object.cpp 43 KB

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