1 /* 2 * Copyright (C) 2006 Apple Computer, Inc. All rights reserved. 3 * Copyright (C) 2008 Torch Mobile Inc. All rights reserved. (http://www.torchmobile.com/) 4 * Copyright (C) 2009 Google, Inc. All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 9 * 1. Redistributions of source code must retain the above copyright 10 * notice, this list of conditions and the following disclaimer. 11 * 2. Redistributions in binary form must reproduce the above copyright 12 * notice, this list of conditions and the following disclaimer in the 13 * documentation and/or other materials provided with the distribution. 14 * 15 * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY 16 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 18 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE COMPUTER, INC. OR 19 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 20 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 21 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR 22 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY 23 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 25 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 26 */ 27 28 #ifndef BackForwardList_h 29 #define BackForwardList_h 30 31 #include <wtf/RefCounted.h> 32 #include <wtf/PassRefPtr.h> 33 #include <wtf/HashSet.h> 34 #include <wtf/Vector.h> 35 36 namespace WebCore { 37 38 class HistoryItem; 39 class Page; 40 41 typedef Vector<RefPtr<HistoryItem> > HistoryItemVector; 42 typedef HashSet<RefPtr<HistoryItem> > HistoryItemHashSet; 43 44 #if PLATFORM(CHROMIUM) 45 // In the Chromium port, the back/forward list is managed externally. 46 // See BackForwardListChromium.cpp 47 class BackForwardListClient { 48 public: ~BackForwardListClient()49 virtual ~BackForwardListClient() {} 50 virtual void addItem(PassRefPtr<HistoryItem>) = 0; 51 virtual void goToItem(HistoryItem*) = 0; 52 virtual HistoryItem* currentItem() = 0; 53 virtual HistoryItem* itemAtIndex(int) = 0; 54 virtual int backListCount() = 0; 55 virtual int forwardListCount() = 0; 56 virtual void close() = 0; 57 }; 58 #endif 59 60 class BackForwardList : public RefCounted<BackForwardList> { 61 public: create(Page * page)62 static PassRefPtr<BackForwardList> create(Page* page) { return adoptRef(new BackForwardList(page)); } 63 ~BackForwardList(); 64 65 #if PLATFORM(CHROMIUM) 66 // Must be called before any other methods. setClient(BackForwardListClient * client)67 void setClient(BackForwardListClient* client) { m_client = client; } 68 #endif 69 page()70 Page* page() { return m_page; } 71 72 void addItem(PassRefPtr<HistoryItem>); 73 void goBack(); 74 void goForward(); 75 void goToItem(HistoryItem*); 76 77 HistoryItem* backItem(); 78 HistoryItem* currentItem(); 79 HistoryItem* forwardItem(); 80 HistoryItem* itemAtIndex(int); 81 82 void backListWithLimit(int, HistoryItemVector&); 83 void forwardListWithLimit(int, HistoryItemVector&); 84 85 int capacity(); 86 void setCapacity(int); 87 bool enabled(); 88 void setEnabled(bool); 89 int backListCount(); 90 int forwardListCount(); 91 bool containsItem(HistoryItem*); 92 93 void close(); 94 bool closed(); 95 96 void removeItem(HistoryItem*); 97 HistoryItemVector& entries(); 98 99 #if ENABLE(WML) 100 void clearWMLPageHistory(); 101 #endif 102 103 private: 104 BackForwardList(Page*); 105 106 Page* m_page; 107 #if PLATFORM(CHROMIUM) 108 BackForwardListClient* m_client; 109 #else 110 HistoryItemVector m_entries; 111 HistoryItemHashSet m_entryHash; 112 unsigned m_current; 113 #endif 114 unsigned m_capacity; 115 bool m_closed; 116 bool m_enabled; 117 }; 118 119 } //namespace WebCore 120 121 #endif 122