X-Git-Url: http://nitlanguage.org diff --git a/src/ni_nitdoc.nit b/src/ni_nitdoc.nit index 048af66..f4e54cd 100644 --- a/src/ni_nitdoc.nit +++ b/src/ni_nitdoc.nit @@ -18,16 +18,17 @@ module ni_nitdoc 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") @@ -61,16 +62,17 @@ class Nitdoc 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 @@ -78,13 +80,13 @@ class Nitdoc 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 @@ -99,50 +101,52 @@ class Nitdoc 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 modules classes - quicksearch_list + #quicksearch_list end end fun overview do - var overviewpage = new NitdocOverview.with(modelbuilder, 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(self) + fullindex.save("{output_dir.to_s}/full-index.html") end fun modules do for mmodule in model.mmodules do - var modulepage = new NitdocModules.with(mmodule, modelbuilder) - modulepage.save("{destinationdir.to_s}/{mmodule.name}.html") + var modulepage = new NitdocModule(mmodule, modelbuilder, dot_dir) + modulepage.save("{output_dir.to_s}/{mmodule.url}") end end fun classes do for mclass in modelbuilder.model.mclasses do - var classpage = new NitdocMClasses.with(mclass, modelbuilder, source) - classpage.save("{destinationdir.to_s}/{mclass.name}.html") + 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 - var file = new OFStream.open("{destinationdir.to_s}/quicksearch-list.js") + 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.link_anchor}\" \}") + content.append("\{txt: \"{propdef.mproperty.full_name}\", url:\"{propdef.url}\" \}") if not propdef is prop.mpropdefs.last then content.append(", ") end content.append("]") @@ -152,7 +156,7 @@ class Nitdoc 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}\" \}") + content.append("\{txt: \"{mclassdef.mclass.full_name}\", url:\"{mclass.url}\" \}") if not mclassdef is mclass.mclassdefs.last then content.append(", ") end content.append("]") @@ -166,116 +170,196 @@ class Nitdoc end +# 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("") + append("") + append("") + append("") + append("") + end + + fun menu is abstract + + fun header do + append("
") + append("") + append("
") + end + + fun content is abstract + + fun footer do + append("") + 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("
") + append("{alt}") + append("
") + 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 " (show code)" + end + end + + # Render the page as a html string + fun render: String do + append("") + append("") + head + append("") + append("") + header + append("
") + content + append("
") + footer + append("") + return html.to_s + end + + # 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] - var mbuilder: ModelBuilder - - # 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(mbuilder: ModelBuilder, opt_nodot: Bool, destination: String) do + init(mbuilder: ModelBuilder, dot_dir: nullable String) do self.mbuilder = mbuilder - self.opt_nodot = opt_nodot - self.destinationdir = destination + 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("Full Index") - 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("

Documentation for the standard library of Nit
Version jenkins-component=stdlib-19
Date: TODAY

