# 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}/")
+ overview
+ fullindex
+ modules
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")
+ end
+
+ fun fullindex do
+ var fullindex = new NitdocFullindex.with(model.mmodules)
+ fullindex.save("{destinationdir.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")
+ end
+ end
+
end
class NitdocOverview
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.")
+ 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
+ end
+ 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")
+ end
+ end
+ op.append("\}\n")
+ generate_dot(op.to_s, "dep", "Modules hierarchy")
+ end
+
+end
+
+class NitdocFullindex
+ super NitdocPage
+
+ var mmodules: Array[MModule]
+
+ init with(mmodules: Array[MModule]) do
+ self.mmodules = mmodules
+ opt_nodot = false
+ destinationdir = ""
+ 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.")
+ end
+
+ fun add_content do
+ module_column
+ classes_column
+ properties_column
+ 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
+ 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")
+ end
+ end
+ close("ul")
+ close("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")
+ end
+
+ close("ul")
+ close("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
+ 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 mmodules.first.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")
+ end
+
+ close("ul")
+ close("article")
+ end
+
+end
+
+class NitdocModules
+ 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 = ""
+ 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.")
+ 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
+ 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")
+ end
+ close("ul")
+
+ close("nav")
+ end
+ close("div")
+ end
+
+ 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 ")
+ else
+ open("li").add_class("redef")
+ add("span").attr("title", "refined in this module").text("R ")
+ end
+ add("a").attr("href", "{name}.html").text(name)
+ close("li")
+ end
+ close("ul")
+ close("article")
+ close("div")
+ end
+
+ 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")
+ 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")
+ end
+
+ close("ul")
+ close("article")
+ end
+
end
class NitdocPage
super HTMLPage
+
var opt_nodot: Bool
var destinationdir : String
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
+
+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
+ ret += "{t.text.replace("# ", "")}"
+ 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
+
+redef class MModule
+
+ var amodule: nullable AModule
+
+ # Get the list of all methods in a module
+ fun imported_methods: Set[MMethod] do
+ var methods = new HashSet[MMethod]
+ for mclass in imported_mclasses do
+ for method in mclass.intro_methods do
+ methods.add(method)
+ end
+ end
+ return methods
+ end
+
+ # Get the list aof all refined methods in a module
+ fun redef_methods: Set[MMethod] do
+ var methods = new HashSet[MMethod]
+ for mclass in redef_mclasses do
+ for method in mclass.intro_methods do
+ methods.add(method)
+ end
+ end
+ return methods
+ end
+end
+
+redef class MProperty
+
+ var is_redef: Bool
+ var apropdef: nullable APropdef
+
+ redef init(intro_mclassdef: MClassDef, name: String, visibility: MVisibility)
+ do
+ super
+ is_redef = false
+ end
+
+ fun local_class: MClass do
+ var classdef = self.intro_mclassdef
+ return classdef.mclass
+ end
+
+end
+
+redef class MClass
+
+ # 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
+
+ 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
+ end
+ return hm
+ end
+
end
# Create a tool context to handle options and paths
nitlanguage / nit.git / blobdiff