WebBackForwardList.cpp [plain text]
#include "config.h"
#include "WebBackForwardList.h"
#include "APIArray.h"
#include "SessionState.h"
#include "WebPageProxy.h"
namespace WebKit {
uint64_t generateWebBackForwardItemID();
uint64_t generateWebBackForwardItemID()
{
static uint64_t uniqueHistoryItemID = 0;
uniqueHistoryItemID += 2;
return uniqueHistoryItemID;
}
static const unsigned DefaultCapacity = 100;
WebBackForwardList::WebBackForwardList(WebPageProxy& page)
: m_page(&page)
, m_hasCurrentIndex(false)
, m_currentIndex(0)
, m_capacity(DefaultCapacity)
{
}
WebBackForwardList::~WebBackForwardList()
{
ASSERT((!m_page && !m_hasCurrentIndex) || !m_page->isValid());
}
void WebBackForwardList::pageClosed()
{
ASSERT(m_page);
if (m_page) {
size_t size = m_entries.size();
for (size_t i = 0; i < size; ++i) {
ASSERT(m_entries[i]);
if (!m_entries[i])
continue;
m_page->backForwardRemovedItem(m_entries[i]->itemID());
}
}
m_page = 0;
m_entries.clear();
m_hasCurrentIndex = false;
}
void WebBackForwardList::addItem(WebBackForwardListItem* newItem)
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
if (!m_capacity || !newItem || !m_page)
return;
Vector<RefPtr<WebBackForwardListItem>> removedItems;
if (m_hasCurrentIndex) {
unsigned targetSize = m_currentIndex + 1;
removedItems.reserveCapacity(m_entries.size() - targetSize);
while (m_entries.size() > targetSize) {
m_page->backForwardRemovedItem(m_entries.last()->itemID());
removedItems.append(m_entries.last().release());
m_entries.removeLast();
}
if (m_entries.size() == m_capacity && (m_currentIndex || m_capacity == 1)) {
m_page->backForwardRemovedItem(m_entries[0]->itemID());
removedItems.append(m_entries[0].release());
m_entries.remove(0);
if (m_entries.isEmpty())
m_hasCurrentIndex = false;
else
m_currentIndex--;
}
} else {
ASSERT(m_entries.isEmpty());
size_t size = m_entries.size();
for (size_t i = 0; i < size; ++i) {
ASSERT(m_entries[i]);
if (!m_entries[i])
continue;
m_page->backForwardRemovedItem(m_entries[i]->itemID());
removedItems.append(m_entries[i].release());
}
m_entries.clear();
}
bool shouldKeepCurrentItem = true;
if (!m_hasCurrentIndex) {
ASSERT(m_entries.isEmpty());
m_currentIndex = 0;
m_hasCurrentIndex = true;
} else {
shouldKeepCurrentItem = m_page->shouldKeepCurrentBackForwardListItemInList(m_entries[m_currentIndex].get());
if (shouldKeepCurrentItem)
m_currentIndex++;
}
if (!shouldKeepCurrentItem) {
ASSERT(m_currentIndex < m_entries.size());
removedItems.append(m_entries[m_currentIndex]);
m_entries[m_currentIndex] = newItem;
} else {
ASSERT(m_currentIndex <= m_entries.size());
if (m_currentIndex <= m_entries.size())
m_entries.insert(m_currentIndex, newItem);
}
m_page->didChangeBackForwardList(newItem, WTF::move(removedItems));
}
void WebBackForwardList::goToItem(WebBackForwardListItem* item)
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
if (!m_entries.size() || !item || !m_page || !m_hasCurrentIndex)
return;
size_t targetIndex = m_entries.find(item);
if (targetIndex == notFound)
return;
WebBackForwardListItem* currentItem = m_entries[m_currentIndex].get();
bool shouldKeepCurrentItem = true;
if (currentItem != item)
shouldKeepCurrentItem = m_page->shouldKeepCurrentBackForwardListItemInList(m_entries[m_currentIndex].get());
Vector<RefPtr<WebBackForwardListItem>> removedItems;
if (!shouldKeepCurrentItem) {
removedItems.append(currentItem);
m_entries.remove(m_currentIndex);
targetIndex = m_entries.find(item);
ASSERT(targetIndex != notFound);
}
m_currentIndex = targetIndex;
m_page->didChangeBackForwardList(nullptr, removedItems);
}
WebBackForwardListItem* WebBackForwardList::currentItem() const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
return m_page && m_hasCurrentIndex ? m_entries[m_currentIndex].get() : nullptr;
}
WebBackForwardListItem* WebBackForwardList::backItem() const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
return m_page && m_hasCurrentIndex && m_currentIndex ? m_entries[m_currentIndex - 1].get() : nullptr;
}
WebBackForwardListItem* WebBackForwardList::forwardItem() const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
return m_page && m_hasCurrentIndex && m_entries.size() && m_currentIndex < m_entries.size() - 1 ? m_entries[m_currentIndex + 1].get() : nullptr;
}
WebBackForwardListItem* WebBackForwardList::itemAtIndex(int index) const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
if (!m_hasCurrentIndex || !m_page)
return nullptr;
if (index < -backListCount())
return nullptr;
if (index > forwardListCount())
return nullptr;
return m_entries[index + m_currentIndex].get();
}
int WebBackForwardList::backListCount() const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
return m_page && m_hasCurrentIndex ? m_currentIndex : 0;
}
int WebBackForwardList::forwardListCount() const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
return m_page && m_hasCurrentIndex ? m_entries.size() - (m_currentIndex + 1) : 0;
}
PassRefPtr<API::Array> WebBackForwardList::backList() const
{
return backListAsAPIArrayWithLimit(backListCount());
}
PassRefPtr<API::Array> WebBackForwardList::forwardList() const
{
return forwardListAsAPIArrayWithLimit(forwardListCount());
}
PassRefPtr<API::Array> WebBackForwardList::backListAsAPIArrayWithLimit(unsigned limit) const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
if (!m_page || !m_hasCurrentIndex)
return API::Array::create();
unsigned backListSize = static_cast<unsigned>(backListCount());
unsigned size = std::min(backListSize, limit);
if (!size)
return API::Array::create();
Vector<RefPtr<API::Object>> vector;
vector.reserveInitialCapacity(size);
ASSERT(backListSize >= size);
for (unsigned i = backListSize - size; i < backListSize; ++i) {
ASSERT(m_entries[i]);
vector.uncheckedAppend(m_entries[i].get());
}
return API::Array::create(WTF::move(vector));
}
PassRefPtr<API::Array> WebBackForwardList::forwardListAsAPIArrayWithLimit(unsigned limit) const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
if (!m_page || !m_hasCurrentIndex)
return API::Array::create();
unsigned size = std::min(static_cast<unsigned>(forwardListCount()), limit);
if (!size)
return API::Array::create();
Vector<RefPtr<API::Object>> vector;
vector.reserveInitialCapacity(size);
unsigned last = m_currentIndex + size;
ASSERT(last < m_entries.size());
for (unsigned i = m_currentIndex + 1; i <= last; ++i) {
ASSERT(m_entries[i]);
vector.uncheckedAppend(m_entries[i].get());
}
return API::Array::create(WTF::move(vector));
}
void WebBackForwardList::removeAllItems()
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
Vector<RefPtr<WebBackForwardListItem>> removedItems;
for (auto& entry : m_entries) {
ASSERT(entry);
if (!entry)
continue;
m_page->backForwardRemovedItem(entry->itemID());
removedItems.append(WTF::move(entry));
}
m_entries.clear();
m_hasCurrentIndex = false;
m_page->didChangeBackForwardList(nullptr, WTF::move(removedItems));
}
void WebBackForwardList::clear()
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
size_t size = m_entries.size();
if (!m_page || size <= 1)
return;
RefPtr<WebBackForwardListItem> currentItem = this->currentItem();
Vector<RefPtr<WebBackForwardListItem>> removedItems;
if (!currentItem) {
ASSERT(!m_hasCurrentIndex);
for (size_t i = 0; i < size; ++i) {
ASSERT(m_entries[i]);
if (!m_entries[i])
continue;
m_page->backForwardRemovedItem(m_entries[i]->itemID());
removedItems.append(m_entries[i].release());
}
m_entries.clear();
m_hasCurrentIndex = false;
m_page->didChangeBackForwardList(nullptr, WTF::move(removedItems));
return;
}
for (size_t i = 0; i < size; ++i) {
ASSERT(m_entries[i]);
if (m_entries[i] && m_entries[i] != currentItem)
m_page->backForwardRemovedItem(m_entries[i]->itemID());
}
removedItems.reserveCapacity(size - 1);
for (size_t i = 0; i < size; ++i) {
if (i != m_currentIndex && m_hasCurrentIndex && m_entries[i])
removedItems.append(m_entries[i].release());
}
m_currentIndex = 0;
if (currentItem) {
m_entries.shrink(1);
m_entries[0] = currentItem.release();
} else {
m_entries.clear();
m_hasCurrentIndex = false;
}
m_page->didChangeBackForwardList(nullptr, WTF::move(removedItems));
}
BackForwardListState WebBackForwardList::backForwardListState(const std::function<bool (WebBackForwardListItem&)>& filter) const
{
ASSERT(!m_hasCurrentIndex || m_currentIndex < m_entries.size());
BackForwardListState backForwardListState;
if (m_hasCurrentIndex)
backForwardListState.currentIndex = m_currentIndex;
for (size_t i = 0; i < m_entries.size(); ++i) {
auto& entry = *m_entries[i];
if (filter && !filter(entry)) {
if (backForwardListState.currentIndex && i <= backForwardListState.currentIndex.value())
--backForwardListState.currentIndex.value();
continue;
}
backForwardListState.items.append(entry.itemState());
}
return backForwardListState;
}
void WebBackForwardList::restoreFromState(BackForwardListState backForwardListState)
{
Vector<RefPtr<WebBackForwardListItem>> items;
items.reserveInitialCapacity(backForwardListState.items.size());
for (auto& backForwardListItemState : backForwardListState.items) {
backForwardListItemState.identifier = generateWebBackForwardItemID();
items.uncheckedAppend(WebBackForwardListItem::create(WTF::move(backForwardListItemState), m_page->pageID()));
}
m_hasCurrentIndex = !!backForwardListState.currentIndex;
m_currentIndex = backForwardListState.currentIndex.valueOr(0);
m_entries = WTF::move(items);
}
Vector<BackForwardListItemState> WebBackForwardList::itemStates() const
{
Vector<BackForwardListItemState> itemStates;
itemStates.reserveInitialCapacity(m_entries.size());
for (const auto& entry : m_entries)
itemStates.uncheckedAppend(entry->itemState());
return itemStates;
}
}