variant_utility.cpp 63 KB

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