[dragonfly.git] / bin / sh / var.h

/*-
 * Copyright (c) 1991, 1993
 *	The Regents of the University of California.  All rights reserved.
 *
 * This code is derived from software contributed to Berkeley by
 * Kenneth Almquist.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by the University of
 *	California, Berkeley and its contributors.
 * 4. Neither the name of the University nor the names of its contributors
 *    may be used to endorse or promote products derived from this software
 *    without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 *	@(#)var.h	8.2 (Berkeley) 5/4/95
 * $FreeBSD: src/bin/sh/var.h,v 1.23 2011/06/12 23:06:04 jilles Exp $
 */

/*
 * Shell variables.
 */

/* flags */
#define VEXPORT		0x01	/* variable is exported */
#define VREADONLY	0x02	/* variable cannot be modified */
#define VSTRFIXED	0x04	/* variable struct is statically allocated */
#define VTEXTFIXED	0x08	/* text is statically allocated */
#define VSTACK		0x10	/* text is allocated on the stack */
#define VUNSET		0x20	/* the variable is not set */
#define VNOFUNC		0x40	/* don't call the callback function */
#define VNOSET		0x80	/* do not set variable - just readonly test */
#define VNOLOCAL	0x100	/* ignore forcelocal */


struct var {
	struct var *next;		/* next entry in hash list */
	int flags;			/* flags are defined above */
	int name_len;			/* length of name */
	char *text;			/* name=value */
	void (*func)(const char *);
					/* function to be called when  */
					/* the variable gets set/unset */
};


struct localvar {
	struct localvar *next;		/* next local variable in list */
	struct var *vp;			/* the variable that was made local */
	int flags;			/* saved flags */
	char *text;			/* saved text */
};


struct localvar *localvars;
extern int forcelocal;

extern struct var vifs;
extern struct var vmail;
extern struct var vmpath;
extern struct var vpath;
extern struct var vppid;
extern struct var vps1;
extern struct var vps2;
extern struct var vps4;
#ifndef NO_HISTORY
extern struct var vhistsize;
extern struct var vterm;
#endif

extern int localeisutf8;
/* The parser uses the locale that was in effect at startup. */
extern int initial_localeisutf8;

/*
 * The following macros access the values of the above variables.
 * They have to skip over the name.  They return the null string
 * for unset variables.
 */

#define ifsval()	(vifs.text + 4)
#define ifsset()	((vifs.flags & VUNSET) == 0)
#define mailval()	(vmail.text + 5)
#define mpathval()	(vmpath.text + 9)
#define pathval()	(vpath.text + 5)
#define ps1val()	(vps1.text + 4)
#define ps2val()	(vps2.text + 4)
#define ps4val()	(vps4.text + 4)
#define optindval()	(voptind.text + 7)
#ifndef NO_HISTORY
#define histsizeval()	(vhistsize.text + 9)
#define termval()	(vterm.text + 5)
#endif

#define mpathset()	((vmpath.flags & VUNSET) == 0)

void initvar(void);
void setvar(const char *, const char *, int);
void setvareq(char *, int);
struct strlist;
void listsetvar(struct strlist *, int);
char *lookupvar(const char *);
char *bltinlookup(const char *, int);
void bltinsetlocale(void);
void bltinunsetlocale(void);
void updatecharset(void);
void initcharset(void);
char **environment(void);
int showvarscmd(int, char **);
int exportcmd(int, char **);
int localcmd(int, char **);
void mklocal(char *);
void poplocalvars(void);
int setvarcmd(int, char **);
int unsetcmd(int, char **);
int unsetvar(const char *);
int setvarsafe(const char *, const char *, int);
Commit	Line	Data
984263bc MD	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
32931063	37	* $FreeBSD: src/bin/sh/var.h,v 1.23 2011/06/12 23:06:04 jilles Exp $
984263bc MD	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 */
84a135da PA	47	#define VSTRFIXED 0x04 /* variable struct is statically allocated */
84a135da PA	48	#define VTEXTFIXED 0x08 /* text is statically allocated */
984263bc MD	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 */
99512ac4	52	#define VNOSET 0x80 /* do not set variable - just readonly test */
32931063	53	#define VNOLOCAL 0x100 /* ignore forcelocal */
984263bc MD	54
	55
	56	struct var {
	57	struct var next; / next entry in hash list */
	58	int flags; /* flags are defined above */
7ea41a21	59	int name_len; /* length of name */
984263bc MD	60	char text; / name=value */
	61	void (func)(const char );
	62	/* function to be called when */
	63	/* the variable gets set/unset */
	64	};
	65
	66
	67	struct localvar {
	68	struct localvar next; / next local variable in list */
	69	struct var vp; / the variable that was made local */
	70	int flags; /* saved flags */
	71	char text; / saved text */
	72	};
	73
	74
	75	struct localvar *localvars;
32931063	76	extern int forcelocal;
984263bc	77
984263bc MD	78	extern struct var vifs;
	79	extern struct var vmail;
	80	extern struct var vmpath;
	81	extern struct var vpath;
	82	extern struct var vppid;
	83	extern struct var vps1;
	84	extern struct var vps2;
0d5aaed6	85	extern struct var vps4;
984263bc MD	86	#ifndef NO_HISTORY
984263bc MD	87	extern struct var vhistsize;
99512ac4	88	extern struct var vterm;
984263bc MD	89	#endif
984263bc MD	90
be4e801b	91	extern int localeisutf8;
145a4981 PA	92	/* The parser uses the locale that was in effect at startup. */
145a4981 PA	93	extern int initial_localeisutf8;
be4e801b	94
984263bc MD	95	/*
	96	* The following macros access the values of the above variables.
	97	* They have to skip over the name. They return the null string
	98	* for unset variables.
	99	*/
	100
	101	#define ifsval() (vifs.text + 4)
	102	#define ifsset() ((vifs.flags & VUNSET) == 0)
	103	#define mailval() (vmail.text + 5)
	104	#define mpathval() (vmpath.text + 9)
	105	#define pathval() (vpath.text + 5)
	106	#define ps1val() (vps1.text + 4)
	107	#define ps2val() (vps2.text + 4)
0d5aaed6	108	#define ps4val() (vps4.text + 4)
984263bc MD	109	#define optindval() (voptind.text + 7)
	110	#ifndef NO_HISTORY
	111	#define histsizeval() (vhistsize.text + 9)
99512ac4	112	#define termval() (vterm.text + 5)
984263bc MD	113	#endif
984263bc MD	114
984263bc MD	115	#define mpathset() ((vmpath.flags & VUNSET) == 0)
	116
	117	void initvar(void);
492efe05	118	void setvar(const char , const char , int);
984263bc MD	119	void setvareq(char *, int);
984263bc MD	120	struct strlist;
99512ac4	121	void listsetvar(struct strlist *, int);
492efe05 CP	122	char lookupvar(const char );
492efe05 CP	123	char bltinlookup(const char , int);
99512ac4 PA	124	void bltinsetlocale(void);
99512ac4 PA	125	void bltinunsetlocale(void);
be4e801b	126	void updatecharset(void);
145a4981	127	void initcharset(void);
984263bc	128	char **environment(void);
984263bc MD	129	int showvarscmd(int, char **);
	130	int exportcmd(int, char **);
	131	int localcmd(int, char **);
	132	void mklocal(char *);
	133	void poplocalvars(void);
	134	int setvarcmd(int, char **);
	135	int unsetcmd(int, char **);
492efe05 CP	136	int unsetvar(const char *);
492efe05 CP	137	int setvarsafe(const char , const char , int);