# This file is part of NIT ( http://www.nitlanguage.org ).
#
-# Copyright 2008 Jean Privat <jean@pryen.org>
-#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
# See the License for the specific language governing permissions and
# limitations under the License.
+# ni or nit index, is a command tool used to display documentation
module ni
import model_utils
private class Pager
- var content: String = ""
+ var content = new Buffer
fun add(text: String) do addn("{text}\n")
- fun addn(text: String) do content += text.escape
+ fun addn(text: String) do content.append(text.escape)
fun add_rule do add("\n---\n")
fun render do sys.system("echo \"{content}\" | pager -r")
end
+# Main class of the nit index tool
+# NitIndex build the model using the toolcontext argument
+# then wait for query on std in to display documentation
class NitIndex
private var toolcontext: ToolContext
private var model: Model
init(toolcontext: ToolContext) do
# We need a model to collect stufs
self.toolcontext = toolcontext
+ self.toolcontext.option_context.options.clear
self.arguments = toolcontext.option_context.rest
- if arguments.length > 2 then
+ if arguments.is_empty or arguments.length > 2 then
print "usage: ni path/to/module.nit [expression]"
toolcontext.option_context.usage
exit(1)
#var mmodules = modelbuilder.parse_and_build(["{dir}/lib/standard/standard.nit"])
var mmodules = mbuilder.parse_and_build([arguments.first])
if mmodules.is_empty then return
- mbuilder.full_propdef_semantic_analysis
assert mmodules.length == 1
self.mainmodule = mmodules.first
end
end
fun seek(entry: String) do
- # quitting?
if entry.is_empty then exit(0)
-
var flag = false
- for m in model.mmodules do
- if m.name == entry then
+ # seek return types
+ if entry.has_prefix("return:") then
+ var ret = entry.split_with(":")[1].replace(" ", "")
+ var matches = seek_returns(ret)
+ if not matches.is_empty then
flag = true
- module_fulldoc(m)
+ props_fulldoc(matches)
end
- end
- for c in model.mclasses do
- if c.name == entry then
- if not mbuilder.mclassdef2nclassdef[c.intro] isa AStdClassdef then continue
+ else if entry.has_prefix("param:") then
+ var param = entry.split_with(":")[1].replace(" ", "")
+ var matches = seek_params(param)
+ if not matches.is_empty then
flag = true
- class_fulldoc(c)
+ props_fulldoc(matches)
end
- end
- var matches = new List[MProperty]
- for p in model.mproperties do
- if p.name == entry then
- flag = true
- matches.add(p)
+ else
+ # seek for modules
+ var mmatches = new List[MModule]
+ for m in model.mmodules do
+ if m.name == entry then
+ flag = true
+ mmatches.add(m)
+ end
+ end
+ if not mmatches.is_empty then modules_fulldoc(mmatches)
+ # seek for classes
+ var cmatches = new List[MClass]
+ for c in model.mclasses do
+ if c.name == entry then
+ flag = true
+ cmatches.add(c)
+ end
end
+ if not cmatches.is_empty then classes_fulldoc(cmatches)
+ # seek for properties
+ var matches = new List[MProperty]
+ for p in model.mproperties do
+ if p.name == entry then
+ flag = true
+ matches.add(p)
+ end
+ end
+ if not matches.is_empty then props_fulldoc(matches)
end
- if not matches.is_empty then props_fulldoc(matches)
-
+ # no matches
if not flag then print "Nothing known about '{entry}'"
if arguments.length == 1 then prompt
end
- private fun module_fulldoc(mmodule: MModule) do
- var nmodule = mbuilder.mmodule2nmodule[mmodule]
+ private fun modules_fulldoc(mmodules: List[MModule]) do
var pager = new Pager
- pager.add("# module {mmodule.name}\n".bold)
- pager.add("import {mmodule.in_importation.direct_greaters.join(", ")}")
- #TODO add kmown clients
- pager.add_rule
- pager.addn(nmodule.comment.green)
- pager.add_rule
-
- var cats = new HashMap[String, Collection[MClass]]
- cats["introduced classes"] = mmodule.intro_mclasses
- cats["refined classes"] = mmodule.redef_mclasses
- cats["inherited classes"] = mmodule.imported_mclasses
-
- for cat, list in cats do
- if not list.is_empty then
- pager.add("# {cat}\n".bold)
- for mclass in list do
- var nclass = mbuilder.mclassdef2nclassdef[mclass.intro].as(AStdClassdef)
- if not nclass.short_comment.is_empty then
- pager.add("\t# {nclass.short_comment}")
- end
- if cat == "refined classes" then
- pager.add("\tredef {mclass.short_doc}")
- else
- pager.add("\t{mclass.short_doc}")
- end
- if not mclass.intro_mmodule == mmodule then
- pager.add("\t\t" + "introduced in {mmodule.full_name}::{mclass}".gray)
- end
- for mclassdef in mclass.mclassdefs do
- if mclassdef != mclass.intro then
- pager.add("\t\t" + "refined in {mclassdef.namespace}".gray)
+ for mmodule in mmodules do
+ var nmodule = mbuilder.mmodule2nmodule[mmodule]
+ pager.add("# module {mmodule.namespace}\n".bold)
+ if not mmodule.in_importation.direct_greaters.is_empty then
+ pager.add("import ".bold + "{mmodule.in_importation.direct_greaters.join(", ")}\n")
+ end
+ if not mmodule.in_importation.direct_smallers.is_empty then
+ pager.add("known clients: ".bold + "{mmodule.in_importation.direct_smallers.join(", ")}\n")
+ end
+ pager.add_rule
+ pager.addn(nmodule.n_moduledecl.n_doc.comment.green)
+ pager.add_rule
+
+ var cats = new HashMap[String, Collection[MClass]]
+ cats["introduced classes"] = mmodule.intro_mclasses
+ cats["refined classes"] = mmodule.redef_mclasses
+ cats["imported classes"] = mmodule.imported_mclasses
+
+ for cat, list in cats do
+ if not list.is_empty then
+ pager.add("\n# {cat}".bold)
+ #sort list
+ var sorted = new Array[MClass]
+ sorted.add_all(list)
+ var sorter = new ComparableSorter[MClass]
+ sorter.sort(sorted)
+ for mclass in sorted do
+ var nclass = mbuilder.mclassdef2nclassdef[mclass.intro].as(AStdClassdef)
+ pager.add("")
+ if not nclass.n_doc == null and not nclass.n_doc.short_comment.is_empty then
+ pager.add("\t# {nclass.n_doc.short_comment}")
+ end
+ if cat == "refined classes" then
+ pager.add("\tredef {mclass.short_doc}")
+ else
+ pager.add("\t{mclass.short_doc}")
+ end
+ if cat != "introduced classes" then
+ pager.add("\t\t" + "introduced in {mmodule.full_name}::{mclass}".gray)
+ end
+ for mclassdef in mclass.mclassdefs do
+ if mclassdef != mclass.intro then
+ pager.add("\t\t" + "refined in {mclassdef.namespace}".gray)
+ end
end
end
- pager.add("")
end
end
+ pager.add_rule
end
- pager.add_rule
pager.render
end
- private fun class_fulldoc(mclass: MClass) do
- var nclass = mbuilder.mclassdef2nclassdef[mclass.intro].as(AStdClassdef)
+ private fun classes_fulldoc(mclasses: List[MClass]) do
var pager = new Pager
- pager.add("# {mclass.intro_mmodule.public_owner.name}::{mclass.name}\n".bold)
- pager.add("{mclass.short_doc} ")
- #TODO add kmown subclasses
- pager.add_rule
- pager.addn(nclass.comment.green)
- pager.add_rule
- if not mclass.parameter_types.is_empty then
- pager.add("# formal types\n".bold)
- for ft, bound in mclass.parameter_types do
- pager.add("\t{ft.to_s.green}: {bound}")
- pager.add("")
+ for mclass in mclasses do
+ var nclass = mbuilder.mclassdef2nclassdef[mclass.intro].as(AStdClassdef)
+
+ pager.add("# {mclass.namespace}\n".bold)
+ pager.add("{mclass.short_doc}")
+ pager.add_rule
+ pager.addn(nclass.n_doc.comment.green)
+ pager.add_rule
+ 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}")
+ end
end
- end
- if not mclass.virtual_types.is_empty then
- pager.add("# virtual types\n".bold)
- for vt in mclass.virtual_types do
- if vt.visibility.to_s == "public" then pager.add("\t{vt.to_s.green}: {vt.intro.bound.to_s}")
- if vt.visibility.to_s == "private" then pager.add("\t{vt.to_s.red}: {vt.intro.bound.to_s}")
- if vt.visibility.to_s == "protected" then pager.add("\t{vt.to_s.yellow}: {vt.intro.bound.to_s}")
- if vt.intro_mclassdef != mclass.intro then
- pager.add("\t\t" + "introduced in {vt.intro_mclassdef.namespace}::{vt}".gray)
+ if not mclass.virtual_types.is_empty then
+ pager.add("# virtual types".bold)
+ for vt in mclass.virtual_types do
+ pager.add("")
+ vt_fulldoc(pager, vt)
end
- for mpropdef in vt.mpropdefs do
- if mpropdef != vt.intro then
- pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
+ end
+ pager.add_rule
+
+ var cats = new HashMap[String, Collection[MMethod]]
+ cats["constructors"] = mclass.constructors
+ cats["introduced methods"] = mclass.intro_methods
+ cats["refined methods"] = mclass.redef_methods
+ cats["inherited methods"] = mclass.inherited_methods
+
+ for cat, list in cats do
+ if not list.is_empty then
+ #sort list
+ var sorted = new Array[MMethod]
+ sorted.add_all(list)
+ var sorter = new ComparableSorter[MMethod]
+ sorter.sort(sorted)
+ pager.add("\n# {cat}".bold)
+ for mprop in sorted do
+ pager.add("")
+ method_fulldoc(pager, mprop)
end
end
- pager.add("")
end
+ pager.add_rule
end
- pager.add_rule
-
- var cats = new HashMap[String, Collection[MMethod]]
- cats["constructors"] = mclass.constructors
- cats["introduced methods"] = mclass.intro_methods
- cats["refined methods"] = mclass.redef_methods
- cats["inherited methods"] = mclass.inherited_methods
-
- for cat, list in cats do
- if not list.is_empty then
- pager.add("# {cat}\n".bold)
- for mprop in list do
- #TODO verifier cast
- var nmethod = mbuilder.mpropdef2npropdef[mprop.intro].as(AMethPropdef)
- if not nmethod.short_comment.is_empty then
- pager.add("\t# {nmethod.short_comment}")
- end
- if cat == "refined methods" then
- pager.add("\tredef {nmethod}")
- else
- pager.add("\t{nmethod}")
- end
- if not mprop.intro_mclassdef == mclass.intro then
- pager.add("\t\t" + "introduced in {mprop.intro_mclassdef.namespace}".gray)
- end
- for mpropdef in mprop.mpropdefs do
- if mpropdef != mprop.intro then
- pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
- end
- end
+ pager.render
+ end
+
+ private fun props_fulldoc(raw_mprops: List[MProperty]) do
+ var pager = new Pager
+ # group by module
+ var cats = new HashMap[MClass, Array[MProperty]]
+ for mprop in raw_mprops do
+ if not mbuilder.mpropdef2npropdef.has_key(mprop.intro) then continue
+ if mprop isa MAttribute then continue
+ var mclass = mprop.intro_mclassdef.mclass
+ if not cats.has_key(mclass) then cats[mclass] = new Array[MProperty]
+ cats[mclass].add(mprop)
+ end
+ #sort groups
+ var sorter = new ComparableSorter[MClass]
+ var sorted = new Array[MClass]
+ sorted.add_all(cats.keys)
+ sorter.sort(sorted)
+ # display
+ for mclass in sorted do
+ var mprops = cats[mclass]
+ pager.add("# {mclass.namespace}".bold)
+ var sorterp = new ComparableSorter[MProperty]
+ sorterp.sort(mprops)
+ for mprop in mprops do
+ if mprop isa MMethod and mbuilder.mpropdef2npropdef.has_key(mprop.intro) then
+ pager.add("")
+ method_fulldoc(pager, mprop)
+ else if mprop isa MVirtualTypeProp then
pager.add("")
+ vt_fulldoc(pager, mprop)
end
end
+ pager.add_rule
end
pager.render
end
- private fun props_fulldoc(mprops: List[MProperty]) do
- var pager = new Pager
- for mprop in mprops do
- var nprop = mbuilder.mpropdef2npropdef[mprop.intro]
- if nprop isa AMethPropdef then
- pager.add("# {mprop.intro_mclassdef.namespace.bold}\n")
- if not nprop.short_comment.is_empty then
- pager.add("\t# {nprop.short_comment}")
+ 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
+
+ private fun method_fulldoc(pager: Pager, mprop: MMethod) do
+ 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.short_comment.is_empty then
+ pager.add("\t# {nprop.n_doc.short_comment}")
+ end
+ if nprop isa AAttrPropdef then
+ pager.add("\t{nprop.read_accessor}")
+ pager.add("\t{nprop.write_accessor}")
+ else if nprop isa AMethPropdef then
pager.add("\t{nprop}")
- pager.add("\t\t" + "introduced in {mprop.intro_mclassdef.namespace}".gray)
- for mpropdef in mprop.mpropdefs do
- if mpropdef != mprop.intro then
- pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
- end
+ end
+ pager.add("\t\t" + "introduced in {mprop.intro_mclassdef.namespace}".gray)
+ for mpropdef in mprop.mpropdefs do
+ if mpropdef != mprop.intro then
+ pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
end
end
- pager.add_rule
end
- pager.render
+ end
+
+ private fun vt_fulldoc(pager: Pager, vt: MVirtualTypeProp) do
+ pager.add("\t{vt.short_doc}")
+ pager.add("\t\t" + "introduced in {vt.intro_mclassdef.namespace}::{vt}".gray)
+ for mpropdef in vt.mpropdefs do
+ if mpropdef != vt.intro then
+ pager.add("\t\t" + "refined in {mpropdef.mclassdef.namespace}".gray)
+ end
+ end
end
end
# Printing facilities
+redef class MModule
+ super Comparable
+ redef type OTHER: MModule
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+
+ private fun namespace: String do
+ return full_name
+ end
+end
+
redef class MClass
+ super Comparable
+ redef type OTHER: MClass
+ redef fun <(other: OTHER): Bool do return self.name < other.name
redef fun to_s: String do
if arity > 0 then
if visibility.to_s == "public" then ret = "{ret}{to_s.green}"
if visibility.to_s == "private" then ret = "{ret}{to_s.red}"
if visibility.to_s == "protected" then ret = "{ret}{to_s.yellow}"
- ret = "{ret} super {parents.join(", ")}"
+ if not parents.is_empty then
+ ret = "{ret} super {parents.join(", ")}"
+ end
return ret
end
+
+ private fun namespace: String do
+ if not intro_mmodule.public_owner == null then
+ return "{intro_mmodule.public_owner.name}::{name}"
+ else
+ return "{intro_mmodule.name}::{name}"
+ end
+ end
end
redef class MClassDef
end
end
-redef class AModule
- private fun comment: String do
+redef class MProperty
+ super Comparable
+ redef type OTHER: MProperty
+ redef fun <(other: OTHER): Bool do return self.name < other.name
+end
+
+redef class MVirtualTypeProp
+ private fun short_doc: String do
var ret = ""
- for t in n_moduledecl.n_doc.n_comment do
- ret += "{t.text.replace("# ", "")}"
- end
+ if visibility.to_s == "public" then ret = "{to_s.green}: {intro.bound.to_s}"
+ if visibility.to_s == "private" then ret = "\t{to_s.red}: {intro.bound.to_s}"
+ if visibility.to_s == "protected" then ret = "\t{to_s.yellow}: {intro.bound.to_s}"
return ret
end
end
-redef class AStdClassdef
+redef class ADoc
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 res = new Buffer
+ for t in n_comment do
+ res.append(t.text.replace("# ", "").replace("#", ""))
end
- return ret
+ return res.to_s
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
+ return n_comment.first.text.replace("# ", "").replace("\n", "")
end
end
-redef class AMethPropdef
- 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
+redef class AAttrPropdef
+ private fun read_accessor: String do
+ var ret = "fun "
+ #FIXME bug with standard::stream::FDStream::fd
+ var name = mreadpropdef.mproperty.name
+ if mpropdef.mproperty.visibility.to_s == "public" then ret = "{ret}{name.green}"
+ if mpropdef.mproperty.visibility.to_s == "private" then ret = "{ret}{name.red}"
+ if mpropdef.mproperty.visibility.to_s == "protected" then ret = "{ret}{name.yellow}"
+ ret = "{ret}: {n_type.to_s}"
+ if n_kwredef != null then ret = "redef {ret}"
+ return ret
+ end
+
+ private fun write_accessor: String do
+ var ret = "fun "
+ var name = "{mreadpropdef.mproperty.name}="
+ if n_readable != null and n_readable.n_visibility != null then
+ if n_readable.n_visibility isa APublicVisibility then ret = "{ret}{name.green}"
+ if n_readable.n_visibility isa APrivateVisibility then ret = "{ret}{name.red}"
+ if n_readable.n_visibility isa AProtectedVisibility then ret = "{ret}{name.yellow}"
+ else
+ ret = "{ret}{name.red}"
end
+ ret = "{ret}({mreadpropdef.mproperty.name}: {n_type.to_s})"
+ if n_kwredef != null then ret = "redef {ret}"
return ret
end
+end
+redef class AMethPropdef
redef fun to_s do
var ret = ""
if not mpropdef.mproperty.is_init then
var ni = new NitIndex(toolcontext)
ni.start
-# TODO seek methods
-# TODO lister les methods qui retournent un certain type
-# TODO lister les methods qui utilisent un certain type
-# TODO lister les sous-types connus d'une type
-# TODO sorter par ordre alphabétique
+# TODO seek subclasses and super classes <.<class> >.<class>
+# TODO seek subclasses and super types <:<type> >:<type>
+# TODO seek with regexp
+# TODO standardize namespaces with private option
nitlanguage / nit.git / blobdiff