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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23