summaryrefslogtreecommitdiff
path: root/sources/scalac/symtab/classfile/PackageParser.java
blob: 50b2fbbc2c2f4c58db91ce84568cb52376801439 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/*     ____ ____  ____ ____  ______                                     *\
**    / __// __ \/ __// __ \/ ____/    SOcos COmpiles Scala             **
**  __\_ \/ /_/ / /__/ /_/ /\_ \       (c) 2002, LAMP/EPFL              **
** /_____/\____/\___/\____/____/                                        **
\*                                                                      */

// $Id$

package scalac.symtab.classfile;

import java.util.Iterator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.Map.Entry;

import scala.tools.util.AbstractFile;

import scalac.Global;
import scalac.symtab.Scope;
import scalac.symtab.SourceCompleter;
import scalac.symtab.Symbol;
import scalac.symtab.SymbolLoader;
import scalac.symtab.Type;
import scalac.util.Name;
import scalac.util.Debug;

/**
 * This class implements a package member loader. It can be used to
 * complete package class symbols.
 */
public class PackageParser extends SymbolLoader {

    //########################################################################
    // Protected Fields

    /** The directory to read */
    protected final AbstractFile directory;

    /** A table to collect .scala files */
    protected final HashMap/*<String,AbstractFile>*/ sources = new HashMap();
    /** A table to collect .symbl files */
    protected final HashMap/*<String,AbstractFile>*/ symbols = new HashMap();
    /** A table to collect .class files */
    protected final HashMap/*<String,AbstractFile>*/ classes = new HashMap();
    /** A table to collect subdirectories */
    protected final HashMap/*<String,AbstractFile>*/ packages = new HashMap();

    //########################################################################
    // Public Constructors

    /** Initializes this instance. */
    public PackageParser(Global global, AbstractFile directory) {
        super(global);
        this.directory = directory;
        assert directory != null;
    }

    //########################################################################
    // Protected Methods

    /** Returns a new package parser for the given directory. */
    protected PackageParser newPackageParser(AbstractFile directory) {
        return new PackageParser(global, directory);
    }

    /**
     * Collects all members of the package. This method is invoked by
     * method "doComplete". It should not be invoked otherwise.
     */
    protected void collectAllMembers(Symbol clasz) {
        for (Iterator i = directory.list(); i.hasNext(); ) {
            AbstractFile file = (AbstractFile)i.next();
            String filename = file.getName();
            if (file.isDirectory()) {
                if (filename.equals("META-INF")) continue;
                packages.put(filename, file);
                continue;
            }
            if (filename.endsWith(".class")) {
                String name = filename.substring(0, filename.length() - 6);
                if (!classes.containsKey(name)) classes.put(name, file);
                continue;
            }
            if (filename.endsWith(".symbl")) {
                String name = filename.substring(0, filename.length() - 6);
                if (!symbols.containsKey(name)) symbols.put(name, file);
                continue;
            }
            if (filename.endsWith(".scala")) {
                String name = filename.substring(0, filename.length() - 6);
                if (!sources.containsKey(name)) sources.put(name, file);
                continue;
            }
	}
    }

