/[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 94862 - (show annotations)
Wed Apr 16 16:16:29 2014 UTC (5 years, 9 months ago) by apaolo
File size: 13625 byte(s)
Added new 'Empty uncommented feature' rule for Inspector Eiffel.
1 note
2 description: "THE Code Analyzer."
3 author: "Stefan Zurfluh"
4 date: "$Date$"
5 revision: "$Revision$"
6
7 class
8 CA_CODE_ANALYZER
9
10 inherit
11 SHARED_EIFFEL_PROJECT
12
13 CA_SHARED_NAMES
14
15 create
16 make
17
18 feature {NONE} -- Initialization
19
20 make
21 -- Initialization for `Current'.
22 do
23 create settings.make
24 create rules.make
25 -- Adding the rules.
26 rules.extend (create {CA_SELF_ASSIGNMENT_RULE}.make)
27 rules.extend (create {CA_UNUSED_ARGUMENT_RULE}.make)
28 rules.extend (create {CA_NPATH_RULE}.make (settings.preference_manager))
29 rules.extend (create {CA_EMPTY_IF_RULE}.make)
30 rules.extend (create {CA_FEATURE_NEVER_CALLED_RULE}.make)
31 rules.extend (create {CA_CQ_SEPARATION_RULE}.make)
32 rules.extend (create {CA_UNNEEDED_OT_LOCAL_RULE}.make)
33 rules.extend (create {CA_UNNEEDED_OBJECT_TEST_RULE}.make) -- Needs type info.
34 rules.extend (create {CA_NESTED_COMPLEXITY_RULE}.make (settings.preference_manager))
35 rules.extend (create {CA_MANY_ARGUMENTS_RULE}.make (settings.preference_manager))
36 rules.extend (create {CA_CREATION_PROC_EXPORTED_RULE}.make)
37 rules.extend (create {CA_VARIABLE_NOT_READ_RULE}.make)
38 rules.extend (create {CA_SEMICOLON_ARGUMENTS_RULE}.make)
39 rules.extend (create {CA_VERY_LONG_ROUTINE_RULE}.make (settings.preference_manager))
40 rules.extend (create {CA_VERY_BIG_CLASS_RULE}.make (settings.preference_manager))
41 rules.extend (create {CA_FEATURE_SECTION_COMMENT_RULE}.make)
42 rules.extend (create {CA_FEATURE_NOT_COMMENTED_RULE}.make)
43 rules.extend (create {CA_BOOLEAN_RESULT_RULE}.make)
44 rules.extend (create {CA_BOOLEAN_COMPARISON_RULE}.make)
45 rules.extend (create {CA_VERY_SHORT_IDENTIFIER_RULE}.make (settings.preference_manager))
46 rules.extend (create {CA_VERY_LONG_IDENTIFIER_RULE}.make (settings.preference_manager))
47 rules.extend (create {CA_MISSING_IS_EQUAL_RULE}.make)
48 rules.extend (create {CA_SIMPLIFIABLE_BOOLEAN_RULE}.make)
49 rules.extend (create {CA_SELF_COMPARISON_RULE}.make)
50 rules.extend (create {CA_TODO_RULE}.make)
51 rules.extend (create {CA_WRONG_LOOP_ITERATION_RULE}.make)
52 rules.extend (create {CA_INSPECT_INSTRUCTIONS_RULE}.make (settings.preference_manager))
53 rules.extend (create {CA_ATTRIBUTE_TO_LOCAL_RULE}.make)
54 rules.extend (create {CA_EMPTY_EFFECTIVE_ROUTINE_RULE}.make)
55 rules.extend (create {CA_IF_ELSE_NOT_EQUAL_RULE}.make)
56 rules.extend (create {CA_SHORT_CIRCUIT_IF_RULE}.make)
57 rules.extend (create {CA_ITERABLE_LOOP_RULE}.make) -- Needs type info.
58 rules.extend (create {CA_COUNT_EQUALS_ZERO_RULE}.make) -- Needs type info.
59 rules.extend (create {CA_DEEPLY_NESTED_IF_RULE}.make (settings.preference_manager))
60 rules.extend (create {CA_UNNEEDED_HELPER_VARIABLE_RULE}.make (settings.preference_manager))
61 rules.extend (create {CA_UNNEEDED_PARENTHESES_RULE}.make)
62 rules.extend (create {CA_CLASS_NAMING_CONVENTION_RULE}.make)
63 rules.extend (create {CA_FEATURE_NAMING_CONVENTION_RULE}.make)
64 rules.extend (create {CA_VARIABLE_NAMING_CONVENTION_RULE}.make)
65 rules.extend (create {CA_ARGUMENT_NAMING_CONVENTION_RULE}.make)
66 rules.extend (create {CA_UNNECESSARY_SIGN_OPERAND}.make)
67 rules.extend (create {CA_EMPTY_UNCOMMENTED_ROUTINE}.make)
68
69 settings.initialize_rule_settings (rules)
70
71 create classes_to_analyze.make
72 create rule_violations.make (100)
73 create completed_actions
74 create output_actions
75
76 create ignoredby.make (25)
77 create library_class.make (25)
78 create nonlibrary_class.make (25)
79 end
80
81 feature -- Analysis interface
82
83 add_completed_action (a_action: attached PROCEDURE [ANY, TUPLE [ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]]]])
84 -- Adds `a_action' to the list of procedures that will be
85 -- called when analysis has completed.
86 do
87 completed_actions.extend (a_action)
88 end
89
90 add_output_action (a_action: attached PROCEDURE [ANY, TUPLE [READABLE_STRING_GENERAL]])
91 -- Adds `a_action' to the procedures that are called for outputting status. The final results
92 -- (rule violations) are not given to these procedures.
93 do
94 output_actions.extend (a_action)
95 end
96
97 analyze
98 -- Analyze all the classes that have been added.
99 require
100 not is_running
101 local
102 l_rules_checker: CA_ALL_RULES_CHECKER
103 l_task: CA_RULE_CHECKING_TASK
104 l_rules_to_check: LINKED_LIST [CA_RULE]
105 do
106 is_running := True
107
108 create l_rules_checker.make
109 create l_rules_to_check.make
110 across rules as l_rules loop
111 l_rules.item.clear_violations
112 if is_rule_checkable (l_rules.item) then
113 l_rules_to_check.extend (l_rules.item)
114 -- Here we only prepare standard rules. The rule checking task will iterate again
115 -- through the rules and run the analysis on the enabled rules.
116 if attached {CA_STANDARD_RULE} l_rules.item as l_std_rule then
117 l_std_rule.prepare_checking (l_rules_checker)
118 end
119 end
120 end
121
122 create l_task.make (l_rules_checker, l_rules_to_check, classes_to_analyze, agent analysis_completed)
123 l_task.set_output_actions (output_actions)
124 rota.run_task (l_task)
125 end
126
127 is_rule_checkable (a_rule: attached CA_RULE): BOOLEAN
128 -- Will `a_rule' be checked based on the current preferences and based on the current
129 -- checking scope?
130 do
131 Result := a_rule.is_enabled.value
132 and then (system_wide_check or else (not a_rule.is_system_wide))
133 and then is_severity_enabled (a_rule.severity)
134 end
135
136 clear_classes_to_analyze
137 -- Removes all classes that have been added to the list of classes
138 -- to analyze.
139 do
140 classes_to_analyze.wipe_out
141 end
142
143 add_whole_system
144 -- Adds all the classes that are part of the current system. Classes of referenced libraries
145 -- will not be added.
146 local
147 l_cluster: CLUSTER_I
148 do
149 across
150 eiffel_universe.groups as l_groups
151 loop
152 l_cluster ?= l_groups.item
153 -- Only load top-level clusters, as the others will be loaded recursively afterwards.
154 if l_cluster /= Void and then l_cluster.parent_cluster = Void then
155 add_cluster (l_cluster)
156 end
157 end
158
159 system_wide_check := True
160 end
161
162 add_cluster (a_cluster: attached CLUSTER_I)
163 -- Add all classes of cluster `a_cluster'.
164 do
165 system_wide_check := False
166
167 if a_cluster.classes /= Void then
168 across a_cluster.classes as ic loop
169 add_class (ic.item)
170 end
171 end
172
173 if a_cluster.sub_clusters /= Void then
174 across a_cluster.sub_clusters as ic loop
175 add_cluster (ic.item)
176 end
177 end
178 end
179
180 add_group (a_group: attached CONF_GROUP)
181 -- Add all classes of the configuration group `a_group'.
182 require
183 a_group_not_void: a_group /= Void
184 do
185 if a_group.classes /= Void then
186 across a_group.classes as ic loop
187 add_class (ic.item)
188 end
189 end
190 end
191
192 add_classes (a_classes: attached ITERABLE [attached CONF_CLASS])
193 -- Add the classes `a_classes'.
194 do
195 system_wide_check := False
196
197 across a_classes as l_classes loop
198 add_class (l_classes.item)
199 end
200 end
201
202 add_class (a_class: attached CONF_CLASS)
203 -- Adds class `a_class'.
204 local
205 l_class_c: CLASS_C
206 do
207 system_wide_check := False
208
209 if attached {EIFFEL_CLASS_I} a_class as l_eiffel_class
210 and then attached l_eiffel_class.compiled_class as l_compiled
211 then
212 classes_to_analyze.extend (l_compiled)
213
214 extract_indexes (l_compiled)
215 else
216 output_actions.call ([ca_messages.class_skipped (a_class.name)])
217 end
218 end
219
220 feature -- Properties
221
222 is_running: BOOLEAN
223 -- Is code analysis running?
224
225 rules: LINKED_LIST [CA_RULE]
226 -- List of rules that will be used for analysis.
227
228 rule_violations: detachable HASH_TABLE [SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION], CLASS_C]
229 -- All found violations from the last analysis.
230
231 settings: CA_SETTINGS
232 -- The settings manager for Code Analysis.
233
234 preferences: PREFERENCES
235 -- Code Analysis preferences.
236 do Result := settings.preferences end
237
238 class_list: ITERABLE [CLASS_C]
239 -- List of classes that have been added.
240 do Result := classes_to_analyze end
241
242 feature {NONE} -- Implementation
243
244 csv_file_name: STRING = "last_analysis_result.csv"
245
246 csv_header: STRING = "Severity;Class;Location;Title;Description;Rule ID;Severity Score"
247
248 analysis_completed (a_exceptions: detachable ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]])
249 -- Will be called when the analysis task has finished. `a_exceptions'
250 -- contains a list of exception that occurred during analysis.
251 local
252 l_csv_writer: CA_CSV_WRITER
253 do
254 create l_csv_writer.make (csv_file_name, csv_header)
255
256 across rules as l_rules loop
257 across l_rules.item.violations as l_v loop
258 -- Check the ignore list.
259 if is_violation_valid (l_v.item) then
260 -- Make sure a list for this class exists in the hash table:
261 rule_violations.put (create {SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION]}.make, l_v.item.affected_class)
262 -- Add the violation.
263 rule_violations.at (l_v.item.affected_class).extend (l_v.item)
264 -- Log it.
265 l_csv_writer.add_line (l_v.item.csv_line)
266 end
267 end
268 end
269
270 l_csv_writer.close_file
271
272 clear_classes_to_analyze
273
274 is_running := False
275 completed_actions.call ([a_exceptions])
276 completed_actions.wipe_out
277 end
278
279 is_violation_valid (a_viol: attached CA_RULE_VIOLATION): BOOLEAN
280 -- Is the violation `a_viol' valid under the current settings
281 -- such as the rule ignore list of a class, or the library or
282 -- non-library status of a class?
283 local
284 l_affected_class: CLASS_C
285 l_rule: CA_RULE
286 do
287 l_affected_class := a_viol.affected_class
288 l_rule := a_viol.rule
289
290 Result := True
291
292 if ignoredby.has (l_affected_class)
293 and then (ignoredby.at (l_affected_class)).has (l_rule.id) then
294 Result := False
295 end
296
297 if (not l_rule.checks_library_classes) and then library_class.at (l_affected_class) then
298 Result := False
299 end
300
301 if (not l_rule.checks_nonlibrary_classes) and then nonlibrary_class.at (l_affected_class) then
302 Result := False
303 end
304 end
305
306 classes_to_analyze: LINKED_SET [CLASS_C]
307 -- List of classes that shall be analyzed.
308
309 system_wide_check: BOOLEAN
310 -- Shall the whole system be analyzed?
311
312 completed_actions: ACTION_SEQUENCE [TUPLE [ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]]]]
313 -- List of procedures to call when analysis has completed.
314
315 frozen rota: detachable ROTA_S
316 -- Accesses the rota service.
317 local
318 l_service_consumer: SERVICE_CONSUMER [ROTA_S]
319 do
320 create l_service_consumer
321 if attached l_service_consumer.service as l_service and then l_service.is_interface_usable then
322 Result := l_service
323 end
324 end
325
326 is_severity_enabled (a_severity: attached CA_RULE_SEVERITY): BOOLEAN
327 do
328 Result := (attached {CA_HINT} a_severity and settings.are_hints_enabled.value)
329 or else (attached {CA_SUGGESTION} a_severity and settings.are_suggestions_enabled.value)
330 or else (attached {CA_WARNING} a_severity and settings.are_warnings_enabled.value)
331 or else (attached {CA_ERROR} a_severity and settings.are_errors_enabled.value)
332 end
333
334 output_actions: ACTION_SEQUENCE [TUPLE [READABLE_STRING_GENERAL]]
335 -- Will be called whenever there is a message to output.
336
337 feature {NONE} -- Class-wide Options (From Indexing Clauses)
338
339 extract_indexes (a_class: attached CLASS_C)
340 -- Extracts options from the indexing clause of class `a_class'.
341 local
342 l_ast: CLASS_AS
343 l_ignoredby: LINKED_LIST [STRING_32]
344 do
345 create l_ignoredby.make
346 l_ignoredby.compare_objects -- We want to compare the actual strings.
347 -- Reset the class flags.
348 library_class.force (False, a_class)
349 nonlibrary_class.force (False, a_class)
350 l_ast := a_class.ast
351
352 if attached l_ast.internal_top_indexes as l_top then
353 search_indexing_tags (l_top, a_class, l_ignoredby)
354 end
355 if attached l_ast.internal_bottom_indexes as l_bottom then
356 search_indexing_tags (l_bottom, a_class, l_ignoredby)
357 end
358
359 ignoredby.force (l_ignoredby, a_class)
360 end
361
362 search_indexing_tags (a_clause: attached INDEXING_CLAUSE_AS; a_class: attached CLASS_C; a_ignoredby: attached LINKED_LIST [STRING_32])
363 -- Searches `a_clause' for settings relevant to code analysis.
364 local
365 l_item: STRING_32
366 do
367 across a_clause as ic loop
368 if ic.item.tag.name_32.is_equal ("ca_ignoredby") then
369 -- Class wants to ignore certain rules.
370 across ic.item.index_list as l_list loop
371 l_item := l_list.item.string_value_32
372 l_item.prune_all ('%"')
373 a_ignoredby.extend (l_item)
374 end
375 elseif ic.item.tag.name_32.is_equal ("ca_library") then
376 -- Class has information on whether it is a library class.
377 if not ic.item.index_list.is_empty then
378 l_item := ic.item.index_list.first.string_value_32
379 l_item.to_lower
380 l_item.prune_all ('%"')
381 if l_item.is_equal ("true") then
382 library_class.force (True, a_class)
383 elseif l_item.is_equal ("false") then
384 nonlibrary_class.force (True, a_class)
385 end
386 end
387 end
388 end
389 end
390
391 ignoredby: HASH_TABLE [LINKED_LIST [STRING_32], CLASS_C]
392 -- Maps classes to lists of rules (rule IDs) the class wants to be ignored by.
393
394 library_class, nonlibrary_class: HASH_TABLE [BOOLEAN, CLASS_C]
395 -- Stores classes that are marked as library or non-library classes.
396
397 invariant
398 -- law_of_non_contradiction: one class must not be both a library_class and a nonlibrary_class
399
400 end

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23