Files
@ r12768:980ae0491352
Branch filter:
Location: cpp/openttd-patchpack/source/src/ai/api/squirrel_export.awk
r12768:980ae0491352
14.1 KiB
application/x-awk
(svn r17248) -Fix: add GPL license notice where appropriate
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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 | # $Id$
# This file is part of OpenTTD.
# OpenTTD 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, version 2.
# OpenTTD 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 OpenTTD. If not, see <http://www.gnu.org/licenses/>.
#
# Awk script to automatically generate the code needed
# to export the AI API to Squirrel.
#
# Note that arrays are 1 based...
#
# Simple insertion sort.
function array_sort(ARRAY, ELEMENTS, temp, i, j) {
for (i = 2; i <= ELEMENTS; i++)
for (j = i; ARRAY[j - 1] > ARRAY[j]; --j) {
temp = ARRAY[j]
ARRAY[j] = ARRAY[j - 1]
ARRAY[j - 1] = temp
}
return
}
function dump_class_templates(name) {
print " template <> " name " *GetParam(ForceType<" name " *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (" name " *)instance; }"
print " template <> " name " &GetParam(ForceType<" name " &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(" name " *)instance; }"
print " template <> const " name " *GetParam(ForceType<const " name " *>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return (" name " *)instance; }"
print " template <> const " name " &GetParam(ForceType<const " name " &>, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQUserPointer instance; sq_getinstanceup(vm, index, &instance, 0); return *(" name " *)instance; }"
if (name == "AIEvent") {
print " template <> int Return<" name " *>(HSQUIRRELVM vm, " name " *res) { if (res == NULL) { sq_pushnull(vm); return 1; } Squirrel::CreateClassInstanceVM(vm, \"" name "\", res, NULL, DefSQDestructorCallback<" name ">); return 1; }"
} else {
print " template <> int Return<" name " *>(HSQUIRRELVM vm, " name " *res) { if (res == NULL) { sq_pushnull(vm); return 1; } res->AddRef(); Squirrel::CreateClassInstanceVM(vm, \"" name "\", res, NULL, DefSQDestructorCallback<" name ">); return 1; }"
}
}
BEGIN {
enum_size = 0
enum_value_size = 0
enum_string_to_error_size = 0
enum_error_to_string_size = 0
const_size = 0
struct_size = 0
method_size = 0
static_method_size = 0
virtual_class = "false"
super_cls = ""
cls = ""
start_squirrel_define_on_next_line = "false"
cls_level = 0
RS = "\r|\n"
}
/@file/ {
# Break it in two lines, so SVN doesn't replace it
printf "/* $I"
print "d$ */"
print ""
print "/*"
print " * This file is part of OpenTTD."
print " * OpenTTD 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, version 2."
print " * OpenTTD 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."
print " * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>."
print " */"
print ""
print "/* THIS FILE IS AUTO-GENERATED; PLEASE DO NOT ALTER MANUALLY */"
print ""
print "#include \"" $3 "\""
}
# Remove the old squirrel stuff
/#ifdef DEFINE_SQUIRREL_CLASS/ { squirrel_stuff = "true"; next; }
/^#endif \/\* DEFINE_SQUIRREL_CLASS \*\// { if (squirrel_stuff == "true") { squirrel_stuff = "false"; next; } }
{ if (squirrel_stuff == "true") next; }
# Ignore forward declarations of classes
/^( *)class(.*);/ { next; }
# We only want to have public functions exported for now
/^( *)class/ {
if (cls_level == 0) {
public = "false"
cls_param[0] = ""
cls_param[1] = 1
cls_param[2] = "x"
cls = $2
if (match($4, "public") || match($4, "protected") || match($4, "private")) {
super_cls = $5
} else {
super_cls = $4
}
} else if (cls_level == 1) {
struct_size++
structs[struct_size] = cls "::" $2
}
cls_level++
next
}
/^( *)public/ { if (cls_level == 1) public = "true"; next; }
/^( *)protected/ { if (cls_level == 1) public = "false"; next; }
/^( *)private/ { if (cls_level == 1) public = "false"; next; }
# Ignore special doxygen blocks
/^#ifndef DOXYGEN_SKIP/ { doxygen_skip = "next"; next; }
/^#ifdef DOXYGEN_SKIP/ { doxygen_skip = "true"; next; }
/^#endif \/\* DOXYGEN_SKIP \*\// { doxygen_skip = "false"; next; }
/^#else/ {
if (doxygen_skip == "next") {
doxygen_skip = "true";
} else {
doxygen_skip = "false";
}
next;
}
{ if (doxygen_skip == "true") next }
# Ignore functions that shouldn't be exported to squirrel
/^#ifndef EXPORT_SKIP/ { export_skip = "true"; next; }
/^#endif \/\* EXPORT_SKIP \*\// { export_skip = "false"; next; }
{ if (export_skip == "true") next }
# Ignore the comments
/^#/ { next; }
/\/\*.*\*\// { comment = "false"; next; }
/\/\*/ { comment = "true"; next; }
/\*\// { comment = "false"; next; }
{ if (comment == "true") next }
# We need to make specialized conversions for structs
/^( *)struct/ {
cls_level++
if (public == "false") next
if (cls_level != 1) next
struct_size++
structs[struct_size] = cls "::" $2
next
}
# We need to make specialized conversions for enums
/^( *)enum/ {
cls_level++
if (public == "false") next;
in_enum = "true"
enum_size++
enums[enum_size] = cls "::" $2
next
}
# Maybe the end of the class, if so we can start with the Squirrel export pretty soon
/};/ {
cls_level--
if (cls_level != 0) {
in_enum = "false";
next;
}
if (cls == "") {
next;
}
start_squirrel_define_on_next_line = "true"
next;
}
# Empty/white lines. When we may do the Squirrel export, do that export.
/^([ ]*)$/ {
if (start_squirrel_define_on_next_line == "false") next
spaces = " ";
public = "false"
namespace_opened = "false"
print ""
# First check whether we have enums to print
if (enum_size != 0) {
if (namespace_opened == "false") {
print "namespace SQConvert {"
namespace_opened = "true"
}
print " /* Allow enums to be used as Squirrel parameters */"
for (i = 1; i <= enum_size; i++) {
print " template <> " enums[i] " GetParam(ForceType<" enums[i] ">, HSQUIRRELVM vm, int index, SQAutoFreePointers *ptr) { SQInteger tmp; sq_getinteger(vm, index, &tmp); return (" enums[i] ")tmp; }"
print " template <> int Return<" enums[i] ">(HSQUIRRELVM vm, " enums[i] " res) { sq_pushinteger(vm, (int32)res); return 1; }"
delete enums[i]
}
}
# Then check whether we have structs/classes to print
if (struct_size != 0) {
if (namespace_opened == "false") {
print "namespace SQConvert {"
namespace_opened = "true"
}
print " /* Allow inner classes/structs to be used as Squirrel parameters */"
for (i = 1; i <= struct_size; i++) {
dump_class_templates(structs[i])
delete structs[i]
}
}
if (namespace_opened == "false") {
print "namespace SQConvert {"
namespace_opened = "true"
} else {
print ""
}
print " /* Allow " cls " to be used as Squirrel parameter */"
dump_class_templates(cls)
print "}; // namespace SQConvert"
print "";
# Then do the registration functions of the class. */
print "void SQ" cls "_Register(Squirrel *engine) {"
print " DefSQClass <" cls "> SQ" cls "(\"" cls "\");"
if (super_cls == "AIObject" || super_cls == "AIAbstractList::Valuator") {
print " SQ" cls ".PreRegister(engine);"
} else {
print " SQ" cls ".PreRegister(engine, \"" super_cls "\");"
}
if (virtual_class == "false" && super_cls != "AIEvent") {
print " SQ" cls ".AddConstructor<void (" cls "::*)(" cls_param[0] "), " cls_param[1]">(engine, \"" cls_param[2] "\");"
}
print ""
# Enum values
mlen = 0
for (i = 1; i <= enum_value_size; i++) {
if (mlen <= length(enum_value[i])) mlen = length(enum_value[i])
}
for (i = 1; i <= enum_value_size; i++) {
print " SQ" cls ".DefSQConst(engine, " cls "::" enum_value[i] ", " substr(spaces, 1, mlen - length(enum_value[i])) "\"" enum_value[i] "\");"
delete enum_value[i]
}
if (enum_value_size != 0) print ""
# Const values
mlen = 0
for (i = 1; i <= const_size; i++) {
if (mlen <= length(const_value[i])) mlen = length(const_value[i])
}
for (i = 1; i <= const_size; i++) {
print " SQ" cls ".DefSQConst(engine, " cls "::" const_value[i] ", " substr(spaces, 1, mlen - length(const_value[i])) "\"" const_value[i] "\");"
delete const_value[i]
}
if (const_size != 0) print ""
# Mapping of OTTD strings to errors
mlen = 0
for (i = 1; i <= enum_string_to_error_size; i++) {
if (mlen <= length(enum_string_to_error_mapping_string[i])) mlen = length(enum_string_to_error_mapping_string[i])
}
for (i = 1; i <= enum_string_to_error_size; i++) {
print " AIError::RegisterErrorMap(" enum_string_to_error_mapping_string[i] ", " substr(spaces, 1, mlen - length(enum_string_to_error_mapping_string[i])) cls "::" enum_string_to_error_mapping_error[i] ");"
delete enum_string_to_error_mapping_string[i]
}
if (enum_string_to_error_size != 0) print ""
# Mapping of errors to human 'readable' strings.
mlen = 0
for (i = 1; i <= enum_error_to_string_size; i++) {
if (mlen <= length(enum_error_to_string_mapping[i])) mlen = length(enum_error_to_string_mapping[i])
}
for (i = 1; i <= enum_error_to_string_size; i++) {
print " AIError::RegisterErrorMapString(" cls "::" enum_error_to_string_mapping[i] ", " substr(spaces, 1, mlen - length(enum_error_to_string_mapping[i])) "\"" enum_error_to_string_mapping[i] "\");"
delete enum_error_to_string_mapping[i]
}
if (enum_error_to_string_size != 0) print ""
# Static methods
mlen = 0
for (i = 1; i <= static_method_size; i++) {
if (mlen <= length(static_methods[i, 0])) mlen = length(static_methods[i, 0])
}
for (i = 1; i <= static_method_size; i++) {
print " SQ" cls ".DefSQStaticMethod(engine, &" cls "::" static_methods[i, 0] ", " substr(spaces, 1, mlen - length(static_methods[i, 0])) "\"" static_methods[i, 0] "\", " substr(spaces, 1, mlen - length(static_methods[i, 0])) "" static_methods[i, 1] ", \"" static_methods[i, 2] "\");"
delete static_methods[i]
}
if (static_method_size != 0) print ""
if (virtual_class == "false") {
# Non-static methods
mlen = 0
for (i = 1; i <= method_size; i++) {
if (mlen <= length(methods[i, 0])) mlen = length(methods[i, 0])
}
for (i = 1; i <= method_size; i++) {
if (methods[i, 2] == "v") {
print " SQ" cls ".DefSQAdvancedMethod(engine, &" cls "::" methods[i, 0] ", " substr(spaces, 1, mlen - length(methods[i, 0]) - 8) "\"" methods[i, 0] "\");"
} else {
print " SQ" cls ".DefSQMethod(engine, &" cls "::" methods[i, 0] ", " substr(spaces, 1, mlen - length(methods[i, 0])) "\"" methods[i, 0] "\", " substr(spaces, 1, mlen - length(methods[i, 0])) "" methods[i, 1] ", \"" methods[i, 2] "\");"
}
delete methods[i]
}
if (method_size != 0) print ""
}
print " SQ" cls ".PostRegister(engine);"
print "}"
enum_size = 0
enum_value_size = 0
enum_string_to_error_size = 0
enum_error_to_string_size = 0
struct_size = 0
method_size = 0
static_method_size = 0
virtual_class = "false"
cls = ""
start_squirrel_define_on_next_line = "false"
cls_level = 0
}
# Skip non-public functions
{ if (public == "false") next }
# Add enums
{
if (in_enum == "true") {
enum_value_size++
sub(",", "", $1)
enum_value[enum_value_size] = $1
# Check if this a special error enum
if (match(enums[enum_size], ".*::ErrorMessages") != 0) {
# syntax:
# enum ErrorMessages {
# ERR_SOME_ERROR, // [STR_ITEM1, STR_ITEM2, ...]
# }
# Set the mappings
if (match($0, "\\[.*\\]") != 0) {
mappings = substr($0, RSTART, RLENGTH);
gsub("([\\[[:space:]\\]])", "", mappings);
split(mappings, mapitems, ",");
for (i = 1; i <= length(mapitems); i++) {
enum_string_to_error_size++
enum_string_to_error_mapping_string[enum_string_to_error_size] = mapitems[i]
enum_string_to_error_mapping_error[enum_string_to_error_size] = $1
}
enum_error_to_string_size++
enum_error_to_string_mapping[enum_error_to_string_size] = $1
}
}
next
}
}
# Add a const (non-enum) value
/^[ ]*static const \w+ \w+ = \w+;/ {
const_size++
const_value[const_size] = $4
next
}
# Add a method to the list
/^.*\(.*\).*$/ {
if (cls_level != 1) next
if (match($0, "~")) next
is_static = match($0, "static")
if (match($0, "virtual")) {
virtual_class = "true"
}
gsub("virtual", "", $0)
gsub("static", "", $0)
gsub("const", "", $0)
gsub("{.*", "", $0)
param_s = $0
gsub("\\*", "", $0)
gsub("\\(.*", "", $0)
sub(".*\\(", "", param_s)
sub("\\).*", "", param_s)
funcname = $2
if ($1 == cls && funcname == "") {
cls_param[0] = param_s
if (param_s == "") next
} else if (funcname == "") next
split(param_s, params, ",")
if (is_static) {
types = "."
} else {
types = "x"
}
for (len = 1; params[len] != ""; len++) {
sub("^[ ]*", "", params[len])
if (match(params[len], "\\*") || match(params[len], "&")) {
if (match(params[len], "^char")) {
types = types "."
} else if (match(params[len], "^void")) {
types = types "p"
} else if (match(params[len], "^Array")) {
types = types "a"
} else if (match(params[len], "^struct Array")) {
types = types "a"
} else {
types = types "x"
}
} else if (match(params[len], "^bool")) {
types = types "b"
} else if (match(params[len], "^HSQUIRRELVM")) {
types = "v"
} else {
types = types "i"
}
}
if ($1 == cls && funcname == "") {
cls_param[1] = len;
cls_param[2] = types;
} else if (substr(funcname, 0, 1) == "_" && types != "v") {
} else if (funcname == "GetClassName" && types == ".") {
} else if (is_static) {
static_method_size++
static_methods[static_method_size, 0] = funcname
static_methods[static_method_size, 1] = len
static_methods[static_method_size, 2] = types
} else {
method_size++
methods[method_size, 0] = funcname
methods[method_size, 1] = len
methods[method_size, 2] = types
}
next
}
|