TripKit.h

/***************************************************************************
 *   Copyright (C) 2023-2024 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 <QGeoCoordinate>
#include <QJsonArray>
 
#include "fileFormats/ZipFile.h"
#include "geomaps/VAC.h"
 
namespace FileFormats
{

class TripKit : public DataFileAbstract
{
public:
    TripKit(const QString& fileName);
 
    // Destructor
    ~TripKit() = default;
 
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] QString name() const { return m_name; }

    [[nodiscard]] qsizetype numCharts() const { return m_entries.size(); }
 
 
 
    //
    // Methods
    //

    [[nodiscard]] GeoMaps::VAC extract(const QString& directoryPath, qsizetype index);
 
 
    //
    // Static methods
    //

    [[nodiscard]] static QStringList mimeTypes() { return FileFormats::ZipFile::mimeTypes(); }
 
private:
    Q_DISABLE_COPY_MOVE(TripKit)
 
    // Fills the list m_entries, returns an error message or an empty string.
    QString readTripKitData();
 
    // Check if the ZIP file contains image file with coordinates in the file name
    void readVACs();
 
    struct chartEntry
    {
        QString name; // Name of the chart e.g. "EDTF"
        QString ending; // file path ending e.g. "webp" or "tiff". Will be in lower case, might be empty
        QString path; // Path of the chart within the ZIP file
        QGeoCoordinate topLeft;
        QGeoCoordinate topRight;
        QGeoCoordinate bottomLeft;
        QGeoCoordinate bottomRight;
    };
    QList<TripKit::chartEntry> m_entries;
 
    FileFormats::ZipFile m_zip;
    QString m_name;
 
    // Some trip kits contain the content top-level, other trip kits hide the content ina top-level
    // directory. This string is either empty or of the form "topLevelDirName/".
    QString m_prefix;
};
 
} // namespace FileFormats