/[eiffelstudio]/branches/eth/eve/Src/framework/code_analysis/ca_code_analyzer.e
ViewVC logotype

Annotation of /branches/eth/eve/Src/framework/code_analysis/ca_code_analyzer.e

Parent Directory Parent Directory | Revision Log Revision Log


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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23