summaryrefslogtreecommitdiff
path: root/sources/scalac/transformer/AddConstructors.java
blob: 5ef1e1c406c753e8a64dd0466c6b11432eb36dcf (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
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
/*     ____ ____  ____ ____  ______                                     *\
**    / __// __ \/ __// __ \/ ____/    SOcos COmpiles Scala             **
**  __\_ \/ /_/ / /__/ /_/ /\_ \       (c) 2002, LAMP/EPFL              **
** /_____/\____/\___/\____/____/                                        **
\*                                                                      */

// $Id$

package scalac.transformer;

import java.util.HashMap;
import java.util.ArrayList;

import scalac.Global;
import scalac.ast.Tree;
import scalac.ast.Tree.Template;
import scalac.ast.GenTransformer;
import scalac.symtab.Type;
import scalac.symtab.Symbol;
import scalac.symtab.SymbolSubstTypeMap;
import scalac.symtab.TermSymbol;
import scalac.symtab.Modifiers;
import scalac.util.Debug;

/**
 * This phase adds to all classes one initializer method per
 * constructor. Initializers have the same value parameters as their
 * corresponding constructor but no type parameters.
 *
 * An initializer may be used in the body of another initializer
 * either to invoke another initializer of the same class or to invoke
 * an initailizer of the superclass. In that case, the initializer
 * must appear in a Select node whose qualifier is either a This node
 * or a Super node. The type of such a Select node is the type of the
 * initializer.
 *
 * An initializer may also be used in a new operation. In that case,
 * the initializer must appear in an Ident node.  The type of such an
 * Ident node is a PolyType whose arguments are the type arguments of
 * the initializer's class and whose result type is the initializer's
 * type.
 *
 * This phase does the following in the tree:
 *
 * - replaces all non-primary constructors definitions by initializer
 *   definitions with the same body,
 *
 * - for each non-interface class creates an primary initializer
 *   method corresponding to the primary constructor,
 *
 * - moves the call to the super constructor into the primary
 *   initializer,
 *
 * - moves all class fields initialization code (rhs of ValDefs) into
 *   the primary initializer,
 *
 * - moves all class-level expressions into the primary initializer,
 *
 * - replaces all constructor invocations by initializer invocations,
 *   except in the parents field of class templates.
 *
 * @author Nikolay Mihaylov
 * @version 1.2
 */
public class AddConstructors extends GenTransformer {

    /** A constructor to initializer map */
    private final HashMap/*<Symbol,Symbol>*/ initializers;

    /** A constructor to initializer parameter substitution */
    private final SymbolSubstTypeMap subst;

    /** The current primary initializer or null */
    private Symbol primaryInitializer;

    public AddConstructors(Global global, HashMap initializers) {
	super(global);
        this.initializers = initializers;
        this.subst = new SymbolSubstTypeMap();
    }

    /** Returns the initializer corresponding to the given constructor. */
    private Symbol getInitializer(Symbol constructor) {
   	assert constructor.isConstructor(): Debug.show(constructor);
	Symbol initializer = (Symbol)initializers.get(constructor);
	if (initializer == null) {
	    assert !constructor.constructorClass().isInterface():
                "found interface constructor " + Debug.show(constructor);
	    int flags = constructor.isPrivate()
		? (constructor.flags & ~Modifiers.PRIVATE) | Modifiers.PROTECTED
		: constructor.flags;
	    initializer = new TermSymbol(
                constructor.pos,
                constructor.name,
                constructor.constructorClass(),
                flags & Modifiers.ACCESSFLAGS);
	    initializer.setInfo(
                Type.MethodType(
                    constructor.valueParams(),
                    global.definitions.UNIT_TYPE())
                .cloneType(constructor, initializer));
            initializer.owner().members().enterOrOverload(initializer);
	    initializers.put(constructor, initializer);
	}
	return initializer;
    }

    /** process the tree
     */
    public Tree transform(Tree tree) {
        return transform(tree, false);
    }

    private Tree transform(Tree tree, boolean inNew) {
	switch (tree) {
	case ClassDef(_, _, _, _, _, Template impl):
            Symbol clasz = tree.symbol();
	    if (clasz.isInterface())
		return gen.ClassDef(clasz, transform(impl.body));

	    // expressions that go before the call to the super constructor
	    final ArrayList constrBody = new ArrayList();

	    // expressions that go after the call to the super constructor
	    final ArrayList constrBody2 = new ArrayList();

	    // the body of the class after the transformation
	    final ArrayList classBody = new ArrayList();

            Symbol local = impl.symbol();
	    for (int i = 0; i < impl.body.length; i++) {
                Tree member = impl.body[i];
		if (member.definesSymbol() && member.symbol().owner()!=local) {
		    switch (member) {
		    case ValDef(_, _, _, Tree rhs):
                        // move initialization code into initializer
                        Symbol field = member.symbol();
			if (rhs == Tree.Empty) break;
                        member = gen.ValDef(field, Tree.Empty);
                        Tree assign = gen.Assign(
                            gen.Select(gen.This(member.pos, clasz),field),rhs);
                        if (rhs.hasSymbol() && rhs.symbol().isParameter()) {
                            constrBody.add(assign);
                        } else {
                            constrBody2.add(assign);
                        }
		    }
		    classBody.add(member);
                } else {
		    // move class-level code into initializer
		    constrBody2.add(member);
		}
	    }

	    // inline the call to the super constructor
            for (int i = 0; i < impl.parents.length; i++) {
            switch (impl.parents[i]) {
            case Apply(TypeApply(Tree fun, Tree[] targs), Tree[] args):
                assert fun.symbol().isConstructor(): impl.parents[i];
                if (fun.symbol().constructorClass().isInterface()) continue;
                int pos = impl.parents[i].pos;
                Tree superConstr = gen.Select
                    (gen.Super(pos, clasz), getInitializer(fun.symbol()));
                constrBody.add(gen.mkApply_V(superConstr, args));
                break;
            case Apply(Tree fun, Tree[] args):
                assert fun.symbol().isConstructor(): impl.parents[i];
                if (fun.symbol().constructorClass().isInterface()) continue;
                int pos = impl.parents[i].pos;
                Tree superConstr = gen.Select
                    (gen.Super(pos, clasz), getInitializer(fun.symbol()));
                constrBody.add(gen.mkApply_V(superConstr, args));
                break;
            default:
                throw Debug.abort("illegal case", impl.parents[i]);
            }
            }

	    // add valdefs and class-level expression to the constructorr body
	    constrBody.addAll(constrBody2);

            Tree constrTree = constrBody.size() > 1 ?
                gen.Block((Tree[])constrBody.
			  toArray(new Tree[constrBody.size()])):
                (Tree) constrBody.get(0);

	    classBody.add(gen.DefDef(clasz.primaryConstructor(),constrTree));

	    Tree[] newBody = (Tree[]) classBody.toArray(Tree.EMPTY_ARRAY);

	    // transform the bodies of all members in order to substitute
	    // the constructor references with the new ones
	    return gen.ClassDef(clasz, transform(newBody));

        case DefDef(_, _, _, _, _, Tree rhs):
            if (!tree.symbol().isConstructor()) return super.transform(tree);
            // replace constructor by initializer
            Symbol constructor = tree.symbol();
            Symbol initializer = getInitializer(constructor);
            subst.insertSymbol(
                constructor.typeParams(),
                constructor.constructorClass().typeParams());
            subst.insertSymbol(
                constructor.valueParams(),
                initializer.valueParams());
            if (constructor.isPrimaryConstructor())
                primaryInitializer = initializer;
            rhs = transform(rhs);
            primaryInitializer = null;
            subst.removeSymbol(constructor.valueParams());
            subst.removeSymbol(constructor.typeParams());
            // add consistent result expression
            rhs = gen.mkBlock(new Tree[] { rhs, gen.mkUnitLit(rhs.pos) });
            return gen.DefDef(initializer, rhs);

        case ValDef(_, _, _, _):
        case LabelDef(_, _, _):
            if (primaryInitializer != null)
                if (tree.symbol().owner() != primaryInitializer)
                    tree.symbol().setOwner(primaryInitializer);
            return super.transform(tree);

        case New(Template(Tree[] parents, _)):
            return gen.New(transform(parents[0], true));

 	case TypeApply(Tree fun, Tree[] args):
            if (!inNew && fun.symbol().isConstructor()) return transform(fun);
            return gen.TypeApply(transform(fun, inNew), transform(args));

 	case Apply(Tree fun, Tree[] args):
            return gen.Apply(transform(fun, inNew), transform(args));

        case Ident(_):
            Symbol symbol = tree.symbol();
            if (symbol.isConstructor()) {
                symbol = getInitializer(symbol);
                if (!inNew) {
                    Symbol clasz = symbol.owner();
                    return gen.Select(gen.This(tree.pos, clasz), symbol);
                }
            } else if (symbol.owner().isConstructor()) {
                symbol = subst.lookupSymbol(symbol);
            }
            return gen.Ident(tree.pos, symbol);

        case TypeTerm():
            return gen.TypeTerm(tree.pos, subst.apply(tree.getType()));

        default:
            return super.transform(tree);
	} // switch(tree)

    } // transform()

} // class AddConstructors