csharp_script.cpp 61 KB

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