X-Git-Url: http://nitlanguage.org diff --git a/src/doc/html_templates/html_model.nit b/src/doc/html_templates/html_model.nit index ebc6eff..f3c2751 100644 --- a/src/doc/html_templates/html_model.nit +++ b/src/doc/html_templates/html_model.nit @@ -21,16 +21,6 @@ import html_components import html::bootstrap import ordered_tree -redef class Location - # Github url based on this location - fun github(gitdir: String): String do - var base_dir = getcwd.join_path(gitdir).simplify_path - var file_loc = getcwd.join_path(file.filename).simplify_path - var gith_loc = file_loc.substring(base_dir.length + 1, file_loc.length) - return "{gith_loc}:{line_start},{column_start}--{line_end},{column_end}" - end -end - redef class MEntity # ID used as a HTML unique ID and in file names. # @@ -103,74 +93,29 @@ redef class MEntity return tpl end - # A template article that briefly describe the entity - fun tpl_short_article: TplArticle do - var tpl = tpl_article - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.content = mdoc.tpl_short_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 = tpl_namespace - tpl.summary_title = html_name - return tpl - end - - # A template namespace - fun tpl_namespace: Template is abstract - - # 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 html_link + # Returns `self` namespace decorated with HTML links. + # + # * MProject: `mproject` + # * MGroup: `mproject(::group)` + # * MModule: `mgroup::mmodule` + # * MClass: `mproject::mclass` + # * MClassDef: `mmodule::mclassdef` + # * MProperty: `mclass::mprop` + # * MPropdef: `mclassdef:mpropdef` + fun html_namespace: Template is abstract + + # Returns the comment of this MEntity formatted as HTML. + var html_comment: nullable Writable is lazy do var mdoc = mdoc_or_fallback - if mdoc != null then - lnk.add ": " - lnk.add mdoc.tpl_short_comment - end - return new TplListItem.with_content(lnk) + if mdoc == null then return null + return mdoc.tpl_comment 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 tpl_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 + # Returns the comment of this MEntity formatted as HTML. + var html_short_comment: nullable Writable is lazy do var mdoc = mdoc_or_fallback - if mdoc != null then - lnk.add ": " - lnk.add mdoc.tpl_short_comment - end - return new TplListItem.with_content(lnk) + if mdoc == null then return null + return mdoc.tpl_short_comment end end @@ -178,19 +123,7 @@ redef class MProject redef var nitdoc_id = name.to_cmangle is lazy redef fun nitdoc_url do return root.nitdoc_url redef var html_modifiers = ["project"] - - redef fun tpl_namespace do return html_link - - redef fun tpl_definition do - var tpl = new TplDefinition - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.comment = mdoc.tpl_comment - end - return tpl - end - - redef fun tpl_css_classes do return ["public"] + redef fun html_namespace do return html_link end redef class MGroup @@ -204,24 +137,19 @@ redef class MGroup redef fun nitdoc_url do return "group_{nitdoc_id}.html" redef var html_modifiers = ["group"] - redef fun tpl_namespace do + # Depends if `self` is root or not. + # + # * If root `mproject`. + # * Else `mproject::self`. + redef fun html_namespace do var tpl = new Template - tpl.add mproject.tpl_namespace + tpl.add mproject.html_namespace if mproject.root != self then tpl.add "::" tpl.add html_link end return tpl end - - redef fun tpl_definition do - var tpl = new TplDefinition - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.comment = mdoc.tpl_comment - end - return tpl - end end redef class MModule @@ -239,26 +167,19 @@ redef class MModule redef fun nitdoc_url do return "module_{nitdoc_id}.html" redef var html_modifiers = ["module"] - redef fun tpl_namespace do + # Depends if `self` belongs to a MGroup. + # + # * If mgroup `mgroup::self`. + # * Else `self`. + redef fun html_namespace do var tpl = new Template if mgroup != null then - tpl.add mgroup.tpl_namespace + tpl.add mgroup.html_namespace tpl.add "::" end tpl.add html_link return tpl end - - redef fun tpl_definition do - var tpl = new TplClassDefinition - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.comment = mdoc.tpl_comment - end - return tpl - end - - redef fun tpl_css_classes do return ["public"] end redef class MClass @@ -285,41 +206,21 @@ redef class MClass redef fun html_modifiers do return intro.html_modifiers redef fun html_declaration do return intro.html_declaration - redef fun tpl_definition do return intro.tpl_definition - - redef fun tpl_namespace do + # Returns `mproject::self`. + redef fun html_namespace do var tpl = new Template - tpl.add intro_mmodule.mgroup.mproject.tpl_namespace + tpl.add intro_mmodule.mgroup.mproject.html_namespace tpl.add "::" tpl.add html_link tpl.add "" 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_icon do return intro.tpl_icon + # Returns `intro.html_short_signature`. + fun html_short_signature: Template do return intro.html_short_signature - fun tpl_signature: Template do - var tpl = new Template - if arity > 0 then - tpl.add "[" - var parameter_names = new Array[String] - for p in mparameters do - parameter_names.add(p.html_name) - end - tpl.add parameter_names.join(", ") - tpl.add "]" - end - return tpl - end - - redef fun tpl_css_classes do return intro.tpl_css_classes + # Returns `intro.html_signature`. + fun html_signature: Template do return intro.html_signature end redef class MClassDef @@ -355,51 +256,29 @@ redef class MClassDef tpl.add html_modifiers.join(" ") tpl.add " " tpl.add html_link - tpl.add tpl_signature + tpl.add html_signature tpl.add "" return tpl end - redef fun tpl_namespace do + # Returns `mmodule::self` + redef fun html_namespace do var tpl = new Template - tpl.add mmodule.tpl_namespace + tpl.add mmodule.html_namespace tpl.add "::" tpl.add mclass.html_link tpl.add "" return tpl end - 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.tpl_namespace - tpl.subtitle = title - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.content = mdoc.tpl_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 - - fun tpl_signature: Template do + # Returns the MClassDef generic signature without static bounds. + fun html_short_signature: Template do var tpl = new Template var mparameters = mclass.mparameters if not mparameters.is_empty then tpl.add "[" for i in [0..mparameters.length[ do - tpl.add "{mparameters[i].html_name}: " - tpl.add bound_mtype.arguments[i].tpl_signature + tpl.add mparameters[i].html_name if i < mparameters.length - 1 then tpl.add ", " end tpl.add "]" @@ -407,28 +286,18 @@ redef class MClassDef return tpl end - redef fun tpl_definition do - var tpl = new TplClassDefinition - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.comment = mdoc.tpl_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 + # Returns the MClassDef generic signature with static bounds. + fun html_signature: Template do var tpl = new Template - for modifier in modifiers do - if modifier == "public" then continue - tpl.add "{modifier.html_escape} " + var mparameters = mclass.mparameters + if not mparameters.is_empty then + tpl.add "[" + for i in [0..mparameters.length[ do + tpl.add "{mparameters[i].html_name}: " + tpl.add bound_mtype.arguments[i].html_signature + if i < mparameters.length - 1 then tpl.add ", " + end + tpl.add "]" end return tpl end @@ -441,22 +310,21 @@ redef class MProperty redef fun html_modifiers do return intro.html_modifiers redef fun html_declaration do return intro.html_declaration - redef fun tpl_namespace do + # Returns `mclass::self`. + redef fun html_namespace do var tpl = new Template - tpl.add intro_mclassdef.mclass.tpl_namespace + tpl.add intro_mclassdef.mclass.html_namespace tpl.add "::" tpl.add intro.html_link tpl.add "" return tpl end - fun tpl_signature: Template do return new Template - - redef fun tpl_title do return intro.tpl_title + # Returns `intro.html_short_signature`. + fun html_short_signature: Template do return intro.html_short_signature - redef fun tpl_icon do return intro.tpl_icon - - redef fun tpl_css_classes do return intro.tpl_css_classes + # Returns `intro.html_signature`. + fun html_signature: Template do return intro.html_signature end redef class MPropDef @@ -491,97 +359,25 @@ redef class MPropDef tpl.add html_modifiers.join(" ") tpl.add " " tpl.add html_link - tpl.add tpl_signature + tpl.add html_signature tpl.add "" return tpl end - redef fun tpl_namespace do + # Returns `mclassdef::self` + redef fun html_namespace do var tpl = new Template - tpl.add mclassdef.tpl_namespace + tpl.add mclassdef.html_namespace tpl.add "::" tpl.add html_link return tpl end - 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 mdoc = mdoc_or_fallback - if mdoc != null then - tpl.content = mdoc.tpl_comment - end - return tpl - end - - redef fun tpl_definition do - var tpl = new TplDefinition - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.comment = mdoc.tpl_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 + # Returns the MPropdDef signature without static types. + fun html_short_signature: Template is abstract - 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 - - fun tpl_signature: Template do return new Template - - redef fun tpl_list_item do - var lnk = new Template - lnk.add new TplLabel.with_classes(tpl_css_classes.to_a) - var atext = html_link.text - var ahref = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}" - var atitle = html_link.title - var anchor = new Link.with_title(ahref, atext, atitle) - lnk.add anchor - var mdoc = mdoc_or_fallback - if mdoc != null then - lnk.add ": " - lnk.add mdoc.tpl_short_comment - end - 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 mclassdef.mmodule.tpl_namespace - lnk.add "::" - var atext = mclassdef.html_link.text - var ahref = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}" - var atitle = mclassdef.html_link.title - var anchor = new Link.with_title(ahref, atext, atitle) - lnk.add anchor - var mdoc = mdoc_or_fallback - if mdoc != null then - lnk.add ": " - lnk.add mdoc.tpl_short_comment - end - var li = new TplListItem.with_content(lnk) - li.css_classes.add "signature" - return li - end + # Returns the MPropDef signature with static types. + fun html_signature: Template is abstract end redef class MAttributeDef @@ -592,27 +388,13 @@ redef class MAttributeDef return res end - redef fun tpl_signature do + redef fun html_short_signature do return new Template + + redef fun html_signature do var tpl = new Template if static_mtype != null then tpl.add ": " - tpl.add static_mtype.tpl_signature - end - return tpl - end -end - -redef class MMethod - redef fun tpl_signature do - var tpl = new Template - var params = new Array[String] - for param in intro.msignature.mparameters do - params.add param.name.html_escape - end - if not params.is_empty then - tpl.add "(" - tpl.add params.join(", ") - tpl.add ")" + tpl.add static_mtype.html_signature end return tpl end @@ -636,12 +418,12 @@ redef class MMethodDef return res end - redef fun tpl_signature do return msignature.tpl_signature + redef fun html_short_signature do return msignature.html_short_signature + redef fun html_signature do return msignature.html_signature end redef class MVirtualTypeProp redef fun html_link do return mvirtualtype.html_link - redef fun tpl_signature do return html_link end redef class MVirtualTypeDef @@ -652,41 +434,69 @@ redef class MVirtualTypeDef return res end - redef fun tpl_signature do + redef fun html_short_signature do return new Template + + redef fun html_signature do var tpl = new Template if bound == null then return tpl tpl.add ": " - tpl.add bound.tpl_signature + tpl.add bound.html_signature return tpl end end redef class MType - fun tpl_signature: Template is abstract + # Returns the signature of this type whithout bounds. + fun html_short_signature: Template is abstract + + # Returns the signature of this type. + fun html_signature: Template is abstract end redef class MClassType redef fun html_link do return mclass.html_link - redef fun tpl_signature do return html_link + redef fun html_short_signature do return html_link + redef fun html_signature do return html_link end redef class MNullableType - redef fun tpl_signature do + + redef fun html_short_signature do var tpl = new Template tpl.add "nullable " - tpl.add mtype.tpl_signature + tpl.add mtype.html_short_signature + return tpl + end + + redef fun html_signature do + var tpl = new Template + tpl.add "nullable " + tpl.add mtype.html_signature return tpl end end redef class MGenericType - redef fun tpl_signature do + redef fun html_short_signature do var lnk = html_link var tpl = new Template tpl.add new Link.with_title(lnk.href, mclass.name.html_escape, lnk.title) tpl.add "[" for i in [0..arguments.length[ do - tpl.add arguments[i].tpl_signature + tpl.add arguments[i].html_short_signature + if i < arguments.length - 1 then tpl.add ", " + end + tpl.add "]" + return tpl + end + + redef fun html_signature do + var lnk = html_link + var tpl = new Template + tpl.add new Link.with_title(lnk.href, mclass.name.html_escape, lnk.title) + tpl.add "[" + for i in [0..arguments.length[ do + tpl.add arguments[i].html_signature if i < arguments.length - 1 then tpl.add ", " end tpl.add "]" @@ -698,86 +508,74 @@ redef class MParameterType redef fun html_link do return new Link.with_title("{mclass.nitdoc_url}#FT_{name.to_cmangle}", name, "formal type") end - redef fun tpl_signature do return html_link + + redef fun html_short_signature do return html_link + redef fun html_signature do return html_link end redef class MVirtualType redef fun html_link do return mproperty.intro.html_link - redef fun tpl_signature do return html_link + redef fun html_signature do return html_link end redef class MSignature - redef fun tpl_signature do + + redef fun html_short_signature do var tpl = new Template if not mparameters.is_empty then tpl.add "(" for i in [0..mparameters.length[ do - tpl.add mparameters[i].tpl_signature + tpl.add mparameters[i].html_short_signature + if i < mparameters.length - 1 then tpl.add ", " + end + tpl.add ")" + end + return tpl + end + + redef fun html_signature do + var tpl = new Template + if not mparameters.is_empty then + tpl.add "(" + for i in [0..mparameters.length[ do + tpl.add mparameters[i].html_signature if i < mparameters.length - 1 then tpl.add ", " end tpl.add ")" end if return_mtype != null then tpl.add ": " - tpl.add return_mtype.tpl_signature + tpl.add return_mtype.html_signature end return tpl end end redef class MParameter - fun tpl_signature: Template do + + # Returns `self` name and ellipsys if any. + fun html_short_signature: Template do var tpl = new Template - tpl.add "{name}: " - tpl.add mtype.tpl_signature + tpl.add name if is_vararg then tpl.add "..." return tpl 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 + # Returns `self` name with it's static type and ellipsys if any. + fun html_signature: Template do + var tpl = new Template + tpl.add "{name}: " + tpl.add mtype.html_signature + if is_vararg then tpl.add "..." + return tpl end end - ################################################################################ # Additions to `model_ext`. redef class MRawType - redef fun tpl_signature do + redef fun html_signature do var tpl = new Template for part in parts do @@ -793,7 +591,7 @@ end redef class MInnerClass redef fun nitdoc_url do return inner.nitdoc_url - redef fun tpl_signature do return inner.tpl_signature + redef fun html_signature do return inner.html_signature end redef class MInnerClassDef @@ -801,14 +599,5 @@ redef class MInnerClassDef redef fun html_link_to_anchor do return inner.html_link_to_anchor redef fun html_link do return inner.html_link - redef fun tpl_signature do return inner.tpl_signature - - redef fun tpl_definition do - var tpl = new TplClassDefinition - var mdoc = mdoc_or_fallback - if mdoc != null then - tpl.comment = mdoc.tpl_comment - end - return tpl - end + redef fun html_signature do return inner.html_signature end