gdnative.cpp 37 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232
  1. /*************************************************************************/
  2. /* gdnative.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 "gdnative.h"
  31. #include "global_config.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 "scene/main/scene_main_loop.h"
  37. #include "scene/resources/scene_format_text.h"
  38. #if defined(TOOLS_ENABLED) && defined(DEBUG_METHODS_ENABLED)
  39. #include "api_generator.h"
  40. #endif
  41. #ifdef TOOLS_ENABLED
  42. #include "editor/editor_node.h"
  43. #endif
  44. Error NativeLibrary::initialize(NativeLibrary *&p_native_lib, const StringName p_path) {
  45. if (GDNativeScriptLanguage::get_singleton()->initialized_libraries.has(p_path)) {
  46. p_native_lib = GDNativeScriptLanguage::get_singleton()->initialized_libraries[p_path];
  47. return OK;
  48. }
  49. NativeLibrary *lib = memnew(NativeLibrary);
  50. lib->path = p_path;
  51. p_native_lib = lib;
  52. // Open the file
  53. Error error;
  54. error = OS::get_singleton()->open_dynamic_library(p_path, lib->handle);
  55. if (error) return error;
  56. ERR_FAIL_COND_V(!lib->handle, ERR_BUG);
  57. // Get the method
  58. void *library_init;
  59. error = OS::get_singleton()->get_dynamic_library_symbol_handle(lib->handle, GDNativeScriptLanguage::get_init_symbol_name(), library_init);
  60. if (error) return error;
  61. ERR_FAIL_COND_V(!library_init, ERR_BUG);
  62. void (*library_init_fpointer)(godot_native_init_options *) = (void (*)(godot_native_init_options *))library_init;
  63. godot_native_init_options options;
  64. options.in_editor = SceneTree::get_singleton()->is_editor_hint();
  65. /*
  66. options.core_api_hash = ClassDB::get_api_hash(ClassDB::API_CORE);
  67. options.editor_api_hash = ClassDB::get_api_hash(ClassDB::API_EDITOR);
  68. options.no_api_hash = ClassDB::get_api_hash(ClassDB::API_NONE);
  69. */
  70. library_init_fpointer(&options); // Catch errors?
  71. GDNativeScriptLanguage::get_singleton()->initialized_libraries[p_path] = lib;
  72. return OK;
  73. }
  74. Error NativeLibrary::terminate(NativeLibrary *&p_native_lib) {
  75. if (!GDNativeScriptLanguage::get_singleton()->initialized_libraries.has(p_native_lib->path)) {
  76. OS::get_singleton()->close_dynamic_library(p_native_lib->handle);
  77. p_native_lib->handle = 0;
  78. return OK;
  79. }
  80. Error error = OK;
  81. void *library_terminate;
  82. error = OS::get_singleton()->get_dynamic_library_symbol_handle(p_native_lib->handle, GDNativeScriptLanguage::get_terminate_symbol_name(), library_terminate);
  83. if (error)
  84. return OK; // no terminate? okay, not that important lol
  85. void (*library_terminate_pointer)(godot_native_terminate_options *) = (void (*)(godot_native_terminate_options *))library_terminate;
  86. godot_native_terminate_options options;
  87. options.in_editor = SceneTree::get_singleton()->is_editor_hint();
  88. library_terminate_pointer(&options);
  89. GDNativeScriptLanguage::get_singleton()->initialized_libraries.erase(p_native_lib->path);
  90. OS::get_singleton()->close_dynamic_library(p_native_lib->handle);
  91. p_native_lib->handle = 0;
  92. return OK;
  93. }
  94. // Script
  95. #ifdef TOOLS_ENABLED
  96. void GDNativeScript::_update_placeholder(PlaceHolderScriptInstance *p_placeholder) {
  97. ERR_FAIL_COND(!script_data);
  98. List<PropertyInfo> pinfo;
  99. Map<StringName, Variant> values;
  100. for (Map<StringName, GDNativeScriptData::Property>::Element *E = script_data->properties.front(); E; E = E->next()) {
  101. PropertyInfo p = E->get().info;
  102. p.name = String(E->key());
  103. pinfo.push_back(p);
  104. values[p.name] = E->get().default_value;
  105. }
  106. p_placeholder->update(pinfo, values);
  107. }
  108. void GDNativeScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  109. placeholders.erase(p_placeholder);
  110. }
  111. #endif
  112. bool GDNativeScript::can_instance() const {
  113. #ifdef TOOLS_ENABLED
  114. return script_data || (!is_tool() && !ScriptServer::is_scripting_enabled());
  115. #else
  116. // allow defaultlibrary without editor features
  117. if (!library.is_valid()) {
  118. String path = GLOBAL_GET("gdnative/default_gdnativelibrary");
  119. RES lib = ResourceLoader::load(path);
  120. if (lib.is_valid() && lib->cast_to<GDNativeLibrary>()) {
  121. return true;
  122. }
  123. }
  124. return script_data;
  125. #endif
  126. //return script_data || (!tool && !ScriptServer::is_scripting_enabled());
  127. // change to true enable in editor stuff.
  128. }
  129. Ref<Script> GDNativeScript::get_base_script() const {
  130. Ref<GDNativeScript> base_script;
  131. base_script->library = library;
  132. base_script->script_data = script_data;
  133. base_script->script_name = script_data->base;
  134. return base_script;
  135. }
  136. StringName GDNativeScript::get_instance_base_type() const {
  137. return script_data->base_native_type;
  138. }
  139. ScriptInstance *GDNativeScript::instance_create(Object *p_this) {
  140. #ifdef TOOLS_ENABLED
  141. // find a good way to initialize stuff in the editor
  142. if (!ScriptServer::is_scripting_enabled() && !is_tool()) {
  143. // placeholder, for nodes. But for tools we want the real thing
  144. PlaceHolderScriptInstance *sins = memnew(PlaceHolderScriptInstance(GDNativeScriptLanguage::singleton, Ref<Script>((Script *)this), p_this));
  145. placeholders.insert(sins);
  146. if (!library.is_valid())
  147. return sins;
  148. if (!library->native_library) {
  149. Error err = library->_initialize();
  150. if (err != OK) {
  151. return sins;
  152. }
  153. }
  154. if (!script_data) {
  155. script_data = library->get_script_data(script_name);
  156. }
  157. if (script_data && script_data->create_func.create_func) {
  158. script_data->create_func.create_func((godot_object *)p_this, script_data->create_func.method_data);
  159. }
  160. _update_placeholder(sins);
  161. return sins;
  162. }
  163. #endif
  164. if (!library.is_valid()) {
  165. String path = GLOBAL_GET("gdnative/default_gdnativelibrary");
  166. RES lib = ResourceLoader::load(path);
  167. if (lib.is_valid() && lib->cast_to<GDNativeLibrary>()) {
  168. set_library(lib);
  169. }
  170. }
  171. GDNativeInstance *new_instance = memnew(GDNativeInstance);
  172. new_instance->owner = p_this;
  173. new_instance->script = Ref<GDNativeScript>(this);
  174. #ifndef TOOLS_ENABLED
  175. if (!ScriptServer::is_scripting_enabled()) {
  176. new_instance->userdata = 0;
  177. } else {
  178. new_instance->userdata = script_data->create_func.create_func((godot_object *)p_this, script_data->create_func.method_data);
  179. }
  180. #else
  181. new_instance->userdata = script_data->create_func.create_func((godot_object *)p_this, script_data->create_func.method_data);
  182. #endif
  183. instances.insert(p_this);
  184. return new_instance;
  185. }
  186. bool GDNativeScript::instance_has(const Object *p_this) const {
  187. return instances.has((Object *)p_this); // TODO
  188. }
  189. bool GDNativeScript::has_source_code() const {
  190. return false;
  191. }
  192. String GDNativeScript::get_source_code() const {
  193. return "";
  194. }
  195. Error GDNativeScript::reload(bool p_keep_state) {
  196. return FAILED;
  197. }
  198. bool GDNativeScript::has_method(const StringName &p_method) const {
  199. if (!script_data)
  200. return false;
  201. GDNativeScriptData *data = script_data;
  202. while (data) {
  203. if (data->methods.has(p_method))
  204. return true;
  205. data = data->base_data;
  206. }
  207. return false;
  208. }
  209. MethodInfo GDNativeScript::get_method_info(const StringName &p_method) const {
  210. if (!script_data)
  211. return MethodInfo();
  212. GDNativeScriptData *data = script_data;
  213. while (data) {
  214. if (data->methods.has(p_method))
  215. return data->methods[p_method].info;
  216. data = data->base_data;
  217. }
  218. ERR_FAIL_COND_V(!script_data->methods.has(p_method), MethodInfo());
  219. return MethodInfo();
  220. }
  221. void GDNativeScript::get_script_method_list(List<MethodInfo> *p_list) const {
  222. if (!script_data) return;
  223. Set<MethodInfo> methods;
  224. GDNativeScriptData *data = script_data;
  225. while (data) {
  226. for (Map<StringName, GDNativeScriptData::Method>::Element *E = data->methods.front(); E; E = E->next()) {
  227. methods.insert(E->get().info);
  228. }
  229. data = data->base_data;
  230. }
  231. for (Set<MethodInfo>::Element *E = methods.front(); E; E = E->next()) {
  232. p_list->push_back(E->get());
  233. }
  234. }
  235. void GDNativeScript::get_script_property_list(List<PropertyInfo> *p_list) const {
  236. if (!script_data) return;
  237. Set<PropertyInfo> properties;
  238. GDNativeScriptData *data = script_data;
  239. while (data) {
  240. for (Map<StringName, GDNativeScriptData::Property>::Element *E = data->properties.front(); E; E = E->next()) {
  241. properties.insert(E->get().info);
  242. }
  243. data = data->base_data;
  244. }
  245. for (Set<PropertyInfo>::Element *E = properties.front(); E; E = E->next()) {
  246. p_list->push_back(E->get());
  247. }
  248. }
  249. bool GDNativeScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  250. if (!script_data) return false;
  251. GDNativeScriptData *data = script_data;
  252. while (data) {
  253. if (data->properties.has(p_property)) {
  254. r_value = data->properties[p_property].default_value;
  255. return true;
  256. }
  257. data = data->base_data;
  258. }
  259. return false;
  260. }
  261. bool GDNativeScript::is_tool() const {
  262. ERR_FAIL_COND_V(!script_data, false);
  263. return script_data->is_tool;
  264. }
  265. String GDNativeScript::get_node_type() const {
  266. return ""; // ?
  267. }
  268. ScriptLanguage *GDNativeScript::get_language() const {
  269. return GDNativeScriptLanguage::singleton;
  270. }
  271. bool GDNativeScript::has_script_signal(const StringName &p_signal) const {
  272. if (!script_data)
  273. return false;
  274. GDNativeScriptData *data = script_data;
  275. while (data) {
  276. if (data->signals_.has(p_signal)) {
  277. return true;
  278. }
  279. data = data->base_data;
  280. }
  281. return false;
  282. }
  283. void GDNativeScript::get_script_signal_list(List<MethodInfo> *r_signals) const {
  284. if (!script_data)
  285. return;
  286. Set<MethodInfo> signals_;
  287. GDNativeScriptData *data = script_data;
  288. while (data) {
  289. for (Map<StringName, GDNativeScriptData::Signal>::Element *S = data->signals_.front(); S; S = S->next()) {
  290. signals_.insert(S->get().signal);
  291. }
  292. data = data->base_data;
  293. }
  294. for (Set<MethodInfo>::Element *E = signals_.front(); E; E = E->next()) {
  295. r_signals->push_back(E->get());
  296. }
  297. }
  298. Ref<GDNativeLibrary> GDNativeScript::get_library() const {
  299. return library;
  300. }
  301. void GDNativeScript::set_library(Ref<GDNativeLibrary> p_library) {
  302. library = p_library;
  303. #ifdef TOOLS_ENABLED
  304. if (!ScriptServer::is_scripting_enabled())
  305. return;
  306. #endif
  307. if (library.is_valid()) {
  308. Error initalize_status = library->_initialize();
  309. ERR_FAIL_COND(initalize_status != OK);
  310. if (script_name) {
  311. script_data = library->native_library->scripts[script_name];
  312. ERR_FAIL_COND(!script_data);
  313. }
  314. }
  315. }
  316. StringName GDNativeScript::get_script_name() const {
  317. return script_name;
  318. }
  319. void GDNativeScript::set_script_name(StringName p_script_name) {
  320. script_name = p_script_name;
  321. if (library.is_valid()) {
  322. #ifdef TOOLS_ENABLED
  323. if (!library->native_library) {
  324. library->_initialize();
  325. }
  326. #endif
  327. if (library->native_library) {
  328. script_data = library->get_script_data(script_name);
  329. ERR_FAIL_COND(!script_data);
  330. }
  331. }
  332. }
  333. void GDNativeScript::_bind_methods() {
  334. ClassDB::bind_method(D_METHOD("get_library"), &GDNativeScript::get_library);
  335. ClassDB::bind_method(D_METHOD("set_library", "library"), &GDNativeScript::set_library);
  336. ClassDB::bind_method(D_METHOD("get_script_name"), &GDNativeScript::get_script_name);
  337. ClassDB::bind_method(D_METHOD("set_script_name", "script_name"), &GDNativeScript::set_script_name);
  338. ADD_PROPERTYNZ(PropertyInfo(Variant::OBJECT, "library", PROPERTY_HINT_RESOURCE_TYPE, "GDNativeLibrary"), "set_library", "get_library");
  339. ADD_PROPERTYNZ(PropertyInfo(Variant::STRING, "script_name"), "set_script_name", "get_script_name");
  340. }
  341. GDNativeScript::GDNativeScript() {
  342. script_data = NULL;
  343. GDNativeScriptLanguage::get_singleton()->script_list.insert(this);
  344. }
  345. GDNativeScript::~GDNativeScript() {
  346. //hmm
  347. GDNativeScriptLanguage::get_singleton()->script_list.erase(this);
  348. }
  349. // Library
  350. GDNativeLibrary *GDNativeLibrary::currently_initialized_library = NULL;
  351. GDNativeLibrary *GDNativeLibrary::get_currently_initialized_library() {
  352. return currently_initialized_library;
  353. }
  354. static const char *_dl_platforms_info[] = {
  355. "|unix|so|Unix",
  356. "unix|x11|so|X11",
  357. "unix|server|so|Server",
  358. "unix|android|so|Android",
  359. "unix|blackberry|so|Blackberry 10",
  360. "unix|haiku|so|Haiku", // Right?
  361. "|mac|dynlib|Mac",
  362. "mac|ios|dynlib|iOS",
  363. "mac|osx|dynlib|OSX",
  364. "|html5|js|HTML5",
  365. "|windows|dll|Windows",
  366. "windows|uwp|dll|UWP",
  367. NULL // Finishing condition
  368. };
  369. void GDNativeLibrary::set_platform_file(StringName p_platform, String p_file) {
  370. if (p_file.empty()) {
  371. platform_files.erase(p_platform);
  372. } else {
  373. platform_files[p_platform] = p_file;
  374. }
  375. }
  376. String GDNativeLibrary::get_platform_file(StringName p_platform) const {
  377. if (platform_files.has(p_platform)) {
  378. return platform_files[p_platform];
  379. } else {
  380. return "";
  381. }
  382. }
  383. Error GDNativeLibrary::_initialize() {
  384. _THREAD_SAFE_METHOD_
  385. // Get the file
  386. const String platform_name = OS::get_singleton()->get_name();
  387. String platform_file("");
  388. char **platform_info = (char **)_dl_platforms_info;
  389. if (platform_files.has(platform_name.to_lower())) {
  390. platform_file = platform_files[platform_name.to_lower()];
  391. }
  392. while (*platform_info) {
  393. String platform_info_string(*platform_info);
  394. if (platform_name == platform_info_string.get_slicec('|', 3)) {
  395. String platform_key = platform_info_string.get_slicec('|', 1);
  396. String fallback_platform_key = platform_info_string.get_slicec('|', 0);
  397. if (platform_files.has(platform_key)) {
  398. platform_file = platform_files[platform_key];
  399. } else if (!fallback_platform_key.empty() && platform_files.has(fallback_platform_key)) {
  400. platform_file = platform_files[fallback_platform_key];
  401. } else {
  402. return ERR_UNAVAILABLE;
  403. }
  404. }
  405. platform_info++;
  406. }
  407. ERR_FAIL_COND_V(platform_file == "", ERR_DOES_NOT_EXIST);
  408. StringName path = GlobalConfig::get_singleton()->globalize_path(platform_file);
  409. GDNativeLibrary::currently_initialized_library = this;
  410. Error ret = NativeLibrary::initialize(native_library, path);
  411. native_library->dllib = this;
  412. GDNativeLibrary::currently_initialized_library = NULL;
  413. return ret;
  414. }
  415. Error GDNativeLibrary::_terminate() {
  416. ERR_FAIL_COND_V(!native_library, ERR_BUG);
  417. ERR_FAIL_COND_V(!native_library->handle, ERR_BUG);
  418. // de-init stuff
  419. for (Map<StringName, GDNativeScriptData *>::Element *E = native_library->scripts.front(); E; E = E->next()) {
  420. for (Map<StringName, GDNativeScriptData::Method>::Element *M = E->get()->methods.front(); M; M = M->next()) {
  421. if (M->get().method.free_func) {
  422. M->get().method.free_func(M->get().method.method_data);
  423. }
  424. }
  425. if (E->get()->create_func.free_func) {
  426. E->get()->create_func.free_func(E->get()->create_func.method_data);
  427. }
  428. if (E->get()->destroy_func.free_func) {
  429. E->get()->destroy_func.free_func(E->get()->destroy_func.method_data);
  430. }
  431. for (Set<GDNativeScript *>::Element *S = GDNativeScriptLanguage::get_singleton()->script_list.front(); S; S = S->next()) {
  432. if (S->get()->script_data == E->get()) {
  433. S->get()->script_data = NULL;
  434. }
  435. }
  436. memdelete(E->get());
  437. }
  438. Error ret = NativeLibrary::terminate(native_library);
  439. native_library->scripts.clear();
  440. return ret;
  441. }
  442. void GDNativeLibrary::_register_script(const StringName p_name, const StringName p_base, godot_instance_create_func p_instance_func, godot_instance_destroy_func p_destroy_func) {
  443. ERR_FAIL_COND(!native_library);
  444. ERR_FAIL_COND(native_library->scripts.has(p_name));
  445. GDNativeScriptData *s = memnew(GDNativeScriptData);
  446. s->base = p_base;
  447. s->create_func = p_instance_func;
  448. s->destroy_func = p_destroy_func;
  449. Map<StringName, GDNativeScriptData *>::Element *E = native_library->scripts.find(p_base);
  450. if (E) {
  451. s->base_data = E->get();
  452. s->base_native_type = s->base_data->base_native_type;
  453. } else {
  454. if (!ClassDB::class_exists(p_base)) {
  455. memdelete(s);
  456. ERR_EXPLAIN("Invalid base for registered type '" + p_name + "'");
  457. ERR_FAIL();
  458. }
  459. s->base_native_type = p_base;
  460. }
  461. native_library->scripts.insert(p_name, s);
  462. }
  463. void GDNativeLibrary::_register_tool_script(const StringName p_name, const StringName p_base, godot_instance_create_func p_instance_func, godot_instance_destroy_func p_destroy_func) {
  464. ERR_FAIL_COND(!native_library);
  465. ERR_FAIL_COND(native_library->scripts.has(p_name));
  466. GDNativeScriptData *s = memnew(GDNativeScriptData);
  467. s->base = p_base;
  468. s->create_func = p_instance_func;
  469. s->destroy_func = p_destroy_func;
  470. s->is_tool = true;
  471. Map<StringName, GDNativeScriptData *>::Element *E = native_library->scripts.find(p_base);
  472. if (E) {
  473. s->base_data = E->get();
  474. s->base_native_type = s->base_data->base_native_type;
  475. } else {
  476. if (!ClassDB::class_exists(p_base)) {
  477. memdelete(s);
  478. ERR_EXPLAIN("Invalid base for registered type '" + p_name + "'");
  479. ERR_FAIL();
  480. }
  481. s->base_native_type = p_base;
  482. }
  483. native_library->scripts.insert(p_name, s);
  484. }
  485. void GDNativeLibrary::_register_script_method(const StringName p_name, const StringName p_method, godot_method_attributes p_attr, godot_instance_method p_func, MethodInfo p_info) {
  486. ERR_FAIL_COND(!native_library);
  487. ERR_FAIL_COND(!native_library->scripts.has(p_name));
  488. p_info.name = p_method;
  489. GDNativeScriptData::Method method;
  490. method = GDNativeScriptData::Method(p_func, p_info, p_attr.rpc_type);
  491. native_library->scripts[p_name]->methods.insert(p_method, method);
  492. }
  493. void GDNativeLibrary::_register_script_property(const StringName p_name, const String p_path, godot_property_attributes *p_attr, godot_property_set_func p_setter, godot_property_get_func p_getter) {
  494. ERR_FAIL_COND(!native_library);
  495. ERR_FAIL_COND(!native_library->scripts.has(p_name));
  496. GDNativeScriptData::Property p;
  497. PropertyInfo pi;
  498. pi.name = p_path;
  499. if (p_attr != NULL) {
  500. pi = PropertyInfo((Variant::Type)p_attr->type, p_path, (PropertyHint)p_attr->hint, *(String *)&p_attr->hint_string, p_attr->usage);
  501. p = GDNativeScriptData::Property(p_setter, p_getter, pi, *(Variant *)&p_attr->default_value, p_attr->rset_type);
  502. }
  503. native_library->scripts[p_name]->properties.insert(p_path, p);
  504. }
  505. void GDNativeLibrary::_register_script_signal(const StringName p_name, const godot_signal *p_signal) {
  506. ERR_FAIL_COND(!native_library);
  507. ERR_FAIL_COND(!native_library->scripts.has(p_name));
  508. ERR_FAIL_COND(!p_signal);
  509. GDNativeScriptData::Signal signal;
  510. signal.signal.name = *(String *)&p_signal->name;
  511. {
  512. List<PropertyInfo> arguments;
  513. for (int i = 0; i < p_signal->num_args; i++) {
  514. PropertyInfo info;
  515. godot_signal_argument attrib = p_signal->args[i];
  516. String *name = (String *)&attrib.name;
  517. info.name = *name;
  518. info.type = (Variant::Type)attrib.type;
  519. info.hint = (PropertyHint)attrib.hint;
  520. info.hint_string = *(String *)&attrib.hint_string;
  521. info.usage = attrib.usage;
  522. arguments.push_back(info);
  523. }
  524. signal.signal.arguments = arguments;
  525. }
  526. {
  527. Vector<Variant> default_arguments;
  528. for (int i = 0; i < p_signal->num_default_args; i++) {
  529. Variant *v;
  530. godot_signal_argument attrib = p_signal->args[i];
  531. v = (Variant *)&attrib.default_value;
  532. default_arguments.push_back(*v);
  533. }
  534. signal.signal.default_arguments = default_arguments;
  535. }
  536. native_library->scripts[p_name]->signals_.insert(*(String *)&p_signal->name, signal);
  537. }
  538. GDNativeScriptData *GDNativeLibrary::get_script_data(const StringName p_name) {
  539. ERR_FAIL_COND_V(!native_library, NULL);
  540. ERR_FAIL_COND_V(!native_library->scripts.has(p_name), NULL);
  541. return native_library->scripts[p_name];
  542. }
  543. bool GDNativeLibrary::_set(const StringName &p_name, const Variant &p_value) {
  544. String name = p_name;
  545. if (name.begins_with("platform/")) {
  546. set_platform_file(name.get_slice("/", 1), p_value);
  547. return true;
  548. }
  549. return false;
  550. }
  551. bool GDNativeLibrary::_get(const StringName &p_name, Variant &r_ret) const {
  552. String name = p_name;
  553. if (name.begins_with("platform/")) {
  554. r_ret = get_platform_file(name.get_slice("/", 1));
  555. return true;
  556. }
  557. return false;
  558. }
  559. void GDNativeLibrary::_get_property_list(List<PropertyInfo> *p_list) const {
  560. char **platform_info = (char **)_dl_platforms_info;
  561. Set<String> registered_platform_names;
  562. {
  563. List<StringName> ep;
  564. // ep.push_back("X11");
  565. // EditorImportExport::get_singleton()->get_export_platforms(&ep);
  566. // @Todo
  567. // get export platforms with the new export system somehow.
  568. for (List<StringName>::Element *E = ep.front(); E; E = E->next()) {
  569. registered_platform_names.insert(String(E->get()).to_lower());
  570. }
  571. }
  572. while (*platform_info) {
  573. String platform_info_string(*platform_info);
  574. String fallback_platform_key = platform_info_string.get_slicec('|', 0);
  575. String platform_key = platform_info_string.get_slicec('|', 1);
  576. String platform_extension = platform_info_string.get_slicec('|', 2);
  577. String platform_name = platform_info_string.get_slicec('|', 3);
  578. registered_platform_names.erase(platform_name);
  579. if (fallback_platform_key.empty()) {
  580. p_list->push_back(PropertyInfo(Variant::STRING, "platform/" + platform_key, PROPERTY_HINT_FILE, "*." + platform_extension));
  581. } else {
  582. if (platform_files.has(platform_key)) {
  583. p_list->push_back(PropertyInfo(Variant::STRING, "platform/" + platform_key, PROPERTY_HINT_FILE, "*." + platform_extension, PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_CHECKABLE | PROPERTY_USAGE_CHECKED));
  584. } else {
  585. p_list->push_back(PropertyInfo(Variant::STRING, "platform/" + platform_key, PROPERTY_HINT_FILE, "*." + platform_extension, PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_CHECKABLE));
  586. }
  587. }
  588. platform_info++;
  589. }
  590. while (registered_platform_names.size()) {
  591. const String platform_name = registered_platform_names.front()->get();
  592. registered_platform_names.erase(platform_name);
  593. p_list->push_back(PropertyInfo(Variant::STRING, "platform/" + platform_name.to_lower(), PROPERTY_HINT_FILE, "*"));
  594. }
  595. }
  596. void GDNativeLibrary::_notification(int what) {
  597. // TODO
  598. }
  599. void GDNativeLibrary::_bind_methods() {
  600. ClassDB::bind_method(D_METHOD("set_platform_file", "platform", "file"), &GDNativeLibrary::set_platform_file);
  601. ClassDB::bind_method(D_METHOD("get_platform_file", "platform"), &GDNativeLibrary::get_platform_file);
  602. }
  603. GDNativeLibrary::GDNativeLibrary() {
  604. native_library = NULL;
  605. }
  606. GDNativeLibrary::~GDNativeLibrary() {
  607. if (!native_library) {
  608. return;
  609. }
  610. if (native_library->handle) {
  611. _terminate();
  612. }
  613. }
  614. // Instance
  615. bool GDNativeInstance::set(const StringName &p_name, const Variant &p_value) {
  616. if (!script->script_data)
  617. return false;
  618. if (script->script_data->properties.has(p_name)) {
  619. script->script_data->properties[p_name].setter.set_func((godot_object *)owner, script->script_data->properties[p_name].setter.method_data, userdata, *(godot_variant *)&p_value);
  620. return true;
  621. }
  622. return false;
  623. }
  624. bool GDNativeInstance::get(const StringName &p_name, Variant &r_ret) const {
  625. if (!script->script_data)
  626. return false;
  627. if (script->script_data->properties.has(p_name)) {
  628. godot_variant value = script->script_data->properties[p_name].getter.get_func((godot_object *)owner, script->script_data->properties[p_name].getter.method_data, userdata);
  629. r_ret = *(Variant *)&value;
  630. return true;
  631. }
  632. return false;
  633. }
  634. void GDNativeInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  635. script->get_script_property_list(p_properties);
  636. // TODO: dynamic properties
  637. }
  638. Variant::Type GDNativeInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  639. if (script->script_data->properties.has(p_name)) {
  640. *r_is_valid = true;
  641. return script->script_data->properties[p_name].info.type;
  642. }
  643. *r_is_valid = false;
  644. return Variant::NIL;
  645. }
  646. void GDNativeInstance::get_method_list(List<MethodInfo> *p_list) const {
  647. script->get_script_method_list(p_list);
  648. }
  649. bool GDNativeInstance::has_method(const StringName &p_method) const {
  650. return script->has_method(p_method);
  651. }
  652. Variant GDNativeInstance::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  653. // TODO: validated methods & errors
  654. GDNativeScriptData *data_ptr = script->script_data;
  655. while (data_ptr) {
  656. Map<StringName, GDNativeScriptData::Method>::Element *E = data_ptr->methods.find(p_method);
  657. if (E) {
  658. godot_variant result = E->get().method.method((godot_object *)owner, E->get().method.method_data, userdata, p_argcount, (godot_variant **)p_args);
  659. return *(Variant *)&result;
  660. }
  661. data_ptr = data_ptr->base_data;
  662. }
  663. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  664. return Variant();
  665. }
  666. void GDNativeInstance::call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount) {
  667. // TODO: validated methods & errors
  668. GDNativeScriptData *data_ptr = script->script_data;
  669. while (data_ptr) {
  670. Map<StringName, GDNativeScriptData::Method>::Element *E = data_ptr->methods.find(p_method);
  671. if (E) {
  672. E->get().method.method((godot_object *)owner, E->get().method.method_data, userdata, p_argcount, (godot_variant **)p_args);
  673. }
  674. data_ptr = data_ptr->base_data;
  675. }
  676. }
  677. void GDNativeInstance::_ml_call_reversed(GDNativeScriptData *data_ptr, const StringName &p_method, const Variant **p_args, int p_argcount) {
  678. // TODO: validated methods & errors
  679. if (data_ptr->base_data)
  680. _ml_call_reversed(data_ptr->base_data, p_method, p_args, p_argcount);
  681. // Variant::CallError ce;
  682. Map<StringName, GDNativeScriptData::Method>::Element *E = data_ptr->methods.find(p_method);
  683. if (E) {
  684. E->get().method.method((godot_object *)owner, E->get().method.method_data, userdata, p_argcount, (godot_variant **)p_args);
  685. }
  686. }
  687. void GDNativeInstance::call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount) {
  688. if (script.ptr() && script->script_data) {
  689. _ml_call_reversed(script->script_data, p_method, p_args, p_argcount);
  690. }
  691. }
  692. void GDNativeInstance::notification(int p_notification) {
  693. Variant value = p_notification;
  694. const Variant *args[1] = { &value };
  695. call_multilevel(GDNativeScriptLanguage::singleton->strings._notification, args, 1);
  696. }
  697. Ref<Script> GDNativeInstance::get_script() const {
  698. return script;
  699. }
  700. ScriptLanguage *GDNativeInstance::get_language() {
  701. return GDNativeScriptLanguage::singleton;
  702. }
  703. ScriptInstance::RPCMode GDNativeInstance::get_rpc_mode(const StringName &p_method) const {
  704. GDNativeScriptData::Method m = script->script_data->methods[p_method];
  705. switch (m.rpc_mode) {
  706. case GODOT_METHOD_RPC_MODE_DISABLED:
  707. return RPC_MODE_DISABLED;
  708. case GODOT_METHOD_RPC_MODE_REMOTE:
  709. return RPC_MODE_REMOTE;
  710. case GODOT_METHOD_RPC_MODE_SYNC:
  711. return RPC_MODE_SYNC;
  712. case GODOT_METHOD_RPC_MODE_MASTER:
  713. return RPC_MODE_MASTER;
  714. case GODOT_METHOD_RPC_MODE_SLAVE:
  715. return RPC_MODE_SLAVE;
  716. default:
  717. return RPC_MODE_DISABLED;
  718. }
  719. }
  720. ScriptInstance::RPCMode GDNativeInstance::get_rset_mode(const StringName &p_variable) const {
  721. GDNativeScriptData::Property p = script->script_data->properties[p_variable];
  722. switch (p.rset_mode) {
  723. case GODOT_METHOD_RPC_MODE_DISABLED:
  724. return RPC_MODE_DISABLED;
  725. case GODOT_METHOD_RPC_MODE_REMOTE:
  726. return RPC_MODE_REMOTE;
  727. case GODOT_METHOD_RPC_MODE_SYNC:
  728. return RPC_MODE_SYNC;
  729. case GODOT_METHOD_RPC_MODE_MASTER:
  730. return RPC_MODE_MASTER;
  731. case GODOT_METHOD_RPC_MODE_SLAVE:
  732. return RPC_MODE_SLAVE;
  733. default:
  734. return RPC_MODE_DISABLED;
  735. }
  736. }
  737. GDNativeInstance::GDNativeInstance() {
  738. owner = NULL;
  739. userdata = NULL;
  740. }
  741. GDNativeInstance::~GDNativeInstance() {
  742. if (script.is_valid()) {
  743. if (owner) {
  744. script->instances.erase(owner);
  745. }
  746. if (!script->script_data)
  747. return;
  748. script->script_data->destroy_func.destroy_func((godot_object *)owner, script->script_data->destroy_func.method_data, userdata);
  749. if (script->script_data->destroy_func.free_func)
  750. script->script_data->destroy_func.free_func(script->script_data->destroy_func.method_data);
  751. if (script->script_data->create_func.free_func)
  752. script->script_data->create_func.free_func(script->script_data->create_func.method_data);
  753. }
  754. }
  755. // Language
  756. GDNativeScriptLanguage *GDNativeScriptLanguage::singleton = NULL;
  757. String GDNativeScriptLanguage::get_name() const {
  758. return "Native";
  759. }
  760. void _add_reload_node() {
  761. #ifdef TOOLS_ENABLED
  762. GDNativeReloadNode *rn = memnew(GDNativeReloadNode);
  763. EditorNode::get_singleton()->add_child(rn);
  764. #endif
  765. }
  766. void GDNativeScriptLanguage::init() {
  767. // TODO: Expose globals
  768. GLOBAL_DEF("gdnative/default_gdnativelibrary", "");
  769. PropertyInfo prop_info(Variant::STRING, "gdnative/default_gdnativelibrary", PROPERTY_HINT_FILE, "tres,res,dllib");
  770. GlobalConfig::get_singleton()->set_custom_property_info("gdnative/default_gdnativelibrary", prop_info);
  771. // generate bindings
  772. #if defined(TOOLS_ENABLED) && defined(DEBUG_METHODS_ENABLED)
  773. List<String> args = OS::get_singleton()->get_cmdline_args();
  774. List<String>::Element *E = args.find("--gdnative-generate-json-api");
  775. if (E && E->next()) {
  776. if (generate_c_api(E->next()->get()) != OK) {
  777. ERR_PRINT("Failed to generate C API\n");
  778. }
  779. }
  780. #endif
  781. #ifdef TOOLS_ENABLED
  782. // if (SceneTree::get_singleton()->is_editor_hint()) {
  783. EditorNode::add_init_callback(&_add_reload_node);
  784. // }
  785. #endif
  786. }
  787. String GDNativeScriptLanguage::get_type() const {
  788. return "Native";
  789. }
  790. String GDNativeScriptLanguage::get_extension() const {
  791. return "gdn";
  792. }
  793. Error GDNativeScriptLanguage::execute_file(const String &p_path) {
  794. return OK; // ??
  795. }
  796. void GDNativeScriptLanguage::finish() {
  797. // cleanup is for noobs
  798. }
  799. // scons doesn't want to link in the api source so we need to call a dummy function to cause it to link
  800. extern "C" void _api_anchor();
  801. void GDNativeScriptLanguage::_compile_dummy_for_the_api() {
  802. _api_anchor();
  803. }
  804. Ref<Script> GDNativeScriptLanguage::get_template(const String &p_class_name, const String &p_base_class_name) const {
  805. GDNativeScript *src = memnew(GDNativeScript);
  806. src->set_script_name(p_class_name);
  807. return Ref<GDNativeScript>(src);
  808. }
  809. bool GDNativeScriptLanguage::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 {
  810. return false; // TODO
  811. }
  812. Script *GDNativeScriptLanguage::create_script() const {
  813. GDNativeScript *scr = memnew(GDNativeScript);
  814. return scr;
  815. }
  816. bool GDNativeScriptLanguage::has_named_classes() const {
  817. return true;
  818. }
  819. int GDNativeScriptLanguage::find_function(const String &p_function, const String &p_code) const {
  820. return -1; // No source code!
  821. }
  822. String GDNativeScriptLanguage::make_function(const String &p_class, const String &p_name, const PoolStringArray &p_args) const {
  823. return ""; // No source code!
  824. }
  825. void GDNativeScriptLanguage::add_global_constant(const StringName &p_variable, const Variant &p_value) {
  826. // TODO TODO TODO
  827. }
  828. // TODO: Any debugging? (research)
  829. String GDNativeScriptLanguage::debug_get_error() const {
  830. return "";
  831. }
  832. int GDNativeScriptLanguage::debug_get_stack_level_count() const {
  833. return 1; // ?
  834. }
  835. int GDNativeScriptLanguage::debug_get_stack_level_line(int p_level) const {
  836. return -1;
  837. }
  838. String GDNativeScriptLanguage::debug_get_stack_level_function(int p_level) const {
  839. return "[native code]"; // ?
  840. }
  841. String GDNativeScriptLanguage::debug_get_stack_level_source(int p_level) const {
  842. return "";
  843. }
  844. void GDNativeScriptLanguage::debug_get_stack_level_members(int p_level, List<String> *p_members, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {}
  845. void GDNativeScriptLanguage::debug_get_globals(List<String> *p_locals, List<Variant> *p_values, int p_max_subitems, int p_max_depth) {}
  846. String GDNativeScriptLanguage::debug_parse_stack_level_expression(int p_level, const String &p_expression, int p_max_subitems, int p_max_depth) {
  847. return ""; // ??
  848. }
  849. void GDNativeScriptLanguage::reload_all_scripts() {
  850. // @Todo
  851. }
  852. void GDNativeScriptLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  853. // @Todo
  854. OS::get_singleton()->print("reload tool scripts\n");
  855. }
  856. void GDNativeScriptLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  857. p_extensions->push_back("gdn"); // Container file format
  858. }
  859. void GDNativeScriptLanguage::get_public_functions(List<MethodInfo> *p_functions) const {
  860. }
  861. void GDNativeScriptLanguage::get_public_constants(List<Pair<String, Variant> > *p_constants) const {
  862. }
  863. // TODO: all profilling
  864. void GDNativeScriptLanguage::profiling_start() {
  865. }
  866. void GDNativeScriptLanguage::profiling_stop() {
  867. }
  868. int GDNativeScriptLanguage::profiling_get_accumulated_data(ProfilingInfo *p_info_arr, int p_info_max) {
  869. return 0;
  870. }
  871. int GDNativeScriptLanguage::profiling_get_frame_data(ProfilingInfo *p_info_arr, int p_info_max) {
  872. return 0;
  873. }
  874. void GDNativeScriptLanguage::frame() {
  875. }
  876. String GDNativeScriptLanguage::get_init_symbol_name() {
  877. return "godot_native_init"; // TODO: Maybe make some internal function which would do the actual stuff
  878. }
  879. String GDNativeScriptLanguage::get_terminate_symbol_name() {
  880. return "godot_native_terminate";
  881. }
  882. GDNativeScriptLanguage::GDNativeScriptLanguage() {
  883. ERR_FAIL_COND(singleton);
  884. strings._notification = StringName("_notification");
  885. singleton = this;
  886. initialized_libraries = Map<StringName, NativeLibrary *>();
  887. }
  888. GDNativeScriptLanguage::~GDNativeScriptLanguage() {
  889. singleton = NULL;
  890. }
  891. // DLReloadNode
  892. void GDNativeReloadNode::_bind_methods() {
  893. ClassDB::bind_method("_notification", &GDNativeReloadNode::_notification);
  894. }
  895. void GDNativeReloadNode::_notification(int p_what) {
  896. #ifdef TOOLS_ENABLED
  897. switch (p_what) {
  898. case MainLoop::NOTIFICATION_WM_FOCUS_IN: {
  899. Set<NativeLibrary *> libs_to_reload;
  900. for (Map<StringName, NativeLibrary *>::Element *L = GDNativeScriptLanguage::get_singleton()->initialized_libraries.front(); L; L = L->next()) {
  901. // check if file got modified at all
  902. // @Todo
  903. libs_to_reload.insert(L->get());
  904. }
  905. for (Set<NativeLibrary *>::Element *L = libs_to_reload.front(); L; L = L->next()) {
  906. GDNativeLibrary *lib = L->get()->dllib;
  907. lib->_terminate();
  908. lib->_initialize();
  909. // update placeholders (if any)
  910. Set<GDNativeScript *> scripts;
  911. for (Set<GDNativeScript *>::Element *S = GDNativeScriptLanguage::get_singleton()->script_list.front(); S; S = S->next()) {
  912. if (lib->native_library->scripts.has(S->get()->get_script_name())) {
  913. GDNativeScript *script = S->get();
  914. script->script_data = lib->get_script_data(script->get_script_name());
  915. scripts.insert(script);
  916. }
  917. }
  918. for (Set<GDNativeScript *>::Element *S = scripts.front(); S; S = S->next()) {
  919. GDNativeScript *script = S->get();
  920. if (script->placeholders.size() == 0)
  921. continue;
  922. for (Set<PlaceHolderScriptInstance *>::Element *P = script->placeholders.front(); P; P = P->next()) {
  923. PlaceHolderScriptInstance *p = P->get();
  924. script->_update_placeholder(p);
  925. }
  926. }
  927. }
  928. } break;
  929. default: {
  930. };
  931. }
  932. #endif
  933. }
  934. // Resource loader/saver
  935. RES ResourceFormatLoaderGDNativeScript::load(const String &p_path, const String &p_original_path, Error *r_error) {
  936. ResourceFormatLoaderText rsflt;
  937. return rsflt.load(p_path, p_original_path, r_error);
  938. }
  939. void ResourceFormatLoaderGDNativeScript::get_recognized_extensions(List<String> *p_extensions) const {
  940. p_extensions->push_back("gdn");
  941. }
  942. bool ResourceFormatLoaderGDNativeScript::handles_type(const String &p_type) const {
  943. return (p_type == "Script" || p_type == "Native");
  944. }
  945. String ResourceFormatLoaderGDNativeScript::get_resource_type(const String &p_path) const {
  946. String el = p_path.get_extension().to_lower();
  947. if (el == "gdn")
  948. return "Native";
  949. return "";
  950. }
  951. Error ResourceFormatSaverGDNativeScript::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  952. ResourceFormatSaverText rfst;
  953. return rfst.save(p_path, p_resource, p_flags);
  954. }
  955. bool ResourceFormatSaverGDNativeScript::recognize(const RES &p_resource) const {
  956. return p_resource->cast_to<GDNativeScript>() != NULL;
  957. }
  958. void ResourceFormatSaverGDNativeScript::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  959. if (p_resource->cast_to<GDNativeScript>()) {
  960. p_extensions->push_back("gdn");
  961. }
  962. }