src/doc: DefinitionArticle use new templates
authorAlexandre Terrasa <alexandre@moz-code.org>
Mon, 23 Feb 2015 23:26:44 +0000 (00:26 +0100)
committerAlexandre Terrasa <alexandre@moz-code.org>
Sat, 25 Apr 2015 01:39:47 +0000 (21:39 -0400)
Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

src/doc/doc_phases/doc_html.nit
src/doc/html_templates/html_model.nit
src/doc/html_templates/html_templates.nit

index 20bf2c4..db5cf94 100644 (file)
@@ -243,9 +243,14 @@ redef class OverviewPage
                sorter.sort mprojects
                var ssection = new TplSection.with_title("projects", "Projects")
                for mproject in mprojects do
-                       var sarticle = mproject.tpl_article
+                       var sarticle = new TplArticle(mproject.nitdoc_id)
+                       var title = new Template
+                       title.add mproject.html_icon
+                       title.add mproject.html_link
+                       sarticle.title = title
+                       sarticle.title_classes.add "signature"
+                       sarticle.summary_title = mproject.html_name
                        sarticle.subtitle = mproject.html_declaration
-                       sarticle.content = mproject.tpl_definition
                        var comment = mproject.html_short_comment
                        if comment != null then
                                sarticle.content = comment
@@ -361,7 +366,7 @@ redef class MGroupPage
        end
 
        private fun tpl_sidebar_item(def: MClass): TplListItem do
-               var classes = def.intro.tpl_css_classes.to_a
+               var classes = def.intro.css_classes
                if intros.has(def) then
                        classes.add "intro"
                else
@@ -402,7 +407,7 @@ redef class MModulePage
        end
 
        private fun tpl_sidebar_item(def: MClass): TplListItem do
-               var classes = def.intro.tpl_css_classes.to_a
+               var classes = def.intro.css_classes
                if def.intro_mmodule == self.mentity then
                        classes.add "intro"
                else
@@ -447,7 +452,7 @@ redef class MClassPage
        end
 
        private fun tpl_sidebar_item(mprop: MProperty): TplListItem do
-               var classes = mprop.intro.tpl_css_classes.to_a
+               var classes = mprop.intro.css_classes
                if not mprop_is_local(mprop) then
                        classes.add "inherit"
                        var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url
@@ -620,26 +625,80 @@ end
 
 redef class DefinitionArticle
        redef fun render(v, doc, page, parent) do
-               var article: TplArticle
+               var title = new Template
+               title.add mentity.html_icon
+               title.add mentity.html_name
+
+               var article = new TplArticle(mentity.nitdoc_id)
+               article.title = title
+               article.title_classes.add "signature"
+               article.subtitle = mentity.html_declaration
+               article.summary_title = mentity.html_name
+               article.content = write_to_string
+
+               # FIXME less hideous hacks...
                var mentity = self.mentity
-               # FIXME hideous hacks...
                if mentity isa MModule then
-                       article = mentity.tpl_article
-                       article.subtitle = mentity.html_declaration
-                       article.content = mentity.tpl_definition
+                       title = new Template
+                       title.add mentity.html_icon
+                       title.add mentity.html_namespace
+                       article.title = title
                else if mentity isa MClass then
-                       article = make_mclass_article(v, page)
+                       title = new Template
+                       title.add mentity.html_icon
+                       title.add mentity.html_link
+                       article.title = title
+                       article.subtitle = mentity.html_namespace
+                       article.content = null
                else if mentity isa MClassDef then
-                       article = make_mclassdef_article(v, page)
+                       title = new Template
+                       title.add "in "
+                       title.add mentity.mmodule.html_namespace
+                       article.title = mentity.html_declaration
+                       article.subtitle = title
                        article.source_link = v.tpl_showsource(mentity.location)
