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

Corrections on code review

Browse Source
This commit is contained in:
Valentin Kipyatkov
2015-03-04 17:41:44 +03:00
parent ac6a56761e
commit 4a29e968d0
3 changed files with 76 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
j2k/src/org/jetbrains/kotlin/j2k/AnnotationConverter.kt
+16 -15
View File
@@ -33,10 +33,10 @@ class AnnotationConverter(private val converter: Converter) {
private fun convertAnnotationsOnly(owner: PsiModifierListOwner): Annotations {
val modifierList = owner.getModifierList()
val annotations = modifierList?.getAnnotations()?.filter { it.getQualifiedName() !in annotationsToRemove }.orEmpty()
val annotations = modifierList?.getAnnotations()?.filter { it.getQualifiedName() !in annotationsToRemove }
val newLines = run {
if (!modifierList!!.isInSingleLine()) {
var convertedAnnotations: List<Annotation> = if (annotations != null && annotations.isNotEmpty()) {
val newLines = if (!modifierList!!.isInSingleLine()) {
true
}
else {
@@ -47,30 +47,31 @@ class AnnotationConverter(private val converter: Converter) {
}
if (child is PsiWhiteSpace) !child!!.isInSingleLine() else false
}
annotations.map { convertAnnotation(it, owner is PsiLocalVariable, newLines) }.filterNotNull() //TODO: brackets are also needed for local classes
}
else {
listOf()
}
var list = annotations.map { convertAnnotation(it, owner is PsiLocalVariable, newLines) }.filterNotNull() //TODO: brackets are also needed for local classes
if (owner is PsiDocCommentOwner) {
val deprecatedAnnotation = convertDeprecatedJavadocTag(owner)
if (deprecatedAnnotation != null) {
list += deprecatedAnnotation
convertedAnnotations += deprecatedAnnotation
}
}
return if (list.isEmpty()) Annotations.Empty else Annotations(list).assignNoPrototype()
return Annotations(convertedAnnotations).assignNoPrototype()
}
private fun convertDeprecatedJavadocTag(element: PsiDocCommentOwner): Annotation? {
val deprecatedTag = element.getDocComment()?.findTagByName("deprecated")
if (deprecatedTag != null) {
val deferredExpression = converter.deferredElement<Expression> {
LiteralExpression("\"${StringUtil.escapeStringCharacters(deprecatedTag.content())}\"").assignNoPrototype()
}
return Annotation(Identifier("deprecated").assignPrototype(deprecatedTag.getNameElement()),
listOf(null to deferredExpression), false, true)
.assignPrototype(deprecatedTag)
val deprecatedTag = element.getDocComment()?.findTagByName("deprecated") ?: return null
val deferredExpression = converter.deferredElement<Expression> {
LiteralExpression("\"" + StringUtil.escapeStringCharacters(deprecatedTag.content()) + "\"").assignNoPrototype()
}
return null
return Annotation(Identifier("deprecated").assignPrototype(deprecatedTag.getNameElement()),
listOf(null to deferredExpression), false, true)
.assignPrototype(deprecatedTag)
}
private fun convertModifiersToAnnotations(owner: PsiModifierListOwner): Annotations {
j2k/src/org/jetbrains/kotlin/j2k/CodeBuilder.kt
+2 -1
View File
@@ -61,7 +61,8 @@ class CodeBuilder(private val topElement: PsiElement?) {
private fun appendCommentOrWhiteSpace(element: PsiElement) {
if (element is PsiDocComment) {
append(DocCommentConverter.convertDocComment(element), false)
} else {
}
else {
append(element.getText()!!, element.isEndOfLineComment())
}
}
j2k/src/org/jetbrains/kotlin/j2k/DocCommentConverter.kt
+58 -32
View File
@@ -31,45 +31,49 @@ import java.util.Stack
object DocCommentConverter {
fun convertDocComment(docComment: PsiDocComment): String {
val htmlTextBuilder = StringBuilder()
htmlTextBuilder.appendJavadocElements(docComment.getDescriptionElements())
docComment.getTags().filter { it.getName() != "deprecated" }.forEach {
if (it.getName() == "see") {
htmlTextBuilder.append("@see ${convertJavadocLink(it.content())}\n")
} else {
htmlTextBuilder.appendJavadocElements(it.getChildren()).append("\n")
val html = StringBuilder {
appendJavadocElements(docComment.getDescriptionElements())
for (tag in docComment.getTags()) {
when (tag.getName()) {
"deprecated" -> continue
"see" -> append("@see ${convertJavadocLink(tag.content())}\n")
else -> appendJavadocElements(tag.getChildren()).append("\n")
}
}
}
val html = htmlTextBuilder.toString()
}.toString()
if (html.trim().isEmpty() && docComment.findTagByName("deprecated") != null) {
// @deprecated was the only content of the doc comment; we can drop the comment
return ""
}
val htmlFile = PsiFileFactory.getInstance(docComment.getProject()).createFileFromText(
"javadoc.html", HtmlFileType.INSTANCE, html)
val htmlToMarkdownConverter = HtmlToMarkdownConverter()
htmlFile.accept(htmlToMarkdownConverter)
return htmlToMarkdownConverter.markdownBuilder.toString()
return htmlToMarkdownConverter.result
}
fun StringBuilder.appendJavadocElements(elements: Array<PsiElement>): StringBuilder {
private fun StringBuilder.appendJavadocElements(elements: Array<PsiElement>): StringBuilder {
elements.forEach {
if (it is PsiInlineDocTag) {
append(convertInlineDocTag(it))
} else {
}
else {
append(it.getText())
}
}
return this
}
fun convertInlineDocTag(tag: PsiInlineDocTag) = when(tag.getName()) {
private fun convertInlineDocTag(tag: PsiInlineDocTag) = when(tag.getName()) {
"code", "literal" -> {
val text = StringBuilder()
tag.getDataElements().forEach { text.append(it.getText()) }
val escaped = StringUtil.escapeXml(text.toString().trimLeading())
val text = tag.getDataElements().map { it.getText() }.join()
val escaped = StringUtil.escapeXml(text.trimLeading())
if (tag.getName() == "code") "<code>$escaped</code>" else escaped
}
"link", "linkplain" -> {
val valueElement = tag.linkElement()
val labelText = tag.getDataElements().firstOrNull { it is PsiDocToken }?.getText() ?: ""
@@ -77,25 +81,30 @@ object DocCommentConverter {
val linkText = if (labelText.isEmpty()) kdocLink else StringUtil.escapeXml(labelText)
"<a docref=\"$kdocLink\">$linkText</a>"
}
else -> tag.getText()
}
fun convertJavadocLink(link: String?): String =
private fun convertJavadocLink(link: String?): String =
if (link != null) link.substringBefore('(').replace('#', '.') else ""
private fun PsiDocTag.linkElement(): PsiElement? =
getValueElement() ?: getDataElements().firstOrNull { it !is PsiWhiteSpace }
class HtmlToMarkdownConverter() : XmlRecursiveElementVisitor() {
enum class ListType { Ordered; Unordered }
private class HtmlToMarkdownConverter() : XmlRecursiveElementVisitor() {
private enum class ListType { Ordered; Unordered }
val markdownBuilder = StringBuilder("/**")
var afterLineBreak: Boolean = false
var whitespaceIsPartOfText: Boolean = true
var currentListType = ListType.Unordered
val result: String
get() = markdownBuilder.toString()
private val markdownBuilder = StringBuilder("/**")
private var afterLineBreak = false
private var whitespaceIsPartOfText = true
private var currentListType = ListType.Unordered
override fun visitWhiteSpace(space: PsiWhiteSpace) {
super.visitWhiteSpace(space)
if (whitespaceIsPartOfText) {
appendPendingText()
markdownBuilder.append(space.getText())
@@ -107,6 +116,7 @@ object DocCommentConverter {
override fun visitElement(element: PsiElement) {
super.visitElement(element)
val tokenType = element.getNode().getElementType()
if (tokenType == XmlTokenType.XML_DATA_CHARACTERS || tokenType == XmlTokenType.XML_CHAR_ENTITY_REF) {
appendPendingText()
@@ -121,13 +131,15 @@ object DocCommentConverter {
appendPendingText()
val (openingMarkdown, closingMarkdown) = getMarkdownForTag(tag, atLineStart)
markdownBuilder.append(openingMarkdown)
super.visitXmlTag(tag)
markdownBuilder.append(closingMarkdown)
currentListType = oldListType
}
}
override fun visitXmlText(text: XmlText?) {
override fun visitXmlText(text: XmlText) {
withWhitespaceAsPartOfText(true) {
super.visitXmlText(text)
}
@@ -138,27 +150,40 @@ object DocCommentConverter {
whitespaceIsPartOfText = newValue
try {
block()
} finally {
}
finally {
whitespaceIsPartOfText = oldValue
}
}
private fun getMarkdownForTag(tag: XmlTag, atLineStart: Boolean): Pair<String, String> = when(tag.getName()) {
"b", "strong" -> "**" to "**"
"p" -> if (atLineStart) "\n * " to "" else "\n *\n *" to ""
"i", "em" -> "*" to "*"
"s", "del" -> "~~" to "~~"
"code" -> "`" to "`"
"a" -> if (tag.getAttributeValue("docref") != null) {
val docRef = tag.getAttributeValue("docref")
val innerText = tag.getValue().getText()
if (docRef == innerText) "[" to "]" else "[" to "][$docRef]"
} else {
"[" to "](${tag.getAttributeValue("href")})"
"a" -> {
if (tag.getAttributeValue("docref") != null) {
val docRef = tag.getAttributeValue("docref")
val innerText = tag.getValue().getText()
if (docRef == innerText) "[" to "]" else "[" to "][$docRef]"
}
else {
"[" to "](${tag.getAttributeValue("href")})"
}
}
"ul" -> { currentListType = ListType.Unordered; "" to "" }
"ol" -> { currentListType = ListType.Ordered; "" to "" }
"li" -> if (currentListType == ListType.Unordered) " * " to "" else " 1. " to ""
else -> "" to ""
}
@@ -169,8 +194,9 @@ object DocCommentConverter {
}
}
override fun visitXmlFile(file: XmlFile?) {
override fun visitXmlFile(file: XmlFile) {
super.visitXmlFile(file)
markdownBuilder.append(" */")
}
}