calamares/src/modules/partition/core/BootLoaderModel.h

/* === This file is part of Calamares - <https://calamares.io> ===
 *
 *   SPDX-FileCopyrightText: 2014 Aurélien Gâteau <agateau@kde.org>
 *   SPDX-FileCopyrightText: 2015 Teo Mrnjavac <teo@kde.org>
 *   SPDX-FileCopyrightText: 2019 Adriaan de Groot <groot@kde.org>
 *   SPDX-License-Identifier: GPL-3.0-or-later
 *
 *   Calamares is Free Software: see the License-Identifier above.
 *
 */
#ifndef BOOTLOADERMODEL_H
#define BOOTLOADERMODEL_H

#include <QList>
#include <QMutex>
#include <QStandardItemModel>

class Device;
class QComboBox;

/**
 * This model contains one entry for each device MBR plus one entry for the
 * /boot or / partition
 */
class BootLoaderModel : public QStandardItemModel
{
    Q_OBJECT
public:
    using DeviceList = QList< Device* >;

    enum
    {
        BootLoaderPathRole = Qt::UserRole + 1,
        IsPartitionRole
    };

    BootLoaderModel( QObject* parent = nullptr );
    ~BootLoaderModel() override;

    /**
     * Init the model with the list of devices. Does *not* take ownership of the
     * devices.
     */
    void init( const DeviceList& devices );

    void update();

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

    /** @brief Looks up a boot-loader by device-name @p path (e.g. /dev/sda)
    *
    * Returns a row number (index) in the model and a Device*: if there **is** a
    * device for the given @p path, index will be in range of the model and
    * Device* non-null. Returns (-1, nullptr) otherwise.
    */
    std::pair< int, Device* > findBootLoader( const QString& path ) const;

private:
    DeviceList m_devices;
    mutable QMutex m_lock;

    void createMbrItems();
    void updateInternal();
};

namespace Calamares
{
/** @brief Tries to set @p path as selected item in @p combo
 *
 * Matches a boot-loader install path (e.g. /dev/sda) with a model
 * row and sets that as the current row.
 */
void restoreSelectedBootLoader( QComboBox& combo, const QString& path );
}  // namespace Calamares
#endif /* BOOTLOADERMODEL_H */