    /**
     * Removes from the members collected by "collectAllMembers" all
     * those that are hidden. This method is invoked by method
     * "doComplete". It should not be invoked otherwise.
     */
    protected void removeHiddenMembers(Symbol clasz) {
        // Classes/Objects in the root package are hidden.
        if (clasz.isRoot()) sources.clear();
        if (clasz.isRoot()) symbols.clear();
        if (clasz.isRoot()) classes.clear();
        // For all files "<N>.class" find the longest M such that
        // there is a file "<M>.symbl" and M equals N or "<M>$" is a
        // prefix of N. If the file "<N>.class" is less recent than
        // the file "<M>.symbl" ignore the ".class" file. Otherwise,
        // if M equals N, ignore the ".symbl" file.
        for (Iterator i = classes.entrySet().iterator(); i.hasNext(); ) {
            Entry entry = (Entry)i.next();
            String cname = (String)entry.getKey();
            AbstractFile cfile = (AbstractFile)entry.getValue();
            for (String zname = cname; true; ) {
                AbstractFile zfile = (AbstractFile)symbols.get(zname);
                if (zfile != null) {
                    if (cfile.lastModified() <= zfile.lastModified()) {
                        i.remove();
                    } else if (zname == cname) {
                        symbols.remove(zname);
                    }
                    break;
                }
                int index = zname.lastIndexOf('$');
                if (index < 0) break;
                zname = zname.substring(0, index);
            }
        }
        // Source versions hide compiled versions except if separate
        // compilation is enabled and the compiled version is more
        // recent. In that case the compiled version hides the source
        // version.
        boolean separate = global.separate;
        for (Iterator i = sources.entrySet().iterator(); i.hasNext(); ) {
            HashMap.Entry entry = (HashMap.Entry)i.next();
            String name = (String)entry.getKey();
            AbstractFile sfile = (AbstractFile)entry.getValue();
            AbstractFile zfile = (AbstractFile)symbols.get(name);
            AbstractFile cfile = (AbstractFile)classes.get(name);
            boolean hidden = false;
            if (zfile != null)
                if (separate && zfile.lastModified() > sfile.lastModified())
                    hidden = true;
                else
                    symbols.remove(name);
            if (cfile != null)
                if (separate && cfile.lastModified() > sfile.lastModified())
                    hidden = true;
                else
                    classes.remove(name);
            if (hidden) i.remove();
        }
        // Packages are hidden by classes/objects with the same name.
        packages.keySet().removeAll(sources.keySet());
        packages.keySet().removeAll(symbols.keySet());
        packages.keySet().removeAll(classes.keySet());
    }

    /**
     * Creates symbols for all members left by method
     * "removeHiddenMembers". This method is invoked by method
     * "doComplete". It should not be invoked otherwise.
     */
    protected Scope createMemberSymbols(Symbol clasz) {
        Scope members = new Scope();
        for (Iterator i = sources.entrySet().iterator(); i.hasNext(); ) {
            HashMap.Entry entry = (HashMap.Entry)i.next();
            String name = (String)entry.getKey();
            AbstractFile sfile = (AbstractFile)entry.getValue();
            Name classname = Name.fromString(name).toTypeName();
            SymbolLoader loader = new SourceCompleter(global, sfile);
            clasz.newLoadedClass(0, classname, loader, members);
        }
        for (Iterator i = symbols.entrySet().iterator(); i.hasNext(); ) {
            HashMap.Entry entry = (HashMap.Entry)i.next();
            String name = (String)entry.getKey();
            AbstractFile zfile = (AbstractFile)entry.getValue();
            Name classname = Name.fromString(name).toTypeName();
            SymbolLoader loader = new SymblParser(global, zfile);
            clasz.newLoadedClass(0, classname, loader, members);
        }
        for (Iterator i = classes.entrySet().iterator(); i.hasNext(); ) {
            HashMap.Entry entry = (HashMap.Entry)i.next();
            String name = (String)entry.getKey();
            AbstractFile cfile = (AbstractFile)entry.getValue();
            Name classname = Name.fromString(name).toTypeName();
            SymbolLoader loader = new ClassParser(global, cfile);
            clasz.newLoadedClass(JAVA, classname, loader, members);
        }
        for (Iterator i = packages.entrySet().iterator(); i.hasNext(); ) {
            HashMap.Entry entry = (HashMap.Entry)i.next();
            String name = (String)entry.getKey();
            AbstractFile dfile = (AbstractFile)entry.getValue();
            SymbolLoader loader = newPackageParser(dfile);
            clasz.newLoadedPackage(Name.fromString(name), loader, members);
        }
        return members;
    }

    /** Completes the package symbol by loading all its members. */
    protected String doComplete(Symbol root) {
        assert root.isRoot() || root.isPackage(): Debug.show(root);
        Symbol clasz = root.isRoot() ? root : root.moduleClass();
        collectAllMembers(clasz);
        removeHiddenMembers(clasz);
        Scope members = createMemberSymbols(clasz);
        clasz.setInfo(Type.compoundType(Type.EMPTY_ARRAY, members, clasz));
        return "directory path '" + directory + "'";
    }

    //########################################################################
}