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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23