/
sequence_subcompiler.rb
420 lines (365 loc) · 15.4 KB
/
sequence_subcompiler.rb
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
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
# frozen_string_literal: true
module RuboCop
module AST
class NodePattern
class Compiler
# Compiles terms within a sequence to code that evalues to true or false.
# Compilation of the nodes that can match only a single term is deferred to
# `NodePatternSubcompiler`; only nodes that can match multiple terms are
# compiled here.
# Assumes the given `var` is a `::RuboCop::AST::Node`
#
# Doc on how this fits in the compiling process:
# /doc/modules/ROOT/pages/node_pattern.md
#
# rubocop:disable Metrics/ClassLength
class SequenceSubcompiler < Subcompiler
DELTA = 1
POSITIVE = :positive?.to_proc
private_constant :POSITIVE
# Calls `compile_sequence`; the actual `compile` method
# will be used for the different terms of the sequence.
# The only case of re-entrant call to `compile` is `visit_capture`
def initialize(compiler, sequence:, var:)
@seq = sequence # The node to be compiled
@seq_var = var # Holds the name of the variable holding the AST::Node we are matching
super(compiler)
end
def compile_sequence
# rubocop:disable Layout/CommentIndentation
compiler.with_temp_variables do |cur_child, cur_index, previous_index|
@cur_child_var = cur_child # To hold the current child node
@cur_index_var = cur_index # To hold the current child index (always >= 0)
@prev_index_var = previous_index # To hold the child index before we enter the
# variadic nodes
@cur_index = :seq_head # Can be any of:
# :seq_head : when the current child is actually the
# sequence head
# :variadic_mode : child index held by @cur_index_var
# >= 0 : when the current child index is known
# (from the begining)
# < 0 : when the index is known from the end,
# where -1 is *past the end*,
# -2 is the last child, etc...
# This shift of 1 from standard Ruby indices
# is stored in DELTA
@in_sync = false # `true` iff `@cur_child_var` and `@cur_index_var`
# correspond to `@cur_index`
# Must be true if `@cur_index` is `:variadic_mode`
compile_terms
end
# rubocop:enable Layout/CommentIndentation
end
private
private :compile # Not meant to be called from outside
# Single node patterns are all handled here
def visit_other_type
access = case @cur_index
when :seq_head
{ var: @seq_var,
seq_head: true }
when :variadic_mode
{ var: @cur_child_var }
else
idx = @cur_index + (@cur_index.negative? ? DELTA : 0)
{ access: "#{@seq_var}.children[#{idx}]" }
end
term = compiler.compile_as_node_pattern(node, **access)
compile_and_advance(term)
end
def visit_repetition
within_loop do
child_captures = node.child.nb_captures
child_code = compile(node.child)
next compile_loop(child_code) if child_captures.zero?
compile_captured_repetition(child_code, child_captures)
end
end
def visit_any_order
within_loop do
compiler.with_temp_variables do |matched|
case_terms = compile_any_order_branches(matched)
else_code, init = compile_any_order_else
term = "#{compile_case(case_terms, else_code)} && #{compile_loop_advance}"
all_matched_check = "&&\n#{matched}.size == #{node.term_nodes.size}" if node.rest_node
<<~RUBY
(#{init}#{matched} = {}; true) &&
#{compile_loop(term)} #{all_matched_check} \\
RUBY
end
end
end
def visit_union
return visit_other_type if node.arity == 1
# The way we implement complex unions is by "forking", i.e.
# making a copy of the present subcompiler to compile each branch
# of the union.
# We then use the resulting state of the subcompilers to
# reset ourselves.
forks = compile_union_forks
preserve_union_start(forks)
merge_forks!(forks)
expr = forks.values.join(" || \n")
"(#{expr})"
end
def compile_case(when_branches, else_code)
<<~RUBY
case
#{when_branches.join(' ')}
else #{else_code}
end \\
RUBY
end
def compile_any_order_branches(matched_var)
node.term_nodes.map.with_index do |node, i|
code = compiler.compile_as_node_pattern(node, var: @cur_child_var, seq_head: false)
var = "#{matched_var}[#{i}]"
"when !#{var} && #{code} then #{var} = true"
end
end
# @return [Array<String>] Else code, and init code (if any)
def compile_any_order_else
rest = node.rest_node
if !rest
'false'
elsif rest.capture?
capture_rest = compiler.next_capture
init = "#{capture_rest} = [];"
["#{capture_rest} << #{@cur_child_var}", init]
else
'true'
end
end
def visit_capture
return visit_other_type if node.child.arity == 1
storage = compiler.next_capture
term = compile(node.child)
capture = "#{@seq_var}.children[#{compile_matched(:range)}]"
"#{term} && (#{storage} = #{capture})"
end
def visit_rest
empty_loop
end
# Compilation helpers
def compile_and_advance(term)
case @cur_index
when :variadic_mode
"#{term} && #{compile_loop_advance}"
when :seq_head
# @in_sync = false # already the case
@cur_index = 0
term
else
@in_sync = false
@cur_index += 1
term
end
end
def compile_captured_repetition(child_code, child_captures)
captured_range = "#{compiler.captures - child_captures}...#{compiler.captures}"
captured = "captures[#{captured_range}]"
compiler.with_temp_variables do |accumulate|
code = "#{child_code} && #{accumulate}.push(#{captured})"
<<~RUBY
(#{accumulate} = Array.new) &&
#{compile_loop(code)} &&
(#{captured} = if #{accumulate}.empty?
(#{captured_range}).map{[]} # Transpose hack won't work for empty case
else
#{accumulate}.transpose
end) \\
RUBY
end
end
# Assumes `@cur_index` is already updated
def compile_matched(kind)
to = compile_cur_index
from = if @prev_index == :variadic_mode
@prev_index_used = true
@prev_index_var
else
compile_index(@prev_index)
end
case kind
when :range
"#{from}...#{to}"
when :length
"#{to} - #{from}"
end
end
def handle_prev
@prev_index = @cur_index
@prev_index_used = false
code = yield
if @prev_index_used
@prev_index_used = false
code = "(#{@prev_index_var} = #{@cur_index_var}; true) && #{code}"
end
code
end
def compile_terms(children = @seq.children, last_arity = 0..0)
arities = remaining_arities(children, last_arity)
total_arity = arities.shift
guard = compile_child_nb_guard(total_arity)
return guard if children.empty?
@remaining_arity = total_arity
terms = children.map do |child|
use_index_from_end
@remaining_arity = arities.shift
handle_prev { compile(child) }
end
[guard, terms].join(" &&\n")
end
# yield `sync_code` iff not already in sync
def sync
return if @in_sync
code = compile_loop_advance("= #{compile_cur_index}")
@in_sync = true
yield code
end
# @api private
attr_reader :in_sync, :cur_index
public :in_sync
protected :cur_index, :compile_terms, :sync
# @return [Array<Range>] total arities (as Ranges) of remaining children nodes
# E.g. For sequence `(_ _? <_ _>)`, arities are: 1, 0..1, 2
# and remaining arities are: 3..4, 2..3, 2..2, 0..0
def remaining_arities(children, last_arity)
last = last_arity
arities = children
.reverse
.map(&:arity_range)
.map { |r| last = last.begin + r.begin..last.max + r.max }
.reverse!
arities.push last_arity
end
# @return [String] code that evaluates to `false` if the matched arity is too small
def compile_min_check
return 'false' unless node.variadic?
unless @remaining_arity.end.infinite?
not_too_much_remaining = "#{compile_remaining} <= #{@remaining_arity.max}"
end
min_to_match = node.arity_range.begin
if min_to_match.positive?
enough_matched = "#{compile_matched(:length)} >= #{min_to_match}"
end
return 'true' unless not_too_much_remaining || enough_matched
[not_too_much_remaining, enough_matched].compact.join(' && ')
end
def compile_remaining
offset = case @cur_index
when :seq_head
' + 1'
when :variadic_mode
" - #{@cur_index_var}"
when 0
''
when POSITIVE
" - #{@cur_index}"
else
# odd compiling condition, result may not be expected
# E.g: `(... {a | b c})` => the b c branch can never match
return - (@cur_index + DELTA)
end
"#{@seq_var}.children.size #{offset}"
end
def compile_max_matched
return node.arity unless node.variadic?
min_remaining_children = "#{compile_remaining} - #{@remaining_arity.begin}"
return min_remaining_children if node.arity.end.infinite?
"[#{min_remaining_children}, #{node.arity.max}].min"
end
def empty_loop
@cur_index = -@remaining_arity.begin - DELTA
@in_sync = false
'true'
end
def compile_cur_index
return @cur_index_var if @in_sync
compile_index
end
def compile_index(cur = @cur_index)
return cur if cur >= 0
"#{@seq_var}.children.size - #{-(cur + DELTA)}"
end
# Note: assumes `@cur_index != :seq_head`. Node types using `within_loop` must
# have `def in_sequence_head; :raise; end`
def within_loop
sync do |sync_code|
@cur_index = :variadic_mode
"#{sync_code} && #{yield}"
end || yield
end
# returns truthy iff `@cur_index` switched to relative from end mode (i.e. < 0)
def use_index_from_end
return if @cur_index == :seq_head || @remaining_arity.begin != @remaining_arity.max
@cur_index = -@remaining_arity.begin - DELTA
end
def compile_loop_advance(to = '+=1')
# The `#{@cur_child_var} ||` is just to avoid unused variable warning
"(#{@cur_child_var} = #{@seq_var}.children[#{@cur_index_var} #{to}]; " \
"#{@cur_child_var} || true)"
end
def compile_loop(term)
<<~RUBY
(#{compile_max_matched}).times do
break #{compile_min_check} unless #{term}
end \\
RUBY
end
def compile_child_nb_guard(arity_range)
case arity_range.max
when Float::INFINITY
"#{compile_remaining} >= #{arity_range.begin}"
when arity_range.begin
"#{compile_remaining} == #{arity_range.begin}"
else
"(#{arity_range.begin}..#{arity_range.max}).cover?(#{compile_remaining})"
end
end
# @return [Hash] of {subcompiler => code}
def compile_union_forks
compiler.each_union(node.children).map do |child|
subsequence_terms = child.is_a?(Node::Subsequence) ? child.children : [child]
fork = dup
code = fork.compile_terms(subsequence_terms, @remaining_arity)
@in_sync = false if @cur_index != :variadic_mode
[fork, code]
end.to_h # we could avoid map if RUBY_VERSION >= 2.6...
end
# Modifies in place `forks` to insure that `cur_{child|index}_var` are ok
def preserve_union_start(forks)
return if @cur_index != :variadic_mode || forks.size <= 1
compiler.with_temp_variables do |union_reset|
cur = "(#{union_reset} = [#{@cur_child_var}, #{@cur_index_var}]) && "
reset = "(#{@cur_child_var}, #{@cur_index_var} = #{union_reset}) && "
forks.transform_values! do |code|
code = "#{cur}#{code}"
cur = reset
code
end
end
end
# Modifies in place `forks`
# Syncs our state
def merge_forks!(forks)
sub_compilers = forks.keys
if !node.variadic? # e.g {a b | c d}
@cur_index = sub_compilers.first.cur_index # all cur_index should be equivalent
elsif use_index_from_end
# nothing to do
else
# can't use index from end, so we must sync all forks
@cur_index = :variadic_mode
forks.each do |sub, code|
sub.sync { |sync_code| forks[sub] = "#{code} && #{sync_code}" }
end
end
@in_sync = sub_compilers.all?(&:in_sync)
end
end
# rubocop:enable Metrics/ClassLength
end
end
end
end