/[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 95467 - (show annotations)
Sun Jul 20 07:49:56 2014 UTC (5 years, 5 months ago) by schmisam
File size: 15567 byte(s)
Added code analysis rule for Void checking using 'is_equal'
Added test for this rule.


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_caseless (100) -- Rule IDs should be case insensitive.
25
26 -- Adding the rules.
27 add_rule (create {CA_SELF_ASSIGNMENT_RULE}.make)
28 add_rule (create {CA_UNUSED_ARGUMENT_RULE}.make)
29 add_rule (create {CA_NPATH_RULE}.make (settings.preference_manager))
30 add_rule (create {CA_EMPTY_IF_RULE}.make)
31 add_rule (create {CA_FEATURE_NEVER_CALLED_RULE}.make)
32 add_rule (create {CA_CQ_SEPARATION_RULE}.make)
33 add_rule (create {CA_UNNEEDED_OT_LOCAL_RULE}.make)
34 add_rule (create {CA_UNNEEDED_OBJECT_TEST_RULE}.make) -- Needs type info.
35 add_rule (create {CA_NESTED_COMPLEXITY_RULE}.make (settings.preference_manager))
36 add_rule (create {CA_MANY_ARGUMENTS_RULE}.make (settings.preference_manager))
37 add_rule (create {CA_CREATION_PROC_EXPORTED_RULE}.make)
38 add_rule (create {CA_VARIABLE_NOT_READ_RULE}.make)
39 add_rule (create {CA_SEMICOLON_ARGUMENTS_RULE}.make)
40 add_rule (create {CA_VERY_LONG_ROUTINE_RULE}.make (settings.preference_manager))
41 add_rule (create {CA_VERY_BIG_CLASS_RULE}.make (settings.preference_manager))
42 add_rule (create {CA_FEATURE_SECTION_COMMENT_RULE}.make)
43 add_rule (create {CA_FEATURE_NOT_COMMENTED_RULE}.make)
44 add_rule (create {CA_BOOLEAN_RESULT_RULE}.make)
45 add_rule (create {CA_BOOLEAN_COMPARISON_RULE}.make)
46 add_rule (create {CA_VERY_SHORT_IDENTIFIER_RULE}.make (settings.preference_manager))
47 add_rule (create {CA_VERY_LONG_IDENTIFIER_RULE}.make (settings.preference_manager))
48 add_rule (create {CA_MISSING_IS_EQUAL_RULE}.make)
49 add_rule (create {CA_SIMPLIFIABLE_BOOLEAN_RULE}.make)
50 add_rule (create {CA_SELF_COMPARISON_RULE}.make)
51 add_rule (create {CA_TODO_RULE}.make)
52 add_rule (create {CA_WRONG_LOOP_ITERATION_RULE}.make)
53 add_rule (create {CA_INSPECT_INSTRUCTIONS_RULE}.make (settings.preference_manager))
54 add_rule (create {CA_ATTRIBUTE_TO_LOCAL_RULE}.make)
55 add_rule (create {CA_EMPTY_EFFECTIVE_ROUTINE_RULE}.make)
56 add_rule (create {CA_IF_ELSE_NOT_EQUAL_RULE}.make)
57 add_rule (create {CA_SHORT_CIRCUIT_IF_RULE}.make)
58 add_rule (create {CA_ITERABLE_LOOP_RULE}.make) -- Needs type info.
59 add_rule (create {CA_COUNT_EQUALS_ZERO_RULE}.make) -- Needs type info.
60 add_rule (create {CA_DEEPLY_NESTED_IF_RULE}.make (settings.preference_manager))
61 add_rule (create {CA_UNNEEDED_HELPER_VARIABLE_RULE}.make (settings.preference_manager))
62 add_rule (create {CA_UNNEEDED_PARENTHESES_RULE}.make)
63 add_rule (create {CA_CLASS_NAMING_CONVENTION_RULE}.make)
64 add_rule (create {CA_FEATURE_NAMING_CONVENTION_RULE}.make)
65 add_rule (create {CA_LOCAL_NAMING_CONVENTION_RULE}.make (settings.preference_manager))
66 add_rule (create {CA_ARGUMENT_NAMING_CONVENTION_RULE}.make (settings.preference_manager))
67 add_rule (create {CA_UNNECESSARY_SIGN_OPERATOR_RULE}.make)
68 add_rule (create {CA_EMPTY_UNCOMMENTED_ROUTINE_RULE}.make)
69 add_rule (create {CA_UNNEEDED_ACCESSOR_FUNCTION_RULE}.make)
70 add_rule (create {CA_MERGEABLE_FEATURE_CLAUSES_RULE}.make)
71 add_rule (create {CA_EMPTY_RESCUE_CLAUSE_RULE}.make)
72 add_rule (create {CA_INSPECT_NO_WHEN_RULE}.make)
73 add_rule (create {CA_EXPLICIT_REDUNDANT_INHERITANCE_RULE}.make)
74 add_rule (create {CA_UNDESIRABLE_COMMENT_CONTENT_RULE}.make (settings.preference_manager))
75 add_rule (create {CA_INHERIT_FROM_ANY_RULE}.make)
76 add_rule (create {CA_DOUBLE_NEGATION_RULE}.make)
77 add_rule (create {CA_EMPTY_LOOP_RULE}.make)
78 add_rule (create {CA_MISSING_CREATION_PROC_WITHOUT_ARGS_RULE}.make)
79 add_rule (create {CA_COMMENT_NOT_WELL_PHRASED_RULE}.make)
80 add_rule (create {CA_OBJECT_CREATION_WITHIN_LOOP_RULE}.make)
81 add_rule (create {CA_EMPTY_CREATION_PROC_RULE}.make)
82 add_rule (create {CA_VOID_CHECK_USING_IS_EQUAL_RULE}.make)
83
84 settings.initialize_rule_settings (rules)
85
86 create classes_to_analyze.make
87 create rule_violations.make (100)
88 create completed_actions
89 create output_actions
90
91 create ignoredby.make (25)
92 create library_class.make (25)
93 create nonlibrary_class.make (25)
94 end
95
96 feature -- Analysis interface
97
98 add_completed_action (a_action: attached PROCEDURE [ANY, TUPLE [ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]]]])
99 -- Adds `a_action' to the list of procedures that will be
100 -- called when analysis has completed.
101 do
102 completed_actions.extend (a_action)
103 end
104
105 add_output_action (a_action: attached PROCEDURE [ANY, TUPLE [READABLE_STRING_GENERAL]])
106 -- Adds `a_action' to the procedures that are called for outputting status. The final results
107 -- (rule violations) are not given to these procedures.
108 do
109 output_actions.extend (a_action)
110 end
111
112 analyze
113 -- Analyze all the classes that have been added.
114 require
115 not is_running
116 local
117 l_rules_checker: CA_ALL_RULES_CHECKER
118 l_task: CA_RULE_CHECKING_TASK
119 l_rules_to_check: LINKED_LIST [CA_RULE]
120 do
121 is_running := True
122
123 create l_rules_checker.make
124 create l_rules_to_check.make
125 across rules as l_rules loop
126 l_rules.item.clear_violations
127 if is_rule_checkable (l_rules.item) then
128 l_rules_to_check.extend (l_rules.item)
129 -- Here we only prepare standard rules. The rule checking task will iterate again
130 -- through the rules and run the analysis on the enabled rules.
131 if attached {CA_STANDARD_RULE} l_rules.item as l_std_rule then
132 l_std_rule.prepare_checking (l_rules_checker)
133 end
134 end
135 end
136
137 create l_task.make (l_rules_checker, l_rules_to_check, classes_to_analyze, agent analysis_completed)
138 l_task.set_output_actions (output_actions)
139 if attached rota as l_rota then
140 rota.run_task (l_task)
141 else
142 -- No ROTA task is available, we execute the task synchronously.
143 from
144
145 until
146 not l_task.has_next_step
147 loop
148 l_task.step
149 end
150 end
151 end
152
153 is_rule_checkable (a_rule: attached CA_RULE): BOOLEAN
154 -- Will `a_rule' be checked based on the current preferences and based on the current
155 -- checking scope?
156 do
157 Result := a_rule.is_enabled.value
158 and then (system_wide_check or else (not a_rule.is_system_wide))
159 and then is_severity_enabled (a_rule.severity)
160 end
161
162 clear_classes_to_analyze
163 -- Removes all classes that have been added to the list of classes
164 -- to analyze.
165 do
166 classes_to_analyze.wipe_out
167 end
168
169 add_whole_system
170 -- Adds all the classes that are part of the current system. Classes of referenced libraries
171 -- will not be added.
172 do
173 across
174 eiffel_universe.groups as l_groups
175 loop
176 -- Only load top-level clusters, as the others will be loaded recursively afterwards.
177 if attached {CLUSTER_I} l_groups.item as l_cluster and then l_cluster.parent_cluster = Void then
178 add_cluster (l_cluster)
179 end
180 end
181
182 system_wide_check := True
183 end
184
185 add_cluster (a_cluster: attached CLUSTER_I)
186 -- Add all classes of cluster `a_cluster'.
187 do
188 system_wide_check := False
189
190 if a_cluster.classes /= Void then
191 across a_cluster.classes as ic loop
192 add_class (ic.item)
193 end
194 end
195
196 if a_cluster.sub_clusters /= Void then
197 across a_cluster.sub_clusters as ic loop
198 add_cluster (ic.item)
199 end
200 end
201 end
202
203 add_group (a_group: attached CONF_GROUP)
204 -- Add all classes of the configuration group `a_group'.
205 require
206 a_group_not_void: a_group /= Void
207 do
208 if a_group.classes /= Void then
209 across a_group.classes as ic loop
210 add_class (ic.item)
211 end
212 end
213 end
214
215 add_classes (a_classes: attached ITERABLE [attached CONF_CLASS])
216 -- Add the classes `a_classes'.
217 do
218 system_wide_check := False
219
220 across a_classes as l_classes loop
221 add_class (l_classes.item)
222 end
223 end
224
225 add_class (a_class: attached CONF_CLASS)
226 -- Adds class `a_class'.
227 do
228 system_wide_check := False
229
230 if attached {EIFFEL_CLASS_I} a_class as l_eiffel_class
231 and then attached l_eiffel_class.compiled_class as l_compiled
232 then
233 classes_to_analyze.extend (l_compiled)
234
235 extract_indexes (l_compiled)
236 else
237 output_actions.call ([ca_messages.class_skipped (a_class.name)])
238 end
239 end
240
241
242 force_preferences (a_preferences: LIST [TUPLE [rule_id: READABLE_STRING_GENERAL; preference_name: STRING; preference_value: READABLE_STRING_GENERAL]])
243 -- Forcefully set the preferences in `a_preferences' to the specified values,
244 -- overwriting the current ones.
245 local
246 l_full_preference_name: STRING
247 l_preference: PREFERENCE
248 do
249 -- Disable all rules.
250 across rules as ic loop
251 ic.item.is_enabled.set_value (False)
252 end
253
254 across a_preferences as ic loop
255 if rules.has_key (ic.item.rule_id) then
256 l_full_preference_name := rules.found_item.full_preference_name (ic.item.preference_name)
257 l_preference := preferences.get_preference (l_full_preference_name)
258
259 if attached l_preference then
260 l_preference.set_value_from_string (ic.item.preference_value)
261 else
262 output_actions.call ([ca_messages.preference_not_found (l_full_preference_name)])
263 end
264
265 else
266 output_actions.call ([ca_messages.rule_not_found (ic.item.rule_id)])
267 end
268 end
269 end
270
271
272 feature -- Properties
273
274 is_running: BOOLEAN
275 -- Is code analysis running?
276
277 rules: STRING_TABLE [CA_RULE]
278 -- Table containing the rules that will be used for analysis. Rules are indexed by ID.
279
280 add_rule (a_rule: CA_RULE)
281 -- Adds `a_rule' to the rules list.
282 require
283 not_added_yet: not rules.has (a_rule.id)
284 do
285 rules.extend (a_rule, a_rule.id)
286 ensure
287 added: rules.has (a_rule.id)
288 end
289
290 rule_violations: detachable HASH_TABLE [SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION], CLASS_C]
291 -- All found violations from the last analysis.
292
293 settings: CA_SETTINGS
294 -- The settings manager for Code Analysis.
295
296 preferences: PREFERENCES
297 -- Code Analysis preferences.
298 do Result := settings.preferences end
299
300 class_list: ITERABLE [CLASS_C]
301 -- List of classes that have been added.
302 do Result := classes_to_analyze end
303
304 feature {NONE} -- Implementation
305
306 csv_file_name: STRING = "last_analysis_result.csv"
307
308 csv_header: STRING = "Severity;Class;Location;Title;Description;Rule ID;Severity Score"
309
310 analysis_completed (a_exceptions: detachable ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]])
311 -- Will be called when the analysis task has finished. `a_exceptions'
312 -- contains a list of exception that occurred during analysis.
313 local
314 l_csv_writer: CA_CSV_WRITER
315 do
316 create l_csv_writer.make (eiffel_project.project_location.target_path.extended (csv_file_name), csv_header)
317
318 across rules as l_rules loop
319 across l_rules.item.violations as l_v loop
320 -- Check the ignore list.
321 if is_violation_valid (l_v.item) then
322 -- Make sure a list for this class exists in the hash table:
323 rule_violations.put (create {SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION]}.make, l_v.item.affected_class)
324 -- Add the violation.
325 rule_violations.at (l_v.item.affected_class).extend (l_v.item)
326 -- Log it.
327 l_csv_writer.add_line (l_v.item.csv_line)
328 end
329 end
330 end
331
332 l_csv_writer.close_file
333
334 clear_classes_to_analyze
335
336 is_running := False
337 completed_actions.call ([a_exceptions])
338 completed_actions.wipe_out
339 end
340
341 is_violation_valid (a_viol: attached CA_RULE_VIOLATION): BOOLEAN
342 -- Is the violation `a_viol' valid under the current settings
343 -- such as the rule ignore list of a class, or the library or
344 -- non-library status of a class?
345 local
346 l_affected_class: CLASS_C
347 l_rule: CA_RULE
348 do
349 l_affected_class := a_viol.affected_class
350 l_rule := a_viol.rule
351
352 Result := True
353
354 if ignoredby.has (l_affected_class)
355 and then (ignoredby.at (l_affected_class)).has (l_rule.id) then
356 Result := False
357 end
358
359 if (not l_rule.checks_library_classes) and then library_class.at (l_affected_class) then
360 Result := False
361 end
362
363 if (not l_rule.checks_nonlibrary_classes) and then nonlibrary_class.at (l_affected_class) then
364 Result := False
365 end
366 end
367
368 classes_to_analyze: LINKED_SET [CLASS_C]
369 -- List of classes that shall be analyzed.
370
371 system_wide_check: BOOLEAN
372 -- Shall the whole system be analyzed?
373
374 completed_actions: ACTION_SEQUENCE [TUPLE [ITERABLE [TUPLE [detachable EXCEPTION, CLASS_C]]]]
375 -- List of procedures to call when analysis has completed.
376
377 frozen rota: detachable ROTA_S
378 -- Accesses the rota service.
379 local
380 l_service_consumer: SERVICE_CONSUMER [ROTA_S]
381 do
382 create l_service_consumer
383 if attached l_service_consumer.service as l_service and then l_service.is_interface_usable then
384 Result := l_service
385 end
386 end
387
388 is_severity_enabled (a_severity: attached CA_RULE_SEVERITY): BOOLEAN
389 do
390 Result := (attached {CA_HINT} a_severity and settings.are_hints_enabled.value)
391 or else (attached {CA_SUGGESTION} a_severity and settings.are_suggestions_enabled.value)
392 or else (attached {CA_WARNING} a_severity and settings.are_warnings_enabled.value)
393 or else (attached {CA_ERROR} a_severity and settings.are_errors_enabled.value)
394 end
395
396 output_actions: ACTION_SEQUENCE [TUPLE [READABLE_STRING_GENERAL]]
397 -- Will be called whenever there is a message to output.
398
399 feature {NONE} -- Class-wide Options (From Indexing Clauses)
400
401 extract_indexes (a_class: attached CLASS_C)
402 -- Extracts options from the indexing clause of class `a_class'.
403 local
404 l_ast: CLASS_AS
405 l_ignoredby: LINKED_LIST [STRING_32]
406 do
407 create l_ignoredby.make
408 l_ignoredby.compare_objects -- We want to compare the actual strings.
409 -- Reset the class flags.
410 library_class.force (False, a_class)
411 nonlibrary_class.force (False, a_class)
412 l_ast := a_class.ast
413
414 if attached l_ast.internal_top_indexes as l_top then
415 search_indexing_tags (l_top, a_class, l_ignoredby)
416 end
417 if attached l_ast.internal_bottom_indexes as l_bottom then
418 search_indexing_tags (l_bottom, a_class, l_ignoredby)
419 end
420
421 ignoredby.force (l_ignoredby, a_class)
422 end
423
424 search_indexing_tags (a_clause: attached INDEXING_CLAUSE_AS; a_class: attached CLASS_C; a_ignoredby: attached LINKED_LIST [STRING_32])
425 -- Searches `a_clause' for settings relevant to code analysis.
426 local
427 l_item: STRING_32
428 do
429 across a_clause as ic loop
430 if attached ic.item.tag as l_tag then
431 if l_tag.name_32.same_string_general ("ca_ignoredby") then
432 -- Class wants to ignore certain rules.
433 across ic.item.index_list as l_list loop
434 l_item := l_list.item.string_value_32
435 l_item.prune_all ('%"')
436 a_ignoredby.extend (l_item)
437 end
438 elseif l_tag.name_32.is_equal ("ca_library") then
439 -- Class has information on whether it is a library class.
440 if not ic.item.index_list.is_empty then
441 l_item := ic.item.index_list.first.string_value_32
442 l_item.to_lower
443 l_item.prune_all ('%"')
444 if l_item.is_equal ("true") then
445 library_class.force (True, a_class)
446 elseif l_item.is_equal ("false") then
447 nonlibrary_class.force (True, a_class)
448 end
449 end
450 end
451 end
452 end
453 end
454
455 ignoredby: HASH_TABLE [LINKED_LIST [STRING_32], CLASS_C]
456 -- Maps classes to lists of rules (rule IDs) the class wants to be ignored by.
457
458 library_class, nonlibrary_class: HASH_TABLE [BOOLEAN, CLASS_C]
459 -- Stores classes that are marked as library or non-library classes.
460
461 invariant
462 -- law_of_non_contradiction: one class must not be both a library_class and a nonlibrary_class
463
464 end

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23