summaryrefslogtreecommitdiffstats
path: root/Source/JavaScriptCore/collector/handles/Local.h
blob: 035e9e90ecf7a259394851848e5fc4cd9aa2183d (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
/*
 * Copyright (C) 2010 Apple Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef Local_h
#define Local_h

#include "Handle.h"
#include "JSGlobalData.h"

/*
    A Local is a temporary handle whose lifetime is tied to a given LocalScope.
    Use Locals for local values on the stack. It is an error to create a Local
    outside of any LocalScope.
*/

namespace JSC {
template <typename T> class Local;
}

namespace WTF {

template<typename T> struct VectorTraits<JSC::Local<T> > {
    static const bool needsDestruction = false;
    static const bool needsInitialization = true;
    static const bool canInitializeWithMemset = false;
    static const bool canMoveWithMemcpy = true;
    static const bool canCopyWithMemcpy = false;
    static const bool canFillWithMemset = false;
    static const bool canCompareWithMemcmp = true;
};

}

namespace JSC {

template <typename T> class Local : public Handle<T> {
    friend class LocalScope;
public:
    typedef typename Handle<T>::ExternalType ExternalType;
    Local(JSGlobalData&, ExternalType = ExternalType());
    Local(JSGlobalData&, Handle<T>);
    Local(const Local<T>&); // Adopting constructor. Used to return a Local to a calling function.

    Local& operator=(ExternalType);
    Local& operator=(Handle<T>);
    
    using Handle<T>::slot;

private:
    Local(HandleSlot, ExternalType); // Used by LocalScope::release() to move a Local to a containing scope.
    void internalSet(ExternalType value)
    {
        JSValue newValue(HandleTypes<T>::toJSValue(value));
        HandleSlot slot = this->slot();
        *slot = newValue;
    }
};

template <typename T> inline Local<T>::Local(JSGlobalData& globalData, ExternalType value)
    : Handle<T>(globalData.allocateLocalHandle())
{
    internalSet(value);
}

template <typename T> inline Local<T>::Local(JSGlobalData& globalData, Handle<T> handle)
    : Handle<T>(globalData.allocateLocalHandle())
{
    internalSet(handle.get());
}

template <typename T> inline Local<T>::Local(const Local<T>& o)
    : Handle<T>(o.slot())
{
    const_cast<Local<T>&>(o).invalidate(); // Prevent accidental sharing.
}

template <typename T> inline Local<T>::Local(HandleSlot slot, ExternalType value)
    : Handle<T>(slot, value)
{
}

template <typename T> inline Local<T>& Local<T>::operator=(ExternalType value)
{
    internalSet(value);
    return *this;
}

template <typename T> inline Local<T>& Local<T>::operator=(Handle<T> handle)
{
    internalSet(handle.get());
    return *this;
}

template <typename T, unsigned inlineCapacity = 0> class LocalStack {
    typedef typename Handle<T>::ExternalType ExternalType;
public:
    LocalStack(JSGlobalData& globalData)
        : m_globalData(&globalData)
        , m_count(0)
    {
    }

    ExternalType peek() const
    {
        ASSERT(m_count > 0);
        return m_stack[m_count - 1].get();
    }

    ExternalType pop()
    {
        ASSERT(m_count > 0);
        return m_stack[--m_count].get();
    }

    void push(ExternalType value)
    {
        if (m_count == m_stack.size())
            m_stack.append(Local<T>(*m_globalData, value));
        else
            m_stack[m_count] = value;
        m_count++;
    }

    bool isEmpty() const { return !m_count; }
    unsigned size() const { return m_count; }

private:
    RefPtr<JSGlobalData> m_globalData;
    Vector<Local<T>, inlineCapacity> m_stack;
    unsigned m_count;
};

}

#endif