self.dot_dir = null
if not opt_nodot.value then self.dot_dir = output_dir.to_s
overview
- #fullindex
+ fullindex
modules
classes
- #quicksearch_list
+ quicksearch_list
end
end
end
fun fullindex do
- var fullindex = new NitdocFullindex(model.mmodules)
+ var fullindex = new NitdocFullindex(self)
fullindex.save("{output_dir.to_s}/full-index.html")
end
fun modules do
for mmodule in model.mmodules do
var modulepage = new NitdocModule(mmodule, modelbuilder, dot_dir)
- modulepage.save("{output_dir.to_s}/{mmodule.name}.html")
+ modulepage.save("{output_dir.to_s}/{mmodule.url}")
end
end
fun classes do
for mclass in modelbuilder.model.mclasses do
var classpage = new NitdocClass(mclass, self, dot_dir, source)
- classpage.save("{output_dir.to_s}/{mclass.name}.html")
+ classpage.save("{output_dir.to_s}/{mclass.url}")
end
end
var file = new OFStream.open("{output_dir.to_s}/quicksearch-list.js")
var content = new Buffer
content.append("var entries = \{ ")
- for prop in model.mproperties do
- if not prop isa MMethod then continue
- content.append("\"{prop.name}\": [")
- for propdef in prop.mpropdefs do
- content.append("\{txt: \"{propdef.mproperty.full_name}\", url:\"{propdef.mproperty.anchor}\" \}")
- if not propdef is prop.mpropdefs.last then content.append(", ")
- end
- content.append("]")
- content.append(", ")
- end
+ for mmodule in model.mmodules do
+ content.append("\"{mmodule.name}\": [")
+ content.append("\{txt: \"{mmodule.name}\", url:\"{mmodule.url}\" \},")
+ content.append("],")
+ end
for mclass in model.mclasses do
+ if mclass.visibility <= none_visibility then continue
content.append("\"{mclass.name}\": [")
- for mclassdef in mclass.mclassdefs do
- content.append("\{txt: \"{mclassdef.mclass.full_name}\", url:\"{mclass.link_anchor}\" \}")
- if not mclassdef is mclass.mclassdefs.last then content.append(", ")
+ content.append("\{txt: \"{mclass.name}\", url:\"{mclass.url}\" \},")
+ content.append("],")
+ end
+ var name2mprops = new HashMap[String, Set[MPropDef]]
+ for mproperty in model.mproperties do
+ if mproperty.visibility <= none_visibility then continue
+ if mproperty isa MAttribute then continue
+ if not name2mprops.has_key(mproperty.name) then name2mprops[mproperty.name] = new HashSet[MPropDef]
+ name2mprops[mproperty.name].add_all(mproperty.mpropdefs)
+ end
+ for mproperty, mpropdefs in name2mprops do
+ content.append("\"{mproperty}\": [")
+ for mpropdef in mpropdefs do
+ content.append("\{txt: \"{mpropdef.full_name}\", url:\"{mpropdef.url}\" \},")
end
- content.append("]")
- if not mclass is model.mclasses.last then content.append(", ")
+ content.append("],")
end
content.append(" \};")
var op = new Buffer
op.append("digraph dep \{ rankdir=BT; node[shape=none,margin=0,width=0,height=0,fontsize=10]; edge[dir=none,color=gray]; ranksep=0.2; nodesep=0.1;\n")
for mmodule in mmodules do
- op.append("\"{mmodule.name}\"[URL=\"{mmodule.name}.html\"];\n")
+ op.append("\"{mmodule.name}\"[URL=\"{mmodule.url}\"];\n")
for imported in mmodule.in_importation.direct_greaters do
if imported.direct_owner == null then
op.append("\"{mmodule.name}\"->\"{imported.name}\";\n")
class NitdocFullindex
super NitdocPage
- private var mmodules: Array[MModule]
+ private var nitdoc: Nitdoc
- init(mmodules: Array[MModule]) do
- self.mmodules = mmodules
+ init(nitdoc: Nitdoc) do
+ self.nitdoc = nitdoc
self.dot_dir = null
end
# Add to content modules column
fun module_column do
- var ls = new List[nullable MModule]
- var sorted = mmodules
- var sorterp = new ComparableSorter[MModule]
- sorterp.sort(sorted)
- append("<article class='modules filterable'></article>")
+ var sorter = new ComparableSorter[MModule]
+ var sorted = new Array[MModule]
+ for mmodule in nitdoc.modelbuilder.model.mmodule_importation_hierarchy do
+ sorted.add(mmodule)
+ end
+ sorter.sort(sorted)
+ append("<article class='modules filterable'>")
append("<h2>Modules</h2>")
append("<ul>")
for mmodule in sorted do
- if mmodule.public_owner != null and not ls.has(mmodule.public_owner) then
- ls.add(mmodule.public_owner)
- append("<li><a href='{mmodule.public_owner.name}.html'>(mmodule.public_owner.name)</a></li>")
- end
+ append("<li>{mmodule.link(nitdoc.modelbuilder)}</li>")
end
append("</ul>")
append("</article>")
# Add to content classes modules
fun classes_column do
- var sorted = mmodules.first.imported_mclasses.to_a
- var sorterp = new ComparableSorter[MClass]
- sorterp.sort(sorted)
- append("<article class='classes filterable'>")
+ var sorted = nitdoc.modelbuilder.model.mclasses
+ var sorter = new ComparableSorter[MClass]
+ sorter.sort(sorted)
+ append("<article class='modules filterable'>")
append("<h2>Classes</h2>")
append("<ul>")
for mclass in sorted do
- append("<li><a href='{mclass}.html'>(mclass.name)</a></li>")
+ append("<li>{mclass.link(nitdoc.modelbuilder)}</li>")
end
append("</ul>")
append("</article>")
# Insert the properties column of fullindex page
fun properties_column do
- append("<article class='classes filterable'>")
+ var sorted = nitdoc.modelbuilder.model.mproperties
+ var sorter = new ComparableSorter[MProperty]
+ sorter.sort(sorted)
+ append("<article class='modules filterable'>")
append("<h2>Properties</h2>")
append("<ul>")
- var sorted_imported = mmodules.first.imported_methods.to_a
- var sorted_redef = mmodules.first.redef_methods.to_a
- var sorterp = new ComparableSorter[MProperty]
- sorterp.sort(sorted_imported)
- sorterp.sort(sorted_redef)
-
- for method in sorted_imported do
- if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- append("<li class='intro'</li>")
- append("<span title='introduction'>I</span> ")
- append("<a href='{method.intro_mclassdef.mclass.name}.html' title=''>{method.name} ({method.intro_mclassdef.mclass.name})</a>")
- append("</li>")
- end
-
- for method in sorted_redef do
- if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- append("<li class='redef'>")
- append("<span title='redefinition'>R</span> ")
- append("<a href='{method.intro_mclassdef.mclass.name}.html' title=''>{method.name} ({method.intro_mclassdef.mclass.name})</span>")
- append("</li>")
+ for mproperty in sorted do
+ if mproperty isa MAttribute then continue
+ append("<li>{mproperty.intro.link(nitdoc.modelbuilder)} ({mproperty.intro.mclassdef.mclass.link(nitdoc.modelbuilder)})</li>")
end
append("</ul>")
append("</article>")
if m == mmodule then
op.append("\"{m.name}\"[shape=box,margin=0.03];\n")
else
- op.append("\"{m.name}\"[URL=\"{m.name}.html\"];\n")
+ op.append("\"{m.name}\"[URL=\"{m.url}\"];\n")
end
end
for imported in m.in_importation.direct_greaters do
append("<ul>")
for sup in sorted do
if sup == mclass then continue
- append("<li><a href='{sup.name}.html'>{sup.name}</a></li>")
+ append("<li>{sup.link(mbuilder)}</li>")
end
append("</ul>")
end
append("<ul>")
for sub in sorted do
if sub == mclass then continue
- append("<li><a href='{sub.name}.html'>{sub.name}</a></li>")
+ append("<li>{sub.link(mbuilder)}</li>")
end
append("</ul>")
else if mclass.children.length <= 100 then
append("<ul>")
for sub in sorted do
if sub == mclass then continue
- append("<li><a href='{sub.name}.html'>{sub.name}</a></li>")
+ append("<li>{sub.link(mbuilder)}</li>")
end
append("</ul>")
else
var nowner = mbuilder.mmodule2nmodule[owner]
append("<li>")
if nowner.short_comment.is_empty then
- append("<a href=\"#MOD_{owner.name}\">{owner.name}</a>")
+ append("<a href=\"#{owner.anchor}\">{owner.name}</a>")
else
- append("<a href=\"#MOD_{owner.name}\">{owner.name}</a>: {nowner.short_comment}")
+ append("<a href=\"#{owner.anchor}\">{owner.name}</a>: {nowner.short_comment}")
end
if not mmodules.is_empty then
append("<ul>")
for mmodule in mmodules do
var nmodule = mbuilder.mmodule2nmodule[mmodule]
if nmodule.short_comment.is_empty then
- append("<li><a href=\"#MOD_{mmodule.name}\">{mmodule.name}</a></li>")
+ append("<li><a href=\"#{mmodule.anchor}\">{mmodule.name}</a></li>")
else
- append("<li><a href=\"#MOD_{mmodule.name}\">{mmodule.name}</a>: {nmodule.short_comment}</li>")
+ append("<li><a href=\"#{mmodule.anchor}\">{mmodule.name}</a>: {nmodule.short_comment}</li>")
end
end
append("</ul>")
# formal types
if mclass.arity > 0 and nclass isa AStdClassdef then
for ft, bound in mclass.parameter_types do
- append("<article id='{ft}'>")
+ append("<article id='FT_{ft}'>")
append("<h3 class='signature'>{ft}: {bound.link(mbuilder)}</h3>")
append("<div class=\"info\">formal generic type</div>")
append("</article>")
append("<section class='methods'>")
append("<h2 class='section-header'>Methods</h2>")
for owner, mmodules in sections do
- append("<a id=\"MOD_{owner.name}\"></a>")
+ append("<a id=\"{owner.anchor}\"></a>")
if owner != mclass.intro_mmodule and owner != mclass.public_owner then
var nowner = mbuilder.mmodule2nmodule[owner]
append("<h3 class=\"concern-toplevel\">Methods refined in {owner.link(mbuilder)}</h3>")
if nowner.short_comment.is_empty then
- append("<p class=\"concern-doc\">{owner.name}</p>")
+ append("<p class=\"concern-doc\">{owner.link(mbuilder)}</p>")
else
- append("<p class=\"concern-doc\">{owner.name}: {nowner.short_comment}</p>")
+ append("<p class=\"concern-doc\">{owner.link(mbuilder)}: {nowner.short_comment}</p>")
end
end
if concern2meths.has_key(owner) then
for prop in mmethods do append(prop.html_full_desc(self))
end
for mmodule in mmodules do
- append("<a id=\"MOD_{mmodule.name}\"></a>")
+ append("<a id=\"{mmodule.anchor}\"></a>")
var nmodule = mbuilder.mmodule2nmodule[mmodule]
if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then
if nmodule.short_comment.is_empty then
- append("<p class=\"concern-doc\">{mmodule.name}</p>")
+ append("<p class=\"concern-doc\">{mmodule.link(mbuilder)}</p>")
else
- append("<p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
+ append("<p class=\"concern-doc\">{mmodule.link(mbuilder)}: {nmodule.short_comment}</p>")
end
end
var mmethods = concern2meths[mmodule]
if c == mclass then
op.append("\"{c.name}\"[shape=box,margin=0.03];\n")
else
- op.append("\"{c.name}\"[URL=\"{c.name}.html\"];\n")
+ op.append("\"{c.name}\"[URL=\"{c.url}\"];\n")
end
for c2 in pe.poset[c].direct_greaters do
if not cla.has(c2) then continue
return methods
end
+ # URL to nitdoc page
+ fun url: String do
+ var res = new Buffer
+ res.append("module_")
+ var mowner = public_owner
+ if mowner != null then
+ res.append("{public_owner.name}_")
+ end
+ res.append("{self.name}.html")
+ return res.to_s
+ end
+
+ # html anchor id to the module in a nitdoc page
+ fun anchor: String do
+ var res = new Buffer
+ res.append("MOD_")
+ var mowner = public_owner
+ if mowner != null then
+ res.append("{public_owner.name}_")
+ end
+ res.append(self.name)
+ return res.to_s
+ end
+
# Return a link (html a tag) to the nitdoc module page
fun link(mbuilder: ModelBuilder): String do
- return "<a href='{name}.html' title='{mbuilder.mmodule2nmodule[self].short_comment}'>{name}</a>"
+ return "<a href='{url}' title='{mbuilder.mmodule2nmodule[self].short_comment}'>{name}</a>"
end
# Return the module signature decorated with html
if mbuilder.mclassdef2nclassdef.has_key(intro) then
var nclass = mbuilder.mclassdef2nclassdef[intro]
if nclass isa AStdClassdef then
- return "<a href='{name}.html' title=\"{nclass.short_comment}\">{html_signature}</a>"
+ return "<a href='{url}' title=\"{nclass.short_comment}\">{html_signature}</a>"
else
- return "<a href='{name}.html'>{html_signature}</a>"
+ return "<a href='{url}'>{html_signature}</a>"
end
else
- return "<a href='{name}.html'>{html_signature}</a>"
+ return "<a href='{url}'>{html_signature}</a>"
end
end
return res.to_s
end
- fun link_anchor: String do
- return "{name}.html"
+ fun url: String do
+ return "class_{public_owner}_{c_name}.html"
end
# Escape name for html output
redef type OTHER: MProperty
redef fun <(other: OTHER): Bool do return self.name < other.name
- fun anchor: String do
- return "PROP_{c_name}"
- end
-
# Return the property namespace decorated with html
fun html_namespace(mbuilder: ModelBuilder): String do
return "{intro_mclassdef.mclass.html_namespace(mbuilder)}::<span>{intro.link(mbuilder)}</span>"
end
- # Return the property signature decorated with html
- fun html_signature(mbuilder: ModelBuilder): String do
- var nprop = mbuilder.mpropdef2npropdef[intro]
- return "{name}{nprop.html_signature(mbuilder)}"
- end
-
# Escape name for html output
redef fun name do return super.html_escape
end
redef fun link(mbuilder) do return "nullable {mtype.link(mbuilder)}"
end
+redef class MGenericType
+ redef fun link(mbuilder) do
+ var res = new Buffer
+ res.append("<a href='{mclass.url}'>{mclass.name}</a>[")
+ for i in [0..arguments.length[ do
+ res.append(arguments[i].link(mbuilder))
+ if i < arguments.length - 1 then res.append(", ")
+ end
+ res.append("]")
+ return res.to_s
+ end
+end
+
+redef class MParameterType
+ redef fun link(mbuilder) do
+ var name = mclass.intro.parameter_names[rank]
+ return "<a href='{mclass.url}#FT_{name}' title='formal type'>{name}</a>"
+ end
+end
+
+redef class MVirtualType
+ redef fun link(mbuilder) do return mproperty.intro.link(mbuilder)
+end
+
redef class MClassDef
# Return the classdef namespace decorated with html
fun html_namespace(mbuilder: ModelBuilder): String do
redef type OTHER: MPropDef
redef fun <(other: OTHER): Bool do return self.mproperty.name < other.mproperty.name
+ fun url: String do return "{mclassdef.mclass.url}#{anchor}"
+ fun anchor: String do return "PROP_{mclassdef.mclass.public_owner.name}_{c_name}"
+
# Return a link (html a tag) to the nitdoc class page
fun link(mbuilder: ModelBuilder): String do
if mbuilder.mpropdef2npropdef.has_key(self) then
var nprop = mbuilder.mpropdef2npropdef[self]
- return "<a href=\"{mclassdef.mclass.name}.html#{mproperty.anchor}\" title=\"{nprop.short_comment}\">{mproperty.name}</a>"
+ return "<a href=\"{url}\" title=\"{nprop.short_comment}\">{mproperty.name}</a>"
else
- return "<a href=\"{mclassdef.mclass.name}.html#{mproperty.anchor}\">{mproperty.name}</a>"
+ return "<a href=\"{url}\">{mproperty.name}</a>"
end
end
var res = new Buffer
if is_intro then
res.append("<li class='intro'>")
- res.append("<span title='introduction'>I</span> {link(mbuilder)} ({mclassdef.mclass.name})")
+ res.append("<span title='introduction'>I</span> {link(mbuilder)} ({mclassdef.mclass.link(mbuilder)})")
res.append("</li>")
else
res.append("<li class='redef'>")
- res.append("<span title='redefinition'>R</span> {link(mbuilder)} ({mclassdef.mclass.name})")
+ res.append("<span title='redefinition'>R</span> {link(mbuilder)} ({mclassdef.mclass.link(mbuilder)})")
res.append("</li>")
end
return res.to_s
fun html_full_desc(page: NitdocClass): String is abstract
fun html_info(page: NitdocClass): String is abstract
+
+ fun full_name: String do
+ return "{mclassdef.mclass.public_owner.name}::{mclassdef.mclass.name}::{mproperty.name}"
+ end
end
redef class MMethodDef
else
classes.add("public")
end
- res.append("<article class='{classes.join(" ")}' id='{mprop.anchor}'>")
- res.append("<h3 class='signature'>{mprop.html_signature(page.mbuilder)}</h3>")
+ res.append("<article class='{classes.join(" ")}' id='{anchor}'>")
+ if nprop isa AAttrPropdef then
+ if nprop.mreadpropdef == self then
+ res.append("<h3 class='signature'>{mprop.name}: {nprop.html_signature(page.mbuilder)}</h3>")
+ else
+ res.append("<h3 class='signature'>{mprop.name}(value: {nprop.html_signature(page.mbuilder)})</h3>")
+ end
+ else
+ var intro_nprop = page.mbuilder.mpropdef2npropdef[mprop.intro]
+ res.append("<h3 class='signature'>{mprop.name}{intro_nprop.html_signature(page.mbuilder)}</h3>")
+ end
res.append(html_info(page))
res.append("<div class='description'>")
if nprop.comment == "" then
end
res.append("<textarea id=\"fileContent\" class=\"edit\" cols=\"76\" rows=\"1\" style=\"display: none;\"></textarea><a id=\"cancelBtn\" style=\"display: none;\">Cancel</a><a id=\"commitBtn\" style=\"display: none;\">Commit</a><pre id=\"preSave\" class=\"text_label\" type=\"2\"></pre>")
# definitions block
- res.append("<p>")
+ res.append("<p class='info'>")
page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
var previous_defs = new Array[MMethodDef]
var next_defs = new Array[MMethodDef]
else
classes.add("public")
end
- res.append("<article class='{classes.join(" ")}' id='{mprop.anchor}'>")
+ res.append("<article class='{classes.join(" ")}' id='{anchor}'>")
res.append("<h3 class='signature'>{mprop.name}: {bound.link(page.mbuilder)}</h3>")
res.append(html_info(page))
res.append("<div class='description'>")
end
res.append("<textarea id=\"fileContent\" class=\"edit\" cols=\"76\" rows=\"1\" style=\"display: none;\"></textarea><a id=\"cancelBtn\" style=\"display: none;\">Cancel</a><a id=\"commitBtn\" style=\"display: none;\">Commit</a><pre id=\"preSave\" class=\"text_label\" type=\"2\"></pre>")
# definitions block
- res.append("<p>")
+ res.append("<p class='info'>")
page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
var previous_defs = new Array[MVirtualTypeDef]
var next_defs = new Array[MVirtualTypeDef]
end
redef fun html_signature(mbuilder) do
- var res = ""
- if n_type != null and n_type.to_html != "" then res += ": {n_type.to_html}"
- return res
+ if n_type != null then return n_type.mtype.link(mbuilder)
+ return ""
end
end
end
redef fun html_signature(mbuilder) do
- if n_signature != null then return n_signature.to_html
+ if n_signature != null then return n_signature.to_html(mbuilder)
return ""
end
end
end
redef class ASignature
- fun to_html: String do
+ fun to_html(mbuilder: ModelBuilder): String do
#TODO closures
- var ret = ""
+ var res = new Buffer
if not n_params.is_empty then
- ret = "{ret}({n_params.join(", ")})"
+ res.append("(")
+ for i in [0..n_params.length[ do
+ res.append(n_params[i].to_html(mbuilder))
+ if i < n_params.length - 1 then res.append(", ")
+ end
+ res.append(")")
end
- if n_type != null and n_type.to_html != "" then ret += ": {n_type.to_html}"
- return ret
+ if n_type != null and n_type.mtype.link(mbuilder) != "" then res.append(": {n_type.mtype.link(mbuilder)}")
+ return res.to_s
end
end
redef class AParam
- redef fun to_s do
+ fun to_html(mbuilder: ModelBuilder): String do
var ret = "{n_id.text}"
if n_type != null then
- ret = "{ret}: {n_type.to_html}"
+ ret = "{ret}: {n_type.mtype.link(mbuilder)}"
if n_dotdotdot != null then ret = "{ret}..."
end
return ret
end
end
-redef class AType
- fun to_html: String do
- var ret = "<a href=\"{n_id.text}.html\">{n_id.text}</a>"
- if n_kwnullable != null then ret = "nullable {ret}"
- if not n_types.is_empty then ret = "{ret}[{n_types.join(", ")}]"
- return ret
- end
-
- fun name: String do return n_id.text.html_escape
-end
-
# Create a tool context to handle options and paths
var toolcontext = new ToolContext
nitlanguage / nit.git / blobdiff