Move parseIncPath and sysIncPath out of global scope
[dragonfly.git] / usr.bin / make / parse.h
1 /*-
2  * Copyright (c) 1988, 1989, 1990, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  * Copyright (c) 1989 by Berkeley Softworks
5  * All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Adam de Boor.
9  *
10  * Redistribution and use in source and binary forms, with or without
11  * modification, are permitted provided that the following conditions
12  * are met:
13  * 1. Redistributions of source code must retain the above copyright
14  *    notice, this list of conditions and the following disclaimer.
15  * 2. Redistributions in binary form must reproduce the above copyright
16  *    notice, this list of conditions and the following disclaimer in the
17  *    documentation and/or other materials provided with the distribution.
18  * 3. All advertising materials mentioning features or use of this software
19  *    must display the following acknowledgement:
20  *      This product includes software developed by the University of
21  *      California, Berkeley and its contributors.
22  * 4. Neither the name of the University nor the names of its contributors
23  *    may be used to endorse or promote products derived from this software
24  *    without specific prior written permission.
25  *
26  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
27  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
28  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
29  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
30  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
31  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
32  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
33  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
34  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
35  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
36  * SUCH DAMAGE.
37  *
38  * $DragonFly: src/usr.bin/make/parse.h,v 1.12 2005/05/23 20:05:05 okumoto Exp $
39  */
40
41 #ifndef parse_h_470eeb9a
42 #define parse_h_470eeb9a
43
44 #include <stdio.h>
45
46 #include "util.h"
47
48 struct GNode;
49 struct Lst;
50 struct MakeFlags;
51
52 typedef struct Parser {
53         /**
54          * The list of target names specified on the command line.
55          * Used to resolve #if make(...) statements
56          */
57         struct Lst      *create;
58
59         /** The list of dirs to search when looking for includes. (readonly) */
60         struct Path     *parseIncPath;
61
62         /** The system include path. (readonly) */
63         struct Path     *sysIncPath;
64 } Parser;
65
66 typedef void DirectiveHandler(Parser *, char *, int, int);
67
68 /*
69  * Error levels for parsing. PARSE_FATAL means the process cannot continue
70  * once the makefile has been parsed. PARSE_WARNING means it can. Passed
71  * as the first argument to Parse_Error.
72  */
73 #define PARSE_WARNING   2
74 #define PARSE_FATAL     1
75
76 /*
77  * Definitions for the "local" variables. Used only for clarity.
78  */
79 #define TARGET          "@"     /* Target of dependency */
80 #define OODATE          "?"     /* All out-of-date sources */
81 #define ALLSRC          ">"     /* All sources */
82 #define IMPSRC          "<"     /* Source implied by transformation */
83 #define PREFIX          "*"     /* Common prefix */
84 #define ARCHIVE         "!"     /* Archive in "archive(member)" syntax */
85 #define MEMBER          "%"     /* Member in "archive(member)" syntax */
86
87 #define FTARGET         "@F"    /* file part of TARGET */
88 #define DTARGET         "@D"    /* directory part of TARGET */
89 #define FIMPSRC         "<F"    /* file part of IMPSRC */
90 #define DIMPSRC         "<D"    /* directory part of IMPSRC */
91 #define FPREFIX         "*F"    /* file part of PREFIX */
92 #define DPREFIX         "*D"    /* directory part of PREFIX */
93
94 void Parse_Error(int, const char *, ...);
95 Boolean Parse_AnyExport(void);
96 Boolean Parse_IsVar(char *);
97 void Parse_DoVar(char *, struct GNode *);
98 void Parse_AddIncludeDir(char *);
99 void Parse_File(Parser *, struct MakeFlags *, const char [], FILE *);
100 void Parse_FromString(char *, int);
101 void Parse_MainName(struct Lst *);
102
103 #endif /* parse_h_470eeb9a */