variant_utility.cpp 79 KB

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