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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23