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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23