1/*
2 * Copyright (C) 2004 Apple Computer, Inc.  All rights reserved.
3 *
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
6 * are met:
7 * 1. Redistributions of source code must retain the above copyright
8 *    notice, this list of conditions and the following disclaimer.
9 * 2. Redistributions in binary form must reproduce the above copyright
10 *    notice, this list of conditions and the following disclaimer in the
11 *    documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16 * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
17 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
18 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
19 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
20 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
21 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
22 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
23 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
24 */
25
26#ifndef RUNTIME_ROOT_H_
27#define RUNTIME_ROOT_H_
28
29#if PLATFORM(MAC)
30#include "jni_jsobject.h"
31#endif
32#include <heap/Strong.h>
33
34#include <runtime/WeakGCMap.h>
35#include <wtf/Forward.h>
36#include <wtf/Noncopyable.h>
37#include <wtf/PassRefPtr.h>
38#include <wtf/RefCounted.h>
39
40namespace JSC {
41
42class Interpreter;
43class JSGlobalObject;
44
45namespace Bindings {
46
47class RootObject;
48class RuntimeObject;
49
50typedef HashCountedSet<JSObject*> ProtectCountSet;
51
52extern RootObject* findProtectingRootObject(JSObject*);
53extern RootObject* findRootObject(JSGlobalObject*);
54
55class RootObject : public RefCounted<RootObject> {
56    friend class JavaJSObject;
57
58public:
59    ~RootObject();
60
61    static PassRefPtr<RootObject> create(const void* nativeHandle, JSGlobalObject*);
62
63    bool isValid() { return m_isValid; }
64    void invalidate();
65
66    void gcProtect(JSObject*);
67    void gcUnprotect(JSObject*);
68    bool gcIsProtected(JSObject*);
69
70    const void* nativeHandle() const;
71    JSGlobalObject* globalObject() const;
72    void updateGlobalObject(JSGlobalObject*);
73
74    void addRuntimeObject(JSGlobalData&, RuntimeObject*);
75    void removeRuntimeObject(RuntimeObject*);
76
77    struct InvalidationCallback {
78        virtual void operator()(RootObject*) = 0;
79        virtual ~InvalidationCallback();
80    };
81    void addInvalidationCallback(InvalidationCallback* callback) { m_invalidationCallbacks.add(callback); }
82
83private:
84    RootObject(const void* nativeHandle, JSGlobalObject*);
85
86    bool m_isValid;
87
88    const void* m_nativeHandle;
89    Strong<JSGlobalObject> m_globalObject;
90
91    ProtectCountSet m_protectCountSet;
92    WeakGCMap<RuntimeObject*, RuntimeObject> m_runtimeObjects; // Really need a WeakGCSet, but this will do.
93
94    HashSet<InvalidationCallback*> m_invalidationCallbacks;
95};
96
97} // namespace Bindings
98
99} // namespace JSC
100
101#endif // RUNTIME_ROOT_H_
102