variant_utility.cpp 63 KB

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