gdscript_utility_functions.cpp 28 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734
  1. /*************************************************************************/
  2. /* gdscript_utility_functions.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "gdscript_utility_functions.h"
  31. #include "core/io/resource_loader.h"
  32. #include "core/object/class_db.h"
  33. #include "core/object/method_bind.h"
  34. #include "core/object/object.h"
  35. #include "core/templates/oa_hash_map.h"
  36. #include "core/templates/vector.h"
  37. #include "core/variant/typed_array.h"
  38. #include "gdscript.h"
  39. #ifdef DEBUG_ENABLED
  40. #define VALIDATE_ARG_COUNT(m_count) \
  41. if (p_arg_count < m_count) { \
  42. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS; \
  43. r_error.argument = m_count; \
  44. r_error.expected = m_count; \
  45. *r_ret = Variant(); \
  46. return; \
  47. } \
  48. if (p_arg_count > m_count) { \
  49. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS; \
  50. r_error.argument = m_count; \
  51. r_error.expected = m_count; \
  52. *r_ret = Variant(); \
  53. return; \
  54. }
  55. #define VALIDATE_ARG_INT(m_arg) \
  56. if (p_args[m_arg]->get_type() != Variant::INT) { \
  57. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT; \
  58. r_error.argument = m_arg; \
  59. r_error.expected = Variant::INT; \
  60. *r_ret = Variant(); \
  61. return; \
  62. }
  63. #define VALIDATE_ARG_NUM(m_arg) \
  64. if (!p_args[m_arg]->is_num()) { \
  65. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT; \
  66. r_error.argument = m_arg; \
  67. r_error.expected = Variant::FLOAT; \
  68. *r_ret = Variant(); \
  69. return; \
  70. }
  71. #else
  72. #define VALIDATE_ARG_COUNT(m_count)
  73. #define VALIDATE_ARG_INT(m_arg)
  74. #define VALIDATE_ARG_NUM(m_arg)
  75. #endif
  76. struct GDScriptUtilityFunctionsDefinitions {
  77. static inline void convert(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  78. VALIDATE_ARG_COUNT(2);
  79. VALIDATE_ARG_INT(1);
  80. int type = *p_args[1];
  81. if (type < 0 || type >= Variant::VARIANT_MAX) {
  82. *r_ret = RTR("Invalid type argument to convert(), use TYPE_* constants.");
  83. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  84. r_error.argument = 0;
  85. r_error.expected = Variant::INT;
  86. return;
  87. } else {
  88. Variant::construct(Variant::Type(type), *r_ret, p_args, 1, r_error);
  89. }
  90. }
  91. static inline void type_exists(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  92. VALIDATE_ARG_COUNT(1);
  93. *r_ret = ClassDB::class_exists(*p_args[0]);
  94. }
  95. static inline void _char(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  96. VALIDATE_ARG_COUNT(1);
  97. VALIDATE_ARG_INT(0);
  98. char32_t result[2] = { *p_args[0], 0 };
  99. *r_ret = String(result);
  100. }
  101. static inline void str(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  102. if (p_arg_count < 1) {
  103. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  104. r_error.argument = 1;
  105. r_error.expected = 1;
  106. *r_ret = Variant();
  107. return;
  108. }
  109. String str;
  110. for (int i = 0; i < p_arg_count; i++) {
  111. String os = p_args[i]->operator String();
  112. if (i == 0) {
  113. str = os;
  114. } else {
  115. str += os;
  116. }
  117. }
  118. *r_ret = str;
  119. }
  120. static inline void range(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  121. switch (p_arg_count) {
  122. case 0: {
  123. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  124. r_error.argument = 1;
  125. r_error.expected = 1;
  126. *r_ret = Variant();
  127. } break;
  128. case 1: {
  129. VALIDATE_ARG_NUM(0);
  130. int count = *p_args[0];
  131. Array arr;
  132. if (count <= 0) {
  133. *r_ret = arr;
  134. return;
  135. }
  136. Error err = arr.resize(count);
  137. if (err != OK) {
  138. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  139. *r_ret = Variant();
  140. return;
  141. }
  142. for (int i = 0; i < count; i++) {
  143. arr[i] = i;
  144. }
  145. *r_ret = arr;
  146. } break;
  147. case 2: {
  148. VALIDATE_ARG_NUM(0);
  149. VALIDATE_ARG_NUM(1);
  150. int from = *p_args[0];
  151. int to = *p_args[1];
  152. Array arr;
  153. if (from >= to) {
  154. *r_ret = arr;
  155. return;
  156. }
  157. Error err = arr.resize(to - from);
  158. if (err != OK) {
  159. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  160. *r_ret = Variant();
  161. return;
  162. }
  163. for (int i = from; i < to; i++) {
  164. arr[i - from] = i;
  165. }
  166. *r_ret = arr;
  167. } break;
  168. case 3: {
  169. VALIDATE_ARG_NUM(0);
  170. VALIDATE_ARG_NUM(1);
  171. VALIDATE_ARG_NUM(2);
  172. int from = *p_args[0];
  173. int to = *p_args[1];
  174. int incr = *p_args[2];
  175. if (incr == 0) {
  176. *r_ret = RTR("Step argument is zero!");
  177. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  178. return;
  179. }
  180. Array arr;
  181. if (from >= to && incr > 0) {
  182. *r_ret = arr;
  183. return;
  184. }
  185. if (from <= to && incr < 0) {
  186. *r_ret = arr;
  187. return;
  188. }
  189. // Calculate how many.
  190. int count = 0;
  191. if (incr > 0) {
  192. count = ((to - from - 1) / incr) + 1;
  193. } else {
  194. count = ((from - to - 1) / -incr) + 1;
  195. }
  196. Error err = arr.resize(count);
  197. if (err != OK) {
  198. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  199. *r_ret = Variant();
  200. return;
  201. }
  202. if (incr > 0) {
  203. int idx = 0;
  204. for (int i = from; i < to; i += incr) {
  205. arr[idx++] = i;
  206. }
  207. } else {
  208. int idx = 0;
  209. for (int i = from; i > to; i += incr) {
  210. arr[idx++] = i;
  211. }
  212. }
  213. *r_ret = arr;
  214. } break;
  215. default: {
  216. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  217. r_error.argument = 3;
  218. r_error.expected = 3;
  219. *r_ret = Variant();
  220. } break;
  221. }
  222. }
  223. static inline void load(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  224. VALIDATE_ARG_COUNT(1);
  225. if (p_args[0]->get_type() != Variant::STRING) {
  226. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  227. r_error.argument = 0;
  228. r_error.expected = Variant::STRING;
  229. *r_ret = Variant();
  230. } else {
  231. *r_ret = ResourceLoader::load(*p_args[0]);
  232. }
  233. }
  234. static inline void inst_to_dict(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  235. VALIDATE_ARG_COUNT(1);
  236. if (p_args[0]->get_type() == Variant::NIL) {
  237. *r_ret = Variant();
  238. } else if (p_args[0]->get_type() != Variant::OBJECT) {
  239. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  240. r_error.argument = 0;
  241. *r_ret = Variant();
  242. } else {
  243. Object *obj = *p_args[0];
  244. if (!obj) {
  245. *r_ret = Variant();
  246. } else if (!obj->get_script_instance() || obj->get_script_instance()->get_language() != GDScriptLanguage::get_singleton()) {
  247. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  248. r_error.argument = 0;
  249. r_error.expected = Variant::DICTIONARY;
  250. *r_ret = RTR("Not a script with an instance");
  251. return;
  252. } else {
  253. GDScriptInstance *ins = static_cast<GDScriptInstance *>(obj->get_script_instance());
  254. Ref<GDScript> base = ins->get_script();
  255. if (base.is_null()) {
  256. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  257. r_error.argument = 0;
  258. r_error.expected = Variant::DICTIONARY;
  259. *r_ret = RTR("Not based on a script");
  260. return;
  261. }
  262. GDScript *p = base.ptr();
  263. String path = p->get_script_path();
  264. Vector<StringName> sname;
  265. while (p->_owner) {
  266. sname.push_back(p->name);
  267. p = p->_owner;
  268. }
  269. sname.reverse();
  270. if (!path.is_resource_file()) {
  271. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  272. r_error.argument = 0;
  273. r_error.expected = Variant::DICTIONARY;
  274. *r_ret = Variant();
  275. *r_ret = RTR("Not based on a resource file");
  276. return;
  277. }
  278. NodePath cp(sname, Vector<StringName>(), false);
  279. Dictionary d;
  280. d["@subpath"] = cp;
  281. d["@path"] = path;
  282. for (const KeyValue<StringName, GDScript::MemberInfo> &E : base->member_indices) {
  283. if (!d.has(E.key)) {
  284. d[E.key] = ins->members[E.value.index];
  285. }
  286. }
  287. *r_ret = d;
  288. }
  289. }
  290. }
  291. static inline void dict_to_inst(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  292. VALIDATE_ARG_COUNT(1);
  293. if (p_args[0]->get_type() != Variant::DICTIONARY) {
  294. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  295. r_error.argument = 0;
  296. r_error.expected = Variant::DICTIONARY;
  297. *r_ret = Variant();
  298. return;
  299. }
  300. Dictionary d = *p_args[0];
  301. if (!d.has("@path")) {
  302. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  303. r_error.argument = 0;
  304. r_error.expected = Variant::OBJECT;
  305. *r_ret = RTR("Invalid instance dictionary format (missing @path)");
  306. return;
  307. }
  308. Ref<Script> scr = ResourceLoader::load(d["@path"]);
  309. if (!scr.is_valid()) {
  310. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  311. r_error.argument = 0;
  312. r_error.expected = Variant::OBJECT;
  313. *r_ret = RTR("Invalid instance dictionary format (can't load script at @path)");
  314. return;
  315. }
  316. Ref<GDScript> gdscr = scr;
  317. if (!gdscr.is_valid()) {
  318. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  319. r_error.argument = 0;
  320. r_error.expected = Variant::OBJECT;
  321. *r_ret = Variant();
  322. *r_ret = RTR("Invalid instance dictionary format (invalid script at @path)");
  323. return;
  324. }
  325. NodePath sub;
  326. if (d.has("@subpath")) {
  327. sub = d["@subpath"];
  328. }
  329. for (int i = 0; i < sub.get_name_count(); i++) {
  330. gdscr = gdscr->subclasses[sub.get_name(i)];
  331. if (!gdscr.is_valid()) {
  332. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  333. r_error.argument = 0;
  334. r_error.expected = Variant::OBJECT;
  335. *r_ret = Variant();
  336. *r_ret = RTR("Invalid instance dictionary (invalid subclasses)");
  337. return;
  338. }
  339. }
  340. *r_ret = gdscr->_new(nullptr, -1 /*skip initializer*/, r_error);
  341. if (r_error.error != Callable::CallError::CALL_OK) {
  342. *r_ret = Variant();
  343. return;
  344. }
  345. GDScriptInstance *ins = static_cast<GDScriptInstance *>(static_cast<Object *>(*r_ret)->get_script_instance());
  346. Ref<GDScript> gd_ref = ins->get_script();
  347. for (KeyValue<StringName, GDScript::MemberInfo> &E : gd_ref->member_indices) {
  348. if (d.has(E.key)) {
  349. ins->members.write[E.value.index] = d[E.key];
  350. }
  351. }
  352. }
  353. static inline void Color8(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  354. if (p_arg_count < 3) {
  355. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  356. r_error.argument = 3;
  357. *r_ret = Variant();
  358. return;
  359. }
  360. if (p_arg_count > 4) {
  361. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  362. r_error.argument = 4;
  363. *r_ret = Variant();
  364. return;
  365. }
  366. VALIDATE_ARG_INT(0);
  367. VALIDATE_ARG_INT(1);
  368. VALIDATE_ARG_INT(2);
  369. Color color((int64_t)*p_args[0] / 255.0f, (int64_t)*p_args[1] / 255.0f, (int64_t)*p_args[2] / 255.0f);
  370. if (p_arg_count == 4) {
  371. VALIDATE_ARG_INT(3);
  372. color.a = (int64_t)*p_args[3] / 255.0f;
  373. }
  374. *r_ret = color;
  375. }
  376. static inline void print_debug(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  377. String s;
  378. for (int i = 0; i < p_arg_count; i++) {
  379. s += p_args[i]->operator String();
  380. }
  381. if (Thread::get_caller_id() == Thread::get_main_id()) {
  382. ScriptLanguage *script = GDScriptLanguage::get_singleton();
  383. if (script->debug_get_stack_level_count() > 0) {
  384. s += "\n At: " + script->debug_get_stack_level_source(0) + ":" + itos(script->debug_get_stack_level_line(0)) + ":" + script->debug_get_stack_level_function(0) + "()";
  385. }
  386. } else {
  387. s += "\n At: Cannot retrieve debug info outside the main thread. Thread ID: " + itos(Thread::get_caller_id());
  388. }
  389. print_line(s);
  390. *r_ret = Variant();
  391. }
  392. static inline void print_stack(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  393. VALIDATE_ARG_COUNT(0);
  394. if (Thread::get_caller_id() != Thread::get_main_id()) {
  395. print_line("Cannot retrieve debug info outside the main thread. Thread ID: " + itos(Thread::get_caller_id()));
  396. return;
  397. }
  398. ScriptLanguage *script = GDScriptLanguage::get_singleton();
  399. for (int i = 0; i < script->debug_get_stack_level_count(); i++) {
  400. print_line("Frame " + itos(i) + " - " + script->debug_get_stack_level_source(i) + ":" + itos(script->debug_get_stack_level_line(i)) + " in function '" + script->debug_get_stack_level_function(i) + "'");
  401. };
  402. *r_ret = Variant();
  403. }
  404. static inline void get_stack(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  405. VALIDATE_ARG_COUNT(0);
  406. if (Thread::get_caller_id() != Thread::get_main_id()) {
  407. *r_ret = TypedArray<Dictionary>();
  408. return;
  409. }
  410. ScriptLanguage *script = GDScriptLanguage::get_singleton();
  411. TypedArray<Dictionary> ret;
  412. for (int i = 0; i < script->debug_get_stack_level_count(); i++) {
  413. Dictionary frame;
  414. frame["source"] = script->debug_get_stack_level_source(i);
  415. frame["function"] = script->debug_get_stack_level_function(i);
  416. frame["line"] = script->debug_get_stack_level_line(i);
  417. ret.push_back(frame);
  418. };
  419. *r_ret = ret;
  420. }
  421. static inline void len(Variant *r_ret, const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  422. VALIDATE_ARG_COUNT(1);
  423. switch (p_args[0]->get_type()) {
  424. case Variant::STRING: {
  425. String d = *p_args[0];
  426. *r_ret = d.length();
  427. } break;
  428. case Variant::DICTIONARY: {
  429. Dictionary d = *p_args[0];
  430. *r_ret = d.size();
  431. } break;
  432. case Variant::ARRAY: {
  433. Array d = *p_args[0];
  434. *r_ret = d.size();
  435. } break;
  436. case Variant::PACKED_BYTE_ARRAY: {
  437. Vector<uint8_t> d = *p_args[0];
  438. *r_ret = d.size();
  439. } break;
  440. case Variant::PACKED_INT32_ARRAY: {
  441. Vector<int32_t> d = *p_args[0];
  442. *r_ret = d.size();
  443. } break;
  444. case Variant::PACKED_INT64_ARRAY: {
  445. Vector<int64_t> d = *p_args[0];
  446. *r_ret = d.size();
  447. } break;
  448. case Variant::PACKED_FLOAT32_ARRAY: {
  449. Vector<float> d = *p_args[0];
  450. *r_ret = d.size();
  451. } break;
  452. case Variant::PACKED_FLOAT64_ARRAY: {
  453. Vector<double> d = *p_args[0];
  454. *r_ret = d.size();
  455. } break;
  456. case Variant::PACKED_STRING_ARRAY: {
  457. Vector<String> d = *p_args[0];
  458. *r_ret = d.size();
  459. } break;
  460. case Variant::PACKED_VECTOR2_ARRAY: {
  461. Vector<Vector2> d = *p_args[0];
  462. *r_ret = d.size();
  463. } break;
  464. case Variant::PACKED_VECTOR3_ARRAY: {
  465. Vector<Vector3> d = *p_args[0];
  466. *r_ret = d.size();
  467. } break;
  468. case Variant::PACKED_COLOR_ARRAY: {
  469. Vector<Color> d = *p_args[0];
  470. *r_ret = d.size();
  471. } break;
  472. default: {
  473. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  474. r_error.argument = 0;
  475. r_error.expected = Variant::NIL;
  476. *r_ret = vformat(RTR("Value of type '%s' can't provide a length."), Variant::get_type_name(p_args[0]->get_type()));
  477. }
  478. }
  479. }
  480. };
  481. struct GDScriptUtilityFunctionInfo {
  482. GDScriptUtilityFunctions::FunctionPtr function = nullptr;
  483. MethodInfo info;
  484. bool is_constant = false;
  485. };
  486. static OAHashMap<StringName, GDScriptUtilityFunctionInfo> utility_function_table;
  487. static List<StringName> utility_function_name_table;
  488. static void _register_function(const String &p_name, const MethodInfo &p_method_info, GDScriptUtilityFunctions::FunctionPtr p_function, bool p_is_const) {
  489. StringName sname(p_name);
  490. ERR_FAIL_COND(utility_function_table.has(sname));
  491. GDScriptUtilityFunctionInfo function;
  492. function.function = p_function;
  493. function.info = p_method_info;
  494. function.is_constant = p_is_const;
  495. utility_function_table.insert(sname, function);
  496. utility_function_name_table.push_back(sname);
  497. }
  498. #define REGISTER_FUNC(m_func, m_is_const, m_return_type, ...) \
  499. { \
  500. String name(#m_func); \
  501. if (name.begins_with("_")) { \
  502. name = name.substr(1, name.length() - 1); \
  503. } \
  504. MethodInfo info = MethodInfo(name, __VA_ARGS__); \
  505. info.return_val.type = m_return_type; \
  506. _register_function(name, info, GDScriptUtilityFunctionsDefinitions::m_func, m_is_const); \
  507. }
  508. #define REGISTER_FUNC_NO_ARGS(m_func, m_is_const, m_return_type) \
  509. { \
  510. String name(#m_func); \
  511. if (name.begins_with("_")) { \
  512. name = name.substr(1, name.length() - 1); \
  513. } \
  514. MethodInfo info = MethodInfo(name); \
  515. info.return_val.type = m_return_type; \
  516. _register_function(name, info, GDScriptUtilityFunctionsDefinitions::m_func, m_is_const); \
  517. }
  518. #define REGISTER_VARARG_FUNC(m_func, m_is_const, m_return_type) \
  519. { \
  520. String name(#m_func); \
  521. if (name.begins_with("_")) { \
  522. name = name.substr(1, name.length() - 1); \
  523. } \
  524. MethodInfo info = MethodInfo(name); \
  525. info.return_val.type = m_return_type; \
  526. info.flags |= METHOD_FLAG_VARARG; \
  527. _register_function(name, info, GDScriptUtilityFunctionsDefinitions::m_func, m_is_const); \
  528. }
  529. #define REGISTER_VARIANT_FUNC(m_func, m_is_const, ...) \
  530. { \
  531. String name(#m_func); \
  532. if (name.begins_with("_")) { \
  533. name = name.substr(1, name.length() - 1); \
  534. } \
  535. MethodInfo info = MethodInfo(name, __VA_ARGS__); \
  536. info.return_val.type = Variant::NIL; \
  537. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT; \
  538. _register_function(name, info, GDScriptUtilityFunctionsDefinitions::m_func, m_is_const); \
  539. }
  540. #define REGISTER_CLASS_FUNC(m_func, m_is_const, m_return_type, ...) \
  541. { \
  542. String name(#m_func); \
  543. if (name.begins_with("_")) { \
  544. name = name.substr(1, name.length() - 1); \
  545. } \
  546. MethodInfo info = MethodInfo(name, __VA_ARGS__); \
  547. info.return_val.type = Variant::OBJECT; \
  548. info.return_val.hint = PROPERTY_HINT_RESOURCE_TYPE; \
  549. info.return_val.class_name = m_return_type; \
  550. _register_function(name, info, GDScriptUtilityFunctionsDefinitions::m_func, m_is_const); \
  551. }
  552. #define REGISTER_FUNC_DEF(m_func, m_is_const, m_default, m_return_type, ...) \
  553. { \
  554. String name(#m_func); \
  555. if (name.begins_with("_")) { \
  556. name = name.substr(1, name.length() - 1); \
  557. } \
  558. MethodInfo info = MethodInfo(name, __VA_ARGS__); \
  559. info.return_val.type = m_return_type; \
  560. info.default_arguments.push_back(m_default); \
  561. _register_function(name, info, GDScriptUtilityFunctionsDefinitions::m_func, m_is_const); \
  562. }
  563. #define ARG(m_name, m_type) \
  564. PropertyInfo(m_type, m_name)
  565. #define VARARG(m_name) \
  566. PropertyInfo(Variant::NIL, m_name, PROPERTY_HINT_NONE, "", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_NIL_IS_VARIANT)
  567. void GDScriptUtilityFunctions::register_functions() {
  568. REGISTER_VARIANT_FUNC(convert, true, VARARG("what"), ARG("type", Variant::INT));
  569. REGISTER_FUNC(type_exists, true, Variant::BOOL, ARG("type", Variant::STRING_NAME));
  570. REGISTER_FUNC(_char, true, Variant::STRING, ARG("char", Variant::INT));
  571. REGISTER_VARARG_FUNC(str, true, Variant::STRING);
  572. REGISTER_VARARG_FUNC(range, false, Variant::ARRAY);
  573. REGISTER_CLASS_FUNC(load, false, "Resource", ARG("path", Variant::STRING));
  574. REGISTER_FUNC(inst_to_dict, false, Variant::DICTIONARY, ARG("instance", Variant::OBJECT));
  575. REGISTER_FUNC(dict_to_inst, false, Variant::OBJECT, ARG("dictionary", Variant::DICTIONARY));
  576. REGISTER_FUNC_DEF(Color8, true, 255, Variant::COLOR, ARG("r8", Variant::INT), ARG("g8", Variant::INT), ARG("b8", Variant::INT), ARG("a8", Variant::INT));
  577. REGISTER_VARARG_FUNC(print_debug, false, Variant::NIL);
  578. REGISTER_FUNC_NO_ARGS(print_stack, false, Variant::NIL);
  579. REGISTER_FUNC_NO_ARGS(get_stack, false, Variant::ARRAY);
  580. REGISTER_FUNC(len, true, Variant::INT, VARARG("var"));
  581. }
  582. void GDScriptUtilityFunctions::unregister_functions() {
  583. utility_function_name_table.clear();
  584. utility_function_table.clear();
  585. }
  586. GDScriptUtilityFunctions::FunctionPtr GDScriptUtilityFunctions::get_function(const StringName &p_function) {
  587. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  588. ERR_FAIL_COND_V(!info, nullptr);
  589. return info->function;
  590. }
  591. bool GDScriptUtilityFunctions::has_function_return_value(const StringName &p_function) {
  592. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  593. ERR_FAIL_COND_V(!info, false);
  594. return info->info.return_val.type != Variant::NIL || bool(info->info.return_val.usage & PROPERTY_USAGE_NIL_IS_VARIANT);
  595. }
  596. Variant::Type GDScriptUtilityFunctions::get_function_return_type(const StringName &p_function) {
  597. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  598. ERR_FAIL_COND_V(!info, Variant::NIL);
  599. return info->info.return_val.type;
  600. }
  601. StringName GDScriptUtilityFunctions::get_function_return_class(const StringName &p_function) {
  602. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  603. ERR_FAIL_COND_V(!info, StringName());
  604. return info->info.return_val.class_name;
  605. }
  606. Variant::Type GDScriptUtilityFunctions::get_function_argument_type(const StringName &p_function, int p_arg) {
  607. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  608. ERR_FAIL_COND_V(!info, Variant::NIL);
  609. ERR_FAIL_COND_V(p_arg >= info->info.arguments.size(), Variant::NIL);
  610. return info->info.arguments[p_arg].type;
  611. }
  612. int GDScriptUtilityFunctions::get_function_argument_count(const StringName &p_function, int p_arg) {
  613. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  614. ERR_FAIL_COND_V(!info, 0);
  615. return info->info.arguments.size();
  616. }
  617. bool GDScriptUtilityFunctions::is_function_vararg(const StringName &p_function) {
  618. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  619. ERR_FAIL_COND_V(!info, false);
  620. return (bool)(info->info.flags & METHOD_FLAG_VARARG);
  621. }
  622. bool GDScriptUtilityFunctions::is_function_constant(const StringName &p_function) {
  623. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  624. ERR_FAIL_COND_V(!info, false);
  625. return info->is_constant;
  626. }
  627. bool GDScriptUtilityFunctions::function_exists(const StringName &p_function) {
  628. return utility_function_table.has(p_function);
  629. }
  630. void GDScriptUtilityFunctions::get_function_list(List<StringName> *r_functions) {
  631. for (const StringName &E : utility_function_name_table) {
  632. r_functions->push_back(E);
  633. }
  634. }
  635. MethodInfo GDScriptUtilityFunctions::get_function_info(const StringName &p_function) {
  636. GDScriptUtilityFunctionInfo *info = utility_function_table.lookup_ptr(p_function);
  637. ERR_FAIL_COND_V(!info, MethodInfo());
  638. return info->info;
  639. }