variant_utility.cpp 89 KB

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