Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Copyright (c) 2023 bitlap
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
package org.bitlap.tools.internal
import scala.reflect.macros.whitebox
/** @author
* 梦境迷离
* @since 2021/7/7
* @version 1.0
*/
object toStringMacro {
class ToStringProcessor(override val c: whitebox.Context) extends AbstractMacroProcessor(c) {
import c.universe._
private case class ToStringOptions(
includeInternalFields: Boolean,
includeFieldNames: Boolean,
callSuper: Boolean
)
private def extractTree(aa: Tree, bb: Tree, cc: Tree): ToStringOptions =
ToStringOptions(
evalTree[Boolean](aa),
evalTree[Boolean](bb),
evalTree[Boolean](cc)
)
private val extractOptions: ToStringOptions = c.prefix.tree match {
case q"new toString(includeInternalFields=$aa, includeFieldNames=$bb, callSuper=$cc)" =>
extractTree(aa.asInstanceOf[Tree], bb.asInstanceOf[Tree], cc.asInstanceOf[Tree])
case q"new toString(includeInternalFields=$aa, includeFieldNames=$bb)" =>
extractTree(aa.asInstanceOf[Tree], bb.asInstanceOf[Tree], q"false")
case q"new toString(includeInternalFields=$aa)" =>
extractTree(aa.asInstanceOf[Tree], q"true", q"false")
case q"new toString(includeFieldNames=$aa)" =>
extractTree(q"true", aa.asInstanceOf[Tree], q"false")
case q"new toString(callSuper=$aa)" =>
extractTree(q"true", q"true", aa.asInstanceOf[Tree])
case q"new toString()" =>
ToStringOptions(includeInternalFields = true, includeFieldNames = true, callSuper = false)
case _ => c.abort(c.enclosingPosition, ErrorMessage.UNEXPECTED_PATTERN)
}
override def createCustomExpr(classDecl: c.universe.ClassDef, compDeclOpt: Option[c.universe.ModuleDef]): Any = {
// extract parameters of annotation, must in order
val resTree = appendClassBody(classDecl, _ => List(getToStringTemplate(extractOptions, classDecl)))
c.Expr(q"""
${compDeclOpt.fold(EmptyTree)(x => x)}
$resTree
""")
}
private def printField(options: ToStringOptions, lastParam: Option[String], field: Tree): Tree =
// Print one field as +"="+fieldName
if (options.includeFieldNames) {
lastParam.fold(q"$field") { lp =>
field match {
case v: ValDef =>
if (v.name.toTermName.decodedName.toString != lp)
q"""${v.name.toTermName.decodedName.toString}+${"="}+this.${v.name}+${", "}"""
else q"""${v.name.toTermName.decodedName.toString}+${"="}+this.${v.name}"""
case _ => q"$field"
}
}
} else {
lastParam.fold(q"$field") { lp =>
field match {
case v: ValDef =>
if (v.name.toTermName.decodedName.toString != lp) q"""${v.name}+${", "}""" else q"""${v.name}"""
case _ => if (field.toString() != lp) q"""$field+${", "}""" else q"""$field"""
}
}
}
private def getToStringTemplate(options: ToStringOptions, classDecl: ClassDef): Tree = {
// For a given class definition, separate the components of the class
val classDefinition = mapToClassDeclInfo(classDecl)
// Check the type of the class, whether it already contains its own toString
val annotteeClassFieldDefinitions = classDefinition.body.filter(_ match {
case _: ValDef => true
case mem: MemberDef =>
if (mem.name.decodedName.toString.startsWith("toString")) { // TODO better way
c.abort(mem.pos, "'toString' method has already defined, please remove it or not use'@toString'")
}
false
case _ => false
})
val ctorParams = classDefinition.classParamss.flatten
val member = if (options.includeInternalFields) ctorParams ++ annotteeClassFieldDefinitions else ctorParams
val lastParam = member.lastOption.map {
case v: ValDef => v.name.toTermName.decodedName.toString
case c => c.toString
}
val paramsWithName = member.foldLeft(q"${""}")((res, acc) => q"$res + ${printField(options, lastParam, acc)}")
// scala/bug https://github.com/scala/bug/issues/3967 not be 'Foo(i=1,j=2)' in standard library
val toString =
q"""override def toString: String = ${classDefinition.className.toTermName.decodedName.toString} + ${"("} + $paramsWithName + ${")"}"""
// Have super class ?
if (options.callSuper && classDefinition.superClasses.nonEmpty) {
val superClassDef = classDefinition.superClasses.head match {
case tree: Tree => Some(tree) // TODO type check better
case _ => None
}
superClassDef.fold(toString) { _ =>
val superClass = q"${"super="}"
q"override def toString: String = StringContext(${classDefinition.className.toTermName.decodedName.toString} + ${"("} + $superClass, ${if (member.nonEmpty) ", "
else ""}+$paramsWithName + ${")"}).s(super.toString)"
}
} else {
toString
}
}
}
}
