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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23