/[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 93544 - (show annotations)
Tue Nov 26 11:14:22 2013 UTC (6 years, 2 months ago) by zurfluhs
File size: 7927 byte(s)
Code Analyzer:

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23