master xplshn/aruu / cmd / posix / sh / var.h
  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
 35/*
 36 * Shell variables.
 37 */
 38
 39/* flags */
 40#define VEXPORT		0x01	/* variable is exported */
 41#define VREADONLY	0x02	/* variable cannot be modified */
 42#define VSTRFIXED	0x04	/* variable struct is statically allocated */
 43#define VTEXTFIXED	0x08	/* text is statically allocated */
 44#define VSTACK		0x10	/* text is allocated on the stack */
 45#define VUNSET		0x20	/* the variable is not set */
 46#define VNOFUNC		0x40	/* don't call the callback function */
 47#define VNOSET		0x80	/* do not set variable - just readonly test */
 48#define VNOLOCAL	0x100	/* ignore forcelocal */
 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
 70extern struct localvar *localvars;
 71extern int forcelocal;
 72
 73extern struct var vifs;
 74extern struct var vmail;
 75extern struct var vmpath;
 76extern struct var vpath;
 77extern struct var vps1;
 78extern struct var vps2;
 79extern struct var vps4;
 80extern struct var vdisvfork;
 81#ifndef NO_HISTORY
 82extern struct var vhistsize;
 83extern struct var vterm;
 84#endif
 85
 86extern int localeisutf8;
 87/* The parser uses the locale that was in effect at startup. */
 88extern int initial_localeisutf8;
 89
 90/*
 91 * The following macros access the values of the above variables.
 92 * They have to skip over the name.  They return the null string
 93 * for unset variables.
 94 */
 95
 96#define ifsval()	(vifs.text + 4)
 97#define ifsset()	((vifs.flags & VUNSET) == 0)
 98#define mailval()	(vmail.text + 5)
 99#define mpathval()	(vmpath.text + 9)
100#define pathval()	(vpath.text + 5)
101#define ps1val()	(vps1.text + 4)
102#define ps2val()	(vps2.text + 4)
103#define ps4val()	(vps4.text + 4)
104#define optindval()	(voptind.text + 7)
105#ifndef NO_HISTORY
106#define histsizeval()	(vhistsize.text + 9)
107#define termval()	(vterm.text + 5)
108#endif
109
110#define mpathset()	((vmpath.flags & VUNSET) == 0)
111#define disvforkset()	((vdisvfork.flags & VUNSET) == 0)
112
113void initvar(void);
114void setvar(const char *, const char *, int);
115void setvareq(char *, int);
116struct arglist;
117void listsetvar(struct arglist *, int);
118char *lookupvar(const char *);
119char *bltinlookup(const char *, int);
120void bltinsetlocale(void);
121void bltinunsetlocale(void);
122void updatecharset(void);
123void initcharset(void);
124char **environment(void);
125int showvarscmd(int, char **);
126void mklocal(char *);
127void poplocalvars(void);
128int unsetvar(const char *);
129int setvarsafe(const char *, const char *, int);