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