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

183 lines, 75 significant
1# Runtime value
2
3module value
4{
5 # import from frontend/syntax.asdl
6 use frontend syntax {
7 loc Token
8 expr command
9 DoubleQuoted
10 re proc_sig
11 LiteralBlock Func
12 NameType
13 EggexFlag
14 }
15
16 use core runtime {
17 Cell
18 }
19
20 IntBox = (int i)
21
22 ProcDefaults = (
23 List[value]? for_word, # all of them are value.Str
24 List[value]? for_typed,
25 Dict[str, value]? for_named,
26 value? for_block,
27 )
28
29 LeftName = (str name, loc blame_loc)
30
31 # for setvar, and value.Place
32 y_lvalue =
33 # e.g. read (&x)
34 Local %LeftName
35 # e.g. &a[0][1].key -- we evaluate a[0][1] first
36 | Container(value obj, value index)
37
38 # An sh_lvalue is for things mutation that happen with dynamic scope
39 #
40 # - sh_expr_eval uses this for unset / printf -v
41 # - word_eval uses this for ${a[0]=}
42 # - expr_eval / cmd_eval use this for setvar a[i] = 42
43 sh_lvalue =
44 Var %LeftName
45 | Indexed(str name, int index, loc blame_loc)
46 | Keyed(str name, str key, loc blame_loc)
47
48 eggex_ops =
49 # for BASH_REMATCH or ~ with a string
50 No
51 # These lists are indexed by group number, and will have None entries
52 | Yes(List[value?] convert_funcs, List[Token?] convert_toks,
53 List[str?] capture_names)
54
55 RegexMatch = (str s, List[int] indices, eggex_ops ops)
56
57 regex_match =
58 No
59 | Yes %RegexMatch
60
61 # prototype is for the attribute lookup chain
62 Dict_ = (Dict[str, value] d, Dict_? prototype)
63 Obj = (Dict[str, value] d, Obj? prototype)
64
65 # Commands, words, and expressions from syntax.asdl are evaluated to a VALUE.
66 # value_t instances are stored in state.Mem().
67 value =
68 # Only used for val_ops.StdinIterator. (It would be nice if we could
69 # express iter_value.{Eof,Interrupted,Str,Int,...} in ASDL)
70 Interrupted
71 | Stdin
72
73 # Methods on state.Mem return value.Undef, but it's not visible in YSH.
74 #
75 # A var bound to Undef is different than no binding because of dynamic
76 # scope. Undef can shadow values lower on the stack.
77 | Undef
78
79 | Str(str s)
80
81 # "holes" in the array are represented by None
82 | BashArray(List[str] strs)
83 # TODO: Switch to this more efficient representation?
84 # max_index makes append-sparse workload faster, and normal append loops too
85 | SparseArray(Dict[BigInt, str] d, BigInt max_index)
86
87 | BashAssoc(Dict[str, str] d)
88
89 # DATA model for YSH follows JSON. Note: YSH doesn't have 'undefined' and
90 # 'null' like JavaScript, just 'null'.
91 | Null
92 | Bool(bool b)
93 | Int(BigInt i)
94 #| Int(int i)
95 | Float(float f)
96 | List(List[value] items)
97 | Dict %Dict_
98
99 # for polymorphism - should replace value.{IO,Module} too
100 # because they have attributes (functions), methods - not just methods
101 | Obj %Obj
102
103 # CODE types
104 # unevaluated: Eggex, Expr, Template, Command/Block
105 # callable, in separate namespaces: Func, BoundFunc, Proc
106
107 # expr is spliced
108 # / d+; ignorecase / -> '[[:digit:]]+' REG_ICASE
109 | Eggex(re spliced, str canonical_flags,
110 List[value?] convert_funcs, List[Token?] convert_toks,
111 # str? is because some groups are not named
112 str? as_ere, List[str?] capture_names)
113
114 # The indices list has 2 * (num_group + 1) entries. Group 0 is the whole
115 # match, and each group has both a start and end index.
116 # It's flat to reduce allocations. The group() start() end() funcs/methods
117 # provide a nice interface.
118 | Match %RegexMatch
119
120 # ^[42 + a[i]]
121 | Expr(expr e)
122
123 # ^(echo 1; echo 2) and cd { echo 1; echo 2 }
124 | Command(command c)
125
126 # for Hay to get the backing lines
127 # TODO: Consolidate value.Command and value.LiteralBlock. All Command
128 # instance should have backing lines.
129
130 # TODO: ASDL doesn't support shared variant across module
131 # This would be more efficient
132 # | LiteralBlock %LiteralBlock
133 | Block(LiteralBlock block)
134
135 # A place has an additional stack frame where the value is evaluated.
136 # The frame MUST be lower on the stack at the time of use.
137 | Place(y_lvalue lval, Dict[str, Cell] frame)
138
139 # for Flags/flag and Flags/arg?
140 # for json read/write ?
141 # Possibly unify Hay and modules/namespaces
142 | Module(Dict[str, value] defs)
143
144 # The ability to use operating system functions. Right now some functions
145 # leak, like glob().
146 | IO(any cmd_ev, any prompt_ev)
147
148 # Do we need this?
149 # _guts->heapId() can be used to detect object cycles.
150 # It's considered impure; it depends on VM implementation details. The =
151 # operator and 'pp value' also print the heap ID.
152 | Guts(any vm)
153
154 # callable is vm._Callable.
155 # TODO: ASDL needs some kind of "extern" to declare vm._Callable and
156 # cmd_eval.CommandEvaluator. I think it would just generate a forward
157 # declaration.
158 | BuiltinFunc(any callable)
159 | BoundFunc(value me, value func)
160
161 # command.ShFunction and command.Proc evaluate to value.Proc
162 # They each have name, name_tok, and body.
163 #
164 # YSH procs disable dynamic scope, have default args to evaluate, and
165 # different @ARGV.
166
167 | Proc(str name, Token name_tok, proc_sig sig, command body,
168 ProcDefaults? defaults, bool sh_compat)
169
170 # module may be a frame where defined
171 | Func(str name, Func parsed,
172 List[value] pos_defaults, Dict[str, value] named_defaults,
173 Dict[str, Cell]? module_)
174
175 # a[3:5] a[:10] a[3:] a[:] # both ends are optional
176 | Slice(IntBox? lower, IntBox? upper)
177
178 # for i in (1:n) { echo $i } # both ends are required
179 | Range(int lower, int upper)
180}
181
182# vim: sw=2
183