options.h revision 1.26
1/*	$NetBSD: options.h,v 1.26 2017/05/18 13:53:18 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 *	@(#)options.h	8.2 (Berkeley) 5/4/95
35 */
36
37struct shparam {
38	int nparam;		/* # of positional parameters (without $0) */
39	unsigned char malloc;	/* if parameter list dynamically allocated */
40	unsigned char reset;	/* if getopts has been reset */
41	char **p;		/* parameter list */
42	char **optnext;		/* next parameter to be processed by getopts */
43	char *optptr;		/* used by getopts */
44};
45
46/*
47 * Note that option default values can be changed at shell startup
48 * depending upon the environment in which the shell is running.
49 */
50struct optent {
51	const char *name;		/* for set -o <name> */
52	const char letter;		/* set [+/-]<letter> and $- */
53	const char opt_set;		/* mutually exclusive option set */
54	unsigned char val;		/* value of <letter>flag */
55	unsigned char dflt;		/* default value of flag */
56};
57
58/* Those marked [U] are required by posix, but have no effect! */
59
60#ifdef DEFINE_OPTIONS
61#define DEF_OPTS_D(name,letter,opt_set,dflt) {name, letter, opt_set, 0, dflt },
62struct optent optlist[] = {
63#else
64#define DEF_OPTS_D(name,letter,opt_set,dflt)
65#endif
66#define DEF_OPTS(name,letter,opt_set)	DEF_OPTS_D(name, letter, opt_set, 0)
67#define DEF_OPT(name,letter)		DEF_OPTS_D(name, letter, 0, 0)
68#define DEF_OPT_D(name,letter,dflt)	DEF_OPTS_D(name, letter, 0, dflt)
69
70DEF_OPT( "errexit",	'e' )	/* exit on error */
71#define eflag optlist[0].val
72DEF_OPT( "noglob",	'f' )	/* no pathname expansion */
73#define fflag optlist[1].val
74DEF_OPT( "ignoreeof",	'I' )	/* do not exit on EOF */
75#define Iflag optlist[2].val
76DEF_OPT( "interactive",'i' )	/* interactive shell */
77#define iflag optlist[3].val
78DEF_OPT( "monitor",	'm' )	/* job control */
79#define mflag optlist[4].val
80DEF_OPT( "noexec",	'n' )	/* do not exec commands */
81#define nflag optlist[5].val
82DEF_OPT( "stdin",	's' )	/* read from stdin */
83#define sflag optlist[6].val
84DEF_OPT( "xtrace",	'x' )	/* trace after expansion */
85#define xflag optlist[7].val
86DEF_OPT( "verbose",	'v' )	/* trace read input */
87#define vflag optlist[8].val
88DEF_OPTS( "vi",		'V', 'V' )	/* vi style editing */
89#define Vflag optlist[9].val
90DEF_OPTS( "emacs",	'E', 'V' )	/* emacs style editing */
91#define	Eflag optlist[10].val
92DEF_OPT( "noclobber",	'C' )	/* do not overwrite files with > */
93#define	Cflag optlist[11].val
94DEF_OPT( "allexport",	'a' )	/* export all variables */
95#define	aflag optlist[12].val
96DEF_OPT( "notify",	'b' )	/* [U] report completion of background jobs */
97#define	bflag optlist[13].val
98DEF_OPT( "nounset",	'u' )	/* error expansion of unset variables */
99#define	uflag optlist[14].val
100DEF_OPT( "quietprofile", 'q' )
101#define	qflag optlist[15].val
102DEF_OPT( "nolog",	0 )	/* [U] no functon defs in command history */
103#define	nolog optlist[16].val
104DEF_OPT( "cdprint",	0 )	/* always print result of cd */
105#define	cdprint optlist[17].val
106DEF_OPT( "tabcomplete",	0 )	/* <tab> causes filename expansion */
107#define	tabcomplete optlist[18].val
108DEF_OPT( "fork",	'F' )	/* use fork(2) instead of vfork(2) */
109#define	usefork optlist[19].val
110DEF_OPT( "nopriv",	'p' )	/* preserve privs even if set{u,g}id */
111#define	pflag optlist[20].val
112DEF_OPT( "trackall",	'h' )	/* [U] locate cmds in funcs when defined */
113#define	hflag optlist[21].val
114DEF_OPT( "posix",	0  )	/* operate in posix mode */
115#define	posix optlist[22].val
116#ifdef DEBUG
117DEF_OPT( "debug",	0 )	/* enable debug prints */
118#define	debug optlist[23].val
119#endif
120
121#ifdef DEFINE_OPTIONS
122	{ 0, 0, 0, 0, 0 },
123};
124#define NOPTS (sizeof optlist / sizeof optlist[0] - 1)
125int sizeof_optlist = sizeof optlist;
126#else
127extern struct optent optlist[];
128extern int sizeof_optlist;
129#endif
130
131
132extern char *minusc;		/* argument to -c option */
133extern char *arg0;		/* $0 */
134extern struct shparam shellparam;  /* $@ */
135extern char **argptr;		/* argument list for builtin commands */
136extern char *optionarg;		/* set by nextopt */
137extern char *optptr;		/* used by nextopt */
138
139void procargs(int, char **);
140void optschanged(void);
141void setparam(char **);
142void freeparam(volatile struct shparam *);
143int nextopt(const char *);
144void getoptsreset(const char *);
145