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 # Wiki internal links handling.
19 import markdown
::wikilinks
22 # Looks up a WikiEntry by its `name`.
25 # 1. Looks in the current section
26 # 2. Looks in the current section children
27 # 3. Looks in the current section parent
28 # 4. Looks up to wiki root
30 # Returns `null` if no article can be found.
31 fun lookup_entry_by_name
(context
: WikiEntry, name
: String): nullable WikiEntry do
32 var section
: nullable WikiEntry = context
.parent
or else context
33 var res
= section
.lookup_entry_by_name
(name
)
34 if res
!= null then return res
35 while section
!= null do
36 if section
.name
== name
then return section
37 if section
.children
.has_key
(name
) then return section
.children
[name
]
38 section
= section
.parent
43 # Looks up a WikiEntry by its `title`.
46 # 1. Looks in the current section
47 # 2. Looks in the current section children
48 # 3. Looks in the current section parent
49 # 4. Looks up to wiki root
51 # Returns `null` if no article can be found.
52 fun lookup_entry_by_title
(context
: WikiEntry, title
: String): nullable WikiEntry do
53 var section
: nullable WikiEntry = context
.parent
or else context
54 var res
= section
.lookup_entry_by_title
(title
)
55 if res
!= null then return res
56 while section
!= null do
57 if section
.title
== title
then return section
58 for child
in section
.children
.values
do
59 if child
.title
== title
then return child
61 section
= section
.parent
66 # Looks up a WikiEntry by its `path`.
68 # Path can be relative from `context` like `context/entry`.
69 # Or absolute like `/entry1/entry2`.
71 # Returns `null` if no article can be found.
72 fun lookup_entry_by_path
(context
: WikiEntry, path
: String): nullable WikiEntry do
73 var entry
: nullable WikiEntry = context
.parent
or else context
74 var parts
= path
.split_with
("/")
75 if path
.has_prefix
("/") then
77 if parts
.is_empty
then return root_section
.index
80 while not parts
.is_empty
do
81 var name
= parts
.shift
82 if name
.is_empty
then continue
83 if not entry
.children
.has_key
(name
) then return null
84 entry
= entry
.children
[name
]
92 # Url to `self` once generated.
93 fun url
: String do return wiki
.config
.root_url
.join_path
(breadcrumbs
.join
("/"))
97 if not is_dirty
and not wiki
.force_render
then return
98 render_sidebar_wikilinks
101 # Search in `self` then `self.children` if an entry has the name `name`.
102 fun lookup_entry_by_name
(name
: String): nullable WikiEntry do
103 if children
.has_key
(name
) then return children
[name
]
104 for child
in children
.values
do
105 var res
= child
.lookup_entry_by_name
(name
)
106 if res
!= null then return res
111 # Search in `self` then `self.children` if an entry has the title `title`.
112 fun lookup_entry_by_title
(title
: String): nullable WikiEntry do
113 for child
in children
.values
do
114 if child
.title
== title
then return child
116 for child
in children
.values
do
117 var res
= child
.lookup_entry_by_title
(title
)
118 if res
!= null then return res
123 private var md_proc
: NitiwikiMdProcessor is lazy
do
124 return new NitiwikiMdProcessor(wiki
, self)
127 # Process wikilinks from sidebar.
128 private fun render_sidebar_wikilinks
do
129 var blocks
= sidebar
.blocks
130 for i
in [0..blocks
.length
[ do
131 blocks
[i
] = md_proc
.process
(blocks
[i
].to_s
).write_to_string
132 md_proc
.emitter
.decorator
.headlines
.clear
137 redef class WikiSection
139 # The index page for this section.
141 # If no file `index.md` exists for this section,
142 # a summary is generated using contained articles.
143 var index
: WikiArticle is lazy
do
144 for child
in children
.values
do
145 if child
isa WikiArticle and child
.is_index
then return child
147 return new WikiSectionIndex(wiki
, "index", self)
151 redef class WikiArticle
153 # Headlines ids and titles.
154 var headlines
= new ArrayMap[String, HeadLine]
156 # Is `self` an index page?
158 # Checks if `self.name == "index"`.
159 fun is_index
: Bool do return name
== "index"
162 if parent
== null then
163 return wiki
.config
.root_url
.join_path
("{name}.html")
165 return parent
.url
.join_path
("{name}.html")
171 if not is_dirty
and not wiki
.force_render
or not has_source
then return
172 content
= md_proc
.process
(md
.as(not null))
173 headlines
.recover_with
(md_proc
.emitter
.decorator
.headlines
)
177 # A `WikiArticle` that contains the section index tree.
178 class WikiSectionIndex
181 # The section described by `self`.
182 var section
: WikiSection
184 redef fun title
do return section
.title
186 redef fun url
do return section
.url
189 # A MarkdownProcessor able to parse wiki links.
190 class NitiwikiMdProcessor
191 super MarkdownProcessor
193 # Wiki used to resolve links.
196 # Article parsed by `self`.
198 # Used to contextualize links.
199 var context
: WikiEntry
202 emitter
= new MarkdownEmitter(self)
203 emitter
.decorator
= new NitiwikiDecorator(wiki
, context
)
207 private class NitiwikiDecorator
210 # Wiki used to resolve links.
213 # Article used to contextualize links.
214 var context
: WikiEntry
216 redef fun add_wikilink
(v
, link
, name
, comment
) do
217 var anchor
: nullable String = null
219 if not link
.has_prefix
("http://") and not link
.has_prefix
("https://") then
220 var wiki
= v
.processor
.as(NitiwikiMdProcessor).wiki
221 var target
: nullable WikiEntry = null
222 if link
.has
("#") then
223 var parts
= link
.split_with
("#")
225 anchor
= parts
.subarray
(1, parts
.length
- 1).join
("#")
227 if link
.has
("/") then
228 target
= wiki
.lookup_entry_by_path
(context
, link
.to_s
)
230 target
= wiki
.lookup_entry_by_name
(context
, link
.to_s
)
231 if target
== null then
232 target
= wiki
.lookup_entry_by_title
(context
, link
.to_s
)
235 if target
!= null then
236 if name
== null then name
= target
.title
239 var loc
= context
.src_path
or else context
.name
240 wiki
.message
("Warning: unknown wikilink `{link}` (in {loc})", 0)
241 v
.add
"class=\"broken\
" "
245 append_value(v, link)
246 if anchor != null then append_value(v, "#{anchor}")
248 if comment != null and not comment.is_empty then
250 append_value
(v
, comment
)
254 if name == null then name = link