Add IPC decoding support to BackForwardListState
[WebKit-https.git] / Source / WebKit2 / Shared / SessionState.h
1 /*
2  * Copyright (C) 2014 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 SessionState_h
27 #define SessionState_h
28
29 #include <WebCore/IntPoint.h>
30 #include <WebCore/URL.h>
31 #include <wtf/Optional.h>
32 #include <wtf/Vector.h>
33 #include <wtf/text/WTFString.h>
34
35 namespace IPC {
36 class ArgumentDecoder;
37 class ArgumentEncoder;
38 }
39
40 namespace WebKit {
41
42 struct HTTPBody {
43     struct Element {
44         void encode(IPC::ArgumentEncoder&) const;
45         static bool decode(IPC::ArgumentDecoder&, Element&);
46
47         enum class Type {
48             Data,
49             File,
50             Blob,
51         };
52
53         Type type = Type::Data;
54
55         // Data.
56         Vector<char> data;
57
58         // File.
59         String filePath;
60         int64_t fileStart;
61         Optional<int64_t> fileLength;
62         Optional<double> expectedFileModificationTime;
63
64         // Blob.
65         String blobURLString;
66     };
67
68     void encode(IPC::ArgumentEncoder&) const;
69     static bool decode(IPC::ArgumentDecoder&, HTTPBody&);
70
71     String contentType;
72     Vector<Element> elements;
73 };
74
75 struct FrameState {
76     void encode(IPC::ArgumentEncoder&) const;
77     static bool decode(IPC::ArgumentDecoder&, FrameState&);
78
79     String urlString;
80     String originalURLString;
81     String referrer;
82     String target;
83
84     Vector<String> documentState;
85     Vector<uint8_t> stateObjectData;
86
87     int64_t documentSequenceNumber;
88     int64_t itemSequenceNumber;
89
90     WebCore::IntPoint scrollPoint;
91     float pageScaleFactor;
92
93     Optional<HTTPBody> httpBody;
94
95     Vector<FrameState> children;
96 };
97
98 struct PageState {
99     void encode(IPC::ArgumentEncoder&) const;
100     static bool decode(IPC::ArgumentDecoder&, PageState&);
101
102     String title;
103     FrameState mainFrameState;
104 };
105
106 struct BackForwardListState {
107     void encode(IPC::ArgumentEncoder&) const;
108     static bool decode(IPC::ArgumentDecoder&, BackForwardListState&);
109
110     Vector<PageState> items;
111     uint32_t currentIndex;
112 };
113
114 struct SessionState {
115     BackForwardListState backForwardListState;
116     WebCore::URL provisionalURL;
117 };
118
119 } // namespace WebKit
120
121 #endif // SessionState_h