nativescript.cpp 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227
  1. /*************************************************************************/
  2. /* nativescript.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 "nativescript.h"
  31. #include "modules/gdnative/godot/gdnative.h"
  32. #include "global_constants.h"
  33. #include "io/file_access_encrypted.h"
  34. #include "os/file_access.h"
  35. #include "os/os.h"
  36. #include "project_settings.h"
  37. #include "scene/main/scene_tree.h"
  38. #include "scene/resources/scene_format_text.h"
  39. #ifndef NO_THREADS
  40. #include "os/thread.h"
  41. #endif
  42. #if defined(TOOLS_ENABLED) && defined(DEBUG_METHODS_ENABLED)
  43. #include "api_generator.h"
  44. #endif
  45. #ifdef TOOLS_ENABLED
  46. #include "editor/editor_node.h"
  47. #endif
  48. ////// Script stuff
  49. void NativeScript::_bind_methods() {
  50. ClassDB::bind_method(D_METHOD("set_class_name", "class_name:String"), &NativeScript::set_class_name);
  51. ClassDB::bind_method(D_METHOD("get_class_name:String"), &NativeScript::get_class_name);
  52. ClassDB::bind_method(D_METHOD("set_library", "library:GDNativeLibrary"), &NativeScript::set_library);
  53. ClassDB::bind_method(D_METHOD("get_library:GDNativeLibrary"), &NativeScript::get_library);
  54. ADD_PROPERTYNZ(PropertyInfo(Variant::STRING, "class_name"), "set_class_name", "get_class_name");
  55. ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT, "library", PROPERTY_HINT_RESOURCE_TYPE, "GDNativeLibrary"), "set_library", "get_library");
  56. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &NativeScript::_new, MethodInfo(Variant::OBJECT, "new"));
  57. }
  58. #define NSL NativeScriptLanguage::get_singleton()
  59. #ifdef TOOLS_ENABLED
  60. void NativeScript::_update_placeholder(PlaceHolderScriptInstance *p_placeholder) {
  61. NativeScriptDesc *script_data = get_script_desc();
  62. ERR_FAIL_COND(!script_data);
  63. List<PropertyInfo> info;
  64. Map<StringName, Variant> values;
  65. for (Map<StringName, NativeScriptDesc::Property>::Element *E = script_data->properties.front(); E; E = E->next()) {
  66. PropertyInfo p = E->get().info;
  67. p.name = String(E->key());
  68. info.push_back(p);
  69. values[p.name] = E->get().default_value;
  70. }
  71. p_placeholder->update(info, values);
  72. }
  73. void NativeScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  74. placeholders.erase(p_placeholder);
  75. }
  76. #endif
  77. void NativeScript::set_class_name(String p_class_name) {
  78. class_name = p_class_name;
  79. }
  80. String NativeScript::get_class_name() const {
  81. return class_name;
  82. }
  83. void NativeScript::set_library(Ref<GDNativeLibrary> p_library) {
  84. if (!library.is_null()) {
  85. WARN_PRINT("library on NativeScript already set. Do nothing.");
  86. return;
  87. }
  88. library = p_library;
  89. lib_path = library->get_active_library_path();
  90. #ifndef NO_THREADS
  91. if (Thread::get_caller_ID() != Thread::get_main_ID()) {
  92. NSL->defer_init_library(p_library, this);
  93. } else
  94. #endif
  95. {
  96. NSL->init_library(p_library);
  97. NSL->register_script(this);
  98. }
  99. }
  100. Ref<GDNativeLibrary> NativeScript::get_library() const {
  101. return library;
  102. }
  103. bool NativeScript::can_instance() const {
  104. NativeScriptDesc *script_data = get_script_desc();
  105. #ifdef TOOLS_ENABLED
  106. return script_data || (!is_tool() && !ScriptServer::is_scripting_enabled());
  107. #else
  108. return script_data;
  109. #endif
  110. }
  111. // TODO(karroffel): implement this
  112. Ref<Script> NativeScript::get_base_script() const {
  113. NativeScriptDesc *script_data = get_script_desc();
  114. if (!script_data)
  115. return Ref<Script>();
  116. Ref<NativeScript> ns = Ref<NativeScript>(NSL->create_script());
  117. ns->set_class_name(script_data->base);
  118. ns->set_library(get_library());
  119. return ns;
  120. }
  121. StringName NativeScript::get_instance_base_type() const {
  122. NativeScriptDesc *script_data = get_script_desc();
  123. if (!script_data)
  124. return "";
  125. return script_data->base_native_type;
  126. }
  127. ScriptInstance *NativeScript::instance_create(Object *p_this) {
  128. NativeScriptDesc *script_data = get_script_desc();
  129. if (!script_data) {
  130. return NULL;
  131. }
  132. #ifdef TOOLS_ENABLED
  133. if (!ScriptServer::is_scripting_enabled() && !is_tool()) {
  134. // placeholder for nodes. For tools we want the rool thing.
  135. PlaceHolderScriptInstance *sins = memnew(PlaceHolderScriptInstance(NSL, Ref<Script>(this), p_this));
  136. placeholders.insert(sins);
  137. if (script_data->create_func.create_func) {
  138. script_data->create_func.create_func(
  139. (godot_object *)p_this,
  140. script_data->create_func.method_data);
  141. }
  142. _update_placeholder(sins);
  143. return sins;
  144. }
  145. #endif
  146. NativeScriptInstance *nsi = memnew(NativeScriptInstance);
  147. nsi->owner = p_this;
  148. nsi->script = Ref<NativeScript>(this);
  149. #ifndef TOOLS_ENABLED
  150. if (!ScriptServer::is_scripting_enabled()) {
  151. nsi->userdata = NULL;
  152. } else {
  153. nsi->userdata = script_data->create_func.create_func((godot_object *)p_this, script_data->create_func.method_data);
  154. }
  155. #else
  156. nsi->userdata = script_data->create_func.create_func((godot_object *)p_this, script_data->create_func.method_data);
  157. #endif
  158. #ifndef NO_THREADS
  159. owners_lock->lock();
  160. #endif
  161. instance_owners.insert(p_this);
  162. #ifndef NO_THREADS
  163. owners_lock->unlock();
  164. #endif
  165. return nsi;
  166. }
  167. bool NativeScript::instance_has(const Object *p_this) const {
  168. return instance_owners.has((Object *)p_this);
  169. }
  170. bool NativeScript::has_source_code() const {
  171. return false;
  172. }
  173. String NativeScript::get_source_code() const {
  174. return "";
  175. }
  176. void NativeScript::set_source_code(const String &p_code) {
  177. }
  178. Error NativeScript::reload(bool p_keep_state) {
  179. return FAILED;
  180. }
  181. bool NativeScript::has_method(const StringName &p_method) const {
  182. NativeScriptDesc *script_data = get_script_desc();
  183. while (script_data) {
  184. if (script_data->methods.has(p_method))
  185. return true;
  186. script_data = script_data->base_data;
  187. }
  188. return false;
  189. }
  190. MethodInfo NativeScript::get_method_info(const StringName &p_method) const {
  191. NativeScriptDesc *script_data = get_script_desc();
  192. if (!script_data)
  193. return MethodInfo();
  194. while (script_data) {
  195. Map<StringName, NativeScriptDesc::Method>::Element *M = script_data->methods.find(p_method);
  196. if (M)
  197. return M->get().info;
  198. script_data = script_data->base_data;
  199. }
  200. return MethodInfo();
  201. }
  202. bool NativeScript::is_tool() const {
  203. NativeScriptDesc *script_data = get_script_desc();
  204. if (script_data)
  205. return script_data->is_tool;
  206. return false;
  207. }
  208. String NativeScript::get_node_type() const {
  209. return ""; // NOTE(karroffel): uhm?
  210. }
  211. ScriptLanguage *NativeScript::get_language() const {
  212. return NativeScriptLanguage::get_singleton();
  213. }
  214. bool NativeScript::has_script_signal(const StringName &p_signal) const {
  215. NativeScriptDesc *script_data = get_script_desc();
  216. while (script_data) {
  217. if (script_data->signals_.has(p_signal))
  218. return true;
  219. script_data = script_data->base_data;
  220. }
  221. return false;
  222. }
  223. void NativeScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  224. NativeScriptDesc *script_data = get_script_desc();
  225. if (!script_data)
  226. return;
  227. Set<MethodInfo> signals_;
  228. while (script_data) {
  229. for (Map<StringName, NativeScriptDesc::Signal>::Element *S = script_data->signals_.front(); S; S = S->next()) {
  230. signals_.insert(S->get().signal);
  231. }
  232. script_data = script_data->base_data;
  233. }
  234. for (Set<MethodInfo>::Element *E = signals_.front(); E; E = E->next()) {
  235. r_signals->push_back(E->get());
  236. }
  237. }
  238. bool NativeScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  239. NativeScriptDesc *script_data = get_script_desc();
  240. if (!script_data)
  241. return false;
  242. Map<StringName, NativeScriptDesc::Property>::Element *P = script_data->properties.find(p_property);
  243. if (!P)
  244. return false;
  245. r_value = P->get().default_value;
  246. return true;
  247. }
  248. void NativeScript::update_exports() {
  249. }
  250. void NativeScript::get_script_method_list(List<MethodInfo> *p_list) const {
  251. NativeScriptDesc *script_data = get_script_desc();
  252. if (!script_data)
  253. return;
  254. Set<MethodInfo> methods;
  255. while (script_data) {
  256. for (Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.front(); E; E = E->next()) {
  257. methods.insert(E->get().info);
  258. }
  259. script_data = script_data->base_data;
  260. }
  261. for (Set<MethodInfo>::Element *E = methods.front(); E; E = E->next()) {
  262. p_list->push_back(E->get());
  263. }
  264. }
  265. void NativeScript::get_script_property_list(List<PropertyInfo> *p_list) const {
  266. NativeScriptDesc *script_data = get_script_desc();
  267. if (!script_data)
  268. return;
  269. Set<PropertyInfo> properties;
  270. while (script_data) {
  271. for (Map<StringName, NativeScriptDesc::Property>::Element *E = script_data->properties.front(); E; E = E->next()) {
  272. properties.insert(E->get().info);
  273. }
  274. script_data = script_data->base_data;
  275. }
  276. for (Set<PropertyInfo>::Element *E = properties.front(); E; E = E->next()) {
  277. p_list->push_back(E->get());
  278. }
  279. }
  280. Variant NativeScript::_new(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  281. if (lib_path.empty() || class_name.empty() || library.is_null()) {
  282. r_error.error = Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL;
  283. return Variant();
  284. }
  285. NativeScriptDesc *script_data = get_script_desc();
  286. if (!script_data) {
  287. r_error.error = Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL;
  288. return Variant();
  289. }
  290. r_error.error = Variant::CallError::CALL_OK;
  291. REF ref;
  292. Object *owner = NULL;
  293. if (!(script_data->base_native_type == "")) {
  294. owner = ClassDB::instance(script_data->base_native_type);
  295. } else {
  296. owner = memnew(Reference);
  297. }
  298. Reference *r = owner->cast_to<Reference>();
  299. if (r) {
  300. ref = REF(r);
  301. }
  302. NativeScriptInstance *instance = (NativeScriptInstance *)instance_create(owner);
  303. owner->set_script_instance(instance);
  304. if (!instance) {
  305. if (ref.is_null()) {
  306. memdelete(owner); //no owner, sorry
  307. }
  308. return Variant();
  309. }
  310. if (ref.is_valid()) {
  311. return ref;
  312. } else {
  313. return owner;
  314. }
  315. }
  316. // TODO(karroffel): implement this
  317. NativeScript::NativeScript() {
  318. library = Ref<GDNative>();
  319. lib_path = "";
  320. class_name = "";
  321. #ifndef NO_THREADS
  322. owners_lock = Mutex::create();
  323. #endif
  324. }
  325. // TODO(karroffel): implement this
  326. NativeScript::~NativeScript() {
  327. NSL->unregister_script(this);
  328. #ifndef NO_THREADS
  329. memdelete(owners_lock);
  330. #endif
  331. }
  332. ////// ScriptInstance stuff
  333. #define GET_SCRIPT_DESC() script->get_script_desc()
  334. void NativeScriptInstance::_ml_call_reversed(NativeScriptDesc *script_data, const StringName &p_method, const Variant **p_args, int p_argcount) {
  335. if (script_data->base_data) {
  336. _ml_call_reversed(script_data->base_data, p_method, p_args, p_argcount);
  337. }
  338. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find(p_method);
  339. if (E) {
  340. godot_variant res = E->get().method.method((godot_object *)owner, E->get().method.method_data, userdata, p_argcount, (godot_variant **)p_args);
  341. godot_variant_destroy(&res);
  342. }
  343. }
  344. bool NativeScriptInstance::set(const StringName &p_name, const Variant &p_value) {
  345. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  346. while (script_data) {
  347. Map<StringName, NativeScriptDesc::Property>::Element *P = script_data->properties.find(p_name);
  348. if (P) {
  349. P->get().setter.set_func((godot_object *)owner,
  350. P->get().setter.method_data,
  351. userdata,
  352. (godot_variant *)&p_value);
  353. return true;
  354. }
  355. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find("_set");
  356. if (E) {
  357. Variant name = p_name;
  358. const Variant *args[2] = { &name, &p_value };
  359. E->get().method.method((godot_object *)owner,
  360. E->get().method.method_data,
  361. userdata,
  362. 2,
  363. (godot_variant **)args);
  364. return true;
  365. }
  366. script_data = script_data->base_data;
  367. }
  368. return false;
  369. }
  370. bool NativeScriptInstance::get(const StringName &p_name, Variant &r_ret) const {
  371. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  372. while (script_data) {
  373. Map<StringName, NativeScriptDesc::Property>::Element *P = script_data->properties.find(p_name);
  374. if (P) {
  375. godot_variant value;
  376. value = P->get().getter.get_func((godot_object *)owner,
  377. P->get().getter.method_data,
  378. userdata);
  379. r_ret = *(Variant *)&value;
  380. godot_variant_destroy(&value);
  381. return true;
  382. }
  383. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find("_get");
  384. if (E) {
  385. Variant name = p_name;
  386. const Variant *args[1] = { &name };
  387. godot_variant result;
  388. result = E->get().method.method((godot_object *)owner,
  389. E->get().method.method_data,
  390. userdata,
  391. 1,
  392. (godot_variant **)args);
  393. r_ret = *(Variant *)&result;
  394. godot_variant_destroy(&result);
  395. if (r_ret.get_type() == Variant::NIL) {
  396. return false;
  397. }
  398. return true;
  399. }
  400. script_data = script_data->base_data;
  401. }
  402. return false;
  403. }
  404. void NativeScriptInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  405. script->get_script_property_list(p_properties);
  406. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  407. while (script_data) {
  408. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find("_get_property_list");
  409. if (E) {
  410. godot_variant result;
  411. result = E->get().method.method((godot_object *)owner,
  412. E->get().method.method_data,
  413. userdata,
  414. 0,
  415. NULL);
  416. Variant res = *(Variant *)&result;
  417. godot_variant_destroy(&result);
  418. if (res.get_type() != Variant::ARRAY) {
  419. ERR_EXPLAIN("_get_property_list must return an array of dictionaries");
  420. ERR_FAIL();
  421. }
  422. Array arr = res;
  423. for (int i = 0; i < arr.size(); i++) {
  424. Dictionary d = arr[i];
  425. ERR_CONTINUE(!d.has("name"));
  426. ERR_CONTINUE(!d.has("type"));
  427. PropertyInfo info;
  428. info.type = Variant::Type(d["type"].operator int64_t());
  429. ERR_CONTINUE(info.type < 0 || info.type >= Variant::VARIANT_MAX);
  430. info.name = d["name"];
  431. ERR_CONTINUE(info.name == "");
  432. if (d.has("hint")) {
  433. info.hint = PropertyHint(d["hint"].operator int64_t());
  434. }
  435. if (d.has("hint_string")) {
  436. info.hint_string = d["hint_string"];
  437. }
  438. if (d.has("usage")) {
  439. info.usage = d["usage"];
  440. }
  441. p_properties->push_back(info);
  442. }
  443. }
  444. script_data = script_data->base_data;
  445. }
  446. return;
  447. }
  448. Variant::Type NativeScriptInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  449. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  450. while (script_data) {
  451. Map<StringName, NativeScriptDesc::Property>::Element *P = script_data->properties.find(p_name);
  452. if (P) {
  453. *r_is_valid = true;
  454. return P->get().info.type;
  455. }
  456. script_data = script_data->base_data;
  457. }
  458. return Variant::NIL;
  459. }
  460. void NativeScriptInstance::get_method_list(List<MethodInfo> *p_list) const {
  461. script->get_method_list(p_list);
  462. }
  463. bool NativeScriptInstance::has_method(const StringName &p_method) const {
  464. return script->has_method(p_method);
  465. }
  466. Variant NativeScriptInstance::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  467. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  468. while (script_data) {
  469. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find(p_method);
  470. if (E) {
  471. godot_variant result;
  472. result = E->get().method.method((godot_object *)owner,
  473. E->get().method.method_data,
  474. userdata,
  475. p_argcount,
  476. (godot_variant **)p_args);
  477. Variant res = *(Variant *)&result;
  478. godot_variant_destroy(&result);
  479. r_error.error = Variant::CallError::CALL_OK;
  480. return res;
  481. }
  482. script_data = script_data->base_data;
  483. }
  484. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  485. return Variant();
  486. }
  487. void NativeScriptInstance::notification(int p_notification) {
  488. Variant value = p_notification;
  489. const Variant *args[1] = { &value };
  490. call_multilevel("_notification", args, 1);
  491. }
  492. void NativeScriptInstance::refcount_incremented() {
  493. Variant::CallError err;
  494. call("_refcount_incremented", NULL, 0, err);
  495. if (err.error != Variant::CallError::CALL_OK && err.error != Variant::CallError::CALL_ERROR_INVALID_METHOD) {
  496. ERR_PRINT("Failed to invoke _refcount_incremented - should not happen");
  497. }
  498. }
  499. bool NativeScriptInstance::refcount_decremented() {
  500. Variant::CallError err;
  501. Variant ret = call("_refcount_decremented", NULL, 0, err);
  502. if (err.error != Variant::CallError::CALL_OK && err.error != Variant::CallError::CALL_ERROR_INVALID_METHOD) {
  503. ERR_PRINT("Failed to invoke _refcount_decremented - should not happen");
  504. return true; // assume we can destroy the object
  505. }
  506. if (err.error == Variant::CallError::CALL_ERROR_INVALID_METHOD) {
  507. // the method does not exist, default is true
  508. return true;
  509. }
  510. return ret;
  511. }
  512. Ref<Script> NativeScriptInstance::get_script() const {
  513. return script;
  514. }
  515. NativeScriptInstance::RPCMode NativeScriptInstance::get_rpc_mode(const StringName &p_method) const {
  516. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  517. while (script_data) {
  518. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find(p_method);
  519. if (E) {
  520. switch (E->get().rpc_mode) {
  521. case GODOT_METHOD_RPC_MODE_DISABLED:
  522. return RPC_MODE_DISABLED;
  523. case GODOT_METHOD_RPC_MODE_REMOTE:
  524. return RPC_MODE_REMOTE;
  525. case GODOT_METHOD_RPC_MODE_SYNC:
  526. return RPC_MODE_SYNC;
  527. case GODOT_METHOD_RPC_MODE_MASTER:
  528. return RPC_MODE_MASTER;
  529. case GODOT_METHOD_RPC_MODE_SLAVE:
  530. return RPC_MODE_SLAVE;
  531. default:
  532. return RPC_MODE_DISABLED;
  533. }
  534. }
  535. script_data = script_data->base_data;
  536. }
  537. return RPC_MODE_DISABLED;
  538. }
  539. // TODO(karroffel): implement this
  540. NativeScriptInstance::RPCMode NativeScriptInstance::get_rset_mode(const StringName &p_variable) const {
  541. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  542. while (script_data) {
  543. Map<StringName, NativeScriptDesc::Property>::Element *E = script_data->properties.find(p_variable);
  544. if (E) {
  545. switch (E->get().rset_mode) {
  546. case GODOT_METHOD_RPC_MODE_DISABLED:
  547. return RPC_MODE_DISABLED;
  548. case GODOT_METHOD_RPC_MODE_REMOTE:
  549. return RPC_MODE_REMOTE;
  550. case GODOT_METHOD_RPC_MODE_SYNC:
  551. return RPC_MODE_SYNC;
  552. case GODOT_METHOD_RPC_MODE_MASTER:
  553. return RPC_MODE_MASTER;
  554. case GODOT_METHOD_RPC_MODE_SLAVE:
  555. return RPC_MODE_SLAVE;
  556. default:
  557. return RPC_MODE_DISABLED;
  558. }
  559. }
  560. script_data = script_data->base_data;
  561. }
  562. return RPC_MODE_DISABLED;
  563. }
  564. ScriptLanguage *NativeScriptInstance::get_language() {
  565. return NativeScriptLanguage::get_singleton();
  566. }
  567. void NativeScriptInstance::call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount) {
  568. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  569. while (script_data) {
  570. Map<StringName, NativeScriptDesc::Method>::Element *E = script_data->methods.find(p_method);
  571. if (E) {
  572. godot_variant res = E->get().method.method((godot_object *)owner,
  573. E->get().method.method_data,
  574. userdata,
  575. p_argcount,
  576. (godot_variant **)p_args);
  577. godot_variant_destroy(&res);
  578. }
  579. script_data = script_data->base_data;
  580. }
  581. }
  582. void NativeScriptInstance::call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount) {
  583. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  584. if (script_data) {
  585. _ml_call_reversed(script_data, p_method, p_args, p_argcount);
  586. }
  587. }
  588. NativeScriptInstance::~NativeScriptInstance() {
  589. NativeScriptDesc *script_data = GET_SCRIPT_DESC();
  590. if (!script_data)
  591. return;
  592. script_data->destroy_func.destroy_func((godot_object *)owner, script_data->destroy_func.method_data, userdata);
  593. if (owner) {
  594. #ifndef NO_THREADS
  595. script->owners_lock->lock();
  596. #endif
  597. script->instance_owners.erase(owner);
  598. #ifndef NO_THREADS
  599. script->owners_lock->unlock();
  600. #endif
  601. }
  602. }
  603. ////// ScriptingLanguage stuff
  604. NativeScriptLanguage *NativeScriptLanguage::singleton;
  605. extern "C" void _native_script_hook();
  606. void NativeScriptLanguage::_hacky_api_anchor() {
  607. _native_script_hook();
  608. }
  609. void NativeScriptLanguage::_unload_stuff() {
  610. for (Map<String, Map<StringName, NativeScriptDesc> >::Element *L = library_classes.front(); L; L = L->next()) {
  611. for (Map<StringName, NativeScriptDesc>::Element *C = L->get().front(); C; C = C->next()) {
  612. // free property stuff first
  613. for (Map<StringName, NativeScriptDesc::Property>::Element *P = C->get().properties.front(); P; P = P->next()) {
  614. if (P->get().getter.free_func)
  615. P->get().getter.free_func(P->get().getter.method_data);
  616. if (P->get().setter.free_func)
  617. P->get().setter.free_func(P->get().setter.method_data);
  618. }
  619. // free method stuff
  620. for (Map<StringName, NativeScriptDesc::Method>::Element *M = C->get().methods.front(); M; M = M->next()) {
  621. if (M->get().method.free_func)
  622. M->get().method.free_func(M->get().method.method_data);
  623. }
  624. // free constructor/destructor
  625. if (C->get().create_func.free_func)
  626. C->get().create_func.free_func(C->get().create_func.method_data);
  627. if (C->get().destroy_func.free_func)
  628. C->get().destroy_func.free_func(C->get().destroy_func.method_data);
  629. }
  630. }
  631. }
  632. NativeScriptLanguage::NativeScriptLanguage() {
  633. NativeScriptLanguage::singleton = this;
  634. #ifndef NO_THREADS
  635. mutex = Mutex::create();
  636. #endif
  637. }
  638. // TODO(karroffel): implement this
  639. NativeScriptLanguage::~NativeScriptLanguage() {
  640. // _unload_stuff(); // NOTE(karroffel): This gets called in ::finish()
  641. for (Map<String, Ref<GDNative> >::Element *L = NSL->library_gdnatives.front(); L; L = L->next()) {
  642. L->get()->terminate();
  643. NSL->library_classes.clear();
  644. NSL->library_gdnatives.clear();
  645. NSL->library_script_users.clear();
  646. }
  647. #ifndef NO_THREADS
  648. memdelete(mutex);
  649. #endif
  650. }
  651. String NativeScriptLanguage::get_name() const {
  652. return "NativeScript";
  653. }
  654. void _add_reload_node() {
  655. #ifdef TOOLS_ENABLED
  656. NativeReloadNode *rn = memnew(NativeReloadNode);
  657. EditorNode::get_singleton()->add_child(rn);
  658. #endif
  659. }
  660. // TODO(karroffel): implement this
  661. void NativeScriptLanguage::init() {
  662. #if defined(TOOLS_ENABLED) && defined(DEBUG_METHODS_ENABLED)
  663. List<String> args = OS::get_singleton()->get_cmdline_args();
  664. List<String>::Element *E = args.find("--gdnative-generate-json-api");
  665. if (E && E->next()) {
  666. if (generate_c_api(E->next()->get()) != OK) {
  667. ERR_PRINT("Failed to generate C API\n");
  668. }
  669. }
  670. #endif
  671. #ifdef TOOLS_ENABLED
  672. EditorNode::add_init_callback(&_add_reload_node);
  673. #endif
  674. }
  675. String NativeScriptLanguage::get_type() const {
  676. return "NativeScript";
  677. }
  678. String NativeScriptLanguage::get_extension() const {
  679. return "gdns";
  680. }
  681. Error NativeScriptLanguage::execute_file(const String &p_path) {
  682. return OK; // Qué?
  683. }
  684. void NativeScriptLanguage::finish() {
  685. _unload_stuff();
  686. }
  687. void NativeScriptLanguage::get_reserved_words(List<String> *p_words) const {
  688. }
  689. void NativeScriptLanguage::get_comment_delimiters(List<String> *p_delimiters) const {
  690. }
  691. void NativeScriptLanguage::get_string_delimiters(List<String> *p_delimiters) const {
  692. }
  693. // TODO(karroffel): implement this
  694. Ref<Script> NativeScriptLanguage::get_template(const String &p_class_name, const String &p_base_class_name) const {
  695. NativeScript *s = memnew(NativeScript);
  696. s->set_class_name(p_class_name);
  697. // TODO(karroffel): use p_base_class_name
  698. return Ref<NativeScript>(s);
  699. }
  700. bool NativeScriptLanguage::validate(const String &p_script, int &r_line_error, int &r_col_error, String &r_test_error, const String &p_path, List<String> *r_functions) const {
  701. return false;
  702. }
  703. Script *NativeScriptLanguage::create_script() const {
  704. NativeScript *script = memnew(NativeScript);
  705. return script;
  706. }
  707. bool NativeScriptLanguage::has_named_classes() const {
  708. return true;
  709. }
  710. int NativeScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  711. return -1;
  712. }
  713. String NativeScriptLanguage::make_function(const String &p_class, const String &p_name, const PoolStringArray &p_args) const {
  714. return "";
  715. }
  716. void NativeScriptLanguage::auto_indent_code(String &p_code, int p_from_line, int p_to_line) const {
  717. }
  718. void NativeScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  719. }
  720. // Debugging stuff here. Not used for now.
  721. String NativeScriptLanguage::debug_get_error() const {
  722. return "";
  723. }
  724. int NativeScriptLanguage::debug_get_stack_level_count() const {
  725. return -1;
  726. }
  727. int NativeScriptLanguage::debug_get_stack_level_line(int p_level) const {
  728. return -1;
  729. }
  730. String NativeScriptLanguage::debug_get_stack_level_function(int p_level) const {
  731. return "";
  732. }
  733. String NativeScriptLanguage::debug_get_stack_level_source(int p_level) const {
  734. return "";
  735. }
  736. void NativeScriptLanguage::debug_get_stack_level_locals(int p_level, List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  737. }
  738. void NativeScriptLanguage::debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  739. }
  740. void NativeScriptLanguage::debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {
  741. }
  742. String NativeScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  743. return "";
  744. }
  745. // Debugging stuff end.
  746. void NativeScriptLanguage::reload_all_scripts() {
  747. }
  748. void NativeScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  749. }
  750. void NativeScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  751. p_extensions->push_back("gdns");
  752. }
  753. void NativeScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  754. }
  755. void NativeScriptLanguage::get_public_constants(List<Pair<String, Variant> > *p_constants) const {
  756. }
  757. void NativeScriptLanguage::profiling_start() {
  758. }
  759. void NativeScriptLanguage::profiling_stop() {
  760. }
  761. int NativeScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  762. return -1;
  763. }
  764. int NativeScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  765. return -1;
  766. }
  767. #ifndef NO_THREADS
  768. void NativeScriptLanguage::defer_init_library(Ref<GDNativeLibrary> lib, NativeScript *script) {
  769. MutexLock lock(mutex);
  770. libs_to_init.insert(lib);
  771. scripts_to_register.insert(script);
  772. has_objects_to_register = true;
  773. }
  774. #endif
  775. void NativeScriptLanguage::init_library(const Ref<GDNativeLibrary> &lib) {
  776. #ifndef NO_THREADS
  777. MutexLock lock(mutex);
  778. #endif
  779. // See if this library was "registered" already.
  780. const String &lib_path = lib->get_active_library_path();
  781. Map<String, Ref<GDNative> >::Element *E = library_gdnatives.find(lib_path);
  782. if (!E) {
  783. Ref<GDNative> gdn;
  784. gdn.instance();
  785. gdn->set_library(lib);
  786. // TODO(karroffel): check the return value?
  787. gdn->initialize();
  788. library_gdnatives.insert(lib_path, gdn);
  789. library_classes.insert(lib_path, Map<StringName, NativeScriptDesc>());
  790. if (!library_script_users.has(lib_path))
  791. library_script_users.insert(lib_path, Set<NativeScript *>());
  792. void *args[1] = {
  793. (void *)&lib_path
  794. };
  795. // here the library registers all the classes and stuff.
  796. gdn->call_native_raw(_init_call_type,
  797. _init_call_name,
  798. NULL,
  799. 1,
  800. args,
  801. NULL);
  802. } else {
  803. // already initialized. Nice.
  804. }
  805. }
  806. void NativeScriptLanguage::register_script(NativeScript *script) {
  807. #ifndef NO_THREADS
  808. MutexLock lock(mutex);
  809. #endif
  810. library_script_users[script->lib_path].insert(script);
  811. }
  812. void NativeScriptLanguage::unregister_script(NativeScript *script) {
  813. #ifndef NO_THREADS
  814. MutexLock lock(mutex);
  815. #endif
  816. Map<String, Set<NativeScript *> >::Element *S = library_script_users.find(script->lib_path);
  817. if (S) {
  818. S->get().erase(script);
  819. if (S->get().size() == 0) {
  820. library_script_users.erase(S);
  821. }
  822. }
  823. #ifndef NO_THREADS
  824. scripts_to_register.erase(script);
  825. #endif
  826. }
  827. #ifndef NO_THREADS
  828. void NativeScriptLanguage::frame() {
  829. if (has_objects_to_register) {
  830. MutexLock lock(mutex);
  831. for (Set<Ref<GDNativeLibrary> >::Element *L = libs_to_init.front(); L; L = L->next()) {
  832. init_library(L->get());
  833. }
  834. libs_to_init.clear();
  835. for (Set<NativeScript *>::Element *S = scripts_to_register.front(); S; S = S->next()) {
  836. register_script(S->get());
  837. }
  838. scripts_to_register.clear();
  839. has_objects_to_register = false;
  840. }
  841. }
  842. void NativeScriptLanguage::thread_enter() {
  843. Vector<Ref<GDNative> > libs;
  844. {
  845. MutexLock lock(mutex);
  846. for (Map<String, Ref<GDNative> >::Element *L = library_gdnatives.front(); L; L = L->next()) {
  847. libs.push_back(L->get());
  848. }
  849. }
  850. for (int i = 0; i < libs.size(); ++i) {
  851. libs[i]->call_native_raw(
  852. _thread_cb_call_type,
  853. _thread_enter_call_name,
  854. NULL,
  855. 0,
  856. NULL,
  857. NULL);
  858. }
  859. }
  860. void NativeScriptLanguage::thread_exit() {
  861. Vector<Ref<GDNative> > libs;
  862. {
  863. MutexLock lock(mutex);
  864. for (Map<String, Ref<GDNative> >::Element *L = library_gdnatives.front(); L; L = L->next()) {
  865. libs.push_back(L->get());
  866. }
  867. }
  868. for (int i = 0; i < libs.size(); ++i) {
  869. libs[i]->call_native_raw(
  870. _thread_cb_call_type,
  871. _thread_exit_call_name,
  872. NULL,
  873. 0,
  874. NULL,
  875. NULL);
  876. }
  877. }
  878. #endif // NO_THREADS
  879. void NativeReloadNode::_bind_methods() {
  880. ClassDB::bind_method(D_METHOD("_notification"), &NativeReloadNode::_notification);
  881. }
  882. void NativeReloadNode::_notification(int p_what) {
  883. #ifdef TOOLS_ENABLED
  884. switch (p_what) {
  885. case MainLoop::NOTIFICATION_WM_FOCUS_OUT: {
  886. if (unloaded)
  887. break;
  888. #ifndef NO_THREADS
  889. MutexLock lock(NSL->mutex);
  890. #endif
  891. NSL->_unload_stuff();
  892. for (Map<String, Ref<GDNative> >::Element *L = NSL->library_gdnatives.front(); L; L = L->next()) {
  893. L->get()->terminate();
  894. NSL->library_classes.erase(L->key());
  895. }
  896. unloaded = true;
  897. } break;
  898. case MainLoop::NOTIFICATION_WM_FOCUS_IN: {
  899. if (!unloaded)
  900. break;
  901. #ifndef NO_THREADS
  902. MutexLock lock(NSL->mutex);
  903. #endif
  904. Set<StringName> libs_to_remove;
  905. for (Map<String, Ref<GDNative> >::Element *L = NSL->library_gdnatives.front(); L; L = L->next()) {
  906. if (!L->get()->initialize()) {
  907. libs_to_remove.insert(L->key());
  908. continue;
  909. }
  910. NSL->library_classes.insert(L->key(), Map<StringName, NativeScriptDesc>());
  911. void *args[1] = {
  912. (void *)&L->key()
  913. };
  914. // here the library registers all the classes and stuff.
  915. L->get()->call_native_raw(NSL->_init_call_type,
  916. NSL->_init_call_name,
  917. NULL,
  918. 1,
  919. args,
  920. NULL);
  921. for (Map<String, Set<NativeScript *> >::Element *U = NSL->library_script_users.front(); U; U = U->next()) {
  922. for (Set<NativeScript *>::Element *S = U->get().front(); S; S = S->next()) {
  923. NativeScript *script = S->get();
  924. if (script->placeholders.size() == 0)
  925. continue;
  926. for (Set<PlaceHolderScriptInstance *>::Element *P = script->placeholders.front(); P; P = P->next()) {
  927. script->_update_placeholder(P->get());
  928. }
  929. }
  930. }
  931. }
  932. unloaded = false;
  933. for (Set<StringName>::Element *R = libs_to_remove.front(); R; R = R->next()) {
  934. NSL->library_gdnatives.erase(R->get());
  935. }
  936. } break;
  937. default: {
  938. };
  939. }
  940. #endif
  941. }
  942. RES ResourceFormatLoaderNativeScript::load(const String &p_path, const String &p_original_path, Error *r_error) {
  943. ResourceFormatLoaderText rsflt;
  944. return rsflt.load(p_path, p_original_path, r_error);
  945. }
  946. void ResourceFormatLoaderNativeScript::get_recognized_extensions(List<String> *p_extensions) const {
  947. p_extensions->push_back("gdns");
  948. }
  949. bool ResourceFormatLoaderNativeScript::handles_type(const String &p_type) const {
  950. return (p_type == "Script" || p_type == "NativeScript");
  951. }
  952. String ResourceFormatLoaderNativeScript::get_resource_type(const String &p_path) const {
  953. String el = p_path.get_extension().to_lower();
  954. if (el == "gdns")
  955. return "NativeScript";
  956. return "";
  957. }
  958. Error ResourceFormatSaverNativeScript::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  959. ResourceFormatSaverText rfst;
  960. return rfst.save(p_path, p_resource, p_flags);
  961. }
  962. bool ResourceFormatSaverNativeScript::recognize(const RES &p_resource) const {
  963. return p_resource->cast_to<NativeScript>() != NULL;
  964. }
  965. void ResourceFormatSaverNativeScript::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  966. if (p_resource->cast_to<NativeScript>()) {
  967. p_extensions->push_back("gdns");
  968. }
  969. }