var git_dir = opt_github_gitdir
var opts = [upstream.value, base_sha.value, git_dir.value]
if not opts.has_only(null) and opts.has(null) then
- print "Error: Options {upstream.names.first}, " +
+ print "Option Error: options {upstream.names.first}, " +
"{base_sha.names.first} and {git_dir.names.first} " +
"are required to enable the GitHub plugin"
exit 1
var dir = ctx.nit_dir
sharedir = dir/"share/nitdoc"
if not sharedir.file_exists then
- print "Error: Cannot locate nitdoc share files. Uses --sharedir or envvar NIT_DIR"
+ print "Error: cannot locate nitdoc share files. Uses --sharedir or envvar NIT_DIR"
abort
end
end
var ssection = new TplSection.with_title("projects", "Projects")
for mproject in mprojects do
var sarticle = mproject.tpl_article
- sarticle.subtitle = mproject.tpl_declaration
+ sarticle.subtitle = mproject.html_declaration
sarticle.content = mproject.tpl_definition
var mdoc = mproject.mdoc_or_fallback
if mdoc != null then
tpl.title = "Index"
# modules list
for mmodule in modules_list(v, doc) do
- tpl.modules.add mmodule.tpl_link
+ tpl.modules.add mmodule.html_link
end
# classes list
for mclass in classes_list(v, doc) do
- tpl.classes.add mclass.tpl_link
+ tpl.classes.add mclass.html_link
end
# properties list
for mproperty in mprops_list(v, doc) do
var m = new Template
- m.add mproperty.intro.tpl_link
+ m.add mproperty.intro.html_link
m.add " ("
- m.add mproperty.intro.mclassdef.mclass.tpl_link
+ m.add mproperty.intro.mclassdef.mclass.html_link
m.add ")"
tpl.props.add m
end
end
var lnk = new Template
lnk.add new TplLabel.with_classes(classes)
- lnk.add def.tpl_link
+ lnk.add def.html_link
return new TplListItem.with_content(lnk)
end
end
end
var lnk = new Template
lnk.add new TplLabel.with_classes(classes)
- lnk.add def.tpl_link
+ lnk.add def.html_link
return new TplListItem.with_content(lnk)
end
end
end
var lnk = new Template
lnk.add new TplLabel.with_classes(classes)
- lnk.add mprop.tpl_anchor
+ lnk.add mprop.html_link_to_anchor
return new TplListItem.with_content(lnk)
end
redef class MPropertyPage
redef fun init_title(v, doc) do
- title = "{mentity.html_name}{mentity.tpl_signature.write_to_string}"
+ title = "{mentity.html_name}{mentity.html_short_signature.write_to_string}"
end
redef fun init_topmenu(v, doc) do
var section = new TplSection("top")
var mentity = page.mentity
section.title = mentity.html_name
- section.subtitle = mentity.tpl_declaration
+ section.subtitle = mentity.html_declaration
# FIXME ugly hack to avoid diff
if mentity isa MGroup and mentity.is_root then
section.title = mentity.mproject.html_name
- section.subtitle = mentity.mproject.tpl_declaration
+ section.subtitle = mentity.mproject.html_declaration
else if mentity isa MProperty then
- section.title = "{mentity.html_name}{mentity.intro.tpl_signature.write_to_string}"
- section.subtitle = mentity.tpl_namespace
+ section.title = "{mentity.html_name}{mentity.intro.html_signature.write_to_string}"
+ section.subtitle = mentity.html_namespace
section.summary_title = mentity.html_name
end
render(v, doc, page, section)
title.add "from "
section.summary_title = "from {mmodule.html_name}"
end
- title.add mmodule.tpl_namespace
+ title.add mmodule.html_namespace
section.title = title
end
private fun render_concern_other(page: MEntityPage, section: TplSection, mmodule: MModule) do
var title = new Template
title.add "in "
- title.add mmodule.tpl_namespace
+ title.add mmodule.html_namespace
section.title = title
section.summary_title = "in {mmodule.html_name}"
end
else if mentity isa MPropDef then
article.source_link = v.tpl_showsource(mentity.location)
end
- # article.subtitle = mentity.tpl_declaration
+ # article.subtitle = mentity.html_declaration
# FIXME diff hack
if mentity isa MProperty then
# intro title
- var ns = mentity.intro.mclassdef.mmodule.tpl_namespace
+ var ns = mentity.intro.mclassdef.mmodule.html_namespace
var section = new TplSection("intro")
var title = new Template
title.add "Introduction in "
# FIXME hideous hacks...
if mentity isa MModule then
article = mentity.tpl_article
- article.subtitle = mentity.tpl_declaration
+ article.subtitle = mentity.html_declaration
article.content = mentity.tpl_definition
else if mentity isa MClass then
article = make_mclass_article(v, page)
article = make_mpropdef_article(v, doc, page)
else
article = mentity.tpl_article
- article.subtitle = mentity.tpl_declaration
+ article.subtitle = mentity.html_declaration
if mentity isa MPropDef then
article.source_link = v.tpl_showsource(mentity.location)
end
private fun make_mclass_article(v: RenderHTMLPhase, page: MEntityPage): TplArticle do
var article = mentity.tpl_article
- article.subtitle = mentity.tpl_namespace
+ article.subtitle = mentity.html_namespace
article.content = null
return article
end
end
var title = new Template
title.add "in "
- title.add mclassdef.mmodule.tpl_namespace
+ title.add mclassdef.mmodule.html_namespace
article.subtitle = title
return article
end
title.add mprop.tpl_icon
title.add "<span id='{mpropdef.nitdoc_id}'></span>"
if mpropdef.is_intro then
- title.add mprop.tpl_link
- title.add mprop.intro.tpl_signature
+ 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}"
article.title = title
article.title_classes.add "signature"
article.summary_title = "{mprop.html_name}"
- article.subtitle = mpropdef.tpl_namespace
+ article.subtitle = mpropdef.html_namespace
if mpropdef.mdoc_or_fallback != null then
article.content = mpropdef.mdoc_or_fallback.tpl_comment
end
parent.add_child article
end
end
+
+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
+ # 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 = 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 html_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
+
+ 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 mdoc = mdoc_or_fallback
+ if mdoc != null then
+ lnk.add ": "
+ lnk.add mdoc.tpl_short_comment
+ end
+ return new TplListItem.with_content(lnk)
+ end
+end
+
+redef class MProject
+ 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"]
+end
+
+redef class MGroup
+ 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
+ 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
+ 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 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
+
+ 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
+ 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 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
+
+ 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)
+ 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.html_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
+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 mdoc = mdoc_or_fallback
+ if mdoc != null then
+ tpl.comment = mdoc.tpl_comment
+ end
+ return tpl
+ end
+end
nitlanguage / nit.git / blobdiff