OILS / core / runtime.asdl View on Github | oilshell.org

188 lines, 80 significant
1# Data types used at runtime
2
3module runtime
4{
5 # import from frontend/syntax.asdl
6 use frontend syntax {
7 loc Token
8 expr word command
9 CompoundWord DoubleQuoted
10 ArgList re redir_loc proc_sig
11 Func
12 }
13
14 use core value {
15 value Obj
16 }
17
18 # Evaluating SimpleCommand results in either an argv array or an assignment.
19 # in 'local foo', rval is None.
20 AssignArg = (str var_name, value? rval, bool plus_eq, CompoundWord blame_word)
21
22 ProcArgs = (
23 # Unevaluated args
24 ArgList typed_args,
25
26 # Evaluated args, similar to typed_args.py Reader
27 List[value]? pos_args, Dict[str, value]? named_args,
28
29 # block_arg comes from either p (; ; myblock) or p { echo b }
30 value? block_arg
31 )
32
33 # note: could import 'builtin' from synthetic option_asdl
34 cmd_value =
35 Argv(List[str] argv, List[CompoundWord] arg_locs,
36 bool is_last_cmd,
37 Obj? self_obj, ProcArgs? proc_args)
38
39 | Assign(int builtin_id,
40 List[str] argv, List[CompoundWord] arg_locs,
41 List[AssignArg] pairs)
42
43 # - Single or double quoted parts get neither split or globbed.
44 # - Bare words like echo or *.py are globbed, but NOT split with IFS.
45 # - Unquoted Substitutions are split and globbed.
46 Piece = (str s, bool quoted, bool do_split)
47
48 # A parse-time word_part from syntax.asdl is evaluated to a runtime
49 # part_value.
50 part_value =
51 String %Piece
52
53 # "$@" or "${a[@]}" # never globbed or split (though other shells
54 # split them)
55 | Array(List[str] strs)
56 # only produced when EXTGLOB_FS flag is passed
57 | ExtGlob(List[part_value] part_vals)
58
59 coerced = Int | Float | Neither
60
61 # evaluation state for BracedVarSub
62 VarSubState = (bool join_array, bool is_type_query, bool has_test_op)
63
64 # A Cell is a wrapper for a value.
65 # TODO: add location for declaration for 'assigning const' error
66
67 # Invariant: if exported or nameref is set, the val should be Str or Undef.
68 # This is enforced in mem.SetValue but isn't expressed in the schema.
69 Cell = (bool exported, bool readonly, bool nameref, value val)
70
71 # Where scopes are used
72 # Shopt: to respect shopt -u dynamic_scope.
73 # GetValue: Dynamic or LocalOrGlobal
74 # SetValue: Dynamic or LocalOnly
75 # Dynamic:
76 # GetValue: Shell Style
77 # SetValue: Shell Style
78 # LocalOrGlobal:
79 # GetValue: YSH style
80 # SetValue: N/A
81 # LocalOnly:
82 # GetValue: N/A, we can always READ globals
83 # SetValue: setvar, parameter bindings, for loop iterator vars
84 # GlobalOnly:
85 # GetValue: N/A
86 # SetValue: internal use in COMPREPLY, and YSH 'setglobal' keyword
87
88 # TODO: Avoid mutating __builtins__? This could be illegal:
89 #
90 # setvar io.glob = 'foo'
91 #
92 # Instead of LocalOnly, GlobalOnly, have MutateLocalOnly, MutateGlobalOnly?
93 # So they don't find the 'io' or 'vm' builtin Objs
94
95 scope = Shopt | Dynamic | LocalOrGlobal | LocalOnly | GlobalOnly
96
97 # What is valid in arrays or assoc arrays a[i] or A[i] in shell.
98 # Used for ${a[i]=x}.
99 a_index = Str(str s) | Int(int i)
100
101 # For the place in ${a[0]=a}
102 # Transformed into sh_lvalue_t
103 VTestPlace = (str? name, a_index? index)
104
105 redirect_arg =
106 Path(str filename)
107 | CopyFd(int target_fd)
108 | MoveFd(int target_fd) # 3>&1-
109 | CloseFd
110 | HereDoc(str body) # call this String and combine with Path?
111
112 # Evaluated version of syntax.Redir
113 RedirValue = (id op_id, loc op_loc, redir_loc loc, redirect_arg arg)
114
115 # An exit status with location info. For process sub.
116 StatusArray = (
117 List[int]? codes, # init to null, rarely allocated
118 List[loc]? locs # init to null, rarely allocated
119 )
120
121 CommandStatus = (
122 # set for atoms
123 bool check_errexit,
124
125 # By default, don't show the code on errexit. Sometimes we want to.
126 bool show_code
127
128 # Should we use 'int simple_status' for atoms like atoms like ls (( [[ ?
129
130 # for pipeline
131 bool pipe_negated,
132 List[int]? pipe_status, # init to null, rarely allocated
133 List[loc]? pipe_locs, # init to null, rarely allocated
134 )
135
136 wait_status =
137 Proc(int code)
138 | Pipeline(List[int] codes)
139 # because the 'wait' builtin is interruptible
140 | Cancelled(int sig_num)
141
142 flow = Nothing | Break | Raise
143
144 # For word splitting (in frontend/consts.py and osh/split.py)
145 span = Black | Delim | Backslash
146
147 emit = Part | Delim | Empty | Escape | Nothing
148 generate [integers]
149 state = Invalid | Start | DE_White1 | DE_Gray | DE_White2 | Black | Backslash | Done
150 generate [integers]
151
152 # Edges are characters. DE_ is the delimiter prefix. DE_White is for
153 # whitespace; DE_Gray is for other IFS chars; Black is for significant
154 # characters. Sentinel is the end of the string.
155 char_kind = DE_White | DE_Gray | Black | Backslash | Sentinel
156 generate [integers]
157
158 # core/process.py
159 # A Job is a Process or Pipeline.
160 # - Processes usually go from Running to Stopped, unless unless Ctrl-Z stops
161 # them.
162 # - Pipelines go Running to Done. They are never stopped; only the processes
163 # inside them are stopped.
164 job_state = Running | Done | Stopped
165
166 # Flag arguments can be any of these types.
167 flag_type = Bool | Int | Float | Str
168
169 # For dev.Tracer
170 trace =
171 External(List[str] argv) # sync, needs argv (command.Simple or 'command')
172 | CommandSub # sync
173 | ForkWait # sync
174 | Fork # async, needs argv, & fork
175 | PipelinePart # async
176 | ProcessSub # async (other processes can be started)
177 | HereDoc # async (multiple here docs per process)
178
179 # tools/ysh_ify.py
180 word_style = Expr | Unquoted | DQ | SQ
181
182 # Hay "first word" namespace
183 HayNode = (Dict[str, HayNode] children)
184
185 comp_action = Other | FileSystem | BashFunc
186}
187
188# vim: sw=2