forked from scala/scala3
-
Notifications
You must be signed in to change notification settings - Fork 17
/
Denotations.scala
1335 lines (1197 loc) · 57.6 KB
/
Denotations.scala
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
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package dotty.tools
package dotc
package core
import SymDenotations.{ SymDenotation, ClassDenotation, NoDenotation, LazyType }
import Contexts.{Context, ContextBase}
import Names._
import NameKinds._
import StdNames._
import Symbols.NoSymbol
import Symbols._
import Types._
import Periods._
import Flags._
import DenotTransformers._
import Decorators._
import printing.Texts._
import printing.Printer
import io.AbstractFile
import config.Config
import util.common._
import collection.mutable.ListBuffer
/** Denotations represent the meaning of symbols and named types.
* The following diagram shows how the principal types of denotations
* and their denoting entities relate to each other. Lines ending in
* a down-arrow `v` are member methods. The two methods shown in the diagram are
* "symbol" and "deref". Both methods are parameterized by the current context,
* and are effectively indexed by current period.
*
* Lines ending in a horizontal line mean subtying (right is a subtype of left).
*
* NamedType
* | Symbol---------ClassSymbol
* | | |
* | denot | denot | denot
* v v v
* Denotation-+-----SingleDenotation-+------SymDenotation-+----ClassDenotation
* | |
* +-----MultiDenotation |
* |
* +--UniqueRefDenotation
* +--JointRefDenotation
*
* Here's a short summary of the classes in this diagram.
*
* NamedType A type consisting of a prefix type and a name, with fields
* prefix: Type
* name: Name
* It has two subtypes: TermRef and TypeRef
* Symbol A label for a definition or declaration in one compiler run
* ClassSymbol A symbol representing a class
* Denotation The meaning of a named type or symbol during a period
* MultiDenotation A denotation representing several overloaded members
* SingleDenotation A denotation representing a non-overloaded member or definition, with main fields
* symbol: Symbol
* info: Type
* UniqueRefDenotation A denotation referring to a single definition with some member type
* JointRefDenotation A denotation referring to a member that could resolve to several definitions
* SymDenotation A denotation representing a single definition with its original type, with main fields
* name: Name
* owner: Symbol
* flags: Flags
* privateWithin: Symbol
* annotations: List[Annotation]
* ClassDenotation A denotation representing a single class definition.
*/
object Denotations {
implicit def eqDenotation: Eq[Denotation, Denotation] = Eq
/** A PreDenotation represents a group of single denotations or a single multi-denotation
* It is used as an optimization to avoid forming MultiDenotations too eagerly.
*/
abstract class PreDenotation {
/** A denotation in the group exists */
def exists: Boolean
/** First/last denotation in the group */
def first: Denotation
def last: Denotation
/** Convert to full denotation by &-ing all elements */
def toDenot(pre: Type)(implicit ctx: Context): Denotation
/** Group contains a denotation that refers to given symbol */
def containsSym(sym: Symbol): Boolean
/** Group contains a denotation with the same signature as `other` */
def matches(other: SingleDenotation)(implicit ctx: Context): Boolean
/** Keep only those denotations in this group which satisfy predicate `p`. */
def filterWithPredicate(p: SingleDenotation => Boolean): PreDenotation
/** Keep only those denotations in this group which have a signature
* that's not already defined by `denots`.
*/
def filterDisjoint(denots: PreDenotation)(implicit ctx: Context): PreDenotation
/** Keep only those inherited members M of this predenotation for which the following is true
* - M is not marked Private
* - If M has a unique symbol, it does not appear in `prevDenots`.
* - M's signature as seen from prefix `pre` does not appear in `ownDenots`
* Return the denotation as seen from `pre`.
* Called from SymDenotations.computeMember. There, `ownDenots` are the denotations found in
* the base class, which shadow any inherited denotations with the same signature.
* `prevDenots` are the denotations that are defined in the class or inherited from
* a base type which comes earlier in the linearization.
*/
def mapInherited(ownDenots: PreDenotation, prevDenots: PreDenotation, pre: Type)(implicit ctx: Context): PreDenotation
/** Keep only those denotations in this group that have all of the flags in `required`,
* but none of the flags in `excluded`.
*/
def filterWithFlags(required: FlagConjunction, excluded: FlagSet)(implicit ctx: Context): PreDenotation
private[this] var cachedPrefix: Type = _
private[this] var cachedAsSeenFrom: AsSeenFromResult = _
private[this] var validAsSeenFrom: Period = Nowhere
type AsSeenFromResult <: PreDenotation
/** The denotation with info(s) as seen from prefix type */
final def asSeenFrom(pre: Type)(implicit ctx: Context): AsSeenFromResult =
if (Config.cacheAsSeenFrom) {
if ((cachedPrefix ne pre) || ctx.period != validAsSeenFrom) {
cachedAsSeenFrom = computeAsSeenFrom(pre)
cachedPrefix = pre
validAsSeenFrom = if (pre.isProvisional) Nowhere else ctx.period
}
cachedAsSeenFrom
} else computeAsSeenFrom(pre)
protected def computeAsSeenFrom(pre: Type)(implicit ctx: Context): AsSeenFromResult
/** The union of two groups. */
def union(that: PreDenotation): PreDenotation =
if (!this.exists) that
else if (!that.exists) this
else DenotUnion(this, that)
}
/** A denotation is the result of resolving
* a name (either simple identifier or select) during a given period.
*
* Denotations can be combined with `&` and `|`.
* & is conjunction, | is disjunction.
*
* `&` will create an overloaded denotation from two
* non-overloaded denotations if their signatures differ.
* Analogously `|` of two denotations with different signatures will give
* an empty denotation `NoDenotation`.
*
* A denotation might refer to `NoSymbol`. This is the case if the denotation
* was produced from a disjunction of two denotations with different symbols
* and there was no common symbol in a superclass that could substitute for
* both symbols. Here is an example:
*
* Say, we have:
*
* class A { def f: A }
* class B { def f: B }
* val x: A | B = if (test) new A else new B
* val y = x.f
*
* Then the denotation of `y` is `SingleDenotation(NoSymbol, A | B)`.
*
* @param symbol The referencing symbol, or NoSymbol is none exists
*/
abstract class Denotation(val symbol: Symbol, protected var myInfo: Type) extends PreDenotation with printing.Showable {
type AsSeenFromResult <: Denotation
/** The type info.
* The info is an instance of TypeType iff this is a type denotation
* Uncompleted denotations set myInfo to a LazyType.
*/
final def info(implicit ctx: Context): Type = {
def completeInfo = { // Written this way so that `info` is small enough to be inlined
this.asInstanceOf[SymDenotation].completeFrom(myInfo.asInstanceOf[LazyType]); info
}
if (myInfo.isInstanceOf[LazyType]) completeInfo else myInfo
}
/** The type info, or, if this is a SymDenotation where the symbol
* is not yet completed, the completer
*/
def infoOrCompleter: Type
/** The period during which this denotation is valid. */
def validFor: Period
/** Is this a reference to a type symbol? */
def isType: Boolean
/** Is this a reference to a term symbol? */
def isTerm: Boolean = !isType
/** Is this denotation overloaded? */
final def isOverloaded: Boolean = isInstanceOf[MultiDenotation]
/** Denotation points to unique symbol; false for overloaded denotations
* and JointRef denotations.
*/
def hasUniqueSym: Boolean
/** The name of the denotation */
def name(implicit ctx: Context): Name
/** The signature of the denotation. */
def signature(implicit ctx: Context): Signature
/** Resolve overloaded denotation to pick the ones with the given signature
* when seen from prefix `site`.
* @param relaxed When true, consider only parameter signatures for a match.
*/
def atSignature(sig: Signature, site: Type = NoPrefix, relaxed: Boolean = false)(implicit ctx: Context): Denotation
/** The variant of this denotation that's current in the given context.
* If no such denotation exists, returns the denotation with each alternative
* at its first point of definition.
*/
def current(implicit ctx: Context): Denotation
/** Is this denotation different from NoDenotation or an ErrorDenotation? */
def exists: Boolean = true
/** A denotation with the info of this denotation transformed using `f` */
def mapInfo(f: Type => Type)(implicit ctx: Context): Denotation
/** If this denotation does not exist, fallback to alternative */
final def orElse(that: => Denotation): Denotation = if (this.exists) this else that
/** The set of alternative single-denotations making up this denotation */
final def alternatives: List[SingleDenotation] = altsWith(alwaysTrue)
/** The alternatives of this denotation that satisfy the predicate `p`. */
def altsWith(p: Symbol => Boolean): List[SingleDenotation]
/** The unique alternative of this denotation that satisfies the predicate `p`,
* or NoDenotation if no satisfying alternative exists.
* @throws TypeError if there is at more than one alternative that satisfies `p`.
*/
def suchThat(p: Symbol => Boolean)(implicit ctx: Context): SingleDenotation
/** If this is a SingleDenotation, return it, otherwise throw a TypeError */
def checkUnique(implicit ctx: Context): SingleDenotation = suchThat(alwaysTrue)
/** Does this denotation have an alternative that satisfies the predicate `p`? */
def hasAltWith(p: SingleDenotation => Boolean): Boolean
/** The denotation made up from the alternatives of this denotation that
* are accessible from prefix `pre`, or NoDenotation if no accessible alternative exists.
*/
def accessibleFrom(pre: Type, superAccess: Boolean = false)(implicit ctx: Context): Denotation
/** Find member of this denotation with given `name`, all `required`
* flags and no `excluded` flag, and produce a denotation that contains the type of the member
* as seen from given prefix `pre`.
*/
def findMember(name: Name, pre: Type, required: FlagConjunction, excluded: FlagSet)(implicit ctx: Context): Denotation =
info.findMember(name, pre, required, excluded)
/** If this denotation is overloaded, filter with given predicate.
* If result is still overloaded throw a TypeError.
* Note: disambiguate is slightly different from suchThat in that
* single-denotations that do not satisfy the predicate are left alone
* (whereas suchThat would map them to NoDenotation).
*/
def disambiguate(p: Symbol => Boolean)(implicit ctx: Context): SingleDenotation = this match {
case sdenot: SingleDenotation => sdenot
case mdenot => suchThat(p) orElse NoQualifyingRef(alternatives)
}
/** Return symbol in this denotation that satisfies the given predicate.
* if generateStubs is specified, return a stubsymbol if denotation is a missing ref.
* Throw a `TypeError` if predicate fails to disambiguate symbol or no alternative matches.
*/
def requiredSymbol(p: Symbol => Boolean, source: AbstractFile = null, generateStubs: Boolean = true)(implicit ctx: Context): Symbol =
disambiguate(p) match {
case m @ MissingRef(ownerd, name) =>
if (generateStubs) {
if (ctx.settings.YdebugMissingRefs.value) m.ex.printStackTrace()
ctx.newStubSymbol(ownerd.symbol, name, source)
}
else NoSymbol
case NoDenotation | _: NoQualifyingRef =>
throw new TypeError(i"None of the alternatives of $this satisfies required predicate")
case denot =>
denot.symbol
}
def requiredMethod(name: PreName)(implicit ctx: Context): TermSymbol =
info.member(name.toTermName).requiredSymbol(_ is Method).asTerm
def requiredMethodRef(name: PreName)(implicit ctx: Context): TermRef =
requiredMethod(name).termRef
def requiredMethod(name: PreName, argTypes: List[Type])(implicit ctx: Context): TermSymbol = {
info.member(name.toTermName).requiredSymbol { x =>
(x is Method) && {
x.info.paramInfoss match {
case paramInfos :: Nil => paramInfos.corresponds(argTypes)(_ =:= _)
case _ => false
}
}
}.asTerm
}
def requiredMethodRef(name: PreName, argTypes: List[Type])(implicit ctx: Context): TermRef =
requiredMethod(name, argTypes).termRef
def requiredValue(name: PreName)(implicit ctx: Context): TermSymbol =
info.member(name.toTermName).requiredSymbol(_.info.isParameterless).asTerm
def requiredValueRef(name: PreName)(implicit ctx: Context): TermRef =
requiredValue(name).termRef
def requiredClass(name: PreName)(implicit ctx: Context): ClassSymbol =
info.member(name.toTypeName).requiredSymbol(_.isClass).asClass
def requiredType(name: PreName)(implicit ctx: Context): TypeSymbol =
info.member(name.toTypeName).requiredSymbol(_.isType).asType
/** The alternative of this denotation that has a type matching `targetType` when seen
* as a member of type `site`, `NoDenotation` if none exists.
*/
def matchingDenotation(site: Type, targetType: Type)(implicit ctx: Context): SingleDenotation = {
def qualifies(sym: Symbol) = site.memberInfo(sym).matchesLoosely(targetType)
if (isOverloaded) {
atSignature(targetType.signature, site, relaxed = true) match {
case sd: SingleDenotation => sd.matchingDenotation(site, targetType)
case md => md.suchThat(qualifies(_))
}
}
else if (exists && !qualifies(symbol)) NoDenotation
else asSingleDenotation
}
/** Handle merge conflict by throwing a `MergeError` exception */
private def mergeConflict(tp1: Type, tp2: Type, that: Denotation)(implicit ctx: Context): Type =
throw new MergeError(this.symbol, that.symbol, tp1, tp2, NoPrefix)
/** Merge parameter names of lambda types. If names in corresponding positions match, keep them,
* otherwise generate new synthetic names.
*/
private def mergeParamNames(tp1: LambdaType, tp2: LambdaType): List[tp1.ThisName] =
(for ((name1, name2, idx) <- (tp1.paramNames, tp2.paramNames, tp1.paramNames.indices).zipped)
yield if (name1 == name2) name1 else tp1.companion.syntheticParamName(idx)).toList
/** Form a denotation by conjoining with denotation `that`.
*
* NoDenotations are dropped. MultiDenotations are handled by merging
* parts with same signatures. SingleDenotations with equal signatures
* are joined as follows:
*
* In a first step, consider only those denotations which have symbols
* that are accessible from prefix `pre`.
*
* If there are several such denotations, try to pick one by applying the following
* three precedence rules in decreasing order of priority:
*
* 1. Prefer denotations with more specific infos.
* 2. If infos are equally specific, prefer denotations with concrete symbols over denotations
* with abstract symbols.
* 3. If infos are equally specific and symbols are equally concrete,
* prefer denotations with symbols defined in subclasses
* over denotations with symbols defined in proper superclasses.
*
* If there is exactly one (preferred) accessible denotation, return it.
*
* If there is no preferred accessible denotation, return a JointRefDenotation
* with one of the operand symbols (unspecified which one), and an info which
* is the intersection (using `&` or `safe_&` if `safeIntersection` is true)
* of the infos of the operand denotations.
*
* If SingleDenotations with different signatures are joined, return NoDenotation.
*/
def & (that: Denotation, pre: Type, safeIntersection: Boolean = false)(implicit ctx: Context): Denotation = {
/** Normally, `tp1 & tp2`. Special cases for matching methods and classes, with
* the possibility of raising a merge error.
*/
def infoMeet(tp1: Type, tp2: Type): Type = {
if (tp1 eq tp2) tp1
else tp1 match {
case tp1: TypeBounds =>
tp2 match {
case tp2: TypeBounds => if (safeIntersection) tp1 safe_& tp2 else tp1 & tp2
case tp2: ClassInfo if tp1 contains tp2 => tp2
case _ => mergeConflict(tp1, tp2, that)
}
case tp1: ClassInfo =>
tp2 match {
case tp2: ClassInfo if tp1.cls eq tp2.cls => tp1.derivedClassInfo(tp1.prefix & tp2.prefix)
case tp2: TypeBounds if tp2 contains tp1 => tp1
case _ => mergeConflict(tp1, tp2, that)
}
// Two remedial strategies:
//
// 1. Prefer method types over poly types. This is necessary to handle
// overloaded definitions like the following
//
// def ++ [B >: A](xs: C[B]): D[B]
// def ++ (xs: C[A]): D[A]
//
// (Code like this is found in the collection strawman)
//
// 2. In the case of two method types or two polytypes with matching
// parameters and implicit status, merge corresponding parameter
// and result types.
case tp1: MethodType =>
tp2 match {
case tp2: PolyType =>
tp1
case tp2: MethodType if ctx.typeComparer.matchingMethodParams(tp1, tp2) &&
tp1.isImplicitMethod == tp2.isImplicitMethod =>
tp1.derivedLambdaType(
mergeParamNames(tp1, tp2),
tp1.paramInfos,
infoMeet(tp1.resultType, tp2.resultType.subst(tp2, tp1)))
case _ =>
mergeConflict(tp1, tp2, that)
}
case tp1: PolyType =>
tp2 match {
case tp2: MethodType =>
tp2
case tp2: PolyType if ctx.typeComparer.matchingPolyParams(tp1, tp2) =>
tp1.derivedLambdaType(
mergeParamNames(tp1, tp2),
tp1.paramInfos.zipWithConserve(tp2.paramInfos) { (p1, p2) =>
infoMeet(p1, p2.subst(tp2, tp1)).bounds
},
infoMeet(tp1.resultType, tp2.resultType.subst(tp2, tp1)))
case _ =>
mergeConflict(tp1, tp2, that)
}
case _ =>
tp1 & tp2
}
}
/** Try to merge denot1 and denot2 without adding a new signature. */
def mergeDenot(denot1: Denotation, denot2: SingleDenotation): Denotation = denot1 match {
case denot1 @ MultiDenotation(denot11, denot12) =>
val d1 = mergeDenot(denot11, denot2)
if (d1.exists) denot1.derivedUnionDenotation(d1, denot12)
else {
val d2 = mergeDenot(denot12, denot2)
if (d2.exists) denot1.derivedUnionDenotation(denot11, d2)
else NoDenotation
}
case denot1: SingleDenotation =>
if (denot1 eq denot2) denot1
else if (denot1.matches(denot2)) mergeSingleDenot(denot1, denot2)
else NoDenotation
}
/** Try to merge single-denotations. */
def mergeSingleDenot(denot1: SingleDenotation, denot2: SingleDenotation): SingleDenotation = {
val info1 = denot1.info
val info2 = denot2.info
val sym1 = denot1.symbol
val sym2 = denot2.symbol
val sym2Accessible = sym2.isAccessibleFrom(pre)
/** Does `sym1` come before `sym2` in the linearization of `pre`? */
def precedes(sym1: Symbol, sym2: Symbol) = {
def precedesIn(bcs: List[ClassSymbol]): Boolean = bcs match {
case bc :: bcs1 => (sym1 eq bc) || !(sym2 eq bc) && precedesIn(bcs1)
case Nil => true
}
(sym1 ne sym2) &&
(sym1.derivesFrom(sym2) ||
!sym2.derivesFrom(sym1) && precedesIn(pre.baseClasses))
}
/** Similar to SymDenotation#accessBoundary, but without the special cases. */
def accessBoundary(sym: Symbol) =
if (sym.is(Private)) sym.owner
else sym.privateWithin.orElse(
if (sym.is(Protected)) sym.owner.enclosingPackageClass
else defn.RootClass)
/** Establish a partial order "preference" order between symbols.
* Give preference to `sym1` over `sym2` if one of the following
* conditions holds, in decreasing order of weight:
* 1. sym2 doesn't exist
* 2. sym1 is concrete and sym2 is abstract
* 3. The owner of sym1 comes before the owner of sym2 in the linearization
* of the type of the prefix `pre`.
* 4. The access boundary of sym2 is properly contained in the access
* boundary of sym1. For protected access, we count the enclosing
* package as access boundary.
* 5. sym1 is a method but sym2 is not.
* 6. sym1 is a non-polymorphic method but sym2 is a polymorphic method.
* (to be consistent with infoMeet, see #4819)
* The aim of these criteria is to give some disambiguation on access which
* - does not depend on textual order or other arbitrary choices
* - minimizes raising of doubleDef errors
*/
def preferSym(sym1: Symbol, sym2: Symbol) =
sym1.eq(sym2) ||
sym1.exists &&
(!sym2.exists ||
sym1.isAsConcrete(sym2) &&
(!sym2.isAsConcrete(sym1) ||
precedes(sym1.owner, sym2.owner) ||
accessBoundary(sym2).isProperlyContainedIn(accessBoundary(sym1)) ||
sym2.is(Bridge) && !sym1.is(Bridge) ||
sym1.is(Method) && !sym2.is(Method)) ||
sym1.info.isInstanceOf[MethodType] && sym2.info.isInstanceOf[PolyType] ||
sym1.info.isErroneous)
/** Sym preference provided types also override */
def prefer(sym1: Symbol, sym2: Symbol, info1: Type, info2: Type) =
preferSym(sym1, sym2) &&
info1.overrides(info2, sym1.matchNullaryLoosely || sym2.matchNullaryLoosely)
def handleDoubleDef =
if (preferSym(sym1, sym2)) denot1
else if (preferSym(sym2, sym1)) denot2
else doubleDefError(denot1, denot2, pre)
if (sym2Accessible && prefer(sym2, sym1, info2, info1)) denot2
else {
val sym1Accessible = sym1.isAccessibleFrom(pre)
if (sym1Accessible && prefer(sym1, sym2, info1, info2)) denot1
else if (sym1Accessible && sym2.exists && !sym2Accessible) denot1
else if (sym2Accessible && sym1.exists && !sym1Accessible) denot2
else if (isDoubleDef(sym1, sym2)) handleDoubleDef
else {
val sym =
if (preferSym(sym2, sym1)) sym2
else sym1
val jointInfo =
try infoMeet(info1, info2)
catch {
case ex: MergeError =>
// TODO: this picks one type over the other whereas it might be better
// to return a MultiDenotation instead. But doing so would affect lots of
// things, starting with the return type of this method.
if (preferSym(sym2, sym1)) info2
else if (preferSym(sym1, sym2)) info1
else if (pre.widen.classSymbol.is(Scala2x) || ctx.scala2Mode)
info1 // follow Scala2 linearization -
// compare with way merge is performed in SymDenotation#computeMembersNamed
else throw new MergeError(ex.sym1, ex.sym2, ex.tp1, ex.tp2, pre)
}
new JointRefDenotation(sym, jointInfo, denot1.validFor & denot2.validFor)
}
}
}
if (this eq that) this
else if (!this.exists) that
else if (!that.exists) this
else that match {
case that: SingleDenotation =>
val r = mergeDenot(this, that)
if (r.exists) r else MultiDenotation(this, that)
case that @ MultiDenotation(denot1, denot2) =>
this & (denot1, pre) & (denot2, pre)
}
}
/** Form a choice between this denotation and that one.
* @param pre The prefix type of the members of the denotation, used
* to determine an accessible symbol if it exists.
*/
def | (that: Denotation, pre: Type)(implicit ctx: Context): Denotation = {
/** Normally, `tp1 | tp2`. Special cases for matching methods and classes, with
* the possibility of raising a merge error.
*/
def infoJoin(tp1: Type, tp2: Type): Type = tp1 match {
case tp1: TypeBounds =>
tp2 match {
case tp2: TypeBounds => tp1 | tp2
case tp2: ClassInfo if tp1 contains tp2 => tp1
case _ => mergeConflict(tp1, tp2, that)
}
case tp1: ClassInfo =>
tp2 match {
case tp2: ClassInfo if tp1.cls eq tp2.cls => tp1.derivedClassInfo(tp1.prefix | tp2.prefix)
case tp2: TypeBounds if tp2 contains tp1 => tp2
case _ => mergeConflict(tp1, tp2, that)
}
case tp1: MethodType =>
tp2 match {
case tp2: MethodType
if ctx.typeComparer.matchingMethodParams(tp1, tp2) &&
tp1.isImplicitMethod == tp2.isImplicitMethod =>
tp1.derivedLambdaType(
mergeParamNames(tp1, tp2),
tp1.paramInfos,
tp1.resultType | tp2.resultType.subst(tp2, tp1))
case _ =>
mergeConflict(tp1, tp2, that)
}
case tp1: PolyType =>
tp2 match {
case tp2: PolyType
if ctx.typeComparer.matchingPolyParams(tp1, tp2) =>
tp1.derivedLambdaType(
mergeParamNames(tp1, tp2),
tp1.paramInfos.zipWithConserve(tp2.paramInfos) { (p1, p2) =>
(p1 | p2.subst(tp2, tp1)).bounds
},
tp1.resultType | tp2.resultType.subst(tp2, tp1))
case _ =>
mergeConflict(tp1, tp2, that)
}
case _ =>
tp1 | tp2
}
def unionDenot(denot1: SingleDenotation, denot2: SingleDenotation): Denotation =
if (denot1.matches(denot2)) {
val sym1 = denot1.symbol
val sym2 = denot2.symbol
val info1 = denot1.info
val info2 = denot2.info
val sameSym = sym1 eq sym2
if (sameSym && (info1 frozen_<:< info2)) denot2
else if (sameSym && (info2 frozen_<:< info1)) denot1
else {
val jointSym =
if (sameSym) sym1
else {
val owner2 = if (sym2 ne NoSymbol) sym2.owner else NoSymbol
/** Determine a symbol which is overridden by both sym1 and sym2.
* Preference is given to accessible symbols.
*/
def lubSym(overrides: Iterator[Symbol], previous: Symbol): Symbol =
if (!overrides.hasNext) previous
else {
val candidate = overrides.next()
if (owner2 derivesFrom candidate.owner)
if (candidate isAccessibleFrom pre) candidate
else lubSym(overrides, previous orElse candidate)
else
lubSym(overrides, previous)
}
lubSym(sym1.allOverriddenSymbols, NoSymbol)
}
new JointRefDenotation(
jointSym, infoJoin(info1, info2), denot1.validFor & denot2.validFor)
}
}
else NoDenotation
if (this eq that) this
else if (!this.exists) this
else if (!that.exists) that
else this match {
case denot1 @ MultiDenotation(denot11, denot12) =>
denot1.derivedUnionDenotation(denot11 | (that, pre), denot12 | (that, pre))
case denot1: SingleDenotation =>
that match {
case denot2 @ MultiDenotation(denot21, denot22) =>
denot2.derivedUnionDenotation(this | (denot21, pre), this | (denot22, pre))
case denot2: SingleDenotation =>
unionDenot(denot1, denot2)
}
}
}
final def asSingleDenotation: SingleDenotation = asInstanceOf[SingleDenotation]
final def asSymDenotation: SymDenotation = asInstanceOf[SymDenotation]
def toText(printer: Printer): Text = printer.toText(this)
// ------ PreDenotation ops ----------------------------------------------
final def toDenot(pre: Type)(implicit ctx: Context): Denotation = this
final def containsSym(sym: Symbol): Boolean = hasUniqueSym && (symbol eq sym)
}
/** A non-overloaded denotation */
abstract class SingleDenotation(symbol: Symbol, initInfo: Type) extends Denotation(symbol, initInfo) {
protected def newLikeThis(symbol: Symbol, info: Type): SingleDenotation
final def name(implicit ctx: Context): Name = symbol.name
final def signature(implicit ctx: Context): Signature =
if (isType) Signature.NotAMethod // don't force info if this is a type SymDenotation
else info match {
case info: MethodicType =>
try info.signature
catch { // !!! DEBUG
case scala.util.control.NonFatal(ex) =>
ctx.echo(s"cannot take signature of ${info.show}")
throw ex
}
case _ => Signature.NotAMethod
}
def derivedSingleDenotation(symbol: Symbol, info: Type)(implicit ctx: Context): SingleDenotation =
if ((symbol eq this.symbol) && (info eq this.info)) this
else newLikeThis(symbol, info)
def mapInfo(f: Type => Type)(implicit ctx: Context): SingleDenotation =
derivedSingleDenotation(symbol, f(info))
def orElse(that: => SingleDenotation): SingleDenotation = if (this.exists) this else that
def altsWith(p: Symbol => Boolean): List[SingleDenotation] =
if (exists && p(symbol)) this :: Nil else Nil
def suchThat(p: Symbol => Boolean)(implicit ctx: Context): SingleDenotation =
if (exists && p(symbol)) this else NoDenotation
def hasAltWith(p: SingleDenotation => Boolean): Boolean =
exists && p(this)
def accessibleFrom(pre: Type, superAccess: Boolean)(implicit ctx: Context): Denotation =
if (!symbol.exists || symbol.isAccessibleFrom(pre, superAccess)) this else NoDenotation
def atSignature(sig: Signature, site: Type, relaxed: Boolean)(implicit ctx: Context): SingleDenotation = {
val situated = if (site == NoPrefix) this else asSeenFrom(site)
val matches = sig.matchDegree(situated.signature) >=
(if (relaxed) Signature.ParamMatch else Signature.FullMatch)
if (matches) this else NoDenotation
}
// ------ Forming types -------------------------------------------
/** The TypeRef representing this type denotation at its original location. */
def typeRef(implicit ctx: Context): TypeRef =
TypeRef(symbol.owner.thisType, symbol.name.asTypeName, this)
/** The typeRef applied to its own type parameters */
def appliedRef(implicit ctx: Context): Type =
typeRef.appliedTo(symbol.typeParams.map(_.typeRef))
/** The TermRef representing this term denotation at its original location. */
def termRef(implicit ctx: Context): TermRef =
TermRef(symbol.owner.thisType, symbol.name.asTermName, this)
/** The NamedType representing this denotation at its original location.
* Same as either `typeRef` or `termRef` depending whether this denotes a type or not.
*/
def namedType(implicit ctx: Context): NamedType =
if (isType) typeRef else termRef
// ------ Transformations -----------------------------------------
private[this] var myValidFor: Period = Nowhere
def validFor: Period = myValidFor
def validFor_=(p: Period): Unit = {
myValidFor = p
symbol.invalidateDenotCache()
}
/** The next SingleDenotation in this run, with wrap-around from last to first.
*
* There may be several `SingleDenotation`s with different validity
* representing the same underlying definition at different phases.
* These are called a "flock". Flock members are generated by
* @See current. Flock members are connected in a ring
* with their `nextInRun` fields.
*
* There are the following invariants concerning flock members
*
* 1) validity periods are non-overlapping
* 2) the union of all validity periods is a contiguous
* interval.
*/
protected var nextInRun: SingleDenotation = this
/** The version of this SingleDenotation that was valid in the first phase
* of this run.
*/
def initial: SingleDenotation =
if (validFor.firstPhaseId <= 1) this
else {
var current = nextInRun
while (current.validFor.code > this.myValidFor.code) current = current.nextInRun
current
}
def history: List[SingleDenotation] = {
val b = new ListBuffer[SingleDenotation]
var current = initial
do {
b += (current)
current = current.nextInRun
}
while (current ne initial)
b.toList
}
/** Invalidate all caches and fields that depend on base classes and their contents */
def invalidateInheritedInfo(): Unit = ()
private def updateValidity()(implicit ctx: Context): this.type = {
assert(ctx.runId >= validFor.runId || ctx.settings.YtestPickler.value, // mixing test pickler with debug printing can travel back in time
s"denotation $this invalid in run ${ctx.runId}. ValidFor: $validFor")
var d: SingleDenotation = this
do {
d.validFor = Period(ctx.period.runId, d.validFor.firstPhaseId, d.validFor.lastPhaseId)
d.invalidateInheritedInfo()
d = d.nextInRun
} while (d ne this)
this
}
/** Move validity period of this denotation to a new run. Throw a StaleSymbol error
* if denotation is no longer valid.
* However, StaleSymbol error is not thrown in the following situations:
*
* - If ctx.acceptStale returns true (e.g. because we are in the IDE),
* update the symbol to the new version if it exists, or return
* the old version otherwise.
* - If the symbol did not have a denotation that was defined at the current phase
* return a NoDenotation instead.
*/
private def bringForward()(implicit ctx: Context): SingleDenotation = {
this match {
case symd: SymDenotation =>
if (ctx.stillValid(symd)) return updateValidity()
if (ctx.acceptStale(symd)) return symd.currentSymbol.denot.orElse(symd).updateValidity()
case _ =>
}
if (!symbol.exists) return updateValidity()
if (!coveredInterval.containsPhaseId(ctx.phaseId)) return NoDenotation
if (ctx.debug) ctx.traceInvalid(this)
staleSymbolError
}
/** The next defined denotation (following `nextInRun`) or an arbitrary
* undefined denotation, if all denotations in a `nextinRun` cycle are
* undefined.
*/
private def nextDefined: SingleDenotation = {
var p1 = this
var p2 = nextInRun
while (p1.validFor == Nowhere && (p1 ne p2)) {
p1 = p1.nextInRun
p2 = p2.nextInRun.nextInRun
}
p1
}
/** Skip any denotations that have been removed by an installAfter or that
* are otherwise undefined.
*/
def skipRemoved(implicit ctx: Context): SingleDenotation =
if (myValidFor.code <= 0) nextDefined else this
/** Produce a denotation that is valid for the given context.
* Usually called when !(validFor contains ctx.period)
* (even though this is not a precondition).
* If the runId of the context is the same as runId of this denotation,
* the right flock member is located, or, if it does not exist yet,
* created by invoking a transformer (@See Transformers).
* If the runId's differ, but this denotation is a SymDenotation
* and its toplevel owner class or module
* is still a member of its enclosing package, then the whole flock
* is brought forward to be valid in the new runId. Otherwise
* the symbol is stale, which constitutes an internal error.
*/
def current(implicit ctx: Context): SingleDenotation = {
val currentPeriod = ctx.period
val valid = myValidFor
if (valid.code <= 0) {
// can happen if we sit on a stale denotation which has been replaced
// wholesale by an installAfter; in this case, proceed to the next
// denotation and try again.
val nxt = nextDefined
if (nxt.validFor != Nowhere) return nxt
assert(false, this)
}
if (valid.runId != currentPeriod.runId)
if (exists) initial.bringForward().current
else this
else {
var cur = this
if (currentPeriod.code > valid.code) {
// search for containing period as long as nextInRun increases.
var next = nextInRun
while (next.validFor.code > valid.code && !(next.validFor contains currentPeriod)) {
cur = next
next = next.nextInRun
}
if (next.validFor.code > valid.code) {
// in this case, next.validFor contains currentPeriod
cur = next
cur
} else {
//println(s"might need new denot for $cur, valid for ${cur.validFor} at $currentPeriod")
// not found, cur points to highest existing variant
val nextTransformerId = ctx.base.nextDenotTransformerId(cur.validFor.lastPhaseId)
if (currentPeriod.lastPhaseId <= nextTransformerId)
cur.validFor = Period(currentPeriod.runId, cur.validFor.firstPhaseId, nextTransformerId)
else {
var startPid = nextTransformerId + 1
val transformer = ctx.base.denotTransformers(nextTransformerId)
//println(s"transforming $this with $transformer")
try {
next = transformer.transform(cur)(ctx.withPhase(transformer))
} catch {
case ex: CyclicReference =>
println(s"error while transforming $this") // DEBUG
throw ex
}
if (next eq cur)
startPid = cur.validFor.firstPhaseId
else {
next match {
case next: ClassDenotation =>
assert(!next.is(Package), s"illegal transformation of package denotation by transformer ${ctx.withPhase(transformer).phase}")
case _ =>
}
next.insertAfter(cur)
cur = next
}
cur.validFor = Period(currentPeriod.runId, startPid, transformer.lastPhaseId)
//printPeriods(cur)
//println(s"new denot: $cur, valid for ${cur.validFor}")
}
cur.current // multiple transformations could be required
}
} else {
// currentPeriod < end of valid; in this case a version must exist
// but to be defensive we check for infinite loop anyway
var cnt = 0
while (!(cur.validFor contains currentPeriod)) {
//println(s"searching: $cur at $currentPeriod, valid for ${cur.validFor}")
cur = cur.nextInRun
// Note: One might be tempted to add a `prev` field to get to the new denotation
// more directly here. I tried that, but it degrades rather than improves
// performance: Test setup: Compile everything in dotc and immediate subdirectories
// 10 times. Best out of 10: 18154ms with `prev` field, 17777ms without.
cnt += 1
if (cnt > MaxPossiblePhaseId)
return current(ctx.withPhase(coveredInterval.firstPhaseId))
}
cur
}
}
}
private def demandOutsideDefinedMsg(implicit ctx: Context): String =
s"demanding denotation of $this at phase ${ctx.phase}(${ctx.phaseId}) outside defined interval: defined periods are${definedPeriodsString}"
/** Install this denotation to be the result of the given denotation transformer.
* This is the implementation of the same-named method in SymDenotations.
* It's placed here because it needs access to private fields of SingleDenotation.
* @pre Can only be called in `phase.next`.
*/
protected def installAfter(phase: DenotTransformer)(implicit ctx: Context): Unit = {
val targetId = phase.next.id
if (ctx.phaseId != targetId) installAfter(phase)(ctx.withPhase(phase.next))
else {
val current = symbol.current
// println(s"installing $this after $phase/${phase.id}, valid = ${current.validFor}")
// printPeriods(current)
this.validFor = Period(ctx.runId, targetId, current.validFor.lastPhaseId)
if (current.validFor.firstPhaseId >= targetId)
current.replaceWith(this)
else {
current.validFor = Period(ctx.runId, current.validFor.firstPhaseId, targetId - 1)
insertAfter(current)
}
// printPeriods(this)
}
}
/** Apply a transformation `f` to all denotations in this group that start at or after
* given phase. Denotations are replaced while keeping the same validity periods.
*/
protected def transformAfter(phase: DenotTransformer, f: SymDenotation => SymDenotation)(implicit ctx: Context): Unit = {
var current = symbol.current
while (current.validFor.firstPhaseId < phase.id && (current.nextInRun.validFor.code > current.validFor.code))
current = current.nextInRun
var hasNext = true
while ((current.validFor.firstPhaseId >= phase.id) && hasNext) {
val current1: SingleDenotation = f(current.asSymDenotation)
if (current1 ne current) {
current1.validFor = current.validFor
current.replaceWith(current1)
}
hasNext = current1.nextInRun.validFor.code > current1.validFor.code
current = current1.nextInRun
}
}
/** Insert this denotation so that it follows `prev`. */
private def insertAfter(prev: SingleDenotation) = {
this.nextInRun = prev.nextInRun
prev.nextInRun = this
}
/** Insert this denotation instead of `old`.
* Also ensure that `old` refers with `nextInRun` to this denotation