1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
|
----
-- Value(stream), implements the `AST` inteface.
--
-- @classmod Value
import Result from require 'core.result'
import Error from require 'core.error'
import scope, base, registry from require 'core.cycle'
ancestor = (klass) ->
assert klass, "cant find the ancestor of nil"
while klass.__parent
klass = klass.__parent
klass
class Value
--- members
-- @section members
--- return whether this Value was changed in the current tick.
--
-- @treturn bool
dirty: => @updated == registry.Registry.active!.tick
--- update this Value.
--
-- Marks this Value as dirty for the remainder of the current tick.
set: (@value) => @updated = registry.Registry.active!.tick
--- unwrap to the Lua type.
--
-- Asserts `@type == type` if `type` is given.
--
-- @tparam[opt] string type the type to check for
-- @tparam[optchain] string msg message to throw if type don't match
-- @treturn any `value`
unwrap: (type, msg) =>
assert type == @type, msg or "#{@} is not a #{type}" if type
@value
--- create a mutable copy of this Value.
--
-- Used to wrap insulate eval-cycles from each other.
--
-- @treturn Value
fork: =>
with Value @type, @value, @raw
.updated = @updated
--- alias for `unwrap`.
__call: (...) => @unwrap ...
--- compare two values.
--
-- Compares two `Value`s by comparing their types and their Lua values.
__eq: (other) => other.type == @type and other.value == @value
__tostring: =>
value = if 'table' == (type @value) and rawget @value, '__base' then @value.__name else @value
"<#{@@__name} #{@type}: #{value}>"
--- the type name of the Value.
--
-- the following builtin typenames are used:
--
-- - `str` - strings, `value` is a Lua string
-- - `sym` - symbols, `value` is a Lua string
-- - `num` - numbers, `value` is a Lua number
-- - `bool` - booleans, `value` is a Lua boolean
-- - `bang` - trigger signals, `value` is a Lua boolean
-- - `opdef` - `value` is an `Op` subclass
-- - `builtin` - `value` is an `Action` subclass
-- - `fndef` - `value` is a `FnDef` instance
-- - `scope` - `value` is a `Scope` instance
--
-- @tfield string type
--- the wrapped Lua value.
-- @tfield any value
--- documentation metadata.
--
-- an optional table containing metadata for error messages and
-- documentation. The following keys are recognized:
--
-- - `name`: optional name
-- - `summary`: single-line description (markdown)
-- - `examples`: optional list of single-line code examples
-- - `description`: optional full-text description (markdown)
--
-- @tfield ?table meta
--- AST interface
--
-- `Value` implements the `AST` interface.
-- @section ast
--- evaluate this literal constant.
--
-- Throws an error if `type` is not a literal (`num`, `str` or `sym`).
-- Returns an eval-time const result for `num` and `str`.
-- Resolves `sym`s in `scope` and returns a reference to them.
--
-- @tparam Scope scope the scope to evaluate in
-- @treturn Result the evaluation result
eval: (scope) =>
switch @type
when 'num', 'str'
Result value: @
when 'sym'
assert (scope\get @value), Error 'reference', "undefined symbol '#{@value}'"
else
error "cannot evaluate #{@}"
--- quote this literal constant.
--
-- @treturn Value self
quote: => @
--- stringify this literal constant.
--
-- Throws an error if `raw` is not set.
--
-- @treturn string the exact string this Value was parsed from
stringify: => assert @raw, "stringifying Value that wasn't parsed"
--- clone this literal constant.
--
-- @treturn Value self
clone: (prefix) => @
--- static functions
-- @section static
--- construct a new Value.
--
-- @classmethod
-- @tparam string type the type name
-- @tparam any value the Lua value to be accessed through `unwrap`
-- @tparam string raw the raw string that resulted in this value. Used by `parsing`.
new: (@type, @value, @raw) =>
@meta = {}
unescape = (str) -> str\gsub '\\([\'"\\])', '%1'
--- create a capture-function (for parsing with Lpeg).
--
-- @tparam string type the type name (one of `num`, `sym` or `str`)
-- @tparam string sep the seperator char (only for `str`)
@parse: (type, sep) =>
switch type
when 'num' then (match) -> @ 'num', (tonumber match), match
when 'sym' then (match) -> @ 'sym', match, match
when 'str' then (match) -> @ 'str', (unescape match), sep .. match .. sep
--- wrap a Lua value.
--
-- Attempts to guess the type and wrap a Lua value.
--
-- @tparam any val the value to wrap
-- @tparam[opt] string name the name of this value (for error logging)
-- @treturn Value
@wrap: (val, name='(unknown)') ->
typ = switch type val
when 'number' then 'num'
when 'string' then 'str'
when 'table'
if rawget val, '__base'
-- a class
switch ancestor val
when base.Op then 'opdef'
when base.Action then 'builtin'
else
error "#{name}: cannot wrap class '#{val.__name}'"
elseif val.__class
-- an instance
switch ancestor val.__class
when scope.Scope then 'scope'
when base.FnDef then 'fndef'
when Value
return val
else
error "#{name}: cannot wrap '#{val.__class.__name}' instance"
else
-- plain table
return Value 'scope', scope.Scope.from_table val
else
error "#{name}: cannot wrap Lua type '#{type val}'"
Value typ, val
--- create a constant number.
-- @tparam number num the number
-- @treturn Value
@num: (num) -> Value 'num', num, tostring num
--- create a constant string.
-- @tparam string str the string
-- @treturn Value
@str: (str) -> Value 'str', str, "'#{str}'"
--- create a constant symbol.
-- @tparam string sym the symbol
-- @treturn Value
@sym: (sym) -> Value 'sym', sym, sym
--- create a constant boolean.
-- @tparam boolean bool the boolean
-- @treturn Value
@bool: (bool) -> Value 'bool', bool, tostring bool
--- wrap and document a value.
--
-- wraps `args.value` using `wrap`, then assigns `meta`.
--
-- @tparam table args table with keys `value` and `meta`
-- @treturn Value
@meta: (args) ->
with Value.wrap args.value
.meta = args.meta if args.meta
class LiteralValue extends Value
eval: => Result value: @
{
:Value
:LiteralValue
:load_
}
|
