Changeset 38097 in webkit

Timestamp:

Nov 4, 2008 8:22:05 AM (16 years ago)

Author:

Simon Hausmann

Message:

WebCore:

2008-11-03 Yael Aharon <​yael.aharon@nokia.com>

Reviewed by Simon Hausmann.

Add methods for getting and setting user data on History Item.
This change is limited to QT port only. Tests were added in
the patch for ​https://bugs.webkit.org/show_bug.cgi?id=21864.

Minor change by Simon: made the functions inline and added a missing
const.

WebKit/qt:

2008-10-24 Yael Aharon <​yael.aharon@nokia.com>

Reviewed by Simon Hausmann.

Add userData() and setUserData() to QWebHistoryItem.
Add setMaximumItemCount() and maximumItemCount() to QWebHistory.
Add currentItemIndex() to QWebHistory.

See also ​https://bugs.webkit.org/show_bug.cgi?id=21864

Small cleanup by Simon (docs and forward declaration of QWebHistoryItem in qwebframe.h)

Location:

trunk

Files:

• WebCore/ChangeLog (modified) (1 diff)
• WebCore/history/HistoryItem.h (modified) (3 diffs)
• WebKit/qt/Api/qwebframe.cpp (modified) (1 diff)
• WebKit/qt/Api/qwebframe.h (modified) (2 diffs)
• WebKit/qt/Api/qwebhistory.cpp (modified) (4 diffs)
• WebKit/qt/Api/qwebhistory.h (modified) (4 diffs)
• WebKit/qt/ChangeLog (modified) (1 diff)
• WebKit/qt/WebCoreSupport/FrameLoaderClientQt.cpp (modified) (2 diffs)
• WebKit/qt/tests/qwebpage/tst_qwebpage.cpp (modified) (1 diff)

trunk/WebCore/ChangeLog

@@ +1 @@
+2008-11-03  Yael Aharon  <yael.aharon@nokia.com>
+
+        Reviewed by Simon Hausmann.
+
+        Add methods for getting and setting user data on History Item.
+        This change is limited to QT port only. Tests were added in
+        the patch for https://bugs.webkit.org/show_bug.cgi?id=21864.
+
+        Minor change by Simon: made the functions inline and added a missing
+        const.
+
+        * history/HistoryItem.h:
+
 2008-11-01  Alexey Proskuryakov  <ap@webkit.org>
 

trunk/WebCore/history/HistoryItem.h

@@ -38 +38 @@
 #include <wtf/Vector.h>
 
+#if PLATFORM(QT)
+#include <QVariant>
+#endif
+
 #if PLATFORM(MAC)
 #import <wtf/RetainPtr.h>
@@ -149 +153 @@
 #endif
 
+#if PLATFORM(QT)
+    QVariant userData() const { return m_userData; }
+    void setUserData(const QVariant& userData) { m_userData = userData; }
+#endif
+
 #ifndef NDEBUG
     int showTree() const;
@@ -197 +206 @@
     OwnPtr<HashMap<String, RetainPtr<id> > > m_transientProperties;
 #endif
+#if PLATFORM(QT)
+    QVariant m_userData;
+#endif
 }; //class HistoryItem
 

trunk/WebKit/qt/Api/qwebframe.cpp

@@ -961 +961 @@
 
 /*!
+  \since 4.5
+  \fn void QWebFrame::aboutToUpdateHistory(QWebHistoryItem* item);
+
+  This signal is emitted shortly before the history of navigated pages
+  is changed, for example when navigating back in the history.
+
+  A potential use-case for this signal is to store custom data in
+  the QWebHistoryItem associated to the frame, using QWebHistoryItem::setUserData().
+*/
+
+/*!
     \class QWebHitTestResult
     \since 4.4

trunk/WebKit/qt/Api/qwebframe.h

@@ -47 +47 @@
 class QWebPage;
 class QWebHitTestResult;
+class QWebHistoryItem;
 
 namespace WebCore {
@@ -185 +186 @@
     void iconChanged();
 
+    void aboutToUpdateHistory(QWebHistoryItem* item);
+
 private:
     friend class QWebPage;

trunk/WebKit/qt/Api/qwebhistory.cpp

@@ -48 +48 @@
   \row    \o lastVisited() \o The date and time of the user's last visit to the page.
   \row    \o icon()        \o The icon associated with the page that was provided by the server.
+  \row    \o userData()    \o The user specific data that was stored with the history item.
   \endtable
 
@@ -145 +146 @@
 
 /*!
+  \since 4.5
+  Returns the user specific data that was stored with the history item.
+
+  \sa setUserData()
+*/
+QVariant QWebHistoryItem::userData() const
+{
+    if (d->item)
+        return d->item->userData();
+    return QVariant();
+}
+
+/*!
+  \since 4.5
+
+ Stores user specific data with the history item.
+
+ \sa userData()
+*/
+void QWebHistoryItem::setUserData(const QVariant& userData)
+{
+    if (d->item)
+        d->item->setUserData(userData);
+}
+
+/*!*
   \internal
 */
