qt-creator/src/plugins/mcusupport/mcusupportoptions.h

/****************************************************************************
**
** Copyright (C) 2022 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 as published by the Free Software
** Foundation with exceptions as appearing in the file LICENSE.GPL3-EXCEPT
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
****************************************************************************/

#pragma once

#include <utils/environmentfwd.h>
#include "mcusupport_global.h"

#include <QCoreApplication>
#include <QObject>
#include <QVector>
#include <QVersionNumber>

QT_FORWARD_DECLARE_CLASS(QWidget)

namespace Utils {
class FilePath;
class PathChooser;
class InfoLabel;
} // namespace Utils

namespace ProjectExplorer {
class Kit;
class ToolChain;
} // namespace ProjectExplorer

namespace McuSupport {
namespace Internal {

class McuAbstractPackage;
class McuToolChainPackage;

void printMessage(const QString &message, bool important);

class McuTarget : public QObject
{
    Q_OBJECT

public:
    enum class OS { Desktop, BareMetal, FreeRTOS };

    struct Platform
    {
        QString name;
        QString displayName;
        QString vendor;
    };

    enum { UnspecifiedColorDepth = -1 };

    McuTarget(const QVersionNumber &qulVersion,
              const Platform &platform,
              OS os,
              const QVector<McuAbstractPackage *> &packages,
              const McuToolChainPackage *toolChainPackage,
              int colorDepth = UnspecifiedColorDepth);

    const QVersionNumber &qulVersion() const;
    const QVector<McuAbstractPackage *> &packages() const;
    const McuToolChainPackage *toolChainPackage() const;
    const Platform &platform() const;
    OS os() const;
    int colorDepth() const;
    bool isValid() const;
    void printPackageProblems() const;

private:
    const QVersionNumber m_qulVersion;
    const Platform m_platform;
    const OS m_os;
    const QVector<McuAbstractPackage *> m_packages;
    const McuToolChainPackage *m_toolChainPackage;
    const int m_colorDepth;
}; // class McuTarget

class McuSdkRepository
{
public:
    QVector<McuAbstractPackage *> packages;
    QVector<McuTarget *> mcuTargets;

    void deletePackagesAndTargets();
};

class McuSupportOptions : public QObject
{
    Q_OBJECT

public:
    explicit McuSupportOptions(QObject *parent = nullptr);
    ~McuSupportOptions() override;

    McuAbstractPackage *qtForMCUsSdkPackage = nullptr;
    McuSdkRepository sdkRepository;

    void setQulDir(const Utils::FilePath &dir);
    static void setKitEnvironment(ProjectExplorer::Kit *,
                                  const McuTarget *,
                                  const McuAbstractPackage *);
    static void updateKitEnvironment(ProjectExplorer::Kit *, const McuTarget *);
    static void remapQul2xCmakeVars(ProjectExplorer::Kit *, const Utils::EnvironmentItems &);
    static Utils::FilePath qulDirFromSettings();

    static void registerQchFiles();
    static void registerExamples();

    static const QVersionNumber &minimalQulVersion();

    void checkUpgradeableKits();
    void populatePackagesAndTargets();
private:
    void deletePackagesAndTargets();

signals:
    void packagesChanged();
};

class McuKitManager
{
    Q_DECLARE_TR_FUNCTIONS(McuSupport::Internal::McuKitManager)

public:
    enum class UpgradeOption {
        Ignore,
        Keep,
        Replace
    };

    // Creating kits:
    static ProjectExplorer::Kit *newKit(const McuTarget *mcuTarget, const McuAbstractPackage *qtForMCUsSdk);
    static void createAutomaticKits();

    // Querying the kits:
    static QList<ProjectExplorer::Kit *> existingKits(const McuTarget *mcuTarget);
    static QList<ProjectExplorer::Kit *> matchingKits(const McuTarget *mcuTarget,
                                                      const McuAbstractPackage *qtForMCUsSdkPackage);
    static QList<ProjectExplorer::Kit *> upgradeableKits(
        const McuTarget *mcuTarget, const McuAbstractPackage *qtForMCUsSdkPackage);
    static QList<ProjectExplorer::Kit *> kitsWithMismatchedDependencies(const McuTarget *mcuTarget);

    // Upgrading kits:
    static UpgradeOption askForKitUpgrades();
    static void upgradeKitsByCreatingNewPackage(UpgradeOption upgradeOption);
    static void upgradeKitInPlace(ProjectExplorer::Kit *kit, const McuTarget *mcuTarget, const McuAbstractPackage *qtForMCUsSdk);

    // Fixing kits:
    static void fixKitsDependencies();
    static void fixExistingKits();

    // Outdated kits:
    static QList<ProjectExplorer::Kit *> outdatedKits();
    static void removeOutdatedKits();

    // Querying kits:
    static QString kitName(const McuTarget* mcuTarget);
    static QVersionNumber kitQulVersion(const ProjectExplorer::Kit *kit);
    static bool kitIsUpToDate(const ProjectExplorer::Kit *kit, const McuTarget *mcuTarget, const McuAbstractPackage *qtForMCUsSdkPackage);
};

} // namespace Internal
} // namespace McuSupport