nitdoc: migrate phases to model view

Signed-off-by: Alexandre Terrasa <alexandre@moz-code.org>

diff --git a/src/doc/doc_phases/doc_concerns.nit b/src/doc/doc_phases/doc_concerns.nit
index 5c9b2e9..a84adb2 100644 (file)
--- a/src/doc/doc_phases/doc_concerns.nit
+++ b/src/doc/doc_phases/doc_concerns.nit
@@ -63,7 +63,7 @@ redef class MGroupPage
                        for mclass in mmodule.intro_mclasses do
                                if doc.mclasses.has(mclass) then intros.add mclass
                        end
-                       for mclass in mmodule.collect_redef_mclasses(v.ctx.min_visibility) do
+                       for mclass in mmodule.collect_redef_mclasses(v.doc) do
                                if doc.mclasses.has(mclass) then redefs.add mclass
                        end
                end

diff --git a/src/doc/doc_phases/doc_console.nit b/src/doc/doc_phases/doc_console.nit
index b118019..070b86b 100644 (file)
--- a/src/doc/doc_phases/doc_console.nit
+++ b/src/doc/doc_phases/doc_console.nit
@@ -20,7 +20,6 @@ module doc_console
 
 import semantize
 import doc_commands
-import doc_extract
 import doc_poset
 import doc::console_templates
 

