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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23