object.cpp 50 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015
  1. /*************************************************************************/
  2. /* object.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* http://www.godotengine.org */
  7. /*************************************************************************/
  8. /* Copyright (c) 2007-2017 Juan Linietsky, Ariel Manzur. */
  9. /* Copyright (c) 2014-2017 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 "class_db.h"
  32. #include "core_string_names.h"
  33. #include "message_queue.h"
  34. #include "os/os.h"
  35. #include "print_string.h"
  36. #include "resource.h"
  37. #include "script_language.h"
  38. #include "translation.h"
  39. #ifdef DEBUG_ENABLED
  40. struct _ObjectDebugLock {
  41. Object *obj;
  42. _ObjectDebugLock(Object *p_obj) {
  43. obj = p_obj;
  44. obj->_lock_index.ref();
  45. }
  46. ~_ObjectDebugLock() {
  47. obj->_lock_index.unref();
  48. }
  49. };
  50. #define OBJ_DEBUG_LOCK _ObjectDebugLock _debug_lock(this);
  51. #else
  52. #define OBJ_DEBUG_LOCK
  53. #endif
  54. PropertyInfo::operator Dictionary() const {
  55. Dictionary d;
  56. d["name"] = name;
  57. d["class_name"] = class_name;
  58. d["type"] = type;
  59. d["hint"] = hint;
  60. d["hint_string"] = hint_string;
  61. d["usage"] = usage;
  62. return d;
  63. }
  64. PropertyInfo PropertyInfo::from_dict(const Dictionary &p_dict) {
  65. PropertyInfo pi;
  66. if (p_dict.has("type"))
  67. pi.type = Variant::Type(int(p_dict["type"]));
  68. if (p_dict.has("name"))
  69. pi.name = p_dict["name"];
  70. if (p_dict.has("class_name"))
  71. pi.class_name = p_dict["class_name"];
  72. if (p_dict.has("hint"))
  73. pi.hint = PropertyHint(int(p_dict["hint"]));
  74. if (p_dict.has("hint_string"))
  75. pi.hint_string = p_dict["hint_string"];
  76. if (p_dict.has("usage"))
  77. pi.usage = p_dict["usage"];
  78. return pi;
  79. }
  80. Array convert_property_list(const List<PropertyInfo> *p_list) {
  81. Array va;
  82. for (const List<PropertyInfo>::Element *E = p_list->front(); E; E = E->next()) {
  83. va.push_back(Dictionary(E->get()));
  84. }
  85. return va;
  86. }
  87. MethodInfo::operator Dictionary() const {
  88. Dictionary d;
  89. d["name"] = name;
  90. d["args"] = convert_property_list(&arguments);
  91. Array da;
  92. for (int i = 0; i < default_arguments.size(); i++)
  93. da.push_back(default_arguments[i]);
  94. d["default_args"] = da;
  95. d["flags"] = flags;
  96. d["id"] = id;
  97. Dictionary r = return_val;
  98. d["return"] = r;
  99. return d;
  100. }
  101. MethodInfo::MethodInfo()
  102. : flags(METHOD_FLAG_NORMAL),
  103. id(0) {
  104. }
  105. MethodInfo MethodInfo::from_dict(const Dictionary &p_dict) {
  106. MethodInfo mi;
  107. if (p_dict.has("name"))
  108. mi.name = p_dict["name"];
  109. Array args;
  110. if (p_dict.has("args")) {
  111. args = p_dict["args"];
  112. }
  113. for (int i = 0; i < args.size(); i++) {
  114. Dictionary d = args[i];
  115. mi.arguments.push_back(PropertyInfo::from_dict(d));
  116. }
  117. Array defargs;
  118. if (p_dict.has("default_args")) {
  119. defargs = p_dict["default_args"];
  120. }
  121. for (int i = 0; i < defargs.size(); i++) {
  122. mi.default_arguments.push_back(defargs[i]);
  123. }
  124. if (p_dict.has("return")) {
  125. mi.return_val = PropertyInfo::from_dict(p_dict["return"]);
  126. }
  127. if (p_dict.has("flags"))
  128. mi.flags = p_dict["flags"];
  129. return mi;
  130. }
  131. MethodInfo::MethodInfo(const String &p_name)
  132. : name(p_name),
  133. flags(METHOD_FLAG_NORMAL),
  134. id(0) {
  135. }
  136. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1)
  137. : name(p_name),
  138. flags(METHOD_FLAG_NORMAL),
  139. id(0) {
  140. arguments.push_back(p_param1);
  141. }
  142. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2)
  143. : name(p_name),
  144. flags(METHOD_FLAG_NORMAL),
  145. id(0) {
  146. arguments.push_back(p_param1);
  147. arguments.push_back(p_param2);
  148. }
  149. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3)
  150. : name(p_name),
  151. flags(METHOD_FLAG_NORMAL),
  152. id(0) {
  153. arguments.push_back(p_param1);
  154. arguments.push_back(p_param2);
  155. arguments.push_back(p_param3);
  156. }
  157. MethodInfo::MethodInfo(const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3, const PropertyInfo &p_param4)
  158. : name(p_name),
  159. flags(METHOD_FLAG_NORMAL),
  160. id(0) {
  161. arguments.push_back(p_param1);
  162. arguments.push_back(p_param2);
  163. arguments.push_back(p_param3);
  164. arguments.push_back(p_param4);
  165. }
  166. 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)
  167. : name(p_name),
  168. flags(METHOD_FLAG_NORMAL),
  169. id(0) {
  170. arguments.push_back(p_param1);
  171. arguments.push_back(p_param2);
  172. arguments.push_back(p_param3);
  173. arguments.push_back(p_param4);
  174. arguments.push_back(p_param5);
  175. }
  176. MethodInfo::MethodInfo(Variant::Type ret)
  177. : flags(METHOD_FLAG_NORMAL),
  178. id(0) {
  179. return_val.type = ret;
  180. }
  181. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name)
  182. : name(p_name),
  183. flags(METHOD_FLAG_NORMAL),
  184. id(0) {
  185. return_val.type = ret;
  186. }
  187. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1)
  188. : name(p_name),
  189. flags(METHOD_FLAG_NORMAL),
  190. id(0) {
  191. return_val.type = ret;
  192. arguments.push_back(p_param1);
  193. }
  194. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2)
  195. : name(p_name),
  196. flags(METHOD_FLAG_NORMAL),
  197. id(0) {
  198. return_val.type = ret;
  199. arguments.push_back(p_param1);
  200. arguments.push_back(p_param2);
  201. }
  202. MethodInfo::MethodInfo(Variant::Type ret, const String &p_name, const PropertyInfo &p_param1, const PropertyInfo &p_param2, const PropertyInfo &p_param3)
  203. : name(p_name),
  204. flags(METHOD_FLAG_NORMAL),
  205. id(0) {
  206. return_val.type = ret;
  207. arguments.push_back(p_param1);
  208. arguments.push_back(p_param2);
  209. arguments.push_back(p_param3);
  210. }
  211. 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)
  212. : name(p_name),
  213. flags(METHOD_FLAG_NORMAL),
  214. id(0) {
  215. return_val.type = ret;
  216. arguments.push_back(p_param1);
  217. arguments.push_back(p_param2);
  218. arguments.push_back(p_param3);
  219. arguments.push_back(p_param4);
  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, const PropertyInfo &p_param5)
  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. arguments.push_back(p_param5);
  231. }
  232. Object::Connection::operator Variant() const {
  233. Dictionary d;
  234. d["source"] = source;
  235. d["signal"] = signal;
  236. d["target"] = target;
  237. d["method"] = method;
  238. d["flags"] = flags;
  239. d["binds"] = binds;
  240. return d;
  241. }
  242. bool Object::Connection::operator<(const Connection &p_conn) const {
  243. if (source == p_conn.source) {
  244. if (signal == p_conn.signal) {
  245. if (target == p_conn.target) {
  246. return method < p_conn.method;
  247. } else {
  248. return target < p_conn.target;
  249. }
  250. } else
  251. return signal < p_conn.signal;
  252. } else {
  253. return source < p_conn.source;
  254. }
  255. }
  256. Object::Connection::Connection(const Variant &p_variant) {
  257. Dictionary d = p_variant;
  258. if (d.has("source"))
  259. source = d["source"];
  260. if (d.has("signal"))
  261. signal = d["signal"];
  262. if (d.has("target"))
  263. target = d["target"];
  264. if (d.has("method"))
  265. method = d["method"];
  266. if (d.has("flags"))
  267. flags = d["flags"];
  268. if (d.has("binds"))
  269. binds = d["binds"];
  270. }
  271. bool Object::_predelete() {
  272. _predelete_ok = 1;
  273. notification(NOTIFICATION_PREDELETE, true);
  274. if (_predelete_ok) {
  275. _class_ptr = NULL; //must restore so destructors can access class ptr correctly
  276. }
  277. return _predelete_ok;
  278. }
  279. void Object::_postinitialize() {
  280. _class_ptr = _get_class_namev();
  281. _initialize_classv();
  282. notification(NOTIFICATION_POSTINITIALIZE);
  283. }
  284. void Object::get_valid_parents_static(List<String> *p_parents) {
  285. }
  286. void Object::_get_valid_parents_static(List<String> *p_parents) {
  287. }
  288. #if 0
  289. //old style set, deprecated
  290. void Object::set(const String& p_name, const Variant& p_value) {
  291. _setv(p_name,p_value);
  292. /*
  293. if (!_use_builtin_script())
  294. return;
  295. */
  296. bool success;
  297. ClassDB::set_property(this,p_name,p_value,success);
  298. if (success) {
  299. return;
  300. }
  301. if (p_name=="__meta__") {
  302. metadata=p_value;
  303. } else if (p_name=="script") {
  304. set_script(p_value);
  305. } else if (script_instance) {
  306. script_instance->set(p_name,p_value);
  307. }
  308. }
  309. #endif
  310. void Object::set(const StringName &p_name, const Variant &p_value, bool *r_valid) {
  311. #ifdef TOOLS_ENABLED
  312. _edited = true;
  313. #endif
  314. if (script_instance) {
  315. if (script_instance->set(p_name, p_value)) {
  316. if (r_valid)
  317. *r_valid = true;
  318. return;
  319. }
  320. }
  321. //try built-in setgetter
  322. {
  323. if (ClassDB::set_property(this, p_name, p_value, r_valid)) {
  324. /*
  325. if (r_valid)
  326. *r_valid=true;
  327. */
  328. return;
  329. }
  330. }
  331. if (p_name == CoreStringNames::get_singleton()->_script) {
  332. set_script(p_value);
  333. if (r_valid)
  334. *r_valid = true;
  335. return;
  336. } else if (p_name == CoreStringNames::get_singleton()->_meta) {
  337. //set_meta(p_name,p_value);
  338. metadata = p_value;
  339. if (r_valid)
  340. *r_valid = true;
  341. return;
  342. #ifdef TOOLS_ENABLED
  343. } else if (p_name == CoreStringNames::get_singleton()->_sections_unfolded) {
  344. Array arr = p_value;
  345. for (int i = 0; i < arr.size(); i++) {
  346. editor_section_folding.insert(arr[i]);
  347. }
  348. if (r_valid)
  349. *r_valid = true;
  350. return;
  351. #endif
  352. } else {
  353. //something inside the object... :|
  354. bool success = _setv(p_name, p_value);
  355. if (success) {
  356. if (r_valid)
  357. *r_valid = true;
  358. return;
  359. }
  360. setvar(p_name, p_value, r_valid);
  361. }
  362. }
  363. Variant Object::get(const StringName &p_name, bool *r_valid) const {
  364. Variant ret;
  365. if (script_instance) {
  366. if (script_instance->get(p_name, ret)) {
  367. if (r_valid)
  368. *r_valid = true;
  369. return ret;
  370. }
  371. }
  372. //try built-in setgetter
  373. {
  374. if (ClassDB::get_property(const_cast<Object *>(this), p_name, ret)) {
  375. if (r_valid)
  376. *r_valid = true;
  377. return ret;
  378. }
  379. }
  380. if (p_name == CoreStringNames::get_singleton()->_script) {
  381. ret = get_script();
  382. if (r_valid)
  383. *r_valid = true;
  384. return ret;
  385. } else if (p_name == CoreStringNames::get_singleton()->_meta) {
  386. ret = metadata;
  387. if (r_valid)
  388. *r_valid = true;
  389. return ret;
  390. #ifdef TOOLS_ENABLED
  391. } else if (p_name == CoreStringNames::get_singleton()->_sections_unfolded) {
  392. Array array;
  393. for (Set<String>::Element *E = editor_section_folding.front(); E; E = E->next()) {
  394. array.push_back(E->get());
  395. }
  396. if (r_valid)
  397. *r_valid = true;
  398. return array;
  399. #endif
  400. } else {
  401. //something inside the object... :|
  402. bool success = _getv(p_name, ret);
  403. if (success) {
  404. if (r_valid)
  405. *r_valid = true;
  406. return ret;
  407. }
  408. //if nothing else, use getvar
  409. return getvar(p_name, r_valid);
  410. }
  411. }
  412. #if 0
  413. //old style get, deprecated
  414. Variant Object::get(const String& p_name) const {
  415. Variant ret=_getv(p_name);
  416. if (ret.get_type()!=Variant::NIL)
  417. return ret;
  418. bool success;
  419. ClassDB::get_property(const_cast<Object*>(this),p_name,ret,success);
  420. if (success) {
  421. return ret;
  422. }
  423. if (p_name=="__meta__")
  424. return metadata;
  425. else if (p_name=="script")
  426. return script;
  427. if (script_instance) {
  428. return script_instance->get(p_name);
  429. }
  430. return Variant();
  431. }
  432. #endif
  433. void Object::get_property_list(List<PropertyInfo> *p_list, bool p_reversed) const {
  434. if (script_instance && p_reversed) {
  435. p_list->push_back(PropertyInfo(Variant::NIL, "Script Variables", PROPERTY_HINT_NONE, String(), PROPERTY_USAGE_CATEGORY));
  436. script_instance->get_property_list(p_list);
  437. }
  438. _get_property_listv(p_list, p_reversed);
  439. if (!is_class("Script")) // can still be set, but this is for userfriendlyness
  440. p_list->push_back(PropertyInfo(Variant::OBJECT, "script", PROPERTY_HINT_RESOURCE_TYPE, "Script", PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_STORE_IF_NONZERO));
  441. #ifdef TOOLS_ENABLED
  442. if (editor_section_folding.size()) {
  443. p_list->push_back(PropertyInfo(Variant::ARRAY, CoreStringNames::get_singleton()->_sections_unfolded, PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR));
  444. }
  445. #endif
  446. if (!metadata.empty())
  447. p_list->push_back(PropertyInfo(Variant::DICTIONARY, "__meta__", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NOEDITOR | PROPERTY_USAGE_STORE_IF_NONZERO));
  448. if (script_instance && !p_reversed) {
  449. p_list->push_back(PropertyInfo(Variant::NIL, "Script Variables", PROPERTY_HINT_NONE, String(), PROPERTY_USAGE_CATEGORY));
  450. script_instance->get_property_list(p_list);
  451. }
  452. }
  453. void Object::_validate_property(PropertyInfo &property) const {
  454. }
  455. void Object::get_method_list(List<MethodInfo> *p_list) const {
  456. ClassDB::get_method_list(get_class_name(), p_list);
  457. if (script_instance) {
  458. script_instance->get_method_list(p_list);
  459. }
  460. }
  461. Variant Object::_call_bind(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  462. if (p_argcount < 1) {
  463. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  464. r_error.argument = 0;
  465. return Variant();
  466. }
  467. if (p_args[0]->get_type() != Variant::STRING) {
  468. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  469. r_error.argument = 0;
  470. r_error.expected = Variant::STRING;
  471. return Variant();
  472. }
  473. StringName method = *p_args[0];
  474. return call(method, &p_args[1], p_argcount - 1, r_error);
  475. }
  476. Variant Object::_call_deferred_bind(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  477. if (p_argcount < 1) {
  478. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  479. r_error.argument = 0;
  480. return Variant();
  481. }
  482. if (p_args[0]->get_type() != Variant::STRING) {
  483. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  484. r_error.argument = 0;
  485. r_error.expected = Variant::STRING;
  486. return Variant();
  487. }
  488. r_error.error = Variant::CallError::CALL_OK;
  489. StringName method = *p_args[0];
  490. MessageQueue::get_singleton()->push_call(get_instance_id(), method, &p_args[1], p_argcount - 1);
  491. return Variant();
  492. }
  493. #if 0
  494. Variant Object::_call_bind(const StringName& p_name, const Variant& p_arg1, const Variant& p_arg2, const Variant& p_arg3, const Variant& p_arg4) {
  495. ERR_FAIL_COND_V(p_argcount<1,Variant());
  496. return call(p_name, p_arg1, p_arg2, p_arg3, p_arg4);
  497. };
  498. void Object::_call_deferred_bind(const StringName& p_name, const Variant& p_arg1, const Variant& p_arg2, const Variant& p_arg3, const Variant& p_arg4) {
  499. call_deferred(p_name, p_arg1, p_arg2, p_arg3, p_arg4);
  500. };
  501. #endif
  502. #ifdef DEBUG_ENABLED
  503. static bool _test_call_error(const StringName &p_func, const Variant::CallError &error) {
  504. switch (error.error) {
  505. case Variant::CallError::CALL_OK:
  506. return true;
  507. case Variant::CallError::CALL_ERROR_INVALID_METHOD:
  508. return false;
  509. case Variant::CallError::CALL_ERROR_INVALID_ARGUMENT: {
  510. ERR_EXPLAIN("Error Calling Function: " + String(p_func) + " - Invalid type for argument " + itos(error.argument) + ", expected " + Variant::get_type_name(error.expected));
  511. ERR_FAIL_V(true);
  512. } break;
  513. case Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS: {
  514. ERR_EXPLAIN("Error Calling Function: " + String(p_func) + " - Too many arguments, expected " + itos(error.argument));
  515. ERR_FAIL_V(true);
  516. } break;
  517. case Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS: {
  518. ERR_EXPLAIN("Error Calling Function: " + String(p_func) + " - Too few arguments, expected " + itos(error.argument));
  519. ERR_FAIL_V(true);
  520. } break;
  521. case Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL: {
  522. } //?
  523. }
  524. return true;
  525. }
  526. #else
  527. #define _test_call_error(m_str, m_err) ((m_err.error == Variant::CallError::CALL_ERROR_INVALID_METHOD) ? false : true)
  528. #endif
  529. void Object::call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount) {
  530. if (p_method == CoreStringNames::get_singleton()->_free) {
  531. #ifdef DEBUG_ENABLED
  532. if (Object::cast_to<Reference>(this)) {
  533. ERR_EXPLAIN("Can't 'free' a reference.");
  534. ERR_FAIL();
  535. return;
  536. }
  537. if (_lock_index.get() > 1) {
  538. ERR_EXPLAIN("Object is locked and can't be freed.");
  539. ERR_FAIL();
  540. return;
  541. }
  542. #endif
  543. //must be here, must be before everything,
  544. memdelete(this);
  545. return;
  546. }
  547. //Variant ret;
  548. OBJ_DEBUG_LOCK
  549. Variant::CallError error;
  550. if (script_instance) {
  551. script_instance->call_multilevel(p_method, p_args, p_argcount);
  552. //_test_call_error(p_method,error);
  553. }
  554. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  555. if (method) {
  556. method->call(this, p_args, p_argcount, error);
  557. _test_call_error(p_method, error);
  558. }
  559. }
  560. void Object::call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount) {
  561. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  562. Variant::CallError error;
  563. OBJ_DEBUG_LOCK
  564. if (method) {
  565. method->call(this, p_args, p_argcount, error);
  566. _test_call_error(p_method, error);
  567. }
  568. //Variant ret;
  569. if (script_instance) {
  570. script_instance->call_multilevel_reversed(p_method, p_args, p_argcount);
  571. //_test_call_error(p_method,error);
  572. }
  573. }
  574. bool Object::has_method(const StringName &p_method) const {
  575. if (p_method == CoreStringNames::get_singleton()->_free) {
  576. return true;
  577. }
  578. if (script_instance && script_instance->has_method(p_method)) {
  579. return true;
  580. }
  581. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  582. if (method) {
  583. return true;
  584. }
  585. return false;
  586. }
  587. Variant Object::getvar(const Variant &p_key, bool *r_valid) const {
  588. if (r_valid)
  589. *r_valid = false;
  590. return Variant();
  591. }
  592. void Object::setvar(const Variant &p_key, const Variant &p_value, bool *r_valid) {
  593. if (r_valid)
  594. *r_valid = false;
  595. }
  596. Variant Object::callv(const StringName &p_method, const Array &p_args) {
  597. if (p_args.size() == 0) {
  598. return call(p_method);
  599. }
  600. Vector<Variant> args;
  601. args.resize(p_args.size());
  602. Vector<const Variant *> argptrs;
  603. argptrs.resize(p_args.size());
  604. for (int i = 0; i < p_args.size(); i++) {
  605. args[i] = p_args[i];
  606. argptrs[i] = &args[i];
  607. }
  608. Variant::CallError ce;
  609. return call(p_method, argptrs.ptr(), p_args.size(), ce);
  610. }
  611. Variant Object::call(const StringName &p_name, VARIANT_ARG_DECLARE) {
  612. #if 0
  613. if (p_name==CoreStringNames::get_singleton()->_free) {
  614. #ifdef DEBUG_ENABLED
  615. if (cast_to<Reference>()) {
  616. ERR_EXPLAIN("Can't 'free' a reference.");
  617. ERR_FAIL_V(Variant());
  618. }
  619. #endif
  620. //must be here, must be before everything,
  621. memdelete(this);
  622. return Variant();
  623. }
  624. VARIANT_ARGPTRS;
  625. int argc=0;
  626. for(int i=0;i<VARIANT_ARG_MAX;i++) {
  627. if (argptr[i]->get_type()==Variant::NIL)
  628. break;
  629. argc++;
  630. }
  631. Variant::CallError error;
  632. Variant ret;
  633. if (script_instance) {
  634. ret = script_instance->call(p_name,argptr,argc,error);
  635. if (_test_call_error(p_name,error))
  636. return ret;
  637. }
  638. MethodBind *method=ClassDB::get_method(get_type_name(),p_name);
  639. if (method) {
  640. Variant ret = method->call(this,argptr,argc,error);
  641. if (_test_call_error(p_name,error))
  642. return ret;
  643. return ret;
  644. } else {
  645. }
  646. return Variant();
  647. #else
  648. VARIANT_ARGPTRS;
  649. int argc = 0;
  650. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  651. if (argptr[i]->get_type() == Variant::NIL)
  652. break;
  653. argc++;
  654. }
  655. Variant::CallError error;
  656. Variant ret = call(p_name, argptr, argc, error);
  657. return ret;
  658. #endif
  659. }
  660. void Object::call_multilevel(const StringName &p_name, VARIANT_ARG_DECLARE) {
  661. #if 0
  662. if (p_name==CoreStringNames::get_singleton()->_free) {
  663. #ifdef DEBUG_ENABLED
  664. if (cast_to<Reference>()) {
  665. ERR_EXPLAIN("Can't 'free' a reference.");
  666. ERR_FAIL();
  667. return;
  668. }
  669. #endif
  670. //must be here, must be before everything,
  671. memdelete(this);
  672. return;
  673. }
  674. VARIANT_ARGPTRS;
  675. int argc=0;
  676. for(int i=0;i<VARIANT_ARG_MAX;i++) {
  677. if (argptr[i]->get_type()==Variant::NIL)
  678. break;
  679. argc++;
  680. }
  681. Variant::CallError error;
  682. if (script_instance) {
  683. script_instance->call(p_name,argptr,argc,error);
  684. _test_call_error(p_name,error);
  685. }
  686. MethodBind *method=ClassDB::get_method(get_type_name(),p_name);
  687. if (method) {
  688. method->call(this,argptr,argc,error);
  689. _test_call_error(p_name,error);
  690. }
  691. #else
  692. VARIANT_ARGPTRS;
  693. int argc = 0;
  694. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  695. if (argptr[i]->get_type() == Variant::NIL)
  696. break;
  697. argc++;
  698. }
  699. //Variant::CallError error;
  700. call_multilevel(p_name, argptr, argc);
  701. #endif
  702. }
  703. Variant Object::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  704. r_error.error = Variant::CallError::CALL_OK;
  705. if (p_method == CoreStringNames::get_singleton()->_free) {
  706. //free must be here, before anything, always ready
  707. #ifdef DEBUG_ENABLED
  708. if (p_argcount != 0) {
  709. r_error.argument = 0;
  710. r_error.error = Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS;
  711. return Variant();
  712. }
  713. if (Object::cast_to<Reference>(this)) {
  714. r_error.argument = 0;
  715. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  716. ERR_EXPLAIN("Can't 'free' a reference.");
  717. ERR_FAIL_V(Variant());
  718. }
  719. if (_lock_index.get() > 1) {
  720. r_error.argument = 0;
  721. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  722. ERR_EXPLAIN("Object is locked and can't be freed.");
  723. ERR_FAIL_V(Variant());
  724. }
  725. #endif
  726. //must be here, must be before everything,
  727. memdelete(this);
  728. r_error.error = Variant::CallError::CALL_OK;
  729. return Variant();
  730. }
  731. Variant ret;
  732. OBJ_DEBUG_LOCK
  733. if (script_instance) {
  734. ret = script_instance->call(p_method, p_args, p_argcount, r_error);
  735. //force jumptable
  736. switch (r_error.error) {
  737. case Variant::CallError::CALL_OK:
  738. return ret;
  739. case Variant::CallError::CALL_ERROR_INVALID_METHOD:
  740. break;
  741. case Variant::CallError::CALL_ERROR_INVALID_ARGUMENT:
  742. case Variant::CallError::CALL_ERROR_TOO_MANY_ARGUMENTS:
  743. case Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS:
  744. return ret;
  745. case Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL: {
  746. }
  747. }
  748. }
  749. MethodBind *method = ClassDB::get_method(get_class_name(), p_method);
  750. if (method) {
  751. ret = method->call(this, p_args, p_argcount, r_error);
  752. } else {
  753. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  754. }
  755. return ret;
  756. }
  757. void Object::notification(int p_notification, bool p_reversed) {
  758. _notificationv(p_notification, p_reversed);
  759. if (script_instance) {
  760. script_instance->notification(p_notification);
  761. }
  762. }
  763. void Object::_changed_callback(Object *p_changed, const char *p_prop) {
  764. }
  765. void Object::add_change_receptor(Object *p_receptor) {
  766. change_receptors.insert(p_receptor);
  767. }
  768. void Object::remove_change_receptor(Object *p_receptor) {
  769. change_receptors.erase(p_receptor);
  770. }
  771. void Object::property_list_changed_notify() {
  772. _change_notify();
  773. }
  774. void Object::cancel_delete() {
  775. _predelete_ok = true;
  776. }
  777. void Object::set_script_and_instance(const RefPtr &p_script, ScriptInstance *p_instance) {
  778. //this function is not meant to be used in any of these ways
  779. ERR_FAIL_COND(p_script.is_null());
  780. ERR_FAIL_COND(!p_instance);
  781. ERR_FAIL_COND(script_instance != NULL || !script.is_null());
  782. script = p_script;
  783. script_instance = p_instance;
  784. }
  785. void Object::set_script(const RefPtr &p_script) {
  786. if (script == p_script)
  787. return;
  788. if (script_instance) {
  789. memdelete(script_instance);
  790. script_instance = NULL;
  791. }
  792. script = p_script;
  793. Ref<Script> s(script);
  794. if (!s.is_null() && s->can_instance()) {
  795. OBJ_DEBUG_LOCK
  796. script_instance = s->instance_create(this);
  797. }
  798. _change_notify("script");
  799. emit_signal(CoreStringNames::get_singleton()->script_changed);
  800. }
  801. void Object::set_script_instance(ScriptInstance *p_instance) {
  802. if (script_instance == p_instance)
  803. return;
  804. if (script_instance)
  805. memdelete(script_instance);
  806. script_instance = p_instance;
  807. if (p_instance)
  808. script = p_instance->get_script().get_ref_ptr();
  809. else
  810. script = RefPtr();
  811. }
  812. RefPtr Object::get_script() const {
  813. return script;
  814. }
  815. bool Object::has_meta(const String &p_name) const {
  816. return metadata.has(p_name);
  817. }
  818. void Object::set_meta(const String &p_name, const Variant &p_value) {
  819. if (p_value.get_type() == Variant::NIL) {
  820. metadata.erase(p_name);
  821. return;
  822. };
  823. metadata[p_name] = p_value;
  824. }
  825. Variant Object::get_meta(const String &p_name) const {
  826. ERR_FAIL_COND_V(!metadata.has(p_name), Variant());
  827. return metadata[p_name];
  828. }
  829. Array Object::_get_property_list_bind() const {
  830. List<PropertyInfo> lpi;
  831. get_property_list(&lpi);
  832. return convert_property_list(&lpi);
  833. }
  834. Array Object::_get_method_list_bind() const {
  835. List<MethodInfo> ml;
  836. get_method_list(&ml);
  837. Array ret;
  838. for (List<MethodInfo>::Element *E = ml.front(); E; E = E->next()) {
  839. Dictionary d = E->get();
  840. //va.push_back(d);
  841. ret.push_back(d);
  842. }
  843. return ret;
  844. }
  845. PoolVector<String> Object::_get_meta_list_bind() const {
  846. PoolVector<String> _metaret;
  847. List<Variant> keys;
  848. metadata.get_key_list(&keys);
  849. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  850. _metaret.push_back(E->get());
  851. }
  852. return _metaret;
  853. }
  854. void Object::get_meta_list(List<String> *p_list) const {
  855. List<Variant> keys;
  856. metadata.get_key_list(&keys);
  857. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  858. p_list->push_back(E->get());
  859. }
  860. }
  861. void Object::add_user_signal(const MethodInfo &p_signal) {
  862. ERR_FAIL_COND(p_signal.name == "");
  863. ERR_FAIL_COND(ClassDB::has_signal(get_class_name(), p_signal.name));
  864. ERR_FAIL_COND(signal_map.has(p_signal.name));
  865. Signal s;
  866. s.user = p_signal;
  867. signal_map[p_signal.name] = s;
  868. }
  869. bool Object::_has_user_signal(const StringName &p_name) const {
  870. if (!signal_map.has(p_name))
  871. return false;
  872. return signal_map[p_name].user.name.length() > 0;
  873. }
  874. struct _ObjectSignalDisconnectData {
  875. StringName signal;
  876. Object *target;
  877. StringName method;
  878. };
  879. #if 0
  880. void Object::_emit_signal(const StringName& p_name,const Array& p_pargs){
  881. Variant args[VARIANT_ARG_MAX];
  882. int count = p_pargs.size();
  883. for(int i=0;i<count;i++) {
  884. args[i]=p_pargs[i];
  885. }
  886. emit_signal(p_name,VARIANT_ARGS_FROM_ARRAY(args));
  887. }
  888. #endif
  889. Variant Object::_emit_signal(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  890. r_error.error = Variant::CallError::CALL_ERROR_TOO_FEW_ARGUMENTS;
  891. ERR_FAIL_COND_V(p_argcount < 1, Variant());
  892. if (p_args[0]->get_type() != Variant::STRING) {
  893. r_error.error = Variant::CallError::CALL_ERROR_INVALID_ARGUMENT;
  894. r_error.argument = 0;
  895. r_error.expected = Variant::STRING;
  896. ERR_FAIL_COND_V(p_args[0]->get_type() != Variant::STRING, Variant());
  897. }
  898. r_error.error = Variant::CallError::CALL_OK;
  899. StringName signal = *p_args[0];
  900. const Variant **args = NULL;
  901. int argc = p_argcount - 1;
  902. if (argc) {
  903. args = &p_args[1];
  904. }
  905. emit_signal(signal, args, argc);
  906. return Variant();
  907. }
  908. Error Object::emit_signal(const StringName &p_name, const Variant **p_args, int p_argcount) {
  909. if (_block_signals)
  910. return ERR_CANT_AQUIRE_RESOURCE; //no emit, signals blocked
  911. Signal *s = signal_map.getptr(p_name);
  912. if (!s) {
  913. #ifdef DEBUG_ENABLED
  914. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_name);
  915. //check in script
  916. if (!signal_is_valid && !script.is_null() && !Ref<Script>(script)->has_script_signal(p_name)) {
  917. ERR_EXPLAIN("Can't emit non-existing signal " + String("\"") + p_name + "\".");
  918. ERR_FAIL_V(ERR_UNAVAILABLE);
  919. }
  920. #endif
  921. //not connected? just return
  922. return ERR_UNAVAILABLE;
  923. }
  924. List<_ObjectSignalDisconnectData> disconnect_data;
  925. //copy on write will ensure that disconnecting the signal or even deleting the object will not affect the signal calling.
  926. //this happens automatically and will not change the performance of calling.
  927. //awesome, isn't it?
  928. VMap<Signal::Target, Signal::Slot> slot_map = s->slot_map;
  929. int ssize = slot_map.size();
  930. OBJ_DEBUG_LOCK
  931. Vector<const Variant *> bind_mem;
  932. Error err = OK;
  933. for (int i = 0; i < ssize; i++) {
  934. const Connection &c = slot_map.getv(i).conn;
  935. Object *target;
  936. #ifdef DEBUG_ENABLED
  937. target = ObjectDB::get_instance(slot_map.getk(i)._id);
  938. ERR_CONTINUE(!target);
  939. #else
  940. target = c.target;
  941. #endif
  942. const Variant **args = p_args;
  943. int argc = p_argcount;
  944. if (c.binds.size()) {
  945. //handle binds
  946. bind_mem.resize(p_argcount + c.binds.size());
  947. for (int j = 0; j < p_argcount; j++) {
  948. bind_mem[j] = p_args[j];
  949. }
  950. for (int j = 0; j < c.binds.size(); j++) {
  951. bind_mem[p_argcount + j] = &c.binds[j];
  952. }
  953. args = bind_mem.ptr();
  954. argc = bind_mem.size();
  955. }
  956. if (c.flags & CONNECT_DEFERRED) {
  957. MessageQueue::get_singleton()->push_call(target->get_instance_id(), c.method, args, argc, true);
  958. } else {
  959. Variant::CallError ce;
  960. target->call(c.method, args, argc, ce);
  961. if (ce.error != Variant::CallError::CALL_OK) {
  962. if (ce.error == Variant::CallError::CALL_ERROR_INVALID_METHOD && !ClassDB::class_exists(target->get_class_name())) {
  963. //most likely object is not initialized yet, do not throw error.
  964. } else {
  965. ERR_PRINTS("Error calling method from signal '" + String(p_name) + "': " + Variant::get_call_error_text(target, c.method, args, argc, ce));
  966. err = ERR_METHOD_NOT_FOUND;
  967. }
  968. }
  969. }
  970. if (c.flags & CONNECT_ONESHOT) {
  971. _ObjectSignalDisconnectData dd;
  972. dd.signal = p_name;
  973. dd.target = target;
  974. dd.method = c.method;
  975. disconnect_data.push_back(dd);
  976. }
  977. }
  978. while (!disconnect_data.empty()) {
  979. const _ObjectSignalDisconnectData &dd = disconnect_data.front()->get();
  980. disconnect(dd.signal, dd.target, dd.method);
  981. disconnect_data.pop_front();
  982. }
  983. return err;
  984. }
  985. Error Object::emit_signal(const StringName &p_name, VARIANT_ARG_DECLARE) {
  986. VARIANT_ARGPTRS;
  987. int argc = 0;
  988. for (int i = 0; i < VARIANT_ARG_MAX; i++) {
  989. if (argptr[i]->get_type() == Variant::NIL)
  990. break;
  991. argc++;
  992. }
  993. return emit_signal(p_name, argptr, argc);
  994. }
  995. void Object::_add_user_signal(const String &p_name, const Array &p_args) {
  996. // this version of add_user_signal is meant to be used from scripts or external apis
  997. // without access to ADD_SIGNAL in bind_methods
  998. // added events are per instance, as opposed to the other ones, which are global
  999. MethodInfo mi;
  1000. mi.name = p_name;
  1001. for (int i = 0; i < p_args.size(); i++) {
  1002. Dictionary d = p_args[i];
  1003. PropertyInfo param;
  1004. if (d.has("name"))
  1005. param.name = d["name"];
  1006. if (d.has("type"))
  1007. param.type = (Variant::Type)(int)d["type"];
  1008. mi.arguments.push_back(param);
  1009. }
  1010. add_user_signal(mi);
  1011. }
  1012. #if 0
  1013. void Object::_emit_signal(const StringName& p_name,const Array& p_pargs){
  1014. Variant args[VARIANT_ARG_MAX];
  1015. int count = p_pargs.size();
  1016. for(int i=0;i<count;i++) {
  1017. args[i]=p_pargs[i];
  1018. }
  1019. emit_signal(p_name,VARIANT_ARGS_FROM_ARRAY(args));
  1020. }
  1021. #endif
  1022. Array Object::_get_signal_list() const {
  1023. List<MethodInfo> signal_list;
  1024. get_signal_list(&signal_list);
  1025. Array ret;
  1026. for (List<MethodInfo>::Element *E = signal_list.front(); E; E = E->next()) {
  1027. ret.push_back(Dictionary(E->get()));
  1028. }
  1029. return ret;
  1030. }
  1031. Array Object::_get_signal_connection_list(const String &p_signal) const {
  1032. List<Connection> conns;
  1033. get_all_signal_connections(&conns);
  1034. Array ret;
  1035. for (List<Connection>::Element *E = conns.front(); E; E = E->next()) {
  1036. Connection &c = E->get();
  1037. if (c.signal == p_signal) {
  1038. Dictionary rc;
  1039. rc["signal"] = c.signal;
  1040. rc["method"] = c.method;
  1041. rc["source"] = c.source;
  1042. rc["target"] = c.target;
  1043. rc["binds"] = c.binds;
  1044. rc["flags"] = c.flags;
  1045. ret.push_back(rc);
  1046. }
  1047. }
  1048. return ret;
  1049. }
  1050. Array Object::_get_incoming_connections() const {
  1051. Array ret;
  1052. int connections_amount = connections.size();
  1053. for (int idx_conn = 0; idx_conn < connections_amount; idx_conn++) {
  1054. Dictionary conn_data;
  1055. conn_data["source"] = connections[idx_conn].source;
  1056. conn_data["signal_name"] = connections[idx_conn].signal;
  1057. conn_data["method_name"] = connections[idx_conn].method;
  1058. ret.push_back(conn_data);
  1059. }
  1060. return ret;
  1061. }
  1062. void Object::get_signal_list(List<MethodInfo> *p_signals) const {
  1063. if (!script.is_null()) {
  1064. Ref<Script>(script)->get_script_signal_list(p_signals);
  1065. }
  1066. ClassDB::get_signal_list(get_class_name(), p_signals);
  1067. //find maybe usersignals?
  1068. const StringName *S = NULL;
  1069. while ((S = signal_map.next(S))) {
  1070. if (signal_map[*S].user.name != "") {
  1071. //user signal
  1072. p_signals->push_back(signal_map[*S].user);
  1073. }
  1074. }
  1075. }
  1076. void Object::get_all_signal_connections(List<Connection> *p_connections) const {
  1077. const StringName *S = NULL;
  1078. while ((S = signal_map.next(S))) {
  1079. const Signal *s = &signal_map[*S];
  1080. for (int i = 0; i < s->slot_map.size(); i++) {
  1081. p_connections->push_back(s->slot_map.getv(i).conn);
  1082. }
  1083. }
  1084. }
  1085. void Object::get_signal_connection_list(const StringName &p_signal, List<Connection> *p_connections) const {
  1086. const Signal *s = signal_map.getptr(p_signal);
  1087. if (!s)
  1088. return; //nothing
  1089. for (int i = 0; i < s->slot_map.size(); i++)
  1090. p_connections->push_back(s->slot_map.getv(i).conn);
  1091. }
  1092. bool Object::has_persistent_signal_connections() const {
  1093. const StringName *S = NULL;
  1094. while ((S = signal_map.next(S))) {
  1095. const Signal *s = &signal_map[*S];
  1096. for (int i = 0; i < s->slot_map.size(); i++) {
  1097. if (s->slot_map.getv(i).conn.flags & CONNECT_PERSIST)
  1098. return true;
  1099. }
  1100. }
  1101. return false;
  1102. }
  1103. void Object::get_signals_connected_to_this(List<Connection> *p_connections) const {
  1104. for (const List<Connection>::Element *E = connections.front(); E; E = E->next()) {
  1105. p_connections->push_back(E->get());
  1106. }
  1107. }
  1108. 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) {
  1109. ERR_FAIL_NULL_V(p_to_object, ERR_INVALID_PARAMETER);
  1110. Signal *s = signal_map.getptr(p_signal);
  1111. if (!s) {
  1112. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_signal);
  1113. //check in script
  1114. if (!signal_is_valid && !script.is_null() && Ref<Script>(script)->has_script_signal(p_signal))
  1115. signal_is_valid = true;
  1116. if (!signal_is_valid) {
  1117. ERR_EXPLAIN("In Object of type '" + String(get_class()) + "': Attempt to connect nonexistent signal '" + p_signal + "' to method '" + p_to_object->get_class() + "." + p_to_method + "'");
  1118. ERR_FAIL_COND_V(!signal_is_valid, ERR_INVALID_PARAMETER);
  1119. }
  1120. signal_map[p_signal] = Signal();
  1121. s = &signal_map[p_signal];
  1122. }
  1123. Signal::Target target(p_to_object->get_instance_id(), p_to_method);
  1124. if (s->slot_map.has(target)) {
  1125. ERR_EXPLAIN("Signal '" + p_signal + "' is already connected to given method '" + p_to_method + "' in that object.");
  1126. ERR_FAIL_COND_V(s->slot_map.has(target), ERR_INVALID_PARAMETER);
  1127. }
  1128. Signal::Slot slot;
  1129. Connection conn;
  1130. conn.source = this;
  1131. conn.target = p_to_object;
  1132. conn.method = p_to_method;
  1133. conn.signal = p_signal;
  1134. conn.flags = p_flags;
  1135. conn.binds = p_binds;
  1136. slot.conn = conn;
  1137. slot.cE = p_to_object->connections.push_back(conn);
  1138. s->slot_map[target] = slot;
  1139. return OK;
  1140. }
  1141. bool Object::is_connected(const StringName &p_signal, Object *p_to_object, const StringName &p_to_method) const {
  1142. ERR_FAIL_NULL_V(p_to_object, false);
  1143. const Signal *s = signal_map.getptr(p_signal);
  1144. if (!s) {
  1145. bool signal_is_valid = ClassDB::has_signal(get_class_name(), p_signal);
  1146. if (signal_is_valid)
  1147. return false;
  1148. if (!script.is_null() && Ref<Script>(script)->has_script_signal(p_signal))
  1149. return false;
  1150. ERR_EXPLAIN("Nonexistent signal: " + p_signal);
  1151. ERR_FAIL_COND_V(!s, false);
  1152. }
  1153. Signal::Target target(p_to_object->get_instance_id(), p_to_method);
  1154. return s->slot_map.has(target);
  1155. //const Map<Signal::Target,Signal::Slot>::Element *E = s->slot_map.find(target);
  1156. //return (E!=NULL);
  1157. }
  1158. void Object::disconnect(const StringName &p_signal, Object *p_to_object, const StringName &p_to_method) {
  1159. ERR_FAIL_NULL(p_to_object);
  1160. Signal *s = signal_map.getptr(p_signal);
  1161. if (!s) {
  1162. ERR_EXPLAIN("Nonexistent signal: " + p_signal);
  1163. ERR_FAIL_COND(!s);
  1164. }
  1165. if (s->lock > 0) {
  1166. ERR_EXPLAIN("Attempt to disconnect signal '" + p_signal + "' while emitting (locks: " + itos(s->lock) + ")");
  1167. ERR_FAIL_COND(s->lock > 0);
  1168. }
  1169. Signal::Target target(p_to_object->get_instance_id(), p_to_method);
  1170. if (!s->slot_map.has(target)) {
  1171. ERR_EXPLAIN("Disconnecting nonexistent signal '" + p_signal + "', slot: " + itos(target._id) + ":" + target.method);
  1172. ERR_FAIL();
  1173. }
  1174. p_to_object->connections.erase(s->slot_map[target].cE);
  1175. s->slot_map.erase(target);
  1176. if (s->slot_map.empty() && ClassDB::has_signal(get_class_name(), p_signal)) {
  1177. //not user signal, delete
  1178. signal_map.erase(p_signal);
  1179. }
  1180. }
  1181. void Object::_set_bind(const String &p_set, const Variant &p_value) {
  1182. set(p_set, p_value);
  1183. }
  1184. Variant Object::_get_bind(const String &p_name) const {
  1185. return get(p_name);
  1186. }
  1187. void Object::initialize_class() {
  1188. static bool initialized = false;
  1189. if (initialized)
  1190. return;
  1191. ClassDB::_add_class<Object>();
  1192. _bind_methods();
  1193. initialized = true;
  1194. }
  1195. StringName Object::tr(const StringName &p_message) const {
  1196. if (!_can_translate || !TranslationServer::get_singleton())
  1197. return p_message;
  1198. return TranslationServer::get_singleton()->translate(p_message);
  1199. }
  1200. void Object::_clear_internal_resource_paths(const Variant &p_var) {
  1201. switch (p_var.get_type()) {
  1202. case Variant::OBJECT: {
  1203. RES r = p_var;
  1204. if (!r.is_valid())
  1205. return;
  1206. if (!r->get_path().begins_with("res://") || r->get_path().find("::") == -1)
  1207. return; //not an internal resource
  1208. Object *object = p_var;
  1209. if (!object)
  1210. return;
  1211. r->set_path("");
  1212. r->clear_internal_resource_paths();
  1213. } break;
  1214. case Variant::ARRAY: {
  1215. Array a = p_var;
  1216. for (int i = 0; i < a.size(); i++) {
  1217. _clear_internal_resource_paths(a[i]);
  1218. }
  1219. } break;
  1220. case Variant::DICTIONARY: {
  1221. Dictionary d = p_var;
  1222. List<Variant> keys;
  1223. d.get_key_list(&keys);
  1224. for (List<Variant>::Element *E = keys.front(); E; E = E->next()) {
  1225. _clear_internal_resource_paths(E->get());
  1226. _clear_internal_resource_paths(d[E->get()]);
  1227. }
  1228. } break;
  1229. default: {}
  1230. }
  1231. }
  1232. #ifdef TOOLS_ENABLED
  1233. void Object::editor_set_section_unfold(const String &p_section, bool p_unfolded) {
  1234. set_edited(true);
  1235. if (p_unfolded)
  1236. editor_section_folding.insert(p_section);
  1237. else
  1238. editor_section_folding.erase(p_section);
  1239. }
  1240. bool Object::editor_is_section_unfolded(const String &p_section) {
  1241. return editor_section_folding.has(p_section);
  1242. }
  1243. #endif
  1244. void Object::clear_internal_resource_paths() {
  1245. List<PropertyInfo> pinfo;
  1246. get_property_list(&pinfo);
  1247. for (List<PropertyInfo>::Element *E = pinfo.front(); E; E = E->next()) {
  1248. _clear_internal_resource_paths(get(E->get().name));
  1249. }
  1250. }
  1251. void Object::_bind_methods() {
  1252. ClassDB::bind_method(D_METHOD("get_class"), &Object::get_class);
  1253. ClassDB::bind_method(D_METHOD("is_class", "type"), &Object::is_class);
  1254. ClassDB::bind_method(D_METHOD("set", "property", "value"), &Object::_set_bind);
  1255. ClassDB::bind_method(D_METHOD("get", "property"), &Object::_get_bind);
  1256. ClassDB::bind_method(D_METHOD("get_property_list"), &Object::_get_property_list_bind);
  1257. ClassDB::bind_method(D_METHOD("get_method_list"), &Object::_get_method_list_bind);
  1258. ClassDB::bind_method(D_METHOD("notification", "what", "reversed"), &Object::notification, DEFVAL(false));
  1259. ClassDB::bind_method(D_METHOD("get_instance_id"), &Object::get_instance_id);
  1260. ClassDB::bind_method(D_METHOD("set_script", "script"), &Object::set_script);
  1261. ClassDB::bind_method(D_METHOD("get_script"), &Object::get_script);
  1262. ClassDB::bind_method(D_METHOD("set_meta", "name", "value"), &Object::set_meta);
  1263. ClassDB::bind_method(D_METHOD("get_meta", "name"), &Object::get_meta);
  1264. ClassDB::bind_method(D_METHOD("has_meta", "name"), &Object::has_meta);
  1265. ClassDB::bind_method(D_METHOD("get_meta_list"), &Object::_get_meta_list_bind);
  1266. //todo reimplement this per language so all 5 arguments can be called
  1267. //ClassDB::bind_method(D_METHOD("call","method","arg1","arg2","arg3","arg4"),&Object::_call_bind,DEFVAL(Variant()),DEFVAL(Variant()),DEFVAL(Variant()),DEFVAL(Variant()));
  1268. //ClassDB::bind_method(D_METHOD("call_deferred","method","arg1","arg2","arg3","arg4"),&Object::_call_deferred_bind,DEFVAL(Variant()),DEFVAL(Variant()),DEFVAL(Variant()),DEFVAL(Variant()));
  1269. ClassDB::bind_method(D_METHOD("add_user_signal", "signal", "arguments"), &Object::_add_user_signal, DEFVAL(Array()));
  1270. ClassDB::bind_method(D_METHOD("has_user_signal", "signal"), &Object::_has_user_signal);
  1271. //ClassDB::bind_method(D_METHOD("emit_signal","signal","arguments"),&Object::_emit_signal,DEFVAL(Array()));
  1272. {
  1273. MethodInfo mi;
  1274. mi.name = "emit_signal";
  1275. mi.arguments.push_back(PropertyInfo(Variant::STRING, "signal"));
  1276. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "emit_signal", &Object::_emit_signal, mi);
  1277. }
  1278. {
  1279. MethodInfo mi;
  1280. mi.name = "call";
  1281. mi.arguments.push_back(PropertyInfo(Variant::STRING, "method"));
  1282. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "call", &Object::_call_bind, mi);
  1283. }
  1284. {
  1285. MethodInfo mi;
  1286. mi.name = "call_deferred";
  1287. mi.arguments.push_back(PropertyInfo(Variant::STRING, "method"));
  1288. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "call_deferred", &Object::_call_deferred_bind, mi);
  1289. }
  1290. ClassDB::bind_method(D_METHOD("callv", "method", "arg_array"), &Object::callv);
  1291. ClassDB::bind_method(D_METHOD("has_method", "method"), &Object::has_method);
  1292. ClassDB::bind_method(D_METHOD("get_signal_list"), &Object::_get_signal_list);
  1293. ClassDB::bind_method(D_METHOD("get_signal_connection_list", "signal"), &Object::_get_signal_connection_list);
  1294. ClassDB::bind_method(D_METHOD("get_incoming_connections"), &Object::_get_incoming_connections);
  1295. ClassDB::bind_method(D_METHOD("connect", "signal", "target", "method", "binds", "flags"), &Object::connect, DEFVAL(Array()), DEFVAL(0));
  1296. ClassDB::bind_method(D_METHOD("disconnect", "signal", "target", "method"), &Object::disconnect);
  1297. ClassDB::bind_method(D_METHOD("is_connected", "signal", "target", "method"), &Object::is_connected);
  1298. ClassDB::bind_method(D_METHOD("set_block_signals", "enable"), &Object::set_block_signals);
  1299. ClassDB::bind_method(D_METHOD("is_blocking_signals"), &Object::is_blocking_signals);
  1300. ClassDB::bind_method(D_METHOD("property_list_changed_notify"), &Object::property_list_changed_notify);
  1301. ClassDB::bind_method(D_METHOD("set_message_translation", "enable"), &Object::set_message_translation);
  1302. ClassDB::bind_method(D_METHOD("can_translate_messages"), &Object::can_translate_messages);
  1303. ClassDB::bind_method(D_METHOD("tr", "message"), &Object::tr);
  1304. ClassDB::bind_method(D_METHOD("is_queued_for_deletion"), &Object::is_queued_for_deletion);
  1305. ClassDB::add_virtual_method("Object", MethodInfo("free"), false);
  1306. ADD_SIGNAL(MethodInfo("script_changed"));
  1307. BIND_VMETHOD(MethodInfo("_notification", PropertyInfo(Variant::INT, "what")));
  1308. BIND_VMETHOD(MethodInfo("_set:bool", PropertyInfo(Variant::STRING, "property"), PropertyInfo(Variant::NIL, "value")));
  1309. #ifdef TOOLS_ENABLED
  1310. MethodInfo miget("_get", PropertyInfo(Variant::STRING, "property"));
  1311. miget.return_val.name = "Variant";
  1312. BIND_VMETHOD(miget);
  1313. MethodInfo plget("_get_property_list");
  1314. plget.return_val.type = Variant::ARRAY;
  1315. BIND_VMETHOD(plget);
  1316. #endif
  1317. BIND_VMETHOD(MethodInfo("_init"));
  1318. BIND_CONSTANT(NOTIFICATION_POSTINITIALIZE);
  1319. BIND_CONSTANT(NOTIFICATION_PREDELETE);
  1320. BIND_ENUM_CONSTANT(CONNECT_DEFERRED);
  1321. BIND_ENUM_CONSTANT(CONNECT_PERSIST);
  1322. BIND_ENUM_CONSTANT(CONNECT_ONESHOT);
  1323. }
  1324. void Object::call_deferred(const StringName &p_method, VARIANT_ARG_DECLARE) {
  1325. MessageQueue::get_singleton()->push_call(this, p_method, VARIANT_ARG_PASS);
  1326. }
  1327. void Object::set_block_signals(bool p_block) {
  1328. _block_signals = p_block;
  1329. }
  1330. bool Object::is_blocking_signals() const {
  1331. return _block_signals;
  1332. }
  1333. void Object::get_translatable_strings(List<String> *p_strings) const {
  1334. List<PropertyInfo> plist;
  1335. get_property_list(&plist);
  1336. for (List<PropertyInfo>::Element *E = plist.front(); E; E = E->next()) {
  1337. if (!(E->get().usage & PROPERTY_USAGE_INTERNATIONALIZED))
  1338. continue;
  1339. String text = get(E->get().name);
  1340. if (text == "")
  1341. continue;
  1342. p_strings->push_back(text);
  1343. }
  1344. }
  1345. Variant::Type Object::get_static_property_type(const StringName &p_property, bool *r_valid) const {
  1346. bool valid;
  1347. Variant::Type t = ClassDB::get_property_type(get_class_name(), p_property, &valid);
  1348. if (valid) {
  1349. if (r_valid)
  1350. *r_valid = true;
  1351. return t;
  1352. }
  1353. if (get_script_instance()) {
  1354. return get_script_instance()->get_property_type(p_property, r_valid);
  1355. }
  1356. if (r_valid)
  1357. *r_valid = false;
  1358. return Variant::NIL;
  1359. }
  1360. bool Object::is_queued_for_deletion() const {
  1361. return _is_queued_for_deletion;
  1362. }
  1363. #ifdef TOOLS_ENABLED
  1364. void Object::set_edited(bool p_edited) {
  1365. _edited = p_edited;
  1366. _edited_version++;
  1367. }
  1368. bool Object::is_edited() const {
  1369. return _edited;
  1370. }
  1371. uint32_t Object::get_edited_version() const {
  1372. return _edited_version;
  1373. }
  1374. #endif
  1375. void *Object::get_script_instance_binding(int p_script_language_index) {
  1376. #ifdef DEBUG_ENABLED
  1377. ERR_FAIL_INDEX_V(p_script_language_index, MAX_SCRIPT_INSTANCE_BINDINGS, NULL);
  1378. #endif
  1379. //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
  1380. //just return the same pointer.
  1381. //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
  1382. //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
  1383. if (!_script_instance_bindings[p_script_language_index]) {
  1384. _script_instance_bindings[p_script_language_index] = ScriptServer::get_language(p_script_language_index)->alloc_instance_binding_data(this);
  1385. }
  1386. return _script_instance_bindings[p_script_language_index];
  1387. }
  1388. Object::Object() {
  1389. _class_ptr = NULL;
  1390. _block_signals = false;
  1391. _predelete_ok = 0;
  1392. _instance_ID = 0;
  1393. _instance_ID = ObjectDB::add_instance(this);
  1394. _can_translate = true;
  1395. _is_queued_for_deletion = false;
  1396. memset(_script_instance_bindings, 0, sizeof(void *) * MAX_SCRIPT_INSTANCE_BINDINGS);
  1397. script_instance = NULL;
  1398. #ifdef TOOLS_ENABLED
  1399. _edited = false;
  1400. _edited_version = 0;
  1401. #endif
  1402. #ifdef DEBUG_ENABLED
  1403. _lock_index.init(1);
  1404. #endif
  1405. }
  1406. Object::~Object() {
  1407. if (script_instance)
  1408. memdelete(script_instance);
  1409. script_instance = NULL;
  1410. List<Connection> sconnections;
  1411. const StringName *S = NULL;
  1412. while ((S = signal_map.next(S))) {
  1413. Signal *s = &signal_map[*S];
  1414. ERR_EXPLAIN("Attempt to delete an object in the middle of a signal emission from it");
  1415. ERR_CONTINUE(s->lock > 0);
  1416. for (int i = 0; i < s->slot_map.size(); i++) {
  1417. sconnections.push_back(s->slot_map.getv(i).conn);
  1418. }
  1419. }
  1420. for (List<Connection>::Element *E = sconnections.front(); E; E = E->next()) {
  1421. Connection &c = E->get();
  1422. ERR_CONTINUE(c.source != this); //bug?
  1423. this->disconnect(c.signal, c.target, c.method);
  1424. }
  1425. while (connections.size()) {
  1426. Connection c = connections.front()->get();
  1427. c.source->disconnect(c.signal, c.target, c.method);
  1428. }
  1429. ObjectDB::remove_instance(this);
  1430. _instance_ID = 0;
  1431. _predelete_ok = 2;
  1432. for (int i = 0; i < MAX_SCRIPT_INSTANCE_BINDINGS; i++) {
  1433. if (_script_instance_bindings[i]) {
  1434. ScriptServer::get_language(i)->free_instance_binding_data(_script_instance_bindings[i]);
  1435. }
  1436. }
  1437. }
  1438. bool predelete_handler(Object *p_object) {
  1439. return p_object->_predelete();
  1440. }
  1441. void postinitialize_handler(Object *p_object) {
  1442. p_object->_postinitialize();
  1443. }
  1444. HashMap<ObjectID, Object *> ObjectDB::instances;
  1445. ObjectID ObjectDB::instance_counter = 1;
  1446. HashMap<Object *, ObjectID, ObjectDB::ObjectPtrHash> ObjectDB::instance_checks;
  1447. ObjectID ObjectDB::add_instance(Object *p_object) {
  1448. ERR_FAIL_COND_V(p_object->get_instance_id() != 0, 0);
  1449. rw_lock->write_lock();
  1450. instances[++instance_counter] = p_object;
  1451. #ifdef DEBUG_ENABLED
  1452. instance_checks[p_object] = instance_counter;
  1453. #endif
  1454. rw_lock->write_unlock();
  1455. return instance_counter;
  1456. }
  1457. void ObjectDB::remove_instance(Object *p_object) {
  1458. rw_lock->write_lock();
  1459. instances.erase(p_object->get_instance_id());
  1460. #ifdef DEBUG_ENABLED
  1461. instance_checks.erase(p_object);
  1462. #endif
  1463. rw_lock->write_unlock();
  1464. }
  1465. Object *ObjectDB::get_instance(ObjectID p_instance_ID) {
  1466. rw_lock->read_lock();
  1467. Object **obj = instances.getptr(p_instance_ID);
  1468. rw_lock->read_unlock();
  1469. if (!obj)
  1470. return NULL;
  1471. return *obj;
  1472. }
  1473. void ObjectDB::debug_objects(DebugFunc p_func) {
  1474. rw_lock->read_lock();
  1475. const ObjectID *K = NULL;
  1476. while ((K = instances.next(K))) {
  1477. p_func(instances[*K]);
  1478. }
  1479. rw_lock->read_unlock();
  1480. }
  1481. void Object::get_argument_options(const StringName &p_function, int p_idx, List<String> *r_options) const {
  1482. }
  1483. int ObjectDB::get_object_count() {
  1484. rw_lock->read_lock();
  1485. int count = instances.size();
  1486. rw_lock->read_unlock();
  1487. return count;
  1488. }
  1489. RWLock *ObjectDB::rw_lock = NULL;
  1490. void ObjectDB::setup() {
  1491. rw_lock = RWLock::create();
  1492. }
  1493. void ObjectDB::cleanup() {
  1494. rw_lock->write_lock();
  1495. if (instances.size()) {
  1496. WARN_PRINT("ObjectDB Instances still exist!");
  1497. if (OS::get_singleton()->is_stdout_verbose()) {
  1498. const ObjectID *K = NULL;
  1499. while ((K = instances.next(K))) {
  1500. String node_name;
  1501. if (instances[*K]->is_class("Node"))
  1502. node_name = " - Node Name: " + String(instances[*K]->call("get_name"));
  1503. if (instances[*K]->is_class("Resource"))
  1504. node_name = " - Resource Name: " + String(instances[*K]->call("get_name")) + " Path: " + String(instances[*K]->call("get_path"));
  1505. print_line("Leaked Instance: " + String(instances[*K]->get_class()) + ":" + itos(*K) + node_name);
  1506. }
  1507. }
  1508. }
  1509. instances.clear();
  1510. instance_checks.clear();
  1511. rw_lock->write_unlock();
  1512. memdelete(rw_lock);
  1513. }