object.cpp 45 KB

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