module doc_model
import model_utils
-import modelize_property
-import markdown
+import doc_down
import doc_templates
-
-redef class MDoc
- # Comment synopsys HTML escaped
- fun short_comment: String do return content.first.html_escape
-
- # Full comment HTML escaped
- fun full_comment: String do return content.join("\n").html_escape
-
- # Synopsys in a template
- fun tpl_short_comment: Streamable do return short_markdown
-
- # Full comment in a template
- fun tpl_comment: Streamable do return full_markdown
-end
+import ordered_tree
+import model_ext
redef class Location
# Github url based on this location
end
redef class MEntity
- # HTML Escaped name
- fun nitdoc_name: String is abstract
-
- # HTML anchor to this entity in a nitdoc page
- fun nitdoc_anchor: String is abstract
-
- # URL of this entity Nitdoc page
+ # HTML-escaped name.
+ fun nitdoc_name: String do return name.html_escape
+
+ # ID used as a HTML unique ID and in file names.
+ #
+ # **Must** match the following (POSIX ERE) regular expression:
+ #
+ # ~~~POSIX ERE
+ # ^[A-Za-z_][A-Za-z0-9._-]*$
+ # ~~~
+ #
+ # That way, the ID is always a valid URI component and a valid XML name.
+ fun nitdoc_id: String is abstract
+
+ # URL of this entity’s Nitdoc page.
fun nitdoc_url: String is abstract
- # A template link to the mentity `nitdoc_anchor`
- fun tpl_anchor: TplLink is abstract
+ # A template link to the mentity `nitdoc_id`
+ fun tpl_anchor: TplLink do
+ var tpl = new TplLink("#{nitdoc_id}", nitdoc_name)
+ var mdoc = mdoc_or_fallback
+ if mdoc != null then
+ tpl.title = mdoc.short_comment
+ end
+ return tpl
+ end
# A template link to the mentity `nitdoc_url`
- fun tpl_link: TplLink is abstract
+ fun tpl_link: TplLink do
+ var tpl = new TplLink(nitdoc_url, nitdoc_name)
+ var mdoc = mdoc_or_fallback
+ if mdoc != null then
+ tpl.title = mdoc.short_comment
+ end
+ 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 = nitdoc_name
+ return tpl
+ end
# A template signature that contains modifiers and parameters
fun tpl_declaration: Template is abstract
# A template definition of the mentity
# include name, sysnopsys, comment and namespace
fun tpl_definition: TplDefinition is abstract
-end
-redef class MProject
- fun nitdoc_mdoc: nullable MDoc do
- if mdoc != null then return mdoc
- if root == null then return null
- if root.mdoc != null then return root.mdoc
- if not root.mmodules.is_empty then return root.mmodules.first.mdoc
- return null
+ # 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 tpl_link
+ 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
- redef fun nitdoc_name do return name.html_escape
- redef fun nitdoc_anchor do return "PRJ_{nitdoc_name}"
+ fun tpl_css_classes: Array[String] is abstract
- redef fun nitdoc_url do
- if root != null and not root.mmodules.is_empty then return root.mmodules.first.nitdoc_url
- return "project_{name}.html"
+ # 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
- redef fun tpl_anchor do
- var tpl = new TplLink("#{nitdoc_anchor}", nitdoc_name)
- var mdoc = nitdoc_mdoc
- if mdoc != null then
- tpl.title = mdoc.short_comment
- end
- return tpl
+ # 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 fun tpl_link do
- var tpl = new TplLink(nitdoc_url, nitdoc_name)
- var mdoc = nitdoc_mdoc
+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 tpl_anchor
+ var mdoc = mdoc_or_fallback
if mdoc != null then
- tpl.title = mdoc.short_comment
+ lnk.add ": "
+ lnk.add mdoc.tpl_short_comment
end
- return tpl
+ return new TplListItem.with_content(lnk)
end
+end
+
+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
redef fun tpl_definition do
var tpl = new TplDefinition
- tpl.namespace = tpl_namespace
- var mdoc = nitdoc_mdoc
+ var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.comment = mdoc.tpl_comment
end
return tpl
end
- fun tpl_article: TplArticle do
- var article = new TplArticle.with_title(nitdoc_anchor, tpl_link)
- article.title_classes.add "signature"
- article.subtitle = tpl_declaration
- article.summary_title = nitdoc_name
- article.content = tpl_definition
- return article
- end
+ redef fun tpl_css_classes do return ["public"]
end
redef class MGroup
- redef fun tpl_link do return mmodules.first.tpl_link
-
- redef fun tpl_namespace do
- if mproject == null then return tpl_link
- if mproject.root != self then
- var tpl = new Template
- tpl.add mproject.tpl_namespace
- tpl.add "::"
- tpl.add self.tpl_link
- return tpl
- else
- return mproject.tpl_namespace
- end
- end
-end
-
-redef class MModule
- # Is the mmodule created by nitdoc for internal purpose?
- var is_fictive: Bool writable = false
-
- # Full namespace of this module
- fun full_namespace: String do
- if public_owner != null then
- return "{public_owner.nitdoc_name}::{nitdoc_name}"
+ redef var nitdoc_id is lazy do
+ if parent != null then
+ return "{parent.nitdoc_id}__{name.to_cmangle}"
end
- return nitdoc_name
+ return name.to_cmangle
end
- redef fun nitdoc_name do return name.html_escape
+ redef fun nitdoc_url do return "group_{nitdoc_id}.html"
- redef fun nitdoc_url do
- var res = new FlatBuffer
- res.append("module_")
- var mowner = public_owner
- if mowner != null then
- res.append("{public_owner.name}_")
+ 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
end
- res.append("{self.name}.html")
- return res.to_s
+ return tpl
end
- redef fun nitdoc_anchor: String do
- var res = new FlatBuffer
- res.append("MOD_")
- var mowner = public_owner
- if mowner != null then
- res.append("{public_owner.nitdoc_name}_")
- end
- res.append(nitdoc_name)
- return res.to_s
+ 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_anchor do
- var tpl = new TplLink("#{nitdoc_anchor}", nitdoc_name)
+ redef fun tpl_definition do
+ var tpl = new TplDefinition
+ var mdoc = mdoc_or_fallback
if mdoc != null then
- tpl.title = mdoc.short_comment
+ tpl.comment = mdoc.tpl_comment
end
return tpl
end
+end
- redef fun tpl_link do
- var tpl = new TplLink(nitdoc_url, nitdoc_name)
- if mdoc != null then
- tpl.title = mdoc.short_comment
+redef class MModule
+ redef var nitdoc_id is lazy do
+ if mgroup != null then
+ if mgroup.mmodules.length == 1 then
+ return "{mgroup.nitdoc_id}-"
+ else
+ return "{mgroup.nitdoc_id}__{name.to_cmangle}"
+ end
end
- return tpl
+ return name.to_cmangle
end
+ redef fun nitdoc_url do return "module_{nitdoc_id}.html"
+
redef fun tpl_declaration do
var tpl = new Template
tpl.add "<span>module "
redef fun tpl_namespace do
var tpl = new Template
- if mgroup != null and mgroup.mmodules.first != self then
+ if mgroup != null then
tpl.add mgroup.tpl_namespace
tpl.add "::"
end
- tpl.add "<span>"
tpl.add tpl_link
- tpl.add "</span>"
return tpl
end
redef fun tpl_definition do
- var tpl = new TplDefinition
- tpl.namespace = tpl_namespace
+ var tpl = new TplClassDefinition
+ var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.comment = mdoc.tpl_comment
end
return tpl
end
- fun tpl_article: TplArticle do
- var article = new TplArticle.with_title(nitdoc_anchor, tpl_link)
- article.title_classes.add "signature"
- article.subtitle = tpl_declaration
- article.summary_title = nitdoc_name
- article.content = tpl_definition
- return article
- end
-
- fun tpl_list_item: TplListItem do
- var lnk = new Template
- lnk.add tpl_link
- if mdoc != null then
- lnk.add ": "
- lnk.add mdoc.short_comment
- end
- return new TplListItem.with_content(lnk)
- end
+ redef fun tpl_css_classes do return ["public"]
end
redef class MClass
- redef fun nitdoc_name do return name.html_escape
- redef fun nitdoc_url do return "class_{public_owner}_{name}.html"
- redef fun nitdoc_anchor do return "CLASS_{public_owner.nitdoc_name}_{nitdoc_name}"
-
- redef fun tpl_anchor do
- var tpl = new TplLink("#{nitdoc_anchor}", nitdoc_name)
- if intro.mdoc != null then
- tpl.title = intro.mdoc.short_comment
- end
- return tpl
- end
-
- redef fun tpl_link do
- var tpl = new TplLink(nitdoc_url, nitdoc_name)
- if intro.mdoc != null then
- tpl.title = intro.mdoc.short_comment
- end
- return tpl
- end
+ redef var nitdoc_id = "{intro_mmodule.nitdoc_id}__{name.to_cmangle}" is lazy
+ 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
redef fun tpl_namespace do
var tpl = new Template
- tpl.add intro_mmodule.tpl_namespace
+ tpl.add intro_mmodule.mgroup.mproject.tpl_namespace
tpl.add "::<span>"
tpl.add tpl_link
tpl.add "</span>"
return tpl
end
- fun tpl_list_item: TplListItem do
- var lnk = new Template
- lnk.add tpl_link
- if intro.mdoc != null then
- lnk.add ": "
- lnk.add intro.mdoc.short_comment
- end
- return new TplListItem.with_content(lnk)
+ redef fun tpl_title do
+ var title = new Template
+ title.add tpl_icon
+ title.add tpl_link
+ title.add tpl_signature
+ return title
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 "["
- tpl.add intro.parameter_names.join(", ")
+ var parameter_names = new Array[String]
+ for p in mparameters do
+ parameter_names.add(p.nitdoc_name)
+ end
+ tpl.add parameter_names.join(", ")
tpl.add "]"
end
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 fun nitdoc_name do return mclass.nitdoc_name
+ 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 tpl_link do return mclass.tpl_link
+ redef fun mdoc_or_fallback do return mdoc or else mclass.mdoc_or_fallback
redef fun tpl_namespace do
var tpl = new Template
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.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 tpl_link
+ title.add tpl_signature
+ return title
+ end
+
redef fun tpl_declaration do
var tpl = new Template
tpl.add tpl_modifiers
fun tpl_signature: Template do
var tpl = new Template
- if not parameter_names.is_empty then
+ var mparameters = mclass.mparameters
+ if not mparameters.is_empty then
tpl.add "["
- for i in [0..parameter_names.length[ do
- tpl.add "{parameter_names[i]}: "
+ for i in [0..mparameters.length[ do
+ tpl.add "{mparameters[i].nitdoc_name}: "
tpl.add bound_mtype.arguments[i].tpl_signature
- if i < parameter_names.length - 1 then tpl.add ", "
+ if i < mparameters.length - 1 then tpl.add ", "
end
tpl.add "]"
end
redef fun tpl_definition do
var tpl = new TplClassDefinition
tpl.namespace = tpl_namespace
+ var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.comment = mdoc.tpl_comment
end
return tpl
end
- fun tpl_css_classes: Set[String] do
+ redef fun tpl_css_classes do
var set = new HashSet[String]
if is_intro then set.add "intro"
- set.add_all mclass.intro.modifiers
- set.add_all modifiers
- return set
+ 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} "
+ tpl.add "{modifier.html_escape} "
end
return tpl
end
end
redef class MProperty
- redef fun nitdoc_name do return name.html_escape
+ 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 tpl_namespace do
var tpl = new Template
redef fun tpl_declaration do return intro.tpl_declaration
fun tpl_signature: Template do return new Template
-end
-redef class MPropDef
- redef fun nitdoc_url do return "{mclassdef.mclass.nitdoc_url}#{nitdoc_anchor}"
+ redef fun tpl_title do return intro.tpl_title
- redef fun nitdoc_anchor do
- return "PROP_{mclassdef.mclass.public_owner.nitdoc_name}_{mproperty.name.to_cmangle}"
- end
+ redef fun tpl_icon do return intro.tpl_icon
- redef fun tpl_anchor do
- var tpl = new TplLink("#{nitdoc_anchor}", mproperty.nitdoc_name)
- if mproperty.intro.mdoc != null then
- tpl.title = mproperty.intro.mdoc.short_comment
- end
- return tpl
- end
+ redef fun tpl_css_classes do return intro.tpl_css_classes
+end
- redef fun tpl_link do
- var tpl = new TplLink(nitdoc_url, mproperty.nitdoc_name)
- if mproperty.intro.mdoc != null then
- tpl.title = mproperty.intro.mdoc.short_comment
- end
- return tpl
- end
+redef class MPropDef
+ redef fun nitdoc_name do return mproperty.nitdoc_name
+ 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
var tpl = new Template
tpl.add mclassdef.tpl_namespace
tpl.add "::"
- tpl.add mproperty.name
+ tpl.add tpl_link
+ return tpl
+ end
+
+ redef fun tpl_article do
+ var tpl = new TplArticle(nitdoc_id)
+ tpl.summary_title = "in {mclassdef.nitdoc_name}"
+ var title = new Template
+ title.add "in "
+ title.add mclassdef.tpl_link
+ tpl.title = title
+ tpl.subtitle = tpl_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
tpl.namespace = mclassdef.tpl_namespace
+ var mdoc = mdoc_or_fallback
if mdoc != null then
tpl.comment = mdoc.tpl_comment
end
return tpl
end
- fun tpl_css_classes: Set[String] do
+ redef fun tpl_css_classes do
var set = new HashSet[String]
if is_intro then set.add "intro"
- set.add_all mproperty.intro.modifiers
- set.add_all modifiers
- return set
+ 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} "
+ 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 anchor = tpl_link
+ anchor.href = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}"
+ 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 anchor = mclassdef.tpl_link
+ anchor.href = "{mclassdef.mclass.nitdoc_url}#{mproperty.nitdoc_id}"
+ 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
+end
+
+redef class MAttributeDef
+ redef fun tpl_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
var tpl = new Template
var params = new Array[String]
for param in intro.msignature.mparameters do
- params.add param.name
+ params.add param.name.html_escape
end
if not params.is_empty then
tpl.add "("
redef class MParameterType
redef fun tpl_link do
- var name = mclass.intro.parameter_names[rank]
- return new TplLink.with_title("{mclass.nitdoc_url}#FT_{name}", name, "formal type")
+ return new TplLink.with_title("{mclass.nitdoc_url}#FT_{name.to_cmangle}", name, "formal type")
end
redef fun tpl_signature do return tpl_link
end
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
+
+
+################################################################################
+# Additions to `model_ext`.
+
+redef class MRawType
+ redef fun tpl_signature do
+ var tpl = new Template
+
+ for part in parts do
+ if part.target != null then
+ tpl.add part.target.as(not null).tpl_link
+ else
+ tpl.add part.text.html_escape
+ end
+ end
+ return tpl
+ end
+end
+
+redef class MInnerClass
+ redef fun nitdoc_url do return inner.nitdoc_url
+ redef fun tpl_signature do return inner.tpl_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 tpl_link do return inner.tpl_link
+ redef fun tpl_signature do return inner.tpl_signature
+
+ redef fun tpl_definition do
+ var tpl = new TplClassDefinition
+ tpl.namespace = mclassdef.tpl_namespace
+ var mdoc = mdoc_or_fallback
+ if mdoc != null then
+ tpl.comment = mdoc.tpl_comment
+ end
+ return tpl
+ end
+end
nitlanguage / nit.git / blobdiff