/[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 93943 - (show annotations)
Thu Jan 9 13:38:38 2014 UTC (6 years ago) by zurfluhs
File size: 9856 byte(s)
Code Analysis: 'unneeded helper' rule
1 note
2 description: "Summary description for {CA_CODE_ANALYZER}."
3 author: "Stefan Zurfluh"
4 date: "$Date$"
5 revision: "$Revision$"
6
7 class
8 CA_CODE_ANALYZER
9
10 inherit {NONE}
11 SHARED_EIFFEL_PROJECT
12 CA_SHARED_NAMES
13
14 create
15 make
16
17 feature {NONE} -- Initialization
18
19 make
20 -- Initialization for `Current'.
21 do
22 create settings.make
23 create rules.make
24 -- Adding example rules.
25 rules.extend (create {CA_SELF_ASSIGNMENT_RULE}.make)
26 rules.extend (create {CA_UNUSED_ARGUMENT_RULE}.make)
27 rules.extend (create {CA_NPATH_RULE}.make (settings.preference_manager))
28 rules.extend (create {CA_EMPTY_IF_RULE}.make)
29 rules.extend (create {CA_FEATURE_NEVER_CALLED_RULE}.make)
30 rules.extend (create {CA_CQ_SEPARATION_RULE}.make)
31 rules.extend (create {CA_UNNEEDED_OT_LOCAL_RULE}.make)
32 rules.extend (create {CA_UNNEEDED_OBJECT_TEST_RULE}.make)
33 rules.extend (create {CA_NESTED_COMPLEXITY_RULE}.make (settings.preference_manager))
34 rules.extend (create {CA_MANY_ARGUMENTS_RULE}.make (settings.preference_manager))
35 rules.extend (create {CA_CREATION_PROC_EXPORTED_RULE}.make)
36 rules.extend (create {CA_VARIABLE_NOT_READ_RULE}.make)
37 rules.extend (create {CA_SEMICOLON_ARGUMENTS_RULE}.make)
38 rules.extend (create {CA_VERY_LONG_ROUTINE_RULE}.make (settings.preference_manager))
39 rules.extend (create {CA_VERY_BIG_CLASS_RULE}.make (settings.preference_manager))
40 rules.extend (create {CA_FEATURE_SECTION_COMMENT_RULE}.make)
41 rules.extend (create {CA_FEATURE_NOT_COMMENTED_RULE}.make)
42 rules.extend (create {CA_BOOLEAN_RESULT_RULE}.make)
43 rules.extend (create {CA_BOOLEAN_COMPARISON_RULE}.make)
44 rules.extend (create {CA_VERY_SHORT_IDENTIFIER_RULE}.make (settings.preference_manager))
45 rules.extend (create {CA_VERY_LONG_IDENTIFIER_RULE}.make (settings.preference_manager))
46 rules.extend (create {CA_MISSING_IS_EQUAL_RULE}.make)
47 rules.extend (create {CA_SIMPLIFIABLE_BOOLEAN_RULE}.make)
48 rules.extend (create {CA_SELF_COMPARISON_RULE}.make)
49 rules.extend (create {CA_TODO_RULE}.make)
50 rules.extend (create {CA_WRONG_LOOP_ITERATION_RULE}.make)
51 rules.extend (create {CA_INSPECT_INSTRUCTIONS_RULE}.make (settings.preference_manager))
52 rules.extend (create {CA_ATTRIBUTE_TO_LOCAL_RULE}.make)
53 rules.extend (create {CA_EMPTY_EFFECTIVE_ROUTINE_RULE}.make)
54 rules.extend (create {CA_IF_ELSE_NOT_EQUAL_RULE}.make)
55 rules.extend (create {CA_SHORT_CIRCUIT_IF_RULE}.make)
56 rules.extend (create {CA_ITERABLE_LOOP_RULE}.make)
57 rules.extend (create {CA_COUNT_EQUALS_ZERO_RULE}.make)
58 rules.extend (create {CA_DEEPLY_NESTED_IF_RULE}.make (settings.preference_manager))
59 rules.extend (create {CA_UNNEEDED_HELPER_VARIABLE_RULE}.make (settings.preference_manager))
60 rules.extend (create {CA_UNNEEDED_PARENTHESES_RULE}.make)
61
62 settings.initialize_rule_settings (rules)
63
64 create classes_to_analyze.make
65 create rule_violations.make (100)
66 create completed_actions
67
68 create ignoredby.make (25)
69 create library_class.make (25)
70 create nonlibrary_class.make (25)
71 end
72
73 feature -- Analysis interface
74
75 add_completed_action (a_action: PROCEDURE [ANY, TUPLE [BOOLEAN]])
76 do
77 completed_actions.extend (a_action)
78 end
79
80 analyze
81 require
82 not is_running
83 local
84 l_rules_checker: CA_ALL_RULES_CHECKER
85 l_task: CA_RULE_CHECKING_TASK
86 do
87 is_running := True
88 -- TODO: caching
89 -- rule_violations.wipe_out
90
91 create l_rules_checker.make
92 across rules as l_rules loop
93 l_rules.item.clear_violations
94 if l_rules.item.is_enabled.value then -- Important: only add enabled rules.
95 if system_wide_check or else (not l_rules.item.is_system_wide) then
96 -- Do not add system wide rules if we check only parts of the system.
97 if attached {CA_STANDARD_RULE} l_rules.item as l_std_rule then
98
99 l_std_rule.prepare_checking (l_rules_checker)
100 -- TODO: prepare rules of other types?
101 end
102 end
103 end
104 end
105
106 create l_task.make (l_rules_checker, rules, classes_to_analyze, agent analysis_completed)
107 rota.run_task (l_task)
108 end
109
110 clear_classes_to_analyze
111 do
112 classes_to_analyze.wipe_out
113 end
114
115 add_whole_system
116 local
117 l_groups: LIST [CONF_GROUP]
118 l_cluster: CLUSTER_I
119 do
120 from
121 l_groups := eiffel_universe.groups
122 l_groups.start
123 until
124 l_groups.after
125 loop
126 l_cluster ?= l_groups.item_for_iteration
127 -- Only load top-level clusters, as the others will be loaded recursively afterwards.
128 if l_cluster /= Void and then l_cluster.parent_cluster = Void then
129 add_cluster (l_cluster)
130 end
131 l_groups.forth
132 end
133
134 system_wide_check := True
135 end
136
137 add_cluster (a_cluster: CLUSTER_I)
138 local
139 l_conf_class: CONF_CLASS
140 l_class_i: CLASS_I
141 do
142 system_wide_check := False
143
144 from
145 a_cluster.classes.start
146 until
147 a_cluster.classes.after
148 loop
149 l_conf_class := a_cluster.classes.item_for_iteration
150 l_class_i := eiffel_universe.class_named (l_conf_class.name, a_cluster)
151 add_class (l_class_i)
152 a_cluster.classes.forth
153 end
154 if a_cluster.sub_clusters /= Void then
155 from
156 a_cluster.sub_clusters.start
157 until
158 a_cluster.sub_clusters.after
159 loop
160 add_cluster (a_cluster.sub_clusters.item_for_iteration)
161 a_cluster.sub_clusters.forth
162 end
163 end
164 end
165
166 add_group (a_group: CONF_GROUP)
167 require
168 a_group_not_void: a_group /= Void
169 local
170 l_conf_class: CONF_CLASS
171 l_class_i: CLASS_I
172 do
173 from
174 a_group.classes.start
175 until
176 a_group.classes.after
177 loop
178 l_conf_class := a_group.classes.item_for_iteration
179 l_class_i := eiffel_universe.class_named (l_conf_class.name, a_group)
180 add_class (l_class_i)
181 a_group.classes.forth
182 end
183 end
184
185 add_classes (a_classes: ITERABLE [CLASS_I])
186 do
187 system_wide_check := False
188
189 across a_classes as l_classes loop
190 add_class (l_classes.item)
191 end
192 end
193
194 add_class (a_class: CLASS_I)
195 local
196 l_class_c: CLASS_C
197 do
198 system_wide_check := False
199
200 if a_class.is_compiled then
201 l_class_c := a_class.compiled_class
202 check l_class_c /= Void end
203 classes_to_analyze.extend (l_class_c)
204
205 extract_indexes (l_class_c)
206 else
207 print ("Class " + a_class.name + " not compiled (skipped).%N")
208 end
209 end
210
211 feature -- Properties
212
213 is_running: BOOLEAN
214
215 analysis_successful: BOOLEAN
216
217 rules: LINKED_LIST [CA_RULE]
218
219 rule_violations: detachable HASH_TABLE [SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION], CLASS_C]
220
221 preferences: PREFERENCES
222 do Result := settings.preferences end
223
224 class_list: ITERABLE [CLASS_C]
225 do Result := classes_to_analyze end
226
227 feature {NONE} -- Implementation
228
229 analysis_completed
230 do
231 -- across classes_to_analyze as l_classes loop
232 -- rule_violations.extend (create {SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION]}.make, l_classes.item)
233 -- end
234
235 across rules as l_rules loop
236 across l_rules.item.violations as l_v loop
237 -- Check the ignore list.
238 if is_violation_valid (l_v.item) then
239 -- Make sure a list for this class exists in the hash table:
240 rule_violations.put (create {SORTED_TWO_WAY_LIST [CA_RULE_VIOLATION]}.make, l_v.item.affected_class)
241 -- Add the violation.
242 rule_violations.at (l_v.item.affected_class).extend (l_v.item)
243 end
244 end
245 end
246
247 clear_classes_to_analyze
248
249 is_running := False
250 completed_actions.call ([True])
251 completed_actions.wipe_out
252 end
253
254 is_violation_valid (a_viol: CA_RULE_VIOLATION): BOOLEAN
255 local
256 l_affected_class: CLASS_C
257 l_rule: CA_RULE
258 do
259 l_affected_class := a_viol.affected_class
260 l_rule := a_viol.rule
261
262 Result := True
263
264 if (ignoredby.has (l_affected_class))
265 and then (ignoredby.at (l_affected_class)).has (l_rule.id) then
266 Result := False
267 end
268
269 if (not l_rule.checks_library_classes) and then library_class.at (l_affected_class) = True then
270 Result := False
271 end
272
273 if (not l_rule.checks_nonlibrary_classes) and then nonlibrary_class.at (l_affected_class) = True then
274 Result := False
275 end
276 end
277
278 settings: CA_SETTINGS
279
280 classes_to_analyze: LINKED_SET [CLASS_C]
281
282 system_wide_check: BOOLEAN
283
284 completed_actions: ACTION_SEQUENCE [TUPLE [BOOLEAN]]
285
286 frozen rota: detachable ROTA_S
287 -- Accesses the rota service.
288 local
289 l_service_consumer: SERVICE_CONSUMER [ROTA_S]
290 do
291 create l_service_consumer
292 if l_service_consumer.is_service_available and then l_service_consumer.service.is_interface_usable then
293 Result := l_service_consumer.service
294 end
295 end
296
297
298 feature {NONE} -- Class-wide Options (From Indexing Clauses)
299
300 extract_indexes (a_class: CLASS_C)
301 local
302 l_ast: CLASS_AS
303 l_item: STRING_32
304 l_ignoredby: LINKED_LIST [STRING_32]
305 do
306 create l_ignoredby.make
307 l_ignoredby.compare_objects
308 library_class.force (False, a_class)
309 nonlibrary_class.force (False, a_class)
310 l_ast := a_class.ast
311
312 if attached l_ast.internal_top_indexes then
313 across l_ast.internal_top_indexes as l_indexes loop
314
315 if l_indexes.item.tag.name_32.is_equal ("ca_ignoredby") then
316 across l_indexes.item.index_list as l_list loop
317 l_item := l_list.item.string_value_32
318 l_item.prune_all ('%"')
319 l_ignoredby.extend (l_item)
320 end
321 elseif l_indexes.item.tag.name_32.is_equal ("ca_library") then
322 if not l_indexes.item.index_list.is_empty then
323 l_item := l_indexes.item.index_list.first.string_value_32
324 l_item.to_lower
325 l_item.prune_all ('%"')
326 if l_item.is_equal ("true") then
327 library_class.force (True, a_class)
328 elseif l_item.is_equal ("false") then
329 nonlibrary_class.force (True, a_class)
330 end
331 end
332 end
333 end
334 end
335
336 ignoredby.force (l_ignoredby, a_class)
337 end
338
339 ignoredby: HASH_TABLE [LINKED_LIST [STRING_32], CLASS_C]
340
341 library_class, nonlibrary_class: HASH_TABLE [BOOLEAN, CLASS_C]
342
343 invariant
344 -- law_of_non_contradiction: one class must not be both a library_class and a nonlibrary_class
345
346 end

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23