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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23