X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_down.nit b/src/doc/doc_down.nit index bc5a762..7d5c24d 100644 --- a/src/doc/doc_down.nit +++ b/src/doc/doc_down.nit @@ -16,29 +16,16 @@ module doc_down import markdown -import highlight +import htmlight private import parser_util redef class MDoc - # Synopsis HTML escaped. - var synopsis: String is lazy do return content.first.html_escape - - # Comment without synopsis HTML escaped - var comment: String is lazy do - var lines = content.to_a - if not lines.is_empty then lines.shift - return content.join("\n").html_escape - end - - # Full comment HTML escaped. - var documentation: String is lazy do return content.join("\n").html_escape - - private var markdown_proc: MarkdownProcessor is lazy do + private var markdown_proc: MarkdownProcessor is lazy, writable do return original_mentity.as(not null).model.nitdoc_md_processor end - private var inline_proc: MarkdownProcessor is lazy do + private var inline_proc: MarkdownProcessor is lazy, writable do return original_mentity.as(not null).model.nitdoc_inline_processor end @@ -48,7 +35,12 @@ redef class MDoc var syn = inline_proc.process(content.first) res.add "{syn}" return res + end + # Renders the synopsis as a HTML comment block. + var md_synopsis: Writable is lazy do + if content.is_empty then return "" + return content.first end # Renders the comment without the synopsis as a HTML comment block. @@ -58,12 +50,25 @@ redef class MDoc return lines_to_html(lines) end + # + var md_comment: Writable is lazy do + if content.is_empty then return "" + var lines = content.to_a + lines.shift + return lines.join("\n") + end + # Renders the synopsis and the comment as a HTML comment block. var html_documentation: Writable is lazy do return lines_to_html(content.to_a) + # Renders the synopsis and the comment as a HTML comment block. + var md_documentation: Writable is lazy do return lines_to_md(content.to_a) + # Renders markdown line as a HTML comment block. private fun lines_to_html(lines: Array[String]): Writable do var res = new Template + var decorator = markdown_proc.decorator.as(NitdocDecorator) + decorator.current_mdoc = self res.add "
" # do not use DocUnit as synopsys if not lines.is_empty then @@ -71,7 +76,7 @@ redef class MDoc not lines.first.has_prefix("\t") then # parse synopsys var syn = inline_proc.process(lines.shift) - res.add "

{syn}

" + res.add "

{syn}

" end end # check for annotations @@ -88,15 +93,39 @@ redef class MDoc # add other lines res.add markdown_proc.process(lines.join("\n")) res.add "
" + decorator.current_mdoc = null return res + end + private fun lines_to_md(lines: Array[String]): Writable do + var res = new Template + if not lines.is_empty then + var syn = lines.first + if not syn.has_prefix(" ") and not syn.has_prefix("\t") and + not syn.trim.has_prefix("#") then + lines.shift + res.add "# {syn}\n" + end + end + res.add lines.join("\n") + return res end end -private class NitdocDecorator +# The specific markdown decorator used internally to process MDoc object. +# +# You should use the various methods of `MDoc` like `MDoc::html_documentation` +# +# The class is public so specific behavior can be plugged on it. +class NitdocDecorator super HTMLDecorator - var toolcontext = new ToolContext + private var toolcontext = new ToolContext + + # The currently processed mdoc. + # + # Unfortunately, this seems to be the simpler way to get the currently processed `MDoc` object. + var current_mdoc: nullable MDoc = null redef fun add_code(v, block) do var meta = block.meta or else "nit" @@ -118,9 +147,9 @@ private class NitdocDecorator return end v.add "
"
-		var hl = new HighlightVisitor
+		var hl = new HtmlightVisitor
 		hl.line_id_prefix = ""
-		hl.enter_visit(ast)
+		hl.highlight_node(ast)
 		v.add(hl.html)
 		v.add "
\n" end @@ -135,15 +164,15 @@ private class NitdocDecorator append_code(v, text, from, to) else v.add "" - var hl = new HighlightVisitor + var hl = new HtmlightVisitor hl.line_id_prefix = "" - hl.enter_visit(ast) + hl.highlight_node(ast) v.add(hl.html) end v.add "" end - fun code_from_text(buffer: Text, from, to: Int): String do + private fun code_from_text(buffer: Text, from, to: Int): String do var out = new FlatBuffer for i in [from..to[ do out.add buffer[i] return out.write_to_string @@ -162,6 +191,14 @@ private class InlineDecorator end redef fun add_headline(v, block) do + # save headline + var line = block.block.first_line + if line == null then return + var txt = line.value + var id = strip_id(txt) + var lvl = block.depth + headlines[id] = new HeadLine(id, txt, lvl) + v.emit_in block end @@ -175,8 +212,8 @@ private class InlineDecorator return end v.add "" - var hl = new HighlightVisitor - hl.enter_visit(ast) + var hl = new HtmlightVisitor + hl.highlight_node(ast) v.add(hl.html) v.add "" end @@ -184,18 +221,18 @@ end redef class Model # Get a markdown processor for Nitdoc comments. - var nitdoc_md_processor: MarkdownProcessor is lazy do + var nitdoc_md_processor: MarkdownProcessor is lazy, writable do var proc = new MarkdownProcessor - proc.emitter.decorator = new NitdocDecorator + proc.decorator = new NitdocDecorator return proc end # Get a markdown inline processor for Nitdoc comments. # # This processor is specificaly designed to inlinable doc elements like synopsys. - var nitdoc_inline_processor: MarkdownProcessor is lazy do + var nitdoc_inline_processor: MarkdownProcessor is lazy, writable do var proc = new MarkdownProcessor - proc.emitter.decorator = new InlineDecorator + proc.decorator = new InlineDecorator return proc end end