object.cpp 50 KB

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