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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23