variant_utility.cpp 66 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516
  1. /*************************************************************************/
  2. /* variant_utility.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 "variant.h"
  31. #include "core/core_string_names.h"
  32. #include "core/io/marshalls.h"
  33. #include "core/object/ref_counted.h"
  34. #include "core/os/os.h"
  35. #include "core/templates/oa_hash_map.h"
  36. #include "core/templates/rid.h"
  37. #include "core/templates/rid_owner.h"
  38. #include "core/variant/binder_common.h"
  39. #include "core/variant/variant_parser.h"
  40. struct VariantUtilityFunctions {
  41. // Math
  42. static inline double sin(double arg) {
  43. return Math::sin(arg);
  44. }
  45. static inline double cos(double arg) {
  46. return Math::cos(arg);
  47. }
  48. static inline double tan(double arg) {
  49. return Math::tan(arg);
  50. }
  51. static inline double sinh(double arg) {
  52. return Math::sinh(arg);
  53. }
  54. static inline double cosh(double arg) {
  55. return Math::cosh(arg);
  56. }
  57. static inline double tanh(double arg) {
  58. return Math::tanh(arg);
  59. }
  60. static inline double asin(double arg) {
  61. return Math::asin(arg);
  62. }
  63. static inline double acos(double arg) {
  64. return Math::acos(arg);
  65. }
  66. static inline double atan(double arg) {
  67. return Math::atan(arg);
  68. }
  69. static inline double atan2(double y, double x) {
  70. return Math::atan2(y, x);
  71. }
  72. static inline double sqrt(double x) {
  73. return Math::sqrt(x);
  74. }
  75. static inline double fmod(double b, double r) {
  76. return Math::fmod(b, r);
  77. }
  78. static inline double fposmod(double b, double r) {
  79. return Math::fposmod(b, r);
  80. }
  81. static inline int64_t posmod(int64_t b, int64_t r) {
  82. return Math::posmod(b, r);
  83. }
  84. static inline double floor(double x) {
  85. return Math::floor(x);
  86. }
  87. static inline double ceil(double x) {
  88. return Math::ceil(x);
  89. }
  90. static inline double round(double x) {
  91. return Math::round(x);
  92. }
  93. static inline Variant abs(const Variant &x, Callable::CallError &r_error) {
  94. r_error.error = Callable::CallError::CALL_OK;
  95. switch (x.get_type()) {
  96. case Variant::INT: {
  97. return ABS(VariantInternalAccessor<int64_t>::get(&x));
  98. } break;
  99. case Variant::FLOAT: {
  100. return Math::absd(VariantInternalAccessor<double>::get(&x));
  101. } break;
  102. case Variant::VECTOR2: {
  103. return VariantInternalAccessor<Vector2>::get(&x).abs();
  104. } break;
  105. case Variant::VECTOR2I: {
  106. return VariantInternalAccessor<Vector2i>::get(&x).abs();
  107. } break;
  108. case Variant::VECTOR3: {
  109. return VariantInternalAccessor<Vector3>::get(&x).abs();
  110. } break;
  111. case Variant::VECTOR3I: {
  112. return VariantInternalAccessor<Vector3i>::get(&x).abs();
  113. } break;
  114. default: {
  115. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  116. return Variant();
  117. }
  118. }
  119. }
  120. static inline double absf(double x) {
  121. return Math::absd(x);
  122. }
  123. static inline int64_t absi(int64_t x) {
  124. return ABS(x);
  125. }
  126. static inline Variant sign(const Variant &x, Callable::CallError &r_error) {
  127. r_error.error = Callable::CallError::CALL_OK;
  128. switch (x.get_type()) {
  129. case Variant::INT: {
  130. return SIGN(VariantInternalAccessor<int64_t>::get(&x));
  131. } break;
  132. case Variant::FLOAT: {
  133. return SIGN(VariantInternalAccessor<double>::get(&x));
  134. } break;
  135. case Variant::VECTOR2: {
  136. return VariantInternalAccessor<Vector2>::get(&x).sign();
  137. } break;
  138. case Variant::VECTOR2I: {
  139. return VariantInternalAccessor<Vector2i>::get(&x).sign();
  140. } break;
  141. case Variant::VECTOR3: {
  142. return VariantInternalAccessor<Vector3>::get(&x).sign();
  143. } break;
  144. case Variant::VECTOR3I: {
  145. return VariantInternalAccessor<Vector3i>::get(&x).sign();
  146. } break;
  147. default: {
  148. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  149. return Variant();
  150. }
  151. }
  152. }
  153. static inline double signf(double x) {
  154. return SIGN(x);
  155. }
  156. static inline int64_t signi(int64_t x) {
  157. return SIGN(x);
  158. }
  159. static inline double pow(double x, double y) {
  160. return Math::pow(x, y);
  161. }
  162. static inline double log(double x) {
  163. return Math::log(x);
  164. }
  165. static inline double exp(double x) {
  166. return Math::exp(x);
  167. }
  168. static inline bool is_nan(double x) {
  169. return Math::is_nan(x);
  170. }
  171. static inline bool is_inf(double x) {
  172. return Math::is_inf(x);
  173. }
  174. static inline bool is_equal_approx(double x, double y) {
  175. return Math::is_equal_approx(x, y);
  176. }
  177. static inline bool is_zero_approx(double x) {
  178. return Math::is_zero_approx(x);
  179. }
  180. static inline double ease(float x, float curve) {
  181. return Math::ease(x, curve);
  182. }
  183. static inline int step_decimals(float step) {
  184. return Math::step_decimals(step);
  185. }
  186. static inline double snapped(double value, double step) {
  187. return Math::snapped(value, step);
  188. }
  189. static inline double lerp(double from, double to, double weight) {
  190. return Math::lerp(from, to, weight);
  191. }
  192. static inline double cubic_interpolate(double from, double to, double pre, double post, double weight) {
  193. return Math::cubic_interpolate(from, to, pre, post, weight);
  194. }
  195. static inline double bezier_interpolate(double p_start, double p_control_1, double p_control_2, double p_end, double p_t) {
  196. return Math::bezier_interpolate(p_start, p_control_1, p_control_2, p_end, p_t);
  197. }
  198. static inline double lerp_angle(double from, double to, double weight) {
  199. return Math::lerp_angle(from, to, weight);
  200. }
  201. static inline double inverse_lerp(double from, double to, double weight) {
  202. return Math::inverse_lerp(from, to, weight);
  203. }
  204. static inline double range_lerp(double value, double istart, double istop, double ostart, double ostop) {
  205. return Math::range_lerp(value, istart, istop, ostart, ostop);
  206. }
  207. static inline double smoothstep(double from, double to, double val) {
  208. return Math::smoothstep(from, to, val);
  209. }
  210. static inline double move_toward(double from, double to, double delta) {
  211. return Math::move_toward(from, to, delta);
  212. }
  213. static inline double deg2rad(double angle_deg) {
  214. return Math::deg2rad(angle_deg);
  215. }
  216. static inline double rad2deg(double angle_rad) {
  217. return Math::rad2deg(angle_rad);
  218. }
  219. static inline double linear2db(double linear) {
  220. return Math::linear2db(linear);
  221. }
  222. static inline double db2linear(double db) {
  223. return Math::db2linear(db);
  224. }
  225. static inline Variant wrap(const Variant &p_x, const Variant &p_min, const Variant &p_max, Callable::CallError &r_error) {
  226. Variant::Type x_type = p_x.get_type();
  227. if (x_type != Variant::INT && x_type != Variant::FLOAT) {
  228. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  229. r_error.argument = 0;
  230. r_error.expected = x_type;
  231. return Variant();
  232. }
  233. Variant::Type min_type = p_min.get_type();
  234. if (min_type != Variant::INT && min_type != Variant::FLOAT) {
  235. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  236. r_error.argument = 1;
  237. r_error.expected = x_type;
  238. return Variant();
  239. }
  240. Variant::Type max_type = p_max.get_type();
  241. if (max_type != Variant::INT && max_type != Variant::FLOAT) {
  242. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  243. r_error.argument = 2;
  244. r_error.expected = x_type;
  245. return Variant();
  246. }
  247. Variant value;
  248. switch (x_type) {
  249. case Variant::INT: {
  250. if (x_type != min_type || x_type != max_type) {
  251. value = wrapf((double)p_x, (double)p_min, (double)p_max);
  252. } else {
  253. value = wrapi((int)p_x, (int)p_min, (int)p_max);
  254. }
  255. } break;
  256. case Variant::FLOAT: {
  257. value = wrapf((double)p_x, (double)p_min, (double)p_max);
  258. } break;
  259. default:
  260. break;
  261. }
  262. r_error.error = Callable::CallError::CALL_OK;
  263. return value;
  264. }
  265. static inline int64_t wrapi(int64_t value, int64_t min, int64_t max) {
  266. return Math::wrapi(value, min, max);
  267. }
  268. static inline double wrapf(double value, double min, double max) {
  269. return Math::wrapf(value, min, max);
  270. }
  271. static inline double pingpong(double value, double length) {
  272. return Math::pingpong(value, length);
  273. }
  274. static inline Variant max(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  275. if (p_argcount < 2) {
  276. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  277. r_error.expected = 2;
  278. return Variant();
  279. }
  280. Variant base = *p_args[0];
  281. Variant ret;
  282. for (int i = 1; i < p_argcount; i++) {
  283. bool valid;
  284. Variant::evaluate(Variant::OP_LESS, base, *p_args[i], ret, valid);
  285. if (!valid) {
  286. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  287. r_error.expected = base.get_type();
  288. r_error.argument = i;
  289. return Variant();
  290. }
  291. if (ret.booleanize()) {
  292. base = *p_args[i];
  293. }
  294. }
  295. r_error.error = Callable::CallError::CALL_OK;
  296. return base;
  297. }
  298. static inline double maxf(double x, double y) {
  299. return MAX(x, y);
  300. }
  301. static inline int64_t maxi(int64_t x, int64_t y) {
  302. return MAX(x, y);
  303. }
  304. static inline Variant min(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  305. if (p_argcount < 2) {
  306. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  307. r_error.expected = 2;
  308. return Variant();
  309. }
  310. Variant base = *p_args[0];
  311. Variant ret;
  312. for (int i = 1; i < p_argcount; i++) {
  313. bool valid;
  314. Variant::evaluate(Variant::OP_GREATER, base, *p_args[i], ret, valid);
  315. if (!valid) {
  316. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  317. r_error.expected = base.get_type();
  318. r_error.argument = i;
  319. return Variant();
  320. }
  321. if (ret.booleanize()) {
  322. base = *p_args[i];
  323. }
  324. }
  325. r_error.error = Callable::CallError::CALL_OK;
  326. return base;
  327. }
  328. static inline double minf(double x, double y) {
  329. return MIN(x, y);
  330. }
  331. static inline int64_t mini(int64_t x, int64_t y) {
  332. return MIN(x, y);
  333. }
  334. static inline Variant clamp(const Variant &x, const Variant &min, const Variant &max, Callable::CallError &r_error) {
  335. Variant value = x;
  336. Variant ret;
  337. bool valid;
  338. Variant::evaluate(Variant::OP_LESS, value, min, ret, valid);
  339. if (!valid) {
  340. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  341. r_error.expected = value.get_type();
  342. r_error.argument = 1;
  343. return Variant();
  344. }
  345. if (ret.booleanize()) {
  346. value = min;
  347. }
  348. Variant::evaluate(Variant::OP_GREATER, value, max, ret, valid);
  349. if (!valid) {
  350. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  351. r_error.expected = value.get_type();
  352. r_error.argument = 2;
  353. return Variant();
  354. }
  355. if (ret.booleanize()) {
  356. value = max;
  357. }
  358. r_error.error = Callable::CallError::CALL_OK;
  359. return value;
  360. }
  361. static inline double clampf(double x, double min, double max) {
  362. return CLAMP(x, min, max);
  363. }
  364. static inline int64_t clampi(int64_t x, int64_t min, int64_t max) {
  365. return CLAMP(x, min, max);
  366. }
  367. static inline int64_t nearest_po2(int64_t x) {
  368. return nearest_power_of_2_templated(uint64_t(x));
  369. }
  370. // Random
  371. static inline void randomize() {
  372. Math::randomize();
  373. }
  374. static inline int64_t randi() {
  375. return Math::rand();
  376. }
  377. static inline double randf() {
  378. return Math::randf();
  379. }
  380. static inline double randfn(double mean, double deviation) {
  381. return Math::randfn(mean, deviation);
  382. }
  383. static inline int64_t randi_range(int64_t from, int64_t to) {
  384. return Math::random((int32_t)from, (int32_t)to);
  385. }
  386. static inline double randf_range(double from, double to) {
  387. return Math::random(from, to);
  388. }
  389. static inline void seed(int64_t s) {
  390. return Math::seed(s);
  391. }
  392. static inline PackedInt64Array rand_from_seed(int64_t seed) {
  393. uint64_t s = seed;
  394. PackedInt64Array arr;
  395. arr.resize(2);
  396. arr.write[0] = Math::rand_from_seed(&s);
  397. arr.write[1] = s;
  398. return arr;
  399. }
  400. // Utility
  401. static inline Variant weakref(const Variant &obj, Callable::CallError &r_error) {
  402. if (obj.get_type() == Variant::OBJECT) {
  403. r_error.error = Callable::CallError::CALL_OK;
  404. if (obj.is_ref_counted()) {
  405. Ref<WeakRef> wref = memnew(WeakRef);
  406. Ref<RefCounted> r = obj;
  407. if (r.is_valid()) {
  408. wref->set_ref(r);
  409. }
  410. return wref;
  411. } else {
  412. Ref<WeakRef> wref = memnew(WeakRef);
  413. Object *o = obj.get_validated_object();
  414. if (o) {
  415. wref->set_obj(o);
  416. }
  417. return wref;
  418. }
  419. } else if (obj.get_type() == Variant::NIL) {
  420. r_error.error = Callable::CallError::CALL_OK;
  421. Ref<WeakRef> wref = memnew(WeakRef);
  422. return wref;
  423. } else {
  424. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  425. r_error.argument = 0;
  426. r_error.expected = Variant::OBJECT;
  427. return Variant();
  428. }
  429. }
  430. static inline int64_t _typeof(const Variant &obj) {
  431. return obj.get_type();
  432. }
  433. static inline String str(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  434. if (p_arg_count < 1) {
  435. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  436. r_error.argument = 1;
  437. return String();
  438. }
  439. String s;
  440. for (int i = 0; i < p_arg_count; i++) {
  441. String os = p_args[i]->operator String();
  442. if (i == 0) {
  443. s = os;
  444. } else {
  445. s += os;
  446. }
  447. }
  448. r_error.error = Callable::CallError::CALL_OK;
  449. return s;
  450. }
  451. static inline String error_string(Error error) {
  452. if (error < 0 || error >= ERR_MAX) {
  453. return String("(invalid error code)");
  454. }
  455. return String(error_names[error]);
  456. }
  457. static inline void print(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  458. String s;
  459. for (int i = 0; i < p_arg_count; i++) {
  460. String os = p_args[i]->operator String();
  461. if (i == 0) {
  462. s = os;
  463. } else {
  464. s += os;
  465. }
  466. }
  467. print_line(s);
  468. r_error.error = Callable::CallError::CALL_OK;
  469. }
  470. static inline void print_rich(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  471. String s;
  472. for (int i = 0; i < p_arg_count; i++) {
  473. String os = p_args[i]->operator String();
  474. if (i == 0) {
  475. s = os;
  476. } else {
  477. s += os;
  478. }
  479. }
  480. print_line_rich(s);
  481. r_error.error = Callable::CallError::CALL_OK;
  482. }
  483. static inline void print_verbose(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  484. if (OS::get_singleton()->is_stdout_verbose()) {
  485. String s;
  486. for (int i = 0; i < p_arg_count; i++) {
  487. String os = p_args[i]->operator String();
  488. if (i == 0) {
  489. s = os;
  490. } else {
  491. s += os;
  492. }
  493. }
  494. // No need to use `print_verbose()` as this call already only happens
  495. // when verbose mode is enabled. This avoids performing string argument concatenation
  496. // when not needed.
  497. print_line(s);
  498. }
  499. r_error.error = Callable::CallError::CALL_OK;
  500. }
  501. static inline void printerr(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  502. String s;
  503. for (int i = 0; i < p_arg_count; i++) {
  504. String os = p_args[i]->operator String();
  505. if (i == 0) {
  506. s = os;
  507. } else {
  508. s += os;
  509. }
  510. }
  511. print_error(s);
  512. r_error.error = Callable::CallError::CALL_OK;
  513. }
  514. static inline void printt(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  515. String s;
  516. for (int i = 0; i < p_arg_count; i++) {
  517. if (i) {
  518. s += "\t";
  519. }
  520. s += p_args[i]->operator String();
  521. }
  522. print_line(s);
  523. r_error.error = Callable::CallError::CALL_OK;
  524. }
  525. static inline void prints(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  526. String s;
  527. for (int i = 0; i < p_arg_count; i++) {
  528. if (i) {
  529. s += " ";
  530. }
  531. s += p_args[i]->operator String();
  532. }
  533. print_line(s);
  534. r_error.error = Callable::CallError::CALL_OK;
  535. }
  536. static inline void printraw(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  537. String s;
  538. for (int i = 0; i < p_arg_count; i++) {
  539. String os = p_args[i]->operator String();
  540. if (i == 0) {
  541. s = os;
  542. } else {
  543. s += os;
  544. }
  545. }
  546. OS::get_singleton()->print("%s", s.utf8().get_data());
  547. r_error.error = Callable::CallError::CALL_OK;
  548. }
  549. static inline void push_error(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  550. if (p_arg_count < 1) {
  551. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  552. r_error.argument = 1;
  553. }
  554. String s;
  555. for (int i = 0; i < p_arg_count; i++) {
  556. String os = p_args[i]->operator String();
  557. if (i == 0) {
  558. s = os;
  559. } else {
  560. s += os;
  561. }
  562. }
  563. ERR_PRINT(s);
  564. r_error.error = Callable::CallError::CALL_OK;
  565. }
  566. static inline void push_warning(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  567. if (p_arg_count < 1) {
  568. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  569. r_error.argument = 1;
  570. }
  571. String s;
  572. for (int i = 0; i < p_arg_count; i++) {
  573. String os = p_args[i]->operator String();
  574. if (i == 0) {
  575. s = os;
  576. } else {
  577. s += os;
  578. }
  579. }
  580. WARN_PRINT(s);
  581. r_error.error = Callable::CallError::CALL_OK;
  582. }
  583. static inline String var2str(const Variant &p_var) {
  584. String vars;
  585. VariantWriter::write_to_string(p_var, vars);
  586. return vars;
  587. }
  588. static inline Variant str2var(const String &p_var) {
  589. VariantParser::StreamString ss;
  590. ss.s = p_var;
  591. String errs;
  592. int line;
  593. Variant ret;
  594. (void)VariantParser::parse(&ss, ret, errs, line);
  595. return ret;
  596. }
  597. static inline PackedByteArray var2bytes(const Variant &p_var) {
  598. int len;
  599. Error err = encode_variant(p_var, nullptr, len, false);
  600. if (err != OK) {
  601. return PackedByteArray();
  602. }
  603. PackedByteArray barr;
  604. barr.resize(len);
  605. {
  606. uint8_t *w = barr.ptrw();
  607. err = encode_variant(p_var, w, len, false);
  608. if (err != OK) {
  609. return PackedByteArray();
  610. }
  611. }
  612. return barr;
  613. }
  614. static inline PackedByteArray var2bytes_with_objects(const Variant &p_var) {
  615. int len;
  616. Error err = encode_variant(p_var, nullptr, len, true);
  617. if (err != OK) {
  618. return PackedByteArray();
  619. }
  620. PackedByteArray barr;
  621. barr.resize(len);
  622. {
  623. uint8_t *w = barr.ptrw();
  624. err = encode_variant(p_var, w, len, true);
  625. if (err != OK) {
  626. return PackedByteArray();
  627. }
  628. }
  629. return barr;
  630. }
  631. static inline Variant bytes2var(const PackedByteArray &p_arr) {
  632. Variant ret;
  633. {
  634. const uint8_t *r = p_arr.ptr();
  635. Error err = decode_variant(ret, r, p_arr.size(), nullptr, false);
  636. if (err != OK) {
  637. return Variant();
  638. }
  639. }
  640. return ret;
  641. }
  642. static inline Variant bytes2var_with_objects(const PackedByteArray &p_arr) {
  643. Variant ret;
  644. {
  645. const uint8_t *r = p_arr.ptr();
  646. Error err = decode_variant(ret, r, p_arr.size(), nullptr, true);
  647. if (err != OK) {
  648. return Variant();
  649. }
  650. }
  651. return ret;
  652. }
  653. static inline int64_t hash(const Variant &p_arr) {
  654. return p_arr.hash();
  655. }
  656. static inline Object *instance_from_id(int64_t p_id) {
  657. ObjectID id = ObjectID((uint64_t)p_id);
  658. Object *ret = ObjectDB::get_instance(id);
  659. return ret;
  660. }
  661. static inline bool is_instance_id_valid(int64_t p_id) {
  662. return ObjectDB::get_instance(ObjectID((uint64_t)p_id)) != nullptr;
  663. }
  664. static inline bool is_instance_valid(const Variant &p_instance) {
  665. if (p_instance.get_type() != Variant::OBJECT) {
  666. return false;
  667. }
  668. return p_instance.get_validated_object() != nullptr;
  669. }
  670. static inline uint64_t rid_allocate_id() {
  671. return RID_AllocBase::_gen_id();
  672. }
  673. static inline RID rid_from_int64(uint64_t p_base) {
  674. return RID::from_uint64(p_base);
  675. }
  676. };
  677. #ifdef DEBUG_METHODS_ENABLED
  678. #define VCALLR *ret = p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  679. #define VCALL p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  680. #else
  681. #define VCALLR *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...)
  682. #define VCALL p_func(VariantCaster<P>::cast(*p_args[Is])...)
  683. #endif
  684. template <class R, class... P, size_t... Is>
  685. static _FORCE_INLINE_ void call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  686. r_error.error = Callable::CallError::CALL_OK;
  687. VCALLR;
  688. (void)p_args; // avoid gcc warning
  689. (void)r_error;
  690. }
  691. template <class R, class... P, size_t... Is>
  692. static _FORCE_INLINE_ void validated_call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, IndexSequence<Is...>) {
  693. *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...);
  694. (void)p_args;
  695. }
  696. template <class R, class... P, size_t... Is>
  697. static _FORCE_INLINE_ void ptr_call_helperpr(R (*p_func)(P...), void *ret, const void **p_args, IndexSequence<Is...>) {
  698. PtrToArg<R>::encode(p_func(PtrToArg<P>::convert(p_args[Is])...), ret);
  699. (void)p_args;
  700. }
  701. template <class R, class... P>
  702. static _FORCE_INLINE_ void call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error) {
  703. call_helperpr(p_func, ret, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  704. }
  705. template <class R, class... P>
  706. static _FORCE_INLINE_ void validated_call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args) {
  707. validated_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  708. }
  709. template <class R, class... P>
  710. static _FORCE_INLINE_ void ptr_call_helperr(R (*p_func)(P...), void *ret, const void **p_args) {
  711. ptr_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  712. }
  713. template <class R, class... P>
  714. static _FORCE_INLINE_ int get_arg_count_helperr(R (*p_func)(P...)) {
  715. return sizeof...(P);
  716. }
  717. template <class R, class... P>
  718. static _FORCE_INLINE_ Variant::Type get_arg_type_helperr(R (*p_func)(P...), int p_arg) {
  719. return call_get_argument_type<P...>(p_arg);
  720. }
  721. template <class R, class... P>
  722. static _FORCE_INLINE_ Variant::Type get_ret_type_helperr(R (*p_func)(P...)) {
  723. return GetTypeInfo<R>::VARIANT_TYPE;
  724. }
  725. // WITHOUT RET
  726. template <class... P, size_t... Is>
  727. static _FORCE_INLINE_ void call_helperp(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  728. r_error.error = Callable::CallError::CALL_OK;
  729. VCALL;
  730. (void)p_args;
  731. (void)r_error;
  732. }
  733. template <class... P, size_t... Is>
  734. static _FORCE_INLINE_ void validated_call_helperp(void (*p_func)(P...), const Variant **p_args, IndexSequence<Is...>) {
  735. p_func(VariantCaster<P>::cast(*p_args[Is])...);
  736. (void)p_args;
  737. }
  738. template <class... P, size_t... Is>
  739. static _FORCE_INLINE_ void ptr_call_helperp(void (*p_func)(P...), const void **p_args, IndexSequence<Is...>) {
  740. p_func(PtrToArg<P>::convert(p_args[Is])...);
  741. (void)p_args;
  742. }
  743. template <class... P>
  744. static _FORCE_INLINE_ void call_helper(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error) {
  745. call_helperp(p_func, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  746. }
  747. template <class... P>
  748. static _FORCE_INLINE_ void validated_call_helper(void (*p_func)(P...), const Variant **p_args) {
  749. validated_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  750. }
  751. template <class... P>
  752. static _FORCE_INLINE_ void ptr_call_helper(void (*p_func)(P...), const void **p_args) {
  753. ptr_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  754. }
  755. template <class... P>
  756. static _FORCE_INLINE_ int get_arg_count_helper(void (*p_func)(P...)) {
  757. return sizeof...(P);
  758. }
  759. template <class... P>
  760. static _FORCE_INLINE_ Variant::Type get_arg_type_helper(void (*p_func)(P...), int p_arg) {
  761. return call_get_argument_type<P...>(p_arg);
  762. }
  763. template <class... P>
  764. static _FORCE_INLINE_ Variant::Type get_ret_type_helper(void (*p_func)(P...)) {
  765. return Variant::NIL;
  766. }
  767. #define FUNCBINDR(m_func, m_args, m_category) \
  768. class Func_##m_func { \
  769. public: \
  770. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  771. call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args, r_error); \
  772. } \
  773. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  774. validated_call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args); \
  775. } \
  776. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  777. ptr_call_helperr(VariantUtilityFunctions::m_func, ret, p_args); \
  778. } \
  779. static int get_argument_count() { \
  780. return get_arg_count_helperr(VariantUtilityFunctions::m_func); \
  781. } \
  782. static Variant::Type get_argument_type(int p_arg) { \
  783. return get_arg_type_helperr(VariantUtilityFunctions::m_func, p_arg); \
  784. } \
  785. static Variant::Type get_return_type() { \
  786. return get_ret_type_helperr(VariantUtilityFunctions::m_func); \
  787. } \
  788. static bool has_return_type() { \
  789. return true; \
  790. } \
  791. static bool is_vararg() { return false; } \
  792. static Variant::UtilityFunctionType get_type() { return m_category; } \
  793. }; \
  794. register_utility_function<Func_##m_func>(#m_func, m_args)
  795. #define FUNCBINDVR(m_func, m_args, m_category) \
  796. class Func_##m_func { \
  797. public: \
  798. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  799. r_error.error = Callable::CallError::CALL_OK; \
  800. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], r_error); \
  801. } \
  802. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  803. Callable::CallError ce; \
  804. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], ce); \
  805. } \
  806. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  807. Callable::CallError ce; \
  808. PtrToArg<Variant>::encode(VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), ce), ret); \
  809. } \
  810. static int get_argument_count() { \
  811. return 1; \
  812. } \
  813. static Variant::Type get_argument_type(int p_arg) { \
  814. return Variant::NIL; \
  815. } \
  816. static Variant::Type get_return_type() { \
  817. return Variant::NIL; \
  818. } \
  819. static bool has_return_type() { \
  820. return true; \
  821. } \
  822. static bool is_vararg() { return false; } \
  823. static Variant::UtilityFunctionType get_type() { return m_category; } \
  824. }; \
  825. register_utility_function<Func_##m_func>(#m_func, m_args)
  826. #define FUNCBINDVR3(m_func, m_args, m_category) \
  827. class Func_##m_func { \
  828. public: \
  829. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  830. r_error.error = Callable::CallError::CALL_OK; \
  831. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], r_error); \
  832. } \
  833. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  834. Callable::CallError ce; \
  835. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], ce); \
  836. } \
  837. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  838. Callable::CallError ce; \
  839. Variant r; \
  840. r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), PtrToArg<Variant>::convert(p_args[2]), ce); \
  841. PtrToArg<Variant>::encode(r, ret); \
  842. } \
  843. static int get_argument_count() { \
  844. return 3; \
  845. } \
  846. static Variant::Type get_argument_type(int p_arg) { \
  847. return Variant::NIL; \
  848. } \
  849. static Variant::Type get_return_type() { \
  850. return Variant::NIL; \
  851. } \
  852. static bool has_return_type() { \
  853. return true; \
  854. } \
  855. static bool is_vararg() { return false; } \
  856. static Variant::UtilityFunctionType get_type() { return m_category; } \
  857. }; \
  858. register_utility_function<Func_##m_func>(#m_func, m_args)
  859. #define FUNCBINDVARARG(m_func, m_args, m_category) \
  860. class Func_##m_func { \
  861. public: \
  862. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  863. r_error.error = Callable::CallError::CALL_OK; \
  864. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  865. } \
  866. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  867. Callable::CallError c; \
  868. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  869. } \
  870. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  871. Vector<Variant> args; \
  872. for (int i = 0; i < p_argcount; i++) { \
  873. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  874. } \
  875. Vector<const Variant *> argsp; \
  876. for (int i = 0; i < p_argcount; i++) { \
  877. argsp.push_back(&args[i]); \
  878. } \
  879. Variant r; \
  880. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  881. PtrToArg<Variant>::encode(r, ret); \
  882. } \
  883. static int get_argument_count() { \
  884. return 2; \
  885. } \
  886. static Variant::Type get_argument_type(int p_arg) { \
  887. return Variant::NIL; \
  888. } \
  889. static Variant::Type get_return_type() { \
  890. return Variant::NIL; \
  891. } \
  892. static bool has_return_type() { \
  893. return true; \
  894. } \
  895. static bool is_vararg() { \
  896. return true; \
  897. } \
  898. static Variant::UtilityFunctionType get_type() { \
  899. return m_category; \
  900. } \
  901. }; \
  902. register_utility_function<Func_##m_func>(#m_func, m_args)
  903. #define FUNCBINDVARARGS(m_func, m_args, m_category) \
  904. class Func_##m_func { \
  905. public: \
  906. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  907. r_error.error = Callable::CallError::CALL_OK; \
  908. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  909. } \
  910. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  911. Callable::CallError c; \
  912. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  913. } \
  914. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  915. Vector<Variant> args; \
  916. for (int i = 0; i < p_argcount; i++) { \
  917. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  918. } \
  919. Vector<const Variant *> argsp; \
  920. for (int i = 0; i < p_argcount; i++) { \
  921. argsp.push_back(&args[i]); \
  922. } \
  923. Variant r; \
  924. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  925. PtrToArg<String>::encode(r.operator String(), ret); \
  926. } \
  927. static int get_argument_count() { \
  928. return 1; \
  929. } \
  930. static Variant::Type get_argument_type(int p_arg) { \
  931. return Variant::NIL; \
  932. } \
  933. static Variant::Type get_return_type() { \
  934. return Variant::STRING; \
  935. } \
  936. static bool has_return_type() { \
  937. return true; \
  938. } \
  939. static bool is_vararg() { \
  940. return true; \
  941. } \
  942. static Variant::UtilityFunctionType get_type() { \
  943. return m_category; \
  944. } \
  945. }; \
  946. register_utility_function<Func_##m_func>(#m_func, m_args)
  947. #define FUNCBINDVARARGV(m_func, m_args, m_category) \
  948. class Func_##m_func { \
  949. public: \
  950. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  951. r_error.error = Callable::CallError::CALL_OK; \
  952. VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  953. } \
  954. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  955. Callable::CallError c; \
  956. VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  957. } \
  958. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  959. Vector<Variant> args; \
  960. for (int i = 0; i < p_argcount; i++) { \
  961. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  962. } \
  963. Vector<const Variant *> argsp; \
  964. for (int i = 0; i < p_argcount; i++) { \
  965. argsp.push_back(&args[i]); \
  966. } \
  967. Variant r; \
  968. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  969. } \
  970. static int get_argument_count() { \
  971. return 1; \
  972. } \
  973. static Variant::Type get_argument_type(int p_arg) { \
  974. return Variant::NIL; \
  975. } \
  976. static Variant::Type get_return_type() { \
  977. return Variant::NIL; \
  978. } \
  979. static bool has_return_type() { \
  980. return false; \
  981. } \
  982. static bool is_vararg() { \
  983. return true; \
  984. } \
  985. static Variant::UtilityFunctionType get_type() { \
  986. return m_category; \
  987. } \
  988. }; \
  989. register_utility_function<Func_##m_func>(#m_func, m_args)
  990. #define FUNCBIND(m_func, m_args, m_category) \
  991. class Func_##m_func { \
  992. public: \
  993. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  994. call_helper(VariantUtilityFunctions::m_func, p_args, r_error); \
  995. } \
  996. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  997. validated_call_helper(VariantUtilityFunctions::m_func, p_args); \
  998. } \
  999. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1000. ptr_call_helper(VariantUtilityFunctions::m_func, p_args); \
  1001. } \
  1002. static int get_argument_count() { \
  1003. return get_arg_count_helper(VariantUtilityFunctions::m_func); \
  1004. } \
  1005. static Variant::Type get_argument_type(int p_arg) { \
  1006. return get_arg_type_helper(VariantUtilityFunctions::m_func, p_arg); \
  1007. } \
  1008. static Variant::Type get_return_type() { \
  1009. return get_ret_type_helper(VariantUtilityFunctions::m_func); \
  1010. } \
  1011. static bool has_return_type() { \
  1012. return false; \
  1013. } \
  1014. static bool is_vararg() { return false; } \
  1015. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1016. }; \
  1017. register_utility_function<Func_##m_func>(#m_func, m_args)
  1018. struct VariantUtilityFunctionInfo {
  1019. void (*call_utility)(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) = nullptr;
  1020. Variant::ValidatedUtilityFunction validated_call_utility = nullptr;
  1021. Variant::PTRUtilityFunction ptr_call_utility = nullptr;
  1022. Vector<String> argnames;
  1023. bool is_vararg = false;
  1024. bool returns_value = false;
  1025. int argcount = 0;
  1026. Variant::Type (*get_arg_type)(int) = nullptr;
  1027. Variant::Type return_type;
  1028. Variant::UtilityFunctionType type;
  1029. };
  1030. static OAHashMap<StringName, VariantUtilityFunctionInfo> utility_function_table;
  1031. static List<StringName> utility_function_name_table;
  1032. template <class T>
  1033. static void register_utility_function(const String &p_name, const Vector<String> &argnames) {
  1034. String name = p_name;
  1035. if (name.begins_with("_")) {
  1036. name = name.substr(1, name.length() - 1);
  1037. }
  1038. StringName sname = name;
  1039. ERR_FAIL_COND(utility_function_table.has(sname));
  1040. VariantUtilityFunctionInfo bfi;
  1041. bfi.call_utility = T::call;
  1042. bfi.validated_call_utility = T::validated_call;
  1043. bfi.ptr_call_utility = T::ptrcall;
  1044. bfi.is_vararg = T::is_vararg();
  1045. bfi.argnames = argnames;
  1046. bfi.argcount = T::get_argument_count();
  1047. if (!bfi.is_vararg) {
  1048. ERR_FAIL_COND_MSG(argnames.size() != bfi.argcount, "wrong number of arguments binding utility function: " + name);
  1049. }
  1050. bfi.get_arg_type = T::get_argument_type;
  1051. bfi.return_type = T::get_return_type();
  1052. bfi.type = T::get_type();
  1053. bfi.returns_value = T::has_return_type();
  1054. utility_function_table.insert(sname, bfi);
  1055. utility_function_name_table.push_back(sname);
  1056. }
  1057. void Variant::_register_variant_utility_functions() {
  1058. // Math
  1059. FUNCBINDR(sin, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1060. FUNCBINDR(cos, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1061. FUNCBINDR(tan, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1062. FUNCBINDR(sinh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1063. FUNCBINDR(cosh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1064. FUNCBINDR(tanh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1065. FUNCBINDR(asin, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1066. FUNCBINDR(acos, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1067. FUNCBINDR(atan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1068. FUNCBINDR(atan2, sarray("y", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1069. FUNCBINDR(sqrt, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1070. FUNCBINDR(fmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1071. FUNCBINDR(fposmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1072. FUNCBINDR(posmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1073. FUNCBINDR(floor, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1074. FUNCBINDR(ceil, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1075. FUNCBINDR(round, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1076. FUNCBINDVR(abs, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1077. FUNCBINDR(absf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1078. FUNCBINDR(absi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1079. FUNCBINDVR(sign, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1080. FUNCBINDR(signf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1081. FUNCBINDR(signi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1082. FUNCBINDR(pow, sarray("base", "exp"), Variant::UTILITY_FUNC_TYPE_MATH);
  1083. FUNCBINDR(log, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1084. FUNCBINDR(exp, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1085. FUNCBINDR(is_nan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1086. FUNCBINDR(is_inf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1087. FUNCBINDR(is_equal_approx, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1088. FUNCBINDR(is_zero_approx, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1089. FUNCBINDR(ease, sarray("x", "curve"), Variant::UTILITY_FUNC_TYPE_MATH);
  1090. FUNCBINDR(step_decimals, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1091. FUNCBINDR(snapped, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1092. FUNCBINDR(lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1093. FUNCBINDR(cubic_interpolate, sarray("from", "to", "pre", "post", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1094. FUNCBINDR(bezier_interpolate, sarray("start", "control_1", "control_2", "end", "t"), Variant::UTILITY_FUNC_TYPE_MATH);
  1095. FUNCBINDR(lerp_angle, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1096. FUNCBINDR(inverse_lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1097. FUNCBINDR(range_lerp, sarray("value", "istart", "istop", "ostart", "ostop"), Variant::UTILITY_FUNC_TYPE_MATH);
  1098. FUNCBINDR(smoothstep, sarray("from", "to", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1099. FUNCBINDR(move_toward, sarray("from", "to", "delta"), Variant::UTILITY_FUNC_TYPE_MATH);
  1100. FUNCBINDR(deg2rad, sarray("deg"), Variant::UTILITY_FUNC_TYPE_MATH);
  1101. FUNCBINDR(rad2deg, sarray("rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1102. FUNCBINDR(linear2db, sarray("lin"), Variant::UTILITY_FUNC_TYPE_MATH);
  1103. FUNCBINDR(db2linear, sarray("db"), Variant::UTILITY_FUNC_TYPE_MATH);
  1104. FUNCBINDVR3(wrap, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1105. FUNCBINDR(wrapi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1106. FUNCBINDR(wrapf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1107. FUNCBINDVARARG(max, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1108. FUNCBINDR(maxi, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1109. FUNCBINDR(maxf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1110. FUNCBINDVARARG(min, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1111. FUNCBINDR(mini, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1112. FUNCBINDR(minf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1113. FUNCBINDVR3(clamp, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1114. FUNCBINDR(clampi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1115. FUNCBINDR(clampf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1116. FUNCBINDR(nearest_po2, sarray("value"), Variant::UTILITY_FUNC_TYPE_MATH);
  1117. FUNCBINDR(pingpong, sarray("value", "length"), Variant::UTILITY_FUNC_TYPE_MATH);
  1118. // Random
  1119. FUNCBIND(randomize, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1120. FUNCBINDR(randi, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1121. FUNCBINDR(randf, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1122. FUNCBINDR(randi_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1123. FUNCBINDR(randf_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1124. FUNCBINDR(randfn, sarray("mean", "deviation"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1125. FUNCBIND(seed, sarray("base"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1126. FUNCBINDR(rand_from_seed, sarray("seed"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1127. // Utility
  1128. FUNCBINDVR(weakref, sarray("obj"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1129. FUNCBINDR(_typeof, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1130. FUNCBINDVARARGS(str, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1131. FUNCBINDR(error_string, sarray("error"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1132. FUNCBINDVARARGV(print, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1133. FUNCBINDVARARGV(print_rich, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1134. FUNCBINDVARARGV(printerr, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1135. FUNCBINDVARARGV(printt, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1136. FUNCBINDVARARGV(prints, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1137. FUNCBINDVARARGV(printraw, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1138. FUNCBINDVARARGV(print_verbose, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1139. FUNCBINDVARARGV(push_error, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1140. FUNCBINDVARARGV(push_warning, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1141. FUNCBINDR(var2str, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1142. FUNCBINDR(str2var, sarray("string"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1143. FUNCBINDR(var2bytes, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1144. FUNCBINDR(bytes2var, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1145. FUNCBINDR(var2bytes_with_objects, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1146. FUNCBINDR(bytes2var_with_objects, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1147. FUNCBINDR(hash, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1148. FUNCBINDR(instance_from_id, sarray("instance_id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1149. FUNCBINDR(is_instance_id_valid, sarray("id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1150. FUNCBINDR(is_instance_valid, sarray("instance"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1151. FUNCBINDR(rid_allocate_id, Vector<String>(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1152. FUNCBINDR(rid_from_int64, sarray("base"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1153. }
  1154. void Variant::_unregister_variant_utility_functions() {
  1155. utility_function_table.clear();
  1156. utility_function_name_table.clear();
  1157. }
  1158. void Variant::call_utility_function(const StringName &p_name, Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1159. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1160. if (!bfi) {
  1161. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1162. r_error.argument = 0;
  1163. r_error.expected = 0;
  1164. return;
  1165. }
  1166. if (unlikely(!bfi->is_vararg && p_argcount < bfi->argcount)) {
  1167. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1168. r_error.argument = 0;
  1169. r_error.expected = bfi->argcount;
  1170. return;
  1171. }
  1172. if (unlikely(!bfi->is_vararg && p_argcount > bfi->argcount)) {
  1173. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1174. r_error.argument = 0;
  1175. r_error.expected = bfi->argcount;
  1176. return;
  1177. }
  1178. bfi->call_utility(r_ret, p_args, p_argcount, r_error);
  1179. }
  1180. bool Variant::has_utility_function(const StringName &p_name) {
  1181. return utility_function_table.has(p_name);
  1182. }
  1183. Variant::ValidatedUtilityFunction Variant::get_validated_utility_function(const StringName &p_name) {
  1184. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1185. if (!bfi) {
  1186. return nullptr;
  1187. }
  1188. return bfi->validated_call_utility;
  1189. }
  1190. Variant::PTRUtilityFunction Variant::get_ptr_utility_function(const StringName &p_name) {
  1191. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1192. if (!bfi) {
  1193. return nullptr;
  1194. }
  1195. return bfi->ptr_call_utility;
  1196. }
  1197. Variant::UtilityFunctionType Variant::get_utility_function_type(const StringName &p_name) {
  1198. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1199. if (!bfi) {
  1200. return Variant::UTILITY_FUNC_TYPE_MATH;
  1201. }
  1202. return bfi->type;
  1203. }
  1204. MethodInfo Variant::get_utility_function_info(const StringName &p_name) {
  1205. MethodInfo info;
  1206. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1207. if (bfi) {
  1208. info.name = p_name;
  1209. if (bfi->returns_value && bfi->return_type == Variant::NIL) {
  1210. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1211. }
  1212. info.return_val.type = bfi->return_type;
  1213. if (bfi->is_vararg) {
  1214. info.flags |= METHOD_FLAG_VARARG;
  1215. }
  1216. for (int i = 0; i < bfi->argnames.size(); ++i) {
  1217. PropertyInfo arg;
  1218. arg.type = bfi->get_arg_type(i);
  1219. arg.name = bfi->argnames[i];
  1220. info.arguments.push_back(arg);
  1221. }
  1222. }
  1223. return info;
  1224. }
  1225. int Variant::get_utility_function_argument_count(const StringName &p_name) {
  1226. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1227. if (!bfi) {
  1228. return 0;
  1229. }
  1230. return bfi->argcount;
  1231. }
  1232. Variant::Type Variant::get_utility_function_argument_type(const StringName &p_name, int p_arg) {
  1233. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1234. if (!bfi) {
  1235. return Variant::NIL;
  1236. }
  1237. return bfi->get_arg_type(p_arg);
  1238. }
  1239. String Variant::get_utility_function_argument_name(const StringName &p_name, int p_arg) {
  1240. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1241. if (!bfi) {
  1242. return String();
  1243. }
  1244. ERR_FAIL_INDEX_V(p_arg, bfi->argnames.size(), String());
  1245. ERR_FAIL_COND_V(bfi->is_vararg, String());
  1246. return bfi->argnames[p_arg];
  1247. }
  1248. bool Variant::has_utility_function_return_value(const StringName &p_name) {
  1249. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1250. if (!bfi) {
  1251. return false;
  1252. }
  1253. return bfi->returns_value;
  1254. }
  1255. Variant::Type Variant::get_utility_function_return_type(const StringName &p_name) {
  1256. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1257. if (!bfi) {
  1258. return Variant::NIL;
  1259. }
  1260. return bfi->return_type;
  1261. }
  1262. bool Variant::is_utility_function_vararg(const StringName &p_name) {
  1263. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1264. if (!bfi) {
  1265. return false;
  1266. }
  1267. return bfi->is_vararg;
  1268. }
  1269. uint32_t Variant::get_utility_function_hash(const StringName &p_name) {
  1270. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1271. ERR_FAIL_COND_V(!bfi, 0);
  1272. uint32_t hash = hash_murmur3_one_32(bfi->is_vararg);
  1273. hash = hash_murmur3_one_32(bfi->returns_value, hash);
  1274. if (bfi->returns_value) {
  1275. hash = hash_murmur3_one_32(bfi->return_type, hash);
  1276. }
  1277. hash = hash_murmur3_one_32(bfi->argcount, hash);
  1278. for (int i = 0; i < bfi->argcount; i++) {
  1279. hash = hash_murmur3_one_32(bfi->get_arg_type(i), hash);
  1280. }
  1281. return hash_fmix32(hash);
  1282. }
  1283. void Variant::get_utility_function_list(List<StringName> *r_functions) {
  1284. for (const StringName &E : utility_function_name_table) {
  1285. r_functions->push_back(E);
  1286. }
  1287. }
  1288. int Variant::get_utility_function_count() {
  1289. return utility_function_name_table.size();
  1290. }