QGCCommandLineParser.h

Go to the documentation of this file.

#pragma once
 
#include <optional>
 
#include <QtCore/QCommandLineParser>
#include <QtCore/QLoggingCategory>
#include <QtCore/QStringList>
 
Q_DECLARE_LOGGING_CATEGORY(QGCCommandLineParserLog)
 
namespace QGCCommandLineParser {
 
struct CommandLineParseResult
{
    enum class Status {
        Ok,
        Error,
        VersionRequested,
        HelpRequested
    } statusCode = Status::Ok;
 
    std::unique_ptr<QCommandLineParser> parser;
 
    std::optional<QString> errorString;
    QString helpText;
    QString versionText;
 
    QStringList positional;
    QStringList unknownOptions;
 
    // --- Core options ---
    std::optional<quint8> systemId;
    bool clearSettingsOptions = false;
    bool clearCache = false;
    std::optional<QString> loggingOptions;
    bool logOutput = false;
    bool simpleBootTest = false;
 
    // --- Test options (command-line parsing only in QGC_UNITTEST_BUILD) ---
    bool runningUnitTests = false;
    QStringList unitTests;
    bool stressUnitTests = false;
    uint stressUnitTestsCount = 0;
    std::optional<QString> unitTestOutput;  
    std::optional<QString> labelFilter;     
    bool listTests = false;                 
 
    // --- Desktop options (not on Android/iOS) ---
    bool fakeMobile = false;
    bool allowMultiple = false;
 
    // --- Graphics options ---
    bool useDesktopGL = false;      
    bool useSwRast = false;         
    bool quietWindowsAsserts = false;  
};
 
CommandLineParseResult parseCommandLine();
 
CommandLineParseResult parse(int argc, char* argv[]);
 
std::optional<int> handleParseResult(const CommandLineParseResult& result);
 
enum class AppMode {
    Gui,        
    BootTest,   
#ifdef QGC_UNITTEST_BUILD
    Test,       
    ListTests   
#endif
};
 
AppMode determineAppMode(const CommandLineParseResult& args);
 
#ifdef QGC_UNITTEST_BUILD
void overrideCommandLine(int& argc, char**& argv);
#endif
 
} // namespace QGCCommandLineParser