1 /* $NetBSD: var.h,v 1.41 2024/07/13 13:43:58 kre Exp $ */ 2 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 * @(#)var.h 8.2 (Berkeley) 5/4/95 35 */ 36 37 #ifndef VUNSET /* double include protection */ 38 /* 39 * Shell variables. 40 */ 41 42 /* flags */ 43 #define VUNSET 0x0001 /* the variable is not set */ 44 #define VEXPORT 0x0002 /* variable is exported */ 45 #define VREADONLY 0x0004 /* variable cannot be modified */ 46 #define VNOEXPORT 0x0008 /* variable may not be exported */ 47 48 #define VSTRFIXED 0x0010 /* variable struct is statically allocated */ 49 #define VTEXTFIXED 0x0020 /* text is statically allocated */ 50 #define VSTACK 0x0040 /* text is allocated on the stack */ 51 52 #define VUNSAFE 0x0080 /* variable value imported from environment */ 53 54 #define VNOFUNC 0x0100 /* don't call the callback function */ 55 #define VFUNCREF 0x0200 /* the function is called on ref, not set */ 56 57 #define VSPECIAL 0x1000 /* magic properties not lost when set */ 58 #define VDOEXPORT 0x2000 /* obey VEXPORT even if VNOEXPORT */ 59 #define VNOSET 0x4000 /* do not set variable - just readonly test */ 60 #define VNOERROR 0x8000 /* be quiet if set fails (no error msg) */ 61 62 struct var; 63 64 union var_func_union { /* function to be called when: */ 65 void (*set_func)(char *, int); /* variable gets set/unset */ 66 char*(*ref_func)(struct var *); /* variable is referenced */ 67 }; 68 69 struct var { 70 struct var *next; /* next entry in hash list */ 71 int flags; /* flags are defined above */ 72 char *text; /* name=value */ 73 int name_len; /* length of name */ 74 union var_func_union v_u; /* function to apply (sometimes) */ 75 }; 76 77 78 struct localvar { 79 struct localvar *next; /* next local variable in list */ 80 struct var *vp; /* the variable that was made local */ 81 int flags; /* saved flags */ 82 char *text; /* saved text */ 83 union var_func_union v_u; /* saved function */ 84 }; 85 86 87 extern struct localvar *localvars; 88 89 extern struct var vifs; 90 extern char ifs_default[]; 91 extern struct var vmail; 92 extern struct var vmpath; 93 extern struct var vpath; 94 extern struct var vps1; 95 extern struct var vps2; 96 extern struct var vps4; 97 extern struct var line_num; 98 #ifndef SMALL 99 extern struct var editrc; 100 extern struct var vterm; 101 extern struct var vtermcap; 102 extern struct var vhistappend; 103 extern struct var vhistfile; 104 extern struct var vhistsize; 105 extern struct var ps_lit; 106 extern struct var euname; 107 extern struct var random_num; 108 extern intmax_t sh_start_time; 109 #endif 110 111 extern int line_number; 112 extern int funclinebase; 113 extern int funclineabs; 114 115 /* 116 * The following macros access the values of the above variables. 117 * They have to skip over the name. They return the null string 118 * for unset variables. 119 */ 120 121 #define ifsset() ((vifs.flags & VUNSET) == 0) 122 #define ifsval() (ifsset() ? (vifs.text + 4) : ifs_default) 123 #define mailval() (vmail.text + 5) 124 #define mpathval() (vmpath.text + 9) 125 #define pathval() (vpath.text + 5) 126 #define ps1val() (vps1.text + 4) 127 #define ps2val() (vps2.text + 4) 128 #define ps4val() (vps4.text + 4) 129 #define optindval() (voptind.text + 7) 130 #ifndef SMALL 131 #define histsizeval() (vhistsize.text + 9) 132 #define histsizeflags() (vhistsize.flags) 133 #define histfileval() (vhistfile.text + 9) 134 #define histfileflags() (vhistfile.flags) 135 #define histappval() (vhistappend.text + 11) 136 #define histappflags() (vhistappend.flags) 137 #define termval() (vterm.text + 5) 138 #endif 139 140 #define mpathset() ((vmpath.flags & VUNSET) == 0) 141 142 void initvar(void); 143 void setvar(const char *, const char *, int); 144 void setvareq(char *, int); 145 struct strlist; 146 void listsetvar(struct strlist *, int); 147 char *lookupvar(const char *); 148 char *bltinlookup(const char *, int); 149 char **environment(void); 150 void shprocvar(void); 151 int showvars(const char *, int, int, const char *); 152 void mklocal(const char *, int); 153 void listmklocal(struct strlist *, int); 154 void poplocalvars(void); 155 int unsetvar(const char *, int); 156 void choose_ps1(void); 157 void setvar_invocation(int, char **); 158 int setvarsafe(const char *, const char *, int); 159 void setvareqsafe(char *, int); 160 void print_quoted(const char *); 161 int validname(const char *, int, int *); 162 163 #endif 164