From 04034834f5ae9c68e1e42d8aef151a2ef7f83fdf Mon Sep 17 00:00:00 2001 From: michelou Date: Wed, 25 Apr 2007 17:17:03 +0000 Subject: generates constant values in API doc --- .../scala/tools/nsc/doc/ModelExtractor.scala | 109 +++++++++++---------- src/compiler/scala/tools/nsc/doc/ModelFrames.scala | 2 +- src/compiler/scala/tools/nsc/doc/ModelToXML.scala | 92 +++++++++-------- 3 files changed, 105 insertions(+), 98 deletions(-) (limited to 'src/compiler') diff --git a/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala b/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala index 9969aa63f5..8e9d66f735 100644 --- a/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala +++ b/src/compiler/scala/tools/nsc/doc/ModelExtractor.scala @@ -75,26 +75,26 @@ trait ModelExtractor { } - sealed abstract class Entity(val sym : Symbol) { - private[ModelExtractor] def sym0 = sym; + sealed abstract class Entity(val sym: Symbol) { + private[ModelExtractor] def sym0 = sym - override def toString = sym.toString; - def comment : Option[String] = global.comments.get(sym); + override def toString = sym.toString + def comment : Option[String] = global.comments.get(sym) // comments decoded, now what? - def attributes = sym.attributes; + def attributes = sym.attributes def decodeComment : Option[Comment] = { val comment0 = this.comment; if (comment0.isEmpty) return None; var comment = comment0.get.trim; Some(ModelExtractor.this.decodeComment(comment)); } - protected def accessQualified(core : String, qual : String) = core match { + protected def accessQualified(core: String, qual: String) = core match { case "public" => ""; // assert(qual == null); ""; case core => core + (if (qual == null) "" else "[" + qual + "]"); } def flagsString = { - import symtab.Flags; + import symtab.Flags val isLocal = sym.hasFlag(Flags.LOCAL); val x = if (sym.hasFlag(Flags.PRIVATE)) "private" else if (sym.hasFlag(Flags.PROTECTED)) "protected" else "public"; var string = accessQualified(x, { @@ -121,74 +121,75 @@ trait ModelExtractor { def kind : String; def header = { } - def typeParams : List[TypeParam] = Nil; - def params : List[List[Param]] = Nil; - def resultType : Option[Type] = None; - def parents : Iterable[Type] = Nil; - def lo : Option[Type] = sym.info match { + def typeParams : List[TypeParam] = Nil + def params: List[List[Param]] = Nil + def resultType: Option[Type] = None + def parents: Iterable[Type] = Nil + def lo: Option[Type] = sym.info match { case TypeBounds(lo,hi) if decode(lo.symbol) != definitions.AllClass => Some(lo); case _ => None; } def hi : Option[Type] = sym.info match { - case TypeBounds(lo,hi) if decode(hi.symbol) != definitions.AnyClass => Some(hi); - case _ => None; + case TypeBounds(lo,hi) if decode(hi.symbol) != definitions.AnyClass => Some(hi) + case _ => None } def variance = { - import symtab.Flags._; - if (sym.hasFlag(COVARIANT)) "+"; - else if (sym.hasFlag(CONTRAVARIANT)) "-"; - else ""; - } - def overridden : Iterable[Symbol] = { - Nil; + import symtab.Flags._ + if (sym hasFlag COVARIANT) "+" + else if (sym hasFlag CONTRAVARIANT) "-" + else "" } + def overridden: Iterable[Symbol] = Nil } - class Param(sym : Symbol) extends Entity(sym) { - override def resultType = Some(sym.tpe); + + class Param(sym: Symbol) extends Entity(sym) { + override def resultType = Some(sym.tpe) //def kind = if (sym.isPublic) "val" else ""; - def kind = ""; + def kind = "" } - class ConstructorParam(sym : Symbol) extends Param(sym) { + + class ConstructorParam(sym: Symbol) extends Param(sym) { override protected def accessQualified(core : String, qual : String) = core match { - case "public" => "val"; - case "protected" => super.accessQualified(core,qual) + " val"; - case "private" if qual == "this" => ""; - case core => super.accessQualified(core, qual); + case "public" => "val" + case "protected" => super.accessQualified(core,qual) + " val" + case "private" if qual == "this" => "" + case core => super.accessQualified(core, qual) } } - def Param(sym : Symbol) = new Param(sym); - class TypeParam(sym : Symbol) extends Entity(sym) { - def kind = ""; + def Param(sym: Symbol) = new Param(sym) + class TypeParam(sym: Symbol) extends Entity(sym) { + def kind = "" } - def TypeParam(sym : Symbol) = new TypeParam(sym); + def TypeParam(sym: Symbol) = new TypeParam(sym) trait Clazz extends ClassOrObject { - private def csym = sym.asInstanceOf[TypeSymbol]; - override def typeParams = csym.typeParams.map(TypeParam); + private def csym = sym.asInstanceOf[TypeSymbol] + override def typeParams = csym.typeParams.map(TypeParam) override def params = { - if (constructorArgs.isEmpty) Nil; - else constructorArgs.values.toList :: Nil; + if (constructorArgs.isEmpty) Nil + else constructorArgs.values.toList :: Nil } - def isTrait = csym.isTrait; - override def kind = if (sym.isTrait) "trait" else "class"; + def isTrait = csym.isTrait + override def kind = if (sym.isTrait) "trait" else "class" } + trait Object extends ClassOrObject { - override def kind = "object"; - } - case class Package(override val sym : ModuleSymbol) extends Entity(sym) { - override def kind = "package"; - override def name = fullName('.'); + override def kind = "object" } + case class Package(override val sym: ModuleSymbol) extends Entity(sym) { + override def kind = "package" + override def name = fullName('.') + } - trait TopLevel extends ClassOrObject; - class TopLevelClass (sym : Symbol) extends Entity(sym) with TopLevel with Clazz; - class TopLevelObject(sym : Symbol) extends Entity(sym) with TopLevel with Object; + trait TopLevel extends ClassOrObject + class TopLevelClass (sym: Symbol) extends Entity(sym) with TopLevel with Clazz + class TopLevelObject(sym: Symbol) extends Entity(sym) with TopLevel with Object - def compare(pathA : List[ClassOrObject], pathB : List[ClassOrObject]) : Int = { - var pA = pathA; - var pB = pathB; + def compare(pathA: List[ClassOrObject], pathB: List[ClassOrObject]): Int = { + var pA = pathA + var pB = pathB while (true) { if (pA.isEmpty) return -1; if (pB.isEmpty) return +1; @@ -260,10 +261,10 @@ trait ModelExtractor { o.map(comments.apply); } } - abstract class ValDef(sym : Symbol) extends Member(sym) { + abstract class ValDef(sym: Symbol) extends Member(sym) { override def resultType = Some(resultType0); - protected def resultType0 : Type; - override def overridden : Iterable[Symbol] = { + protected def resultType0: Type + override def overridden: Iterable[Symbol] = { var ret : jcl.LinkedHashSet[Symbol] = null; for (parent <- ClassOrObject.this.parents) { val sym0 = sym.overriddenSymbol(parent.symbol); @@ -294,7 +295,7 @@ trait ModelExtractor { } override def kind = "def" } - case class Val(override val sym : TermSymbol) extends ValDef(sym) { + case class Val(override val sym: TermSymbol) extends ValDef(sym) { def resultType0 : Type = sym.tpe; override def kind = { import symtab.Flags._; diff --git a/src/compiler/scala/tools/nsc/doc/ModelFrames.scala b/src/compiler/scala/tools/nsc/doc/ModelFrames.scala index 42421ac07f..682fdf9864 100644 --- a/src/compiler/scala/tools/nsc/doc/ModelFrames.scala +++ b/src/compiler/scala/tools/nsc/doc/ModelFrames.scala @@ -266,7 +266,7 @@ trait ModelFrames extends ModelExtractor { -
{docTitle}
+
{windowTitle}
diff --git a/src/compiler/scala/tools/nsc/doc/ModelToXML.scala b/src/compiler/scala/tools/nsc/doc/ModelToXML.scala index 6ad9791bc1..00de9d6189 100644 --- a/src/compiler/scala/tools/nsc/doc/ModelToXML.scala +++ b/src/compiler/scala/tools/nsc/doc/ModelToXML.scala @@ -31,7 +31,7 @@ trait ModelToXML extends ModelExtractor { }) else aref(url, entity.nameString); } - def link(tpe: Type)(implicit frame : Frame) : NodeSeq = { + def link(tpe: Type)(implicit frame: Frame): NodeSeq = { if (!tpe.typeArgs.isEmpty) { if (definitions.isFunctionType(tpe)) { val (args,r) = tpe.typeArgs.splitAt(tpe.typeArgs.length - 1); @@ -61,15 +61,11 @@ trait ModelToXML extends ModelExtractor { } } - private def printIf[T](what : Option[T], before : String, after : String)(f : T => NodeSeq) : NodeSeq = { - if (what.isEmpty) return Text(""); - var seq : NodeSeq = Text(before); - seq = seq ++ f(what.get); - seq = seq ++ Text(after); - seq - } + private def printIf[T](what: Option[T], before: String, after: String)(f: T => NodeSeq): NodeSeq = + if (what.isEmpty) Text("") + else Text(before) ++ f(what.get) ++ Text(after) - def bodyFor(entity : Entity)(implicit frame : Frame) : NodeSeq = { + def bodyFor(entity: Entity)(implicit frame: Frame): NodeSeq = { var seq = {entity.typeParams.surround("[", "]")(e => { Text(e.variance) ++ {e.name} ++ {printIf(e.hi, " <: ", "")(link)} ++ @@ -77,22 +73,21 @@ trait ModelToXML extends ModelExtractor { })} ++ printIf(entity.hi, " <: ", "")(link) ++ printIf(entity.lo, " >: ", "")(link); {entity.params.foreach(xs => { - seq = seq ++ xs.mkXML("(", ", ", ")")(arg => { - var seq : NodeSeq = { - val str = arg.flagsString.trim; - if (str.length == 0) NodeSeq.Empty; - else {Text(str)} ; - } - seq = seq ++ {arg.name}; - seq = seq ++ Text(" : ") ++ link(arg.resultType.get); - seq; - }); - seq; + seq = seq ++ xs.mkXML("(", ", ", ")")(arg => + { + val str = arg.flagsString.trim + if (str.length == 0) NodeSeq.Empty + else {Text(str)} + } ++ + {arg.name} ++ + Text(" : ") ++ link(arg.resultType.get) + ); + seq })}; seq ++ {printIf(entity.resultType, " : ", "")(tpe => link(tpe))} } - def extendsFor(entity : Entity)(implicit frame : Frame) : NodeSeq = { + def extendsFor(entity: Entity)(implicit frame: Frame): NodeSeq = { if (entity.parents.isEmpty) NodeSeq.Empty; else extends ++ entity.parents.mkXML(Text(""), with , Text(""))(link); @@ -119,14 +114,14 @@ trait ModelToXML extends ModelExtractor {
{extendsFor(entity)}
; } ++ { - val cmnt = entity.decodeComment; - if (cmnt.isEmpty) NodeSeq.Empty; - else longComment(cmnt.get); + val cmnt = entity.decodeComment + if (cmnt.isEmpty) NodeSeq.Empty + else longComment(cmnt.get) } ++ (entity match { - case entity : ClassOrObject => {classBody(entity)}; - case _ => NodeSeq.Empty; + case entity: ClassOrObject => classBody(entity) + case _ => NodeSeq.Empty }) ++ { - val overridden = entity.overridden; + val overridden = entity.overridden if (!overridden.isEmpty) { var seq : NodeSeq = Text("Overrides "); seq = seq ++ overridden.mkXML("",", ", "")(sym => link(decode(sym.owner)) ++ Text(".") ++ link(sym)); @@ -134,9 +129,9 @@ trait ModelToXML extends ModelExtractor { } else NodeSeq.Empty; } ++
); - def longComment(cmnt : Comment) : NodeSeq = { + def longComment(cmnt: Comment): NodeSeq = { val attrs =
{ - var seq : NodeSeq = NodeSeq.Empty; + var seq: NodeSeq = NodeSeq.Empty cmnt.decodeAttributes.foreach{ case (tag,xs) => seq = seq ++
@@ -149,13 +144,17 @@ trait ModelToXML extends ModelExtractor { }; seq; }
; -
{parse(cmnt.body)}
{attrs} + +
{parse(cmnt.body)}
+ {attrs} + } - def classBody(entity : ClassOrObject)(implicit from : Frame) : NodeSeq = - {categories.mkXML("","\n","")(c => shortList(entity, c)) : NodeSeq} - {categories.mkXML("","\n","")(c => longList(entity, c)) : NodeSeq} - ; + def classBody(entity: ClassOrObject)(implicit from: Frame): NodeSeq = + + {categories.mkXML("","\n","")(c => shortList(entity, c)) : NodeSeq} + {categories.mkXML("","\n","")(c => longList(entity, c)) : NodeSeq} + ; def longList(entity : ClassOrObject,category : Category)(implicit from : Frame) : NodeSeq = { val xs = entity.members(category); @@ -167,13 +166,13 @@ trait ModelToXML extends ModelExtractor {
{xs.mkXML("","\n","")(m => longHeader(m))}
); } - def shortList(entity: ClassOrObject, category: Category)(implicit from: Frame) : NodeSeq = { + def shortList(entity: ClassOrObject, category: Category)(implicit from: Frame): NodeSeq = { val xs = entity.members(category) - var seq : NodeSeq = NodeSeq.Empty + var seq: NodeSeq = NodeSeq.Empty if (xs.elements.hasNext) { // alphabetic val set = new scala.collection.jcl.TreeSet[entity.Member]()(mA => new Ordered[entity.Member] { - def compare(mB : entity.Member) : Int = { + def compare(mB: entity.Member): Int = { if (mA eq mB) return 0; val diff = mA.name compare mB.name; if (diff != 0) return diff; @@ -183,7 +182,7 @@ trait ModelToXML extends ModelExtractor { } }); set addAll xs; - seq = seq ++ + seq = seq ++
{set.mkXML("","\n","")(mmbr => shortHeader(mmbr))}
{Text(category.label + " Summary")}
@@ -220,16 +219,23 @@ trait ModelToXML extends ModelExtractor { {Text(entity.flagsString)} {Text(entity.kind)} - {link(decode(entity.sym))}{bodyFor(entity) ++ extendsFor(entity)} + {link(decode(entity.sym))} + {bodyFor(entity) ++ extendsFor(entity)} + { + entity.resultType match { + case Some(PolyType(_, ConstantType(v))) => Text(" = " + v.escapedStringValue) + case _ => NodeSeq.Empty + } + } { - val cmnt = entity.decodeComment; - if (cmnt.isEmpty) NodeSeq.Empty; - else
{parse(cmnt.get.body)}
; + val cmnt = entity.decodeComment + if (cmnt.isEmpty) NodeSeq.Empty + else
{parse(cmnt.get.body)}
; } - def attrsFor(entity : Entity)(implicit from : Frame) : NodeSeq = { + def attrsFor(entity: Entity)(implicit from: Frame): NodeSeq = { def attrFor(attr: AnnotationInfo[Constant]): Node = { val buf = new StringBuilder val AnnotationInfo(tpe, args, nvPairs) = attr -- cgit v1.2.3