-               else if mentity isa MPropDef and page.mentity isa MClass then
-                       article = make_mpropdef_article(v, doc, page)
-               else
-                       article = mentity.tpl_article
-                       article.subtitle = mentity.html_declaration
-                       if mentity isa MPropDef then
-                               article.source_link = v.tpl_showsource(mentity.location)
+                       if mentity.is_intro and mentity.mmodule != page.mentity then
+                               article.content = mentity.html_short_comment
+                       end
+               else if mentity isa MPropDef then
+                       if page.mentity isa MClass then
+                               title = new Template
+                               title.add mentity.html_icon
+                               title.add mentity.html_declaration
+                               article.title = title
+                               article.subtitle = mentity.html_namespace
+                               # TODO move in its own phase? let's see after doc_template refactoring.
+                               # Add linearization
+                               var all_defs = new HashSet[MPropDef]
+                               for local_def in local_defs(page.as(MClassPage), mentity.mproperty) do
+                                       all_defs.add local_def
+                                       var smpropdef = local_def
+                                       while not smpropdef.is_intro do
+                                               smpropdef = smpropdef.lookup_next_definition(
+                                                       doc.mainmodule, smpropdef.mclassdef.bound_mtype)
+                                               all_defs.add smpropdef
+                                       end
+                               end
+                               var lin = all_defs.to_a
+                               doc.mainmodule.linearize_mpropdefs(lin)
+                               if lin.length > 1 then
+                                       var lin_article = new TplArticle("{mentity.nitdoc_id}.lin")
+                                       lin_article.title = "Inheritance"
+                                       var lst = new TplList.with_classes(["list-unstyled", "list-labeled"])
+                                       for smpropdef in lin do
+                                               lst.add_li smpropdef.tpl_inheritance_item
+                                       end
+                                       lin_article.content = lst
+                                       article.add_child lin_article
+                               end
+                       else
+                               title = new Template
+                               title.add "in "
+                               title.add mentity.mclassdef.html_link
+                               article.title = title
+                               article.summary_title = "in {mentity.mclassdef.html_name}"
                        end
+                       article.source_link = v.tpl_showsource(mentity.location)
                end
                for child in children do
                        child.render(v, doc, page, article)
@@ -647,82 +706,6 @@ redef class DefinitionArticle
                parent.add_child article
        end
 
-       # FIXME avoid diff while preserving TplArticle compatibility.
-
-       private fun make_mclass_article(v: RenderHTMLPhase, page: MEntityPage): TplArticle do
-               var article = mentity.tpl_article
-               article.subtitle = mentity.html_namespace
-               article.content = null
-               return article
-       end
-
-       private fun make_mclassdef_article(v: RenderHTMLPhase, page: MEntityPage): TplArticle do
-               var mclassdef = mentity.as(MClassDef)
-               var article = mentity.tpl_article
-               if mclassdef.is_intro and mclassdef.mmodule != page.mentity then
-                       article = mentity.tpl_short_article
-               end
-               var title = new Template
-               title.add "in "
-               title.add mclassdef.mmodule.html_namespace
-               article.subtitle = title
-               return article
-       end
-
-       private fun make_mpropdef_article(v: RenderHTMLPhase, doc: DocModel, page: MEntityPage): TplArticle
-       do
-               var mpropdef = mentity.as(MPropDef)
-               var mprop = mpropdef.mproperty
-               var article = new TplArticle(mprop.nitdoc_id)
-               var title = new Template
-               title.add mprop.tpl_icon
-               title.add "<span id='{mpropdef.nitdoc_id}'></span>"
-               if mpropdef.is_intro then
-                       title.add mprop.html_link
-                       title.add mprop.intro.html_signature
-               else
-                       var cls_url = mprop.intro.mclassdef.mclass.nitdoc_url
-                       var def_url = "{cls_url}#{mprop.nitdoc_id}"
-                       var lnk = new TplLink.with_title(def_url, mprop.html_name,
-                                       "Go to introduction")
-                       title.add "redef "
-                       title.add lnk
-               end
-               article.title = title
-               article.title_classes.add "signature"
-               article.summary_title = "{mprop.html_name}"
-               article.subtitle = mpropdef.html_namespace
-               var comment = mpropdef.html_comment
-               if comment != null then
-                       article.content = comment
-               end
-               # TODO move in its own phase? let's see after doc_template refactoring.
-               # Add linearization
-               var all_defs = new HashSet[MPropDef]
-               for local_def in local_defs(page.as(MClassPage), mprop) do
-                       all_defs.add local_def
-                       var smpropdef = local_def
-                       while not smpropdef.is_intro do
-                               smpropdef = smpropdef.lookup_next_definition(
-                                       doc.mainmodule, smpropdef.mclassdef.bound_mtype)
-                               all_defs.add smpropdef
-                       end
-               end
-               var lin = all_defs.to_a
-               doc.mainmodule.linearize_mpropdefs(lin)
-               if lin.length > 1 then
-                       var lin_article = new TplArticle("{mpropdef.nitdoc_id}.lin")
-                       lin_article.title = "Inheritance"
-                       var lst = new TplList.with_classes(["list-unstyled", "list-labeled"])
-                       for smpropdef in lin do
-                               lst.add_li smpropdef.tpl_inheritance_item
-                       end
-                       lin_article.content = lst
-                       article.add_child lin_article
-               end
-               return article
-       end
-
        # Filter `page.mpropdefs` for this `mpropertie`.
        #
        # FIXME compatability with current templates.
