csharp_script.cpp 50 KB

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