18d2d79fc59ba22bbe0b5edd15ecdcfdafd3b75a
[WebKit-https.git] / Source / WebKit2 / Platform / CoreIPC / MessageID.h
1 /*
2  * Copyright (C) 2010 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 MessageID_h
27 #define MessageID_h
28
29 namespace CoreIPC {
30
31 enum MessageClass {
32     MessageClassInvalid = 0,
33
34     // Messages sent by Core IPC.
35     MessageClassCoreIPC,
36
37     // Messages sent by the UI process to the web process.
38     MessageClassAuthenticationManager,
39     MessageClassDrawingArea,
40     MessageClassInjectedBundle,
41     MessageClassLayerTreeCoordinator,
42     MessageClassWebApplicationCacheManager,
43     MessageClassWebBatteryManagerProxy,
44     MessageClassWebCookieManager,
45     MessageClassWebDatabaseManager,
46     MessageClassWebFullScreenManager,
47     MessageClassWebGeolocationManagerProxy,
48     MessageClassWebIconDatabaseProxy,
49     MessageClassWebInspector,
50     MessageClassWebKeyValueStorageManager,
51     MessageClassWebMediaCacheManager,
52     MessageClassWebNetworkInfoManagerProxy,
53     MessageClassWebNotificationManager,
54     MessageClassWebPage,
55     MessageClassWebProcess,
56     MessageClassWebResourceCacheManager,
57     MessageClassEventDispatcher,
58 #if USE(SOUP)
59     MessageClassWebSoupRequestManager,
60 #endif
61
62     // Messages sent by the web process to the UI process.
63     MessageClassDownloadProxy,
64     MessageClassDrawingAreaProxy,
65     MessageClassLayerTreeCoordinatorProxy,
66     MessageClassWebApplicationCacheManagerProxy,
67     MessageClassWebBatteryManager,
68     MessageClassWebContext,
69     MessageClassWebContextLegacy,
70     MessageClassWebCookieManagerProxy,
71     MessageClassWebDatabaseManagerProxy,
72     MessageClassWebFullScreenManagerProxy,
73     MessageClassWebGeolocationManager,
74     MessageClassWebIconDatabase,
75     MessageClassWebInspectorProxy,
76     MessageClassWebKeyValueStorageManagerProxy,
77     MessageClassWebMediaCacheManagerProxy,
78     MessageClassWebNetworkInfoManager,
79     MessageClassWebNotificationManagerProxy,
80     MessageClassWebPageProxy,
81     MessageClassWebProcessProxy,
82     MessageClassWebResourceCacheManagerProxy,
83 #if USE(SOUP)
84     MessageClassWebSoupRequestManagerProxy,
85 #endif
86     MessageClassWebVibrationProxy,
87
88     // Messages sent to a WebConnection
89     MessageClassWebConnectionLegacy,
90
91     // Messages sent by the UI process to the plug-in process.
92     MessageClassPluginProcess,
93
94     // Messages sent by the plug-in process to the UI process.
95     MessageClassPluginProcessProxy,
96
97     // Messages sent by the web process to the plug-in process.
98     MessageClassWebProcessConnection,
99     MessageClassPluginControllerProxy,
100
101     // Messages sent by the plug-in process to the web process.
102     MessageClassPluginProcessConnection,
103     MessageClassPluginProxy,
104
105     // NPObject messages sent by both the plug-in process and the web process.
106     MessageClassNPObjectMessageReceiver,
107 };
108
109 template<typename> struct MessageKindTraits { };
110
111
112 /*
113     MessageID Layout (the most significant bit is reserved and therefore always zero)
114
115     ---------
116     | Flags | 7 bits
117     |-------|
118     | Class | 8 bits
119     |-------|
120     |  Msg  | 16 bits
121     |  Kind |
122     ---------
123 */
124
125 class MessageID {
126 public:
127     enum Flags {
128         SyncMessage = 1 << 0,
129         DispatchMessageWhenWaitingForSyncReply = 1 << 1,
130     };
131
132     MessageID()
133         : m_messageID(0)
134     {
135     }
136
137     template <typename EnumType>
138     explicit MessageID(EnumType messageKind, unsigned char flags = 0)
139         : m_messageID(stripMostSignificantBit(flags << 24 | (MessageKindTraits<EnumType>::messageClass) << 16 | messageKind))
140     {
141     }
142
143     MessageID messageIDWithAddedFlags(unsigned char flags)
144     {
145         MessageID messageID;
146
147         messageID.m_messageID = stripMostSignificantBit(m_messageID | (flags << 24));
148         return messageID;
149     }
150
151     template <typename EnumType>
152     EnumType get() const
153     {
154         ASSERT(getClass() == MessageKindTraits<EnumType>::messageClass);
155         return static_cast<EnumType>(m_messageID & 0xffff);
156     }
157
158     template <MessageClass K>
159     bool is() const
160     {
161         return getClass() == K;
162     }
163     
164     template <typename EnumType>
165     bool operator==(EnumType messageKind) const
166     {
167         return m_messageID == MessageID(messageKind).m_messageID;
168     }
169
170     static MessageID fromInt(unsigned i)
171     {
172         MessageID messageID;
173         messageID.m_messageID = stripMostSignificantBit(i);
174         
175         return messageID;
176     }
177     
178     unsigned toInt() const { return m_messageID; }
179
180     bool shouldDispatchMessageWhenWaitingForSyncReply() const { return getFlags() & DispatchMessageWhenWaitingForSyncReply; }
181     bool isSync() const { return getFlags() & SyncMessage; }
182
183     MessageClass messageClass() const
184     {
185         return static_cast<MessageClass>(getClass());
186     }
187
188 private:
189     static inline unsigned stripMostSignificantBit(unsigned value)
190     {
191         return value & 0x7fffffff;
192     }
193
194     unsigned char getFlags() const { return (m_messageID & 0xff000000) >> 24; }
195     unsigned char getClass() const { return (m_messageID & 0x00ff0000) >> 16; }
196
197     unsigned m_messageID;
198 };
199
200 } // namespace CoreIPC
201     
202 #endif // MessageID_h