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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23