Stop using PassRefPtr in ShareableResource
[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 #if ENABLE(SHAREABLE_RESOURCE)
30
31 #include "SharedMemory.h"
32
33 #include <wtf/RefCounted.h>
34 #include <wtf/RefPtr.h>
35 #include <wtf/RetainPtr.h>
36
37
38 namespace WebCore {
39 class SharedBuffer;
40 }
41
42 namespace WebKit {
43     
44 class ShareableResource : public RefCounted<ShareableResource> {
45 public:
46
47     class Handle {
48         WTF_MAKE_NONCOPYABLE(Handle);
49     public:
50         Handle();
51
52         bool isNull() const { return m_handle.isNull(); }
53         unsigned size() const { return m_size; }
54
55         void encode(IPC::ArgumentEncoder&) const;
56         static bool decode(IPC::ArgumentDecoder&, Handle&);
57
58         RefPtr<WebCore::SharedBuffer> tryWrapInSharedBuffer() const;
59
60     private:
61         friend class ShareableResource;
62
63         mutable SharedMemory::Handle m_handle;
64         unsigned m_offset;
65         unsigned m_size;
66     };
67
68     // Create a shareable resource that uses malloced memory.
69     static Ref<ShareableResource> create(Ref<SharedMemory>&&, unsigned offset, unsigned size);
70
71     // Create a shareable resource from a handle.
72     static RefPtr<ShareableResource> map(const Handle&);
73
74     // Create a handle.
75     bool createHandle(Handle&);
76
77     ~ShareableResource();
78
79     const char* data() const;
80     unsigned size() const;
81     
82 private:
83     ShareableResource(Ref<SharedMemory>&&, unsigned offset, unsigned size);
84     RefPtr<WebCore::SharedBuffer> wrapInSharedBuffer();
85
86     Ref<SharedMemory> m_sharedMemory;
87
88     unsigned m_offset;
89     unsigned m_size;    
90 };
91
92 } // namespace WebKit
93
94 #endif // ENABLE(SHAREABLE_RESOURCE)
95
96 #endif // ShareableResource_h