2 * Copyright (C) 2010 Apple Inc. All rights reserved.
4 * Redistribution and use in source and binary forms, with or without
5 * modification, are permitted provided that the following conditions
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.
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.
27 #include "WebBackForwardList.h"
29 #include "WebPageProxy.h"
33 static const unsigned DefaultCapacity = 100;
35 WebBackForwardList::WebBackForwardList(WebPageProxy* page)
37 , m_current(NoCurrentItemIndex)
38 , m_capacity(DefaultCapacity)
42 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
45 WebBackForwardList::~WebBackForwardList()
49 void WebBackForwardList::pageClosed()
52 size_t size = m_entries.size();
53 for (size_t i = 0; i < size; ++i)
54 m_page->backForwardRemovedItem(m_entries[i]->itemID());
60 void WebBackForwardList::addItem(WebBackForwardListItem* newItem)
62 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
64 if (m_capacity == 0 || !m_enabled)
67 Vector<RefPtr<APIObject> > removedItems;
69 // Toss anything in the forward list
70 if (m_current != NoCurrentItemIndex) {
71 unsigned targetSize = m_current + 1;
72 removedItems.reserveCapacity(m_entries.size() - targetSize);
73 while (m_entries.size() > targetSize) {
75 m_page->backForwardRemovedItem(m_entries.last()->itemID());
76 removedItems.append(m_entries.last().release());
77 m_entries.removeLast();
81 // Toss the first item if the list is getting too big, as long as we're not using it
82 // (or even if we are, if we only want 1 entry).
83 if (m_entries.size() == m_capacity && (m_current != 0 || m_capacity == 1)) {
85 m_page->backForwardRemovedItem(m_entries[0]->itemID());
86 removedItems.append(m_entries[0].release());
91 m_entries.insert(m_current + 1, newItem);
95 m_page->didChangeBackForwardList(newItem, &removedItems);
97 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
100 void WebBackForwardList::goToItem(WebBackForwardListItem* item)
102 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
104 if (!m_entries.size() || !item)
108 for (; index < m_entries.size(); ++index) {
109 if (m_entries[index] == item)
112 if (index < m_entries.size()) {
115 m_page->didChangeBackForwardList(0, 0);
119 WebBackForwardListItem* WebBackForwardList::currentItem()
121 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
123 if (m_current != NoCurrentItemIndex)
124 return m_entries[m_current].get();
128 WebBackForwardListItem* WebBackForwardList::backItem()
130 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
132 if (m_current && m_current != NoCurrentItemIndex)
133 return m_entries[m_current - 1].get();
137 WebBackForwardListItem* WebBackForwardList::forwardItem()
139 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
141 if (m_entries.size() && m_current < m_entries.size() - 1)
142 return m_entries[m_current + 1].get();
146 WebBackForwardListItem* WebBackForwardList::itemAtIndex(int index)
148 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
150 // Do range checks without doing math on index to avoid overflow.
151 if (index < -static_cast<int>(m_current))
154 if (index > forwardListCount())
157 return m_entries[index + m_current].get();
160 int WebBackForwardList::backListCount()
162 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
164 return m_current == NoCurrentItemIndex ? 0 : m_current;
167 int WebBackForwardList::forwardListCount()
169 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
171 return m_current == NoCurrentItemIndex ? 0 : static_cast<int>(m_entries.size()) - (m_current + 1);
174 PassRefPtr<ImmutableArray> WebBackForwardList::backListAsImmutableArrayWithLimit(unsigned limit)
176 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
178 unsigned backListSize = static_cast<unsigned>(backListCount());
179 unsigned size = std::min(backListSize, limit);
181 return ImmutableArray::create();
183 Vector<RefPtr<APIObject> > vector;
184 vector.reserveInitialCapacity(size);
186 ASSERT(backListSize >= size);
187 for (unsigned i = backListSize - size; i < backListSize; ++i)
188 vector.uncheckedAppend(m_entries[i].get());
190 return ImmutableArray::adopt(vector);
193 PassRefPtr<ImmutableArray> WebBackForwardList::forwardListAsImmutableArrayWithLimit(unsigned limit)
195 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
197 unsigned size = std::min(static_cast<unsigned>(forwardListCount()), limit);
199 return ImmutableArray::create();
201 Vector<RefPtr<APIObject> > vector;
202 vector.reserveInitialCapacity(size);
204 unsigned last = m_current + size;
205 ASSERT(last < m_entries.size());
206 for (unsigned i = m_current + 1; i <= last; ++i)
207 vector.uncheckedAppend(m_entries[i].get());
209 return ImmutableArray::adopt(vector);
212 void WebBackForwardList::clear()
214 ASSERT(m_current == NoCurrentItemIndex || m_current < m_entries.size());
216 size_t size = m_entries.size();
220 RefPtr<WebBackForwardListItem> currentItem = this->currentItem();
223 for (size_t i = 0; i < size; ++i) {
224 if (m_entries[i] != currentItem)
225 m_page->backForwardRemovedItem(m_entries[i]->itemID());
229 Vector<RefPtr<APIObject> > removedItems;
230 removedItems.reserveCapacity(m_entries.size() - 1);
231 for (size_t i = 0; i < m_entries.size(); ++i) {
233 removedItems.append(m_entries[i].release());
237 m_entries[0] = currentItem.release();
242 m_page->didChangeBackForwardList(0, &removedItems);
245 } // namespace WebKit