azalea/kotlin-fork
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

simplified the model more

Browse Source
This commit is contained in:
James Strachan
2012-02-23 12:09:54 +00:00
parent b392a6217e
commit 99a13a500c
2 changed files with 80 additions and 87 deletions
Download Patch File Download Diff File Expand all files Collapse all files
kdoc/src/main/kotlin/org/jetbrains/kotlin/doc/KDoc.kt
+4 -82
View File
@@ -54,7 +54,7 @@ class KDoc(val outputDir: File) : CompilerPlugin {
model.getPackage(namespace)
for (descriptor in namespace.getMemberScope().getAllDescriptors()) {
if (descriptor is ClassDescriptor) {
val klass = getOrCreateClass(descriptor)
val klass = model.getClass(descriptor)
if (klass != null) {
allClasses.add(klass)
}
@@ -62,23 +62,7 @@ class KDoc(val outputDir: File) : CompilerPlugin {
model.getPackage(descriptor)
}
}
//addNamespace(namespace)
}
/*
for (namespace in allNamespaces) {
for (descriptor in namespace.getMemberScope().getAllDescriptors()) {
if (descriptor is CallableDescriptor) {
val pkg = getPackage(namespace)
val function = createFunction(pkg, descriptor)
if (function != null && function.extensionClass == null) {
pkg.functions.add(function)
pkg.local = true
}
}
}
//addNamespace(namespace)
}
*/
// lets add the functions...
for (klass in allClasses) {
@@ -105,35 +89,6 @@ class KDoc(val outputDir: File) : CompilerPlugin {
}
protected fun getOrCreateClass(classElement: ClassDescriptor): KClass? {
//val docComment = getDocCommentFor(classElement.sure()) ?: "";
val name = classElement.getName()
val container = classElement.containingDeclaration
if (name != null && container is NamespaceDescriptor) {
val pkg = model.getPackage(container)
//val namespaceName = containerName(classElement)
val klass = KClass(pkg, classElement, name)
pkg.classMap.put(name, klass)
if (pkg.description.length() == 0) {
pkg.description = commentsFor(container)
}
pkg.local = true
klass.description = commentsFor(classElement)
val superTypes = classElement.getTypeConstructor().getSupertypes()
for (st in superTypes) {
val sc = getType(st)
if (sc != null) {
klass.baseClasses.add(sc)
}
}
//addFunctions(klass, klass.functions, classElement.getDefaultType().getMemberScope())
return klass
} else {
println("No package found for $container and class $name")
return null
}
}
protected fun addFunctions(owner: KClassOrPackage, list: Collection<KFunction>, scope: JetScope): Unit {
val descriptors = scope.getAllDescriptors()
for (descriptor in descriptors) {
@@ -147,7 +102,7 @@ class KDoc(val outputDir: File) : CompilerPlugin {
}
protected fun createFunction(owner: KClassOrPackage, descriptor: CallableDescriptor): KFunction? {
val returnType = getType(descriptor.getReturnType())
val returnType = model.getClass(descriptor.getReturnType())
if (returnType != null) {
val function = KFunction(owner, descriptor.getName() ?: "null", returnType)
function.description = commentsFor(descriptor)
@@ -162,7 +117,7 @@ class KDoc(val outputDir: File) : CompilerPlugin {
}
val receiver = descriptor.getReceiverParameter()
if (receiver is ExtensionReceiver) {
function.extensionClass = getType(receiver.getType())
function.extensionClass = model.getClass(receiver.getType())
}
return function
}
@@ -170,7 +125,7 @@ class KDoc(val outputDir: File) : CompilerPlugin {
}
protected fun createParameter(descriptor: ValueParameterDescriptor): KParameter? {
val returnType = getType(descriptor.getReturnType())
val returnType = model.getClass(descriptor.getReturnType())
if (returnType != null) {
val name = descriptor.getName()
val answer = KParameter(name, returnType)
@@ -180,39 +135,6 @@ class KDoc(val outputDir: File) : CompilerPlugin {
return null
}
protected fun getType(aType: JetType?): KClass? {
if (aType != null) {
val classifierDescriptor = aType.constructor.declarationDescriptor
if (classifierDescriptor is ClassDescriptor) {
return getOrCreateClass(classifierDescriptor)
}
}
return null
}
protected fun commentsFor(descriptor: DeclarationDescriptor): String {
/*
val psiElement = try {
BindingContextUtils.descriptorToDeclaration(context.sure(), descriptor)
} catch (e: Throwable) {
// ignore exceptions on fake descriptors
null
}
// This method is a hack. Doc comments should be easily accessible, but they aren't for now.
if (psiElement != null) {
var node = psiElement.getNode()?.getTreePrev()
while (node != null && (node?.getElementType() == JetTokens.WHITE_SPACE || node?.getElementType() == JetTokens.BLOCK_COMMENT)) {
node = node?.getTreePrev()
}
if (node == null) return ""
if (node?.getElementType() != JetTokens.DOC_COMMENT) return ""
return node?.getText() ?: ""
}
*/
return ""
}
}
class KDocGenerator(val model: KModel, val outputDir: File) {
kdoc/src/main/kotlin/org/jetbrains/kotlin/model/KotlinModel.kt
+76 -5
View File
@@ -10,6 +10,7 @@ import org.jetbrains.jet.lang.descriptors.NamespaceDescriptor
import org.jetbrains.jet.lang.descriptors.DeclarationDescriptor
import org.jetbrains.jet.lang.descriptors.ModuleDescriptor
import org.jetbrains.jet.lang.resolve.java.JavaNamespaceDescriptor
import org.jetbrains.jet.lang.types.JetType
fun containerName(descriptor: DeclarationDescriptor): String = qualifiedName(descriptor.containingDeclaration)
@@ -30,6 +31,31 @@ fun extensionFunctions(functions: Collection<KFunction>): SortedMap<KClass, List
return map
}
fun commentsFor(descriptor: DeclarationDescriptor): String {
/*
val psiElement = try {
BindingContextUtils.descriptorToDeclaration(context.sure(), descriptor)
} catch (e: Throwable) {
// ignore exceptions on fake descriptors
null
}
// This method is a hack. Doc comments should be easily accessible, but they aren't for now.
if (psiElement != null) {
var node = psiElement.getNode()?.getTreePrev()
while (node != null && (node?.getElementType() == JetTokens.WHITE_SPACE || node?.getElementType() == JetTokens.BLOCK_COMMENT)) {
node = node?.getTreePrev()
}
if (node == null) return ""
if (node?.getElementType() != JetTokens.DOC_COMMENT) return ""
return node?.getText() ?: ""
}
*/
return ""
}
trait KClassOrPackage {
}
@@ -53,11 +79,37 @@ class KModel(var title: String = "Documentation", var version: String = "TODO")
fun getPackage(name: String): KPackage? = packageMap.get(name)
/** Returns the package for the given descriptor, creating one if its not available */
fun getPackage(namespace: NamespaceDescriptor): KPackage {
val name = qualifiedName(namespace)
fun getPackage(descriptor: NamespaceDescriptor): KPackage {
val name = qualifiedName(descriptor)
return packageMap.getOrPut(name) {
KPackage(this, namespace, name)
}
val pkg = KPackage(this, descriptor, name)
pkg.description = commentsFor(descriptor)
pkg
}
}
fun getClass(aType: JetType?): KClass? {
if (aType != null) {
val classifierDescriptor = aType.constructor.declarationDescriptor
if (classifierDescriptor is ClassDescriptor) {
return getClass(classifierDescriptor)
}
}
return null
}
fun getClass(classElement: ClassDescriptor): KClass? {
val name = classElement.getName()
val container = classElement.containingDeclaration
if (name != null && container is NamespaceDescriptor) {
val pkg = getPackage(container)
return pkg.getClass(name, classElement)
} else {
println("No package found for $container and class $name")
return null
}
}
fun previous(pkg: KPackage): KPackage? {
@@ -73,7 +125,8 @@ class KModel(var title: String = "Documentation", var version: String = "TODO")
class KPackage(val model: KModel, val descriptor: NamespaceDescriptor,
val name: String, var external: Boolean = false,
var description: String = "", var detailedDescription: String = "",
var description: String = "",
var detailedDescription: String = "",
var functions: SortedSet<KFunction> = TreeSet<KFunction>(),
var local: Boolean = false) : Comparable<KPackage>, KClassOrPackage {
override fun compareTo(other: KPackage): Int = name.compareTo(other.name)
@@ -82,6 +135,24 @@ class KPackage(val model: KModel, val descriptor: NamespaceDescriptor,
fun toString() = "KPackage($name)"
fun getClass(name: String, classElement: ClassDescriptor): KClass {
return classMap.getOrPut(name) {
//val namespaceName = containerName(classElement)
val klass = KClass(this, classElement, name)
local = true
klass.description = commentsFor(classElement)
val superTypes = classElement.getTypeConstructor().getSupertypes()
for (st in superTypes) {
val sc = model.getClass(st)
if (sc != null) {
klass.baseClasses.add(sc)
}
}
//addFunctions(klass, klass.functions, classElement.getDefaultType().getMemberScope())
klass
}
}
/** Returns the name as a directory using '/' instead of '.' */
public val nameAsPath: String
get() = if (name.length() == 0) "." else name.replace('.', '/')