Differential D6914 Diff 17223 src/script/katescript.cpp

Changeset View

Standalone View

View Options

src/script/katescript.cpp

Context not available.
31 31​
32#include <QFile> 32​#include <QFile>
33#include <QFileInfo> 33​#include <QFileInfo>
34#include <QScriptEngine> 34​#include <QJSEngine>
35#include <QScriptValue> 35​#include <QJSValue>
36#include <QScriptContext> ​
37#include <QMap> 36​#include <QMap>
37​#include <QQmlEngine>
38 38​
39//BEGIN conversion functions for Cursors and Ranges 39​//BEGIN conversion functions for Cursors and Ranges
40/** Converstion function from KTextEditor::Cursor to QtScript cursor */ ​
41static QScriptValue cursorToScriptValue(QScriptEngine *engine, const KTextEditor::Cursor &cursor) ​
42{ ​
43 QString code = QStringLiteral("new Cursor(%1, %2);").arg(cursor.line()) ​
44 .arg(cursor.column()); ​
45 return engine->evaluate(code); ​
46} ​
47 ​
48/** Converstion function from QtScript cursor to KTextEditor::Cursor */ ​
49static void cursorFromScriptValue(const QScriptValue &obj, KTextEditor::Cursor &cursor) ​
50{ ​
51 cursor.setPosition(obj.property(QStringLiteral("line")).toInt32(), ​
52 obj.property(QStringLiteral("column")).toInt32()); ​
53} ​
54 ​
55/** Converstion function from QtScript range to KTextEditor::Range */ ​
56static QScriptValue rangeToScriptValue(QScriptEngine *engine, const KTextEditor::Range &range) ​
57{ ​
58 QString code = QStringLiteral("new Range(%1, %2, %3, %4);").arg(range.start().line()) ​
59 .arg(range.start().column()) ​
60 .arg(range.end().line()) ​
61 .arg(range.end().column()); ​
62 return engine->evaluate(code); ​
63} ​
64 40​
65/** Converstion function from QtScript range to KTextEditor::Range */ ​
66static void rangeFromScriptValue(const QScriptValue &obj, KTextEditor::Range &range) ​
67{ ​
68 range.setRange(KTextEditor::Cursor(obj.property(QStringLiteral("start")).property(QStringLiteral("line")).toInt32(), ​
69 obj.property(QStringLiteral("start")).property(QStringLiteral("column")).toInt32()), ​
70 KTextEditor::Cursor(obj.property(QStringLiteral("end")).property(QStringLiteral("line")).toInt32(), ​
71 obj.property(QStringLiteral("end")).property(QStringLiteral("column")).toInt32())); ​
72} ​
73//END 41​//END
74 42​
75KateScript::KateScript(const QString &urlOrScript, enum InputType inputType) 43​KateScript::KateScript(const QString &urlOrScript, enum InputType inputType)
Context not available.
88{ 56​{
89 if (m_loadSuccessful) { 57​ if (m_loadSuccessful) {
90 // remove data... 58​ // remove data...
91 delete m_engine; ​
92 delete m_document; 59​ delete m_document;
93 delete m_view; 60​ delete m_view;
61​ delete m_engine;
94 } 62​ }
95} 63​}
96 64​
97QString KateScript::backtrace(const QScriptValue &error, const QString &header) 65​QString KateScript::backtrace(const QJSValue &error, const QString &header)
98{ 66​{
99 QString bt; 67​ QString bt;
100 if (!header.isNull()) { 68​ if (!header.isNull()) {
Context not available.
104 bt += error.toString() + QLatin1Char('\n'); 72​ bt += error.toString() + QLatin1Char('\n');
105 } 73​ }
106 74​
107 bt += m_engine->uncaughtExceptionBacktrace().join(QStringLiteral("\n")) + QLatin1Char('\n'); ​
108 ​
109 return bt; 75​ return bt;
110} 76​}
111 77​
dhaumannUnsubmitted
Not Done

If there is no equivalent to get the backtrace, just delete this line.

