2 * Copyright (c) 1991, 1993
3 * The Regents of the University of California. All rights reserved.
5 * This code is derived from software contributed to Berkeley by
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
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 * 4. Neither the name of the University nor the names of its contributors
17 * may be used to endorse or promote products derived from this software
18 * without specific prior written permission.
20 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
21 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
24 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
26 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
27 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
28 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
29 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
35 static char sccsid[] = "@(#)var.c 8.3 (Berkeley) 5/4/95";
38 #include <sys/cdefs.h>
39 __FBSDID("$FreeBSD$");
55 #include "nodes.h" /* for other headers */
56 #include "eval.h" /* defines cmdenviron */
68 #include "myhistedit.h"
79 void (*func)(const char *);
96 static struct var voptind;
101 static const struct varinit varinit[] = {
103 { &vhistsize, VUNSET, "HISTSIZE=",
106 { &vifs, 0, "IFS= \t\n",
108 { &vmail, VUNSET, "MAIL=",
110 { &vmpath, VUNSET, "MAILPATH=",
112 { &vpath, 0, "PATH=" _PATH_DEFPATH,
114 { &vppid, VUNSET, "PPID=",
117 * vps1 depends on uid
119 { &vps2, 0, "PS2=> ",
121 { &vps4, 0, "PS4=+ ",
124 { &vterm, VUNSET, "TERM=",
127 { &voptind, 0, "OPTIND=1",
129 { &vdisvfork, VUNSET, "SH_DISABLE_VFORK=",
135 static struct var *vartab[VTABSIZE];
137 static const char *const locale_names[7] = {
138 "LC_COLLATE", "LC_CTYPE", "LC_MONETARY",
139 "LC_NUMERIC", "LC_TIME", "LC_MESSAGES", NULL
141 static const int locale_categories[7] = {
142 LC_COLLATE, LC_CTYPE, LC_MONETARY, LC_NUMERIC, LC_TIME, LC_MESSAGES, 0
145 static int varequal(const char *, const char *);
146 static struct var *find_var(const char *, struct var ***, int *);
147 static int localevar(const char *);
150 * Initialize the variable symbol tables and import the environment.
155 MKINIT char **environ;
160 for (envp = environ ; *envp ; envp++) {
161 if (strchr(*envp, '=')) {
162 setvareq(*envp, VEXPORT|VTEXTFIXED);
170 * This routine initializes the builtin variables. It is called when the
171 * shell is initialized.
178 const struct varinit *ip;
182 for (ip = varinit ; (vp = ip->var) != NULL ; ip++) {
183 if (find_var(ip->text, &vpp, &vp->name_len) != NULL)
187 vp->text = __DECONST(char *, ip->text);
188 vp->flags = ip->flags | VSTRFIXED | VTEXTFIXED;
194 if (find_var("PS1", &vpp, &vps1.name_len) == NULL) {
197 vps1.text = __DECONST(char *, geteuid() ? "PS1=$ " : "PS1=# ");
198 vps1.flags = VSTRFIXED|VTEXTFIXED;
200 if ((vppid.flags & VEXPORT) == 0) {
201 fmtstr(ppid, sizeof(ppid), "%d", (int)getppid());
202 setvarsafe("PPID", ppid, 0);
207 * Safe version of setvar, returns 1 on success 0 on failure.
211 setvarsafe(const char *name, const char *val, int flags)
213 struct jmploc jmploc;
214 struct jmploc *const savehandler = handler;
219 if (setjmp(jmploc.loc))
223 setvar(name, val, flags);
225 handler = savehandler;
231 * Set the value of a variable. The flags argument is stored with the
232 * flags of the variable. If val is NULL, the variable is unset.
236 setvar(const char *name, const char *val, int flags)
250 if (! is_in_name(*p)) {
251 if (*p == '\0' || *p == '=')
259 error("%.*s: bad variable name", namelen, name);
260 len = namelen + 2; /* 2 is space for '=' and '\0' */
266 nameeq = ckmalloc(len);
267 memcpy(nameeq, name, namelen);
268 nameeq[namelen] = '=';
270 scopy(val, nameeq + namelen + 1);
272 nameeq[namelen + 1] = '\0';
273 setvareq(nameeq, flags);
277 localevar(const char *s)
279 const char *const *ss;
283 if (varequal(s + 1, "ANG"))
285 if (strncmp(s + 1, "C_", 2) != 0)
287 if (varequal(s + 3, "ALL"))
289 for (ss = locale_names; *ss ; ss++)
290 if (varequal(s + 3, *ss + 3))
297 * Sets/unsets an environment variable from a pointer that may actually be a
298 * pointer into environ where the string should not be manipulated.
301 change_env(const char *s, int set)
307 if ((eqp = strchr(ss, '=')) != NULL)
309 if (set && eqp != NULL)
310 (void) setenv(ss, eqp + 1, 1);
320 * Same as setvar except that the variable and value are passed in
321 * the first argument as name=value. Since the first argument will
322 * be actually stored in the table, it should not be a string that
327 setvareq(char *s, int flags)
329 struct var *vp, **vpp;
334 if (forcelocal && !(flags & (VNOSET | VNOLOCAL)))
336 vp = find_var(s, &vpp, &nlen);
338 if (vp->flags & VREADONLY)
339 error("%.*s: is read only", vp->name_len, s);
344 if (vp->func && (flags & VNOFUNC) == 0)
345 (*vp->func)(s + vp->name_len + 1);
347 if ((vp->flags & (VTEXTFIXED|VSTACK)) == 0)
350 vp->flags &= ~(VTEXTFIXED|VSTACK|VUNSET);
355 * We could roll this to a function, to handle it as
356 * a regular variable function callback, but why bother?
358 * Note: this assumes iflag is not set to 1 initially.
359 * As part of init(), this is called before arguments
362 if ((vp == &vmpath || (vp == &vmail && ! mpathset())) &&
365 if ((vp->flags & VEXPORT) && localevar(s)) {
367 (void) setlocale(LC_ALL, "");
376 vp = ckmalloc(sizeof (*vp));
384 if ((vp->flags & VEXPORT) && localevar(s)) {
386 (void) setlocale(LC_ALL, "");
395 * Process a linked list of variable assignments.
399 listsetvar(struct strlist *list, int flags)
404 for (lp = list ; lp ; lp = lp->next) {
405 setvareq(savestr(lp->text), flags);
413 * Find the value of a variable. Returns NULL if not set.
417 lookupvar(const char *name)
421 v = find_var(name, NULL, NULL);
422 if (v == NULL || v->flags & VUNSET)
424 return v->text + v->name_len + 1;
430 * Search the environment of a builtin command. If the second argument
431 * is nonzero, return the value of a variable even if it hasn't been
436 bltinlookup(const char *name, int doall)
443 for (sp = cmdenviron ; sp ; sp = sp->next) {
444 if (varequal(sp->text, name))
445 result = strchr(sp->text, '=') + 1;
450 v = find_var(name, NULL, NULL);
451 if (v == NULL || v->flags & VUNSET ||
452 (!doall && (v->flags & VEXPORT) == 0))
454 return v->text + v->name_len + 1;
459 * Set up locale for a builtin (LANG/LC_* assignments).
469 for (lp = cmdenviron ; lp ; lp = lp->next) {
470 if (localevar(lp->text)) {
477 loc = bltinlookup("LC_ALL", 0);
480 setlocale(LC_ALL, loc);
485 locdef = bltinlookup("LANG", 0);
486 for (i = 0; locale_names[i] != NULL; i++) {
487 loc = bltinlookup(locale_names[i], 0);
491 setlocale(locale_categories[i], loc);
498 * Undo the effect of bltinlocaleset().
501 bltinunsetlocale(void)
506 for (lp = cmdenviron ; lp ; lp = lp->next) {
507 if (localevar(lp->text)) {
508 setlocale(LC_ALL, "");
517 * Update the localeisutf8 flag.
524 charset = nl_langinfo(CODESET);
525 localeisutf8 = !strcmp(charset, "UTF-8");
532 initial_localeisutf8 = localeisutf8;
536 * Generate a list of exported variables. This routine is used to construct
537 * the third argument to execve when executing a program.
549 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
550 for (vp = *vpp ; vp ; vp = vp->next)
551 if (vp->flags & VEXPORT)
554 ep = env = stalloc((nenv + 1) * sizeof *env);
555 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
556 for (vp = *vpp ; vp ; vp = vp->next)
557 if (vp->flags & VEXPORT)
566 var_compare(const void *a, const void *b)
568 const char *const *sa, *const *sb;
573 * This compares two var=value strings which creates a different
574 * order from what you would probably expect. POSIX is somewhat
575 * ambiguous on what should be sorted exactly.
577 return strcoll(*sa, *sb);
582 * Command to list all variables which are set. This is invoked from the
583 * set command when it is called without any options or operands.
587 showvarscmd(int argc __unused, char **argv __unused)
596 * POSIX requires us to sort the variables.
599 for (vpp = vartab; vpp < vartab + VTABSIZE; vpp++) {
600 for (vp = *vpp; vp; vp = vp->next) {
601 if (!(vp->flags & VUNSET))
607 vars = ckmalloc(n * sizeof(*vars));
609 for (vpp = vartab; vpp < vartab + VTABSIZE; vpp++) {
610 for (vp = *vpp; vp; vp = vp->next) {
611 if (!(vp->flags & VUNSET))
612 vars[i++] = vp->text;
616 qsort(vars, n, sizeof(*vars), var_compare);
617 for (i = 0; i < n; i++) {
619 * Skip improper variable names so the output remains usable as
622 if (!isassignment(vars[i]))
624 s = strchr(vars[i], '=');
626 outbin(vars[i], s - vars[i], out1);
639 * The export and readonly commands.
643 exportcmd(int argc, char **argv)
651 int flag = argv[0][0] == 'r'? VREADONLY : VEXPORT;
654 optreset = optind = 1;
657 while ((ch = getopt(argc, argv, "p")) != -1) {
664 error("unknown option: -%c", optopt);
670 if (values && argc != 0)
671 error("-p requires no arguments");
673 while ((name = *argv++) != NULL) {
674 if ((p = strchr(name, '=')) != NULL) {
677 vp = find_var(name, NULL, NULL);
680 if ((vp->flags & VEXPORT) && localevar(vp->text)) {
681 change_env(vp->text, 1);
682 (void) setlocale(LC_ALL, "");
688 setvar(name, p, flag);
691 for (vpp = vartab ; vpp < vartab + VTABSIZE ; vpp++) {
692 for (vp = *vpp ; vp ; vp = vp->next) {
693 if (vp->flags & flag) {
696 * Skip improper variable names
697 * so the output remains usable
700 if (!isassignment(vp->text))
705 if (values && !(vp->flags & VUNSET)) {
707 vp->name_len + 1, out1);
711 outbin(vp->text, vp->name_len,
723 * The "local" command.
727 localcmd(int argc __unused, char **argv __unused)
732 error("Not in a function");
733 while ((name = *argptr++) != NULL) {
741 * Make a variable a local variable. When a variable is made local, it's
742 * value and flags are saved in a localvar structure. The saved values
743 * will be restored when the shell function returns. We handle the name
744 * "-" as a special case.
750 struct localvar *lvp;
755 lvp = ckmalloc(sizeof (struct localvar));
756 if (name[0] == '-' && name[1] == '\0') {
757 lvp->text = ckmalloc(sizeof optlist);
758 memcpy(lvp->text, optlist, sizeof optlist);
761 vp = find_var(name, &vpp, NULL);
763 if (strchr(name, '='))
764 setvareq(savestr(name), VSTRFIXED | VNOLOCAL);
766 setvar(name, NULL, VSTRFIXED | VNOLOCAL);
767 vp = *vpp; /* the new variable */
771 lvp->text = vp->text;
772 lvp->flags = vp->flags;
773 vp->flags |= VSTRFIXED|VTEXTFIXED;
774 if (name[vp->name_len] == '=')
775 setvareq(savestr(name), VNOLOCAL);
779 lvp->next = localvars;
786 * Called after a function returns.
792 struct localvar *lvp;
795 while ((lvp = localvars) != NULL) {
796 localvars = lvp->next;
798 if (vp == NULL) { /* $- saved */
799 memcpy(optlist, lvp->text, sizeof optlist);
802 } else if ((lvp->flags & (VUNSET|VSTRFIXED)) == VUNSET) {
803 (void)unsetvar(vp->text);
805 if ((vp->flags & VTEXTFIXED) == 0)
807 vp->flags = lvp->flags;
808 vp->text = lvp->text;
816 setvarcmd(int argc, char **argv)
819 return unsetcmd(argc, argv);
821 setvar(argv[1], argv[2], 0);
823 error("too many arguments");
829 * The unset builtin command.
833 unsetcmd(int argc __unused, char **argv __unused)
841 while ((i = nextopt("vf")) != '\0') {
847 if (flg_func == 0 && flg_var == 0)
850 for (ap = argptr; *ap ; ap++) {
852 ret |= unsetfunc(*ap);
854 ret |= unsetvar(*ap);
861 * Unset the specified variable.
865 unsetvar(const char *s)
870 vp = find_var(s, &vpp, NULL);
873 if (vp->flags & VREADONLY)
876 if (vp->text[vp->name_len + 1] != '\0')
877 setvar(s, nullstr, 0);
878 if ((vp->flags & VEXPORT) && localevar(vp->text)) {
880 setlocale(LC_ALL, "");
883 vp->flags &= ~VEXPORT;
885 if ((vp->flags & VSTRFIXED) == 0) {
886 if ((vp->flags & VTEXTFIXED) == 0)
898 * Returns true if the two strings specify the same varable. The first
899 * variable name is terminated by '='; the second may be terminated by
900 * either '=' or '\0'.
904 varequal(const char *p, const char *q)
910 if (*p == '=' && *(q - 1) == '\0')
916 * Search for a variable.
917 * 'name' may be terminated by '=' or a NUL.
918 * vppp is set to the pointer to vp, or the list head if vp isn't found
919 * lenp is set to the number of charactets in 'name'
923 find_var(const char *name, struct var ***vppp, int *lenp)
925 unsigned int hashval;
927 struct var *vp, **vpp;
928 const char *p = name;
931 while (*p && *p != '=')
932 hashval = 2 * hashval + (unsigned char)*p++;
937 vpp = &vartab[hashval % VTABSIZE];
941 for (vp = *vpp ; vp ; vpp = &vp->next, vp = *vpp) {
942 if (vp->name_len != len)
944 if (memcmp(vp->text, name, len) != 0)