import model_utils
import abstract_compiler
-class Nitdoc
- private var toolcontext: ToolContext
+# The NitdocContext contains all the knowledge used for doc generation
+class NitdocContext
+ super ToolContext
+
private var model: Model
private var modelbuilder: ModelBuilder
private var mainmodule: MModule
private var dot_dir: nullable String
private var share_dir: nullable String
private var source: nullable String
+ private var min_visibility: MVisibility
private var opt_dir = new OptionString("Directory where doc is generated", "-d", "--dir")
private var opt_source = new OptionString("What link for source (%f for filename, %l for first line, %L for last line)", "--source")
private var opt_sharedir = new OptionString("Directory containing the nitdoc files", "--sharedir")
private var opt_nodot = new OptionBool("Do not generate graphes with graphiviz", "--no-dot")
+ private var opt_private: OptionBool = new OptionBool("Generate the private API", "--private")
+
+ private 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")
+ private 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")
+ private var opt_custom_overview_text: OptionString = new OptionString("Text displayed as introduction of Overview page before the modules list", "--custom-overview-text")
+ private var opt_custom_footer_text: OptionString = new OptionString("Text displayed as footer of all pages", "--custom-footer-text")
- init(toolcontext: ToolContext) do
- # We need a model to collect stufs
- self.toolcontext = toolcontext
- self.arguments = toolcontext.option_context.rest
- toolcontext.option_context.options.clear
- toolcontext.option_context.add_option(opt_dir)
- toolcontext.option_context.add_option(opt_source)
- toolcontext.option_context.add_option(opt_sharedir)
- toolcontext.option_context.add_option(opt_nodot)
- toolcontext.process_options
+ init do
+ super
+ self.arguments = option_context.rest
+ option_context.options.clear
+ option_context.add_option(opt_dir)
+ option_context.add_option(opt_source)
+ option_context.add_option(opt_sharedir)
+ option_context.add_option(opt_nodot)
+ option_context.add_option(opt_private)
+ option_context.add_option(opt_custom_title)
+ option_context.add_option(opt_custom_footer_text)
+ option_context.add_option(opt_custom_overview_text)
+ option_context.add_option(opt_custom_menu_items)
process_options
if arguments.length < 1 then
- toolcontext.option_context.usage
+ option_context.usage
exit(1)
end
model = new Model
- modelbuilder = new ModelBuilder(model, toolcontext)
-
- # Here we load an process std modules
- var mmodules = modelbuilder.parse_and_build([arguments.first])
- if mmodules.is_empty then return
+ modelbuilder = new ModelBuilder(model, self)
+ # Here we load an process all modules passed on the command line
+ var mmodules = modelbuilder.parse_and_build(arguments)
modelbuilder.full_propdef_semantic_analysis
- assert mmodules.length == 1
- self.mainmodule = mmodules.first
+ if mmodules.is_empty then return
+
+ if mmodules.length == 1 then
+ mainmodule = mmodules.first
+ else
+ # We need a main module, so we build it by importing all modules
+ mainmodule = new MModule(model, null, "<main>", new Location(null, 0, 0, 0, 0))
+ mainmodule.set_imported_mmodules(mmodules)
+ end
self.class_hierarchy = mainmodule.flatten_mclass_hierarchy
end
- private fun process_options do
+ redef fun process_options do
+ super
if not opt_dir.value is null then
output_dir = opt_dir.value
else
print "Error: Invalid nitdoc share files. Check --sharedir or envvar NIT_DIR"
abort
end
+
+ if opt_private.value then
+ min_visibility = none_visibility
+ else
+ min_visibility = protected_visibility
+ end
end
- if not opt_source.value is null then
- source = ""
- else
- source = opt_source.value
- end
+ source = opt_source.value
end
- fun start do
- if arguments.length == 1 then
- # Create destination dir if it's necessary
- if not output_dir.file_exists then output_dir.mkdir
- sys.system("cp -r {share_dir.to_s}/* {output_dir.to_s}/")
- self.dot_dir = null
- if not opt_nodot.value then self.dot_dir = output_dir.to_s
- overview
- fullindex
- modules
- classes
- quicksearch_list
- end
+ fun generate_nitdoc do
+ # Create destination dir if it's necessary
+ if not output_dir.file_exists then output_dir.mkdir
+ sys.system("cp -r {share_dir.to_s}/* {output_dir.to_s}/")
+ self.dot_dir = null
+ if not opt_nodot.value then self.dot_dir = output_dir.to_s
+ overview
+ fullindex
+ modules
+ classes
+ quicksearch_list
end
- fun overview do
- var overviewpage = new NitdocOverview(modelbuilder, dot_dir)
+ private fun overview do
+ var overviewpage = new NitdocOverview(self, dot_dir)
overviewpage.save("{output_dir.to_s}/index.html")
end
- fun fullindex do
+ private fun fullindex do
var fullindex = new NitdocFullindex(self)
fullindex.save("{output_dir.to_s}/full-index.html")
end
- fun modules do
+ private fun modules do
for mmodule in model.mmodules do
- var modulepage = new NitdocModule(mmodule, modelbuilder, dot_dir)
+ if mmodule.name == "<main>" then continue
+ var modulepage = new NitdocModule(mmodule, self, dot_dir)
modulepage.save("{output_dir.to_s}/{mmodule.url}")
end
end
- fun classes do
+ private 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.url}")
end
end
- # Generate QuickSearch file
- fun quicksearch_list do
+ private fun quicksearch_list do
var file = new OFStream.open("{output_dir.to_s}/quicksearch-list.js")
var content = new Buffer
content.append("var entries = \{ ")
content.append("],")
end
for mclass in model.mclasses do
- if mclass.visibility <= none_visibility then continue
+ if mclass.visibility < min_visibility then continue
content.append("\"{mclass.name}\": [")
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.visibility < min_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)
var dot_dir: nullable String
var source: nullable String
+ var ctx: NitdocContext
- init do end
+ init(ctx: NitdocContext) do
+ self.ctx = ctx
+ end
fun append(str: String) do html.append(str)
- var html = new Buffer
+ private var html = new Buffer
- fun head do
+ protected fun head do
append("<meta charset='utf-8'/>")
append("<script type='text/javascript' src='scripts/jquery-1.7.1.min.js'></script>")
append("<script type='text/javascript' src='quicksearch-list.js'></script>")
append("<script type='text/javascript' src='scripts/js-facilities.js'></script>")
append("<link rel='stylesheet' href='styles/main.css' type='text/css' media='screen'/>")
+ var title = ""
+ if ctx.opt_custom_title.value != null then
+ title = " | {ctx.opt_custom_title.value.to_s}"
+ end
+ append("<title>{self.title}{title}</title>")
+ end
+
+ protected fun menu do
+ if ctx.opt_custom_menu_items.value != null then
+ append(ctx.opt_custom_menu_items.value.to_s)
+ end
end
- fun menu is abstract
+ protected fun title: String is abstract
- fun header do
+ protected fun header do
append("<header>")
append("<nav class='main'>")
append("<ul>")
append("</header>")
end
- fun content is abstract
+ protected fun content is abstract
- fun footer do
- append("<footer>Nit standard library. Version jenkins-component=stdlib-19.</footer>")
+ protected fun footer do
+ if ctx.opt_custom_footer_text.value != null then
+ append("<footer>{ctx.opt_custom_footer_text.value.to_s}</footer>")
+ end
end
# Generate a clickable graphviz image using a dot content
- fun generate_dot(dot: String, name: String, alt: String) do
+ protected fun generate_dot(dot: String, name: String, alt: String) do
var output_dir = dot_dir
if output_dir == null then return
var file = new OFStream.open("{output_dir}/{name}.dot")
end
# Add a (source) link for a given location
- fun show_source(l: Location): String
+ protected fun show_source(l: Location): String
do
if source == null then
return "({l.file.filename.simplify_path})"
source = x.join(l.line_start.to_s)
x = source.split_with("%L")
source = x.join(l.line_end.to_s)
- return " (<a href=\"{source.to_s}\">show code</a>)"
+ return " (<a href=\"{source.to_s}\">source</a>)"
end
end
private var mbuilder: ModelBuilder
private var mmodules = new Array[MModule]
- init(mbuilder: ModelBuilder, dot_dir: nullable String) do
- self.mbuilder = mbuilder
+ init(ctx: NitdocContext, dot_dir: nullable String) do
+ super(ctx)
+ self.mbuilder = ctx.modelbuilder
self.dot_dir = dot_dir
# get modules
var mmodules = new HashSet[MModule]
for mmodule in mbuilder.model.mmodules do
+ if mmodule.name == "<main>" then continue
var owner = mmodule.public_owner
if owner != null then
mmodules.add(owner)
sorter.sort(self.mmodules)
end
- redef fun head do
- super
- append("<title>Overview | Nit Standard Library</title>")
- end
+ redef fun title do return "Overview"
redef fun menu do
+ super
append("<li class='current'>Overview</li>")
append("<li><a href='full-index.html'>Full Index</a></li>")
end
redef fun content do
append("<div class='content fullpage'>")
- append("<h1>Nit Standard Library</h1>")
- append("<article class='overview'><p>Documentation for the standard library of Nit<br />Version jenkins-component=stdlib-19<br />Date: TODAY</p></article>")
+ var title = "Overview"
+ if ctx.opt_custom_title.value != null then
+ title = ctx.opt_custom_title.value.to_s
+ end
+ append("<h1>{title}</h1>")
+ var text = ""
+ if ctx.opt_custom_overview_text.value != null then
+ text = ctx.opt_custom_overview_text.value.to_s
+ end
+ append("<article class='overview'>{text}</article>")
append("<article class='overview'>")
# module list
append("<h2>Modules</h2>")
append("<ul>")
for mmodule in mmodules do
- var amodule = mbuilder.mmodule2nmodule[mmodule]
- append("<li>{mmodule.link(mbuilder)} {amodule.short_comment}</li>")
+ if mbuilder.mmodule2nmodule.has_key(mmodule) then
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ append("<li>{mmodule.link(mbuilder)} {amodule.short_comment}</li>")
+ end
end
append("</ul>")
# module graph
append("</div>")
end
- fun process_generate_dot do
+ private fun process_generate_dot do
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
class NitdocFullindex
super NitdocPage
- private var nitdoc: Nitdoc
-
- init(nitdoc: Nitdoc) do
- self.nitdoc = nitdoc
+ init(ctx: NitdocContext) do
+ super(ctx)
self.dot_dir = null
end
- redef fun head do
- super
- append("<title>Full Index | Nit Standard Library</title>")
- end
+ redef fun title do return "Full Index"
redef fun menu do
+ super
append("<li><a href='index.html'>Overview</a></li>")
append("<li class='current'>Full Index</li>")
end
end
# Add to content modules column
- fun module_column do
+ private fun module_column do
var sorter = new ComparableSorter[MModule]
var sorted = new Array[MModule]
- for mmodule in nitdoc.modelbuilder.model.mmodule_importation_hierarchy do
+ for mmodule in ctx.modelbuilder.model.mmodule_importation_hierarchy do
sorted.add(mmodule)
end
sorter.sort(sorted)
append("<h2>Modules</h2>")
append("<ul>")
for mmodule in sorted do
- append("<li>{mmodule.link(nitdoc.modelbuilder)}</li>")
+ append("<li>{mmodule.link(ctx.modelbuilder)}</li>")
end
append("</ul>")
append("</article>")
end
# Add to content classes modules
- fun classes_column do
- var sorted = nitdoc.modelbuilder.model.mclasses
+ private fun classes_column do
+ var sorted = ctx.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>{mclass.link(nitdoc.modelbuilder)}</li>")
+ if mclass.visibility < ctx.min_visibility then continue
+ append("<li>{mclass.link(ctx.modelbuilder)}</li>")
end
append("</ul>")
append("</article>")
end
# Insert the properties column of fullindex page
- fun properties_column do
- var sorted = nitdoc.modelbuilder.model.mproperties
+ private fun properties_column do
+ var sorted = ctx.modelbuilder.model.mproperties
var sorter = new ComparableSorter[MProperty]
sorter.sort(sorted)
append("<article class='modules filterable'>")
append("<h2>Properties</h2>")
append("<ul>")
for mproperty in sorted do
+ if mproperty.visibility < ctx.min_visibility then continue
if mproperty isa MAttribute then continue
- append("<li>{mproperty.intro.link(nitdoc.modelbuilder)} ({mproperty.intro.mclassdef.mclass.link(nitdoc.modelbuilder)})</li>")
+ append("<li>{mproperty.intro.link(ctx.modelbuilder)} ({mproperty.intro.mclassdef.mclass.link(ctx.modelbuilder)})</li>")
end
append("</ul>")
append("</article>")
private var mmodule: MModule
private var mbuilder: ModelBuilder
- init(mmodule: MModule, mbuilder: ModelBuilder, dot_dir: nullable String) do
+ init(mmodule: MModule, ctx: NitdocContext, dot_dir: nullable String) do
+ super(ctx)
self.mmodule = mmodule
- self.mbuilder = mbuilder
+ self.mbuilder = ctx.modelbuilder
self.dot_dir = dot_dir
end
- redef fun head do
- super
- var amodule = mbuilder.mmodule2nmodule[mmodule]
- append("<title>{mmodule.name} module | {amodule.short_comment}</title>")
+ redef fun title do
+ if mbuilder.mmodule2nmodule.has_key(mmodule) then
+ var nmodule = mbuilder.mmodule2nmodule[mmodule]
+ return "{mmodule.name} module | {nmodule.short_comment}"
+ else
+ return "{mmodule.name} module"
+ end
end
redef fun menu do
+ super
append("<li><a href='index.html'>Overview</a></li>")
append("<li class='current'>{mmodule.name}</li>")
append("<li><a href='full-index.html'>Full Index</a></li>")
append("</div>")
end
- fun process_generate_dot do
+ private fun process_generate_dot do
var name = "dep_{mmodule.name}"
var op = new Buffer
op.append("digraph {name} \{ 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 m in mmodule.in_importation.poset do
+ if m.name == "<main>" then continue
var public_owner = m.public_owner
if public_owner == null then
public_owner = m
end
end
for imported in m.in_importation.direct_greaters do
+ if imported.name == "<main>" then continue
if imported.public_owner == null then
op.append("\"{public_owner.name}\"->\"{imported.name}\";\n")
end
generate_dot(op.to_s, name, "Dependency graph for module {mmodule.name}")
end
- fun sidebar do
- var amodule = mbuilder.mmodule2nmodule[mmodule]
+ private fun sidebar do
append("<div class='menu'>")
append("<nav>")
append("<h3>Module Hierarchy</h3>")
end
# display the class column
- fun classes do
- var amodule = mbuilder.mmodule2nmodule[mmodule]
+ private fun classes do
var intro_mclasses = mmodule.intro_mclasses
var redef_mclasses = mmodule.redef_mclasses
var all_mclasses = new HashSet[MClass]
append("<h2>Classes</h2>")
append("<ul>")
for c in sorted do
+ if c.visibility < ctx.min_visibility then continue
if redef_mclasses.has(c) and c.intro_mmodule.public_owner != mmodule then
append("<li class='redef'>")
append("<span title='refined in this module'>R </span>")
end
# display the property column
- fun properties do
+ private fun properties do
# get properties
- var amodule = mbuilder.mmodule2nmodule[mmodule]
var mpropdefs = new HashSet[MPropDef]
for m in mmodule.in_nesting.greaters do
for c in m.mclassdefs do mpropdefs.add_all(c.mpropdefs)
append("<ul>")
for mprop in sorted do
if mprop isa MAttributeDef then continue
- if mprop.mproperty.visibility <= none_visibility then continue
+ if mprop.mproperty.visibility < ctx.min_visibility then continue
append(mprop.html_list_item(mbuilder))
end
append("</ul>")
private var mclass: MClass
private var mbuilder: ModelBuilder
- private var nitdoc: Nitdoc
private var vtypes = new HashSet[MVirtualTypeDef]
private var consts = new HashSet[MMethodDef]
private var meths = new HashSet[MMethodDef]
private var inherited = new HashSet[MPropDef]
- init(mclass: MClass, nitdoc: Nitdoc, dot_dir: nullable String, source: nullable String) do
+ init(mclass: MClass, ctx: NitdocContext, dot_dir: nullable String, source: nullable String) do
+ super(ctx)
self.mclass = mclass
- self.mbuilder = nitdoc.modelbuilder
- self.nitdoc = nitdoc
+ self.mbuilder = ctx.modelbuilder
self.dot_dir = dot_dir
self.source = source
# load properties
for mclassdef in mclass.mclassdefs do
for mpropdef in mclassdef.mpropdefs do
- if mpropdef.mproperty.visibility <= none_visibility then continue
+ if mpropdef.mproperty.visibility < ctx.min_visibility then continue
if mpropdef isa MVirtualTypeDef then vtypes.add(mpropdef)
if mpropdef isa MMethodDef then
if mpropdef.mproperty.is_init then
# get inherited properties
for mprop in mclass.inherited_mproperties do
var mpropdef = mprop.intro
- if mprop.visibility <= none_visibility then continue
+ if mprop.visibility < ctx.min_visibility then continue
if mpropdef isa MVirtualTypeDef then vtypes.add(mpropdef)
if mpropdef isa MMethodDef then
if mpropdef.mproperty.is_init then
end
end
- redef fun head do
- super
+ redef fun title do
var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
if nclass isa AStdClassdef then
- append("<title>{mclass.name} class | {nclass.short_comment}</title>")
+ return "{mclass.name} class | {nclass.short_comment}"
else
- append("<title>{mclass.name} class</title>")
+ return "{mclass.name} class"
end
end
redef fun menu do
+ super
append("<li><a href='index.html'>Overview</a></li>")
var public_owner = mclass.public_owner
if public_owner is null then
append("</div>")
end
- fun properties_column do
+ private fun properties_column do
var sorter = new ComparableSorter[MPropDef]
append("<nav class='properties filterable'>")
append("<h3>Properties</h3>")
append("</nav>")
end
- fun inheritance_column do
+ private fun inheritance_column do
var sorted = new Array[MClass]
var sorterp = new ComparableSorter[MClass]
append("<nav>")
append("<h3>Inheritance</h3>")
- if mclass.ancestors.length > 1 then
- sorted = mclass.ancestors.to_a
- sorterp.sort(sorted)
+ var greaters = mclass.in_hierarchy(ctx.mainmodule).greaters.to_a
+ if greaters.length > 1 then
+ ctx.mainmodule.linearize_mclasses(greaters)
append("<h4>Superclasses</h4>")
append("<ul>")
- for sup in sorted do
+ for sup in greaters do
if sup == mclass then continue
append("<li>{sup.link(mbuilder)}</li>")
end
append("</ul>")
end
-
- if mclass.descendants.length <= 1 then
+ var smallers = mclass.in_hierarchy(ctx.mainmodule).smallers.to_a
+ var direct_smallers = mclass.in_hierarchy(ctx.mainmodule).direct_smallers.to_a
+ if smallers.length <= 1 then
append("<h4>No Known Subclasses</h4>")
- else if mclass.descendants.length <= 100 then
- sorted = mclass.descendants.to_a
- sorterp.sort(sorted)
+ else if smallers.length <= 100 then
+ ctx.mainmodule.linearize_mclasses(smallers)
append("<h4>Subclasses</h4>")
append("<ul>")
- for sub in sorted do
+ for sub in smallers do
if sub == mclass then continue
append("<li>{sub.link(mbuilder)}</li>")
end
append("</ul>")
- else if mclass.children.length <= 100 then
- sorted = mclass.children.to_a
- sorterp.sort(sorted)
+ else if direct_smallers.length <= 100 then
+ ctx.mainmodule.linearize_mclasses(direct_smallers)
append("<h4>Direct Subclasses Only</h4>")
append("<ul>")
- for sub in sorted do
+ for sub in direct_smallers do
if sub == mclass then continue
append("<li>{sub.link(mbuilder)}</li>")
end
append("</nav>")
end
- fun class_doc do
+ private fun class_doc do
# title
append("<h1>{mclass.html_signature}</h1>")
append("<div class='subtitle info'>{mclass.html_full_signature(mbuilder)}")
var sorted_meths = new Array[MMethodDef]
var sorted = new Array[MModule]
sorted_meths.add_all(meths)
- nitdoc.mainmodule.linearize_mpropdefs(sorted_meths)
+ ctx.mainmodule.linearize_mpropdefs(sorted_meths)
for meth in meths do
if inherited.has(meth) then continue
var mmodule = meth.mclassdef.mmodule
if inherited.length > 0 then
var sorted_inherited = new Array[MPropDef]
sorted_inherited.add_all(inherited)
- nitdoc.mainmodule.linearize_mpropdefs(sorted_inherited)
+ ctx.mainmodule.linearize_mpropdefs(sorted_inherited)
var classes = new ArrayMap[MClass, Array[MPropDef]]
for mmethod in sorted_inherited.reversed do
var mclass = mmethod.mclassdef.mclass
append("</section>")
end
- fun process_generate_dot do
- var pe = nitdoc.class_hierarchy[mclass]
+ private fun process_generate_dot do
+ var pe = ctx.class_hierarchy[mclass]
var cla = new HashSet[MClass]
var sm = new HashSet[MClass]
var sm2 = new HashSet[MClass]
# Return a link (html a tag) to the nitdoc module page
fun link(mbuilder: ModelBuilder): String do
- return "<a href='{url}' title='{mbuilder.mmodule2nmodule[self].short_comment}'>{name}</a>"
+ if mbuilder.mmodule2nmodule.has_key(self) then
+ return "<a href='{url}' title='{mbuilder.mmodule2nmodule[self].short_comment}'>{name}</a>"
+ else
+ return "<a href='{url}'>{name}</a>"
+ end
end
# Return the module signature decorated with html
# Return the full comment of the module decorated with html
fun html_full_comment(mbuilder: ModelBuilder): String do
var res = new Buffer
- res.append("<div id='description'>")
- res.append("<pre class='text_label'>{mbuilder.mmodule2nmodule[self].comment}</pre>")
- res.append("<textarea class='edit' rows='1' cols='76' id='fileContent'></textarea>")
- res.append("<a id='cancelBtn'>Cancel</a>")
- res.append("<a id='commitBtn'>Commit</a>")
- res.append("<pre class='text_label' id='preSave' type='2'></pre>")
- res.append("</div>")
+ if mbuilder.mmodule2nmodule.has_key(self) then
+ res.append("<div id='description'>")
+ res.append("<pre class='text_label'>{mbuilder.mmodule2nmodule[self].comment}</pre>")
+ res.append("<textarea class='edit' rows='1' cols='76' id='fileContent'></textarea>")
+ res.append("<a id='cancelBtn'>Cancel</a>")
+ res.append("<a id='commitBtn'>Commit</a>")
+ res.append("<pre class='text_label' id='preSave' type='2'></pre>")
+ res.append("</div>")
+ end
return res.to_s
end
end
# Return the module signature decorated with html
fun html_full_signature(mbuilder: ModelBuilder): String do
var res = new Buffer
- if visibility <= none_visibility then
- res.append("private ")
- else if visibility == protected_visibility then
- res.append("protected ")
- end
+ if visibility < public_visibility then res.append("{visibility.to_s} ")
res.append("{kind} {html_namespace(mbuilder)}")
return res.to_s
end
fun full_name: String do
return "{mclassdef.mclass.public_owner.name}::{mclassdef.mclass.name}::{mproperty.name}"
end
+
+ fun html_inheritance(page: NitdocClass): String do
+ var res = new Buffer
+ # definitions block
+ res.append("<p class='info'>")
+ page.ctx.mainmodule.linearize_mpropdefs(mproperty.mpropdefs)
+ var previous_defs = new Array[MPropDef]
+ var next_defs = new Array[MPropDef]
+ var self_passed = false
+ for def in mproperty.mpropdefs do
+ if def == self then
+ self_passed = true
+ continue
+ end
+ if not self_passed then
+ if def.mclassdef.mclass.in_hierarchy(page.ctx.mainmodule) < page.mclass then continue
+ if def.is_intro then continue
+ previous_defs.add(def)
+ else
+ if page.mclass.in_hierarchy(page.ctx.mainmodule) < def.mclassdef.mclass then continue
+ next_defs.add(def)
+ end
+ end
+ var source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(self) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[self].location)}"
+ end
+ res.append("defined by {mclassdef.mmodule.html_full_namespace(page.mbuilder)}{source}")
+ if not is_intro then
+ source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(mproperty.intro) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[mproperty.intro].location)}"
+ end
+ res.append(", introduced by {mproperty.intro.mclassdef.mclass.link(page.mbuilder)}{source}")
+ end
+ if not previous_defs.is_empty then
+ res.append(", inherited from ")
+ for i in [0..previous_defs.length[ do
+ var def = previous_defs[i]
+ source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(def) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[def].location)}"
+ end
+ res.append("{def.mclassdef.mclass.link(page.mbuilder)}{source}")
+ if i < previous_defs.length - 1 then res.append(", ")
+ end
+ end
+ if not next_defs.is_empty then
+ res.append(", redefined by ")
+ for i in [0..next_defs.length[ do
+ var def = next_defs[i]
+ source = ""
+ if page.mbuilder.mpropdef2npropdef.has_key(def) then
+ source = " {page.show_source(page.mbuilder.mpropdef2npropdef[def].location)}"
+ end
+ res.append("{def.mclassdef.mclass.link(page.mbuilder)}{source}")
+ if i < next_defs.length - 1 then res.append(", ")
+ end
+ end
+ res.append(".</p>")
+ return res.to_s
+ end
end
redef class MMethodDef
classes.add("fun")
if mprop.is_init then classes.add("init")
if is_redef then classes.add("redef")
- if mprop.visibility == none_visibility then
- classes.add("private")
- else if mprop.visibility == protected_visibility then
- classes.add("protected")
- else
- classes.add("public")
- end
+ classes.add(mproperty.visibility.to_s)
res.append("<article class='{classes.join(" ")}' id='{anchor}'>")
if nprop isa AAttrPropdef then
if nprop.mreadpropdef == self then
res.append("<pre class=\"text_label\" title=\"\" name=\"\" tag=\"\" type=\"1\">{nprop.comment}</pre>")
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 class='info'>")
- page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
- var previous_defs = new Array[MMethodDef]
- var next_defs = new Array[MMethodDef]
- var self_passed = false
- for def in mprop.mpropdefs do
- if def == self then
- self_passed = true
- continue
- end
- if not self_passed then
- if not page.mclass.ancestors.has(def.mclassdef.mclass) then continue
- if def.is_intro then continue
- previous_defs.add(def)
- else
- if not page.mclass.descendants.has(def.mclassdef.mclass) then continue
- next_defs.add(def)
- end
- end
- res.append("defined by {mclassdef.mmodule.html_full_namespace(page.mbuilder)}")
- if not is_intro then
- res.append(", introduced by {mprop.intro.mclassdef.mclass.link(page.mbuilder)}")
- end
- if not previous_defs.is_empty then
- res.append(", inherited from ")
- for i in [0..previous_defs.length[ do
- res.append(previous_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < previous_defs.length - 1 then res.append(", ")
- end
- end
- if not next_defs.is_empty then
- res.append(", redefined by ")
- for i in [0..next_defs.length[ do
- res.append(next_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < next_defs.length - 1 then res.append(", ")
- end
- end
- res.append(".</p>")
+ res.append(html_inheritance(page))
res.append("</div>")
res.append("</article>")
return res.to_s
redef fun html_info(page) do
var res = new Buffer
res.append("<div class='info'>")
- if mproperty.visibility <= none_visibility then
- res.append("private ")
- else if mproperty.visibility <= protected_visibility then
- res.append("protected ")
- end
+ if mproperty.visibility < public_visibility then res.append("{mproperty.visibility.to_s} ")
if mproperty.intro_mclassdef.mclass != page.mclass then res.append("redef ")
res.append("fun {mproperty.html_namespace(page.mbuilder)}")
res.append("</div>")
var classes = new Array[String]
classes.add("type")
if is_redef then classes.add("redef")
- if mprop.visibility == none_visibility then
- classes.add("private")
- else if mprop.visibility == protected_visibility then
- classes.add("protected")
- else
- classes.add("public")
- end
+ classes.add(mproperty.visibility.to_s)
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("<a class=\"newComment\" title=\"32\" tag=\"\">New Comment</a>")
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 class='info'>")
- page.nitdoc.mainmodule.linearize_mpropdefs(mprop.mpropdefs)
- var previous_defs = new Array[MVirtualTypeDef]
- var next_defs = new Array[MVirtualTypeDef]
- var self_passed = false
- for def in mprop.mpropdefs do
- if def == self then
- self_passed = true
- continue
- end
- if not self_passed then
- if not page.mclass.ancestors.has(def.mclassdef.mclass) then continue
- if def.is_intro then continue
- previous_defs.add(def)
- else
- if not page.mclass.descendants.has(def.mclassdef.mclass) then continue
- next_defs.add(def)
- end
- end
- res.append("defined by {mclassdef.mmodule.html_full_namespace(page.mbuilder)}")
- if not is_intro then
- res.append(", introduced by {mprop.intro.mclassdef.mclass.link(page.mbuilder)}")
- end
- if not previous_defs.is_empty then
- res.append(", inherited from ")
- for i in [0..previous_defs.length[ do
- res.append(previous_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < previous_defs.length - 1 then res.append(", ")
- end
- end
- if not next_defs.is_empty then
- res.append(", redefined by ")
- for i in [0..next_defs.length[ do
- res.append(next_defs[i].mclassdef.mclass.link(page.mbuilder))
- if i < next_defs.length - 1 then res.append(", ")
- end
- end
- res.append(".</p>")
+ res.append(html_inheritance(page))
res.append("</div>")
res.append("</article>")
return res.to_s
redef class AModule
private fun comment: String do
var ret = new Buffer
- if n_moduledecl is null or n_moduledecl.n_doc is null then ret
- if n_moduledecl.n_doc is null then return ""
+ if n_moduledecl == null or n_moduledecl.n_doc == null then return ""
for t in n_moduledecl.n_doc.n_comment do
ret.append(t.text.substring_from(1))
end
end
end
-# Create a tool context to handle options and paths
-var toolcontext = new ToolContext
-
-# Here we launch the nit index
-var nitdoc = new Nitdoc(toolcontext)
-nitdoc.start
+var nitdoc = new NitdocContext
+nitdoc.generate_nitdoc
nitlanguage / nit.git / blobdiff