object.cpp 50 KB

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