1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
7 # http://www.apache.org/licenses/LICENSE-2.0
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
15 # Nodes for modules and files.
16 module model
::module_compound
20 import namespace_members
24 # Creates one modules by inner namespace. The full name of the modules begin
25 # with the namespace’s full name, and end with the unqualified name of the file,
26 # without the extension.
28 # Note: If a module associated to the root namespace is needed, it is added to
29 # the graph only when `put_edges` is called.
34 # Modules corresponding to the namespaces defined/redefined in the file.
35 private var inner_namespaces
= new Array[Module]
37 # `model_id` of the classes declared in the file.
38 private var inner_classes
= new Array[String]
40 # The last component of the path, without the extension.
42 # Used as the unqualified name of the modules.
43 private var basename
: String = ""
49 redef fun location
=(location
: nullable Location) do
51 for m
in inner_namespaces
do m
.location
= location
54 redef fun name
=(name
: String) do
55 # Example: `MyClass.java`
57 var match
= name
.search_last
(".")
62 basename
= name
.substring
(0, match
.from
)
64 # Update the modules’ name.
65 for m
in inner_namespaces
do m
.update_name
68 redef fun declare_namespace
(id
: String, full_name
: String) do
71 assert not full_name
.is_empty
or id
.is_empty
else
72 sys
.stderr
.write
"Inner mamespace declarations without name are not yet supported (except for the root namespace).\n"
74 m
= new Module(graph
, self, new NamespaceRef(id
, full_name
))
76 inner_namespaces
.add m
79 redef fun declare_class
(id
, name
, prot
) do
80 assert not id
.is_empty
else
81 sys
.stderr
.write
"Inner class declarations without ID are not yet supported.\n"
86 redef fun put_in_graph
do
87 # Do not add `self` to the Neo4j graph...
88 # ... but add its modules...
89 for m
in inner_namespaces
do m
.put_in_graph
90 # ... and add `self` to the indexes.
91 if model_id
!= "" then graph
.by_id
[model_id
] = self
95 # If the file contains some classes in the root namespace, add an implicit
96 # module to handle them.
98 # This method is called by `ProjectGraph.add_global_modules` and assumes
99 # that all the namespaces are already fully set and put in the graph.
100 fun declare_root_namespace
do
102 declare_namespace
("", "")
103 inner_namespaces
.last
.put_in_graph
107 # Does this file contain classes in the root namespace?
108 private fun has_globals
: Bool do
109 var root
= graph
.by_id
[""]
110 for c
in inner_classes
do
111 if graph
.class_to_ns
[c
] == root
then return true
119 # For each file, there is one module by inner namespace.
124 # The file that declares the module.
125 var file_compound
: FileCompound
127 # The namespace defined or redefined by the module.
128 var namespace
: NamespaceRef
132 self.labels
.add
("MModule")
138 # Update the short name of the module to the `basename` of the file that
140 fun update_name
do name
= file_compound
.basename
142 redef fun put_in_graph
do
146 redef fun put_edges
do
147 var ns_compound
= namespace
.seek_in
(graph
)
148 var self_class
= ns_compound
.self_class
150 graph
.add_edge
(ns_compound
, "DECLARES", self)
152 for c
in file_compound
.inner_classes
do
153 if graph
.class_to_ns
[c
] != ns_compound
then continue
154 var class_compound
= graph
.by_id
[c
].as(ClassCompound)
155 graph
.add_edge
(self, "INTRODUCES", class_compound
)
156 graph
.add_edge
(self, "DEFINES", class_compound
.class_def
)
159 if self_class
isa SelfClass then
160 # We assume that only one file is linked to the namespace.
161 # TODO When Doxygen will provide a way to know which file defines which member, use it.
162 self_class
.location
= file_compound
.location
163 graph
.add_edge
(self, "INTRODUCES", self_class
)
164 graph
.add_edge
(self, "DEFINES", self_class
.class_def
)
169 # Adds the `add_global_modules` phase to `ProjectGraph`.
170 redef class ProjectGraph
172 # Project’s source files.
173 var files
: SimpleCollection[FileCompound] = new Array[FileCompound]
175 # Add the modules that define the root namespace.
177 # **Must** be called before any call to `put_edges`, and after all the
178 # namespaces are fully set and put in the graph.
180 # Note: This method is not idempotent so it has to be called only once.
181 fun add_global_modules
do
182 for f
in files
do f
.declare_root_namespace