[apple/shell_cmds.git] / sh / nodetypes

#-
# 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. 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.
#
#	@(#)nodetypes	8.2 (Berkeley) 5/4/95
# $FreeBSD: head/bin/sh/nodetypes 314436 2017-02-28 23:42:47Z imp $

# This file describes the nodes used in parse trees.  Unindented lines
# contain a node type followed by a structure tag.  Subsequent indented
# lines specify the fields of the structure.  Several node types can share
# the same structure, in which case the fields of the structure should be
# specified only once.
#
# A field of a structure is described by the name of the field followed
# by a type.  The currently implemented types are:
#	nodeptr - a pointer to a node
#	nodelist - a pointer to a list of nodes
#	string - a pointer to a nul terminated string
#	int - an integer
#	other - any type that can be copied by assignment
#	temp - a field that doesn't have to be copied when the node is copied
# The last two types should be followed by the text of a C declaration for
# the field.

NSEMI nbinary			# two commands separated by a semicolon
	type	  int
	ch1	  nodeptr		# the first child
	ch2	  nodeptr		# the second child

NCMD ncmd			# a simple command
	type	  int
	args	  nodeptr		# the arguments
	redirect  nodeptr		# list of file redirections

NPIPE npipe			# a pipeline
	type	  int
	backgnd	  int			# set to run pipeline in background
	cmdlist	  nodelist		# the commands in the pipeline

NREDIR nredir			# redirection (of a compex command)
	type	  int
	n	  nodeptr		# the command
	redirect  nodeptr		# list of file redirections

NBACKGND nredir			# run command in background
NSUBSHELL nredir		# run command in a subshell

NAND nbinary			# the && operator
NOR nbinary			# the || operator

NIF nif				# the if statement.  Elif clauses are handled
	type	  int		    # using multiple if nodes.
	test	  nodeptr		# if test
	ifpart	  nodeptr		# then ifpart
	elsepart  nodeptr		# else elsepart

NWHILE nbinary			# the while statement.  First child is the test
NUNTIL nbinary			# the until statement

NFOR nfor			# the for statement
	type	  int
	args	  nodeptr		# for var in args
	body	  nodeptr		# do body; done
	var	  string		# the for variable

NCASE ncase			# a case statement
	type	  int
	expr	  nodeptr		# the word to switch on
	cases	  nodeptr		# the list of cases (NCLIST nodes)

NCLIST nclist			# a case ending with ;;
	type	  int
	next	  nodeptr		# the next case in list
	pattern	  nodeptr		# list of patterns for this case
	body	  nodeptr		# code to execute for this case

NCLISTFALLTHRU nclist		# a case ending with ;&

NDEFUN narg			# define a function.  The "next" field contains
				# the body of the function.

NARG narg			# represents a word
	type	  int
	next	  nodeptr		# next word in list
	text	  string		# the text of the word
	backquote nodelist		# list of commands in back quotes

NTO nfile			# fd> fname
NFROM nfile			# fd< fname
NFROMTO nfile			# fd<> fname
NAPPEND nfile			# fd>> fname
NCLOBBER nfile			# fd>| fname
	type	  int
	fd	  int			# file descriptor being redirected
	next	  nodeptr		# next redirection in list
	fname	  nodeptr		# file name, in a NARG node
	expfname  temp	char *expfname	# actual file name

NTOFD ndup			# fd<&dupfd
NFROMFD ndup			# fd>&dupfd
	type	  int
	fd	  int			# file descriptor being redirected
	next	  nodeptr		# next redirection in list
	dupfd	  int			# file descriptor to duplicate
	vname	  nodeptr		# file name if fd>&$var


NHERE nhere			# fd<<\!
NXHERE nhere			# fd<<!
	type	  int
	fd	  int			# file descriptor being redirected
	next	  nodeptr		# next redirection in list
	doc	  nodeptr		# input to command (NARG node)
	expdoc    temp	const char *expdoc	# actual document (for NXHERE)

NNOT nnot			# ! command  (actually pipeline)
	type	int
	com	nodeptr
