-
Notifications
You must be signed in to change notification settings - Fork 530
/
Boilerplate.scala
490 lines (436 loc) · 13.8 KB
/
Boilerplate.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
/*
* Copyright (c) 2011-14 Miles Sabin
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
import sbt._
/**
* Generate a range of boilerplate classes, those offering alternatives with 0-22 params
* and would be tedious to craft by hand
*
* @author Miles Sabin
* @author Kevin Wright
*/
object Boilerplate {
import scala.StringContext._
implicit class BlockHelper(val sc: StringContext) extends AnyVal {
def block(args: Any*): String = {
val interpolated = sc.standardInterpolator(treatEscapes, args)
val rawLines = interpolated split '\n'
val trimmedLines = rawLines map { _ dropWhile (_.isWhitespace) }
trimmedLines mkString "\n"
}
}
val templates: Seq[Template] = List(
GenTuplerInstances,
GenFnToProductInstances,
GenFnFromProductInstances,
GenCaseInst,
GenPolyApply,
GenPolyInst,
GenCases,
GenPolyNTraits,
GenNats,
GenTupleTypeableInstances,
GenSizedBuilder,
GenHMapBuilder,
GenUnpackInstances
)
/** Returns a seq of the generated files. As a side-effect, it actually generates them... */
def gen(dir : File) = for(t <- templates) yield {
val tgtFile = dir / "shapeless" / t.filename
IO.write(tgtFile, t.body)
tgtFile
}
val header = """
|/*
| * Copyright (c) 2011-14 Miles Sabin
| *
| * Licensed under the Apache License, Version 2.0 (the "License");
| * you may not use this file except in compliance with the License.
| * You may obtain a copy of the License at
| *
| * http://www.apache.org/licenses/LICENSE-2.0
| *
| * Unless required by applicable law or agreed to in writing, software
| * distributed under the License is distributed on an "AS IS" BASIS,
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
| * See the License for the specific language governing permissions and
| * limitations under the License.
| */
|
|package shapeless
""".stripMargin
class TemplateVals(val arity: Int) {
val synTypes = (0 until arity) map (n => (n+'A').toChar)
val synVals = (0 until arity) map (n => (n+'a').toChar)
val synTypedVals = (synVals zip synTypes) map { case (v,t) => v + ":" + t}
val `A..N` = synTypes.mkString(", ")
val `A..N,Res` = (synTypes :+ "Res") mkString ", "
val `a..n` = synVals.mkString(", ")
val `A::N` = (synTypes :+ "HNil") mkString "::"
val `a::n` = (synVals :+ "HNil") mkString "::"
val `_.._` = Seq.fill(arity)("_").mkString(", ")
val `(A..N)` = if (arity == 1) "Tuple1[A]" else synTypes.mkString("(", ", ", ")")
val `(_.._)` = if (arity == 1) "Tuple1[_]" else Seq.fill(arity)("_").mkString("(", ", ", ")")
val `(a..n)` = if (arity == 1) "Tuple1(a)" else synVals.mkString("(", ", ", ")")
val `a:A..n:N` = synTypedVals mkString ", "
}
trait Template {
def filename: String
def content(tv: TemplateVals): String
def range = 1 to 22
def body: String = {
val headerLines = header split '\n'
val rawContents = range map { n => content(new TemplateVals(n)) split '\n' filterNot (_.isEmpty) }
val preBody = rawContents.head takeWhile (_ startsWith "|") map (_.tail)
val instances = rawContents flatMap {_ filter (_ startsWith "-") map (_.tail) }
val postBody = rawContents.head dropWhile (_ startsWith "|") dropWhile (_ startsWith "-") map (_.tail)
(headerLines ++ preBody ++ instances ++ postBody) mkString "\n"
}
}
/*
Blocks in the templates below use a custom interpolator, combined with post-processing to produce the body
- The contents of the `header` val is output first
- Then the first block of lines beginning with '|'
- Then the block of lines beginning with '-' is replicated once for each arity,
with the `templateVals` already pre-populated with relevant relevant vals for that arity
- Then the last block of lines prefixed with '|'
The block otherwise behaves as a standard interpolated string with regards to variable substitution.
*/
object GenTuplerInstances extends Template {
val filename = "tupler.scala"
def content(tv: TemplateVals) = {
import tv._
block"""
|package ops
|
|import hlist.Tupler
|
|trait TuplerInstances {
| type Aux[L <: HList, Out0] = Tupler[L] { type Out = Out0 }
-
- implicit def hlistTupler${arity}
- [${`A..N`}]
- : Aux[
- ${`A::N`},
- ${`(A..N)`}
- ] =
- new Tupler[${`A::N`}] {
- type Out = ${`(A..N)`}
- def apply(l : ${`A::N`}): Out = l match { case ${`a::n`} => ${`(a..n)`} }
- }
|}
"""
}
}
object GenFnToProductInstances extends Template {
val filename = "fntoproduct.scala"
override val range = 0 to 22
def content(tv: TemplateVals) = {
import tv._
val fnType = s"(${`A..N`}) => Res"
val hlistFnType = s"(${`A::N`}) => Res"
val fnBody = if (arity == 0) "fn()" else s"l match { case ${`a::n`} => fn(${`a..n`}) }"
block"""
|package ops
|
|import function.FnToProduct
|
|trait FnToProductInstances {
| type Aux[F, Out0] = FnToProduct[F] { type Out = Out0 }
-
- implicit def fnToProduct${arity}
- [${`A..N,Res`}]
- : Aux[
- (${fnType}),
- ${hlistFnType}
- ] =
- new FnToProduct[${fnType}] {
- type Out = ${hlistFnType}
- def apply(fn: ${fnType}): Out
- = (l : ${`A::N`})
- => ${fnBody}
- }
|}
"""
}
}
object GenFnFromProductInstances extends Template {
val filename = "fnfromproduct.scala"
override val range = 0 to 22
def content(tv: TemplateVals) = {
import tv._
val fnType = s"(${`A..N`}) => Res"
val hlistFnType = s"(${`A::N`}) => Res"
block"""
|package ops
|
|import function.FnFromProduct
|
|trait FnFromProductInstances {
| type Aux[F, Out0] = FnFromProduct[F] { type Out = Out0 }
|
- implicit def fnFromProduct${arity}
- [${`A..N,Res`}]
- : Aux[
- ${hlistFnType},
- ${fnType}
- ] =
- new FnFromProduct[${hlistFnType}] {
- type Out = ${fnType}
- def apply(hf : ${hlistFnType}): Out
- = (${`a:A..n:N`})
- => hf(${`a::n`})
- }
-
|}
"""
}
}
object GenCaseInst extends Template {
val filename = "caseinst.scala"
def content(tv: TemplateVals) = {
import tv._
block"""
|
|trait CaseInst {
| import poly._
|
- implicit def inst${arity}
- [Fn <: Poly, ${`A..N`}, Res]
- (cse : Case[Fn, ${`A::N`}] { type Result = Res })
- : (${`A..N`}) => Res =
- (${`a:A..n:N`})
- => cse.value(${`a::n`})
-
|}
"""
}
}
object GenPolyApply extends Template {
val filename = "polyapply.scala"
def content(tv: TemplateVals) = {
import tv._
block"""
|
|trait PolyApply {
| import poly._
- def apply
- [${`A..N`}]
- (${`a:A..n:N`})
- (implicit cse : Case[this.type, ${`A::N`}])
- : cse.Result =
- cse(${`a::n`})
-
|}
"""
}
}
object GenPolyInst extends Template {
val filename = "polyinst.scala"
def content(tv: TemplateVals) = {
import tv._
block"""
|
|trait PolyInst {
|
- implicit def inst${arity}
- [${`A..N`}]
- (fn : Poly)(implicit cse : fn.ProductCase[${`A::N`}])
- : (${`A..N`}) => cse.Result =
- (${`a:A..n:N`})
- => cse(${`a::n`})
-
|}
"""
}
}
object GenCases extends Template {
val filename = "cases.scala"
def content(tv: TemplateVals) = {
import tv._
block"""
|
|trait Cases {
| import poly._
|
- type Case${arity}[Fn, ${`A..N`}]
- = Case[Fn, ${`A::N`}]
-
- object Case${arity} {
- type Aux[Fn, ${`A..N`}, Result0]
- = Case[Fn, ${`A::N`}] { type Result = Result0 }
-
- def apply
- [Fn, ${`A..N`}, Result0]
- (fn: (${`A..N`}) => Result0)
- : Aux[Fn, ${`A..N`}, Result0] =
- new Case[Fn, ${`A::N`}] {
- type Result = Result0
- val value = (l: ${`A::N`})
- => l match {
- case ${`a::n`} =>
- fn(${`a..n`})
- }
- }
- }
-
|}
"""
}
}
object GenPolyNTraits extends Template {
val filename = "polyntraits.scala"
def content(tv: TemplateVals) = {
import tv._
val fnBody = if (arity == 0) "fn()" else s"l match { case ${`a::n`} => fn(${`a..n`}) }"
block"""
|
-
-trait Poly${arity} extends Poly { outer =>
- type Case[${`A..N`}]
- = poly.Case[this.type, ${`A::N`}]
-
- object Case {
- type Aux[${`A..N`}, Result0]
- = poly.Case[outer.type, ${`A::N`}] { type Result = Result0 }
- }
-
- class CaseBuilder[${`A..N`}] {
- def apply[Res]
- (fn: (${`A..N`}) => Res) = new Case[${`A..N`}] {
- type Result = Res
- val value = (l: ${`A::N`})
- => ${fnBody}
- }
- }
-
- def at[${`A..N`}]
- = new CaseBuilder[${`A..N`}]
-}
|
"""
}
}
object GenNats extends Template {
val filename = "nats.scala"
def content(tv: TemplateVals) = {
val n = tv.arity
block"""
|
|trait Nats {
-
- type _${n} = Succ[_${n-1}]
- val _${n}: _${n} = new _${n}
|}
"""
}
}
object GenTupleTypeableInstances extends Template {
val filename = "tupletypeables.scala"
def content(tv: TemplateVals) = {
import tv._
val implicitArgs = (synTypes map(a => s"cast${a}:Typeable[${a}]")) mkString ", "
val enumerators = synTypes.zipWithIndex map { case (a,idx) => s"_ <- p._${idx+1}.cast[${a}]" } mkString "; "
val castVals = (synTypes map(a => s"$${cast${a}.describe}")) mkString ", "
block"""
|
|trait TupleTypeableInstances {
| import syntax.typeable._
|
- implicit def tuple${arity}Typeable
- [${`A..N`}]
- (implicit ${implicitArgs})
- = new Typeable[${`(A..N)`}] {
- def cast(t : Any) : Option[${`(A..N)`}] = {
- if(t == null) None
- else if(t.isInstanceOf[${`(_.._)`}]) {
- val p = t.asInstanceOf[${`(_.._)`}]
- for(${enumerators})
- yield t.asInstanceOf[${`(A..N)`}]
- } else None
- }
- override def describe = s"($castVals)"
- }
-
|}
"""
}
}
object GenSizedBuilder extends Template {
val filename = "sizedbuilder.scala"
def content(tv: TemplateVals) = {
import tv._
val `a:T..n:T` = synVals map (_ + ":T") mkString ", "
block"""
|
|class SizedBuilder[CC[_]] {
| import scala.collection.generic.CanBuildFrom
| import nat._
| import Sized.wrap
|
- def apply[T](${`a:T..n:T`})
- (implicit cbf : CanBuildFrom[Nothing, T, CC[T]], ev : AdditiveCollection[CC[T]]) =
- wrap[CC[T], _${arity}]((cbf() += (${`a..n`})).result)
-
|}
"""
}
}
object GenHMapBuilder extends Template {
val filename = "hmapbuilder.scala"
def content(tv: TemplateVals) = {
import tv._
val typeArgs = (0 until arity) map (n => s"K${n}, V${n}") mkString ", "
val args = (0 until arity) map (n => s"e${n}: (K${n}, V${n})") mkString ", "
val witnesses = (0 until arity) map (n => s"ev${n}: R[K${n}, V${n}]") mkString ", "
val mapArgs = (0 until arity) map (n => "e"+n) mkString ", "
block"""
|
|class HMapBuilder[R[_, _]] {
-
- def apply
- [${typeArgs}]
- (${args})
- (implicit ${witnesses})
- = new HMap[R](Map(${mapArgs}))
|}
"""
}
}
object GenUnpackInstances extends Template {
val filename = "unpack.scala"
def content(tv: TemplateVals) = {
import tv._
val typeblock = "FF[" + `A..N` + "], FF, " + `A..N`
val hktypeblock = "FF[" + `_.._` + "], " + `A..N`
val traitname = s"Unpack${arity}"
block"""
|
-
-/**
- * Type class witnessing that type `PP` is equal to `FF[${`A..N`}]` for some higher kinded type `FF[${`_.._`}]` and type(s) `${`A..N`}`.
- *
- * @author Miles Sabin
- */
-trait $traitname[-PP, $hktypeblock]
-
-object $traitname {
- implicit def unpack[$hktypeblock]: $traitname[$typeblock] = new $traitname[$typeblock] {}
-}
|
"""
}
}
}