2
0

csharp_script.cpp 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999
  1. /*************************************************************************/
  2. /* csharp_script.cpp */
  3. /*************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://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 "csharp_script.h"
  31. #include <mono/metadata/threads.h>
  32. #include "os/file_access.h"
  33. #include "os/os.h"
  34. #include "os/thread.h"
  35. #include "project_settings.h"
  36. #ifdef TOOLS_ENABLED
  37. #include "editor/bindings_generator.h"
  38. #include "editor/csharp_project.h"
  39. #include "editor/editor_node.h"
  40. #include "editor/godotsharp_editor.h"
  41. #include "utils/string_utils.h"
  42. #endif
  43. #include "godotsharp_dirs.h"
  44. #include "mono_gd/gd_mono_class.h"
  45. #include "mono_gd/gd_mono_marshal.h"
  46. #include "signal_awaiter_utils.h"
  47. #define CACHED_STRING_NAME(m_var) (CSharpLanguage::get_singleton()->get_string_names().m_var)
  48. #ifdef TOOLS_ENABLED
  49. static bool _create_project_solution_if_needed() {
  50. String sln_path = GodotSharpDirs::get_project_sln_path();
  51. String csproj_path = GodotSharpDirs::get_project_csproj_path();
  52. if (!FileAccess::exists(sln_path) || !FileAccess::exists(csproj_path)) {
  53. // A solution does not yet exist, create a new one
  54. CRASH_COND(GodotSharpEditor::get_singleton() == NULL);
  55. return GodotSharpEditor::get_singleton()->call("_create_project_solution");
  56. }
  57. return true;
  58. }
  59. #endif
  60. CSharpLanguage *CSharpLanguage::singleton = NULL;
  61. String CSharpLanguage::get_name() const {
  62. return "C#";
  63. }
  64. String CSharpLanguage::get_type() const {
  65. return "CSharpScript";
  66. }
  67. String CSharpLanguage::get_extension() const {
  68. return "cs";
  69. }
  70. Error CSharpLanguage::execute_file(const String &p_path) {
  71. // ??
  72. return OK;
  73. }
  74. #ifdef TOOLS_ENABLED
  75. void gdsharp_editor_init_callback() {
  76. EditorNode *editor = EditorNode::get_singleton();
  77. editor->add_child(memnew(GodotSharpEditor(editor)));
  78. }
  79. #endif
  80. void CSharpLanguage::init() {
  81. gdmono = memnew(GDMono);
  82. gdmono->initialize();
  83. #ifdef MONO_GLUE_DISABLED
  84. WARN_PRINT("This binary is built with `mono_glue=no` and cannot be used for scripting");
  85. #endif
  86. #if defined(TOOLS_ENABLED) && defined(DEBUG_METHODS_ENABLED)
  87. if (gdmono->get_editor_tools_assembly() != NULL) {
  88. List<String> cmdline_args = OS::get_singleton()->get_cmdline_args();
  89. BindingsGenerator::handle_cmdline_args(cmdline_args);
  90. }
  91. #endif
  92. #ifdef TOOLS_ENABLED
  93. EditorNode::add_init_callback(&gdsharp_editor_init_callback);
  94. #endif
  95. }
  96. void CSharpLanguage::finish() {
  97. // Release gchandle bindings before finalizing mono runtime
  98. gchandle_bindings.clear();
  99. if (gdmono) {
  100. memdelete(gdmono);
  101. gdmono = NULL;
  102. }
  103. }
  104. void CSharpLanguage::get_reserved_words(List<String> *p_words) const {
  105. static const char *_reserved_words[] = {
  106. // Reserved keywords
  107. "abstract",
  108. "as",
  109. "base",
  110. "bool",
  111. "break",
  112. "byte",
  113. "case",
  114. "catch",
  115. "char",
  116. "checked",
  117. "class",
  118. "const",
  119. "continue",
  120. "decimal",
  121. "default",
  122. "delegate",
  123. "do",
  124. "double",
  125. "else",
  126. "enum",
  127. "event",
  128. "explicit",
  129. "extern",
  130. "false",
  131. "finally",
  132. "fixed",
  133. "float",
  134. "for",
  135. "forech",
  136. "goto",
  137. "if",
  138. "implicit",
  139. "in",
  140. "int",
  141. "interface",
  142. "internal",
  143. "is",
  144. "lock",
  145. "long",
  146. "namespace",
  147. "new",
  148. "null",
  149. "object",
  150. "operator",
  151. "out",
  152. "override",
  153. "params",
  154. "private",
  155. "protected",
  156. "public",
  157. "readonly",
  158. "ref",
  159. "return",
  160. "sbyte",
  161. "sealed",
  162. "short",
  163. "sizeof",
  164. "stackalloc",
  165. "static",
  166. "string",
  167. "struct",
  168. "switch",
  169. "this",
  170. "throw",
  171. "true",
  172. "try",
  173. "typeof",
  174. "uint",
  175. "ulong",
  176. "unchecked",
  177. "unsafe",
  178. "ushort",
  179. "using",
  180. "virtual",
  181. "volatile",
  182. "void",
  183. "while",
  184. // Contextual keywords. Not reserved words, but I guess we should include
  185. // them because this seems to be used only for syntax highlighting.
  186. "add",
  187. "ascending",
  188. "by",
  189. "descending",
  190. "dynamic",
  191. "equals",
  192. "from",
  193. "get",
  194. "global",
  195. "group",
  196. "in",
  197. "into",
  198. "join",
  199. "let",
  200. "on",
  201. "orderby",
  202. "partial",
  203. "remove",
  204. "select",
  205. "set",
  206. "value",
  207. "var",
  208. "where",
  209. "yield",
  210. 0
  211. };
  212. const char **w = _reserved_words;
  213. while (*w) {
  214. p_words->push_back(*w);
  215. w++;
  216. }
  217. }
  218. void CSharpLanguage::get_comment_delimiters(List<String> *p_delimiters) const {
  219. p_delimiters->push_back("//"); // single-line comment
  220. p_delimiters->push_back("/* */"); // delimited comment
  221. }
  222. void CSharpLanguage::get_string_delimiters(List<String> *p_delimiters) const {
  223. p_delimiters->push_back("' '"); // character literal
  224. p_delimiters->push_back("\" \""); // regular string literal
  225. p_delimiters->push_back("@\" \""); // verbatim string literal
  226. }
  227. Ref<Script> CSharpLanguage::get_template(const String &p_class_name, const String &p_base_class_name) const {
  228. String script_template = "using " BINDINGS_NAMESPACE ";\n"
  229. "using System;\n"
  230. "\n"
  231. "public class %CLASS_NAME% : %BASE_CLASS_NAME%\n"
  232. "{\n"
  233. " // Member variables here, example:\n"
  234. " // private int a = 2;\n"
  235. " // private string b = \"textvar\";\n"
  236. "\n"
  237. " public override void _Ready()\n"
  238. " {\n"
  239. " // Called every time the node is added to the scene.\n"
  240. " // Initialization here\n"
  241. " \n"
  242. " }\n"
  243. "\n"
  244. "// public override void _Process(float delta)\n"
  245. "// {\n"
  246. "// // Called every frame. Delta is time since last frame.\n"
  247. "// // Update game logic here.\n"
  248. "// \n"
  249. "// }\n"
  250. "}\n";
  251. script_template = script_template.replace("%BASE_CLASS_NAME%", p_base_class_name)
  252. .replace("%CLASS_NAME%", p_class_name);
  253. Ref<CSharpScript> script;
  254. script.instance();
  255. script->set_source_code(script_template);
  256. script->set_name(p_class_name);
  257. return script;
  258. }
  259. Script *CSharpLanguage::create_script() const {
  260. return memnew(CSharpScript);
  261. }
  262. bool CSharpLanguage::has_named_classes() const {
  263. return false;
  264. }
  265. bool CSharpLanguage::supports_builtin_mode() const {
  266. return false;
  267. }
  268. static String variant_type_to_managed_name(const String &p_var_type_name) {
  269. if (p_var_type_name.empty())
  270. return "object";
  271. if (!ClassDB::class_exists(p_var_type_name)) {
  272. Variant::Type var_types[] = {
  273. Variant::BOOL,
  274. Variant::INT,
  275. Variant::REAL,
  276. Variant::STRING,
  277. Variant::VECTOR2,
  278. Variant::RECT2,
  279. Variant::VECTOR3,
  280. Variant::TRANSFORM2D,
  281. Variant::PLANE,
  282. Variant::QUAT,
  283. Variant::RECT3,
  284. Variant::BASIS,
  285. Variant::TRANSFORM,
  286. Variant::COLOR,
  287. Variant::NODE_PATH,
  288. Variant::_RID
  289. };
  290. for (int i = 0; i < sizeof(var_types) / sizeof(Variant::Type); i++) {
  291. if (p_var_type_name == Variant::get_type_name(var_types[i]))
  292. return p_var_type_name;
  293. }
  294. if (p_var_type_name == "String")
  295. return "string"; // I prefer this one >:[
  296. // TODO these will be rewritten later into custom containers
  297. if (p_var_type_name == "Array")
  298. return "object[]";
  299. if (p_var_type_name == "Dictionary")
  300. return "Dictionary<object, object>";
  301. if (p_var_type_name == "PoolByteArray")
  302. return "byte[]";
  303. if (p_var_type_name == "PoolIntArray")
  304. return "int[]";
  305. if (p_var_type_name == "PoolRealArray")
  306. return "float[]";
  307. if (p_var_type_name == "PoolStringArray")
  308. return "string[]";
  309. if (p_var_type_name == "PoolVector2Array")
  310. return "Vector2[]";
  311. if (p_var_type_name == "PoolVector3Array")
  312. return "Vector3[]";
  313. if (p_var_type_name == "PoolColorArray")
  314. return "Color[]";
  315. return "object";
  316. }
  317. return p_var_type_name;
  318. }
  319. String CSharpLanguage::make_function(const String &p_class, const String &p_name, const PoolStringArray &p_args) const {
  320. #ifdef TOOLS_ENABLED
  321. // FIXME
  322. // - Due to Godot's API limitation this just appends the function to the end of the file
  323. // - Use fully qualified name if there is ambiguity
  324. String s = "private void " + p_name + "(";
  325. for (int i = 0; i < p_args.size(); i++) {
  326. const String &arg = p_args[i];
  327. if (i > 0)
  328. s += ", ";
  329. s += variant_type_to_managed_name(arg.get_slice(":", 1)) + " " + escape_csharp_keyword(arg.get_slice(":", 0));
  330. }
  331. s += ")\n{\n // Replace with function body\n}\n";
  332. return s;
  333. #else
  334. return String();
  335. #endif
  336. }
  337. void CSharpLanguage::frame() {
  338. const Ref<MonoGCHandle> &task_scheduler_handle = GDMonoUtils::mono_cache.task_scheduler_handle;
  339. if (task_scheduler_handle.is_valid()) {
  340. MonoObject *task_scheduler = task_scheduler_handle->get_target();
  341. if (task_scheduler) {
  342. GDMonoUtils::GodotTaskScheduler_Activate thunk = CACHED_METHOD_THUNK(GodotTaskScheduler, Activate);
  343. ERR_FAIL_NULL(thunk);
  344. MonoObject *ex;
  345. thunk(task_scheduler, &ex);
  346. if (ex) {
  347. mono_print_unhandled_exception(ex);
  348. ERR_FAIL();
  349. }
  350. }
  351. }
  352. }
  353. struct CSharpScriptDepSort {
  354. // must support sorting so inheritance works properly (parent must be reloaded first)
  355. bool operator()(const Ref<CSharpScript> &A, const Ref<CSharpScript> &B) const {
  356. if (A == B)
  357. return false; // shouldn't happen but..
  358. GDMonoClass *I = B->base;
  359. while (I) {
  360. if (I == A->script_class) {
  361. // A is a base of B
  362. return true;
  363. }
  364. I = I->get_parent_class();
  365. }
  366. return false; // not a base
  367. }
  368. };
  369. void CSharpLanguage::reload_all_scripts() {
  370. #ifdef DEBUG_ENABLED
  371. #ifndef NO_THREADS
  372. lock->lock();
  373. #endif
  374. List<Ref<CSharpScript> > scripts;
  375. SelfList<CSharpScript> *elem = script_list.first();
  376. while (elem) {
  377. if (elem->self()->get_path().is_resource_file()) {
  378. scripts.push_back(Ref<CSharpScript>(elem->self())); //cast to gdscript to avoid being erased by accident
  379. }
  380. elem = elem->next();
  381. }
  382. #ifndef NO_THREADS
  383. lock->unlock();
  384. #endif
  385. //as scripts are going to be reloaded, must proceed without locking here
  386. scripts.sort_custom<CSharpScriptDepSort>(); //update in inheritance dependency order
  387. for (List<Ref<CSharpScript> >::Element *E = scripts.front(); E; E = E->next()) {
  388. E->get()->load_source_code(E->get()->get_path());
  389. E->get()->reload(true);
  390. }
  391. #endif
  392. }
  393. void CSharpLanguage::reload_tool_script(const Ref<Script> &p_script, bool p_soft_reload) {
  394. (void)p_script; // UNUSED
  395. #ifdef TOOLS_ENABLED
  396. MonoReloadNode::get_singleton()->restart_reload_timer();
  397. reload_assemblies_if_needed(p_soft_reload);
  398. #endif
  399. }
  400. #ifdef TOOLS_ENABLED
  401. void CSharpLanguage::reload_assemblies_if_needed(bool p_soft_reload) {
  402. if (gdmono->is_runtime_initialized()) {
  403. GDMonoAssembly *proj_assembly = gdmono->get_project_assembly();
  404. String name = ProjectSettings::get_singleton()->get("application/config/name");
  405. if (name.empty()) {
  406. name = "UnnamedProject";
  407. }
  408. if (proj_assembly) {
  409. String proj_asm_path = proj_assembly->get_path();
  410. if (!FileAccess::exists(proj_assembly->get_path())) {
  411. // Maybe it wasn't loaded from the default path, so check this as well
  412. proj_asm_path = GodotSharpDirs::get_res_temp_assemblies_dir().plus_file(name);
  413. if (!FileAccess::exists(proj_asm_path))
  414. return; // No assembly to load
  415. }
  416. if (FileAccess::get_modified_time(proj_asm_path) <= proj_assembly->get_modified_time())
  417. return; // Already up to date
  418. } else {
  419. if (!FileAccess::exists(GodotSharpDirs::get_res_temp_assemblies_dir().plus_file(name)))
  420. return; // No assembly to load
  421. }
  422. }
  423. #ifndef NO_THREADS
  424. lock->lock();
  425. #endif
  426. List<Ref<CSharpScript> > scripts;
  427. SelfList<CSharpScript> *elem = script_list.first();
  428. while (elem) {
  429. if (elem->self()->get_path().is_resource_file()) {
  430. scripts.push_back(Ref<CSharpScript>(elem->self())); //cast to CSharpScript to avoid being erased by accident
  431. }
  432. elem = elem->next();
  433. }
  434. #ifndef NO_THREADS
  435. lock->unlock();
  436. #endif
  437. //when someone asks you why dynamically typed languages are easier to write....
  438. Map<Ref<CSharpScript>, Map<ObjectID, List<Pair<StringName, Variant> > > > to_reload;
  439. //as scripts are going to be reloaded, must proceed without locking here
  440. scripts.sort_custom<CSharpScriptDepSort>(); //update in inheritance dependency order
  441. for (List<Ref<CSharpScript> >::Element *E = scripts.front(); E; E = E->next()) {
  442. to_reload.insert(E->get(), Map<ObjectID, List<Pair<StringName, Variant> > >());
  443. if (!p_soft_reload) {
  444. //save state and remove script from instances
  445. Map<ObjectID, List<Pair<StringName, Variant> > > &map = to_reload[E->get()];
  446. while (E->get()->instances.front()) {
  447. Object *obj = E->get()->instances.front()->get();
  448. //save instance info
  449. List<Pair<StringName, Variant> > state;
  450. if (obj->get_script_instance()) {
  451. obj->get_script_instance()->get_property_state(state);
  452. Ref<MonoGCHandle> gchandle = CAST_CSHARP_INSTANCE(obj->get_script_instance())->gchandle;
  453. if (gchandle.is_valid())
  454. gchandle->release();
  455. map[obj->get_instance_id()] = state;
  456. obj->set_script(RefPtr());
  457. }
  458. }
  459. //same thing for placeholders
  460. while (E->get()->placeholders.size()) {
  461. Object *obj = E->get()->placeholders.front()->get()->get_owner();
  462. //save instance info
  463. List<Pair<StringName, Variant> > state;
  464. if (obj->get_script_instance()) {
  465. obj->get_script_instance()->get_property_state(state);
  466. map[obj->get_instance_id()] = state;
  467. obj->set_script(RefPtr());
  468. }
  469. }
  470. for (Map<ObjectID, List<Pair<StringName, Variant> > >::Element *F = E->get()->pending_reload_state.front(); F; F = F->next()) {
  471. map[F->key()] = F->get(); //pending to reload, use this one instead
  472. }
  473. E->get()->_clear();
  474. }
  475. }
  476. if (gdmono->reload_scripts_domain() != OK)
  477. return;
  478. for (Map<Ref<CSharpScript>, Map<ObjectID, List<Pair<StringName, Variant> > > >::Element *E = to_reload.front(); E; E = E->next()) {
  479. Ref<CSharpScript> scr = E->key();
  480. scr->exports_invalidated = true;
  481. scr->reload(p_soft_reload);
  482. scr->update_exports();
  483. //restore state if saved
  484. for (Map<ObjectID, List<Pair<StringName, Variant> > >::Element *F = E->get().front(); F; F = F->next()) {
  485. Object *obj = ObjectDB::get_instance(F->key());
  486. if (!obj)
  487. continue;
  488. if (!p_soft_reload) {
  489. //clear it just in case (may be a pending reload state)
  490. obj->set_script(RefPtr());
  491. }
  492. obj->set_script(scr.get_ref_ptr());
  493. if (!obj->get_script_instance()) {
  494. //failed, save reload state for next time if not saved
  495. if (!scr->pending_reload_state.has(obj->get_instance_id())) {
  496. scr->pending_reload_state[obj->get_instance_id()] = F->get();
  497. }
  498. continue;
  499. }
  500. for (List<Pair<StringName, Variant> >::Element *G = F->get().front(); G; G = G->next()) {
  501. obj->get_script_instance()->set(G->get().first, G->get().second);
  502. }
  503. scr->pending_reload_state.erase(obj->get_instance_id()); //as it reloaded, remove pending state
  504. }
  505. //if instance states were saved, set them!
  506. }
  507. if (Engine::get_singleton()->is_editor_hint())
  508. EditorNode::get_singleton()->get_property_editor()->update_tree();
  509. }
  510. #endif
  511. void CSharpLanguage::get_recognized_extensions(List<String> *p_extensions) const {
  512. p_extensions->push_back("cs");
  513. }
  514. #ifdef TOOLS_ENABLED
  515. Error CSharpLanguage::open_in_external_editor(const Ref<Script> &p_script, int p_line, int p_col) {
  516. return GodotSharpEditor::get_singleton()->open_in_external_editor(p_script, p_line, p_col);
  517. }
  518. bool CSharpLanguage::overrides_external_editor() {
  519. return GodotSharpEditor::get_singleton()->overrides_external_editor();
  520. }
  521. #endif
  522. void CSharpLanguage::thread_enter() {
  523. #if 0
  524. if (mono->is_runtime_initialized()) {
  525. GDMonoUtils::attach_current_thread();
  526. }
  527. #endif
  528. }
  529. void CSharpLanguage::thread_exit() {
  530. #if 0
  531. if (mono->is_runtime_initialized()) {
  532. GDMonoUtils::detach_current_thread();
  533. }
  534. #endif
  535. }
  536. bool CSharpLanguage::debug_break_parse(const String &p_file, int p_line, const String &p_error) {
  537. // Break because of parse error
  538. if (ScriptDebugger::get_singleton() && Thread::get_caller_id() == Thread::get_main_id()) {
  539. // TODO
  540. //_debug_parse_err_line = p_line;
  541. //_debug_parse_err_file = p_file;
  542. //_debug_error = p_error;
  543. ScriptDebugger::get_singleton()->debug(this, false);
  544. return true;
  545. } else {
  546. return false;
  547. }
  548. }
  549. bool CSharpLanguage::debug_break(const String &p_error, bool p_allow_continue) {
  550. if (ScriptDebugger::get_singleton() && Thread::get_caller_id() == Thread::get_main_id()) {
  551. // TODO
  552. //_debug_parse_err_line = -1;
  553. //_debug_parse_err_file = "";
  554. //_debug_error = p_error;
  555. ScriptDebugger::get_singleton()->debug(this, p_allow_continue);
  556. return true;
  557. } else {
  558. return false;
  559. }
  560. }
  561. void CSharpLanguage::set_language_index(int p_idx) {
  562. ERR_FAIL_COND(lang_idx != -1);
  563. lang_idx = p_idx;
  564. }
  565. CSharpLanguage::CSharpLanguage() {
  566. ERR_FAIL_COND(singleton);
  567. singleton = this;
  568. gdmono = NULL;
  569. #ifdef NO_THREADS
  570. lock = NULL;
  571. gchandle_bind_lock = NULL;
  572. #else
  573. lock = Mutex::create();
  574. script_bind_lock = Mutex::create();
  575. #endif
  576. lang_idx = -1;
  577. }
  578. CSharpLanguage::~CSharpLanguage() {
  579. finish();
  580. if (lock) {
  581. memdelete(lock);
  582. lock = NULL;
  583. }
  584. if (script_bind_lock) {
  585. memdelete(script_bind_lock);
  586. script_bind_lock = NULL;
  587. }
  588. singleton = NULL;
  589. }
  590. void *CSharpLanguage::alloc_instance_binding_data(Object *p_object) {
  591. #ifdef DEBUG_ENABLED
  592. // I don't trust you
  593. if (p_object->get_script_instance())
  594. CRASH_COND(NULL != CAST_CSHARP_INSTANCE(p_object->get_script_instance()));
  595. #endif
  596. StringName type_name = p_object->get_class_name();
  597. // ¯\_(ツ)_/¯
  598. const ClassDB::ClassInfo *classinfo = ClassDB::classes.getptr(type_name);
  599. while (classinfo && !classinfo->exposed)
  600. classinfo = classinfo->inherits_ptr;
  601. ERR_FAIL_NULL_V(classinfo, NULL);
  602. type_name = classinfo->name;
  603. GDMonoClass *type_class = GDMonoUtils::type_get_proxy_class(type_name);
  604. ERR_FAIL_NULL_V(type_class, NULL);
  605. MonoObject *mono_object = GDMonoUtils::create_managed_for_godot_object(type_class, type_name, p_object);
  606. ERR_FAIL_NULL_V(mono_object, NULL);
  607. // Tie managed to unmanaged
  608. bool strong_handle = true;
  609. Reference *ref = Object::cast_to<Reference>(p_object);
  610. if (ref) {
  611. strong_handle = false;
  612. // Unsafe refcount increment. The managed instance also counts as a reference.
  613. // This way if the unmanaged world has no references to our owner
  614. // but the managed instance is alive, the refcount will be 1 instead of 0.
  615. // See: _GodotSharp::_dispose_object(Object *p_object)
  616. ref->reference();
  617. }
  618. Ref<MonoGCHandle> gchandle = strong_handle ? MonoGCHandle::create_strong(mono_object) :
  619. MonoGCHandle::create_weak(mono_object);
  620. #ifndef NO_THREADS
  621. script_bind_lock->lock();
  622. #endif
  623. void *data = (void *)gchandle_bindings.insert(p_object, gchandle);
  624. #ifndef NO_THREADS
  625. script_bind_lock->unlock();
  626. #endif
  627. return data;
  628. }
  629. void CSharpLanguage::free_instance_binding_data(void *p_data) {
  630. if (GDMono::get_singleton() == NULL) {
  631. #ifdef DEBUG_ENABLED
  632. CRASH_COND(!gchandle_bindings.empty());
  633. #endif
  634. // Mono runtime finalized, all the gchandle bindings were already released
  635. return;
  636. }
  637. #ifndef NO_THREADS
  638. script_bind_lock->lock();
  639. #endif
  640. gchandle_bindings.erase((Map<Object *, Ref<MonoGCHandle> >::Element *)p_data);
  641. #ifndef NO_THREADS
  642. script_bind_lock->unlock();
  643. #endif
  644. }
  645. void CSharpInstance::_ml_call_reversed(GDMonoClass *klass, const StringName &p_method, const Variant **p_args, int p_argcount) {
  646. GDMonoClass *base = klass->get_parent_class();
  647. if (base && base != script->native)
  648. _ml_call_reversed(base, p_method, p_args, p_argcount);
  649. GDMonoMethod *method = klass->get_method(p_method, p_argcount);
  650. if (method) {
  651. method->invoke(get_mono_object(), p_args);
  652. }
  653. }
  654. CSharpInstance *CSharpInstance::create_for_managed_type(Object *p_owner, CSharpScript *p_script, const Ref<MonoGCHandle> &p_gchandle) {
  655. CSharpInstance *instance = memnew(CSharpInstance);
  656. Reference *ref = Object::cast_to<Reference>(p_owner);
  657. instance->base_ref = ref != NULL;
  658. instance->script = Ref<CSharpScript>(p_script);
  659. instance->owner = p_owner;
  660. instance->gchandle = p_gchandle;
  661. if (instance->base_ref)
  662. instance->_reference_owner_unsafe();
  663. p_script->instances.insert(p_owner);
  664. return instance;
  665. }
  666. MonoObject *CSharpInstance::get_mono_object() const {
  667. #ifdef DEBUG_ENABLED
  668. CRASH_COND(gchandle.is_null());
  669. #endif
  670. return gchandle->get_target();
  671. }
  672. bool CSharpInstance::set(const StringName &p_name, const Variant &p_value) {
  673. ERR_FAIL_COND_V(!script.is_valid(), false);
  674. GDMonoClass *top = script->script_class;
  675. while (top && top != script->native) {
  676. GDMonoField *field = script->script_class->get_field(p_name);
  677. if (field) {
  678. MonoObject *mono_object = get_mono_object();
  679. ERR_EXPLAIN("Reference has been garbage collected?");
  680. ERR_FAIL_NULL_V(mono_object, false);
  681. field->set_value(mono_object, p_value);
  682. return true;
  683. }
  684. top = top->get_parent_class();
  685. }
  686. // Call _set
  687. Variant name = p_name;
  688. const Variant *args[2] = { &name, &p_value };
  689. MonoObject *mono_object = get_mono_object();
  690. top = script->script_class;
  691. while (top && top != script->native) {
  692. GDMonoMethod *method = top->get_method(CACHED_STRING_NAME(_set), 2);
  693. if (method) {
  694. MonoObject *ret = method->invoke(mono_object, args);
  695. if (ret && GDMonoMarshal::unbox<MonoBoolean>(ret) == true)
  696. return true;
  697. }
  698. top = top->get_parent_class();
  699. }
  700. return false;
  701. }
  702. bool CSharpInstance::get(const StringName &p_name, Variant &r_ret) const {
  703. ERR_FAIL_COND_V(!script.is_valid(), false);
  704. GDMonoClass *top = script->script_class;
  705. while (top && top != script->native) {
  706. GDMonoField *field = top->get_field(p_name);
  707. if (field) {
  708. MonoObject *mono_object = get_mono_object();
  709. ERR_EXPLAIN("Reference has been garbage collected?");
  710. ERR_FAIL_NULL_V(mono_object, false);
  711. MonoObject *value = field->get_value(mono_object);
  712. r_ret = GDMonoMarshal::mono_object_to_variant(value, field->get_type());
  713. return true;
  714. }
  715. // Call _get
  716. GDMonoMethod *method = top->get_method(CACHED_STRING_NAME(_get), 1);
  717. if (method) {
  718. Variant name = p_name;
  719. const Variant *args[1] = { &name };
  720. MonoObject *ret = method->invoke(get_mono_object(), args);
  721. if (ret) {
  722. r_ret = GDMonoMarshal::mono_object_to_variant(ret);
  723. return true;
  724. }
  725. }
  726. top = top->get_parent_class();
  727. }
  728. return false;
  729. }
  730. void CSharpInstance::get_property_list(List<PropertyInfo> *p_properties) const {
  731. for (Map<StringName, PropertyInfo>::Element *E = script->member_info.front(); E; E = E->next()) {
  732. p_properties->push_back(E->value());
  733. }
  734. }
  735. Variant::Type CSharpInstance::get_property_type(const StringName &p_name, bool *r_is_valid) const {
  736. if (script->member_info.has(p_name)) {
  737. if (r_is_valid)
  738. *r_is_valid = true;
  739. return script->member_info[p_name].type;
  740. }
  741. if (r_is_valid)
  742. *r_is_valid = false;
  743. return Variant::NIL;
  744. }
  745. bool CSharpInstance::has_method(const StringName &p_method) const {
  746. if (!script.is_valid())
  747. return false;
  748. GDMonoClass *top = script->script_class;
  749. while (top && top != script->native) {
  750. if (top->has_method(p_method)) {
  751. return true;
  752. }
  753. top = top->get_parent_class();
  754. }
  755. return false;
  756. }
  757. Variant CSharpInstance::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  758. MonoObject *mono_object = get_mono_object();
  759. ERR_EXPLAIN("Reference has been garbage collected?");
  760. ERR_FAIL_NULL_V(mono_object, Variant());
  761. if (!script.is_valid())
  762. return Variant();
  763. GDMonoClass *top = script->script_class;
  764. while (top && top != script->native) {
  765. GDMonoMethod *method = top->get_method(p_method, p_argcount);
  766. if (method) {
  767. MonoObject *return_value = method->invoke(mono_object, p_args);
  768. if (return_value) {
  769. return GDMonoMarshal::mono_object_to_variant(return_value, method->get_return_type());
  770. } else {
  771. return Variant();
  772. }
  773. }
  774. top = top->get_parent_class();
  775. }
  776. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  777. return Variant();
  778. }
  779. void CSharpInstance::call_multilevel(const StringName &p_method, const Variant **p_args, int p_argcount) {
  780. if (script.is_valid()) {
  781. MonoObject *mono_object = get_mono_object();
  782. GDMonoClass *top = script->script_class;
  783. while (top && top != script->native) {
  784. GDMonoMethod *method = top->get_method(p_method, p_argcount);
  785. if (method)
  786. method->invoke(mono_object, p_args);
  787. top = top->get_parent_class();
  788. }
  789. }
  790. }
  791. void CSharpInstance::call_multilevel_reversed(const StringName &p_method, const Variant **p_args, int p_argcount) {
  792. if (script.is_valid()) {
  793. _ml_call_reversed(script->script_class, p_method, p_args, p_argcount);
  794. }
  795. }
  796. void CSharpInstance::_reference_owner_unsafe() {
  797. #ifdef DEBUG_ENABLED
  798. CRASH_COND(!base_ref);
  799. #endif
  800. // Unsafe refcount increment. The managed instance also counts as a reference.
  801. // This way if the unmanaged world has no references to our owner
  802. // but the managed instance is alive, the refcount will be 1 instead of 0.
  803. // See: _unreference_owner_unsafe()
  804. // May not me referenced yet, so we must use init_ref() instead of reference()
  805. Object::cast_to<Reference>(owner)->init_ref();
  806. }
  807. void CSharpInstance::_unreference_owner_unsafe() {
  808. #ifdef DEBUG_ENABLED
  809. CRASH_COND(!base_ref);
  810. #endif
  811. // Called from CSharpInstance::mono_object_disposed() or ~CSharpInstance()
  812. // Unsafe refcount decrement. The managed instance also counts as a reference.
  813. // See: _reference_owner_unsafe()
  814. if (Object::cast_to<Reference>(owner)->unreference()) {
  815. memdelete(owner);
  816. owner = NULL;
  817. }
  818. }
  819. void CSharpInstance::mono_object_disposed() {
  820. if (base_ref)
  821. _unreference_owner_unsafe();
  822. }
  823. void CSharpInstance::refcount_incremented() {
  824. CRASH_COND(!base_ref);
  825. Reference *ref_owner = Object::cast_to<Reference>(owner);
  826. if (ref_owner->reference_get_count() > 1) { // Remember the managed side holds a reference, hence 1 instead of 0 here
  827. // The reference count was increased after the managed side was the only one referencing our owner.
  828. // This means the owner is being referenced again by the unmanaged side,
  829. // so the owner must hold the managed side alive again to avoid it from being GCed.
  830. // Release the current weak handle and replace it with a strong handle.
  831. uint32_t strong_gchandle = MonoGCHandle::make_strong_handle(gchandle->get_target());
  832. gchandle->release();
  833. gchandle->set_handle(strong_gchandle);
  834. }
  835. }
  836. bool CSharpInstance::refcount_decremented() {
  837. CRASH_COND(!base_ref);
  838. Reference *ref_owner = Object::cast_to<Reference>(owner);
  839. int refcount = ref_owner->reference_get_count();
  840. if (refcount == 1) { // Remember the managed side holds a reference, hence 1 instead of 0 here
  841. // If owner owner is no longer referenced by the unmanaged side,
  842. // the managed instance takes responsibility of deleting the owner when GCed.
  843. // Release the current strong handle and replace it with a weak handle.
  844. uint32_t weak_gchandle = MonoGCHandle::make_weak_handle(gchandle->get_target());
  845. gchandle->release();
  846. gchandle->set_handle(weak_gchandle);
  847. return false;
  848. }
  849. ref_dying = (refcount == 0);
  850. return ref_dying;
  851. }
  852. ScriptInstance::RPCMode CSharpInstance::get_rpc_mode(const StringName &p_method) const {
  853. GDMonoClass *top = script->script_class;
  854. while (top && top != script->native) {
  855. GDMonoMethod *method = top->get_method(p_method);
  856. if (method) { // TODO should we reject static methods?
  857. // TODO cache result
  858. if (method->has_attribute(CACHED_CLASS(RemoteAttribute)))
  859. return RPC_MODE_REMOTE;
  860. if (method->has_attribute(CACHED_CLASS(SyncAttribute)))
  861. return RPC_MODE_SYNC;
  862. if (method->has_attribute(CACHED_CLASS(MasterAttribute)))
  863. return RPC_MODE_MASTER;
  864. if (method->has_attribute(CACHED_CLASS(SlaveAttribute)))
  865. return RPC_MODE_SLAVE;
  866. }
  867. top = top->get_parent_class();
  868. }
  869. return RPC_MODE_DISABLED;
  870. }
  871. ScriptInstance::RPCMode CSharpInstance::get_rset_mode(const StringName &p_variable) const {
  872. GDMonoClass *top = script->script_class;
  873. while (top && top != script->native) {
  874. GDMonoField *field = top->get_field(p_variable);
  875. if (field) { // TODO should we reject static fields?
  876. // TODO cache result
  877. if (field->has_attribute(CACHED_CLASS(RemoteAttribute)))
  878. return RPC_MODE_REMOTE;
  879. if (field->has_attribute(CACHED_CLASS(SyncAttribute)))
  880. return RPC_MODE_SYNC;
  881. if (field->has_attribute(CACHED_CLASS(MasterAttribute)))
  882. return RPC_MODE_MASTER;
  883. if (field->has_attribute(CACHED_CLASS(SlaveAttribute)))
  884. return RPC_MODE_SLAVE;
  885. }
  886. top = top->get_parent_class();
  887. }
  888. return RPC_MODE_DISABLED;
  889. }
  890. void CSharpInstance::notification(int p_notification) {
  891. Variant value = p_notification;
  892. const Variant *args[1] = { &value };
  893. call_multilevel(CACHED_STRING_NAME(_notification), args, 1);
  894. }
  895. Ref<Script> CSharpInstance::get_script() const {
  896. return script;
  897. }
  898. ScriptLanguage *CSharpInstance::get_language() {
  899. return CSharpLanguage::get_singleton();
  900. }
  901. CSharpInstance::CSharpInstance() {
  902. owner = NULL;
  903. base_ref = false;
  904. ref_dying = false;
  905. }
  906. CSharpInstance::~CSharpInstance() {
  907. if (gchandle.is_valid()) {
  908. gchandle->release(); // Make sure it's released
  909. }
  910. if (base_ref && !ref_dying) { // it may be called from the owner's destructor
  911. #ifdef DEBUG_ENABLED
  912. CRASH_COND(!owner); // dunno, just in case
  913. #endif
  914. _unreference_owner_unsafe();
  915. }
  916. if (script.is_valid() && owner) {
  917. #ifndef NO_THREADS
  918. CSharpLanguage::singleton->lock->lock();
  919. #endif
  920. #ifdef DEBUG_ENABLED
  921. // CSharpInstance must not be created unless it's going to be added to the list for sure
  922. Set<Object *>::Element *match = script->instances.find(owner);
  923. CRASH_COND(!match);
  924. script->instances.erase(match);
  925. #else
  926. script->instances.erase(owner);
  927. #endif
  928. #ifndef NO_THREADS
  929. CSharpLanguage::singleton->lock->unlock();
  930. #endif
  931. }
  932. }
  933. #ifdef TOOLS_ENABLED
  934. void CSharpScript::_placeholder_erased(PlaceHolderScriptInstance *p_placeholder) {
  935. placeholders.erase(p_placeholder);
  936. }
  937. #endif
  938. #ifdef TOOLS_ENABLED
  939. void CSharpScript::_update_exports_values(Map<StringName, Variant> &values, List<PropertyInfo> &propnames) {
  940. if (base_cache.is_valid()) {
  941. base_cache->_update_exports_values(values, propnames);
  942. }
  943. for (Map<StringName, Variant>::Element *E = exported_members_defval_cache.front(); E; E = E->next()) {
  944. values[E->key()] = E->get();
  945. }
  946. for (List<PropertyInfo>::Element *E = exported_members_cache.front(); E; E = E->next()) {
  947. propnames.push_back(E->get());
  948. }
  949. }
  950. #endif
  951. bool CSharpScript::_update_exports() {
  952. #ifdef TOOLS_ENABLED
  953. if (!valid)
  954. return false;
  955. bool changed = false;
  956. if (exports_invalidated) {
  957. exports_invalidated = false;
  958. changed = true;
  959. member_info.clear();
  960. exported_members_cache.clear();
  961. exported_members_defval_cache.clear();
  962. // We are creating a temporary new instance of the class here to get the default value
  963. // TODO Workaround. Should be replaced with IL opcodes analysis
  964. MonoObject *tmp_object = mono_object_new(SCRIPTS_DOMAIN, script_class->get_raw());
  965. if (tmp_object) {
  966. CACHED_FIELD(GodotObject, ptr)->set_value_raw(tmp_object, tmp_object); // FIXME WTF is this workaround
  967. GDMonoMethod *ctor = script_class->get_method(CACHED_STRING_NAME(dotctor), 0);
  968. MonoObject *ex = NULL;
  969. ctor->invoke(tmp_object, NULL, &ex);
  970. if (ex) {
  971. ERR_PRINT("Exception thrown from constructor of temporary MonoObject:");
  972. mono_print_unhandled_exception(ex);
  973. tmp_object = NULL;
  974. ERR_FAIL_V(false);
  975. }
  976. } else {
  977. ERR_PRINT("Failed to create temporary MonoObject");
  978. return false;
  979. }
  980. GDMonoClass *top = script_class;
  981. while (top && top != native) {
  982. const Vector<GDMonoField *> &fields = top->get_all_fields();
  983. for (int i = 0; i < fields.size(); i++) {
  984. GDMonoField *field = fields[i];
  985. if (field->is_static()) {
  986. if (field->has_attribute(CACHED_CLASS(ExportAttribute)))
  987. ERR_PRINTS("Cannot export field because it is static: " + top->get_full_name() + "." + field->get_name());
  988. continue;
  989. }
  990. String name = field->get_name();
  991. StringName cname = name;
  992. if (member_info.has(cname))
  993. continue;
  994. ManagedType field_type = field->get_type();
  995. Variant::Type type = GDMonoMarshal::managed_to_variant_type(field_type);
  996. if (field->has_attribute(CACHED_CLASS(ExportAttribute))) {
  997. // Field has Export attribute
  998. MonoObject *attr = field->get_attribute(CACHED_CLASS(ExportAttribute));
  999. PropertyHint hint;
  1000. String hint_string;
  1001. if (type == Variant::NIL) {
  1002. ERR_PRINTS("Unknown type of exported field: " + top->get_full_name() + "." + field->get_name());
  1003. continue;
  1004. } else if (type == Variant::INT && field_type.type_encoding == MONO_TYPE_VALUETYPE && mono_class_is_enum(field_type.type_class->get_raw())) {
  1005. type = Variant::INT;
  1006. hint = PROPERTY_HINT_ENUM;
  1007. Vector<MonoClassField *> fields = field_type.type_class->get_enum_fields();
  1008. for (int i = 0; i < fields.size(); i++) {
  1009. if (i > 0)
  1010. hint_string += ",";
  1011. hint_string += mono_field_get_name(fields[i]);
  1012. }
  1013. } else if (type == Variant::OBJECT && CACHED_CLASS(GodotReference)->is_assignable_from(field_type.type_class)) {
  1014. hint = PROPERTY_HINT_RESOURCE_TYPE;
  1015. hint_string = NATIVE_GDMONOCLASS_NAME(field_type.type_class);
  1016. } else {
  1017. hint = PropertyHint(CACHED_FIELD(ExportAttribute, hint)->get_int_value(attr));
  1018. hint_string = CACHED_FIELD(ExportAttribute, hint_string)->get_string_value(attr);
  1019. }
  1020. PropertyInfo prop_info = PropertyInfo(type, name, hint, hint_string, PROPERTY_USAGE_DEFAULT | PROPERTY_USAGE_SCRIPT_VARIABLE);
  1021. member_info[cname] = prop_info;
  1022. exported_members_cache.push_back(prop_info);
  1023. if (tmp_object) {
  1024. exported_members_defval_cache[cname] = GDMonoMarshal::mono_object_to_variant(field->get_value(tmp_object));
  1025. }
  1026. } else {
  1027. member_info[cname] = PropertyInfo(type, name, PROPERTY_HINT_NONE, "", PROPERTY_USAGE_SCRIPT_VARIABLE);
  1028. }
  1029. }
  1030. top = top->get_parent_class();
  1031. }
  1032. }
  1033. if (placeholders.size()) {
  1034. // Update placeholders if any
  1035. Map<StringName, Variant> values;
  1036. List<PropertyInfo> propnames;
  1037. _update_exports_values(values, propnames);
  1038. for (Set<PlaceHolderScriptInstance *>::Element *E = placeholders.front(); E; E = E->next()) {
  1039. E->get()->update(propnames, values);
  1040. }
  1041. }
  1042. return changed;
  1043. #endif
  1044. return false;
  1045. }
  1046. void CSharpScript::_clear() {
  1047. tool = false;
  1048. valid = false;
  1049. base = NULL;
  1050. native = NULL;
  1051. script_class = NULL;
  1052. }
  1053. Variant CSharpScript::call(const StringName &p_method, const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  1054. GDMonoClass *top = script_class;
  1055. while (top && top != native) {
  1056. GDMonoMethod *method = top->get_method(p_method, p_argcount);
  1057. if (method && method->is_static()) {
  1058. MonoObject *result = method->invoke(NULL, p_args);
  1059. if (result) {
  1060. return GDMonoMarshal::mono_object_to_variant(result, method->get_return_type());
  1061. } else {
  1062. return Variant();
  1063. }
  1064. }
  1065. top = top->get_parent_class();
  1066. }
  1067. // No static method found. Try regular instance calls
  1068. return Script::call(p_method, p_args, p_argcount, r_error);
  1069. }
  1070. void CSharpScript::_resource_path_changed() {
  1071. String path = get_path();
  1072. if (!path.empty()) {
  1073. name = get_path().get_file().get_basename();
  1074. }
  1075. }
  1076. void CSharpScript::_bind_methods() {
  1077. ClassDB::bind_vararg_method(METHOD_FLAGS_DEFAULT, "new", &CSharpScript::_new, MethodInfo(Variant::OBJECT, "new"));
  1078. }
  1079. Ref<CSharpScript> CSharpScript::create_for_managed_type(GDMonoClass *p_class) {
  1080. // This method should not fail
  1081. CRASH_COND(!p_class);
  1082. Ref<CSharpScript> script = memnew(CSharpScript);
  1083. script->name = p_class->get_name();
  1084. script->script_class = p_class;
  1085. script->native = GDMonoUtils::get_class_native_base(script->script_class);
  1086. CRASH_COND(script->native == NULL);
  1087. GDMonoClass *base = script->script_class->get_parent_class();
  1088. if (base != script->native)
  1089. script->base = base;
  1090. #ifdef DEBUG_ENABLED
  1091. // For debug builds, we must fetch from all native base methods as well.
  1092. // Native base methods must be fetched before the current class.
  1093. // Not needed if the script class itself is a native class.
  1094. if (script->script_class != script->native) {
  1095. GDMonoClass *native_top = script->native;
  1096. while (native_top) {
  1097. native_top->fetch_methods_with_godot_api_checks(script->native);
  1098. if (native_top == CACHED_CLASS(GodotObject))
  1099. break;
  1100. native_top = native_top->get_parent_class();
  1101. }
  1102. }
  1103. #endif
  1104. script->script_class->fetch_methods_with_godot_api_checks(script->native);
  1105. // Need to fetch method from base classes as well
  1106. GDMonoClass *top = script->script_class;
  1107. while (top && top != script->native) {
  1108. top->fetch_methods_with_godot_api_checks(script->native);
  1109. top = top->get_parent_class();
  1110. }
  1111. return script;
  1112. }
  1113. bool CSharpScript::can_instance() const {
  1114. #ifdef TOOLS_ENABLED
  1115. if (Engine::get_singleton()->is_editor_hint()) {
  1116. if (get_path().find("::") == -1) { // Ignore if built-in script. Can happen if the file is deleted...
  1117. if (_create_project_solution_if_needed()) {
  1118. CSharpProject::add_item(GodotSharpDirs::get_project_csproj_path(),
  1119. "Compile",
  1120. ProjectSettings::get_singleton()->globalize_path(get_path()));
  1121. } else {
  1122. ERR_PRINTS("Cannot add " + get_path() + " to the C# project because it could not be created.");
  1123. }
  1124. }
  1125. }
  1126. #endif
  1127. return valid || (!tool && !ScriptServer::is_scripting_enabled());
  1128. }
  1129. StringName CSharpScript::get_instance_base_type() const {
  1130. if (native)
  1131. return native->get_name();
  1132. else
  1133. return StringName();
  1134. }
  1135. CSharpInstance *CSharpScript::_create_instance(const Variant **p_args, int p_argcount, Object *p_owner, bool p_isref, Variant::CallError &r_error) {
  1136. /* STEP 1, CREATE */
  1137. CSharpInstance *instance = memnew(CSharpInstance);
  1138. instance->base_ref = p_isref;
  1139. instance->script = Ref<CSharpScript>(this);
  1140. instance->owner = p_owner;
  1141. instance->owner->set_script_instance(instance);
  1142. if (instance->base_ref)
  1143. instance->_reference_owner_unsafe();
  1144. /* STEP 2, INITIALIZE AND CONSTRUCT */
  1145. MonoObject *mono_object = mono_object_new(SCRIPTS_DOMAIN, script_class->get_raw());
  1146. if (!mono_object) {
  1147. instance->script = Ref<CSharpScript>();
  1148. instance->owner->set_script_instance(NULL);
  1149. r_error.error = Variant::CallError::CALL_ERROR_INSTANCE_IS_NULL;
  1150. ERR_EXPLAIN("Failed to allocate memory for the object");
  1151. ERR_FAIL_V(NULL);
  1152. }
  1153. #ifndef NO_THREADS
  1154. CSharpLanguage::singleton->lock->lock();
  1155. #endif
  1156. instances.insert(instance->owner);
  1157. #ifndef NO_THREADS
  1158. CSharpLanguage::singleton->lock->unlock();
  1159. #endif
  1160. CACHED_FIELD(GodotObject, ptr)->set_value_raw(mono_object, instance->owner);
  1161. // Construct
  1162. GDMonoMethod *ctor = script_class->get_method(CACHED_STRING_NAME(dotctor), p_argcount);
  1163. ctor->invoke(mono_object, p_args, NULL);
  1164. // Tie managed to unmanaged
  1165. instance->gchandle = MonoGCHandle::create_strong(mono_object);
  1166. /* STEP 3, PARTY */
  1167. //@TODO make thread safe
  1168. return instance;
  1169. }
  1170. Variant CSharpScript::_new(const Variant **p_args, int p_argcount, Variant::CallError &r_error) {
  1171. if (!valid) {
  1172. r_error.error = Variant::CallError::CALL_ERROR_INVALID_METHOD;
  1173. return Variant();
  1174. }
  1175. r_error.error = Variant::CallError::CALL_OK;
  1176. REF ref;
  1177. Object *owner = NULL;
  1178. ERR_FAIL_NULL_V(native, Variant());
  1179. owner = ClassDB::instance(NATIVE_GDMONOCLASS_NAME(native));
  1180. Reference *r = Object::cast_to<Reference>(owner);
  1181. if (r) {
  1182. ref = REF(r);
  1183. }
  1184. CSharpInstance *instance = _create_instance(p_args, p_argcount, owner, r != NULL, r_error);
  1185. if (!instance) {
  1186. if (ref.is_null()) {
  1187. memdelete(owner); //no owner, sorry
  1188. }
  1189. return Variant();
  1190. }
  1191. if (ref.is_valid()) {
  1192. return ref;
  1193. } else {
  1194. return owner;
  1195. }
  1196. }
  1197. ScriptInstance *CSharpScript::instance_create(Object *p_this) {
  1198. if (!valid)
  1199. return NULL;
  1200. if (!tool && !ScriptServer::is_scripting_enabled()) {
  1201. #ifdef TOOLS_ENABLED
  1202. PlaceHolderScriptInstance *si = memnew(PlaceHolderScriptInstance(CSharpLanguage::get_singleton(), Ref<Script>(this), p_this));
  1203. placeholders.insert(si);
  1204. _update_exports();
  1205. return si;
  1206. #else
  1207. return NULL;
  1208. #endif
  1209. }
  1210. if (native) {
  1211. String native_name = native->get_name();
  1212. if (!ClassDB::is_parent_class(p_this->get_class_name(), native_name)) {
  1213. if (ScriptDebugger::get_singleton()) {
  1214. CSharpLanguage::get_singleton()->debug_break_parse(get_path(), 0, "Script inherits from native type '" + native_name + "', so it can't be instanced in object of type: '" + p_this->get_class() + "'");
  1215. }
  1216. ERR_EXPLAIN("Script inherits from native type '" + native_name + "', so it can't be instanced in object of type: '" + p_this->get_class() + "'");
  1217. ERR_FAIL_V(NULL);
  1218. }
  1219. }
  1220. Variant::CallError unchecked_error;
  1221. return _create_instance(NULL, 0, p_this, Object::cast_to<Reference>(p_this), unchecked_error);
  1222. }
  1223. bool CSharpScript::instance_has(const Object *p_this) const {
  1224. #ifndef NO_THREADS
  1225. CSharpLanguage::singleton->lock->lock();
  1226. #endif
  1227. bool ret = instances.has((Object *)p_this);
  1228. #ifndef NO_THREADS
  1229. CSharpLanguage::singleton->lock->unlock();
  1230. #endif
  1231. return ret;
  1232. }
  1233. bool CSharpScript::has_source_code() const {
  1234. return !source.empty();
  1235. }
  1236. String CSharpScript::get_source_code() const {
  1237. return source;
  1238. }
  1239. void CSharpScript::set_source_code(const String &p_code) {
  1240. if (source == p_code)
  1241. return;
  1242. source = p_code;
  1243. #ifdef TOOLS_ENABLED
  1244. source_changed_cache = true;
  1245. #endif
  1246. }
  1247. bool CSharpScript::has_method(const StringName &p_method) const {
  1248. return script_class->has_method(p_method);
  1249. }
  1250. Error CSharpScript::reload(bool p_keep_state) {
  1251. #ifndef NO_THREADS
  1252. CSharpLanguage::singleton->lock->lock();
  1253. #endif
  1254. bool has_instances = instances.size();
  1255. #ifndef NO_THREADS
  1256. CSharpLanguage::singleton->lock->unlock();
  1257. #endif
  1258. ERR_FAIL_COND_V(!p_keep_state && has_instances, ERR_ALREADY_IN_USE);
  1259. GDMonoAssembly *project_assembly = GDMono::get_singleton()->get_project_assembly();
  1260. if (project_assembly) {
  1261. script_class = project_assembly->get_object_derived_class(name);
  1262. if (!script_class) {
  1263. ERR_PRINTS("Cannot find class " + name + " for script " + get_path());
  1264. }
  1265. #ifdef DEBUG_ENABLED
  1266. else if (OS::get_singleton()->is_stdout_verbose()) {
  1267. OS::get_singleton()->print(String("Found class " + script_class->get_namespace() + "." +
  1268. script_class->get_name() + " for script " + get_path() + "\n")
  1269. .utf8());
  1270. }
  1271. #endif
  1272. valid = script_class != NULL;
  1273. if (script_class) {
  1274. tool = script_class->has_attribute(CACHED_CLASS(ToolAttribute));
  1275. native = GDMonoUtils::get_class_native_base(script_class);
  1276. CRASH_COND(native == NULL);
  1277. GDMonoClass *base_class = script_class->get_parent_class();
  1278. if (base_class != native)
  1279. base = base_class;
  1280. #ifdef DEBUG_ENABLED
  1281. // For debug builds, we must fetch from all native base methods as well.
  1282. // Native base methods must be fetched before the current class.
  1283. // Not needed if the script class itself is a native class.
  1284. if (script_class != native) {
  1285. GDMonoClass *native_top = native;
  1286. while (native_top) {
  1287. native_top->fetch_methods_with_godot_api_checks(native);
  1288. if (native_top == CACHED_CLASS(GodotObject))
  1289. break;
  1290. native_top = native_top->get_parent_class();
  1291. }
  1292. }
  1293. #endif
  1294. script_class->fetch_methods_with_godot_api_checks(native);
  1295. // Need to fetch method from base classes as well
  1296. GDMonoClass *top = script_class;
  1297. while (top && top != native) {
  1298. top->fetch_methods_with_godot_api_checks(native);
  1299. top = top->get_parent_class();
  1300. }
  1301. }
  1302. return OK;
  1303. }
  1304. return ERR_FILE_MISSING_DEPENDENCIES;
  1305. }
  1306. ScriptLanguage *CSharpScript::get_language() const {
  1307. return CSharpLanguage::get_singleton();
  1308. }
  1309. bool CSharpScript::get_property_default_value(const StringName &p_property, Variant &r_value) const {
  1310. #ifdef TOOLS_ENABLED
  1311. const Map<StringName, Variant>::Element *E = exported_members_defval_cache.find(p_property);
  1312. if (E) {
  1313. r_value = E->get();
  1314. return true;
  1315. }
  1316. if (base_cache.is_valid()) {
  1317. return base_cache->get_property_default_value(p_property, r_value);
  1318. }
  1319. #endif
  1320. return false;
  1321. }
  1322. void CSharpScript::update_exports() {
  1323. #ifdef TOOLS_ENABLED
  1324. _update_exports();
  1325. #endif
  1326. }
  1327. Ref<Script> CSharpScript::get_base_script() const {
  1328. // TODO search in metadata file once we have it, not important any way?
  1329. return Ref<Script>();
  1330. }
  1331. void CSharpScript::get_script_property_list(List<PropertyInfo> *p_list) const {
  1332. for (Map<StringName, PropertyInfo>::Element *E = member_info.front(); E; E = E->next()) {
  1333. p_list->push_back(E->value());
  1334. }
  1335. }
  1336. int CSharpScript::get_member_line(const StringName &p_member) const {
  1337. // TODO omnisharp
  1338. return -1;
  1339. }
  1340. Error CSharpScript::load_source_code(const String &p_path) {
  1341. PoolVector<uint8_t> sourcef;
  1342. Error err;
  1343. FileAccess *f = FileAccess::open(p_path, FileAccess::READ, &err);
  1344. ERR_FAIL_COND_V(err != OK, err);
  1345. int len = f->get_len();
  1346. sourcef.resize(len + 1);
  1347. PoolVector<uint8_t>::Write w = sourcef.write();
  1348. int r = f->get_buffer(w.ptr(), len);
  1349. f->close();
  1350. memdelete(f);
  1351. ERR_FAIL_COND_V(r != len, ERR_CANT_OPEN);
  1352. w[len] = 0;
  1353. String s;
  1354. if (s.parse_utf8((const char *)w.ptr())) {
  1355. ERR_EXPLAIN("Script '" + p_path + "' contains invalid unicode (utf-8), so it was not loaded. Please ensure that scripts are saved in valid utf-8 unicode.");
  1356. ERR_FAIL_V(ERR_INVALID_DATA);
  1357. }
  1358. source = s;
  1359. #ifdef TOOLS_ENABLED
  1360. source_changed_cache = true;
  1361. #endif
  1362. return OK;
  1363. }
  1364. StringName CSharpScript::get_script_name() const {
  1365. return name;
  1366. }
  1367. CSharpScript::CSharpScript()
  1368. : script_list(this) {
  1369. _clear();
  1370. #ifdef TOOLS_ENABLED
  1371. source_changed_cache = false;
  1372. exports_invalidated = true;
  1373. #endif
  1374. _resource_path_changed();
  1375. #ifdef DEBUG_ENABLED
  1376. #ifndef NO_THREADS
  1377. CSharpLanguage::get_singleton()->lock->lock();
  1378. #endif
  1379. CSharpLanguage::get_singleton()->script_list.add(&script_list);
  1380. #ifndef NO_THREADS
  1381. CSharpLanguage::get_singleton()->lock->unlock();
  1382. #endif
  1383. #endif // DEBUG_ENABLED
  1384. }
  1385. CSharpScript::~CSharpScript() {
  1386. #ifdef DEBUG_ENABLED
  1387. #ifndef NO_THREADS
  1388. CSharpLanguage::get_singleton()->lock->lock();
  1389. #endif
  1390. CSharpLanguage::get_singleton()->script_list.remove(&script_list);
  1391. #ifndef NO_THREADS
  1392. CSharpLanguage::get_singleton()->lock->unlock();
  1393. #endif
  1394. #endif // DEBUG_ENABLED
  1395. }
  1396. /*************** RESOURCE ***************/
  1397. RES ResourceFormatLoaderCSharpScript::load(const String &p_path, const String &p_original_path, Error *r_error) {
  1398. if (r_error)
  1399. *r_error = ERR_FILE_CANT_OPEN;
  1400. // TODO ignore anything inside bin/ and obj/ in tools builds?
  1401. CSharpScript *script = memnew(CSharpScript);
  1402. Ref<CSharpScript> scriptres(script);
  1403. #if defined(DEBUG_ENABLED) || defined(TOOLS_ENABLED)
  1404. Error err = script->load_source_code(p_path);
  1405. ERR_FAIL_COND_V(err != OK, RES());
  1406. #endif
  1407. script->set_path(p_original_path);
  1408. #ifndef TOOLS_ENABLED
  1409. #ifdef DEBUG_ENABLED
  1410. // User is responsible for thread attach/detach
  1411. ERR_EXPLAIN("Thread is not attached");
  1412. CRASH_COND(mono_domain_get() == NULL);
  1413. #endif
  1414. #else
  1415. if (Engine::get_singleton()->is_editor_hint() && mono_domain_get() == NULL) {
  1416. CRASH_COND(Thread::get_caller_id() == Thread::get_main_id());
  1417. // Thread is not attached, but we will make an exception in this case
  1418. // because this may be called by one of the editor's worker threads.
  1419. // Attach this thread temporarily to reload the script.
  1420. MonoThread *mono_thread = mono_thread_attach(SCRIPTS_DOMAIN);
  1421. CRASH_COND(mono_thread == NULL);
  1422. script->reload();
  1423. mono_thread_detach(mono_thread);
  1424. } else // just reload it normally
  1425. #endif
  1426. script->reload();
  1427. if (r_error)
  1428. *r_error = OK;
  1429. return scriptres;
  1430. }
  1431. void ResourceFormatLoaderCSharpScript::get_recognized_extensions(List<String> *p_extensions) const {
  1432. p_extensions->push_back("cs");
  1433. }
  1434. bool ResourceFormatLoaderCSharpScript::handles_type(const String &p_type) const {
  1435. return p_type == "Script" || p_type == CSharpLanguage::get_singleton()->get_type();
  1436. }
  1437. String ResourceFormatLoaderCSharpScript::get_resource_type(const String &p_path) const {
  1438. return p_path.get_extension().to_lower() == "cs" ? CSharpLanguage::get_singleton()->get_type() : "";
  1439. }
  1440. Error ResourceFormatSaverCSharpScript::save(const String &p_path, const RES &p_resource, uint32_t p_flags) {
  1441. Ref<CSharpScript> sqscr = p_resource;
  1442. ERR_FAIL_COND_V(sqscr.is_null(), ERR_INVALID_PARAMETER);
  1443. String source = sqscr->get_source_code();
  1444. #ifdef TOOLS_ENABLED
  1445. if (!FileAccess::exists(p_path)) {
  1446. // The file does not yet exists, let's assume the user just created this script
  1447. if (_create_project_solution_if_needed()) {
  1448. CSharpProject::add_item(GodotSharpDirs::get_project_csproj_path(),
  1449. "Compile",
  1450. ProjectSettings::get_singleton()->globalize_path(p_path));
  1451. } else {
  1452. ERR_PRINTS("Cannot add " + p_path + " to the C# project because it could not be created.");
  1453. }
  1454. }
  1455. #endif
  1456. Error err;
  1457. FileAccess *file = FileAccess::open(p_path, FileAccess::WRITE, &err);
  1458. ERR_FAIL_COND_V(err, err);
  1459. file->store_string(source);
  1460. if (file->get_error() != OK && file->get_error() != ERR_FILE_EOF) {
  1461. memdelete(file);
  1462. return ERR_CANT_CREATE;
  1463. }
  1464. file->close();
  1465. memdelete(file);
  1466. if (ScriptServer::is_reload_scripts_on_save_enabled()) {
  1467. CSharpLanguage::get_singleton()->reload_tool_script(p_resource, false);
  1468. }
  1469. return OK;
  1470. }
  1471. void ResourceFormatSaverCSharpScript::get_recognized_extensions(const RES &p_resource, List<String> *p_extensions) const {
  1472. if (Object::cast_to<CSharpScript>(p_resource.ptr())) {
  1473. p_extensions->push_back("cs");
  1474. }
  1475. }
  1476. bool ResourceFormatSaverCSharpScript::recognize(const RES &p_resource) const {
  1477. return Object::cast_to<CSharpScript>(p_resource.ptr()) != NULL;
  1478. }
  1479. CSharpLanguage::StringNameCache::StringNameCache() {
  1480. _signal_callback = StaticCString::create("_signal_callback");
  1481. _set = StaticCString::create("_set");
  1482. _get = StaticCString::create("_get");
  1483. _notification = StaticCString::create("_notification");
  1484. dotctor = StaticCString::create(".ctor");
  1485. }