variant_utility.cpp 84 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914
  1. /**************************************************************************/
  2. /* variant_utility.cpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  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_utility.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. // Math
  41. double VariantUtilityFunctions::sin(double arg) {
  42. return Math::sin(arg);
  43. }
  44. double VariantUtilityFunctions::cos(double arg) {
  45. return Math::cos(arg);
  46. }
  47. double VariantUtilityFunctions::tan(double arg) {
  48. return Math::tan(arg);
  49. }
  50. double VariantUtilityFunctions::sinh(double arg) {
  51. return Math::sinh(arg);
  52. }
  53. double VariantUtilityFunctions::cosh(double arg) {
  54. return Math::cosh(arg);
  55. }
  56. double VariantUtilityFunctions::tanh(double arg) {
  57. return Math::tanh(arg);
  58. }
  59. double VariantUtilityFunctions::asin(double arg) {
  60. return Math::asin(arg);
  61. }
  62. double VariantUtilityFunctions::acos(double arg) {
  63. return Math::acos(arg);
  64. }
  65. double VariantUtilityFunctions::atan(double arg) {
  66. return Math::atan(arg);
  67. }
  68. double VariantUtilityFunctions::atan2(double y, double x) {
  69. return Math::atan2(y, x);
  70. }
  71. double VariantUtilityFunctions::asinh(double arg) {
  72. return Math::asinh(arg);
  73. }
  74. double VariantUtilityFunctions::acosh(double arg) {
  75. return Math::acosh(arg);
  76. }
  77. double VariantUtilityFunctions::atanh(double arg) {
  78. return Math::atanh(arg);
  79. }
  80. double VariantUtilityFunctions::sqrt(double x) {
  81. return Math::sqrt(x);
  82. }
  83. double VariantUtilityFunctions::fmod(double b, double r) {
  84. return Math::fmod(b, r);
  85. }
  86. double VariantUtilityFunctions::fposmod(double b, double r) {
  87. return Math::fposmod(b, r);
  88. }
  89. int64_t VariantUtilityFunctions::posmod(int64_t b, int64_t r) {
  90. return Math::posmod(b, r);
  91. }
  92. Variant VariantUtilityFunctions::floor(Variant x, Callable::CallError &r_error) {
  93. r_error.error = Callable::CallError::CALL_OK;
  94. switch (x.get_type()) {
  95. case Variant::INT: {
  96. return VariantInternalAccessor<int64_t>::get(&x);
  97. } break;
  98. case Variant::FLOAT: {
  99. return Math::floor(VariantInternalAccessor<double>::get(&x));
  100. } break;
  101. case Variant::VECTOR2: {
  102. return VariantInternalAccessor<Vector2>::get(&x).floor();
  103. } break;
  104. case Variant::VECTOR3: {
  105. return VariantInternalAccessor<Vector3>::get(&x).floor();
  106. } break;
  107. case Variant::VECTOR4: {
  108. return VariantInternalAccessor<Vector4>::get(&x).floor();
  109. } break;
  110. default: {
  111. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  112. return Variant();
  113. }
  114. }
  115. }
  116. double VariantUtilityFunctions::floorf(double x) {
  117. return Math::floor(x);
  118. }
  119. int64_t VariantUtilityFunctions::floori(double x) {
  120. return int64_t(Math::floor(x));
  121. }
  122. Variant VariantUtilityFunctions::ceil(Variant x, Callable::CallError &r_error) {
  123. r_error.error = Callable::CallError::CALL_OK;
  124. switch (x.get_type()) {
  125. case Variant::INT: {
  126. return VariantInternalAccessor<int64_t>::get(&x);
  127. } break;
  128. case Variant::FLOAT: {
  129. return Math::ceil(VariantInternalAccessor<double>::get(&x));
  130. } break;
  131. case Variant::VECTOR2: {
  132. return VariantInternalAccessor<Vector2>::get(&x).ceil();
  133. } break;
  134. case Variant::VECTOR3: {
  135. return VariantInternalAccessor<Vector3>::get(&x).ceil();
  136. } break;
  137. case Variant::VECTOR4: {
  138. return VariantInternalAccessor<Vector4>::get(&x).ceil();
  139. } break;
  140. default: {
  141. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  142. return Variant();
  143. }
  144. }
  145. }
  146. double VariantUtilityFunctions::ceilf(double x) {
  147. return Math::ceil(x);
  148. }
  149. int64_t VariantUtilityFunctions::ceili(double x) {
  150. return int64_t(Math::ceil(x));
  151. }
  152. Variant VariantUtilityFunctions::round(Variant x, Callable::CallError &r_error) {
  153. r_error.error = Callable::CallError::CALL_OK;
  154. switch (x.get_type()) {
  155. case Variant::INT: {
  156. return VariantInternalAccessor<int64_t>::get(&x);
  157. } break;
  158. case Variant::FLOAT: {
  159. return Math::round(VariantInternalAccessor<double>::get(&x));
  160. } break;
  161. case Variant::VECTOR2: {
  162. return VariantInternalAccessor<Vector2>::get(&x).round();
  163. } break;
  164. case Variant::VECTOR3: {
  165. return VariantInternalAccessor<Vector3>::get(&x).round();
  166. } break;
  167. case Variant::VECTOR4: {
  168. return VariantInternalAccessor<Vector4>::get(&x).round();
  169. } break;
  170. default: {
  171. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  172. return Variant();
  173. }
  174. }
  175. }
  176. double VariantUtilityFunctions::roundf(double x) {
  177. return Math::round(x);
  178. }
  179. int64_t VariantUtilityFunctions::roundi(double x) {
  180. return int64_t(Math::round(x));
  181. }
  182. Variant VariantUtilityFunctions::abs(const Variant &x, Callable::CallError &r_error) {
  183. r_error.error = Callable::CallError::CALL_OK;
  184. switch (x.get_type()) {
  185. case Variant::INT: {
  186. return ABS(VariantInternalAccessor<int64_t>::get(&x));
  187. } break;
  188. case Variant::FLOAT: {
  189. return Math::absd(VariantInternalAccessor<double>::get(&x));
  190. } break;
  191. case Variant::VECTOR2: {
  192. return VariantInternalAccessor<Vector2>::get(&x).abs();
  193. } break;
  194. case Variant::VECTOR2I: {
  195. return VariantInternalAccessor<Vector2i>::get(&x).abs();
  196. } break;
  197. case Variant::VECTOR3: {
  198. return VariantInternalAccessor<Vector3>::get(&x).abs();
  199. } break;
  200. case Variant::VECTOR3I: {
  201. return VariantInternalAccessor<Vector3i>::get(&x).abs();
  202. } break;
  203. case Variant::VECTOR4: {
  204. return VariantInternalAccessor<Vector4>::get(&x).abs();
  205. } break;
  206. case Variant::VECTOR4I: {
  207. return VariantInternalAccessor<Vector4i>::get(&x).abs();
  208. } break;
  209. default: {
  210. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  211. return Variant();
  212. }
  213. }
  214. }
  215. double VariantUtilityFunctions::absf(double x) {
  216. return Math::absd(x);
  217. }
  218. int64_t VariantUtilityFunctions::absi(int64_t x) {
  219. return ABS(x);
  220. }
  221. Variant VariantUtilityFunctions::sign(const Variant &x, Callable::CallError &r_error) {
  222. r_error.error = Callable::CallError::CALL_OK;
  223. switch (x.get_type()) {
  224. case Variant::INT: {
  225. return SIGN(VariantInternalAccessor<int64_t>::get(&x));
  226. } break;
  227. case Variant::FLOAT: {
  228. return SIGN(VariantInternalAccessor<double>::get(&x));
  229. } break;
  230. case Variant::VECTOR2: {
  231. return VariantInternalAccessor<Vector2>::get(&x).sign();
  232. } break;
  233. case Variant::VECTOR2I: {
  234. return VariantInternalAccessor<Vector2i>::get(&x).sign();
  235. } break;
  236. case Variant::VECTOR3: {
  237. return VariantInternalAccessor<Vector3>::get(&x).sign();
  238. } break;
  239. case Variant::VECTOR3I: {
  240. return VariantInternalAccessor<Vector3i>::get(&x).sign();
  241. } break;
  242. case Variant::VECTOR4: {
  243. return VariantInternalAccessor<Vector4>::get(&x).sign();
  244. } break;
  245. case Variant::VECTOR4I: {
  246. return VariantInternalAccessor<Vector4i>::get(&x).sign();
  247. } break;
  248. default: {
  249. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  250. return Variant();
  251. }
  252. }
  253. }
  254. double VariantUtilityFunctions::signf(double x) {
  255. return SIGN(x);
  256. }
  257. int64_t VariantUtilityFunctions::signi(int64_t x) {
  258. return SIGN(x);
  259. }
  260. double VariantUtilityFunctions::pow(double x, double y) {
  261. return Math::pow(x, y);
  262. }
  263. double VariantUtilityFunctions::log(double x) {
  264. return Math::log(x);
  265. }
  266. double VariantUtilityFunctions::exp(double x) {
  267. return Math::exp(x);
  268. }
  269. bool VariantUtilityFunctions::is_nan(double x) {
  270. return Math::is_nan(x);
  271. }
  272. bool VariantUtilityFunctions::is_inf(double x) {
  273. return Math::is_inf(x);
  274. }
  275. bool VariantUtilityFunctions::is_equal_approx(double x, double y) {
  276. return Math::is_equal_approx(x, y);
  277. }
  278. bool VariantUtilityFunctions::is_zero_approx(double x) {
  279. return Math::is_zero_approx(x);
  280. }
  281. bool VariantUtilityFunctions::is_finite(double x) {
  282. return Math::is_finite(x);
  283. }
  284. double VariantUtilityFunctions::ease(float x, float curve) {
  285. return Math::ease(x, curve);
  286. }
  287. int VariantUtilityFunctions::step_decimals(float step) {
  288. return Math::step_decimals(step);
  289. }
  290. Variant VariantUtilityFunctions::snapped(const Variant &x, const Variant &step, Callable::CallError &r_error) {
  291. r_error.error = Callable::CallError::CALL_OK;
  292. if (x.get_type() != step.get_type() && !((x.get_type() == Variant::INT && step.get_type() == Variant::FLOAT) || (x.get_type() == Variant::FLOAT && step.get_type() == Variant::INT))) {
  293. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  294. r_error.argument = 1;
  295. r_error.expected = x.get_type();
  296. return Variant();
  297. }
  298. switch (step.get_type()) {
  299. case Variant::INT: {
  300. return snappedi(x, VariantInternalAccessor<int64_t>::get(&step));
  301. } break;
  302. case Variant::FLOAT: {
  303. return snappedf(x, VariantInternalAccessor<double>::get(&step));
  304. } break;
  305. case Variant::VECTOR2: {
  306. return VariantInternalAccessor<Vector2>::get(&x).snapped(VariantInternalAccessor<Vector2>::get(&step));
  307. } break;
  308. case Variant::VECTOR2I: {
  309. return VariantInternalAccessor<Vector2i>::get(&x).snapped(VariantInternalAccessor<Vector2i>::get(&step));
  310. } break;
  311. case Variant::VECTOR3: {
  312. return VariantInternalAccessor<Vector3>::get(&x).snapped(VariantInternalAccessor<Vector3>::get(&step));
  313. } break;
  314. case Variant::VECTOR3I: {
  315. return VariantInternalAccessor<Vector3i>::get(&x).snapped(VariantInternalAccessor<Vector3i>::get(&step));
  316. } break;
  317. case Variant::VECTOR4: {
  318. return VariantInternalAccessor<Vector4>::get(&x).snapped(VariantInternalAccessor<Vector4>::get(&step));
  319. } break;
  320. case Variant::VECTOR4I: {
  321. return VariantInternalAccessor<Vector4i>::get(&x).snapped(VariantInternalAccessor<Vector4i>::get(&step));
  322. } break;
  323. default: {
  324. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  325. return Variant();
  326. }
  327. }
  328. }
  329. double VariantUtilityFunctions::snappedf(double x, double step) {
  330. return Math::snapped(x, step);
  331. }
  332. int64_t VariantUtilityFunctions::snappedi(double x, int64_t step) {
  333. return Math::snapped(x, step);
  334. }
  335. Variant VariantUtilityFunctions::lerp(const Variant &from, const Variant &to, double weight, Callable::CallError &r_error) {
  336. r_error.error = Callable::CallError::CALL_OK;
  337. if (from.get_type() != to.get_type()) {
  338. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  339. r_error.argument = 1;
  340. r_error.expected = from.get_type();
  341. return Variant();
  342. }
  343. switch (from.get_type()) {
  344. case Variant::INT: {
  345. return lerpf(VariantInternalAccessor<int64_t>::get(&from), to, weight);
  346. } break;
  347. case Variant::FLOAT: {
  348. return lerpf(VariantInternalAccessor<double>::get(&from), to, weight);
  349. } break;
  350. case Variant::VECTOR2: {
  351. return VariantInternalAccessor<Vector2>::get(&from).lerp(VariantInternalAccessor<Vector2>::get(&to), weight);
  352. } break;
  353. case Variant::VECTOR3: {
  354. return VariantInternalAccessor<Vector3>::get(&from).lerp(VariantInternalAccessor<Vector3>::get(&to), weight);
  355. } break;
  356. case Variant::VECTOR4: {
  357. return VariantInternalAccessor<Vector4>::get(&from).lerp(VariantInternalAccessor<Vector4>::get(&to), weight);
  358. } break;
  359. case Variant::QUATERNION: {
  360. return VariantInternalAccessor<Quaternion>::get(&from).slerp(VariantInternalAccessor<Quaternion>::get(&to), weight);
  361. } break;
  362. case Variant::BASIS: {
  363. return VariantInternalAccessor<Basis>::get(&from).slerp(VariantInternalAccessor<Basis>::get(&to), weight);
  364. } break;
  365. case Variant::COLOR: {
  366. return VariantInternalAccessor<Color>::get(&from).lerp(VariantInternalAccessor<Color>::get(&to), weight);
  367. } break;
  368. default: {
  369. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  370. return Variant();
  371. }
  372. }
  373. }
  374. double VariantUtilityFunctions::lerpf(double from, double to, double weight) {
  375. return Math::lerp(from, to, weight);
  376. }
  377. double VariantUtilityFunctions::cubic_interpolate(double from, double to, double pre, double post, double weight) {
  378. return Math::cubic_interpolate(from, to, pre, post, weight);
  379. }
  380. double VariantUtilityFunctions::cubic_interpolate_angle(double from, double to, double pre, double post, double weight) {
  381. return Math::cubic_interpolate_angle(from, to, pre, post, weight);
  382. }
  383. double VariantUtilityFunctions::cubic_interpolate_in_time(double from, double to, double pre, double post, double weight,
  384. double to_t, double pre_t, double post_t) {
  385. return Math::cubic_interpolate_in_time(from, to, pre, post, weight, to_t, pre_t, post_t);
  386. }
  387. double VariantUtilityFunctions::cubic_interpolate_angle_in_time(double from, double to, double pre, double post, double weight,
  388. double to_t, double pre_t, double post_t) {
  389. return Math::cubic_interpolate_angle_in_time(from, to, pre, post, weight, to_t, pre_t, post_t);
  390. }
  391. double VariantUtilityFunctions::bezier_interpolate(double p_start, double p_control_1, double p_control_2, double p_end, double p_t) {
  392. return Math::bezier_interpolate(p_start, p_control_1, p_control_2, p_end, p_t);
  393. }
  394. double VariantUtilityFunctions::bezier_derivative(double p_start, double p_control_1, double p_control_2, double p_end, double p_t) {
  395. return Math::bezier_derivative(p_start, p_control_1, p_control_2, p_end, p_t);
  396. }
  397. double VariantUtilityFunctions::angle_difference(double from, double to) {
  398. return Math::angle_difference(from, to);
  399. }
  400. double VariantUtilityFunctions::lerp_angle(double from, double to, double weight) {
  401. return Math::lerp_angle(from, to, weight);
  402. }
  403. double VariantUtilityFunctions::inverse_lerp(double from, double to, double weight) {
  404. return Math::inverse_lerp(from, to, weight);
  405. }
  406. double VariantUtilityFunctions::remap(double value, double istart, double istop, double ostart, double ostop) {
  407. return Math::remap(value, istart, istop, ostart, ostop);
  408. }
  409. double VariantUtilityFunctions::smoothstep(double from, double to, double val) {
  410. return Math::smoothstep(from, to, val);
  411. }
  412. double VariantUtilityFunctions::move_toward(double from, double to, double delta) {
  413. return Math::move_toward(from, to, delta);
  414. }
  415. double VariantUtilityFunctions::rotate_toward(double from, double to, double delta) {
  416. return Math::rotate_toward(from, to, delta);
  417. }
  418. double VariantUtilityFunctions::deg_to_rad(double angle_deg) {
  419. return Math::deg_to_rad(angle_deg);
  420. }
  421. double VariantUtilityFunctions::rad_to_deg(double angle_rad) {
  422. return Math::rad_to_deg(angle_rad);
  423. }
  424. double VariantUtilityFunctions::linear_to_db(double linear) {
  425. return Math::linear_to_db(linear);
  426. }
  427. double VariantUtilityFunctions::db_to_linear(double db) {
  428. return Math::db_to_linear(db);
  429. }
  430. Variant VariantUtilityFunctions::wrap(const Variant &p_x, const Variant &p_min, const Variant &p_max, Callable::CallError &r_error) {
  431. Variant::Type x_type = p_x.get_type();
  432. if (x_type != Variant::INT && x_type != Variant::FLOAT) {
  433. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  434. r_error.argument = 0;
  435. r_error.expected = Variant::FLOAT;
  436. return Variant();
  437. }
  438. Variant::Type min_type = p_min.get_type();
  439. if (min_type != Variant::INT && min_type != Variant::FLOAT) {
  440. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  441. r_error.argument = 1;
  442. r_error.expected = x_type;
  443. return Variant();
  444. }
  445. Variant::Type max_type = p_max.get_type();
  446. if (max_type != Variant::INT && max_type != Variant::FLOAT) {
  447. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  448. r_error.argument = 2;
  449. r_error.expected = x_type;
  450. return Variant();
  451. }
  452. Variant value;
  453. switch (x_type) {
  454. case Variant::INT: {
  455. if (x_type != min_type || x_type != max_type) {
  456. value = wrapf((double)p_x, (double)p_min, (double)p_max);
  457. } else {
  458. value = wrapi((int)p_x, (int)p_min, (int)p_max);
  459. }
  460. } break;
  461. case Variant::FLOAT: {
  462. value = wrapf((double)p_x, (double)p_min, (double)p_max);
  463. } break;
  464. default:
  465. break;
  466. }
  467. r_error.error = Callable::CallError::CALL_OK;
  468. return value;
  469. }
  470. int64_t VariantUtilityFunctions::wrapi(int64_t value, int64_t min, int64_t max) {
  471. return Math::wrapi(value, min, max);
  472. }
  473. double VariantUtilityFunctions::wrapf(double value, double min, double max) {
  474. return Math::wrapf(value, min, max);
  475. }
  476. double VariantUtilityFunctions::pingpong(double value, double length) {
  477. return Math::pingpong(value, length);
  478. }
  479. Variant VariantUtilityFunctions::max(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  480. if (p_argcount < 2) {
  481. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  482. r_error.expected = 2;
  483. return Variant();
  484. }
  485. Variant base = *p_args[0];
  486. Variant ret;
  487. for (int i = 0; i < p_argcount; i++) {
  488. Variant::Type arg_type = p_args[i]->get_type();
  489. if (arg_type != Variant::INT && arg_type != Variant::FLOAT) {
  490. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  491. r_error.argument = i;
  492. r_error.expected = Variant::FLOAT;
  493. return Variant();
  494. }
  495. if (i == 0) {
  496. continue;
  497. }
  498. bool valid;
  499. Variant::evaluate(Variant::OP_LESS, base, *p_args[i], ret, valid);
  500. if (!valid) {
  501. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  502. r_error.argument = i;
  503. r_error.expected = base.get_type();
  504. return Variant();
  505. }
  506. if (ret.booleanize()) {
  507. base = *p_args[i];
  508. }
  509. }
  510. r_error.error = Callable::CallError::CALL_OK;
  511. return base;
  512. }
  513. double VariantUtilityFunctions::maxf(double x, double y) {
  514. return MAX(x, y);
  515. }
  516. int64_t VariantUtilityFunctions::maxi(int64_t x, int64_t y) {
  517. return MAX(x, y);
  518. }
  519. Variant VariantUtilityFunctions::min(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  520. if (p_argcount < 2) {
  521. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  522. r_error.expected = 2;
  523. return Variant();
  524. }
  525. Variant base = *p_args[0];
  526. Variant ret;
  527. for (int i = 0; i < p_argcount; i++) {
  528. Variant::Type arg_type = p_args[i]->get_type();
  529. if (arg_type != Variant::INT && arg_type != Variant::FLOAT) {
  530. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  531. r_error.argument = i;
  532. r_error.expected = Variant::FLOAT;
  533. return Variant();
  534. }
  535. if (i == 0) {
  536. continue;
  537. }
  538. bool valid;
  539. Variant::evaluate(Variant::OP_GREATER, base, *p_args[i], ret, valid);
  540. if (!valid) {
  541. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  542. r_error.argument = i;
  543. r_error.expected = base.get_type();
  544. return Variant();
  545. }
  546. if (ret.booleanize()) {
  547. base = *p_args[i];
  548. }
  549. }
  550. r_error.error = Callable::CallError::CALL_OK;
  551. return base;
  552. }
  553. double VariantUtilityFunctions::minf(double x, double y) {
  554. return MIN(x, y);
  555. }
  556. int64_t VariantUtilityFunctions::mini(int64_t x, int64_t y) {
  557. return MIN(x, y);
  558. }
  559. Variant VariantUtilityFunctions::clamp(const Variant &x, const Variant &min, const Variant &max, Callable::CallError &r_error) {
  560. Variant value = x;
  561. Variant ret;
  562. bool valid;
  563. Variant::evaluate(Variant::OP_LESS, value, min, ret, valid);
  564. if (!valid) {
  565. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  566. r_error.argument = 1;
  567. r_error.expected = value.get_type();
  568. return Variant();
  569. }
  570. if (ret.booleanize()) {
  571. value = min;
  572. }
  573. Variant::evaluate(Variant::OP_GREATER, value, max, ret, valid);
  574. if (!valid) {
  575. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  576. r_error.argument = 2;
  577. r_error.expected = value.get_type();
  578. return Variant();
  579. }
  580. if (ret.booleanize()) {
  581. value = max;
  582. }
  583. r_error.error = Callable::CallError::CALL_OK;
  584. return value;
  585. }
  586. double VariantUtilityFunctions::clampf(double x, double min, double max) {
  587. return CLAMP(x, min, max);
  588. }
  589. int64_t VariantUtilityFunctions::clampi(int64_t x, int64_t min, int64_t max) {
  590. return CLAMP(x, min, max);
  591. }
  592. int64_t VariantUtilityFunctions::nearest_po2(int64_t x) {
  593. return nearest_power_of_2_templated(uint64_t(x));
  594. }
  595. // Random
  596. void VariantUtilityFunctions::randomize() {
  597. Math::randomize();
  598. }
  599. int64_t VariantUtilityFunctions::randi() {
  600. return Math::rand();
  601. }
  602. double VariantUtilityFunctions::randf() {
  603. return Math::randf();
  604. }
  605. double VariantUtilityFunctions::randfn(double mean, double deviation) {
  606. return Math::randfn(mean, deviation);
  607. }
  608. int64_t VariantUtilityFunctions::randi_range(int64_t from, int64_t to) {
  609. return Math::random((int32_t)from, (int32_t)to);
  610. }
  611. double VariantUtilityFunctions::randf_range(double from, double to) {
  612. return Math::random(from, to);
  613. }
  614. void VariantUtilityFunctions::seed(int64_t s) {
  615. return Math::seed(s);
  616. }
  617. PackedInt64Array VariantUtilityFunctions::rand_from_seed(int64_t seed) {
  618. uint64_t s = seed;
  619. PackedInt64Array arr;
  620. arr.resize(2);
  621. arr.write[0] = Math::rand_from_seed(&s);
  622. arr.write[1] = s;
  623. return arr;
  624. }
  625. // Utility
  626. Variant VariantUtilityFunctions::weakref(const Variant &obj, Callable::CallError &r_error) {
  627. if (obj.get_type() == Variant::OBJECT) {
  628. r_error.error = Callable::CallError::CALL_OK;
  629. if (obj.is_ref_counted()) {
  630. Ref<WeakRef> wref = memnew(WeakRef);
  631. Ref<RefCounted> r = obj;
  632. if (r.is_valid()) {
  633. wref->set_ref(r);
  634. }
  635. return wref;
  636. } else {
  637. Ref<WeakRef> wref = memnew(WeakRef);
  638. Object *o = obj.get_validated_object();
  639. if (o) {
  640. wref->set_obj(o);
  641. }
  642. return wref;
  643. }
  644. } else if (obj.get_type() == Variant::NIL) {
  645. r_error.error = Callable::CallError::CALL_OK;
  646. Ref<WeakRef> wref = memnew(WeakRef);
  647. return wref;
  648. } else {
  649. r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
  650. r_error.argument = 0;
  651. r_error.expected = Variant::OBJECT;
  652. return Variant();
  653. }
  654. }
  655. int64_t VariantUtilityFunctions::_typeof(const Variant &obj) {
  656. return obj.get_type();
  657. }
  658. Variant VariantUtilityFunctions::type_convert(const Variant &p_variant, const Variant::Type p_type) {
  659. switch (p_type) {
  660. case Variant::Type::NIL:
  661. return Variant();
  662. case Variant::Type::BOOL:
  663. return p_variant.operator bool();
  664. case Variant::Type::INT:
  665. return p_variant.operator int64_t();
  666. case Variant::Type::FLOAT:
  667. return p_variant.operator double();
  668. case Variant::Type::STRING:
  669. return p_variant.operator String();
  670. case Variant::Type::VECTOR2:
  671. return p_variant.operator Vector2();
  672. case Variant::Type::VECTOR2I:
  673. return p_variant.operator Vector2i();
  674. case Variant::Type::RECT2:
  675. return p_variant.operator Rect2();
  676. case Variant::Type::RECT2I:
  677. return p_variant.operator Rect2i();
  678. case Variant::Type::VECTOR3:
  679. return p_variant.operator Vector3();
  680. case Variant::Type::VECTOR3I:
  681. return p_variant.operator Vector3i();
  682. case Variant::Type::TRANSFORM2D:
  683. return p_variant.operator Transform2D();
  684. case Variant::Type::VECTOR4:
  685. return p_variant.operator Vector4();
  686. case Variant::Type::VECTOR4I:
  687. return p_variant.operator Vector4i();
  688. case Variant::Type::PLANE:
  689. return p_variant.operator Plane();
  690. case Variant::Type::QUATERNION:
  691. return p_variant.operator Quaternion();
  692. case Variant::Type::AABB:
  693. return p_variant.operator ::AABB();
  694. case Variant::Type::BASIS:
  695. return p_variant.operator Basis();
  696. case Variant::Type::TRANSFORM3D:
  697. return p_variant.operator Transform3D();
  698. case Variant::Type::PROJECTION:
  699. return p_variant.operator Projection();
  700. case Variant::Type::COLOR:
  701. return p_variant.operator Color();
  702. case Variant::Type::STRING_NAME:
  703. return p_variant.operator StringName();
  704. case Variant::Type::NODE_PATH:
  705. return p_variant.operator NodePath();
  706. case Variant::Type::RID:
  707. return p_variant.operator ::RID();
  708. case Variant::Type::OBJECT:
  709. return p_variant.operator Object *();
  710. case Variant::Type::CALLABLE:
  711. return p_variant.operator Callable();
  712. case Variant::Type::SIGNAL:
  713. return p_variant.operator Signal();
  714. case Variant::Type::DICTIONARY:
  715. return p_variant.operator Dictionary();
  716. case Variant::Type::ARRAY:
  717. return p_variant.operator Array();
  718. case Variant::Type::PACKED_BYTE_ARRAY:
  719. return p_variant.operator PackedByteArray();
  720. case Variant::Type::PACKED_INT32_ARRAY:
  721. return p_variant.operator PackedInt32Array();
  722. case Variant::Type::PACKED_INT64_ARRAY:
  723. return p_variant.operator PackedInt64Array();
  724. case Variant::Type::PACKED_FLOAT32_ARRAY:
  725. return p_variant.operator PackedFloat32Array();
  726. case Variant::Type::PACKED_FLOAT64_ARRAY:
  727. return p_variant.operator PackedFloat64Array();
  728. case Variant::Type::PACKED_STRING_ARRAY:
  729. return p_variant.operator PackedStringArray();
  730. case Variant::Type::PACKED_VECTOR2_ARRAY:
  731. return p_variant.operator PackedVector2Array();
  732. case Variant::Type::PACKED_VECTOR3_ARRAY:
  733. return p_variant.operator PackedVector3Array();
  734. case Variant::Type::PACKED_COLOR_ARRAY:
  735. return p_variant.operator PackedColorArray();
  736. case Variant::Type::VARIANT_MAX:
  737. ERR_PRINT("Invalid type argument to type_convert(), use the TYPE_* constants. Returning the unconverted Variant.");
  738. }
  739. return p_variant;
  740. }
  741. String VariantUtilityFunctions::str(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  742. if (p_arg_count < 1) {
  743. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  744. r_error.expected = 1;
  745. return String();
  746. }
  747. String s;
  748. for (int i = 0; i < p_arg_count; i++) {
  749. String os = p_args[i]->operator String();
  750. if (i == 0) {
  751. s = os;
  752. } else {
  753. s += os;
  754. }
  755. }
  756. r_error.error = Callable::CallError::CALL_OK;
  757. return s;
  758. }
  759. String VariantUtilityFunctions::error_string(Error error) {
  760. if (error < 0 || error >= ERR_MAX) {
  761. return String("(invalid error code)");
  762. }
  763. return String(error_names[error]);
  764. }
  765. String VariantUtilityFunctions::type_string(Variant::Type p_type) {
  766. ERR_FAIL_INDEX_V_MSG((int)p_type, (int)Variant::VARIANT_MAX, "<invalid type>", "Invalid type argument to type_string(), use the TYPE_* constants.");
  767. return Variant::get_type_name(p_type);
  768. }
  769. void VariantUtilityFunctions::print(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  770. String s;
  771. for (int i = 0; i < p_arg_count; i++) {
  772. String os = p_args[i]->operator String();
  773. if (i == 0) {
  774. s = os;
  775. } else {
  776. s += os;
  777. }
  778. }
  779. print_line(s);
  780. r_error.error = Callable::CallError::CALL_OK;
  781. }
  782. void VariantUtilityFunctions::print_rich(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  783. String s;
  784. for (int i = 0; i < p_arg_count; i++) {
  785. String os = p_args[i]->operator String();
  786. if (i == 0) {
  787. s = os;
  788. } else {
  789. s += os;
  790. }
  791. }
  792. print_line_rich(s);
  793. r_error.error = Callable::CallError::CALL_OK;
  794. }
  795. #undef print_verbose
  796. void VariantUtilityFunctions::print_verbose(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  797. if (OS::get_singleton()->is_stdout_verbose()) {
  798. String s;
  799. for (int i = 0; i < p_arg_count; i++) {
  800. String os = p_args[i]->operator String();
  801. if (i == 0) {
  802. s = os;
  803. } else {
  804. s += os;
  805. }
  806. }
  807. // No need to use `print_verbose()` as this call already only happens
  808. // when verbose mode is enabled. This avoids performing string argument concatenation
  809. // when not needed.
  810. print_line(s);
  811. }
  812. r_error.error = Callable::CallError::CALL_OK;
  813. }
  814. void VariantUtilityFunctions::printerr(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  815. String s;
  816. for (int i = 0; i < p_arg_count; i++) {
  817. String os = p_args[i]->operator String();
  818. if (i == 0) {
  819. s = os;
  820. } else {
  821. s += os;
  822. }
  823. }
  824. print_error(s);
  825. r_error.error = Callable::CallError::CALL_OK;
  826. }
  827. void VariantUtilityFunctions::printt(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  828. String s;
  829. for (int i = 0; i < p_arg_count; i++) {
  830. if (i) {
  831. s += "\t";
  832. }
  833. s += p_args[i]->operator String();
  834. }
  835. print_line(s);
  836. r_error.error = Callable::CallError::CALL_OK;
  837. }
  838. void VariantUtilityFunctions::prints(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  839. String s;
  840. for (int i = 0; i < p_arg_count; i++) {
  841. if (i) {
  842. s += " ";
  843. }
  844. s += p_args[i]->operator String();
  845. }
  846. print_line(s);
  847. r_error.error = Callable::CallError::CALL_OK;
  848. }
  849. void VariantUtilityFunctions::printraw(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  850. String s;
  851. for (int i = 0; i < p_arg_count; i++) {
  852. String os = p_args[i]->operator String();
  853. if (i == 0) {
  854. s = os;
  855. } else {
  856. s += os;
  857. }
  858. }
  859. OS::get_singleton()->print("%s", s.utf8().get_data());
  860. r_error.error = Callable::CallError::CALL_OK;
  861. }
  862. void VariantUtilityFunctions::push_error(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  863. if (p_arg_count < 1) {
  864. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  865. r_error.expected = 1;
  866. }
  867. String s;
  868. for (int i = 0; i < p_arg_count; i++) {
  869. String os = p_args[i]->operator String();
  870. if (i == 0) {
  871. s = os;
  872. } else {
  873. s += os;
  874. }
  875. }
  876. ERR_PRINT(s);
  877. r_error.error = Callable::CallError::CALL_OK;
  878. }
  879. void VariantUtilityFunctions::push_warning(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
  880. if (p_arg_count < 1) {
  881. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  882. r_error.expected = 1;
  883. }
  884. String s;
  885. for (int i = 0; i < p_arg_count; i++) {
  886. String os = p_args[i]->operator String();
  887. if (i == 0) {
  888. s = os;
  889. } else {
  890. s += os;
  891. }
  892. }
  893. WARN_PRINT(s);
  894. r_error.error = Callable::CallError::CALL_OK;
  895. }
  896. String VariantUtilityFunctions::var_to_str(const Variant &p_var) {
  897. String vars;
  898. VariantWriter::write_to_string(p_var, vars);
  899. return vars;
  900. }
  901. Variant VariantUtilityFunctions::str_to_var(const String &p_var) {
  902. VariantParser::StreamString ss;
  903. ss.s = p_var;
  904. String errs;
  905. int line;
  906. Variant ret;
  907. (void)VariantParser::parse(&ss, ret, errs, line);
  908. return ret;
  909. }
  910. PackedByteArray VariantUtilityFunctions::var_to_bytes(const Variant &p_var) {
  911. int len;
  912. Error err = encode_variant(p_var, nullptr, len, false);
  913. if (err != OK) {
  914. return PackedByteArray();
  915. }
  916. PackedByteArray barr;
  917. barr.resize(len);
  918. {
  919. uint8_t *w = barr.ptrw();
  920. err = encode_variant(p_var, w, len, false);
  921. if (err != OK) {
  922. return PackedByteArray();
  923. }
  924. }
  925. return barr;
  926. }
  927. PackedByteArray VariantUtilityFunctions::var_to_bytes_with_objects(const Variant &p_var) {
  928. int len;
  929. Error err = encode_variant(p_var, nullptr, len, true);
  930. if (err != OK) {
  931. return PackedByteArray();
  932. }
  933. PackedByteArray barr;
  934. barr.resize(len);
  935. {
  936. uint8_t *w = barr.ptrw();
  937. err = encode_variant(p_var, w, len, true);
  938. if (err != OK) {
  939. return PackedByteArray();
  940. }
  941. }
  942. return barr;
  943. }
  944. Variant VariantUtilityFunctions::bytes_to_var(const PackedByteArray &p_arr) {
  945. Variant ret;
  946. {
  947. const uint8_t *r = p_arr.ptr();
  948. Error err = decode_variant(ret, r, p_arr.size(), nullptr, false);
  949. if (err != OK) {
  950. return Variant();
  951. }
  952. }
  953. return ret;
  954. }
  955. Variant VariantUtilityFunctions::bytes_to_var_with_objects(const PackedByteArray &p_arr) {
  956. Variant ret;
  957. {
  958. const uint8_t *r = p_arr.ptr();
  959. Error err = decode_variant(ret, r, p_arr.size(), nullptr, true);
  960. if (err != OK) {
  961. return Variant();
  962. }
  963. }
  964. return ret;
  965. }
  966. int64_t VariantUtilityFunctions::hash(const Variant &p_arr) {
  967. return p_arr.hash();
  968. }
  969. Object *VariantUtilityFunctions::instance_from_id(int64_t p_id) {
  970. ObjectID id = ObjectID((uint64_t)p_id);
  971. Object *ret = ObjectDB::get_instance(id);
  972. return ret;
  973. }
  974. bool VariantUtilityFunctions::is_instance_id_valid(int64_t p_id) {
  975. return ObjectDB::get_instance(ObjectID((uint64_t)p_id)) != nullptr;
  976. }
  977. bool VariantUtilityFunctions::is_instance_valid(const Variant &p_instance) {
  978. if (p_instance.get_type() != Variant::OBJECT) {
  979. return false;
  980. }
  981. return p_instance.get_validated_object() != nullptr;
  982. }
  983. uint64_t VariantUtilityFunctions::rid_allocate_id() {
  984. return RID_AllocBase::_gen_id();
  985. }
  986. RID VariantUtilityFunctions::rid_from_int64(uint64_t p_base) {
  987. return RID::from_uint64(p_base);
  988. }
  989. bool VariantUtilityFunctions::is_same(const Variant &p_a, const Variant &p_b) {
  990. return p_a.identity_compare(p_b);
  991. }
  992. #ifdef DEBUG_METHODS_ENABLED
  993. #define VCALLR *ret = p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  994. #define VCALL p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
  995. #else
  996. #define VCALLR *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...)
  997. #define VCALL p_func(VariantCaster<P>::cast(*p_args[Is])...)
  998. #endif
  999. template <class R, class... P, size_t... Is>
  1000. static _FORCE_INLINE_ void call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  1001. r_error.error = Callable::CallError::CALL_OK;
  1002. VCALLR;
  1003. (void)p_args; // avoid gcc warning
  1004. (void)r_error;
  1005. }
  1006. template <class R, class... P, size_t... Is>
  1007. static _FORCE_INLINE_ void validated_call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, IndexSequence<Is...>) {
  1008. *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...);
  1009. (void)p_args;
  1010. }
  1011. template <class R, class... P, size_t... Is>
  1012. static _FORCE_INLINE_ void ptr_call_helperpr(R (*p_func)(P...), void *ret, const void **p_args, IndexSequence<Is...>) {
  1013. PtrToArg<R>::encode(p_func(PtrToArg<P>::convert(p_args[Is])...), ret);
  1014. (void)p_args;
  1015. }
  1016. template <class R, class... P>
  1017. static _FORCE_INLINE_ void call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error) {
  1018. call_helperpr(p_func, ret, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  1019. }
  1020. template <class R, class... P>
  1021. static _FORCE_INLINE_ void validated_call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args) {
  1022. validated_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  1023. }
  1024. template <class R, class... P>
  1025. static _FORCE_INLINE_ void ptr_call_helperr(R (*p_func)(P...), void *ret, const void **p_args) {
  1026. ptr_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
  1027. }
  1028. template <class R, class... P>
  1029. static _FORCE_INLINE_ int get_arg_count_helperr(R (*p_func)(P...)) {
  1030. return sizeof...(P);
  1031. }
  1032. template <class R, class... P>
  1033. static _FORCE_INLINE_ Variant::Type get_arg_type_helperr(R (*p_func)(P...), int p_arg) {
  1034. return call_get_argument_type<P...>(p_arg);
  1035. }
  1036. template <class R, class... P>
  1037. static _FORCE_INLINE_ Variant::Type get_ret_type_helperr(R (*p_func)(P...)) {
  1038. return GetTypeInfo<R>::VARIANT_TYPE;
  1039. }
  1040. // WITHOUT RET
  1041. template <class... P, size_t... Is>
  1042. static _FORCE_INLINE_ void call_helperp(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
  1043. r_error.error = Callable::CallError::CALL_OK;
  1044. VCALL;
  1045. (void)p_args;
  1046. (void)r_error;
  1047. }
  1048. template <class... P, size_t... Is>
  1049. static _FORCE_INLINE_ void validated_call_helperp(void (*p_func)(P...), const Variant **p_args, IndexSequence<Is...>) {
  1050. p_func(VariantCaster<P>::cast(*p_args[Is])...);
  1051. (void)p_args;
  1052. }
  1053. template <class... P, size_t... Is>
  1054. static _FORCE_INLINE_ void ptr_call_helperp(void (*p_func)(P...), const void **p_args, IndexSequence<Is...>) {
  1055. p_func(PtrToArg<P>::convert(p_args[Is])...);
  1056. (void)p_args;
  1057. }
  1058. template <class... P>
  1059. static _FORCE_INLINE_ void call_helper(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error) {
  1060. call_helperp(p_func, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
  1061. }
  1062. template <class... P>
  1063. static _FORCE_INLINE_ void validated_call_helper(void (*p_func)(P...), const Variant **p_args) {
  1064. validated_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  1065. }
  1066. template <class... P>
  1067. static _FORCE_INLINE_ void ptr_call_helper(void (*p_func)(P...), const void **p_args) {
  1068. ptr_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
  1069. }
  1070. template <class... P>
  1071. static _FORCE_INLINE_ int get_arg_count_helper(void (*p_func)(P...)) {
  1072. return sizeof...(P);
  1073. }
  1074. template <class... P>
  1075. static _FORCE_INLINE_ Variant::Type get_arg_type_helper(void (*p_func)(P...), int p_arg) {
  1076. return call_get_argument_type<P...>(p_arg);
  1077. }
  1078. template <class... P>
  1079. static _FORCE_INLINE_ Variant::Type get_ret_type_helper(void (*p_func)(P...)) {
  1080. return Variant::NIL;
  1081. }
  1082. #define FUNCBINDR(m_func, m_args, m_category) \
  1083. class Func_##m_func { \
  1084. public: \
  1085. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1086. call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args, r_error); \
  1087. } \
  1088. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1089. validated_call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args); \
  1090. } \
  1091. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1092. ptr_call_helperr(VariantUtilityFunctions::m_func, ret, p_args); \
  1093. } \
  1094. static int get_argument_count() { \
  1095. return get_arg_count_helperr(VariantUtilityFunctions::m_func); \
  1096. } \
  1097. static Variant::Type get_argument_type(int p_arg) { \
  1098. return get_arg_type_helperr(VariantUtilityFunctions::m_func, p_arg); \
  1099. } \
  1100. static Variant::Type get_return_type() { \
  1101. return get_ret_type_helperr(VariantUtilityFunctions::m_func); \
  1102. } \
  1103. static bool has_return_type() { \
  1104. return true; \
  1105. } \
  1106. static bool is_vararg() { return false; } \
  1107. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1108. }; \
  1109. register_utility_function<Func_##m_func>(#m_func, m_args)
  1110. #define FUNCBINDVR(m_func, m_args, m_category) \
  1111. class Func_##m_func { \
  1112. public: \
  1113. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1114. r_error.error = Callable::CallError::CALL_OK; \
  1115. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], r_error); \
  1116. } \
  1117. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1118. Callable::CallError ce; \
  1119. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], ce); \
  1120. } \
  1121. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1122. Callable::CallError ce; \
  1123. PtrToArg<Variant>::encode(VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), ce), ret); \
  1124. } \
  1125. static int get_argument_count() { \
  1126. return 1; \
  1127. } \
  1128. static Variant::Type get_argument_type(int p_arg) { \
  1129. return Variant::NIL; \
  1130. } \
  1131. static Variant::Type get_return_type() { \
  1132. return Variant::NIL; \
  1133. } \
  1134. static bool has_return_type() { \
  1135. return true; \
  1136. } \
  1137. static bool is_vararg() { return false; } \
  1138. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1139. }; \
  1140. register_utility_function<Func_##m_func>(#m_func, m_args)
  1141. #define FUNCBINDVR2(m_func, m_args, m_category) \
  1142. class Func_##m_func { \
  1143. public: \
  1144. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1145. r_error.error = Callable::CallError::CALL_OK; \
  1146. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], r_error); \
  1147. } \
  1148. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1149. Callable::CallError ce; \
  1150. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], ce); \
  1151. } \
  1152. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1153. Callable::CallError ce; \
  1154. Variant r; \
  1155. r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), ce); \
  1156. PtrToArg<Variant>::encode(r, ret); \
  1157. } \
  1158. static int get_argument_count() { \
  1159. return 2; \
  1160. } \
  1161. static Variant::Type get_argument_type(int p_arg) { \
  1162. return Variant::NIL; \
  1163. } \
  1164. static Variant::Type get_return_type() { \
  1165. return Variant::NIL; \
  1166. } \
  1167. static bool has_return_type() { \
  1168. return true; \
  1169. } \
  1170. static bool is_vararg() { return false; } \
  1171. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1172. }; \
  1173. register_utility_function<Func_##m_func>(#m_func, m_args)
  1174. #define FUNCBINDVR3(m_func, m_args, m_category) \
  1175. class Func_##m_func { \
  1176. public: \
  1177. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1178. r_error.error = Callable::CallError::CALL_OK; \
  1179. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], r_error); \
  1180. } \
  1181. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1182. Callable::CallError ce; \
  1183. *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], ce); \
  1184. } \
  1185. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1186. Callable::CallError ce; \
  1187. Variant r; \
  1188. r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), PtrToArg<Variant>::convert(p_args[2]), ce); \
  1189. PtrToArg<Variant>::encode(r, ret); \
  1190. } \
  1191. static int get_argument_count() { \
  1192. return 3; \
  1193. } \
  1194. static Variant::Type get_argument_type(int p_arg) { \
  1195. return Variant::NIL; \
  1196. } \
  1197. static Variant::Type get_return_type() { \
  1198. return Variant::NIL; \
  1199. } \
  1200. static bool has_return_type() { \
  1201. return true; \
  1202. } \
  1203. static bool is_vararg() { return false; } \
  1204. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1205. }; \
  1206. register_utility_function<Func_##m_func>(#m_func, m_args)
  1207. #define FUNCBINDVARARG(m_func, m_args, m_category) \
  1208. class Func_##m_func { \
  1209. public: \
  1210. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1211. r_error.error = Callable::CallError::CALL_OK; \
  1212. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  1213. } \
  1214. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1215. Callable::CallError c; \
  1216. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  1217. } \
  1218. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1219. Vector<Variant> args; \
  1220. for (int i = 0; i < p_argcount; i++) { \
  1221. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  1222. } \
  1223. Vector<const Variant *> argsp; \
  1224. for (int i = 0; i < p_argcount; i++) { \
  1225. argsp.push_back(&args[i]); \
  1226. } \
  1227. Variant r; \
  1228. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  1229. PtrToArg<Variant>::encode(r, ret); \
  1230. } \
  1231. static int get_argument_count() { \
  1232. return 2; \
  1233. } \
  1234. static Variant::Type get_argument_type(int p_arg) { \
  1235. return Variant::NIL; \
  1236. } \
  1237. static Variant::Type get_return_type() { \
  1238. return Variant::NIL; \
  1239. } \
  1240. static bool has_return_type() { \
  1241. return true; \
  1242. } \
  1243. static bool is_vararg() { \
  1244. return true; \
  1245. } \
  1246. static Variant::UtilityFunctionType get_type() { \
  1247. return m_category; \
  1248. } \
  1249. }; \
  1250. register_utility_function<Func_##m_func>(#m_func, m_args)
  1251. #define FUNCBINDVARARGS(m_func, m_args, m_category) \
  1252. class Func_##m_func { \
  1253. public: \
  1254. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1255. r_error.error = Callable::CallError::CALL_OK; \
  1256. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  1257. } \
  1258. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1259. Callable::CallError c; \
  1260. *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  1261. } \
  1262. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1263. Vector<Variant> args; \
  1264. for (int i = 0; i < p_argcount; i++) { \
  1265. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  1266. } \
  1267. Vector<const Variant *> argsp; \
  1268. for (int i = 0; i < p_argcount; i++) { \
  1269. argsp.push_back(&args[i]); \
  1270. } \
  1271. Variant r; \
  1272. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  1273. PtrToArg<String>::encode(r.operator String(), ret); \
  1274. } \
  1275. static int get_argument_count() { \
  1276. return 1; \
  1277. } \
  1278. static Variant::Type get_argument_type(int p_arg) { \
  1279. return Variant::NIL; \
  1280. } \
  1281. static Variant::Type get_return_type() { \
  1282. return Variant::STRING; \
  1283. } \
  1284. static bool has_return_type() { \
  1285. return true; \
  1286. } \
  1287. static bool is_vararg() { \
  1288. return true; \
  1289. } \
  1290. static Variant::UtilityFunctionType get_type() { \
  1291. return m_category; \
  1292. } \
  1293. }; \
  1294. register_utility_function<Func_##m_func>(#m_func, m_args)
  1295. #define FUNCBINDVARARGV(m_func, m_args, m_category) \
  1296. class Func_##m_func { \
  1297. public: \
  1298. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1299. r_error.error = Callable::CallError::CALL_OK; \
  1300. VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
  1301. } \
  1302. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1303. Callable::CallError c; \
  1304. VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
  1305. } \
  1306. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1307. Vector<Variant> args; \
  1308. for (int i = 0; i < p_argcount; i++) { \
  1309. args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
  1310. } \
  1311. Vector<const Variant *> argsp; \
  1312. for (int i = 0; i < p_argcount; i++) { \
  1313. argsp.push_back(&args[i]); \
  1314. } \
  1315. Variant r; \
  1316. validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
  1317. } \
  1318. static int get_argument_count() { \
  1319. return 1; \
  1320. } \
  1321. static Variant::Type get_argument_type(int p_arg) { \
  1322. return Variant::NIL; \
  1323. } \
  1324. static Variant::Type get_return_type() { \
  1325. return Variant::NIL; \
  1326. } \
  1327. static bool has_return_type() { \
  1328. return false; \
  1329. } \
  1330. static bool is_vararg() { \
  1331. return true; \
  1332. } \
  1333. static Variant::UtilityFunctionType get_type() { \
  1334. return m_category; \
  1335. } \
  1336. }; \
  1337. register_utility_function<Func_##m_func>(#m_func, m_args)
  1338. #define FUNCBIND(m_func, m_args, m_category) \
  1339. class Func_##m_func { \
  1340. public: \
  1341. static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
  1342. call_helper(VariantUtilityFunctions::m_func, p_args, r_error); \
  1343. } \
  1344. static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
  1345. validated_call_helper(VariantUtilityFunctions::m_func, p_args); \
  1346. } \
  1347. static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
  1348. ptr_call_helper(VariantUtilityFunctions::m_func, p_args); \
  1349. } \
  1350. static int get_argument_count() { \
  1351. return get_arg_count_helper(VariantUtilityFunctions::m_func); \
  1352. } \
  1353. static Variant::Type get_argument_type(int p_arg) { \
  1354. return get_arg_type_helper(VariantUtilityFunctions::m_func, p_arg); \
  1355. } \
  1356. static Variant::Type get_return_type() { \
  1357. return get_ret_type_helper(VariantUtilityFunctions::m_func); \
  1358. } \
  1359. static bool has_return_type() { \
  1360. return false; \
  1361. } \
  1362. static bool is_vararg() { return false; } \
  1363. static Variant::UtilityFunctionType get_type() { return m_category; } \
  1364. }; \
  1365. register_utility_function<Func_##m_func>(#m_func, m_args)
  1366. struct VariantUtilityFunctionInfo {
  1367. void (*call_utility)(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) = nullptr;
  1368. Variant::ValidatedUtilityFunction validated_call_utility = nullptr;
  1369. Variant::PTRUtilityFunction ptr_call_utility = nullptr;
  1370. Vector<String> argnames;
  1371. bool is_vararg = false;
  1372. bool returns_value = false;
  1373. int argcount = 0;
  1374. Variant::Type (*get_arg_type)(int) = nullptr;
  1375. Variant::Type return_type;
  1376. Variant::UtilityFunctionType type;
  1377. };
  1378. static OAHashMap<StringName, VariantUtilityFunctionInfo> utility_function_table;
  1379. static List<StringName> utility_function_name_table;
  1380. template <class T>
  1381. static void register_utility_function(const String &p_name, const Vector<String> &argnames) {
  1382. String name = p_name;
  1383. if (name.begins_with("_")) {
  1384. name = name.substr(1, name.length() - 1);
  1385. }
  1386. StringName sname = name;
  1387. ERR_FAIL_COND(utility_function_table.has(sname));
  1388. VariantUtilityFunctionInfo bfi;
  1389. bfi.call_utility = T::call;
  1390. bfi.validated_call_utility = T::validated_call;
  1391. bfi.ptr_call_utility = T::ptrcall;
  1392. bfi.is_vararg = T::is_vararg();
  1393. bfi.argnames = argnames;
  1394. bfi.argcount = T::get_argument_count();
  1395. if (!bfi.is_vararg) {
  1396. ERR_FAIL_COND_MSG(argnames.size() != bfi.argcount, "wrong number of arguments binding utility function: " + name);
  1397. }
  1398. bfi.get_arg_type = T::get_argument_type;
  1399. bfi.return_type = T::get_return_type();
  1400. bfi.type = T::get_type();
  1401. bfi.returns_value = T::has_return_type();
  1402. utility_function_table.insert(sname, bfi);
  1403. utility_function_name_table.push_back(sname);
  1404. }
  1405. void Variant::_register_variant_utility_functions() {
  1406. // Math
  1407. FUNCBINDR(sin, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1408. FUNCBINDR(cos, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1409. FUNCBINDR(tan, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1410. FUNCBINDR(sinh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1411. FUNCBINDR(cosh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1412. FUNCBINDR(tanh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1413. FUNCBINDR(asin, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1414. FUNCBINDR(acos, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1415. FUNCBINDR(atan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1416. FUNCBINDR(atan2, sarray("y", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1417. FUNCBINDR(asinh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1418. FUNCBINDR(acosh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1419. FUNCBINDR(atanh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1420. FUNCBINDR(sqrt, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1421. FUNCBINDR(fmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1422. FUNCBINDR(fposmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1423. FUNCBINDR(posmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
  1424. FUNCBINDVR(floor, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1425. FUNCBINDR(floorf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1426. FUNCBINDR(floori, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1427. FUNCBINDVR(ceil, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1428. FUNCBINDR(ceilf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1429. FUNCBINDR(ceili, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1430. FUNCBINDVR(round, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1431. FUNCBINDR(roundf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1432. FUNCBINDR(roundi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1433. FUNCBINDVR(abs, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1434. FUNCBINDR(absf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1435. FUNCBINDR(absi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1436. FUNCBINDVR(sign, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1437. FUNCBINDR(signf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1438. FUNCBINDR(signi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1439. FUNCBINDVR2(snapped, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1440. FUNCBINDR(snappedf, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1441. FUNCBINDR(snappedi, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
  1442. FUNCBINDR(pow, sarray("base", "exp"), Variant::UTILITY_FUNC_TYPE_MATH);
  1443. FUNCBINDR(log, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1444. FUNCBINDR(exp, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1445. FUNCBINDR(is_nan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1446. FUNCBINDR(is_inf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1447. FUNCBINDR(is_equal_approx, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1448. FUNCBINDR(is_zero_approx, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1449. FUNCBINDR(is_finite, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1450. FUNCBINDR(ease, sarray("x", "curve"), Variant::UTILITY_FUNC_TYPE_MATH);
  1451. FUNCBINDR(step_decimals, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1452. FUNCBINDVR3(lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1453. FUNCBINDR(lerpf, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1454. FUNCBINDR(cubic_interpolate, sarray("from", "to", "pre", "post", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1455. FUNCBINDR(cubic_interpolate_angle, sarray("from", "to", "pre", "post", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1456. FUNCBINDR(cubic_interpolate_in_time, sarray("from", "to", "pre", "post", "weight", "to_t", "pre_t", "post_t"), Variant::UTILITY_FUNC_TYPE_MATH);
  1457. FUNCBINDR(cubic_interpolate_angle_in_time, sarray("from", "to", "pre", "post", "weight", "to_t", "pre_t", "post_t"), Variant::UTILITY_FUNC_TYPE_MATH);
  1458. FUNCBINDR(bezier_interpolate, sarray("start", "control_1", "control_2", "end", "t"), Variant::UTILITY_FUNC_TYPE_MATH);
  1459. FUNCBINDR(bezier_derivative, sarray("start", "control_1", "control_2", "end", "t"), Variant::UTILITY_FUNC_TYPE_MATH);
  1460. FUNCBINDR(angle_difference, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_MATH);
  1461. FUNCBINDR(lerp_angle, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1462. FUNCBINDR(inverse_lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
  1463. FUNCBINDR(remap, sarray("value", "istart", "istop", "ostart", "ostop"), Variant::UTILITY_FUNC_TYPE_MATH);
  1464. FUNCBINDR(smoothstep, sarray("from", "to", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
  1465. FUNCBINDR(move_toward, sarray("from", "to", "delta"), Variant::UTILITY_FUNC_TYPE_MATH);
  1466. FUNCBINDR(rotate_toward, sarray("from", "to", "delta"), Variant::UTILITY_FUNC_TYPE_MATH);
  1467. FUNCBINDR(deg_to_rad, sarray("deg"), Variant::UTILITY_FUNC_TYPE_MATH);
  1468. FUNCBINDR(rad_to_deg, sarray("rad"), Variant::UTILITY_FUNC_TYPE_MATH);
  1469. FUNCBINDR(linear_to_db, sarray("lin"), Variant::UTILITY_FUNC_TYPE_MATH);
  1470. FUNCBINDR(db_to_linear, sarray("db"), Variant::UTILITY_FUNC_TYPE_MATH);
  1471. FUNCBINDVR3(wrap, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1472. FUNCBINDR(wrapi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1473. FUNCBINDR(wrapf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1474. FUNCBINDVARARG(max, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1475. FUNCBINDR(maxi, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1476. FUNCBINDR(maxf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1477. FUNCBINDVARARG(min, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
  1478. FUNCBINDR(mini, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1479. FUNCBINDR(minf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
  1480. FUNCBINDVR3(clamp, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1481. FUNCBINDR(clampi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1482. FUNCBINDR(clampf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
  1483. FUNCBINDR(nearest_po2, sarray("value"), Variant::UTILITY_FUNC_TYPE_MATH);
  1484. FUNCBINDR(pingpong, sarray("value", "length"), Variant::UTILITY_FUNC_TYPE_MATH);
  1485. // Random
  1486. FUNCBIND(randomize, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1487. FUNCBINDR(randi, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1488. FUNCBINDR(randf, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1489. FUNCBINDR(randi_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1490. FUNCBINDR(randf_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1491. FUNCBINDR(randfn, sarray("mean", "deviation"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1492. FUNCBIND(seed, sarray("base"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1493. FUNCBINDR(rand_from_seed, sarray("seed"), Variant::UTILITY_FUNC_TYPE_RANDOM);
  1494. // Utility
  1495. FUNCBINDVR(weakref, sarray("obj"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1496. FUNCBINDR(_typeof, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1497. FUNCBINDR(type_convert, sarray("variant", "type"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1498. FUNCBINDVARARGS(str, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1499. FUNCBINDR(error_string, sarray("error"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1500. FUNCBINDR(type_string, sarray("type"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1501. FUNCBINDVARARGV(print, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1502. FUNCBINDVARARGV(print_rich, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1503. FUNCBINDVARARGV(printerr, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1504. FUNCBINDVARARGV(printt, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1505. FUNCBINDVARARGV(prints, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1506. FUNCBINDVARARGV(printraw, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1507. FUNCBINDVARARGV(print_verbose, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1508. FUNCBINDVARARGV(push_error, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1509. FUNCBINDVARARGV(push_warning, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1510. FUNCBINDR(var_to_str, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1511. FUNCBINDR(str_to_var, sarray("string"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1512. FUNCBINDR(var_to_bytes, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1513. FUNCBINDR(bytes_to_var, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1514. FUNCBINDR(var_to_bytes_with_objects, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1515. FUNCBINDR(bytes_to_var_with_objects, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1516. FUNCBINDR(hash, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1517. FUNCBINDR(instance_from_id, sarray("instance_id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1518. FUNCBINDR(is_instance_id_valid, sarray("id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1519. FUNCBINDR(is_instance_valid, sarray("instance"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1520. FUNCBINDR(rid_allocate_id, Vector<String>(), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1521. FUNCBINDR(rid_from_int64, sarray("base"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1522. FUNCBINDR(is_same, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_GENERAL);
  1523. }
  1524. void Variant::_unregister_variant_utility_functions() {
  1525. utility_function_table.clear();
  1526. utility_function_name_table.clear();
  1527. }
  1528. void Variant::call_utility_function(const StringName &p_name, Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
  1529. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1530. if (!bfi) {
  1531. r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
  1532. r_error.argument = 0;
  1533. r_error.expected = 0;
  1534. return;
  1535. }
  1536. if (unlikely(!bfi->is_vararg && p_argcount < bfi->argcount)) {
  1537. r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  1538. r_error.expected = bfi->argcount;
  1539. return;
  1540. }
  1541. if (unlikely(!bfi->is_vararg && p_argcount > bfi->argcount)) {
  1542. r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  1543. r_error.expected = bfi->argcount;
  1544. return;
  1545. }
  1546. bfi->call_utility(r_ret, p_args, p_argcount, r_error);
  1547. }
  1548. bool Variant::has_utility_function(const StringName &p_name) {
  1549. return utility_function_table.has(p_name);
  1550. }
  1551. Variant::ValidatedUtilityFunction Variant::get_validated_utility_function(const StringName &p_name) {
  1552. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1553. if (!bfi) {
  1554. return nullptr;
  1555. }
  1556. return bfi->validated_call_utility;
  1557. }
  1558. Variant::PTRUtilityFunction Variant::get_ptr_utility_function(const StringName &p_name) {
  1559. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1560. if (!bfi) {
  1561. return nullptr;
  1562. }
  1563. return bfi->ptr_call_utility;
  1564. }
  1565. Variant::UtilityFunctionType Variant::get_utility_function_type(const StringName &p_name) {
  1566. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1567. if (!bfi) {
  1568. return Variant::UTILITY_FUNC_TYPE_MATH;
  1569. }
  1570. return bfi->type;
  1571. }
  1572. MethodInfo Variant::get_utility_function_info(const StringName &p_name) {
  1573. MethodInfo info;
  1574. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1575. if (bfi) {
  1576. info.name = p_name;
  1577. if (bfi->returns_value && bfi->return_type == Variant::NIL) {
  1578. info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1579. }
  1580. info.return_val.type = bfi->return_type;
  1581. if (bfi->is_vararg) {
  1582. info.flags |= METHOD_FLAG_VARARG;
  1583. }
  1584. for (int i = 0; i < bfi->argnames.size(); ++i) {
  1585. PropertyInfo arg;
  1586. arg.type = bfi->get_arg_type(i);
  1587. arg.name = bfi->argnames[i];
  1588. info.arguments.push_back(arg);
  1589. }
  1590. }
  1591. return info;
  1592. }
  1593. int Variant::get_utility_function_argument_count(const StringName &p_name) {
  1594. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1595. if (!bfi) {
  1596. return 0;
  1597. }
  1598. return bfi->argcount;
  1599. }
  1600. Variant::Type Variant::get_utility_function_argument_type(const StringName &p_name, int p_arg) {
  1601. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1602. if (!bfi) {
  1603. return Variant::NIL;
  1604. }
  1605. return bfi->get_arg_type(p_arg);
  1606. }
  1607. String Variant::get_utility_function_argument_name(const StringName &p_name, int p_arg) {
  1608. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1609. if (!bfi) {
  1610. return String();
  1611. }
  1612. ERR_FAIL_INDEX_V(p_arg, bfi->argnames.size(), String());
  1613. ERR_FAIL_COND_V(bfi->is_vararg, String());
  1614. return bfi->argnames[p_arg];
  1615. }
  1616. bool Variant::has_utility_function_return_value(const StringName &p_name) {
  1617. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1618. if (!bfi) {
  1619. return false;
  1620. }
  1621. return bfi->returns_value;
  1622. }
  1623. Variant::Type Variant::get_utility_function_return_type(const StringName &p_name) {
  1624. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1625. if (!bfi) {
  1626. return Variant::NIL;
  1627. }
  1628. return bfi->return_type;
  1629. }
  1630. bool Variant::is_utility_function_vararg(const StringName &p_name) {
  1631. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1632. if (!bfi) {
  1633. return false;
  1634. }
  1635. return bfi->is_vararg;
  1636. }
  1637. uint32_t Variant::get_utility_function_hash(const StringName &p_name) {
  1638. const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
  1639. ERR_FAIL_NULL_V(bfi, 0);
  1640. uint32_t hash = hash_murmur3_one_32(bfi->is_vararg);
  1641. hash = hash_murmur3_one_32(bfi->returns_value, hash);
  1642. if (bfi->returns_value) {
  1643. hash = hash_murmur3_one_32(bfi->return_type, hash);
  1644. }
  1645. hash = hash_murmur3_one_32(bfi->argcount, hash);
  1646. for (int i = 0; i < bfi->argcount; i++) {
  1647. hash = hash_murmur3_one_32(bfi->get_arg_type(i), hash);
  1648. }
  1649. return hash_fmix32(hash);
  1650. }
  1651. void Variant::get_utility_function_list(List<StringName> *r_functions) {
  1652. for (const StringName &E : utility_function_name_table) {
  1653. r_functions->push_back(E);
  1654. }
  1655. }
  1656. int Variant::get_utility_function_count() {
  1657. return utility_function_name_table.size();
  1658. }