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