variant_utility.cpp 87 KB

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