X-Git-Url: http://nitlanguage.org diff --git a/src/doc/doc_down.nit b/src/doc/doc_down.nit index 60ed50b..7bb330b 100644 --- a/src/doc/doc_down.nit +++ b/src/doc/doc_down.nit @@ -16,65 +16,133 @@ 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 + # Synopsis HTML escaped. + var synopsis: String is lazy do return content.first.html_escape - # Synopsys in a template - var tpl_short_comment: Writable is lazy do + # 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 lines.join("\n") + end + + # Full comment HTML escaped. + var documentation: String is lazy do return content.join("\n") + + 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, writable do + return original_mentity.as(not null).model.nitdoc_inline_processor + end + + # Renders the synopsis as a HTML comment block. + var html_synopsis: Writable is lazy do var res = new Template - var syn = nitdoc_inline_processor.process(content.first) + 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 "
" # do not use DocUnit as synopsys - if not content.first.has_prefix(" ") and - not content.first.has_prefix("\t") then - # parse synopsys - var syn = nitdoc_inline_processor.process(lines.shift) - 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 "

{syn}

" + end end # check for annotations for i in [0 .. lines.length[ do var line = lines[i] if line.to_upper.has_prefix("ENSURE") or line.to_upper.has_prefix("REQUIRE") then - var html = nitdoc_inline_processor.process(line) + var html = inline_proc.process(line) lines[i] = "

{html}

" else if line.to_upper.has_prefix("TODO") or line.to_upper.has_prefix("FIXME") then - var html = nitdoc_inline_processor.process(line) + var html = inline_proc.process(line) lines[i] = "

{html}

" end end # add other lines - res.add nitdoc_md_processor.process(lines.join("\n")) + 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 = "nit" - if block isa BlockFence and block.meta != null then - meta = block.meta.to_s - end + var meta = block.meta or else "nit" + # Do not try to highlight non-nit code. if meta != "nit" and meta != "nitish" then v.add "
"
@@ -83,7 +151,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 "
"
@@ -92,9 +160,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
@@ -109,38 +177,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.
@@ -168,25 +217,27 @@ 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
 end
 
-# Get a markdown processor for Nitdoc comments.
-private fun nitdoc_md_processor: MarkdownProcessor do
-	var proc = new MarkdownProcessor
-	proc.emitter.decorator = new NitdocDecorator
-	return once proc
-end
+redef class Model
+	# Get a markdown processor for Nitdoc comments.
+	var nitdoc_md_processor: MarkdownProcessor is lazy, writable do
+		var proc = new MarkdownProcessor
+		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 fun nitdoc_inline_processor: MarkdownProcessor do
-	var proc = new MarkdownProcessor
-	proc.emitter.decorator = new InlineDecorator
-	return once proc
+	# 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, writable do
+		var proc = new MarkdownProcessor
+		proc.decorator = new InlineDecorator
+		return proc
+	end
 end