Bug 21863 – Add userData and setUserData methods to History Item

• Status: RESOLVED
• Resolution: FIXED
• Component: WebKit Qt

[Yael]

Add userData() and setUserData() methods to History Item, under QT flag only.

[Yael]

Created attachment 24648 [details]
Add setUserData() and userData() methods.

Add setUserData() and userData() methods to HistoryItem under QT flag only.

[Brady Eidson]

Comment on attachment 24648 [details]
Add setUserData() and userData() methods.

> Index: WebCore/WebCore.pro
> ===================================================================
> --- WebCore/WebCore.pro	(revision 37851)
> +++ WebCore/WebCore.pro	(working copy)
> @@ -1006,6 +1006,7 @@
>      bridge/qt/qt_class.cpp \
>      bridge/qt/qt_instance.cpp \
>      bridge/qt/qt_runtime.cpp \
> +    history/qt/HistoryItemQt.cpp \
>      page/qt/AccessibilityObjectQt.cpp \
>      page/qt/DragControllerQt.cpp \
>      page/qt/EventHandlerQt.cpp \
> Index: WebCore/ChangeLog
> ===================================================================
> --- WebCore/ChangeLog	(revision 37853)
> +++ WebCore/ChangeLog	(working copy)
> @@ -1,3 +1,16 @@
> [phone]  Yael Aharon <[e-mail]>
> +
> +        Reviewed by NOBODY (OOPS!).
> +
> +        Add methods for getting and setting user data on History Item.
> +        This change is limited to QT port only. Tests will be added shortly.
> +
> +        * WebCore.pro:
> +        * history/HistoryItem.h:
> +        * history/qt/HistoryItemQt.cpp: Added.
> +        (WebCore::HistoryItem::userData):
> +        (WebCore::HistoryItem::setUserData):
> +
>  2008-10-24  Simon Fraser  <[e-mail]>
>  
>          Reviewed by Darin Adler
> Index: WebCore/history/qt/HistoryItemQt.cpp
> ===================================================================
> --- WebCore/history/qt/HistoryItemQt.cpp	(revision 0)
> +++ WebCore/history/qt/HistoryItemQt.cpp	(revision 0)
> @@ -0,0 +1,35 @@
> +/*
> +    Copyright (C) 2008 Trolltech ASA
> +
> +    This library is free software; you can redistribute it and/or
> +    modify it under the terms of the GNU Library General Public
> +    License as published by the Free Software Foundation; either
> +    version 2 of the License, or (at your option) any later version.
> +
> +    This library is distributed in the hope that it will be useful,
> +    but WITHOUT ANY WARRANTY; without even the implied warranty of
> +    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
> +    Library General Public License for more details.
> +
> +    You should have received a copy of the GNU Library General Public License
> +    along with this library; see the file COPYING.LIB.  If not, write to
> +    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
> +    Boston, MA 02110-1301, USA.
> +*/
> +
> +#include "HistoryItem.h"
> +#include <QVariant>
> +
> +namespace WebCore {
> +
> +QVariant HistoryItem::userData()
> +{
> +    return m_userData;
> +}
> +
> +void HistoryItem::setUserData(QVariant& userData)
> +{
> +    m_userData = userData;
> +}
> +
> +}; // namespace WebCore
> Index: WebCore/history/HistoryItem.h
> ===================================================================
> --- WebCore/history/HistoryItem.h	(revision 37851)
> +++ WebCore/history/HistoryItem.h	(working copy)
> @@ -41,7 +41,9 @@
>  #import <wtf/RetainPtr.h>
>  typedef struct objc_object* id;
>  #endif
> -
> +#if PLATFORM(QT)
> +#include <QVariant>
> +#endif
>  namespace WebCore {
>  
>  class Document;
> @@ -147,6 +149,10 @@
>      id getTransientProperty(const String&) const;
>      void setTransientProperty(const String&, id);
>  #endif
> +#if PLATFORM(QT)
> +    QVariant userData();
> +    void setUserData(QVariant& userData);
> +#endif
>  
>  #ifndef NDEBUG
>      int showTree() const;
> @@ -196,6 +202,9 @@
>      RetainPtr<id> m_viewState;
>      OwnPtr<HashMap<String, RetainPtr<id> > > m_transientProperties;
>  #endif
> +#if PLATFORM(QT)
> +    QVariant m_userData;
> +#endif
>  }; //class HistoryItem
>  
>  } //namespace WebCore

[Holger Freyther]

Trolltech ASA is gone? Please update the copyright notice to something more appropriate.

The implementation is not including "config.h" as it should do and I still don't understand the need for that change.

[Yael]

