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
|
package dotty.tools
package dottydoc
package core
import dotc.CompilationUnit
import dotc.core.Contexts.Context
import dotc.core.Comments.ContextDocstrings
import dotc.core.Phases.Phase
import model._
import model.internal._
import util.syntax._
object transform {
/**
* The idea behind DocMiniTransformations is to fuse transformations to the
* doc AST, much like `MiniPhaseTransform` in dotty core - but in a much more
* simple implementation
*
* Usage
* -----
*
* Create a `DocMiniPhase` which overrides the relevant method:
*
* ```scala
* override def transformDef(implicit ctx: Context) = {
* case x if shouldTransform(x) => x.copy(newValue = ...)
* }
* ```
*
* On each node in the AST, the appropriate method in `DocMiniPhase` will be
* called in the order that they are supplied in
* `DocMiniphaseTransformations`.
*
* There won't be a match-error as `transformX` is composed with an
* `identity` function.
*
* The transformations in `DocMiniTransformations` will apply transformations
* to all nodes - this means that you do _not_ need to transform children in
* `transformPackage`, because `transformX` will be called for the relevant
* children. If you want to add children to `Package` you need to do that in
* `transformPackage`, these additions will be persisted.
*
* Deleting nodes in the AST
* -------------------------
* To delete a node in the AST, simply return NonEntity from transforming method
*/
abstract class DocMiniTransformations(transformations: List[DocMiniPhase]) extends Phase {
override def runOn(units: List[CompilationUnit])(implicit ctx: Context): List[CompilationUnit] = {
for {
rootName <- rootPackages
pack = ctx.docbase.packages(rootName)
transformed = performPackageTransform(pack)
} yield ctx.docbase.packagesMutable(rootName) = transformed
super.runOn(units)
}
private def rootPackages(implicit ctx: Context): List[String] = {
var currentDepth = Int.MaxValue
var packs = List.empty[String]
for (key <- ctx.docbase.packages.keys) {
val keyDepth = key.split("\\.").length
packs =
if (keyDepth < currentDepth) {
currentDepth = keyDepth
key :: Nil
} else if (keyDepth == currentDepth) {
key :: packs
} else packs
}
packs
}
private def performPackageTransform(pack: Package)(implicit ctx: Context): Package = {
def transformEntity[E <: Entity](e: E, f: DocMiniPhase => E => E)(createNew: E => E): Entity = {
val transformedEntity = transformations.foldLeft(e) { case (oldE, transf) =>
f(transf)(oldE)
}
if (transformedEntity eq NonEntity) NonEntity
else createNew(transformedEntity)
}
def traverse(ent: Entity): Entity = ent match {
case p: Package => transformEntity(p, _.packageTransformation) { p =>
val newPackage = PackageImpl(
p.symbol,
p.annotations,
p.name,
p.members.map(traverse).filterNot(_ eq NonEntity),
p.path,
p.superTypes,
p.comment
)
// Update reference in context to newPackage
ctx.docbase.packagesMutable += (newPackage.path.mkString(".") -> newPackage)
newPackage
}
case t: TypeAlias => transformEntity(t, _.typeAliasTransformation) { t =>
TypeAliasImpl(
t.symbol,
t.annotations,
t.modifiers,
t.name,
t.path,
t.alias,
t.comment
)
}
case c: Class => transformEntity(c, _.classTransformation) { cls =>
ClassImpl(
cls.symbol,
cls.annotations,
cls.name,
cls.members.map(traverse).filterNot(_ eq NonEntity),
cls.modifiers,
cls.path,
cls.typeParams,
cls.constructors,
cls.superTypes,
cls.comment
)
}
case cc: CaseClass => transformEntity(cc, _.caseClassTransformation) { cc =>
CaseClassImpl(
cc.symbol,
cc.annotations,
cc.name,
cc.members.map(traverse).filterNot(_ eq NonEntity),
cc.modifiers,
cc.path,
cc.typeParams,
cc.constructors,
cc.superTypes,
cc.comment
)
}
case trt: Trait => transformEntity(trt, _.traitTransformation) { trt =>
TraitImpl(
trt.symbol,
trt.annotations,
trt.name,
trt.members.map(traverse).filterNot(_ eq NonEntity),
trt.modifiers,
trt.path,
trt.typeParams,
trt.traitParams,
trt.superTypes,
trt.comment
)
}
case obj: Object => transformEntity(obj, _.objectTransformation) { obj =>
ObjectImpl(
obj.symbol,
obj.annotations,
obj.name,
obj.members.map(traverse).filterNot(_ eq NonEntity),
obj.modifiers,
obj.path,
obj.superTypes,
obj.comment
)
}
case df: Def => transformEntity(df, _.defTransformation) { df =>
DefImpl(
df.symbol,
df.annotations,
df.name,
df.modifiers,
df.path,
df.returnValue,
df.typeParams,
df.paramLists,
df.comment,
df.implicitlyAddedFrom
)
}
case vl: Val => transformEntity(vl, _.valTransformation) { vl =>
ValImpl(
vl.symbol,
vl.annotations,
vl.name,
vl.modifiers,
vl.path,
vl.returnValue,
vl.kind,
vl.comment,
vl.implicitlyAddedFrom
)
}
}
traverse(pack).asInstanceOf[Package]
}
override def run(implicit ctx: Context): Unit = ()
}
object DocMiniTransformations {
private var previousPhase = 0
def apply(transformations: DocMiniPhase*) =
new DocMiniTransformations(transformations.toList) {
val packages = Map.empty[String, Package]
def phaseName = s"MiniTransformation${ previousPhase += 1 }"
}
}
trait DocMiniPhase { phase =>
private def identity[E]: PartialFunction[E, E] = {
case id: E @unchecked => id
}
def transformPackage(implicit ctx: Context): PartialFunction[Package, Package] = identity
def transformTypeAlias(implicit ctx: Context): PartialFunction[TypeAlias, TypeAlias] = identity
def transformClass(implicit ctx: Context): PartialFunction[Class, Class] = identity
def transformCaseClass(implicit ctx: Context): PartialFunction[CaseClass, CaseClass] = identity
def transformTrait(implicit ctx: Context): PartialFunction[Trait, Trait] = identity
def transformObject(implicit ctx: Context): PartialFunction[Object, Object] = identity
def transformDef(implicit ctx: Context): PartialFunction[Def, Def] = identity
def transformVal(implicit ctx: Context): PartialFunction[Val, Val] = identity
private[transform] def packageTransformation(p: Package)(implicit ctx: Context) = (transformPackage orElse identity)(p)
private[transform] def typeAliasTransformation(alias: TypeAlias)(implicit ctx: Context) = (transformTypeAlias orElse identity)(alias)
private[transform] def classTransformation(cls: Class)(implicit ctx: Context) = (transformClass orElse identity)(cls)
private[transform] def caseClassTransformation(cc: CaseClass)(implicit ctx: Context) = (transformCaseClass orElse identity)(cc)
private[transform] def traitTransformation(trt: Trait)(implicit ctx: Context) = (transformTrait orElse identity)(trt)
private[transform] def objectTransformation(obj: Object)(implicit ctx: Context) = (transformObject orElse identity)(obj)
private[transform] def defTransformation(df: Def)(implicit ctx: Context) = (transformDef orElse identity)(df)
private[transform] def valTransformation(vl: Val)(implicit ctx: Context) = (transformVal orElse identity)(vl)
}
}
|
