File: scriptingplugin.h

package info (click to toggle)
sqlitestudio 3.4.21%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 54,880 kB
  • sloc: ansic: 406,208; cpp: 123,872; yacc: 2,692; tcl: 497; sh: 462; xml: 426; makefile: 19
file content (62 lines) | stat: -rw-r--r-- 2,504 bytes parent folder | download
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
#ifndef SCRIPTINGPLUGIN_H
#define SCRIPTINGPLUGIN_H

#include "plugin.h"
#include <QVariant>

class Db;

class ScriptingPlugin : virtual public Plugin
{
    public:
        class Context
        {
            public:
                virtual ~Context() {}
        };

        class FunctionInfo
        {
            public:
                virtual QString getName() const = 0;
                virtual QStringList getArguments() const = 0;
                virtual bool getUndefinedArgs() const = 0;
        };

        virtual QString getLanguage() const = 0;
        virtual Context* createContext() = 0;
        virtual void releaseContext(Context* context) = 0;
        virtual void resetContext(Context* context) = 0;
        virtual void setVariable(Context* context, const QString& name, const QVariant& value) = 0;
        virtual QVariant getVariable(Context* context, const QString& name) = 0;
        virtual QVariant evaluate(Context* context, const QString& code, const FunctionInfo& funcInfo,
                                  const QList<QVariant>& args = QList<QVariant>()) = 0;
        virtual bool hasError(Context* context) const = 0;
        virtual QString getErrorMessage(Context* context) const = 0;
        virtual QVariant evaluate(const QString& code, const FunctionInfo& funcInfo, const QList<QVariant>& args = QList<QVariant>(),
                                  QString* errorMessage = nullptr) = 0;
        virtual QString getIconPath() const = 0;
};

class DbAwareScriptingPlugin : public ScriptingPlugin
{
    public:
        virtual QVariant evaluate(Context* context, const QString& code, const FunctionInfo& funcInfo, const QList<QVariant>& args,
                                  Db* db, bool locking = false) = 0;
        virtual QVariant evaluate(const QString& code, const FunctionInfo& funcInfo, const QList<QVariant>& args, Db* db,
                                  bool locking = false, QString* errorMessage = nullptr) = 0;

        QVariant evaluate(Context* context, const QString& code, const FunctionInfo& funcInfo, const QList<QVariant>& args)
        {
            return evaluate(context, code, funcInfo, args, nullptr, true);
        }

        QVariant evaluate(const QString& code, const FunctionInfo& funcInfo, const QList<QVariant>& args, QString* errorMessage = nullptr)
        {
            return evaluate(code, funcInfo, args, nullptr, true, errorMessage);
        }
};

Q_DECLARE_METATYPE(ScriptingPlugin::Context*)

#endif // SCRIPTINGPLUGIN_H