Qt Script之qscript

这是一个简单的JS命令解释器,可以在命令行输入简单的JS代码显示运行结果。

用到的一些函数

bool QScriptEngine::canEvaluate(const QString & program) const

如果程序可以被评估则返回true;代码是足够来确定它是否是语法正确的程序或者包含一个语法错误。如果程序是不完整的则返回false。这个函数典型的用法是用来实现交互式解释器。

QScriptValue QScriptEngine::evaluate(const QString & program, const QString & fileName = QString(), int lineNumber = 1)

评估程序,使用lineNumber作为基础行数并且返回评估结果。

QScriptValue QScriptEngine::importExtension(const QString & extension)

导入给定的扩展到脚本引擎,如果脚本被导入成功返回undefinedValue。

parentContext

返回这个上下文的父上下文。

QScriptValue QScriptContext::activationObject() const

返回上下文的激活对象,激活对象提供访问关联这个上下文的局部变量。

void QScriptContext::setThisObject(const QScriptValue & thisObject)

设置关联上下文的this成为thisObject

bool QScriptEngine::hasUncaughtException() const

如果最后一个脚本评估导致了一个未捕获的异常则返回true.

forever一个无限循环的宏

//main.cpp
#include <qscriptengine.h>
#include <QtCore/QFile>
#include <QtCore/QTextStream>
#include <QtCore/QStringList>
#include <QtWidgets/QApplication>

#include <stdlib.h>
#include <QDebug>
#include "bytearrayclass.h"
           

static bool wantsToQuit;
//输入quit()或者exit()退出环境
static QScriptValue qtscript_quit(QScriptContext *ctx, QScriptEngine *eng)
{
    Q_UNUSED(ctx);
    wantsToQuit = true;//设置退出变量为true
    return eng->undefinedValue();
}

static void interactive(QScriptEngine *eng)
{
    QScriptValue global = eng->globalObject();//获取全局变量并且设置exit和quit属性
    QScriptValue quitFunction = eng->newFunction(qtscript_quit);
    if (!global.property(QLatin1String("exit")).isValid())
        global.setProperty(QLatin1String("exit"), quitFunction);
    if (!global.property(QLatin1String("quit")).isValid())
        global.setProperty(QLatin1String("quit"), quitFunction);
    wantsToQuit = false;

    QTextStream qin(stdin, QFile::ReadOnly);//从标准输入中读取text

    const char *qscript_prompt = "qs> ";
    const char *dot_prompt = ".... ";
    const char *prompt = qscript_prompt;

    QString code;

    forever {
        QString line;

        printf("%s", prompt);
        fflush(stdout);//使stdout清空,就会立刻输出所有在缓冲区的内容

        line = qin.readLine();//如果line是null
        if (line.isNull())
            break;

        code += line;
        code += QLatin1Char('\n');

        if (line.trimmed().isEmpty()) {//输入去除空格后如果为空则continue
            continue;

        } else if (! eng->canEvaluate(code)) {//代码不能评估
            prompt = dot_prompt;

        } else {
            QScriptValue result = eng->evaluate(code, QLatin1String("typein"));//执行代码
            code.clear();
            prompt = qscript_prompt;

            if (! result.isUndefined())
                fprintf(stderr, "%s\n", qPrintable(result.toString()));

            if (wantsToQuit)
                break;
        }
    }
}
//加载JS扩展
static QScriptValue importExtension(QScriptContext *context, QScriptEngine *engine)
{
    return engine->importExtension(context->argument().toString());
}

static QScriptValue loadScripts(QScriptContext *context, QScriptEngine *engine)
{
    for (int i = ; i < context->argumentCount(); ++i) {
        QString fileName = context->argument(i).toString();//从arguments对象中获得文件名
        QFile file(fileName);
        if (!file.open(QIODevice::ReadOnly))
            return context->throwError(QString::fromLatin1("could not open %0 for reading").arg(fileName));
        QTextStream ts(&file);
        QString contents = ts.readAll();//获取JS代码
        file.close();
        QScriptContext *pc = context->parentContext();//load上下文的parentContext(全局上下文)
        context->setActivationObject(pc->activationObject());//应该是全局对象globalObject()
        context->setThisObject(pc->thisObject());//设置this对象
        QScriptValue ret = engine->evaluate(contents);//执行JS代码
        if (engine->hasUncaughtException())
            return ret;
    }
    return engine->undefinedValue();
}

int main(int argc, char *argv[])
{
    QCoreApplication *app = new QCoreApplication(argc, argv);
    QScriptEngine *eng = new QScriptEngine();

    QScriptValue globalObject = eng->globalObject();
    //为脚本环境定义一个load函数
    globalObject.setProperty("load", eng->newFunction(loadScripts, /*length=*/));
    {
        //为脚本环境定义一个qt.script.importExtension函数。
        if (!globalObject.property("qt").isObject())
            globalObject.setProperty("qt", eng->newObject());            
        QScriptValue qscript = eng->newObject();
        qscript.setProperty("importExtension", eng->newFunction(importExtension));
        globalObject.property("qt").setProperty("script", qscript);
    }
    //为脚本环境注册一个新的Qt Script类
    //ByteArrayClass *byteArrayClass = new ByteArrayClass(eng);
    //globalObject.setProperty("ByteArray", byteArrayClass->constructor());
    if (! *++argv) { //如果命令行第二个参数为空则进入交互函数
        interactive(eng);
        return EXIT_SUCCESS;
    }
    while (const char *arg = *argv++) {//不为空则判断第二个参数
        QString fn = QString::fromLocal8Bit(arg);

        if (fn == QLatin1String("-i")) {//-i进入交互函数
            interactive(eng);
            break;
        }

        QString contents;
        int lineNumber = ;

        if (fn == QLatin1String("-")) {//输入- 然后换行输入js的代码
            QTextStream stream(stdin, QFile::ReadOnly);
            contents = stream.readAll();
        }

        else {
            QFile file(fn);//假设第二个参数是文件名则加载文件内容

            if (file.open(QFile::ReadOnly)) {
                QTextStream stream(&file);
                contents = stream.readAll();
                file.close();

                // strip off #!/usr/bin/env qscript line
                if (contents.startsWith("#!")) {
                    contents.remove(, contents.indexOf("\n"));
                    ++lineNumber;
                }
            }
        }

        if (contents.isEmpty())//js代码不为空
            continue;

        QScriptValue r = eng->evaluate(contents, fn, lineNumber);//评估JS代码并返回结果
        if (eng->hasUncaughtException()) {//捕捉代码中的异常
            QStringList backtrace = eng->uncaughtExceptionBacktrace();
            fprintf (stderr, "    %s\n%s\n\n", qPrintable(r.toString()),
                     qPrintable(backtrace.join("\n")));
            return EXIT_FAILURE;
        }
    }

    delete eng;
    delete app;

    return EXIT_SUCCESS;
}