@@ -833,33 +816,10 @@ redef class Location
 end
 
 redef class MEntity
-       # A template article that briefly describe the entity
-       fun tpl_short_article: TplArticle do
-               var tpl = tpl_article
-               var comment = html_short_comment
-               if comment != null then
-                       tpl.content = comment
-               end
-               return tpl
-       end
-
-       # A template article that describe the entity
-       fun tpl_article: TplArticle do
-               var tpl = new TplArticle.with_title(nitdoc_id, tpl_title)
-               tpl.title_classes.add "signature"
-               tpl.subtitle = html_namespace
-               tpl.summary_title = html_name
-               return tpl
-       end
-
-       # A template definition of the mentity
-       # include name, sysnopsys, comment and namespace
-       fun tpl_definition: TplDefinition is abstract
-
        # A li element that can go in a list
        fun tpl_list_item: TplListItem do
                var lnk = new Template
-               lnk.add new TplLabel.with_classes(tpl_css_classes)
+               lnk.add new TplLabel.with_classes(css_classes)
                lnk.add html_link
                var comment = html_short_comment
                if comment != null then
@@ -868,192 +828,12 @@ redef class MEntity
                end
                return new TplListItem.with_content(lnk)
        end
-
-       var tpl_css_classes = new Array[String]
-
-       # Box title for this mentity
-       fun tpl_title: Template do
-               var title = new Template
-               title.add tpl_icon
-               title.add html_namespace
-               return title
-       end
-
-       # Icon that will be displayed before the title
-       fun tpl_icon: TplIcon do
-               var icon = new TplIcon.with_icon("tag")
-               icon.css_classes.add_all(tpl_css_classes)
-               return icon
-       end
-end
-
-redef class MConcern
-       # Return a li element for `self` that can be displayed in a concern list
-       private fun tpl_concern_item: TplListItem do
-               var lnk = new Template
-               lnk.add html_link_to_anchor
-               var comment = html_short_comment
-               if comment != null then
-                       lnk.add ": "
-                       lnk.add comment
-               end
-               return new TplListItem.with_content(lnk)
-       end
-end
-
-redef class MProject
-       redef fun tpl_definition do
-               var tpl = new TplDefinition
-                       var comment = html_comment
-               if comment != null then
-                       tpl.comment = comment
-               end
-               return tpl
-       end
-
-       redef fun tpl_css_classes do return ["public"]
-end
-
-redef class MGroup
-       redef fun tpl_definition do
-               var tpl = new TplDefinition
-               var comment = html_comment
-               if comment != null then
-                       tpl.comment = comment
-               end
-               return tpl
-       end
-end
-
-redef class MModule
-       redef fun tpl_definition do
-               var tpl = new TplClassDefinition
-               var comment = html_comment
-               if comment != null then
-                       tpl.comment = comment
-               end
-               return tpl
-       end
-
-       redef fun tpl_css_classes do return ["public"]
-end
-
-redef class MClass
-       redef fun tpl_definition do return intro.tpl_definition
-
-       redef fun tpl_title do
-               var title = new Template
-               title.add tpl_icon
-               title.add html_link
-               return title
-       end
-
-       redef fun tpl_icon do return intro.tpl_icon
-       redef fun tpl_css_classes do return intro.tpl_css_classes
-end
-
-redef class MClassDef
-       redef fun tpl_article do
-               var tpl = new TplArticle(nitdoc_id)
-               tpl.summary_title = "in {mmodule.html_name}"
-               tpl.title = html_declaration
-               tpl.title_classes.add "signature"
-               var title = new Template
-               title.add "in "
-               title.add mmodule.html_namespace
-               tpl.subtitle = title
-               var comment = html_comment
-               if comment != null then
-                       tpl.content = comment
-               end
-               return tpl
-       end
-
-       redef fun tpl_title do
-               var title = new Template
-               title.add tpl_icon
-               title.add html_link
-               return title
-       end
-
-       redef fun tpl_definition do
-               var tpl = new TplClassDefinition
-               var comment = html_comment
-               if comment != null then
-                       tpl.comment = comment
-               end
-               return tpl
-       end
-
-       redef fun tpl_css_classes do
-               var set = new HashSet[String]
-               if is_intro then set.add "intro"
-               for m in mclass.intro.modifiers do set.add m.to_cmangle
-               for m in modifiers do set.add m.to_cmangle
-               return set.to_a
-       end
-
-       fun tpl_modifiers: Template do
-               var tpl = new Template
-               for modifier in modifiers do
-                       if modifier == "public" then continue
-                       tpl.add "{modifier.html_escape} "
-               end
-               return tpl
-       end
-end
-
-redef class MProperty
-       redef fun tpl_title do return intro.tpl_title
-       redef fun tpl_icon do return intro.tpl_icon
-       redef fun tpl_css_classes do return intro.tpl_css_classes
 end
 
 redef class MPropDef
