var.h revision 146039 
15488Swollman/*-
250476Speter * Copyright (c) 2002 Juli Mallett.
35488Swollman * Copyright (c) 1988, 1989, 1990, 1993
4106146Sru *	The Regents of the University of California.  All rights reserved.
5106146Sru * Copyright (c) 1989 by Berkeley Softworks
6106146Sru * All rights reserved.
7106146Sru *
8136910Sru * This code is derived from software contributed to Berkeley by
9106146Sru * Adam de Boor.
105488Swollman *
115488Swollman * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 *    notice, this list of conditions and the following disclaimer.
16 * 2. Redistributions in binary form must reproduce the above copyright
17 *    notice, this list of conditions and the following disclaimer in the
18 *    documentation and/or other materials provided with the distribution.
19 * 3. All advertising materials mentioning features or use of this software
20 *    must display the following acknowledgement:
21 *	This product includes software developed by the University of
22 *	California, Berkeley and its contributors.
23 * 4. Neither the name of the University nor the names of its contributors
24 *    may be used to endorse or promote products derived from this software
25 *    without specific prior written permission.
26 *
27 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
28 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
29 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
30 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
31 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
32 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
33 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
34 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
35 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
36 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
37 * SUCH DAMAGE.
38 *
39 * $FreeBSD: head/usr.bin/make/var.h 146039 2005-05-10 08:14:26Z harti $
40 */
41
42#ifndef var_h_9cccafce
43#define	var_h_9cccafce
44
45#include <regex.h>
46
47#include "config.h"
48
49struct GNode;
50struct Buffer;
51
52typedef struct Var {
53	char		*name;	/* the variable's name */
54	struct Buffer	*val;	/* its value */
55	int		flags;	/* miscellaneous status flags */
56
57#define	VAR_IN_USE	1	/* Variable's value currently being used.
58				 * Used to avoid recursion */
59
60#define	VAR_JUNK	4	/* Variable is a junk variable that
61				 * should be destroyed when done with
62				 * it. Used by Var_Parse for undefined,
63				 * modified variables */
64
65#define	VAR_TO_ENV	8	/* Place variable in environment */
66} Var;
67
68/* Var*Pattern flags */
69#define	VAR_SUB_GLOBAL	0x01	/* Apply substitution globally */
70#define	VAR_SUB_ONE	0x02	/* Apply substitution to one word */
71#define	VAR_SUB_MATCHED	0x04	/* There was a match */
72#define	VAR_MATCH_START	0x08	/* Match at start of word */
73#define	VAR_MATCH_END	0x10	/* Match at end of word */
74
75typedef struct {
76	struct Buffer	*lhs;	/* String to match */
77	struct Buffer	*rhs;	/* Replacement string (w/ &'s removed) */
78
79	regex_t			re;
80	int			nsub;
81	regmatch_t		*matches;
82
83	int	flags;
84} VarPattern;
85
86typedef Boolean VarModifyProc(const char *, Boolean, struct Buffer *, void *);
87
88/*
89 * var.c
90 */
91void VarREError(int, regex_t *, const char *);
92void Var_Append(const char *, const char *, struct GNode *);
93void Var_Delete(const char *, struct GNode *);
94void Var_Dump(void);
95Boolean Var_Exists(const char *, struct GNode *);
96void Var_Init(char **);
97size_t Var_Match(const char [], struct GNode *);
98char *Var_Parse(const char *, struct GNode *, Boolean, size_t *, Boolean *);
99char *Var_Quote(const char *);
100void Var_Set(const char *, const char *, struct GNode *);
101void Var_SetEnv(const char *, struct GNode *);
102struct Buffer *Var_Subst(const char *, struct GNode *, Boolean);
103struct Buffer *Var_SubstOnly(const char *, const char *, struct GNode *, Boolean);
104char *Var_Value(const char *, struct GNode *, char **);
105
106/*
107 * var_modify.c
108 */
109VarModifyProc VarHead;
110VarModifyProc VarMatch;
111VarModifyProc VarNoMatch;
112VarModifyProc VarRESubstitute;
113VarModifyProc VarRoot;
114VarModifyProc VarSubstitute;
115VarModifyProc VarSuffix;
116VarModifyProc VarTail;
117
118#ifdef SYSVVARSUB
119VarModifyProc VarSYSVMatch;
120#endif
121
122#endif /* var_h_9cccafce */
123