dhaumann: If there is no equivalent to get the backtrace, just delete this line.
112void KateScript::displayBacktrace(const QScriptValue &error, const QString &header) 78​void KateScript::displayBacktrace(const QJSValue &error, const QString &header)
113{ 79​{
114 if (!m_engine) { 80​ if (!m_engine) {
115 std::cerr << "KateScript::displayBacktrace: no engine, cannot display error\n"; 81​ std::cerr << "KateScript::displayBacktrace: no engine, cannot display error\n";
Context not available.
123 if (!load()) { 89​ if (!load()) {
124 return; 90​ return;
125 } 91​ }
126 m_engine->clearExceptions(); ​
127} 92​}
128 93​
129QScriptValue KateScript::global(const QString &name) 94​QJSValue KateScript::global(const QString &name)
130{ 95​{
131 // load the script if necessary 96​ // load the script if necessary
dhaumannUnsubmitted
Not Done

If such a call is not required, please delete.

dhaumann: If such a call is not required, please delete.
132 if (!load()) { 97​ if (!load()) {
133 return QScriptValue(); 98​ return QJSValue::UndefinedValue;
134 } 99​ }
135 return m_engine->globalObject().property(name); 100​ return m_engine->globalObject().property(name);
136} 101​}
137 102​
138QScriptValue KateScript::function(const QString &name) 103​QJSValue KateScript::function(const QString &name)
139{ 104​{
140 QScriptValue value = global(name); 105​ QJSValue value = global(name);
141 if (!value.isFunction()) { 106​ if (!value.isCallable()) {
142 return QScriptValue(); 107​ return QJSValue::UndefinedValue;
143 } 108​ }
144 return value; 109​ return value;
145} 110​}
Context not available.
164 } 129​ }
165 130​
166 // create script engine, register meta types 131​ // create script engine, register meta types
167 m_engine = new QScriptEngine(); 132​ m_engine = new QJSEngine();
168 qScriptRegisterMetaType(m_engine, cursorToScriptValue, cursorFromScriptValue); ​
169 qScriptRegisterMetaType(m_engine, rangeToScriptValue, rangeFromScriptValue); ​
170 133​
171 // export read & require function and add the require guard object 134​ // export read & require function and add the require guard object
172 m_engine->globalObject().setProperty(QStringLiteral("read"), m_engine->newFunction(Kate::Script::read)); 135​ QJSValue functions = m_engine->newQObject(new Kate::ScriptHelper(m_engine));
173 m_engine->globalObject().setProperty(QStringLiteral("require"), m_engine->newFunction(Kate::Script::require)); 136​ m_engine->globalObject().setProperty(QStringLiteral("functions"), functions);
137​ m_engine->globalObject().setProperty(QStringLiteral("read"), functions.property(QStringLiteral("read")));
138​ m_engine->globalObject().setProperty(QStringLiteral("require"), functions.property(QStringLiteral("require")));
174 m_engine->globalObject().setProperty(QStringLiteral("require_guard"), m_engine->newObject()); 139​ m_engine->globalObject().setProperty(QStringLiteral("require_guard"), m_engine->newObject());
175 140​
176 // export debug function 141​ // export debug function
177 m_engine->globalObject().setProperty(QStringLiteral("debug"), m_engine->newFunction(Kate::Script::debug)); 142​ m_engine->globalObject().setProperty(QStringLiteral("debug"), functions.property(QStringLiteral("debug")));
178 143​
179 // export translation functions 144​ // export translation functions
180 m_engine->globalObject().setProperty(QStringLiteral("i18n"), m_engine->newFunction(Kate::Script::i18n)); 145​ m_engine->globalObject().setProperty(QStringLiteral("i18n"), functions.property(QStringLiteral("_i18n")));
181 m_engine->globalObject().setProperty(QStringLiteral("i18nc"), m_engine->newFunction(Kate::Script::i18nc)); 146​ m_engine->globalObject().setProperty(QStringLiteral("i18nc"), functions.property(QStringLiteral("_i18nc")));
182 m_engine->globalObject().setProperty(QStringLiteral("i18ncp"), m_engine->newFunction(Kate::Script::i18ncp)); 147​ m_engine->globalObject().setProperty(QStringLiteral("i18np"), functions.property(QStringLiteral("_i18np")));
183 m_engine->globalObject().setProperty(QStringLiteral("i18np"), m_engine->newFunction(Kate::Script::i18np)); 148​ m_engine->globalObject().setProperty(QStringLiteral("i18ncp"), functions.property(QStringLiteral("_i18ncp")));
184 149​
185 // register default styles as ds* global properties 150​ // register default styles as ds* global properties
dhaumannUnsubmitted
Not Done

