Home | History | Annotate | Download | only in sh
      1 /*	$NetBSD: var.h,v 1.23 2004/10/02 12:16:53 dsl 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 /*
     38  * Shell variables.
     39  */
     40 
     41 /* flags */
     42 #define VEXPORT		0x01	/* variable is exported */
     43 #define VREADONLY	0x02	/* variable cannot be modified */
     44 #define VSTRFIXED	0x04	/* variable struct is statically allocated */
     45 #define VTEXTFIXED	0x08	/* text is statically allocated */
     46 #define VSTACK		0x10	/* text is allocated on the stack */
     47 #define VUNSET		0x20	/* the variable is not set */
     48 #define VNOFUNC		0x40	/* don't call the callback function */
     49 #define VNOSET		0x80	/* do not set variable - just readonly test */
     50 
     51 
     52 struct var {
     53 	struct var *next;		/* next entry in hash list */
     54 	int flags;			/* flags are defined above */
     55 	char *text;			/* name=value */
     56 	int name_len;			/* length of name */
     57 	void (*func)(const char *);
     58 					/* function to be called when  */
     59 					/* the variable gets set/unset */
     60 };
     61 
     62 
     63 struct localvar {
     64 	struct localvar *next;		/* next local variable in list */
     65 	struct var *vp;			/* the variable that was made local */
     66 	int flags;			/* saved flags */
     67 	char *text;			/* saved text */
     68 };
     69 
     70 
     71 struct localvar *localvars;
     72 
     73 #if ATTY
     74 extern struct var vatty;
     75 #endif
     76 extern struct var vifs;
     77 extern struct var vmpath;
     78 extern struct var vpath;
     79 extern struct var vps1;
     80 extern struct var vps2;
     81 extern struct var vps4;
     82 #ifdef WITH_HISTORY
     83 extern struct var vterm;
     84 extern struct var vtermcap;
     85 extern struct var vhistsize;
     86 #endif
     87 
     88 /*
     89  * The following macros access the values of the above variables.
     90  * They have to skip over the name.  They return the null string
     91  * for unset variables.
     92  */
     93 
     94 #define ifsval()	(vifs.text + 4)
     95 #define ifsset()	((vifs.flags & VUNSET) == 0)
     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 #ifdef WITH_HISTORY
    103 #define histsizeval()	(vhistsize.text + 9)
    104 #define termval()	(vterm.text + 5)
    105 #endif
    106 
    107 #if ATTY
    108 #define attyset()	((vatty.flags & VUNSET) == 0)
    109 #endif
    110 #define mpathset()	((vmpath.flags & VUNSET) == 0)
    111 
    112 void initvar(void);
    113 void setvar(const char *, const char *, int);
    114 void setvareq(char *, int);
    115 struct strlist;
    116 void listsetvar(struct strlist *, int);
    117 char *lookupvar(const char *);
    118 char *bltinlookup(const char *, int);
    119 char **environment(void);
    120 void shprocvar(void);
    121 int showvars(const char *, int, int);
    122 int exportcmd(int, char **);
    123 int localcmd(int, char **);
    124 void mklocal(const char *, int);
    125 void listmklocal(struct strlist *, int);
    126 void poplocalvars(void);
    127 int setvarcmd(int, char **);
    128 int unsetcmd(int, char **);
    129 int unsetvar(const char *, int);
    130 int setvarsafe(const char *, const char *, int);
    131 void print_quoted(const char *);
    132