object.cpp 43 KB

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