initial import
[vuplus_webkit] / Source / WebKit2 / Platform / CoreIPC / Attachment.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 Attachment_h
27 #define Attachment_h
28
29 namespace CoreIPC {
30
31 class ArgumentDecoder;
32 class ArgumentEncoder;
33
34 class Attachment {
35 public:
36     Attachment();
37
38     enum Type {
39         Uninitialized,
40 #if PLATFORM(MAC)
41         MachPortType,
42         MachOOLMemoryType,
43 #elif USE(UNIX_DOMAIN_SOCKETS)
44         SocketType,
45         MappedMemoryType
46 #endif
47     };
48
49 #if PLATFORM(MAC)
50     Attachment(mach_port_name_t port, mach_msg_type_name_t disposition);
51     Attachment(void* address, mach_msg_size_t size, mach_msg_copy_options_t copyOptions, bool deallocate);
52 #elif USE(UNIX_DOMAIN_SOCKETS)
53     Attachment(int fileDescriptor, size_t);
54     Attachment(int fileDescriptor);
55 #endif
56
57     Type type() const { return m_type; }
58
59 #if PLATFORM(MAC)
60     void release();
61
62     // MachPortType
63     mach_port_name_t port() const { ASSERT(m_type == MachPortType); return m_port.port; }
64     mach_msg_type_name_t disposition() const { ASSERT(m_type == MachPortType); return m_port.disposition; }
65
66     // MachOOLMemoryType
67     void* address() const { ASSERT(m_type == MachOOLMemoryType); return m_oolMemory.address; }
68     mach_msg_size_t size() const { ASSERT(m_type == MachOOLMemoryType); return m_oolMemory.size; }
69     mach_msg_copy_options_t copyOptions() const { ASSERT(m_type == MachOOLMemoryType); return m_oolMemory.copyOptions; }
70     bool deallocate() const { ASSERT(m_type == MachOOLMemoryType); return m_oolMemory.deallocate; }
71 #elif USE(UNIX_DOMAIN_SOCKETS)
72     size_t size() const { return m_size; }
73
74     int releaseFileDescriptor() { int temp = m_fileDescriptor; m_fileDescriptor = -1; return temp; }
75     int fileDescriptor() const { return m_fileDescriptor; }
76
77     void dispose();
78 #endif
79
80     void encode(ArgumentEncoder*) const;
81     static bool decode(ArgumentDecoder*, Attachment&);
82     
83 private:
84     Type m_type;
85
86 #if PLATFORM(MAC)
87     union {
88         struct {
89             mach_port_name_t port;
90             mach_msg_type_name_t disposition;
91         } m_port;
92         struct {
93             void* address;
94             mach_msg_size_t size;
95             mach_msg_copy_options_t copyOptions;
96             bool deallocate;
97         } m_oolMemory;
98     };
99 #elif USE(UNIX_DOMAIN_SOCKETS)
100     int m_fileDescriptor;
101     size_t m_size;
102 #endif
103 };
104
105 } // namespace CoreIPC
106
107 #endif // Attachment_h