Commit	Line	Data
71aad674 A	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.
254f12f7	16	# 3. Neither the name of the University nor the names of its contributors
71aad674 A	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	# @(#)nodetypes 8.2 (Berkeley) 5/4/95
254f12f7	33	# $FreeBSD: head/bin/sh/nodetypes 314436 2017-02-28 23:42:47Z imp $
71aad674 A	34
	35	# This file describes the nodes used in parse trees. Unindented lines
	36	# contain a node type followed by a structure tag. Subsequent indented
	37	# lines specify the fields of the structure. Several node types can share
	38	# the same structure, in which case the fields of the structure should be
	39	# specified only once.
	40	#
	41	# A field of a structure is described by the name of the field followed
	42	# by a type. The currently implemented types are:
	43	# nodeptr - a pointer to a node
	44	# nodelist - a pointer to a list of nodes
	45	# string - a pointer to a nul terminated string
	46	# int - an integer
	47	# other - any type that can be copied by assignment
	48	# temp - a field that doesn't have to be copied when the node is copied
	49	# The last two types should be followed by the text of a C declaration for
	50	# the field.
	51
	52	NSEMI nbinary # two commands separated by a semicolon
	53	type int
	54	ch1 nodeptr # the first child
	55	ch2 nodeptr # the second child
	56
	57	NCMD ncmd # a simple command
	58	type int
	59	args nodeptr # the arguments
	60	redirect nodeptr # list of file redirections
	61
	62	NPIPE npipe # a pipeline
	63	type int
	64	backgnd int # set to run pipeline in background
	65	cmdlist nodelist # the commands in the pipeline
	66
	67	NREDIR nredir # redirection (of a compex command)
	68	type int
	69	n nodeptr # the command
	70	redirect nodeptr # list of file redirections
	71
	72	NBACKGND nredir # run command in background
	73	NSUBSHELL nredir # run command in a subshell
	74
	75	NAND nbinary # the && operator
	76	NOR nbinary # the \|\| operator
	77
	78	NIF nif # the if statement. Elif clauses are handled
	79	type int # using multiple if nodes.
	80	test nodeptr # if test
	81	ifpart nodeptr # then ifpart
	82	elsepart nodeptr # else elsepart
	83
	84	NWHILE nbinary # the while statement. First child is the test
	85	NUNTIL nbinary # the until statement
	86
	87	NFOR nfor # the for statement
	88	type int
	89	args nodeptr # for var in args
	90	body nodeptr # do body; done
	91	var string # the for variable
	92
	93	NCASE ncase # a case statement
	94	type int
	95	expr nodeptr # the word to switch on
	96	cases nodeptr # the list of cases (NCLIST nodes)
	97
98	NCLIST nclist # a case ending with ;;
99	type int
100	next nodeptr # the next case in list
101	pattern nodeptr # list of patterns for this case
102	body nodeptr # code to execute for this case
103
104	NCLISTFALLTHRU nclist # a case ending with ;&
105
106	NDEFUN narg # define a function. The "next" field contains
107	# the body of the function.
108
109	NARG narg # represents a word
110	type int
111	next nodeptr # next word in list
112	text string # the text of the word
113	backquote nodelist # list of commands in back quotes
114
115	NTO nfile # fd> fname
116	NFROM nfile # fd< fname
117	NFROMTO nfile # fd<> fname
118	NAPPEND nfile # fd>> fname
119	NCLOBBER nfile # fd>\| fname
120	type int
121	fd int # file descriptor being redirected
122	next nodeptr # next redirection in list
123	fname nodeptr # file name, in a NARG node
124	expfname temp char *expfname # actual file name
125
126	NTOFD ndup # fd<&dupfd
127	NFROMFD ndup # fd>&dupfd
128	type int
129	fd int # file descriptor being redirected
130	next nodeptr # next redirection in list
131	dupfd int # file descriptor to duplicate
132	vname nodeptr # file name if fd>&$var
133
134
135	NHERE nhere # fd<<\!
136	NXHERE nhere # fd<<!
137	type int
138	fd int # file descriptor being redirected
139	next nodeptr # next redirection in list
140	doc nodeptr # input to command (NARG node)
141	expdoc temp const char *expdoc # actual document (for NXHERE)
142
143	NNOT nnot # ! command (actually pipeline)
144	type int
145	com nodeptr