variant_utility.cpp 62 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407
  1. /*************************************************************************/
  2. /* variant_utility.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2021 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/variant/binder_common.h"
  37. #include "core/variant/variant_parser.h"
  38. struct VariantUtilityFunctions {
  39. // Math
  40. static inline double sin(double arg) {
  41. return Math::sin(arg);
  42. }
  43. static inline double cos(double arg) {
  44. return Math::cos(arg);
  45. }
  46. static inline double tan(double arg) {
  47. return Math::tan(arg);
  48. }
  49. static inline double sinh(double arg) {
  50. return Math::sinh(arg);
  51. }
  52. static inline double cosh(double arg) {
  53. return Math::cosh(arg);
  54. }
  55. static inline double tanh(double arg) {
  56. return Math::tanh(arg);
  57. }
  58. static inline double asin(double arg) {
  59. return Math::asin(arg);
  60. }
  61. static inline double acos(double arg) {
  62. return Math::acos(arg);
  63. }
  64. static inline double atan(double arg) {
  65. return Math::atan(arg);
  66. }
  67. static inline double atan2(double y, double x) {
  68. return Math::atan2(y, x);
  69. }
  70. static inline double sqrt(double x) {
  71. return Math::sqrt(x);
  72. }
  73. static inline double fmod(double b, double r) {
  74. return Math::fmod(b, r);
  75. }
  76. static inline double fposmod(double b, double r) {
  77. return Math::fposmod(b, r);
  78. }
  79. static inline int64_t posmod(int64_t b, int64_t r) {
  80. return Math::posmod(b, r);
  81. }
  82. static inline double floor(double x) {
  83. return Math::floor(x);
  84. }
  85. static inline double ceil(double x) {
  86. return Math::ceil(x);
  87. }
  88. static inline double round(double x) {
  89. return Math::round(x);
  90. }
  91. static inline Variant abs(const Variant &x, Callable::CallError &r_error) {
  92. r_error.error = Callable::CallError::CALL_OK;
  93. switch (x.get_type()) {
  94. case Variant::INT: {
  95. return ABS(VariantInternalAccessor<int64_t>::get(&x));
  96. } break;
  97. case Variant::FLOAT: {
  98. return Math::absd(VariantInternalAccessor<double>::get(&x));
  99. } break;
  100. case Variant::VECTOR2: {
  101. return VariantInternalAccessor<Vector2>::get(&x).abs();
  102. } break;
  103. case Variant::VECTOR2I: {
  104. return VariantInternalAccessor<Vector2i>::get(&x).abs();
  105. } break;
  106. case Variant::VECTOR3: {
  107. return VariantInternalAccessor<Vector3>::get(&x).abs();
  108. } break;
  109. case Variant::VECTOR3I: {
  110. return VariantInternalAccessor<Vector3i>::get(&x).abs();
  111. } break;
  112. default: {
  113. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  114. return Variant();
  115. }
  116. }
  117. }
  118. static inline double absf(double x) {
  119. return Math::absd(x);
  120. }
  121. static inline int64_t absi(int64_t x) {
  122. return ABS(x);
  123. }
  124. static inline Variant sign(const Variant &x, Callable::CallError &r_error) {
  125. r_error.error = Callable::CallError::CALL_OK;
  126. switch (x.get_type()) {
  127. case Variant::INT: {
  128. return SGN(VariantInternalAccessor<int64_t>::get(&x));
  129. } break;
  130. case Variant::FLOAT: {
  131. return SGN(VariantInternalAccessor<double>::get(&x));
  132. } break;
  133. case Variant::VECTOR2: {
  134. return VariantInternalAccessor<Vector2>::get(&x).sign();
  135. } break;
  136. case Variant::VECTOR2I: {
  137. return VariantInternalAccessor<Vector2i>::get(&x).sign();
  138. } break;
  139. case Variant::VECTOR3: {
  140. return VariantInternalAccessor<Vector3>::get(&x).sign();
  141. } break;
  142. case Variant::VECTOR3I: {
  143. return VariantInternalAccessor<Vector3i>::get(&x).sign();
  144. } break;
  145. default: {
  146. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  147. return Variant();
  148. }
  149. }
  150. }
  151. static inline double signf(double x) {
  152. return SGN(x);
  153. }
  154. static inline int64_t signi(int64_t x) {
  155. return SGN(x);
  156. }
  157. static inline double pow(double x, double y) {
  158. return Math::pow(x, y);
  159. }
  160. static inline double log(double x) {
  161. return Math::log(x);
  162. }
  163. static inline double exp(double x) {
  164. return Math::exp(x);
  165. }
  166. static inline bool is_nan(double x) {
  167. return Math::is_nan(x);
  168. }
  169. static inline bool is_inf(double x) {
  170. return Math::is_inf(x);
  171. }
  172. static inline bool is_equal_approx(double x, double y) {
  173. return Math::is_equal_approx(x, y);
  174. }
  175. static inline bool is_zero_approx(double x) {
  176. return Math::is_zero_approx(x);
  177. }
  178. static inline double ease(float x, float curve) {
  179. return Math::ease(x, curve);
  180. }
  181. static inline int step_decimals(float step) {
  182. return Math::step_decimals(step);
  183. }
  184. static inline int range_step_decimals(float step) {
  185. return Math::range_step_decimals(step);
  186. }
  187. static inline double snapped(double value, double step) {
  188. return Math::snapped(value, step);
  189. }
  190. static inline double lerp(double from, double to, double weight) {
  191. return Math::lerp(from, to, weight);
  192. }
  193. static inline double lerp_angle(double from, double to, double weight) {
  194. return Math::lerp_angle(from, to, weight);
  195. }
  196. static inline double inverse_lerp(double from, double to, double weight) {
  197. return Math::inverse_lerp(from, to, weight);
  198. }
  199. static inline double range_lerp(double value, double istart, double istop, double ostart, double ostop) {
  200. return Math::range_lerp(value, istart, istop, ostart, ostop);
  201. }
  202. static inline double smoothstep(double from, double to, double val) {
  203. return Math::smoothstep(from, to, val);
  204. }
  205. static inline double move_toward(double from, double to, double delta) {
  206. return Math::move_toward(from, to, delta);
  207. }
  208. static inline double dectime(double value, double amount, double step) {
  209. return Math::dectime(value, amount, step);
  210. }
  211. static inline double deg2rad(double angle_deg) {
  212. return Math::deg2rad(angle_deg);
  213. }
  214. static inline double rad2deg(double angle_rad) {
  215. return Math::rad2deg(angle_rad);
  216. }
  217. static inline double linear2db(double linear) {
  218. return Math::linear2db(linear);
  219. }
  220. static inline double db2linear(double db) {
  221. return Math::db2linear(db);
  222. }
  223. static inline Vector2 polar2cartesian(double r, double th) {
  224. return Vector2(r * Math::cos(th), r * Math::sin(th));
  225. }
  226. static inline Vector2 cartesian2polar(double x, double y) {
  227. return Vector2(Math::sqrt(x * x + y * y), Math::atan2(y, x));
  228. }
  229. static inline int64_t wrapi(int64_t value, int64_t min, int64_t max) {
  230. return Math::wrapi(value, min, max);
  231. }
  232. static inline double wrapf(double value, double min, double max) {
  233. return Math::wrapf(value, min, max);
  234. }
  235. static inline Variant max(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  236. if (p_argcount < 2) {
  237. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  238. r_error.expected = 2;
  239. return Variant();
  240. }
  241. Variant base = *p_args[0];
  242. Variant ret;
  243. for (int i = 1; i < p_argcount; i++) {
  244. bool valid;
  245. Variant::evaluate(Variant::OP_LESS, base, *p_args[i], ret, valid);
  246. if (!valid) {
  247. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  248. r_error.expected = base.get_type();
  249. r_error.argument = i;
  250. return Variant();
  251. }
  252. if (ret.booleanize()) {
  253. base = *p_args[i];
  254. }
  255. }
  256. r_error.error = Callable::CallError::CALL_OK;
  257. return base;
  258. }
  259. static inline double maxf(double x, double y) {
  260. return MAX(x, y);
  261. }
  262. static inline int64_t maxi(int64_t x, int64_t y) {
  263. return MAX(x, y);
  264. }
  265. static inline Variant min(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  266. if (p_argcount < 2) {
  267. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  268. r_error.expected = 2;
  269. return Variant();
  270. }
  271. Variant base = *p_args[0];
  272. Variant ret;
  273. for (int i = 1; i < p_argcount; i++) {
  274. bool valid;
  275. Variant::evaluate(Variant::OP_GREATER, base, *p_args[i], ret, valid);
  276. if (!valid) {
  277. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  278. r_error.expected = base.get_type();
  279. r_error.argument = i;
  280. return Variant();
  281. }
  282. if (ret.booleanize()) {
  283. base = *p_args[i];
  284. }
  285. }
  286. r_error.error = Callable::CallError::CALL_OK;
  287. return base;
  288. }
  289. static inline double minf(double x, double y) {
  290. return MIN(x, y);
  291. }
  292. static inline int64_t mini(int64_t x, int64_t y) {
  293. return MIN(x, y);
  294. }
  295. static inline Variant clamp(const Variant &x, const Variant &min, const Variant &max, Callable::CallError &r_error) {
  296. Variant value = x;
  297. Variant ret;
  298. bool valid;
  299. Variant::evaluate(Variant::OP_LESS, value, min, ret, valid);
  300. if (!valid) {
  301. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  302. r_error.expected = value.get_type();
  303. r_error.argument = 1;
  304. return Variant();
  305. }
  306. if (ret.booleanize()) {
  307. value = min;
  308. }
  309. Variant::evaluate(Variant::OP_GREATER, value, max, ret, valid);
  310. if (!valid) {
  311. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  312. r_error.expected = value.get_type();
  313. r_error.argument = 2;
  314. return Variant();
  315. }
  316. if (ret.booleanize()) {
  317. value = max;
  318. }
  319. r_error.error = Callable::CallError::CALL_OK;
  320. return value;
  321. }
  322. static inline double clampf(double x, double min, double max) {
  323. return CLAMP(x, min, max);
  324. }
  325. static inline int64_t clampi(int64_t x, int64_t min, int64_t max) {
  326. return CLAMP(x, min, max);
  327. }
  328. static inline int64_t nearest_po2(int64_t x) {
  329. return nearest_power_of_2_templated(uint64_t(x));
  330. }
  331. // Random
  332. static inline void randomize() {
  333. Math::randomize();
  334. }
  335. static inline int64_t randi() {
  336. return Math::rand();
  337. }
  338. static inline double randf() {
  339. return Math::randf();
  340. }
  341. static inline int64_t randi_range(int64_t from, int64_t to) {
  342. return Math::random((int32_t)from, (int32_t)to);
  343. }
  344. static inline double randf_range(double from, double to) {
  345. return Math::random(from, to);
  346. }
  347. static inline void seed(int64_t s) {
  348. return Math::seed(s);
  349. }
  350. static inline PackedInt64Array rand_from_seed(int64_t seed) {
  351. uint64_t s = seed;
  352. PackedInt64Array arr;
  353. arr.resize(2);
  354. arr.write[0] = Math::rand_from_seed(&s);
  355. arr.write[1] = s;
  356. return arr;
  357. }
  358. // Utility
  359. static inline Variant weakref(const Variant &obj, Callable::CallError &r_error) {
  360. if (obj.get_type() == Variant::OBJECT) {
  361. r_error.error = Callable::CallError::CALL_OK;
  362. if (obj.is_ref()) {
  363. Ref<WeakRef> wref = memnew(WeakRef);
  364. REF r = obj;
  365. if (r.is_valid()) {
  366. wref->set_ref(r);
  367. }
  368. return wref;
  369. } else {
  370. Ref<WeakRef> wref = memnew(WeakRef);
  371. Object *o = obj.get_validated_object();
  372. if (o) {
  373. wref->set_obj(o);
  374. }
  375. return wref;
  376. }
  377. } else if (obj.get_type() == Variant::NIL) {
  378. r_error.error = Callable::CallError::CALL_OK;
  379. Ref<WeakRef> wref = memnew(WeakRef);
  380. return wref;
  381. } else {
  382. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  383. r_error.argument = 0;
  384. r_error.expected = Variant::OBJECT;
  385. return Variant();
  386. }
  387. }
  388. static inline int64_t _typeof(const Variant &obj) {
  389. return obj.get_type();
  390. }
  391. static inline String str(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  392. if (p_arg_count < 1) {
  393. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  394. r_error.argument = 1;
  395. return String();
  396. }
  397. String str;
  398. for (int i = 0; i < p_arg_count; i++) {
  399. String os = p_args[i]->operator String();
  400. if (i == 0) {
  401. str = os;
  402. } else {
  403. str += os;
  404. }
  405. }
  406. r_error.error = Callable::CallError::CALL_OK;
  407. return str;
  408. }
  409. static inline void print(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  410. if (p_arg_count < 1) {
  411. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  412. r_error.argument = 1;
  413. }
  414. String str;
  415. for (int i = 0; i < p_arg_count; i++) {
  416. String os = p_args[i]->operator String();
  417. if (i == 0) {
  418. str = os;
  419. } else {
  420. str += os;
  421. }
  422. }
  423. print_line(str);
  424. r_error.error = Callable::CallError::CALL_OK;
  425. }
  426. static inline void printerr(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  427. if (p_arg_count < 1) {
  428. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  429. r_error.argument = 1;
  430. }
  431. String str;
  432. for (int i = 0; i < p_arg_count; i++) {
  433. String os = p_args[i]->operator String();
  434. if (i == 0) {
  435. str = os;
  436. } else {
  437. str += os;
  438. }
  439. }
  440. print_error(str);
  441. r_error.error = Callable::CallError::CALL_OK;
  442. }
  443. static inline void printt(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  444. if (p_arg_count < 1) {
  445. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  446. r_error.argument = 1;
  447. }
  448. String str;
  449. for (int i = 0; i < p_arg_count; i++) {
  450. if (i) {
  451. str += "\t";
  452. }
  453. str += p_args[i]->operator String();
  454. }
  455. print_line(str);
  456. r_error.error = Callable::CallError::CALL_OK;
  457. }
  458. static inline void prints(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  459. if (p_arg_count < 1) {
  460. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  461. r_error.argument = 1;
  462. }
  463. String str;
  464. for (int i = 0; i < p_arg_count; i++) {
  465. if (i) {
  466. str += " ";
  467. }
  468. str += p_args[i]->operator String();
  469. }
  470. print_line(str);
  471. r_error.error = Callable::CallError::CALL_OK;
  472. }
  473. static inline void printraw(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  474. if (p_arg_count < 1) {
  475. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  476. r_error.argument = 1;
  477. }
  478. String str;
  479. for (int i = 0; i < p_arg_count; i++) {
  480. String os = p_args[i]->operator String();
  481. if (i == 0) {
  482. str = os;
  483. } else {
  484. str += os;
  485. }
  486. }
  487. OS::get_singleton()->print("%s", str.utf8().get_data());
  488. r_error.error = Callable::CallError::CALL_OK;
  489. }
  490. static inline void push_error(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  491. if (p_arg_count < 1) {
  492. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  493. r_error.argument = 1;
  494. }
  495. String str;
  496. for (int i = 0; i < p_arg_count; i++) {
  497. String os = p_args[i]->operator String();
  498. if (i == 0) {
  499. str = os;
  500. } else {
  501. str += os;
  502. }
  503. }
  504. ERR_PRINT(str);
  505. r_error.error = Callable::CallError::CALL_OK;
  506. }
  507. static inline void push_warning(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  508. if (p_arg_count < 1) {
  509. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  510. r_error.argument = 1;
  511. }
  512. String str;
  513. for (int i = 0; i < p_arg_count; i++) {
  514. String os = p_args[i]->operator String();
  515. if (i == 0) {
  516. str = os;
  517. } else {
  518. str += os;
  519. }
  520. }
  521. WARN_PRINT(str);
  522. r_error.error = Callable::CallError::CALL_OK;
  523. }
  524. static inline String var2str(const Variant &p_var) {
  525. String vars;
  526. VariantWriter::write_to_string(p_var, vars);
  527. return vars;
  528. }
  529. static inline Variant str2var(const String &p_var) {
  530. VariantParser::StreamString ss;
  531. ss.s = p_var;
  532. String errs;
  533. int line;
  534. Variant ret;
  535. (void)VariantParser::parse(&ss, ret, errs, line);
  536. return ret;
  537. }
  538. static inline PackedByteArray var2bytes(const Variant &p_var) {
  539. int len;
  540. Error err = encode_variant(p_var, nullptr, len, false);
  541. if (err != OK) {
  542. return PackedByteArray();
  543. }
  544. PackedByteArray barr;
  545. barr.resize(len);
  546. {
  547. uint8_t *w = barr.ptrw();
  548. err = encode_variant(p_var, w, len, false);
  549. if (err != OK) {
  550. return PackedByteArray();
  551. }
  552. }
  553. return barr;
  554. }
  555. static inline PackedByteArray var2bytes_with_objects(const Variant &p_var) {
  556. int len;
  557. Error err = encode_variant(p_var, nullptr, len, true);
  558. if (err != OK) {
  559. return PackedByteArray();
  560. }
  561. PackedByteArray barr;
  562. barr.resize(len);
  563. {
  564. uint8_t *w = barr.ptrw();
  565. err = encode_variant(p_var, w, len, true);
  566. if (err != OK) {
  567. return PackedByteArray();
  568. }
  569. }
  570. return barr;
  571. }
  572. static inline Variant bytes2var(const PackedByteArray &p_arr) {
  573. Variant ret;
  574. {
  575. const uint8_t *r = p_arr.ptr();
  576. Error err = decode_variant(ret, r, p_arr.size(), nullptr, false);
  577. if (err != OK) {
  578. return Variant();
  579. }
  580. }
  581. return ret;
  582. }
  583. static inline Variant bytes2var_with_objects(const PackedByteArray &p_arr) {
  584. Variant ret;
  585. {
  586. const uint8_t *r = p_arr.ptr();
  587. Error err = decode_variant(ret, r, p_arr.size(), nullptr, true);
  588. if (err != OK) {
  589. return Variant();
  590. }
  591. }
  592. return ret;
  593. }
  594. static inline int64_t hash(const Variant &p_arr) {
  595. return p_arr.hash();
  596. }
  597. static inline Object *instance_from_id(int64_t p_id) {
  598. ObjectID id = ObjectID((uint64_t)p_id);
  599. Object *ret = ObjectDB::get_instance(id);
  600. return ret;
  601. }
  602. static inline bool is_instance_id_valid(int64_t p_id) {
  603. return ObjectDB::get_instance(ObjectID((uint64_t)p_id)) != nullptr;
  604. }
  605. static inline bool is_instance_valid(const Variant &p_instance) {
  606. if (p_instance.get_type() != Variant::OBJECT) {
  607. return false;
  608. }
  609. return p_instance.get_validated_object() != nullptr;
  610. }
  611. };
  612. #ifdef DEBUG_METHODS_ENABLED
  613. #define VCALLR *ret = p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  614. #define VCALL p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  615. #else
  616. #define VCALLR *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...)
  617. #define VCALL p_func(VariantCaster<P>::cast(*p_args[Is])...)
  618. #endif
  619. template <class R, class... P, size_t... Is>
  620. static _FORCE_INLINE_ void call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  621. r_error.error = Callable::CallError::CALL_OK;
  622. VCALLR;
  623. (void)p_args; // avoid gcc warning
  624. (void)r_error;
  625. }
  626. template <class R, class... P, size_t... Is>
  627. static _FORCE_INLINE_ void validated_call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, IndexSequence<Is...>) {
  628. *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...);
  629. (void)p_args;
  630. }
  631. template <class R, class... P, size_t... Is>
  632. static _FORCE_INLINE_ void ptr_call_helperpr(R (*p_func)(P...), void *ret, const void **p_args, IndexSequence<Is...>) {
  633. PtrToArg<R>::encode(p_func(PtrToArg<P>::convert(p_args[Is])...), ret);
  634. (void)p_args;
  635. }
  636. template <class R, class... P>
  637. static _FORCE_INLINE_ void call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error) {
  638. call_helperpr(p_func, ret, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  639. }
  640. template <class R, class... P>
  641. static _FORCE_INLINE_ void validated_call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args) {
  642. validated_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  643. }
  644. template <class R, class... P>
  645. static _FORCE_INLINE_ void ptr_call_helperr(R (*p_func)(P...), void *ret, const void **p_args) {
  646. ptr_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  647. }
  648. template <class R, class... P>
  649. static _FORCE_INLINE_ int get_arg_count_helperr(R (*p_func)(P...)) {
  650. return sizeof...(P);
  651. }
  652. template <class R, class... P>
  653. static _FORCE_INLINE_ Variant::Type get_arg_type_helperr(R (*p_func)(P...), int p_arg) {
  654. return call_get_argument_type<P...>(p_arg);
  655. }
  656. template <class R, class... P>
  657. static _FORCE_INLINE_ Variant::Type get_ret_type_helperr(R (*p_func)(P...)) {
  658. return GetTypeInfo<R>::VARIANT_TYPE;
  659. }
  660. // WITHOUT RET
  661. template <class... P, size_t... Is>
  662. static _FORCE_INLINE_ void call_helperp(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  663. r_error.error = Callable::CallError::CALL_OK;
  664. VCALL;
  665. (void)p_args;
  666. (void)r_error;
  667. }
  668. template <class... P, size_t... Is>
  669. static _FORCE_INLINE_ void validated_call_helperp(void (*p_func)(P...), const Variant **p_args, IndexSequence<Is...>) {
  670. p_func(VariantCaster<P>::cast(*p_args[Is])...);
  671. (void)p_args;
  672. }
  673. template <class... P, size_t... Is>
  674. static _FORCE_INLINE_ void ptr_call_helperp(void (*p_func)(P...), const void **p_args, IndexSequence<Is...>) {
  675. p_func(PtrToArg<P>::convert(p_args[Is])...);
  676. (void)p_args;
  677. }
  678. template <class... P>
  679. static _FORCE_INLINE_ void call_helper(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error) {
  680. call_helperp(p_func, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  681. }
  682. template <class... P>
  683. static _FORCE_INLINE_ void validated_call_helper(void (*p_func)(P...), const Variant **p_args) {
  684. validated_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  685. }
  686. template <class... P>
  687. static _FORCE_INLINE_ void ptr_call_helper(void (*p_func)(P...), const void **p_args) {
  688. ptr_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  689. }
  690. template <class... P>
  691. static _FORCE_INLINE_ int get_arg_count_helper(void (*p_func)(P...)) {
  692. return sizeof...(P);
  693. }
  694. template <class... P>
  695. static _FORCE_INLINE_ Variant::Type get_arg_type_helper(void (*p_func)(P...), int p_arg) {
  696. return call_get_argument_type<P...>(p_arg);
  697. }
  698. template <class... P>
  699. static _FORCE_INLINE_ Variant::Type get_ret_type_helper(void (*p_func)(P...)) {
  700. return Variant::NIL;
  701. }
  702. #define FUNCBINDR(m_func, m_args, m_category) \
  703. class Func_##m_func { \
  704. public: \
  705. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  706. call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args, r_error); \
  707. } \
  708. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  709. validated_call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args); \
  710. } \
  711. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  712. ptr_call_helperr(VariantUtilityFunctions::m_func, ret, p_args); \
  713. } \
  714. static int get_argument_count() { \
  715. return get_arg_count_helperr(VariantUtilityFunctions::m_func); \
  716. } \
  717. static Variant::Type get_argument_type(int p_arg) { \
  718. return get_arg_type_helperr(VariantUtilityFunctions::m_func, p_arg); \
  719. } \
  720. static Variant::Type get_return_type() { \
  721. return get_ret_type_helperr(VariantUtilityFunctions::m_func); \
  722. } \
  723. static bool has_return_type() { \
  724. return true; \
  725. } \
  726. static bool is_vararg() { return false; } \
  727. static Variant::UtilityFunctionType get_type() { return m_category; } \
  728. }; \
  729. register_utility_function<Func_##m_func>(#m_func, m_args)
  730. #define FUNCBINDVR(m_func, m_args, m_category) \
  731. class Func_##m_func { \
  732. public: \
  733. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  734. r_error.error = Callable::CallError::CALL_OK; \
  735. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], r_error); \
  736. } \
  737. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  738. Callable::CallError ce; \
  739. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], ce); \
  740. } \
  741. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  742. Callable::CallError ce; \
  743. PtrToArg<Variant>::encode(VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), ce), ret); \
  744. } \
  745. static int get_argument_count() { \
  746. return 1; \
  747. } \
  748. static Variant::Type get_argument_type(int p_arg) { \
  749. return Variant::NIL; \
  750. } \
  751. static Variant::Type get_return_type() { \
  752. return Variant::NIL; \
  753. } \
  754. static bool has_return_type() { \
  755. return true; \
  756. } \
  757. static bool is_vararg() { return false; } \
  758. static Variant::UtilityFunctionType get_type() { return m_category; } \
  759. }; \
  760. register_utility_function<Func_##m_func>(#m_func, m_args)
  761. #define FUNCBINDVR3(m_func, m_args, m_category) \
  762. class Func_##m_func { \
  763. public: \
  764. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  765. r_error.error = Callable::CallError::CALL_OK; \
  766. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], r_error); \
  767. } \
  768. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  769. Callable::CallError ce; \
  770. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], ce); \
  771. } \
  772. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  773. Callable::CallError ce; \
  774. Variant r; \
  775. r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), PtrToArg<Variant>::convert(p_args[2]), ce); \
  776. PtrToArg<Variant>::encode(r, ret); \
  777. } \
  778. static int get_argument_count() { \
  779. return 3; \
  780. } \
  781. static Variant::Type get_argument_type(int p_arg) { \
  782. return Variant::NIL; \
  783. } \
  784. static Variant::Type get_return_type() { \
  785. return Variant::NIL; \
  786. } \
  787. static bool has_return_type() { \
  788. return true; \
  789. } \
  790. static bool is_vararg() { return false; } \
  791. static Variant::UtilityFunctionType get_type() { return m_category; } \
  792. }; \
  793. register_utility_function<Func_##m_func>(#m_func, m_args)
  794. #define FUNCBINDVARARG(m_func, m_args, m_category) \
  795. class Func_##m_func { \
  796. public: \
  797. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  798. r_error.error = Callable::CallError::CALL_OK; \
  799. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  800. } \
  801. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  802. Callable::CallError c; \
  803. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  804. } \
  805. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  806. Vector<Variant> args; \
  807. for (int i = 0; i < p_argcount; i++) { \
  808. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  809. } \
  810. Vector<const Variant *> argsp; \
  811. for (int i = 0; i < p_argcount; i++) { \
  812. argsp.push_back(&args[i]); \
  813. } \
  814. Variant r; \
  815. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  816. PtrToArg<Variant>::encode(r, ret); \
  817. } \
  818. static int get_argument_count() { \
  819. return 2; \
  820. } \
  821. static Variant::Type get_argument_type(int p_arg) { \
  822. return Variant::NIL; \
  823. } \
  824. static Variant::Type get_return_type() { \
  825. return Variant::NIL; \
  826. } \
  827. static bool has_return_type() { \
  828. return true; \
  829. } \
  830. static bool is_vararg() { \
  831. return true; \
  832. } \
  833. static Variant::UtilityFunctionType get_type() { \
  834. return m_category; \
  835. } \
  836. }; \
  837. register_utility_function<Func_##m_func>(#m_func, m_args)
  838. #define FUNCBINDVARARGS(m_func, m_args, m_category) \
  839. class Func_##m_func { \
  840. public: \
  841. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  842. r_error.error = Callable::CallError::CALL_OK; \
  843. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  844. } \
  845. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  846. Callable::CallError c; \
  847. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  848. } \
  849. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  850. Vector<Variant> args; \
  851. for (int i = 0; i < p_argcount; i++) { \
  852. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  853. } \
  854. Vector<const Variant *> argsp; \
  855. for (int i = 0; i < p_argcount; i++) { \
  856. argsp.push_back(&args[i]); \
  857. } \
  858. Variant r; \
  859. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  860. PtrToArg<String>::encode(r.operator String(), ret); \
  861. } \
  862. static int get_argument_count() { \
  863. return 1; \
  864. } \
  865. static Variant::Type get_argument_type(int p_arg) { \
  866. return Variant::NIL; \
  867. } \
  868. static Variant::Type get_return_type() { \
  869. return Variant::STRING; \
  870. } \
  871. static bool has_return_type() { \
  872. return true; \
  873. } \
  874. static bool is_vararg() { \
  875. return true; \
  876. } \
  877. static Variant::UtilityFunctionType get_type() { \
  878. return m_category; \
  879. } \
  880. }; \
  881. register_utility_function<Func_##m_func>(#m_func, m_args)
  882. #define FUNCBINDVARARGV(m_func, m_args, m_category) \
  883. class Func_##m_func { \
  884. public: \
  885. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  886. r_error.error = Callable::CallError::CALL_OK; \
  887. VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  888. } \
  889. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  890. Callable::CallError c; \
  891. VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  892. } \
  893. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  894. Vector<Variant> args; \
  895. for (int i = 0; i < p_argcount; i++) { \
  896. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  897. } \
  898. Vector<const Variant *> argsp; \
  899. for (int i = 0; i < p_argcount; i++) { \
  900. argsp.push_back(&args[i]); \
  901. } \
  902. Variant r; \
  903. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  904. } \
  905. static int get_argument_count() { \
  906. return 1; \
  907. } \
  908. static Variant::Type get_argument_type(int p_arg) { \
  909. return Variant::NIL; \
  910. } \
  911. static Variant::Type get_return_type() { \
  912. return Variant::NIL; \
  913. } \
  914. static bool has_return_type() { \
  915. return false; \
  916. } \
  917. static bool is_vararg() { \
  918. return true; \
  919. } \
  920. static Variant::UtilityFunctionType get_type() { \
  921. return m_category; \
  922. } \
  923. }; \
  924. register_utility_function<Func_##m_func>(#m_func, m_args)
  925. #define FUNCBIND(m_func, m_args, m_category) \
  926. class Func_##m_func { \
  927. public: \
  928. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  929. call_helper(VariantUtilityFunctions::m_func, p_args, r_error); \
  930. } \
  931. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  932. validated_call_helper(VariantUtilityFunctions::m_func, p_args); \
  933. } \
  934. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  935. ptr_call_helper(VariantUtilityFunctions::m_func, p_args); \
  936. } \
  937. static int get_argument_count() { \
  938. return get_arg_count_helper(VariantUtilityFunctions::m_func); \
  939. } \
  940. static Variant::Type get_argument_type(int p_arg) { \
  941. return get_arg_type_helper(VariantUtilityFunctions::m_func, p_arg); \
  942. } \
  943. static Variant::Type get_return_type() { \
  944. return get_ret_type_helper(VariantUtilityFunctions::m_func); \
  945. } \
  946. static bool has_return_type() { \
  947. return false; \
  948. } \
  949. static bool is_vararg() { return false; } \
  950. static Variant::UtilityFunctionType get_type() { return m_category; } \
  951. }; \
  952. register_utility_function<Func_##m_func>(#m_func, m_args)
  953. struct VariantUtilityFunctionInfo {
  954. void (*call_utility)(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error);
  955. Variant::ValidatedUtilityFunction validated_call_utility;
  956. Variant::PTRUtilityFunction ptr_call_utility;
  957. Vector<String> argnames;
  958. bool is_vararg;
  959. bool returns_value;
  960. int argcount;
  961. Variant::Type (*get_arg_type)(int);
  962. Variant::Type return_type;
  963. Variant::UtilityFunctionType type;
  964. };
  965. static OAHashMap<StringName, VariantUtilityFunctionInfo> utility_function_table;
  966. static List<StringName> utility_function_name_table;
  967. template <class T>
  968. static void register_utility_function(const String &p_name, const Vector<String> &argnames) {
  969. String name = p_name;
  970. if (name.begins_with("_")) {
  971. name = name.substr(1, name.length() - 1);
  972. }
  973. StringName sname = name;
  974. ERR_FAIL_COND(utility_function_table.has(sname));
  975. VariantUtilityFunctionInfo bfi;
  976. bfi.call_utility = T::call;
  977. bfi.validated_call_utility = T::validated_call;
  978. bfi.ptr_call_utility = T::ptrcall;
  979. bfi.is_vararg = T::is_vararg();
  980. bfi.argnames = argnames;
  981. bfi.argcount = T::get_argument_count();
  982. if (!bfi.is_vararg) {
  983. ERR_FAIL_COND_MSG(argnames.size() != bfi.argcount, "wrong number of arguments binding utility function: " + name);
  984. }
  985. bfi.get_arg_type = T::get_argument_type;
  986. bfi.return_type = T::get_return_type();
  987. bfi.type = T::get_type();
  988. bfi.returns_value = T::has_return_type();
  989. utility_function_table.insert(sname, bfi);
  990. utility_function_name_table.push_back(sname);
  991. }
  992. void Variant::_register_variant_utility_functions() {
  993. // Math
  994. FUNCBINDR(sin, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  995. FUNCBINDR(cos, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  996. FUNCBINDR(tan, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  997. FUNCBINDR(sinh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  998. FUNCBINDR(cosh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  999. FUNCBINDR(tanh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1000. FUNCBINDR(asin, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1001. FUNCBINDR(acos, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1002. FUNCBINDR(atan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1003. FUNCBINDR(atan2, sarray("y", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1004. FUNCBINDR(sqrt, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1005. FUNCBINDR(fmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1006. FUNCBINDR(fposmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1007. FUNCBINDR(posmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1008. FUNCBINDR(floor, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1009. FUNCBINDR(ceil, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1010. FUNCBINDR(round, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1011. FUNCBINDVR(abs, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1012. FUNCBINDR(absf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1013. FUNCBINDR(absi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1014. FUNCBINDVR(sign, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1015. FUNCBINDR(signf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1016. FUNCBINDR(signi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1017. FUNCBINDR(pow, sarray("base", "exp"), Variant::UTILITY_FUNC_TYPE_MATH);
  1018. FUNCBINDR(log, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1019. FUNCBINDR(exp, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1020. FUNCBINDR(is_nan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1021. FUNCBINDR(is_inf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1022. FUNCBINDR(is_equal_approx, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1023. FUNCBINDR(is_zero_approx, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1024. FUNCBINDR(ease, sarray("x", "curve"), Variant::UTILITY_FUNC_TYPE_MATH);
  1025. FUNCBINDR(step_decimals, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1026. FUNCBINDR(range_step_decimals, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1027. FUNCBINDR(snapped, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1028. FUNCBINDR(lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1029. FUNCBINDR(lerp_angle, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1030. FUNCBINDR(inverse_lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1031. FUNCBINDR(range_lerp, sarray("value", "istart", "istop", "ostart", "ostop"), Variant::UTILITY_FUNC_TYPE_MATH);
  1032. FUNCBINDR(smoothstep, sarray("from", "to", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1033. FUNCBINDR(move_toward, sarray("from", "to", "delta"), Variant::UTILITY_FUNC_TYPE_MATH);
  1034. FUNCBINDR(dectime, sarray("value", "amount", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1035. FUNCBINDR(deg2rad, sarray("deg"), Variant::UTILITY_FUNC_TYPE_MATH);
  1036. FUNCBINDR(rad2deg, sarray("rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1037. FUNCBINDR(linear2db, sarray("lin"), Variant::UTILITY_FUNC_TYPE_MATH);
  1038. FUNCBINDR(db2linear, sarray("db"), Variant::UTILITY_FUNC_TYPE_MATH);
  1039. FUNCBINDR(polar2cartesian, sarray("r", "th"), Variant::UTILITY_FUNC_TYPE_MATH);
  1040. FUNCBINDR(cartesian2polar, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1041. FUNCBINDR(wrapi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1042. FUNCBINDR(wrapf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1043. FUNCBINDVARARG(max, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1044. FUNCBINDR(maxi, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1045. FUNCBINDR(maxf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1046. FUNCBINDVARARG(min, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1047. FUNCBINDR(mini, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1048. FUNCBINDR(minf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1049. FUNCBINDVR3(clamp, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1050. FUNCBINDR(clampi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1051. FUNCBINDR(clampf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1052. FUNCBINDR(nearest_po2, sarray("value"), Variant::UTILITY_FUNC_TYPE_MATH);
  1053. // Random
  1054. FUNCBIND(randomize, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1055. FUNCBINDR(randi, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1056. FUNCBINDR(randf, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1057. FUNCBINDR(randi_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1058. FUNCBINDR(randf_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1059. FUNCBIND(seed, sarray("base"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1060. FUNCBINDR(rand_from_seed, sarray("seed"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1061. // Utility
  1062. FUNCBINDVR(weakref, sarray("obj"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1063. FUNCBINDR(_typeof, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1064. FUNCBINDVARARGS(str, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1065. FUNCBINDVARARGV(print, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1066. FUNCBINDVARARGV(printerr, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1067. FUNCBINDVARARGV(printt, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1068. FUNCBINDVARARGV(prints, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1069. FUNCBINDVARARGV(printraw, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1070. FUNCBINDVARARGV(push_error, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1071. FUNCBINDVARARGV(push_warning, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1072. FUNCBINDR(var2str, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1073. FUNCBINDR(str2var, sarray("string"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1074. FUNCBINDR(var2bytes, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1075. FUNCBINDR(bytes2var, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1076. FUNCBINDR(var2bytes_with_objects, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1077. FUNCBINDR(bytes2var_with_objects, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1078. FUNCBINDR(hash, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1079. FUNCBINDR(instance_from_id, sarray("instance_id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1080. FUNCBINDR(is_instance_id_valid, sarray("id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1081. FUNCBINDR(is_instance_valid, sarray("instance"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1082. }
  1083. void Variant::_unregister_variant_utility_functions() {
  1084. utility_function_table.clear();
  1085. utility_function_name_table.clear();
  1086. }
  1087. void Variant::call_utility_function(const StringName &p_name, Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1088. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1089. if (!bfi) {
  1090. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1091. r_error.argument = 0;
  1092. r_error.expected = 0;
  1093. return;
  1094. }
  1095. if (unlikely(!bfi->is_vararg && p_argcount < bfi->argcount)) {
  1096. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1097. r_error.argument = 0;
  1098. r_error.expected = bfi->argcount;
  1099. return;
  1100. }
  1101. if (unlikely(!bfi->is_vararg && p_argcount > bfi->argcount)) {
  1102. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1103. r_error.argument = 0;
  1104. r_error.expected = bfi->argcount;
  1105. return;
  1106. }
  1107. bfi->call_utility(r_ret, p_args, p_argcount, r_error);
  1108. }
  1109. bool Variant::has_utility_function(const StringName &p_name) {
  1110. return utility_function_table.has(p_name);
  1111. }
  1112. Variant::ValidatedUtilityFunction Variant::get_validated_utility_function(const StringName &p_name) {
  1113. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1114. if (!bfi) {
  1115. return nullptr;
  1116. }
  1117. return bfi->validated_call_utility;
  1118. }
  1119. Variant::PTRUtilityFunction Variant::get_ptr_utility_function(const StringName &p_name) {
  1120. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1121. if (!bfi) {
  1122. return nullptr;
  1123. }
  1124. return bfi->ptr_call_utility;
  1125. }
  1126. Variant::UtilityFunctionType Variant::get_utility_function_type(const StringName &p_name) {
  1127. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1128. if (!bfi) {
  1129. return Variant::UTILITY_FUNC_TYPE_MATH;
  1130. }
  1131. return bfi->type;
  1132. }
  1133. int Variant::get_utility_function_argument_count(const StringName &p_name) {
  1134. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1135. if (!bfi) {
  1136. return 0;
  1137. }
  1138. return bfi->argcount;
  1139. }
  1140. Variant::Type Variant::get_utility_function_argument_type(const StringName &p_name, int p_arg) {
  1141. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1142. if (!bfi) {
  1143. return Variant::NIL;
  1144. }
  1145. return bfi->get_arg_type(p_arg);
  1146. }
  1147. String Variant::get_utility_function_argument_name(const StringName &p_name, int p_arg) {
  1148. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1149. if (!bfi) {
  1150. return String();
  1151. }
  1152. ERR_FAIL_INDEX_V(p_arg, bfi->argnames.size(), String());
  1153. ERR_FAIL_COND_V(bfi->is_vararg, String());
  1154. return bfi->argnames[p_arg];
  1155. }
  1156. bool Variant::has_utility_function_return_value(const StringName &p_name) {
  1157. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1158. if (!bfi) {
  1159. return false;
  1160. }
  1161. return bfi->returns_value;
  1162. }
  1163. Variant::Type Variant::get_utility_function_return_type(const StringName &p_name) {
  1164. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1165. if (!bfi) {
  1166. return Variant::NIL;
  1167. }
  1168. return bfi->return_type;
  1169. }
  1170. bool Variant::is_utility_function_vararg(const StringName &p_name) {
  1171. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1172. if (!bfi) {
  1173. return false;
  1174. }
  1175. return bfi->is_vararg;
  1176. }
  1177. uint32_t Variant::get_utility_function_hash(const StringName &p_name) {
  1178. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1179. ERR_FAIL_COND_V(!bfi, 0);
  1180. uint32_t hash = hash_djb2_one_32(bfi->is_vararg);
  1181. hash = hash_djb2_one_32(bfi->returns_value, hash);
  1182. if (bfi->returns_value) {
  1183. hash = hash_djb2_one_32(bfi->return_type, hash);
  1184. }
  1185. hash = hash_djb2_one_32(bfi->argcount, hash);
  1186. for (int i = 0; i < bfi->argcount; i++) {
  1187. hash = hash_djb2_one_32(bfi->get_arg_type(i), hash);
  1188. }
  1189. return hash;
  1190. }
  1191. void Variant::get_utility_function_list(List<StringName> *r_functions) {
  1192. for (List<StringName>::Element *E = utility_function_name_table.front(); E; E = E->next()) {
  1193. r_functions->push_back(E->get());
  1194. }
  1195. }
  1196. int Variant::get_utility_function_count() {
  1197. return utility_function_name_table.size();
  1198. }