-
Notifications
You must be signed in to change notification settings - Fork 391
/
GenJSCode.scala
4664 lines (4057 loc) · 173 KB
/
GenJSCode.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
/* Scala.js compiler
* Copyright 2013 LAMP/EPFL
* @author Sébastien Doeraene
*/
package org.scalajs.core.compiler
import scala.language.implicitConversions
import scala.annotation.switch
import scala.collection.mutable
import scala.collection.mutable.ListBuffer
import scala.tools.nsc._
import scala.annotation.tailrec
import org.scalajs.core.ir
import ir.{Trees => js, Types => jstpe, ClassKind, Hashers}
import ir.Trees.OptimizerHints
import util.ScopedVar
import ScopedVar.withScopedVars
/** Generate JavaScript code and output it to disk
*
* @author Sébastien Doeraene
*/
abstract class GenJSCode extends plugins.PluginComponent
with TypeKinds
with JSEncoding
with GenJSExports
with GenJSFiles
with PluginComponent210Compat {
val jsAddons: JSGlobalAddons {
val global: GenJSCode.this.global.type
}
val scalaJSOpts: ScalaJSOptions
import global._
import jsAddons._
import rootMirror._
import definitions._
import jsDefinitions._
import jsInterop.{jsNameOf, fullJSNameOf}
import JSTreeExtractors._
import treeInfo.hasSynthCaseSymbol
import platform.isMaybeBoxed
val phaseName: String = "jscode"
override val description: String = "generate JavaScript code from ASTs"
/** testing: this will be called when ASTs are generated */
def generatedJSAST(clDefs: List[js.Tree]): Unit
/** Implicit conversion from nsc Position to ir.Position. */
implicit def pos2irPos(pos: Position): ir.Position = {
if (pos == NoPosition) ir.Position.NoPosition
else {
val source = pos2irPosCache.toIRSource(pos.source)
// nsc positions are 1-based but IR positions are 0-based
ir.Position(source, pos.line-1, pos.column-1)
}
}
private[this] object pos2irPosCache { // scalastyle:ignore
import scala.reflect.internal.util._
private[this] var lastNscSource: SourceFile = null
private[this] var lastIRSource: ir.Position.SourceFile = null
def toIRSource(nscSource: SourceFile): ir.Position.SourceFile = {
if (nscSource != lastNscSource) {
lastIRSource = convert(nscSource)
lastNscSource = nscSource
}
lastIRSource
}
private[this] def convert(nscSource: SourceFile): ir.Position.SourceFile = {
nscSource.file.file match {
case null =>
new java.net.URI(
"virtualfile", // Pseudo-Scheme
nscSource.file.path, // Scheme specific part
null // Fragment
)
case file =>
val srcURI = file.toURI
def matches(pat: java.net.URI) = pat.relativize(srcURI) != srcURI
scalaJSOpts.sourceURIMaps.collectFirst {
case ScalaJSOptions.URIMap(from, to) if matches(from) =>
val relURI = from.relativize(srcURI)
to.fold(relURI)(_.resolve(relURI))
} getOrElse srcURI
}
}
def clear(): Unit = {
lastNscSource = null
lastIRSource = null
}
}
/** Materialize implicitly an ir.Position from an implicit nsc Position. */
implicit def implicitPos2irPos(implicit pos: Position): ir.Position = pos
override def newPhase(p: Phase): StdPhase = new JSCodePhase(p)
private object jsnme { // scalastyle:ignore
val arg_outer = newTermName("arg$outer")
val newString = newTermName("newString")
}
class JSCodePhase(prev: Phase) extends StdPhase(prev) with JSExportsPhase {
override def name: String = phaseName
override def description: String = GenJSCode.this.description
override def erasedTypes: Boolean = true
// Some state --------------------------------------------------------------
val currentClassSym = new ScopedVar[Symbol]
val currentMethodSym = new ScopedVar[Symbol]
val thisLocalVarIdent = new ScopedVar[Option[js.Ident]](None)
val fakeTailJumpParamRepl = new ScopedVar[(Symbol, Symbol)]((NoSymbol, NoSymbol))
val enclosingLabelDefParams = new ScopedVar(Map.empty[Symbol, List[Symbol]])
val mutableLocalVars = new ScopedVar[mutable.Set[Symbol]]
val mutatedLocalVars = new ScopedVar[mutable.Set[Symbol]]
val unexpectedMutatedFields = new ScopedVar[mutable.Set[Symbol]]
val paramAccessorLocals = new ScopedVar(Map.empty[Symbol, js.ParamDef])
var isModuleInitialized: Boolean = false // see genApply for super calls
val countsOfReturnsToMatchEnd = mutable.Map.empty[Symbol, Int]
private def currentClassType = encodeClassType(currentClassSym)
val tryingToGenMethodAsJSFunction = new ScopedVar[Boolean](false)
class CancelGenMethodAsJSFunction(message: String)
extends Throwable(message) with scala.util.control.ControlThrowable
// Rewriting of anonymous function classes ---------------------------------
// scalastyle:off disallow.space.after.token
private val translatedAnonFunctions =
mutable.Map.empty[Symbol,
/*ctor args:*/ List[js.Tree] => /*instance:*/ js.Tree]
private val instantiatedAnonFunctions =
mutable.Set.empty[Symbol]
private val undefinedDefaultParams =
mutable.Set.empty[Symbol]
// scalastyle:on disallow.space.after.token
// Top-level apply ---------------------------------------------------------
override def run(): Unit = {
scalaPrimitives.init()
initializeCoreBTypesCompat()
jsPrimitives.init()
super.run()
}
/** Generates the Scala.js IR for a compilation unit
* This method iterates over all the class and interface definitions
* found in the compilation unit and emits their IR (.sjsir).
*
* Some classes are never actually emitted:
* - Classes representing primitive types
* - The scala.Array class
* - Implementation classes for raw JS traits
*
* Some classes representing anonymous functions are not actually emitted.
* Instead, a temporary representation of their `apply` method is built
* and recorded, so that it can be inlined as a JavaScript anonymous
* function in the method that instantiates it.
*
* Other ClassDefs are emitted according to their nature:
* * Scala.js-defined JS class -> `genScalaJSDefinedJSClass()`
* * Other raw JS type (<: js.Any) -> `genRawJSClassData()`
* * Interface -> `genInterface()`
* * Implementation class -> `genImplClass()`
* * Normal class -> `genClass()`
*/
override def apply(cunit: CompilationUnit): Unit = {
try {
val generatedClasses = ListBuffer.empty[(Symbol, js.ClassDef)]
def collectClassDefs(tree: Tree): List[ClassDef] = {
tree match {
case EmptyTree => Nil
case PackageDef(_, stats) => stats flatMap collectClassDefs
case cd: ClassDef => cd :: Nil
}
}
val allClassDefs = collectClassDefs(cunit.body)
/* First gen and record lambdas for js.FunctionN and js.ThisFunctionN.
* Since they are SAMs, there cannot be dependencies within this set,
* and hence we are sure we can record them before they are used,
* which is critical for these.
*/
val nonRawJSFunctionDefs = allClassDefs filterNot { cd =>
if (isRawJSFunctionDef(cd.symbol)) {
genAndRecordRawJSFunctionClass(cd)
true
} else {
false
}
}
/* Then try to gen and record lambdas for scala.FunctionN.
* These may fail, and sometimes because of dependencies. Since there
* appears to be more forward dependencies than backward dependencies
* (at least for non-nested lambdas, which we cannot translate anyway),
* we process class defs in reverse order here.
*/
val fullClassDefs = (nonRawJSFunctionDefs.reverse filterNot { cd =>
cd.symbol.isAnonymousFunction && tryGenAndRecordAnonFunctionClass(cd)
}).reverse
/* Finally, we emit true code for the remaining class defs. */
for (cd <- fullClassDefs) {
val sym = cd.symbol
implicit val pos = sym.pos
/* Do not actually emit code for primitive types nor scala.Array. */
val isPrimitive =
isPrimitiveValueClass(sym) || (sym == ArrayClass)
/* Similarly, do not emit code for impl classes of raw JS traits. */
val isRawJSImplClass =
sym.isImplClass && isRawJSType(
sym.owner.info.decl(sym.name.dropRight(nme.IMPL_CLASS_SUFFIX.length)).tpe)
if (!isPrimitive && !isRawJSImplClass) {
withScopedVars(
currentClassSym := sym,
unexpectedMutatedFields := mutable.Set.empty
) {
val tree = if (isRawJSType(sym.tpe)) {
assert(!isRawJSFunctionDef(sym),
s"Raw JS function def should have been recorded: $cd")
if (!sym.isInterface && isScalaJSDefinedJSClass(sym))
genScalaJSDefinedJSClass(cd)
else
genRawJSClassData(cd)
} else if (sym.isInterface) {
genInterface(cd)
} else if (sym.isImplClass) {
genImplClass(cd)
} else {
genClass(cd)
}
generatedClasses += ((sym, tree))
}
}
}
val clDefs = generatedClasses.map(_._2).toList
generatedJSAST(clDefs)
for ((sym, tree) <- generatedClasses) {
genIRFile(cunit, sym, tree)
}
} finally {
translatedAnonFunctions.clear()
instantiatedAnonFunctions.clear()
undefinedDefaultParams.clear()
countsOfReturnsToMatchEnd.clear()
pos2irPosCache.clear()
}
}
// Generate a class --------------------------------------------------------
/** Gen the IR ClassDef for a class definition (maybe a module class).
*/
def genClass(cd: ClassDef): js.ClassDef = {
val ClassDef(mods, name, _, impl) = cd
val sym = cd.symbol
implicit val pos = sym.pos
assert(!sym.isInterface && !sym.isImplClass,
"genClass() must be called only for normal classes: "+sym)
assert(sym.superClass != NoSymbol, sym)
if (hasDefaultCtorArgsAndRawJSModule(sym)) {
reporter.error(pos,
"Implementation restriction: constructors of " +
"Scala classes cannot have default parameters " +
"if their companion module is JS native.")
}
val classIdent = encodeClassFullNameIdent(sym)
val isHijacked = isHijackedBoxedClass(sym)
// Optimizer hints
def isStdLibClassWithAdHocInlineAnnot(sym: Symbol): Boolean = {
val fullName = sym.fullName
(fullName.startsWith("scala.Tuple") && !fullName.endsWith("$")) ||
(fullName.startsWith("scala.collection.mutable.ArrayOps$of"))
}
val shouldMarkInline = (
sym.hasAnnotation(InlineAnnotationClass) ||
(sym.isAnonymousFunction && !sym.isSubClass(PartialFunctionClass)) ||
isStdLibClassWithAdHocInlineAnnot(sym))
val optimizerHints =
OptimizerHints.empty.
withInline(shouldMarkInline).
withNoinline(sym.hasAnnotation(NoinlineAnnotationClass))
// Generate members (constructor + methods)
val generatedMethods = new ListBuffer[js.MethodDef]
val exportedSymbols = new ListBuffer[Symbol]
def gen(tree: Tree): Unit = {
tree match {
case EmptyTree => ()
case Template(_, _, body) => body foreach gen
case ValDef(mods, name, tpt, rhs) =>
() // fields are added via genClassFields()
case dd: DefDef =>
val sym = dd.symbol
val isExport = jsInterop.isExport(sym)
val isNamedExport = isExport && sym.annotations.exists(
_.symbol == JSExportNamedAnnotation)
if (isNamedExport)
generatedMethods += genNamedExporterDef(dd)
else
generatedMethods ++= genMethod(dd)
if (isExport) {
// We add symbols that we have to export here. This way we also
// get inherited stuff that is implemented in this class.
exportedSymbols += sym
}
case _ => abort("Illegal tree in gen of genClass(): " + tree)
}
}
gen(impl)
// Generate fields if necessary (and add to methods + ctors)
val generatedMembers =
if (!isHijacked) genClassFields(cd) ++ generatedMethods.toList
else generatedMethods.toList // No fields needed
// Generate the exported members, constructors and accessors
val exports = {
// Generate the exported members
val memberExports = genMemberExports(sym, exportedSymbols.toList)
// Generate exported constructors or accessors
val exportedConstructorsOrAccessors =
if (isStaticModule(sym)) genModuleAccessorExports(sym)
else genConstructorExports(sym)
memberExports ++ exportedConstructorsOrAccessors
}
// Hashed definitions of the class
val hashedDefs =
Hashers.hashDefs(generatedMembers ++ exports)
// The complete class definition
val kind =
if (isStaticModule(sym)) ClassKind.ModuleClass
else if (isHijacked) ClassKind.HijackedClass
else ClassKind.Class
val classDefinition = js.ClassDef(
classIdent,
kind,
Some(encodeClassFullNameIdent(sym.superClass)),
genClassInterfaces(sym),
None,
hashedDefs)(
optimizerHints)
classDefinition
}
/** Gen the IR ClassDef for a Scala.js-defined JS class. */
def genScalaJSDefinedJSClass(cd: ClassDef): js.ClassDef = {
val sym = cd.symbol
implicit val pos = sym.pos
assert(isScalaJSDefinedJSClass(sym),
"genScalaJSDefinedJSClass() must be called only for " +
s"Scala.js-defined JS classes: $sym")
assert(sym.superClass != NoSymbol, sym)
val classIdent = encodeClassFullNameIdent(sym)