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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23