If I remember correctly, Christoph once said it as quite a hassle to get this include guard working correctly. Are you sure it works or are there possibly issues due to some other behavior in QJSEngine?

dhaumann: If I remember correctly, Christoph once said it as quite a hassle to get this include guard…
186 m_engine->globalObject().setProperty(QStringLiteral("dsNormal"), KTextEditor::dsNormal); 151​ m_engine->globalObject().setProperty(QStringLiteral("dsNormal"), KTextEditor::dsNormal);
Context not available.
216 m_engine->globalObject().setProperty(QStringLiteral("dsError"), KTextEditor::dsError); 181​ m_engine->globalObject().setProperty(QStringLiteral("dsError"), KTextEditor::dsError);
217 182​
218 // register scripts itself 183​ // register scripts itself
219 QScriptValue result = m_engine->evaluate(source, m_url); 184​ QJSValue result = m_engine->evaluate(source, m_url);
220 if (hasException(result, m_url)) { 185​ if (hasException(result, m_url)) {
221 return false; 186​ return false;
222 } 187​ }
223 188​
224 // AFTER SCRIPT: set the view/document objects as necessary 189​ // AFTER SCRIPT: set the view/document objects as necessary
225 m_engine->globalObject().setProperty(QStringLiteral("document"), m_engine->newQObject(m_document = new KateScriptDocument())); 190​ m_engine->globalObject().setProperty(QStringLiteral("document"), m_engine->newQObject(m_document = new KateScriptDocument(m_engine)));
226 m_engine->globalObject().setProperty(QStringLiteral("view"), m_engine->newQObject(m_view = new KateScriptView())); 191​ m_engine->globalObject().setProperty(QStringLiteral("view"), m_engine->newQObject(m_view = new KateScriptView(m_engine)));
227 192​
228 // yip yip! 193​ // yip yip!
229 m_loadSuccessful = true; 194​ m_loadSuccessful = true;
Context not available.
231 return true; 196​ return true;
232} 197​}
233 198​
234QScriptValue KateScript::evaluate(const QString& program, const FieldMap& env) 199​QJSValue KateScript::evaluate(const QString& program, const FieldMap& env)
235{ 200​{
236 if ( !load() ) { 201​ if ( !load() ) {
237 qWarning() << "load of script failed:" << program; 202​ qWarning() << "load of script failed:" << program;
238 return QScriptValue(); 203​ return QJSValue();
239 } 204​ }
240 205​
241 // set up stuff in a new context, to not pollute the global stuff 206​ // Wrap the arguments in a function to avoid poluting the global object
242 auto context = m_engine->pushContext(); 207​ QString programWithContext = QStringLiteral("function(") +
208​ QStringList(env.keys()).join(QLatin1Char(',')) +
209​ QStringLiteral(") { return ") +
210​ program +
211​ QStringLiteral("}");
212​ QJSValue programFunction = m_engine->evaluate(programWithContext);
213​ Q_ASSERT(programFunction.isCallable());
243 214​
244 auto obj = context->activationObject(); 215​ QJSValueList args;
245 for ( auto it = env.begin(); it != env.end(); it++ ) { 216​ for ( auto it = env.begin(); it != env.end(); it++ ) {
246 obj.setProperty(it.key(), *it); 217​ args << it.value();
247 } 218​ }
248 auto result = m_engine->evaluate(program); ​
249 219​
250 m_engine->popContext(); 220​ QJSValue result = programFunction.call(args);
221​ if (result.isError())
222​ qWarning() << "Error evaluating script: " << result.toString();
223​
251 return result; 224​ return result;
252} 225​}
253 226​
254bool KateScript::hasException(const QScriptValue &object, const QString &file) 227​bool KateScript::hasException(const QJSValue &object, const QString &file)
255{ 228​{
256 if (m_engine->hasUncaughtException()) { 229​ if (object.isError()) {
257 displayBacktrace(object, i18n("Error loading script %1\n", file)); 230​ displayBacktrace(object, i18n("Error loading script %1\n", file));
258 m_errorMessage = i18n("Error loading script %1", file); 231​ m_errorMessage = i18n("Error loading script %1", file);
259 delete m_engine; 232​ delete m_engine;
Context not available.
284{ 257​{
285 return m_generalHeader; 258​ return m_generalHeader;
286} 259​}
287 ​
Context not available.