") - 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("Overview | Nit Standard Library") end - fun add_modules do - var mmodules = list_mmodules - var sorted = new Array[MModule].from(mmodules) - var sorter = new ComparableSorter[MModule] - sorter.sort(sorted) - for mmodule in sorted do + redef fun menu do + append("
  • Overview
  • ") + append("
  • Full Index
  • ") + end + + redef fun content do + append("
    ") + append("

    Nit Standard Library

    ") + append("

    Documentation for the standard library of Nit
    Version jenkins-component=stdlib-19
    Date: TODAY

    ") + append("
    ") + # module list + append("

    Modules

    ") + append("") + # module graph + process_generate_dot + append("
    ") + append("
    ") 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 mmodule in list_mmodules do - op.append("\"{mmodule.name}\"[URL=\"{mmodule.name}.html\"];\n") + for mmodule in mmodules do + op.append("\"{mmodule.name}\"[URL=\"{mmodule.url}\"];\n") for imported in mmodule.in_importation.direct_greaters do if imported.direct_owner == null then op.append("\"{mmodule.name}\"->\"{imported.name}\";\n") @@ -285,340 +369,192 @@ class NitdocOverview op.append("\}\n") generate_dot(op.to_s, "dep", "Modules hierarchy") end - - private fun list_mmodules: Set[MModule] do - 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 - return mmodules - end - end +# The full index page class NitdocFullindex super NitdocPage - var mmodules: Array[MModule] + private var nitdoc: Nitdoc - init with(mmodules: Array[MModule]) do - self.mmodules = mmodules - opt_nodot = false - destinationdir = "" + init(nitdoc: Nitdoc) do + self.nitdoc = nitdoc + 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("Overview") - 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("Full Index | Nit Standard Library") end - fun add_content do + redef fun menu do + append("
  • Overview
  • ") + append("
  • Full Index
  • ") + end + + redef fun content do + append("
    ") + append("

    Full Index

    ") module_column classes_column properties_column + append("
    ") end # Add to content modules column fun module_column do - var ls = new List[nullable MModule] - var sorted = mmodules - var sorterp = new ComparableSorter[MModule] - sorterp.sort(sorted) - open("article").add_class("modules filterable") - add("h2").text("Modules") - open("ul") + var sorter = new ComparableSorter[MModule] + var sorted = new Array[MModule] + for mmodule in nitdoc.modelbuilder.model.mmodule_importation_hierarchy do + sorted.add(mmodule) + end + sorter.sort(sorted) + append("
    ") + append("

    Modules

    ") + append("") + append("
    ") end # Add to content classes modules fun classes_column do - var sorted = mmodules.first.imported_mclasses.to_a - var sorterp = new ComparableSorter[MClass] - sorterp.sort(sorted) - open("article").add_class("classes filterable") - add("h2").text("Classes") - open("ul") - + var sorted = nitdoc.modelbuilder.model.mclasses + var sorter = new ComparableSorter[MClass] + sorter.sort(sorted) + append("
    ") + append("

    Classes

    ") + append("") + append("
    ") end # Insert the properties column of fullindex page fun properties_column do - open("article").add_class("properties filterable") - add("h2").text("Properties") - open("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") - end - - 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") + var sorted = nitdoc.modelbuilder.model.mproperties + var sorter = new ComparableSorter[MProperty] + sorter.sort(sorted) + append("
    ") + append("

    Properties

    ") + append("") + append("
    ") end end -class NitdocModules +# A module page +class NitdocModule super NitdocPage - var mmodule: MModule - var mbuilder: ModelBuilder + private var mmodule: MModule + private var mbuilder: ModelBuilder - init with(mmodule: MModule, mbuilder: ModelBuilder) do + init(mmodule: MModule, mbuilder: ModelBuilder, dot_dir: nullable String) do self.mmodule = mmodule self.mbuilder = mbuilder - opt_nodot = false - destinationdir = "" + self.dot_dir = dot_dir end redef fun head do super var amodule = mbuilder.mmodule2nmodule[mmodule] - add("title").text("{mmodule.name} module | {amodule.short_comment}") - end - - redef fun header do - open("header") - open("nav").add_class("main") - open("ul") - open("li") - add_html("Overview") - close("li") - add("li").add_class("current").text(mmodule.name) - open("li") - add_html("Full Index") - 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.") + append("{mmodule.name} module | {amodule.short_comment}") end - # Insert all tags in content part - fun add_content do - open("div").add_class("content") - add("h1").text(mmodule.name) - add("div").add_class("subtitle").text("module {mmodule.name}") - module_comment + redef fun menu do + append("
  • Overview
  • ") + append("
  • {mmodule.name}
  • ") + append("
  • Full Index
  • ") + end + + redef fun content do + sidebar + append("
    ") + append("

    {mmodule.name}

    ") + append("
    {mmodule.html_signature(mbuilder)}
    ") + append(mmodule.html_full_comment(mbuilder)) + process_generate_dot classes properties - close("div") + append("
    ") end - # Insert module comment in the content - fun module_comment do - var amodule = mbuilder.mmodule2nmodule[mmodule] - 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") + 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.url}\"];\n") + end + end + 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 menu do + fun sidebar do var amodule = mbuilder.mmodule2nmodule[mmodule] - open("div").add_class("menu") - open("nav") - add("h3").text("Module Hierarchy").attr("style","cursor: pointer;") - if mmodule.in_importation.greaters.length > 0 then - add_html("

    All dependencies

    ") - end - if mmodule.in_importation.smallers.length > 0 then - add_html("

    All clients

    ") + append("") end + private fun display_module_list(list: Array[MModule]) do + append("") + end + + # display the class column fun classes do var amodule = mbuilder.mmodule2nmodule[mmodule] var intro_mclasses = mmodule.intro_mclasses @@ -635,28 +571,29 @@ class NitdocModules sorted.add_all(all_mclasses) var sorter = new ComparableSorter[MClass] sorter.sort(sorted) - open("div").add_class("module") - open("article").add_class("classes filterable") - add("h2").text("Classes") - open("ul") + append("
    ") + append("
    ") + append("

    Classes

    ") + append("") + append("
    ") + append("
    ") end + # display the property column fun properties do + # get properties var amodule = mbuilder.mmodule2nmodule[mmodule] var mpropdefs = new HashSet[MPropDef] for m in mmodule.in_nesting.greaters do @@ -666,444 +603,404 @@ class NitdocModules var sorted = mpropdefs.to_a var sorter = new ComparableSorter[MPropDef] sorter.sort(sorted) - open("article").add_class("properties filterable") - add_html("

    Properties

    ") - open("ul") - for p in sorted do - if p.mproperty.visibility <= none_visibility then continue - if p.is_intro then - open("li").add_class("intro") - add("span").attr("title", "introduction").text("I") - else - open("li").add_class("redef") - add("span").attr("title", "redefinition").text("R") - end - add_html(" ") - add("a").attr("href", "{p.mclassdef.mclass.name}.html").attr("title", "").text("{p.mproperty.name} ({p.mclassdef.mclass.name})") - close("li") + # display properties in one column + append("
    ") + append("

    Properties

    ") + append("") + append("
    ") end end -# Nit Standard Library -class NitdocMClasses +# A class page +class NitdocClass super NitdocPage - var mclass: MClass - var mbuilder: ModelBuilder + 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 with(mclass: MClass, mbuilder: ModelBuilder, source: nullable String) do + init(mclass: MClass, nitdoc: Nitdoc, dot_dir: nullable String, source: nullable String) do self.mclass = mclass - self.mbuilder = mbuilder - self.opt_nodot = false - self.destinationdir = "" + self.mbuilder = nitdoc.modelbuilder + self.nitdoc = nitdoc + 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 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 + # get inherited properties + for mprop in mclass.inherited_mproperties do + var mpropdef = mprop.intro + if mprop.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 + inherited.add(mpropdef) + end end redef fun head do super var nclass = mbuilder.mclassdef2nclassdef[mclass.intro] if nclass isa AStdClassdef then - add("title").text("{mclass.name} class | {nclass.short_comment}") + append("{mclass.name} class | {nclass.short_comment}") else - add("title").text("{mclass.name} class") + append("{mclass.name} class") end end - redef fun header do - open("header") - open("nav").add_class("main") - open("ul") - open("li") - add_html("Overview") - close("li") - open("li") + redef fun menu do + append("
  • Overview
  • ") var public_owner = mclass.public_owner if public_owner is null then - add_html("{mclass.intro_mmodule.name}") + append("
  • {mclass.intro_mmodule.link(mbuilder)}
  • ") else - add_html("{public_owner.name}") - end - close("li") - add("li").add_class("current").text(mclass.name) - open("li") - add_html("Full Index") - 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("
  • {public_owner.link(mbuilder)}
  • ") + end + append("
  • {mclass.name}
  • ") + append("
  • Full Index
  • ") end - # Insert all tags in content part - fun add_content do - open("div").add_class("menu") + redef fun content do + append("") + append("
    ") + class_doc + append("
    ") end fun properties_column do - var sorted = new Array[MProperty] - var sorter = new ComparableSorter[MProperty] - open("nav").add_class("properties filterable") - add("h3").text("Properties") - - if mclass.virtual_types.length > 0 then - add("h4").text("Virtual Types") - open("ul") - sorted = mclass.virtual_types.to_a - sorter.sort(sorted) - for prop in sorted do - add_html("
  • R{prop.name}
  • ") + var sorter = new ComparableSorter[MPropDef] + append("") end fun inheritance_column do var sorted = new Array[MClass] var sorterp = new ComparableSorter[MClass] - open("nav") - add("h3").text("Inheritance") - if mclass.parents.length > 0 then - sorted = mclass.parents.to_a + append("") end - fun content do + fun class_doc do + # title + append("

    {mclass.html_signature}

    ") + append("
    {mclass.html_full_signature(mbuilder)}") + + append("
    ") + # comment var nclass = mbuilder.mclassdef2nclassdef[mclass.intro] + append("
    ") + append("
    ") + if nclass isa AStdClassdef and not nclass.comment.is_empty then append("
    {nclass.comment}
    CancelCommit
    ")
    +		process_generate_dot
    +		append("
    ") + # concerns + var concern2meths = new ArrayMap[MModule, Array[MMethodDef]] + var sorted_meths = new Array[MMethodDef] var sorted = new Array[MModule] - sorted.add_all(mclass.concerns.keys) - var sorterp = new ComparableSorter[MModule] + sorted_meths.add_all(meths) + nitdoc.mainmodule.linearize_mpropdefs(sorted_meths) + for meth in meths do + if inherited.has(meth) then continue + var mmodule = meth.mclassdef.mmodule + if not concern2meths.has_key(mmodule) then + sorted.add(mmodule) + concern2meths[mmodule] = new Array[MMethodDef] + end + concern2meths[mmodule].add(meth) + end + var sections = new ArrayMap[MModule, Array[MModule]] + for mmodule in concern2meths.keys do + var owner = mmodule.public_owner + if owner == null then owner = mmodule + if not sections.has_key(owner) then sections[owner] = new Array[MModule] + if owner != mmodule then sections[owner].add(mmodule) + end + append("
    ") + append("

    Concerns

    ") + append("") + append("
    ") + # properties + var prop_sorter = new ComparableSorter[MPropDef] var sorterprop = new ComparableSorter[MProperty] var sorterc = new ComparableSorter[MClass] - sorterp.sort(sorted) - var subtitle = "" var lmmodule = new List[MModule] - # Insert the subtitle part - add("h1").text(mclass.name) - open("div").add_class("subtitle") - if mclass.visibility is none_visibility then subtitle += "private " - subtitle += "{mclass.kind} {mclass.public_owner.name}::{mclass.name}" - add_html(subtitle) - close("div") - add_html("
    ") - # We add the class description - open("section").add_class("description") - if nclass isa AStdClassdef and not nclass.comment.is_empty then add_html("
    {nclass.comment} 
    CancelCommit
    ")
    -		close("section")
    -		open("section").add_class("concerns")
    -		add("h2").add_class("section-header").text("Concerns")
    -		open("ul")
    -		for owner in sorted do
    -			var nmodule = mbuilder.mmodule2nmodule[owner]
    -			var childs = mclass.concerns[owner]
    -			open("li")
    -			add_html("{owner.name}: {nmodule.short_comment}")
    -			if not childs is null then
    -				open("ul")
    -				var sortedc = childs.to_a
    -				var sorterpc = new ComparableSorter[MModule]
    -				sorterpc.sort(sortedc)
    -				for child in sortedc do
    -					var nchild = mbuilder.mmodule2nmodule[child]
    -					add_html("
  • {child.name}: {nchild.short_comment}
  • ") - end - close("ul") - end - close("li") - end - close("ul") - close("section") - # Insert virtual types if there is almost one - if mclass.virtual_types.length > 0 or mclass.arity > 0 then - open("section").add_class("types") - add("h2").text("Formal and Virtual Types") - if mclass.virtual_types.length > 0 then for prop in mclass.virtual_types do description(prop) + # virtual and formal types + var local_vtypes = new Array[MVirtualTypeDef] + for vt in vtypes do if not inherited.has(vt) then local_vtypes.add(vt) + if local_vtypes.length > 0 or mclass.arity > 0 then + append("
    ") + append("

    Formal and Virtual Types

    ") + # formal types if mclass.arity > 0 and nclass isa AStdClassdef then - for prop in nclass.n_formaldefs do - open("article").attr("id", "FT_Object_{prop.collect_text}") - open("h3").add_class("signature").text("{prop.collect_text}: nullable ") - add_html("Object") - close("h3") - add_html("
    formal generic type
    ") - close("article") + for ft, bound in mclass.parameter_types do + append("
    ") + append("

    {ft}: {bound.link(mbuilder)}

    ") + append("
    formal generic type
    ") + append("
    ") end end - close("section") - end - # Insert constructors if there is almost one - if mclass.constructors.length > 0 then - var sortedc = mclass.constructors.to_a - sorterprop.sort(sortedc) - open("section").add_class("constructors") - add("h2").add_class("section-header").text("Constructors") - for prop in sortedc do description(prop) - close("section") - end - open("section").add_class("methods") - add("h2").add_class("section-header").text("Methods") - for mmodule, mmethods in mclass.all_methods do - var nmodule = mbuilder.mmodule2nmodule[mmodule] - add_html("") - if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then - if mclass.has_mmodule(mmodule) then - add_html("

    {mmodule.name}: {nmodule.short_comment}

    ") - else - add_html("

    Methods refined in {mmodule.name}

    {mmodule.name}: {nmodule.short_comment}

    ") + # virtual types + prop_sorter.sort(local_vtypes) + for prop in local_vtypes do append(prop.html_full_desc(self)) + append("
    ") + end + # constructors + var local_consts = new Array[MMethodDef] + for const in consts do if not inherited.has(const) then local_consts.add(const) + prop_sorter.sort(local_consts) + if local_consts.length > 0 then + append("
    ") + append("

    Constructors

    ") + for prop in local_consts do append(prop.html_full_desc(self)) + append("
    ") + end + # methods + if not concern2meths.is_empty then + append("
    ") + append("

    Methods

    ") + for owner, mmodules in sections do + append("") + if owner != mclass.intro_mmodule and owner != mclass.public_owner then + var nowner = mbuilder.mmodule2nmodule[owner] + append("

    Methods refined in {owner.link(mbuilder)}

    ") + if nowner.short_comment.is_empty then + append("

    {owner.name}

    ") + else + append("

    {owner.name}: {nowner.short_comment}

    ") + end + end + if concern2meths.has_key(owner) then + var mmethods = concern2meths[owner] + prop_sorter.sort(mmethods) + for prop in mmethods do append(prop.html_full_desc(self)) + end + for mmodule in mmodules do + append("") + var nmodule = mbuilder.mmodule2nmodule[mmodule] + if mmodule != mclass.intro_mmodule and mmodule != mclass.public_owner then + if nmodule.short_comment.is_empty then + append("

    {mmodule.name}

    ") + else + append("

    {mmodule.name}: {nmodule.short_comment}

    ") + end + end + var mmethods = concern2meths[mmodule] + prop_sorter.sort(mmethods) + for prop in mmethods do append(prop.html_full_desc(self)) end end - var sortedc = mmethods.to_a - sorterprop.sort(sortedc) - for prop in sortedc do description(prop) - end - # Insert inherited methods - if mclass.inherited_methods.length > 0 then - var sortedc = new Array[MClass] - sortedc.add_all(mclass.inherited.keys) - sorterc.sort(sortedc) - add("h3").text("Inherited Methods") - for i_mclass in sortedc do - var sortedp = mclass.inherited[i_mclass].to_a - sorterprop.sort(sortedp) - open("p") - add_html("Defined in {i_mclass.name}: ") - for method in sortedp do - add_html("{method.name}") - if method != sortedp.last then add_html(", ") + end + # inherited properties + if inherited.length > 0 then + var sorted_inherited = new Array[MPropDef] + sorted_inherited.add_all(inherited) + nitdoc.mainmodule.linearize_mpropdefs(sorted_inherited) + var classes = new ArrayMap[MClass, Array[MPropDef]] + for mmethod in sorted_inherited.reversed do + var mclass = mmethod.mclassdef.mclass + if not classes.has_key(mclass) then classes[mclass] = new Array[MPropDef] + classes[mclass].add(mmethod) + end + append("

    Inherited Properties

    ") + for c, mmethods in classes do + prop_sorter.sort(mmethods) + append("

    Defined in {c.link(mbuilder)}: ") + for i in [0..mmethods.length[ do + var mmethod = mmethods[i] + append(mmethod.link(mbuilder)) + if i <= mmethods.length - 1 then append(", ") end - close("p") + append("

    ") end end - close("section") + append("
    ") end - # Insert description tags for 'prop' - fun description(prop: MProperty) do - open("article").add_class("fun public {if prop.is_redef then "redef" else ""}").attr("id", "{prop.anchor}") - var sign = prop.name - if prop.apropdef != null then sign += prop.apropdef.signature - add_html("

    {sign}

    ") - add_html("
    {if prop.is_redef then "redef" else ""} fun {prop.intro_mclassdef.namespace(mclass)}::{prop.name}
    ") - - open("div").add_class("description") - if prop.apropdef is null or prop.apropdef.comment == "" then - add_html("New Comment") - else - add_html("
    {prop.apropdef.comment}
    ") - end - add_html("CancelCommit
    ")
    -		open("p")
    -		if prop.local_class != mclass then add_html("inherited from {prop.local_class.intro_mmodule.name} ")
    -		#TODO display show code if doc github
    -		add_html("defined by the module {prop.intro_mclassdef.mmodule.name} {if prop.apropdef is null then "" else show_source(prop.apropdef.location)}.")
    -
    -		for parent in mclass.parents do
    -			if prop isa MMethod then if parent.constructors.has(prop) then add_html(" Previously defined by: {parent.intro_mmodule.name} for {parent.name}.")
    +	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
    -		close("p")
    -		close("div")
    -
    -		close("article")
    -	end
    -
    -end	
    -
    -class NitdocPage
    -	super HTMLPage
    -	
    -	var opt_nodot: Bool
    -	var destinationdir : String
    -	var source: nullable String
    -
    -	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")
    -	end
    -
    -	redef fun body do header
    -	fun header do end
    -
    -	# 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
    -	end
    +		cla.add_all(pe.greaters)
     
    -	# Add a (source) link fo 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 " (show code)"
    +		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.url}\"];\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 = ""
    -		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
    -			var txt = t.text
    -			txt = txt.replace("# ", "")
    -			txt = txt.replace("#", "")
    -			ret += txt
    -		end
    -		return ret
    -	end
    -
    -	private fun short_comment: String do
    -		var ret = ""
    -		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
    -		end
    -		return ret
    -	end
    -end
    +#
    +# Model redefs
    +#
     
     redef class MModule
    -
     	super Comparable
     	redef type OTHER: MModule
     	redef fun <(other: OTHER): Bool do return self.name < other.name
     
    -	var amodule: nullable AModule
    -
     	# Get the list of all methods in a module
     	fun imported_methods: Set[MMethod] do
     		var methods = new HashSet[MMethod]
    @@ -1125,279 +1022,549 @@ redef class MModule
     		end
     		return methods
     	end
    -end
    -redef class MPropDef
    -	super Comparable
    -	redef type OTHER: MPropDef
    -	redef fun <(other: OTHER): Bool do return self.mproperty.name < other.mproperty.name
    -end
     
    -redef class MProperty
    +	# URL to nitdoc page
    +	fun url: String do
    +		var res = new Buffer
    +		res.append("module_")
    +		var mowner = public_owner
    +		if mowner != null then
    +			res.append("{public_owner.name}_")
    +		end
    +		res.append("{self.name}.html")
    +		return res.to_s
    +	end
    +
    +	# html anchor id to the module in a nitdoc page
    +	fun anchor: String do
    +		var res = new Buffer
    +		res.append("MOD_")
    +		var mowner = public_owner
    +		if mowner != null then
    +			res.append("{public_owner.name}_")
    +		end
    +		res.append(self.name)
    +		return res.to_s
    +	end
    +
    +	# Return a link (html a tag) to the nitdoc module page
    +	fun link(mbuilder: ModelBuilder): String do
    +		return "{name}"
    +	end
    +
    +	# Return the module signature decorated with html
    +	fun html_signature(mbuilder: ModelBuilder): String do
    +		return "module {html_full_namespace(mbuilder)}"
    +	end
    +
    +	# Return the module full namespace decorated with html
    +	fun html_full_namespace(mbuilder: ModelBuilder): String do
    +		var res = new Buffer
    +		res.append("")
    +		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("")
    +		return res.to_s
    +	end
    +
    +	# Return the module full namespace decorated with html
    +	fun html_namespace(mbuilder: ModelBuilder): String do
    +		var res = new Buffer
    +		res.append("")
    +		var mowner = public_owner
    +		if mowner != null then
    +			res.append(public_owner.html_namespace(mbuilder))
    +		else
    +			res.append(self.link(mbuilder))
    +		end
    +		res.append("")
    +		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("
    ") + res.append("
    {mbuilder.mmodule2nmodule[self].comment}
    ") + res.append("") + res.append("Cancel") + res.append("Commit") + res.append("
    ")
    +		res.append("
    ") + return res.to_s + end +end +redef class MClass super Comparable - redef type OTHER: MProperty + redef type OTHER: MClass redef fun <(other: OTHER): Bool do return self.name < other.name - var is_redef: Bool - var apropdef: nullable APropdef + # 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 + res.append("{kind} {html_namespace(mbuilder)}") + return res.to_s + end - redef init(intro_mclassdef: MClassDef, name: String, visibility: MVisibility) - do - super - is_redef = false + # 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 "{html_signature}" + else + return "{html_signature}" + end + else + return "{html_signature}" + end end - fun local_class: MClass do - var classdef = self.intro_mclassdef - return classdef.mclass + # Return the class namespace decorated with html + fun html_namespace(mbuilder: ModelBuilder): String do + var res = new Buffer + res.append(intro_mmodule.html_namespace(mbuilder)) + res.append("::{self.link(mbuilder)}") + return res.to_s end - fun class_text: String do - return local_class.name + fun url: String do + return "class_{public_owner}_{c_name}.html" end - fun link_anchor: String do - return "{class_text}.html#{anchor}" + # Escape name for html output + redef fun name do return super.html_escape +end + +redef class MProperty + super Comparable + redef type OTHER: MProperty + redef fun <(other: OTHER): Bool do return self.name < other.name + + # Return the property namespace decorated with html + fun html_namespace(mbuilder: ModelBuilder): String do + return "{intro_mclassdef.mclass.html_namespace(mbuilder)}::{intro.link(mbuilder)}" end - fun anchor: String do - return "PROP_{c_name}" + # Return the property signature decorated with html + fun html_signature(mbuilder: ModelBuilder): String do + var nprop = mbuilder.mpropdef2npropdef[intro] + return "{name}{nprop.html_signature(mbuilder)}" end + # Escape name for html output + redef fun name do return super.html_escape end -redef class MClass +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 MClassDef + # Return the classdef namespace decorated with html + fun html_namespace(mbuilder: ModelBuilder): String do + var res = new Buffer + res.append(mmodule.html_full_namespace(mbuilder)) + res.append("::{self.mclass.link(mbuilder)}") + return res.to_s + end +end + +redef class MPropDef super Comparable - redef type OTHER: MClass - redef fun <(other: OTHER): Bool do return self.name < other.name + redef type OTHER: MPropDef + redef fun <(other: OTHER): Bool do return self.mproperty.name < other.mproperty.name - # Associate all MMethods to each MModule concerns - fun all_methods: HashMap[MModule, Set[MMethod]] do - var hm = new HashMap[MModule, Set[MMethod]] - for mmodule, childs in concerns do - if not hm.has_key(mmodule) then hm[mmodule] = new HashSet[MMethod] - for prop in intro_methods do - if mmodule == prop.intro_mclassdef.mmodule then - prop.is_redef = false - hm[mmodule].add(prop) - end - end - for prop in redef_methods do - if mmodule == prop.intro_mclassdef.mmodule then - prop.is_redef = true - hm[mmodule].add(prop) - end - end + fun url: String do return "{mclassdef.mclass.url}#{anchor}" + fun anchor: String do return "PROP_{mclassdef.mclass.public_owner.name}_{c_name}" - if childs != null then - for child in childs do - if not hm.has_key(child) then hm[child] = new HashSet[MMethod] - for prop in intro_methods do - if child == prop.intro_mclassdef.mmodule then - prop.is_redef = false - hm[child].add(prop) - end - end - for prop in redef_methods do - if child == prop.intro_mclassdef.mmodule then - prop.is_redef = true - hm[child].add(prop) - end - end - end - end + # 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 "{mproperty.name}" + else + return "{mproperty.name}" end - return hm end - fun public_owner: MModule do - var owner = intro_mmodule - if owner.public_owner is null then - return owner + # 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("
  • ") + res.append("I {link(mbuilder)} ({mclassdef.mclass.link(mbuilder)})") + res.append("
  • ") else - return owner.public_owner.as(not null) + res.append("
  • ") + res.append("R {link(mbuilder)} ({mclassdef.mclass.link(mbuilder)})") + res.append("
  • ") end - end - - # Associate Amodule to all MModule concern by 'self' - fun amodule(amodules: HashMap[MModule, AModule]) do - for owner, childs in concerns do - if childs != null then for child in childs do child.amodule = amodules[child] - owner.amodule = amodules[owner] + return res.to_s + end + + # Return a list item for the mpropdef + fun html_sidebar_item(page: NitdocClass): String do + var res = new Buffer + if is_intro and mclassdef.mclass == page.mclass then + res.append("
  • ") + res.append("I") + else if is_intro and mclassdef.mclass != page.mclass then + res.append("
  • ") + res.append("H") + else + res.append("
  • ") + res.append("R") end + res.append(link(page.mbuilder)) + res.append("
  • ") + return res.to_s 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 + fun html_full_desc(page: NitdocClass): String is abstract + fun html_info(page: NitdocClass): String is abstract +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 +redef class MMethodDef + redef fun html_full_desc(page) do + if not page.mbuilder.mpropdef2npropdef.has_key(self) then + return "" + end + var res = new Buffer + var mprop = mproperty + var nprop = page.mbuilder.mpropdef2npropdef[self] + var classes = new Array[String] + var is_redef = mprop.intro_mclassdef.mclass != page.mclass + 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 + res.append("
    ") + res.append("

    {mprop.html_signature(page.mbuilder)}

    ") + res.append(html_info(page)) + res.append("
    ") + if nprop.comment == "" then + res.append("New Comment") + else + res.append("
    {nprop.comment}
    ") + end + res.append("CancelCommit
    ")
    +		# definitions block
    +		res.append("

    ") + 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 - return false + 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(".

    ") + res.append("
    ") + res.append("
    ") + return res.to_s + end + + redef fun html_info(page) do + var res = new Buffer + res.append("
    ") + if mproperty.visibility <= none_visibility then + res.append("private ") + else if mproperty.visibility <= protected_visibility then + res.append("protected ") + end + if mproperty.intro_mclassdef.mclass != page.mclass then res.append("redef ") + res.append("fun {mproperty.html_namespace(page.mbuilder)}") + res.append("
    ") + res.append("
    ") + return res.to_s end +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) +redef class MVirtualTypeDef + redef fun html_full_desc(page) do + var res = new Buffer + var mprop = mproperty + var is_redef = mprop.intro_mclassdef.mclass != page.mclass + 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 + res.append("
    ") + res.append("

    {mprop.name}: {bound.link(page.mbuilder)}

    ") + res.append(html_info(page)) + res.append("
    ") + + if page.mbuilder.mpropdef2npropdef.has_key(self) and page.mbuilder.mpropdef2npropdef[self].comment != "" then + var nprop = page.mbuilder.mpropdef2npropdef[self] + res.append("
    {nprop.comment}
    ") + else + res.append("New Comment") + end + res.append("CancelCommit
    ")
    +		# definitions block
    +		res.append("

    ") + 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 - - for intro in intro_methods do - if mprop2npropdef.has_key(intro)then - if mprop2npropdef[intro] isa AMethPropdef then intro.apropdef = mprop2npropdef[intro].as(AMethPropdef) + 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 - - for rd in redef_methods do - if mprop2npropdef.has_key(rd)then - if mprop2npropdef[rd] isa AMethPropdef then rd.apropdef = mprop2npropdef[rd].as(AMethPropdef) + 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(".

    ") + res.append("
    ") + res.append("
    ") + return res.to_s end - fun link_anchor: String do - return "{name}.html" + redef fun html_info(page) do + var res = new Buffer + res.append("
    ") + if mproperty.intro_mclassdef.mclass != page.mclass then res.append("redef ") + res.append("type {mproperty.html_namespace(page.mbuilder)}") + res.append("
    ") + res.append("
    ") + return res.to_s end - end -redef class AStdClassdef +# +# Nodes redefs +# + +redef class AModule private fun comment: String do - var ret = "" - if n_doc != null then - for t in n_doc.n_comment do - var txt = t.text.replace("# ", "") - txt = txt.replace("#", "") - ret += "{txt}" - end + 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.append(t.text.substring_from(1)) end - return ret + return ret.to_s.html_escape end private fun short_comment: String do - var ret = "" - if n_doc != null then - var txt = n_doc.n_comment.first.text - txt = txt.replace("# ", "") - txt = txt.replace("\n", "") - ret += txt - end - return ret - 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(", ")})" + var ret = new Buffer + if n_moduledecl != null and n_moduledecl.n_doc != null then + ret.append(n_moduledecl.n_doc.n_comment.first.text.substring_from(2).replace("\n", "")) end - if n_type != null and n_type.to_s != "" then ret += " {n_type.to_s}" - return ret + return ret.to_s.html_escape 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}..." +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 + return ret.to_s.html_escape end -end -redef class AType - redef fun to_s do - var ret = "{n_id.text}" - if n_kwnullable != null then ret = "nullable {ret}" - if not n_types.is_empty then ret = "{ret}[{n_types.join(", ")}]" - return ret + 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 APropdef private fun short_comment: String is abstract - private fun signature: String is abstract + private fun html_signature(mbuilder: ModelBuilder): String is abstract private fun comment: String is abstract end redef class AAttrPropdef redef fun short_comment do - var ret = "" + 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 private fun comment: String do + var ret = new Buffer if n_doc != null then - var txt = n_doc.n_comment.first.text - txt = txt.replace("# ", "") - txt = txt.replace("\n", "") - ret += txt + for t in n_doc.n_comment do ret.append(t.text.substring_from(1)) end - return ret + return ret.to_s.html_escape + end + + redef fun html_signature(mbuilder) do + var res = "" + if n_type != null and n_type.to_html != "" then res += ": {n_type.to_html}" + return res end end redef class AMethPropdef redef fun short_comment do - var ret = "" + 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 private fun comment: String do + var ret = new Buffer if n_doc != null then - var txt = n_doc.n_comment.first.text - txt = txt.replace("# ", "") - txt = txt.replace("\n", "") - ret += txt + for t in n_doc.n_comment do ret.append(t.text.substring_from(1)) end - return ret + 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 + redef fun html_signature(mbuilder) do + if n_signature != null then return n_signature.to_html + return "" + end +end + +redef class ATypePropdef + 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 private fun comment: String do - var ret = "" + var ret = new Buffer if n_doc != null then - for t in n_doc.n_comment do - var txt = t.text.replace("# ", "") - txt = txt.replace("#", "") - ret += "{txt}" - end + for t in n_doc.n_comment do ret.append(t.text.substring_from(1)) end - return ret + return ret.to_s.html_escape + end + + redef fun html_signature(mbuilder) do + return mpropdef.bound.link(mbuilder) end end -redef class MClassDef - private fun namespace(mclass: MClass): String do +redef class ASignature + fun to_html: String 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_html != "" then ret += ": {n_type.to_html}" + return ret + end +end - 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}::{mclass.name}" +redef class AParam + redef fun to_s do + var ret = "{n_id.text}" + if n_type != null then + ret = "{ret}: {n_type.to_html}" + if n_dotdotdot != null then ret = "{ret}..." end + return ret end end -redef class Set[E] - fun last: E do - return to_a[length-1] +redef class AType + fun to_html: String do + var ret = "{n_id.text}" + if n_kwnullable != null then ret = "nullable {ret}" + if not n_types.is_empty then ret = "{ret}[{n_types.join(", ")}]" + return ret end + + fun name: String do return n_id.text.html_escape end # Create a tool context to handle options and paths