WaypointLibrary.h

/***************************************************************************
 *   Copyright (C) 2022-2026 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QAbstractListModel>
#include <QQmlEngine>
#include <QStandardPaths>
 
#include "GlobalObject.h"
#include "geomaps/Waypoint.h"
 
namespace GeoMaps
{

 
    class WaypointLibrary : public QAbstractListModel
    {
        Q_OBJECT
        QML_ELEMENT
        QML_SINGLETON
 
    public:
        explicit WaypointLibrary(QObject *parent = nullptr);
 
        // No default constructor, important for QML singleton
        explicit WaypointLibrary() = delete;
 
        // factory function for QML singleton
        static GeoMaps::WaypointLibrary* create(QQmlEngine* /*unused*/, QJSEngine* /*unused*/)
        {
            return GlobalObject::waypointLibrary();
        }
 
        ~WaypointLibrary() override = default;

        enum Role : int {
            WaypointRole = Qt::UserRole + 1,

            NameRole
        };
 
 
        //
        // Properties
        //

        Q_PROPERTY(QList<GeoMaps::Waypoint> waypoints READ waypoints NOTIFY waypointsChanged)
 
        
        Q_PROPERTY(QByteArray GeoJSON READ GeoJSON NOTIFY waypointsChanged)
 
 
        //
        // Getter Methods
        //

        [[nodiscard]] QList<GeoMaps::Waypoint> waypoints() const
        {
            return m_waypoints;
        }

        [[nodiscard]] QByteArray GeoJSON() const;
 
 
        //
        // Model API
        //

        [[nodiscard]] int rowCount(const QModelIndex& parent = QModelIndex()) const override;

        [[nodiscard]] QVariant data(const QModelIndex& index, int role = Qt::DisplayRole) const override;

        [[nodiscard]] QHash<int, QByteArray> roleNames() const override;
 
 
        //
        // Methods
        //

        Q_INVOKABLE void add(const GeoMaps::Waypoint &waypoint);

        Q_INVOKABLE void clear();

        [[nodiscard]] Q_INVOKABLE bool contains(const GeoMaps::Waypoint &waypoint) const
        {
            return m_waypoints.contains(waypoint);
        }

        [[nodiscard]] Q_INVOKABLE bool hasNearbyEntry(const GeoMaps::Waypoint& waypoint) const;

        [[nodiscard]] Q_INVOKABLE QString import(const QString& fileName, bool skip);

        [[nodiscard]] Q_INVOKABLE QString loadFromGeoJSON(QString fileName = {});

        Q_INVOKABLE bool remove(const GeoMaps::Waypoint &waypoint);

        Q_INVOKABLE bool replace(const GeoMaps::Waypoint &oldWaypoint, const GeoMaps::Waypoint &newWaypoint);

        [[nodiscard]] Q_INVOKABLE QString save(QString fileName = {}) const;

        [[nodiscard]] Q_INVOKABLE QByteArray toGpx() const;
 
    signals:
        void waypointsChanged();
 
    private:
        Q_DISABLE_COPY_MOVE(WaypointLibrary)
 
        // Row at which a waypoint with the given name is to be inserted, so
        // that m_waypoints stays sorted by name
        [[nodiscard]] int insertionRow(const QString& name) const;
 
        // Sorts a list of waypoints by name
        static void sortByName(QList<GeoMaps::Waypoint>& waypoints);
 
        // Standard file name for save() and loadFromGeoJGON() methods
        QString stdFileName{QStandardPaths::writableLocation(QStandardPaths::AppDataLocation) + "/waypoint library.geojson"};
 
        // Acutual list of waypoints, sorted by name
        QList<GeoMaps::Waypoint> m_waypoints;
    };
 
} // namespace GeoMaps