xref: /dragonfly/bin/sh/var.h (revision f746689a)
1 /*-
2  * Copyright (c) 1991, 1993
3  *	The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Kenneth Almquist.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *	This product includes software developed by the University of
19  *	California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *	@(#)var.h	8.2 (Berkeley) 5/4/95
37  * $FreeBSD: src/bin/sh/var.h,v 1.14 2006/06/15 07:00:49 stefanf Exp $
38  * $DragonFly: src/bin/sh/var.h,v 1.6 2007/01/14 15:16:49 pavalos Exp $
39  */
40 
41 /*
42  * Shell variables.
43  */
44 
45 /* flags */
46 #define VEXPORT		0x01	/* variable is exported */
47 #define VREADONLY	0x02	/* variable cannot be modified */
48 #define VSTRFIXED	0x04	/* variable struct is statically allocated */
49 #define VTEXTFIXED	0x08	/* text is statically allocated */
50 #define VSTACK		0x10	/* text is allocated on the stack */
51 #define VUNSET		0x20	/* the variable is not set */
52 #define VNOFUNC		0x40	/* don't call the callback function */
53 
54 
55 struct var {
56 	struct var *next;		/* next entry in hash list */
57 	int flags;			/* flags are defined above */
58 	char *text;			/* name=value */
59 	void (*func)(const char *);
60 					/* function to be called when  */
61 					/* the variable gets set/unset */
62 };
63 
64 
65 struct localvar {
66 	struct localvar *next;		/* next local variable in list */
67 	struct var *vp;			/* the variable that was made local */
68 	int flags;			/* saved flags */
69 	char *text;			/* saved text */
70 };
71 
72 
73 struct localvar *localvars;
74 
75 extern struct var vifs;
76 extern struct var vmail;
77 extern struct var vmpath;
78 extern struct var vpath;
79 extern struct var vppid;
80 extern struct var vps1;
81 extern struct var vps2;
82 extern struct var vps4;
83 #ifndef NO_HISTORY
84 extern struct var vhistsize;
85 #endif
86 
87 /*
88  * The following macros access the values of the above variables.
89  * They have to skip over the name.  They return the null string
90  * for unset variables.
91  */
92 
93 #define ifsval()	(vifs.text + 4)
94 #define ifsset()	((vifs.flags & VUNSET) == 0)
95 #define mailval()	(vmail.text + 5)
96 #define mpathval()	(vmpath.text + 9)
97 #define pathval()	(vpath.text + 5)
98 #define ps1val()	(vps1.text + 4)
99 #define ps2val()	(vps2.text + 4)
100 #define ps4val()	(vps4.text + 4)
101 #define optindval()	(voptind.text + 7)
102 #ifndef NO_HISTORY
103 #define histsizeval()	(vhistsize.text + 9)
104 #endif
105 
106 #define mpathset()	((vmpath.flags & VUNSET) == 0)
107 
108 void initvar(void);
109 void setvar(const char *, const char *, int);
110 void setvareq(char *, int);
111 struct strlist;
112 void listsetvar(struct strlist *);
113 char *lookupvar(const char *);
114 char *bltinlookup(const char *, int);
115 char **environment(void);
116 void shprocvar(void);
117 int showvarscmd(int, char **);
118 int exportcmd(int, char **);
119 int localcmd(int, char **);
120 void mklocal(char *);
121 void poplocalvars(void);
122 int setvarcmd(int, char **);
123 int unsetcmd(int, char **);
124 int unsetvar(const char *);
125 int setvarsafe(const char *, const char *, int);
126