variant_utility.cpp 80 KB

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