var article = mmodule.tpl_article
article.subtitle = mmodule.tpl_declaration
article.content = mmodule.tpl_definition
- # mclassdefs list
- var intros = mmodule.intro_mclassdefs(ctx.min_visibility).to_a
- if not intros.is_empty then
- mainmodule.linearize_mclassdefs(intros)
- var intros_art = new TplArticle.with_title("{mmodule.nitdoc_id}.intros", "Introduces")
- var intros_lst = new TplList.with_classes(["list-unstyled", "list-labeled"])
- for mclassdef in intros do
- intros_lst.add_li mclassdef.tpl_list_item
- end
- if not intros_lst.is_empty then
- intros_art.content = intros_lst
- article.add_child intros_art
- end
- end
- var redefs = mmodule.redef_mclassdefs(ctx.min_visibility).to_a
- if not redefs.is_empty then
- mainmodule.linearize_mclassdefs(redefs)
- var redefs_art = new TplArticle.with_title("{mmodule.nitdoc_id}.redefs", "Redefines")
- var redefs_lst = new TplList.with_classes(["list-unstyled", "list-labeled"])
- for mclassdef in redefs do
- redefs_lst.add_li mclassdef.tpl_list_item
- end
- if not redefs_lst.is_empty then
- redefs_art.content = redefs_lst
- article.add_child redefs_art
- end
- end
return article
end
# MClassDef description template
fun tpl_mclass_article(mclass: MClass, mclassdefs: Array[MClassDef]): TplArticle do
var article = mclass.tpl_article
- if not mclassdefs.has(mclass.intro) then
- # add intro synopsys
- var intro_article = mclass.intro.tpl_short_article
- intro_article.source_link = tpl_showsource(mclass.intro.location)
- article.add_child intro_article
- end
- mainmodule.linearize_mclassdefs(mclassdefs)
- for mclassdef in mclassdefs do
- # add mclassdef full description
- var redef_article = mclassdef.tpl_article
- redef_article.source_link = tpl_showsource(mclassdef.location)
- article.add_child redef_article
- # mpropdefs list
- var intros = new TplArticle.with_title("{mclassdef.nitdoc_id}.intros", "Introduces")
- var intros_lst = new TplList.with_classes(["list-unstyled", "list-labeled"])
- for mpropdef in mclassdef.collect_intro_mpropdefs(ctx.min_visibility) do
- intros_lst.add_li mpropdef.tpl_list_item
- end
- if not intros_lst.is_empty then
- intros.content = intros_lst
- redef_article.add_child intros
- end
- var redefs = new TplArticle.with_title("{mclassdef.nitdoc_id}.redefs", "Redefines")
- var redefs_lst = new TplList.with_classes(["list-unstyled", "list-labeled"])
- for mpropdef in mclassdef.collect_redef_mpropdefs(ctx.min_visibility) do
- redefs_lst.add_li mpropdef.tpl_list_item
- end
- if not redefs_lst.is_empty then
- redefs.content = redefs_lst
- redef_article.add_child redefs
- end
- end
return article
end
article.content = main_mpropdef.mdoc_or_fallback.tpl_comment
end
var subarticle = new TplArticle("{main_mpropdef.nitdoc_id}.redefs")
- # Add redef in same `MClass`
- if local_mpropdefs.length > 1 then
- for mpropdef in local_mpropdefs do
- if mpropdef == main_mpropdef then continue
- var redef_article = new TplArticle("{mpropdef.nitdoc_id}")
- var redef_title = new Template
- redef_title.add "also redef in "
- redef_title.add mpropdef.tpl_namespace
- redef_article.title = redef_title
- redef_article.title_classes.add "signature info"
- redef_article.css_classes.add "nospace"
- var redef_content = new Template
- if mpropdef.mdoc != null then
- redef_content.add mpropdef.mdoc.tpl_comment
- end
- redef_article.content = redef_content
- subarticle.add_child redef_article
- end
- end
# Add linearization
if lin.length > 1 then
var lin_article = new TplArticle("{main_mpropdef.nitdoc_id}.lin")
article.add_child subarticle
return article
end
-
- # MProperty description template
- fun tpl_mpropdef_article(mpropdef: MPropDef): TplArticle do
- var article = mpropdef.tpl_article
- article.source_link = tpl_showsource(mpropdef.location)
- return article
- end
end
# The overview page
--- /dev/null
+# This file is part of NIT ( http://www.nitlanguage.org ).
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Generates lists about intros/redefs in MEntity.
+#
+# Actually, this works only for MModules and MclassDefs.
+module doc_intros_redefs
+
+import doc_structure
+
+# Computes intro / redef mentity list for each DefinitionArticle.
+class IntroRedefListPhase
+ super DocPhase
+
+ redef fun apply do
+ for page in doc.pages do
+ if not page isa MEntityPage then continue
+ page.root.build_intro_redef_list(self, doc, page)
+ end
+ end
+end
+
+redef class DocComposite
+
+ # Computes intro / redef lists for this page.
+ #
+ # See `IntroRedefListPhase`.
+ fun build_intro_redef_list(v: IntroRedefListPhase, doc: DocModel, page: MEntityPage) do
+ for child in children do child.build_intro_redef_list(v, doc, page)
+ end
+end
+
+redef class DefinitionArticle
+ redef fun build_intro_redef_list(v, doc, page) do
+ var mentity = self.mentity
+ if mentity isa MModule then
+ build_mmodule_list(v, doc, mentity)
+ else if mentity isa MClassDef and mentity.mmodule == page.mentity then
+ build_mclassdef_list(v, doc, mentity)
+ end
+ super
+ end
+
+ # TODO this should move to MEntity?
+ private fun build_mmodule_list(v: IntroRedefListPhase, doc: DocModel, mmodule: MModule) do
+ var intros = mmodule.intro_mclassdefs(v.ctx.min_visibility).to_a
+ doc.mainmodule.linearize_mclassdefs(intros)
+ children.add new IntrosRedefsListArticle(mentity, "Introduces", intros)
+ var redefs = mmodule.redef_mclassdefs(v.ctx.min_visibility).to_a
+ doc.mainmodule.linearize_mclassdefs(redefs)
+ children.add new IntrosRedefsListArticle(mentity, "Redefines", redefs)
+ end
+
+ # TODO this should move to MEntity?
+ private fun build_mclassdef_list(v: IntroRedefListPhase, doc: DocModel, mclassdef: MClassDef) do
+ var intros = mclassdef.collect_intro_mpropdefs(v.ctx.min_visibility).to_a
+ # FIXME avoid diff changes
+ # v.ctx.mainmodule.linearize_mpropdefs(intros)
+ children.add new IntrosRedefsListArticle(mentity, "Introduces", intros)
+ var redefs = mclassdef.collect_redef_mpropdefs(v.ctx.min_visibility).to_a
+ # FIXME avoid diff changes
+ # v.ctx.mainmodule.linearize_mpropdefs(redefs)
+ children.add new IntrosRedefsListArticle(mentity, "Redefines", redefs)
+ end
+
+end
+
+# An article that displays a list of introduced / refined mentities.
+#
+# FIXME diff hack
+# This can merged with InheritanceListArticle in a more generic class.
+class IntrosRedefsListArticle
+ super MEntityArticle
+
+ # Title displayed as header of the list.
+ var list_title: String
+
+ # Intro mentities to list.
+ var mentities: Array[MEntity]
+end
nitlanguage / nit.git / commitdiff