object.cpp 45 KB

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