csharp_script.cpp 51 KB

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