Add the notion of auto-converting page and frame handles
[WebKit-https.git] / Source / WebKit2 / Shared / UserData.h
1 /*
2  * Copyright (C) 2013 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 UserData_h
27 #define UserData_h
28
29 #include "APIObject.h"
30 #include <wtf/RefPtr.h>
31
32 namespace IPC {
33 class ArgumentEncoder;
34 class ArgumentDecoder;
35 }
36
37 namespace WebKit {
38
39 class UserData {
40 public:
41     UserData();
42     explicit UserData(RefPtr<API::Object>&&);
43     ~UserData();
44
45     struct Transformer {
46         virtual ~Transformer() { }
47         virtual bool shouldTransformObject(const API::Object&) const = 0;
48         virtual RefPtr<API::Object> transformObject(API::Object&) const = 0;
49     };
50     static RefPtr<API::Object> transform(API::Object*, const Transformer&);
51
52     API::Object* object() const { return m_object.get(); }
53
54     void encode(IPC::ArgumentEncoder&) const;
55     static bool decode(IPC::ArgumentDecoder&, UserData&);
56
57 private:
58     void encode(IPC::ArgumentEncoder&, const API::Object*) const;
59     void encode(IPC::ArgumentEncoder&, const API::Object&) const;
60
61     static bool decode(IPC::ArgumentDecoder&, RefPtr<API::Object>&);
62
63     RefPtr<API::Object> m_object;
64 };
65
66 } // namespace WebKit
67
68 #endif // UserData_h