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 # Phases of the processing of nit programs
22 redef class ToolContext
23 # The various registered phases to performs
24 # The order in the poset is the dependence of phases
26 # While you can directly modify the poset (nodes and edges),
27 # it is often simpler to use the constructor in `Phase`
28 var phases
= new POSet[Phase]
31 var opt_disable_phase
= new OptionArray("DEBUG: Disable a specific phase; use `list` to get the list.", "--disable-phase")
34 var opt_sloppy
= new OptionBool("DEBUG: force lazy semantic analysis of the source-code", "--sloppy")
40 option_context
.add_option
(opt_disable_phase
, opt_sloppy
)
43 redef fun process_options
(args
)
47 for v
in opt_disable_phase
.value
do
49 for p
in phases_list
do
50 var deps
= p
.in_hierarchy
.direct_greaters
54 print
"{p} (dep: {deps.join(", ")})"
62 if v
!= p
.to_s
then continue
66 if not found
then fatal_error
(null, "Error: no phase named `{v}`. Use `list` to list all phases.")
69 if opt_sloppy
.value
then semantize_is_lazy
= true
72 # The list of registered phases in the application order.
73 var phases_list
: Sequence[Phase] is lazy
do
74 var phases
= self.phases
.to_a
75 self.phases
.sort
(phases
)
79 # Is `phase_process_npropdef` not called automatically by `run_phases`?
81 # When set to true, it is the responsibility of the tools
83 # Is false by default.
84 var semantize_is_lazy
= false is writable
86 # Set of already analyzed modules.
87 private var phased_modules
= new HashSet[AModule]
89 # Run all registered phases on a set of modules
90 fun run_phases
(nmodules
: Collection[AModule])
93 self.info
("*** SEMANTIC ANALYSIS ***", 1)
96 var phases
= phases_list
98 for phase
in phases
do
99 self.info
(" registered phases: {phase}", 2)
102 for nmodule
in nmodules
do
103 if phased_modules
.has
(nmodule
) then continue
104 phased_modules
.add nmodule
106 self.info
("Semantic analysis module {nmodule.location.file.filename}", 2)
108 var vannot
= new AnnotationPhaseVisitor
109 vannot
.enter_visit
(nmodule
)
111 for phase
in phases
do
112 if phase
.disabled
then continue
113 assert phase
.toolcontext
== self
114 var errcount
= self.error_count
115 phase
.process_nmodule
(nmodule
)
116 if errcount
!= self.error_count
then
120 errcount
= self.error_count
121 for nclassdef
in nmodule
.n_classdefs
do
122 assert phase
.toolcontext
== self
123 phase
.process_nclassdef
(nclassdef
)
124 if not semantize_is_lazy
then for npropdef
in nclassdef
.n_propdefs
do
125 assert phase
.toolcontext
== self
126 phase_process_npropdef
(phase
, npropdef
)
129 if errcount
!= self.error_count
then
133 for na
in vannot
.annotations
do
135 if p
isa AAnnotations then p
= p
.parent
137 phase
.process_annotated_node
(p
, na
)
139 if errcount
!= self.error_count
then
148 self.info
("*** END SEMANTIC ANALYSIS: {time1-time0} ***", 2)
153 # Process the given `phase` on the `npropdef`
154 # Called by `run_phases`
155 protected fun phase_process_npropdef
(phase
: Phase, npropdef
: APropdef)
157 phase
.process_npropdef
(npropdef
)
160 # Run the phase on the given npropdef.
161 # Does nothing if `semantize_is_lazy` is false.
162 fun run_phases_on_npropdef
(npropdef
: APropdef)
164 if not semantize_is_lazy
then return
165 if npropdef
.is_phased
then return
166 npropdef
.is_phased
= true
168 #self.info("Semantic analysis of property {npropdef.location.file.filename}", 0)
170 var phases
= phases_list
171 for phase
in phases
do
172 if phase
.disabled
then continue
173 assert phase
.toolcontext
== self
174 phase_process_npropdef
(phase
, npropdef
)
181 # Is the propdef already analyzed by `run_phases_on_npropdef`.
182 # Unused unless `semantize_is_lazy` is true.
183 private var is_phased
= false
186 # Collect all annotation
187 private class AnnotationPhaseVisitor
190 # The collected annotations
191 var annotations
= new Array[AAnnotation]
196 if n
isa AAnnotation then annotations
.add n
200 # Abstraction of steps in the analysis/processing of Nit programs
201 # Specific phases should implements one of the `process_*` method
203 # The toolcontext instance attached to the phase
204 var toolcontext
: ToolContext
206 # The dependence relation of the phase with the other phases
207 var in_hierarchy
: POSetElement[Phase] is noinit
209 # The explicit dependences, used to initialize `in_importation`
210 var depends
: nullable Collection[Phase]
212 # Initialize and register a phase to the toolcontext
215 in_hierarchy
= toolcontext
.phases
.add_node
(self)
216 var depends
= self.depends
217 if depends
!= null then
219 toolcontext
.phases
.add_edge
(self, d
)
224 # By default, the name is the lowercased prefix of the classname
225 redef fun to_s
do return class_name
.strip_extension
("Phase").to_snake_case
227 # Is the phase globally disabled?
228 # A disabled phase is not called automatically called by `ToolContext::run_phases` and cie.
230 # Warning: disabling a phase may cause subsequent phases to work in a degraded way or to fail.
231 var disabled
= false is writable
233 # Specific actions to execute on the whole tree of a module
235 fun process_nmodule
(nmodule
: AModule) do end
237 # Specific actions to execute on the tree of a class definition
238 # Note that the order of the visit is the one of the file
240 fun process_nclassdef
(nclassdef
: AClassdef) do end
242 # Specific actions to execute on the tree of a property
243 # Note that the order of the visit is the one of the file
245 fun process_npropdef
(npropdef
: APropdef) do end
247 # Specific actions to execute on annotated nodes
248 # Note that the order of the visit is the one of the file
250 fun process_annotated_node
(node
: ANode, nat
: AAnnotation) do end