aboutsummaryrefslogtreecommitdiff
path: root/src/jdk/nashorn/internal/codegen/MapCreator.java
blob: 1bec86fcf056ac51675cfbe79afdfd9a2fc80811 (plain)
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
/*
 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation.  Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

package jdk.nashorn.internal.codegen;

import static jdk.nashorn.internal.runtime.arrays.ArrayIndex.getArrayIndex;
import static jdk.nashorn.internal.runtime.arrays.ArrayIndex.isValidArrayIndex;

import java.util.ArrayList;
import java.util.List;
import jdk.nashorn.internal.ir.Symbol;
import jdk.nashorn.internal.runtime.AccessorProperty;
import jdk.nashorn.internal.runtime.Property;
import jdk.nashorn.internal.runtime.PropertyMap;
import jdk.nashorn.internal.runtime.ScriptObject;
import jdk.nashorn.internal.runtime.SpillProperty;

/**
 * Class that creates PropertyMap sent to script object constructors.
 * @param <T> value type for tuples, e.g. Symbol
 */
public class MapCreator<T> {
    /** Object structure for objects associated with this map */
    private final Class<?> structure;

    /** key set for object map */
    private final List<MapTuple<T>> tuples;

    /**
     * Constructor
     *
     * @param structure structure to generate map for (a JO subclass)
     * @param tuples    list of tuples for map
     */
    MapCreator(final Class<? extends ScriptObject> structure, final List<MapTuple<T>> tuples) {
        this.structure = structure;
        this.tuples    = tuples;
    }

    /**
     * Constructs a property map based on a set of fields.
     *
     * @param hasArguments  does the created object have an "arguments" property
     * @param fieldCount    Number of fields in use.
     * @param fieldMaximum  Number of fields available.
     * @param evalCode      is this property map created for 'eval' code?
     * @return New map populated with accessor properties.
     */
    PropertyMap makeFieldMap(final boolean hasArguments, final int fieldCount, final int fieldMaximum, final boolean evalCode) {
        final List<Property> properties = new ArrayList<>();
        assert tuples != null;

        for (final MapTuple<T> tuple : tuples) {
            final String   key         = tuple.key;
            final Symbol   symbol      = tuple.symbol;
            final Class<?> initialType = tuple.getValueType();

            if (symbol != null && !isValidArrayIndex(getArrayIndex(key))) {
                final int      flags    = getPropertyFlags(symbol, hasArguments, evalCode);
                final Property property = new AccessorProperty(
                        key,
                        flags,
                        structure,
                        symbol.getFieldIndex(),
                        initialType);
                properties.add(property);
            }
        }

        return PropertyMap.newMap(properties, structure.getName(), fieldCount, fieldMaximum, 0);
    }

    PropertyMap makeSpillMap(final boolean hasArguments) {
        final List<Property> properties = new ArrayList<>();
        int spillIndex = 0;
        assert tuples != null;

        for (final MapTuple<T> tuple : tuples) {
            final String key    = tuple.key;
            final Symbol symbol = tuple.symbol;

            //TODO initial type is object here no matter what. Is that right?
            if (symbol != null && !isValidArrayIndex(getArrayIndex(key))) {
                final int flags = getPropertyFlags(symbol, hasArguments, false);
                properties.add(
                        new SpillProperty(
                                key,
                                flags,
                                spillIndex++));
            }
        }

        return PropertyMap.newMap(properties, structure.getName(), 0, 0, spillIndex);
    }

    /**
     * Compute property flags given local state of a field. May be overridden and extended,
     *
     * @param symbol       symbol to check
     * @param hasArguments does the created object have an "arguments" property
     *
     * @return flags to use for fields
     */
    static int getPropertyFlags(final Symbol symbol, final boolean hasArguments, final boolean evalCode) {
        int flags = 0;

        if (symbol.isParam()) {
            flags |= Property.IS_PARAMETER;
        }

        if (hasArguments) {
            flags |= Property.HAS_ARGUMENTS;
        }

        // See ECMA 5.1 10.5 Declaration Binding Instantiation.
        // Step 2  If code is eval code, then let configurableBindings
        // be true else let configurableBindings be false.
        // We have to make vars, functions declared in 'eval' code
        // configurable. But vars, functions from any other code is
        // not configurable.
        if (symbol.isScope() && !evalCode) {
            flags |= Property.NOT_CONFIGURABLE;
        }

        if (symbol.isFunctionDeclaration()) {
            flags |= Property.IS_FUNCTION_DECLARATION;
        }

        if (symbol.isConst()) {
            flags |= Property.NOT_WRITABLE;
        }

        if (symbol.isBlockScoped()) {
            flags |= Property.IS_LEXICAL_BINDING;
        }

        // Mark symbol as needing declaration. Access before declaration will throw a ReferenceError.
        if (symbol.isBlockScoped() && symbol.isScope()) {
            flags |= Property.NEEDS_DECLARATION;
        }

        return flags;
    }
}