-       redef fun tpl_article do
-               var tpl = new TplArticle(nitdoc_id)
-               tpl.summary_title = "in {mclassdef.html_name}"
-               var title = new Template
-               title.add "in "
-               title.add mclassdef.html_link
-               tpl.title = title
-               tpl.subtitle = html_declaration
-               var comment = html_comment
-               if comment != null then
-                       tpl.content = comment
-               end
-               return tpl
-       end
-
-       redef fun tpl_definition do
-               var tpl = new TplDefinition
-               var comment = html_comment
-               if comment != null then
-                       tpl.comment = comment
-               end
-               return tpl
-       end
-
-       redef fun tpl_css_classes do
-               var set = new HashSet[String]
-               if is_intro then set.add "intro"
-               for m in mproperty.intro.modifiers do set.add m.to_cmangle
-               for m in modifiers do set.add m.to_cmangle
-               return set.to_a
-       end
-
-       fun tpl_modifiers: Template do
-               var tpl = new Template
-               for modifier in modifiers do
-                       if modifier == "public" then continue
-                       tpl.add "{modifier.html_escape} "
-               end
-               return tpl
-       end
-
        redef fun tpl_list_item do
                var lnk = new Template
-               lnk.add new TplLabel.with_classes(tpl_css_classes.to_a)
+               lnk.add new TplLabel.with_classes(css_classes)
                var atext = html_link.text
                var ahref = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}"
                var atitle = html_link.title
@@ -1067,9 +847,10 @@ redef class MPropDef
                return new TplListItem.with_content(lnk)
        end
 
+       #
        fun tpl_inheritance_item: TplListItem do
                var lnk = new Template
-               lnk.add new TplLabel.with_classes(tpl_css_classes.to_a)
+               lnk.add new TplLabel.with_classes(css_classes)
                lnk.add mclassdef.mmodule.html_namespace
                lnk.add "::"
                var atext = mclassdef.html_link.text
@@ -1087,51 +868,3 @@ redef class MPropDef
                return li
        end
 end
-
-redef class ConcernsTree
-
-       private var seen = new HashSet[MConcern]
-
-       redef fun add(p, e) do
-               if seen.has(e) then return
-               seen.add e
-               super(p, e)
-       end
-
-       fun to_tpl: TplList do
-               var lst = new TplList.with_classes(["list-unstyled", "list-definition"])
-               for r in roots do
-                       var li = r.tpl_concern_item
-                       lst.add_li li
-                       build_list(r, li)
-               end
-               return lst
-       end
-
-       private fun build_list(e: MConcern, li: TplListItem) do
-               if not sub.has_key(e) then return
-               var subs = sub[e]
-               var lst = new TplList.with_classes(["list-unstyled", "list-definition"])
-               for e2 in subs do
-                       if e2 isa MGroup and e2.is_root then
-                               build_list(e2, li)
-                       else
-                               var sli = e2.tpl_concern_item
-                               lst.add_li sli
-                               build_list(e2, sli)
-                       end
-               end
-               li.append lst
-       end
-end
-
-redef class MInnerClassDef
-       redef fun tpl_definition do
-               var tpl = new TplClassDefinition
-               var comment = html_comment
-               if comment != null then
-                       tpl.comment = comment
-               end
-               return tpl
-       end
-end
index a1e0283..5d55a53 100644 (file)
@@ -117,6 +117,18 @@ redef class MEntity
                if mdoc == null then return null
                return mdoc.tpl_short_comment
        end
