xref: /netbsd/bin/sh/var.h (revision bf9ec67e)
1 /*	$NetBSD: var.h,v 1.18 2000/05/22 10:18:47 elric Exp $	*/
2 
3 /*-
4  * Copyright (c) 1991, 1993
5  *	The Regents of the University of California.  All rights reserved.
6  *
7  * This code is derived from software contributed to Berkeley by
8  * Kenneth Almquist.
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  *	@(#)var.h	8.2 (Berkeley) 5/4/95
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 staticly allocated */
49 #define VTEXTFIXED	0x08	/* text is staticly 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) __P((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 #if ATTY
76 extern struct var vatty;
77 #endif
78 extern struct var vifs;
79 extern struct var vmail;
80 extern struct var vmpath;
81 extern struct var vpath;
82 extern struct var vps1;
83 extern struct var vps2;
84 #ifndef SMALL
85 extern struct var vterm;
86 extern struct var vtermcap;
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 #define optindval()	(voptind.text + 7)
104 #ifndef SMALL
105 #define histsizeval()	(vhistsize.text + 9)
106 #define termval()	(vterm.text + 5)
107 #endif
108 
109 #if ATTY
110 #define attyset()	((vatty.flags & VUNSET) == 0)
111 #endif
112 #define mpathset()	((vmpath.flags & VUNSET) == 0)
113 
114 void initvar __P((void));
115 void setvar __P((const char *, const char *, int));
116 void setvareq __P((char *, int));
117 struct strlist;
118 void listsetvar __P((struct strlist *));
119 char *lookupvar __P((const char *));
120 char *bltinlookup __P((const char *, int));
121 char **environment __P((void));
122 void shprocvar __P((void));
123 int showvarscmd __P((int, char **));
124 int exportcmd __P((int, char **));
125 int localcmd __P((int, char **));
126 void mklocal __P((char *));
127 void poplocalvars __P((void));
128 int setvarcmd __P((int, char **));
129 int unsetcmd __P((int, char **));
130 int unsetvar __P((const char *));
131 int setvarsafe __P((const char *, const char *, int));
132