Remove excessive headers from JavaScriptCore
[WebKit-https.git] / Source / JavaScriptCore / runtime / WeakGCMap.h
1 /*
2  * Copyright (C) 2009, 2015-2016 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 "Weak.h"
29 #include <wtf/HashMap.h>
30
31 namespace JSC {
32
33 // A HashMap with Weak<JSCell> values, which automatically removes values once they're garbage collected.
34
35 template<typename KeyArg, typename ValueArg, typename HashArg = typename DefaultHash<KeyArg>::Hash,
36     typename KeyTraitsArg = HashTraits<KeyArg>>
37 class WeakGCMap {
38     WTF_MAKE_FAST_ALLOCATED;
39     typedef Weak<ValueArg> ValueType;
40     typedef HashMap<KeyArg, ValueType, HashArg, KeyTraitsArg> HashMapType;
41
42 public:
43     typedef typename HashMapType::KeyType KeyType;
44     typedef typename HashMapType::AddResult AddResult;
45     typedef typename HashMapType::iterator iterator;
46     typedef typename HashMapType::const_iterator const_iterator;
47
48     explicit WeakGCMap(VM&);
49     ~WeakGCMap();
50
51     ValueArg* get(const KeyType& key) const
52     {
53         return m_map.get(key);
54     }
55
56     AddResult set(const KeyType& key, ValueType value)
57     {
58         return m_map.set(key, WTFMove(value));
59     }
60
61     bool remove(const KeyType& key)
62     {
63         return m_map.remove(key);
64     }
65
66     void clear()
67     {
68         m_map.clear();
69     }
70
71     bool isEmpty() const
72     {
73         const_iterator it = m_map.begin();
74         const_iterator end = m_map.end();
75         while (it != end) {
76             if (it->value)
77                 return true;
78         }
79         return false;
80     }
81
82     inline iterator find(const KeyType& key);
83
84     inline const_iterator find(const KeyType& key) const;
85
86     template<typename Functor>
87     void forEach(Functor functor)
88     {
89         for (auto& pair : m_map) {
90             if (pair.value)
91                 functor(pair.key, pair.value.get());
92         }
93     }
94
95     inline bool contains(const KeyType& key) const;
96
97     void pruneStaleEntries();
98
99 private:
100     HashMapType m_map;
101     VM& m_vm;
102 };
103
104 } // namespace JSC