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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23