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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23