params.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2025 QuasarApp.
 * Distributed under the lgplv3 software license, see the accompanying
 * Everyone is permitted to copy and distribute verbatim copies
 * of this license document, but changing it is not allowed.
*/
 
#ifndef PARAMS_H
#define PARAMS_H
 
#include <QMap>
#include <QVariant>
#include "quasarapp_global.h"
#include "helpdata.h"
#include "optiondata.h"
 
namespace QuasarAppUtils {
 
 
enum VerboseLvl {
    Error   = 0x0,
    Warning = 0x1,
    Info    = 0x2,
    Debug   = 0x3,
 
};
#ifdef QA_DISABLE_LOG
#define DEFAULT_VERBOSE_LVL "0"
#else
#ifdef QT_DEBUG
#define DEFAULT_VERBOSE_LVL "3"
#else
#define DEFAULT_VERBOSE_LVL "2"
#endif
#endif
 
class QUASARAPPSHARED_EXPORT Params
{
public:
    Params() = delete;
 
    static bool parseParams(const int argc, const char *argv[], const OptionsDataList& options = {});
 
    static bool parseParams(int argc, char *argv[], const OptionsDataList& options = {});
 
    static bool parseParams(const QStringList& paramsArray, const OptionsDataList& options = {});
 
    static QString getArg(const QString& key, const QString &def = {});
 
    static void setArg(const QString& key, const QString& val);
 
    static void setEnable(const QString& key, bool enable);
 
    static bool isEndable(const QString& key);
 
    [[deprecated("Use QALogger and qt debug functions(qDebug, qInfo, qError...)")]]
    static void log(const QString& log, VerboseLvl vLvl = VerboseLvl::Debug);
 
    static VerboseLvl getVerboseLvl();
 
    static bool isDebug();
 
    [[deprecated("Use Qt MACROSSSES")]]
    static bool isDebugBuild();
 
    static int size();
 
    static void showHelp();
 
    static void showHelpForInputOptions();
 
    static Help::Section getHelpOfInputOptions();
 
    static const Help::Section& getHelp();
 
    static const QMap<QString, QString> &getUserParamsMap();
 
    static void clearParsedData();
 
    static QString getCurrentExecutable();
 
    static QString getCurrentExecutableDir();
 
    static OptionsDataList availableArguments();
 
private:
 
    static bool optionsForEach(const QStringList& paramsArray,
                               const OptionsDataList &availableOptions);
 
    static void printWorkingOptions();
 
    static bool checkOption(const OptionData &option, const QString &rawOptionName);
 
    static void parseAvailableOptions(const OptionsDataList& availableOptionsListIn,
                                      OptionsDataList* availableOptionsListOut,
                                      Help::Section* helpOut);
 
 
    static QMap<QString, QString> params;
    static OptionsDataList inputOptions;
 
    static Help::Section userHelp;
    static QString appPath;
    static QString appName;
 
};
}
 
#endif // PARAMS_H