@@ -365 +392 @@
 
 /*!
+  \since 4.5
+  Returns the index of the current item in history.
+*/
+int QWebHistory::currentItemIndex() const
+{
+    return d->lst->backListCount();
+}
+
+/*!
   Returns the item at index \a i in the history.
 */
@@ -383 +419 @@
 }
 
+/*!
+  \since 4.5
+  Returns the maximum number of items in the history.
+
+  \sa setMaximumItemCount()
+*/
+int QWebHistory::maximumItemCount() const
+{
+    return d->lst->capacity();
+}
+
+/*!
+  \since 4.5
+  Sets the maximum number of items in the history.
+
+  \sa maximumItemCount()
+*/
+void QWebHistory::setMaximumItemCount(int count)
+{
+    d->lst->setCapacity(count);
+}
+

trunk/WebKit/qt/Api/qwebhistory.h

@@ -31 +31 @@
 class QWebPage;
 
+namespace WebCore {
+    class FrameLoaderClientQt;
+};
+
 class QWebHistoryItemPrivate;
 class QWEBKIT_EXPORT QWebHistoryItem
@@ -47 +51 @@
     QIcon icon() const;
 
+    QVariant userData() const;
+    void setUserData(const QVariant& userData);
+
     bool isValid() const;
 
@@ -53 +60 @@
     friend class QWebHistory;
     friend class QWebPage;
+    friend class WebCore::FrameLoaderClientQt;
     QExplicitlySharedDataPointer<QWebHistoryItemPrivate> d;
 };
@@ -78 +86 @@
     QWebHistoryItem itemAt(int i) const;
 
+    int currentItemIndex() const;
+
     int count() const;
+
+    int maximumItemCount() const;
+    void setMaximumItemCount(int count);
 
 private:

trunk/WebKit/qt/ChangeLog

@@ +1 @@
+2008-10-24  Yael Aharon <yael.aharon@nokia.com>
+
+        Reviewed by Simon Hausmann.
+
+        Add userData() and setUserData() to QWebHistoryItem.
+        Add setMaximumItemCount() and maximumItemCount() to QWebHistory.
+        Add currentItemIndex() to QWebHistory.
+
+        See also https://bugs.webkit.org/show_bug.cgi?id=21864
+
+        Small cleanup by Simon (docs and forward declaration of QWebHistoryItem in qwebframe.h)
+
+        * Api/qwebframe.h:
+        * Api/qwebhistory.cpp:
+        (QWebHistoryItem::userData):
+        (QWebHistoryItem::setUserData):
+        (QWebHistory::currentItemIndex):
+        (QWebHistory::maximumItemCount):
+        (QWebHistory::setMaximumItemCount):
+        * Api/qwebhistory.h:
+        * WebCoreSupport/FrameLoaderClientQt.cpp:
+        (WebCore::FrameLoaderClientQt::saveViewStateToItem):
+        * tests/qwebpage/tst_qwebpage.cpp:
+        (tst_QWebPage::modified):
+
 2008-11-03  Cameron Zwarich  <zwarich@apple.com>
 

trunk/WebKit/qt/WebCoreSupport/FrameLoaderClientQt.cpp

@@ -67 +67 @@
 #include "qwebnetworkinterface_p.h"
 #endif
+#include "qwebhistory_p.h"
 
 static bool dumpFrameLoaderCallbacks = false;
@@ -633 +634 @@
 }
 
-void FrameLoaderClientQt::saveViewStateToItem(WebCore::HistoryItem*)
-{
+void FrameLoaderClientQt::saveViewStateToItem(WebCore::HistoryItem* item)
+{
+    QWebHistoryItem historyItem(new QWebHistoryItemPrivate(item));
+    emit m_webFrame->aboutToUpdateHistory(&historyItem);
 }
 

trunk/WebKit/qt/tests/qwebpage/tst_qwebpage.cpp

@@ -305 +305 @@
 
     QVERIFY(!m_page->isModified());
+
+    QVERIFY(m_page->history()->currentItemIndex() == 0);
+
+    m_page->history()->setMaximumItemCount(3);
+    QVERIFY(m_page->history()->maximumItemCount() == 3);
+
+    QVariant variant("string test");
+    m_page->history()->currentItem().setUserData(variant);
+    QVERIFY(m_page->history()->currentItem().userData().toString() == "string test");
+
+    m_page->mainFrame()->setUrl(QUrl("data:text/html,<body>This is second page"));
+    m_page->mainFrame()->setUrl(QUrl("data:text/html,<body>This is third page"));
+    QVERIFY(m_page->history()->count() == 2);
+    m_page->mainFrame()->setUrl(QUrl("data:text/html,<body>This is fourth page"));
+    QVERIFY(m_page->history()->count() == 2);
+    m_page->mainFrame()->setUrl(QUrl("data:text/html,<body>This is fifth page"));
+    QVERIFY(::waitForSignal(m_page->mainFrame(), SIGNAL(aboutToUpdateHistory(QWebHistoryItem*))));
 }