simplecommandparser.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_MISC_SIMPLECOMMANDPARSER_H
#define SWIFT_MISC_SIMPLECOMMANDPARSER_H
 
#include <QString>
#include <QStringList>
 
#include "misc/swiftmiscexport.h"
 
namespace swift::misc
{
 
    class SWIFT_MISC_EXPORT CSimpleCommandParser
    {
    public:
        CSimpleCommandParser(const QStringList &knownCommands);
 
        bool isKnownCommand() const { return m_knownCommand; }
 
        void parse(const QString &commandLine);
 
        bool matchesCommand(const QString &checkCommand, const QString &alias1 = "", const QString &alias2 = "");
 
        bool commandStartsWith(const QString &startPattern) const;
 
        bool commandEndsWith(const QString &endPattern) const;
 
        const QString &part(int index) const;
 
        QString partAndRemainingStringAfter(int index) const;
 
        int countParts() const;
 
        bool hasPart(int index) const;
 
        int countPartsWithoutCommand() const;
 
        bool isInt(int index) const;
 
        bool isDouble(int index) const;
 
        int toInt(int index, int def = -1) const;
 
        bool toBool(int index, bool def = false) const;
 
        double toDouble(int index, double def = -1.0) const;
 
        bool matchesPart(int index, const QString &toMatch, Qt::CaseSensitivity cs = Qt::CaseInsensitive) const;
 
        struct CommandHtmlHelp
        {
            QString command; 
            QString help; 
 
            CommandHtmlHelp(const QString &command, const QString &help) : command(command), help(help) {}
 
            static bool less(const CommandHtmlHelp &a, const CommandHtmlHelp &b) { return a.command < b.command; }
        };
 
        static void registerCommand(const CommandHtmlHelp &command);
 
        static bool registered(const QString &helpContext);
 
        static QString commandsHtmlHelp();
 
    private:
        QString m_originalLine; 
        QString m_cleanedLine; 
        QString m_commandPart; 
        QStringList m_splitParts; 
        QStringList m_knownCommands; 
        bool m_knownCommand = false; 
 
        static QList<CommandHtmlHelp> s_commands; 
        static QSet<QString> s_registered; 
 
        void setCheckedCommandList(const QStringList &commands);
 
        static QString removeLeadingDot(const QString &candidate);
 
        static QString formatCommand(const QString &command);
 
        static bool isCommand(const QString &candidate);
    };
} // namespace swift::misc
 
#endif // SWIFT_MISC_SIMPLECOMMANDPARSER_H