variant_utility.cpp 83 KB

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