javascript - 为 QScriptEngine 重新定义 "Undefined Value"函数时返回 "print()"有什么意义？

Question

[背景]

QScriptEngine 的默认print() 函数将结果打印到 Qt Creator IDE 的终端以进行调试。因此，如果我们要自己制作 ECMA 脚本解释器，则必须将输出重定向到我们的文本编辑器。

这部分文件"Making Applications Scriptable"自 Qt 4.3 以来保持不变。

第"Redefining print()" :

Qt Script provides a built-in print() function that can be useful for simple debugging purposes. The built-in print() function writes to standard output. You can redefine the print() function (or add your own function, e.g. debug() or log()) that redirects the text to somewhere else. The following code shows a custom print() that adds text to a QPlainTextEdit.

所以这里是建议重新定义print():

QScriptValue QtPrintFunction(QScriptContext *context, QScriptEngine *engine)
 {
     QString result;
     for (int i = 0; i < context->argumentCount(); ++i) {
         if (i > 0)
             result.append(" ");
         result.append(context->argument(i).toString());
     }

     QScriptValue calleeData = context->callee().data();
     QPlainTextEdit *edit = qobject_cast<QPlainTextEdit*>(calleeData.toQObject());
     edit->appendPlainText(result);

     return engine->undefinedValue();
 }

起初我怀疑return engine->undefinedValue();是否需要返回一个“Undefined Value”，看起来像参数*的作用engine就是返回这个void值。

所以这是我为更改函数所做的工作:

QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine)
{
    QString result;

    for (int i = 0; i < context->argumentCount(); ++i) {
        if (i > 0)
            result.append(" ");
        result.append(context->argument(i).toString());
    }

    /*
    QScriptValue calleeData = context->callee().data();
    QPlainTextEdit *edit = qobject_cast<QPlainTextEdit*>(calleeData.toQObject());
    edit->appendPlainText(result);

    return engine->undefinedValue();
    */
    return engine->toScriptValue(result); // ---> return the result directly
}

我认为这对我来说更合理:从脚本引擎返回一个评估的QScriptValue，然后该值可以被转换为QString 用于输出。这绕过了动态类型转换的需要，这可能会变得困惑，特别是对于定制的 QObjects。

对于这两种打印函数，这里是对脚本引擎的说明:

 QScriptEngine *engine = new QScriptEngine(this); 
 QTextEdit *input = new QTextEdit(this);
 QTextEdit *output = new QTextEdit(this);

 // Use documented print function : 
 QScriptValue fun = engine->newFunction(QtPrintFunction);
 // Use my revised print function : 
 // QScriptValue fun = engine->newFunction(myPrintFunction);
 fun.setData(engine->newQObject(output));
 engine->globalObject().setProperty("print", fun);

评估和输出:

QString command = input->toPlainText();
QScriptValue result = engine->evaluate(command);
output->append(result.toString());

---

[可编译代码]

(需要Qt版本> 4)

test.pro

QT += core gui widgets script
TARGET = Test
TEMPLATE = app


SOURCES += main.cpp\
        console.cpp

HEADERS  += console.h

main.cpp

#include <QApplication>
#include "console.h"

int main(int argc, char *argv[])
{
    QApplication app(argc, argv);

    Console w;
    w.show();

    return app.exec();
}

console.h

#ifndef CONSOLE_H
#define CONSOLE_H

#include <QWidget>
#include <QVBoxLayout>
#include <QTextEdit>
#include <QPushButton>
#include <QScriptEngine>

class Console : public QWidget
{
    Q_OBJECT

public:
    Console();
    ~Console();

public slots:
    void runScript();

private:
    QScriptEngine *engine;
    QVBoxLayout *layout;
    QPushButton *run;
    QTextEdit *input, *output;
};

QScriptValue QtPrintFunction(QScriptContext *context, QScriptEngine *engine);
QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine);

#endif // CONSOLE_H

控制台.cpp

#include "console.h"

Console::Console()
{
    engine = new QScriptEngine(this);
    layout = new QVBoxLayout(this);
    run = new QPushButton("Run",this);
    input = new QTextEdit(this);
    output = new QTextEdit(this);

    layout->addWidget(input);
    layout->addWidget(run);
    layout->addWidget(output);

    //QScriptValue fun = engine->newFunction(QtPrintFunction);
    QScriptValue fun = engine->newFunction(myPrintFunction);
    fun.setData(engine->newQObject(output));
    engine->globalObject().setProperty("print", fun);

    connect(run, SIGNAL(clicked()), this, SLOT(runScript()));
}

