xref: /dragonfly/bin/sh/var.h (revision 92fc8b5c)
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.19 2011/01/01 13:26:18 jilles Exp $
38  */
39 
40 /*
41  * Shell variables.
42  */
43 
44 /* flags */
45 #define VEXPORT		0x01	/* variable is exported */
46 #define VREADONLY	0x02	/* variable cannot be modified */
47 #define VSTRFIXED	0x04	/* variable struct is statically allocated */
48 #define VTEXTFIXED	0x08	/* text is statically allocated */
49 #define VSTACK		0x10	/* text is allocated on the stack */
50 #define VUNSET		0x20	/* the variable is not set */
51 #define VNOFUNC		0x40	/* don't call the callback function */
52 #define VNOSET		0x80	/* do not set variable - just readonly test */
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 extern struct var vterm;
86 #endif
87 
88 /*
89  * The following macros access the values of the above variables.
90  * They have to skip over the name.  They return the null string
91  * for unset variables.
92  */
93 
94 #define ifsval()	(vifs.text + 4)
95 #define ifsset()	((vifs.flags & VUNSET) == 0)
96 #define mailval()	(vmail.text + 5)
97 #define mpathval()	(vmpath.text + 9)
98 #define pathval()	(vpath.text + 5)
99 #define ps1val()	(vps1.text + 4)
100 #define ps2val()	(vps2.text + 4)
101 #define ps4val()	(vps4.text + 4)
102 #define optindval()	(voptind.text + 7)
103 #ifndef NO_HISTORY
104 #define histsizeval()	(vhistsize.text + 9)
105 #define termval()	(vterm.text + 5)
106 #endif
107 
108 #define mpathset()	((vmpath.flags & VUNSET) == 0)
109 
110 void initvar(void);
111 void setvar(const char *, const char *, int);
112 void setvareq(char *, int);
113 struct strlist;
114 void listsetvar(struct strlist *, int);
115 char *lookupvar(const char *);
116 char *bltinlookup(const char *, int);
117 void bltinsetlocale(void);
118 void bltinunsetlocale(void);
119 char **environment(void);
120 int showvarscmd(int, char **);
121 int exportcmd(int, char **);
122 int localcmd(int, char **);
123 void mklocal(char *);
124 void poplocalvars(void);
125 int setvarcmd(int, char **);
126 int unsetcmd(int, char **);
127 int unsetvar(const char *);
128 int setvarsafe(const char *, const char *, int);
129