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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23