+# 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.
+
+# Computes importation and class hierarchy lists.
+module doc_hierarchies
+
+import doc_structure
+import doc_poset
+
+# Insert inheritance / importation lists in the page.
+class InheritanceListsPhase
+ super DocPhase
+
+ # Used to sort list by name.
+ var name_sorter = new MEntityNameSorter
+
+ redef fun apply do
+ for page in doc.pages do
+ if page isa MEntityPage then page.build_inh_list(self, doc)
+ end
+ end
+end
+
+redef class MEntityPage
+
+ # Build importation / inheritance list for this page.
+ fun build_inh_list(v: InheritanceListsPhase, doc: DocModel) do end
+end
+
+redef class MModulePage
+ redef fun build_inh_list(v, doc) do
+ var section = new ImportationListSection
+ var imports = self.imports.to_a
+ v.name_sorter.sort(imports)
+ section.children.add new HierarchyListArticle(mentity, "Imports", imports)
+ var clients = self.clients.to_a
+ v.name_sorter.sort(clients)
+ section.children.add new HierarchyListArticle(mentity, "Clients", clients)
+ root.children.insert(section, 1)
+ end
+end
+
+redef class MClassPage
+ redef fun build_inh_list(v, doc) do
+ var section = new InheritanceListSection
+ var parents = self.parents.to_a
+ v.name_sorter.sort(parents)
+ section.children.add new HierarchyListArticle(mentity, "Parents", parents)
+ var ancestors = self.ancestors.to_a
+ v.name_sorter.sort(ancestors)
+ section.children.add new HierarchyListArticle(mentity, "Ancestors", ancestors)
+ var children = self.children.to_a
+ v.name_sorter.sort(children)
+ section.children.add new HierarchyListArticle(mentity, "Children", children)
+ var descendants = self.descendants.to_a
+ v.name_sorter.sort(descendants)
+ section.children.add new HierarchyListArticle(mentity, "Descendants", descendants)
+ root.children.insert(section, 1)
+ end
+end
+
+# FIXME diff hack
+class ImportationListSection
+ super DocSection
+end
+
+# FIXME diff hack
+class InheritanceListSection
+ super DocSection
+end
+
+# Dislay a hierarchical list of mentities.
+class HierarchyListArticle
+ super MEntityArticle
+
+ # Title displayed in the top of this list.
+ var list_title: String
+
+ # MEntities to display in this list.
+ var mentities: Array[MEntity]
+end