- printn ">> "
- seek(stdin.read_line)
- end
-
- fun seek(entry: String) do
- if entry.is_empty then
- prompt
- return
- end
- if entry == ":h" then
- help
- prompt
- return
- end
- if entry == ":q" then exit(0)
- var pager = new Pager
- # seek return types
- if entry.has_prefix("return:") then
- var ret = entry.split_with(":")[1].replace(" ", "")
- var matches = seek_returns(ret)
- props_fulldoc(pager, matches)
- else if entry.has_prefix("param:") then
- var param = entry.split_with(":")[1].replace(" ", "")
- var matches = seek_params(param)
- props_fulldoc(pager, matches)
- else
- # seek for modules
- var mmatches = new List[MModule]
- for m in model.mmodules do
- if m.name == entry then mmatches.add(m)
- end
- if not mmatches.is_empty then modules_fulldoc(pager, mmatches)
- # seek for classes
- var cmatches = new List[MClass]
- for c in model.mclasses do
- if c.name == entry then cmatches.add(c)
- end
- if not cmatches.is_empty then classes_fulldoc(pager, cmatches)
- # seek for properties
- var matches = new List[MProperty]
- for p in model.mproperties do
- if p.name == entry then matches.add(p)
- end
- if not matches.is_empty then props_fulldoc(pager, matches)
- end
- # no matches
- if pager.content.is_empty then
- print "Nothing known about '{entry}', type ':h' for help"
- else
- pager.render
- end
- if arguments.length == 1 then prompt
- end
-
- private fun modules_fulldoc(pager: Pager, mmodules: List[MModule]) do
- for mmodule in mmodules do
- # name and prototype
- pager.add("# {mmodule.namespace}\n".bold)
- # comment
- if mbuilder.mmodule2nmodule.has_key(mmodule) then
- var nmodule = mbuilder.mmodule2nmodule[mmodule]
- if not nmodule.n_moduledecl.n_doc == null then
- for comment in nmodule.n_moduledecl.n_doc.comment do pager.add(comment.green)
- end
- end
- pager.add("{mmodule.prototype}\n")
- # imports
- var msorter = new MModuleNameSorter
- var ms = mmodule.in_importation.greaters.to_a
- if ms.length > 1 then
- msorter.sort(ms)
- pager.add("## imported modules".bold)
- pager.addn("\t")
- for i in [0..ms.length[ do
- if ms[i] == mmodule then continue
- pager.addn(ms[i].name)
- if i < ms.length - 1 then pager.addn(", ")
- end
- pager.add("\n")
- end
- # clients
- ms = mmodule.in_importation.smallers.to_a
- if ms.length > 1 then
- msorter.sort(ms)
- pager.add("## known modules".bold)
- pager.addn("\t")
- for i in [0..ms.length[ do
- if ms[i] == mmodule then continue
- pager.addn(ms[i].name)
- if i < ms.length - 1 then pager.addn(", ")
- end
- pager.add("\n")
- end
- # local classes and interfaces
- var sorter = new MClassDefNameSorter
- var intro_mclassdefs = new Array[MClassDef]
- var redef_mclassdefs = new Array[MClassDef]
- for mclassdef in mmodule.mclassdefs do
- if mclassdef.is_intro then
- intro_mclassdefs.add(mclassdef)
- else
- redef_mclassdefs.add(mclassdef)
- end
- end
- # intro
- if not intro_mclassdefs.is_empty then
- sorter.sort(intro_mclassdefs)
- pager.add("\n## introduced classes".bold)
- for mclassdef in intro_mclassdefs do
- pager.add("")
- var nclass = mbuilder.mclassdef2nclassdef[mclassdef]
- if nclass isa AStdClassdef and not nclass.n_doc == null and not nclass.n_doc.short_comment.is_empty then
- pager.add("\t{nclass.n_doc.short_comment.green}")
- end
- pager.add("\t{mclassdef.mclass.prototype}")
- #TODO add redefs?
- end
- end
- # redefs
- if not redef_mclassdefs.is_empty then
- sorter.sort(redef_mclassdefs)
- pager.add("\n## refined classes".bold)
- for mclassdef in redef_mclassdefs do
- pager.add("")
- #TODO intro comment?
- var nclass = mbuilder.mclassdef2nclassdef[mclassdef]
- if nclass isa AStdClassdef and not nclass.n_doc == null and not nclass.n_doc.short_comment.is_empty then
- pager.add("\t# {nclass.n_doc.short_comment.green}")
- end
- pager.add("\t{mclassdef.mclass.prototype}")
- pager.add("\t\t" + "introduced in {mclassdef.mclass.intro.mmodule.namespace.bold}".gray)
- for odef in mclassdef.mclass.mclassdefs do
- if odef.is_intro or odef == mclassdef or mclassdef.mmodule == mmodule then continue
- pager.add("\t\t" + "refined in {mclassdef.mmodule.namespace.bold}".gray)
- end
- end
- end
- #TODO add inherited classes?
- pager.add_rule
- end
- end
-
- private fun classes_fulldoc(pager: Pager, mclasses: List[MClass]) do
- for mclass in mclasses do
- # title
- pager.add("# {mclass.namespace}\n".bold)
- # comment
- if mbuilder.mclassdef2nclassdef.has_key(mclass.intro) then
- var nclass = mbuilder.mclassdef2nclassdef[mclass.intro]
- if nclass isa AStdClassdef and not nclass.n_doc == null then
- for comment in nclass.n_doc.comment do pager.add(comment.green)
- end
- end
- pager.addn("{mclass.prototype}")
- if not mclass.in_hierarchy(mainmodule).direct_greaters.is_empty then
- var supers = mclass.in_hierarchy(mainmodule).direct_greaters.to_a
- pager.addn(" super ")
- for i in [0..supers.length[ do
- if supers[i] == mclass then continue
- pager.addn("{supers[i].name}{supers[i].signature}")
- if i < mclass.in_hierarchy(mainmodule).direct_greaters.length -1 then pager.addn(", ")
- end
- end
- pager.add("\n")
- # formal types
- if not mclass.parameter_types.is_empty then
- pager.add("## formal types".bold)
- for ft, bound in mclass.parameter_types do
- pager.add("")
- pager.add("\t{ft.to_s.green}: {bound.to_console}")
- end
- pager.add("")
- end
- # get properties
- var cats = new ArrayMap[String, Set[MPropDef]]
- cats["virtual types"] = new HashSet[MPropDef]
- cats["constructors"] = new HashSet[MPropDef]
- cats["introduced methods"] = new HashSet[MPropDef]
- cats["refined methods"] = new HashSet[MPropDef]
-
- for mclassdef in mclass.mclassdefs do
- for mpropdef in mclassdef.mpropdefs do
- if mpropdef isa MAttributeDef then continue
- if mpropdef isa MVirtualTypeDef then cats["virtual types"].add(mpropdef)
- if mpropdef isa MMethodDef then
- if mpropdef.mproperty.is_init then
- cats["constructors"].add(mpropdef)
- else if mpropdef.is_intro then
- cats["introduced methods"].add(mpropdef)
- else
- cats["refined methods"].add(mpropdef)
- end
- end
- end
- end
- # local mproperties
- for cat, list in cats do
- if not list.is_empty then
- #sort list
- var sorted = new Array[MPropDef]
- sorted.add_all(list)
- var sorter = new MPropDefNameSorter
- sorter.sort(sorted)
- pager.add("## {cat}".bold)
- for mpropdef in sorted do
- pager.add("")
- if mbuilder.mpropdef2npropdef.has_key(mpropdef) then
- var nprop = mbuilder.mpropdef2npropdef[mpropdef]
- if not nprop.n_doc == null and not nprop.n_doc.comment.is_empty then
- for comment in nprop.n_doc.comment do pager.add("\t{comment.green}")
- else
- nprop = mbuilder.mpropdef2npropdef[mpropdef.mproperty.intro]
- if not nprop.n_doc == null and not nprop.n_doc.comment.is_empty then
- for comment in nprop.n_doc.comment do pager.add("\t{comment.green}")
- end
- end
- end
- pager.add("\t{mpropdef.to_console}")
- mainmodule.linearize_mpropdefs(mpropdef.mproperty.mpropdefs)
- var previous_defs = new Array[MPropDef]
- for def in mpropdef.mproperty.mpropdefs do
- if def == mpropdef then continue
- if def.is_intro then continue
- if mclass.in_hierarchy(mainmodule) < def.mclassdef.mclass then
- previous_defs.add(def)
- end
- end
- if not mpropdef.is_intro then
- pager.add("\t\t" + "introduced by {mpropdef.mproperty.intro.mclassdef.namespace.bold}".gray)
- end
- if not previous_defs.is_empty then
- for def in previous_defs do pager.add("\t\t" + "inherited from {def.mclassdef.namespace.bold}".gray)
- end
- end
- pager.add("")
- end
- end
- # inherited mproperties
- var inhs = new ArrayMap[MClass, Array[MProperty]]
- var ancestors = mclass.in_hierarchy(mainmodule).greaters.to_a
- mainmodule.linearize_mclasses(ancestors)
- for a in ancestors do
- if a == mclass then continue
- for c in a.mclassdefs do
- for p in c.intro_mproperties do
- if p.intro_mclassdef == c then
- if not inhs.has_key(a) then inhs[a] = new Array[MProperty]
- inhs[a].add(p)
- end
- end
- end
- end
- if not inhs.is_empty then
- pager.add("## inherited properties".bold)
- for a, ps in inhs do
- pager.add("\n\tfrom {a.namespace.bold}: {ps.join(", ")}")
- end
- end
- pager.add_rule
- end
- end
-
- private fun props_fulldoc(pager: Pager, raw_mprops: List[MProperty]) do
- # group by module
- var cats = new HashMap[MModule, Array[MProperty]]
- for mprop in raw_mprops do
- if mprop isa MAttribute then continue
- var key = mprop.intro.mclassdef.mmodule
- if not cats.has_key(key) then cats[key] = new Array[MProperty]
- cats[key].add(mprop)
- end
- #sort groups
- var sorter = new MModuleNameSorter
- var sorted = new Array[MModule]
- sorted.add_all(cats.keys)
- sorter.sort(sorted)
- # display
- for mmodule in sorted do
- var mprops = cats[mmodule]
- pager.add("# matches in module {mmodule.namespace.bold}")
- var sorterp = new MPropertyNameSorter
- sorterp.sort(mprops)
- for mprop in mprops do
- pager.add("")
- if mbuilder.mpropdef2npropdef.has_key(mprop.intro) then
- var nprop = mbuilder.mpropdef2npropdef[mprop.intro]
- if not nprop.n_doc == null and not nprop.n_doc.comment.is_empty then
- for comment in nprop.n_doc.comment do pager.add("\t{comment.green}")
- end
- end
- pager.add("\t{mprop.intro.to_console}")
- pager.add("\t\t" + "introduced in {mprop.intro_mclassdef.namespace.bold}".gray)
- var mpropdefs = mprop.mpropdefs
- mainmodule.linearize_mpropdefs(mpropdefs)
- for mpdef in mpropdefs do
- if not mpdef.is_intro then
- pager.add("\t\t" + "refined in {mpdef.mclassdef.namespace.bold}".gray)
- end
- end
- end
- pager.add_rule
- end
- end
-
- private fun seek_returns(entry: String): List[MProperty] do
- # TODO how to match with generic types?
- var matches = new List[MProperty]
- for mprop in model.mproperties do
- var intro = mprop.intro
- if intro isa MMethodDef then
- if intro.msignature.return_mtype != null and intro.msignature.return_mtype.to_s == entry then matches.add(mprop)
- else if intro isa MAttributeDef then
- if intro.static_mtype.to_s == entry then matches.add(mprop)
- end
- end
- return matches
- end
-
- private fun seek_params(entry: String): List[MProperty] do
- # TODO how to match with generic types?
- var matches = new List[MProperty]
- for mprop in model.mproperties do
- var intro = mprop.intro
- if intro isa MMethodDef then
- var mparameters = intro.msignature.mparameters
- for mparameter in mparameters do
- if mparameter.mtype.to_s == entry then matches.add(mprop)
- end
- else if intro isa MAttributeDef then
- if intro.static_mtype.to_s == entry then matches.add(mprop)
- end
- end
- return matches
- end
-end
-
-# Printing facilities
-
-redef class MModule
- # prototype of the module
- # module ownername::name
- private fun prototype: String do return "module {name}"
-
- # namespace of the module
- # ownername::name
- private fun namespace: String do
- if public_owner == null then
- return self.name