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
|
/*
This is part of TeXworks, an environment for working with TeX documents
Copyright (C) 2010-2023 Jonathan Kew, Stefan Löffler, Charlie Sharpsteen
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
For links to further information, or to contact the authors,
see <http://www.tug.org/texworks/>.
*/
#ifndef LuaScript_H
#define LuaScript_H
#include "LuaScriptInterface.h"
#include "scripting/Script.h"
#include "scripting/ScriptAPIInterface.h"
#include <QCoreApplication>
#include <QMetaMethod>
#include <QMetaProperty>
#include <QVariant>
namespace Tw {
namespace Scripting {
/** \brief Class for handling lua scripts */
class LuaScript : public Script
{
Q_INTERFACES(Tw::Scripting::Script)
Q_DECLARE_TR_FUNCTIONS(Tw::Scripting::ECMAScript)
public:
/** \brief Constructor
*
* Initializes m_LuaPlugin
* \param lua pointer to the plugin that holds the lua state to operate on
*/
LuaScript(LuaScriptInterface * lua, const QString& fileName) : Script(lua, fileName), m_LuaPlugin(lua) { }
/** \brief Parse the script header
*
* \return \c true if successful, \c false if not (e.g. because the file
* is no valid Tw lua script)
*/
bool parseHeader() override { return doParseHeader(QString::fromLatin1("--[["), QString::fromLatin1("]]"), QString()); }
protected:
/** \brief Run the lua script
*
* \param tw the TW interface object, exposed to the script as the TW global
*
* \return \c true on success, \c false if an error occurred
*/
bool execute(ScriptAPIInterface *tw) const override;
/** \brief Convenience function to wrap a QObject and push it onto the stack
*
* \param L the lua state to operate on
* \param obj the QObject to expose to python
* \param throwError currently unused
* \return the number of values pushed onto the stack; 1 on success, 0 on
* failure
*/
static int pushQObject(lua_State * L, QObject * obj, const bool throwError = true);
/** \brief Convenience function to convert a QVariant and push it onto the stack
*
* \note QList will be converted to lua tables with numeric, one-based
* indices.
* \param L the lua state to operate on
* \param v the QVariant to convert and push
* \param throwError if \c true, luaL_error is used to report errors;
* this should only be used in protected mode (i.e. from inside
* the lua engine, as it could cause Tw to crash otherwise)
* \return the number of values pushed onto the stack; 1 on success, 0 on
* failure
*/
static int pushVariant(lua_State * L, const QVariant & v, const bool throwError = true);
/** \brief Convenience function to convert a stack value to a QVariant
*
* \note Tables with only numeric, consecutive, one-based indices will be
* converted to QList. If the value can't be converted, an error is
* raised and an empty QVariant is returned.
* \param L the lua state to operate on
* \param idx the index of the value on the stack (may be negative)
* \param throwError if \c true, luaL_error is used to report errors;
* this should only be used in protected mode (i.e. from inside
* the lua engine, as it could cause Tw to crash otherwise)
* \return the QVariant
*/
static QVariant getLuaStackValue(lua_State * L, int idx, const bool throwError = true);
/** \brief Handler for property requests on QObjects
*
* On success, the value of the property is pushed onto the stack
* \note The QObject* must be supplied as first upvalue.
* \param L the lua state to operate on
* \return the number of values pushed onto the stack; 1 on success, 0 on
* failure
*/
static int getProperty(lua_State * L);
/** \brief Handler for setting attribute values on QObjects
*
* \note The QObject* must be supplied as first upvalue.
* \param L the lua state to operate on
* \return 0 (the number of values pushed onto the stack)
*/
static int setProperty(lua_State * L);
/** \brief Handler for calling methods of QObjects
*
* \note The QObject* must be supplied as first upvalue and the method
* name as second upvalue.
* \note For void methods, nil is pushed onto the stack
* \param L the lua state to operate on
* \return the number of values pushed onto the stack; 1 on success, 0 on
* failure
*/
static int callMethod(lua_State * L);
LuaScriptInterface * m_LuaPlugin; ///< pointer to the lua plugin holding the lua state
};
} // namespace Scripting
} // namespace Tw
#endif // !defined(LuaScript_H)
|
