{nclass.comment} CancelCommit")
+ close("section")
+ open("section").add_class("concerns")
+ add("h2").add_class("section-header").text("Concerns")
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("{mmodule.name}: {nmodule.short_comment}
") + else + add_html("{mmodule.name}: {nmodule.short_comment}
") + end end + var sortedc = mmethods.to_a + sorterprop.sort(sortedc) + for prop in sortedc do description(prop) end - close("ul") - close("nav") - end - -end - -class NitdocPage - super HTMLPage - - var opt_nodot: Bool - var destinationdir : 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") + # 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 imclass in sortedc do + var inclass = mbuilder.mclassdef2nclassdef[imclass.intro].as(AStdClassdef) + var sortedp = mclass.inherited[imclass].to_a + sorterprop.sort(sortedp) + open("p") + add_html("Defined in {imclass.link(inclass)}: ") + for method in sortedp do + #TODO link to inherited propdef + add_html("{method.name}") + if method != sortedp.last then add_html(", ") + end + close("p") + end + end + close("section") end - redef fun body do header - fun header do end + 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 + open("article").add_classes(classes).attr("id", "{prop.anchor}") + var sign = prop.name + open("h3").add_class("signature") + add_html("{prop.name}{nprop.signature}") + close("h3") + open("div").add_class("info") + add_html("{if prop.is_redef then "redef" else ""} fun {prop.intro_mclassdef.namespace(mclass)}::{prop.name}{nprop.comment}")
+ end
+ add_html("CancelCommit")
+ open("p")
+ if prop.local_class != mclass then
+ var mredef = prop.local_class.intro_mmodule
+ var nredef = mbuilder.mmodule2nmodule[mredef]
+ add_html("inherited from {mredef.link(nredef)} ")
+ end
+ #TODO display show code if doc github
+ var mintro = prop.intro_mclassdef.mmodule
+ var nintro = mbuilder.mmodule2nmodule[mintro]
+ add_html("defined by the module {mintro.link(nintro)}{if prop.apropdef is null then "" else show_source(prop.apropdef.location)}.")
+
+ for parent in mclass.parents do
+ var mparent = parent.intro_mmodule
+ var nparent = mbuilder.mmodule2nmodule[mparent]
+ if prop isa MMethod then if parent.constructors.has(prop) then add_html(" Previously defined by: {mparent.link(nparent)} for {parent.name}.")
+ end
+ close("p")
+ close("div")
- # 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
@@ -778,7 +1015,10 @@ redef class AModule
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("# ", "")}"
+ var txt = t.text
+ txt = txt.replace("# ", "")
+ txt = txt.replace("#", "")
+ ret += txt
end
return ret
end
@@ -796,8 +1036,9 @@ redef class AModule
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
@@ -820,9 +1061,40 @@ redef class MModule
end
return methods
end
+
+ # Return a link (html a tag) to the nitdoc module page
+ fun link(amodule: AModule): String do
+ return "{name}"
+ end
+
+ # Return the module namespace decorated with html
+ fun namespace(mbuilder: ModelBuilder): String do
+ var str = new Buffer
+ var mowner = public_owner
+ if mowner != null then
+ var nowner = mbuilder.mmodule2nmodule[mowner]
+ str.append(public_owner.link(nowner))
+ end
+ var nmodule = mbuilder.mmodule2nmodule[self]
+ str.append(self.link(nmodule))
+ return str.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(nprop: APropdef): String do
+ return "{mproperty}"
+ 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
@@ -838,14 +1110,6 @@ redef class MProperty
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
@@ -853,6 +1117,23 @@ redef class MProperty
end
redef class MClass
+ super Comparable
+ redef type OTHER: MClass
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+
+ # Add type parameters
+ redef fun to_s 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(aclass: AStdClassdef): String do
+ return "{self}"
+ end
# Associate all MMethods to each MModule concerns
fun all_methods: HashMap[MModule, Set[MMethod]] do
@@ -893,11 +1174,189 @@ redef class MClass
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
+
+end
+
+redef class AStdClassdef
+ 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
+ end
+ return ret
+ 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(", ")})"
+ 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 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
+ end
+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 = ""
+ 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 AMethPropdef
+ redef fun short_comment 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.append(txt)
+ end
+ return ret.to_s
+ 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
+ var txt = t.text.replace("# ", "")
+ txt = txt.replace("#", "")
+ ret.append(txt)
+ end
+ end
+ return ret.to_s
+ 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}::{mclass.name}"
+ 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)