Librarian.h

/***************************************************************************
 *   Copyright (C) 2020-2023 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 <QDir>
#include <QQmlEngine>
#include <QRegularExpression>
#include <QSettings>
 
#include "GlobalObject.h"
#include "navigation/Aircraft.h"
#include "units/ByteSize.h"
 

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

    enum Library : quint8 {
        Aircraft,

        Routes
    };
    Q_ENUM(Library)
 
 
    
    [[nodiscard]] Q_INVOKABLE static bool contains(const Navigation::Aircraft& acft);

    [[nodiscard]] Q_INVOKABLE static bool contains(const QObject* route);

    [[nodiscard]] Q_INVOKABLE static QString directory(Librarian::Library library) ;

    Q_INVOKABLE QStringList entries(Librarian::Library library, const QString& filter=QString());

    [[nodiscard]] Q_INVOKABLE static bool exists(Librarian::Library library, const QString& baseName) ;

    [[nodiscard]] Q_INVOKABLE static QString fullPath(Librarian::Library library, const QString& baseName) ;

    [[nodiscard]] Q_INVOKABLE static QObject* get(Librarian::Library library, const QString& baseName) ;

    Q_INVOKABLE static QString getStringFromRessource(const QString& name);

    Q_INVOKABLE static Units::ByteSize getStringHashFromRessource(const QString& name);

    [[nodiscard]] Q_INVOKABLE static QString import(Librarian::Library library, const QString& fileName) ;

    Q_INVOKABLE static void remove(Librarian::Library library, const QString& baseName) ;

    Q_INVOKABLE static void rename(Librarian::Library library, const QString& oldName, const QString& newName);

    QStringList permissiveFilter(const QStringList &input, const QString &filter);

    QString simplifySpecialChars(const QString& string);
 
private:
    Q_DISABLE_COPY_MOVE(Librarian)
 
    // Caches used to speed up the method simplifySpecialChars
    QRegularExpression specialChars {QStringLiteral("[^a-zA-Z0-9]")};
    QHash<QString, QString> simplifySpecialChars_cache;
 
};