Temporarily revert r276592 as it breaks some native apps
[WebKit-https.git] / Source / WebCore / history / BackForwardItemIdentifier.h
1 /*
2  * Copyright (C) 2018 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 "ProcessIdentifier.h"
29 #include <wtf/DebugUtilities.h>
30 #include <wtf/Hasher.h>
31 #include <wtf/text/StringConcatenateNumbers.h>
32
33 namespace WebCore {
34
35 struct BackForwardItemIdentifier {
36     ProcessIdentifier processIdentifier;
37     enum ItemIdentifierType { };
38     ObjectIdentifier<ItemIdentifierType> itemIdentifier;
39
40     unsigned hash() const;
41     explicit operator bool() const { return processIdentifier && itemIdentifier; }
42
43     template<class Encoder> void encode(Encoder&) const;
44     template<class Decoder> static Optional<BackForwardItemIdentifier> decode(Decoder&);
45
46     String string() const { return makeString(processIdentifier.toUInt64(), '-', itemIdentifier.toUInt64()); }
47
48     WEBCORE_EXPORT bool isValid() const;
49
50 #if !LOG_DISABLED
51     const char* logString() const;
52 #endif
53 };
54
55 #if !LOG_DISABLED
56
57 inline const char* BackForwardItemIdentifier::logString() const
58 {
59     return debugString(makeString(processIdentifier.toUInt64(), '-', itemIdentifier.toUInt64()));
60 }
61
62 #endif
63
64 inline bool operator==(const BackForwardItemIdentifier& a, const BackForwardItemIdentifier& b)
65 {
66     return a.processIdentifier == b.processIdentifier &&  a.itemIdentifier == b.itemIdentifier;
67 }
68
69 inline bool operator!=(const BackForwardItemIdentifier& a, const BackForwardItemIdentifier& b)
70 {
71     return !(a == b);
72 }
73
74 template<class Encoder>
75 void BackForwardItemIdentifier::encode(Encoder& encoder) const
76 {
77     encoder << processIdentifier << itemIdentifier;
78 }
79
80 template<class Decoder>
81 Optional<BackForwardItemIdentifier> BackForwardItemIdentifier::decode(Decoder& decoder)
82 {
83     Optional<ProcessIdentifier> processIdentifier;
84     decoder >> processIdentifier;
85     if (!processIdentifier)
86         return WTF::nullopt;
87
88     Optional<ObjectIdentifier<ItemIdentifierType>> itemIdentifier;
89     decoder >> itemIdentifier;
90     if (!itemIdentifier)
91         return WTF::nullopt;
92
93     BackForwardItemIdentifier result = { WTFMove(*processIdentifier), WTFMove(*itemIdentifier) };
94     if (!result.isValid())
95         return WTF::nullopt;
96     return result;
97 }
98
99 inline unsigned BackForwardItemIdentifier::hash() const
100 {
101     return computeHash(processIdentifier.toUInt64(), itemIdentifier.toUInt64());
102 }
103
104 } // namespace WebCore
105
106 namespace WTF {
107
108 struct BackForwardItemIdentifierHash {
109     static unsigned hash(const WebCore::BackForwardItemIdentifier& key) { return key.hash(); }
110     static bool equal(const WebCore::BackForwardItemIdentifier& a, const WebCore::BackForwardItemIdentifier& b) { return a == b; }
111     static const bool safeToCompareToEmptyOrDeleted = true;
112 };
113
114 template<> struct HashTraits<WebCore::BackForwardItemIdentifier> : GenericHashTraits<WebCore::BackForwardItemIdentifier> {
115     static WebCore::BackForwardItemIdentifier emptyValue() { return { }; }
116
117     static void constructDeletedValue(WebCore::BackForwardItemIdentifier& slot) { new (NotNull, &slot.processIdentifier) WebCore::ProcessIdentifier(WTF::HashTableDeletedValue); }
118
119     static bool isDeletedValue(const WebCore::BackForwardItemIdentifier& slot) { return slot.processIdentifier.isHashTableDeletedValue(); }
120 };
121
122 template<> struct DefaultHash<WebCore::BackForwardItemIdentifier> : BackForwardItemIdentifierHash { };
123
124 } // namespace WTF