diff --git a/src/doc/doc_phases/doc_extract.nit b/src/doc/doc_phases/doc_extract.nit
deleted file mode 100644 (file)
index fcca4ea..0000000
--- a/src/doc/doc_phases/doc_extract.nit
+++ /dev/null
@@ -1,223 +0,0 @@
-# This file is part of NIT ( http://www.nitlanguage.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
-#
-# http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Extract data mentities of Model that will be documented.
-#
-# ExtractionPhase populates the DocModel that is the base for all other phases.
-# No DocPages are created at this level.
-#
-# TODO build a model instead?
-module doc_extract
-
-import doc_base
-
-redef class ToolContext
-
-       # Do not generate documentation for attributes.
-       var opt_no_attributes = new OptionBool("Ignore the attributes", "--no-attributes")
-
-       # Do not generate documentation for private properties.
-       var opt_private = new OptionBool("Also generate private API", "--private")
-
-       redef init do
-               super
-               option_context.add_option(opt_no_attributes, opt_private)
-       end
-
-       # Minimum visibility displayed.
-       #
-       # See `opt_private`.
-       var min_visibility: MVisibility is lazy do
-               if opt_private.value then return none_visibility
-               return protected_visibility
-       end
-end
-
-# ExtractionPhase populates the DocModel.
-class ExtractionPhase
-       super DocPhase
-
-       private var new_model: Model is noinit
-
-       # Populates the given DocModel.
-       redef fun apply do
-               doc.populate(self)
-       end
-
-       # Should we exclude this `mpackage` from the documentation?
-       fun ignore_mentity(mentity: MEntity): Bool do
-               if mentity isa MModule then
-                       return mentity.is_fictive or mentity.is_test_suite
-               else if mentity isa MClass then
-                       return mentity.visibility < ctx.min_visibility
-               else if mentity isa MClassDef then
-                       return ignore_mentity(mentity.mclass)
-               else if mentity isa MProperty then
-                       return ignore_mentity(mentity.intro_mclassdef) or
-                               mentity.visibility < ctx.min_visibility or
-                               (ctx.opt_no_attributes.value and mentity isa MAttribute) or
-                               mentity isa MInnerClass
-               else if mentity isa MPropDef then
-                       return ignore_mentity(mentity.mclassdef) or
-                               ignore_mentity(mentity.mproperty)
-               end
-               return false
-       end
-end
-
-# TODO Should I rebuild a new Model from filtered data?
-redef class DocModel
-
-       # MPackages that will be documented.
-       var mpackages = new HashSet[MPackage]
-
-       # MGroups that will be documented.
-       var mgroups = new HashSet[MGroup]
-
-       # MModules that will be documented.
-       var mmodules = new HashSet[MModule]
-
-       # MClasses that will be documented.
-       var mclasses = new HashSet[MClass]
-
-       # MClassDefs that will be documented.
-       var mclassdefs = new HashSet[MClassDef]
-
-       # MProperties that will be documented.
-       var mproperties = new HashSet[MProperty]
-
-       # MPropdefs that will be documented.
-       var mpropdefs = new HashSet[MPropDef]
-
-       # Populate `self` from internal `model`.
-       fun populate(v: ExtractionPhase) do
-               populate_mpackages(v)
-               populate_mclasses(v)
-               populate_mproperties(v)
-       end
-
-       # Populates the `mpackages` set.
-       private fun populate_mpackages(v: ExtractionPhase) do
-               for mpackage in model.mpackages do
-                       if v.ignore_mentity(mpackage) then continue
-                       self.mpackages.add mpackage
-                       for mgroup in mpackage.mgroups do
-                               if v.ignore_mentity(mgroup) then continue
-                               self.mgroups.add mgroup
-                               for mmodule in mgroup.mmodules do
-                                       if v.ignore_mentity(mmodule) then continue
-                                       self.mmodules.add mmodule
-                               end
-                       end
-               end
-       end
-
-       # Populates the `mclasses` set.
-       private fun populate_mclasses(v: ExtractionPhase) do
-               for mclass in model.mclasses do
-                       if v.ignore_mentity(mclass) then continue
-                       self.mclasses.add mclass
-                       for mclassdef in mclass.mclassdefs do
-                               if v.ignore_mentity(mclassdef) then continue
-                               self.mclassdefs.add mclassdef
-                       end
-               end
-       end
-
-       # Populates the `mproperties` set.
-       private fun populate_mproperties(v: ExtractionPhase) do
-               for mproperty in model.mproperties do
-                       if v.ignore_mentity(mproperty) then continue
-                       self.mproperties.add mproperty
-                       for mpropdef in mproperty.mpropdefs do
-                               if v.ignore_mentity(mpropdef) then continue
-                               self.mpropdefs.add mpropdef
-                       end
-               end
-       end
-
-       # Lists all MEntities in the model.
-       #
-       # FIXME invalidate cache if `self` is modified.
-       var mentities: Collection[MEntity] is lazy do
-               var res = new HashSet[MEntity]
-               res.add_all mpackages
-               res.add_all mgroups
-               res.add_all mmodules
-               res.add_all mclasses
-               res.add_all mclassdefs
-               res.add_all mproperties
-               res.add_all mpropdefs
-               return res
-       end
-
-       # Searches MEntities that match `name`.
-       fun mentities_by_name(name: String): Array[MEntity] do
-               var res = new Array[MEntity]
-               for mentity in mentities do
-                       if mentity.name != name then continue
-                       res.add mentity
-               end
-               return res
-       end
-
-       # Looks up a MEntity by its `namespace`.
-       #
-       # Usefull when `mentities_by_name` by return conflicts.
-       #
-       # Path can be the shortest possible to disambiguise like `Class::property`.
-       # In case of larger conflicts, a more complex namespace can be given like
-       # `package::module::Class::prop`.
-       fun mentities_by_namespace(namespace: String): Array[MEntity] do
-               var res = new Array[MEntity]
-               for mentity in mentities do
-                       mentity.mentities_by_namespace(namespace, res)
-               end
-               return res
-       end
-end
-
-redef class MEntity
-       # Looks up a MEntity by its `namespace` from `self`.
-       private fun mentities_by_namespace(namespace: String, res: Array[MEntity]) do end
-
-       private fun lookup_in(mentities: Collection[MEntity], namespace: String, res: Array[MEntity]) do
-               var parts = namespace.split_once_on("::")
-               var name = parts.shift
-               for mentity in mentities do
-                       if mentity.name != name then continue
-                       if parts.is_empty then
-                               res.add mentity
-                       else
-                               mentity.mentities_by_namespace(parts.first, res)
-                       end
-               end
-       end
-end
-
-redef class MPackage
-       redef fun mentities_by_namespace(namespace, res) do lookup_in(mgroups, namespace, res)
-end
-
-redef class MGroup
-       redef fun mentities_by_namespace(namespace, res) do lookup_in(mmodules, namespace, res)
-end
-
-redef class MModule
-       redef fun mentities_by_namespace(namespace, res) do lookup_in(mclassdefs, namespace, res)
-end
-
-redef class MClassDef
-       redef fun mentities_by_namespace(namespace, res) do lookup_in(mpropdefs, namespace, res)
-end

diff --git a/src/doc/doc_phases/doc_html.nit b/src/doc/doc_phases/doc_html.nit
index 623b241..c2ed988 100644 (file)
--- a/src/doc/doc_phases/doc_html.nit
+++ b/src/doc/doc_phases/doc_html.nit
@@ -339,8 +339,8 @@ redef class MModulePage
                # TODO filter here?
                super
                var mclasses = new HashSet[MClass]
-               mclasses.add_all mentity.collect_intro_mclasses(v.ctx.min_visibility)
-               mclasses.add_all mentity.collect_redef_mclasses(v.ctx.min_visibility)
+               mclasses.add_all mentity.collect_intro_mclasses(v.doc)
+               mclasses.add_all mentity.collect_redef_mclasses(v.doc)
                if mclasses.is_empty then return
                var list = new UnorderedList
                list.css_classes.add "list-unstyled list-labeled"
@@ -447,8 +447,8 @@ redef class MClassPage
 
        private fun mclass_inherited_mprops(v: RenderHTMLPhase, doc: DocModel): Set[MProperty] do
                var res = new HashSet[MProperty]
