variant_utility.cpp 89 KB

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