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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23