xref: /freebsd/bin/sh/var.h (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
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  * 4. Neither the name of the University nor the names of its contributors
17  *    may be used to endorse or promote products derived from this software
18  *    without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
30  * SUCH DAMAGE.
31  *
32  *	@(#)var.h	8.2 (Berkeley) 5/4/95
33  * $FreeBSD$
34  */
35 
36 /*
37  * Shell variables.
38  */
39 
40 /* flags */
41 #define VEXPORT		0x01	/* variable is exported */
42 #define VREADONLY	0x02	/* variable cannot be modified */
43 #define VSTRFIXED	0x04	/* variable struct is statically allocated */
44 #define VTEXTFIXED	0x08	/* text is statically allocated */
45 #define VSTACK		0x10	/* text is allocated on the stack */
46 #define VUNSET		0x20	/* the variable is not set */
47 #define VNOFUNC		0x40	/* don't call the callback function */
48 #define VNOSET		0x80	/* do not set variable - just readonly test */
49 #define VNOLOCAL	0x100	/* ignore forcelocal */
50 
51 
52 struct var {
53 	struct var *next;		/* next entry in hash list */
54 	int flags;			/* flags are defined above */
55 	int name_len;			/* length of name */
56 	char *text;			/* name=value */
57 	void (*func)(const char *);
58 					/* function to be called when  */
59 					/* the variable gets set/unset */
60 };
61 
62 
63 struct localvar {
64 	struct localvar *next;		/* next local variable in list */
65 	struct var *vp;			/* the variable that was made local */
66 	int flags;			/* saved flags */
67 	char *text;			/* saved text */
68 };
69 
70 
71 extern struct localvar *localvars;
72 extern int forcelocal;
73 
74 extern struct var vifs;
75 extern struct var vmail;
76 extern struct var vmpath;
77 extern struct var vpath;
78 extern struct var vps1;
79 extern struct var vps2;
80 extern struct var vps4;
81 extern struct var vdisvfork;
82 #ifndef NO_HISTORY
83 extern struct var vhistsize;
84 extern struct var vterm;
85 #endif
86 
87 extern int localeisutf8;
88 /* The parser uses the locale that was in effect at startup. */
89 extern int initial_localeisutf8;
90 
91 /*
92  * The following macros access the values of the above variables.
93  * They have to skip over the name.  They return the null string
94  * for unset variables.
95  */
96 
97 #define ifsval()	(vifs.text + 4)
98 #define ifsset()	((vifs.flags & VUNSET) == 0)
99 #define mailval()	(vmail.text + 5)
100 #define mpathval()	(vmpath.text + 9)
101 #define pathval()	(vpath.text + 5)
102 #define ps1val()	(vps1.text + 4)
103 #define ps2val()	(vps2.text + 4)
104 #define ps4val()	(vps4.text + 4)
105 #define optindval()	(voptind.text + 7)
106 #ifndef NO_HISTORY
107 #define histsizeval()	(vhistsize.text + 9)
108 #define termval()	(vterm.text + 5)
109 #endif
110 
111 #define mpathset()	((vmpath.flags & VUNSET) == 0)
112 #define disvforkset()	((vdisvfork.flags & VUNSET) == 0)
113 
114 void initvar(void);
115 void setvar(const char *, const char *, int);
116 void setvareq(char *, int);
117 struct strlist;
118 void listsetvar(struct strlist *, int);
119 char *lookupvar(const char *);
120 char *bltinlookup(const char *, int);
121 void bltinsetlocale(void);
122 void bltinunsetlocale(void);
123 void updatecharset(void);
124 void initcharset(void);
125 char **environment(void);
126 int showvarscmd(int, char **);
127 void mklocal(char *);
128 void poplocalvars(void);
129 int unsetvar(const char *);
130 int setvarsafe(const char *, const char *, int);
131