master xplshn/aruu / cmd / posix / sh / parser.h
 1/*-
 2 * SPDX-License-Identifier: BSD-3-Clause
 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
35/* control characters in argument strings */
36#define CTLESC    '\300'
37#define CTLVAR    '\301'
38#define CTLENDVAR '\371'
39#define CTLBACKQ  '\372'
40#define CTLQUOTE  01 /* ored with CTLBACKQ code if in quotes */
41/*	CTLBACKQ | CTLQUOTE == '\373' */
42#define CTLARI       '\374'
43#define CTLENDARI    '\375'
44#define CTLQUOTEMARK '\376'
45#define CTLQUOTEEND  '\377' /* only for ${v+-...} */
46
47/* variable substitution byte (follows CTLVAR) */
48#define VSTYPE 0x0f /* type of variable substitution */
49#define VSNUL  0x10 /* colon--treat the empty string as unset */
50#define VSLINENO                                                                                   \
51  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 * NEOF is returned by parsecmd when it encounters an end of file.  It
70 * must be distinct from NULL.
71 */
72#define NEOF ((union node *)-1)
73extern int               whichprompt; /* 1 == PS1, 2 == PS2 */
74extern const char *const parsekwd[];
75
76union node *parsecmd(int);
77union node *parsewordexp(void);
78void        forcealias(void);
79void        fixredir(union node *, const char *, int);
80int         goodname(const char *);
81int         isassignment(const char *);
82char       *getprompt(void *);
83const char *expandstr(const char *);