Add types for DownloadID and TaskIdentifier
[WebKit-https.git] / Source / WebKit2 / Shared / Downloads / DownloadID.h
1 /*
2  * Copyright (C) 2015 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 #ifndef DownloadID_h
27 #define DownloadID_h
28
29 #include "ArgumentCoder.h"
30 #include "ArgumentDecoder.h"
31 #include "ArgumentEncoder.h"
32 #include <wtf/HashTraits.h>
33
34 namespace WebKit {
35
36 class DownloadID {
37 public:
38     DownloadID()
39     {
40     }
41
42     explicit DownloadID(uint64_t downloadID)
43         : m_downloadID(downloadID)
44     {
45     }
46
47     bool operator==(DownloadID other) const { return m_downloadID == other.m_downloadID; }
48
49     uint64_t downloadID() const { return m_downloadID; }
50 private:
51     uint64_t m_downloadID { 0 };
52 };
53
54 }
55
56 namespace IPC {
57     
58 template<> struct ArgumentCoder<WebKit::DownloadID> {
59     static void encode(ArgumentEncoder& encoder, const WebKit::DownloadID& downloadID)
60     {
61         encoder << downloadID.downloadID();
62     }
63     static bool decode(ArgumentDecoder& decoder, WebKit::DownloadID& downloadID)
64     {
65         uint64_t id;
66         if (!decoder.decode(id))
67             return false;
68
69         downloadID = WebKit::DownloadID(downloadID);
70         
71         return true;
72     }
73 };
74
75 }
76
77 namespace WTF {
78     
79 struct DownloadIDHash {
80     static unsigned hash(const WebKit::DownloadID& d) { return intHash(d.downloadID()); }
81     static bool equal(const WebKit::DownloadID& a, const WebKit::DownloadID& b) { return a.downloadID() == b.downloadID(); }
82     static const bool safeToCompareToEmptyOrDeleted = true;
83 };
84 template<> struct HashTraits<WebKit::DownloadID> : GenericHashTraits<WebKit::DownloadID> {
85     static WebKit::DownloadID emptyValue() { return WebKit::DownloadID(0); }
86     
87     static void constructDeletedValue(WebKit::DownloadID& slot) { slot = WebKit::DownloadID(std::numeric_limits<uint64_t>::max()); }
88     static bool isDeletedValue(const WebKit::DownloadID& slot) { return slot.downloadID() == std::numeric_limits<uint64_t>::max(); }
89 };
90 template<> struct DefaultHash<WebKit::DownloadID> {
91     typedef DownloadIDHash Hash;
92 };
93
94 }
95 #endif /* DownloadID_h */