variant_utility.cpp 62 KB

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