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.16 2005/09/17 11:07:23 okumoto Exp $
  39  */
  40
  41 #ifndef parse_h_470eeb9a
  42 #define parse_h_470eeb9a
  43
  44 #include <stdio.h>
  45 #include <stdbool.h>
  46
  47 struct CLI;
  48 struct GNode;
  49 struct Lst;
  50
  51 typedef struct Parser {
  52         /**
  53          * The list of target names specified on the command line.
  54          * Used to resolve #if make(...) statements
  55          */
  56         struct Lst      *create;
  57
  58         /** The list of dirs to search when looking for includes. (readonly) */
  59         struct Path     *parseIncPath;
  60
  61         /** The system include path. (readonly) */
  62         struct Path     *sysIncPath;
  63 } Parser;
  64
  65 typedef void DirectiveHandler(Parser *, char *, int, int);
  66
  67 /*
  68  * Error levels for parsing. PARSE_FATAL means the process cannot continue
  69  * once the makefile has been parsed. PARSE_WARNING means it can. Passed
  70  * as the first argument to Parse_Error.
  71  */
  72 #define PARSE_WARNING   2
  73 #define PARSE_FATAL     1
  74
  75 /*
  76  * Definitions for the "local" variables. Used only for clarity.
  77  */
  78 #define TARGET          "@"     /* Target of dependency */
  79 #define OODATE          "?"     /* All out-of-date sources */
  80 #define ALLSRC          ">"     /* All sources */
  81 #define IMPSRC          "<"     /* Source implied by transformation */
  82 #define PREFIX          "*"     /* Common prefix */
  83 #define ARCHIVE         "!"     /* Archive in "archive(member)" syntax */
  84 #define MEMBER          "%"     /* Member in "archive(member)" syntax */
  85
  86 #define FTARGET         "@F"    /* file part of TARGET */
  87 #define DTARGET         "@D"    /* directory part of TARGET */
  88 #define FIMPSRC         "<F"    /* file part of IMPSRC */
  89 #define DIMPSRC         "<D"    /* directory part of IMPSRC */
  90 #define FPREFIX         "*F"    /* file part of PREFIX */
  91 #define DPREFIX         "*D"    /* directory part of PREFIX */
  92
  93 void Parse_Error(int, const char *, ...);
  94 bool Parse_AnyExport(void);
  95 bool Parse_IsVar(char *);
  96 void Parse_DoVar(char *, struct GNode *);
  97 void Parse_AddIncludeDir(char *);
  98 void Parse_File(Parser *, struct CLI *, const char [], FILE *);
  99 void Parse_FromString(char *, int);
 100 void Parse_MainName(struct Lst *);
 101
 102 #endif /* parse_h_470eeb9a */