/[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 93712 - (show annotations)
Fri Dec 13 16:13:09 2013 UTC (6 years, 2 months ago) by zurfluhs
File size: 8790 byte(s)
Code Analysis: Rules

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23