import model_utils
import abstract_compiler
-import html
class Nitdoc
private var toolcontext: ToolContext
private var model: Model
private var modelbuilder: ModelBuilder
private var mainmodule: MModule
+ private var class_hierarchy: POSet[MClass]
private var arguments: Array[String]
- private var destinationdir: nullable String
- private var sharedir: nullable String
+ private var output_dir: nullable String
+ private var dot_dir: nullable String
+ private var share_dir: nullable String
+ private var source: nullable String
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")
# 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
process_options
if arguments.length < 1 then
modelbuilder.full_propdef_semantic_analysis
assert mmodules.length == 1
self.mainmodule = mmodules.first
+ self.class_hierarchy = mainmodule.flatten_mclass_hierarchy
end
private fun process_options do
if not opt_dir.value is null then
- destinationdir = opt_dir.value
+ output_dir = opt_dir.value
else
- destinationdir = "nitdoc_directory"
+ output_dir = "doc"
end
if not opt_sharedir.value is null then
- sharedir = opt_sharedir.value
+ share_dir = opt_sharedir.value
else
var dir = "NIT_DIR".environ
if dir.is_empty then
else
dir = "{dir}/share/nitdoc"
end
- sharedir = dir
- if sharedir is null then
+ share_dir = dir
+ if share_dir is null then
print "Error: Cannot locate nitdoc share files. Uses --sharedir or envvar NIT_DIR"
abort
end
- dir = "{sharedir.to_s}/scripts/js-facilities.js"
- if sharedir is null then
+ dir = "{share_dir.to_s}/scripts/js-facilities.js"
+ if share_dir is null then
print "Error: Invalid nitdoc share files. Check --sharedir or envvar NIT_DIR"
abort
end
end
+ if not opt_source.value is null then
+ source = ""
+ else
+ source = opt_source.value
+ end
end
fun start do
if arguments.length == 1 then
# Create destination dir if it's necessary
- if not destinationdir.file_exists then destinationdir.mkdir
- sys.system("cp -r {sharedir.to_s}/* {destinationdir.to_s}/")
+ 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
+ #fullindex
modules
classes
+ #quicksearch_list
end
end
fun overview do
- var overviewpage = new NitdocOverview.with(modelbuilder.nmodules, self.opt_nodot.value, destinationdir.to_s)
- overviewpage.save("{destinationdir.to_s}/index.html")
+ var overviewpage = new NitdocOverview(modelbuilder, dot_dir)
+ overviewpage.save("{output_dir.to_s}/index.html")
end
fun fullindex do
- var fullindex = new NitdocFullindex.with(model.mmodules)
- fullindex.save("{destinationdir.to_s}/full-index.html")
+ var fullindex = new NitdocFullindex(model.mmodules)
+ fullindex.save("{output_dir.to_s}/full-index.html")
end
fun modules do
- for mod in modelbuilder.nmodules do
- var modulepage = new NitdocModules.with(mod)
- modulepage.save("{destinationdir.to_s}/{mod.mmodule.name}.html")
+ for mmodule in model.mmodules do
+ var modulepage = new NitdocModule(mmodule, modelbuilder, dot_dir)
+ modulepage.save("{output_dir.to_s}/{mmodule.name}.html")
end
end
fun classes do
- for amodule in modelbuilder.nmodules do
- for mclass, aclassdef in amodule.mclass2nclassdef do
- var classpage = new NitdocMClasses.with(mclass, aclassdef)
- classpage.save("{destinationdir.to_s}/{mclass.name}.html")
+ 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")
+ end
+ end
+
+ # Generate QuickSearch file
+ fun quicksearch_list do
+ 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 mclass in model.mclasses do
+ 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(", ")
+ end
+ content.append("]")
+ if not mclass is model.mclasses.last then content.append(", ")
+ end
+
+ content.append(" \};")
+ file.write(content.to_s)
+ file.close
end
end
-class NitdocOverview
- super NitdocPage
+# Nitdoc base page
+abstract class NitdocPage
+
+ var dot_dir: nullable String
+ var source: nullable String
+
+ init do end
+
+ fun append(str: String) do html.append(str)
+ var html = new Buffer
+
+ 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'/>")
+ end
+
+ fun menu is abstract
+
+ fun header do
+ append("<header>")
+ append("<nav class='main'>")
+ append("<ul>")
+ menu
+ append("<li id='liGitHub'>")
+ append("<a class='btn' id='logGitHub'>")
+ append("<img id='imgGitHub' src='resources/icons/github-icon.png' alt='GitHub'/>")
+ append("</a>")
+ append("<div class='popover bottom'>")
+ append("<div class='arrow'> </div>")
+ append("<div class='githubTitle'>")
+ append("<h3>Github Sign In</h3>")
+ append("</div>")
+ append("<div>")
+ append("<label id='lbloginGit'>Username</label>")
+ append("<input id='loginGit' name='login' type='text'/>")
+ append("<label id='logginMessage'>Hello ")
+ append("<a id='githubAccount'><strong id='nickName'></strong></a>")
+ append("</label>")
+ append("</div>")
+ append("<div>")
+ append("<label id='lbpasswordGit'>Password</label>")
+ append("<input id='passwordGit' name='password' type='password'/>")
+ append("<div id='listBranches'>")
+ append("<label id='lbBranches'>Branch</label>")
+ append("<select class='dropdown' id='dropBranches' name='dropBranches' tabindex='1'></select>")
+ append("</div>")
+ append("</div>")
+ append("<div>")
+ append("<label id='lbrepositoryGit'>Repository</label>")
+ append("<input id='repositoryGit' name='repository' type='text'/>")
+ append("</div>")
+ append("<div>")
+ append("<label id='lbbranchGit'>Branch</label>")
+ append("<input id='branchGit' name='branch' type='text'/>")
+ append("</div>")
+ append("<div>")
+ append("<a id='signIn'>Sign In</a>")
+ append("</div>")
+ append("</div>")
+ append("</li>")
+ append("</ul>")
+ append("</nav>")
+ append("</header>")
+ end
+
+ fun content is abstract
+
+ fun footer do
+ append("<footer>Nit standard library. Version jenkins-component=stdlib-19.</footer>")
+ end
+
+ # Generate a clickable graphviz image using a dot content
+ 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")
+ file.write(dot)
+ file.close
+ sys.system("\{ test -f {output_dir}/{name}.png && test -f {output_dir}/{name}.s.dot && diff {output_dir}/{name}.dot {output_dir}/{name}.s.dot >/dev/null 2>&1 ; \} || \{ cp {output_dir}/{name}.dot {output_dir}/{name}.s.dot && dot -Tpng -o{output_dir}/{name}.png -Tcmapx -o{output_dir}/{name}.map {output_dir}/{name}.s.dot ; \}")
+ append("<article class='graph'>")
+ append("<img src='{name}.png' usemap='#{name}' style='margin:auto' alt='{alt}'/>")
+ append("</article>")
+ var fmap = new IFStream.open("{output_dir}/{name}.map")
+ append(fmap.read_all)
+ fmap.close
+ end
+
+ # Add a (source) link for a given location
+ fun show_source(l: Location): String
+ do
+ if source == null then
+ return "({l.file.filename.simplify_path})"
+ else
+ # THIS IS JUST UGLY ! (but there is no replace yet)
+ var x = source.split_with("%f")
+ source = x.join(l.file.filename.simplify_path)
+ x = source.split_with("%l")
+ 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>)"
+ end
+ end
- var amodules: Array[AModule]
+ # Render the page as a html string
+ fun render: String do
+ append("<!DOCTYPE html>")
+ append("<head>")
+ head
+ append("</head>")
+ append("<body>")
+ header
+ append("<div class='page'>")
+ content
+ append("</div>")
+ footer
+ append("</body>")
+ return html.to_s
+ end
- # Init with Array[AModule] to get all ifnormations about each MModule containt in a program
- # opt_nodot to inform about the graph gen
- # destination: to know where will be saved dot files
- init with(modules: Array[AModule], opt_nodot: Bool, destination: String) do
- self.amodules = modules
- self.opt_nodot = opt_nodot
- self.destinationdir = destination
+ # Save html page in the specified file
+ fun save(file: String) do
+ var out = new OFStream.open(file)
+ out.write(render)
+ out.close
+ end
+end
+
+# The overview page
+class NitdocOverview
+ super NitdocPage
+ private var mbuilder: ModelBuilder
+ private var mmodules = new Array[MModule]
+
+ init(mbuilder: ModelBuilder, dot_dir: nullable String) do
+ self.mbuilder = mbuilder
+ self.dot_dir = dot_dir
+ # get modules
+ var mmodules = new HashSet[MModule]
+ for mmodule in mbuilder.model.mmodules do
+ var owner = mmodule.public_owner
+ if owner != null then
+ mmodules.add(owner)
+ else
+ mmodules.add(mmodule)
+ end
+ end
+ # sort modules
+ var sorter = new ComparableSorter[MModule]
+ self.mmodules.add_all(mmodules)
+ sorter.sort(self.mmodules)
end
redef fun head do
super
- add("title").text("Overview | Nit Standard Library")
- end
-
- redef fun header do
- open("header")
- open("nav").add_class("main")
- open("ul")
- add("li").add_class("current").text("Overview")
- open("li")
- add_html("<a href=\"full-index.html\">Full Index</a>")
- close("li")
- open("li").attr("id", "liGitHub")
- open("a").add_class("btn").attr("id", "logGitHub")
- add("img").attr("id", "imgGitHub").attr("src", "resources/icons/github-icon.png")
- close("a")
- open("div").add_class("popover bottom")
- add("div").add_class("arrow").text(" ")
- open("div").add_class("githubTitle")
- add("h3").text("Github Sign In")
- close("div")
- open("div")
- add("label").attr("id", "lbloginGit").text("Username")
- add("input").attr("id", "loginGit").attr("name", "login").attr("type", "text")
- open("label").attr("id", "logginMessage").text("Hello ")
- open("a").attr("id", "githubAccount")
- add("strong").attr("id", "nickName").text(" ")
- close("a")
- close("label")
- close("div")
- open("div")
- add("label").attr("id", "lbpasswordGit").text("Password")
- add("input").attr("id", "passwordGit").attr("name", "password").attr("type", "password")
- open("div").attr("id", "listBranches")
- add("label").attr("id", "lbBranches").text("Branch")
- add("select").add_class("dropdown").attr("id", "dropBranches").attr("name", "dropBranches").attr("tabindex", "1").text(" ")
- close("div")
- close("div")
- open("div")
- add("label").attr("id", "lbrepositoryGit").text("Repository")
- add("input").attr("id", "repositoryGit").attr("name", "repository").attr("type", "text")
- close("div")
- open("div")
- add("label").attr("id", "lbbranchGit").text("Branch")
- add("input").attr("id", "branchGit").attr("name", "branch").attr("type", "text")
- close("div")
- open("div")
- add("a").attr("id", "signIn").text("Sign In")
- close("div")
- close("div")
- close("li")
- close("ul")
- close("nav")
- close("header")
- end
-
- redef fun body do
- super
- open("div").add_class("page")
- open("div").add_class("content fullpage")
- add("h1").text("Nit Standard Library")
- open("article").add_class("overview")
- add_html("<p>Documentation for the standard library of Nit<br />Version jenkins-component=stdlib-19<br />Date: TODAY</p>")
- close("article")
- open("article").add_class("overview")
- add("h2").text("Modules")
- open("ul")
- add_modules
- close("ul")
- process_generate_dot
- close("article")
- close("div")
- close("div")
- add("footer").text("Nit standard library. Version jenkins-component=stdlib-19.")
+ append("<title>Overview | Nit Standard Library</title>")
end
- fun add_modules do
- var ls = new List[nullable MModule]
- for amodule in amodules do
- var mmodule = amodule.mmodule.public_owner
- if mmodule != null and not ls.has(mmodule) then
- open("li")
- add("a").attr("href", "{mmodule.name}.html").text("{mmodule.to_s} ")
- add_html(amodule.comment)
- close("li")
- ls.add(mmodule)
- end
+ redef fun menu do
+ 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>")
+ 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>")
end
+ append("</ul>")
+ # module graph
+ process_generate_dot
+ append("</article>")
+ append("</div>")
end
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 amodule in amodules do
- op.append("\"{amodule.mmodule.name}\"[URL=\"{amodule.mmodule.name}.html\"];\n")
- for mmodule2 in amodule.mmodule.in_importation.direct_greaters do
- op.append("\"{amodule.mmodule.name}\"->\"{mmodule2.name}\";\n")
+ for mmodule in mmodules do
+ op.append("\"{mmodule.name}\"[URL=\"{mmodule.name}.html\"];\n")
+ for imported in mmodule.in_importation.direct_greaters do
+ if imported.direct_owner == null then
+ op.append("\"{mmodule.name}\"->\"{imported.name}\";\n")
+ end
end
end
op.append("\}\n")
generate_dot(op.to_s, "dep", "Modules hierarchy")
end
-
end
+# The full index page
class NitdocFullindex
super NitdocPage
- var mmodules: Array[MModule]
+ private var mmodules: Array[MModule]
- init with(mmodules: Array[MModule]) do
+ init(mmodules: Array[MModule]) do
self.mmodules = mmodules
- opt_nodot = false
- destinationdir = ""
+ self.dot_dir = null
end
redef fun head do
super
- add("title").text("Full Index | Nit Standard Library")
- end
-
- redef fun header do
- open("header")
- open("nav").add_class("main")
- open("ul")
- open("li")
- add_html("<a href=\"index.html\">Overview</a>")
- close("li")
- add("li").add_class("current").text("Full Index")
- open("li").attr("id", "liGitHub")
- open("a").add_class("btn").attr("id", "logGitHub")
- add("img").attr("id", "imgGitHub").attr("src", "resources/icons/github-icon.png")
- close("a")
- open("div").add_class("popover bottom")
- add("div").add_class("arrow").text(" ")
- open("div").add_class("githubTitle")
- add("h3").text("Github Sign In")
- close("div")
- open("div")
- add("label").attr("id", "lbloginGit").text("Username")
- add("input").attr("id", "loginGit").attr("name", "login").attr("type", "text")
- open("label").attr("id", "logginMessage").text("Hello ")
- open("a").attr("id", "githubAccount")
- add("strong").attr("id", "nickName").text(" ")
- close("a")
- close("label")
- close("div")
- open("div")
- add("label").attr("id", "lbpasswordGit").text("Password")
- add("input").attr("id", "passwordGit").attr("name", "password").attr("type", "password")
- open("div").attr("id", "listBranches")
- add("label").attr("id", "lbBranches").text("Branch")
- add("select").add_class("dropdown").attr("id", "dropBranches").attr("name", "dropBranches").attr("tabindex", "1").text(" ")
- close("div")
- close("div")
- open("div")
- add("label").attr("id", "lbrepositoryGit").text("Repository")
- add("input").attr("id", "repositoryGit").attr("name", "repository").attr("type", "text")
- close("div")
- open("div")
- add("label").attr("id", "lbbranchGit").text("Branch")
- add("input").attr("id", "branchGit").attr("name", "branch").attr("type", "text")
- close("div")
- open("div")
- add("a").attr("id", "signIn").text("Sign In")
- close("div")
- close("div")
- close("li")
- close("ul")
- close("nav")
- close("header")
- end
-
- redef fun body do
- super
- open("div").add_class("page")
- open("div").add_class("content fullpage")
- add("h1").text("Full Index")
- add_content
- close("div")
- close("div")
- add("footer").text("Nit standard library. Version jenkins-component=stdlib-19.")
+ append("<title>Full Index | Nit Standard Library</title>")
+ end
+
+ redef fun menu do
+ append("<li><a href='index.html'>Overview</a></li>")
+ append("<li class='current'>Full Index</li>")
end
- fun add_content do
+ redef fun content do
+ append("<div class='content fullpage'>")
+ append("<h1>Full Index</h1>")
module_column
classes_column
properties_column
+ append("</div>")
end
# Add to content modules column
fun module_column do
var ls = new List[nullable MModule]
- open("article").add_class("modules filterable")
- add("h2").text("Modules")
- open("ul")
- for mmodule in mmodules do
+ var sorted = mmodules
+ var sorterp = new ComparableSorter[MModule]
+ sorterp.sort(sorted)
+ append("<article class='modules filterable'></article>")
+ 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)
- open("li")
- add("a").attr("href", "{mmodule.public_owner.name}.html").text(mmodule.public_owner.name)
- close("li")
+ append("<li><a href='{mmodule.public_owner.name}.html'>(mmodule.public_owner.name)</a></li>")
end
end
- close("ul")
- close("article")
+ append("</ul>")
+ append("</article>")
end
# Add to content classes modules
fun classes_column do
- open("article").add_class("classes filterable")
- add("h2").text("Classes")
- open("ul")
-
- for mclass in mmodules.first.imported_mclasses do
- open("li")
- add("a").attr("href", "{mclass.name}.html").text(mclass.name)
- close("li")
+ var sorted = mmodules.first.imported_mclasses.to_a
+ var sorterp = new ComparableSorter[MClass]
+ sorterp.sort(sorted)
+ append("<article class='classes filterable'>")
+ append("<h2>Classes</h2>")
+ append("<ul>")
+ for mclass in sorted do
+ append("<li><a href='{mclass}.html'>(mclass.name)</a></li>")
end
-
- close("ul")
- close("article")
+ append("</ul>")
+ append("</article>")
end
# Insert the properties column of fullindex page
fun properties_column do
- open("article").add_class("properties filterable")
- add("h2").text("Properties")
- open("ul")
-
- for method in mmodules.first.imported_methods do
+ append("<article class='classes 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
- open("li").add_class("intro")
- add("span").attr("title", "introduction").text("I")
- add_html(" ")
- add("a").attr("href", "{method.local_class.name}.html").attr("title", "").text("{method.name} ({method.local_class.name})")
- close("li")
+ append("<li class='intro'</li>")
+ append("<span title='introduction'>I</span> ")
+ append("<a href='{method.local_class.name}.html' title=''>{method.name} ({method.local_class.name})</a>")
+ append("</li>")
end
- for method in mmodules.first.redef_methods do
+ for method in sorted_redef do
if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- open("li").add_class("redef")
- add("span").attr("title", "redefinition").text("R")
- add_html(" ")
- add("a").attr("href", "{method.local_class.name}.html").attr("title", "").text("{method.name} ({method.local_class.name})")
- close("li")
+ append("<li class='redef'>")
+ append("<span title='redefinition'>R</span> ")
+ append("<a href='{method.local_class.name}.html' title=''>{method.name} ({method.local_class.name})</span>")
+ append("</li>")
end
-
- close("ul")
- close("article")
+ append("</ul>")
+ append("</article>")
end
end
-class NitdocModules
+# A module page
+class NitdocModule
super NitdocPage
- var amodule: AModule
- var modulename: String
- init with(amodule: AModule) do
- self.amodule = amodule
- self.modulename = self.amodule.mmodule.name
- opt_nodot = false
- destinationdir = ""
+ private var mmodule: MModule
+ private var mbuilder: ModelBuilder
+
+ init(mmodule: MModule, mbuilder: ModelBuilder, dot_dir: nullable String) do
+ self.mmodule = mmodule
+ self.mbuilder = mbuilder
+ self.dot_dir = dot_dir
end
redef fun head do
super
- add("title").text("{modulename} module | {amodule.short_comment}")
- end
-
- redef fun header do
- open("header")
- open("nav").add_class("main")
- open("ul")
- open("li")
- add_html("<a href=\"index.html\">Overview</a>")
- close("li")
- add("li").add_class("current").text(modulename)
- open("li")
- add_html("<a href=\"full-index.html\" >Full Index</a>")
- close("li")
- open("li").attr("id", "liGitHub")
- open("a").add_class("btn").attr("id", "logGitHub")
- add("img").attr("id", "imgGitHub").attr("src", "resources/icons/github-icon.png")
- close("a")
- open("div").add_class("popover bottom")
- add("div").add_class("arrow").text(" ")
- open("div").add_class("githubTitle")
- add("h3").text("Github Sign In")
- close("div")
- open("div")
- add("label").attr("id", "lbloginGit").text("Username")
- add("input").attr("id", "loginGit").attr("name", "login").attr("type", "text")
- open("label").attr("id", "logginMessage").text("Hello ")
- open("a").attr("id", "githubAccount")
- add("strong").attr("id", "nickName").text(" ")
- close("a")
- close("label")
- close("div")
- open("div")
- add("label").attr("id", "lbpasswordGit").text("Password")
- add("input").attr("id", "passwordGit").attr("name", "password").attr("type", "password")
- open("div").attr("id", "listBranches")
- add("label").attr("id", "lbBranches").text("Branch")
- add("select").add_class("dropdown").attr("id", "dropBranches").attr("name", "dropBranches").attr("tabindex", "1").text(" ")
- close("div")
- close("div")
- open("div")
- add("label").attr("id", "lbrepositoryGit").text("Repository")
- add("input").attr("id", "repositoryGit").attr("name", "repository").attr("type", "text")
- close("div")
- open("div")
- add("label").attr("id", "lbbranchGit").text("Branch")
- add("input").attr("id", "branchGit").attr("name", "branch").attr("type", "text")
- close("div")
- open("div")
- add("a").attr("id", "signIn").text("Sign In")
- close("div")
- close("div")
- close("li")
- close("ul")
- close("nav")
- close("header")
- end
-
- redef fun body do
- super
- open("div").add_class("page")
- menu
- add_content
- close("div")
- add("footer").text("Nit standard library. Version jenkins-component=stdlib-19.")
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ append("<title>{mmodule.name} module | {amodule.short_comment}</title>")
+ end
+
+ redef fun menu do
+ 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>")
end
- # Insert all tags in content part
- fun add_content do
- open("div").add_class("content")
- add("h1").text(modulename)
- add("div").add_class("subtitle").text("module {modulename}")
- module_comment
+ redef fun content do
+ sidebar
+ append("<div class='content'>")
+ append("<h1>{mmodule.name}</h1>")
+ append("<div class='subtitle'>{mmodule.html_signature(mbuilder)}</div>")
+ append(mmodule.html_full_comment(mbuilder))
+ process_generate_dot
classes
properties
- close("div")
- end
-
- # Insert module comment in the content
- fun module_comment do
- var doc = amodule.comment
- open("div").attr("id", "description")
- add("pre").add_class("text_label").text(doc)
- add("textarea").add_class("edit").attr("rows", "1").attr("cols", "76").attr("id", "fileContent").text(" ")
- add("a").attr("id", "cancelBtn").text("Cancel")
- add("a").attr("id", "commitBtn").text("Commit")
- add("pre").add_class("text_label").attr("id", "preSave").attr("type", "2")
- close("div")
- end
-
- fun menu do
- var mmodule = amodule.mmodule
- open("div").add_class("menu")
- open("nav")
- add("h3").text("Module Hierarchy").attr("style","cursor: pointer;")
- if mmodule.in_importation.direct_greaters.length > 0 then
- add_html("<h4>All dependencies</h4><ul>")
- for m in mmodule.in_importation.direct_greaters do
- if m == mmodule or mmodule == m.public_owner then continue
- open("li")
- add("a").attr("href", "{m.name}.html").text(m.name)
- close("li")
- end
- add_html("</ul>")
- end
- if mmodule.in_importation.greaters.length > 0 then
- add_html("<h4>All clients</h4><ul>")
- for m in mmodule.in_importation.greaters do
- if m == mmodule then continue
- open("li")
- add("a").attr("href", "{m.name}.html").text(m.name)
- close("li")
- end
- add_html("</ul>")
- end
- close("nav")
- if mmodule.in_nesting.direct_greaters.length > 0 then
- open("nav")
- add("h3").text("Nested Modules").attr("style","cursor: pointer;")
- open("ul")
- for m in mmodule.in_nesting.direct_greaters do
- open("li")
- add("a").attr("href", "{m.name}.html").text(m.name)
- close("li")
+ append("</div>")
+ end
+
+ 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
+ var public_owner = m.public_owner
+ if public_owner == null then
+ public_owner = m
+ if m == mmodule then
+ op.append("\"{m.name}\"[shape=box,margin=0.03];\n")
+ else
+ op.append("\"{m.name}\"[URL=\"{m.name}.html\"];\n")
+ end
end
- close("ul")
-
- close("nav")
+ for imported in m.in_importation.direct_greaters do
+ if imported.public_owner == null then
+ op.append("\"{public_owner.name}\"->\"{imported.name}\";\n")
+ end
+ end
+ end
+ op.append("\}\n")
+ generate_dot(op.to_s, name, "Dependency graph for module {mmodule.name}")
+ end
+
+ fun sidebar do
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ append("<div class='menu'>")
+ append("<nav>")
+ append("<h3>Module Hierarchy</h3>")
+ var dependencies = new Array[MModule]
+ for dep in mmodule.in_importation.greaters do
+ if dep == mmodule or dep.public_owner != null then continue
+ dependencies.add(dep)
+ end
+ if dependencies.length > 0 then
+ append("<h4>All dependencies</h4>")
+ display_module_list(dependencies)
+ end
+ var clients = new Array[MModule]
+ for dep in mmodule.in_importation.smallers do
+ if dep == mmodule or dep.public_owner != null then continue
+ clients.add(dep)
+ end
+ if clients.length > 0 then
+ append("<h4>All clients</h4>")
+ display_module_list(clients)
end
- close("div")
+ append("</nav>")
+ if mmodule.in_nesting.direct_greaters.length > 0 then
+ append("<nav>")
+ append("<h3>Nested Modules</h3>")
+ display_module_list(mmodule.in_nesting.direct_greaters.to_a)
+ append("</nav>")
+ end
+ append("</div>")
end
+ private fun display_module_list(list: Array[MModule]) do
+ append("<ul>")
+ var sorter = new ComparableSorter[MModule]
+ sorter.sort(list)
+ for m in list do append("<li>{m.link(mbuilder)}</li>")
+ append("</ul>")
+ end
+
+ # display the class column
fun classes do
- open("div").add_class("module")
- open("article").add_class("classes filterable")
- add("h2").text("Classes")
- open("ul")
- for c, state in amodule.mmodule.mclasses do
- var name = c.name
- if state == c_is_intro or state == c_is_imported then
- open("li").add_class("intro")
- add("span").attr("title", "introduced in this module").text("I ")
+ var amodule = mbuilder.mmodule2nmodule[mmodule]
+ var intro_mclasses = mmodule.intro_mclasses
+ var redef_mclasses = mmodule.redef_mclasses
+ var all_mclasses = new HashSet[MClass]
+ for m in mmodule.in_nesting.greaters do
+ all_mclasses.add_all(m.intro_mclasses)
+ all_mclasses.add_all(m.redef_mclasses)
+ end
+ all_mclasses.add_all(intro_mclasses)
+ all_mclasses.add_all(redef_mclasses)
+
+ var sorted = new Array[MClass]
+ sorted.add_all(all_mclasses)
+ var sorter = new ComparableSorter[MClass]
+ sorter.sort(sorted)
+ append("<div class='module'>")
+ append("<article class='classes filterable'>")
+ append("<h2>Classes</h2>")
+ append("<ul>")
+ for c in sorted do
+ 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>")
else
- open("li").add_class("redef")
- add("span").attr("title", "refined in this module").text("R ")
+ append("<li class='intro'>")
+ append("<span title='introduced in this module'>I </span>")
end
- add("a").attr("href", "{name}.html").text(name)
- close("li")
+ append(c.link(mbuilder))
+ append("</li>")
end
- close("ul")
- close("article")
- close("div")
+ append("</ul>")
+ append("</article>")
+ append("</div>")
end
+ # display the property column
fun properties do
- open("article").add_class("properties filterable")
- add_html("<h2>Properties</h2>")
- open("ul")
- for method in amodule.mmodule.imported_methods do
- if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- open("li").add_class("intro")
- add("span").attr("title", "introduction").text("I")
- add_html(" ")
- add("a").attr("href", "{method.local_class.name}.html").attr("title", "").text("{method.name} ({method.local_class.name})")
- close("li")
+ # 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)
end
-
- for method in amodule.mmodule.redef_methods do
- if method.visibility is none_visibility or method.visibility is intrude_visibility then continue
- open("li").add_class("redef")
- add("span").attr("title", "redefinition").text("R")
- add_html(" ")
- add("a").attr("href", "{method.local_class.name}.html").attr("title", "").text("{method.name} ({method.local_class.name})")
- close("li")
+ for c in mmodule.mclassdefs do mpropdefs.add_all(c.mpropdefs)
+ var sorted = mpropdefs.to_a
+ var sorter = new ComparableSorter[MPropDef]
+ sorter.sort(sorted)
+ # display properties in one column
+ append("<article class='properties filterable'>")
+ append("<h2>Properties</h2>")
+ append("<ul>")
+ for mprop in sorted do
+ if mprop isa MAttributeDef then continue
+ if mprop.mproperty.visibility <= none_visibility then continue
+ append(mprop.html_list_item(mbuilder))
end
-
- close("ul")
- close("article")
+ append("</ul>")
+ append("</article>")
end
-
end
-# Nit Standard Library
-class NitdocMClasses
+# A class page
+class NitdocClass
super NitdocPage
- var mclass: MClass
- var aclassdef: AClassdef
- var stdclassdef: nullable AStdClassdef
- var public_owner: nullable MModule
+ private var mclass: MClass
+ private var mbuilder: ModelBuilder
+ private var nitdoc: Nitdoc
- init with(mclass: MClass, aclassdef: AClassdef) do
+ init(mclass: MClass, nitdoc: Nitdoc, dot_dir: nullable String, source: nullable String) do
self.mclass = mclass
- self.aclassdef = aclassdef
- if aclassdef isa AStdClassdef then self.stdclassdef = aclassdef
- self.public_owner = mclass.intro_mmodule.public_owner
- opt_nodot = false
- destinationdir = ""
+ self.mbuilder = nitdoc.modelbuilder
+ self.nitdoc = nitdoc
+ self.dot_dir = dot_dir
+ self.source = source
end
redef fun head do
super
- add("title").text("{self.mclass.name} class | Nit Standard Library")
+ var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
+ if nclass isa AStdClassdef then
+ append("<title>{mclass.name} class | {nclass.short_comment}</title>")
+ else
+ append("<title>{mclass.name} class</title>")
+ end
end
- redef fun header do
- open("header")
- open("nav").add_class("main")
- open("ul")
- open("li")
- add_html("<a href=\"index.html\">Overview</a>")
- close("li")
- open("li")
+ redef fun menu do
+ append("<li><a href='index.html'>Overview</a></li>")
+ var public_owner = mclass.public_owner
if public_owner is null then
- add_html("<a href=\"{mclass.intro_mmodule.name}.html\">{mclass.intro_mmodule.name}</a>")
+ append("<li>{mclass.intro_mmodule.link(mbuilder)}</li>")
else
- add_html("<a href=\"{public_owner.name}.html\">{public_owner.name}</a>")
- end
- close("li")
- add("li").add_class("current").text(mclass.name)
- open("li")
- add_html("<a href=\"full-index.html\" >Full Index</a>")
- close("li")
- open("li").attr("id", "liGitHub")
- open("a").add_class("btn").attr("id", "logGitHub")
- add("img").attr("id", "imgGitHub").attr("src", "resources/icons/github-icon.png")
- close("a")
- open("div").add_class("popover bottom")
- add("div").add_class("arrow").text(" ")
- open("div").add_class("githubTitle")
- add("h3").text("Github Sign In")
- close("div")
- open("div")
- add("label").attr("id", "lbloginGit").text("Username")
- add("input").attr("id", "loginGit").attr("name", "login").attr("type", "text")
- open("label").attr("id", "logginMessage").text("Hello ")
- open("a").attr("id", "githubAccount")
- add("strong").attr("id", "nickName").text(" ")
- close("a")
- close("label")
- close("div")
- open("div")
- add("label").attr("id", "lbpasswordGit").text("Password")
- add("input").attr("id", "passwordGit").attr("name", "password").attr("type", "password")
- open("div").attr("id", "listBranches")
- add("label").attr("id", "lbBranches").text("Branch")
- add("select").add_class("dropdown").attr("id", "dropBranches").attr("name", "dropBranches").attr("tabindex", "1").text(" ")
- close("div")
- close("div")
- open("div")
- add("label").attr("id", "lbrepositoryGit").text("Repository")
- add("input").attr("id", "repositoryGit").attr("name", "repository").attr("type", "text")
- close("div")
- open("div")
- add("label").attr("id", "lbbranchGit").text("Branch")
- add("input").attr("id", "branchGit").attr("name", "branch").attr("type", "text")
- close("div")
- open("div")
- add("a").attr("id", "signIn").text("Sign In")
- close("div")
- close("div")
- close("li")
- close("ul")
- close("nav")
- close("header")
- end
-
- redef fun body do
- super
- open("div").add_class("page")
- add_content
- close("div")
- add("footer").text("Nit standard library. Version jenkins-component=stdlib-19.")
+ append("<li>{public_owner.link(mbuilder)}</li>")
+ end
+ append("<li class='current'>{mclass.name}</li>")
+ append("<li><a href='full-index.html'>Full Index</a></li>")
end
- # Insert all tags in content part
- fun add_content do
- open("div").add_class("menu")
+ redef fun content do
+ append("<div class='menu'>")
properties_column
- close("div")
- open("div").add_class("content")
- close("div")
+ inheritance_column
+ append("</div>")
+ append("<div class='content'>")
+ class_doc
+ append("</div>")
end
fun properties_column do
- open("nav").add_class("properties filterable")
- add("h3").text("Properties")
+ var sorter = new ComparableSorter[MPropDef]
+ append("<nav class='properties filterable'>")
+ append("<h3>Properties</h3>")
+ # get properties
+ var vtypes = new HashSet[MVirtualTypeDef]
+ var consts = new HashSet[MMethodDef]
+ var meths = new HashSet[MMethodDef]
+ for mclassdef in mclass.mclassdefs do
+ for mpropdef in mclassdef.mpropdefs do
+ if not mbuilder.mpropdef2npropdef.has_key(mpropdef) then continue
+ if mpropdef.mproperty.visibility <= none_visibility then continue
+ if mpropdef isa MVirtualTypeDef then vtypes.add(mpropdef)
+ if mpropdef isa MMethodDef then
+ if mpropdef.mproperty.is_init then
+ consts.add(mpropdef)
+ else
+ meths.add(mpropdef)
+ end
+ end
+ end
+ end
+ for mprop in mclass.inherited_methods do
+ var mpropdef = mprop.intro
+ if not mbuilder.mpropdef2npropdef.has_key(mpropdef) then continue
+ if mprop.visibility <= none_visibility then continue
+ if mprop.intro_mclassdef.mclass.name == "Object" then continue
+ meths.add(mpropdef)
+ end
+ # virtual types
+ if vtypes.length > 0 then
+ var vts = new Array[MVirtualTypeDef]
+ vts.add_all(vtypes)
+ sorter.sort(vts)
+ append("<h4>Virtual Types</h4>")
+ display_mpropdef_list(vts)
+ end
+ if consts.length > 0 then
+ var cts = new Array[MMethodDef]
+ cts.add_all(consts)
+ sorter.sort(cts)
+ append("<h4>Constructors</h4>")
+ display_mpropdef_list(cts)
+ end
+ if meths.length > 0 then
+ var mts = new Array[MMethodDef]
+ mts.add_all(meths)
+ sorter.sort(mts)
+ append("<h4>Methods</h4>")
+ display_mpropdef_list(mts)
+ end
+ append("</nav>")
+ end
- if mclass.virtual_types.length > 0 then
- add("h4").text("Virtual Types")
- open("ul")
- for prop in mclass.virtual_types do
- add_html("<li class=\"redef\"><span title=\"Redefined\">R</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
+ private fun display_mpropdef_list(list: Array[MPropDef]) do
+ append("<ul>")
+ for prop in list do
+ if prop.is_intro and prop.mproperty.intro_mclassdef.mclass != mclass then
+ append("<li class='inherit'>")
+ append("<span title='Inherited'>H</span>")
+ else if prop.is_intro then
+ append("<li class='intro'>")
+ append("<span title='Introduced'>I</span>")
+ else
+ append("<li class='redef'>")
+ append("<span title='Redefined'>R</span>")
end
- close("ul")
+ append(prop.link(mbuilder))
+ append("</li>")
end
- if mclass.constructors.length > 0 then
- add("h4").text("Constructors")
- open("ul")
- for prop in mclass.constructors do
- add_html("<li class=\"intro\"><span title=\"Introduced\">I</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
+ append("</ul>")
+ end
+
+ 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)
+ append("<h4>Superclasses</h4>")
+ append("<ul>")
+ for sup in sorted do
+ if sup == mclass then continue
+ append("<li><a href='{sup.name}.html'>{sup.name}</a></li>")
end
- close("ul")
+ append("</ul>")
end
- add("h4").text("Methods")
- open("ul")
- if mclass.intro_methods.length > 0 then
- for prop in mclass.intro_methods do
- if prop.visibility is public_visibility or prop.visibility is protected_visibility then add_html("<li class=\"intro\"><span title=\"Introduced\">I</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
+
+ if mclass.descendants.length <= 1 then
+ append("<h4>No Known Subclasses</h4>")
+ else if mclass.descendants.length <= 100 then
+ sorted = mclass.descendants.to_a
+ sorterp.sort(sorted)
+ append("<h4>Subclasses</h4>")
+ append("<ul>")
+ for sub in sorted do
+ if sub == mclass then continue
+ append("<li><a href='{sub.name}.html'>{sub.name}</a></li>")
end
+ append("</ul>")
+ else if mclass.children.length <= 100 then
+ sorted = mclass.children.to_a
+ sorterp.sort(sorted)
+ append("<h4>Direct Subclasses Only</h4>")
+ append("<ul>")
+ for sub in sorted do
+ if sub == mclass then continue
+ append("<li><a href='{sub.name}.html'>{sub.name}</a></li>")
+ end
+ append("</ul>")
+ else
+ append("<h4>Too much Subclasses to list</h4>")
end
- if mclass.inherited_methods.length > 0 then
- for prop in mclass.inherited_methods do
- if prop.visibility is public_visibility or prop.visibility is protected_visibility then add_html("<li class=\"inherit\"><span title=\"Inherited\">H</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
+ append("</nav>")
+ end
+
+ fun class_doc do
+ # title
+ append("<h1>{mclass.html_signature}</h1>")
+ append("<div class='subtitle'>")
+ var subtitle = ""
+ if mclass.visibility is none_visibility then subtitle += "private "
+ subtitle += "{mclass.kind} {mclass.public_owner.html_namespace(mbuilder)}::{mclass}"
+ append(subtitle)
+ append("</div>")
+ # comment
+ var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
+ append("<div style=\"float: right;\"><a id=\"lblDiffCommit\"></a></div>")
+ append("<section class='description'>")
+ if nclass isa AStdClassdef and not nclass.comment.is_empty then append("<pre class=\"text_label\" title=\"122\" name=\"\" tag=\"{mclass.mclassdefs.first.location.to_s}\" type=\"2\">{nclass.comment}</pre><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>")
+ process_generate_dot
+ append("</section>")
+ # concerns
+ var sorted = new Array[MModule]
+ sorted.add_all(mclass.concerns.keys)
+ var sorterp = new ComparableSorter[MModule]
+ sorterp.sort(sorted)
+ append("<section class='concerns'>")
+ append("<h2 class='section-header'>Concerns</h2>")
+ append("<ul>")
+ for owner in sorted do
+ var nmodule = mbuilder.mmodule2nmodule[owner]
+ var childs = mclass.concerns[owner]
+ append("<li>")
+ append("<a href=\"#MOD_{owner.name}\">{owner.name}</a>: {nmodule.short_comment}")
+ if not childs is null then
+ append("<ul>")
+ var sortedc = childs.to_a
+ var sorterpc = new ComparableSorter[MModule]
+ sorterpc.sort(sortedc)
+ for child in sortedc do
+ var nchild = mbuilder.mmodule2nmodule[child]
+ append("<li><a href=\"#MOD_{child.name}\">{child.name}</a>: {nchild.short_comment} </li>")
+ end
+ append("</ul>")
end
+ append("</li>")
end
- if mclass.redef_methods.length > 0 then
- for prop in mclass.redef_methods do
- if prop.visibility is public_visibility or prop.visibility is protected_visibility then add_html("<li class=\"redef\"><span title=\"Refined\">R</span><a href=\"{prop.link_anchor}\">{prop.name}</a></li>")
+ append("</ul>")
+ append("</section>")
+ # properties
+ var sorterprop = new ComparableSorter[MProperty]
+ var sorterc = new ComparableSorter[MClass]
+ var lmmodule = new List[MModule]
+ # virtual and formal types
+ if mclass.virtual_types.length > 0 or mclass.arity > 0 then
+ append("<section class='types'>")
+ append("<h2>Formal and Virtual Types</h2>")
+ if mclass.virtual_types.length > 0 then for prop in mclass.virtual_types do description(prop)
+ if mclass.arity > 0 and nclass isa AStdClassdef then
+ for ft, bound in mclass.parameter_types do
+ append("<article id='{ft}'>")
+ append("<h3 class='signature'>{ft}: {bound.link(mbuilder)}</h3>")
+ append("<div class=\"info\">formal generic type</div>")
+ append("</article>")
+ end
end
+ append("</section>")
end
- close("ul")
- close("nav")
+ # constructors
+ if mclass.constructors.length > 0 then
+ var sortedc = mclass.constructors.to_a
+ sorterprop.sort(sortedc)
+ append("<section class='constructors'>")
+ append("<h2 class='section-header'>Constructors</h2>")
+ for prop in sortedc do description(prop)
+ append("</section>")
+ end
+ # methods
+ append("<section class='methods'>")
+ append("<h2 class='section-header'>Methods</h2>")
+ for mmodule, mmethods in mclass.all_methods do
+ var nmodule = mbuilder.mmodule2nmodule[mmodule]
+ append("<a id=\"MOD_{mmodule.name}\"></a>")
+ if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then
+ if mclass.has_mmodule(mmodule) then
+ append("<p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
+ else
+ append("<h3 class=\"concern-toplevel\">Methods refined in {mmodule.link(mbuilder)}</h3><p class=\"concern-doc\">{mmodule.name}: {nmodule.short_comment}</p>")
+ end
+ end
+ var sortedc = mmethods.to_a
+ sorterprop.sort(sortedc)
+ for prop in sortedc do description(prop)
+ end
+ # inherited methods
+ if mclass.inherited_methods.length > 0 then
+ var sortedc = new Array[MClass]
+ sortedc.add_all(mclass.inherited.keys)
+ sorterc.sort(sortedc)
+ append("<h3>Inherited Methods</h3>")
+ for imclass in sortedc do
+ var sortedp = mclass.inherited[imclass].to_a
+ sorterprop.sort(sortedp)
+ append("<p>Defined in {imclass.link(mbuilder)}: ")
+ for method in sortedp do
+ #TODO link to inherited propdef
+ append("<a href=\"\">{method.name}</a>")
+ if method != sortedp.last then append(", ")
+ end
+ append("</p>")
+ end
+ end
+ append("</section>")
end
-end
-
-class NitdocPage
- super HTMLPage
-
- var opt_nodot: Bool
- var destinationdir : String
+ fun description(prop: MProperty) do
+ if not mbuilder.mpropdef2npropdef.has_key(prop.intro) then return
+ var nprop = mbuilder.mpropdef2npropdef[prop.intro]
+ if not nprop isa AMethPropdef then return
+ var classes = new Array[String]
+ if nprop isa AInitPropdef then
+ classes.add("init")
+ else
+ classes.add("fun")
+ end
+ if prop.is_redef then classes.add("redef")
+ if prop.visibility == none_visibility then
+ classes.add("private")
+ else if prop.visibility == protected_visibility then
+ classes.add("protected")
+ else
+ classes.add("public")
+ end
+ append("<article class='{classes.join(" ")}' id='{prop.anchor}'>")
+ var sign = prop.name
+ append("<h3 class='signature'>{prop.name}{nprop.signature}</h3>")
+ append("<div class='info'>")
+ append("{if prop.is_redef then "redef" else ""} fun {prop.intro_mclassdef.namespace(mclass)}::{prop.name}</div><div style=\"float: right;\"><a id=\"lblDiffCommit\"></a>")
+ append("</div>")
+ append("<div class='description'>")
+ if nprop.comment == "" then
+ append("<a class=\"newComment\" title=\"32\" tag=\"\">New Comment</a>")
+ else
+ append("<pre class=\"text_label\" title=\"\" name=\"\" tag=\"\" type=\"1\">{nprop.comment}</pre>")
+ end
+ 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>")
+ append("<p>")
+ if prop.local_class != mclass then
+ var mredef = prop.local_class.intro_mmodule
+ append("inherited from {mredef.link(mbuilder)} ")
+ end
+ #TODO display show code if doc github
+ var mintro = prop.intro_mclassdef.mmodule
+ append("defined by the module {mintro.link(mbuilder)}{if prop.apropdef is null then "" else show_source(prop.apropdef.location)}.")
- redef fun head do
- add("meta").attr("charset", "utf-8")
- add("script").attr("type", "text/javascript").attr("src", "scripts/jquery-1.7.1.min.js")
- add("script").attr("type", "text/javascript").attr("src", "quicksearch-list.js")
- add("script").attr("type", "text/javascript").attr("src", "scripts/js-facilities.js")
- add("link").attr("rel", "stylesheet").attr("href", "styles/main.css").attr("type", "text/css").attr("media", "screen")
+ for parent in mclass.parents do
+ var mparent = parent.intro_mmodule
+ if prop isa MMethod then if parent.constructors.has(prop) then append(" Previously defined by: {mparent.link(mbuilder)} for <a href=\"{parent.name}.html\">{parent.name}</a>.")
+ end
+ append("</p>")
+ append("</div>")
+ append("</article>")
end
- redef fun body do header
- fun header do end
+ fun process_generate_dot do
+ var pe = nitdoc.class_hierarchy[mclass]
+ var cla = new HashSet[MClass]
+ var sm = new HashSet[MClass]
+ var sm2 = new HashSet[MClass]
+ sm.add(mclass)
+ while cla.length + sm.length < 10 and sm.length > 0 do
+ cla.add_all(sm)
+ sm2.clear
+ for x in sm do
+ sm2.add_all(pe.poset[x].direct_smallers)
+ end
+ var t = sm
+ sm = sm2
+ sm2 = t
+ end
+ cla.add_all(pe.greaters)
- # Generate a clickable graphviz image using a dot content
- fun generate_dot(dot: String, name: String, alt: String) do
- if opt_nodot then return
- var file = new OFStream.open("{self.destinationdir}/{name}.dot")
- file.write(dot)
- file.close
- sys.system("\{ test -f {self.destinationdir}/{name}.png && test -f {self.destinationdir}/{name}.s.dot && diff {self.destinationdir}/{name}.dot {self.destinationdir}/{name}.s.dot >/dev/null 2>&1 ; \} || \{ cp {self.destinationdir}/{name}.dot {self.destinationdir}/{name}.s.dot && dot -Tpng -o{self.destinationdir}/{name}.png -Tcmapx -o{self.destinationdir}/{name}.map {self.destinationdir}/{name}.s.dot ; \}")
- open("article").add_class("graph")
- add("img").attr("src", "{name}.png").attr("usemap", "#{name}").attr("style", "margin:auto").attr("alt", "{alt}")
- close("article")
- var fmap = new IFStream.open("{self.destinationdir}/{name}.map")
- add_html(fmap.read_all)
- fmap.close
+ var op = new Buffer
+ var name = "dep_{mclass.name}"
+ 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 c in cla do
+ if c == mclass then
+ op.append("\"{c.name}\"[shape=box,margin=0.03];\n")
+ else
+ op.append("\"{c.name}\"[URL=\"{c.name}.html\"];\n")
+ end
+ for c2 in pe.poset[c].direct_greaters do
+ if not cla.has(c2) then continue
+ op.append("\"{c.name}\"->\"{c2.name}\";\n")
+ end
+ if not pe.poset[c].direct_smallers.is_empty then
+ var others = true
+ for c2 in pe.poset[c].direct_smallers do
+ if cla.has(c2) then others = false
+ end
+ if others then
+ op.append("\"{c.name}...\"[label=\"\"];\n")
+ op.append("\"{c.name}...\"->\"{c.name}\"[style=dotted];\n")
+ end
+ end
+ end
+ op.append("\}\n")
+ generate_dot(op.to_s, name, "Dependency graph for class {mclass.name}")
end
-
end
redef class AModule
private fun comment: String do
- var ret = ""
+ 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 ""
for t in n_moduledecl.n_doc.n_comment do
- ret += "{t.text.replace("# ", "")}"
+ ret.append(t.text.substring_from(1))
end
- return ret
+ return ret.to_s.html_escape
end
private fun short_comment: String do
- var ret = ""
+ var ret = new Buffer
if n_moduledecl != null and n_moduledecl.n_doc != null then
- var txt = n_moduledecl.n_doc.n_comment.first.text
- txt = txt.replace("# ", "")
- txt = txt.replace("\n", "")
- ret += txt
+ ret.append(n_moduledecl.n_doc.n_comment.first.text.substring_from(2).replace("\n", ""))
end
- return ret
+ return ret.to_s.html_escape
end
end
redef class MModule
-
- var amodule: nullable AModule
+ super Comparable
+ redef type OTHER: MModule
+ redef fun <(other: OTHER): Bool do return self.name < other.name
# Get the list of all methods in a module
fun imported_methods: Set[MMethod] do
end
return methods
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>"
+ end
+
+ # Return the module signature decorated with html
+ fun html_signature(mbuilder: ModelBuilder): String do
+ return "<span>module {html_namespace(mbuilder)}</span>"
+ end
+
+ # Return the module namespace decorated with html
+ fun html_namespace(mbuilder: ModelBuilder): String do
+ var res = new Buffer
+ res.append("<span>")
+ var mowner = public_owner
+ if mowner != null then
+ res.append(public_owner.html_namespace(mbuilder))
+ res.append("::")
+ end
+ res.append(self.link(mbuilder))
+ res.append("</span>")
+ return res.to_s
+ end
+
+ # 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>")
+ return res.to_s
+ end
+end
+redef class MPropDef
+ super Comparable
+ redef type OTHER: MPropDef
+ redef fun <(other: OTHER): Bool do return self.mproperty.name < other.mproperty.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>"
+ else
+ return "<a href=\"{mclassdef.mclass.name}.html#{mproperty.anchor}\">{mproperty.name}</a>"
+ end
+ end
+
+ # Return a list item for the mpropdef
+ fun html_list_item(mbuilder: ModelBuilder): String do
+ 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("</li>")
+ else
+ res.append("<li class='redef'>")
+ res.append("<span title='redefinition'>R</span> {link(mbuilder)} ({mclassdef.mclass.name})")
+ res.append("</li>")
+ end
+ return res.to_s
+ end
end
redef class MProperty
+ super Comparable
+ redef type OTHER: MProperty
+ redef fun <(other: OTHER): Bool do return self.name < other.name
var is_redef: Bool
var apropdef: nullable APropdef
return classdef.mclass
end
- fun class_text: String do
- return local_class.name
- end
-
- fun link_anchor: String do
- return "{class_text}.html#{anchor}"
- end
-
fun anchor: String do
return "PROP_{c_name}"
end
+ # Escape name for html output
+ redef fun name do return super.html_escape
end
redef class MClass
+ super Comparable
+ redef type OTHER: MClass
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+
+ # Add type parameters
+ fun html_signature: String do
+ if arity > 0 then
+ return "{name}[{intro.parameter_names.join(", ")}]"
+ else
+ return name
+ end
+ end
+
+ # Return a link (html a tag) to the nitdoc class page
+ fun link(mbuilder: ModelBuilder): String do
+ 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>"
+ else
+ return "<a href='{name}.html'>{html_signature}</a>"
+ end
+ else
+ return "<a href='{name}.html'>{html_signature}</a>"
+ end
+ end
# Associate all MMethods to each MModule concerns
fun all_methods: HashMap[MModule, Set[MMethod]] do
return hm
end
+ fun public_owner: MModule do
+ var owner = intro_mmodule
+ if owner.public_owner is null then
+ return owner
+ else
+ return owner.public_owner.as(not null)
+ end
+ end
+
+ # Associate MClass to all MMethod include in 'inherited_methods'
+ fun inherited: HashMap[MClass, Set[MMethod]] do
+ var hm = new HashMap[MClass, Set[MMethod]]
+ for method in inherited_methods do
+ var mclass = method.intro_mclassdef.mclass
+ if not hm.has_key(mclass) then hm[mclass] = new HashSet[MMethod]
+ hm[mclass].add(method)
+ end
+ return hm
+ end
+
+ # Return true if MModule concern contain subMModule
+ fun has_mmodule(sub: MModule): Bool do
+ for mmodule, childs in concerns do
+ if childs is null then continue
+ if childs.has(sub) then return true
+ end
+ return false
+ end
+
+ fun mmethod(mprop2npropdef: Map[MProperty, APropdef]) do
+ for const in constructors do
+ if mprop2npropdef.has_key(const)then
+ const.apropdef = mprop2npropdef[const].as(AMethPropdef)
+ end
+ end
+
+ for intro in intro_methods do
+ if mprop2npropdef.has_key(intro)then
+ if mprop2npropdef[intro] isa AMethPropdef then intro.apropdef = mprop2npropdef[intro].as(AMethPropdef)
+ end
+ end
+
+ for rd in redef_methods do
+ if mprop2npropdef.has_key(rd)then
+ if mprop2npropdef[rd] isa AMethPropdef then rd.apropdef = mprop2npropdef[rd].as(AMethPropdef)
+ end
+ end
+ end
+
+ fun link_anchor: String do
+ return "{name}.html"
+ end
+
+ # Escape name for html output
+ redef fun name do return super.html_escape
+end
+
+redef class AStdClassdef
+ private fun comment: String do
+ var ret = new Buffer
+ if n_doc != null then
+ for t in n_doc.n_comment do ret.append(t.text.substring_from(1))
+ end
+ return ret.to_s.html_escape
+ end
+
+ private fun short_comment: String do
+ var ret = new Buffer
+ if n_doc != null then ret.append(n_doc.n_comment.first.text.substring_from(2).replace("\n", ""))
+ return ret.to_s.html_escape
+ end
+end
+
+redef class ASignature
+ redef fun to_s do
+ #TODO closures
+ var ret = ""
+ if not n_params.is_empty then
+ ret = "{ret}({n_params.join(", ")})"
+ end
+ if n_type != null and n_type.to_s != "" then ret += ": {n_type.to_s}"
+ return ret
+ end
+end
+
+redef class AParam
+ redef fun to_s do
+ var ret = "{n_id.text}"
+ if n_type != null then
+ ret = "{ret}: {n_type.to_s}"
+ if n_dotdotdot != null then ret = "{ret}..."
+ end
+ return ret
+ end
+end
+
+redef class MType
+ fun link(mbuilder: ModelBuilder): String is abstract
+end
+
+redef class MClassType
+ redef fun link(mbuilder) do return mclass.link(mbuilder)
+end
+
+redef class MNullableType
+ redef fun link(mbuilder) do return "nullable {mtype.link(mbuilder)}"
+end
+
+redef class AType
+ fun link: 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
+
+redef class APropdef
+ private fun short_comment: String is abstract
+ private fun signature: String is abstract
+ private fun comment: String is abstract
+end
+
+redef class AAttrPropdef
+ redef fun short_comment do
+ var ret = new Buffer
+ if n_doc != null then ret.append(n_doc.n_comment.first.text.substring_from(1))
+ return ret.to_s.html_escape
+ end
+end
+
+redef class AMethPropdef
+ redef fun short_comment do
+ var ret = new Buffer
+ if n_doc != null then ret.append(n_doc.n_comment.first.text.substring_from(2).replace("\n", ""))
+ return ret.to_s.html_escape
+ end
+
+ redef fun signature: String do
+ var sign = ""
+ if n_signature != null then sign = "{n_signature.to_s}"
+ return sign
+ end
+
+ redef private fun comment: String do
+ var ret = new Buffer
+ if n_doc != null then
+ for t in n_doc.n_comment do ret.append(t.text.substring_from(1))
+ end
+ return ret.to_s.html_escape
+ end
+end
+
+redef class MClassDef
+ private fun namespace(mclass: MClass): String do
+
+ if mmodule.public_owner is null then
+ return "{mmodule.full_name}::{mclass.name}"
+ else if mclass is self.mclass then
+ return "{mmodule.public_owner.name}::{mclass.name}"
+ else
+ return "{mmodule.public_owner.name}::<a href=\"{mclass.name}.html\">{mclass.name}</a>"
+ end
+ end
+end
+
+redef class Set[E]
+ fun last: E do
+ return to_a[length-1]
+ end
end
# Create a tool context to handle options and paths
var toolcontext = new ToolContext
-toolcontext.process_options
# Here we launch the nit index
var nitdoc = new Nitdoc(toolcontext)
nitlanguage / nit.git / blobdiff