aboutsummaryrefslogtreecommitdiffstats
path: root/SQLiteStudio3/sqlitestudiocli/commands/clicommand.h
blob: 4fc86182defcc7d95bbcd422a8fce431abba716f (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
#ifndef CLICOMMAND_H
#define CLICOMMAND_H

#include "clicommandsyntax.h"
#include <QStringList>
#include <QTextStream>
#include <QObject>
#include <QDir>

class QFile;
class SQLiteStudio;
class DbManager;
class CLI;
class Config;

class CliCommand : public QObject
{
    Q_OBJECT

    public:
        CliCommand();
        virtual ~CliCommand();

        void setup(CLI* cli);

        /**
         * @brief execute
         */
        virtual void execute() = 0;

        /**
         * @brief Short help displayed in commands index.
         * @return Single line of command description.
         */
        virtual QString shortHelp() const = 0;

        /**
         * @brief Full help is displayed when help for specific command was requested.
         * @return Multi line, detailed description, including syntax.
         */
        virtual QString fullHelp() const = 0;

        virtual bool isAsyncExecution() const;

        virtual void defineSyntax() = 0;

        QStringList aliases() const;
        bool parseArgs(const QStringList& args);
        QString usage() const;
        QString usage(const QString& alias) const;
        QString getName() const;
        QStringList complete(const QStringList& args);

    protected:
        enum ArgIds
        {
            DB_NAME         = 1000,
            DB_NAME_OR_FILE = 1001,
            FILE_PATH       = 1002,
            DIR_OR_FILE     = 1003,
            DIR_PATH        = 1004,
            CMD_NAME        = 1005,
            INTRNAL_DB      = 1006,
            STRING          = 1007,
            TABLE           = 1008,
            INDEX           = 1009,
            TRIGGER         = 1010,
            VIEW            = 1011
        };

        static void println(const QString& str = "");
        static void print(const QString& str = "");
        static void printBox(const QString& str);
        static QString cmdName(const QString& cmd);

        void printUsage();
        QString getFilterAndFixDir(QDir& dir, const QString& path);
        QStringList getCompletionDbNames();
        QStringList getCompletionTables();
        QStringList getCompletionIndexes();
        QStringList getCompletionTriggers();
        QStringList getCompletionViews();
        QStringList getCompletionDbNamesOrFiles(const QString& partialValue);
        QStringList getCompletionFiles(const QString& partialValue);
        QStringList getCompletionDirs(const QString& partialValue);
        QStringList getCompletionDirsOrFiles(const QString& partialValue);
        QStringList getCompletionInternalDbs();
        virtual QStringList getCompletionValuesFor(int id, const QString& partialValue);

        CLI* cli = nullptr;
        CliCommandSyntax syntax;

    signals:
        void execComplete();
};

#endif // CLICOMMAND_H