Address some style problems found by static analysis
[WebKit-https.git] / Source / WebKit2 / Shared / WebBackForwardListItem.h
1 /*
2  * Copyright (C) 2010-2011, 2016 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 WebBackForwardListItem_h
27 #define WebBackForwardListItem_h
28
29 #include "APIObject.h"
30 #include "SessionState.h"
31 #include <wtf/PassRefPtr.h>
32 #include <wtf/text/WTFString.h>
33
34 namespace API {
35 class Data;
36 }
37
38 namespace IPC {
39 class Decoder;
40 class Encoder;
41 }
42
43 namespace WebKit {
44
45 class WebBackForwardListItem : public API::ObjectImpl<API::Object::Type::BackForwardListItem> {
46 public:
47     static Ref<WebBackForwardListItem> create(BackForwardListItemState&&, uint64_t pageID);
48     virtual ~WebBackForwardListItem();
49
50     uint64_t itemID() const { return m_itemState.identifier; }
51     const BackForwardListItemState& itemState() { return m_itemState; }
52     uint64_t pageID() const { return m_pageID; }
53
54     void setPageState(PageState pageState) { m_itemState.pageState = WTFMove(pageState); }
55
56     const String& originalURL() const { return m_itemState.pageState.mainFrameState.originalURLString; }
57     const String& url() const { return m_itemState.pageState.mainFrameState.urlString; }
58     const String& title() const { return m_itemState.pageState.title; }
59
60     bool itemIsInSameDocument(const WebBackForwardListItem&) const;
61
62 #if PLATFORM(COCOA)
63     ViewSnapshot* snapshot() const { return m_itemState.snapshot.get(); }
64     void setSnapshot(PassRefPtr<ViewSnapshot> snapshot) { m_itemState.snapshot = snapshot; }
65 #endif
66
67     static uint64_t highestUsedItemID();
68
69 private:
70     explicit WebBackForwardListItem(BackForwardListItemState&&, uint64_t pageID);
71
72     BackForwardListItemState m_itemState;
73     uint64_t m_pageID;
74 };
75
76 typedef Vector<RefPtr<WebBackForwardListItem>> BackForwardListItemVector;
77
78 } // namespace WebKit
79
80 #endif // WebBackForwardListItem_h