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 40 namespace WebKit { 41 42 typedef Vector<RefPtr<WebBackForwardListItem> > BackForwardListItemVector; 43 44 /* 45 * Current 46 * |---------*--------------| Entries 47 * Back Forward 48 */ 49 50 class WebBackForwardList : public APIObject { 51 public: 52 static const Type APIType = TypeBackForwardList; 53 create(WebPageProxy * page)54 static PassRefPtr<WebBackForwardList> create(WebPageProxy* page) 55 { 56 return adoptRef(new WebBackForwardList(page)); 57 } 58 void pageClosed(); 59 60 virtual ~WebBackForwardList(); 61 62 void addItem(WebBackForwardListItem*); 63 void goToItem(WebBackForwardListItem*); 64 void clear(); 65 66 WebBackForwardListItem* currentItem(); 67 WebBackForwardListItem* backItem(); 68 WebBackForwardListItem* forwardItem(); 69 WebBackForwardListItem* itemAtIndex(int); 70 entries()71 const BackForwardListItemVector& entries() const { return m_entries; } 72 currentIndex()73 uint32_t currentIndex() { return m_current; } 74 int backListCount(); 75 int forwardListCount(); 76 77 PassRefPtr<ImmutableArray> backListAsImmutableArrayWithLimit(unsigned limit); 78 PassRefPtr<ImmutableArray> forwardListAsImmutableArrayWithLimit(unsigned limit); 79 80 #if USE(CF) 81 CFDictionaryRef createCFDictionaryRepresentation(WebPageProxy::WebPageProxySessionStateFilterCallback, void* context) const; 82 bool restoreFromCFDictionaryRepresentation(CFDictionaryRef); 83 #endif 84 85 private: 86 static const unsigned NoCurrentItemIndex = UINT_MAX; 87 88 WebBackForwardList(WebPageProxy*); 89 type()90 virtual Type type() const { return APIType; } 91 92 WebPageProxy* m_page; 93 BackForwardListItemVector m_entries; 94 uint32_t m_current; 95 uint32_t m_capacity; 96 bool m_closed; 97 bool m_enabled; 98 }; 99 100 } // namespace WebKit 101 102 #endif // WebBackForwardList_h 103