Home | History | Annotate | Line # | Download | only in sh
var.h revision 1.38 
      1 /*	$NetBSD: var.h,v 1.38 2018/12/04 14:03:30 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 #define VNOFUNC		0x0100	/* don't call the callback function */
     52 #define VFUNCREF	0x0200	/* the function is called on ref, not set */
     53 
     54 #define VSPECIAL	0x1000	/* magic properties not lost when set */
     55 #define VDOEXPORT	0x2000	/* obey VEXPORT even if VNOEXPORT */
     56 #define VNOSET		0x4000	/* do not set variable - just readonly test */
     57 #define VNOERROR	0x8000	/* be quiet if set fails (no error msg) */
     58 
     59 struct var;
     60 
     61 union var_func_union {		/* function to be called when:  */
     62 	void (*set_func)(const char *);		/* variable gets set/unset */
     63 	char*(*ref_func)(struct var *);		/* variable is referenced */
     64 };
     65 
     66 struct var {
     67 	struct var *next;		/* next entry in hash list */
     68 	int flags;			/* flags are defined above */
     69 	char *text;			/* name=value */
     70 	int name_len;			/* length of name */
     71 	union var_func_union v_u;	/* function to apply (sometimes) */
     72 };
     73 
     74 
     75 struct localvar {
     76 	struct localvar *next;		/* next local variable in list */
     77 	struct var *vp;			/* the variable that was made local */
     78 	int flags;			/* saved flags */
     79 	char *text;			/* saved text */
     80 	union var_func_union v_u;	/* saved function */
     81 };
     82 
     83 
     84 extern struct localvar *localvars;
     85 
     86 extern struct var vifs;
     87 extern char ifs_default[];
     88 extern struct var vmail;
     89 extern struct var vmpath;
     90 extern struct var vpath;
     91 extern struct var vps1;
     92 extern struct var vps2;
     93 extern struct var vps4;
     94 extern struct var line_num;
     95 #ifndef SMALL
     96 extern struct var editrc;
     97 extern struct var vterm;
     98 extern struct var vtermcap;
     99 extern struct var vhistsize;
    100 extern struct var ps_lit;
    101 extern struct var euname;
    102 extern struct var random_num;
    103 extern intmax_t sh_start_time;
    104 #endif
    105 
    106 extern int line_number;
    107 extern int funclinebase;
    108 extern int funclineabs;
    109 
    110 /*
    111  * The following macros access the values of the above variables.
    112  * They have to skip over the name.  They return the null string
    113  * for unset variables.
    114  */
    115 
    116 #define ifsset()	((vifs.flags & VUNSET) == 0)
    117 #define ifsval()	(ifsset() ? (vifs.text + 4) : ifs_default)
    118 #define mailval()	(vmail.text + 5)
    119 #define mpathval()	(vmpath.text + 9)
    120 #define pathval()	(vpath.text + 5)
    121 #define ps1val()	(vps1.text + 4)
    122 #define ps2val()	(vps2.text + 4)
    123 #define ps4val()	(vps4.text + 4)
    124 #define optindval()	(voptind.text + 7)
    125 #ifndef SMALL
    126 #define histsizeval()	(vhistsize.text + 9)
    127 #define termval()	(vterm.text + 5)
    128 #endif
    129 
    130 #define mpathset()	((vmpath.flags & VUNSET) == 0)
    131 
    132 void initvar(void);
    133 void setvar(const char *, const char *, int);
    134 void setvareq(char *, int);
    135 struct strlist;
    136 void listsetvar(struct strlist *, int);
    137 char *lookupvar(const char *);
    138 char *bltinlookup(const char *, int);
    139 char **environment(void);
    140 void shprocvar(void);
    141 int showvars(const char *, int, int, const char *);
    142 void mklocal(const char *, int);
    143 void listmklocal(struct strlist *, int);
    144 void poplocalvars(void);
    145 int unsetvar(const char *, int);
    146 void choose_ps1(void);
    147 int setvarsafe(const char *, const char *, int);
    148 void print_quoted(const char *);
    149 int validname(const char *, int, int *);
    150 
    151 #endif
    152