import doc_base
import doc_down
-import doc_templates
+import html_components
+import html::bootstrap
import ordered_tree
redef class Location
# URL of this entity’s Nitdoc page.
fun nitdoc_url: String is abstract
- # A template link to the mentity `nitdoc_id`
- fun tpl_anchor: TplLink do
- var tpl = new TplLink("#{nitdoc_id}", nitdoc_name)
+ # Returns the mentity name without short signature.
+ #
+ # * MProject: `foo`
+ # * MGroup: `foo`
+ # * MModule: `foo`
+ # * MClass: `Foo[E]`
+ # * MClassDef: `Foo[E]`
+ # * MProperty: `foo(e)`
+ # * MPropdef: `foo(e)`
+ var html_name: String is lazy do return name.html_escape
+
+ # Returns a Link to the mentity `html_url`.
+ #
+ # Example: `<a href="html_url" title="mdoc.short_comment">html_short_name</a>
+ var html_link: Link is lazy do
+ var tpl = new Link(nitdoc_url, html_name)
var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.title = mdoc.short_comment
return tpl
end
- # A template link to the mentity `nitdoc_url`
- fun tpl_link: TplLink do
- var tpl = new TplLink(nitdoc_url, nitdoc_name)
+ # Returns a Link to the mentity `nitdoc_id`.
+ #
+ # Example: `<a href="#nitdoc_id" title="mdoc.short_comment">html_short_name</a>
+ fun html_link_to_anchor: Link do
+ var tpl = new Link("#{nitdoc_id}", html_name)
var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.title = mdoc.short_comment
return tpl
end
+ # Returns the list of keyword used in `self` declaration.
+ fun html_modifiers: Array[String] is abstract
+
+ # Returns the complete MEntity declaration decorated with HTML.
+ #
+ # * MProject: `project foo`
+ # * MGroup: `group foo`
+ # * MModule: `module foo`
+ # * MClass: `private abstract class Foo[E: Object]`
+ # * MClassDef: `redef class Foo[E]`
+ # * MProperty: `private fun foo(e: Object): Int`
+ # * MPropdef: `redef fun foo(e)`
+ fun html_declaration: Template do
+ var tpl = new Template
+ tpl.add "<span>"
+ tpl.add html_modifiers.join(" ")
+ tpl.add " "
+ tpl.add html_link
+ tpl.add "</span>"
+ return tpl
+ end
+
# A template article that briefly describe the entity
fun tpl_short_article: TplArticle do
var tpl = tpl_article
var tpl = new TplArticle.with_title(nitdoc_id, tpl_title)
tpl.title_classes.add "signature"
tpl.subtitle = tpl_namespace
- tpl.summary_title = nitdoc_name
+ tpl.summary_title = html_name
return tpl
end
- # A template signature that contains modifiers and parameters
- fun tpl_declaration: Template is abstract
-
# A template namespace
fun tpl_namespace: Template is abstract
fun tpl_list_item: TplListItem do
var lnk = new Template
lnk.add new TplLabel.with_classes(tpl_css_classes)
- lnk.add tpl_link
+ lnk.add html_link
var mdoc = mdoc_or_fallback
if mdoc != null then
lnk.add ": "
# 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 tpl_anchor
+ lnk.add html_link_to_anchor
var mdoc = mdoc_or_fallback
if mdoc != null then
lnk.add ": "
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_declaration do
- var tpl = new Template
- tpl.add "<span>project "
- tpl.add tpl_link
- tpl.add "</span>"
- return tpl
- end
-
- redef fun tpl_namespace do return tpl_link
+ redef fun tpl_namespace do return html_link
redef fun tpl_definition do
var tpl = new TplDefinition
end
redef fun nitdoc_url do return "group_{nitdoc_id}.html"
+ redef var html_modifiers = ["group"]
redef fun tpl_namespace do
var tpl = new Template
tpl.add mproject.tpl_namespace
if mproject.root != self then
tpl.add "::"
- tpl.add tpl_link
+ tpl.add html_link
end
return tpl
end
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add "<span>group "
- tpl.add tpl_link
- tpl.add "</span>"
- return tpl
- end
-
redef fun tpl_definition do
var tpl = new TplDefinition
var mdoc = mdoc_or_fallback
end
redef fun nitdoc_url do return "module_{nitdoc_id}.html"
-
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add "<span>module "
- tpl.add tpl_namespace
- tpl.add "</span>"
- return tpl
- end
+ redef var html_modifiers = ["module"]
redef fun tpl_namespace do
var tpl = new Template
tpl.add mgroup.tpl_namespace
tpl.add "::"
end
- tpl.add tpl_link
+ tpl.add html_link
return tpl
end
redef fun nitdoc_url do return "class_{nitdoc_id}.html"
redef fun mdoc_or_fallback do return intro.mdoc
- redef fun tpl_declaration do return intro.tpl_declaration
+ # Format: `Foo[E]`
+ redef var html_name is lazy do
+ var tpl = new Template
+ tpl.add name.html_escape
+ 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.write_to_string
+ end
+
+ 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
var tpl = new Template
tpl.add intro_mmodule.mgroup.mproject.tpl_namespace
tpl.add "::<span>"
- tpl.add tpl_link
+ tpl.add html_link
tpl.add "</span>"
return tpl
end
redef fun tpl_title do
var title = new Template
title.add tpl_icon
- title.add tpl_link
- title.add tpl_signature
+ title.add html_link
return title
end
tpl.add "["
var parameter_names = new Array[String]
for p in mparameters do
- parameter_names.add(p.nitdoc_name)
+ parameter_names.add(p.html_name)
end
tpl.add parameter_names.join(", ")
tpl.add "]"
return tpl
end
- redef fun tpl_article do
- var tpl = super
- tpl.summary_title = "{nitdoc_name}{tpl_signature.write_to_string}"
- return tpl
- end
-
redef fun tpl_css_classes do return intro.tpl_css_classes
end
redef class MClassDef
redef var nitdoc_id = "{mmodule.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "{mclass.nitdoc_url}#{nitdoc_id}"
-
redef fun mdoc_or_fallback do return mdoc or else mclass.mdoc_or_fallback
+ # Depends if `self` is an intro or not.
+ #
+ # * If intro contains the visibility and kind.
+ # * If redef contains the `redef` keyword and kind.
+ redef fun html_modifiers do
+ var res = new Array[String]
+ if not is_intro then
+ res.add "redef"
+ else
+ if mclass.visibility != public_visibility then
+ res.add mclass.visibility.to_s
+ end
+ end
+ res.add mclass.kind.to_s
+ return res
+ end
+
+ # Depends if `self` is an intro or not.
+ #
+ # 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 tpl_signature
+ tpl.add "</span>"
+ return tpl
+ end
+
redef fun tpl_namespace do
var tpl = new Template
tpl.add mmodule.tpl_namespace
tpl.add "::<span>"
- tpl.add mclass.tpl_link
+ tpl.add mclass.html_link
tpl.add "</span>"
return tpl
end
redef fun tpl_article do
var tpl = new TplArticle(nitdoc_id)
- tpl.summary_title = "in {mmodule.nitdoc_name}"
- tpl.title = tpl_declaration
+ tpl.summary_title = "in {mmodule.html_name}"
+ tpl.title = html_declaration
tpl.title_classes.add "signature"
var title = new Template
title.add "in "
redef fun tpl_title do
var title = new Template
title.add tpl_icon
- title.add tpl_link
- title.add tpl_signature
+ title.add html_link
return title
end
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add tpl_modifiers
- tpl.add tpl_link
- tpl.add tpl_signature
- return tpl
- end
-
fun tpl_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].nitdoc_name}: "
+ tpl.add "{mparameters[i].html_name}: "
tpl.add bound_mtype.arguments[i].tpl_signature
if i < mparameters.length - 1 then tpl.add ", "
end
redef class MProperty
redef var nitdoc_id = "{intro_mclassdef.mclass.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "property_{nitdoc_id}.html"
-
redef fun mdoc_or_fallback do return intro.mdoc
+ redef fun html_modifiers do return intro.html_modifiers
+ redef fun html_declaration do return intro.html_declaration
redef fun tpl_namespace do
var tpl = new Template
tpl.add intro_mclassdef.mclass.tpl_namespace
tpl.add "::<span>"
- tpl.add intro.tpl_link
+ tpl.add intro.html_link
tpl.add "</span>"
return tpl
end
- redef fun tpl_declaration do return intro.tpl_declaration
-
fun tpl_signature: Template do return new Template
redef fun tpl_title do return intro.tpl_title
redef class MPropDef
redef var nitdoc_id = "{mclassdef.nitdoc_id}__{name.to_cmangle}" is lazy
redef fun nitdoc_url do return "{mproperty.nitdoc_url}#{nitdoc_id}"
-
redef fun mdoc_or_fallback do return mdoc or else mproperty.mdoc_or_fallback
+ # Depends if `self` is an intro or not.
+ #
+ # * If intro contains the visibility and kind.
+ # * If redef contains the `redef` keyword and kind.
+ redef fun html_modifiers do
+ var res = new Array[String]
+ if not is_intro then
+ res.add "redef"
+ else
+ if mproperty.visibility != public_visibility then
+ res.add mproperty.visibility.to_s
+ end
+ end
+ return res
+ end
+
+ # Depends if `self` is an intro or not.
+ #
+ # 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 tpl_signature
+ tpl.add "</span>"
+ return tpl
+ end
+
redef fun tpl_namespace do
var tpl = new Template
tpl.add mclassdef.tpl_namespace
tpl.add "::"
- tpl.add tpl_link
+ tpl.add html_link
return tpl
end
redef fun tpl_article do
var tpl = new TplArticle(nitdoc_id)
- tpl.summary_title = "in {mclassdef.nitdoc_name}"
+ tpl.summary_title = "in {mclassdef.html_name}"
var title = new Template
title.add "in "
- title.add mclassdef.tpl_link
+ title.add mclassdef.html_link
tpl.title = title
- tpl.subtitle = tpl_declaration
+ tpl.subtitle = html_declaration
var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.content = mdoc.tpl_comment
return tpl
end
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add tpl_modifiers
- tpl.add tpl_link
- tpl.add tpl_signature
- return tpl
- end
-
redef fun tpl_css_classes do
var set = new HashSet[String]
if is_intro then set.add "intro"
redef fun tpl_list_item do
var lnk = new Template
lnk.add new TplLabel.with_classes(tpl_css_classes.to_a)
- var anchor = tpl_link
- anchor.href = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}"
+ 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 new TplLabel.with_classes(tpl_css_classes.to_a)
lnk.add mclassdef.mmodule.tpl_namespace
lnk.add "::"
- var anchor = mclassdef.tpl_link
- anchor.href = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}"
+ 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
end
redef class MAttributeDef
+
+ redef fun html_modifiers do
+ var res = super
+ res.add "var"
+ return res
+ end
+
redef fun tpl_signature do
var tpl = new Template
if static_mtype != null then
end
redef class MMethodDef
+
+ # FIXME annotation should be handled in their own way
+ redef fun html_modifiers do
+ var res = super
+ if is_abstract then
+ res.add "abstract"
+ else if is_intern then
+ res.add "intern"
+ end
+ if mproperty.is_init then
+ res.add "init"
+ else
+ res.add "fun"
+ end
+ return res
+ end
+
redef fun tpl_signature do return msignature.tpl_signature
end
redef class MVirtualTypeProp
- redef fun tpl_link do return mvirtualtype.tpl_link
- redef fun tpl_signature do return tpl_link
+ redef fun html_link do return mvirtualtype.html_link
+ redef fun tpl_signature do return html_link
end
redef class MVirtualTypeDef
+
+ redef fun html_modifiers do
+ var res = super
+ res.add "type"
+ return res
+ end
+
redef fun tpl_signature do
var tpl = new Template
if bound == null then return tpl
end
redef class MClassType
- redef fun tpl_link do return mclass.tpl_link
- redef fun tpl_signature do return tpl_link
+ redef fun html_link do return mclass.html_link
+ redef fun tpl_signature do return html_link
end
redef class MNullableType
redef class MGenericType
redef fun tpl_signature do
+ var lnk = html_link
var tpl = new Template
- tpl.add tpl_link
+ 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
end
redef class MParameterType
- redef fun tpl_link do
- return new TplLink.with_title("{mclass.nitdoc_url}#FT_{name.to_cmangle}", name, "formal type")
+ 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 tpl_link
+ redef fun tpl_signature do return html_link
end
redef class MVirtualType
- redef fun tpl_link do return mproperty.intro.tpl_link
- redef fun tpl_signature do return tpl_link
+ redef fun html_link do return mproperty.intro.html_link
+ redef fun tpl_signature do return html_link
end
redef class MSignature
for part in parts do
if part.target != null then
- tpl.add part.target.as(not null).tpl_link
+ tpl.add part.target.as(not null).html_link
else
tpl.add part.text.html_escape
end
redef class MInnerClassDef
redef fun nitdoc_url do return inner.nitdoc_url
- redef fun tpl_anchor do return inner.tpl_anchor
- redef fun tpl_link do return inner.tpl_link
+ 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
nitlanguage / nit.git / blobdiff