123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800 |
- /**************************************************************************/
- /* variant_utility.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "variant.h"
- #include "core/core_string_names.h"
- #include "core/io/marshalls.h"
- #include "core/object/ref_counted.h"
- #include "core/os/os.h"
- #include "core/templates/oa_hash_map.h"
- #include "core/templates/rid.h"
- #include "core/templates/rid_owner.h"
- #include "core/variant/binder_common.h"
- #include "core/variant/variant_parser.h"
- struct VariantUtilityFunctions {
- // Math
- static inline double sin(double arg) {
- return Math::sin(arg);
- }
- static inline double cos(double arg) {
- return Math::cos(arg);
- }
- static inline double tan(double arg) {
- return Math::tan(arg);
- }
- static inline double sinh(double arg) {
- return Math::sinh(arg);
- }
- static inline double cosh(double arg) {
- return Math::cosh(arg);
- }
- static inline double tanh(double arg) {
- return Math::tanh(arg);
- }
- static inline double asin(double arg) {
- return Math::asin(arg);
- }
- static inline double acos(double arg) {
- return Math::acos(arg);
- }
- static inline double atan(double arg) {
- return Math::atan(arg);
- }
- static inline double atan2(double y, double x) {
- return Math::atan2(y, x);
- }
- static inline double sqrt(double x) {
- return Math::sqrt(x);
- }
- static inline double fmod(double b, double r) {
- return Math::fmod(b, r);
- }
- static inline double fposmod(double b, double r) {
- return Math::fposmod(b, r);
- }
- static inline int64_t posmod(int64_t b, int64_t r) {
- return Math::posmod(b, r);
- }
- static inline Variant floor(Variant x, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- switch (x.get_type()) {
- case Variant::INT: {
- return VariantInternalAccessor<int64_t>::get(&x);
- } break;
- case Variant::FLOAT: {
- return Math::floor(VariantInternalAccessor<double>::get(&x));
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&x).floor();
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&x).floor();
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&x).floor();
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double floorf(double x) {
- return Math::floor(x);
- }
- static inline int64_t floori(double x) {
- return int64_t(Math::floor(x));
- }
- static inline Variant ceil(Variant x, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- switch (x.get_type()) {
- case Variant::INT: {
- return VariantInternalAccessor<int64_t>::get(&x);
- } break;
- case Variant::FLOAT: {
- return Math::ceil(VariantInternalAccessor<double>::get(&x));
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&x).ceil();
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&x).ceil();
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&x).ceil();
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double ceilf(double x) {
- return Math::ceil(x);
- }
- static inline int64_t ceili(double x) {
- return int64_t(Math::ceil(x));
- }
- static inline Variant round(Variant x, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- switch (x.get_type()) {
- case Variant::INT: {
- return VariantInternalAccessor<int64_t>::get(&x);
- } break;
- case Variant::FLOAT: {
- return Math::round(VariantInternalAccessor<double>::get(&x));
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&x).round();
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&x).round();
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&x).round();
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double roundf(double x) {
- return Math::round(x);
- }
- static inline int64_t roundi(double x) {
- return int64_t(Math::round(x));
- }
- static inline Variant abs(const Variant &x, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- switch (x.get_type()) {
- case Variant::INT: {
- return ABS(VariantInternalAccessor<int64_t>::get(&x));
- } break;
- case Variant::FLOAT: {
- return Math::absd(VariantInternalAccessor<double>::get(&x));
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&x).abs();
- } break;
- case Variant::VECTOR2I: {
- return VariantInternalAccessor<Vector2i>::get(&x).abs();
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&x).abs();
- } break;
- case Variant::VECTOR3I: {
- return VariantInternalAccessor<Vector3i>::get(&x).abs();
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&x).abs();
- } break;
- case Variant::VECTOR4I: {
- return VariantInternalAccessor<Vector4i>::get(&x).abs();
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double absf(double x) {
- return Math::absd(x);
- }
- static inline int64_t absi(int64_t x) {
- return ABS(x);
- }
- static inline Variant sign(const Variant &x, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- switch (x.get_type()) {
- case Variant::INT: {
- return SIGN(VariantInternalAccessor<int64_t>::get(&x));
- } break;
- case Variant::FLOAT: {
- return SIGN(VariantInternalAccessor<double>::get(&x));
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&x).sign();
- } break;
- case Variant::VECTOR2I: {
- return VariantInternalAccessor<Vector2i>::get(&x).sign();
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&x).sign();
- } break;
- case Variant::VECTOR3I: {
- return VariantInternalAccessor<Vector3i>::get(&x).sign();
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&x).sign();
- } break;
- case Variant::VECTOR4I: {
- return VariantInternalAccessor<Vector4i>::get(&x).sign();
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double signf(double x) {
- return SIGN(x);
- }
- static inline int64_t signi(int64_t x) {
- return SIGN(x);
- }
- static inline double pow(double x, double y) {
- return Math::pow(x, y);
- }
- static inline double log(double x) {
- return Math::log(x);
- }
- static inline double exp(double x) {
- return Math::exp(x);
- }
- static inline bool is_nan(double x) {
- return Math::is_nan(x);
- }
- static inline bool is_inf(double x) {
- return Math::is_inf(x);
- }
- static inline bool is_equal_approx(double x, double y) {
- return Math::is_equal_approx(x, y);
- }
- static inline bool is_zero_approx(double x) {
- return Math::is_zero_approx(x);
- }
- static inline bool is_finite(double x) {
- return Math::is_finite(x);
- }
- static inline double ease(float x, float curve) {
- return Math::ease(x, curve);
- }
- static inline int step_decimals(float step) {
- return Math::step_decimals(step);
- }
- static inline Variant snapped(const Variant &x, const Variant &step, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- 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))) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.argument = 1;
- return Variant();
- }
- switch (step.get_type()) {
- case Variant::INT: {
- return snappedi(x, VariantInternalAccessor<int64_t>::get(&step));
- } break;
- case Variant::FLOAT: {
- return snappedf(x, VariantInternalAccessor<double>::get(&step));
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&x).snapped(VariantInternalAccessor<Vector2>::get(&step));
- } break;
- case Variant::VECTOR2I: {
- return VariantInternalAccessor<Vector2i>::get(&x).snapped(VariantInternalAccessor<Vector2i>::get(&step));
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&x).snapped(VariantInternalAccessor<Vector3>::get(&step));
- } break;
- case Variant::VECTOR3I: {
- return VariantInternalAccessor<Vector3i>::get(&x).snapped(VariantInternalAccessor<Vector3i>::get(&step));
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&x).snapped(VariantInternalAccessor<Vector4>::get(&step));
- } break;
- case Variant::VECTOR4I: {
- return VariantInternalAccessor<Vector4i>::get(&x).snapped(VariantInternalAccessor<Vector4i>::get(&step));
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double snappedf(double x, double step) {
- return Math::snapped(x, step);
- }
- static inline int64_t snappedi(double x, int64_t step) {
- return Math::snapped(x, step);
- }
- static inline Variant lerp(const Variant &from, const Variant &to, double weight, Callable::CallError &r_error) {
- r_error.error = Callable::CallError::CALL_OK;
- if (from.get_type() != to.get_type()) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = from.get_type();
- r_error.argument = 1;
- return Variant();
- }
- switch (from.get_type()) {
- case Variant::INT: {
- return lerpf(VariantInternalAccessor<int64_t>::get(&from), to, weight);
- } break;
- case Variant::FLOAT: {
- return lerpf(VariantInternalAccessor<double>::get(&from), to, weight);
- } break;
- case Variant::VECTOR2: {
- return VariantInternalAccessor<Vector2>::get(&from).lerp(VariantInternalAccessor<Vector2>::get(&to), weight);
- } break;
- case Variant::VECTOR3: {
- return VariantInternalAccessor<Vector3>::get(&from).lerp(VariantInternalAccessor<Vector3>::get(&to), weight);
- } break;
- case Variant::VECTOR4: {
- return VariantInternalAccessor<Vector4>::get(&from).lerp(VariantInternalAccessor<Vector4>::get(&to), weight);
- } break;
- case Variant::QUATERNION: {
- return VariantInternalAccessor<Quaternion>::get(&from).slerp(VariantInternalAccessor<Quaternion>::get(&to), weight);
- } break;
- case Variant::BASIS: {
- return VariantInternalAccessor<Basis>::get(&from).slerp(VariantInternalAccessor<Basis>::get(&to), weight);
- } break;
- case Variant::COLOR: {
- return VariantInternalAccessor<Color>::get(&from).lerp(VariantInternalAccessor<Color>::get(&to), weight);
- } break;
- default: {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- }
- }
- static inline double lerpf(double from, double to, double weight) {
- return Math::lerp(from, to, weight);
- }
- static inline double cubic_interpolate(double from, double to, double pre, double post, double weight) {
- return Math::cubic_interpolate(from, to, pre, post, weight);
- }
- static inline double cubic_interpolate_angle(double from, double to, double pre, double post, double weight) {
- return Math::cubic_interpolate_angle(from, to, pre, post, weight);
- }
- static inline double cubic_interpolate_in_time(double from, double to, double pre, double post, double weight,
- double to_t, double pre_t, double post_t) {
- return Math::cubic_interpolate_in_time(from, to, pre, post, weight, to_t, pre_t, post_t);
- }
- static inline double cubic_interpolate_angle_in_time(double from, double to, double pre, double post, double weight,
- double to_t, double pre_t, double post_t) {
- return Math::cubic_interpolate_angle_in_time(from, to, pre, post, weight, to_t, pre_t, post_t);
- }
- static inline double bezier_interpolate(double p_start, double p_control_1, double p_control_2, double p_end, double p_t) {
- return Math::bezier_interpolate(p_start, p_control_1, p_control_2, p_end, p_t);
- }
- static inline double bezier_derivative(double p_start, double p_control_1, double p_control_2, double p_end, double p_t) {
- return Math::bezier_derivative(p_start, p_control_1, p_control_2, p_end, p_t);
- }
- static inline double lerp_angle(double from, double to, double weight) {
- return Math::lerp_angle(from, to, weight);
- }
- static inline double inverse_lerp(double from, double to, double weight) {
- return Math::inverse_lerp(from, to, weight);
- }
- static inline double remap(double value, double istart, double istop, double ostart, double ostop) {
- return Math::remap(value, istart, istop, ostart, ostop);
- }
- static inline double smoothstep(double from, double to, double val) {
- return Math::smoothstep(from, to, val);
- }
- static inline double move_toward(double from, double to, double delta) {
- return Math::move_toward(from, to, delta);
- }
- static inline double deg_to_rad(double angle_deg) {
- return Math::deg_to_rad(angle_deg);
- }
- static inline double rad_to_deg(double angle_rad) {
- return Math::rad_to_deg(angle_rad);
- }
- static inline double linear_to_db(double linear) {
- return Math::linear_to_db(linear);
- }
- static inline double db_to_linear(double db) {
- return Math::db_to_linear(db);
- }
- static inline Variant wrap(const Variant &p_x, const Variant &p_min, const Variant &p_max, Callable::CallError &r_error) {
- Variant::Type x_type = p_x.get_type();
- if (x_type != Variant::INT && x_type != Variant::FLOAT) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.argument = 0;
- r_error.expected = x_type;
- return Variant();
- }
- Variant::Type min_type = p_min.get_type();
- if (min_type != Variant::INT && min_type != Variant::FLOAT) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.argument = 1;
- r_error.expected = x_type;
- return Variant();
- }
- Variant::Type max_type = p_max.get_type();
- if (max_type != Variant::INT && max_type != Variant::FLOAT) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.argument = 2;
- r_error.expected = x_type;
- return Variant();
- }
- Variant value;
- switch (x_type) {
- case Variant::INT: {
- if (x_type != min_type || x_type != max_type) {
- value = wrapf((double)p_x, (double)p_min, (double)p_max);
- } else {
- value = wrapi((int)p_x, (int)p_min, (int)p_max);
- }
- } break;
- case Variant::FLOAT: {
- value = wrapf((double)p_x, (double)p_min, (double)p_max);
- } break;
- default:
- break;
- }
- r_error.error = Callable::CallError::CALL_OK;
- return value;
- }
- static inline int64_t wrapi(int64_t value, int64_t min, int64_t max) {
- return Math::wrapi(value, min, max);
- }
- static inline double wrapf(double value, double min, double max) {
- return Math::wrapf(value, min, max);
- }
- static inline double pingpong(double value, double length) {
- return Math::pingpong(value, length);
- }
- static inline Variant max(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
- if (p_argcount < 2) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
- r_error.expected = 2;
- return Variant();
- }
- Variant base = *p_args[0];
- Variant ret;
- for (int i = 0; i < p_argcount; i++) {
- Variant::Type arg_type = p_args[i]->get_type();
- if (arg_type != Variant::INT && arg_type != Variant::FLOAT) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = Variant::FLOAT;
- r_error.argument = i;
- return Variant();
- }
- if (i == 0) {
- continue;
- }
- bool valid;
- Variant::evaluate(Variant::OP_LESS, base, *p_args[i], ret, valid);
- if (!valid) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = base.get_type();
- r_error.argument = i;
- return Variant();
- }
- if (ret.booleanize()) {
- base = *p_args[i];
- }
- }
- r_error.error = Callable::CallError::CALL_OK;
- return base;
- }
- static inline double maxf(double x, double y) {
- return MAX(x, y);
- }
- static inline int64_t maxi(int64_t x, int64_t y) {
- return MAX(x, y);
- }
- static inline Variant min(const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
- if (p_argcount < 2) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
- r_error.expected = 2;
- return Variant();
- }
- Variant base = *p_args[0];
- Variant ret;
- for (int i = 0; i < p_argcount; i++) {
- Variant::Type arg_type = p_args[i]->get_type();
- if (arg_type != Variant::INT && arg_type != Variant::FLOAT) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = Variant::FLOAT;
- r_error.argument = i;
- return Variant();
- }
- if (i == 0) {
- continue;
- }
- bool valid;
- Variant::evaluate(Variant::OP_GREATER, base, *p_args[i], ret, valid);
- if (!valid) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = base.get_type();
- r_error.argument = i;
- return Variant();
- }
- if (ret.booleanize()) {
- base = *p_args[i];
- }
- }
- r_error.error = Callable::CallError::CALL_OK;
- return base;
- }
- static inline double minf(double x, double y) {
- return MIN(x, y);
- }
- static inline int64_t mini(int64_t x, int64_t y) {
- return MIN(x, y);
- }
- static inline Variant clamp(const Variant &x, const Variant &min, const Variant &max, Callable::CallError &r_error) {
- Variant value = x;
- Variant ret;
- bool valid;
- Variant::evaluate(Variant::OP_LESS, value, min, ret, valid);
- if (!valid) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = value.get_type();
- r_error.argument = 1;
- return Variant();
- }
- if (ret.booleanize()) {
- value = min;
- }
- Variant::evaluate(Variant::OP_GREATER, value, max, ret, valid);
- if (!valid) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.expected = value.get_type();
- r_error.argument = 2;
- return Variant();
- }
- if (ret.booleanize()) {
- value = max;
- }
- r_error.error = Callable::CallError::CALL_OK;
- return value;
- }
- static inline double clampf(double x, double min, double max) {
- return CLAMP(x, min, max);
- }
- static inline int64_t clampi(int64_t x, int64_t min, int64_t max) {
- return CLAMP(x, min, max);
- }
- static inline int64_t nearest_po2(int64_t x) {
- return nearest_power_of_2_templated(uint64_t(x));
- }
- // Random
- static inline void randomize() {
- Math::randomize();
- }
- static inline int64_t randi() {
- return Math::rand();
- }
- static inline double randf() {
- return Math::randf();
- }
- static inline double randfn(double mean, double deviation) {
- return Math::randfn(mean, deviation);
- }
- static inline int64_t randi_range(int64_t from, int64_t to) {
- return Math::random((int32_t)from, (int32_t)to);
- }
- static inline double randf_range(double from, double to) {
- return Math::random(from, to);
- }
- static inline void seed(int64_t s) {
- return Math::seed(s);
- }
- static inline PackedInt64Array rand_from_seed(int64_t seed) {
- uint64_t s = seed;
- PackedInt64Array arr;
- arr.resize(2);
- arr.write[0] = Math::rand_from_seed(&s);
- arr.write[1] = s;
- return arr;
- }
- // Utility
- static inline Variant weakref(const Variant &obj, Callable::CallError &r_error) {
- if (obj.get_type() == Variant::OBJECT) {
- r_error.error = Callable::CallError::CALL_OK;
- if (obj.is_ref_counted()) {
- Ref<WeakRef> wref = memnew(WeakRef);
- Ref<RefCounted> r = obj;
- if (r.is_valid()) {
- wref->set_ref(r);
- }
- return wref;
- } else {
- Ref<WeakRef> wref = memnew(WeakRef);
- Object *o = obj.get_validated_object();
- if (o) {
- wref->set_obj(o);
- }
- return wref;
- }
- } else if (obj.get_type() == Variant::NIL) {
- r_error.error = Callable::CallError::CALL_OK;
- Ref<WeakRef> wref = memnew(WeakRef);
- return wref;
- } else {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_ARGUMENT;
- r_error.argument = 0;
- r_error.expected = Variant::OBJECT;
- return Variant();
- }
- }
- static inline int64_t _typeof(const Variant &obj) {
- return obj.get_type();
- }
- static inline String str(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- if (p_arg_count < 1) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
- r_error.argument = 1;
- return String();
- }
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- r_error.error = Callable::CallError::CALL_OK;
- return s;
- }
- static inline String error_string(Error error) {
- if (error < 0 || error >= ERR_MAX) {
- return String("(invalid error code)");
- }
- return String(error_names[error]);
- }
- static inline void print(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- print_line(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void print_rich(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- print_line_rich(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void print_verbose(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- if (OS::get_singleton()->is_stdout_verbose()) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- // No need to use `print_verbose()` as this call already only happens
- // when verbose mode is enabled. This avoids performing string argument concatenation
- // when not needed.
- print_line(s);
- }
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void printerr(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- print_error(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void printt(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- if (i) {
- s += "\t";
- }
- s += p_args[i]->operator String();
- }
- print_line(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void prints(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- if (i) {
- s += " ";
- }
- s += p_args[i]->operator String();
- }
- print_line(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void printraw(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- OS::get_singleton()->print("%s", s.utf8().get_data());
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void push_error(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- if (p_arg_count < 1) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
- r_error.argument = 1;
- }
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- ERR_PRINT(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline void push_warning(const Variant **p_args, int p_arg_count, Callable::CallError &r_error) {
- if (p_arg_count < 1) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
- r_error.argument = 1;
- }
- String s;
- for (int i = 0; i < p_arg_count; i++) {
- String os = p_args[i]->operator String();
- if (i == 0) {
- s = os;
- } else {
- s += os;
- }
- }
- WARN_PRINT(s);
- r_error.error = Callable::CallError::CALL_OK;
- }
- static inline String var_to_str(const Variant &p_var) {
- String vars;
- VariantWriter::write_to_string(p_var, vars);
- return vars;
- }
- static inline Variant str_to_var(const String &p_var) {
- VariantParser::StreamString ss;
- ss.s = p_var;
- String errs;
- int line;
- Variant ret;
- (void)VariantParser::parse(&ss, ret, errs, line);
- return ret;
- }
- static inline PackedByteArray var_to_bytes(const Variant &p_var) {
- int len;
- Error err = encode_variant(p_var, nullptr, len, false);
- if (err != OK) {
- return PackedByteArray();
- }
- PackedByteArray barr;
- barr.resize(len);
- {
- uint8_t *w = barr.ptrw();
- err = encode_variant(p_var, w, len, false);
- if (err != OK) {
- return PackedByteArray();
- }
- }
- return barr;
- }
- static inline PackedByteArray var_to_bytes_with_objects(const Variant &p_var) {
- int len;
- Error err = encode_variant(p_var, nullptr, len, true);
- if (err != OK) {
- return PackedByteArray();
- }
- PackedByteArray barr;
- barr.resize(len);
- {
- uint8_t *w = barr.ptrw();
- err = encode_variant(p_var, w, len, true);
- if (err != OK) {
- return PackedByteArray();
- }
- }
- return barr;
- }
- static inline Variant bytes_to_var(const PackedByteArray &p_arr) {
- Variant ret;
- {
- const uint8_t *r = p_arr.ptr();
- Error err = decode_variant(ret, r, p_arr.size(), nullptr, false);
- if (err != OK) {
- return Variant();
- }
- }
- return ret;
- }
- static inline Variant bytes_to_var_with_objects(const PackedByteArray &p_arr) {
- Variant ret;
- {
- const uint8_t *r = p_arr.ptr();
- Error err = decode_variant(ret, r, p_arr.size(), nullptr, true);
- if (err != OK) {
- return Variant();
- }
- }
- return ret;
- }
- static inline int64_t hash(const Variant &p_arr) {
- return p_arr.hash();
- }
- static inline Object *instance_from_id(int64_t p_id) {
- ObjectID id = ObjectID((uint64_t)p_id);
- Object *ret = ObjectDB::get_instance(id);
- return ret;
- }
- static inline bool is_instance_id_valid(int64_t p_id) {
- return ObjectDB::get_instance(ObjectID((uint64_t)p_id)) != nullptr;
- }
- static inline bool is_instance_valid(const Variant &p_instance) {
- if (p_instance.get_type() != Variant::OBJECT) {
- return false;
- }
- return p_instance.get_validated_object() != nullptr;
- }
- static inline uint64_t rid_allocate_id() {
- return RID_AllocBase::_gen_id();
- }
- static inline RID rid_from_int64(uint64_t p_base) {
- return RID::from_uint64(p_base);
- }
- static inline bool is_same(const Variant &p_a, const Variant &p_b) {
- return p_a.identity_compare(p_b);
- }
- };
- #ifdef DEBUG_METHODS_ENABLED
- #define VCALLR *ret = p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
- #define VCALL p_func(VariantCasterAndValidate<P>::cast(p_args, Is, r_error)...)
- #else
- #define VCALLR *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...)
- #define VCALL p_func(VariantCaster<P>::cast(*p_args[Is])...)
- #endif
- template <class R, class... P, size_t... Is>
- static _FORCE_INLINE_ void call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
- r_error.error = Callable::CallError::CALL_OK;
- VCALLR;
- (void)p_args; // avoid gcc warning
- (void)r_error;
- }
- template <class R, class... P, size_t... Is>
- static _FORCE_INLINE_ void validated_call_helperpr(R (*p_func)(P...), Variant *ret, const Variant **p_args, IndexSequence<Is...>) {
- *ret = p_func(VariantCaster<P>::cast(*p_args[Is])...);
- (void)p_args;
- }
- template <class R, class... P, size_t... Is>
- static _FORCE_INLINE_ void ptr_call_helperpr(R (*p_func)(P...), void *ret, const void **p_args, IndexSequence<Is...>) {
- PtrToArg<R>::encode(p_func(PtrToArg<P>::convert(p_args[Is])...), ret);
- (void)p_args;
- }
- template <class R, class... P>
- static _FORCE_INLINE_ void call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args, Callable::CallError &r_error) {
- call_helperpr(p_func, ret, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
- }
- template <class R, class... P>
- static _FORCE_INLINE_ void validated_call_helperr(R (*p_func)(P...), Variant *ret, const Variant **p_args) {
- validated_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
- }
- template <class R, class... P>
- static _FORCE_INLINE_ void ptr_call_helperr(R (*p_func)(P...), void *ret, const void **p_args) {
- ptr_call_helperpr(p_func, ret, p_args, BuildIndexSequence<sizeof...(P)>{});
- }
- template <class R, class... P>
- static _FORCE_INLINE_ int get_arg_count_helperr(R (*p_func)(P...)) {
- return sizeof...(P);
- }
- template <class R, class... P>
- static _FORCE_INLINE_ Variant::Type get_arg_type_helperr(R (*p_func)(P...), int p_arg) {
- return call_get_argument_type<P...>(p_arg);
- }
- template <class R, class... P>
- static _FORCE_INLINE_ Variant::Type get_ret_type_helperr(R (*p_func)(P...)) {
- return GetTypeInfo<R>::VARIANT_TYPE;
- }
- // WITHOUT RET
- template <class... P, size_t... Is>
- static _FORCE_INLINE_ void call_helperp(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error, IndexSequence<Is...>) {
- r_error.error = Callable::CallError::CALL_OK;
- VCALL;
- (void)p_args;
- (void)r_error;
- }
- template <class... P, size_t... Is>
- static _FORCE_INLINE_ void validated_call_helperp(void (*p_func)(P...), const Variant **p_args, IndexSequence<Is...>) {
- p_func(VariantCaster<P>::cast(*p_args[Is])...);
- (void)p_args;
- }
- template <class... P, size_t... Is>
- static _FORCE_INLINE_ void ptr_call_helperp(void (*p_func)(P...), const void **p_args, IndexSequence<Is...>) {
- p_func(PtrToArg<P>::convert(p_args[Is])...);
- (void)p_args;
- }
- template <class... P>
- static _FORCE_INLINE_ void call_helper(void (*p_func)(P...), const Variant **p_args, Callable::CallError &r_error) {
- call_helperp(p_func, p_args, r_error, BuildIndexSequence<sizeof...(P)>{});
- }
- template <class... P>
- static _FORCE_INLINE_ void validated_call_helper(void (*p_func)(P...), const Variant **p_args) {
- validated_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
- }
- template <class... P>
- static _FORCE_INLINE_ void ptr_call_helper(void (*p_func)(P...), const void **p_args) {
- ptr_call_helperp(p_func, p_args, BuildIndexSequence<sizeof...(P)>{});
- }
- template <class... P>
- static _FORCE_INLINE_ int get_arg_count_helper(void (*p_func)(P...)) {
- return sizeof...(P);
- }
- template <class... P>
- static _FORCE_INLINE_ Variant::Type get_arg_type_helper(void (*p_func)(P...), int p_arg) {
- return call_get_argument_type<P...>(p_arg);
- }
- template <class... P>
- static _FORCE_INLINE_ Variant::Type get_ret_type_helper(void (*p_func)(P...)) {
- return Variant::NIL;
- }
- #define FUNCBINDR(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args, r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- validated_call_helperr(VariantUtilityFunctions::m_func, r_ret, p_args); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- ptr_call_helperr(VariantUtilityFunctions::m_func, ret, p_args); \
- } \
- static int get_argument_count() { \
- return get_arg_count_helperr(VariantUtilityFunctions::m_func); \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return get_arg_type_helperr(VariantUtilityFunctions::m_func, p_arg); \
- } \
- static Variant::Type get_return_type() { \
- return get_ret_type_helperr(VariantUtilityFunctions::m_func); \
- } \
- static bool has_return_type() { \
- return true; \
- } \
- static bool is_vararg() { return false; } \
- static Variant::UtilityFunctionType get_type() { return m_category; } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBINDVR(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- r_error.error = Callable::CallError::CALL_OK; \
- *r_ret = VariantUtilityFunctions::m_func(*p_args[0], r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- Callable::CallError ce; \
- *r_ret = VariantUtilityFunctions::m_func(*p_args[0], ce); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- Callable::CallError ce; \
- PtrToArg<Variant>::encode(VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), ce), ret); \
- } \
- static int get_argument_count() { \
- return 1; \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return Variant::NIL; \
- } \
- static Variant::Type get_return_type() { \
- return Variant::NIL; \
- } \
- static bool has_return_type() { \
- return true; \
- } \
- static bool is_vararg() { return false; } \
- static Variant::UtilityFunctionType get_type() { return m_category; } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBINDVR2(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- r_error.error = Callable::CallError::CALL_OK; \
- *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- Callable::CallError ce; \
- *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], ce); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- Callable::CallError ce; \
- Variant r; \
- r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), ce); \
- PtrToArg<Variant>::encode(r, ret); \
- } \
- static int get_argument_count() { \
- return 2; \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return Variant::NIL; \
- } \
- static Variant::Type get_return_type() { \
- return Variant::NIL; \
- } \
- static bool has_return_type() { \
- return true; \
- } \
- static bool is_vararg() { return false; } \
- static Variant::UtilityFunctionType get_type() { return m_category; } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBINDVR3(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- r_error.error = Callable::CallError::CALL_OK; \
- *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- Callable::CallError ce; \
- *r_ret = VariantUtilityFunctions::m_func(*p_args[0], *p_args[1], *p_args[2], ce); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- Callable::CallError ce; \
- Variant r; \
- r = VariantUtilityFunctions::m_func(PtrToArg<Variant>::convert(p_args[0]), PtrToArg<Variant>::convert(p_args[1]), PtrToArg<Variant>::convert(p_args[2]), ce); \
- PtrToArg<Variant>::encode(r, ret); \
- } \
- static int get_argument_count() { \
- return 3; \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return Variant::NIL; \
- } \
- static Variant::Type get_return_type() { \
- return Variant::NIL; \
- } \
- static bool has_return_type() { \
- return true; \
- } \
- static bool is_vararg() { return false; } \
- static Variant::UtilityFunctionType get_type() { return m_category; } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBINDVARARG(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- r_error.error = Callable::CallError::CALL_OK; \
- *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- Callable::CallError c; \
- *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- Vector<Variant> args; \
- for (int i = 0; i < p_argcount; i++) { \
- args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
- } \
- Vector<const Variant *> argsp; \
- for (int i = 0; i < p_argcount; i++) { \
- argsp.push_back(&args[i]); \
- } \
- Variant r; \
- validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
- PtrToArg<Variant>::encode(r, ret); \
- } \
- static int get_argument_count() { \
- return 2; \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return Variant::NIL; \
- } \
- static Variant::Type get_return_type() { \
- return Variant::NIL; \
- } \
- static bool has_return_type() { \
- return true; \
- } \
- static bool is_vararg() { \
- return true; \
- } \
- static Variant::UtilityFunctionType get_type() { \
- return m_category; \
- } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBINDVARARGS(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- r_error.error = Callable::CallError::CALL_OK; \
- *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- Callable::CallError c; \
- *r_ret = VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- Vector<Variant> args; \
- for (int i = 0; i < p_argcount; i++) { \
- args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
- } \
- Vector<const Variant *> argsp; \
- for (int i = 0; i < p_argcount; i++) { \
- argsp.push_back(&args[i]); \
- } \
- Variant r; \
- validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
- PtrToArg<String>::encode(r.operator String(), ret); \
- } \
- static int get_argument_count() { \
- return 1; \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return Variant::NIL; \
- } \
- static Variant::Type get_return_type() { \
- return Variant::STRING; \
- } \
- static bool has_return_type() { \
- return true; \
- } \
- static bool is_vararg() { \
- return true; \
- } \
- static Variant::UtilityFunctionType get_type() { \
- return m_category; \
- } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBINDVARARGV(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- r_error.error = Callable::CallError::CALL_OK; \
- VariantUtilityFunctions::m_func(p_args, p_argcount, r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- Callable::CallError c; \
- VariantUtilityFunctions::m_func(p_args, p_argcount, c); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- Vector<Variant> args; \
- for (int i = 0; i < p_argcount; i++) { \
- args.push_back(PtrToArg<Variant>::convert(p_args[i])); \
- } \
- Vector<const Variant *> argsp; \
- for (int i = 0; i < p_argcount; i++) { \
- argsp.push_back(&args[i]); \
- } \
- Variant r; \
- validated_call(&r, (const Variant **)argsp.ptr(), p_argcount); \
- } \
- static int get_argument_count() { \
- return 1; \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return Variant::NIL; \
- } \
- static Variant::Type get_return_type() { \
- return Variant::NIL; \
- } \
- static bool has_return_type() { \
- return false; \
- } \
- static bool is_vararg() { \
- return true; \
- } \
- static Variant::UtilityFunctionType get_type() { \
- return m_category; \
- } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- #define FUNCBIND(m_func, m_args, m_category) \
- class Func_##m_func { \
- public: \
- static void call(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) { \
- call_helper(VariantUtilityFunctions::m_func, p_args, r_error); \
- } \
- static void validated_call(Variant *r_ret, const Variant **p_args, int p_argcount) { \
- validated_call_helper(VariantUtilityFunctions::m_func, p_args); \
- } \
- static void ptrcall(void *ret, const void **p_args, int p_argcount) { \
- ptr_call_helper(VariantUtilityFunctions::m_func, p_args); \
- } \
- static int get_argument_count() { \
- return get_arg_count_helper(VariantUtilityFunctions::m_func); \
- } \
- static Variant::Type get_argument_type(int p_arg) { \
- return get_arg_type_helper(VariantUtilityFunctions::m_func, p_arg); \
- } \
- static Variant::Type get_return_type() { \
- return get_ret_type_helper(VariantUtilityFunctions::m_func); \
- } \
- static bool has_return_type() { \
- return false; \
- } \
- static bool is_vararg() { return false; } \
- static Variant::UtilityFunctionType get_type() { return m_category; } \
- }; \
- register_utility_function<Func_##m_func>(#m_func, m_args)
- struct VariantUtilityFunctionInfo {
- void (*call_utility)(Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) = nullptr;
- Variant::ValidatedUtilityFunction validated_call_utility = nullptr;
- Variant::PTRUtilityFunction ptr_call_utility = nullptr;
- Vector<String> argnames;
- bool is_vararg = false;
- bool returns_value = false;
- int argcount = 0;
- Variant::Type (*get_arg_type)(int) = nullptr;
- Variant::Type return_type;
- Variant::UtilityFunctionType type;
- };
- static OAHashMap<StringName, VariantUtilityFunctionInfo> utility_function_table;
- static List<StringName> utility_function_name_table;
- template <class T>
- static void register_utility_function(const String &p_name, const Vector<String> &argnames) {
- String name = p_name;
- if (name.begins_with("_")) {
- name = name.substr(1, name.length() - 1);
- }
- StringName sname = name;
- ERR_FAIL_COND(utility_function_table.has(sname));
- VariantUtilityFunctionInfo bfi;
- bfi.call_utility = T::call;
- bfi.validated_call_utility = T::validated_call;
- bfi.ptr_call_utility = T::ptrcall;
- bfi.is_vararg = T::is_vararg();
- bfi.argnames = argnames;
- bfi.argcount = T::get_argument_count();
- if (!bfi.is_vararg) {
- ERR_FAIL_COND_MSG(argnames.size() != bfi.argcount, "wrong number of arguments binding utility function: " + name);
- }
- bfi.get_arg_type = T::get_argument_type;
- bfi.return_type = T::get_return_type();
- bfi.type = T::get_type();
- bfi.returns_value = T::has_return_type();
- utility_function_table.insert(sname, bfi);
- utility_function_name_table.push_back(sname);
- }
- void Variant::_register_variant_utility_functions() {
- // Math
- FUNCBINDR(sin, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(cos, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(tan, sarray("angle_rad"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(sinh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(cosh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(tanh, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(asin, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(acos, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(atan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(atan2, sarray("y", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(sqrt, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(fmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(fposmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(posmod, sarray("x", "y"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR(floor, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(floorf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(floori, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR(ceil, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(ceilf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(ceili, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR(round, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(roundf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(roundi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR(abs, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(absf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(absi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR(sign, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(signf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(signi, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR2(snapped, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(snappedf, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(snappedi, sarray("x", "step"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(pow, sarray("base", "exp"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(log, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(exp, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(is_nan, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(is_inf, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(is_equal_approx, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(is_zero_approx, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(is_finite, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(ease, sarray("x", "curve"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(step_decimals, sarray("x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR3(lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(lerpf, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(cubic_interpolate, sarray("from", "to", "pre", "post", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(cubic_interpolate_angle, sarray("from", "to", "pre", "post", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(cubic_interpolate_in_time, sarray("from", "to", "pre", "post", "weight", "to_t", "pre_t", "post_t"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(cubic_interpolate_angle_in_time, sarray("from", "to", "pre", "post", "weight", "to_t", "pre_t", "post_t"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(bezier_interpolate, sarray("start", "control_1", "control_2", "end", "t"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(bezier_derivative, sarray("start", "control_1", "control_2", "end", "t"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(lerp_angle, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(inverse_lerp, sarray("from", "to", "weight"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(remap, sarray("value", "istart", "istop", "ostart", "ostop"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(smoothstep, sarray("from", "to", "x"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(move_toward, sarray("from", "to", "delta"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(deg_to_rad, sarray("deg"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(rad_to_deg, sarray("rad"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(linear_to_db, sarray("lin"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(db_to_linear, sarray("db"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR3(wrap, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(wrapi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(wrapf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVARARG(max, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(maxi, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(maxf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVARARG(min, sarray(), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(mini, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(minf, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDVR3(clamp, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(clampi, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(clampf, sarray("value", "min", "max"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(nearest_po2, sarray("value"), Variant::UTILITY_FUNC_TYPE_MATH);
- FUNCBINDR(pingpong, sarray("value", "length"), Variant::UTILITY_FUNC_TYPE_MATH);
- // Random
- FUNCBIND(randomize, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBINDR(randi, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBINDR(randf, sarray(), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBINDR(randi_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBINDR(randf_range, sarray("from", "to"), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBINDR(randfn, sarray("mean", "deviation"), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBIND(seed, sarray("base"), Variant::UTILITY_FUNC_TYPE_RANDOM);
- FUNCBINDR(rand_from_seed, sarray("seed"), Variant::UTILITY_FUNC_TYPE_RANDOM);
- // Utility
- FUNCBINDVR(weakref, sarray("obj"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(_typeof, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGS(str, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(error_string, sarray("error"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(print, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(print_rich, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(printerr, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(printt, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(prints, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(printraw, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(print_verbose, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(push_error, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDVARARGV(push_warning, sarray(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(var_to_str, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(str_to_var, sarray("string"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(var_to_bytes, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(bytes_to_var, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(var_to_bytes_with_objects, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(bytes_to_var_with_objects, sarray("bytes"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(hash, sarray("variable"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(instance_from_id, sarray("instance_id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(is_instance_id_valid, sarray("id"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(is_instance_valid, sarray("instance"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(rid_allocate_id, Vector<String>(), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(rid_from_int64, sarray("base"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- FUNCBINDR(is_same, sarray("a", "b"), Variant::UTILITY_FUNC_TYPE_GENERAL);
- }
- void Variant::_unregister_variant_utility_functions() {
- utility_function_table.clear();
- utility_function_name_table.clear();
- }
- void Variant::call_utility_function(const StringName &p_name, Variant *r_ret, const Variant **p_args, int p_argcount, Callable::CallError &r_error) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- r_error.error = Callable::CallError::CALL_ERROR_INVALID_METHOD;
- r_error.argument = 0;
- r_error.expected = 0;
- return;
- }
- if (unlikely(!bfi->is_vararg && p_argcount < bfi->argcount)) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
- r_error.argument = 0;
- r_error.expected = bfi->argcount;
- return;
- }
- if (unlikely(!bfi->is_vararg && p_argcount > bfi->argcount)) {
- r_error.error = Callable::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
- r_error.argument = 0;
- r_error.expected = bfi->argcount;
- return;
- }
- bfi->call_utility(r_ret, p_args, p_argcount, r_error);
- }
- bool Variant::has_utility_function(const StringName &p_name) {
- return utility_function_table.has(p_name);
- }
- Variant::ValidatedUtilityFunction Variant::get_validated_utility_function(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return nullptr;
- }
- return bfi->validated_call_utility;
- }
- Variant::PTRUtilityFunction Variant::get_ptr_utility_function(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return nullptr;
- }
- return bfi->ptr_call_utility;
- }
- Variant::UtilityFunctionType Variant::get_utility_function_type(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return Variant::UTILITY_FUNC_TYPE_MATH;
- }
- return bfi->type;
- }
- MethodInfo Variant::get_utility_function_info(const StringName &p_name) {
- MethodInfo info;
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (bfi) {
- info.name = p_name;
- if (bfi->returns_value && bfi->return_type == Variant::NIL) {
- info.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
- }
- info.return_val.type = bfi->return_type;
- if (bfi->is_vararg) {
- info.flags |= METHOD_FLAG_VARARG;
- }
- for (int i = 0; i < bfi->argnames.size(); ++i) {
- PropertyInfo arg;
- arg.type = bfi->get_arg_type(i);
- arg.name = bfi->argnames[i];
- info.arguments.push_back(arg);
- }
- }
- return info;
- }
- int Variant::get_utility_function_argument_count(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return 0;
- }
- return bfi->argcount;
- }
- Variant::Type Variant::get_utility_function_argument_type(const StringName &p_name, int p_arg) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return Variant::NIL;
- }
- return bfi->get_arg_type(p_arg);
- }
- String Variant::get_utility_function_argument_name(const StringName &p_name, int p_arg) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return String();
- }
- ERR_FAIL_INDEX_V(p_arg, bfi->argnames.size(), String());
- ERR_FAIL_COND_V(bfi->is_vararg, String());
- return bfi->argnames[p_arg];
- }
- bool Variant::has_utility_function_return_value(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return false;
- }
- return bfi->returns_value;
- }
- Variant::Type Variant::get_utility_function_return_type(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return Variant::NIL;
- }
- return bfi->return_type;
- }
- bool Variant::is_utility_function_vararg(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- if (!bfi) {
- return false;
- }
- return bfi->is_vararg;
- }
- uint32_t Variant::get_utility_function_hash(const StringName &p_name) {
- const VariantUtilityFunctionInfo *bfi = utility_function_table.lookup_ptr(p_name);
- ERR_FAIL_COND_V(!bfi, 0);
- uint32_t hash = hash_murmur3_one_32(bfi->is_vararg);
- hash = hash_murmur3_one_32(bfi->returns_value, hash);
- if (bfi->returns_value) {
- hash = hash_murmur3_one_32(bfi->return_type, hash);
- }
- hash = hash_murmur3_one_32(bfi->argcount, hash);
- for (int i = 0; i < bfi->argcount; i++) {
- hash = hash_murmur3_one_32(bfi->get_arg_type(i), hash);
- }
- return hash_fmix32(hash);
- }
- void Variant::get_utility_function_list(List<StringName> *r_functions) {
- for (const StringName &E : utility_function_name_table) {
- r_functions->push_back(E);
- }
- }
- int Variant::get_utility_function_count() {
- return utility_function_name_table.size();
- }
|