void Console::runScript()
{
    QString command = input->toPlainText();
    QScriptValue result = engine->evaluate(command);
    output->append(result.toString());
}

QScriptValue QtPrintFunction(QScriptContext *context, QScriptEngine *engine)
{
    QString result;
    for (int i = 0; i < context->argumentCount(); ++i) {
        if (i > 0)
            result.append(" ");
        result.append(context->argument(i).toString());
    }

    QScriptValue calleeData = context->callee().data();
    QTextEdit *edit = qobject_cast<QTextEdit*>(calleeData.toQObject());
    edit->append(result);

    return engine->undefinedValue();
}

QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine)
{
    QString result;
    for (int i = 0; i < context->argumentCount(); ++i) {
        if (i > 0)
            result.append(" ");
        result.append(context->argument(i).toString());
    }

    return engine->toScriptValue(result);
}

Console::~Console()
{

}

---

[例子]

输入 1:

print(123);

输出(Qt 文档 QtPrintFunction()):

123
undefined

输出(我的版本 myPrintFunction()):

123

---

输入 2:

for (i = 0; i < 3; i++)
    print(i);

输出(Qt 文档 QtPrintFunction() ):

0

1

2

undefined

输出(myPrintFunction()):

2

---

输入 3:

print("Stack");
print("Overflow");

输出(Qt 文档 QtPrintFunction() ):

Stack

Overflow

undefined

输出(我的版本 myPrintFunction()):

Overflow

---

[问题]

虽然 myPrintFunction 一开始似乎工作正常，但当脚本中调用了两个以上的 print 时它就不起作用了，其中只有最后一个 print 将被执行。

It seems the returning of an "Undefined Value" is NECESSARY for the print function. But why???

Answer 1

返回 undefinedValue() 并不是必须的，但是当你这样做的时候，就等于什么都不返回。或者本质上，就像您将函数声明为 void print(...) 一样，可以这么说。

这就是 QtPrintFunction 所做的——它返回“无”。但它确实有一个副作用，即无论何时调用它，都会将其参数附加到内部数据对象。这就是为什么您在 output 对象中获取所有传递给 print 的值。

现在，当您调用 engine->evaluate() 时，它会返回最后 计算表达式的值。因此，使用 myPrintFunction，您只能获得 last 值。

因此，如果您要输入以下内容:

print("Stack");
print("Overflow");
"garbage";

您只会返回垃圾(双关语)，因为这是最后计算的表达式。

但是，如果你要输入这个:

print("Stack") + '\n' +
print("Overflow");

如您所料，您将获得这两个值。

此外，如果您输入:

result = "";
for (i = 0; i < 3; i++)
    result += print(i) + '\n';

你也会得到你所期望的。

希望这能解释为什么你的函数会这样运行。

但是，我认为这不是您要实现的目标。所以...继续前进。

您可以做的一件事是按如下方式定义myPrintFunction:

QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine)
{
    static QString result;
    for (int i = 0; i < context->argumentCount(); ++i) {
        if (i > 0)
            result.append(" ");
        result.append(context->argument(i).toString());
    }
    result.append('\n');

    return engine->toScriptValue(result);
}

这将按照您预期的方式“工作”。唯一的问题是您无法清除result 的值。如果这对您有用，那就是了。

有一个更好的方法可以做到这一点，这可能是定义一个类，例如:

class QTrace: public QObject
{
    ...
    void clear();
    void append(const QString& value);
    const QString& get();
}

并将该类的对象传递给 fun.setData(engine->newQObject(trace)) 并将您的函数定义为:

QScriptValue myPrintFunction(QScriptContext *context, QScriptEngine *engine)
{
    QString result;
    for (int i = 0; i < context->argumentCount(); ++i) {
        if (i > 0)
            result.append(" ");
        result.append(context->argument(i).toString());
    }
    result.append('\n');

    QScriptValue calleeData = context->callee().data();
    QTrace *trace = qobject_cast<QTrace*>(calleeData.toQObject());
    trace->append(result);

    return engine->undefinedValue();
}

最后，您可以将 runScript 函数更改为如下内容:

trace->clear();

QScriptValue result = engine->evaluate(command);
if(result.isError())
    output->append(result.toString());
else
    output->append(trace->get());

或者可能还有其他方法，但希望能帮助您朝着正确的方向前进。