6a4d4f89a1d3c09bfdc800d148efc067faf3ac68
[WebKit-https.git] / Source / JavaScriptCore / runtime / WeakMapData.h
1 /*
2  * Copyright (C) 2013 Apple 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 INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #pragma once
27
28 #include "JSCell.h"
29 #include "Structure.h"
30 #include <wtf/HashFunctions.h>
31 #include <wtf/HashMap.h>
32 #include <wtf/MathExtras.h>
33
34 namespace JSC {
35
36 class WeakMapData final : public JSCell {
37 public:
38     typedef JSCell Base;
39     static const unsigned StructureFlags = Base::StructureFlags | StructureIsImmortal;
40
41     static WeakMapData* create(VM& vm)
42     {
43         WeakMapData* weakMapData = new (NotNull, allocateCell<WeakMapData>(vm.heap)) WeakMapData(vm);
44         weakMapData->finishCreation(vm);
45         return weakMapData;
46     }
47
48     static Structure* createStructure(VM& vm, JSGlobalObject* globalObject, JSValue prototype)
49     {
50         return Structure::create(vm, globalObject, prototype, TypeInfo(CellType, StructureFlags), info());
51     }
52
53     static const bool needsDestruction = true;
54
55     void set(VM&, JSObject*, JSValue);
56     JSValue get(JSObject*);
57     bool remove(JSObject*);
58     bool contains(JSObject*);
59     void clear();
60
61     DECLARE_INFO;
62
63     typedef HashMap<JSObject*, WriteBarrier<Unknown>> MapType;
64     MapType::const_iterator begin() const { return m_map.begin(); }
65     MapType::const_iterator end() const { return m_map.end(); }
66
67     int size() const { return m_map.size(); }
68
69 private:
70     WeakMapData(VM&);
71     static void destroy(JSCell*);
72     static size_t estimatedSize(JSCell*);
73     static void visitChildren(JSCell*, SlotVisitor&);
74     void finishCreation(VM&);
75
76     class DeadKeyCleaner : public UnconditionalFinalizer, public WeakReferenceHarvester {
77     public:
78         DeadKeyCleaner(WeakMapData* target)
79             : m_target(target)
80         {
81         }
82     private:
83         void visitWeakReferences(SlotVisitor&) override;
84         void finalizeUnconditionally() override;
85         unsigned m_liveKeyCount;
86         WeakMapData* m_target;
87     };
88     DeadKeyCleaner m_deadKeyCleaner;
89     MapType m_map;
90 };
91
92 } // namespace JSC