FunctionScope.java revision 953:221a84ef44c0 
1/*
2 * Copyright (c) 2010, 2013, Oracle and/or its affiliates. All rights reserved.
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * This code is free software; you can redistribute it and/or modify it
6 * under the terms of the GNU General Public License version 2 only, as
7 * published by the Free Software Foundation.  Oracle designates this
8 * particular file as subject to the "Classpath" exception as provided
9 * by Oracle in the LICENSE file that accompanied this code.
10 *
11 * This code is distributed in the hope that it will be useful, but WITHOUT
12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
14 * version 2 for more details (a copy is included in the LICENSE file that
15 * accompanied this code).
16 *
17 * You should have received a copy of the GNU General Public License version
18 * 2 along with this work; if not, write to the Free Software Foundation,
19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
20 *
21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
22 * or visit www.oracle.com if you need additional information or have any
23 * questions.
24 */
25
26package jdk.nashorn.internal.runtime;
27
28/**
29 * This is the base class for function scopes.  Subclasses of this class are
30 * produced by the ObjectClassGenerator along with additional fields for storing
31 * local vars.  The number of fields required is determined by ObjectCreator.
32 *
33 * The scope is also responsible for handling the var arg 'arguments' object,
34 * though most of the access is via generated code.
35 *
36 * The constructor of this class is responsible for any function prologue
37 * involving the scope.
38 *
39 * TODO see NASHORN-715.
40 */
41public class FunctionScope extends ScriptObject implements Scope {
42
43    /** Area to store scope arguments. (public for access from scripts.) */
44    public final ScriptObject arguments;
45
46    /** Flag to indicate that a split method issued a return statement */
47    private int splitState = -1;
48
49    /**
50     * Constructor
51     *
52     * @param map         property map
53     * @param callerScope caller scope
54     * @param arguments   arguments
55     */
56    public FunctionScope(final PropertyMap map, final ScriptObject callerScope, final ScriptObject arguments) {
57        super(callerScope, map);
58        this.arguments = arguments;
59        setIsScope();
60    }
61
62    /**
63     * Constructor
64     *
65     * @param map         property map
66     * @param callerScope caller scope
67     */
68    public FunctionScope(final PropertyMap map, final ScriptObject callerScope) {
69        super(callerScope, map);
70        this.arguments = null;
71        setIsScope();
72    }
73
74    /**
75     * Constructor
76     *
77     * @param map            property map
78     * @param primitiveSpill primitive spill pool
79     * @param objectSpill    reference spill pool
80     */
81    public FunctionScope(final PropertyMap map, final long[] primitiveSpill, final Object[] objectSpill) {
82        super(map, primitiveSpill, objectSpill);
83        this.arguments = null;
84    }
85
86
87    /**
88     * Get the current split state.
89     * @return current split state
90     */
91    @Override
92    public int getSplitState() {
93        return splitState;
94    }
95
96    /**
97     * Set the current split state.
98     * @param state current split state
99     */
100    @Override
101    public void setSplitState(final int state) {
102        splitState = state;
103    }
104}
105