variant_utility.cpp 79 KB

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