var.h revision 330897 
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 * 4. 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 * $FreeBSD: stable/11/bin/sh/var.h 330897 2018-03-14 03:19:51Z eadler $
36 */
37
38/*
39 * Shell variables.
40 */
41
42/* flags */
43#define VEXPORT		0x01	/* variable is exported */
44#define VREADONLY	0x02	/* variable cannot be modified */
45#define VSTRFIXED	0x04	/* variable struct is statically allocated */
46#define VTEXTFIXED	0x08	/* text is statically allocated */
47#define VSTACK		0x10	/* text is allocated on the stack */
48#define VUNSET		0x20	/* the variable is not set */
49#define VNOFUNC		0x40	/* don't call the callback function */
50#define VNOSET		0x80	/* do not set variable - just readonly test */
51#define VNOLOCAL	0x100	/* ignore forcelocal */
52
53
54struct var {
55	struct var *next;		/* next entry in hash list */
56	int flags;			/* flags are defined above */
57	int name_len;			/* length of name */
58	char *text;			/* name=value */
59	void (*func)(const char *);
60					/* function to be called when  */
61					/* the variable gets set/unset */
62};
63
64
65struct localvar {
66	struct localvar *next;		/* next local variable in list */
67	struct var *vp;			/* the variable that was made local */
68	int flags;			/* saved flags */
69	char *text;			/* saved text */
70};
71
72
73extern struct localvar *localvars;
74extern int forcelocal;
75
76extern struct var vifs;
77extern struct var vmail;
78extern struct var vmpath;
79extern struct var vpath;
80extern struct var vps1;
81extern struct var vps2;
82extern struct var vps4;
83extern struct var vdisvfork;
84#ifndef NO_HISTORY
85extern struct var vhistsize;
86extern struct var vterm;
87#endif
88
89extern int localeisutf8;
90/* The parser uses the locale that was in effect at startup. */
91extern int initial_localeisutf8;
92
93/*
94 * The following macros access the values of the above variables.
95 * They have to skip over the name.  They return the null string
96 * for unset variables.
97 */
98
99#define ifsval()	(vifs.text + 4)
100#define ifsset()	((vifs.flags & VUNSET) == 0)
101#define mailval()	(vmail.text + 5)
102#define mpathval()	(vmpath.text + 9)
103#define pathval()	(vpath.text + 5)
104#define ps1val()	(vps1.text + 4)
105#define ps2val()	(vps2.text + 4)
106#define ps4val()	(vps4.text + 4)
107#define optindval()	(voptind.text + 7)
108#ifndef NO_HISTORY
109#define histsizeval()	(vhistsize.text + 9)
110#define termval()	(vterm.text + 5)
111#endif
112
113#define mpathset()	((vmpath.flags & VUNSET) == 0)
114#define disvforkset()	((vdisvfork.flags & VUNSET) == 0)
115
116void initvar(void);
117void setvar(const char *, const char *, int);
118void setvareq(char *, int);
119struct arglist;
120void listsetvar(struct arglist *, int);
121char *lookupvar(const char *);
122char *bltinlookup(const char *, int);
123void bltinsetlocale(void);
124void bltinunsetlocale(void);
125void updatecharset(void);
126void initcharset(void);
127char **environment(void);
128int showvarscmd(int, char **);
129void mklocal(char *);
130void poplocalvars(void);
131int unsetvar(const char *);
132int setvarsafe(const char *, const char *, int);
133