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
|
<?php
/**
* Basic services that Lua libraries will probably need
*
* 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, write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
* http://www.gnu.org/copyleft/gpl.html
*
* @file
* @author Brad Jorsch
*/
/**
* This class provides some basic services that Lua libraries will probably need
*/
// @codingStandardsIgnoreLine Squiz.Classes.ValidClassName.NotCamelCaps
abstract class Scribunto_LuaLibraryBase {
/**
* @var Scribunto_LuaEngine
*/
private $engine;
/**
* @param Scribunto_LuaEngine $engine
*/
function __construct( Scribunto_LuaEngine $engine ) {
$this->engine = $engine;
}
/**
* Called to register the library.
*
* This should do any necessary setup and then call $this->getEngine()->registerInterface().
* The value returned by that call should be returned from this function,
* and must be for 'deferLoad' libraries to work right.
*
* @return array Lua package
*/
abstract function register();
/**
* Get the engine
*
* @return Scribunto_LuaEngine engine
*/
protected function getEngine() {
return $this->engine;
}
/**
* Get the interpreter
*
* @return Scribunto_LuaInterpreter interpreter
*/
protected function getInterpreter() {
return $this->engine->getInterpreter();
}
/**
* Get the parser
*
* @return Parser parser
*/
protected function getParser() {
return $this->engine->getParser();
}
/**
* Get the title
*
* @return Title title
*/
protected function getTitle() {
return $this->getEngine()->getTitle();
}
/**
* Get the parser options
*
* @return ParserOptions parser options
*/
protected function getParserOptions() {
return $this->engine->getParser()->getOptions();
}
/**
* Get the Lua type corresponding to the type of the variable.
*
* If the variable does not correspond to any type, the PHP type will be
* returned (prefixed with "PHP"). For example, "PHP resource" or "PHP
* object of class Foo".
*
* @param mixed $var Variable to test
* @return string Type
*/
protected function getLuaType( $var ) {
static $luaTypes = [
'NULL' => 'nil',
'double' => 'number',
'integer' => 'number',
'string' => 'string',
'boolean' => 'boolean',
'array' => 'table',
];
$type = gettype( $var );
if ( isset( $luaTypes[$type] ) ) {
return $luaTypes[$type];
} elseif ( $this->getInterpreter()->isLuaFunction( $var ) ) {
return 'function';
} else {
$type = "PHP $type";
if ( is_object( $var ) ) {
$type .= " of class " . get_class( $var );
}
return $type;
}
}
/**
* Check the type of a variable
*
* If the type of the variable does not match the expected type,
* a Scribunto_LuaError will be thrown.
*
* @param string $name Name of the calling function (as seen from Lua)
* @param int $argIdx Index of the argument being tested (1-based)
* @param mixed $arg Variable to test
* @param string $expectType Lua type expected
* @return void
*/
protected function checkType( $name, $argIdx, $arg, $expectType ) {
$type = $this->getLuaType( $arg );
if ( $type !== $expectType ) {
throw new Scribunto_LuaError(
"bad argument #$argIdx to '$name' ($expectType expected, got $type)"
);
}
}
/**
* Check the type of a variable, with default if null
*
* If the variable is null, $default will be assigned. Otherwise, if the
* type of the variable does not match the expected type, a
* Scribunto_LuaError will be thrown.
*
* @param string $name Name of the calling function (as seen from Lua)
* @param int $argIdx Index of the argument being tested (1-based)
* @param mixed &$arg Variable to test/set
* @param string $expectType Lua type expected
* @param mixed $default Default value
* @return void
*/
protected function checkTypeOptional( $name, $argIdx, &$arg, $expectType, $default ) {
if ( $arg === null ) {
$arg = $default;
} else {
$this->checkType( $name, $argIdx, $arg, $expectType );
}
}
/**
* Increment the expensive function count, and throw if limit exceeded
*
* @return null
*/
public function incrementExpensiveFunctionCount() {
return $this->getEngine()->incrementExpensiveFunctionCount();
}
}
|
