bpscmdlineparser.h

Go to the documentation of this file.

 
#ifndef BPSCMDLINEPARSER_H
#define BPSCMDLINEPARSER_H
 
#include "bpscore_global.h"
#include <QObject>
#include <QScriptable>
#include <QString>
#include <QStringList>
 
class BPSCORE_EXPORT BpsCmdlineParser : public QObject, protected QScriptable
{
    Q_OBJECT
    BPS_PRIVATE(BpsCmdlineParser)
 
public:
 
    BpsCmdlineParser(QObject* aParent = nullptr);
 
    virtual ~BpsCmdlineParser();
 
public slots:
 
    BpsCmdlineParser& setDescription(const QString& aDescription);
 
    BpsCmdlineParser& setProgram(const QString& aName);
 
    BpsCmdlineParser& addMandatory(const QString& aParam);
 
    BpsCmdlineParser& addOptional(const QString& aParam);
 
    BpsCmdlineParser& addOptionals(const QString& aParam);
 
    BpsCmdlineParser& addSwitch(QChar aKey, const QString& aName, const QString& aInfo);
 
    BpsCmdlineParser& addHelpSwitch(QChar aKey, const QString& aName, const QString& aInfo);
 
    BpsCmdlineParser& addOption(QChar aKey, const QString& aName, const QString& aParam, const QString& aInfo);
 
    BpsCmdlineParser& addOptions(QChar aKey, const QString& aName, const QString& aParam, const QString& aInfo);
 
    BpsCmdlineParser& parse();
 
    QString program() const;
 
    QString mandatory(const QString& aParam) const;
 
    QString optional(const QString& aParam) const;
 
    QStringList optionals() const;
 
    bool switchState(QChar aKey, const QString& aName = QString()) const;
 
    QString option(QChar aKey, const QString& aName = QString()) const;
 
    QStringList options(QChar aKey, const QString& aName = QString()) const;
 
    QString help(int aWidth = 79) const;
 
};
 
#endif // BPSCMDLINEPARSER_H