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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 95468 - (hide annotations)
Sun Jul 20 09:11:06 2014 UTC (5 years, 5 months ago) by schmisam
File size: 15629 byte(s)
Added code analysis rule for comparison of object references.
Added test for the rule.
Some beautification of older rules.


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23