variant_utility.cpp 72 KB

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