1 # This file is part of NIT ( http://www.nitlanguage.org ).
3 # Copyright 2012 Jean Privat <jean@pryen.org>
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
9 # http://www.apache.org/licenses/LICENSE-2.0
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
17 # Simple vavious processing on a AST
18 # The analysis warns on :
19 # * superfluous parentheses
20 # * nested "once" expressions
21 # * use of "while true" instead of "loop"
22 module simple_misc_analysis
26 redef class ToolContext
27 var simple_misc_analysis_phase
: Phase = new SimpleMiscAnalysisPhase(self, null)
30 private class SimpleMiscAnalysisPhase
32 redef fun process_nmodule
(nmodule
) do nmodule
.do_simple_misc_analysis
(toolcontext
)
36 # Visit the module to detect easy warnings that does not need the metamodel or the importation
37 # Warnings are displayed on the toolcontext
38 fun do_simple_misc_analysis
(toolcontext
: ToolContext)
40 var v
= new SimpleMiscVisitor(toolcontext
)
45 private class SimpleMiscVisitor
49 n
.accept_simple_misc
(self)
52 # Number of nested once
53 var once_count
: Int = 0
55 var toolcontext
: ToolContext
57 fun warning
(node
: ANode, tag
, msg
: String)
59 toolcontext
.warning
(node
.hot_location
, tag
, msg
)
62 init(toolcontext
: ToolContext)
64 self.toolcontext
= toolcontext
69 ###############################################################################
72 private fun accept_simple_misc
(v
: SimpleMiscVisitor)
77 private fun after_simple_misc
(v
: SimpleMiscVisitor) do end
80 redef class ASignature
81 redef fun after_simple_misc
(v
)
83 if self.n_opar
!= null and self.n_params
.is_empty
then
84 v
.warning
(self, "parentheses", "Warning: superfluous parentheses.")
90 # Warn in case of superfluous parentheses
91 private fun warn_parentheses
(v
: SimpleMiscVisitor) do end
95 redef fun warn_parentheses
(v
)
97 v
.warning
(self, "parentheses", "Warning: superfluous parentheses.")
101 redef class AParExprs
102 redef fun after_simple_misc
(v
)
104 if n_exprs
.is_empty
then
105 v
.warning
(self, "parentheses", "Warning: superfluous parentheses.")
110 redef class AReturnExpr
111 redef fun after_simple_misc
(v
)
115 e
.warn_parentheses
(v
)
120 redef class AEscapeExpr
121 redef fun after_simple_misc
(v
)
125 e
.warn_parentheses
(v
)
130 redef class AWhileExpr
131 redef fun after_simple_misc
(v
)
133 if n_expr
isa ATrueExpr then
134 v
.warning
(self, "loop", "Warning: use `loop` instead of `while true do`.")
136 n_expr
.warn_parentheses
(v
)
142 redef fun after_simple_misc
(v
)
144 n_expr
.warn_parentheses
(v
)
149 redef fun after_simple_misc
(v
)
151 n_expr
.warn_parentheses
(v
)
155 redef class AIfexprExpr
156 redef fun after_simple_misc
(v
)
158 n_expr
.warn_parentheses
(v
)
162 redef class AOnceExpr
163 redef fun accept_simple_misc
(v
)
165 if v
.once_count
> 0 then
166 v
.warning
(self, "nested-once", "Warning: useless once in a once expression.")
168 v
.once_count
= v
.once_count
+ 1
172 v
.once_count
= v
.once_count
- 1