d23ae32c76c55116fc750c8aeafcb12d56334a56
[dragonfly.git] / bin / sh / var.h
1 /*-
2  * Copyright (c) 1991, 1993
3  *      The Regents of the University of California.  All rights reserved.
4  *
5  * This code is derived from software contributed to Berkeley by
6  * Kenneth Almquist.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  * 1. Redistributions of source code must retain the above copyright
12  *    notice, this list of conditions and the following disclaimer.
13  * 2. Redistributions in binary form must reproduce the above copyright
14  *    notice, this list of conditions and the following disclaimer in the
15  *    documentation and/or other materials provided with the distribution.
16  * 3. All advertising materials mentioning features or use of this software
17  *    must display the following acknowledgement:
18  *      This product includes software developed by the University of
19  *      California, Berkeley and its contributors.
20  * 4. Neither the name of the University nor the names of its contributors
21  *    may be used to endorse or promote products derived from this software
22  *    without specific prior written permission.
23  *
24  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
25  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
26  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
27  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
28  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
29  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
30  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
31  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
32  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
33  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
34  * SUCH DAMAGE.
35  *
36  *      @(#)var.h       8.2 (Berkeley) 5/4/95
37  * $FreeBSD: src/bin/sh/var.h,v 1.22 2011/05/08 17:40:10 jilles Exp $
38  */
39
40 /*
41  * Shell variables.
42  */
43
44 /* flags */
45 #define VEXPORT         0x01    /* variable is exported */
46 #define VREADONLY       0x02    /* variable cannot be modified */
47 #define VSTRFIXED       0x04    /* variable struct is statically allocated */
48 #define VTEXTFIXED      0x08    /* text is statically allocated */
49 #define VSTACK          0x10    /* text is allocated on the stack */
50 #define VUNSET          0x20    /* the variable is not set */
51 #define VNOFUNC         0x40    /* don't call the callback function */
52 #define VNOSET          0x80    /* do not set variable - just readonly test */
53
54
55 struct var {
56         struct var *next;               /* next entry in hash list */
57         int flags;                      /* flags are defined above */
58         int name_len;                   /* length of name */
59         char *text;                     /* name=value */
60         void (*func)(const char *);
61                                         /* function to be called when  */
62                                         /* the variable gets set/unset */
63 };
64
65
66 struct localvar {
67         struct localvar *next;          /* next local variable in list */
68         struct var *vp;                 /* the variable that was made local */
69         int flags;                      /* saved flags */
70         char *text;                     /* saved text */
71 };
72
73
74 struct localvar *localvars;
75
76 extern struct var vifs;
77 extern struct var vmail;
78 extern struct var vmpath;
79 extern struct var vpath;
80 extern struct var vppid;
81 extern struct var vps1;
82 extern struct var vps2;
83 extern struct var vps4;
84 #ifndef NO_HISTORY
85 extern struct var vhistsize;
86 extern struct var vterm;
87 #endif
88
89 extern int localeisutf8;
90 /* The parser uses the locale that was in effect at startup. */
91 extern int initial_localeisutf8;
92
93 /*
94  * The following macros access the values of the above variables.
95  * They have to skip over the name.  They return the null string
96  * for unset variables.
97  */
98
99 #define ifsval()        (vifs.text + 4)
100 #define ifsset()        ((vifs.flags & VUNSET) == 0)
101 #define mailval()       (vmail.text + 5)
102 #define mpathval()      (vmpath.text + 9)
103 #define pathval()       (vpath.text + 5)
104 #define ps1val()        (vps1.text + 4)
105 #define ps2val()        (vps2.text + 4)
106 #define ps4val()        (vps4.text + 4)
107 #define optindval()     (voptind.text + 7)
108 #ifndef NO_HISTORY
109 #define histsizeval()   (vhistsize.text + 9)
110 #define termval()       (vterm.text + 5)
111 #endif
112
113 #define mpathset()      ((vmpath.flags & VUNSET) == 0)
114
115 void initvar(void);
116 void setvar(const char *, const char *, int);
117 void setvareq(char *, int);
118 struct strlist;
119 void listsetvar(struct strlist *, int);
120 char *lookupvar(const char *);
121 char *bltinlookup(const char *, int);
122 void bltinsetlocale(void);
123 void bltinunsetlocale(void);
124 void updatecharset(void);
125 void initcharset(void);
126 char **environment(void);
127 int showvarscmd(int, char **);
128 int exportcmd(int, char **);
129 int localcmd(int, char **);
130 void mklocal(char *);
131 void poplocalvars(void);
132 int setvarcmd(int, char **);
133 int unsetcmd(int, char **);
134 int unsetvar(const char *);
135 int setvarsafe(const char *, const char *, int);