/[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 95440 - (hide annotations)
Thu Jul 17 00:25:44 2014 UTC (5 years, 6 months ago) by schmisam
File size: 15253 byte(s)
Added code analysis rule for empty loops.
Added tests for empty loops.

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23