xref: /freebsd/bin/sh/var.h (revision a8445737e740901f5f2c8d24c12ef7fc8b00134e)
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  *	$Id: var.h,v 1.6 1997/02/22 13:58:48 peter 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 staticly allocated */
48 #define VTEXTFIXED	0x08	/* text is staticly 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 
53 
54 struct var {
55 	struct var *next;		/* next entry in hash list */
56 	int flags;			/* flags are defined above */
57 	char *text;			/* name=value */
58 	void (*func) __P((const char *));
59 					/* function to be called when  */
60 					/* the variable gets set/unset */
61 };
62 
63 
64 struct localvar {
65 	struct localvar *next;		/* next local variable in list */
66 	struct var *vp;			/* the variable that was made local */
67 	int flags;			/* saved flags */
68 	char *text;			/* saved text */
69 };
70 
71 
72 struct localvar *localvars;
73 
74 #if ATTY
75 extern struct var vatty;
76 #endif
77 extern struct var vifs;
78 extern struct var vmail;
79 extern struct var vmpath;
80 extern struct var vpath;
81 extern struct var vps1;
82 extern struct var vps2;
83 #if ATTY
84 extern struct var vterm;
85 #endif
86 #ifndef NO_HISTORY
87 extern struct var vhistsize;
88 #endif
89 
90 /*
91  * The following macros access the values of the above variables.
92  * They have to skip over the name.  They return the null string
93  * for unset variables.
94  */
95 
96 #define ifsval()	(vifs.text + 4)
97 #define ifsset()	((vifs.flags & VUNSET) == 0)
98 #define mailval()	(vmail.text + 5)
99 #define mpathval()	(vmpath.text + 9)
100 #define pathval()	(vpath.text + 5)
101 #define ps1val()	(vps1.text + 4)
102 #define ps2val()	(vps2.text + 4)
103 #if ATTY
104 #define termval()	(vterm.text + 5)
105 #endif
106 #define optindval()	(voptind.text + 7)
107 #ifndef NO_HISTORY
108 #define histsizeval()	(vhistsize.text + 9)
109 #endif
110 
111 #if ATTY
112 #define attyset()	((vatty.flags & VUNSET) == 0)
113 #endif
114 #define mpathset()	((vmpath.flags & VUNSET) == 0)
115 
116 void initvar __P((void));
117 void setvar __P((char *, char *, int));
118 void setvareq __P((char *, int));
119 struct strlist;
120 void listsetvar __P((struct strlist *));
121 char *lookupvar __P((char *));
122 char *bltinlookup __P((char *, int));
123 char **environment __P((void));
124 void shprocvar __P((void));
125 int showvarscmd __P((int, char **));
126 int exportcmd __P((int, char **));
127 int localcmd __P((int, char **));
128 void mklocal __P((char *));
129 void poplocalvars __P((void));
130 int setvarcmd __P((int, char **));
131 int unsetcmd __P((int, char **));
132 int unsetvar __P((char *));
133 int setvarsafe __P((char *, char *, int));
134