auto import from //depot/cupcake/@135843

1 files changed, 238 insertions, 0 deletions

diff --git a/WebCore/history/HistoryItem.h b/WebCore/history/HistoryItem.h
new file mode 100644
index 0000000..839f47d
--- /dev/null
+++ b/WebCore/history/HistoryItem.h
@@ -0,0 +1,238 @@
+/*
+ * Copyright (C) 2006 Apple Computer, Inc.  All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY APPLE COMPUTER, INC. ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+ * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+ * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
+ * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+ * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+ * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+ * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+ * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 
+ */
+
+#ifndef HistoryItem_h
+#define HistoryItem_h
+
+#include "CachedPage.h"
+#include "FormData.h"
+#include "IntPoint.h"
+#include "PlatformString.h"
+#include <wtf/RefCounted.h>
+#include "StringHash.h"
+#include <wtf/HashMap.h>
+#include <wtf/OwnPtr.h>
+#include <wtf/RefPtr.h>
+#include <wtf/Vector.h>
+
+#if PLATFORM(QT)
+#include <QVariant>
+#endif
+
+#if PLATFORM(MAC)
+#import <wtf/RetainPtr.h>
+typedef struct objc_object* id;
+#endif
+
+#ifdef ANDROID_HISTORY_CLIENT
+#include "WebHistory.h"
+#endif
+
+namespace WebCore {
+
+class Document;
+class Image;
+class KURL;
+class ResourceRequest;
+
+class HistoryItem;
+typedef Vector<RefPtr<HistoryItem> > HistoryItemVector;
+
+#ifdef ANDROID_HISTORY_CLIENT
+extern void (*notifyHistoryItemChanged)(HistoryItem*);
+#else
+extern void (*notifyHistoryItemChanged)();
+#endif
+
+class HistoryItem : public RefCounted<HistoryItem> {
+    friend class PageCache;
+
+public: 
+    static PassRefPtr<HistoryItem> create() { return adoptRef(new HistoryItem); }
+    static PassRefPtr<HistoryItem> create(const String& urlString, const String& title, double lastVisited)
+    {
+        return adoptRef(new HistoryItem(urlString, title, lastVisited));
+    }
+    static PassRefPtr<HistoryItem> create(const String& urlString, const String& title, const String& alternateTitle, double lastVisited)
+    {
+        return adoptRef(new HistoryItem(urlString, title, alternateTitle, lastVisited));
+    }
+    static PassRefPtr<HistoryItem> create(const KURL& url, const String& target, const String& parent, const String& title)
+    {
+        return adoptRef(new HistoryItem(url, target, parent, title));
+    }
+    
+    ~HistoryItem();
+    
+    PassRefPtr<HistoryItem> copy() const;
+    
+    const String& originalURLString() const;
+    const String& urlString() const;
+    const String& title() const;
+    
+    void setInPageCache(bool inPageCache) { m_isInPageCache = inPageCache; }
+    bool isInPageCache() const { return m_isInPageCache; }
+    
+    double lastVisitedTime() const;
+    
+    void setAlternateTitle(const String& alternateTitle);
+    const String& alternateTitle() const;
+    
+    Image* icon() const;
+    
+    const String& parent() const;
+    KURL url() const;
+    KURL originalURL() const;
+    const String& target() const;
+    bool isTargetItem() const;
+    
+    FormData* formData();
+    String formContentType() const;
+    String formReferrer() const;
+    String rssFeedReferrer() const;
+    
+    int visitCount() const;
+
+    void mergeAutoCompleteHints(HistoryItem* otherItem);
+    
+    const IntPoint& scrollPoint() const;
+    void setScrollPoint(const IntPoint&);
+    void clearScrollPoint();
+    const Vector<String>& documentState() const;
+    void setDocumentState(const Vector<String>&);
+    void clearDocumentState();
+
+    void setURL(const KURL&);
+    void setURLString(const String&);
+    void setOriginalURLString(const String&);
+    void setTarget(const String&);
+    void setParent(const String&);
+    void setTitle(const String&);
+    void setIsTargetItem(bool);
+    
+    void setFormInfoFromRequest(const ResourceRequest&);
+
+    void setRSSFeedReferrer(const String&);
+    void setVisitCount(int);
+
+    void addChildItem(PassRefPtr<HistoryItem>);
+    HistoryItem* childItemWithName(const String&) const;
+    HistoryItem* targetItem();
+    HistoryItem* recurseToFindTargetItem();
+    const HistoryItemVector& children() const;
+    bool hasChildren() const;
+
+    // This should not be called directly for HistoryItems that are already included
+    // in GlobalHistory. The WebKit api for this is to use -[WebHistory setLastVisitedTimeInterval:forItem:] instead.
+    void setLastVisitedTime(double);
+    
+    bool isCurrentDocument(Document*) const;
+    
+#if PLATFORM(MAC)
+    id viewState() const;
+    void setViewState(id);
+    
+    // Transient properties may be of any ObjC type.  They are intended to be used to store state per back/forward list entry.
+    // The properties will not be persisted; when the history item is removed, the properties will be lost.
+    id getTransientProperty(const String&) const;
+    void setTransientProperty(const String&, id);
+#endif
+
+#if PLATFORM(QT)
+    QVariant userData() const { return m_userData; }
+    void setUserData(const QVariant& userData) { m_userData = userData; }
+#endif
+
+#ifndef NDEBUG
+    int showTree() const;
+    int showTreeWithIndent(unsigned indentLevel) const;
+#endif
+    
+#ifdef ANDROID_HISTORY_CLIENT
+    void setBridge(android::WebHistoryItem* bridge) { m_bridge = adoptRef(bridge); }
+    android::WebHistoryItem* bridge() const { return m_bridge.get(); }
+#endif
+
+private:
+    HistoryItem();
+    HistoryItem(const String& urlString, const String& title, double lastVisited);
+    HistoryItem(const String& urlString, const String& title, const String& alternateTitle, double lastVisited);
+    HistoryItem(const KURL& url, const String& target, const String& parent, const String& title);
+
+    HistoryItem(const HistoryItem&);
+    
+    String m_urlString;
+    String m_originalURLString;
+    String m_target;
+    String m_parent;
+    String m_title;
+    String m_displayTitle;
+    
+    double m_lastVisitedTime;
+
+    IntPoint m_scrollPoint;
+    Vector<String> m_documentState;
+    
+    HistoryItemVector m_subItems;
+    
+    bool m_isInPageCache;
+    bool m_isTargetItem;
+    int m_visitCount;
+    
+    // info used to repost form data
+    RefPtr<FormData> m_formData;
+    String m_formContentType;
+    String m_formReferrer;
+
+    // info used to support RSS feeds
+    String m_rssFeedReferrer;
+
+    // PageCache controls these fields.
+    HistoryItem* m_next;
+    HistoryItem* m_prev;
+    RefPtr<CachedPage> m_cachedPage;
+    
+#if PLATFORM(MAC)
+    RetainPtr<id> m_viewState;
+    OwnPtr<HashMap<String, RetainPtr<id> > > m_transientProperties;
+#endif
+        
+#ifdef ANDROID_HISTORY_CLIENT
+    RefPtr<android::WebHistoryItem> m_bridge;
+#endif
+
+#if PLATFORM(QT)
+    QVariant m_userData;
+#endif
+}; //class HistoryItem
+
+} //namespace WebCore
+
+#ifndef NDEBUG
+// Outside the WebCore namespace for ease of invocation from gdb.
+extern "C" int showTree(const WebCore::HistoryItem*);
+#endif
+
+#endif // HISTORYITEM_H