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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23