Move QWebEngineHistory to core

Keep debug stream operators in page for now,
since QWebEngineHsitory is accessible from page only.

[ChangeLog] QWebEngineHistory is in QtWebEngineCore

Task-number: QTBUG-74585
Change-Id: I5dfc13a0d59ac87f18fe4905ebcfd4a9ec5ad3a1
Reviewed-by: Allan Sandfeld Jensen <allan.jensen@qt.io>

4 files changed, 476 insertions, 2 deletions

diff --git a/src/core/api/core_api.pro b/src/core/api/core_api.pro
index ac7313a1a..95095a2f7 100644
--- a/src/core/api/core_api.pro
+++ b/src/core/api/core_api.pro
@@ -62,7 +62,10 @@ HEADERS = \
     qwebenginescriptcollection_p.h \
     qwebengineprofile.h \
     qwebengineprofile_p.h \
-    qwebengineclientcertificateselection.h
+    qwebengineclientcertificateselection.h \
+    qwebenginehistory.h \
+    qwebenginehistory_p.h
+
 
 SOURCES = \
     qtwebenginecoreglobal.cpp \
@@ -86,7 +89,8 @@ SOURCES = \
     qwebenginescript.cpp \
     qwebenginescriptcollection.cpp \
     qwebengineprofile.cpp \
-    qwebengineclientcertificateselection.cpp
+    qwebengineclientcertificateselection.cpp \
+    qwebenginehistory.cpp
 
 # Chromium headers included are not remotely clean
 CONFIG -= warning_clean
