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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23