/[eiffelstudio]/branches/eth/eve/Src/framework/code_analysis/ca_code_analyzer.e
ViewVC logotype

Contents of /branches/eth/eve/Src/framework/code_analysis/ca_code_analyzer.e

Parent Directory Parent Directory | Revision Log Revision Log


Revision 93736 - (show annotations)
Mon Dec 16 14:18:54 2013 UTC (6 years, 1 month ago) by zurfluhs
File size: 9062 byte(s)
Code Analysis: 'avoid not-equal comparison in if-else' rule
1 note
2 description: "Summary description for {CA_CODE_ANALYZER}."
3 author: "Stefan Zurfluh"
4 date: "$Date$"
5 revision: "$Revision$"
6
7 class
8 CA_CODE_ANALYZER
9
10 inherit {NONE}
11 SHARED_EIFFEL_PROJECT
12 CA_SHARED_NAMES
13
14 create
15 make
16
17 feature {NONE} -- Initialization
18
19 make
20 -- Initialization for `Current'.
21 do
22 create settings.make
23 create rules.make
24 -- Adding example rules
25 rules.extend (create {CA_SELF_ASSIGNMENT_RULE}.make)
26 rules.extend (create {CA_UNUSED_ARGUMENT_RULE}.make)
27 rules.extend (create {CA_NPATH_RULE}.make (settings.preference_manager))
28 rules.extend (create {CA_EMPTY_IF_RULE}.make)
29 rules.extend (create {CA_FEATURE_NEVER_CALLED_RULE}.make)
30 rules.extend (create {CA_CQ_SEPARATION_RULE}.make)
31 rules.extend (create {CA_UNNEEDED_OT_LOCAL_RULE}.make)
32 rules.extend (create {CA_UNNEEDED_OBJECT_TEST_RULE}.make)
33 rules.extend (create {CA_NESTED_COMPLEXITY_RULE}.make (settings.preference_manager))
34 rules.extend (create {CA_MANY_ARGUMENTS_RULE}.make (settings.preference_manager))
35 rules.extend (create {CA_CREATION_PROC_EXPORTED_RULE}.make)
36 rules.extend (create {CA_VARIABLE_NOT_READ_RULE}.make)
37 rules.extend (create {CA_SEMICOLON_ARGUMENTS_RULE}.make)
38 rules.extend (create {CA_VERY_LONG_ROUTINE_RULE}.make (settings.preference_manager))
39 rules.extend (create {CA_VERY_BIG_CLASS_RULE}.make (settings.preference_manager))
40 rules.extend (create {CA_FEATURE_SECTION_COMMENT_RULE}.make)
41 rules.extend (create {CA_FEATURE_NOT_COMMENTED_RULE}.make)
42 rules.extend (create {CA_BOOLEAN_RESULT_RULE}.make)
43 rules.extend (create {CA_BOOLEAN_COMPARISON_RULE}.make)
44 rules.extend (create {CA_VERY_SHORT_IDENTIFIER_RULE}.make (settings.preference_manager))
45 rules.extend (create {CA_VERY_LONG_IDENTIFIER_RULE}.make (settings.preference_manager))
46 rules.extend (create {CA_MISSING_IS_EQUAL_RULE}.make)
47 rules.extend (create {CA_SIMPLIFIABLE_BOOLEAN_RULE}.make)
48 rules.extend (create {CA_SELF_COMPARISON_RULE}.make)
49 rules.extend (create {CA_TODO_RULE}.make)
50 rules.extend (create {CA_WRONG_LOOP_ITERATION_RULE}.make)
51 rules.extend (create {CA_INSPECT_INSTRUCTIONS_RULE}.make (settings.preference_manager))
52 rules.extend (create {CA_ATTRIBUTE_TO_LOCAL_RULE}.make)
53 rules.extend (create {CA_EMPTY_EFFECTIVE_ROUTINE_RULE}.make)
54 rules.extend (create {CA_IF_ELSE_NOT_EQUAL_RULE}.make)
55
56 settings.initialize_rule_settings (rules)
57
58 create classes_to_analyze.make
59 create rule_violations.make (100)
60 create completed_actions
61
62 create ignoredby.make (25)
63 create library_class.make (25)
64 create nonlibrary_class.make (25)
65 end
66
67 feature -- Analysis interface
68
69 add_completed_action (a_action: PROCEDURE [ANY, TUPLE [BOOLEAN]])
70 do
71 completed_actions.extend (a_action)
72 end
73
74 analyze
75 require
76 not is_running
77 local
78 l_rules_checker: CA_ALL_RULES_CHECKER
79 l_task: CA_RULE_CHECKING_TASK
80 do
81 is_running := True
82 -- TODO: caching
83 rule_violations.wipe_out
84
85 create l_rules_checker.make
86 across rules as l_rules loop
87 l_rules.item.clear_violations
88 if l_rules.item.is_enabled.value then -- important: only add enabled rules
89 if system_wide_check or else (not l_rules.item.is_system_wide) then
90 -- do not add system wide rules if we check only parts of the system
91 if attached {CA_STANDARD_RULE} l_rules.item as l_std_rule then
92
93 l_std_rule.prepare_checking (l_rules_checker)
94 -- TODO: prepare rules of other types?
95 end
96 end
97 end
98 end
99
100 create l_task.make (l_rules_checker, rules, classes_to_analyze, agent analysis_completed)
101 rota.run_task (l_task)
102 end
103
104 clear_classes_to_analyze
105 do
106 classes_to_analyze.wipe_out
107 end
108
109 add_whole_system
110 local
111 l_groups: LIST [CONF_GROUP]
112 l_cluster: CLUSTER_I
113 do
114 from
115 l_groups := eiffel_universe.groups
116 l_groups.start
117 until
118 l_groups.after
119 loop
120 l_cluster ?= l_groups.item_for_iteration
121 -- Only load top-level clusters, as they are loaded recursively afterwards
122 if l_cluster /= Void and then l_cluster.parent_cluster = Void then
123 add_cluster (l_cluster)
124 end
125 l_groups.forth
126 end
127
128 system_wide_check := True
129 end
130
131 add_cluster (a_cluster: CLUSTER_I)
132 local
133 l_conf_class: CONF_CLASS
134 l_class_i: CLASS_I
135 do
136 system_wide_check := False
137
138 from
139 a_cluster.classes.start
140 until
141 a_cluster.classes.after
142 loop
143 l_conf_class := a_cluster.classes.item_for_iteration
144 l_class_i := eiffel_universe.class_named (l_conf_class.name, a_cluster)
145 add_class (l_class_i)
146 a_cluster.classes.forth
147 end
148 if a_cluster.sub_clusters /= Void then
149 from
150 a_cluster.sub_clusters.start
151 until
152 a_cluster.sub_clusters.after
153 loop
154 add_cluster (a_cluster.sub_clusters.item_for_iteration)
155 a_cluster.sub_clusters.forth
156 end
157 end
158 end
159
160 add_group (a_group: CONF_GROUP)
161 require
162 a_group_not_void: a_group /= Void
163 local
164 l_conf_class: CONF_CLASS
165 l_class_i: CLASS_I
166 do
167 from
168 a_group.classes.start
169 until
170 a_group.classes.after
171 loop
172 l_conf_class := a_group.classes.item_for_iteration
173 l_class_i := eiffel_universe.class_named (l_conf_class.name, a_group)
174 add_class (l_class_i)
175 a_group.classes.forth
176 end
177 end
178
179 add_classes (a_classes: ITERABLE[CLASS_I])
180 do
181 system_wide_check := False
182
183 across a_classes as l_classes loop
184 add_class (l_classes.item)
185 end
186 end
187
188 add_class (a_class: CLASS_I)
189 local
190 l_class_c: CLASS_C
191 do
192 system_wide_check := False
193
194 if a_class.is_compiled then
195 l_class_c := a_class.compiled_class
196 check l_class_c /= Void end
197 classes_to_analyze.extend (l_class_c)
198
199 extract_indexes (l_class_c)
200 else
201 print ("Class " + a_class.name + " not compiled (skipped).%N")
202 end
203 end
204
205 feature -- Properties
206
207 is_running: BOOLEAN
208
209 analysis_successful: BOOLEAN
210
211 rules: LINKED_LIST[CA_RULE]
212
213 rule_violations: detachable HASH_TABLE[SORTED_TWO_WAY_LIST[CA_RULE_VIOLATION], CLASS_C]
214
215 preferences: PREFERENCES
216 do Result := settings.preferences end
217
218 feature {NONE} -- Implementation
219
220 analysis_completed
221 do
222 across classes_to_analyze as l_classes loop
223 rule_violations.extend (create {SORTED_TWO_WAY_LIST[CA_RULE_VIOLATION]}.make, l_classes.item)
224 end
225
226 across rules as l_rules loop
227 across l_rules.item.violations as l_v loop
228 -- check the ignore list
229 if is_violation_valid (l_v.item) then
230 rule_violations.at (l_v.item.affected_class).extend (l_v.item)
231 end
232 end
233 end
234
235 clear_classes_to_analyze
236
237 is_running := False
238 completed_actions.call ([True])
239 completed_actions.wipe_out
240 end
241
242 is_violation_valid (a_viol: CA_RULE_VIOLATION): BOOLEAN
243 local
244 l_affected_class: CLASS_C
245 l_rule: CA_RULE
246 do
247 l_affected_class := a_viol.affected_class
248 l_rule := a_viol.rule
249
250 Result := True
251
252 if (ignoredby.has (l_affected_class))
253 and then (ignoredby.at (l_affected_class)).has (l_rule.id) then
254 Result := False
255 end
256
257 if (not l_rule.checks_library_classes) and then library_class.at (l_affected_class) = True then
258 Result := False
259 end
260
261 if (not l_rule.checks_nonlibrary_classes) and then nonlibrary_class.at (l_affected_class) = True then
262 Result := False
263 end
264 end
265
266 settings: CA_SETTINGS
267
268 classes_to_analyze: LINKED_SET [CLASS_C]
269
270 system_wide_check: BOOLEAN
271
272 completed_actions: ACTION_SEQUENCE [TUPLE [BOOLEAN]]
273
274 frozen rota: detachable ROTA_S
275 -- Access to rota service
276 local
277 l_service_consumer: SERVICE_CONSUMER [ROTA_S]
278 do
279 create l_service_consumer
280 if l_service_consumer.is_service_available and then l_service_consumer.service.is_interface_usable then
281 Result := l_service_consumer.service
282 end
283 end
284
285
286 feature {NONE} -- Class-wide Options (From Indexing Clauses)
287
288 extract_indexes (a_class: CLASS_C)
289 local
290 l_ast: CLASS_AS
291 l_item: STRING_32
292 l_ignoredby: LINKED_LIST [STRING_32]
293 do
294 create l_ignoredby.make
295 l_ignoredby.compare_objects
296 library_class.force (False, a_class)
297 nonlibrary_class.force (False, a_class)
298 l_ast := a_class.ast
299
300 across l_ast.internal_top_indexes as l_indexes loop
301
302 if l_indexes.item.tag.name_32.is_equal ("ca_ignoredby") then
303 across l_indexes.item.index_list as l_list loop
304 l_item := l_list.item.string_value_32
305 l_item.prune_all ('%"')
306 l_ignoredby.extend (l_item)
307 end
308 elseif l_indexes.item.tag.name_32.is_equal ("ca_library") then
309 if not l_indexes.item.index_list.is_empty then
310 l_item := l_indexes.item.index_list.first.string_value_32
311 l_item.to_lower
312 l_item.prune_all ('%"')
313 if l_item.is_equal ("true") then
314 library_class.force (True, a_class)
315 elseif l_item.is_equal ("false") then
316 nonlibrary_class.force (True, a_class)
317 end
318 end
319 end
320 end
321
322 ignoredby.force (l_ignoredby, a_class)
323 end
324
325 ignoredby: HASH_TABLE [LINKED_LIST [STRING_32], CLASS_C]
326
327 library_class, nonlibrary_class: HASH_TABLE [BOOLEAN, CLASS_C]
328
329 invariant
330 -- law_of_non_contradiction: one class must not be both a library_class and a nonlibrary_class
331
332 end

Properties

Name Value
svn:eol-style native
svn:keywords Author Date ID Revision

  ViewVC Help
Powered by ViewVC 1.1.23