X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_down.nit b/src/doc/doc_down.nit index e1a5348..7d5c24d 100644 --- a/src/doc/doc_down.nit +++ b/src/doc/doc_down.nit @@ -16,44 +16,68 @@ module doc_down import markdown -import highlight +import htmlight private import parser_util redef class MDoc - # Comment synopsys HTML escaped - var short_comment: String is lazy do return content.first.html_escape - # Full comment HTML escaped - var full_comment: String is lazy do return content.join("\n").html_escape - - private var markdown_proc: MarkdownProcessor is lazy do - return original_mentity.model.nitdoc_md_processor + 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 - return original_mentity.model.nitdoc_inline_processor + private var inline_proc: MarkdownProcessor is lazy, writable do + return original_mentity.as(not null).model.nitdoc_inline_processor end - # Synopsys in a template - var tpl_short_comment: Writable is lazy do + # Renders the synopsis as a HTML comment block. + var html_synopsis: Writable is lazy do var res = new Template 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 - # Full comment in a template - var tpl_comment: Writable is lazy do - var res = new Template + # Renders the comment without the synopsis as a HTML comment block. + var html_comment: Writable is lazy do + var lines = content.to_a + if not lines.is_empty then lines.shift + 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 "
{syn}
" + if not lines.is_empty then + if not lines.first.has_prefix(" ") and + not lines.first.has_prefix("\t") then + # parse synopsys + var syn = inline_proc.process(lines.shift) + res.add ""
@@ -91,7 +138,7 @@ private class NitdocDecorator
return
end
# Try to parse code
- var code = code_from_block(block)
+ var code = block.raw_content
var ast = toolcontext.parse_something(code)
if ast isa AError then
v.add ""
@@ -100,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
@@ -117,38 +164,19 @@ 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
end
-
- fun code_from_block(block: BlockCode): String do
- var infence = block isa BlockFence
- var text = new FlatBuffer
- var line = block.block.first_line
- while line != null do
- if not line.is_empty then
- var str = line.value
- if not infence and str.has_prefix(" ") then
- text.append str.substring(4, str.length - line.trailing)
- else
- text.append str
- end
- end
- text.append "\n"
- line = line.next
- end
- return text.write_to_string
- end
end
# Decorator for span elements.
@@ -163,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
@@ -176,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
@@ -185,18 +221,18 @@ end
redef class Model
# Get a markdown processor for Nitdoc comments.
- private 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.
- private 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