/[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 93712 - (hide annotations)
Fri Dec 13 16:13:09 2013 UTC (6 years, 1 month ago) by zurfluhs
File size: 8790 byte(s)
Code Analysis: Rules

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23