/[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 93738 - (show annotations)
Mon Dec 16 16:46:59 2013 UTC (6 years, 2 months ago) by zurfluhs
File size: 9173 byte(s)
Code Analysis: new rule

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23