FileExchange_Abstract.h

/***************************************************************************
 *   Copyright (C) 2019-2025 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 <QQmlEngine>
 
#include "geomaps/Waypoint.h"
#include "geomaps/VAC.h"
#include "GlobalObject.h"
 
namespace Platform {

 
class FileExchange_Abstract : public GlobalObject
{
    Q_OBJECT
 
public:
    enum FileFunction : quint8
      {
        UnknownFunction, /*< Unknown file */
        FlightRouteOrWaypointLibrary, /*< File contains a flight route or a waypoint library. */
        FlightRoute, /*< File contains a flight route. */
        VectorMap, /*< File contains a vector map. */
        RasterMap, /*< File contains a raster map. */
        WaypointLibrary, /*< Waypoint library in CUP or GeoJSON format */
        OpenAir, /*< Airspace data in openAir format */
        Image, /*< Image without georeferencing information */
        TripKit, /*< Trip Kit */
        ZipFile, /*< Zip File */
        Cub, /*< Airspace data in CUB format */
        FlightLogJSON /*< Flight log in Enroute's JSON export format */
      };
    Q_ENUM(FileFunction)
 
 
    
    explicit FileExchange_Abstract(QObject* parent = nullptr);
 
    ~FileExchange_Abstract() override = default;
 
 
 
    //
    // Methods
    //

    Q_INVOKABLE virtual void importContent() = 0;

    Q_INVOKABLE virtual void openFilePicker(const QString& mimeType) { Q_UNUSED(mimeType) }

    Q_INVOKABLE virtual QString shareContent(const QByteArray& content, const QString& mimeType, const QString& fileNameSuffix, const QString& fileNameTemplate) = 0;

    Q_INVOKABLE virtual void saveContent(const QByteArray& content, const QString& mimeType, const QString& fileNameSuffix, const QString& fileNameTemplate);

    Q_INVOKABLE virtual QString viewContent(const QByteArray& content, const QString& mimeType, const QString& fileNameSuffix, const QString& fileNameTemplate) = 0;
 
public slots:
    virtual void onGUISetupCompleted() = 0;

    virtual void processFileOpenRequest(const QString& path, const QString& unmingledFilename);

    void processFileOpenRequest(const QByteArray& path);

    void processFileOpenRequest(const QString& path);

    void processText(const QString& text);
 
signals:
    void openFileRequest(QString fileName, QString info, Platform::FileExchange_Abstract::FileFunction fileFunction);

    void openVACRequest(GeoMaps::VAC vac);

    void openWaypointRequest(GeoMaps::Waypoint waypoint);

    void resolveURL(QString url, QString site);

    void unableToProcessText(QString text);

    void importError(QString text);

    void saveContentResult(QString result);
 
private:
    Q_DISABLE_COPY_MOVE(FileExchange_Abstract)
};
 
} // namespace Platform
 
// Declare meta types
Q_DECLARE_METATYPE(Platform::FileExchange_Abstract)