xref: /freebsd/bin/sh/parser.h (revision 09a53ad8f1318c5daae6cfb19d97f4f6459f0013)
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  * 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.
19  *
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
30  * SUCH DAMAGE.
31  *
32  *	@(#)parser.h	8.3 (Berkeley) 5/4/95
33  * $FreeBSD$
34  */
35 
36 /* control characters in argument strings */
37 #define CTLESC '\300'
38 #define CTLVAR '\301'
39 #define CTLENDVAR '\371'
40 #define CTLBACKQ '\372'
41 #define CTLQUOTE 01		/* ored with CTLBACKQ code if in quotes */
42 /*	CTLBACKQ | CTLQUOTE == '\373' */
43 #define	CTLARI	'\374'
44 #define	CTLENDARI '\375'
45 #define	CTLQUOTEMARK '\376'
46 #define	CTLQUOTEEND '\377' /* only for ${v+-...} */
47 
48 /* variable substitution byte (follows CTLVAR) */
49 #define VSTYPE		0x0f	/* type of variable substitution */
50 #define VSNUL		0x10	/* colon--treat the empty string as unset */
51 #define VSLINENO	0x20	/* expansion of $LINENO, the line number \
52 				   follows immediately */
53 #define VSQUOTE		0x80	/* inside double quotes--suppress splitting */
54 
55 /* values of VSTYPE field */
56 #define VSNORMAL	0x1		/* normal variable:  $var or ${var} */
57 #define VSMINUS		0x2		/* ${var-text} */
58 #define VSPLUS		0x3		/* ${var+text} */
59 #define VSQUESTION	0x4		/* ${var?message} */
60 #define VSASSIGN	0x5		/* ${var=text} */
61 #define VSTRIMLEFT	0x6		/* ${var#pattern} */
62 #define VSTRIMLEFTMAX	0x7		/* ${var##pattern} */
63 #define VSTRIMRIGHT	0x8		/* ${var%pattern} */
64 #define VSTRIMRIGHTMAX 	0x9		/* ${var%%pattern} */
65 #define VSLENGTH	0xa		/* ${#var} */
66 #define VSERROR		0xb		/* Syntax error, issue when expanded */
67 
68 
69 /*
70  * NEOF is returned by parsecmd when it encounters an end of file.  It
71  * must be distinct from NULL.
72  */
73 #define NEOF ((union node *)-1)
74 extern int whichprompt;		/* 1 == PS1, 2 == PS2 */
75 extern const char *const parsekwd[];
76 
77 
78 union node *parsecmd(int);
79 union node *parsewordexp(void);
80 void forcealias(void);
81 void fixredir(union node *, const char *, int);
82 int goodname(const char *);
83 int isassignment(const char *);
84 char *getprompt(void *);
85 const char *expandstr(const char *);
86