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