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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
|
/* NSC -- new Scala compiler
* Copyright 2005-2007 LAMP/EPFL
* @author Burak Emir
*/
// $Id$
package scala.tools.nsc.matching
import scala.tools.nsc.util.{Position, NoPosition}
/**
* @author Burak Emir
*/
trait PatternNodes { self: transform.ExplicitOuter =>
import global._
/** returns all variables that are binding the given pattern
* @param x a pattern
* @return vs variables bound, p pattern proper
*/
final def strip(x: Tree): (Set[Symbol], Tree) = x match {
case b @ Bind(_,pat) => val (vs, p) = strip(pat); (vs + b.symbol, p)
case z => (emptySymbolSet,z)
}
final def strip1(x: Tree): Set[Symbol] = x match { // same as strip(x)._1
case b @ Bind(_,pat) => strip1(pat) + b.symbol
case z => emptySymbolSet
}
final def strip2(x: Tree): Tree = x match { // same as strip(x)._2
case Bind(_,pat) => strip2(pat)
case z => z
}
//
type SymSet = collection.immutable.Set[Symbol]
/** returns the child patterns of a pattern
*/
protected def patternArgs(tree: Tree): List[Tree] = {
//Console.println("patternArgs "+tree.toString())
/*val res = */ tree match {
case Bind(_, pat) =>
patternArgs(pat)
case a @ Apply(_, List(av @ ArrayValue(_, ts))) if isSeqApply(a) && isRightIgnoring(av) =>
ts.reverse.drop(1).reverse
case a @ Apply(_, List(av @ ArrayValue(_, ts))) if isSeqApply(a) =>
ts
case a @ Apply(_, args) =>
args
case a @ UnApply(_, args) =>
args
case av @ ArrayValue(_, ts) if isRightIgnoring(av) =>
ts.reverse.drop(1).reverse
case av @ ArrayValue(_, ts) =>
ts
case _ =>
List()
}
//Console.println("patternArgs returns "+res.toString()) ; res
}
/** Intermediate data structure for algebraic + pattern matcher
*/
sealed class PatternNode {
var pos : Position = NoPosition
var tpe: Type = _
var or: PatternNode = _
var and: PatternNode = _
def casted: Symbol = NoSymbol
def symbol2bind: Symbol = casted
def forEachAlternative(f: PatternNode => Unit) { // only for header?
var z = this;
while (z ne null) {
f(z)
z = z.or
}
}
def isUnguardedBody = this match {
case b:Body => b.hasUnguarded
case _ => false
}
def isSingleUnguardedBody = this match {
case b:Body => b.isSingleUnguarded
case _ => false
}
def bodyToTree(): Tree = this match {
case _b:Body =>
_b.body(0)
case _ =>
error("bodyToTree called for pattern node "+this)
null
}
def set(p:(Position,Type)): this.type = {
/*assert(tpe ne null); */
this.pos = p._1; this.tpe = p._2; this
}
def dup(): PatternNode = {
var res: PatternNode = this match {
case h:Header =>
new Header(h.selector, h.next)
case b:Body=>
new Body(b.bound, b.guard, b.body)
case DefaultPat() =>
DefaultPat()
case ConstrPat(casted) =>
ConstrPat(casted)
case SequencePat(casted, len) =>
SequencePat(casted, len)
case ConstantPat(value) =>
ConstantPat(value)
case VariablePat(tree) =>
VariablePat(tree)
case AltPat(subheader) =>
AltPat(subheader)
case _ =>
error("unexpected pattern"); null
}
res set ((pos, tpe))
res.or = or
res.and = and
res
}
/*
def _symbol: Symbol = this match { // @todo
case UnapplyPat(casted, fn) =>
casted
case ConstrPat(casted) =>
casted
case SequencePat(casted, _) =>
casted
case RightIgnoringSequencePat(casted, _, _) =>
casted
case _ =>
NoSymbol //.NONE
}
*/
def nextH(): PatternNode = this match {
case _h:Header => _h.next
case _ => null
}
def isDefaultPat(): Boolean = this match {
case DefaultPat() => true
case _ => false
}
/** returns true if
* p and q are equal (constructor | sequence) type tests, or
* "q matches" => "p matches"
*/
def isSameAs(q: PatternNode): Boolean = this match {
case ConstrPat(_) =>
q match {
case ConstrPat(_) =>
isSameType(q.tpe, this.tpe)
case _ =>
false
}
case SequencePat(_, plen) =>
q match {
case SequencePat(_, qlen) =>
(plen == qlen) && isSameType(q.tpe, this.tpe)
case _ =>
false
}
case _ =>
subsumes(q)
}
/** returns true if "q matches" => "p matches"
*/
def subsumes(q:PatternNode): Boolean = this match {
case DefaultPat() =>
q match {
case DefaultPat() =>
true
case _ =>
false
}
case ConstrPat(_) =>
q match {
case ConstrPat(_) =>
isSubType(q.tpe, this.tpe)
case _ =>
false
}
case SequencePat(_, plen) =>
q match {
case SequencePat(_, qlen) =>
(plen == qlen) && isSubType(q.tpe, this.tpe)
case _ =>
false
}
case ConstantPat(pval) =>
q match {
case ConstantPat(qval) =>
pval == qval
case _ =>
false
}
case VariablePat(tree) =>
q match {
case VariablePat(other) =>
(tree.symbol ne null) &&
(tree.symbol != NoSymbol) &&
(!tree.symbol.isError) &&
(tree.symbol == other.symbol)
case _ =>
false
}
case _ =>
false
}
override def toString(): String = this match {
case _h:Header =>
"Header(" + _h.selector + ")";
case _b:Body =>
"Body"
case DefaultPat() =>
"DefaultPat"
case ConstrPat(casted) =>
"ConstrPat(" + casted + ")"
case SequencePat(casted, len) =>
"SequencePat(" + casted + ", " + len + "...)"
case RightIgnoringSequencePat(casted, castedRest, minlen) =>
"RightIgnoringSequencePat(" + casted + ", " + castedRest + ", "+ minlen + "...)"
case ConstantPat(value) =>
"ConstantPat(" + value + ")"
case VariablePat(tree) =>
"VariablePat"
case UnapplyPat(casted, fn) =>
"UnapplyPat(" + casted + ")"
case AltPat(alts) =>
"Alternative("+alts+")"
}
def print(indent: String, sb: StringBuilder): StringBuilder = {
val patNode = this
def cont = if (patNode.or ne null) patNode.or.print(indent, sb) else sb
def newIndent(s: String) = {
val removeBar: Boolean = (null == patNode.or)
val sb = new StringBuilder()
sb.append(indent)
if (removeBar)
sb.setCharAt(indent.length() - 1, ' ')
var i = 0; while (i < s.length()) {
sb.append(' ')
i += 1
}
sb.toString()
}
if (patNode eq null)
sb.append(indent).append("NULL")
else
patNode match {
case UnapplyPat(_,fn) =>
sb.append(indent + "UNAPPLY(" + fn + ")").append('\n')
case _h: Header =>
val selector = _h.selector
val next = _h.next
sb.append(indent + "HEADER(" + patNode.tpe +
", " + selector + ")").append('\n')
if(patNode.or ne null) patNode.or.print(indent + "|", sb)
if (next ne null)
next.print(indent, sb)
else
sb
case ConstrPat(casted) =>
val s = ("-- " + patNode.tpe.typeSymbol.name +
"(" + patNode.tpe + ", " + casted + ") -> ")
val nindent = newIndent(s)
sb.append(nindent + s).append('\n')
patNode.and.print(nindent, sb)
cont
case SequencePat( casted, plen ) =>
val s = ("-- " + patNode.tpe.typeSymbol.name + "(" +
patNode.tpe +
", " + casted + ", " + plen + ") -> ")
val nindent = newIndent(s)
sb.append(indent + s).append('\n')
patNode.and.print(nindent, sb)
cont
case RightIgnoringSequencePat( casted, castedRest, plen ) =>
val s = ("-- ri " + patNode.tpe.typeSymbol.name + "(" +
patNode.tpe +
", " + casted + ", " + plen + ") -> ")
val nindent = newIndent(s)
sb.append(indent + s).append('\n')
patNode.and.print(nindent, sb)
cont
case DefaultPat() =>
sb.append(indent + "-- _ -> ").append('\n')
patNode.and.print(indent.substring(0, indent.length() - 1) +
" ", sb)
cont
case ConstantPat(value) =>
val s = "-- CONST(" + value + ") -> "
val nindent = newIndent(s)
sb.append(indent + s).append('\n')
patNode.and.print( nindent, sb)
cont
case VariablePat(tree) =>
val s = "-- STABLEID(" + tree + ": " + patNode.tpe + ") -> "
val nindent = newIndent(s)
sb.append(indent + s).append('\n')
patNode.and.print(nindent, sb)
cont
case AltPat(header) =>
sb.append(indent + "-- ALTERNATIVES:").append('\n')
header.print(indent + " * ", sb)
patNode.and.print(indent + " * -> ", sb)
cont
case _b:Body =>
if ((_b.guard.length == 0) && (_b.body.length == 0))
sb.append(indent + "true").append('\n')
else
sb.append(indent + "BODY(" + _b.body.length + ")").append('\n')
}
} // def print
} // class PatternNode
class Header(sel1: Tree, next1: Header) extends PatternNode {
var selector: Tree = sel1
var next: Header = next1
def findLast: PatternNode = {
var g: PatternNode = findLastSection
while(g.or != null) { g = g.or }
g
}
def findLastSection: Header = {
var h: Header = this
while(h.next != null) { h = h.next }
h
}
var isSubHeader = false
/* returns true if this header node has a catch all case
def catchesAll: Boolean = {
//Console.println(this.print(" catchesAll %%%%", new StringBuilder()).toString)
val p = findLast
(p.isDefaultPat && p.and.isUnguardedBody)
}
*/
// executes an action for every or branch
def forEachBranch(f: PatternNode => Unit) { if(or ne null) or.forEachAlternative(f) }
// executes an action for every header section
def forEachSection(f: Header => Unit) { var h = this; while (h ne null) {f(h); h = h.next}}
/** returns true if this tree is optimizable
* throws a warning if is not exhaustive
*/
def optimize1(): (Boolean, SymSet, SymSet) = {
import symtab.Flags
val selType = this.tpe
if (!isSubType(selType, definitions.ScalaObjectClass.tpe))
return (false, null, emptySymbolSet)
if(this.or eq null)
return (false, null, emptySymbolSet) // only case _
def checkExCoverage(tpesym:Symbol): SymSet =
if(!tpesym.hasFlag(Flags.SEALED)) emptySymbolSet else
tpesym.children.flatMap { x =>
val z = checkExCoverage(x)
if(x.hasFlag(Flags.ABSTRACT)) z else z + x
}
def andIsUnguardedBody(p1:PatternNode) = p1.and match {
case p: Body => p.hasUnguarded
case _ => false
}
//Console.println("optimize1("+selType+","+alternatives1+")")
var res = true
var coveredCases: SymSet = emptySymbolSet
var remainingCases = checkExCoverage(selType.typeSymbol)
var cases = 0
def traverse(alts:PatternNode) {
//Console.println("traverse, alts="+alts)
alts match {
case ConstrPat(_) =>
//Console.print("ConstPat! of"+alts.tpe.typeSymbol)
if (alts.tpe.typeSymbol.hasFlag(Flags.CASE)) {
coveredCases = coveredCases + alts.tpe.typeSymbol
remainingCases = remainingCases - alts.tpe.typeSymbol
cases = cases + 1
} else {
val covered = remainingCases.filter { x =>
//Console.println("x.tpe is "+x.tpe)
val y = alts.tpe.prefix.memberType(x)
//Console.println(y + " is sub of "+alts.tpe+" ? "+isSubType(y, alts.tpe));
isSubType(y, alts.tpe)
}
//Console.println(" covered : "+covered)
coveredCases = coveredCases ++ covered
remainingCases = remainingCases -- covered
res = false
}
// Nil is also a "constructor pattern" somehow
case VariablePat(tree) if (tree.tpe.typeSymbol.hasFlag(Flags.MODULE)) => // Nil
coveredCases = coveredCases + tree.tpe.typeSymbol
remainingCases = remainingCases - tree.tpe.typeSymbol
cases = cases + 1
res = res && tree.tpe.typeSymbol.hasFlag(Flags.CASE)
case DefaultPat() =>
if(andIsUnguardedBody(alts) || alts.and.isInstanceOf[Header]) {
coveredCases = emptySymbolSet
remainingCases = emptySymbolSet
}
case UnapplyPat(_,_) | SequencePat(_, _) | RightIgnoringSequencePat(_, _, _) =>
res = false
remainingCases = emptySymbolSet
case ConstantPat(_) =>
res = false
case AltPat(branchesHeader) =>
res = false
//Console.println("----------bfore: "+coveredCases)
branchesHeader.forEachBranch(traverse) // branchesHeader is header
//Console.println("----------after: "+coveredCases)
case VariablePat(_) =>
res = false
case _:Header | _:Body =>
Predef.error("cannot happen")
}
}
this.forEachBranch(traverse)
return (res && (cases > 2), coveredCases, remainingCases)
} // def optimize
}
/** contains at least one body, so arrays are always nonempty
*/
class Body(bound1: Array[Array[ValDef]], guard1:Array[Tree], body1:Array[Tree]) extends PatternNode {
var bound = bound1
var guard = guard1
var body = body1
def hasUnguarded = guard.exists { x => x == EmptyTree }
def isSingleUnguarded = (guard.length == 1) && (guard(0) == EmptyTree) && (bound(0).length == 0)
}
case class DefaultPat()extends PatternNode
case class ConstrPat(override val casted:Symbol) extends PatternNode
case class UnapplyPat(override val casted:Symbol, fn:Tree) extends PatternNode {
override def symbol2bind = NoSymbol
def returnsOne = {
/*val res =*/ definitions.getProductArgs(casted.tpe) match {
case Some(Nil) => true // n = 0
case Some(x::Nil) => true // n = 1
case Some(_) => false
case _ => true
}
//Console.println("returns one? "+casted.tpe)
//Console.println(" I say: "+res)
//res
}
}
case class ConstantPat(value: Any /*AConstant*/) extends PatternNode
case class VariablePat(tree: Tree) extends PatternNode
case class AltPat(subheader: Header) extends PatternNode
case class SequencePat(override val casted: Symbol, len: Int) extends PatternNode // only used in PatternMatcher
case class RightIgnoringSequencePat(override val casted: Symbol, castedRest: Symbol, minlen: int) extends PatternNode //PM
/** the environment for a body of a case
* @param owner the owner of the variables created here
*/
class CaseEnv {
// (val owner:Symbol, unit:CompilationUnit)
private var boundVars: Array[ValDef] = new Array[ValDef](4)
private var numVars = 0
def substitute(oldSym: Symbol, newInit: Tree) {
var i = 0; while (i < numVars) {
if (boundVars(i).rhs.symbol == oldSym) {
boundVars(i) = ValDef(boundVars(i).symbol, newInit)
return
}
i += 1
}
}
def newBoundVar(sym: Symbol, tpe: Type, init: Tree) {
//if(sym == Symbol.NoSymbol ) {
// scala.Predef.Error("can't add variable with NoSymbol");
//}
//sym.setOwner( owner ); // FIXME should be corrected earlier
//@maybe is corrected now? bq
if (numVars == boundVars.length) {
val newVars = new Array[ValDef](numVars * 2)
Array.copy(boundVars, 0, newVars, 0, numVars)
this.boundVars = newVars
}
sym.setInfo(tpe)
this.boundVars(numVars) = ValDef(sym, init.duplicate)
numVars += 1
}
def getBoundVars(): Array[ValDef] = {
val newVars = new Array[ValDef](numVars)
Array.copy(boundVars, 0, newVars, 0, numVars)
newVars
}
override def equals(obj: Any): Boolean = {
if (!(obj.isInstanceOf[CaseEnv]))
return false
val env = obj.asInstanceOf[CaseEnv]
if (env.numVars != numVars)
return false
var i = 0; while (i < numVars) {
if ((boundVars(i).name != env.boundVars(i).name) ||
!isSameType(boundVars(i).tpe, env.boundVars(i).tpe) ||
(boundVars(i).rhs != env.boundVars(i).rhs))
return false
i += 1
}
true
}
} // class CaseEnv
}
|