readable var _opt_private: OptionBool = new OptionBool("Generate the private API", "--private")
readable var _opt_nodot: OptionBool = new OptionBool("Do not generate graphes with graphviz", "--no-dot")
readable var _opt_sharedir: OptionString = new OptionString("Directory containing the nitdoc files", "--sharedir")
+
+ readable var _opt_custom_menu_items: OptionString = new OptionString("Items displayed in menu before the 'Overview' item (Each item must be enclosed in 'li' tags)", "--custom-menu-items")
+ readable var _opt_custom_title: OptionString = new OptionString("Title displayed in the top of the Overview page and as suffix of all page names", "--custom-title")
+ readable var _opt_custom_overview_text: OptionString = new OptionString("Text displayed as introduction of Overview page before the modules list", "--custom-overview-text")
+ readable var _opt_custom_footer_text: OptionString = new OptionString("Text displayed as footer of all pages", "--custom-footer-text")
var sharedir: nullable String
fun public_only: Bool
end
var head = "<meta charset=\"utf-8\">" +
- "<script type=\"text/javascript\" src=\"scripts/jquery-1.7.1.min.js\"></script>\n" +
+ "<script type=\"text/javascript\" src=\"scripts/jquery-1.7.1.min.js\"></script>\n" +
+ "<script type=\"text/javascript\" src=\"quicksearch-list.js\"></script>\n" +
"<script type=\"text/javascript\" src=\"scripts/js-facilities.js\"></script>\n" +
"<link rel=\"stylesheet\" href=\"styles/main.css\" type=\"text/css\" media=\"screen\" />"
- var action_bar = "<header><nav class='main'><ul><li class=\"current\">Overview</li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ var custom_items = ""
+ if self._opt_custom_menu_items.value != null then custom_items = self._opt_custom_menu_items.value.as(not null)
+
+ var action_bar = "<header><nav class='main'><ul>{custom_items}<li class=\"current\">Overview</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
+
+ var custom_title = "Nitdoc"
+ if self._opt_custom_title.value != null then custom_title = self._opt_custom_title.value.as(not null)
+
+ var overview_text = ""
+ if self._opt_custom_overview_text.value != null then overview_text = self._opt_custom_overview_text.value.as(not null)
+ var footer_text = ""
+ if self._opt_custom_footer_text.value != null then footer_text = self._opt_custom_footer_text.value.as(not null)
+
# generate the index
self.filename = "index.html"
clear
add("<!DOCTYPE html>")
- add("<html><head>{head}<title>Index</title></head><body>\n")
+ add("<html><head>{head}<title>Overview | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
add("<div class=\"content fullpage\">")
- add("<h1>Modules</h1>\n<article class='overview'><ul>")
+ add("<h1>{custom_title}</h1>\n<article class='overview'>{overview_text}</article><article class='overview'><h2>Modules</h2><ul>")
var modss = mainmod.mhe.greaters_and_self.to_a
sort(modss)
for mod in modss do
op.append("\}\n")
self.gen_dot(op.to_s, "dep", "Modules hierarchy")
add("</article></div>")
- add("<div class='clear'></div>")
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/index.html")
assert mod isa MMSrcModule
if not mod.require_doc(self) then continue
self.filename = mod.html_name
- action_bar = "<header><nav class='main'><ul><li><a href='./index.html'>Overview</a></li><li class=\"current\">{mod.name}</li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ action_bar = "<header><nav class='main'><ul>{custom_items}<li><a href='./index.html'>Overview</a></li><li class=\"current\">{mod.name}</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
add("<!DOCTYPE html>")
- add("<html><head>{head}<title>Module {mod.name}</title></head><body>\n")
+ add("<html><head>{head}<title>{mod.name} module | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
mod.file_page_doc(self)
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/{mod.html_name}.html")
end
for c in mainmod.local_classes do
if not c.require_doc(self) then continue
self.filename = c.html_name
- action_bar = "<header><nav class='main'><ul><li><a href='./index.html'>Overview</a></li><li>{c.global.intro.mmmodule.toplevel_owner.html_link(self)}</li><li class=\"current\">{c.name}</li><li><a href='full-index.html'>Full Index</a></li></ul></nav></header>\n"
+ action_bar = "<header><nav class='main'><ul>{custom_items}<li><a href='./index.html'>Overview</a></li><li>{c.global.intro.mmmodule.toplevel_owner.html_link(self)}</li><li class=\"current\">{c.name}</li><li><a href='full-index.html'>Full Index</a></li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
add("<!DOCTYPE html>")
- add("<html><head>{head}<title>Class {c.name}</title></head><body>\n")
+ add("<html><head>{head}<title>{c.name} class | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
c.file_page_doc(self)
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/{c.html_name}.html")
end
self.filename = "fullindex"
- action_bar = "<header><nav class='main'><ul><li><a href='./index.html'>Overview</a></li><li class=\"current\">Full Index</li></ul></nav></header>\n"
+ action_bar = "<header><nav class='main'><ul>{custom_items}<li><a href='./index.html'>Overview</a></li><li class=\"current\">Full Index</li><li><a href=\"help.html\">Help</a></li></ul></nav></header>\n"
clear
add("<!DOCTYPE html>")
- add("<html><head>{head}<title>Full Index</title></head><body>\n")
+ add("<html><head>{head}<title>Full Index | {custom_title}</title></head><body>\n")
add(action_bar)
add("<div class=\"page\">")
add("<div class=\"content fullpage\">")
mainmod.file_index_page_doc(self)
add("</div>")
add("</div>")
+ add("<footer>{footer_text}</footer>")
add("</body></html>\n")
write_to("{dir}/full-index.html")
+
+ self.filename = "quicksearch-list"
+ clear
+ mainmod.file_quicksearch_list_doc(self)
+ write_to("{dir}/quicksearch-list.js")
end
do
var s = opt_source.value
if s == null then
- add("in #{l.file.filename.simplify_path}")
+ add("({l.file.filename.simplify_path})")
else
# THIS IS JUST UGLY ! (but there is no replace yet)
var x = s.split_with("%f")
option_context.add_option(opt_source)
option_context.add_option(opt_nodot)
option_context.add_option(opt_sharedir)
+ option_context.add_option(opt_custom_title)
+ option_context.add_option(opt_custom_menu_items)
+ option_context.add_option(opt_custom_overview_text)
+ option_context.add_option(opt_custom_footer_text)
end
redef fun process_options
sharedir = opt_sharedir.value
if sharedir == null then
- var dir = once ("NIT_DIR".to_symbol).environ
+ var dir = "NIT_DIR".environ
if dir.is_empty then
dir = "{sys.program_name.dirname}/../share/nitdoc"
if dir.file_exists then sharedir = dir
end
# Generalization of metamodel entities
-class MMEntity
+interface MMEntity
# Return a link to
fun html_link(dctx: DocContext): String is abstract
# The doc node from the AST
# Return null is none
fun doc: nullable ADoc do return null
+
+ # Return a JSON entry for quicksearch list
+ fun json_entry(dctx: DocContext): String is abstract
+
+ # Return the qualified name as string
+ fun qualified_name: String is abstract
+
end
redef class MMModule
super MMEntity
redef fun html_link(dctx) do
- return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
+ if short_doc == " " then
+ return "<a href=\"{html_name}.html\"\">{self}</a>"
+ else
+ return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
+ end
+ end
+
+ fun html_anchor: String do
+ return "<a id=\"MOD_{html_name}\"></a>"
+ end
+
+ fun html_link_to_anchor: String do
+ return "<a href=\"#MOD_{html_name}\" title=\"Jump to definitions from module {html_name}\">{self}</a>"
+ end
+
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{self.qualified_name}\",url:\"{html_name}.html\"\},"
+ end
+
+ redef fun qualified_name do
+ var buffer = new Buffer
+ for m in mnhe.smallers do
+ buffer.append("{m.html_name}::")
+ end
+ buffer.append("{self.name}")
+ return buffer.to_s
end
fun require_doc(dctx: DocContext): Bool
dctx.stage("</ul></article>\n")
dctx.close_stage
end
+
+ # Fill the quicksearch list JSON object
+ fun file_quicksearch_list_doc(dctx: DocContext)
+ do
+ var entities = new HashMap[String, Array[MMEntity]]
+ var props = new HashMap[MMGlobalProperty, Array[MMLocalProperty]]
+ for m in mhe.greaters_and_self do
+ if not m.require_doc(dctx) then continue
+ var a = new Array[MMEntity]
+ a.add(m)
+ entities[m.html_name] = a
+ end
+ for g in global_classes do
+ var lc = self[g]
+ if not lc.require_doc(dctx) then continue
+ var a = new Array[MMEntity]
+ a.add(lc)
+ entities[lc.html_name] = a
+ for gp in lc.global_properties do
+ var lp = lc[gp]
+ if not lp.require_doc(dctx) then continue
+ if lp.kind == "var" then continue
+ if props.has_key(lp.global) then
+ if not props[lp.global].has(lp) then
+ props[lp.global].add(lp)
+ end
+ else
+ props[lp.global] = [lp]
+ end
+ end
+ end
+
+ for k, v in props do
+ entities[k.short_name] = v
+ end
+
+ var keys = entities.keys.to_a
+ var sorter = new AlphaSorter[String]
+ sorter.sort(keys)
+
+ dctx.open_stage
+ dctx.stage("var entries = \{")
+ for key in keys do
+ dctx.add("\"{key}\": [")
+ for entity in entities[key] do
+ dctx.add(entity.json_entry(dctx))
+ end
+ dctx.add("],")
+ end
+ dctx.stage("\};")
+ dctx.close_stage
+ end
end
+redef class MMGlobalProperty
+ # Return the short name of the property
+ fun short_name: String do
+ return self.intro.html_name
+ end
+end
+
redef class MMLocalProperty
super MMEntity
# Anchor of the property description in the module html file
fun html_anchor: String
do
- return "PROP_{local_class}_{cmangle(name)}"
+ return "PROP_{self.mmmodule.toplevel_owner}_{local_class}_{cmangle(name)}"
+ end
+
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{qualified_name}\",url:\"{local_class.html_name}.html#{html_anchor}\"\},"
+ end
+
+ redef fun qualified_name do
+ return "{intro_module.qualified_name}::{local_class.html_name}::{html_name}"
end
fun html_open_link(dctx: DocContext): String
dctx.add("::{mmmodule[intro_class.global].html_link(dctx)}")
end
if is_redef then
- dctx.add("::{mmmodule[intro_class.global][global].html_link(dctx)}")
+ dctx.add("::{mmmodule[intro_class.global][global].global.intro.html_link(dctx)}")
else
dctx.add("::{html_name}")
end
if lp == tlp then continue
dctx.add(" {lp.mmmodule.html_link(dctx)}")
if lp.local_class.global != lc.global then
- dctx.add(" for {lp.local_class.html_link(dctx)}")
+ dctx.add(" for {lp.local_class.html_link(dctx)} ")
end
n = lp.node
redef fun html_link(dctx)
do
if not require_doc(dctx) then print "{dctx.filename}: not required {self}"
- return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
+ if short_doc == " " then
+ return "<a href=\"{html_name}.html\"\">{self}</a>"
+ else
+ return "<a href=\"{html_name}.html\" title=\"{short_doc}\">{self}</a>"
+ end
+ end
+
+ redef fun json_entry(dctx) do
+ return "\{txt:\"{qualified_name}\",url:\"{html_name}.html\"\},"
+ end
+
+ redef fun qualified_name do
+ return "{intro_module.qualified_name}::{html_name}"
end
redef fun short_doc do return global.intro.short_doc
end
op.append("\}\n")
dctx.gen_dot(op.to_s, name.to_s, "Inheritance graph for class {name}")
+ dctx.add("</section>\n")
+ # Concerns table
+ dctx.open_stage
+ dctx.stage("<section class=\"concerns\">\n")
+ dctx.stage("<h2 class=\"section-header\">Concerns</h2>\n")
var mods = new Array[MMModule]
mods.add(global.intro.mmmodule.toplevel_owner)
var m = lc.mmmodule.toplevel_owner
if not mods.has(m) then mods.add(m)
end
- dctx.sort(mods)
+
+ var intro = global.intro.mmmodule
+ var short_doc
+ dctx.add("<ul>\n")
for m in mods do
- if m == global.intro.mmmodule.toplevel_owner then
- dctx.add("<p>Introduced by {m.html_link(dctx)}")
- else
- dctx.add("<p>Refined by {m.html_link(dctx)}")
- end
- dctx.open_stage
- dctx.stage(". Definition in:")
- for lc in crhe.greaters do
+ short_doc = ""
+ if m.short_doc != " " then short_doc = ": {m.short_doc}"
+ dctx.add("<li>{m.html_link_to_anchor}{short_doc}")
+ dctx.add("<ul>\n")
+ for lc in crhe.linear_extension.reversed do
if lc.mmmodule.toplevel_owner != m then continue
- dctx.add(" {lc.mmmodule.html_link(dctx)}")
- assert lc isa MMSrcLocalClass
- var n = lc.node
- if n != null then
- dctx.show_source(n.location)
- end
+ if lc.mmmodule == m then continue
+ short_doc = ""
+ if lc.mmmodule.short_doc != " " then short_doc = ": {lc.mmmodule.short_doc}"
+ dctx.add("<li>{lc.mmmodule.html_link_to_anchor}{short_doc}</li>")
end
- dctx.close_stage
- dctx.add("</p>\n")
+ dctx.add("</ul>\n")
+ dctx.add("</li>\n")
end
- dctx.add("</section>\n")
+ dctx.add("</ul>\n")
+ dctx.stage("</section>\n")
+ dctx.close_stage
dctx.open_stage
dctx.stage("<section class=\"types\">\n")
dctx.open_stage
dctx.stage("<section class=\"methods\">\n")
dctx.stage("<h2 class=\"section-header\">Methods</h2>\n")
+ var redefs = new HashMap[MMModule, HashMap[MMModule, Array[MMMethod]]]
for p in props do
if p.global.is_init then continue
if p.local_class.global != self.global then continue
if not p isa MMMethod then continue
- p.full_documentation(dctx, self)
+ # Top level module
+ var toplevel_module = p.mmmodule.toplevel_owner
+ if not redefs.has_key(toplevel_module) then
+ redefs[toplevel_module] = new HashMap[MMModule, Array[MMMethod]]
+ end
+ # Nested module
+ var nested_module = p.mmmodule
+ if not redefs[toplevel_module].has_key(nested_module) then
+ redefs[toplevel_module][nested_module] = new Array[MMMethod]
+ end
+ # Props
+ redefs[toplevel_module][nested_module].add(p)
+
+ # Redefs
+ if p.mmmodule.toplevel_owner != p.intro_module then
+ toplevel_module = p.intro_module
+ nested_module = p.global.intro.mmmodule
+
+ if not redefs.has_key(toplevel_module) then
+ redefs[toplevel_module] = new HashMap[MMModule, Array[MMMethod]]
+ end
+ if not redefs[toplevel_module].has_key(nested_module) then
+ redefs[toplevel_module][nested_module] = new Array[MMMethod]
+ end
+
+ redefs[toplevel_module][nested_module].add(p.global.intro.as(MMMethod))
+ end
+ end
+
+ # Display toplevel blocks
+ for m in mods do
+ if not redefs.has_key(m) then continue
+ dctx.add(m.html_anchor)
+ if m != global.intro.mmmodule.toplevel_owner then
+ dctx.add("<h3 class=\"concern-toplevel\">Methods refined in {m.html_link(dctx)}</h3>")
+ end
+
+ # Display nested module blocks
+ for lc in crhe.linear_extension.reversed do
+ if lc.mmmodule.toplevel_owner != m then continue
+ var nm = lc.mmmodule
+ if not redefs[m].has_key(nm) then continue
+ dctx.add(nm.html_anchor)
+ if nm != global.intro.mmmodule then
+ short_doc = ""
+ if nm.short_doc != " " then short_doc = ": {nm.short_doc}"
+ dctx.add("<p class=\"concern-doc\">{nm.html_name}{short_doc}</p>\n")
+ end
+
+ var pps = redefs[m][nm]
+ dctx.sort(pps)
+ for p in pps do
+ p.full_documentation(dctx, self)
+ end
+ end
end
+
if not inhs.is_empty then
dctx.open_stage
dctx.stage("<h3>Inherited Methods</h3>\n")
for lc in inhs do
dctx.open_stage
dctx.stage("<p>Defined in {lc.html_link(dctx)}:")
+
+ var ims = new Array[MMMethod]
for p in inh[lc] do
if p.global.is_init then continue
if not p isa MMMethod then continue
+ ims.add(p)
+ end
+
+ var i = 0
+ for p in ims do
dctx.add(" {p.html_link(dctx)}")
+ if i < ims.length - 1 then dctx.add(",")
+ i += 1
end
+
dctx.stage("</p>")
dctx.close_stage
end
nitlanguage / nit.git / blobdiff