+
+       # Icon that will be displayed before the title
+       fun html_icon: BSIcon do
+               var icon = new BSIcon("tag")
+               icon.css_classes.add_all(css_classes)
+               return icon
+       end
+
+       # CSS classes used to decorate `self`.
+       #
+       # Mainly used for icons.
+       var css_classes = new Array[String]
 end
 
 redef class MProject
@@ -124,6 +136,7 @@ redef class MProject
        redef fun nitdoc_url do return root.nitdoc_url
        redef var html_modifiers = ["project"]
        redef fun html_namespace do return html_link
+       redef var css_classes = ["public"]
 end
 
 redef class MGroup
@@ -150,6 +163,8 @@ redef class MGroup
                end
                return tpl
        end
+
+       redef var css_classes = ["public"]
 end
 
 redef class MModule
@@ -180,6 +195,8 @@ redef class MModule
                tpl.add html_link
                return tpl
        end
+
+       redef var css_classes = ["public"]
 end
 
 redef class MClass
@@ -221,6 +238,9 @@ redef class MClass
 
        # Returns `intro.html_signature`.
        fun html_signature: Template do return intro.html_signature
+
+       redef fun html_icon do return intro.html_icon
+       redef fun css_classes do return intro.css_classes
 end
 
 redef class MClassDef
@@ -249,14 +269,17 @@ redef class MClassDef
        #
        # For intro: `private abstract class Foo[E: Object]`
        # For redef: `redef class Foo[E]`
-       # TODO change the implementation to correspond to the comment.
        redef fun html_declaration do
                var tpl = new Template
                tpl.add "<span>"
                tpl.add html_modifiers.join(" ")
                tpl.add " "
                tpl.add html_link
-               tpl.add html_signature
+               if is_intro then
+                       tpl.add html_signature
+               else
+                       tpl.add html_short_signature
+               end
                tpl.add "</span>"
                return tpl
        end
@@ -301,6 +324,14 @@ redef class MClassDef
                end
                return tpl
        end
+
+       redef fun css_classes do
+               var set = new HashSet[String]
+               if is_intro then set.add "intro"
+               for m in mclass.intro.modifiers do set.add m.to_cmangle
+               for m in modifiers do set.add m.to_cmangle
+               return set.to_a
+       end
 end
 
 redef class MProperty
@@ -325,6 +356,8 @@ redef class MProperty
 
        # Returns `intro.html_signature`.
        fun html_signature: Template do return intro.html_signature
+
+       redef fun css_classes do return intro.css_classes
 end
 
 redef class MPropDef
@@ -352,14 +385,18 @@ redef class MPropDef
        #
        # For intro: `private fun foo(e: Object): Bar is abstract`
        # For redef: `redef fun foo(e) is cached`
-       # TODO change the implementation to correspond to the comment.
        redef fun html_declaration do
                var tpl = new Template
                tpl.add "<span>"
                tpl.add html_modifiers.join(" ")
                tpl.add " "
-               tpl.add html_link
-               tpl.add html_signature
+               if is_intro then
+                       tpl.add html_link
+                       tpl.add html_signature
+               else
+                       tpl.add mproperty.intro.html_link
+                       tpl.add html_short_signature
+               end
                tpl.add "</span>"
                return tpl
        end
@@ -378,6 +415,14 @@ redef class MPropDef
 
        # Returns the MPropDef signature with static types.
        fun html_signature: Template is abstract
+
+       redef fun css_classes do
+               var set = new HashSet[String]
+               if is_intro then set.add "intro"
+               for m in mproperty.intro.modifiers do set.add m.to_cmangle
+               for m in modifiers do set.add m.to_cmangle
+               return set.to_a
+       end
 end
 
 redef class MAttributeDef
index 3dba2d9..d6cd154 100644 (file)
@@ -286,3 +286,16 @@ redef class ConcernsArticle
 
        redef fun render_body do add concerns.html_list
 end
+
+redef class DefinitionArticle
+       redef var html_id is lazy do return "article_definition_{mentity.nitdoc_id}"
+       redef var html_title is lazy do return mentity.html_name
+       redef var html_subtitle is lazy do return mentity.html_declaration
+       redef var is_hidden = false
+
+       redef fun render_body do
+               var comment = mentity.html_comment
+               if comment != null then addn comment
+               super
+       end
+end