/[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 93681 - (hide annotations)
Tue Dec 10 14:20:43 2013 UTC (6 years, 1 month ago) by zurfluhs
File size: 8511 byte(s)
Code Analysis: new rules

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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23