variant_utility.cpp 79 KB

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