Move locationhelper, linemodel and mediasizehelper to Timeline

src/timeline/CMakeLists.txt

@@ -56,11 +56,14 @@ ecm_add_qml_module(Timeline GENERATE_PLUGIN_SOURCE
         VideoComponent.qml
     SOURCES
         contentprovider.cpp
+        locationhelper.cpp
+        mediasizehelper.cpp
         messageattached.cpp
         pollhandler.cpp
         timelinedelegate.cpp
         enums/delegatetype.h
         models/itinerarymodel.cpp
+        models/linemodel.cpp
         models/mediamessagefiltermodel.cpp
         models/messagecontentmodel.cpp
         models/messagecontentfiltermodel.cpp

src/timeline/locationhelper.cpp

@@ -0,0 +1,46 @@
+// SPDX-FileCopyrightText: 2023 Volker Krause <vkrause@kde.org>
+// SPDX-License-Identifier: LGPL-2.0-or-later
+
+#include "locationhelper.h"
+
+#include <cmath>
+
+QRectF LocationHelper::unite(const QRectF &r1, const QRectF &r2)
+{
+    // this looks weird but is actually intentional as we need to handle point-like "rects" as well
+    if ((!r1.isEmpty() || r1.isNull()) && (!r2.isEmpty() || r2.isNull())) {
+        return r1 | r2;
+    }
+    return (!r1.isEmpty() || r1.isNull()) ? r1 : r2;
+}
+
+QPointF LocationHelper::center(const QRectF &r)
+{
+    return r.center();
+}
+
+constexpr inline double degToRad(double deg)
+{
+    return deg / 180.0 * M_PI;
+}
+
+static QPointF mercatorProject(double lat, double lon, double zoom)
+{
+    const auto x = (256.0 / (2.0 * M_PI)) * std::pow(2.0, zoom) * (degToRad(lon) + M_PI);
+    const auto y = (256.0 / (2.0 * M_PI)) * std::pow(2.0, zoom) * (M_PI - std::log(std::tan(M_PI / 4.0 + degToRad(lat) / 2.0)));
+    return QPointF(x, y);
+}
+
+float LocationHelper::zoomToFit(const QRectF &r, float mapWidth, float mapHeight)
+{
+    const auto p1 = mercatorProject(r.bottomLeft().y(), r.bottomLeft().x(), 1.0);
+    const auto p2 = mercatorProject(r.topRight().y(), r.topRight().x(), 1.0);
+
+    const auto zx = std::log2((mapWidth / (p2.x() - p1.x())));
+    const auto zy = std::log2((mapHeight / (p2.y() - p1.y())));
+    const auto z = std::min(zx, zy);
+
+    return z;
+}
+
+#include "moc_locationhelper.cpp"

src/timeline/locationhelper.h

@@ -0,0 +1,27 @@
+// SPDX-FileCopyrightText: 2023 Volker Krause <vkrause@kde.org>
+// SPDX-License-Identifier: LGPL-2.0-or-later
+#pragma once
+
+#include <QMetaType>
+#include <QObject>
+#include <QQmlEngine>
+#include <QRectF>
+
+/** Location related helper functions for QML. */
+class LocationHelper : public QObject
+{
+    Q_OBJECT
+    QML_ELEMENT
+    QML_SINGLETON
+
+public:
+    /** Unite two rectanlges. */
+    Q_INVOKABLE static QRectF unite(const QRectF &r1, const QRectF &r2);
+    /** Returns the center of @p r. */
+    Q_INVOKABLE static QPointF center(const QRectF &r);
+
+    /** Returns the highest zoom level to fit @r into a map of size @p mapWidth x @p mapHeight. */
+    Q_INVOKABLE static float zoomToFit(const QRectF &r, float mapWidth, float mapHeight);
+};
+
+Q_DECLARE_METATYPE(LocationHelper)

src/timeline/mediasizehelper.cpp

@@ -0,0 +1,170 @@
+// SPDX-FileCopyrightText: 2023 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
+
+#include "mediasizehelper.h"
+
+int MediaSizeHelper::m_mediaMaxWidth = 0;
+int MediaSizeHelper::m_mediaMaxHeight = 0;
+
+MediaSizeHelper::MediaSizeHelper(QObject *parent)
+    : QObject(parent)
+{
+}
+
+qreal MediaSizeHelper::contentMaxWidth() const
+{
+    return m_contentMaxWidth;
+}
+
+void MediaSizeHelper::setContentMaxWidth(qreal contentMaxWidth)
+{
+    if (contentMaxWidth < 0.0 || qFuzzyCompare(contentMaxWidth, 0.0)) {
+        m_contentMaxWidth = -1.0;
+        Q_EMIT contentMaxWidthChanged();
+        Q_EMIT currentSizeChanged();
+        return;
+    }
+    if (qFuzzyCompare(contentMaxWidth, m_contentMaxWidth)) {
+        return;
+    }
+    m_contentMaxWidth = contentMaxWidth;
+    Q_EMIT contentMaxWidthChanged();
+    Q_EMIT currentSizeChanged();
+}
+
+qreal MediaSizeHelper::contentMaxHeight() const
+{
+    return m_contentMaxHeight;
+}
+
+void MediaSizeHelper::setContentMaxHeight(qreal contentMaxHeight)
+{
+    if (contentMaxHeight < 0.0 || qFuzzyCompare(contentMaxHeight, 0.0)) {
+        m_contentMaxHeight = -1.0;
+        Q_EMIT contentMaxHeightChanged();
+        Q_EMIT currentSizeChanged();
+        return;
+    }
+    if (qFuzzyCompare(contentMaxHeight, m_contentMaxHeight)) {
+        return;
+    }
+    m_contentMaxHeight = contentMaxHeight;
+    Q_EMIT contentMaxHeightChanged();
+    Q_EMIT currentSizeChanged();
+}
+
+qreal MediaSizeHelper::mediaWidth() const
+{
+    return m_mediaWidth;
+}
+
+void MediaSizeHelper::setMediaWidth(qreal mediaWidth)
+{
+    if (mediaWidth < 0.0 || qFuzzyCompare(mediaWidth, 0.0)) {
+        m_mediaWidth = -1.0;
+        Q_EMIT mediaWidthChanged();
+        Q_EMIT currentSizeChanged();
+        return;
+    }
+    if (qFuzzyCompare(mediaWidth, m_mediaWidth)) {
+        return;
+    }
+    m_mediaWidth = mediaWidth;
+    Q_EMIT mediaWidthChanged();
+    Q_EMIT currentSizeChanged();
+}
+
+qreal MediaSizeHelper::mediaHeight() const
+{
+    return m_mediaHeight;
+}
+
+void MediaSizeHelper::setMediaHeight(qreal mediaHeight)
+{
+    if (mediaHeight < 0.0 || qFuzzyCompare(mediaHeight, 0.0)) {
+        m_mediaHeight = -1.0;
+        Q_EMIT mediaHeightChanged();
+        Q_EMIT currentSizeChanged();
+        return;
+    }
+    if (qFuzzyCompare(mediaHeight, m_mediaHeight)) {
+        return;
+    }
+    m_mediaHeight = mediaHeight;
+    Q_EMIT mediaHeightChanged();
+    Q_EMIT currentSizeChanged();
+}
+
+qreal MediaSizeHelper::resolvedMediaWidth() const
+{
+    if (m_mediaWidth > 0.0) {
+        return m_mediaWidth;
+    }
+    return widthLimit();
+}
+
+qreal MediaSizeHelper::resolvedMediaHeight() const
+{
+    if (m_mediaHeight > 0.0) {
+        return m_mediaHeight;
+    }
+    return widthLimit() / 16.0 * 9.0;
+}
+
+qreal MediaSizeHelper::aspectRatio() const
+{
+    return resolvedMediaWidth() / resolvedMediaHeight();
+}
+
+bool MediaSizeHelper::limitWidth() const
+{
+    // If actual data isn't available we'll be using a placeholder that is width
+    // limited so return true.
+    if (m_mediaWidth < 0.0 || m_mediaHeight < 0.0) {
+        return true;
+    }
+    return m_mediaWidth >= m_mediaHeight;
+}
+
+qreal MediaSizeHelper::widthLimit() const
+{
+    if (m_contentMaxWidth < 0.0) {
+        return m_mediaMaxWidth;
+    }
+    return std::min(m_contentMaxWidth, qreal(m_mediaMaxWidth));
+}
+
+qreal MediaSizeHelper::heightLimit() const
+{
+    if (m_contentMaxHeight < 0.0) {
+        return m_mediaMaxHeight;
+    }
+    return std::min(m_contentMaxHeight, qreal(m_mediaMaxHeight));
+}
+
+QSize MediaSizeHelper::currentSize() const
+{
+    if (limitWidth()) {
+        qreal width = std::min(widthLimit(), resolvedMediaWidth());
+        qreal height = width / aspectRatio();
+        if (height > heightLimit()) {
+            return QSize(qRound(heightLimit() * aspectRatio()), qRound(heightLimit()));
+        }
+        return QSize(qRound(width), qRound(height));
+    } else {
+        qreal height = std::min(heightLimit(), resolvedMediaHeight());
+        qreal width = height * aspectRatio();
+        if (width > widthLimit()) {
+            return QSize(qRound(widthLimit()), qRound(widthLimit() / aspectRatio()));
+        }
+        return QSize(qRound(width), qRound(height));
+    }
+}
+
+void MediaSizeHelper::setMaxSize(int width, int height)
+{
+    MediaSizeHelper::m_mediaMaxWidth = width;
+    MediaSizeHelper::m_mediaMaxHeight = height;
+}
+
+#include "moc_mediasizehelper.cpp"

src/timeline/mediasizehelper.h

@@ -0,0 +1,110 @@
+// SPDX-FileCopyrightText: 2023 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
+
+#pragma once
+
+#include <QObject>
+#include <QQmlEngine>
+#include <QSize>
+
+/**
+ * @class MediaSizeHelper
+ *
+ * A class to help calculate the current width of a media item within a chat delegate.
+ *
+ * The only realistic way to guarantee that a media item (e.g. an image or video)
+ * is the correct size in QML is to calculate the size manually.
+ *
+ * The rules for this component work as follows:
+ *  - The output will always try to keep the media size if no limits are breached.
+ *  - If no media width is set, the current size will be a placeholder at a 16:9 ratio
+ *    calcualated from either the configured max width or the contentMaxWidth, whichever
+ *    is smaller (if the contentMaxWidth isn't set, the configured max width is used).
+ *  - The aspect ratio of the media will always be maintained if set (otherwise 16:9).
+ *  - The current size will never be larger than any of the limits in either direction.
+ *  - If any limit is breached the image size will be reduced while maintaining aspect
+ *    ration, i.e. no stretching or squashing. This can mean that the width or height
+ *    is reduced even if that parameter doesn't breach the limit itself.
+ */
+class MediaSizeHelper : public QObject
+{
+    Q_OBJECT
+    QML_ELEMENT
+
+    /**
+     * @brief The maximum width (in px) the media can be.
+     *
+     * This is the upper limit placed upon the media by the delegate.
+     */
+    Q_PROPERTY(qreal contentMaxWidth READ contentMaxWidth WRITE setContentMaxWidth NOTIFY contentMaxWidthChanged)
+
+    /**
+     * @brief The maximum height (in px) the media can be.
+     *
+     * This is the upper limit placed upon the media by the delegate.
+     */
+    Q_PROPERTY(qreal contentMaxHeight READ contentMaxHeight WRITE setContentMaxHeight NOTIFY contentMaxHeightChanged)
+
+    /**
+     * @brief The base width (in px) of the media.
+     */
+    Q_PROPERTY(qreal mediaWidth READ mediaWidth WRITE setMediaWidth NOTIFY mediaWidthChanged)
+
+    /**
+     * @brief The base height (in px) of the media.
+     */
+    Q_PROPERTY(qreal mediaHeight READ mediaHeight WRITE setMediaHeight NOTIFY mediaHeightChanged)
+
+    /**
+     * @brief The size (in px) of the component based on the current input.
+     *
+     * Will always try to return a value even if some of the inputs are not set to
+     * account for being called before the parameters are intialised. For any parameters
+     * not set these will just be left out of the calcs.
+     *
+     * If no input values are provided a default placeholder value will be returned.
+     */
+    Q_PROPERTY(QSize currentSize READ currentSize NOTIFY currentSizeChanged)
+
+public:
+    explicit MediaSizeHelper(QObject *parent = nullptr);
+
+    qreal contentMaxWidth() const;
+    void setContentMaxWidth(qreal contentMaxWidth);
+
+    qreal contentMaxHeight() const;
+    void setContentMaxHeight(qreal contentMaxHeight);
+
+    qreal mediaWidth() const;
+    void setMediaWidth(qreal mediaWidth);
+
+    qreal mediaHeight() const;
+    void setMediaHeight(qreal mediaHeight);
+
+    QSize currentSize() const;
+
+    static void setMaxSize(int width, int height);
+
+Q_SIGNALS:
+    void contentMaxWidthChanged();
+    void contentMaxHeightChanged();
+    void mediaWidthChanged();
+    void mediaHeightChanged();
+    void currentSizeChanged();
+
+private:
+    qreal m_contentMaxWidth = -1.0;
+    qreal m_contentMaxHeight = -1.0;
+    qreal m_mediaWidth = -1.0;
+    qreal m_mediaHeight = -1.0;
+
+    qreal resolvedMediaWidth() const;
+    qreal resolvedMediaHeight() const;
+    qreal aspectRatio() const;
+    bool limitWidth() const;
+    qreal widthLimit() const;
+    qreal heightLimit() const;
+
+    static int m_mediaMaxWidth;
+    static int m_mediaMaxHeight;
+};

src/timeline/models/linemodel.cpp

@@ -0,0 +1,66 @@
+// SPDX-FileCopyrightText: 2024 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
+
+#include "linemodel.h"
+
+LineModel::LineModel(QObject *parent)
+    : QAbstractListModel(parent)
+{
+}
+
+QQuickTextDocument *LineModel::document() const
+{
+    return m_document;
+}
+
+void LineModel::setDocument(QQuickTextDocument *document)
+{
+    if (document == m_document) {
+        return;
+    }
+
+    m_document = document;
+    Q_EMIT documentChanged();
+
+    resetModel();
+}
+
+QVariant LineModel::data(const QModelIndex &index, int role) const
+{
+    if (!index.isValid()) {
+        return {};
+    }
+
+    const auto &row = index.row();
+    if (row < 0 || row > rowCount()) {
+        return {};
+    }
+
+    if (role == LineHeightRole) {
+        auto textDoc = m_document->textDocument();
+        return int(textDoc->documentLayout()->blockBoundingRect(textDoc->findBlockByNumber(row)).height());
+    }
+    return {};
+}
+
+int LineModel::rowCount(const QModelIndex &parent) const
+{
+    Q_UNUSED(parent);
+    if (m_document == nullptr) {
+        return 0;
+    }
+    return m_document->textDocument()->blockCount();
+}
+
+QHash<int, QByteArray> LineModel::roleNames() const
+{
+    return {{LineHeightRole, "docLineHeight"}};
+}
+
+void LineModel::resetModel()
+{
+    beginResetModel();
+    endResetModel();
+}
+
+#include "moc_linemodel.cpp"

src/timeline/models/linemodel.h

@@ -0,0 +1,80 @@
+// SPDX-FileCopyrightText: 2024 James Graham <james.h.graham@protonmail.com>
+// SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only OR LicenseRef-KDE-Accepted-GPL
+
+#pragma once
+
+#include <QAbstractListModel>
+#include <QAbstractTextDocumentLayout>
+#include <QQmlEngine>
+#include <QQuickTextDocument>
+#include <QTextBlock>
+#include <qtmetamacros.h>
+
+/**
+ * @class LineModel
+ *
+ * A model to provide line info for a QQuickTextDocument.
+ *
+ * @sa QQuickTextDocument
+ */
+class LineModel : public QAbstractListModel
+{
+    Q_OBJECT
+    QML_ELEMENT
+
+    /**
+     * @brief The QQuickTextDocument that is being handled.
+     */
+    Q_PROPERTY(QQuickTextDocument *document READ document WRITE setDocument NOTIFY documentChanged)
+
+public:
+    /**
+     * @brief Defines the model roles.
+     */
+    enum Roles {
+        LineHeightRole = Qt::UserRole + 1, /**< The delegate type of the message. */
+    };
+    Q_ENUM(Roles)
+
+    explicit LineModel(QObject *parent = nullptr);
+
+    [[nodiscard]] QQuickTextDocument *document() const;
+    void setDocument(QQuickTextDocument *document);
+
+    /**
+     * @brief Get the given role value at the given index.
+     *
+     * @sa QAbstractItemModel::data
+     */
+    [[nodiscard]] QVariant data(const QModelIndex &index, int role) const override;
+
+    /**
+     * @brief Number of rows in the model.
+     *
+     * @sa QAbstractItemModel::rowCount
+     */
+    [[nodiscard]] int rowCount(const QModelIndex &parent = QModelIndex()) const override;
+
+    /**
+     * @brief Returns a mapping from Role enum values to role names.
+     *
+     * @sa Roles, QAbstractItemModel::roleNames()
+     */
+    [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
+
+    /**
+     * @brief Reset the model.
+     *
+     * This needs to be called when the QQuickTextDocument container changes width
+     * or height as this may change line heights due to wrapping.
+     *
+     * @sa QQuickTextDocument
+     */
+    Q_INVOKABLE void resetModel();
+
+Q_SIGNALS:
+    void documentChanged();
+
+private:
+    QPointer<QQuickTextDocument> m_document = nullptr;
+};