variant_utility.cpp 87 KB

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