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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23