diff --git a/src/core/api/qwebenginehistory.cpp b/src/core/api/qwebenginehistory.cpp
new file mode 100644
index 000000000..2f32444b2
--- /dev/null
+++ b/src/core/api/qwebenginehistory.cpp
@@ -0,0 +1,258 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#include "qwebenginehistory.h"
+#include "qwebenginehistory_p.h"
+
+#include "web_contents_adapter.h"
+
+QT_BEGIN_NAMESPACE
+
+/*!
+    \fn QWebEngineHistoryItem::swap(QWebEngineHistoryItem &other)
+    Swaps the history item with the \a other item.
+*/
+
+QWebEngineHistoryItemPrivate::QWebEngineHistoryItemPrivate(
+        QtWebEngineCore::WebContentsAdapterClient *adapter, int index)
+    : m_adapter(adapter), index(index)
+{
+}
+
+QWebEngineHistoryItem::QWebEngineHistoryItem(QWebEngineHistoryItemPrivate *d) : d(d) { }
+
+QWebEngineHistoryItem::QWebEngineHistoryItem(const QWebEngineHistoryItem &other) : d(other.d) { }
+
+QWebEngineHistoryItem &QWebEngineHistoryItem::operator=(const QWebEngineHistoryItem &other)
+{
+    d = other.d;
+    return *this;
+}
+
+QWebEngineHistoryItem::~QWebEngineHistoryItem() { }
+
+QUrl QWebEngineHistoryItem::originalUrl() const
+{
+    Q_D(const QWebEngineHistoryItem);
+    return d->m_adapter
+            ? d->m_adapter->webContentsAdapter()->getNavigationEntryOriginalUrl(d->index)
+            : QUrl();
+}
+
+QUrl QWebEngineHistoryItem::url() const
+{
+    Q_D(const QWebEngineHistoryItem);
+    return d->m_adapter ? d->m_adapter->webContentsAdapter()->getNavigationEntryUrl(d->index)
+                        : QUrl();
+}
+
+QString QWebEngineHistoryItem::title() const
+{
+    Q_D(const QWebEngineHistoryItem);
+    return d->m_adapter ? d->m_adapter->webContentsAdapter()->getNavigationEntryTitle(d->index)
+                        : QString();
+}
+
+QDateTime QWebEngineHistoryItem::lastVisited() const
+{
+    Q_D(const QWebEngineHistoryItem);
+    return d->m_adapter ? d->m_adapter->webContentsAdapter()->getNavigationEntryTimestamp(d->index)
+                        : QDateTime();
+}
+
+/*!
+    Returns the URL of the icon associated with the history item.
+
+    \sa url(), originalUrl(), title()
+*/
+QUrl QWebEngineHistoryItem::iconUrl() const
+{
+    Q_D(const QWebEngineHistoryItem);
+    return d->m_adapter ? d->m_adapter->webContentsAdapter()->getNavigationEntryIconUrl(d->index)
+                        : QUrl();
+}
+
+bool QWebEngineHistoryItem::isValid() const
+{
+    Q_D(const QWebEngineHistoryItem);
+    if (!d->m_adapter)
+        return false;
+    return d->index >= 0 && d->index < d->m_adapter->webContentsAdapter()->navigationEntryCount();
+}
+
+QWebEngineHistoryPrivate::QWebEngineHistoryPrivate(
+        QtWebEngineCore::WebContentsAdapterClient *adapter)
+    : m_adapter(adapter)
+{
+}
+
+QWebEngineHistoryPrivate::~QWebEngineHistoryPrivate()
+{
+    // Invalidate shared item references possibly still out there.
+    QList<QWebEngineHistoryItem>::iterator it, end;
+    for (it = items.begin(), end = items.end(); it != end; ++it)
+        it->d->m_adapter = 0;
+}
+
+void QWebEngineHistoryPrivate::updateItems() const
+{
+    // Keep track of items we return to be able to invalidate them
+    // and avoid dangling references to our m_adapter.
+    int entryCount = m_adapter->webContentsAdapter()->navigationEntryCount();
+    while (items.size() > entryCount) {
+        items.last().d->m_adapter = 0;
+        items.removeLast();
+    }
+    while (items.size() < entryCount) {
+        int nextIndex = items.size();
+        items.append(QWebEngineHistoryItem(new QWebEngineHistoryItemPrivate(m_adapter, nextIndex)));
+    }
+}
+
+QWebEngineHistory::QWebEngineHistory(QWebEngineHistoryPrivate *d) : d_ptr(d) { }
+
+QWebEngineHistory::~QWebEngineHistory() { }
+
+void QWebEngineHistory::clear()
+{
+    Q_D(const QWebEngineHistory);
+    d->m_adapter->webContentsAdapter()->clearNavigationHistory();
+    d->m_adapter->updateNavigationActions();
+}
+
+QList<QWebEngineHistoryItem> QWebEngineHistory::items() const
+{
+    Q_D(const QWebEngineHistory);
+    d->updateItems();
+    return d->items;
+}
+
+QList<QWebEngineHistoryItem> QWebEngineHistory::backItems(int maxItems) const
+{
+    Q_D(const QWebEngineHistory);
+    d->updateItems();
+    const int end = currentItemIndex();
+    const int start = std::max(0, end - maxItems);
+    return d->items.mid(start, end - start);
+}
+
+QList<QWebEngineHistoryItem> QWebEngineHistory::forwardItems(int maxItems) const
+{
+    Q_D(const QWebEngineHistory);
+    d->updateItems();
+    const int start = currentItemIndex() + 1;
+    const int end = std::min(count(), start + maxItems);
+    return d->items.mid(start, end - start);
+}
+
+bool QWebEngineHistory::canGoBack() const
+{
+    Q_D(const QWebEngineHistory);
+    return d->m_adapter->webContentsAdapter()->canGoToOffset(-1);
+}
+
+bool QWebEngineHistory::canGoForward() const
+{
+    Q_D(const QWebEngineHistory);
+    return d->m_adapter->webContentsAdapter()->canGoToOffset(1);
+}
+
+void QWebEngineHistory::back()
+{
+    Q_D(const QWebEngineHistory);
+    d->m_adapter->webContentsAdapter()->navigateToOffset(-1);
+}
+
+void QWebEngineHistory::forward()
+{
+    Q_D(const QWebEngineHistory);
+    d->m_adapter->webContentsAdapter()->navigateToOffset(1);
+}
+
+void QWebEngineHistory::goToItem(const QWebEngineHistoryItem &item)
+{
+    Q_D(const QWebEngineHistory);
+    Q_ASSERT(item.d->m_adapter == d->m_adapter);
+    d->m_adapter->webContentsAdapter()->navigateToIndex(item.d->index);
+}
+
+QWebEngineHistoryItem QWebEngineHistory::backItem() const
+{
+    return itemAt(currentItemIndex() - 1);
+}
+
+QWebEngineHistoryItem QWebEngineHistory::currentItem() const
+{
+    return itemAt(currentItemIndex());
+}
+
+QWebEngineHistoryItem QWebEngineHistory::forwardItem() const
+{
+    return itemAt(currentItemIndex() + 1);
+}
+
+QWebEngineHistoryItem QWebEngineHistory::itemAt(int i) const
+{
+    Q_D(const QWebEngineHistory);
+    if (i >= 0 && i < count()) {
+        d->updateItems();
+        return d->items[i];
+    } else {
+        // Return an invalid item right away.
+        QWebEngineHistoryItem item(new QWebEngineHistoryItemPrivate(0, i));
+        Q_ASSERT(!item.isValid());
+        return item;
+    }
+}
+
+int QWebEngineHistory::currentItemIndex() const
+{
+    Q_D(const QWebEngineHistory);
+    return d->m_adapter->webContentsAdapter()->currentNavigationEntryIndex();
+}
+
+int QWebEngineHistory::count() const
+{
+    Q_D(const QWebEngineHistory);
+    if (!d->m_adapter->webContentsAdapter()->isInitialized())
+        return 0;
+    return d->m_adapter->webContentsAdapter()->navigationEntryCount();
+}
+
+QT_END_NAMESPACE
diff --git a/src/core/api/qwebenginehistory.h b/src/core/api/qwebenginehistory.h
new file mode 100644
index 000000000..f7e591e38
--- /dev/null
+++ b/src/core/api/qwebenginehistory.h
@@ -0,0 +1,127 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWEBENGINEHISTORY_H
+#define QWEBENGINEHISTORY_H
+
+#include <QtWebEngineCore/qtwebenginecoreglobal.h>
+#include <QtCore/qurl.h>
+#include <QtCore/qstring.h>
+#include <QtCore/qdatetime.h>
+#include <QtCore/qshareddata.h>
+#include <QtGui/qicon.h>
+
+QT_BEGIN_NAMESPACE
+
+class QWebEngineHistory;
+class QWebEngineHistoryItemPrivate;
+class QWebEnginePage;
+class QWebEnginePagePrivate;
+
+class Q_WEBENGINECORE_EXPORT QWebEngineHistoryItem
+{
+public:
+    QWebEngineHistoryItem(const QWebEngineHistoryItem &other);
+    QWebEngineHistoryItem &operator=(const QWebEngineHistoryItem &other);
+    ~QWebEngineHistoryItem();
+
+    QUrl originalUrl() const;
+    QUrl url() const;
+
+    QString title() const;
+    QDateTime lastVisited() const;
+    QUrl iconUrl() const;
+
+    bool isValid() const;
+
+    void swap(QWebEngineHistoryItem &other) Q_DECL_NOTHROW { qSwap(d, other.d); }
+
+private:
+    QWebEngineHistoryItem(QWebEngineHistoryItemPrivate *priv);
+    Q_DECLARE_PRIVATE_D(d.data(), QWebEngineHistoryItem)
+    QExplicitlySharedDataPointer<QWebEngineHistoryItemPrivate> d;
+    friend class QWebEngineHistory;
+    friend class QWebEngineHistoryPrivate;
+};
+
+Q_DECLARE_SHARED_NOT_MOVABLE_UNTIL_QT6(QWebEngineHistoryItem)
+
+class QWebEngineHistoryPrivate;
+class Q_WEBENGINECORE_EXPORT QWebEngineHistory
+{
+public:
+    void clear();
+
+    QList<QWebEngineHistoryItem> items() const;
+    QList<QWebEngineHistoryItem> backItems(int maxItems) const;
+    QList<QWebEngineHistoryItem> forwardItems(int maxItems) const;
+
+    bool canGoBack() const;
+    bool canGoForward() const;
+
+    void back();
+    void forward();
+    void goToItem(const QWebEngineHistoryItem &item);
+
+    QWebEngineHistoryItem backItem() const;
+    QWebEngineHistoryItem currentItem() const;
+    QWebEngineHistoryItem forwardItem() const;
+    QWebEngineHistoryItem itemAt(int i) const;
+
+    int currentItemIndex() const;
+
+    int count() const;
+
+private:
+    QWebEngineHistory(QWebEngineHistoryPrivate *d);
+    ~QWebEngineHistory();
+
+    Q_DISABLE_COPY(QWebEngineHistory)
+    Q_DECLARE_PRIVATE(QWebEngineHistory)
+    QScopedPointer<QWebEngineHistoryPrivate> d_ptr;
+
+    friend Q_WEBENGINECORE_EXPORT QDataStream &operator>>(QDataStream &, QWebEngineHistory &);
+    friend Q_WEBENGINECORE_EXPORT QDataStream &operator<<(QDataStream &, const QWebEngineHistory &);
+    friend class QWebEnginePage;
+    friend class QWebEnginePagePrivate;
+};
+
+QT_END_NAMESPACE
+
+#endif // QWEBENGINEHISTORY_H
diff --git a/src/core/api/qwebenginehistory_p.h b/src/core/api/qwebenginehistory_p.h
new file mode 100644
index 000000000..2ca944e5b
--- /dev/null
+++ b/src/core/api/qwebenginehistory_p.h
@@ -0,0 +1,85 @@
+/****************************************************************************
+**
+** Copyright (C) 2016 The Qt Company Ltd.
+** Contact: https://www.qt.io/licensing/
+**
+** This file is part of the QtWebEngine module of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** Commercial License Usage
+** Licensees holding valid commercial Qt licenses may use this file in
+** accordance with the commercial license agreement provided with the
+** Software or, alternatively, in accordance with the terms contained in
+** a written agreement between you and The Qt Company. For licensing terms
+** and conditions see https://www.qt.io/terms-conditions. For further
+** information use the contact form at https://www.qt.io/contact-us.
+**
+** GNU Lesser General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU Lesser
+** General Public License version 3 as published by the Free Software
+** Foundation and appearing in the file LICENSE.LGPL3 included in the
+** packaging of this file. Please review the following information to
+** ensure the GNU Lesser General Public License version 3 requirements
+** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU
+** General Public License version 2.0 or (at your option) the GNU General
+** Public license version 3 or any later version approved by the KDE Free
+** Qt Foundation. The licenses are as published by the Free Software
+** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
+** included in the packaging of this file. Please review the following
+** information to ensure the GNU General Public License requirements will
+** be met: https://www.gnu.org/licenses/gpl-2.0.html and
+** https://www.gnu.org/licenses/gpl-3.0.html.
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+#ifndef QWEBENGINEHISTORY_P_H
+#define QWEBENGINEHISTORY_P_H
+
+//
+//  W A R N I N G
+//  -------------
+//
+// This file is not part of the Qt API.  It exists purely as an
+// implementation detail.  This header file may change from version to
+// version without notice, or even be removed.
+//
+// We mean it.
+//
+#include "qtwebenginecoreglobal_p.h"
+#include <QtCore/qshareddata.h>
+
+namespace QtWebEngineCore {
+class WebContentsAdapterClient;
+}
+
+QT_BEGIN_NAMESPACE
+class QWebEnginePagePrivate;
+
+class QWebEngineHistoryItemPrivate : public QSharedData
+{
+public:
+    QWebEngineHistoryItemPrivate(QtWebEngineCore::WebContentsAdapterClient *adapter = nullptr,
+                                 int index = 0);
+    QtWebEngineCore::WebContentsAdapterClient *m_adapter;
+    int index;
+};
+
+class Q_WEBENGINECORE_PRIVATE_EXPORT QWebEngineHistoryPrivate
+{
+public:
+    QWebEngineHistoryPrivate(QtWebEngineCore::WebContentsAdapterClient *adapter);
+    ~QWebEngineHistoryPrivate();
+    void updateItems() const;
+
+    QtWebEngineCore::WebContentsAdapterClient *m_adapter;
+    mutable QList<QWebEngineHistoryItem> items;
+};
+
+QT_END_NAMESPACE
+
+#endif // QWEBENGINEHISTORY_P_H