doc: use 'module' instead of 'package' in comments
[nit.git] / src / analysis / instantiated_type_analysis.nit
1 # This file is part of NIT ( http://www.nitlanguage.org ).
2 #
3 # Copyright 2009 Jean-Sebastien Gelinas <calestar@gmail.com>
4 #
5 # Licensed under the Apache License, Version 2.0 (the "License");
6 # you may not use this file except in compliance with the License.
7 # You may obtain a copy of the License at
8 #
9 # http://www.apache.org/licenses/LICENSE-2.0
10 #
11 # Unless required by applicable law or agreed to in writing, software
12 # distributed under the License is distributed on an "AS IS" BASIS,
13 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 # See the License for the specific language governing permissions and
15 # limitations under the License.
16
17 # Module containing all bases for instantiated type analysis
18 package instantiated_type_analysis
19
20 import program
21
22 redef class Program
23 # This attribute is the InstantiatedTypeAnalysis results
24 readable writable var _ita: nullable InstantiatedTypeAnalysis = null
25
26 # This method will create a file and output the name of all types that are instantiated in it
27 fun dump_instantiated_types(directory_name: String) do
28 var f = new OFStream.open("{directory_name}/{main_module.name}.instantiated_types.log")
29 with_each_live_local_classes !action(c) do
30 f.write("{c}\n")
31 end
32 f.close
33 end
34
35 # This method will create a file and output the names of all types that are not instantiated in it
36 fun dump_not_instantiated_types(directory_name: String) do
37 var f = new OFStream.open("{directory_name}/{main_module.name}.not_instantiated_types.log")
38 # Must overwrite 'with_each_local_classes' since we are looking at non-instantiated classes
39 for c in main_module.local_classes do
40 if not ita.is_class_instantiated(c) then
41 f.write("{c}\n")
42 end
43 end
44 f.close
45 end
46
47 # We know which are really live, use that information !
48 redef fun with_each_live_local_classes
49 !action(m: MMLocalClass)
50 do
51 for c in main_module.local_classes do
52 if ita == null or ita.as(not null).is_class_instantiated(c) then action(c)
53 end
54 end
55 end
56
57 # Subclasses of this class would represent an analysis that produces
58 # at least a way of knowing if a class is instantiated somewhere in a
59 # method that is reachable from the entry point of the program
60 class InstantiatedTypeAnalysis
61 fun is_class_instantiated(local_class: MMLocalClass): Bool is abstract
62 end
63
64 # Default behavior is to say that all types are instantiated
65 class DefaultInstantiatedTypeAnalysis
66 special InstantiatedTypeAnalysis
67 redef fun is_class_instantiated(local_class: MMLocalClass): Bool do return true
68
69 init do end
70 end