object.cpp 56 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090
  1. /*************************************************************************/
  2. /* object.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /*************************************************************************/
  30. #include "object.h"
  31. #include "core/class_db.h"
  32. #include "core/core_string_names.h"
  33. #include "core/message_queue.h"
  34. #include "core/object_rc.h"
  35. #include "core/os/os.h"
  36. #include "core/print_string.h"
  37. #include "core/resource.h"
  38. #include "core/script_language.h"
  39. #include "core/translation.h"
  40. #ifdef DEBUG_ENABLED
  41. struct _ObjectDebugLock {
  42. Object *obj;
  43. _ObjectDebugLock(Object *p_obj) {
  44. obj = p_obj;
  45. obj->_lock_index.ref();
  46. }
  47. ~_ObjectDebugLock() {
  48. obj->_lock_index.unref();
  49. }
  50. };
  51. #define OBJ_DEBUG_LOCK _ObjectDebugLock _debug_lock(this);
  52. #else
  53. #define OBJ_DEBUG_LOCK
  54. #endif
  55. PropertyInfo::operator Dictionary() const {
  56. Dictionary d;
  57. d["name"] = name;
  58. d["class_name"] = class_name;
  59. d["type"] = type;
  60. d["hint"] = hint;
  61. d["hint_string"] = hint_string;
  62. d["usage"] = usage;
  63. return d;
  64. }
  65. PropertyInfo PropertyInfo::from_dict(const Dictionary &p_dict) {
  66. PropertyInfo pi;
  67. if (p_dict.has("type")) {
  68. pi.type = Variant::Type(int(p_dict["type"]));
  69. }
  70. if (p_dict.has("name")) {
  71. pi.name = p_dict["name"];
  72. }
  73. if (p_dict.has("class_name")) {
  74. pi.class_name = p_dict["class_name"];
  75. }
  76. if (p_dict.has("hint")) {
  77. pi.hint = PropertyHint(int(p_dict["hint"]));
  78. }
  79. if (p_dict.has("hint_string")) {
  80. pi.hint_string = p_dict["hint_string"];
  81. }
  82. if (p_dict.has("usage")) {
  83. pi.usage = p_dict["usage"];
  84. }
  85. return pi;
  86. }
  87. Array convert_property_list(const List<PropertyInfo> *p_list) {
  88. Array va;
  89. for (const List<PropertyInfo>::Element *E = p_list->front(); E; E = E->next()) {
  90. va.push_back(Dictionary(E->get()));
  91. }
  92. return va;
  93. }
  94. MethodInfo::operator Dictionary() const {
  95. Dictionary d;
  96. d["name"] = name;
  97. d["args"] = convert_property_list(&arguments);
  98. Array da;
  99. for (int i = 0; i < default_arguments.size(); i++) {
  100. da.push_back(default_arguments[i]);
  101. }
  102. d["default_args"] = da;
  103. d["flags"] = flags;
  104. d["id"] = id;
  105. Dictionary r = return_val;
  106. d["return"] = r;
  107. return d;
  108. }
  109. MethodInfo::MethodInfo() :
  110. flags(METHOD_FLAG_NORMAL),
  111. id(0) {
  112. }
  113. MethodInfo MethodInfo::from_dict(const Dictionary &p_dict) {
  114. MethodInfo mi;
  115. if (p_dict.has("name")) {
  116. mi.name = p_dict["name"];
  117. }
  118. Array args;
  119. if (p_dict.has("args")) {
  120. args = p_dict["args"];
  121. }
  122. for (int i = 0; i < args.size(); i++) {
  123. Dictionary d = args[i];
  124. mi.arguments.push_back(PropertyInfo::from_dict(d));
  125. }
  126. Array defargs;
  127. if (p_dict.has("default_args")) {
  128. defargs = p_dict["default_args"];
  129. }
  130. for (int i = 0; i < defargs.size(); i++) {
  131. mi.default_arguments.push_back(defargs[i]);
  132. }
  133. if (p_dict.has("return")) {
  134. mi.return_val = PropertyInfo::from_dict(p_dict["return"]);
  135. }
  136. if (p_dict.has("flags")) {
  137. mi.flags = p_dict["flags"];
  138. }
  139. return mi;
  140. }
  141. MethodInfo::MethodInfo(const String &p_name) :
  142. name(p_name),
  143. flags(METHOD_FLAG_NORMAL),
  144. id(0) {
  145. }
  146. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1) :
  147. name(p_name),
  148. flags(METHOD_FLAG_NORMAL),
  149. id(0) {
  150. arguments.push_back(p_param1);
  151. }
  152. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2) :
  153. name(p_name),
  154. flags(METHOD_FLAG_NORMAL),
  155. id(0) {
  156. arguments.push_back(p_param1);
  157. arguments.push_back(p_param2);
  158. }
  159. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3) :
  160. name(p_name),
  161. flags(METHOD_FLAG_NORMAL),
  162. id(0) {
  163. arguments.push_back(p_param1);
  164. arguments.push_back(p_param2);
  165. arguments.push_back(p_param3);
  166. }
  167. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4) :
  168. name(p_name),
  169. flags(METHOD_FLAG_NORMAL),
  170. id(0) {
  171. arguments.push_back(p_param1);
  172. arguments.push_back(p_param2);
  173. arguments.push_back(p_param3);
  174. arguments.push_back(p_param4);
  175. }
  176. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4, const PropertyInfo &p_param5) :
  177. name(p_name),
  178. flags(METHOD_FLAG_NORMAL),
  179. id(0) {
  180. arguments.push_back(p_param1);
  181. arguments.push_back(p_param2);
  182. arguments.push_back(p_param3);
  183. arguments.push_back(p_param4);
  184. arguments.push_back(p_param5);
  185. }
  186. MethodInfo::MethodInfo(Variant::Type ret) :
  187. flags(METHOD_FLAG_NORMAL),
  188. id(0) {
  189. return_val.type = ret;
  190. }
  191. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name) :
  192. name(p_name),
  193. flags(METHOD_FLAG_NORMAL),
  194. id(0) {
  195. return_val.type = ret;
  196. }
  197. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1) :
  198. name(p_name),
  199. flags(METHOD_FLAG_NORMAL),
  200. id(0) {
  201. return_val.type = ret;
  202. arguments.push_back(p_param1);
  203. }
  204. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2) :
  205. name(p_name),
  206. flags(METHOD_FLAG_NORMAL),
  207. id(0) {
  208. return_val.type = ret;
  209. arguments.push_back(p_param1);
  210. arguments.push_back(p_param2);
  211. }
  212. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3) :
  213. name(p_name),
  214. flags(METHOD_FLAG_NORMAL),
  215. id(0) {
  216. return_val.type = ret;
  217. arguments.push_back(p_param1);
  218. arguments.push_back(p_param2);
  219. arguments.push_back(p_param3);
  220. }
  221. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4) :
  222. name(p_name),
  223. flags(METHOD_FLAG_NORMAL),
  224. id(0) {
  225. return_val.type = ret;
  226. arguments.push_back(p_param1);
  227. arguments.push_back(p_param2);
  228. arguments.push_back(p_param3);
  229. arguments.push_back(p_param4);
  230. }
  231. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4, const PropertyInfo &p_param5) :
  232. name(p_name),
  233. flags(METHOD_FLAG_NORMAL),
  234. id(0) {
  235. return_val.type = ret;
  236. arguments.push_back(p_param1);
  237. arguments.push_back(p_param2);
  238. arguments.push_back(p_param3);
  239. arguments.push_back(p_param4);
  240. arguments.push_back(p_param5);
  241. }
  242. MethodInfo::MethodInfo(const PropertyInfo &p_ret, const String &p_name) :
  243. name(p_name),
  244. return_val(p_ret),
  245. flags(METHOD_FLAG_NORMAL),
  246. id(0) {
  247. }
  248. MethodInfo::MethodInfo(const PropertyInfo &p_ret, const String &p_name, const PropertyInfo &p_param1) :
  249. name(p_name),
  250. return_val(p_ret),
  251. flags(METHOD_FLAG_NORMAL),
  252. id(0) {
  253. arguments.push_back(p_param1);
  254. }
  255. MethodInfo::MethodInfo(const PropertyInfo &p_ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2) :
  256. name(p_name),
  257. return_val(p_ret),
  258. flags(METHOD_FLAG_NORMAL),
  259. id(0) {
  260. arguments.push_back(p_param1);
  261. arguments.push_back(p_param2);
  262. }
  263. MethodInfo::MethodInfo(const PropertyInfo &p_ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3) :
  264. name(p_name),
  265. return_val(p_ret),
  266. flags(METHOD_FLAG_NORMAL),
  267. id(0) {
  268. arguments.push_back(p_param1);
  269. arguments.push_back(p_param2);
  270. arguments.push_back(p_param3);
  271. }
  272. MethodInfo::MethodInfo(const PropertyInfo &p_ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4) :
  273. name(p_name),
  274. return_val(p_ret),
  275. flags(METHOD_FLAG_NORMAL),
  276. id(0) {
  277. arguments.push_back(p_param1);
  278. arguments.push_back(p_param2);
  279. arguments.push_back(p_param3);
  280. arguments.push_back(p_param4);
  281. }
  282. MethodInfo::MethodInfo(const PropertyInfo &p_ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4, const PropertyInfo &p_param5) :
  283. name(p_name),
  284. return_val(p_ret),
  285. flags(METHOD_FLAG_NORMAL),
  286. id(0) {
  287. arguments.push_back(p_param1);
  288. arguments.push_back(p_param2);
  289. arguments.push_back(p_param3);
  290. arguments.push_back(p_param4);
  291. arguments.push_back(p_param5);
  292. }
  293. Object::Connection::operator Variant() const {
  294. Dictionary d;
  295. d["source"] = source;
  296. d["signal"] = signal;
  297. d["target"] = target;
  298. d["method"] = method;
  299. d["flags"] = flags;
  300. d["binds"] = binds;
  301. return d;
  302. }
  303. bool Object::Connection::operator<(const Connection &p_conn) const {
  304. if (source == p_conn.source) {
  305. if (signal == p_conn.signal) {
  306. if (target == p_conn.target) {
  307. return method < p_conn.method;
  308. } else {
  309. return target->get_instance_id() < p_conn.target->get_instance_id();
  310. }
  311. } else {
  312. return signal < p_conn.signal;
  313. }
  314. } else {
  315. return source->get_instance_id() < p_conn.source->get_instance_id();
  316. }
  317. }
  318. Object::Connection::Connection(const Variant &p_variant) {
  319. Dictionary d = p_variant;
  320. if (d.has("source")) {
  321. source = d["source"];
  322. }
  323. if (d.has("signal")) {
  324. signal = d["signal"];
  325. }
  326. if (d.has("target")) {
  327. target = d["target"];
  328. }
  329. if (d.has("method")) {
  330. method = d["method"];
  331. }
  332. if (d.has("flags")) {
  333. flags = d["flags"];
  334. }
  335. if (d.has("binds")) {
  336. binds = d["binds"];
  337. }
  338. }
  339. bool Object::_predelete() {
  340. _predelete_ok = 1;
  341. notification(NOTIFICATION_PREDELETE, true);
  342. if (_predelete_ok) {
  343. _class_ptr = nullptr; //must restore so destructors can access class ptr correctly
  344. }
  345. return _predelete_ok;
  346. }
  347. void Object::_postinitialize() {
  348. _class_ptr = _get_class_namev();
  349. _initialize_classv();
  350. notification(NOTIFICATION_POSTINITIALIZE);
  351. }
  352. void Object::get_valid_parents_static(List<String> *p_parents) {
  353. }
  354. void Object::_get_valid_parents_static(List<String> *p_parents) {
  355. }
  356. void Object::set(const StringName &p_name, const Variant &p_value, bool *r_valid) {
  357. #ifdef TOOLS_ENABLED
  358. _edited = true;
  359. #endif
  360. if (script_instance) {
  361. if (script_instance->set(p_name, p_value)) {
  362. if (r_valid) {
  363. *r_valid = true;
  364. }
  365. return;
  366. }
  367. }
  368. //try built-in setgetter
  369. {
  370. if (ClassDB::set_property(this, p_name, p_value, r_valid)) {
  371. /*
  372. if (r_valid)
  373. *r_valid=true;
  374. */
  375. return;
  376. }
  377. }
  378. if (p_name == CoreStringNames::get_singleton()->_script) {
  379. set_script(p_value);
  380. if (r_valid) {
  381. *r_valid = true;
  382. }
  383. return;
  384. } else if (p_name == CoreStringNames::get_singleton()->_meta) {
  385. //set_meta(p_name,p_value);
  386. metadata = p_value.duplicate();
  387. if (r_valid) {
  388. *r_valid = true;
  389. }
  390. return;
  391. }
  392. //something inside the object... :|
  393. bool success = _setv(p_name, p_value);
  394. if (success) {
  395. if (r_valid) {
  396. *r_valid = true;
  397. }
  398. return;
  399. }
  400. {
  401. bool valid;
  402. setvar(p_name, p_value, &valid);
  403. if (valid) {
  404. if (r_valid) {
  405. *r_valid = true;
  406. }
  407. return;
  408. }
  409. }
  410. #ifdef TOOLS_ENABLED
  411. if (script_instance) {
  412. bool valid;
  413. script_instance->property_set_fallback(p_name, p_value, &valid);
  414. if (valid) {
  415. if (r_valid) {
  416. *r_valid = true;
  417. }
  418. return;
  419. }
  420. }
  421. #endif
  422. if (r_valid) {
  423. *r_valid = false;
  424. }
  425. }
  426. Variant Object::get(const StringName &p_name, bool *r_valid) const {
  427. Variant ret;
  428. if (script_instance) {
  429. if (script_instance->get(p_name, ret)) {
  430. if (r_valid) {
  431. *r_valid = true;
  432. }
  433. return ret;
  434. }
  435. }
  436. //try built-in setgetter
  437. {
  438. if (ClassDB::get_property(const_cast<Object *>(this), p_name, ret)) {
  439. if (r_valid) {
  440. *r_valid = true;
  441. }
  442. return ret;
  443. }
  444. }
  445. if (p_name == CoreStringNames::get_singleton()->_script) {
  446. ret = get_script();
  447. if (r_valid) {
  448. *r_valid = true;
  449. }
  450. return ret;
  451. } else if (p_name == CoreStringNames::get_singleton()->_meta) {
  452. ret = metadata;
  453. if (r_valid) {
  454. *r_valid = true;
  455. }
  456. return ret;
  457. } else {
  458. //something inside the object... :|
  459. bool success = _getv(p_name, ret);
  460. if (success) {
  461. if (r_valid) {
  462. *r_valid = true;
  463. }
  464. return ret;
  465. }
  466. //if nothing else, use getvar
  467. {
  468. bool valid;
  469. ret = getvar(p_name, &valid);
  470. if (valid) {
  471. if (r_valid) {
  472. *r_valid = true;
  473. }
  474. return ret;
  475. }
  476. }
  477. #ifdef TOOLS_ENABLED
  478. if (script_instance) {
  479. bool valid;
  480. ret = script_instance->property_get_fallback(p_name, &valid);
  481. if (valid) {
  482. if (r_valid) {
  483. *r_valid = true;
  484. }
  485. return ret;
  486. }
  487. }
  488. #endif
  489. if (r_valid) {
  490. *r_valid = false;
  491. }
  492. return Variant();
  493. }
  494. }
  495. void Object::set_indexed(const Vector<StringName> &p_names, const Variant &p_value, bool *r_valid) {
  496. if (p_names.empty()) {
  497. if (r_valid) {
  498. *r_valid = false;
  499. }
  500. return;
  501. }
  502. if (p_names.size() == 1) {
  503. set(p_names[0], p_value, r_valid);
  504. return;
  505. }
  506. bool valid = false;
  507. if (!r_valid) {
  508. r_valid = &valid;
  509. }
  510. List<Variant> value_stack;
  511. value_stack.push_back(get(p_names[0], r_valid));
  512. if (!*r_valid) {
  513. value_stack.clear();
  514. return;
  515. }
  516. for (int i = 1; i < p_names.size() - 1; i++) {
  517. value_stack.push_back(value_stack.back()->get().get_named(p_names[i], r_valid));
  518. if (!*r_valid) {
  519. value_stack.clear();
  520. return;
  521. }
  522. }
  523. value_stack.push_back(p_value); // p_names[p_names.size() - 1]
  524. for (int i = p_names.size() - 1; i > 0; i--) {
  525. value_stack.back()->prev()->get().set_named(p_names[i], value_stack.back()->get(), r_valid);
  526. value_stack.pop_back();
  527. if (!*r_valid) {
  528. value_stack.clear();
  529. return;
  530. }
  531. }
  532. set(p_names[0], value_stack.back()->get(), r_valid);
  533. value_stack.pop_back();
  534. ERR_FAIL_COND(!value_stack.empty());
  535. }
  536. Variant Object::get_indexed(const Vector<StringName> &p_names, bool *r_valid) const {
  537. if (p_names.empty()) {
  538. if (r_valid) {
  539. *r_valid = false;
  540. }
  541. return Variant();
  542. }
  543. bool valid = false;
  544. Variant current_value = get(p_names[0], &valid);
  545. for (int i = 1; i < p_names.size(); i++) {
  546. current_value = current_value.get_named(p_names[i], &valid);
  547. if (!valid) {
  548. break;
  549. }
  550. }
  551. if (r_valid) {
  552. *r_valid = valid;
  553. }
  554. return current_value;
  555. }
  556. void Object::get_property_list(List<PropertyInfo> *p_list, bool p_reversed) const {
  557. if (script_instance && p_reversed) {
  558. p_list->push_back(PropertyInfo(Variant::NIL, "Script Variables", PROPERTY_HINT_NONE, String(), PROPERTY_USAGE_CATEGORY));
  559. script_instance->get_property_list(p_list);
  560. }
  561. _get_property_listv(p_list, p_reversed);
  562. if (!is_class("Script")) { // can still be set, but this is for userfriendlyness
  563. p_list->push_back(PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script", PROPERTY_USAGE_DEFAULT));
  564. }
  565. if (!metadata.empty()) {
  566. p_list->push_back(PropertyInfo(Variant::DICTIONARY, "__meta__", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_INTERNAL));
  567. }
  568. if (script_instance && !p_reversed) {
  569. p_list->push_back(PropertyInfo(Variant::NIL, "Script Variables", PROPERTY_HINT_NONE, String(), PROPERTY_USAGE_CATEGORY));
  570. script_instance->get_property_list(p_list);
  571. }
  572. }
  573. void Object::_validate_property(PropertyInfo &property) const {
  574. }
  575. void Object::get_method_list(List<MethodInfo> *p_list) const {
  576. ClassDB::get_method_list(get_class_name(), p_list);
  577. if (script_instance) {
  578. script_instance->get_method_list(p_list);
  579. }
  580. }
  581. Variant Object::_call_bind(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  582. if (p_argcount < 1) {
  583. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  584. r_error.argument = 0;
  585. return Variant();
  586. }
  587. if (p_args[0]->get_type() != Variant::STRING) {
  588. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  589. r_error.argument = 0;
  590. r_error.expected = Variant::STRING;
  591. return Variant();
  592. }
  593. StringName method = *p_args[0];
  594. return call(method, &p_args[1], p_argcount - 1, r_error);
  595. }
  596. Variant Object::_call_deferred_bind(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  597. if (p_argcount < 1) {
  598. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  599. r_error.argument = 0;
  600. return Variant();
  601. }
  602. if (p_args[0]->get_type() != Variant::STRING) {
  603. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  604. r_error.argument = 0;
  605. r_error.expected = Variant::STRING;
  606. return Variant();
  607. }
  608. r_error.error = Variant::CallError::CALL_OK;
  609. StringName method = *p_args[0];
  610. MessageQueue::get_singleton()->push_call(get_instance_id(), method, &p_args[1], p_argcount - 1, true);
  611. return Variant();
  612. }
  613. #ifdef DEBUG_ENABLED
  614. static void _test_call_error(const StringName &p_func, const Variant::CallError &error) {
  615. switch (error.error) {
  616. case Variant::CallError::CALL_OK:
  617. case Variant::CallError::CALL_ERROR_INVALID_METHOD:
  618. break;
  619. case Variant::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  620. ERR_FAIL_MSG("Error calling function: " + String(p_func) + " - Invalid type for argument " + itos(error.argument) + ", expected " + Variant::get_type_name(error.expected) + ".");
  621. break;
  622. }
  623. case Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS: {
  624. ERR_FAIL_MSG("Error calling function: " + String(p_func) + " - Too many arguments, expected " + itos(error.argument) + ".");
  625. break;
  626. }
  627. case Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS: {
  628. ERR_FAIL_MSG("Error calling function: " + String(p_func) + " - Too few arguments, expected " + itos(error.argument) + ".");
  629. break;
  630. }
  631. case Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL:
  632. break;
  633. }
  634. }
  635. #else
  636. #define _test_call_error(m_str, m_err)
  637. #endif
  638. void Object::call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount) {
  639. if (p_method == CoreStringNames::get_singleton()->_free) {
  640. #ifdef DEBUG_ENABLED
  641. ERR_FAIL_COND_MSG(Object::cast_to<Reference>(this), "Can't 'free' a reference.");
  642. ERR_FAIL_COND_MSG(_lock_index.get() > 1, "Object is locked and can't be freed.");
  643. #endif
  644. //must be here, must be before everything,
  645. memdelete(this);
  646. return;
  647. }
  648. //Variant ret;
  649. OBJ_DEBUG_LOCK
  650. Variant::CallError error;
  651. if (script_instance) {
  652. script_instance->call_multilevel(p_method, p_args, p_argcount);
  653. //_test_call_error(p_method,error);
  654. }
  655. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  656. if (method) {
  657. method->call(this, p_args, p_argcount, error);
  658. _test_call_error(p_method, error);
  659. }
  660. }
  661. void Object::call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount) {
  662. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  663. Variant::CallError error;
  664. OBJ_DEBUG_LOCK
  665. if (method) {
  666. method->call(this, p_args, p_argcount, error);
  667. _test_call_error(p_method, error);
  668. }
  669. //Variant ret;
  670. if (script_instance) {
  671. script_instance->call_multilevel_reversed(p_method, p_args, p_argcount);
  672. //_test_call_error(p_method,error);
  673. }
  674. }
  675. bool Object::has_method(const StringName &p_method) const {
  676. if (p_method == CoreStringNames::get_singleton()->_free) {
  677. return true;
  678. }
  679. if (script_instance && script_instance->has_method(p_method)) {
  680. return true;
  681. }
  682. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  683. return method != nullptr;
  684. }
  685. Variant Object::getvar(const Variant &p_key, bool *r_valid) const {
  686. if (r_valid) {
  687. *r_valid = false;
  688. }
  689. return Variant();
  690. }
  691. void Object::setvar(const Variant &p_key, const Variant &p_value, bool *r_valid) {
  692. if (r_valid) {
  693. *r_valid = false;
  694. }
  695. }
  696. Variant Object::callv(const StringName &p_method, const Array &p_args) {
  697. const Variant **argptrs = nullptr;
  698. if (p_args.size() > 0) {
  699. argptrs = (const Variant **)alloca(sizeof(Variant *) * p_args.size());
  700. for (int i = 0; i < p_args.size(); i++) {
  701. argptrs[i] = &p_args[i];
  702. }
  703. }
  704. Variant::CallError ce;
  705. Variant ret = call(p_method, argptrs, p_args.size(), ce);
  706. if (ce.error != Variant::CallError::CALL_OK) {
  707. ERR_FAIL_V_MSG(Variant(), "Error calling method from 'callv': " + Variant::get_call_error_text(this, p_method, argptrs, p_args.size(), ce) + ".");
  708. }
  709. return ret;
  710. }
  711. Variant Object::call(const StringName &p_name, VARIANT_ARG_DECLARE) {
  712. VARIANT_ARGPTRS;
  713. int argc = 0;
  714. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  715. if (argptr[i]->get_type() == Variant::NIL) {
  716. break;
  717. }
  718. argc++;
  719. }
  720. Variant::CallError error;
  721. Variant ret = call(p_name, argptr, argc, error);
  722. return ret;
  723. }
  724. void Object::call_multilevel(const StringName &p_name, VARIANT_ARG_DECLARE) {
  725. VARIANT_ARGPTRS;
  726. int argc = 0;
  727. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  728. if (argptr[i]->get_type() == Variant::NIL) {
  729. break;
  730. }
  731. argc++;
  732. }
  733. //Variant::CallError error;
  734. call_multilevel(p_name, argptr, argc);
  735. }
  736. Variant Object::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  737. r_error.error = Variant::CallError::CALL_OK;
  738. if (p_method == CoreStringNames::get_singleton()->_free) {
  739. //free must be here, before anything, always ready
  740. #ifdef DEBUG_ENABLED
  741. if (p_argcount != 0) {
  742. r_error.argument = 0;
  743. r_error.error = Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  744. return Variant();
  745. }
  746. if (Object::cast_to<Reference>(this)) {
  747. r_error.argument = 0;
  748. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  749. ERR_FAIL_V_MSG(Variant(), "Can't 'free' a reference.");
  750. }
  751. if (_lock_index.get() > 1) {
  752. r_error.argument = 0;
  753. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  754. ERR_FAIL_V_MSG(Variant(), "Object is locked and can't be freed.");
  755. }
  756. #endif
  757. //must be here, must be before everything,
  758. memdelete(this);
  759. r_error.error = Variant::CallError::CALL_OK;
  760. return Variant();
  761. }
  762. Variant ret;
  763. OBJ_DEBUG_LOCK
  764. if (script_instance) {
  765. ret = script_instance->call(p_method, p_args, p_argcount, r_error);
  766. //force jumptable
  767. switch (r_error.error) {
  768. case Variant::CallError::CALL_OK:
  769. return ret;
  770. case Variant::CallError::CALL_ERROR_INVALID_METHOD:
  771. break;
  772. case Variant::CallError::CALL_ERROR_INVALID_ARGUMENT:
  773. case Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  774. case Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  775. return ret;
  776. case Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL: {
  777. }
  778. }
  779. }
  780. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  781. if (method) {
  782. ret = method->call(this, p_args, p_argcount, r_error);
  783. } else {
  784. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  785. }
  786. return ret;
  787. }
  788. void Object::notification(int p_notification, bool p_reversed) {
  789. _notificationv(p_notification, p_reversed);
  790. if (script_instance) {
  791. script_instance->notification(p_notification);
  792. }
  793. }
  794. String Object::to_string() {
  795. if (script_instance) {
  796. bool valid;
  797. String ret = script_instance->to_string(&valid);
  798. if (valid) {
  799. return ret;
  800. }
  801. }
  802. return "[" + get_class() + ":" + itos(get_instance_id()) + "]";
  803. }
  804. void Object::_changed_callback(Object *p_changed, const char *p_prop) {
  805. }
  806. void Object::add_change_receptor(Object *p_receptor) {
  807. change_receptors.insert(p_receptor);
  808. }
  809. void Object::remove_change_receptor(Object *p_receptor) {
  810. change_receptors.erase(p_receptor);
  811. }
  812. void Object::property_list_changed_notify() {
  813. _change_notify();
  814. }
  815. void Object::cancel_delete() {
  816. _predelete_ok = true;
  817. }
  818. ObjectRC *Object::_use_rc() {
  819. // The RC object is lazily created the first time it's requested;
  820. // that way, there's no need to allocate and release it at all if this Object
  821. // is not being referred by any Variant at all.
  822. // Although when dealing with Objects from multiple threads some locking
  823. // mechanism should be used, this at least makes safe the case of first
  824. // assignment.
  825. ObjectRC *rc = nullptr;
  826. ObjectRC *const creating = reinterpret_cast<ObjectRC *>(1);
  827. if (unlikely(_rc.compare_exchange_strong(rc, creating, std::memory_order_acq_rel))) {
  828. // Not created yet
  829. rc = memnew(ObjectRC(this));
  830. _rc.store(rc, std::memory_order_release);
  831. return rc;
  832. }
  833. // Spin-wait until we know it's created (or just return if it's already created)
  834. for (;;) {
  835. if (likely(rc != creating)) {
  836. rc->increment();
  837. return rc;
  838. }
  839. rc = _rc.load(std::memory_order_acquire);
  840. }
  841. }
  842. void Object::set_script_and_instance(const RefPtr &p_script, ScriptInstance *p_instance) {
  843. //this function is not meant to be used in any of these ways
  844. ERR_FAIL_COND(p_script.is_null());
  845. ERR_FAIL_COND(!p_instance);
  846. ERR_FAIL_COND(script_instance != nullptr || !script.is_null());
  847. script = p_script;
  848. script_instance = p_instance;
  849. }
  850. void Object::set_script(const RefPtr &p_script) {
  851. if (script == p_script) {
  852. return;
  853. }
  854. if (script_instance) {
  855. memdelete(script_instance);
  856. script_instance = nullptr;
  857. }
  858. script = p_script;
  859. Ref<Script> s(script);
  860. if (!s.is_null()) {
  861. if (s->can_instance()) {
  862. OBJ_DEBUG_LOCK
  863. script_instance = s->instance_create(this);
  864. } else if (Engine::get_singleton()->is_editor_hint()) {
  865. OBJ_DEBUG_LOCK
  866. script_instance = s->placeholder_instance_create(this);
  867. }
  868. }
  869. _change_notify(); //scripts may add variables, so refresh is desired
  870. emit_signal(CoreStringNames::get_singleton()->script_changed);
  871. }
  872. void Object::set_script_instance(ScriptInstance *p_instance) {
  873. if (script_instance == p_instance) {
  874. return;
  875. }
  876. if (script_instance) {
  877. memdelete(script_instance);
  878. }
  879. script_instance = p_instance;
  880. if (p_instance) {
  881. script = p_instance->get_script().get_ref_ptr();
  882. } else {
  883. script = RefPtr();
  884. }
  885. }
  886. RefPtr Object::get_script() const {
  887. return script;
  888. }
  889. bool Object::has_meta(const String &p_name) const {
  890. return metadata.has(p_name);
  891. }
  892. void Object::set_meta(const String &p_name, const Variant &p_value) {
  893. if (p_value.get_type() == Variant::NIL) {
  894. metadata.erase(p_name);
  895. return;
  896. };
  897. metadata[p_name] = p_value;
  898. }
  899. Variant Object::get_meta(const String &p_name) const {
  900. ERR_FAIL_COND_V(!metadata.has(p_name), Variant());
  901. return metadata[p_name];
  902. }
  903. void Object::remove_meta(const String &p_name) {
  904. metadata.erase(p_name);
  905. }
  906. Array Object::_get_property_list_bind() const {
  907. List<PropertyInfo> lpi;
  908. get_property_list(&lpi);
  909. return convert_property_list(&lpi);
  910. }
  911. Array Object::_get_method_list_bind() const {
  912. List<MethodInfo> ml;
  913. get_method_list(&ml);
  914. Array ret;
  915. for (List<MethodInfo>::Element *E = ml.front(); E; E = E->next()) {
  916. Dictionary d = E->get();
  917. //va.push_back(d);
  918. ret.push_back(d);
  919. }
  920. return ret;
  921. }
  922. PoolVector<String> Object::_get_meta_list_bind() const {
  923. PoolVector<String> _metaret;
  924. List<Variant> keys;
  925. metadata.get_key_list(&keys);
  926. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  927. _metaret.push_back(E->get());
  928. }
  929. return _metaret;
  930. }
  931. void Object::get_meta_list(List<String> *p_list) const {
  932. List<Variant> keys;
  933. metadata.get_key_list(&keys);
  934. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  935. p_list->push_back(E->get());
  936. }
  937. }
  938. void Object::add_user_signal(const MethodInfo &p_signal) {
  939. ERR_FAIL_COND_MSG(p_signal.name == "", "Signal name cannot be empty.");
  940. ERR_FAIL_COND_MSG(ClassDB::has_signal(get_class_name(), p_signal.name), "User signal's name conflicts with a built-in signal of '" + get_class_name() + "'.");
  941. ERR_FAIL_COND_MSG(signal_map.has(p_signal.name), "Trying to add already existing signal '" + p_signal.name + "'.");
  942. Signal s;
  943. s.user = p_signal;
  944. signal_map[p_signal.name] = s;
  945. }
  946. bool Object::_has_user_signal(const StringName &p_name) const {
  947. if (!signal_map.has(p_name)) {
  948. return false;
  949. }
  950. return signal_map[p_name].user.name.length() > 0;
  951. }
  952. struct _ObjectSignalDisconnectData {
  953. StringName signal;
  954. Object *target;
  955. StringName method;
  956. };
  957. Variant Object::_emit_signal(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  958. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  959. ERR_FAIL_COND_V(p_argcount < 1, Variant());
  960. if (p_args[0]->get_type() != Variant::STRING) {
  961. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  962. r_error.argument = 0;
  963. r_error.expected = Variant::STRING;
  964. ERR_FAIL_COND_V(p_args[0]->get_type() != Variant::STRING, Variant());
  965. }
  966. r_error.error = Variant::CallError::CALL_OK;
  967. StringName signal = *p_args[0];
  968. const Variant **args = nullptr;
  969. int argc = p_argcount - 1;
  970. if (argc) {
  971. args = &p_args[1];
  972. }
  973. emit_signal(signal, args, argc);
  974. return Variant();
  975. }
  976. Error Object::emit_signal(const StringName &p_name, const Variant **p_args, int p_argcount) {
  977. if (_block_signals) {
  978. return ERR_CANT_ACQUIRE_RESOURCE; //no emit, signals blocked
  979. }
  980. Signal *s = signal_map.getptr(p_name);
  981. if (!s) {
  982. #ifdef DEBUG_ENABLED
  983. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_name);
  984. //check in script
  985. ERR_FAIL_COND_V_MSG(!signal_is_valid && !script.is_null() && !Ref<Script>(script)->has_script_signal(p_name), ERR_UNAVAILABLE, "Can't emit non-existing signal " + String("\"") + p_name + "\".");
  986. #endif
  987. //not connected? just return
  988. return ERR_UNAVAILABLE;
  989. }
  990. List<_ObjectSignalDisconnectData> disconnect_data;
  991. //copy on write will ensure that disconnecting the signal or even deleting the object will not affect the signal calling.
  992. //this happens automatically and will not change the performance of calling.
  993. //awesome, isn't it?
  994. VMap<Signal::Target, Signal::Slot> slot_map = s->slot_map;
  995. int ssize = slot_map.size();
  996. OBJ_DEBUG_LOCK
  997. Vector<const Variant *> bind_mem;
  998. Error err = OK;
  999. for (int i = 0; i < ssize; i++) {
  1000. const Connection &c = slot_map.getv(i).conn;
  1001. Object *target = ObjectDB::get_instance(slot_map.getk(i)._id);
  1002. if (!target) {
  1003. // Target might have been deleted during signal callback, this is expected and OK.
  1004. continue;
  1005. }
  1006. const Variant **args = p_args;
  1007. int argc = p_argcount;
  1008. if (c.binds.size()) {
  1009. //handle binds
  1010. bind_mem.resize(p_argcount + c.binds.size());
  1011. for (int j = 0; j < p_argcount; j++) {
  1012. bind_mem.write[j] = p_args[j];
  1013. }
  1014. for (int j = 0; j < c.binds.size(); j++) {
  1015. bind_mem.write[p_argcount + j] = &c.binds[j];
  1016. }
  1017. args = (const Variant **)bind_mem.ptr();
  1018. argc = bind_mem.size();
  1019. }
  1020. if (c.flags & CONNECT_DEFERRED) {
  1021. MessageQueue::get_singleton()->push_call(target->get_instance_id(), c.method, args, argc, true);
  1022. } else {
  1023. Variant::CallError ce;
  1024. _emitting = true;
  1025. target->call(c.method, args, argc, ce);
  1026. _emitting = false;
  1027. if (ce.error != Variant::CallError::CALL_OK) {
  1028. #ifdef DEBUG_ENABLED
  1029. if (c.flags & CONNECT_PERSIST && Engine::get_singleton()->is_editor_hint() && (script.is_null() || !Ref<Script>(script)->is_tool())) {
  1030. continue;
  1031. }
  1032. #endif
  1033. if (ce.error == Variant::CallError::CALL_ERROR_INVALID_METHOD && !ClassDB::class_exists(target->get_class_name())) {
  1034. //most likely object is not initialized yet, do not throw error.
  1035. } else {
  1036. ERR_PRINT("Error calling method from signal '" + String(p_name) + "': " + Variant::get_call_error_text(target, c.method, args, argc, ce) + ".");
  1037. err = ERR_METHOD_NOT_FOUND;
  1038. }
  1039. }
  1040. }
  1041. bool disconnect = c.flags & CONNECT_ONESHOT;
  1042. #ifdef TOOLS_ENABLED
  1043. if (disconnect && (c.flags & CONNECT_PERSIST) && Engine::get_singleton()->is_editor_hint()) {
  1044. //this signal was connected from the editor, and is being edited. just don't disconnect for now
  1045. disconnect = false;
  1046. }
  1047. #endif
  1048. if (disconnect) {
  1049. _ObjectSignalDisconnectData dd;
  1050. dd.signal = p_name;
  1051. dd.target = target;
  1052. dd.method = c.method;
  1053. disconnect_data.push_back(dd);
  1054. }
  1055. }
  1056. while (!disconnect_data.empty()) {
  1057. const _ObjectSignalDisconnectData &dd = disconnect_data.front()->get();
  1058. disconnect(dd.signal, dd.target, dd.method);
  1059. disconnect_data.pop_front();
  1060. }
  1061. return err;
  1062. }
  1063. Error Object::emit_signal(const StringName &p_name, VARIANT_ARG_DECLARE) {
  1064. VARIANT_ARGPTRS;
  1065. int argc = 0;
  1066. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  1067. if (argptr[i]->get_type() == Variant::NIL) {
  1068. break;
  1069. }
  1070. argc++;
  1071. }
  1072. return emit_signal(p_name, argptr, argc);
  1073. }
  1074. void Object::_add_user_signal(const String &p_name, const Array &p_args) {
  1075. // this version of add_user_signal is meant to be used from scripts or external apis
  1076. // without access to ADD_SIGNAL in bind_methods
  1077. // added events are per instance, as opposed to the other ones, which are global
  1078. MethodInfo mi;
  1079. mi.name = p_name;
  1080. for (int i = 0; i < p_args.size(); i++) {
  1081. Dictionary d = p_args[i];
  1082. PropertyInfo param;
  1083. if (d.has("name")) {
  1084. param.name = d["name"];
  1085. }
  1086. if (d.has("type")) {
  1087. param.type = (Variant::Type)(int)d["type"];
  1088. }
  1089. mi.arguments.push_back(param);
  1090. }
  1091. add_user_signal(mi);
  1092. }
  1093. Array Object::_get_signal_list() const {
  1094. List<MethodInfo> signal_list;
  1095. get_signal_list(&signal_list);
  1096. Array ret;
  1097. for (List<MethodInfo>::Element *E = signal_list.front(); E; E = E->next()) {
  1098. ret.push_back(Dictionary(E->get()));
  1099. }
  1100. return ret;
  1101. }
  1102. Array Object::_get_signal_connection_list(const String &p_signal) const {
  1103. List<Connection> conns;
  1104. get_all_signal_connections(&conns);
  1105. Array ret;
  1106. for (List<Connection>::Element *E = conns.front(); E; E = E->next()) {
  1107. Connection &c = E->get();
  1108. if (c.signal == p_signal) {
  1109. Dictionary rc;
  1110. rc["signal"] = c.signal;
  1111. rc["method"] = c.method;
  1112. rc["source"] = c.source;
  1113. rc["target"] = c.target;
  1114. rc["binds"] = c.binds;
  1115. rc["flags"] = c.flags;
  1116. ret.push_back(rc);
  1117. }
  1118. }
  1119. return ret;
  1120. }
  1121. Array Object::_get_incoming_connections() const {
  1122. Array ret;
  1123. int connections_amount = connections.size();
  1124. for (int idx_conn = 0; idx_conn < connections_amount; idx_conn++) {
  1125. Dictionary conn_data;
  1126. conn_data["source"] = connections[idx_conn].source;
  1127. conn_data["signal_name"] = connections[idx_conn].signal;
  1128. conn_data["method_name"] = connections[idx_conn].method;
  1129. ret.push_back(conn_data);
  1130. }
  1131. return ret;
  1132. }
  1133. bool Object::has_signal(const StringName &p_name) const {
  1134. if (!script.is_null()) {
  1135. Ref<Script> scr = script;
  1136. if (scr.is_valid() && scr->has_script_signal(p_name)) {
  1137. return true;
  1138. }
  1139. }
  1140. if (ClassDB::has_signal(get_class_name(), p_name)) {
  1141. return true;
  1142. }
  1143. if (_has_user_signal(p_name)) {
  1144. return true;
  1145. }
  1146. return false;
  1147. }
  1148. void Object::get_signal_list(List<MethodInfo> *p_signals) const {
  1149. if (!script.is_null()) {
  1150. Ref<Script> scr = script;
  1151. if (scr.is_valid()) {
  1152. scr->get_script_signal_list(p_signals);
  1153. }
  1154. }
  1155. ClassDB::get_signal_list(get_class_name(), p_signals);
  1156. //find maybe usersignals?
  1157. const StringName *S = nullptr;
  1158. while ((S = signal_map.next(S))) {
  1159. if (signal_map[*S].user.name != "") {
  1160. //user signal
  1161. p_signals->push_back(signal_map[*S].user);
  1162. }
  1163. }
  1164. }
  1165. void Object::get_all_signal_connections(List<Connection> *p_connections) const {
  1166. const StringName *S = nullptr;
  1167. while ((S = signal_map.next(S))) {
  1168. const Signal *s = &signal_map[*S];
  1169. for (int i = 0; i < s->slot_map.size(); i++) {
  1170. p_connections->push_back(s->slot_map.getv(i).conn);
  1171. }
  1172. }
  1173. }
  1174. void Object::get_signal_connection_list(const StringName &p_signal, List<Connection> *p_connections) const {
  1175. const Signal *s = signal_map.getptr(p_signal);
  1176. if (!s) {
  1177. return; //nothing
  1178. }
  1179. for (int i = 0; i < s->slot_map.size(); i++) {
  1180. p_connections->push_back(s->slot_map.getv(i).conn);
  1181. }
  1182. }
  1183. int Object::get_persistent_signal_connection_count() const {
  1184. int count = 0;
  1185. const StringName *S = nullptr;
  1186. while ((S = signal_map.next(S))) {
  1187. const Signal *s = &signal_map[*S];
  1188. for (int i = 0; i < s->slot_map.size(); i++) {
  1189. if (s->slot_map.getv(i).conn.flags & CONNECT_PERSIST) {
  1190. count += 1;
  1191. }
  1192. }
  1193. }
  1194. return count;
  1195. }
  1196. void Object::get_signals_connected_to_this(List<Connection> *p_connections) const {
  1197. for (const List<Connection>::Element *E = connections.front(); E; E = E->next()) {
  1198. p_connections->push_back(E->get());
  1199. }
  1200. }
  1201. Error Object::connect(const StringName &p_signal, Object *p_to_object, const StringName &p_to_method, const Vector<Variant> &p_binds, uint32_t p_flags) {
  1202. ERR_FAIL_NULL_V(p_to_object, ERR_INVALID_PARAMETER);
  1203. Signal *s = signal_map.getptr(p_signal);
  1204. if (!s) {
  1205. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_signal);
  1206. //check in script
  1207. if (!signal_is_valid && !script.is_null()) {
  1208. if (Ref<Script>(script)->has_script_signal(p_signal)) {
  1209. signal_is_valid = true;
  1210. }
  1211. #ifdef TOOLS_ENABLED
  1212. else {
  1213. //allow connecting signals anyway if script is invalid, see issue #17070
  1214. if (!Ref<Script>(script)->is_valid()) {
  1215. signal_is_valid = true;
  1216. }
  1217. }
  1218. #endif
  1219. }
  1220. ERR_FAIL_COND_V_MSG(!signal_is_valid, ERR_INVALID_PARAMETER, "In Object of type '" + String(get_class()) + "': Attempt to connect nonexistent signal '" + p_signal + "' to method '" + p_to_object->get_class() + "." + p_to_method + "'.");
  1221. signal_map[p_signal] = Signal();
  1222. s = &signal_map[p_signal];
  1223. }
  1224. Signal::Target target(p_to_object->get_instance_id(), p_to_method);
  1225. if (s->slot_map.has(target)) {
  1226. if (p_flags & CONNECT_REFERENCE_COUNTED) {
  1227. s->slot_map[target].reference_count++;
  1228. return OK;
  1229. } else {
  1230. ERR_FAIL_V_MSG(ERR_INVALID_PARAMETER, "Signal '" + p_signal + "' is already connected to given method '" + p_to_method + "' in that object.");
  1231. }
  1232. }
  1233. Signal::Slot slot;
  1234. Connection conn;
  1235. conn.source = this;
  1236. conn.target = p_to_object;
  1237. conn.method = p_to_method;
  1238. conn.signal = p_signal;
  1239. conn.flags = p_flags;
  1240. conn.binds = p_binds;
  1241. slot.conn = conn;
  1242. slot.cE = p_to_object->connections.push_back(conn);
  1243. if (p_flags & CONNECT_REFERENCE_COUNTED) {
  1244. slot.reference_count = 1;
  1245. }
  1246. s->slot_map[target] = slot;
  1247. return OK;
  1248. }
  1249. bool Object::is_connected(const StringName &p_signal, Object *p_to_object, const StringName &p_to_method) const {
  1250. ERR_FAIL_NULL_V(p_to_object, false);
  1251. const Signal *s = signal_map.getptr(p_signal);
  1252. if (!s) {
  1253. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_signal);
  1254. if (signal_is_valid) {
  1255. return false;
  1256. }
  1257. if (!script.is_null() && Ref<Script>(script)->has_script_signal(p_signal)) {
  1258. return false;
  1259. }
  1260. ERR_FAIL_V_MSG(false, "Nonexistent signal: " + p_signal + ".");
  1261. }
  1262. Signal::Target target(p_to_object->get_instance_id(), p_to_method);
  1263. return s->slot_map.has(target);
  1264. //const Map<Signal::Target,Signal::Slot>::Element *E = s->slot_map.find(target);
  1265. //return (E!=NULL);
  1266. }
  1267. void Object::disconnect(const StringName &p_signal, Object *p_to_object, const StringName &p_to_method) {
  1268. _disconnect(p_signal, p_to_object, p_to_method);
  1269. }
  1270. void Object::_disconnect(const StringName &p_signal, Object *p_to_object, const StringName &p_to_method, bool p_force) {
  1271. ERR_FAIL_NULL(p_to_object);
  1272. Signal *s = signal_map.getptr(p_signal);
  1273. if (!s) {
  1274. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_signal) ||
  1275. (!script.is_null() && Ref<Script>(script)->has_script_signal(p_signal));
  1276. ERR_FAIL_COND_MSG(signal_is_valid,
  1277. vformat("Attempt to disconnect a nonexistent connection to signal '%s' in %s, with target '%s' in %s.",
  1278. p_signal, to_string(), p_to_method, p_to_object->to_string()));
  1279. }
  1280. ERR_FAIL_COND_MSG(!s, vformat("Disconnecting nonexistent signal '%s' in %s.", p_signal, to_string()));
  1281. Signal::Target target(p_to_object->get_instance_id(), p_to_method);
  1282. ERR_FAIL_COND_MSG(!s->slot_map.has(target), "Disconnecting nonexistent signal '" + p_signal + "', slot: " + itos(target._id) + ":" + target.method + ".");
  1283. Signal::Slot *slot = &s->slot_map[target];
  1284. if (!p_force) {
  1285. slot->reference_count--; // by default is zero, if it was not referenced it will go below it
  1286. if (slot->reference_count > 0) {
  1287. return;
  1288. }
  1289. }
  1290. p_to_object->connections.erase(slot->cE);
  1291. s->slot_map.erase(target);
  1292. if (s->slot_map.empty() && ClassDB::has_signal(get_class_name(), p_signal)) {
  1293. //not user signal, delete
  1294. signal_map.erase(p_signal);
  1295. }
  1296. }
  1297. void Object::_set_bind(const String &p_set, const Variant &p_value) {
  1298. set(p_set, p_value);
  1299. }
  1300. Variant Object::_get_bind(const String &p_name) const {
  1301. return get(p_name);
  1302. }
  1303. void Object::_set_indexed_bind(const NodePath &p_name, const Variant &p_value) {
  1304. set_indexed(p_name.get_as_property_path().get_subnames(), p_value);
  1305. }
  1306. Variant Object::_get_indexed_bind(const NodePath &p_name) const {
  1307. return get_indexed(p_name.get_as_property_path().get_subnames());
  1308. }
  1309. void Object::initialize_class() {
  1310. static bool initialized = false;
  1311. if (initialized) {
  1312. return;
  1313. }
  1314. ClassDB::_add_class<Object>();
  1315. _bind_methods();
  1316. initialized = true;
  1317. }
  1318. StringName Object::tr(const StringName &p_message) const {
  1319. if (!_can_translate || !TranslationServer::get_singleton()) {
  1320. return p_message;
  1321. }
  1322. return TranslationServer::get_singleton()->translate(p_message);
  1323. }
  1324. void Object::_clear_internal_resource_paths(const Variant &p_var) {
  1325. switch (p_var.get_type()) {
  1326. case Variant::OBJECT: {
  1327. RES r = p_var;
  1328. if (!r.is_valid()) {
  1329. return;
  1330. }
  1331. if (!r->get_path().begins_with("res://") || r->get_path().find("::") == -1) {
  1332. return; //not an internal resource
  1333. }
  1334. Object *object = p_var;
  1335. if (!object) {
  1336. return;
  1337. }
  1338. r->set_path("");
  1339. r->clear_internal_resource_paths();
  1340. } break;
  1341. case Variant::ARRAY: {
  1342. Array a = p_var;
  1343. for (int i = 0; i < a.size(); i++) {
  1344. _clear_internal_resource_paths(a[i]);
  1345. }
  1346. } break;
  1347. case Variant::DICTIONARY: {
  1348. Dictionary d = p_var;
  1349. List<Variant> keys;
  1350. d.get_key_list(&keys);
  1351. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1352. _clear_internal_resource_paths(E->get());
  1353. _clear_internal_resource_paths(d[E->get()]);
  1354. }
  1355. } break;
  1356. default: {
  1357. }
  1358. }
  1359. }
  1360. #ifdef TOOLS_ENABLED
  1361. void Object::editor_set_section_unfold(const String &p_section, bool p_unfolded) {
  1362. set_edited(true);
  1363. if (p_unfolded) {
  1364. editor_section_folding.insert(p_section);
  1365. } else {
  1366. editor_section_folding.erase(p_section);
  1367. }
  1368. }
  1369. bool Object::editor_is_section_unfolded(const String &p_section) {
  1370. return editor_section_folding.has(p_section);
  1371. }
  1372. #endif
  1373. void Object::clear_internal_resource_paths() {
  1374. List<PropertyInfo> pinfo;
  1375. get_property_list(&pinfo);
  1376. for (List<PropertyInfo>::Element *E = pinfo.front(); E; E = E->next()) {
  1377. _clear_internal_resource_paths(get(E->get().name));
  1378. }
  1379. }
  1380. void Object::_bind_methods() {
  1381. ClassDB::bind_method(D_METHOD("get_class"), &Object::get_class);
  1382. ClassDB::bind_method(D_METHOD("is_class", "class"), &Object::is_class);
  1383. ClassDB::bind_method(D_METHOD("set", "property", "value"), &Object::_set_bind);
  1384. ClassDB::bind_method(D_METHOD("get", "property"), &Object::_get_bind);
  1385. ClassDB::bind_method(D_METHOD("set_indexed", "property", "value"), &Object::_set_indexed_bind);
  1386. ClassDB::bind_method(D_METHOD("get_indexed", "property"), &Object::_get_indexed_bind);
  1387. ClassDB::bind_method(D_METHOD("get_property_list"), &Object::_get_property_list_bind);
  1388. ClassDB::bind_method(D_METHOD("get_method_list"), &Object::_get_method_list_bind);
  1389. ClassDB::bind_method(D_METHOD("notification", "what", "reversed"), &Object::notification, DEFVAL(false));
  1390. ClassDB::bind_method(D_METHOD("to_string"), &Object::to_string);
  1391. ClassDB::bind_method(D_METHOD("get_instance_id"), &Object::get_instance_id);
  1392. ClassDB::bind_method(D_METHOD("set_script", "script"), &Object::set_script);
  1393. ClassDB::bind_method(D_METHOD("get_script"), &Object::get_script);
  1394. ClassDB::bind_method(D_METHOD("set_meta", "name", "value"), &Object::set_meta);
  1395. ClassDB::bind_method(D_METHOD("remove_meta", "name"), &Object::remove_meta);
  1396. ClassDB::bind_method(D_METHOD("get_meta", "name"), &Object::get_meta);
  1397. ClassDB::bind_method(D_METHOD("has_meta", "name"), &Object::has_meta);
  1398. ClassDB::bind_method(D_METHOD("get_meta_list"), &Object::_get_meta_list_bind);
  1399. ClassDB::bind_method(D_METHOD("add_user_signal", "signal", "arguments"), &Object::_add_user_signal, DEFVAL(Array()));
  1400. ClassDB::bind_method(D_METHOD("has_user_signal", "signal"), &Object::_has_user_signal);
  1401. {
  1402. MethodInfo mi;
  1403. mi.name = "emit_signal";
  1404. mi.arguments.push_back(PropertyInfo(Variant::STRING, "signal"));
  1405. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "emit_signal", &Object::_emit_signal, mi, varray(), false);
  1406. }
  1407. {
  1408. MethodInfo mi;
  1409. mi.name = "call";
  1410. mi.arguments.push_back(PropertyInfo(Variant::STRING, "method"));
  1411. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "call", &Object::_call_bind, mi);
  1412. }
  1413. {
  1414. MethodInfo mi;
  1415. mi.name = "call_deferred";
  1416. mi.arguments.push_back(PropertyInfo(Variant::STRING, "method"));
  1417. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "call_deferred", &Object::_call_deferred_bind, mi, varray(), false);
  1418. }
  1419. ClassDB::bind_method(D_METHOD("set_deferred", "property", "value"), &Object::set_deferred);
  1420. ClassDB::bind_method(D_METHOD("callv", "method", "arg_array"), &Object::callv);
  1421. ClassDB::bind_method(D_METHOD("has_method", "method"), &Object::has_method);
  1422. ClassDB::bind_method(D_METHOD("has_signal", "signal"), &Object::has_signal);
  1423. ClassDB::bind_method(D_METHOD("get_signal_list"), &Object::_get_signal_list);
  1424. ClassDB::bind_method(D_METHOD("get_signal_connection_list", "signal"), &Object::_get_signal_connection_list);
  1425. ClassDB::bind_method(D_METHOD("get_incoming_connections"), &Object::_get_incoming_connections);
  1426. ClassDB::bind_method(D_METHOD("connect", "signal", "target", "method", "binds", "flags"), &Object::connect, DEFVAL(Array()), DEFVAL(0));
  1427. ClassDB::bind_method(D_METHOD("disconnect", "signal", "target", "method"), &Object::disconnect);
  1428. ClassDB::bind_method(D_METHOD("is_connected", "signal", "target", "method"), &Object::is_connected);
  1429. ClassDB::bind_method(D_METHOD("set_block_signals", "enable"), &Object::set_block_signals);
  1430. ClassDB::bind_method(D_METHOD("is_blocking_signals"), &Object::is_blocking_signals);
  1431. ClassDB::bind_method(D_METHOD("property_list_changed_notify"), &Object::property_list_changed_notify);
  1432. ClassDB::bind_method(D_METHOD("set_message_translation", "enable"), &Object::set_message_translation);
  1433. ClassDB::bind_method(D_METHOD("can_translate_messages"), &Object::can_translate_messages);
  1434. ClassDB::bind_method(D_METHOD("tr", "message"), &Object::tr);
  1435. ClassDB::bind_method(D_METHOD("is_queued_for_deletion"), &Object::is_queued_for_deletion);
  1436. ClassDB::add_virtual_method("Object", MethodInfo("free"), false);
  1437. ADD_SIGNAL(MethodInfo("script_changed"));
  1438. BIND_VMETHOD(MethodInfo("_notification", PropertyInfo(Variant::INT, "what")));
  1439. BIND_VMETHOD(MethodInfo(Variant::BOOL, "_set", PropertyInfo(Variant::STRING, "property"), PropertyInfo(Variant::NIL, "value")));
  1440. #ifdef TOOLS_ENABLED
  1441. MethodInfo miget("_get", PropertyInfo(Variant::STRING, "property"));
  1442. miget.return_val.name = "Variant";
  1443. miget.return_val.usage |= PROPERTY_USAGE_NIL_IS_VARIANT;
  1444. BIND_VMETHOD(miget);
  1445. MethodInfo plget("_get_property_list");
  1446. plget.return_val.type = Variant::ARRAY;
  1447. BIND_VMETHOD(plget);
  1448. #endif
  1449. BIND_VMETHOD(MethodInfo("_init"));
  1450. BIND_VMETHOD(MethodInfo(Variant::STRING, "_to_string"));
  1451. BIND_CONSTANT(NOTIFICATION_POSTINITIALIZE);
  1452. BIND_CONSTANT(NOTIFICATION_PREDELETE);
  1453. BIND_ENUM_CONSTANT(CONNECT_DEFERRED);
  1454. BIND_ENUM_CONSTANT(CONNECT_PERSIST);
  1455. BIND_ENUM_CONSTANT(CONNECT_ONESHOT);
  1456. BIND_ENUM_CONSTANT(CONNECT_REFERENCE_COUNTED);
  1457. }
  1458. void Object::call_deferred(const StringName &p_method, VARIANT_ARG_DECLARE) {
  1459. MessageQueue::get_singleton()->push_call(this, p_method, VARIANT_ARG_PASS);
  1460. }
  1461. void Object::set_deferred(const StringName &p_property, const Variant &p_value) {
  1462. MessageQueue::get_singleton()->push_set(this, p_property, p_value);
  1463. }
  1464. void Object::set_block_signals(bool p_block) {
  1465. _block_signals = p_block;
  1466. }
  1467. bool Object::is_blocking_signals() const {
  1468. return _block_signals;
  1469. }
  1470. void Object::get_translatable_strings(List<String> *p_strings) const {
  1471. List<PropertyInfo> plist;
  1472. get_property_list(&plist);
  1473. for (List<PropertyInfo>::Element *E = plist.front(); E; E = E->next()) {
  1474. if (!(E->get().usage & PROPERTY_USAGE_INTERNATIONALIZED)) {
  1475. continue;
  1476. }
  1477. String text = get(E->get().name);
  1478. if (text == "") {
  1479. continue;
  1480. }
  1481. p_strings->push_back(text);
  1482. }
  1483. }
  1484. Variant::Type Object::get_static_property_type(const StringName &p_property, bool *r_valid) const {
  1485. bool valid;
  1486. Variant::Type t = ClassDB::get_property_type(get_class_name(), p_property, &valid);
  1487. if (valid) {
  1488. if (r_valid) {
  1489. *r_valid = true;
  1490. }
  1491. return t;
  1492. }
  1493. if (get_script_instance()) {
  1494. return get_script_instance()->get_property_type(p_property, r_valid);
  1495. }
  1496. if (r_valid) {
  1497. *r_valid = false;
  1498. }
  1499. return Variant::NIL;
  1500. }
  1501. Variant::Type Object::get_static_property_type_indexed(const Vector<StringName> &p_path, bool *r_valid) const {
  1502. if (p_path.size() == 0) {
  1503. if (r_valid) {
  1504. *r_valid = false;
  1505. }
  1506. return Variant::NIL;
  1507. }
  1508. bool valid = false;
  1509. Variant::Type t = get_static_property_type(p_path[0], &valid);
  1510. if (!valid) {
  1511. if (r_valid) {
  1512. *r_valid = false;
  1513. }
  1514. return Variant::NIL;
  1515. }
  1516. Variant::CallError ce;
  1517. Variant check = Variant::construct(t, nullptr, 0, ce);
  1518. for (int i = 1; i < p_path.size(); i++) {
  1519. if (check.get_type() == Variant::OBJECT || check.get_type() == Variant::DICTIONARY || check.get_type() == Variant::ARRAY) {
  1520. // We cannot be sure about the type of properties this types can have
  1521. if (r_valid) {
  1522. *r_valid = false;
  1523. }
  1524. return Variant::NIL;
  1525. }
  1526. check = check.get_named(p_path[i], &valid);
  1527. if (!valid) {
  1528. if (r_valid) {
  1529. *r_valid = false;
  1530. }
  1531. return Variant::NIL;
  1532. }
  1533. }
  1534. if (r_valid) {
  1535. *r_valid = true;
  1536. }
  1537. return check.get_type();
  1538. }
  1539. bool Object::is_queued_for_deletion() const {
  1540. return _is_queued_for_deletion;
  1541. }
  1542. #ifdef TOOLS_ENABLED
  1543. void Object::set_edited(bool p_edited) {
  1544. _edited = p_edited;
  1545. _edited_version++;
  1546. }
  1547. bool Object::is_edited() const {
  1548. return _edited;
  1549. }
  1550. uint32_t Object::get_edited_version() const {
  1551. return _edited_version;
  1552. }
  1553. #endif
  1554. void *Object::get_script_instance_binding(int p_script_language_index) {
  1555. #ifdef DEBUG_ENABLED
  1556. ERR_FAIL_INDEX_V(p_script_language_index, MAX_SCRIPT_INSTANCE_BINDINGS, nullptr);
  1557. #endif
  1558. //it's up to the script language to make this thread safe, if the function is called twice due to threads being out of syncro
  1559. //just return the same pointer.
  1560. //if you want to put a big lock in the entire function and keep allocated pointers in a map or something, feel free to do it
  1561. //as it should not really affect performance much (won't be called too often), as in far most caes the condition below will be false afterwards
  1562. if (!_script_instance_bindings[p_script_language_index]) {
  1563. void *script_data = ScriptServer::get_language(p_script_language_index)->alloc_instance_binding_data(this);
  1564. if (script_data) {
  1565. instance_binding_count.increment();
  1566. _script_instance_bindings[p_script_language_index] = script_data;
  1567. }
  1568. }
  1569. return _script_instance_bindings[p_script_language_index];
  1570. }
  1571. bool Object::has_script_instance_binding(int p_script_language_index) {
  1572. return _script_instance_bindings[p_script_language_index] != nullptr;
  1573. }
  1574. void Object::set_script_instance_binding(int p_script_language_index, void *p_data) {
  1575. #ifdef DEBUG_ENABLED
  1576. CRASH_COND(_script_instance_bindings[p_script_language_index] != nullptr);
  1577. #endif
  1578. _script_instance_bindings[p_script_language_index] = p_data;
  1579. }
  1580. Object::Object() {
  1581. _class_ptr = nullptr;
  1582. _block_signals = false;
  1583. _predelete_ok = 0;
  1584. _instance_id = 0;
  1585. _instance_id = ObjectDB::add_instance(this);
  1586. _can_translate = true;
  1587. _is_queued_for_deletion = false;
  1588. _emitting = false;
  1589. memset(_script_instance_bindings, 0, sizeof(void *) * MAX_SCRIPT_INSTANCE_BINDINGS);
  1590. script_instance = nullptr;
  1591. _rc.store(nullptr, std::memory_order_release);
  1592. #ifdef TOOLS_ENABLED
  1593. _edited = false;
  1594. _edited_version = 0;
  1595. #endif
  1596. #ifdef DEBUG_ENABLED
  1597. _lock_index.init(1);
  1598. #endif
  1599. }
  1600. Object::~Object() {
  1601. ObjectRC *rc = _rc.load(std::memory_order_acquire);
  1602. if (rc) {
  1603. if (rc->invalidate()) {
  1604. memdelete(rc);
  1605. }
  1606. }
  1607. if (script_instance) {
  1608. memdelete(script_instance);
  1609. }
  1610. script_instance = nullptr;
  1611. const StringName *S = nullptr;
  1612. if (_emitting) {
  1613. //@todo this may need to actually reach the debugger prioritarily somehow because it may crash before
  1614. ERR_PRINT("Object " + to_string() + " was freed or unreferenced while a signal is being emitted from it. Try connecting to the signal using 'CONNECT_DEFERRED' flag, or use queue_free() to free the object (if this object is a Node) to avoid this error and potential crashes.");
  1615. }
  1616. while ((S = signal_map.next(nullptr))) {
  1617. Signal *s = &signal_map[*S];
  1618. //brute force disconnect for performance
  1619. int slot_count = s->slot_map.size();
  1620. const VMap<Signal::Target, Signal::Slot>::Pair *slot_list = s->slot_map.get_array();
  1621. for (int i = 0; i < slot_count; i++) {
  1622. slot_list[i].value.conn.target->connections.erase(slot_list[i].value.cE);
  1623. }
  1624. signal_map.erase(*S);
  1625. }
  1626. //signals from nodes that connect to this node
  1627. while (connections.size()) {
  1628. Connection c = connections.front()->get();
  1629. c.source->_disconnect(c.signal, c.target, c.method, true);
  1630. }
  1631. ObjectDB::remove_instance(this);
  1632. _instance_id = 0;
  1633. _predelete_ok = 2;
  1634. if (!ScriptServer::are_languages_finished()) {
  1635. for (int i = 0; i < MAX_SCRIPT_INSTANCE_BINDINGS; i++) {
  1636. if (_script_instance_bindings[i]) {
  1637. ScriptServer::get_language(i)->free_instance_binding_data(_script_instance_bindings[i]);
  1638. }
  1639. }
  1640. }
  1641. }
  1642. bool predelete_handler(Object *p_object) {
  1643. return p_object->_predelete();
  1644. }
  1645. void postinitialize_handler(Object *p_object) {
  1646. p_object->_postinitialize();
  1647. }
  1648. HashMap<ObjectID, Object *> ObjectDB::instances;
  1649. ObjectID ObjectDB::instance_counter = 1;
  1650. HashMap<Object *, ObjectID, ObjectDB::ObjectPtrHash> ObjectDB::instance_checks;
  1651. ObjectID ObjectDB::add_instance(Object *p_object) {
  1652. ERR_FAIL_COND_V(p_object->get_instance_id() != 0, 0);
  1653. rw_lock.write_lock();
  1654. ObjectID instance_id = ++instance_counter;
  1655. instances[instance_id] = p_object;
  1656. instance_checks[p_object] = instance_id;
  1657. rw_lock.write_unlock();
  1658. return instance_id;
  1659. }
  1660. void ObjectDB::remove_instance(Object *p_object) {
  1661. rw_lock.write_lock();
  1662. instances.erase(p_object->get_instance_id());
  1663. instance_checks.erase(p_object);
  1664. rw_lock.write_unlock();
  1665. }
  1666. Object *ObjectDB::get_instance(ObjectID p_instance_id) {
  1667. rw_lock.read_lock();
  1668. Object **obj = instances.getptr(p_instance_id);
  1669. rw_lock.read_unlock();
  1670. if (!obj) {
  1671. return nullptr;
  1672. }
  1673. return *obj;
  1674. }
  1675. void ObjectDB::debug_objects(DebugFunc p_func) {
  1676. rw_lock.read_lock();
  1677. const ObjectID *K = nullptr;
  1678. while ((K = instances.next(K))) {
  1679. p_func(instances[*K]);
  1680. }
  1681. rw_lock.read_unlock();
  1682. }
  1683. void Object::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1684. }
  1685. int ObjectDB::get_object_count() {
  1686. rw_lock.read_lock();
  1687. int count = instances.size();
  1688. rw_lock.read_unlock();
  1689. return count;
  1690. }
  1691. RWLock ObjectDB::rw_lock;
  1692. void ObjectDB::cleanup() {
  1693. rw_lock.write_lock();
  1694. if (instances.size()) {
  1695. WARN_PRINT("ObjectDB instances leaked at exit (run with --verbose for details).");
  1696. if (OS::get_singleton()->is_stdout_verbose()) {
  1697. // Ensure calling the native classes because if a leaked instance has a script
  1698. // that overrides any of those methods, it'd not be OK to call them at this point,
  1699. // now the scripting languages have already been terminated.
  1700. MethodBind *node_get_name = ClassDB::get_method("Node", "get_name");
  1701. MethodBind *resource_get_path = ClassDB::get_method("Resource", "get_path");
  1702. Variant::CallError call_error;
  1703. const ObjectID *K = nullptr;
  1704. while ((K = instances.next(K))) {
  1705. String extra_info;
  1706. if (instances[*K]->is_class("Node")) {
  1707. extra_info = " - Node name: " + String(node_get_name->call(instances[*K], nullptr, 0, call_error));
  1708. }
  1709. if (instances[*K]->is_class("Resource")) {
  1710. extra_info = " - Resource path: " + String(resource_get_path->call(instances[*K], nullptr, 0, call_error));
  1711. }
  1712. print_line("Leaked instance: " + String(instances[*K]->get_class()) + ":" + itos(*K) + extra_info);
  1713. }
  1714. print_line("Hint: Leaked instances typically happen when nodes are removed from the scene tree (with `remove_child()`) but not freed (with `free()` or `queue_free()`).");
  1715. }
  1716. }
  1717. instances.clear();
  1718. instance_checks.clear();
  1719. rw_lock.write_unlock();
  1720. }