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 # Doc down related queries
16 module commands_docdown
18 import commands
::commands_parser
19 import commands
::commands_html
21 intrude import doc_down
22 intrude import markdown
::wikilinks
24 # Retrieve the MDoc summary
26 # List all MarkdownHeading found and their ids.
30 # Markdown processor used to parse the headlines
31 var markdown_processor
: nullable MarkdownProcessor = null is optional
, writable
35 # Associates each headline to its id.
36 var summary
: nullable ArrayMap[String, HeadLine] = null is optional
, writable
38 redef fun init_command
do
40 if not res
isa CmdSuccess then return res
41 var mentity
= self.mentity
.as(not null)
43 var markdown_processor
= self.markdown_processor
44 if markdown_processor
== null then
45 markdown_processor
= new MarkdownProcessor
46 self.markdown_processor
= markdown_processor
51 mdoc
= if fallback
then mentity
.mdoc_or_fallback
else mentity
.mdoc
54 if mdoc
== null then return new WarningNoMDoc(mentity
)
56 markdown_processor
.process
(mdoc
.md_documentation
.write_to_string
)
58 var summary
= new ArrayMap[String, HeadLine]
59 summary
.add_all markdown_processor
.decorator
.headlines
60 self.summary
= summary
65 # Custom Markdown processor able to process doc commands
69 redef type PROCESSOR: CmdMarkdownProcessor
71 # View used by wikilink commands to find model entities
74 redef fun add_span_code
(v
, buffer
, from
, to
) do
75 var text
= new FlatBuffer
76 buffer
.read
(text
, from
, to
)
77 var name
= text
.write_to_string
78 name
= name
.replace
("nullable ", "")
79 var mentity
= try_find_mentity
(view
, name
)
80 if mentity
== null then
84 v
.emit_text mentity
.html_link
.write_to_string
89 private fun try_find_mentity
(view
: ModelView, text
: String): nullable MEntity do
90 var mentity
= view
.mentity_by_full_name
(text
)
91 if mentity
!= null then return mentity
93 var mentities
= view
.mentities_by_name
(text
)
94 if mentities
.is_empty
then
96 else if mentities
.length
> 1 then
97 # TODO smart resolve conflicts
99 return mentities
.first
102 redef fun add_wikilink
(v
, token
) do
103 v
.render_wikilink
(token
, view
)
107 # Same as `InlineDecorator` but with wikilink commands handling
108 class CmdInlineDecorator
109 super InlineDecorator
111 redef type PROCESSOR: CmdMarkdownProcessor
113 # View used by wikilink commands to find model entities
116 redef fun add_wikilink
(v
, token
) do
117 v
.render_wikilink
(token
, view
)
121 # Custom MarkdownEmitter for commands
122 class CmdMarkdownProcessor
123 super MarkdownProcessor
125 # Parser used to process doc commands
126 var parser
: CommandParser
129 fun render_wikilink
(token
: TokenWikiLink, model
: ModelView) do
130 var link
= token
.link
131 if link
== null then return
132 var name
= token
.name
133 if name
!= null then link
= "{name} | {link}"
135 var cmd
= link
.write_to_string
137 var error
= new CmdParserError("Empty wikilink")
138 emit_text error
.to_html
.write_to_string
142 var command
= parser
.parse
(cmd
)
143 var error
= parser
.error
145 # If not a command, try a comment command
146 if command
== null and error
isa CmdParserError then
148 command
= new CmdEntity(parser
.view
, mentity_name
= cmd
)
149 var status
= command
.parser_init
(cmd
, new HashMap[String, String])
150 if not status
isa CmdSuccess then error
= status
153 if error
isa CmdError then
154 emit_text error
.to_html
.write_to_string
157 if error
isa CmdWarning then
158 emit_text error
.to_html
.write_to_string
160 add command
.as(not null).to_html
165 # Read `self` between `nstart` and `nend` (excluded) and writte chars to `out`.
166 private fun read
(out
: FlatBuffer, nstart
, nend
: Int): Int do
168 while pos
< length
and pos
< nend
do
172 if pos
== length
then return -1