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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23