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