-               var local = mentity.collect_local_mproperties(v.ctx.min_visibility)
-               for mprop in mentity.collect_inherited_mproperties(v.ctx.min_visibility) do
+               var local = mentity.collect_local_mproperties(v.doc)
+               for mprop in mentity.collect_inherited_mproperties(v.doc) do
                        if local.has(mprop) then continue
                        #if mprop isa MMethod and mprop.is_init then continue
                        if mprop.intro.mclassdef.mclass.name == "Object" and

diff --git a/src/doc/doc_phases/doc_indexing.nit b/src/doc/doc_phases/doc_indexing.nit
index 1e74138..5d0b9c3 100644 (file)
--- a/src/doc/doc_phases/doc_indexing.nit
+++ b/src/doc/doc_phases/doc_indexing.nit
@@ -15,7 +15,7 @@
 # Manage indexing of Nit model for Nitdoc QuickSearch.
 module doc_indexing
 
-import doc_extract
+import doc_base
 import html_templates::html_model # FIXME maybe this phase should depend on `html_render`
 private import json::static
 

diff --git a/src/doc/doc_phases/doc_intros_redefs.nit b/src/doc/doc_phases/doc_intros_redefs.nit
index abc4f1d..605d2e1 100644 (file)
--- a/src/doc/doc_phases/doc_intros_redefs.nit
+++ b/src/doc/doc_phases/doc_intros_redefs.nit
@@ -58,10 +58,10 @@ redef class DefinitionArticle
                var section = new TabbedGroup("{mentity.nitdoc_id}.intros_redefs")
                section.toc_title = "Intros / Redefs"
                var group = new PanelGroup("list.group", "List")
-               var intros = mmodule.collect_intro_mclassdefs(v.ctx.min_visibility).to_a
+               var intros = mmodule.collect_intro_mclassdefs(v.doc).to_a
                doc.mainmodule.linearize_mclassdefs(intros)
                group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.intros", "Introduces", intros)
-               var redefs = mmodule.collect_redef_mclassdefs(v.ctx.min_visibility).to_a
+               var redefs = mmodule.collect_redef_mclassdefs(v.doc).to_a
                doc.mainmodule.linearize_mclassdefs(redefs)
                group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.redefs", "Redefines", redefs)
                section.add_child group
@@ -73,11 +73,11 @@ redef class DefinitionArticle
                var section = new TabbedGroup("{mentity.nitdoc_id}.intros_redefs")
                section.toc_title = "Intros / Redefs"
                var group = new PanelGroup("list.group", "List")
-               var intros = mclassdef.collect_intro_mpropdefs(v.ctx.min_visibility).to_a
+               var intros = mclassdef.collect_intro_mpropdefs(v.doc).to_a
                # FIXME avoid diff changes
                # v.ctx.mainmodule.linearize_mpropdefs(intros)
                group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.intros", "Introduces", intros)
-               var redefs = mclassdef.collect_redef_mpropdefs(v.ctx.min_visibility).to_a
+               var redefs = mclassdef.collect_redef_mpropdefs(v.doc).to_a
                # FIXME avoid diff changes
                # v.ctx.mainmodule.linearize_mpropdefs(redefs)
                group.add_child new MEntitiesListArticle("{mentity.nitdoc_id}.redefs", "Redefines", redefs)

diff --git a/src/doc/doc_phases/doc_pages.nit b/src/doc/doc_phases/doc_pages.nit
index e08a385..1f7148f 100644 (file)
--- a/src/doc/doc_phases/doc_pages.nit
+++ b/src/doc/doc_phases/doc_pages.nit
@@ -15,7 +15,7 @@
 # Create DocPage instances for each documentated Mentity.
 module doc_pages
 
-import doc_extract
+import doc_base
 
 # ExtractionPhase populates the DocModel with DocPage.
 class MakePagePhase

diff --git a/src/doc/doc_phases/doc_readme.nit b/src/doc/doc_phases/doc_readme.nit
index 605ddac..b34fc7f 100644 (file)
--- a/src/doc/doc_phases/doc_readme.nit
+++ b/src/doc/doc_phases/doc_readme.nit
@@ -258,7 +258,7 @@ redef class ListCommand
                if mentity isa MModule then
                        v.add_article new MEntitiesListArticle("Classes", null, mentity.mclassdefs)
                else if mentity isa MClass then
-                       var mprops = mentity.collect_intro_mproperties(public_visibility)
+                       var mprops = mentity.collect_intro_mproperties(mentity.public_view)
                        v.add_article new MEntitiesListArticle("Methods", null, mprops.to_a)
                else if mentity isa MClassDef then
                        v.add_article new MEntitiesListArticle("Methods", null, mentity.mpropdefs)