Created attachment 24858 [details]
Updated the copyright as requested.

Applications may need to store data with the history that is not currently supported by WebCore. In my case, my application needs to store a thumbnail of the page for each history item.
Without this patch, every application that needs to add more data would have to keeps a second copy of the history, and make sure it is always in sync. While it is doable, I don't think it is the best approach. thanks!

[Simon Hausmann]

(In reply to comment #3)
> Trolltech ASA is gone? Please update the copyright notice to something more
> appropriate.
> 
> The implementation is not including "config.h" as it should do and I still
> don't understand the need for that change.

This is related to #21864, which makes it possible to implement things like thumbnails for pages and store them in the history.

[Simon Hausmann]

Comment on attachment 24648 [details]
Add setUserData() and userData() methods.

Obsoleted by updated patch

[Simon Hausmann]

Comment on attachment 24858 [details]
Updated the copyright as requested.

> Index: WebCore.pro
> ===================================================================
> --- WebCore.pro	(revision 38068)
> +++ WebCore.pro	(working copy)
> @@ -1019,6 +1019,7 @@
>      bridge/qt/qt_class.cpp \
>      bridge/qt/qt_instance.cpp \
>      bridge/qt/qt_runtime.cpp \
> +    history/qt/HistoryItemQt.cpp \
>      page/qt/AccessibilityObjectQt.cpp \
>      page/qt/DragControllerQt.cpp \
>      page/qt/EventHandlerQt.cpp \
> Index: ChangeLog
> ===================================================================
> --- ChangeLog	(revision 38068)
> +++ ChangeLog	(working copy)
> @@ -1,3 +1,17 @@
> [phone]  yael  <[e-mail]>
> +
> +        Reviewed by Brady Eidson.
> +
> +        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.
> +
> +        * WebCore.pro:
> +        * history/HistoryItem.h:
> +        * history/qt/HistoryItemQt.cpp: Added.
> +        (WebCore::HistoryItem::userData):
> +        (WebCore::HistoryItem::setUserData):
> +
>  2008-11-02  Xan Lopez  <[e-mail]>
>  
>          Reviewed by Holger Freyther.
> Index: history/qt/HistoryItemQt.cpp
> ===================================================================
> --- history/qt/HistoryItemQt.cpp	(revision 0)
> +++ history/qt/HistoryItemQt.cpp	(revision 0)
> @@ -0,0 +1,35 @@
> +/*
> +    Copyright (C) 2008 Nokia
> +
> +    This library is free software; you can redistribute it and/or
> +    modify it under the terms of the GNU Library General Public
> +    License as published by the Free Software Foundation; either
> +    version 2 of the License, or (at your option) any later version.
> +
> +    This library is distributed in the hope that it will be useful,
> +    but WITHOUT ANY WARRANTY; without even the implied warranty of
> +    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
> +    Library General Public License for more details.
> +
> +    You should have received a copy of the GNU Library General Public License
> +    along with this library; see the file COPYING.LIB.  If not, write to
> +    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
> +    Boston, MA 02110-1301, USA.
> +*/
> +
> +#include "HistoryItem.h"
> +#include <QVariant>
> +
> +namespace WebCore {
> +
> +QVariant HistoryItem::userData()
> +{
> +    return m_userData;
> +}
> +
> +void HistoryItem::setUserData(QVariant& userData)
> +{
> +    m_userData = userData;
> +}
> +
> +}; // namespace WebCore
> Index: history/HistoryItem.h
> ===================================================================
> --- history/HistoryItem.h	(revision 38068)
> +++ history/HistoryItem.h	(working copy)
> @@ -41,7 +41,9 @@
>  #import <wtf/RetainPtr.h>
>  typedef struct objc_object* id;
>  #endif
> -
> +#if PLATFORM(QT)
> +#include <QVariant>
> +#endif
>  namespace WebCore {
>  
>  class Document;
> @@ -147,6 +149,10 @@
>      id getTransientProperty(const String&) const;
>      void setTransientProperty(const String&, id);
>  #endif
> +#if PLATFORM(QT)
> +    QVariant userData();
> +    void setUserData(QVariant& userData);
> +#endif
>  
>  #ifndef NDEBUG
>      int showTree() const;
> @@ -196,6 +202,9 @@
>      RetainPtr<id> m_viewState;
>      OwnPtr<HashMap<String, RetainPtr<id> > > m_transientProperties;
>  #endif
> +#if PLATFORM(QT)
> +    QVariant m_userData;
> +#endif
>  }; //class HistoryItem
>  
>  } //namespace WebCore

Looks good. I'm doing some minor cleanups before applying, such as making the methods inline.

[Simon Hausmann]

Landed in r38097