Clean up ChunkedUpdateDrawingAreaProxy
[WebKit-https.git] / WebKitTools / DumpRenderTree / chromium / TestNavigationController.h
1 /*
2  * Copyright (C) 2010 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef TestNavigationController_h
32 #define TestNavigationController_h
33
34 #include "WebDataSource.h"
35 #include "WebHistoryItem.h"
36 #include "WebString.h"
37 #include "WebURL.h"
38 #include "webkit/support/webkit_support.h"
39 #include <string>
40 #include <wtf/RefCounted.h>
41 #include <wtf/RefPtr.h>
42 #include <wtf/Vector.h>
43
44 // Associated with browser-initated navigations to hold tracking data.
45 class TestShellExtraData : public WebKit::WebDataSource::ExtraData {
46 public:
47     TestShellExtraData(int32_t pendingPageID)
48         : pendingPageID(pendingPageID)
49         , requestCommitted(false) {}
50
51     // Contains the page_id for this navigation or -1 if there is none yet.
52     int32_t pendingPageID;
53
54     // True if we have already processed the "DidCommitLoad" event for this
55     // request. Used by session history.
56     bool requestCommitted;
57 };
58
59 // Stores one back/forward navigation state for the test shell.
60 class TestNavigationEntry: public RefCounted<TestNavigationEntry> {
61 public:
62     static PassRefPtr<TestNavigationEntry> create();
63     static PassRefPtr<TestNavigationEntry> create(
64         int pageID,
65         const WebKit::WebURL&,
66         const WebKit::WebString& title,
67         const WebKit::WebString& targetFrame);
68
69     // Virtual to allow test_shell to extend the class.
70     virtual ~TestNavigationEntry();
71
72     // Set / Get the URI
73     void setURL(const WebKit::WebURL& url) { m_url = url; }
74     const WebKit::WebURL& URL() const { return m_url; }
75
76     // Set / Get the title
77     void setTitle(const WebKit::WebString& title) { m_title = title; }
78     const WebKit::WebString& title() const { return m_title; }
79
80     // Set / Get a state.
81     void setContentState(const WebKit::WebHistoryItem&);
82     const WebKit::WebHistoryItem& contentState() const { return m_state; }
83
84     // Get the page id corresponding to the tab's state.
85     void setPageID(int pageID) { m_pageID = pageID; }
86     int32_t pageID() const { return m_pageID; }
87
88     const WebKit::WebString& targetFrame() const { return m_targetFrame; }
89
90 private:
91     TestNavigationEntry();
92     TestNavigationEntry(int pageID,
93                         const WebKit::WebURL&,
94                         const WebKit::WebString& title,
95                         const WebKit::WebString& targetFrame);
96
97     // Describes the current page that the tab represents. This is not relevant
98     // for all tab contents types.
99     int32_t m_pageID;
100
101     WebKit::WebURL m_url;
102     WebKit::WebString m_title;
103     WebKit::WebHistoryItem m_state;
104     WebKit::WebString m_targetFrame;
105 };
106
107 class NavigationHost {
108 public:
109     virtual bool navigate(const TestNavigationEntry&, bool reload) = 0;
110 };
111
112 // Test shell's NavigationController. The goal is to be as close to the Chrome
113 // version as possible.
114 class TestNavigationController: public Noncopyable {
115 public:
116     TestNavigationController(NavigationHost*);
117     ~TestNavigationController();
118
119     void reset();
120
121     // Causes the controller to reload the current (or pending) entry.
122     void reload();
123
124     // Causes the controller to go to the specified offset from current. Does
125     // nothing if out of bounds.
126     void goToOffset(int);
127
128     // Causes the controller to go to the specified index.
129     void goToIndex(int);
130
131     // Causes the controller to load the specified entry.
132     // NOTE: Do not pass an entry that the controller already owns!
133     void loadEntry(TestNavigationEntry*);
134
135     // Returns the last committed entry, which may be null if there are no
136     // committed entries.
137     TestNavigationEntry* lastCommittedEntry() const;
138
139     // Returns the number of entries in the NavigationControllerBase, excluding
140     // the pending entry if there is one.
141     int entryCount() const { return static_cast<int>(m_entries.size()); }
142
143     // Returns the active entry, which is the pending entry if a navigation is in
144     // progress or the last committed entry otherwise.  NOTE: This can be 0!!
145     //
146     // If you are trying to get the current state of the NavigationControllerBase,
147     // this is the method you will typically want to call.
148     TestNavigationEntry* activeEntry() const;
149
150     // Returns the index from which we would go back/forward or reload. This is
151     // the m_lastCommittedEntryIndex if m_pendingEntryIndex is -1. Otherwise,
152     // it is the m_pendingEntryIndex.
153     int currentEntryIndex() const;
154
155     // Returns the entry at the specified index.  Returns 0 if out of
156     // bounds.
157     TestNavigationEntry* entryAtIndex(int) const;
158
159     // Return the entry with the corresponding type and page ID, or 0 if
160     // not found.
161     TestNavigationEntry* entryWithPageID(int32_t) const;
162
163     // Returns the index of the last committed entry.
164     int lastCommittedEntryIndex() const { return m_lastCommittedEntryIndex; }
165
166     // Used to inform us of a navigation being committed for a tab. Any entry
167     // located forward to the current entry will be deleted. The new entry
168     // becomes the current entry.
169     void didNavigateToEntry(TestNavigationEntry*);
170
171     // Used to inform us to discard its pending entry.
172     void discardPendingEntry();
173
174 private:
175     // Inserts an entry after the current position, removing all entries after it.
176     // The new entry will become the active one.
177     void insertEntry(TestNavigationEntry*);
178
179     int maxPageID() const { return m_maxPageID; }
180     void navigateToPendingEntry(bool reload);
181
182     // Return the index of the entry with the corresponding type and page ID,
183     // or -1 if not found.
184     int entryIndexWithPageID(int32_t) const;
185
186     // Updates the max page ID with that of the given entry, if is larger.
187     void updateMaxPageID();
188
189     // List of NavigationEntry for this tab
190     typedef Vector<RefPtr<TestNavigationEntry> > NavigationEntryList;
191     typedef NavigationEntryList::iterator NavigationEntryListIterator;
192     NavigationEntryList m_entries;
193
194     // An entry we haven't gotten a response for yet.  This will be discarded
195     // when we navigate again.  It's used only so we know what the currently
196     // displayed tab is.
197     RefPtr<TestNavigationEntry> m_pendingEntry;
198
199     // currently visible entry
200     int m_lastCommittedEntryIndex;
201
202     // index of pending entry if it is in entries_, or -1 if pending_entry_ is a
203     // new entry (created by LoadURL).
204     int m_pendingEntryIndex;
205
206     NavigationHost* m_host;
207     int m_maxPageID;
208 };
209
210 #endif // TestNavigationController_h
211