summaryrefslogtreecommitdiffstats
path: root/scriptrunner.cpp
blob: 4bb0211788784776593aa912578c834ffec4cedf (plain)
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
/**************************************************************************
**
** Copyright (C) 2013 Kläralvdalens Datakonsult AB, a KDAB Group company.
** Contact: Kläralvdalens Datakonsult AB (info@kdab.com)
**
** This file is part of Qt Creator.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

#include "scriptrunner.h"

#include "objects/console.h"
#include "objects/editor.h"
#include "objects/basetexteditor.h"
#include "objects/editors.h"

#include <coreplugin/editormanager/editormanager.h>
#include <coreplugin/editormanager/ieditor.h>

#include "scriptwrappers.h"
#include "enumwappers.h"
#include "utils/dialogs.h"
#include "objects/cppfunction.h"
#include "objects/cppargument.h"
#include <QTextStream>
#include <QFile>
#include <coreplugin/messagemanager.h>
#include <utils/outputformat.h>
#include <QFileInfo>
#include "objects/mark.h"
#include "utils/utils.h"
#include "objects/cppclass.h"

using namespace Scripting;
using namespace Scripting::Internal;

namespace {
    QString rootDir;
}

ScriptRunner* ScriptRunner::m_instance = 0;

ScriptRunner::ScriptRunner(QObject *parent) :
   QObject(parent),
   m_engine(0)
{
    m_instance = this;
}

ScriptRunner *ScriptRunner::instance()
{
    return m_instance;
}

ScriptRunner::~ScriptRunner()
{
}

// The backtrace does unfortunately not include the file in which an error occurred,
// we therefore need this variable to store this information.
static QString errorFileName;

static QScriptValue run(QScriptEngine* engine, const QString& fileName, bool recursive)
{
    QFile file(fileName);
    if (file.open(QIODevice::ReadOnly)) {

        QTextStream stream(&file);
        const QString sourceCode = stream.readAll();

        if ( recursive ) {
            // A script context is pushed by the include function call.
            // Link that context to the one of the script that called include
            // Only do that, however, when called from the scipt
            QScriptContext *context = engine->currentContext();
            QScriptContext *parent=context->parentContext();
            context->setActivationObject(parent->activationObject());
            context->setThisObject(parent->thisObject());
        }

        QScriptValue result = engine->evaluate(sourceCode, fileName);
        if (engine->hasUncaughtException() && errorFileName.isNull() )
            errorFileName = fileName;

        return result;
    }
    else {
        Core::MessageManager::instance()->printToOutputPane(QObject::tr("Error: %1 doesn't exist.\n").arg(fileName),
                                                            Core::MessageManager::Flash);
        engine->abortEvaluation();
        return QScriptValue();
    }
}

static QScriptValue load(QScriptContext *context, QScriptEngine *engine)
{
    QScriptValue callee = context->callee();
    if (context->argumentCount() == 1) {
        QString oldRoot = rootDir;
        QString path = rootDir + QLatin1String("/") + context->argument(0).toString();
        rootDir = QFileInfo(path).absolutePath();
        const QScriptValue result = run(engine, path, true);
        rootDir = oldRoot;
        return result;
    }
    else
        context->throwError(QObject::tr("Wrong number of arguments given to import"));
    return QScriptValue();
}

ErrorMessage ScriptRunner::runScript(const QString fileName)
{
    errorFileName = QString();
    rootDir = QFileInfo(fileName).absolutePath();
    ensureEngineInitialized();

    // Ensure no polution of environment between script runs
    m_engine->pushContext();
    QScriptValue result = run(m_engine.data(), fileName, false);
    const bool failed = m_engine->hasUncaughtException();
    m_engine->popContext();

    // Set the focus back to the editor
    const Core::EditorManager *editorManager = Core::EditorManager::instance();
    if (editorManager->currentEditor())
        editorManager->currentEditor()->widget()->setFocus(Qt::OtherFocusReason);

    m_engine->collectGarbage();

    if (failed)
        return ErrorMessage(errorFileName, m_engine->uncaughtExceptionLineNumber(), result.toString());

    return ErrorMessage();
}

/**
  @brief Convert a relative path to an absolute path relative to the loaded scripts direcotry

  Relative files referenced in the scripts, should always be relative to the script loaded.
 */
QString ScriptRunner::absolutePath(const QString &path)
{
    if (QFileInfo(path).isRelative() )
        return rootDir + QLatin1String("/") + path;
    else
        return path;
}

Q_DECLARE_METATYPE(QList<CppArgument*>)

ScriptRunner::QScriptEnginePtr ScriptRunner::ensureEngineInitialized()
{
    if (!m_engine.isNull())
        return m_engine;
    m_engine = QScriptEnginePtr(new QScriptEngine);

    qRegisterMetaType<Editor*>("Editor*");
    registerQObject<Editor>(m_engine.data());

    qRegisterMetaType<CppFunction*>("CppFunction*");
    registerQObject<CppFunction>(m_engine.data());

    qRegisterMetaType<CppFunction*>("CppClass*");
    registerQObject<CppClass>(m_engine.data());

    qRegisterMetaType<CppArgument*>("CppArgument*");
    registerQObject<CppArgument>(m_engine.data());

    qRegisterMetaType<Mark*>("Mark*");
    registerQObject<Mark>(m_engine.data());

    qRegisterMetaType<Position>("Position");

    qScriptRegisterSequenceMetaType< QList<CppArgument*> >(m_engine.data());

    registerGlobal(new Console, QLatin1String("console"));
    registerGlobal(new Editors, QLatin1String("editors"));
    registerGlobal(new Dialogs, QLatin1String("dialogs"));
    registerGlobal(new Utils, QLatin1String("utils"));
    registerWrappers(m_engine.data());
    registerEnums(m_engine.data());

    m_engine->globalObject().setProperty(QLatin1String("include"), m_engine->newFunction(load));
    return m_engine;
}

void ScriptRunner::registerGlobal(QObject *object, const QString &name)
{
    if (!m_engine.isNull()) {
        object->setParent(this);
        QScriptValue value = m_engine->newQObject(object, QScriptEngine::QtOwnership);
        m_engine->globalObject().setProperty(name, value);
    }
}