1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Handle markdown formatting in Nit comments.
20 private import parser_util
24 # Synopsis HTML escaped.
25 var synopsis
: String is lazy
do return content
.first
.html_escape
27 # Comment without synopsis HTML escaped
28 var comment
: String is lazy
do
29 var lines
= content
.to_a
30 if not lines
.is_empty
then lines
.shift
31 return content
.join
("\n").html_escape
34 # Full comment HTML escaped.
35 var documentation
: String is lazy
do return content
.join
("\n").html_escape
37 private var markdown_proc
: MarkdownProcessor is lazy
do
38 return original_mentity
.as(not null).model
.nitdoc_md_processor
41 private var inline_proc
: MarkdownProcessor is lazy
do
42 return original_mentity
.as(not null).model
.nitdoc_inline_processor
45 # Renders the synopsis as a HTML comment block.
46 var html_synopsis
: Writable is lazy
do
47 var res
= new Template
48 var syn
= inline_proc
.process
(content
.first
)
49 res
.add
"<span class=\"synopsys nitdoc\
">{syn}</span>"
54 # Renders the comment without the synopsis as a HTML comment block.
55 var html_comment
: Writable is lazy
do
56 var lines
= content
.to_a
57 if not lines
.is_empty
then lines
.shift
58 return lines_to_html
(lines
)
61 # Renders the synopsis and the comment as a HTML comment block.
62 var html_documentation
: Writable is lazy
do return lines_to_html
(content
.to_a
)
64 # Renders markdown line as a HTML comment block.
65 private fun lines_to_html
(lines
: Array[String]): Writable do
66 var res
= new Template
67 var decorator
= markdown_proc
.emitter
.decorator
.as(NitdocDecorator)
68 decorator
.current_mdoc
= self
69 res
.add
"<div class=\"nitdoc\
">"
70 # do not use DocUnit as synopsys
71 if not lines
.is_empty
then
72 if not lines
.first
.has_prefix
(" ") and
73 not lines
.first
.has_prefix
("\t") then
75 var syn
= inline_proc
.process
(lines
.shift
)
76 res
.add
"<p class=\"synopsys\
">{syn}</p>"
79 # check for annotations
80 for i
in [0 .. lines
.length
[ do
82 if line
.to_upper
.has_prefix
("ENSURE") or line
.to_upper
.has_prefix
("REQUIRE") then
83 var html
= inline_proc
.process
(line
)
84 lines
[i
] = "<p class=\"contract\
">{html}</p>"
85 else if line
.to_upper
.has_prefix
("TODO") or line
.to_upper
.has_prefix
("FIXME") then
86 var html
= inline_proc
.process
(line
)
87 lines
[i
] = "<p class=\"todo\
">{html}</p>"
91 res
.add markdown_proc
.process
(lines
.join
("\n"))
93 decorator
.current_mdoc
= null
99 # The specific markdown decorator used internally to process MDoc object.
101 # You should use the various methods of `MDoc` like `MDoc::html_documentation`
103 # The class is public so specific behavior can be plugged on it.
104 class NitdocDecorator
107 private var toolcontext
= new ToolContext
109 # The currently processed mdoc.
111 # Unfortunately, this seems to be the simpler way to get the currently processed `MDoc` object.
112 var current_mdoc
: nullable MDoc = null
114 redef fun add_code
(v
, block
) do
115 var meta
= block
.meta
or else "nit"
117 # Do not try to highlight non-nit code.
118 if meta
!= "nit" and meta
!= "nitish" then
119 v
.add
"<pre class=\"{meta}\
"><code>"
121 v
.add
"</code></pre>\n"
125 var code
= block
.raw_content
126 var ast
= toolcontext
.parse_something
(code
)
127 if ast
isa AError then
128 v
.add
"<pre class=\"{meta}\
"><code>"
130 v
.add
"</code></pre>\n"
133 v
.add
"<pre class=\"nitcode\
"><code>"
134 var hl
= new HighlightVisitor
135 hl
.line_id_prefix
= ""
138 v
.add
"</code></pre>\n"
141 redef fun add_span_code
(v
, text
, from
, to
) do
143 var code
= code_from_text
(text
, from
, to
)
144 var ast
= toolcontext
.parse_something
(code
)
146 if ast
isa AError then
147 v
.add
"<code class=\"rawcode\
">"
148 append_code
(v
, text
, from
, to
)
150 v
.add
"<code class=\"nitcode\
">"
151 var hl
= new HighlightVisitor
152 hl
.line_id_prefix
= ""
159 private fun code_from_text
(buffer
: Text, from
, to
: Int): String do
160 var out
= new FlatBuffer
161 for i
in [from
..to
[ do out
.add buffer
[i
]
162 return out
.write_to_string
166 # Decorator for span elements.
168 # Because inline comments can appear as span elements,
169 # InlineDecorator do not decorate things like paragraphs or headers.
170 private class InlineDecorator
171 super NitdocDecorator
173 redef fun add_paragraph
(v
, block
) do
177 redef fun add_headline
(v
, block
) do
181 redef fun add_code
(v
, block
) do
183 var ast
= toolcontext
.parse_something
(block
.block
.text
.to_s
)
184 if ast
isa AError then
190 v
.add
"<code class=\"nitcode\
">"
191 var hl
= new HighlightVisitor
199 # Get a markdown processor for Nitdoc comments.
200 var nitdoc_md_processor
: MarkdownProcessor is lazy
do
201 var proc
= new MarkdownProcessor
202 proc
.emitter
.decorator
= new NitdocDecorator
206 # Get a markdown inline processor for Nitdoc comments.
208 # This processor is specificaly designed to inlinable doc elements like synopsys.
209 var nitdoc_inline_processor
: MarkdownProcessor is lazy
do
210 var proc
= new MarkdownProcessor
211 proc
.emitter
.decorator
= new InlineDecorator