return tpl
end
- # A template link to the mentity `nitdoc_id`
- fun tpl_anchor: TplLink do
- var tpl = new TplLink("#{nitdoc_id}", html_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
+
+ # 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
+
# A template article that briefly describe the entity
fun tpl_short_article: TplArticle do
var tpl = tpl_article
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.subtitle = html_namespace
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
-
# A template definition of the mentity
# include name, sysnopsys, comment and namespace
fun tpl_definition: TplDefinition is abstract
fun tpl_title: Template do
var title = new Template
title.add tpl_icon
- title.add tpl_namespace
+ title.add html_namespace
return title
end
# 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 fun tpl_declaration do
- var tpl = new Template
- tpl.add "<span>project "
- tpl.add html_link
- tpl.add "</span>"
- return tpl
- end
-
- redef fun tpl_namespace do return html_link
+ redef var html_modifiers = ["project"]
+ redef fun html_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
+ # 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
return tpl
end
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add "<span>group "
- tpl.add html_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 var html_modifiers = ["module"]
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add "<span>module "
- tpl.add tpl_namespace
- tpl.add "</span>"
- return tpl
- end
-
- 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.write_to_string
end
- redef fun tpl_declaration do return intro.tpl_declaration
- redef fun tpl_definition do return intro.tpl_definition
+ redef fun html_modifiers do return intro.html_modifiers
+ redef fun html_declaration do return intro.html_declaration
- 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 "::<span>"
tpl.add html_link
tpl.add "</span>"
return tpl
end
+ # Returns `intro.html_short_signature`.
+ fun html_short_signature: Template do return intro.html_short_signature
+
+ # Returns `intro.html_signature`.
+ fun html_signature: Template do return intro.html_signature
+
+ redef fun tpl_definition do return intro.tpl_definition
+
redef fun tpl_title do
var title = new Template
title.add tpl_icon
end
redef fun tpl_icon do return intro.tpl_icon
-
- 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
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
- redef fun tpl_namespace do
+ # 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 mmodule.tpl_namespace
+ tpl.add "<span>"
+ tpl.add html_modifiers.join(" ")
+ tpl.add " "
+ tpl.add html_link
+ tpl.add html_signature
+ tpl.add "</span>"
+ return tpl
+ end
+
+ # Returns `mmodule::self`
+ redef fun html_namespace do
+ var tpl = new Template
+ tpl.add mmodule.html_namespace
tpl.add "::<span>"
tpl.add mclass.html_link
tpl.add "</span>"
return tpl
end
+ # 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
+ if i < mparameters.length - 1 then tpl.add ", "
+ end
+ tpl.add "]"
+ end
+ return tpl
+ end
+
+ # Returns the MClassDef generic signature with static bounds.
+ fun html_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].html_signature
+ if i < mparameters.length - 1 then tpl.add ", "
+ end
+ tpl.add "]"
+ end
+ return tpl
+ end
+
redef fun tpl_article do
var tpl = new TplArticle(nitdoc_id)
tpl.summary_title = "in {mmodule.html_name}"
- tpl.title = tpl_declaration
+ tpl.title = html_declaration
tpl.title_classes.add "signature"
var title = new Template
title.add "in "
- title.add mmodule.tpl_namespace
+ title.add mmodule.html_namespace
tpl.subtitle = title
var mdoc = mdoc_or_fallback
if mdoc != null then
return title
end
- redef fun tpl_declaration do
- var tpl = new Template
- tpl.add tpl_modifiers
- tpl.add html_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].html_name}: "
- tpl.add bound_mtype.arguments[i].tpl_signature
- if i < mparameters.length - 1 then tpl.add ", "
- end
- tpl.add "]"
- end
- return tpl
- end
-
redef fun tpl_definition do
var tpl = new TplClassDefinition
var mdoc = mdoc_or_fallback
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
+ # 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 "::<span>"
tpl.add intro.html_link
tpl.add "</span>"
return tpl
end
- redef fun tpl_declaration do return intro.tpl_declaration
+ # Returns `intro.html_short_signature`.
+ fun html_short_signature: Template do return intro.html_short_signature
- fun tpl_signature: Template do return new Template
+ # Returns `intro.html_signature`.
+ fun html_signature: Template do return intro.html_signature
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
- redef fun tpl_namespace do
+ # 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 html_signature
+ tpl.add "</span>"
+ return tpl
+ end
+
+ # 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
+ # Returns the MPropdDef signature without static types.
+ fun html_short_signature: Template is abstract
+
+ # Returns the MPropDef signature with static types.
+ fun html_signature: Template is abstract
+
redef fun tpl_article do
var tpl = new TplArticle(nitdoc_id)
tpl.summary_title = "in {mclassdef.html_name}"
title.add "in "
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 html_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"
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)
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 mclassdef.mmodule.html_namespace
lnk.add "::"
var atext = mclassdef.html_link.text
var ahref = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}"
end
redef class MAttributeDef
- redef fun tpl_signature do
+
+ redef fun html_modifiers do
+ var res = super
+ res.add "var"
+ return res
+ end
+
+ 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
+ tpl.add static_mtype.html_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
+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 not params.is_empty then
- tpl.add "("
- tpl.add params.join(", ")
- tpl.add ")"
+ if mproperty.is_init then
+ res.add "init"
+ else
+ res.add "fun"
end
- return tpl
+ return res
end
-end
-redef class MMethodDef
- 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
- redef fun tpl_signature do
+
+ redef fun html_modifiers do
+ var res = super
+ res.add "type"
+ return res
+ end
+
+ 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 "]"
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].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].tpl_signature
+ 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
+ if is_vararg then tpl.add "..."
+ return tpl
+ end
+
+ # 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.tpl_signature
+ tpl.add mtype.html_signature
if is_vararg then tpl.add "..."
return tpl
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
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
redef fun nitdoc_url do return inner.nitdoc_url
- redef fun tpl_anchor do return inner.tpl_anchor
+ 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 html_signature do return inner.html_signature
redef fun tpl_definition do
var tpl = new TplClassDefinition
nitlanguage / nit.git / blobdiff