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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23