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

Properties

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

  ViewVC Help
Powered by ViewVC 1.1.23