variant_utility.cpp 79 KB

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