FileLibraryModel.h

/***************************************************************************
 *   Copyright (C) 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 <QFileSystemWatcher>
#include <QQmlEngine>
#include <QTimer>
 

 
class FileLibraryModel : public QAbstractListModel
{
    Q_OBJECT
    QML_ELEMENT
    QML_UNCREATABLE("Use Librarian.aircraftModel or Librarian.routesModel")
 
public:
    enum Role : int {
        NameRole = Qt::UserRole + 1
    };

    explicit FileLibraryModel(QString directory, QString suffix, QObject* parent = nullptr);
 
    // Default destructor
    ~FileLibraryModel() override = default;
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] QStringList names() const { return m_names; }
 
 
    //
    // 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;
 
public slots:
    void refresh();
 
private:
    Q_DISABLE_COPY_MOVE(FileLibraryModel)
 
    // Base names of the library files in the directory, sorted with lessThan()
    [[nodiscard]] QStringList scan() const;
 
    // Sort order of the model: case-insensitive, with a case-sensitive
    // tie-break so that distinct names never compare equal
    static bool lessThan(const QString& first, const QString& second);
 
    QString m_directory;
    QString m_suffix;
 
    // Model content, sorted with lessThan()
    QStringList m_names;
 
    QFileSystemWatcher m_watcher;
 
    // Directory changes arrive in bursts, e.g. when a file is saved
    // atomically. The timer coalesces them into one refresh().
    QTimer m_debounce;
};