variant_utility.cpp 72 KB

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