Message decoding functions should take a MessageDecoder reference
[WebKit-https.git] / Source / WebKit2 / Shared / ShareableResource.h
1 /*
2  * Copyright (C) 2012 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 ShareableResource_h
27 #define ShareableResource_h
28
29 #include "SharedMemory.h"
30
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/RefCounted.h>
33 #include <wtf/RefPtr.h>
34
35 namespace WebKit {
36     
37 class ShareableResource : public RefCounted<ShareableResource> {
38 public:
39
40     class Handle {
41         WTF_MAKE_NONCOPYABLE(Handle);
42     public:
43         Handle();
44
45         bool isNull() const { return m_handle.isNull(); }
46         unsigned size() const { return m_size; }
47
48         void encode(CoreIPC::ArgumentEncoder&) const;
49         static bool decode(CoreIPC::ArgumentDecoder&, Handle&);
50
51     private:
52         friend class ShareableResource;
53
54         mutable SharedMemory::Handle m_handle;
55         unsigned m_offset;
56         unsigned m_size;
57     };
58
59     // Create a shareable bitmap that uses malloced memory.
60     static PassRefPtr<ShareableResource> create(PassRefPtr<SharedMemory>, unsigned offset, unsigned size);
61
62     // Create a shareable bitmap from a handle.
63     static PassRefPtr<ShareableResource> create(const Handle&);
64
65     // Create a handle.
66     bool createHandle(Handle&);
67
68     ~ShareableResource();
69
70     const char* data() const;
71     unsigned size() const;
72     
73 private:
74     ShareableResource(PassRefPtr<SharedMemory>, unsigned offset, unsigned size);
75
76     RefPtr<SharedMemory> m_sharedMemory;
77
78     unsigned m_offset;
79     unsigned m_size;    
80 };
81
82 } // namespace WebKit
83
84 #endif // ShareableResource_h