1/* 2 * Copyright (C) 2010, 2011 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 WebBackForwardList_h 27#define WebBackForwardList_h 28 29#include "APIObject.h" 30#include "ImmutableArray.h" 31#include "WebBackForwardListItem.h" 32#include "WebPageProxy.h" 33#include <wtf/PassRefPtr.h> 34#include <wtf/RefPtr.h> 35#include <wtf/Vector.h> 36#if USE(CF) 37#include <CoreFoundation/CFDictionary.h> 38#endif 39 40namespace WebKit { 41 42typedef Vector<RefPtr<WebBackForwardListItem>> BackForwardListItemVector; 43 44/* 45 * Current 46 * |---------*--------------| Entries 47 * Back Forward 48 */ 49 50class WebBackForwardList : public TypedAPIObject<APIObject::TypeBackForwardList> { 51public: 52 static PassRefPtr<WebBackForwardList> create(WebPageProxy* page) 53 { 54 return adoptRef(new WebBackForwardList(page)); 55 } 56 void pageClosed(); 57 58 virtual ~WebBackForwardList(); 59 60 void addItem(WebBackForwardListItem*); 61 void goToItem(WebBackForwardListItem*); 62 void clear(); 63 64 WebBackForwardListItem* currentItem(); 65 WebBackForwardListItem* backItem(); 66 WebBackForwardListItem* forwardItem(); 67 WebBackForwardListItem* itemAtIndex(int); 68 69 const BackForwardListItemVector& entries() const { return m_entries; } 70 71 uint32_t currentIndex() const { return m_currentIndex; } 72 int backListCount() const; 73 int forwardListCount() const; 74 75 PassRefPtr<ImmutableArray> backListAsImmutableArrayWithLimit(unsigned limit) const; 76 PassRefPtr<ImmutableArray> forwardListAsImmutableArrayWithLimit(unsigned limit) const; 77 78#if USE(CF) 79 CFDictionaryRef createCFDictionaryRepresentation(WebPageProxy::WebPageProxySessionStateFilterCallback, void* context) const; 80 bool restoreFromCFDictionaryRepresentation(CFDictionaryRef); 81 bool restoreFromV0CFDictionaryRepresentation(CFDictionaryRef); 82 bool restoreFromV1CFDictionaryRepresentation(CFDictionaryRef); 83#endif 84 85private: 86 explicit WebBackForwardList(WebPageProxy*); 87 88 WebPageProxy* m_page; 89 BackForwardListItemVector m_entries; 90 91 bool m_hasCurrentIndex; 92 unsigned m_currentIndex; 93 unsigned m_capacity; 94}; 95 96} // namespace WebKit 97 98#endif // WebBackForwardList_h 99