1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212 |
- /*************************************************************************/
- /* gdscript.cpp */
- /*************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /*************************************************************************/
- /* Copyright (c) 2007-2019 Juan Linietsky, Ariel Manzur. */
- /* Copyright (c) 2014-2019 Godot Engine contributors (cf. AUTHORS.md) */
- /* */
- /* 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 "gdscript.h"
- #include "core/engine.h"
- #include "core/global_constants.h"
- #include "core/io/file_access_encrypted.h"
- #include "core/os/file_access.h"
- #include "core/os/os.h"
- #include "core/project_settings.h"
- #include "gdscript_compiler.h"
- ///////////////////////////
- GDScriptNativeClass::GDScriptNativeClass(const StringName &p_name) {
- name = p_name;
- }
- bool GDScriptNativeClass::_get(const StringName &p_name, Variant &r_ret) const {
- bool ok;
- int v = ClassDB::get_integer_constant(name, p_name, &ok);
- if (ok) {
- r_ret = v;
- return true;
- } else {
- return false;
- }
- }
- void GDScriptNativeClass::_bind_methods() {
- ClassDB::bind_method(D_METHOD("new"), &GDScriptNativeClass::_new);
- }
- Variant GDScriptNativeClass::_new() {
- Object *o = instance();
- if (!o) {
- ERR_EXPLAIN("Class type: '" + String(name) + "' is not instantiable.");
- ERR_FAIL_COND_V(!o, Variant());
- }
- Reference *ref = Object::cast_to<Reference>(o);
- if (ref) {
- return REF(ref);
- } else {
- return o;
- }
- }
- Object *GDScriptNativeClass::instance() {
- return ClassDB::instance(name);
- }
- GDScriptInstance *GDScript::_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_isref, Variant::CallError &r_error) {
- /* STEP 1, CREATE */
- GDScriptInstance *instance = memnew(GDScriptInstance);
- instance->base_ref = p_isref;
- instance->members.resize(member_indices.size());
- instance->script = Ref<GDScript>(this);
- instance->owner = p_owner;
- #ifdef DEBUG_ENABLED
- //needed for hot reloading
- for (Map<StringName, MemberInfo>::Element *E = member_indices.front(); E; E = E->next()) {
- instance->member_indices_cache[E->key()] = E->get().index;
- }
- #endif
- instance->owner->set_script_instance(instance);
- /* STEP 2, INITIALIZE AND CONSRTUCT */
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->lock();
- #endif
- instances.insert(instance->owner);
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->unlock();
- #endif
- initializer->call(instance, p_args, p_argcount, r_error);
- if (r_error.error != Variant::CallError::CALL_OK) {
- instance->script = Ref<GDScript>();
- instance->owner->set_script_instance(NULL);
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->lock();
- #endif
- instances.erase(p_owner);
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->unlock();
- #endif
- ERR_FAIL_COND_V(r_error.error != Variant::CallError::CALL_OK, NULL); //error constructing
- }
- //@TODO make thread safe
- return instance;
- }
- Variant GDScript::_new(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
- /* STEP 1, CREATE */
- if (!valid) {
- r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- r_error.error = Variant::CallError::CALL_OK;
- REF ref;
- Object *owner = NULL;
- GDScript *_baseptr = this;
- while (_baseptr->_base) {
- _baseptr = _baseptr->_base;
- }
- ERR_FAIL_COND_V(_baseptr->native.is_null(), Variant());
- if (_baseptr->native.ptr()) {
- owner = _baseptr->native->instance();
- } else {
- owner = memnew(Reference); //by default, no base means use reference
- }
- Reference *r = Object::cast_to<Reference>(owner);
- if (r) {
- ref = REF(r);
- }
- GDScriptInstance *instance = _create_instance(p_args, p_argcount, owner, r != NULL, r_error);
- if (!instance) {
- if (ref.is_null()) {
- memdelete(owner); //no owner, sorry
- }
- return Variant();
- }
- if (ref.is_valid()) {
- return ref;
- } else {
- return owner;
- }
- }
- bool GDScript::can_instance() const {
- #ifdef TOOLS_ENABLED
- return valid && (tool || ScriptServer::is_scripting_enabled());
- #else
- return valid;
- #endif
- }
- Ref<Script> GDScript::get_base_script() const {
- if (_base) {
- return Ref<GDScript>(_base);
- } else {
- return Ref<Script>();
- }
- }
- StringName GDScript::get_instance_base_type() const {
- if (native.is_valid())
- return native->get_name();
- if (base.is_valid())
- return base->get_instance_base_type();
- return StringName();
- }
- struct _GDScriptMemberSort {
- int index;
- StringName name;
- _FORCE_INLINE_ bool operator<(const _GDScriptMemberSort &p_member) const { return index < p_member.index; }
- };
- #ifdef TOOLS_ENABLED
- void GDScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
- placeholders.erase(p_placeholder);
- }
- #endif
- void GDScript::get_script_method_list(List<MethodInfo> *p_list) const {
- for (const Map<StringName, GDScriptFunction *>::Element *E = member_functions.front(); E; E = E->next()) {
- GDScriptFunction *func = E->get();
- MethodInfo mi;
- mi.name = E->key();
- for (int i = 0; i < func->get_argument_count(); i++) {
- mi.arguments.push_back(func->get_argument_type(i));
- }
- mi.return_val = func->get_return_type();
- p_list->push_back(mi);
- }
- }
- void GDScript::get_script_property_list(List<PropertyInfo> *p_list) const {
- const GDScript *sptr = this;
- List<PropertyInfo> props;
- while (sptr) {
- Vector<_GDScriptMemberSort> msort;
- for (Map<StringName, PropertyInfo>::Element *E = sptr->member_info.front(); E; E = E->next()) {
- _GDScriptMemberSort ms;
- ERR_CONTINUE(!sptr->member_indices.has(E->key()));
- ms.index = sptr->member_indices[E->key()].index;
- ms.name = E->key();
- msort.push_back(ms);
- }
- msort.sort();
- msort.invert();
- for (int i = 0; i < msort.size(); i++) {
- props.push_front(sptr->member_info[msort[i].name]);
- }
- sptr = sptr->_base;
- }
- for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
- p_list->push_back(E->get());
- }
- }
- bool GDScript::has_method(const StringName &p_method) const {
- return member_functions.has(p_method);
- }
- MethodInfo GDScript::get_method_info(const StringName &p_method) const {
- const Map<StringName, GDScriptFunction *>::Element *E = member_functions.find(p_method);
- if (!E)
- return MethodInfo();
- GDScriptFunction *func = E->get();
- MethodInfo mi;
- mi.name = E->key();
- for (int i = 0; i < func->get_argument_count(); i++) {
- mi.arguments.push_back(func->get_argument_type(i));
- }
- mi.return_val = func->get_return_type();
- return mi;
- }
- bool GDScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
- #ifdef TOOLS_ENABLED
- const Map<StringName, Variant>::Element *E = member_default_values_cache.find(p_property);
- if (E) {
- r_value = E->get();
- return true;
- }
- if (base_cache.is_valid()) {
- return base_cache->get_property_default_value(p_property, r_value);
- }
- #endif
- return false;
- }
- ScriptInstance *GDScript::instance_create(Object *p_this) {
- GDScript *top = this;
- while (top->_base)
- top = top->_base;
- if (top->native.is_valid()) {
- if (!ClassDB::is_parent_class(p_this->get_class_name(), top->native->get_name())) {
- if (ScriptDebugger::get_singleton()) {
- GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), 0, "Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be instanced in object of type: '" + p_this->get_class() + "'");
- }
- ERR_EXPLAIN("Script inherits from native type '" + String(top->native->get_name()) + "', so it can't be instanced in object of type: '" + p_this->get_class() + "'");
- ERR_FAIL_V(NULL);
- }
- }
- Variant::CallError unchecked_error;
- return _create_instance(NULL, 0, p_this, Object::cast_to<Reference>(p_this), unchecked_error);
- }
- PlaceHolderScriptInstance *GDScript::placeholder_instance_create(Object *p_this) {
- #ifdef TOOLS_ENABLED
- PlaceHolderScriptInstance *si = memnew(PlaceHolderScriptInstance(GDScriptLanguage::get_singleton(), Ref<Script>(this), p_this));
- placeholders.insert(si);
- _update_exports();
- return si;
- #else
- return NULL;
- #endif
- }
- bool GDScript::instance_has(const Object *p_this) const {
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->lock();
- #endif
- bool hasit = instances.has((Object *)p_this);
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->unlock();
- #endif
- return hasit;
- }
- bool GDScript::has_source_code() const {
- return source != "";
- }
- String GDScript::get_source_code() const {
- return source;
- }
- void GDScript::set_source_code(const String &p_code) {
- if (source == p_code)
- return;
- source = p_code;
- #ifdef TOOLS_ENABLED
- source_changed_cache = true;
- #endif
- }
- #ifdef TOOLS_ENABLED
- void GDScript::_update_exports_values(Map<StringName, Variant> &values, List<PropertyInfo> &propnames) {
- if (base_cache.is_valid()) {
- base_cache->_update_exports_values(values, propnames);
- }
- for (Map<StringName, Variant>::Element *E = member_default_values_cache.front(); E; E = E->next()) {
- values[E->key()] = E->get();
- }
- for (List<PropertyInfo>::Element *E = members_cache.front(); E; E = E->next()) {
- propnames.push_back(E->get());
- }
- }
- #endif
- bool GDScript::_update_exports() {
- #ifdef TOOLS_ENABLED
- bool changed = false;
- if (source_changed_cache) {
- source_changed_cache = false;
- changed = true;
- String basedir = path;
- if (basedir == "")
- basedir = get_path();
- if (basedir != "")
- basedir = basedir.get_base_dir();
- GDScriptParser parser;
- Error err = parser.parse(source, basedir, true, path);
- if (err == OK) {
- const GDScriptParser::Node *root = parser.get_parse_tree();
- ERR_FAIL_COND_V(root->type != GDScriptParser::Node::TYPE_CLASS, false);
- const GDScriptParser::ClassNode *c = static_cast<const GDScriptParser::ClassNode *>(root);
- if (base_cache.is_valid()) {
- base_cache->inheriters_cache.erase(get_instance_id());
- base_cache = Ref<GDScript>();
- }
- if (c->extends_used) {
- String path = "";
- if (String(c->extends_file) != "" && String(c->extends_file) != get_path()) {
- path = c->extends_file;
- if (path.is_rel_path()) {
- String base = get_path();
- if (base == "" || base.is_rel_path()) {
- ERR_PRINT(("Could not resolve relative path for parent class: " + path).utf8().get_data());
- } else {
- path = base.get_base_dir().plus_file(path);
- }
- }
- } else if (c->extends_class.size() != 0) {
- String base = c->extends_class[0];
- if (ScriptServer::is_global_class(base))
- path = ScriptServer::get_global_class_path(base);
- }
- if (path != "") {
- if (path != get_path()) {
- Ref<GDScript> bf = ResourceLoader::load(path);
- if (bf.is_valid()) {
- base_cache = bf;
- bf->inheriters_cache.insert(get_instance_id());
- }
- } else {
- ERR_PRINT(("Path extending itself in " + path).utf8().get_data());
- }
- }
- }
- members_cache.clear();
- member_default_values_cache.clear();
- for (int i = 0; i < c->variables.size(); i++) {
- if (c->variables[i]._export.type == Variant::NIL)
- continue;
- members_cache.push_back(c->variables[i]._export);
- member_default_values_cache[c->variables[i].identifier] = c->variables[i].default_value;
- }
- _signals.clear();
- for (int i = 0; i < c->_signals.size(); i++) {
- _signals[c->_signals[i].name] = c->_signals[i].arguments;
- }
- } else {
- for (Set<PlaceHolderScriptInstance *>::Element *E = placeholders.front(); E; E = E->next()) {
- E->get()->set_build_failed(true);
- }
- return false;
- }
- } else {
- if (!valid) {
- for (Set<PlaceHolderScriptInstance *>::Element *E = placeholders.front(); E; E = E->next()) {
- E->get()->set_build_failed(true);
- }
- return false;
- }
- }
- if (base_cache.is_valid()) {
- if (base_cache->_update_exports()) {
- changed = true;
- }
- }
- if (placeholders.size()) { //hm :(
- // update placeholders if any
- Map<StringName, Variant> values;
- List<PropertyInfo> propnames;
- _update_exports_values(values, propnames);
- for (Set<PlaceHolderScriptInstance *>::Element *E = placeholders.front(); E; E = E->next()) {
- E->get()->set_build_failed(false);
- E->get()->update(propnames, values);
- }
- }
- return changed;
- #else
- return false;
- #endif
- }
- void GDScript::update_exports() {
- #ifdef TOOLS_ENABLED
- _update_exports();
- Set<ObjectID> copy = inheriters_cache; //might get modified
- for (Set<ObjectID>::Element *E = copy.front(); E; E = E->next()) {
- Object *id = ObjectDB::get_instance(E->get());
- GDScript *s = Object::cast_to<GDScript>(id);
- if (!s)
- continue;
- s->update_exports();
- }
- #endif
- }
- void GDScript::_set_subclass_path(Ref<GDScript> &p_sc, const String &p_path) {
- p_sc->path = p_path;
- for (Map<StringName, Ref<GDScript> >::Element *E = p_sc->subclasses.front(); E; E = E->next()) {
- _set_subclass_path(E->get(), p_path);
- }
- }
- Error GDScript::reload(bool p_keep_state) {
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->lock();
- #endif
- bool has_instances = instances.size();
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->unlock();
- #endif
- ERR_FAIL_COND_V(!p_keep_state && has_instances, ERR_ALREADY_IN_USE);
- String basedir = path;
- if (basedir == "")
- basedir = get_path();
- if (basedir != "")
- basedir = basedir.get_base_dir();
- if (source.find("%BASE%") != -1) {
- //loading a template, don't parse
- return OK;
- }
- valid = false;
- GDScriptParser parser;
- Error err = parser.parse(source, basedir, false, path);
- if (err) {
- if (ScriptDebugger::get_singleton()) {
- GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), parser.get_error_line(), "Parser Error: " + parser.get_error());
- }
- _err_print_error("GDScript::reload", path.empty() ? "built-in" : (const char *)path.utf8().get_data(), parser.get_error_line(), ("Parse Error: " + parser.get_error()).utf8().get_data(), ERR_HANDLER_SCRIPT);
- ERR_FAIL_V(ERR_PARSE_ERROR);
- }
- bool can_run = ScriptServer::is_scripting_enabled() || parser.is_tool_script();
- GDScriptCompiler compiler;
- err = compiler.compile(&parser, this, p_keep_state);
- if (err) {
- if (can_run) {
- if (ScriptDebugger::get_singleton()) {
- GDScriptLanguage::get_singleton()->debug_break_parse(get_path(), compiler.get_error_line(), "Parser Error: " + compiler.get_error());
- }
- _err_print_error("GDScript::reload", path.empty() ? "built-in" : (const char *)path.utf8().get_data(), compiler.get_error_line(), ("Compile Error: " + compiler.get_error()).utf8().get_data(), ERR_HANDLER_SCRIPT);
- ERR_FAIL_V(ERR_COMPILATION_FAILED);
- } else {
- return err;
- }
- }
- #if DEBUG_ENABLED
- for (const List<GDScriptWarning>::Element *E = parser.get_warnings().front(); E; E = E->next()) {
- const GDScriptWarning &warning = E->get();
- if (ScriptDebugger::get_singleton()) {
- Vector<ScriptLanguage::StackInfo> si;
- ScriptDebugger::get_singleton()->send_error("", get_path(), warning.line, warning.get_name(), warning.get_message(), ERR_HANDLER_WARNING, si);
- }
- }
- #endif
- valid = true;
- for (Map<StringName, Ref<GDScript> >::Element *E = subclasses.front(); E; E = E->next()) {
- _set_subclass_path(E->get(), path);
- }
- return OK;
- }
- ScriptLanguage *GDScript::get_language() const {
- return GDScriptLanguage::get_singleton();
- }
- void GDScript::get_constants(Map<StringName, Variant> *p_constants) {
- if (p_constants) {
- for (Map<StringName, Variant>::Element *E = constants.front(); E; E = E->next()) {
- (*p_constants)[E->key()] = E->value();
- }
- }
- }
- void GDScript::get_members(Set<StringName> *p_members) {
- if (p_members) {
- for (Set<StringName>::Element *E = members.front(); E; E = E->next()) {
- p_members->insert(E->get());
- }
- }
- }
- Variant GDScript::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
- GDScript *top = this;
- while (top) {
- Map<StringName, GDScriptFunction *>::Element *E = top->member_functions.find(p_method);
- if (E) {
- if (!E->get()->is_static()) {
- WARN_PRINT(String("Can't call non-static function: '" + String(p_method) + "' in script.").utf8().get_data());
- }
- return E->get()->call(NULL, p_args, p_argcount, r_error);
- }
- top = top->_base;
- }
- //none found, regular
- return Script::call(p_method, p_args, p_argcount, r_error);
- }
- bool GDScript::_get(const StringName &p_name, Variant &r_ret) const {
- {
- const GDScript *top = this;
- while (top) {
- {
- const Map<StringName, Variant>::Element *E = top->constants.find(p_name);
- if (E) {
- r_ret = E->get();
- return true;
- }
- }
- {
- const Map<StringName, Ref<GDScript> >::Element *E = subclasses.find(p_name);
- if (E) {
- r_ret = E->get();
- return true;
- }
- }
- top = top->_base;
- }
- if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
- r_ret = get_source_code();
- return true;
- }
- }
- return false;
- }
- bool GDScript::_set(const StringName &p_name, const Variant &p_value) {
- if (p_name == GDScriptLanguage::get_singleton()->strings._script_source) {
- set_source_code(p_value);
- reload();
- } else
- return false;
- return true;
- }
- void GDScript::_get_property_list(List<PropertyInfo> *p_properties) const {
- p_properties->push_back(PropertyInfo(Variant::STRING, "script/source", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL));
- }
- void GDScript::_bind_methods() {
- ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &GDScript::_new, MethodInfo(Variant::OBJECT, "new"));
- ClassDB::bind_method(D_METHOD("get_as_byte_code"), &GDScript::get_as_byte_code);
- }
- Vector<uint8_t> GDScript::get_as_byte_code() const {
- GDScriptTokenizerBuffer tokenizer;
- return tokenizer.parse_code_string(source);
- };
- Error GDScript::load_byte_code(const String &p_path) {
- Vector<uint8_t> bytecode;
- if (p_path.ends_with("gde")) {
- FileAccess *fa = FileAccess::open(p_path, FileAccess::READ);
- ERR_FAIL_COND_V(!fa, ERR_CANT_OPEN);
- FileAccessEncrypted *fae = memnew(FileAccessEncrypted);
- ERR_FAIL_COND_V(!fae, ERR_CANT_OPEN);
- Vector<uint8_t> key;
- key.resize(32);
- for (int i = 0; i < key.size(); i++) {
- key.write[i] = script_encryption_key[i];
- }
- Error err = fae->open_and_parse(fa, key, FileAccessEncrypted::MODE_READ);
- if (err) {
- fa->close();
- memdelete(fa);
- memdelete(fae);
- ERR_FAIL_COND_V(err, err);
- }
- bytecode.resize(fae->get_len());
- fae->get_buffer(bytecode.ptrw(), bytecode.size());
- fae->close();
- memdelete(fae);
- } else {
- bytecode = FileAccess::get_file_as_array(p_path);
- }
- ERR_FAIL_COND_V(bytecode.size() == 0, ERR_PARSE_ERROR);
- path = p_path;
- String basedir = path;
- if (basedir == "")
- basedir = get_path();
- if (basedir != "")
- basedir = basedir.get_base_dir();
- valid = false;
- GDScriptParser parser;
- Error err = parser.parse_bytecode(bytecode, basedir, get_path());
- if (err) {
- _err_print_error("GDScript::load_byte_code", path.empty() ? "built-in" : (const char *)path.utf8().get_data(), parser.get_error_line(), ("Parse Error: " + parser.get_error()).utf8().get_data(), ERR_HANDLER_SCRIPT);
- ERR_FAIL_V(ERR_PARSE_ERROR);
- }
- GDScriptCompiler compiler;
- err = compiler.compile(&parser, this);
- if (err) {
- _err_print_error("GDScript::load_byte_code", path.empty() ? "built-in" : (const char *)path.utf8().get_data(), compiler.get_error_line(), ("Compile Error: " + compiler.get_error()).utf8().get_data(), ERR_HANDLER_SCRIPT);
- ERR_FAIL_V(ERR_COMPILATION_FAILED);
- }
- valid = true;
- for (Map<StringName, Ref<GDScript> >::Element *E = subclasses.front(); E; E = E->next()) {
- _set_subclass_path(E->get(), path);
- }
- return OK;
- }
- Error GDScript::load_source_code(const String &p_path) {
- PoolVector<uint8_t> sourcef;
- Error err;
- FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
- if (err) {
- ERR_FAIL_COND_V(err, err);
- }
- int len = f->get_len();
- sourcef.resize(len + 1);
- PoolVector<uint8_t>::Write w = sourcef.write();
- int r = f->get_buffer(w.ptr(), len);
- f->close();
- memdelete(f);
- ERR_FAIL_COND_V(r != len, ERR_CANT_OPEN);
- w[len] = 0;
- String s;
- if (s.parse_utf8((const char *)w.ptr())) {
- ERR_EXPLAIN("Script '" + p_path + "' contains invalid unicode (utf-8), so it was not loaded. Please ensure that scripts are saved in valid utf-8 unicode.");
- ERR_FAIL_V(ERR_INVALID_DATA);
- }
- source = s;
- #ifdef TOOLS_ENABLED
- source_changed_cache = true;
- #endif
- path = p_path;
- return OK;
- }
- const Map<StringName, GDScriptFunction *> &GDScript::debug_get_member_functions() const {
- return member_functions;
- }
- StringName GDScript::debug_get_member_by_index(int p_idx) const {
- for (const Map<StringName, MemberInfo>::Element *E = member_indices.front(); E; E = E->next()) {
- if (E->get().index == p_idx)
- return E->key();
- }
- return "<error>";
- }
- Ref<GDScript> GDScript::get_base() const {
- return base;
- }
- bool GDScript::has_script_signal(const StringName &p_signal) const {
- if (_signals.has(p_signal))
- return true;
- if (base.is_valid()) {
- return base->has_script_signal(p_signal);
- }
- #ifdef TOOLS_ENABLED
- else if (base_cache.is_valid()) {
- return base_cache->has_script_signal(p_signal);
- }
- #endif
- return false;
- }
- void GDScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
- for (const Map<StringName, Vector<StringName> >::Element *E = _signals.front(); E; E = E->next()) {
- MethodInfo mi;
- mi.name = E->key();
- for (int i = 0; i < E->get().size(); i++) {
- PropertyInfo arg;
- arg.name = E->get()[i];
- mi.arguments.push_back(arg);
- }
- r_signals->push_back(mi);
- }
- if (base.is_valid()) {
- base->get_script_signal_list(r_signals);
- }
- #ifdef TOOLS_ENABLED
- else if (base_cache.is_valid()) {
- base_cache->get_script_signal_list(r_signals);
- }
- #endif
- }
- GDScript::GDScript() :
- script_list(this) {
- _static_ref = this;
- valid = false;
- subclass_count = 0;
- initializer = NULL;
- _base = NULL;
- _owner = NULL;
- tool = false;
- #ifdef TOOLS_ENABLED
- source_changed_cache = false;
- #endif
- #ifdef DEBUG_ENABLED
- if (GDScriptLanguage::get_singleton()->lock) {
- GDScriptLanguage::get_singleton()->lock->lock();
- }
- GDScriptLanguage::get_singleton()->script_list.add(&script_list);
- if (GDScriptLanguage::get_singleton()->lock) {
- GDScriptLanguage::get_singleton()->lock->unlock();
- }
- #endif
- }
- GDScript::~GDScript() {
- for (Map<StringName, GDScriptFunction *>::Element *E = member_functions.front(); E; E = E->next()) {
- memdelete(E->get());
- }
- for (Map<StringName, Ref<GDScript> >::Element *E = subclasses.front(); E; E = E->next()) {
- E->get()->_owner = NULL; //bye, you are no longer owned cause I died
- }
- #ifdef DEBUG_ENABLED
- if (GDScriptLanguage::get_singleton()->lock) {
- GDScriptLanguage::get_singleton()->lock->lock();
- }
- GDScriptLanguage::get_singleton()->script_list.remove(&script_list);
- if (GDScriptLanguage::get_singleton()->lock) {
- GDScriptLanguage::get_singleton()->lock->unlock();
- }
- #endif
- }
- //////////////////////////////
- // INSTANCE //
- //////////////////////////////
- bool GDScriptInstance::set(const StringName &p_name, const Variant &p_value) {
- //member
- {
- const Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.find(p_name);
- if (E) {
- if (E->get().setter) {
- const Variant *val = &p_value;
- Variant::CallError err;
- call(E->get().setter, &val, 1, err);
- if (err.error == Variant::CallError::CALL_OK) {
- return true; //function exists, call was successful
- }
- } else {
- if (!E->get().data_type.is_type(p_value)) {
- return false; // Type mismatch
- }
- members.write[E->get().index] = p_value;
- }
- return true;
- }
- }
- GDScript *sptr = script.ptr();
- while (sptr) {
- Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._set);
- if (E) {
- Variant name = p_name;
- const Variant *args[2] = { &name, &p_value };
- Variant::CallError err;
- Variant ret = E->get()->call(this, (const Variant **)args, 2, err);
- if (err.error == Variant::CallError::CALL_OK && ret.get_type() == Variant::BOOL && ret.operator bool())
- return true;
- }
- sptr = sptr->_base;
- }
- return false;
- }
- bool GDScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
- const GDScript *sptr = script.ptr();
- while (sptr) {
- {
- const Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.find(p_name);
- if (E) {
- if (E->get().getter) {
- Variant::CallError err;
- r_ret = const_cast<GDScriptInstance *>(this)->call(E->get().getter, NULL, 0, err);
- if (err.error == Variant::CallError::CALL_OK) {
- return true;
- }
- }
- r_ret = members[E->get().index];
- return true; //index found
- }
- }
- {
- const GDScript *sl = sptr;
- while (sl) {
- const Map<StringName, Variant>::Element *E = sl->constants.find(p_name);
- if (E) {
- r_ret = E->get();
- return true; //index found
- }
- sl = sl->_base;
- }
- }
- {
- const Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get);
- if (E) {
- Variant name = p_name;
- const Variant *args[1] = { &name };
- Variant::CallError err;
- Variant ret = const_cast<GDScriptFunction *>(E->get())->call(const_cast<GDScriptInstance *>(this), (const Variant **)args, 1, err);
- if (err.error == Variant::CallError::CALL_OK && ret.get_type() != Variant::NIL) {
- r_ret = ret;
- return true;
- }
- }
- }
- sptr = sptr->_base;
- }
- return false;
- }
- Variant::Type GDScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
- const GDScript *sptr = script.ptr();
- while (sptr) {
- if (sptr->member_info.has(p_name)) {
- if (r_is_valid)
- *r_is_valid = true;
- return sptr->member_info[p_name].type;
- }
- sptr = sptr->_base;
- }
- if (r_is_valid)
- *r_is_valid = false;
- return Variant::NIL;
- }
- void GDScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
- // exported members, not doen yet!
- const GDScript *sptr = script.ptr();
- List<PropertyInfo> props;
- while (sptr) {
- const Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._get_property_list);
- if (E) {
- Variant::CallError err;
- Variant ret = const_cast<GDScriptFunction *>(E->get())->call(const_cast<GDScriptInstance *>(this), NULL, 0, err);
- if (err.error == Variant::CallError::CALL_OK) {
- if (ret.get_type() != Variant::ARRAY) {
- ERR_EXPLAIN("Wrong type for _get_property list, must be an array of dictionaries.");
- ERR_FAIL();
- }
- Array arr = ret;
- for (int i = 0; i < arr.size(); i++) {
- Dictionary d = arr[i];
- ERR_CONTINUE(!d.has("name"));
- ERR_CONTINUE(!d.has("type"));
- PropertyInfo pinfo;
- pinfo.type = Variant::Type(d["type"].operator int());
- ERR_CONTINUE(pinfo.type < 0 || pinfo.type >= Variant::VARIANT_MAX);
- pinfo.name = d["name"];
- ERR_CONTINUE(pinfo.name == "");
- if (d.has("hint"))
- pinfo.hint = PropertyHint(d["hint"].operator int());
- if (d.has("hint_string"))
- pinfo.hint_string = d["hint_string"];
- if (d.has("usage"))
- pinfo.usage = d["usage"];
- props.push_back(pinfo);
- }
- }
- }
- //instance a fake script for editing the values
- Vector<_GDScriptMemberSort> msort;
- for (Map<StringName, PropertyInfo>::Element *E = sptr->member_info.front(); E; E = E->next()) {
- _GDScriptMemberSort ms;
- ERR_CONTINUE(!sptr->member_indices.has(E->key()));
- ms.index = sptr->member_indices[E->key()].index;
- ms.name = E->key();
- msort.push_back(ms);
- }
- msort.sort();
- msort.invert();
- for (int i = 0; i < msort.size(); i++) {
- props.push_front(sptr->member_info[msort[i].name]);
- }
- sptr = sptr->_base;
- }
- for (List<PropertyInfo>::Element *E = props.front(); E; E = E->next()) {
- p_properties->push_back(E->get());
- }
- }
- void GDScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
- const GDScript *sptr = script.ptr();
- while (sptr) {
- for (Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.front(); E; E = E->next()) {
- MethodInfo mi;
- mi.name = E->key();
- mi.flags |= METHOD_FLAG_FROM_SCRIPT;
- for (int i = 0; i < E->get()->get_argument_count(); i++)
- mi.arguments.push_back(PropertyInfo(Variant::NIL, "arg" + itos(i)));
- p_list->push_back(mi);
- }
- sptr = sptr->_base;
- }
- }
- bool GDScriptInstance::has_method(const StringName &p_method) const {
- const GDScript *sptr = script.ptr();
- while (sptr) {
- const Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(p_method);
- if (E)
- return true;
- sptr = sptr->_base;
- }
- return false;
- }
- Variant GDScriptInstance::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
- //printf("calling %ls:%i method %ls\n", script->get_path().c_str(), -1, String(p_method).c_str());
- GDScript *sptr = script.ptr();
- while (sptr) {
- Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(p_method);
- if (E) {
- return E->get()->call(this, p_args, p_argcount, r_error);
- }
- sptr = sptr->_base;
- }
- r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
- return Variant();
- }
- void GDScriptInstance::call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount) {
- GDScript *sptr = script.ptr();
- Variant::CallError ce;
- while (sptr) {
- Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(p_method);
- if (E) {
- E->get()->call(this, p_args, p_argcount, ce);
- }
- sptr = sptr->_base;
- }
- }
- void GDScriptInstance::_ml_call_reversed(GDScript *sptr, const StringName &p_method, const Variant **p_args, int p_argcount) {
- if (sptr->_base)
- _ml_call_reversed(sptr->_base, p_method, p_args, p_argcount);
- Variant::CallError ce;
- Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(p_method);
- if (E) {
- E->get()->call(this, p_args, p_argcount, ce);
- }
- }
- void GDScriptInstance::call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount) {
- if (script.ptr()) {
- _ml_call_reversed(script.ptr(), p_method, p_args, p_argcount);
- }
- }
- void GDScriptInstance::notification(int p_notification) {
- //notification is not virtual, it gets called at ALL levels just like in C.
- Variant value = p_notification;
- const Variant *args[1] = { &value };
- GDScript *sptr = script.ptr();
- while (sptr) {
- Map<StringName, GDScriptFunction *>::Element *E = sptr->member_functions.find(GDScriptLanguage::get_singleton()->strings._notification);
- if (E) {
- Variant::CallError err;
- E->get()->call(this, args, 1, err);
- if (err.error != Variant::CallError::CALL_OK) {
- //print error about notification call
- }
- }
- sptr = sptr->_base;
- }
- }
- Ref<Script> GDScriptInstance::get_script() const {
- return script;
- }
- ScriptLanguage *GDScriptInstance::get_language() {
- return GDScriptLanguage::get_singleton();
- }
- MultiplayerAPI::RPCMode GDScriptInstance::get_rpc_mode(const StringName &p_method) const {
- const GDScript *cscript = script.ptr();
- while (cscript) {
- const Map<StringName, GDScriptFunction *>::Element *E = cscript->member_functions.find(p_method);
- if (E) {
- if (E->get()->get_rpc_mode() != MultiplayerAPI::RPC_MODE_DISABLED) {
- return E->get()->get_rpc_mode();
- }
- }
- cscript = cscript->_base;
- }
- return MultiplayerAPI::RPC_MODE_DISABLED;
- }
- MultiplayerAPI::RPCMode GDScriptInstance::get_rset_mode(const StringName &p_variable) const {
- const GDScript *cscript = script.ptr();
- while (cscript) {
- const Map<StringName, GDScript::MemberInfo>::Element *E = cscript->member_indices.find(p_variable);
- if (E) {
- if (E->get().rpc_mode) {
- return E->get().rpc_mode;
- }
- }
- cscript = cscript->_base;
- }
- return MultiplayerAPI::RPC_MODE_DISABLED;
- }
- void GDScriptInstance::reload_members() {
- #ifdef DEBUG_ENABLED
- members.resize(script->member_indices.size()); //resize
- Vector<Variant> new_members;
- new_members.resize(script->member_indices.size());
- //pass the values to the new indices
- for (Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.front(); E; E = E->next()) {
- if (member_indices_cache.has(E->key())) {
- Variant value = members[member_indices_cache[E->key()]];
- new_members.write[E->get().index] = value;
- }
- }
- //apply
- members = new_members;
- //pass the values to the new indices
- member_indices_cache.clear();
- for (Map<StringName, GDScript::MemberInfo>::Element *E = script->member_indices.front(); E; E = E->next()) {
- member_indices_cache[E->key()] = E->get().index;
- }
- #endif
- }
- GDScriptInstance::GDScriptInstance() {
- owner = NULL;
- base_ref = false;
- }
- GDScriptInstance::~GDScriptInstance() {
- if (script.is_valid() && owner) {
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->lock();
- #endif
- script->instances.erase(owner);
- #ifndef NO_THREADS
- GDScriptLanguage::singleton->lock->unlock();
- #endif
- }
- }
- /************* SCRIPT LANGUAGE **************/
- GDScriptLanguage *GDScriptLanguage::singleton = NULL;
- String GDScriptLanguage::get_name() const {
- return "GDScript";
- }
- /* LANGUAGE FUNCTIONS */
- void GDScriptLanguage::_add_global(const StringName &p_name, const Variant &p_value) {
- if (globals.has(p_name)) {
- //overwrite existing
- global_array.write[globals[p_name]] = p_value;
- return;
- }
- globals[p_name] = global_array.size();
- global_array.push_back(p_value);
- _global_array = global_array.ptrw();
- }
- void GDScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
- _add_global(p_variable, p_value);
- }
- void GDScriptLanguage::add_named_global_constant(const StringName &p_name, const Variant &p_value) {
- named_globals[p_name] = p_value;
- }
- void GDScriptLanguage::remove_named_global_constant(const StringName &p_name) {
- ERR_FAIL_COND(!named_globals.has(p_name));
- named_globals.erase(p_name);
- }
- void GDScriptLanguage::init() {
- //populate global constants
- int gcc = GlobalConstants::get_global_constant_count();
- for (int i = 0; i < gcc; i++) {
- _add_global(StaticCString::create(GlobalConstants::get_global_constant_name(i)), GlobalConstants::get_global_constant_value(i));
- }
- _add_global(StaticCString::create("PI"), Math_PI);
- _add_global(StaticCString::create("TAU"), Math_TAU);
- _add_global(StaticCString::create("INF"), Math_INF);
- _add_global(StaticCString::create("NAN"), Math_NAN);
- //populate native classes
- List<StringName> class_list;
- ClassDB::get_class_list(&class_list);
- for (List<StringName>::Element *E = class_list.front(); E; E = E->next()) {
- StringName n = E->get();
- String s = String(n);
- if (s.begins_with("_"))
- n = s.substr(1, s.length());
- if (globals.has(n))
- continue;
- Ref<GDScriptNativeClass> nc = memnew(GDScriptNativeClass(E->get()));
- _add_global(n, nc);
- }
- //populate singletons
- List<Engine::Singleton> singletons;
- Engine::get_singleton()->get_singletons(&singletons);
- for (List<Engine::Singleton>::Element *E = singletons.front(); E; E = E->next()) {
- _add_global(E->get().name, E->get().ptr);
- }
- }
- String GDScriptLanguage::get_type() const {
- return "GDScript";
- }
- String GDScriptLanguage::get_extension() const {
- return "gd";
- }
- Error GDScriptLanguage::execute_file(const String &p_path) {
- // ??
- return OK;
- }
- void GDScriptLanguage::finish() {
- }
- void GDScriptLanguage::profiling_start() {
- #ifdef DEBUG_ENABLED
- if (lock) {
- lock->lock();
- }
- SelfList<GDScriptFunction> *elem = function_list.first();
- while (elem) {
- elem->self()->profile.call_count = 0;
- elem->self()->profile.self_time = 0;
- elem->self()->profile.total_time = 0;
- elem->self()->profile.frame_call_count = 0;
- elem->self()->profile.frame_self_time = 0;
- elem->self()->profile.frame_total_time = 0;
- elem->self()->profile.last_frame_call_count = 0;
- elem->self()->profile.last_frame_self_time = 0;
- elem->self()->profile.last_frame_total_time = 0;
- elem = elem->next();
- }
- profiling = true;
- if (lock) {
- lock->unlock();
- }
- #endif
- }
- void GDScriptLanguage::profiling_stop() {
- #ifdef DEBUG_ENABLED
- if (lock) {
- lock->lock();
- }
- profiling = false;
- if (lock) {
- lock->unlock();
- }
- #endif
- }
- int GDScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
- int current = 0;
- #ifdef DEBUG_ENABLED
- if (lock) {
- lock->lock();
- }
- SelfList<GDScriptFunction> *elem = function_list.first();
- while (elem) {
- if (current >= p_info_max)
- break;
- p_info_arr[current].call_count = elem->self()->profile.call_count;
- p_info_arr[current].self_time = elem->self()->profile.self_time;
- p_info_arr[current].total_time = elem->self()->profile.total_time;
- p_info_arr[current].signature = elem->self()->profile.signature;
- elem = elem->next();
- current++;
- }
- if (lock) {
- lock->unlock();
- }
- #endif
- return current;
- }
- int GDScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
- int current = 0;
- #ifdef DEBUG_ENABLED
- if (lock) {
- lock->lock();
- }
- SelfList<GDScriptFunction> *elem = function_list.first();
- while (elem) {
- if (current >= p_info_max)
- break;
- if (elem->self()->profile.last_frame_call_count > 0) {
- p_info_arr[current].call_count = elem->self()->profile.last_frame_call_count;
- p_info_arr[current].self_time = elem->self()->profile.last_frame_self_time;
- p_info_arr[current].total_time = elem->self()->profile.last_frame_total_time;
- p_info_arr[current].signature = elem->self()->profile.signature;
- current++;
- }
- elem = elem->next();
- }
- if (lock) {
- lock->unlock();
- }
- #endif
- return current;
- }
- struct GDScriptDepSort {
- //must support sorting so inheritance works properly (parent must be reloaded first)
- bool operator()(const Ref<GDScript> &A, const Ref<GDScript> &B) const {
- if (A == B)
- return false; //shouldn't happen but..
- const GDScript *I = B->get_base().ptr();
- while (I) {
- if (I == A.ptr()) {
- // A is a base of B
- return true;
- }
- I = I->get_base().ptr();
- }
- return false; //not a base
- }
- };
- void GDScriptLanguage::reload_all_scripts() {
- #ifdef DEBUG_ENABLED
- print_verbose("GDScript: Reloading all scripts");
- if (lock) {
- lock->lock();
- }
- List<Ref<GDScript> > scripts;
- SelfList<GDScript> *elem = script_list.first();
- while (elem) {
- if (elem->self()->get_path().is_resource_file()) {
- print_verbose("GDScript: Found: " + elem->self()->get_path());
- scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
- }
- elem = elem->next();
- }
- if (lock) {
- lock->unlock();
- }
- //as scripts are going to be reloaded, must proceed without locking here
- scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
- for (List<Ref<GDScript> >::Element *E = scripts.front(); E; E = E->next()) {
- print_verbose("GDScript: Reloading: " + E->get()->get_path());
- E->get()->load_source_code(E->get()->get_path());
- E->get()->reload(true);
- }
- #endif
- }
- void GDScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
- #ifdef DEBUG_ENABLED
- if (lock) {
- lock->lock();
- }
- List<Ref<GDScript> > scripts;
- SelfList<GDScript> *elem = script_list.first();
- while (elem) {
- if (elem->self()->get_path().is_resource_file()) {
- scripts.push_back(Ref<GDScript>(elem->self())); //cast to gdscript to avoid being erased by accident
- }
- elem = elem->next();
- }
- if (lock) {
- lock->unlock();
- }
- //when someone asks you why dynamically typed languages are easier to write....
- Map<Ref<GDScript>, Map<ObjectID, List<Pair<StringName, Variant> > > > to_reload;
- //as scripts are going to be reloaded, must proceed without locking here
- scripts.sort_custom<GDScriptDepSort>(); //update in inheritance dependency order
- for (List<Ref<GDScript> >::Element *E = scripts.front(); E; E = E->next()) {
- bool reload = E->get() == p_script || to_reload.has(E->get()->get_base());
- if (!reload)
- continue;
- to_reload.insert(E->get(), Map<ObjectID, List<Pair<StringName, Variant> > >());
- if (!p_soft_reload) {
- //save state and remove script from instances
- Map<ObjectID, List<Pair<StringName, Variant> > > &map = to_reload[E->get()];
- while (E->get()->instances.front()) {
- Object *obj = E->get()->instances.front()->get();
- //save instance info
- List<Pair<StringName, Variant> > state;
- if (obj->get_script_instance()) {
- obj->get_script_instance()->get_property_state(state);
- map[obj->get_instance_id()] = state;
- obj->set_script(RefPtr());
- }
- }
- //same thing for placeholders
- #ifdef TOOLS_ENABLED
- while (E->get()->placeholders.size()) {
- Object *obj = E->get()->placeholders.front()->get()->get_owner();
- //save instance info
- if (obj->get_script_instance()) {
- map.insert(obj->get_instance_id(), List<Pair<StringName, Variant> >());
- List<Pair<StringName, Variant> > &state = map[obj->get_instance_id()];
- obj->get_script_instance()->get_property_state(state);
- obj->set_script(RefPtr());
- } else {
- // no instance found. Let's remove it so we don't loop forever
- E->get()->placeholders.erase(E->get()->placeholders.front()->get());
- }
- }
- #endif
- for (Map<ObjectID, List<Pair<StringName, Variant> > >::Element *F = E->get()->pending_reload_state.front(); F; F = F->next()) {
- map[F->key()] = F->get(); //pending to reload, use this one instead
- }
- }
- }
- for (Map<Ref<GDScript>, Map<ObjectID, List<Pair<StringName, Variant> > > >::Element *E = to_reload.front(); E; E = E->next()) {
- Ref<GDScript> scr = E->key();
- scr->reload(p_soft_reload);
- //restore state if saved
- for (Map<ObjectID, List<Pair<StringName, Variant> > >::Element *F = E->get().front(); F; F = F->next()) {
- Object *obj = ObjectDB::get_instance(F->key());
- if (!obj)
- continue;
- if (!p_soft_reload) {
- //clear it just in case (may be a pending reload state)
- obj->set_script(RefPtr());
- }
- obj->set_script(scr.get_ref_ptr());
- if (!obj->get_script_instance()) {
- //failed, save reload state for next time if not saved
- if (!scr->pending_reload_state.has(obj->get_instance_id())) {
- scr->pending_reload_state[obj->get_instance_id()] = F->get();
- }
- continue;
- }
- for (List<Pair<StringName, Variant> >::Element *G = F->get().front(); G; G = G->next()) {
- obj->get_script_instance()->set(G->get().first, G->get().second);
- }
- scr->pending_reload_state.erase(obj->get_instance_id()); //as it reloaded, remove pending state
- }
- //if instance states were saved, set them!
- }
- #endif
- }
- void GDScriptLanguage::frame() {
- calls = 0;
- #ifdef DEBUG_ENABLED
- if (profiling) {
- if (lock) {
- lock->lock();
- }
- SelfList<GDScriptFunction> *elem = function_list.first();
- while (elem) {
- elem->self()->profile.last_frame_call_count = elem->self()->profile.frame_call_count;
- elem->self()->profile.last_frame_self_time = elem->self()->profile.frame_self_time;
- elem->self()->profile.last_frame_total_time = elem->self()->profile.frame_total_time;
- elem->self()->profile.frame_call_count = 0;
- elem->self()->profile.frame_self_time = 0;
- elem->self()->profile.frame_total_time = 0;
- elem = elem->next();
- }
- if (lock) {
- lock->unlock();
- }
- }
- #endif
- }
- /* EDITOR FUNCTIONS */
- void GDScriptLanguage::get_reserved_words(List<String> *p_words) const {
- static const char *_reserved_words[] = {
- // operators
- "and",
- "in",
- "not",
- "or",
- // types and values
- "false",
- "float",
- "int",
- "bool",
- "null",
- "PI",
- "TAU",
- "INF",
- "NAN",
- "self",
- "true",
- "void",
- // functions
- "as",
- "assert",
- "breakpoint",
- "class",
- "class_name",
- "extends",
- "is",
- "func",
- "preload",
- "setget",
- "signal",
- "tool",
- "yield",
- // var
- "const",
- "enum",
- "export",
- "onready",
- "static",
- "var",
- // control flow
- "break",
- "continue",
- "if",
- "elif",
- "else",
- "for",
- "pass",
- "return",
- "match",
- "while",
- "remote",
- "sync",
- "master",
- "puppet",
- "slave",
- "remotesync",
- "mastersync",
- "puppetsync",
- 0
- };
- const char **w = _reserved_words;
- while (*w) {
- p_words->push_back(*w);
- w++;
- }
- for (int i = 0; i < GDScriptFunctions::FUNC_MAX; i++) {
- p_words->push_back(GDScriptFunctions::get_func_name(GDScriptFunctions::Function(i)));
- }
- }
- bool GDScriptLanguage::handles_global_class_type(const String &p_type) const {
- return p_type == "GDScript";
- }
- String GDScriptLanguage::get_global_class_name(const String &p_path, String *r_base_type, String *r_icon_path) const {
- PoolVector<uint8_t> sourcef;
- Error err;
- FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
- if (err) {
- return String();
- }
- int len = f->get_len();
- sourcef.resize(len + 1);
- PoolVector<uint8_t>::Write w = sourcef.write();
- int r = f->get_buffer(w.ptr(), len);
- f->close();
- memdelete(f);
- ERR_FAIL_COND_V(r != len, String());
- w[len] = 0;
- String s;
- if (s.parse_utf8((const char *)w.ptr())) {
- return String();
- }
- GDScriptParser parser;
- parser.parse(s, p_path.get_base_dir(), true, p_path);
- if (parser.get_parse_tree() && parser.get_parse_tree()->type == GDScriptParser::Node::TYPE_CLASS) {
- const GDScriptParser::ClassNode *c = static_cast<const GDScriptParser::ClassNode *>(parser.get_parse_tree());
- if (r_base_type) {
- GDScriptParser::DataType base_type;
- if (c->base_type.has_type) {
- base_type = c->base_type;
- while (base_type.has_type && base_type.kind != GDScriptParser::DataType::NATIVE) {
- switch (base_type.kind) {
- case GDScriptParser::DataType::CLASS: {
- base_type = base_type.class_type->base_type;
- } break;
- case GDScriptParser::DataType::GDSCRIPT: {
- Ref<GDScript> gds = base_type.script_type;
- if (gds.is_valid()) {
- base_type.kind = GDScriptParser::DataType::NATIVE;
- base_type.native_type = gds->get_instance_base_type();
- } else {
- base_type = GDScriptParser::DataType();
- }
- } break;
- default: {
- base_type = GDScriptParser::DataType();
- } break;
- }
- }
- }
- if (base_type.has_type) {
- *r_base_type = base_type.native_type;
- } else {
- // Fallback
- if (c->extends_used && c->extends_class.size() == 1) {
- *r_base_type = c->extends_class[0];
- } else if (!c->extends_used) {
- *r_base_type = "Reference";
- }
- }
- }
- if (r_icon_path) {
- if (c->icon_path.empty() || c->icon_path.is_abs_path())
- *r_icon_path = c->icon_path;
- else if (c->icon_path.is_rel_path())
- *r_icon_path = p_path.get_base_dir().plus_file(c->icon_path).simplify_path();
- }
- return c->name;
- }
- return String();
- }
- #ifdef DEBUG_ENABLED
- String GDScriptWarning::get_message() const {
- #define CHECK_SYMBOLS(m_amount) ERR_FAIL_COND_V(symbols.size() < m_amount, String());
- switch (code) {
- case UNASSIGNED_VARIABLE_OP_ASSIGN: {
- CHECK_SYMBOLS(1);
- return "Using assignment with operation but the variable '" + symbols[0] + "' was not previously assigned a value.";
- } break;
- case UNASSIGNED_VARIABLE: {
- CHECK_SYMBOLS(1);
- return "The variable '" + symbols[0] + "' was used but never assigned a value.";
- } break;
- case UNUSED_VARIABLE: {
- CHECK_SYMBOLS(1);
- return "The local variable '" + symbols[0] + "' is declared but never used in the block.";
- } break;
- case UNUSED_CLASS_VARIABLE: {
- CHECK_SYMBOLS(1);
- return "The class variable '" + symbols[0] + "' is declared but never used in the script.";
- } break;
- case UNUSED_ARGUMENT: {
- CHECK_SYMBOLS(2);
- return "The argument '" + symbols[1] + "' is never used in the function '" + symbols[0] + "'.";
- } break;
- case UNREACHABLE_CODE: {
- CHECK_SYMBOLS(1);
- return "Unreachable code (statement after return) in function '" + symbols[0] + "()'.";
- } break;
- case STANDALONE_EXPRESSION: {
- return "Standalone expression (the line has no effect).";
- } break;
- case VOID_ASSIGNMENT: {
- CHECK_SYMBOLS(1);
- return "Assignment operation, but the function '" + symbols[0] + "()' returns void.";
- } break;
- case NARROWING_CONVERSION: {
- return "Narrowing coversion (float is converted to int and lose precision).";
- } break;
- case FUNCTION_MAY_YIELD: {
- CHECK_SYMBOLS(1);
- return "Assigned variable is typed but the function '" + symbols[0] + "()' may yield and return a GDScriptFunctionState instead.";
- } break;
- case VARIABLE_CONFLICTS_FUNCTION: {
- CHECK_SYMBOLS(1);
- return "Variable declaration of '" + symbols[0] + "' conflicts with a function of the same name.";
- } break;
- case FUNCTION_CONFLICTS_VARIABLE: {
- CHECK_SYMBOLS(1);
- return "Function declaration of '" + symbols[0] + "()' conflicts with a variable of the same name.";
- } break;
- case FUNCTION_CONFLICTS_CONSTANT: {
- CHECK_SYMBOLS(1);
- return "Function declaration of '" + symbols[0] + "()' conflicts with a constant of the same name.";
- } break;
- case INCOMPATIBLE_TERNARY: {
- return "Values of the ternary conditional are not mutually compatible.";
- } break;
- case UNUSED_SIGNAL: {
- CHECK_SYMBOLS(1);
- return "The signal '" + symbols[0] + "' is declared but never emitted.";
- } break;
- case RETURN_VALUE_DISCARDED: {
- CHECK_SYMBOLS(1);
- return "The function '" + symbols[0] + "()' returns a value, but this value is never used.";
- } break;
- case PROPERTY_USED_AS_FUNCTION: {
- CHECK_SYMBOLS(2);
- return "The method '" + symbols[0] + "()' was not found in base '" + symbols[1] + "' but there's a property with the same name. Did you mean to access it?";
- } break;
- case CONSTANT_USED_AS_FUNCTION: {
- CHECK_SYMBOLS(2);
- return "The method '" + symbols[0] + "()' was not found in base '" + symbols[1] + "' but there's a constant with the same name. Did you mean to access it?";
- } break;
- case FUNCTION_USED_AS_PROPERTY: {
- CHECK_SYMBOLS(2);
- return "The property '" + symbols[0] + "' was not found in base '" + symbols[1] + "' but there's a method with the same name. Did you mean to call it?";
- } break;
- case INTEGER_DIVISION: {
- return "Integer division, decimal part will be discarded.";
- } break;
- case UNSAFE_PROPERTY_ACCESS: {
- CHECK_SYMBOLS(2);
- return "The property '" + symbols[0] + "' is not present on the inferred type '" + symbols[1] + "' (but may be present on a subtype).";
- } break;
- case UNSAFE_METHOD_ACCESS: {
- CHECK_SYMBOLS(2);
- return "The method '" + symbols[0] + "' is not present on the inferred type '" + symbols[1] + "' (but may be present on a subtype).";
- } break;
- case UNSAFE_CAST: {
- CHECK_SYMBOLS(1);
- return "The value is cast to '" + symbols[0] + "' but has an unknown type.";
- } break;
- case UNSAFE_CALL_ARGUMENT: {
- CHECK_SYMBOLS(4);
- return "The argument '" + symbols[0] + "' of the function '" + symbols[1] + "' requires a the subtype '" + symbols[2] + "' but the supertype '" + symbols[3] + "' was provided";
- } break;
- case DEPRECATED_KEYWORD: {
- CHECK_SYMBOLS(2);
- return "The '" + symbols[0] + "' keyword is deprecated and will be removed in a future release, please replace its uses by '" + symbols[1] + "'.";
- } break;
- case WARNING_MAX: break; // Can't happen, but silences warning
- }
- ERR_EXPLAIN("Invalid GDScript warning code: " + get_name_from_code(code));
- ERR_FAIL_V(String());
- #undef CHECK_SYMBOLS
- }
- String GDScriptWarning::get_name() const {
- return get_name_from_code(code);
- }
- String GDScriptWarning::get_name_from_code(Code p_code) {
- ERR_FAIL_COND_V(p_code < 0 || p_code >= WARNING_MAX, String());
- static const char *names[] = {
- "UNASSIGNED_VARIABLE",
- "UNASSIGNED_VARIABLE_OP_ASSIGN",
- "UNUSED_VARIABLE",
- "UNUSED_CLASS_VARIABLE",
- "UNUSED_ARGUMENT",
- "UNREACHABLE_CODE",
- "STANDALONE_EXPRESSION",
- "VOID_ASSIGNMENT",
- "NARROWING_CONVERSION",
- "FUNCTION_MAY_YIELD",
- "VARIABLE_CONFLICTS_FUNCTION",
- "FUNCTION_CONFLICTS_VARIABLE",
- "FUNCTION_CONFLICTS_CONSTANT",
- "INCOMPATIBLE_TERNARY",
- "UNUSED_SIGNAL",
- "RETURN_VALUE_DISCARDED",
- "PROPERTY_USED_AS_FUNCTION",
- "CONSTANT_USED_AS_FUNCTION",
- "FUNCTION_USED_AS_PROPERTY",
- "INTEGER_DIVISION",
- "UNSAFE_PROPERTY_ACCESS",
- "UNSAFE_METHOD_ACCESS",
- "UNSAFE_CAST",
- "UNSAFE_CALL_ARGUMENT",
- "DEPRECATED_KEYWORD",
- NULL
- };
- return names[(int)p_code];
- }
- GDScriptWarning::Code GDScriptWarning::get_code_from_name(const String &p_name) {
- for (int i = 0; i < WARNING_MAX; i++) {
- if (get_name_from_code((Code)i) == p_name) {
- return (Code)i;
- }
- }
- ERR_EXPLAIN("Invalid GDScript warning name: " + p_name);
- ERR_FAIL_V(WARNING_MAX);
- }
- #endif // DEBUG_ENABLED
- GDScriptLanguage::GDScriptLanguage() {
- calls = 0;
- ERR_FAIL_COND(singleton);
- singleton = this;
- strings._init = StaticCString::create("_init");
- strings._notification = StaticCString::create("_notification");
- strings._set = StaticCString::create("_set");
- strings._get = StaticCString::create("_get");
- strings._get_property_list = StaticCString::create("_get_property_list");
- strings._script_source = StaticCString::create("script/source");
- _debug_parse_err_line = -1;
- _debug_parse_err_file = "";
- #ifdef NO_THREADS
- lock = NULL;
- #else
- lock = Mutex::create();
- #endif
- profiling = false;
- script_frame_time = 0;
- _debug_call_stack_pos = 0;
- int dmcs = GLOBAL_DEF("debug/settings/gdscript/max_call_stack", 1024);
- ProjectSettings::get_singleton()->set_custom_property_info("debug/settings/gdscript/max_call_stack", PropertyInfo(Variant::INT, "debug/settings/gdscript/max_call_stack", PROPERTY_HINT_RANGE, "1024,4096,1,or_greater")); //minimum is 1024
- if (ScriptDebugger::get_singleton()) {
- //debugging enabled!
- _debug_max_call_stack = dmcs;
- _call_stack = memnew_arr(CallLevel, _debug_max_call_stack + 1);
- } else {
- _debug_max_call_stack = 0;
- _call_stack = NULL;
- }
- #ifdef DEBUG_ENABLED
- GLOBAL_DEF("debug/gdscript/warnings/enable", true);
- GLOBAL_DEF("debug/gdscript/warnings/treat_warnings_as_errors", false);
- GLOBAL_DEF("debug/gdscript/completion/autocomplete_setters_and_getters", false);
- for (int i = 0; i < (int)GDScriptWarning::WARNING_MAX; i++) {
- String warning = GDScriptWarning::get_name_from_code((GDScriptWarning::Code)i).to_lower();
- GLOBAL_DEF("debug/gdscript/warnings/" + warning, !warning.begins_with("unsafe_"));
- }
- #endif // DEBUG_ENABLED
- }
- GDScriptLanguage::~GDScriptLanguage() {
- if (lock) {
- memdelete(lock);
- lock = NULL;
- }
- if (_call_stack) {
- memdelete_arr(_call_stack);
- }
- singleton = NULL;
- }
- /*************** RESOURCE ***************/
- RES ResourceFormatLoaderGDScript::load(const String &p_path, const String &p_original_path, Error *r_error) {
- if (r_error)
- *r_error = ERR_FILE_CANT_OPEN;
- GDScript *script = memnew(GDScript);
- Ref<GDScript> scriptres(script);
- if (p_path.ends_with(".gde") || p_path.ends_with(".gdc")) {
- script->set_script_path(p_original_path); // script needs this.
- script->set_path(p_original_path);
- Error err = script->load_byte_code(p_path);
- ERR_FAIL_COND_V(err != OK, RES());
- } else {
- Error err = script->load_source_code(p_path);
- ERR_FAIL_COND_V(err != OK, RES());
- script->set_script_path(p_original_path); // script needs this.
- script->set_path(p_original_path);
- script->reload();
- }
- if (r_error)
- *r_error = OK;
- return scriptres;
- }
- void ResourceFormatLoaderGDScript::get_recognized_extensions(List<String> *p_extensions) const {
- p_extensions->push_back("gd");
- p_extensions->push_back("gdc");
- p_extensions->push_back("gde");
- }
- bool ResourceFormatLoaderGDScript::handles_type(const String &p_type) const {
- return (p_type == "Script" || p_type == "GDScript");
- }
- String ResourceFormatLoaderGDScript::get_resource_type(const String &p_path) const {
- String el = p_path.get_extension().to_lower();
- if (el == "gd" || el == "gdc" || el == "gde")
- return "GDScript";
- return "";
- }
- Error ResourceFormatSaverGDScript::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
- Ref<GDScript> sqscr = p_resource;
- ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
- String source = sqscr->get_source_code();
- Error err;
- FileAccess *file = FileAccess::open(p_path, FileAccess::WRITE, &err);
- if (err) {
- ERR_FAIL_COND_V(err, err);
- }
- file->store_string(source);
- if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
- memdelete(file);
- return ERR_CANT_CREATE;
- }
- file->close();
- memdelete(file);
- if (ScriptServer::is_reload_scripts_on_save_enabled()) {
- GDScriptLanguage::get_singleton()->reload_tool_script(p_resource, false);
- }
- return OK;
- }
- void ResourceFormatSaverGDScript::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
- if (Object::cast_to<GDScript>(*p_resource)) {
- p_extensions->push_back("gd");
- }
- }
- bool ResourceFormatSaverGDScript::recognize(const RES &p_resource) const {
- return Object::cast_to<GDScript>(*p_resource) != NULL;
- }
|