xref: /freebsd/bin/sh/var.h (revision 2008043f386721d58158e37e0d7e50df8095942d)
1 /*-
2  * SPDX-License-Identifier: BSD-3-Clause
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. Neither the name of the University nor the names of its contributors
19  *    may be used to endorse or promote products derived from this software
20  *    without specific prior written permission.
21  *
22  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32  * SUCH DAMAGE.
33  *
34  *	@(#)var.h	8.2 (Berkeley) 5/4/95
35  */
36 
37 /*
38  * Shell variables.
39  */
40 
41 /* flags */
42 #define VEXPORT		0x01	/* variable is exported */
43 #define VREADONLY	0x02	/* variable cannot be modified */
44 #define VSTRFIXED	0x04	/* variable struct is statically allocated */
45 #define VTEXTFIXED	0x08	/* text is statically allocated */
46 #define VSTACK		0x10	/* text is allocated on the stack */
47 #define VUNSET		0x20	/* the variable is not set */
48 #define VNOFUNC		0x40	/* don't call the callback function */
49 #define VNOSET		0x80	/* do not set variable - just readonly test */
50 #define VNOLOCAL	0x100	/* ignore forcelocal */
51 
52 
53 struct var {
54 	struct var *next;		/* next entry in hash list */
55 	int flags;			/* flags are defined above */
56 	int name_len;			/* length of name */
57 	char *text;			/* name=value */
58 	void (*func)(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 extern struct localvar *localvars;
73 extern int forcelocal;
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 vps1;
80 extern struct var vps2;
81 extern struct var vps4;
82 extern struct var vdisvfork;
83 #ifndef NO_HISTORY
84 extern struct var vhistsize;
85 extern struct var vterm;
86 #endif
87 
88 extern int localeisutf8;
89 /* The parser uses the locale that was in effect at startup. */
90 extern int initial_localeisutf8;
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 NO_HISTORY
108 #define histsizeval()	(vhistsize.text + 9)
109 #define termval()	(vterm.text + 5)
110 #endif
111 
112 #define mpathset()	((vmpath.flags & VUNSET) == 0)
113 #define disvforkset()	((vdisvfork.flags & VUNSET) == 0)
114 
115 void initvar(void);
116 void setvar(const char *, const char *, int);
117 void setvareq(char *, int);
118 struct arglist;
119 void listsetvar(struct arglist *, int);
120 char *lookupvar(const char *);
121 char *bltinlookup(const char *, int);
122 void bltinsetlocale(void);
123 void bltinunsetlocale(void);
124 void updatecharset(void);
125 void initcharset(void);
126 char **environment(void);
127 int showvarscmd(int, char **);
128 void mklocal(char *);
129 void poplocalvars(void);
130 int unsetvar(const char *);
131 int setvarsafe(const char *, const char *, int);
132