variant_utility.cpp 66 KB

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