├── .gitignore ├── LICENSE ├── README.md ├── examples └── src │ └── main │ └── scala │ └── com │ └── softwaremill │ └── aop │ ├── Foo.scala │ ├── FooImpl.scala │ ├── FooWrapper.scala │ └── Usage.scala ├── macros └── src │ └── main │ └── scala │ └── com │ └── softwaremill │ └── aop │ ├── delegate.scala │ └── delegateMacro.scala └── project ├── Build.scala └── build.properties /.gitignore: -------------------------------------------------------------------------------- 1 | *.class 2 | *.log 3 | 4 | # sbt specific 5 | dist/* 6 | target/ 7 | lib_managed/ 8 | src_managed/ 9 | project/boot/ 10 | project/plugins/project/ 11 | 12 | # Scala-IDE specific 13 | .scala_dependencies 14 | 15 | .idea* -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, and 10 | distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by the copyright 13 | owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all other entities 16 | that control, are controlled by, or are under common control with that entity. 17 | For the purposes of this definition, "control" means (i) the power, direct or 18 | indirect, to cause the direction or management of such entity, whether by 19 | contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the 20 | outstanding shares, or (iii) beneficial ownership of such entity. 21 | 22 | "You" (or "Your") shall mean an individual or Legal Entity exercising 23 | permissions granted by this License. 24 | 25 | "Source" form shall mean the preferred form for making modifications, including 26 | but not limited to software source code, documentation source, and configuration 27 | files. 28 | 29 | "Object" form shall mean any form resulting from mechanical transformation or 30 | translation of a Source form, including but not limited to compiled object code, 31 | generated documentation, and conversions to other media types. 32 | 33 | "Work" shall mean the work of authorship, whether in Source or Object form, made 34 | available under the License, as indicated by a copyright notice that is included 35 | in or attached to the work (an example is provided in the Appendix below). 36 | 37 | "Derivative Works" shall mean any work, whether in Source or Object form, that 38 | is based on (or derived from) the Work and for which the editorial revisions, 39 | annotations, elaborations, or other modifications represent, as a whole, an 40 | original work of authorship. For the purposes of this License, Derivative Works 41 | shall not include works that remain separable from, or merely link (or bind by 42 | name) to the interfaces of, the Work and Derivative Works thereof. 43 | 44 | "Contribution" shall mean any work of authorship, including the original version 45 | of the Work and any modifications or additions to that Work or Derivative Works 46 | thereof, that is intentionally submitted to Licensor for inclusion in the Work 47 | by the copyright owner or by an individual or Legal Entity authorized to submit 48 | on behalf of the copyright owner. For the purposes of this definition, 49 | "submitted" means any form of electronic, verbal, or written communication sent 50 | to the Licensor or its representatives, including but not limited to 51 | communication on electronic mailing lists, source code control systems, and 52 | issue tracking systems that are managed by, or on behalf of, the Licensor for 53 | the purpose of discussing and improving the Work, but excluding communication 54 | that is conspicuously marked or otherwise designated in writing by the copyright 55 | owner as "Not a Contribution." 56 | 57 | "Contributor" shall mean Licensor and any individual or Legal Entity on behalf 58 | of whom a Contribution has been received by Licensor and subsequently 59 | incorporated within the Work. 60 | 61 | 2. Grant of Copyright License. 62 | 63 | Subject to the terms and conditions of this License, each Contributor hereby 64 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 65 | irrevocable copyright license to reproduce, prepare Derivative Works of, 66 | publicly display, publicly perform, sublicense, and distribute the Work and such 67 | Derivative Works in Source or Object form. 68 | 69 | 3. Grant of Patent License. 70 | 71 | Subject to the terms and conditions of this License, each Contributor hereby 72 | grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, 73 | irrevocable (except as stated in this section) patent license to make, have 74 | made, use, offer to sell, sell, import, and otherwise transfer the Work, where 75 | such license applies only to those patent claims licensable by such Contributor 76 | that are necessarily infringed by their Contribution(s) alone or by combination 77 | of their Contribution(s) with the Work to which such Contribution(s) was 78 | submitted. If You institute patent litigation against any entity (including a 79 | cross-claim or counterclaim in a lawsuit) alleging that the Work or a 80 | Contribution incorporated within the Work constitutes direct or contributory 81 | patent infringement, then any patent licenses granted to You under this License 82 | for that Work shall terminate as of the date such litigation is filed. 83 | 84 | 4. Redistribution. 85 | 86 | You may reproduce and distribute copies of the Work or Derivative Works thereof 87 | in any medium, with or without modifications, and in Source or Object form, 88 | provided that You meet the following conditions: 89 | 90 | You must give any other recipients of the Work or Derivative Works a copy of 91 | this License; and 92 | You must cause any modified files to carry prominent notices stating that You 93 | changed the files; and 94 | You must retain, in the Source form of any Derivative Works that You distribute, 95 | all copyright, patent, trademark, and attribution notices from the Source form 96 | of the Work, excluding those notices that do not pertain to any part of the 97 | Derivative Works; and 98 | If the Work includes a "NOTICE" text file as part of its distribution, then any 99 | Derivative Works that You distribute must include a readable copy of the 100 | attribution notices contained within such NOTICE file, excluding those notices 101 | that do not pertain to any part of the Derivative Works, in at least one of the 102 | following places: within a NOTICE text file distributed as part of the 103 | Derivative Works; within the Source form or documentation, if provided along 104 | with the Derivative Works; or, within a display generated by the Derivative 105 | Works, if and wherever such third-party notices normally appear. The contents of 106 | the NOTICE file are for informational purposes only and do not modify the 107 | License. You may add Your own attribution notices within Derivative Works that 108 | You distribute, alongside or as an addendum to the NOTICE text from the Work, 109 | provided that such additional attribution notices cannot be construed as 110 | modifying the License. 111 | You may add Your own copyright statement to Your modifications and may provide 112 | additional or different license terms and conditions for use, reproduction, or 113 | distribution of Your modifications, or for any such Derivative Works as a whole, 114 | provided Your use, reproduction, and distribution of the Work otherwise complies 115 | with the conditions stated in this License. 116 | 117 | 5. Submission of Contributions. 118 | 119 | Unless You explicitly state otherwise, any Contribution intentionally submitted 120 | for inclusion in the Work by You to the Licensor shall be under the terms and 121 | conditions of this License, without any additional terms or conditions. 122 | Notwithstanding the above, nothing herein shall supersede or modify the terms of 123 | any separate license agreement you may have executed with Licensor regarding 124 | such Contributions. 125 | 126 | 6. Trademarks. 127 | 128 | This License does not grant permission to use the trade names, trademarks, 129 | service marks, or product names of the Licensor, except as required for 130 | reasonable and customary use in describing the origin of the Work and 131 | reproducing the content of the NOTICE file. 132 | 133 | 7. Disclaimer of Warranty. 134 | 135 | Unless required by applicable law or agreed to in writing, Licensor provides the 136 | Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, 137 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, 138 | including, without limitation, any warranties or conditions of TITLE, 139 | NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are 140 | solely responsible for determining the appropriateness of using or 141 | redistributing the Work and assume any risks associated with Your exercise of 142 | permissions under this License. 143 | 144 | 8. Limitation of Liability. 145 | 146 | In no event and under no legal theory, whether in tort (including negligence), 147 | contract, or otherwise, unless required by applicable law (such as deliberate 148 | and grossly negligent acts) or agreed to in writing, shall any Contributor be 149 | liable to You for damages, including any direct, indirect, special, incidental, 150 | or consequential damages of any character arising as a result of this License or 151 | out of the use or inability to use the Work (including but not limited to 152 | damages for loss of goodwill, work stoppage, computer failure or malfunction, or 153 | any and all other commercial damages or losses), even if such Contributor has 154 | been advised of the possibility of such damages. 155 | 156 | 9. Accepting Warranty or Additional Liability. 157 | 158 | While redistributing the Work or Derivative Works thereof, You may choose to 159 | offer, and charge a fee for, acceptance of support, warranty, indemnity, or 160 | other liability obligations and/or rights consistent with this License. However, 161 | in accepting such obligations, You may act only on Your own behalf and on Your 162 | sole responsibility, not on behalf of any other Contributor, and only if You 163 | agree to indemnify, defend, and hold each Contributor harmless for any liability 164 | incurred by, or claims asserted against, such Contributor by reason of your 165 | accepting any such warranty or additional liability. 166 | 167 | END OF TERMS AND CONDITIONS 168 | 169 | APPENDIX: How to apply the Apache License to your work 170 | 171 | To apply the Apache License to your work, attach the following boilerplate 172 | notice, with the fields enclosed by brackets "[]" replaced with your own 173 | identifying information. (Don't include the brackets!) The text should be 174 | enclosed in the appropriate comment syntax for the file format. We also 175 | recommend that a file or class name and description of purpose be included on 176 | the same "printed page" as the copyright notice for easier identification within 177 | third-party archives. 178 | 179 | Copyright [yyyy] [name of copyright owner] 180 | 181 | Licensed under the Apache License, Version 2.0 (the "License"); 182 | you may not use this file except in compliance with the License. 183 | You may obtain a copy of the License at 184 | 185 | http://www.apache.org/licenses/LICENSE-2.0 186 | 187 | Unless required by applicable law or agreed to in writing, software 188 | distributed under the License is distributed on an "AS IS" BASIS, 189 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 190 | See the License for the specific language governing permissions and 191 | limitations under the License. 192 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | scala-macro-aop 2 | =============== 3 | 4 | delegate / proxy / decorator 5 | ---------------------------- 6 | 7 | The `@delegate` macro annotation can be applied to class parameters. The macro will generate missing methods which 8 | delegate calls to the annotated value. 9 | 10 | Currently the implementation is at a POC stage, doesn't support overloading, method type parameters or multiple 11 | parameter lists. 12 | 13 | For example: 14 | 15 | ````scala 16 | trait Foo { 17 | def method1(): String 18 | def method2(p1: String): Long 19 | def method3(p1: String): Int 20 | def method4(p1: String, p2: Long): String 21 | } 22 | 23 | class FooImpl extends Foo { 24 | def method1() = "m1" 25 | def method2(p1: String) = 42L 26 | def method3(p1: String) = p1.length() 27 | def method4(p1: String, p2: Long) = s"ok $p1 $p2" 28 | } 29 | 30 | class FooWrapper(@delegate wrapped: Foo) extends Foo { 31 | def method2(p1: String) = 41L 32 | } 33 | ```` 34 | 35 | This will compile, even though there's no direct definition of `method1`, `method3` or `method4` in `FooWrapper`. 36 | That's because of the `@delegate` macro annotation, which will generate the missing methods (`method2` is already 37 | defined). The generated code will be, for example: 38 | 39 | ````scala 40 | def method4(p1: String, p2: Long) = wrapped.method4(p2, p3) 41 | ```` 42 | 43 | To see the macro in action, execute `sbt run`. 44 | 45 | See also the blog: [Automatic generation of delegate methods with Macro Annotations](http://www.warski.org/blog/2013/09/automatic-generation-of-delegate-methods-with-macro-annotations/) 46 | -------------------------------------------------------------------------------- /examples/src/main/scala/com/softwaremill/aop/Foo.scala: -------------------------------------------------------------------------------- 1 | package com.softwaremill.aop 2 | 3 | trait Foo { 4 | def method1(): String 5 | def method2(p1: String): Long 6 | def method3(p1: String): Int 7 | def method4(p1: String, p2: Long): String 8 | } 9 | -------------------------------------------------------------------------------- /examples/src/main/scala/com/softwaremill/aop/FooImpl.scala: -------------------------------------------------------------------------------- 1 | package com.softwaremill.aop 2 | 3 | class FooImpl extends Foo { 4 | def method1() = "m1" 5 | def method2(p1: String) = 42L 6 | def method3(p1: String) = p1.length() 7 | def method4(p1: String, p2: Long) = s"ok $p1 $p2" 8 | } 9 | -------------------------------------------------------------------------------- /examples/src/main/scala/com/softwaremill/aop/FooWrapper.scala: -------------------------------------------------------------------------------- 1 | package com.softwaremill.aop 2 | 3 | class FooWrapper(@delegate wrapped: Foo) extends Foo { 4 | def method2(p1: String) = 41L 5 | } 6 | -------------------------------------------------------------------------------- /examples/src/main/scala/com/softwaremill/aop/Usage.scala: -------------------------------------------------------------------------------- 1 | package com.softwaremill.aop 2 | 3 | object Usage extends App { 4 | def invokeMethodsOnFoo(foo: Foo) { 5 | println("Method 1 result: " + foo.method1()) 6 | println("Method 2 result: " + foo.method2("x")) 7 | println("Method 3 result: " + foo.method3("y")) 8 | println("Method 4 result: " + foo.method4("z", 10L)) 9 | } 10 | 11 | val original = new FooImpl 12 | val wrapped = new FooWrapper(original) 13 | 14 | println("Original:") 15 | invokeMethodsOnFoo(original) 16 | 17 | println("---------") 18 | println("Wrapped:") 19 | invokeMethodsOnFoo(wrapped) 20 | } 21 | -------------------------------------------------------------------------------- /macros/src/main/scala/com/softwaremill/aop/delegate.scala: -------------------------------------------------------------------------------- 1 | package com.softwaremill.aop 2 | 3 | import scala.language.experimental.macros 4 | 5 | import scala.annotation.StaticAnnotation 6 | 7 | class delegate extends StaticAnnotation { 8 | def macroTransform(annottees: Any*) = macro delegateMacro.impl 9 | } 10 | -------------------------------------------------------------------------------- /macros/src/main/scala/com/softwaremill/aop/delegateMacro.scala: -------------------------------------------------------------------------------- 1 | package com.softwaremill.aop 2 | 3 | import scala.reflect.macros.Context 4 | 5 | object delegateMacro { 6 | def impl(c: Context)(annottees: c.Expr[Any]*): c.Expr[Any] = { 7 | import c.universe._ 8 | 9 | def reportInvalidAnnotationTarget() { 10 | c.error(c.enclosingPosition, "This annotation can only be used on vals") 11 | } 12 | 13 | // From MacWire ... 14 | def typeCheckExpressionOfType(typeTree: Tree): Type = { 15 | val someValueOfTypeString = reify { 16 | def x[T](): T = throw new Exception 17 | x[String]() 18 | } 19 | 20 | val Expr(Block(stats, Apply(TypeApply(someValueFun, _), someTypeArgs))) = someValueOfTypeString 21 | 22 | val someValueOfGivenType = Block(stats, Apply(TypeApply(someValueFun, List(typeTree)), someTypeArgs)) 23 | val someValueOfGivenTypeChecked = c.typeCheck(someValueOfGivenType) 24 | 25 | someValueOfGivenTypeChecked.tpe 26 | } 27 | 28 | def computeType(tpt: Tree): Type = { 29 | if (tpt.tpe != null) { 30 | tpt.tpe 31 | } else { 32 | val calculatedType = c.typeCheck(tpt.duplicate, silent = true, withMacrosDisabled = true).tpe 33 | val result = if (tpt.tpe == null) calculatedType else tpt.tpe 34 | 35 | if (result == NoType) { 36 | typeCheckExpressionOfType(tpt) 37 | } else { 38 | result 39 | } 40 | } 41 | } 42 | // ... until here 43 | 44 | def addDelegateMethods(valDef: ValDef, addToClass: ClassDef) = { 45 | def allMethodsInDelegate = computeType(valDef.tpt).declarations 46 | 47 | val ClassDef(mods, name, tparams, Template(parents, self, body)) = addToClass 48 | 49 | // TODO better filtering - allow overriding 50 | val existingMethods = body.flatMap(tree => tree match { 51 | case DefDef(_, n, _, _, _, _) => Some(n) 52 | case _ => None 53 | }).toSet 54 | val methodsToAdd = allMethodsInDelegate.filter(method => !existingMethods.contains(method.name)) 55 | 56 | val newMethods = for { 57 | methodToAdd <- methodsToAdd 58 | } yield { 59 | val methodSymbol = methodToAdd.asMethod 60 | 61 | val vparamss = methodSymbol.paramss.map(_.map { 62 | paramSymbol => ValDef( 63 | Modifiers(Flag.PARAM, tpnme.EMPTY, List()), 64 | paramSymbol.name.toTermName, 65 | TypeTree(paramSymbol.typeSignature), 66 | EmptyTree) 67 | }) 68 | 69 | val delegateInvocation = Apply( 70 | Select(Ident(valDef.name), methodSymbol.name), 71 | methodSymbol.paramss.flatMap(_.map(param => Ident(param.name)))) // TODO - multi params list 72 | 73 | DefDef(Modifiers(), 74 | methodSymbol.name, 75 | List(), // TODO - type parameters 76 | vparamss, 77 | TypeTree(methodSymbol.returnType), 78 | delegateInvocation) 79 | } 80 | 81 | ClassDef(mods, name, tparams, Template(parents, self, body ++ newMethods)) 82 | } 83 | 84 | val inputs = annottees.map(_.tree).toList 85 | val (_, expandees) = inputs match { 86 | case (param: ValDef) :: (enclosing: ClassDef) :: rest => { 87 | val newEnclosing = addDelegateMethods(param, enclosing) 88 | (param, newEnclosing :: rest) 89 | } 90 | case (param: TypeDef) :: (rest @ (_ :: _)) => reportInvalidAnnotationTarget(); (param, rest) 91 | case _ => reportInvalidAnnotationTarget(); (EmptyTree, inputs) 92 | } 93 | val outputs = expandees 94 | c.Expr[Any](Block(outputs, Literal(Constant(())))) 95 | } 96 | } 97 | -------------------------------------------------------------------------------- /project/Build.scala: -------------------------------------------------------------------------------- 1 | import sbt._ 2 | import Keys._ 3 | 4 | object BuildSettings { 5 | val buildSettings = Defaults.defaultSettings ++ Seq( 6 | organization := "com.softwaremill.scala-macro-aop", 7 | version := "1.0.0", 8 | scalacOptions ++= Seq(), 9 | scalaVersion := "2.10.2", 10 | resolvers += Resolver.sonatypeRepo("snapshots"), 11 | addCompilerPlugin("org.scala-lang.plugins" % "macro-paradise" % "2.0.0-SNAPSHOT" cross CrossVersion.full) 12 | ) 13 | } 14 | 15 | object MyBuild extends Build { 16 | import BuildSettings._ 17 | 18 | lazy val root: Project = Project( 19 | "root", 20 | file("."), 21 | settings = buildSettings ++ Seq( 22 | run <<= run in Compile in examples 23 | ) 24 | ) aggregate(macros, examples) 25 | 26 | lazy val macros: Project = Project( 27 | "macros", 28 | file("macros"), 29 | settings = buildSettings ++ Seq( 30 | libraryDependencies <+= (scalaVersion)("org.scala-lang" % "scala-reflect" % _)) 31 | ) 32 | 33 | lazy val examples: Project = Project( 34 | "examples", 35 | file("examples"), 36 | settings = buildSettings 37 | ) dependsOn(macros) 38 | } 39 | -------------------------------------------------------------------------------- /project/build.properties: -------------------------------------------------------------------------------- 1 | sbt.version=0.12.4 2 | --------------------------------------------------------------------------------