Implement "UpdateWorkerState" and use it
[WebKit-https.git] / Source / WTF / wtf / ObjectIdentifier.h
1 /*
2  * Copyright (C) 2017 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 <wtf/HashTraits.h>
29 #include <wtf/text/WTFString.h>
30
31 namespace WTF {
32
33 template<typename T> class ObjectIdentifier {
34 public:
35     ObjectIdentifier() = default;
36
37     ObjectIdentifier(HashTableDeletedValueType) : m_identifier(hashTableDeletedValue()) { }
38     bool isHashTableDeletedValue() const { return m_identifier == hashTableDeletedValue(); }
39
40     template<typename Encoder> void encode(Encoder& encoder) const
41     {
42         ASSERT(isValidIdentifier(m_identifier));
43         encoder << m_identifier;
44     }
45     template<typename Decoder> static std::optional<ObjectIdentifier> decode(Decoder& decoder)
46     {
47         std::optional<uint64_t> identifier;
48         decoder >> identifier;
49         if (!identifier)
50             return std::nullopt;
51         ASSERT(isValidIdentifier(*identifier));
52         return ObjectIdentifier { *identifier };
53     }
54
55     bool operator==(const ObjectIdentifier& other) const
56     {
57         return m_identifier == other.m_identifier;
58     }
59
60     bool operator!=(const ObjectIdentifier& other) const
61     {
62         return m_identifier != other.m_identifier;
63     }
64     
65 #ifndef NDEBUG
66     String loggingString() const
67     {
68         return String::number(m_identifier);
69     }
70 #endif
71
72 private:
73     template<typename U> friend ObjectIdentifier<U> makeObjectIdentifier(uint64_t);
74     friend struct HashTraits<ObjectIdentifier>;
75     template<typename U> friend struct ObjectIdentifierHash;
76
77     static uint64_t hashTableDeletedValue() { return std::numeric_limits<uint64_t>::max(); }
78     static bool isValidIdentifier(uint64_t identifier) { return identifier && identifier != hashTableDeletedValue(); }
79
80     explicit ObjectIdentifier(uint64_t identifier)
81         : m_identifier(identifier)
82     {
83     }
84
85     uint64_t m_identifier { 0 };
86 };
87
88 template<typename T> inline ObjectIdentifier<T> makeObjectIdentifier(uint64_t identifier)
89 {
90     ASSERT(ObjectIdentifier<T>::isValidIdentifier(identifier));
91     return ObjectIdentifier<T> { identifier };
92 }
93
94 template<typename T> struct ObjectIdentifierHash {
95     static unsigned hash(const ObjectIdentifier<T>& identifier) { return intHash(identifier.m_identifier); }
96     static bool equal(const ObjectIdentifier<T>& a, const ObjectIdentifier<T>& b) { return a == b; }
97     static const bool safeToCompareToEmptyOrDeleted = true;
98 };
99
100 template<typename T> struct HashTraits<ObjectIdentifier<T>> : SimpleClassHashTraits<ObjectIdentifier<T>> { };
101
102 template<typename T> struct DefaultHash<ObjectIdentifier<T>> {
103     typedef ObjectIdentifierHash<T> Hash;
104 };
105
106 } // namespace WTF
107
108 using WTF::ObjectIdentifier;
109 using WTF::makeObjectIdentifier;