variant_utility.cpp 68 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565
  1. /*************************************************************************/
  2. /* variant_utility.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "variant.h"
  31. #include "core/core_string_names.h"
  32. #include "core/io/marshalls.h"
  33. #include "core/object/ref_counted.h"
  34. #include "core/os/os.h"
  35. #include "core/templates/oa_hash_map.h"
  36. #include "core/templates/rid.h"
  37. #include "core/templates/rid_owner.h"
  38. #include "core/variant/binder_common.h"
  39. #include "core/variant/variant_parser.h"
  40. struct VariantUtilityFunctions {
  41. // Math
  42. static inline double sin(double arg) {
  43. return Math::sin(arg);
  44. }
  45. static inline double cos(double arg) {
  46. return Math::cos(arg);
  47. }
  48. static inline double tan(double arg) {
  49. return Math::tan(arg);
  50. }
  51. static inline double sinh(double arg) {
  52. return Math::sinh(arg);
  53. }
  54. static inline double cosh(double arg) {
  55. return Math::cosh(arg);
  56. }
  57. static inline double tanh(double arg) {
  58. return Math::tanh(arg);
  59. }
  60. static inline double asin(double arg) {
  61. return Math::asin(arg);
  62. }
  63. static inline double acos(double arg) {
  64. return Math::acos(arg);
  65. }
  66. static inline double atan(double arg) {
  67. return Math::atan(arg);
  68. }
  69. static inline double atan2(double y, double x) {
  70. return Math::atan2(y, x);
  71. }
  72. static inline double sqrt(double x) {
  73. return Math::sqrt(x);
  74. }
  75. static inline double fmod(double b, double r) {
  76. return Math::fmod(b, r);
  77. }
  78. static inline double fposmod(double b, double r) {
  79. return Math::fposmod(b, r);
  80. }
  81. static inline int64_t posmod(int64_t b, int64_t r) {
  82. return Math::posmod(b, r);
  83. }
  84. static inline 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. case Variant::VECTOR4: {
  115. return VariantInternalAccessor<Vector4>::get(&x).abs();
  116. } break;
  117. case Variant::VECTOR4I: {
  118. return VariantInternalAccessor<Vector4i>::get(&x).abs();
  119. } break;
  120. default: {
  121. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  122. return Variant();
  123. }
  124. }
  125. }
  126. static inline double absf(double x) {
  127. return Math::absd(x);
  128. }
  129. static inline int64_t absi(int64_t x) {
  130. return ABS(x);
  131. }
  132. static inline Variant sign(const Variant &x, Callable::CallError &r_error) {
  133. r_error.error = Callable::CallError::CALL_OK;
  134. switch (x.get_type()) {
  135. case Variant::INT: {
  136. return SIGN(VariantInternalAccessor<int64_t>::get(&x));
  137. } break;
  138. case Variant::FLOAT: {
  139. return SIGN(VariantInternalAccessor<double>::get(&x));
  140. } break;
  141. case Variant::VECTOR2: {
  142. return VariantInternalAccessor<Vector2>::get(&x).sign();
  143. } break;
  144. case Variant::VECTOR2I: {
  145. return VariantInternalAccessor<Vector2i>::get(&x).sign();
  146. } break;
  147. case Variant::VECTOR3: {
  148. return VariantInternalAccessor<Vector3>::get(&x).sign();
  149. } break;
  150. case Variant::VECTOR3I: {
  151. return VariantInternalAccessor<Vector3i>::get(&x).sign();
  152. } break;
  153. case Variant::VECTOR4: {
  154. return VariantInternalAccessor<Vector4>::get(&x).sign();
  155. } break;
  156. case Variant::VECTOR4I: {
  157. return VariantInternalAccessor<Vector4i>::get(&x).sign();
  158. } break;
  159. default: {
  160. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  161. return Variant();
  162. }
  163. }
  164. }
  165. static inline double signf(double x) {
  166. return SIGN(x);
  167. }
  168. static inline int64_t signi(int64_t x) {
  169. return SIGN(x);
  170. }
  171. static inline double pow(double x, double y) {
  172. return Math::pow(x, y);
  173. }
  174. static inline double log(double x) {
  175. return Math::log(x);
  176. }
  177. static inline double exp(double x) {
  178. return Math::exp(x);
  179. }
  180. static inline bool is_nan(double x) {
  181. return Math::is_nan(x);
  182. }
  183. static inline bool is_inf(double x) {
  184. return Math::is_inf(x);
  185. }
  186. static inline bool is_equal_approx(double x, double y) {
  187. return Math::is_equal_approx(x, y);
  188. }
  189. static inline bool is_zero_approx(double x) {
  190. return Math::is_zero_approx(x);
  191. }
  192. static inline double ease(float x, float curve) {
  193. return Math::ease(x, curve);
  194. }
  195. static inline int step_decimals(float step) {
  196. return Math::step_decimals(step);
  197. }
  198. static inline double snapped(double value, double step) {
  199. return Math::snapped(value, step);
  200. }
  201. static inline Variant lerp(const Variant &from, const Variant &to, double weight, Callable::CallError &r_error) {
  202. r_error.error = Callable::CallError::CALL_OK;
  203. if (from.get_type() != to.get_type()) {
  204. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  205. r_error.argument = 1;
  206. return Variant();
  207. }
  208. switch (from.get_type()) {
  209. case Variant::FLOAT: {
  210. return lerpf(VariantInternalAccessor<double>::get(&from), to, weight);
  211. } break;
  212. case Variant::VECTOR2: {
  213. return VariantInternalAccessor<Vector2>::get(&from).lerp(VariantInternalAccessor<Vector2>::get(&to), weight);
  214. } break;
  215. case Variant::VECTOR3: {
  216. return VariantInternalAccessor<Vector3>::get(&from).lerp(VariantInternalAccessor<Vector3>::get(&to), weight);
  217. } break;
  218. case Variant::VECTOR4: {
  219. return VariantInternalAccessor<Vector4>::get(&from).lerp(VariantInternalAccessor<Vector4>::get(&to), weight);
  220. } break;
  221. case Variant::QUATERNION: {
  222. return VariantInternalAccessor<Quaternion>::get(&from).slerp(VariantInternalAccessor<Quaternion>::get(&to), weight);
  223. } break;
  224. case Variant::BASIS: {
  225. return VariantInternalAccessor<Basis>::get(&from).slerp(VariantInternalAccessor<Basis>::get(&to), weight);
  226. } break;
  227. case Variant::COLOR: {
  228. return VariantInternalAccessor<Color>::get(&from).lerp(VariantInternalAccessor<Color>::get(&to), weight);
  229. } break;
  230. default: {
  231. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  232. return Variant();
  233. }
  234. }
  235. }
  236. static inline double lerpf(double from, double to, double weight) {
  237. return Math::lerp(from, to, weight);
  238. }
  239. static inline double cubic_interpolate(double from, double to, double pre, double post, double weight) {
  240. return Math::cubic_interpolate(from, to, pre, post, weight);
  241. }
  242. static inline double bezier_interpolate(double p_start, double p_control_1, double p_control_2, double p_end, double p_t) {
  243. return Math::bezier_interpolate(p_start, p_control_1, p_control_2, p_end, p_t);
  244. }
  245. static inline double lerp_angle(double from, double to, double weight) {
  246. return Math::lerp_angle(from, to, weight);
  247. }
  248. static inline double inverse_lerp(double from, double to, double weight) {
  249. return Math::inverse_lerp(from, to, weight);
  250. }
  251. static inline double range_lerp(double value, double istart, double istop, double ostart, double ostop) {
  252. return Math::range_lerp(value, istart, istop, ostart, ostop);
  253. }
  254. static inline double smoothstep(double from, double to, double val) {
  255. return Math::smoothstep(from, to, val);
  256. }
  257. static inline double move_toward(double from, double to, double delta) {
  258. return Math::move_toward(from, to, delta);
  259. }
  260. static inline double deg2rad(double angle_deg) {
  261. return Math::deg2rad(angle_deg);
  262. }
  263. static inline double rad2deg(double angle_rad) {
  264. return Math::rad2deg(angle_rad);
  265. }
  266. static inline double linear2db(double linear) {
  267. return Math::linear2db(linear);
  268. }
  269. static inline double db2linear(double db) {
  270. return Math::db2linear(db);
  271. }
  272. static inline Variant wrap(const Variant &p_x, const Variant &p_min, const Variant &p_max, Callable::CallError &r_error) {
  273. Variant::Type x_type = p_x.get_type();
  274. if (x_type != Variant::INT && x_type != Variant::FLOAT) {
  275. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  276. r_error.argument = 0;
  277. r_error.expected = x_type;
  278. return Variant();
  279. }
  280. Variant::Type min_type = p_min.get_type();
  281. if (min_type != Variant::INT && min_type != Variant::FLOAT) {
  282. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  283. r_error.argument = 1;
  284. r_error.expected = x_type;
  285. return Variant();
  286. }
  287. Variant::Type max_type = p_max.get_type();
  288. if (max_type != Variant::INT && max_type != Variant::FLOAT) {
  289. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  290. r_error.argument = 2;
  291. r_error.expected = x_type;
  292. return Variant();
  293. }
  294. Variant value;
  295. switch (x_type) {
  296. case Variant::INT: {
  297. if (x_type != min_type || x_type != max_type) {
  298. value = wrapf((double)p_x, (double)p_min, (double)p_max);
  299. } else {
  300. value = wrapi((int)p_x, (int)p_min, (int)p_max);
  301. }
  302. } break;
  303. case Variant::FLOAT: {
  304. value = wrapf((double)p_x, (double)p_min, (double)p_max);
  305. } break;
  306. default:
  307. break;
  308. }
  309. r_error.error = Callable::CallError::CALL_OK;
  310. return value;
  311. }
  312. static inline int64_t wrapi(int64_t value, int64_t min, int64_t max) {
  313. return Math::wrapi(value, min, max);
  314. }
  315. static inline double wrapf(double value, double min, double max) {
  316. return Math::wrapf(value, min, max);
  317. }
  318. static inline double pingpong(double value, double length) {
  319. return Math::pingpong(value, length);
  320. }
  321. static inline Variant max(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  322. if (p_argcount < 2) {
  323. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  324. r_error.expected = 2;
  325. return Variant();
  326. }
  327. Variant base = *p_args[0];
  328. Variant ret;
  329. for (int i = 1; i < p_argcount; i++) {
  330. bool valid;
  331. Variant::evaluate(Variant::OP_LESS, base, *p_args[i], ret, valid);
  332. if (!valid) {
  333. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  334. r_error.expected = base.get_type();
  335. r_error.argument = i;
  336. return Variant();
  337. }
  338. if (ret.booleanize()) {
  339. base = *p_args[i];
  340. }
  341. }
  342. r_error.error = Callable::CallError::CALL_OK;
  343. return base;
  344. }
  345. static inline double maxf(double x, double y) {
  346. return MAX(x, y);
  347. }
  348. static inline int64_t maxi(int64_t x, int64_t y) {
  349. return MAX(x, y);
  350. }
  351. static inline Variant min(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  352. if (p_argcount < 2) {
  353. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  354. r_error.expected = 2;
  355. return Variant();
  356. }
  357. Variant base = *p_args[0];
  358. Variant ret;
  359. for (int i = 1; i < p_argcount; i++) {
  360. bool valid;
  361. Variant::evaluate(Variant::OP_GREATER, base, *p_args[i], ret, valid);
  362. if (!valid) {
  363. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  364. r_error.expected = base.get_type();
  365. r_error.argument = i;
  366. return Variant();
  367. }
  368. if (ret.booleanize()) {
  369. base = *p_args[i];
  370. }
  371. }
  372. r_error.error = Callable::CallError::CALL_OK;
  373. return base;
  374. }
  375. static inline double minf(double x, double y) {
  376. return MIN(x, y);
  377. }
  378. static inline int64_t mini(int64_t x, int64_t y) {
  379. return MIN(x, y);
  380. }
  381. static inline Variant clamp(const Variant &x, const Variant &min, const Variant &max, Callable::CallError &r_error) {
  382. Variant value = x;
  383. Variant ret;
  384. bool valid;
  385. Variant::evaluate(Variant::OP_LESS, value, min, ret, valid);
  386. if (!valid) {
  387. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  388. r_error.expected = value.get_type();
  389. r_error.argument = 1;
  390. return Variant();
  391. }
  392. if (ret.booleanize()) {
  393. value = min;
  394. }
  395. Variant::evaluate(Variant::OP_GREATER, value, max, ret, valid);
  396. if (!valid) {
  397. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  398. r_error.expected = value.get_type();
  399. r_error.argument = 2;
  400. return Variant();
  401. }
  402. if (ret.booleanize()) {
  403. value = max;
  404. }
  405. r_error.error = Callable::CallError::CALL_OK;
  406. return value;
  407. }
  408. static inline double clampf(double x, double min, double max) {
  409. return CLAMP(x, min, max);
  410. }
  411. static inline int64_t clampi(int64_t x, int64_t min, int64_t max) {
  412. return CLAMP(x, min, max);
  413. }
  414. static inline int64_t nearest_po2(int64_t x) {
  415. return nearest_power_of_2_templated(uint64_t(x));
  416. }
  417. // Random
  418. static inline void randomize() {
  419. Math::randomize();
  420. }
  421. static inline int64_t randi() {
  422. return Math::rand();
  423. }
  424. static inline double randf() {
  425. return Math::randf();
  426. }
  427. static inline double randfn(double mean, double deviation) {
  428. return Math::randfn(mean, deviation);
  429. }
  430. static inline int64_t randi_range(int64_t from, int64_t to) {
  431. return Math::random((int32_t)from, (int32_t)to);
  432. }
  433. static inline double randf_range(double from, double to) {
  434. return Math::random(from, to);
  435. }
  436. static inline void seed(int64_t s) {
  437. return Math::seed(s);
  438. }
  439. static inline PackedInt64Array rand_from_seed(int64_t seed) {
  440. uint64_t s = seed;
  441. PackedInt64Array arr;
  442. arr.resize(2);
  443. arr.write[0] = Math::rand_from_seed(&s);
  444. arr.write[1] = s;
  445. return arr;
  446. }
  447. // Utility
  448. static inline Variant weakref(const Variant &obj, Callable::CallError &r_error) {
  449. if (obj.get_type() == Variant::OBJECT) {
  450. r_error.error = Callable::CallError::CALL_OK;
  451. if (obj.is_ref_counted()) {
  452. Ref<WeakRef> wref = memnew(WeakRef);
  453. Ref<RefCounted> r = obj;
  454. if (r.is_valid()) {
  455. wref->set_ref(r);
  456. }
  457. return wref;
  458. } else {
  459. Ref<WeakRef> wref = memnew(WeakRef);
  460. Object *o = obj.get_validated_object();
  461. if (o) {
  462. wref->set_obj(o);
  463. }
  464. return wref;
  465. }
  466. } else if (obj.get_type() == Variant::NIL) {
  467. r_error.error = Callable::CallError::CALL_OK;
  468. Ref<WeakRef> wref = memnew(WeakRef);
  469. return wref;
  470. } else {
  471. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  472. r_error.argument = 0;
  473. r_error.expected = Variant::OBJECT;
  474. return Variant();
  475. }
  476. }
  477. static inline int64_t _typeof(const Variant &obj) {
  478. return obj.get_type();
  479. }
  480. static inline String str(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  481. if (p_arg_count < 1) {
  482. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  483. r_error.argument = 1;
  484. return String();
  485. }
  486. String s;
  487. for (int i = 0; i < p_arg_count; i++) {
  488. String os = p_args[i]->operator String();
  489. if (i == 0) {
  490. s = os;
  491. } else {
  492. s += os;
  493. }
  494. }
  495. r_error.error = Callable::CallError::CALL_OK;
  496. return s;
  497. }
  498. static inline String error_string(Error error) {
  499. if (error < 0 || error >= ERR_MAX) {
  500. return String("(invalid error code)");
  501. }
  502. return String(error_names[error]);
  503. }
  504. static inline void print(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  505. String s;
  506. for (int i = 0; i < p_arg_count; i++) {
  507. String os = p_args[i]->operator String();
  508. if (i == 0) {
  509. s = os;
  510. } else {
  511. s += os;
  512. }
  513. }
  514. print_line(s);
  515. r_error.error = Callable::CallError::CALL_OK;
  516. }
  517. static inline void print_rich(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  518. String s;
  519. for (int i = 0; i < p_arg_count; i++) {
  520. String os = p_args[i]->operator String();
  521. if (i == 0) {
  522. s = os;
  523. } else {
  524. s += os;
  525. }
  526. }
  527. print_line_rich(s);
  528. r_error.error = Callable::CallError::CALL_OK;
  529. }
  530. static inline void print_verbose(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  531. if (OS::get_singleton()->is_stdout_verbose()) {
  532. String s;
  533. for (int i = 0; i < p_arg_count; i++) {
  534. String os = p_args[i]->operator String();
  535. if (i == 0) {
  536. s = os;
  537. } else {
  538. s += os;
  539. }
  540. }
  541. // No need to use `print_verbose()` as this call already only happens
  542. // when verbose mode is enabled. This avoids performing string argument concatenation
  543. // when not needed.
  544. print_line(s);
  545. }
  546. r_error.error = Callable::CallError::CALL_OK;
  547. }
  548. static inline void printerr(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  549. String s;
  550. for (int i = 0; i < p_arg_count; i++) {
  551. String os = p_args[i]->operator String();
  552. if (i == 0) {
  553. s = os;
  554. } else {
  555. s += os;
  556. }
  557. }
  558. print_error(s);
  559. r_error.error = Callable::CallError::CALL_OK;
  560. }
  561. static inline void printt(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  562. String s;
  563. for (int i = 0; i < p_arg_count; i++) {
  564. if (i) {
  565. s += "\t";
  566. }
  567. s += p_args[i]->operator String();
  568. }
  569. print_line(s);
  570. r_error.error = Callable::CallError::CALL_OK;
  571. }
  572. static inline void prints(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  573. String s;
  574. for (int i = 0; i < p_arg_count; i++) {
  575. if (i) {
  576. s += " ";
  577. }
  578. s += p_args[i]->operator String();
  579. }
  580. print_line(s);
  581. r_error.error = Callable::CallError::CALL_OK;
  582. }
  583. static inline void printraw(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  584. String s;
  585. for (int i = 0; i < p_arg_count; i++) {
  586. String os = p_args[i]->operator String();
  587. if (i == 0) {
  588. s = os;
  589. } else {
  590. s += os;
  591. }
  592. }
  593. OS::get_singleton()->print("%s", s.utf8().get_data());
  594. r_error.error = Callable::CallError::CALL_OK;
  595. }
  596. static inline void push_error(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  597. if (p_arg_count < 1) {
  598. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  599. r_error.argument = 1;
  600. }
  601. String s;
  602. for (int i = 0; i < p_arg_count; i++) {
  603. String os = p_args[i]->operator String();
  604. if (i == 0) {
  605. s = os;
  606. } else {
  607. s += os;
  608. }
  609. }
  610. ERR_PRINT(s);
  611. r_error.error = Callable::CallError::CALL_OK;
  612. }
  613. static inline void push_warning(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  614. if (p_arg_count < 1) {
  615. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  616. r_error.argument = 1;
  617. }
  618. String s;
  619. for (int i = 0; i < p_arg_count; i++) {
  620. String os = p_args[i]->operator String();
  621. if (i == 0) {
  622. s = os;
  623. } else {
  624. s += os;
  625. }
  626. }
  627. WARN_PRINT(s);
  628. r_error.error = Callable::CallError::CALL_OK;
  629. }
  630. static inline String var2str(const Variant &p_var) {
  631. String vars;
  632. VariantWriter::write_to_string(p_var, vars);
  633. return vars;
  634. }
  635. static inline Variant str2var(const String &p_var) {
  636. VariantParser::StreamString ss;
  637. ss.s = p_var;
  638. String errs;
  639. int line;
  640. Variant ret;
  641. (void)VariantParser::parse(&ss, ret, errs, line);
  642. return ret;
  643. }
  644. static inline PackedByteArray var2bytes(const Variant &p_var) {
  645. int len;
  646. Error err = encode_variant(p_var, nullptr, len, false);
  647. if (err != OK) {
  648. return PackedByteArray();
  649. }
  650. PackedByteArray barr;
  651. barr.resize(len);
  652. {
  653. uint8_t *w = barr.ptrw();
  654. err = encode_variant(p_var, w, len, false);
  655. if (err != OK) {
  656. return PackedByteArray();
  657. }
  658. }
  659. return barr;
  660. }
  661. static inline PackedByteArray var2bytes_with_objects(const Variant &p_var) {
  662. int len;
  663. Error err = encode_variant(p_var, nullptr, len, true);
  664. if (err != OK) {
  665. return PackedByteArray();
  666. }
  667. PackedByteArray barr;
  668. barr.resize(len);
  669. {
  670. uint8_t *w = barr.ptrw();
  671. err = encode_variant(p_var, w, len, true);
  672. if (err != OK) {
  673. return PackedByteArray();
  674. }
  675. }
  676. return barr;
  677. }
  678. static inline Variant bytes2var(const PackedByteArray &p_arr) {
  679. Variant ret;
  680. {
  681. const uint8_t *r = p_arr.ptr();
  682. Error err = decode_variant(ret, r, p_arr.size(), nullptr, false);
  683. if (err != OK) {
  684. return Variant();
  685. }
  686. }
  687. return ret;
  688. }
  689. static inline Variant bytes2var_with_objects(const PackedByteArray &p_arr) {
  690. Variant ret;
  691. {
  692. const uint8_t *r = p_arr.ptr();
  693. Error err = decode_variant(ret, r, p_arr.size(), nullptr, true);
  694. if (err != OK) {
  695. return Variant();
  696. }
  697. }
  698. return ret;
  699. }
  700. static inline int64_t hash(const Variant &p_arr) {
  701. return p_arr.hash();
  702. }
  703. static inline Object *instance_from_id(int64_t p_id) {
  704. ObjectID id = ObjectID((uint64_t)p_id);
  705. Object *ret = ObjectDB::get_instance(id);
  706. return ret;
  707. }
  708. static inline bool is_instance_id_valid(int64_t p_id) {
  709. return ObjectDB::get_instance(ObjectID((uint64_t)p_id)) != nullptr;
  710. }
  711. static inline bool is_instance_valid(const Variant &p_instance) {
  712. if (p_instance.get_type() != Variant::OBJECT) {
  713. return false;
  714. }
  715. return p_instance.get_validated_object() != nullptr;
  716. }
  717. static inline uint64_t rid_allocate_id() {
  718. return RID_AllocBase::_gen_id();
  719. }
  720. static inline RID rid_from_int64(uint64_t p_base) {
  721. return RID::from_uint64(p_base);
  722. }
  723. };
  724. #ifdef DEBUG_METHODS_ENABLED
  725. #define VCALLR *ret = p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  726. #define VCALL p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  727. #else
  728. #define VCALLR *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...)
  729. #define VCALL p_func(VariantCaster<P>::cast(*p_args[Is])...)
  730. #endif
  731. template <class R, class... P, size_t... Is>
  732. static _FORCE_INLINE_ void call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  733. r_error.error = Callable::CallError::CALL_OK;
  734. VCALLR;
  735. (void)p_args; // avoid gcc warning
  736. (void)r_error;
  737. }
  738. template <class R, class... P, size_t... Is>
  739. static _FORCE_INLINE_ void validated_call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, IndexSequence<Is...>) {
  740. *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...);
  741. (void)p_args;
  742. }
  743. template <class R, class... P, size_t... Is>
  744. static _FORCE_INLINE_ void ptr_call_helperpr(R (*p_func)(P...), void *ret, const void **p_args, IndexSequence<Is...>) {
  745. PtrToArg<R>::encode(p_func(PtrToArg<P>::convert(p_args[Is])...), ret);
  746. (void)p_args;
  747. }
  748. template <class R, class... P>
  749. static _FORCE_INLINE_ void call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error) {
  750. call_helperpr(p_func, ret, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  751. }
  752. template <class R, class... P>
  753. static _FORCE_INLINE_ void validated_call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args) {
  754. validated_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  755. }
  756. template <class R, class... P>
  757. static _FORCE_INLINE_ void ptr_call_helperr(R (*p_func)(P...), void *ret, const void **p_args) {
  758. ptr_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  759. }
  760. template <class R, class... P>
  761. static _FORCE_INLINE_ int get_arg_count_helperr(R (*p_func)(P...)) {
  762. return sizeof...(P);
  763. }
  764. template <class R, class... P>
  765. static _FORCE_INLINE_ Variant::Type get_arg_type_helperr(R (*p_func)(P...), int p_arg) {
  766. return call_get_argument_type<P...>(p_arg);
  767. }
  768. template <class R, class... P>
  769. static _FORCE_INLINE_ Variant::Type get_ret_type_helperr(R (*p_func)(P...)) {
  770. return GetTypeInfo<R>::VARIANT_TYPE;
  771. }
  772. // WITHOUT RET
  773. template <class... P, size_t... Is>
  774. static _FORCE_INLINE_ void call_helperp(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  775. r_error.error = Callable::CallError::CALL_OK;
  776. VCALL;
  777. (void)p_args;
  778. (void)r_error;
  779. }
  780. template <class... P, size_t... Is>
  781. static _FORCE_INLINE_ void validated_call_helperp(void (*p_func)(P...), const Variant **p_args, IndexSequence<Is...>) {
  782. p_func(VariantCaster<P>::cast(*p_args[Is])...);
  783. (void)p_args;
  784. }
  785. template <class... P, size_t... Is>
  786. static _FORCE_INLINE_ void ptr_call_helperp(void (*p_func)(P...), const void **p_args, IndexSequence<Is...>) {
  787. p_func(PtrToArg<P>::convert(p_args[Is])...);
  788. (void)p_args;
  789. }
  790. template <class... P>
  791. static _FORCE_INLINE_ void call_helper(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error) {
  792. call_helperp(p_func, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  793. }
  794. template <class... P>
  795. static _FORCE_INLINE_ void validated_call_helper(void (*p_func)(P...), const Variant **p_args) {
  796. validated_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  797. }
  798. template <class... P>
  799. static _FORCE_INLINE_ void ptr_call_helper(void (*p_func)(P...), const void **p_args) {
  800. ptr_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  801. }
  802. template <class... P>
  803. static _FORCE_INLINE_ int get_arg_count_helper(void (*p_func)(P...)) {
  804. return sizeof...(P);
  805. }
  806. template <class... P>
  807. static _FORCE_INLINE_ Variant::Type get_arg_type_helper(void (*p_func)(P...), int p_arg) {
  808. return call_get_argument_type<P...>(p_arg);
  809. }
  810. template <class... P>
  811. static _FORCE_INLINE_ Variant::Type get_ret_type_helper(void (*p_func)(P...)) {
  812. return Variant::NIL;
  813. }
  814. #define FUNCBINDR(m_func, m_args, m_category) \
  815. class Func_##m_func { \
  816. public: \
  817. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  818. call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args, r_error); \
  819. } \
  820. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  821. validated_call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args); \
  822. } \
  823. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  824. ptr_call_helperr(VariantUtilityFunctions::m_func, ret, p_args); \
  825. } \
  826. static int get_argument_count() { \
  827. return get_arg_count_helperr(VariantUtilityFunctions::m_func); \
  828. } \
  829. static Variant::Type get_argument_type(int p_arg) { \
  830. return get_arg_type_helperr(VariantUtilityFunctions::m_func, p_arg); \
  831. } \
  832. static Variant::Type get_return_type() { \
  833. return get_ret_type_helperr(VariantUtilityFunctions::m_func); \
  834. } \
  835. static bool has_return_type() { \
  836. return true; \
  837. } \
  838. static bool is_vararg() { return false; } \
  839. static Variant::UtilityFunctionType get_type() { return m_category; } \
  840. }; \
  841. register_utility_function<Func_##m_func>(#m_func, m_args)
  842. #define FUNCBINDVR(m_func, m_args, m_category) \
  843. class Func_##m_func { \
  844. public: \
  845. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  846. r_error.error = Callable::CallError::CALL_OK; \
  847. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], r_error); \
  848. } \
  849. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  850. Callable::CallError ce; \
  851. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], ce); \
  852. } \
  853. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  854. Callable::CallError ce; \
  855. PtrToArg<Variant>::encode(VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), ce), ret); \
  856. } \
  857. static int get_argument_count() { \
  858. return 1; \
  859. } \
  860. static Variant::Type get_argument_type(int p_arg) { \
  861. return Variant::NIL; \
  862. } \
  863. static Variant::Type get_return_type() { \
  864. return Variant::NIL; \
  865. } \
  866. static bool has_return_type() { \
  867. return true; \
  868. } \
  869. static bool is_vararg() { return false; } \
  870. static Variant::UtilityFunctionType get_type() { return m_category; } \
  871. }; \
  872. register_utility_function<Func_##m_func>(#m_func, m_args)
  873. #define FUNCBINDVR3(m_func, m_args, m_category) \
  874. class Func_##m_func { \
  875. public: \
  876. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  877. r_error.error = Callable::CallError::CALL_OK; \
  878. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], r_error); \
  879. } \
  880. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  881. Callable::CallError ce; \
  882. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], ce); \
  883. } \
  884. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  885. Callable::CallError ce; \
  886. Variant r; \
  887. r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), PtrToArg<Variant>::convert(p_args[2]), ce); \
  888. PtrToArg<Variant>::encode(r, ret); \
  889. } \
  890. static int get_argument_count() { \
  891. return 3; \
  892. } \
  893. static Variant::Type get_argument_type(int p_arg) { \
  894. return Variant::NIL; \
  895. } \
  896. static Variant::Type get_return_type() { \
  897. return Variant::NIL; \
  898. } \
  899. static bool has_return_type() { \
  900. return true; \
  901. } \
  902. static bool is_vararg() { return false; } \
  903. static Variant::UtilityFunctionType get_type() { return m_category; } \
  904. }; \
  905. register_utility_function<Func_##m_func>(#m_func, m_args)
  906. #define FUNCBINDVARARG(m_func, m_args, m_category) \
  907. class Func_##m_func { \
  908. public: \
  909. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  910. r_error.error = Callable::CallError::CALL_OK; \
  911. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  912. } \
  913. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  914. Callable::CallError c; \
  915. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  916. } \
  917. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  918. Vector<Variant> args; \
  919. for (int i = 0; i < p_argcount; i++) { \
  920. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  921. } \
  922. Vector<const Variant *> argsp; \
  923. for (int i = 0; i < p_argcount; i++) { \
  924. argsp.push_back(&args[i]); \
  925. } \
  926. Variant r; \
  927. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  928. PtrToArg<Variant>::encode(r, ret); \
  929. } \
  930. static int get_argument_count() { \
  931. return 2; \
  932. } \
  933. static Variant::Type get_argument_type(int p_arg) { \
  934. return Variant::NIL; \
  935. } \
  936. static Variant::Type get_return_type() { \
  937. return Variant::NIL; \
  938. } \
  939. static bool has_return_type() { \
  940. return true; \
  941. } \
  942. static bool is_vararg() { \
  943. return true; \
  944. } \
  945. static Variant::UtilityFunctionType get_type() { \
  946. return m_category; \
  947. } \
  948. }; \
  949. register_utility_function<Func_##m_func>(#m_func, m_args)
  950. #define FUNCBINDVARARGS(m_func, m_args, m_category) \
  951. class Func_##m_func { \
  952. public: \
  953. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  954. r_error.error = Callable::CallError::CALL_OK; \
  955. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  956. } \
  957. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  958. Callable::CallError c; \
  959. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  960. } \
  961. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  962. Vector<Variant> args; \
  963. for (int i = 0; i < p_argcount; i++) { \
  964. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  965. } \
  966. Vector<const Variant *> argsp; \
  967. for (int i = 0; i < p_argcount; i++) { \
  968. argsp.push_back(&args[i]); \
  969. } \
  970. Variant r; \
  971. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  972. PtrToArg<String>::encode(r.operator String(), ret); \
  973. } \
  974. static int get_argument_count() { \
  975. return 1; \
  976. } \
  977. static Variant::Type get_argument_type(int p_arg) { \
  978. return Variant::NIL; \
  979. } \
  980. static Variant::Type get_return_type() { \
  981. return Variant::STRING; \
  982. } \
  983. static bool has_return_type() { \
  984. return true; \
  985. } \
  986. static bool is_vararg() { \
  987. return true; \
  988. } \
  989. static Variant::UtilityFunctionType get_type() { \
  990. return m_category; \
  991. } \
  992. }; \
  993. register_utility_function<Func_##m_func>(#m_func, m_args)
  994. #define FUNCBINDVARARGV(m_func, m_args, m_category) \
  995. class Func_##m_func { \
  996. public: \
  997. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  998. r_error.error = Callable::CallError::CALL_OK; \
  999. VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  1000. } \
  1001. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1002. Callable::CallError c; \
  1003. VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  1004. } \
  1005. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1006. Vector<Variant> args; \
  1007. for (int i = 0; i < p_argcount; i++) { \
  1008. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  1009. } \
  1010. Vector<const Variant *> argsp; \
  1011. for (int i = 0; i < p_argcount; i++) { \
  1012. argsp.push_back(&args[i]); \
  1013. } \
  1014. Variant r; \
  1015. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  1016. } \
  1017. static int get_argument_count() { \
  1018. return 1; \
  1019. } \
  1020. static Variant::Type get_argument_type(int p_arg) { \
  1021. return Variant::NIL; \
  1022. } \
  1023. static Variant::Type get_return_type() { \
  1024. return Variant::NIL; \
  1025. } \
  1026. static bool has_return_type() { \
  1027. return false; \
  1028. } \
  1029. static bool is_vararg() { \
  1030. return true; \
  1031. } \
  1032. static Variant::UtilityFunctionType get_type() { \
  1033. return m_category; \
  1034. } \
  1035. }; \
  1036. register_utility_function<Func_##m_func>(#m_func, m_args)
  1037. #define FUNCBIND(m_func, m_args, m_category) \
  1038. class Func_##m_func { \
  1039. public: \
  1040. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1041. call_helper(VariantUtilityFunctions::m_func, p_args, r_error); \
  1042. } \
  1043. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1044. validated_call_helper(VariantUtilityFunctions::m_func, p_args); \
  1045. } \
  1046. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1047. ptr_call_helper(VariantUtilityFunctions::m_func, p_args); \
  1048. } \
  1049. static int get_argument_count() { \
  1050. return get_arg_count_helper(VariantUtilityFunctions::m_func); \
  1051. } \
  1052. static Variant::Type get_argument_type(int p_arg) { \
  1053. return get_arg_type_helper(VariantUtilityFunctions::m_func, p_arg); \
  1054. } \
  1055. static Variant::Type get_return_type() { \
  1056. return get_ret_type_helper(VariantUtilityFunctions::m_func); \
  1057. } \
  1058. static bool has_return_type() { \
  1059. return false; \
  1060. } \
  1061. static bool is_vararg() { return false; } \
  1062. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1063. }; \
  1064. register_utility_function<Func_##m_func>(#m_func, m_args)
  1065. struct VariantUtilityFunctionInfo {
  1066. void (*call_utility)(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) = nullptr;
  1067. Variant::ValidatedUtilityFunction validated_call_utility = nullptr;
  1068. Variant::PTRUtilityFunction ptr_call_utility = nullptr;
  1069. Vector<String> argnames;
  1070. bool is_vararg = false;
  1071. bool returns_value = false;
  1072. int argcount = 0;
  1073. Variant::Type (*get_arg_type)(int) = nullptr;
  1074. Variant::Type return_type;
  1075. Variant::UtilityFunctionType type;
  1076. };
  1077. static OAHashMap<StringName, VariantUtilityFunctionInfo> utility_function_table;
  1078. static List<StringName> utility_function_name_table;
  1079. template <class T>
  1080. static void register_utility_function(const String &p_name, const Vector<String> &argnames) {
  1081. String name = p_name;
  1082. if (name.begins_with("_")) {
  1083. name = name.substr(1, name.length() - 1);
  1084. }
  1085. StringName sname = name;
  1086. ERR_FAIL_COND(utility_function_table.has(sname));
  1087. VariantUtilityFunctionInfo bfi;
  1088. bfi.call_utility = T::call;
  1089. bfi.validated_call_utility = T::validated_call;
  1090. bfi.ptr_call_utility = T::ptrcall;
  1091. bfi.is_vararg = T::is_vararg();
  1092. bfi.argnames = argnames;
  1093. bfi.argcount = T::get_argument_count();
  1094. if (!bfi.is_vararg) {
  1095. ERR_FAIL_COND_MSG(argnames.size() != bfi.argcount, "wrong number of arguments binding utility function: " + name);
  1096. }
  1097. bfi.get_arg_type = T::get_argument_type;
  1098. bfi.return_type = T::get_return_type();
  1099. bfi.type = T::get_type();
  1100. bfi.returns_value = T::has_return_type();
  1101. utility_function_table.insert(sname, bfi);
  1102. utility_function_name_table.push_back(sname);
  1103. }
  1104. void Variant::_register_variant_utility_functions() {
  1105. // Math
  1106. FUNCBINDR(sin, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1107. FUNCBINDR(cos, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1108. FUNCBINDR(tan, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1109. FUNCBINDR(sinh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1110. FUNCBINDR(cosh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1111. FUNCBINDR(tanh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1112. FUNCBINDR(asin, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1113. FUNCBINDR(acos, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1114. FUNCBINDR(atan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1115. FUNCBINDR(atan2, sarray("y", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1116. FUNCBINDR(sqrt, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1117. FUNCBINDR(fmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1118. FUNCBINDR(fposmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1119. FUNCBINDR(posmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1120. FUNCBINDR(floor, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1121. FUNCBINDR(ceil, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1122. FUNCBINDR(round, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1123. FUNCBINDVR(abs, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1124. FUNCBINDR(absf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1125. FUNCBINDR(absi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1126. FUNCBINDVR(sign, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1127. FUNCBINDR(signf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1128. FUNCBINDR(signi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1129. FUNCBINDR(pow, sarray("base", "exp"), Variant::UTILITY_FUNC_TYPE_MATH);
  1130. FUNCBINDR(log, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1131. FUNCBINDR(exp, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1132. FUNCBINDR(is_nan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1133. FUNCBINDR(is_inf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1134. FUNCBINDR(is_equal_approx, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1135. FUNCBINDR(is_zero_approx, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1136. FUNCBINDR(ease, sarray("x", "curve"), Variant::UTILITY_FUNC_TYPE_MATH);
  1137. FUNCBINDR(step_decimals, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1138. FUNCBINDR(snapped, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1139. FUNCBINDVR3(lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1140. FUNCBINDR(lerpf, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1141. FUNCBINDR(cubic_interpolate, sarray("from", "to", "pre", "post", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1142. FUNCBINDR(bezier_interpolate, sarray("start", "control_1", "control_2", "end", "t"), Variant::UTILITY_FUNC_TYPE_MATH);
  1143. FUNCBINDR(lerp_angle, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1144. FUNCBINDR(inverse_lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1145. FUNCBINDR(range_lerp, sarray("value", "istart", "istop", "ostart", "ostop"), Variant::UTILITY_FUNC_TYPE_MATH);
  1146. FUNCBINDR(smoothstep, sarray("from", "to", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1147. FUNCBINDR(move_toward, sarray("from", "to", "delta"), Variant::UTILITY_FUNC_TYPE_MATH);
  1148. FUNCBINDR(deg2rad, sarray("deg"), Variant::UTILITY_FUNC_TYPE_MATH);
  1149. FUNCBINDR(rad2deg, sarray("rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1150. FUNCBINDR(linear2db, sarray("lin"), Variant::UTILITY_FUNC_TYPE_MATH);
  1151. FUNCBINDR(db2linear, sarray("db"), Variant::UTILITY_FUNC_TYPE_MATH);
  1152. FUNCBINDVR3(wrap, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1153. FUNCBINDR(wrapi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1154. FUNCBINDR(wrapf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1155. FUNCBINDVARARG(max, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1156. FUNCBINDR(maxi, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1157. FUNCBINDR(maxf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1158. FUNCBINDVARARG(min, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1159. FUNCBINDR(mini, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1160. FUNCBINDR(minf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1161. FUNCBINDVR3(clamp, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1162. FUNCBINDR(clampi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1163. FUNCBINDR(clampf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1164. FUNCBINDR(nearest_po2, sarray("value"), Variant::UTILITY_FUNC_TYPE_MATH);
  1165. FUNCBINDR(pingpong, sarray("value", "length"), Variant::UTILITY_FUNC_TYPE_MATH);
  1166. // Random
  1167. FUNCBIND(randomize, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1168. FUNCBINDR(randi, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1169. FUNCBINDR(randf, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1170. FUNCBINDR(randi_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1171. FUNCBINDR(randf_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1172. FUNCBINDR(randfn, sarray("mean", "deviation"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1173. FUNCBIND(seed, sarray("base"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1174. FUNCBINDR(rand_from_seed, sarray("seed"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1175. // Utility
  1176. FUNCBINDVR(weakref, sarray("obj"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1177. FUNCBINDR(_typeof, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1178. FUNCBINDVARARGS(str, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1179. FUNCBINDR(error_string, sarray("error"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1180. FUNCBINDVARARGV(print, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1181. FUNCBINDVARARGV(print_rich, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1182. FUNCBINDVARARGV(printerr, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1183. FUNCBINDVARARGV(printt, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1184. FUNCBINDVARARGV(prints, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1185. FUNCBINDVARARGV(printraw, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1186. FUNCBINDVARARGV(print_verbose, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1187. FUNCBINDVARARGV(push_error, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1188. FUNCBINDVARARGV(push_warning, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1189. FUNCBINDR(var2str, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1190. FUNCBINDR(str2var, sarray("string"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1191. FUNCBINDR(var2bytes, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1192. FUNCBINDR(bytes2var, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1193. FUNCBINDR(var2bytes_with_objects, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1194. FUNCBINDR(bytes2var_with_objects, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1195. FUNCBINDR(hash, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1196. FUNCBINDR(instance_from_id, sarray("instance_id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1197. FUNCBINDR(is_instance_id_valid, sarray("id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1198. FUNCBINDR(is_instance_valid, sarray("instance"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1199. FUNCBINDR(rid_allocate_id, Vector<String>(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1200. FUNCBINDR(rid_from_int64, sarray("base"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1201. }
  1202. void Variant::_unregister_variant_utility_functions() {
  1203. utility_function_table.clear();
  1204. utility_function_name_table.clear();
  1205. }
  1206. void Variant::call_utility_function(const StringName &p_name, Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1207. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1208. if (!bfi) {
  1209. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1210. r_error.argument = 0;
  1211. r_error.expected = 0;
  1212. return;
  1213. }
  1214. if (unlikely(!bfi->is_vararg && p_argcount < bfi->argcount)) {
  1215. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1216. r_error.argument = 0;
  1217. r_error.expected = bfi->argcount;
  1218. return;
  1219. }
  1220. if (unlikely(!bfi->is_vararg && p_argcount > bfi->argcount)) {
  1221. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1222. r_error.argument = 0;
  1223. r_error.expected = bfi->argcount;
  1224. return;
  1225. }
  1226. bfi->call_utility(r_ret, p_args, p_argcount, r_error);
  1227. }
  1228. bool Variant::has_utility_function(const StringName &p_name) {
  1229. return utility_function_table.has(p_name);
  1230. }
  1231. Variant::ValidatedUtilityFunction Variant::get_validated_utility_function(const StringName &p_name) {
  1232. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1233. if (!bfi) {
  1234. return nullptr;
  1235. }
  1236. return bfi->validated_call_utility;
  1237. }
  1238. Variant::PTRUtilityFunction Variant::get_ptr_utility_function(const StringName &p_name) {
  1239. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1240. if (!bfi) {
  1241. return nullptr;
  1242. }
  1243. return bfi->ptr_call_utility;
  1244. }
  1245. Variant::UtilityFunctionType Variant::get_utility_function_type(const StringName &p_name) {
  1246. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1247. if (!bfi) {
  1248. return Variant::UTILITY_FUNC_TYPE_MATH;
  1249. }
  1250. return bfi->type;
  1251. }
  1252. MethodInfo Variant::get_utility_function_info(const StringName &p_name) {
  1253. MethodInfo info;
  1254. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1255. if (bfi) {
  1256. info.name = p_name;
  1257. if (bfi->returns_value && bfi->return_type == Variant::NIL) {
  1258. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1259. }
  1260. info.return_val.type = bfi->return_type;
  1261. if (bfi->is_vararg) {
  1262. info.flags |= METHOD_FLAG_VARARG;
  1263. }
  1264. for (int i = 0; i < bfi->argnames.size(); ++i) {
  1265. PropertyInfo arg;
  1266. arg.type = bfi->get_arg_type(i);
  1267. arg.name = bfi->argnames[i];
  1268. info.arguments.push_back(arg);
  1269. }
  1270. }
  1271. return info;
  1272. }
  1273. int Variant::get_utility_function_argument_count(const StringName &p_name) {
  1274. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1275. if (!bfi) {
  1276. return 0;
  1277. }
  1278. return bfi->argcount;
  1279. }
  1280. Variant::Type Variant::get_utility_function_argument_type(const StringName &p_name, int p_arg) {
  1281. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1282. if (!bfi) {
  1283. return Variant::NIL;
  1284. }
  1285. return bfi->get_arg_type(p_arg);
  1286. }
  1287. String Variant::get_utility_function_argument_name(const StringName &p_name, int p_arg) {
  1288. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1289. if (!bfi) {
  1290. return String();
  1291. }
  1292. ERR_FAIL_INDEX_V(p_arg, bfi->argnames.size(), String());
  1293. ERR_FAIL_COND_V(bfi->is_vararg, String());
  1294. return bfi->argnames[p_arg];
  1295. }
  1296. bool Variant::has_utility_function_return_value(const StringName &p_name) {
  1297. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1298. if (!bfi) {
  1299. return false;
  1300. }
  1301. return bfi->returns_value;
  1302. }
  1303. Variant::Type Variant::get_utility_function_return_type(const StringName &p_name) {
  1304. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1305. if (!bfi) {
  1306. return Variant::NIL;
  1307. }
  1308. return bfi->return_type;
  1309. }
  1310. bool Variant::is_utility_function_vararg(const StringName &p_name) {
  1311. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1312. if (!bfi) {
  1313. return false;
  1314. }
  1315. return bfi->is_vararg;
  1316. }
  1317. uint32_t Variant::get_utility_function_hash(const StringName &p_name) {
  1318. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1319. ERR_FAIL_COND_V(!bfi, 0);
  1320. uint32_t hash = hash_murmur3_one_32(bfi->is_vararg);
  1321. hash = hash_murmur3_one_32(bfi->returns_value, hash);
  1322. if (bfi->returns_value) {
  1323. hash = hash_murmur3_one_32(bfi->return_type, hash);
  1324. }
  1325. hash = hash_murmur3_one_32(bfi->argcount, hash);
  1326. for (int i = 0; i < bfi->argcount; i++) {
  1327. hash = hash_murmur3_one_32(bfi->get_arg_type(i), hash);
  1328. }
  1329. return hash_fmix32(hash);
  1330. }
  1331. void Variant::get_utility_function_list(List<StringName> *r_functions) {
  1332. for (const StringName &E : utility_function_name_table) {
  1333. r_functions->push_back(E);
  1334. }
  1335. }
  1336. int Variant::get_utility_function_count() {
  1337. return utility_function_name_table.size();
  1338. }