/[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 93745 - (show annotations)
Tue Dec 17 14:12:29 2013 UTC (6 years, 1 month ago) by zurfluhs
File size: 9318 byte(s)
Code Analysis: 'deeply nested if' 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
60 settings.initialize_rule_settings (rules)
61
62 create classes_to_analyze.make
63 create rule_violations.make (100)
64 create completed_actions
65
66 create ignoredby.make (25)
67 create library_class.make (25)
68 create nonlibrary_class.make (25)
69 end
70
71 feature -- Analysis interface
72
73 add_completed_action (a_action: PROCEDURE [ANY, TUPLE [BOOLEAN]])
74 do
75 completed_actions.extend (a_action)
76 end
77
78 analyze
79 require
80 not is_running
81 local
82 l_rules_checker: CA_ALL_RULES_CHECKER
83 l_task: CA_RULE_CHECKING_TASK
84 do
85 is_running := True
86 -- TODO: caching
87 rule_violations.wipe_out
88
89 create l_rules_checker.make
90 across rules as l_rules loop
91 l_rules.item.clear_violations
92 if l_rules.item.is_enabled.value then -- important: only add enabled rules
93 if system_wide_check or else (not l_rules.item.is_system_wide) then
94 -- do not add system wide rules if we check only parts of the system
95 if attached {CA_STANDARD_RULE} l_rules.item as l_std_rule then
96
97 l_std_rule.prepare_checking (l_rules_checker)
98 -- TODO: prepare rules of other types?
99 end
100 end
101 end
102 end
103
104 create l_task.make (l_rules_checker, rules, classes_to_analyze, agent analysis_completed)
105 rota.run_task (l_task)
106 end
107
108 clear_classes_to_analyze
109 do
110 classes_to_analyze.wipe_out
111 end
112
113 add_whole_system
114 local
115 l_groups: LIST [CONF_GROUP]
116 l_cluster: CLUSTER_I
117 do
118 from
119 l_groups := eiffel_universe.groups
120 l_groups.start
121 until
122 l_groups.after
123 loop
124 l_cluster ?= l_groups.item_for_iteration
125 -- Only load top-level clusters, as they are loaded recursively afterwards
126 if l_cluster /= Void and then l_cluster.parent_cluster = Void then
127 add_cluster (l_cluster)
128 end
129 l_groups.forth
130 end
131
132 system_wide_check := True
133 end
134
135 add_cluster (a_cluster: CLUSTER_I)
136 local
137 l_conf_class: CONF_CLASS
138 l_class_i: CLASS_I
139 do
140 system_wide_check := False
141
142 from
143 a_cluster.classes.start
144 until
145 a_cluster.classes.after
146 loop
147 l_conf_class := a_cluster.classes.item_for_iteration
148 l_class_i := eiffel_universe.class_named (l_conf_class.name, a_cluster)
149 add_class (l_class_i)
150 a_cluster.classes.forth
151 end
152 if a_cluster.sub_clusters /= Void then
153 from
154 a_cluster.sub_clusters.start
155 until
156 a_cluster.sub_clusters.after
157 loop
158 add_cluster (a_cluster.sub_clusters.item_for_iteration)
159 a_cluster.sub_clusters.forth
160 end
161 end
162 end
163
164 add_group (a_group: CONF_GROUP)
165 require
166 a_group_not_void: a_group /= Void
167 local
168 l_conf_class: CONF_CLASS
169 l_class_i: CLASS_I
170 do
171 from
172 a_group.classes.start
173 until
174 a_group.classes.after
175 loop
176 l_conf_class := a_group.classes.item_for_iteration
177 l_class_i := eiffel_universe.class_named (l_conf_class.name, a_group)
178 add_class (l_class_i)
179 a_group.classes.forth
180 end
181 end
182
183 add_classes (a_classes: ITERABLE[CLASS_I])
184 do
185 system_wide_check := False
186
187 across a_classes as l_classes loop
188 add_class (l_classes.item)
189 end
190 end
191
192 add_class (a_class: CLASS_I)
193 local
194 l_class_c: CLASS_C
195 do
196 system_wide_check := False
197
198 if a_class.is_compiled then
199 l_class_c := a_class.compiled_class
200 check l_class_c /= Void end
201 classes_to_analyze.extend (l_class_c)
202
203 extract_indexes (l_class_c)
204 else
205 print ("Class " + a_class.name + " not compiled (skipped).%N")
206 end
207 end
208
209 feature -- Properties
210
211 is_running: BOOLEAN
212
213 analysis_successful: BOOLEAN
214
215 rules: LINKED_LIST[CA_RULE]
216
217 rule_violations: detachable HASH_TABLE[SORTED_TWO_WAY_LIST[CA_RULE_VIOLATION], CLASS_C]
218
219 preferences: PREFERENCES
220 do Result := settings.preferences end
221
222 feature {NONE} -- Implementation
223
224 analysis_completed
225 do
226 across classes_to_analyze as l_classes loop
227 rule_violations.extend (create {SORTED_TWO_WAY_LIST[CA_RULE_VIOLATION]}.make, l_classes.item)
228 end
229
230 across rules as l_rules loop
231 across l_rules.item.violations as l_v loop
232 -- check the ignore list
233 if is_violation_valid (l_v.item) then
234 rule_violations.at (l_v.item.affected_class).extend (l_v.item)
235 end
236 end
237 end
238
239 clear_classes_to_analyze
240
241 is_running := False
242 completed_actions.call ([True])
243 completed_actions.wipe_out
244 end
245
246 is_violation_valid (a_viol: CA_RULE_VIOLATION): BOOLEAN
247 local
248 l_affected_class: CLASS_C
249 l_rule: CA_RULE
250 do
251 l_affected_class := a_viol.affected_class
252 l_rule := a_viol.rule
253
254 Result := True
255
256 if (ignoredby.has (l_affected_class))
257 and then (ignoredby.at (l_affected_class)).has (l_rule.id) then
258 Result := False
259 end
260
261 if (not l_rule.checks_library_classes) and then library_class.at (l_affected_class) = True then
262 Result := False
263 end
264
265 if (not l_rule.checks_nonlibrary_classes) and then nonlibrary_class.at (l_affected_class) = True then
266 Result := False
267 end
268 end
269
270 settings: CA_SETTINGS
271
272 classes_to_analyze: LINKED_SET [CLASS_C]
273
274 system_wide_check: BOOLEAN
275
276 completed_actions: ACTION_SEQUENCE [TUPLE [BOOLEAN]]
277
278 frozen rota: detachable ROTA_S
279 -- Access to rota service
280 local
281 l_service_consumer: SERVICE_CONSUMER [ROTA_S]
282 do
283 create l_service_consumer
284 if l_service_consumer.is_service_available and then l_service_consumer.service.is_interface_usable then
285 Result := l_service_consumer.service
286 end
287 end
288
289
290 feature {NONE} -- Class-wide Options (From Indexing Clauses)
291
292 extract_indexes (a_class: CLASS_C)
293 local
294 l_ast: CLASS_AS
295 l_item: STRING_32
296 l_ignoredby: LINKED_LIST [STRING_32]
297 do
298 create l_ignoredby.make
299 l_ignoredby.compare_objects
300 library_class.force (False, a_class)
301 nonlibrary_class.force (False, a_class)
302 l_ast := a_class.ast
303
304 across l_ast.internal_top_indexes as l_indexes loop
305
306 if l_indexes.item.tag.name_32.is_equal ("ca_ignoredby") then
307 across l_indexes.item.index_list as l_list loop
308 l_item := l_list.item.string_value_32
309 l_item.prune_all ('%"')
310 l_ignoredby.extend (l_item)
311 end
312 elseif l_indexes.item.tag.name_32.is_equal ("ca_library") then
313 if not l_indexes.item.index_list.is_empty then
314 l_item := l_indexes.item.index_list.first.string_value_32
315 l_item.to_lower
316 l_item.prune_all ('%"')
317 if l_item.is_equal ("true") then
318 library_class.force (True, a_class)
319 elseif l_item.is_equal ("false") then
320 nonlibrary_class.force (True, a_class)
321 end
322 end
323 end
324 end
325
326 ignoredby.force (l_ignoredby, a_class)
327 end
328
329 ignoredby: HASH_TABLE [LINKED_LIST [STRING_32], CLASS_C]
330
331 library_class, nonlibrary_class: HASH_TABLE [BOOLEAN, CLASS_C]
332
333 invariant
334 -- law_of_non_contradiction: one class must not be both a library_class and a nonlibrary_class
335
336 end

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23