1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283 |
- /**************************************************************************/
- /* bindings_generator.cpp */
- /**************************************************************************/
- /* This file is part of: */
- /* GODOT ENGINE */
- /* https://godotengine.org */
- /**************************************************************************/
- /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
- /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
- /* */
- /* Permission is hereby granted, free of charge, to any person obtaining */
- /* a copy of this software and associated documentation files (the */
- /* "Software"), to deal in the Software without restriction, including */
- /* without limitation the rights to use, copy, modify, merge, publish, */
- /* distribute, sublicense, and/or sell copies of the Software, and to */
- /* permit persons to whom the Software is furnished to do so, subject to */
- /* the following conditions: */
- /* */
- /* The above copyright notice and this permission notice shall be */
- /* included in all copies or substantial portions of the Software. */
- /* */
- /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
- /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
- /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
- /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
- /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
- /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
- /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
- /**************************************************************************/
- #include "bindings_generator.h"
- #if defined(DEBUG_METHODS_ENABLED) && defined(TOOLS_ENABLED)
- #include "core/engine.h"
- #include "core/global_constants.h"
- #include "core/io/compression.h"
- #include "core/os/dir_access.h"
- #include "core/os/file_access.h"
- #include "core/os/os.h"
- #include "core/ucaps.h"
- #include "main/main.h"
- #include "../glue/cs_glue_version.gen.h"
- #include "../godotsharp_defs.h"
- #include "../mono_gd/gd_mono_marshal.h"
- #include "../utils/path_utils.h"
- #include "../utils/string_utils.h"
- #define CS_INDENT " " // 4 whitespaces
- #define INDENT1 CS_INDENT
- #define INDENT2 INDENT1 INDENT1
- #define INDENT3 INDENT2 INDENT1
- #define INDENT4 INDENT3 INDENT1
- #define INDENT5 INDENT4 INDENT1
- #define MEMBER_BEGIN "\n" INDENT2
- #define OPEN_BLOCK "{\n"
- #define CLOSE_BLOCK "}\n"
- #define OPEN_BLOCK_L2 INDENT2 OPEN_BLOCK INDENT3
- #define OPEN_BLOCK_L3 INDENT3 OPEN_BLOCK INDENT4
- #define OPEN_BLOCK_L4 INDENT4 OPEN_BLOCK INDENT5
- #define CLOSE_BLOCK_L2 INDENT2 CLOSE_BLOCK
- #define CLOSE_BLOCK_L3 INDENT3 CLOSE_BLOCK
- #define CLOSE_BLOCK_L4 INDENT4 CLOSE_BLOCK
- #define CS_FIELD_MEMORYOWN "memoryOwn"
- #define CS_PARAM_METHODBIND "method"
- #define CS_PARAM_INSTANCE "ptr"
- #define CS_PARAM_CALLER "caller"
- #define CS_SMETHOD_GETINSTANCE "GetPtr"
- #define CS_METHOD_CALL "Call"
- #define GLUE_HEADER_FILE "glue_header.h"
- #define ICALL_PREFIX "godot_icall_"
- #define SINGLETON_ICALL_SUFFIX "_get_singleton"
- #define ICALL_GET_METHODBIND ICALL_PREFIX "Object_ClassDB_get_method"
- #define C_LOCAL_RET "ret"
- #define C_LOCAL_VARARG_RET "vararg_ret"
- #define C_LOCAL_PTRCALL_ARGS "call_args"
- #define C_MACRO_OBJECT_CONSTRUCT "GODOTSHARP_INSTANCE_OBJECT"
- #define C_NS_MONOUTILS "GDMonoUtils"
- #define C_NS_MONOINTERNALS "GDMonoInternals"
- #define C_METHOD_TIE_MANAGED_TO_UNMANAGED C_NS_MONOINTERNALS "::tie_managed_to_unmanaged"
- #define C_METHOD_UNMANAGED_GET_MANAGED C_NS_MONOUTILS "::unmanaged_get_managed"
- #define C_METHOD_CHECK_CALL_ERROR C_NS_MONOINTERNALS "::check_call_error"
- #define C_NS_MONOMARSHAL "GDMonoMarshal"
- #define C_METHOD_MANAGED_TO_VARIANT C_NS_MONOMARSHAL "::mono_object_to_variant"
- #define C_METHOD_MANAGED_FROM_VARIANT C_NS_MONOMARSHAL "::variant_to_mono_object"
- #define C_METHOD_MONOSTR_TO_GODOT C_NS_MONOMARSHAL "::mono_string_to_godot"
- #define C_METHOD_MONOSTR_FROM_GODOT C_NS_MONOMARSHAL "::mono_string_from_godot"
- #define C_METHOD_MONOARRAY_TO(m_type) C_NS_MONOMARSHAL "::mono_array_to_" #m_type
- #define C_METHOD_MONOARRAY_FROM(m_type) C_NS_MONOMARSHAL "::" #m_type "_to_mono_array"
- #define BINDINGS_GENERATOR_VERSION UINT32_C(13)
- const char *BindingsGenerator::TypeInterface::DEFAULT_VARARG_C_IN("\t%0 %1_in = %1;\n");
- static String fix_doc_description(const String &p_bbcode) {
- // This seems to be the correct way to do this. It's the same EditorHelp does.
- return p_bbcode.dedent()
- .replace("\t", "")
- .replace("\r", "")
- .strip_edges();
- }
- static String snake_to_pascal_case(const String &p_identifier, bool p_input_is_upper = false) {
- String ret;
- Vector<String> parts = p_identifier.split("_", true);
- for (int i = 0; i < parts.size(); i++) {
- String part = parts[i];
- if (part.length()) {
- part[0] = _find_upper(part[0]);
- if (p_input_is_upper) {
- for (int j = 1; j < part.length(); j++)
- part[j] = _find_lower(part[j]);
- }
- ret += part;
- } else {
- if (i == 0 || i == (parts.size() - 1)) {
- // Preserve underscores at the beginning and end
- ret += "_";
- } else {
- // Preserve contiguous underscores
- if (parts[i - 1].length()) {
- ret += "__";
- } else {
- ret += "_";
- }
- }
- }
- }
- return ret;
- }
- static String snake_to_camel_case(const String &p_identifier, bool p_input_is_upper = false) {
- String ret;
- Vector<String> parts = p_identifier.split("_", true);
- for (int i = 0; i < parts.size(); i++) {
- String part = parts[i];
- if (part.length()) {
- if (i != 0) {
- part[0] = _find_upper(part[0]);
- }
- if (p_input_is_upper) {
- for (int j = i != 0 ? 1 : 0; j < part.length(); j++)
- part[j] = _find_lower(part[j]);
- }
- ret += part;
- } else {
- if (i == 0 || i == (parts.size() - 1)) {
- // Preserve underscores at the beginning and end
- ret += "_";
- } else {
- // Preserve contiguous underscores
- if (parts[i - 1].length()) {
- ret += "__";
- } else {
- ret += "_";
- }
- }
- }
- }
- return ret;
- }
- String BindingsGenerator::bbcode_to_xml(const String &p_bbcode, const TypeInterface *p_itype) {
- // Based on the version in EditorHelp
- if (p_bbcode.empty())
- return String();
- DocData *doc = EditorHelp::get_doc_data();
- String bbcode = p_bbcode;
- StringBuilder xml_output;
- xml_output.append("<para>");
- List<String> tag_stack;
- bool code_tag = false;
- int pos = 0;
- while (pos < bbcode.length()) {
- int brk_pos = bbcode.find("[", pos);
- if (brk_pos < 0)
- brk_pos = bbcode.length();
- if (brk_pos > pos) {
- String text = bbcode.substr(pos, brk_pos - pos);
- if (code_tag || tag_stack.size() > 0) {
- xml_output.append(text.xml_escape());
- } else {
- Vector<String> lines = text.split("\n");
- for (int i = 0; i < lines.size(); i++) {
- if (i != 0)
- xml_output.append("<para>");
- xml_output.append(lines[i].xml_escape());
- if (i != lines.size() - 1)
- xml_output.append("</para>\n");
- }
- }
- }
- if (brk_pos == bbcode.length())
- break; // nothing else to add
- int brk_end = bbcode.find("]", brk_pos + 1);
- if (brk_end == -1) {
- String text = bbcode.substr(brk_pos, bbcode.length() - brk_pos);
- if (code_tag || tag_stack.size() > 0) {
- xml_output.append(text.xml_escape());
- } else {
- Vector<String> lines = text.split("\n");
- for (int i = 0; i < lines.size(); i++) {
- if (i != 0)
- xml_output.append("<para>");
- xml_output.append(lines[i].xml_escape());
- if (i != lines.size() - 1)
- xml_output.append("</para>\n");
- }
- }
- break;
- }
- String tag = bbcode.substr(brk_pos + 1, brk_end - brk_pos - 1);
- if (tag.begins_with("/")) {
- bool tag_ok = tag_stack.size() && tag_stack.front()->get() == tag.substr(1, tag.length());
- if (!tag_ok) {
- xml_output.append("[");
- pos = brk_pos + 1;
- continue;
- }
- tag_stack.pop_front();
- pos = brk_end + 1;
- code_tag = false;
- if (tag == "/url") {
- xml_output.append("</a>");
- } else if (tag == "/code") {
- xml_output.append("</c>");
- } else if (tag == "/codeblock") {
- xml_output.append("</code>");
- }
- } else if (code_tag) {
- xml_output.append("[");
- pos = brk_pos + 1;
- } else if (tag.begins_with("method ") || tag.begins_with("member ") || tag.begins_with("signal ") || tag.begins_with("enum ") || tag.begins_with("constant ")) {
- String link_target = tag.substr(tag.find(" ") + 1, tag.length());
- String link_tag = tag.substr(0, tag.find(" "));
- const Vector<String> link_target_parts = link_target.split(".");
- if (link_target_parts.size() <= 0 || link_target_parts.size() > 2) {
- ERR_PRINT("Invalid reference format: '" + tag + "'.");
- xml_output.append("<c>");
- xml_output.append(tag);
- xml_output.append("</c>");
- pos = brk_end + 1;
- continue;
- }
- const TypeInterface *target_itype;
- StringName target_cname;
- if (link_target_parts.size() == 2) {
- target_itype = _get_type_or_null(TypeReference(link_target_parts[0]));
- if (!target_itype) {
- target_itype = _get_type_or_null(TypeReference("_" + link_target_parts[0]));
- }
- target_cname = link_target_parts[1];
- } else {
- target_itype = p_itype;
- target_cname = link_target_parts[0];
- }
- if (link_tag == "method") {
- _append_xml_method(xml_output, target_itype, target_cname, link_target, link_target_parts);
- } else if (link_tag == "member") {
- _append_xml_member(xml_output, target_itype, target_cname, link_target, link_target_parts);
- } else if (link_tag == "signal") {
- // We do not declare signals in any way in C#, so there is nothing to reference
- _append_xml_undeclared(xml_output, link_target);
- } else if (link_tag == "enum") {
- _append_xml_enum(xml_output, target_itype, target_cname, link_target, link_target_parts);
- } else if (link_tag == "constant") {
- _append_xml_constant(xml_output, target_itype, target_cname, link_target, link_target_parts);
- }
- pos = brk_end + 1;
- } else if (doc->class_list.has(tag)) {
- if (tag == "Array" || tag == "Dictionary") {
- xml_output.append("<see cref=\"" BINDINGS_NAMESPACE_COLLECTIONS ".");
- xml_output.append(tag);
- xml_output.append("\"/>");
- } else if (tag == "bool" || tag == "int") {
- xml_output.append("<see cref=\"");
- xml_output.append(tag);
- xml_output.append("\"/>");
- } else if (tag == "float") {
- xml_output.append("<see cref=\""
- #ifdef REAL_T_IS_DOUBLE
- "double"
- #else
- "float"
- #endif
- "\"/>");
- } else if (tag == "Variant") {
- // We use System.Object for Variant, so there is no Variant type in C#
- xml_output.append("<c>Variant</c>");
- } else if (tag == "String") {
- xml_output.append("<see cref=\"string\"/>");
- } else if (tag == "Nil") {
- xml_output.append("<see langword=\"null\"/>");
- } else if (tag.begins_with("@")) {
- // @GlobalScope, @GDScript, etc
- xml_output.append("<c>");
- xml_output.append(tag);
- xml_output.append("</c>");
- } else if (tag == "PoolByteArray") {
- xml_output.append("<see cref=\"byte\"/>");
- } else if (tag == "PoolIntArray") {
- xml_output.append("<see cref=\"int\"/>");
- } else if (tag == "PoolRealArray") {
- #ifdef REAL_T_IS_DOUBLE
- xml_output.append("<see cref=\"double\"/>");
- #else
- xml_output.append("<see cref=\"float\"/>");
- #endif
- } else if (tag == "PoolStringArray") {
- xml_output.append("<see cref=\"string\"/>");
- } else if (tag == "PoolVector2Array") {
- xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".Vector2\"/>");
- } else if (tag == "PoolVector3Array") {
- xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".Vector3\"/>");
- } else if (tag == "PoolColorArray") {
- xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".Color\"/>");
- } else {
- const TypeInterface *target_itype = _get_type_or_null(TypeReference(tag));
- if (!target_itype) {
- target_itype = _get_type_or_null(TypeReference("_" + tag));
- }
- if (target_itype) {
- xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- xml_output.append(target_itype->proxy_name);
- xml_output.append("\"/>");
- } else {
- ERR_PRINT("Cannot resolve type reference in documentation: '" + tag + "'.");
- xml_output.append("<c>");
- xml_output.append(tag);
- xml_output.append("</c>");
- }
- }
- pos = brk_end + 1;
- } else if (tag == "b") {
- // bold is not supported in xml comments
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "i") {
- // italics is not supported in xml comments
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "code") {
- xml_output.append("<c>");
- code_tag = true;
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "codeblock") {
- xml_output.append("<code>");
- code_tag = true;
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "kbd") {
- // keyboard combinations are not supported in xml comments
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "center") {
- // center alignment is not supported in xml comments
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "br") {
- xml_output.append("\n"); // FIXME: Should use <para> instead. Luckily this tag isn't used for now.
- pos = brk_end + 1;
- } else if (tag == "u") {
- // underline is not supported in xml comments
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "s") {
- // strikethrough is not supported in xml comments
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag == "url") {
- int end = bbcode.find("[", brk_end);
- if (end == -1)
- end = bbcode.length();
- String url = bbcode.substr(brk_end + 1, end - brk_end - 1);
- xml_output.append("<a href=\"");
- xml_output.append(url);
- xml_output.append("\">");
- xml_output.append(url);
- pos = brk_end + 1;
- tag_stack.push_front(tag);
- } else if (tag.begins_with("url=")) {
- String url = tag.substr(4, tag.length());
- xml_output.append("<a href=\"");
- xml_output.append(url);
- xml_output.append("\">");
- pos = brk_end + 1;
- tag_stack.push_front("url");
- } else if (tag == "img") {
- int end = bbcode.find("[", brk_end);
- if (end == -1)
- end = bbcode.length();
- String image = bbcode.substr(brk_end + 1, end - brk_end - 1);
- // Not supported. Just append the bbcode.
- xml_output.append("[img]");
- xml_output.append(image);
- xml_output.append("[/img]");
- pos = end;
- tag_stack.push_front(tag);
- } else if (tag.begins_with("color=")) {
- // Not supported.
- pos = brk_end + 1;
- tag_stack.push_front("color");
- } else if (tag.begins_with("font=")) {
- // Not supported.
- pos = brk_end + 1;
- tag_stack.push_front("font");
- } else {
- xml_output.append("["); // ignore
- pos = brk_pos + 1;
- }
- }
- xml_output.append("</para>");
- return xml_output.as_string();
- }
- void BindingsGenerator::_append_xml_method(StringBuilder &p_xml_output, const TypeInterface *p_target_itype, const StringName &p_target_cname, const String &p_link_target, const Vector<String> &p_link_target_parts) {
- if (p_link_target_parts[0] == name_cache.type_at_GlobalScope) {
- if (OS::get_singleton()->is_stdout_verbose()) {
- OS::get_singleton()->print("Cannot resolve @GlobalScope method reference in documentation: %s\n", p_link_target.utf8().get_data());
- }
- // TODO Map what we can
- _append_xml_undeclared(p_xml_output, p_link_target);
- } else if (!p_target_itype || !p_target_itype->is_object_type) {
- if (OS::get_singleton()->is_stdout_verbose()) {
- if (p_target_itype) {
- OS::get_singleton()->print("Cannot resolve method reference for non-Godot.Object type in documentation: %s\n", p_link_target.utf8().get_data());
- } else {
- OS::get_singleton()->print("Cannot resolve type from method reference in documentation: %s\n", p_link_target.utf8().get_data());
- }
- }
- // TODO Map what we can
- _append_xml_undeclared(p_xml_output, p_link_target);
- } else {
- if (p_target_cname == "_init") {
- // The _init method is not declared in C#, reference the constructor instead
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(p_target_itype->proxy_name);
- p_xml_output.append(".");
- p_xml_output.append(p_target_itype->proxy_name);
- p_xml_output.append("()\"/>");
- } else {
- const MethodInterface *target_imethod = p_target_itype->find_method_by_name(p_target_cname);
- if (target_imethod) {
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(p_target_itype->proxy_name);
- p_xml_output.append(".");
- p_xml_output.append(target_imethod->proxy_name);
- p_xml_output.append("\"/>");
- } else {
- ERR_PRINT("Cannot resolve method reference in documentation: '" + p_link_target + "'.");
- _append_xml_undeclared(p_xml_output, p_link_target);
- }
- }
- }
- }
- void BindingsGenerator::_append_xml_member(StringBuilder &p_xml_output, const TypeInterface *p_target_itype, const StringName &p_target_cname, const String &p_link_target, const Vector<String> &p_link_target_parts) {
- if (p_link_target.find("/") >= 0) {
- // Properties with '/' (slash) in the name are not declared in C#, so there is nothing to reference.
- _append_xml_undeclared(p_xml_output, p_link_target);
- } else if (!p_target_itype || !p_target_itype->is_object_type) {
- if (OS::get_singleton()->is_stdout_verbose()) {
- if (p_target_itype) {
- OS::get_singleton()->print("Cannot resolve member reference for non-Godot.Object type in documentation: %s\n", p_link_target.utf8().get_data());
- } else {
- OS::get_singleton()->print("Cannot resolve type from member reference in documentation: %s\n", p_link_target.utf8().get_data());
- }
- }
- // TODO Map what we can
- _append_xml_undeclared(p_xml_output, p_link_target);
- } else {
- const TypeInterface *current_itype = p_target_itype;
- const PropertyInterface *target_iprop = NULL;
- while (target_iprop == NULL && current_itype != NULL) {
- target_iprop = current_itype->find_property_by_name(p_target_cname);
- if (target_iprop == NULL) {
- current_itype = _get_type_or_null(TypeReference(current_itype->base_name));
- }
- }
- if (target_iprop) {
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(current_itype->proxy_name);
- p_xml_output.append(".");
- p_xml_output.append(target_iprop->proxy_name);
- p_xml_output.append("\"/>");
- } else {
- ERR_PRINT("Cannot resolve member reference in documentation: '" + p_link_target + "'.");
- _append_xml_undeclared(p_xml_output, p_link_target);
- }
- }
- }
- void BindingsGenerator::_append_xml_enum(StringBuilder &p_xml_output, const TypeInterface *p_target_itype, const StringName &p_target_cname, const String &p_link_target, const Vector<String> &p_link_target_parts) {
- const StringName search_cname = !p_target_itype ? p_target_cname : StringName(p_target_itype->name + "." + (String)p_target_cname);
- const Map<StringName, TypeInterface>::Element *enum_match = enum_types.find(search_cname);
- if (!enum_match && search_cname != p_target_cname) {
- enum_match = enum_types.find(p_target_cname);
- }
- if (enum_match) {
- const TypeInterface &target_enum_itype = enum_match->value();
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(target_enum_itype.proxy_name); // Includes nesting class if any
- p_xml_output.append("\"/>");
- } else {
- ERR_PRINT("Cannot resolve enum reference in documentation: '" + p_link_target + "'.");
- _append_xml_undeclared(p_xml_output, p_link_target);
- }
- }
- void BindingsGenerator::_append_xml_constant(StringBuilder &p_xml_output, const TypeInterface *p_target_itype, const StringName &p_target_cname, const String &p_link_target, const Vector<String> &p_link_target_parts) {
- if (p_link_target_parts[0] == name_cache.type_at_GlobalScope) {
- _append_xml_constant_in_global_scope(p_xml_output, p_target_cname, p_link_target);
- } else if (!p_target_itype || !p_target_itype->is_object_type) {
- // Search in @GlobalScope as a last resort if no class was specified
- if (p_link_target_parts.size() == 1) {
- _append_xml_constant_in_global_scope(p_xml_output, p_target_cname, p_link_target);
- return;
- }
- if (OS::get_singleton()->is_stdout_verbose()) {
- if (p_target_itype) {
- OS::get_singleton()->print("Cannot resolve constant reference for non-Godot.Object type in documentation: %s\n", p_link_target.utf8().get_data());
- } else {
- OS::get_singleton()->print("Cannot resolve type from constant reference in documentation: %s\n", p_link_target.utf8().get_data());
- }
- }
- // TODO Map what we can
- _append_xml_undeclared(p_xml_output, p_link_target);
- } else {
- // Try to find the constant in the current class
- const ConstantInterface *target_iconst = find_constant_by_name(p_target_cname, p_target_itype->constants);
- if (target_iconst) {
- // Found constant in current class
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(p_target_itype->proxy_name);
- p_xml_output.append(".");
- p_xml_output.append(target_iconst->proxy_name);
- p_xml_output.append("\"/>");
- } else {
- // Try to find as enum constant in the current class
- const EnumInterface *target_ienum = NULL;
- for (const List<EnumInterface>::Element *E = p_target_itype->enums.front(); E; E = E->next()) {
- target_ienum = &E->get();
- target_iconst = find_constant_by_name(p_target_cname, target_ienum->constants);
- if (target_iconst) {
- break;
- }
- }
- if (target_iconst) {
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(p_target_itype->proxy_name);
- p_xml_output.append(".");
- p_xml_output.append(target_ienum->cname);
- p_xml_output.append(".");
- p_xml_output.append(target_iconst->proxy_name);
- p_xml_output.append("\"/>");
- } else if (p_link_target_parts.size() == 1) {
- // Also search in @GlobalScope as a last resort if no class was specified
- _append_xml_constant_in_global_scope(p_xml_output, p_target_cname, p_link_target);
- } else {
- ERR_PRINT("Cannot resolve constant reference in documentation: '" + p_link_target + "'.");
- _append_xml_undeclared(p_xml_output, p_link_target);
- }
- }
- }
- }
- void BindingsGenerator::_append_xml_constant_in_global_scope(StringBuilder &p_xml_output, const String &p_target_cname, const String &p_link_target) {
- // Try to find as a global constant
- const ConstantInterface *target_iconst = find_constant_by_name(p_target_cname, global_constants);
- if (target_iconst) {
- // Found global constant
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE "." BINDINGS_GLOBAL_SCOPE_CLASS ".");
- p_xml_output.append(target_iconst->proxy_name);
- p_xml_output.append("\"/>");
- } else {
- // Try to find as global enum constant
- const EnumInterface *target_ienum = NULL;
- for (const List<EnumInterface>::Element *E = global_enums.front(); E; E = E->next()) {
- target_ienum = &E->get();
- target_iconst = find_constant_by_name(p_target_cname, target_ienum->constants);
- if (target_iconst) {
- break;
- }
- }
- if (target_iconst) {
- p_xml_output.append("<see cref=\"" BINDINGS_NAMESPACE ".");
- p_xml_output.append(target_ienum->cname);
- p_xml_output.append(".");
- p_xml_output.append(target_iconst->proxy_name);
- p_xml_output.append("\"/>");
- } else {
- ERR_PRINT("Cannot resolve global constant reference in documentation: '" + p_link_target + "'.");
- _append_xml_undeclared(p_xml_output, p_link_target);
- }
- }
- }
- void BindingsGenerator::_append_xml_undeclared(StringBuilder &p_xml_output, const String &p_link_target) {
- p_xml_output.append("<c>");
- p_xml_output.append(p_link_target);
- p_xml_output.append("</c>");
- }
- int BindingsGenerator::_determine_enum_prefix(const EnumInterface &p_ienum) {
- CRASH_COND(p_ienum.constants.empty());
- const ConstantInterface &front_iconstant = p_ienum.constants.front()->get();
- Vector<String> front_parts = front_iconstant.name.split("_", /* p_allow_empty: */ true);
- int candidate_len = front_parts.size() - 1;
- if (candidate_len == 0)
- return 0;
- for (const List<ConstantInterface>::Element *E = p_ienum.constants.front()->next(); E; E = E->next()) {
- const ConstantInterface &iconstant = E->get();
- Vector<String> parts = iconstant.name.split("_", /* p_allow_empty: */ true);
- int i;
- for (i = 0; i < candidate_len && i < parts.size(); i++) {
- if (front_parts[i] != parts[i]) {
- // HARDCODED: Some Flag enums have the prefix 'FLAG_' for everything except 'FLAGS_DEFAULT' (same for 'METHOD_FLAG_' and'METHOD_FLAGS_DEFAULT').
- bool hardcoded_exc = (i == candidate_len - 1 && ((front_parts[i] == "FLAGS" && parts[i] == "FLAG") || (front_parts[i] == "FLAG" && parts[i] == "FLAGS")));
- if (!hardcoded_exc)
- break;
- }
- }
- candidate_len = i;
- if (candidate_len == 0)
- return 0;
- }
- return candidate_len;
- }
- void BindingsGenerator::_apply_prefix_to_enum_constants(BindingsGenerator::EnumInterface &p_ienum, int p_prefix_length) {
- if (p_prefix_length > 0) {
- for (List<ConstantInterface>::Element *E = p_ienum.constants.front(); E; E = E->next()) {
- int curr_prefix_length = p_prefix_length;
- ConstantInterface &curr_const = E->get();
- String constant_name = curr_const.name;
- Vector<String> parts = constant_name.split("_", /* p_allow_empty: */ true);
- if (parts.size() <= curr_prefix_length)
- continue;
- if (parts[curr_prefix_length][0] >= '0' && parts[curr_prefix_length][0] <= '9') {
- // The name of enum constants may begin with a numeric digit when strip from the enum prefix,
- // so we make the prefix for this constant one word shorter in those cases.
- for (curr_prefix_length = curr_prefix_length - 1; curr_prefix_length > 0; curr_prefix_length--) {
- if (parts[curr_prefix_length][0] < '0' || parts[curr_prefix_length][0] > '9')
- break;
- }
- }
- constant_name = "";
- for (int i = curr_prefix_length; i < parts.size(); i++) {
- if (i > curr_prefix_length)
- constant_name += "_";
- constant_name += parts[i];
- }
- curr_const.proxy_name = snake_to_pascal_case(constant_name, true);
- }
- }
- }
- void BindingsGenerator::_generate_method_icalls(const TypeInterface &p_itype) {
- for (const List<MethodInterface>::Element *E = p_itype.methods.front(); E; E = E->next()) {
- const MethodInterface &imethod = E->get();
- if (imethod.is_virtual)
- continue;
- const TypeInterface *return_type = _get_type_or_placeholder(imethod.return_type);
- String im_sig = "IntPtr " CS_PARAM_METHODBIND ", ";
- String im_unique_sig = imethod.return_type.cname.operator String() + ",IntPtr,IntPtr";
- im_sig += "IntPtr " CS_PARAM_INSTANCE;
- // Get arguments information
- int i = 0;
- for (const List<ArgumentInterface>::Element *F = imethod.arguments.front(); F; F = F->next()) {
- const TypeInterface *arg_type = _get_type_or_placeholder(F->get().type);
- im_sig += ", ";
- im_sig += arg_type->im_type_in;
- im_sig += " arg";
- im_sig += itos(i + 1);
- im_unique_sig += ",";
- im_unique_sig += get_unique_sig(*arg_type);
- i++;
- }
- // Collect caller name for MethodBind
- if (imethod.is_vararg) {
- im_sig += ", string " CS_PARAM_CALLER;
- }
- String im_type_out = return_type->im_type_out;
- if (return_type->ret_as_byref_arg) {
- // Doesn't affect the unique signature
- im_type_out = "void";
- im_sig += ", ";
- im_sig += return_type->im_type_out;
- im_sig += " argRet";
- i++;
- }
- // godot_icall_{argc}_{icallcount}
- String icall_method = ICALL_PREFIX;
- icall_method += itos(imethod.arguments.size());
- icall_method += "_";
- icall_method += itos(method_icalls.size());
- InternalCall im_icall = InternalCall(p_itype.api_type, icall_method, im_type_out, im_sig, im_unique_sig);
- List<InternalCall>::Element *match = method_icalls.find(im_icall);
- if (match) {
- if (p_itype.api_type != ClassDB::API_EDITOR)
- match->get().editor_only = false;
- method_icalls_map.insert(&E->get(), &match->get());
- } else {
- List<InternalCall>::Element *added = method_icalls.push_back(im_icall);
- method_icalls_map.insert(&E->get(), &added->get());
- }
- }
- }
- void BindingsGenerator::_generate_global_constants(StringBuilder &p_output) {
- // Constants (in partial GD class)
- p_output.append("\n#pragma warning disable CS1591 // Disable warning: "
- "'Missing XML comment for publicly visible type or member'\n");
- p_output.append("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
- p_output.append(INDENT1 "public static partial class " BINDINGS_GLOBAL_SCOPE_CLASS "\n" INDENT1 "{");
- for (const List<ConstantInterface>::Element *E = global_constants.front(); E; E = E->next()) {
- const ConstantInterface &iconstant = E->get();
- if (iconstant.const_doc && iconstant.const_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(iconstant.const_doc->description), NULL);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- p_output.append(MEMBER_BEGIN "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- p_output.append(INDENT2 "/// ");
- p_output.append(summary_lines[i]);
- p_output.append("\n");
- }
- p_output.append(INDENT2 "/// </summary>");
- }
- }
- p_output.append(MEMBER_BEGIN "public const int ");
- p_output.append(iconstant.proxy_name);
- p_output.append(" = ");
- p_output.append(itos(iconstant.value));
- p_output.append(";");
- }
- if (!global_constants.empty())
- p_output.append("\n");
- p_output.append(INDENT1 CLOSE_BLOCK); // end of GD class
- // Enums
- for (List<EnumInterface>::Element *E = global_enums.front(); E; E = E->next()) {
- const EnumInterface &ienum = E->get();
- CRASH_COND(ienum.constants.empty());
- String enum_proxy_name = ienum.cname.operator String();
- bool enum_in_static_class = false;
- if (enum_proxy_name.find(".") > 0) {
- enum_in_static_class = true;
- String enum_class_name = enum_proxy_name.get_slicec('.', 0);
- enum_proxy_name = enum_proxy_name.get_slicec('.', 1);
- CRASH_COND(enum_class_name != "Variant"); // Hard-coded...
- _log("Declaring global enum '%s' inside static class '%s'\n", enum_proxy_name.utf8().get_data(), enum_class_name.utf8().get_data());
- p_output.append("\n" INDENT1 "public static partial class ");
- p_output.append(enum_class_name);
- p_output.append("\n" INDENT1 OPEN_BLOCK);
- }
- p_output.append("\n" INDENT1 "public enum ");
- p_output.append(enum_proxy_name);
- p_output.append("\n" INDENT1 OPEN_BLOCK);
- for (const List<ConstantInterface>::Element *F = ienum.constants.front(); F; F = F->next()) {
- const ConstantInterface &iconstant = F->get();
- if (iconstant.const_doc && iconstant.const_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(iconstant.const_doc->description), NULL);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- p_output.append(INDENT2 "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- p_output.append(INDENT2 "/// ");
- p_output.append(summary_lines[i]);
- p_output.append("\n");
- }
- p_output.append(INDENT2 "/// </summary>\n");
- }
- }
- p_output.append(INDENT2);
- p_output.append(iconstant.proxy_name);
- p_output.append(" = ");
- p_output.append(itos(iconstant.value));
- p_output.append(F != ienum.constants.back() ? ",\n" : "\n");
- }
- p_output.append(INDENT1 CLOSE_BLOCK);
- if (enum_in_static_class)
- p_output.append(INDENT1 CLOSE_BLOCK);
- }
- p_output.append(CLOSE_BLOCK); // end of namespace
- p_output.append("\n#pragma warning restore CS1591\n");
- }
- Error BindingsGenerator::generate_cs_core_project(const String &p_proj_dir) {
- ERR_FAIL_COND_V(!initialized, ERR_UNCONFIGURED);
- DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- ERR_FAIL_COND_V(!da, ERR_CANT_CREATE);
- if (!DirAccess::exists(p_proj_dir)) {
- Error err = da->make_dir_recursive(p_proj_dir);
- ERR_FAIL_COND_V_MSG(err != OK, ERR_CANT_CREATE, "Cannot create directory '" + p_proj_dir + "'.");
- }
- da->change_dir(p_proj_dir);
- da->make_dir("Generated");
- da->make_dir("Generated/GodotObjects");
- String base_gen_dir = path::join(p_proj_dir, "Generated");
- String godot_objects_gen_dir = path::join(base_gen_dir, "GodotObjects");
- Vector<String> compile_items;
- // Generate source file for global scope constants and enums
- {
- StringBuilder constants_source;
- _generate_global_constants(constants_source);
- String output_file = path::join(base_gen_dir, BINDINGS_GLOBAL_SCOPE_CLASS "_constants.cs");
- Error save_err = _save_file(output_file, constants_source);
- if (save_err != OK)
- return save_err;
- compile_items.push_back(output_file);
- }
- for (OrderedHashMap<StringName, TypeInterface>::Element E = obj_types.front(); E; E = E.next()) {
- const TypeInterface &itype = E.get();
- if (itype.api_type == ClassDB::API_EDITOR)
- continue;
- String output_file = path::join(godot_objects_gen_dir, itype.proxy_name + ".cs");
- Error err = _generate_cs_type(itype, output_file);
- if (err == ERR_SKIP)
- continue;
- if (err != OK)
- return err;
- compile_items.push_back(output_file);
- }
- // Generate sources from compressed files
- StringBuilder cs_icalls_content;
- cs_icalls_content.append("using System;\n"
- "using System.Runtime.CompilerServices;\n"
- "\n");
- cs_icalls_content.append("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
- cs_icalls_content.append(INDENT1 "internal static class " BINDINGS_CLASS_NATIVECALLS "\n" INDENT1 OPEN_BLOCK);
- cs_icalls_content.append(MEMBER_BEGIN "internal static ulong godot_api_hash = ");
- cs_icalls_content.append(String::num_uint64(GDMono::get_singleton()->get_api_core_hash()) + ";\n");
- cs_icalls_content.append(MEMBER_BEGIN "internal static uint bindings_version = ");
- cs_icalls_content.append(String::num_uint64(BINDINGS_GENERATOR_VERSION) + ";\n");
- cs_icalls_content.append(MEMBER_BEGIN "internal static uint cs_glue_version = ");
- cs_icalls_content.append(String::num_uint64(CS_GLUE_VERSION) + ";\n");
- // We have issues with beforefieldinit and AOT, so we use explicitly declare
- // the static constructor to prevent the class from being beforefieldinit.
- cs_icalls_content.append(MEMBER_BEGIN "static NativeCalls()\n" INDENT2 OPEN_BLOCK CLOSE_BLOCK_L2);
- #define ADD_INTERNAL_CALL(m_icall) \
- if (!m_icall.editor_only) { \
- cs_icalls_content.append(MEMBER_BEGIN "[MethodImpl(MethodImplOptions.InternalCall)]\n"); \
- cs_icalls_content.append(INDENT2 "internal static extern "); \
- cs_icalls_content.append(m_icall.im_type_out + " "); \
- cs_icalls_content.append(m_icall.name + "("); \
- cs_icalls_content.append(m_icall.im_sig + ");\n"); \
- }
- for (const List<InternalCall>::Element *E = core_custom_icalls.front(); E; E = E->next())
- ADD_INTERNAL_CALL(E->get());
- for (const List<InternalCall>::Element *E = method_icalls.front(); E; E = E->next())
- ADD_INTERNAL_CALL(E->get());
- #undef ADD_INTERNAL_CALL
- cs_icalls_content.append(INDENT1 CLOSE_BLOCK CLOSE_BLOCK);
- String internal_methods_file = path::join(base_gen_dir, BINDINGS_CLASS_NATIVECALLS ".cs");
- Error err = _save_file(internal_methods_file, cs_icalls_content);
- if (err != OK)
- return err;
- compile_items.push_back(internal_methods_file);
- StringBuilder includes_props_content;
- includes_props_content.append("<Project>\n"
- " <ItemGroup>\n");
- for (int i = 0; i < compile_items.size(); i++) {
- String include = path::relative_to(compile_items[i], p_proj_dir).replace("/", "\\");
- includes_props_content.append(" <Compile Include=\"" + include + "\" />\n");
- }
- includes_props_content.append(" </ItemGroup>\n"
- "</Project>\n");
- String includes_props_file = path::join(base_gen_dir, "GeneratedIncludes.props");
- err = _save_file(includes_props_file, includes_props_content);
- if (err != OK)
- return err;
- return OK;
- }
- Error BindingsGenerator::generate_cs_editor_project(const String &p_proj_dir) {
- ERR_FAIL_COND_V(!initialized, ERR_UNCONFIGURED);
- DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- ERR_FAIL_COND_V(!da, ERR_CANT_CREATE);
- if (!DirAccess::exists(p_proj_dir)) {
- Error err = da->make_dir_recursive(p_proj_dir);
- ERR_FAIL_COND_V(err != OK, ERR_CANT_CREATE);
- }
- da->change_dir(p_proj_dir);
- da->make_dir("Generated");
- da->make_dir("Generated/GodotObjects");
- String base_gen_dir = path::join(p_proj_dir, "Generated");
- String godot_objects_gen_dir = path::join(base_gen_dir, "GodotObjects");
- Vector<String> compile_items;
- for (OrderedHashMap<StringName, TypeInterface>::Element E = obj_types.front(); E; E = E.next()) {
- const TypeInterface &itype = E.get();
- if (itype.api_type != ClassDB::API_EDITOR)
- continue;
- String output_file = path::join(godot_objects_gen_dir, itype.proxy_name + ".cs");
- Error err = _generate_cs_type(itype, output_file);
- if (err == ERR_SKIP)
- continue;
- if (err != OK)
- return err;
- compile_items.push_back(output_file);
- }
- StringBuilder cs_icalls_content;
- cs_icalls_content.append("using System;\n"
- "using System.Runtime.CompilerServices;\n"
- "\n");
- cs_icalls_content.append("namespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
- cs_icalls_content.append(INDENT1 "internal static class " BINDINGS_CLASS_NATIVECALLS_EDITOR "\n" INDENT1 OPEN_BLOCK);
- cs_icalls_content.append(INDENT2 "internal static ulong godot_api_hash = ");
- cs_icalls_content.append(String::num_uint64(GDMono::get_singleton()->get_api_editor_hash()) + ";\n");
- cs_icalls_content.append(INDENT2 "internal static uint bindings_version = ");
- cs_icalls_content.append(String::num_uint64(BINDINGS_GENERATOR_VERSION) + ";\n");
- cs_icalls_content.append(INDENT2 "internal static uint cs_glue_version = ");
- cs_icalls_content.append(String::num_uint64(CS_GLUE_VERSION) + ";\n");
- // We have issues with beforefieldinit and AOT, so we use explicitly declare
- // the static constructor to prevent the class from being beforefieldinit.
- cs_icalls_content.append(MEMBER_BEGIN "static EditorNativeCalls()\n" INDENT2 OPEN_BLOCK CLOSE_BLOCK_L2);
- #define ADD_INTERNAL_CALL(m_icall) \
- if (m_icall.editor_only) { \
- cs_icalls_content.append(MEMBER_BEGIN "[MethodImpl(MethodImplOptions.InternalCall)]\n"); \
- cs_icalls_content.append(INDENT2 "internal static extern "); \
- cs_icalls_content.append(m_icall.im_type_out + " "); \
- cs_icalls_content.append(m_icall.name + "("); \
- cs_icalls_content.append(m_icall.im_sig + ");\n"); \
- }
- for (const List<InternalCall>::Element *E = editor_custom_icalls.front(); E; E = E->next())
- ADD_INTERNAL_CALL(E->get());
- for (const List<InternalCall>::Element *E = method_icalls.front(); E; E = E->next())
- ADD_INTERNAL_CALL(E->get());
- #undef ADD_INTERNAL_CALL
- cs_icalls_content.append(INDENT1 CLOSE_BLOCK CLOSE_BLOCK);
- String internal_methods_file = path::join(base_gen_dir, BINDINGS_CLASS_NATIVECALLS_EDITOR ".cs");
- Error err = _save_file(internal_methods_file, cs_icalls_content);
- if (err != OK)
- return err;
- compile_items.push_back(internal_methods_file);
- StringBuilder includes_props_content;
- includes_props_content.append("<Project>\n"
- " <ItemGroup>\n");
- for (int i = 0; i < compile_items.size(); i++) {
- String include = path::relative_to(compile_items[i], p_proj_dir).replace("/", "\\");
- includes_props_content.append(" <Compile Include=\"" + include + "\" />\n");
- }
- includes_props_content.append(" </ItemGroup>\n"
- "</Project>\n");
- String includes_props_file = path::join(base_gen_dir, "GeneratedIncludes.props");
- err = _save_file(includes_props_file, includes_props_content);
- if (err != OK)
- return err;
- return OK;
- }
- Error BindingsGenerator::generate_cs_api(const String &p_output_dir) {
- ERR_FAIL_COND_V(!initialized, ERR_UNCONFIGURED);
- String output_dir = path::abspath(path::realpath(p_output_dir));
- DirAccessRef da = DirAccess::create(DirAccess::ACCESS_FILESYSTEM);
- ERR_FAIL_COND_V(!da, ERR_CANT_CREATE);
- if (!DirAccess::exists(output_dir)) {
- Error err = da->make_dir_recursive(output_dir);
- ERR_FAIL_COND_V(err != OK, ERR_CANT_CREATE);
- }
- Error proj_err;
- // Generate GodotSharp source files
- String core_proj_dir = output_dir.plus_file(CORE_API_ASSEMBLY_NAME);
- proj_err = generate_cs_core_project(core_proj_dir);
- if (proj_err != OK) {
- ERR_PRINT("Generation of the Core API C# project failed.");
- return proj_err;
- }
- // Generate GodotSharpEditor source files
- String editor_proj_dir = output_dir.plus_file(EDITOR_API_ASSEMBLY_NAME);
- proj_err = generate_cs_editor_project(editor_proj_dir);
- if (proj_err != OK) {
- ERR_PRINT("Generation of the Editor API C# project failed.");
- return proj_err;
- }
- _log("The Godot API sources were successfully generated\n");
- return OK;
- }
- // FIXME: There are some members that hide other inherited members.
- // - In the case of both members being the same kind, the new one must be declared
- // explicitly as 'new' to avoid the warning (and we must print a message about it).
- // - In the case of both members being of a different kind, then the new one must
- // be renamed to avoid the name collision (and we must print a warning about it).
- // - Csc warning e.g.:
- // ObjectType/LineEdit.cs(140,38): warning CS0108: 'LineEdit.FocusMode' hides inherited member 'Control.FocusMode'. Use the new keyword if hiding was intended.
- Error BindingsGenerator::_generate_cs_type(const TypeInterface &itype, const String &p_output_file) {
- CRASH_COND(!itype.is_object_type);
- bool is_derived_type = itype.base_name != StringName();
- if (!is_derived_type) {
- // Some Godot.Object assertions
- CRASH_COND(itype.cname != name_cache.type_Object);
- CRASH_COND(!itype.is_instantiable);
- CRASH_COND(itype.api_type != ClassDB::API_CORE);
- CRASH_COND(itype.is_reference);
- CRASH_COND(itype.is_singleton);
- }
- List<InternalCall> &custom_icalls = itype.api_type == ClassDB::API_EDITOR ? editor_custom_icalls : core_custom_icalls;
- _log("Generating %s.cs...\n", itype.proxy_name.utf8().get_data());
- String ctor_method(ICALL_PREFIX + itype.proxy_name + "_Ctor"); // Used only for derived types
- StringBuilder output;
- output.append("using System;\n"); // IntPtr
- output.append("using System.Diagnostics;\n"); // DebuggerBrowsable
- output.append("\n"
- "#pragma warning disable CS1591 // Disable warning: "
- "'Missing XML comment for publicly visible type or member'\n"
- "#pragma warning disable CS1573 // Disable warning: "
- "'Parameter has no matching param tag in the XML comment'\n");
- output.append("\nnamespace " BINDINGS_NAMESPACE "\n" OPEN_BLOCK);
- const DocData::ClassDoc *class_doc = itype.class_doc;
- if (class_doc && class_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(class_doc->description), &itype);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- output.append(INDENT1 "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- output.append(INDENT1 "/// ");
- output.append(summary_lines[i]);
- output.append("\n");
- }
- output.append(INDENT1 "/// </summary>\n");
- }
- }
- output.append(INDENT1 "public ");
- if (itype.is_singleton) {
- output.append("static partial class ");
- } else {
- output.append(itype.is_instantiable ? "partial class " : "abstract partial class ");
- }
- output.append(itype.proxy_name);
- if (itype.is_singleton) {
- output.append("\n");
- } else if (is_derived_type) {
- if (obj_types.has(itype.base_name)) {
- output.append(" : ");
- output.append(obj_types[itype.base_name].proxy_name);
- output.append("\n");
- } else {
- ERR_PRINT("Base type '" + itype.base_name.operator String() + "' does not exist, for class '" + itype.name + "'.");
- return ERR_INVALID_DATA;
- }
- }
- output.append(INDENT1 "{");
- if (class_doc) {
- // Add constants
- for (const List<ConstantInterface>::Element *E = itype.constants.front(); E; E = E->next()) {
- const ConstantInterface &iconstant = E->get();
- if (iconstant.const_doc && iconstant.const_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(iconstant.const_doc->description), &itype);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- output.append(MEMBER_BEGIN "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- output.append(INDENT2 "/// ");
- output.append(summary_lines[i]);
- output.append("\n");
- }
- output.append(INDENT2 "/// </summary>");
- }
- }
- output.append(MEMBER_BEGIN "public const int ");
- output.append(iconstant.proxy_name);
- output.append(" = ");
- output.append(itos(iconstant.value));
- output.append(";");
- }
- if (itype.constants.size())
- output.append("\n");
- // Add enums
- for (const List<EnumInterface>::Element *E = itype.enums.front(); E; E = E->next()) {
- const EnumInterface &ienum = E->get();
- ERR_FAIL_COND_V(ienum.constants.empty(), ERR_BUG);
- output.append(MEMBER_BEGIN "public enum ");
- output.append(ienum.cname.operator String());
- output.append(MEMBER_BEGIN OPEN_BLOCK);
- for (const List<ConstantInterface>::Element *F = ienum.constants.front(); F; F = F->next()) {
- const ConstantInterface &iconstant = F->get();
- if (iconstant.const_doc && iconstant.const_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(iconstant.const_doc->description), &itype);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- output.append(INDENT3 "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- output.append(INDENT3 "/// ");
- output.append(summary_lines[i]);
- output.append("\n");
- }
- output.append(INDENT3 "/// </summary>\n");
- }
- }
- output.append(INDENT3);
- output.append(iconstant.proxy_name);
- output.append(" = ");
- output.append(itos(iconstant.value));
- output.append(F != ienum.constants.back() ? ",\n" : "\n");
- }
- output.append(INDENT2 CLOSE_BLOCK);
- }
- // Add properties
- for (const List<PropertyInterface>::Element *E = itype.properties.front(); E; E = E->next()) {
- const PropertyInterface &iprop = E->get();
- Error prop_err = _generate_cs_property(itype, iprop, output);
- ERR_FAIL_COND_V_MSG(prop_err != OK, prop_err,
- "Failed to generate property '" + iprop.cname.operator String() +
- "' for class '" + itype.name + "'.");
- }
- }
- // TODO: BINDINGS_NATIVE_NAME_FIELD should be StringName, once we support it in C#
- if (itype.is_singleton) {
- // Add the type name and the singleton pointer as static fields
- output.append(MEMBER_BEGIN "private static Godot.Object singleton;\n");
- output.append(MEMBER_BEGIN "public static Godot.Object Singleton\n" INDENT2 "{\n" INDENT3
- "get\n" INDENT3 "{\n" INDENT4 "if (singleton == null)\n" INDENT5
- "singleton = Engine.GetSingleton(typeof(");
- output.append(itype.proxy_name);
- output.append(").Name);\n" INDENT4 "return singleton;\n" INDENT3 "}\n" INDENT2 "}\n");
- output.append(MEMBER_BEGIN "private const string " BINDINGS_NATIVE_NAME_FIELD " = \"");
- output.append(itype.name);
- output.append("\";\n");
- output.append(INDENT2 "internal static IntPtr " BINDINGS_PTR_FIELD " = ");
- output.append(itype.api_type == ClassDB::API_EDITOR ? BINDINGS_CLASS_NATIVECALLS_EDITOR : BINDINGS_CLASS_NATIVECALLS);
- output.append("." ICALL_PREFIX);
- output.append(itype.name);
- output.append(SINGLETON_ICALL_SUFFIX "();\n");
- } else if (is_derived_type) {
- // Add member fields
- output.append(MEMBER_BEGIN "private const string " BINDINGS_NATIVE_NAME_FIELD " = \"");
- output.append(itype.name);
- output.append("\";\n");
- // Add default constructor
- if (itype.is_instantiable) {
- output.append(MEMBER_BEGIN "public ");
- output.append(itype.proxy_name);
- output.append("() : this(");
- output.append(itype.memory_own ? "true" : "false");
- // The default constructor may also be called by the engine when instancing existing native objects
- // The engine will initialize the pointer field of the managed side before calling the constructor
- // This is why we only allocate a new native object from the constructor if the pointer field is not set
- output.append(")\n" OPEN_BLOCK_L2 "if (" BINDINGS_PTR_FIELD " == IntPtr.Zero)\n" INDENT4 BINDINGS_PTR_FIELD " = ");
- output.append(itype.api_type == ClassDB::API_EDITOR ? BINDINGS_CLASS_NATIVECALLS_EDITOR : BINDINGS_CLASS_NATIVECALLS);
- output.append("." + ctor_method);
- output.append("(this);\n" CLOSE_BLOCK_L2);
- } else {
- // Hide the constructor
- output.append(MEMBER_BEGIN "internal ");
- output.append(itype.proxy_name);
- output.append("() {}\n");
- }
- // Add.. em.. trick constructor. Sort of.
- output.append(MEMBER_BEGIN "internal ");
- output.append(itype.proxy_name);
- output.append("(bool " CS_FIELD_MEMORYOWN ") : base(" CS_FIELD_MEMORYOWN ") {}\n");
- }
- int method_bind_count = 0;
- for (const List<MethodInterface>::Element *E = itype.methods.front(); E; E = E->next()) {
- const MethodInterface &imethod = E->get();
- Error method_err = _generate_cs_method(itype, imethod, method_bind_count, output);
- ERR_FAIL_COND_V_MSG(method_err != OK, method_err,
- "Failed to generate method '" + imethod.name + "' for class '" + itype.name + "'.");
- }
- if (itype.is_singleton) {
- InternalCall singleton_icall = InternalCall(itype.api_type, ICALL_PREFIX + itype.name + SINGLETON_ICALL_SUFFIX, "IntPtr");
- if (!find_icall_by_name(singleton_icall.name, custom_icalls))
- custom_icalls.push_back(singleton_icall);
- }
- if (is_derived_type && itype.is_instantiable) {
- InternalCall ctor_icall = InternalCall(itype.api_type, ctor_method, "IntPtr", itype.proxy_name + " obj");
- if (!find_icall_by_name(ctor_icall.name, custom_icalls))
- custom_icalls.push_back(ctor_icall);
- }
- output.append(INDENT1 CLOSE_BLOCK /* class */
- CLOSE_BLOCK /* namespace */);
- output.append("\n"
- "#pragma warning restore CS1591\n"
- "#pragma warning restore CS1573\n");
- return _save_file(p_output_file, output);
- }
- Error BindingsGenerator::_generate_cs_property(const BindingsGenerator::TypeInterface &p_itype, const PropertyInterface &p_iprop, StringBuilder &p_output) {
- const MethodInterface *setter = p_itype.find_method_by_name(p_iprop.setter);
- // Search it in base types too
- const TypeInterface *current_type = &p_itype;
- while (!setter && current_type->base_name != StringName()) {
- OrderedHashMap<StringName, TypeInterface>::Element base_match = obj_types.find(current_type->base_name);
- ERR_FAIL_COND_V(!base_match, ERR_BUG);
- current_type = &base_match.get();
- setter = current_type->find_method_by_name(p_iprop.setter);
- }
- const MethodInterface *getter = p_itype.find_method_by_name(p_iprop.getter);
- // Search it in base types too
- current_type = &p_itype;
- while (!getter && current_type->base_name != StringName()) {
- OrderedHashMap<StringName, TypeInterface>::Element base_match = obj_types.find(current_type->base_name);
- ERR_FAIL_COND_V(!base_match, ERR_BUG);
- current_type = &base_match.get();
- getter = current_type->find_method_by_name(p_iprop.getter);
- }
- ERR_FAIL_COND_V(!setter && !getter, ERR_BUG);
- if (setter) {
- int setter_argc = p_iprop.index != -1 ? 2 : 1;
- ERR_FAIL_COND_V(setter->arguments.size() != setter_argc, ERR_BUG);
- }
- if (getter) {
- int getter_argc = p_iprop.index != -1 ? 1 : 0;
- ERR_FAIL_COND_V(getter->arguments.size() != getter_argc, ERR_BUG);
- }
- if (getter && setter) {
- ERR_FAIL_COND_V(getter->return_type.cname != setter->arguments.back()->get().type.cname, ERR_BUG);
- }
- const TypeReference &proptype_name = getter ? getter->return_type : setter->arguments.back()->get().type;
- const TypeInterface *prop_itype = _get_type_or_null(proptype_name);
- ERR_FAIL_NULL_V(prop_itype, ERR_BUG); // Property type not found
- if (p_iprop.prop_doc && p_iprop.prop_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(p_iprop.prop_doc->description), &p_itype);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- p_output.append(MEMBER_BEGIN "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- p_output.append(INDENT2 "/// ");
- p_output.append(summary_lines[i]);
- p_output.append("\n");
- }
- p_output.append(INDENT2 "/// </summary>");
- }
- }
- p_output.append(MEMBER_BEGIN "public ");
- if (p_itype.is_singleton)
- p_output.append("static ");
- p_output.append(prop_itype->cs_type);
- p_output.append(" ");
- p_output.append(p_iprop.proxy_name);
- p_output.append("\n" INDENT2 OPEN_BLOCK);
- if (getter) {
- p_output.append(INDENT3 "get\n"
- // TODO Remove this once we make accessor methods private/internal (they will no longer be marked as obsolete after that)
- "#pragma warning disable CS0618 // Disable warning about obsolete method\n"
- OPEN_BLOCK_L3);
- p_output.append("return ");
- p_output.append(getter->proxy_name + "(");
- if (p_iprop.index != -1) {
- const ArgumentInterface &idx_arg = getter->arguments.front()->get();
- if (idx_arg.type.cname != name_cache.type_int) {
- // Assume the index parameter is an enum
- const TypeInterface *idx_arg_type = _get_type_or_null(idx_arg.type);
- CRASH_COND(idx_arg_type == NULL);
- p_output.append("(" + idx_arg_type->proxy_name + ")" + itos(p_iprop.index));
- } else {
- p_output.append(itos(p_iprop.index));
- }
- }
- p_output.append(");\n"
- CLOSE_BLOCK_L3
- // TODO Remove this once we make accessor methods private/internal (they will no longer be marked as obsolete after that)
- "#pragma warning restore CS0618\n");
- }
- if (setter) {
- p_output.append(INDENT3 "set\n"
- // TODO Remove this once we make accessor methods private/internal (they will no longer be marked as obsolete after that)
- "#pragma warning disable CS0618 // Disable warning about obsolete method\n"
- OPEN_BLOCK_L3);
- p_output.append(setter->proxy_name + "(");
- if (p_iprop.index != -1) {
- const ArgumentInterface &idx_arg = setter->arguments.front()->get();
- if (idx_arg.type.cname != name_cache.type_int) {
- // Assume the index parameter is an enum
- const TypeInterface *idx_arg_type = _get_type_or_null(idx_arg.type);
- CRASH_COND(idx_arg_type == NULL);
- p_output.append("(" + idx_arg_type->proxy_name + ")" + itos(p_iprop.index) + ", ");
- } else {
- p_output.append(itos(p_iprop.index) + ", ");
- }
- }
- p_output.append("value);\n"
- CLOSE_BLOCK_L3
- // TODO Remove this once we make accessor methods private/internal (they will no longer be marked as obsolete after that)
- "#pragma warning restore CS0618\n");
- }
- p_output.append(CLOSE_BLOCK_L2);
- return OK;
- }
- Error BindingsGenerator::_generate_cs_method(const BindingsGenerator::TypeInterface &p_itype, const BindingsGenerator::MethodInterface &p_imethod, int &p_method_bind_count, StringBuilder &p_output) {
- const TypeInterface *return_type = _get_type_or_placeholder(p_imethod.return_type);
- String method_bind_field = "method_bind_" + itos(p_method_bind_count);
- String arguments_sig;
- String cs_in_statements;
- String icall_params = method_bind_field + ", ";
- icall_params += sformat(p_itype.cs_in, "this");
- StringBuilder default_args_doc;
- // Retrieve information from the arguments
- for (const List<ArgumentInterface>::Element *F = p_imethod.arguments.front(); F; F = F->next()) {
- const ArgumentInterface &iarg = F->get();
- const TypeInterface *arg_type = _get_type_or_placeholder(iarg.type);
- // Add the current arguments to the signature
- // If the argument has a default value which is not a constant, we will make it Nullable
- {
- if (F != p_imethod.arguments.front())
- arguments_sig += ", ";
- if (iarg.def_param_mode == ArgumentInterface::NULLABLE_VAL)
- arguments_sig += "Nullable<";
- arguments_sig += arg_type->cs_type;
- if (iarg.def_param_mode == ArgumentInterface::NULLABLE_VAL)
- arguments_sig += "> ";
- else
- arguments_sig += " ";
- arguments_sig += iarg.name;
- if (iarg.default_argument.size()) {
- if (iarg.def_param_mode != ArgumentInterface::CONSTANT)
- arguments_sig += " = null";
- else
- arguments_sig += " = " + sformat(iarg.default_argument, arg_type->cs_type);
- }
- }
- icall_params += ", ";
- if (iarg.default_argument.size() && iarg.def_param_mode != ArgumentInterface::CONSTANT) {
- // The default value of an argument must be constant. Otherwise we make it Nullable and do the following:
- // Type arg_in = arg.HasValue ? arg.Value : <non-const default value>;
- String arg_in = iarg.name;
- arg_in += "_in";
- cs_in_statements += arg_type->cs_type;
- cs_in_statements += " ";
- cs_in_statements += arg_in;
- cs_in_statements += " = ";
- cs_in_statements += iarg.name;
- if (iarg.def_param_mode == ArgumentInterface::NULLABLE_VAL)
- cs_in_statements += ".HasValue ? ";
- else
- cs_in_statements += " != null ? ";
- cs_in_statements += iarg.name;
- if (iarg.def_param_mode == ArgumentInterface::NULLABLE_VAL)
- cs_in_statements += ".Value : ";
- else
- cs_in_statements += " : ";
- String cs_type = arg_type->cs_type;
- if (cs_type.ends_with("[]")) {
- cs_type = cs_type.substr(0, cs_type.length() - 2);
- }
- String def_arg = sformat(iarg.default_argument, cs_type);
- cs_in_statements += def_arg;
- cs_in_statements += ";\n" INDENT3;
- icall_params += arg_type->cs_in.empty() ? arg_in : sformat(arg_type->cs_in, arg_in);
- // Apparently the name attribute must not include the @
- String param_tag_name = iarg.name.begins_with("@") ? iarg.name.substr(1, iarg.name.length()) : iarg.name;
- // Escape < and > in the attribute default value
- String param_def_arg = def_arg.replacen("<", "<").replacen(">", ">");
- default_args_doc.append(MEMBER_BEGIN "/// <param name=\"" + param_tag_name + "\">If the parameter is null, then the default value is " + param_def_arg + "</param>");
- } else {
- icall_params += arg_type->cs_in.empty() ? iarg.name : sformat(arg_type->cs_in, iarg.name);
- }
- }
- if (p_imethod.is_vararg) {
- icall_params += ", \"" + p_imethod.cname + "\"";
- }
- // Generate method
- {
- if (!p_imethod.is_virtual && !p_imethod.requires_object_call) {
- p_output.append(MEMBER_BEGIN "[DebuggerBrowsable(DebuggerBrowsableState.Never)]" MEMBER_BEGIN "private static IntPtr ");
- p_output.append(method_bind_field + " = Object." ICALL_GET_METHODBIND "(" BINDINGS_NATIVE_NAME_FIELD ", \"");
- p_output.append(p_imethod.name);
- p_output.append("\");\n");
- }
- if (p_imethod.method_doc && p_imethod.method_doc->description.size()) {
- String xml_summary = bbcode_to_xml(fix_doc_description(p_imethod.method_doc->description), &p_itype);
- Vector<String> summary_lines = xml_summary.length() ? xml_summary.split("\n") : Vector<String>();
- if (summary_lines.size()) {
- p_output.append(MEMBER_BEGIN "/// <summary>\n");
- for (int i = 0; i < summary_lines.size(); i++) {
- p_output.append(INDENT2 "/// ");
- p_output.append(summary_lines[i]);
- p_output.append("\n");
- }
- p_output.append(INDENT2 "/// </summary>");
- }
- }
- if (default_args_doc.get_string_length()) {
- p_output.append(default_args_doc.as_string());
- }
- if (!p_imethod.is_internal) {
- p_output.append(MEMBER_BEGIN "[GodotMethod(\"");
- p_output.append(p_imethod.name);
- p_output.append("\")]");
- }
- if (p_imethod.is_deprecated) {
- if (p_imethod.deprecation_message.empty())
- WARN_PRINT("An empty deprecation message is discouraged. Method: '" + p_imethod.proxy_name + "'.");
- p_output.append(MEMBER_BEGIN "[Obsolete(\"");
- p_output.append(p_imethod.deprecation_message);
- p_output.append("\")]");
- }
- p_output.append(MEMBER_BEGIN);
- p_output.append(p_imethod.is_internal ? "internal " : "public ");
- if (p_itype.is_singleton) {
- p_output.append("static ");
- } else if (p_imethod.is_virtual) {
- p_output.append("virtual ");
- }
- p_output.append(return_type->cs_type + " ");
- p_output.append(p_imethod.proxy_name + "(");
- p_output.append(arguments_sig + ")\n" OPEN_BLOCK_L2);
- if (p_imethod.is_virtual) {
- // Godot virtual method must be overridden, therefore we return a default value by default.
- if (return_type->cname == name_cache.type_void) {
- p_output.append("return;\n" CLOSE_BLOCK_L2);
- } else {
- p_output.append("return default(");
- p_output.append(return_type->cs_type);
- p_output.append(");\n" CLOSE_BLOCK_L2);
- }
- return OK; // Won't increment method bind count
- }
- if (p_imethod.requires_object_call) {
- // Fallback to Godot's object.Call(string, params)
- p_output.append(CS_METHOD_CALL "(\"");
- p_output.append(p_imethod.name);
- p_output.append("\"");
- for (const List<ArgumentInterface>::Element *F = p_imethod.arguments.front(); F; F = F->next()) {
- p_output.append(", ");
- p_output.append(F->get().name);
- }
- p_output.append(");\n" CLOSE_BLOCK_L2);
- return OK; // Won't increment method bind count
- }
- const Map<const MethodInterface *, const InternalCall *>::Element *match = method_icalls_map.find(&p_imethod);
- ERR_FAIL_NULL_V(match, ERR_BUG);
- const InternalCall *im_icall = match->value();
- String im_call = im_icall->editor_only ? BINDINGS_CLASS_NATIVECALLS_EDITOR : BINDINGS_CLASS_NATIVECALLS;
- im_call += ".";
- im_call += im_icall->name;
- if (p_imethod.arguments.size())
- p_output.append(cs_in_statements);
- if (return_type->cname == name_cache.type_void) {
- p_output.append(im_call + "(" + icall_params + ");\n");
- } else if (return_type->cs_out.empty()) {
- p_output.append("return " + im_call + "(" + icall_params + ");\n");
- } else {
- p_output.append(sformat(return_type->cs_out, im_call, icall_params, return_type->cs_type, return_type->im_type_out));
- p_output.append("\n");
- }
- p_output.append(CLOSE_BLOCK_L2);
- }
- p_method_bind_count++;
- return OK;
- }
- Error BindingsGenerator::generate_glue(const String &p_output_dir) {
- ERR_FAIL_COND_V(!initialized, ERR_UNCONFIGURED);
- bool dir_exists = DirAccess::exists(p_output_dir);
- ERR_FAIL_COND_V_MSG(!dir_exists, ERR_FILE_BAD_PATH, "The output directory does not exist.");
- StringBuilder output;
- output.append("/* THIS FILE IS GENERATED DO NOT EDIT */\n");
- output.append("#include \"" GLUE_HEADER_FILE "\"\n");
- output.append("\n#ifdef MONO_GLUE_ENABLED\n");
- generated_icall_funcs.clear();
- for (OrderedHashMap<StringName, TypeInterface>::Element type_elem = obj_types.front(); type_elem; type_elem = type_elem.next()) {
- const TypeInterface &itype = type_elem.get();
- bool is_derived_type = itype.base_name != StringName();
- if (!is_derived_type) {
- // Some Object assertions
- CRASH_COND(itype.cname != name_cache.type_Object);
- CRASH_COND(!itype.is_instantiable);
- CRASH_COND(itype.api_type != ClassDB::API_CORE);
- CRASH_COND(itype.is_reference);
- CRASH_COND(itype.is_singleton);
- }
- List<InternalCall> &custom_icalls = itype.api_type == ClassDB::API_EDITOR ? editor_custom_icalls : core_custom_icalls;
- OS::get_singleton()->print("Generating %s...\n", itype.name.utf8().get_data());
- String ctor_method(ICALL_PREFIX + itype.proxy_name + "_Ctor"); // Used only for derived types
- for (const List<MethodInterface>::Element *E = itype.methods.front(); E; E = E->next()) {
- const MethodInterface &imethod = E->get();
- Error method_err = _generate_glue_method(itype, imethod, output);
- ERR_FAIL_COND_V_MSG(method_err != OK, method_err,
- "Failed to generate method '" + imethod.name + "' for class '" + itype.name + "'.");
- }
- if (itype.is_singleton) {
- String singleton_icall_name = ICALL_PREFIX + itype.name + SINGLETON_ICALL_SUFFIX;
- InternalCall singleton_icall = InternalCall(itype.api_type, singleton_icall_name, "IntPtr");
- if (!find_icall_by_name(singleton_icall.name, custom_icalls))
- custom_icalls.push_back(singleton_icall);
- output.append("Object* ");
- output.append(singleton_icall_name);
- output.append("() " OPEN_BLOCK "\treturn Engine::get_singleton()->get_singleton_object(\"");
- output.append(itype.proxy_name);
- output.append("\");\n" CLOSE_BLOCK "\n");
- }
- if (is_derived_type && itype.is_instantiable) {
- InternalCall ctor_icall = InternalCall(itype.api_type, ctor_method, "IntPtr", itype.proxy_name + " obj");
- if (!find_icall_by_name(ctor_icall.name, custom_icalls))
- custom_icalls.push_back(ctor_icall);
- output.append("Object* ");
- output.append(ctor_method);
- output.append("(MonoObject* obj) " OPEN_BLOCK
- "\t" C_MACRO_OBJECT_CONSTRUCT "(instance, \"");
- output.append(itype.name);
- output.append("\");\n"
- "\t" C_METHOD_TIE_MANAGED_TO_UNMANAGED "(obj, instance);\n"
- "\treturn instance;\n" CLOSE_BLOCK "\n");
- }
- }
- output.append("namespace GodotSharpBindings\n" OPEN_BLOCK "\n");
- output.append("uint64_t get_core_api_hash() { return ");
- output.append(String::num_uint64(GDMono::get_singleton()->get_api_core_hash()) + "U; }\n");
- output.append("#ifdef TOOLS_ENABLED\n"
- "uint64_t get_editor_api_hash() { return ");
- output.append(String::num_uint64(GDMono::get_singleton()->get_api_editor_hash()) + "U; }\n");
- output.append("#endif // TOOLS_ENABLED\n");
- output.append("uint32_t get_bindings_version() { return ");
- output.append(String::num_uint64(BINDINGS_GENERATOR_VERSION) + "; }\n");
- output.append("uint32_t get_cs_glue_version() { return ");
- output.append(String::num_uint64(CS_GLUE_VERSION) + "; }\n");
- output.append("\nvoid register_generated_icalls() " OPEN_BLOCK);
- output.append("\tgodot_register_glue_header_icalls();\n");
- #define ADD_INTERNAL_CALL_REGISTRATION(m_icall) \
- { \
- output.append("\tGDMonoUtils::add_internal_call("); \
- output.append("\"" BINDINGS_NAMESPACE "."); \
- output.append(m_icall.editor_only ? BINDINGS_CLASS_NATIVECALLS_EDITOR : BINDINGS_CLASS_NATIVECALLS); \
- output.append("::"); \
- output.append(m_icall.name); \
- output.append("\", "); \
- output.append(m_icall.name); \
- output.append(");\n"); \
- }
- bool tools_sequence = false;
- for (const List<InternalCall>::Element *E = core_custom_icalls.front(); E; E = E->next()) {
- if (tools_sequence) {
- if (!E->get().editor_only) {
- tools_sequence = false;
- output.append("#endif\n");
- }
- } else {
- if (E->get().editor_only) {
- output.append("#ifdef TOOLS_ENABLED\n");
- tools_sequence = true;
- }
- }
- ADD_INTERNAL_CALL_REGISTRATION(E->get());
- }
- if (tools_sequence) {
- tools_sequence = false;
- output.append("#endif\n");
- }
- output.append("#ifdef TOOLS_ENABLED\n");
- for (const List<InternalCall>::Element *E = editor_custom_icalls.front(); E; E = E->next())
- ADD_INTERNAL_CALL_REGISTRATION(E->get());
- output.append("#endif // TOOLS_ENABLED\n");
- for (const List<InternalCall>::Element *E = method_icalls.front(); E; E = E->next()) {
- if (tools_sequence) {
- if (!E->get().editor_only) {
- tools_sequence = false;
- output.append("#endif\n");
- }
- } else {
- if (E->get().editor_only) {
- output.append("#ifdef TOOLS_ENABLED\n");
- tools_sequence = true;
- }
- }
- ADD_INTERNAL_CALL_REGISTRATION(E->get());
- }
- if (tools_sequence) {
- tools_sequence = false;
- output.append("#endif\n");
- }
- #undef ADD_INTERNAL_CALL_REGISTRATION
- output.append(CLOSE_BLOCK "\n} // namespace GodotSharpBindings\n");
- output.append("\n#endif // MONO_GLUE_ENABLED\n");
- Error save_err = _save_file(path::join(p_output_dir, "mono_glue.gen.cpp"), output);
- if (save_err != OK)
- return save_err;
- OS::get_singleton()->print("Mono glue generated successfully\n");
- return OK;
- }
- uint32_t BindingsGenerator::get_version() {
- return BINDINGS_GENERATOR_VERSION;
- }
- Error BindingsGenerator::_save_file(const String &p_path, const StringBuilder &p_content) {
- FileAccessRef file = FileAccess::open(p_path, FileAccess::WRITE);
- ERR_FAIL_COND_V_MSG(!file, ERR_FILE_CANT_WRITE, "Cannot open file: '" + p_path + "'.");
- file->store_string(p_content.as_string());
- file->close();
- return OK;
- }
- Error BindingsGenerator::_generate_glue_method(const BindingsGenerator::TypeInterface &p_itype, const BindingsGenerator::MethodInterface &p_imethod, StringBuilder &p_output) {
- if (p_imethod.is_virtual)
- return OK; // Ignore
- bool ret_void = p_imethod.return_type.cname == name_cache.type_void;
- const TypeInterface *return_type = _get_type_or_placeholder(p_imethod.return_type);
- String argc_str = itos(p_imethod.arguments.size());
- String c_func_sig = "MethodBind* " CS_PARAM_METHODBIND ", " + p_itype.c_type_in + " " CS_PARAM_INSTANCE;
- String c_in_statements;
- String c_args_var_content;
- // Get arguments information
- int i = 0;
- for (const List<ArgumentInterface>::Element *F = p_imethod.arguments.front(); F; F = F->next()) {
- const ArgumentInterface &iarg = F->get();
- const TypeInterface *arg_type = _get_type_or_placeholder(iarg.type);
- String c_param_name = "arg" + itos(i + 1);
- if (p_imethod.is_vararg) {
- if (i < p_imethod.arguments.size() - 1) {
- c_in_statements += sformat(arg_type->c_in.size() ? arg_type->c_in : TypeInterface::DEFAULT_VARARG_C_IN, "Variant", c_param_name);
- c_in_statements += "\t" C_LOCAL_PTRCALL_ARGS ".set(";
- c_in_statements += itos(i);
- c_in_statements += sformat(", &%s_in);\n", c_param_name);
- }
- } else {
- if (i > 0)
- c_args_var_content += ", ";
- if (arg_type->c_in.size())
- c_in_statements += sformat(arg_type->c_in, arg_type->c_type, c_param_name);
- c_args_var_content += sformat(arg_type->c_arg_in, c_param_name);
- }
- c_func_sig += ", ";
- c_func_sig += arg_type->c_type_in;
- c_func_sig += " ";
- c_func_sig += c_param_name;
- i++;
- }
- // Collect caller name for MethodBind
- if (p_imethod.is_vararg) {
- c_func_sig += ", MonoString* " CS_PARAM_CALLER;
- }
- if (return_type->ret_as_byref_arg) {
- c_func_sig += ", ";
- c_func_sig += return_type->c_type_in;
- c_func_sig += " ";
- c_func_sig += "arg_ret";
- i++;
- }
- const Map<const MethodInterface *, const InternalCall *>::Element *match = method_icalls_map.find(&p_imethod);
- ERR_FAIL_NULL_V(match, ERR_BUG);
- const InternalCall *im_icall = match->value();
- String icall_method = im_icall->name;
- if (!generated_icall_funcs.find(im_icall)) {
- generated_icall_funcs.push_back(im_icall);
- if (im_icall->editor_only)
- p_output.append("#ifdef TOOLS_ENABLED\n");
- // Generate icall function
- p_output.append((ret_void || return_type->ret_as_byref_arg) ? "void " : return_type->c_type_out + " ");
- p_output.append(icall_method);
- p_output.append("(");
- p_output.append(c_func_sig);
- p_output.append(") " OPEN_BLOCK);
- if (!ret_void) {
- String ptrcall_return_type;
- String initialization;
- if (p_imethod.is_vararg && return_type->cname != name_cache.type_Variant) {
- // VarArg methods always return Variant, but there are some cases in which MethodInfo provides
- // a specific return type. We trust this information is valid. We need a temporary local to keep
- // the Variant alive until the method returns. Otherwise, if the returned Variant holds a RefPtr,
- // it could be deleted too early. This is the case with GDScript.new() which returns OBJECT.
- // Alternatively, we could just return Variant, but that would result in a worse API.
- p_output.append("\tVariant " C_LOCAL_VARARG_RET ";\n");
- }
- if (return_type->is_object_type) {
- ptrcall_return_type = return_type->is_reference ? "Ref<Reference>" : return_type->c_type;
- initialization = return_type->is_reference ? "" : " = NULL";
- } else {
- ptrcall_return_type = return_type->c_type;
- }
- p_output.append("\t" + ptrcall_return_type);
- p_output.append(" " C_LOCAL_RET);
- p_output.append(initialization + ";\n");
- String fail_ret = return_type->c_type_out.ends_with("*") && !return_type->ret_as_byref_arg ? "NULL" : return_type->c_type_out + "()";
- if (return_type->ret_as_byref_arg) {
- p_output.append("\tif (" CS_PARAM_INSTANCE " == NULL) { *arg_ret = ");
- p_output.append(fail_ret);
- p_output.append("; ERR_FAIL_MSG(\"Parameter ' arg_ret ' is null.\"); }\n");
- } else {
- p_output.append("\tERR_FAIL_NULL_V(" CS_PARAM_INSTANCE ", ");
- p_output.append(fail_ret);
- p_output.append(");\n");
- }
- } else {
- p_output.append("\tERR_FAIL_NULL(" CS_PARAM_INSTANCE ");\n");
- }
- if (p_imethod.arguments.size()) {
- if (p_imethod.is_vararg) {
- String vararg_arg = "arg" + argc_str;
- String real_argc_str = itos(p_imethod.arguments.size() - 1); // Arguments count without vararg
- p_output.append("\tint vararg_length = mono_array_length(");
- p_output.append(vararg_arg);
- p_output.append(");\n\tint total_length = ");
- p_output.append(real_argc_str);
- p_output.append(" + vararg_length;\n"
- "\tArgumentsVector<Variant> varargs(vararg_length);\n"
- "\tArgumentsVector<const Variant *> " C_LOCAL_PTRCALL_ARGS "(total_length);\n");
- p_output.append(c_in_statements);
- p_output.append("\tfor (int i = 0; i < vararg_length; i++) " OPEN_BLOCK
- "\t\tMonoObject* elem = mono_array_get(");
- p_output.append(vararg_arg);
- p_output.append(", MonoObject*, i);\n"
- "\t\tvarargs.set(i, GDMonoMarshal::mono_object_to_variant(elem));\n"
- "\t\t" C_LOCAL_PTRCALL_ARGS ".set(");
- p_output.append(real_argc_str);
- p_output.append(" + i, &varargs.get(i));\n\t" CLOSE_BLOCK);
- } else {
- p_output.append(c_in_statements);
- p_output.append("\tconst void* " C_LOCAL_PTRCALL_ARGS "[");
- p_output.append(argc_str + "] = { ");
- p_output.append(c_args_var_content + " };\n");
- }
- }
- if (p_imethod.is_vararg) {
- p_output.append("\tVariant::CallError vcall_error;\n\t");
- if (!ret_void) {
- // See the comment on the C_LOCAL_VARARG_RET declaration
- if (return_type->cname != name_cache.type_Variant) {
- p_output.append(C_LOCAL_VARARG_RET " = ");
- } else {
- p_output.append(C_LOCAL_RET " = ");
- }
- }
- p_output.append(CS_PARAM_METHODBIND "->call(" CS_PARAM_INSTANCE ", ");
- p_output.append(p_imethod.arguments.size() ? C_LOCAL_PTRCALL_ARGS ".ptr()" : "NULL");
- p_output.append(", total_length, vcall_error);\n");
- p_output.append("#ifdef DEBUG_ENABLED\n");
- p_output.append("\tVariant instance_variant = Variant(" CS_PARAM_INSTANCE ");\n");
- p_output.append("\t" C_METHOD_CHECK_CALL_ERROR "(");
- p_output.append(C_METHOD_MONOSTR_TO_GODOT "(" CS_PARAM_CALLER ")");
- p_output.append(", &instance_variant, ");
- p_output.append(p_imethod.arguments.size() ? C_LOCAL_PTRCALL_ARGS ".ptr()" : "NULL");
- p_output.append(", total_length, vcall_error);\n");
- p_output.append("#endif // DEBUG_ENABLED\n");
- if (!ret_void) {
- // See the comment on the C_LOCAL_VARARG_RET declaration
- if (return_type->cname != name_cache.type_Variant) {
- p_output.append("\t" C_LOCAL_RET " = " C_LOCAL_VARARG_RET ";\n");
- }
- }
- } else {
- p_output.append("\t" CS_PARAM_METHODBIND "->ptrcall(" CS_PARAM_INSTANCE ", ");
- p_output.append(p_imethod.arguments.size() ? C_LOCAL_PTRCALL_ARGS ", " : "NULL, ");
- p_output.append(!ret_void ? "&" C_LOCAL_RET ");\n" : "NULL);\n");
- }
- if (!ret_void) {
- if (return_type->c_out.empty()) {
- p_output.append("\treturn " C_LOCAL_RET ";\n");
- } else if (return_type->ret_as_byref_arg) {
- p_output.append(sformat(return_type->c_out, return_type->c_type_out, C_LOCAL_RET, return_type->name, "arg_ret"));
- } else {
- p_output.append(sformat(return_type->c_out, return_type->c_type_out, C_LOCAL_RET, return_type->name));
- }
- }
- p_output.append(CLOSE_BLOCK "\n");
- if (im_icall->editor_only)
- p_output.append("#endif // TOOLS_ENABLED\n");
- }
- return OK;
- }
- const BindingsGenerator::TypeInterface *BindingsGenerator::_get_type_or_null(const TypeReference &p_typeref) {
- const Map<StringName, TypeInterface>::Element *builtin_type_match = builtin_types.find(p_typeref.cname);
- if (builtin_type_match)
- return &builtin_type_match->get();
- const OrderedHashMap<StringName, TypeInterface>::Element obj_type_match = obj_types.find(p_typeref.cname);
- if (obj_type_match)
- return &obj_type_match.get();
- if (p_typeref.is_enum) {
- const Map<StringName, TypeInterface>::Element *enum_match = enum_types.find(p_typeref.cname);
- if (enum_match)
- return &enum_match->get();
- // Enum not found. Most likely because none of its constants were bound, so it's empty. That's fine. Use int instead.
- const Map<StringName, TypeInterface>::Element *int_match = builtin_types.find(name_cache.type_int);
- ERR_FAIL_NULL_V(int_match, NULL);
- return &int_match->get();
- }
- return NULL;
- }
- const BindingsGenerator::TypeInterface *BindingsGenerator::_get_type_or_placeholder(const TypeReference &p_typeref) {
- const TypeInterface *found = _get_type_or_null(p_typeref);
- if (found)
- return found;
- ERR_PRINT(String() + "Type not found. Creating placeholder: '" + p_typeref.cname.operator String() + "'.");
- const Map<StringName, TypeInterface>::Element *match = placeholder_types.find(p_typeref.cname);
- if (match)
- return &match->get();
- TypeInterface placeholder;
- TypeInterface::create_placeholder_type(placeholder, p_typeref.cname);
- return &placeholder_types.insert(placeholder.cname, placeholder)->get();
- }
- StringName BindingsGenerator::_get_int_type_name_from_meta(GodotTypeInfo::Metadata p_meta) {
- switch (p_meta) {
- case GodotTypeInfo::METADATA_INT_IS_INT8:
- return "sbyte";
- break;
- case GodotTypeInfo::METADATA_INT_IS_INT16:
- return "short";
- break;
- case GodotTypeInfo::METADATA_INT_IS_INT32:
- return "int";
- break;
- case GodotTypeInfo::METADATA_INT_IS_INT64:
- return "long";
- break;
- case GodotTypeInfo::METADATA_INT_IS_UINT8:
- return "byte";
- break;
- case GodotTypeInfo::METADATA_INT_IS_UINT16:
- return "ushort";
- break;
- case GodotTypeInfo::METADATA_INT_IS_UINT32:
- return "uint";
- break;
- case GodotTypeInfo::METADATA_INT_IS_UINT64:
- return "ulong";
- break;
- default:
- // Assume INT32
- return "int";
- }
- }
- StringName BindingsGenerator::_get_float_type_name_from_meta(GodotTypeInfo::Metadata p_meta) {
- switch (p_meta) {
- case GodotTypeInfo::METADATA_REAL_IS_FLOAT:
- return "float";
- break;
- case GodotTypeInfo::METADATA_REAL_IS_DOUBLE:
- return "double";
- break;
- default:
- // Assume real_t (float or double depending of REAL_T_IS_DOUBLE)
- #ifdef REAL_T_IS_DOUBLE
- return "double";
- #else
- return "float";
- #endif
- }
- }
- bool BindingsGenerator::_populate_object_type_interfaces() {
- obj_types.clear();
- List<StringName> class_list;
- ClassDB::get_class_list(&class_list);
- class_list.sort_custom<StringName::AlphCompare>();
- while (class_list.size()) {
- StringName type_cname = class_list.front()->get();
- ClassDB::APIType api_type = ClassDB::get_api_type(type_cname);
- if (api_type == ClassDB::API_NONE) {
- class_list.pop_front();
- continue;
- }
- if (!ClassDB::is_class_exposed(type_cname)) {
- _log("Ignoring type '%s' because it's not exposed\n", String(type_cname).utf8().get_data());
- class_list.pop_front();
- continue;
- }
- if (!ClassDB::is_class_enabled(type_cname)) {
- _log("Ignoring type '%s' because it's not enabled\n", String(type_cname).utf8().get_data());
- class_list.pop_front();
- continue;
- }
- ClassDB::ClassInfo *class_info = ClassDB::classes.getptr(type_cname);
- TypeInterface itype = TypeInterface::create_object_type(type_cname, api_type);
- itype.base_name = ClassDB::get_parent_class(type_cname);
- itype.is_singleton = Engine::get_singleton()->has_singleton(itype.proxy_name);
- itype.is_instantiable = class_info->creation_func && !itype.is_singleton;
- itype.is_reference = ClassDB::is_parent_class(type_cname, name_cache.type_Reference);
- itype.memory_own = itype.is_reference;
- itype.c_out = "\treturn ";
- itype.c_out += C_METHOD_UNMANAGED_GET_MANAGED;
- itype.c_out += itype.is_reference ? "(%1.ptr());\n" : "(%1);\n";
- itype.cs_in = itype.is_singleton ? BINDINGS_PTR_FIELD : "Object." CS_SMETHOD_GETINSTANCE "(%0)";
- itype.c_type = "Object*";
- itype.c_type_in = itype.c_type;
- itype.c_type_out = "MonoObject*";
- itype.cs_type = itype.proxy_name;
- itype.im_type_in = "IntPtr";
- itype.im_type_out = itype.proxy_name;
- // Populate properties
- List<PropertyInfo> property_list;
- ClassDB::get_property_list(type_cname, &property_list, true);
- Map<StringName, StringName> accessor_methods;
- for (const List<PropertyInfo>::Element *E = property_list.front(); E; E = E->next()) {
- const PropertyInfo &property = E->get();
- if (property.usage & PROPERTY_USAGE_GROUP || property.usage & PROPERTY_USAGE_CATEGORY)
- continue;
- PropertyInterface iprop;
- iprop.cname = property.name;
- iprop.setter = ClassDB::get_property_setter(type_cname, iprop.cname);
- iprop.getter = ClassDB::get_property_getter(type_cname, iprop.cname);
- if (iprop.setter != StringName())
- accessor_methods[iprop.setter] = iprop.cname;
- if (iprop.getter != StringName())
- accessor_methods[iprop.getter] = iprop.cname;
- bool valid = false;
- iprop.index = ClassDB::get_property_index(type_cname, iprop.cname, &valid);
- ERR_FAIL_COND_V(!valid, false);
- iprop.proxy_name = escape_csharp_keyword(snake_to_pascal_case(iprop.cname));
- // Prevent the property and its enclosing type from sharing the same name
- if (iprop.proxy_name == itype.proxy_name) {
- _log("Name of property '%s' is ambiguous with the name of its enclosing class '%s'. Renaming property to '%s_'\n",
- iprop.proxy_name.utf8().get_data(), itype.proxy_name.utf8().get_data(), iprop.proxy_name.utf8().get_data());
- iprop.proxy_name += "_";
- }
- iprop.proxy_name = iprop.proxy_name.replace("/", "__"); // Some members have a slash...
- iprop.prop_doc = NULL;
- for (int i = 0; i < itype.class_doc->properties.size(); i++) {
- const DocData::PropertyDoc &prop_doc = itype.class_doc->properties[i];
- if (prop_doc.name == iprop.cname) {
- iprop.prop_doc = &prop_doc;
- break;
- }
- }
- itype.properties.push_back(iprop);
- }
- // Populate methods
- List<MethodInfo> virtual_method_list;
- ClassDB::get_virtual_methods(type_cname, &virtual_method_list, true);
- List<MethodInfo> method_list;
- ClassDB::get_method_list(type_cname, &method_list, true);
- method_list.sort();
- for (List<MethodInfo>::Element *E = method_list.front(); E; E = E->next()) {
- const MethodInfo &method_info = E->get();
- int argc = method_info.arguments.size();
- if (method_info.name.empty())
- continue;
- String cname = method_info.name;
- if (blacklisted_methods.find(itype.cname) && blacklisted_methods[itype.cname].find(cname))
- continue;
- MethodInterface imethod;
- imethod.name = method_info.name;
- imethod.cname = cname;
- if (method_info.flags & METHOD_FLAG_VIRTUAL)
- imethod.is_virtual = true;
- PropertyInfo return_info = method_info.return_val;
- MethodBind *m = imethod.is_virtual ? NULL : ClassDB::get_method(type_cname, method_info.name);
- imethod.is_vararg = m && m->is_vararg();
- if (!m && !imethod.is_virtual) {
- ERR_FAIL_COND_V_MSG(!virtual_method_list.find(method_info), false,
- "Missing MethodBind for non-virtual method: '" + itype.name + "." + imethod.name + "'.");
- // A virtual method without the virtual flag. This is a special case.
- // There is no method bind, so let's fallback to Godot's object.Call(string, params)
- imethod.requires_object_call = true;
- // The method Object.free is registered as a virtual method, but without the virtual flag.
- // This is because this method is not supposed to be overridden, but called.
- // We assume the return type is void.
- imethod.return_type.cname = name_cache.type_void;
- // Actually, more methods like this may be added in the future,
- // which could actually will return something different.
- // Let's put this to notify us if that ever happens.
- if (itype.cname != name_cache.type_Object || imethod.name != "free") {
- WARN_PRINT("Notification: New unexpected virtual non-overridable method found."
- " We only expected Object.free, but found '" +
- itype.name + "." + imethod.name + "'.");
- }
- } else if (return_info.type == Variant::INT && return_info.usage & PROPERTY_USAGE_CLASS_IS_ENUM) {
- imethod.return_type.cname = return_info.class_name;
- imethod.return_type.is_enum = true;
- } else if (return_info.class_name != StringName()) {
- imethod.return_type.cname = return_info.class_name;
- if (!imethod.is_virtual && ClassDB::is_parent_class(return_info.class_name, name_cache.type_Reference) && return_info.hint != PROPERTY_HINT_RESOURCE_TYPE) {
- /* clang-format off */
- ERR_PRINT("Return type is reference but hint is not '" _STR(PROPERTY_HINT_RESOURCE_TYPE) "'."
- " Are you returning a reference type by pointer? Method: '" + itype.name + "." + imethod.name + "'.");
- /* clang-format on */
- ERR_FAIL_V(false);
- }
- } else if (return_info.hint == PROPERTY_HINT_RESOURCE_TYPE) {
- imethod.return_type.cname = return_info.hint_string;
- } else if (return_info.type == Variant::NIL && return_info.usage & PROPERTY_USAGE_NIL_IS_VARIANT) {
- imethod.return_type.cname = name_cache.type_Variant;
- } else if (return_info.type == Variant::NIL) {
- imethod.return_type.cname = name_cache.type_void;
- } else {
- if (return_info.type == Variant::INT) {
- imethod.return_type.cname = _get_int_type_name_from_meta(m ? m->get_argument_meta(-1) : GodotTypeInfo::METADATA_NONE);
- } else if (return_info.type == Variant::REAL) {
- imethod.return_type.cname = _get_float_type_name_from_meta(m ? m->get_argument_meta(-1) : GodotTypeInfo::METADATA_NONE);
- } else {
- imethod.return_type.cname = Variant::get_type_name(return_info.type);
- }
- }
- for (int i = 0; i < argc; i++) {
- PropertyInfo arginfo = method_info.arguments[i];
- String orig_arg_name = arginfo.name;
- ArgumentInterface iarg;
- iarg.name = orig_arg_name;
- if (arginfo.type == Variant::INT && arginfo.usage & PROPERTY_USAGE_CLASS_IS_ENUM) {
- iarg.type.cname = arginfo.class_name;
- iarg.type.is_enum = true;
- } else if (arginfo.class_name != StringName()) {
- iarg.type.cname = arginfo.class_name;
- } else if (arginfo.hint == PROPERTY_HINT_RESOURCE_TYPE) {
- iarg.type.cname = arginfo.hint_string;
- } else if (arginfo.type == Variant::NIL) {
- iarg.type.cname = name_cache.type_Variant;
- } else {
- if (arginfo.type == Variant::INT) {
- iarg.type.cname = _get_int_type_name_from_meta(m ? m->get_argument_meta(i) : GodotTypeInfo::METADATA_NONE);
- } else if (arginfo.type == Variant::REAL) {
- iarg.type.cname = _get_float_type_name_from_meta(m ? m->get_argument_meta(i) : GodotTypeInfo::METADATA_NONE);
- } else {
- iarg.type.cname = Variant::get_type_name(arginfo.type);
- }
- }
- iarg.name = escape_csharp_keyword(snake_to_camel_case(iarg.name));
- if (m && m->has_default_argument(i)) {
- bool defval_ok = _arg_default_value_from_variant(m->get_default_argument(i), iarg);
- ERR_FAIL_COND_V_MSG(!defval_ok, false,
- "Cannot determine default value for argument '" + orig_arg_name + "' of method '" + itype.name + "." + imethod.name + "'.");
- }
- imethod.add_argument(iarg);
- }
- if (imethod.is_vararg) {
- ArgumentInterface ivararg;
- ivararg.type.cname = name_cache.type_VarArg;
- ivararg.name = "@args";
- imethod.add_argument(ivararg);
- }
- imethod.proxy_name = escape_csharp_keyword(snake_to_pascal_case(imethod.name));
- // Prevent the method and its enclosing type from sharing the same name
- if (imethod.proxy_name == itype.proxy_name) {
- _log("Name of method '%s' is ambiguous with the name of its enclosing class '%s'. Renaming method to '%s_'\n",
- imethod.proxy_name.utf8().get_data(), itype.proxy_name.utf8().get_data(), imethod.proxy_name.utf8().get_data());
- imethod.proxy_name += "_";
- }
- Map<StringName, StringName>::Element *accessor = accessor_methods.find(imethod.cname);
- if (accessor) {
- const PropertyInterface *accessor_property = itype.find_property_by_name(accessor->value());
- // We only deprecate an accessor method if it's in the same class as the property. It's easier this way, but also
- // we don't know if an accessor method in a different class could have other purposes, so better leave those untouched.
- imethod.is_deprecated = true;
- imethod.deprecation_message = imethod.proxy_name + " is deprecated. Use the " + accessor_property->proxy_name + " property instead.";
- }
- if (itype.class_doc) {
- for (int i = 0; i < itype.class_doc->methods.size(); i++) {
- if (itype.class_doc->methods[i].name == imethod.name) {
- imethod.method_doc = &itype.class_doc->methods[i];
- break;
- }
- }
- }
- if (!imethod.is_virtual && imethod.name[0] == '_') {
- for (const List<PropertyInterface>::Element *F = itype.properties.front(); F; F = F->next()) {
- const PropertyInterface &iprop = F->get();
- if (iprop.setter == imethod.name || iprop.getter == imethod.name) {
- imethod.is_internal = true;
- itype.methods.push_back(imethod);
- break;
- }
- }
- } else {
- itype.methods.push_back(imethod);
- }
- }
- // Populate enums and constants
- List<String> constants;
- ClassDB::get_integer_constant_list(type_cname, &constants, true);
- const HashMap<StringName, List<StringName>> &enum_map = class_info->enum_map;
- const StringName *k = NULL;
- while ((k = enum_map.next(k))) {
- StringName enum_proxy_cname = *k;
- String enum_proxy_name = enum_proxy_cname.operator String();
- if (itype.find_property_by_proxy_name(enum_proxy_cname)) {
- // We have several conflicts between enums and PascalCase properties,
- // so we append 'Enum' to the enum name in those cases.
- enum_proxy_name += "Enum";
- enum_proxy_cname = StringName(enum_proxy_name);
- }
- EnumInterface ienum(enum_proxy_cname);
- const List<StringName> &enum_constants = enum_map.get(*k);
- for (const List<StringName>::Element *E = enum_constants.front(); E; E = E->next()) {
- const StringName &constant_cname = E->get();
- String constant_name = constant_cname.operator String();
- int *value = class_info->constant_map.getptr(constant_cname);
- ERR_FAIL_NULL_V(value, false);
- constants.erase(constant_name);
- ConstantInterface iconstant(constant_name, snake_to_pascal_case(constant_name, true), *value);
- iconstant.const_doc = NULL;
- for (int i = 0; i < itype.class_doc->constants.size(); i++) {
- const DocData::ConstantDoc &const_doc = itype.class_doc->constants[i];
- if (const_doc.name == iconstant.name) {
- iconstant.const_doc = &const_doc;
- break;
- }
- }
- ienum.constants.push_back(iconstant);
- }
- int prefix_length = _determine_enum_prefix(ienum);
- _apply_prefix_to_enum_constants(ienum, prefix_length);
- itype.enums.push_back(ienum);
- TypeInterface enum_itype;
- enum_itype.is_enum = true;
- enum_itype.name = itype.name + "." + String(*k);
- enum_itype.cname = StringName(enum_itype.name);
- enum_itype.proxy_name = itype.proxy_name + "." + enum_proxy_name;
- TypeInterface::postsetup_enum_type(enum_itype);
- enum_types.insert(enum_itype.cname, enum_itype);
- }
- for (const List<String>::Element *E = constants.front(); E; E = E->next()) {
- const String &constant_name = E->get();
- int *value = class_info->constant_map.getptr(StringName(E->get()));
- ERR_FAIL_NULL_V(value, false);
- ConstantInterface iconstant(constant_name, snake_to_pascal_case(constant_name, true), *value);
- iconstant.const_doc = NULL;
- for (int i = 0; i < itype.class_doc->constants.size(); i++) {
- const DocData::ConstantDoc &const_doc = itype.class_doc->constants[i];
- if (const_doc.name == iconstant.name) {
- iconstant.const_doc = &const_doc;
- break;
- }
- }
- itype.constants.push_back(iconstant);
- }
- obj_types.insert(itype.cname, itype);
- class_list.pop_front();
- }
- return true;
- }
- bool BindingsGenerator::_arg_default_value_from_variant(const Variant &p_val, ArgumentInterface &r_iarg) {
- r_iarg.default_argument = p_val;
- switch (p_val.get_type()) {
- case Variant::NIL:
- // Either Object type or Variant
- r_iarg.default_argument = "null";
- break;
- // Atomic types
- case Variant::BOOL:
- r_iarg.default_argument = bool(p_val) ? "true" : "false";
- break;
- case Variant::INT:
- if (r_iarg.type.cname != name_cache.type_int) {
- r_iarg.default_argument = "(%s)" + r_iarg.default_argument;
- }
- break;
- case Variant::REAL:
- if (r_iarg.type.cname == "float") {
- r_iarg.default_argument += "f";
- }
- break;
- case Variant::STRING:
- case Variant::NODE_PATH:
- if (r_iarg.type.cname == name_cache.type_NodePath) {
- r_iarg.default_argument = "(%s)\"" + r_iarg.default_argument + "\"";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_REF;
- } else {
- CRASH_COND(r_iarg.type.cname != name_cache.type_String);
- r_iarg.default_argument = "\"" + r_iarg.default_argument + "\"";
- }
- break;
- case Variant::PLANE: {
- Plane plane = p_val.operator Plane();
- r_iarg.default_argument = "new Plane(new Vector3(" + plane.normal.operator String() + "), " + rtos(plane.d) + ")";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::AABB: {
- AABB aabb = p_val.operator ::AABB();
- r_iarg.default_argument = "new AABB(new Vector3(" + aabb.position.operator String() + "), new Vector3(" + aabb.size.operator String() + "))";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::RECT2: {
- Rect2 rect = p_val.operator Rect2();
- r_iarg.default_argument = "new Rect2(new Vector2(" + rect.position.operator String() + "), new Vector2(" + rect.size.operator String() + "))";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::COLOR: {
- if (r_iarg.default_argument == "1,1,1,1") {
- r_iarg.default_argument = "1, 1, 1, 1";
- }
- r_iarg.default_argument = "new Color(" + r_iarg.default_argument + ")";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::VECTOR2:
- case Variant::VECTOR3:
- r_iarg.default_argument = "new %s" + r_iarg.default_argument;
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- break;
- case Variant::OBJECT:
- ERR_FAIL_COND_V_MSG(!p_val.is_zero(), false,
- "Parameter of type '" + String(r_iarg.type.cname) + "' can only have null/zero as the default value.");
- r_iarg.default_argument = "null";
- break;
- case Variant::DICTIONARY:
- r_iarg.default_argument = "new %s()";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_REF;
- break;
- case Variant::_RID:
- ERR_FAIL_COND_V_MSG(r_iarg.type.cname != name_cache.type_RID, false,
- "Parameter of type '" + String(r_iarg.type.cname) + "' cannot have a default value of type '" + String(name_cache.type_RID) + "'.");
- ERR_FAIL_COND_V_MSG(!p_val.is_zero(), false,
- "Parameter of type '" + String(r_iarg.type.cname) + "' can only have null/zero as the default value.");
- r_iarg.default_argument = "null";
- break;
- case Variant::ARRAY:
- r_iarg.default_argument = "new %s { }";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_REF;
- break;
- case Variant::POOL_BYTE_ARRAY:
- case Variant::POOL_INT_ARRAY:
- case Variant::POOL_REAL_ARRAY:
- case Variant::POOL_STRING_ARRAY:
- case Variant::POOL_VECTOR2_ARRAY:
- case Variant::POOL_VECTOR3_ARRAY:
- case Variant::POOL_COLOR_ARRAY:
- r_iarg.default_argument = "Array.Empty<%s>()";
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_REF;
- break;
- case Variant::TRANSFORM2D: {
- Transform2D transform = p_val.operator Transform2D();
- if (transform == Transform2D()) {
- r_iarg.default_argument = "Transform2D.Identity";
- } else {
- r_iarg.default_argument = "new Transform2D(new Vector2" + transform.elements[0].operator String() + ", new Vector2" + transform.elements[1].operator String() + ", new Vector2" + transform.elements[2].operator String() + ")";
- }
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::TRANSFORM: {
- Transform transform = p_val.operator Transform();
- if (transform == Transform()) {
- r_iarg.default_argument = "Transform.Identity";
- } else {
- Basis basis = transform.basis;
- r_iarg.default_argument = "new Transform(new Vector3" + basis.get_column(0).operator String() + ", new Vector3" + basis.get_column(1).operator String() + ", new Vector3" + basis.get_column(2).operator String() + ", new Vector3" + transform.origin.operator String() + ")";
- }
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::BASIS: {
- Basis basis = p_val.operator Basis();
- if (basis == Basis()) {
- r_iarg.default_argument = "Basis.Identity";
- } else {
- r_iarg.default_argument = "new Basis(new Vector3" + basis.get_column(0).operator String() + ", new Vector3" + basis.get_column(1).operator String() + ", new Vector3" + basis.get_column(2).operator String() + ")";
- }
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- case Variant::QUAT: {
- Quat quat = p_val.operator Quat();
- if (quat == Quat()) {
- r_iarg.default_argument = "Quat.Identity";
- } else {
- r_iarg.default_argument = "new Quat" + quat.operator String();
- }
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_VAL;
- } break;
- default:
- CRASH_NOW_MSG("Unexpected Variant type: " + itos(p_val.get_type()));
- break;
- }
- if (r_iarg.def_param_mode == ArgumentInterface::CONSTANT && r_iarg.type.cname == name_cache.type_Variant && r_iarg.default_argument != "null")
- r_iarg.def_param_mode = ArgumentInterface::NULLABLE_REF;
- return true;
- }
- void BindingsGenerator::_populate_builtin_type_interfaces() {
- builtin_types.clear();
- TypeInterface itype;
- #define INSERT_STRUCT_TYPE(m_type) \
- { \
- itype = TypeInterface::create_value_type(String(#m_type)); \
- itype.c_in = "\t%0 %1_in = MARSHALLED_IN(" #m_type ", %1);\n"; \
- itype.c_out = "\t*%3 = MARSHALLED_OUT(" #m_type ", %1);\n"; \
- itype.c_arg_in = "&%s_in"; \
- itype.c_type_in = "GDMonoMarshal::M_" #m_type "*"; \
- itype.c_type_out = "GDMonoMarshal::M_" #m_type; \
- itype.cs_in = "ref %s"; \
- /* in cs_out, im_type_out (%3) includes the 'out ' part */ \
- itype.cs_out = "%0(%1, %3 argRet); return (%2)argRet;"; \
- itype.im_type_out = "out " + itype.cs_type; \
- itype.ret_as_byref_arg = true; \
- builtin_types.insert(itype.cname, itype); \
- }
- INSERT_STRUCT_TYPE(Vector2)
- INSERT_STRUCT_TYPE(Rect2)
- INSERT_STRUCT_TYPE(Transform2D)
- INSERT_STRUCT_TYPE(Vector3)
- INSERT_STRUCT_TYPE(Basis)
- INSERT_STRUCT_TYPE(Quat)
- INSERT_STRUCT_TYPE(Transform)
- INSERT_STRUCT_TYPE(AABB)
- INSERT_STRUCT_TYPE(Color)
- INSERT_STRUCT_TYPE(Plane)
- #undef INSERT_STRUCT_TYPE
- // bool
- itype = TypeInterface::create_value_type(String("bool"));
- {
- // MonoBoolean <---> bool
- itype.c_in = "\t%0 %1_in = (%0)%1;\n";
- itype.c_out = "\treturn (%0)%1;\n";
- itype.c_type = "bool";
- itype.c_type_in = "MonoBoolean";
- itype.c_type_out = itype.c_type_in;
- itype.c_arg_in = "&%s_in";
- }
- itype.im_type_in = itype.name;
- itype.im_type_out = itype.name;
- builtin_types.insert(itype.cname, itype);
- // Integer types
- {
- // C interface for 'uint32_t' is the same as that of enums. Remember to apply
- // any of the changes done here to 'TypeInterface::postsetup_enum_type' as well.
- #define INSERT_INT_TYPE(m_name, m_c_type_in_out, m_c_type) \
- { \
- itype = TypeInterface::create_value_type(String(m_name)); \
- { \
- itype.c_in = "\t%0 %1_in = (%0)%1;\n"; \
- itype.c_out = "\treturn (%0)%1;\n"; \
- itype.c_type = #m_c_type; \
- itype.c_arg_in = "&%s_in"; \
- } \
- itype.c_type_in = #m_c_type_in_out; \
- itype.c_type_out = itype.c_type_in; \
- itype.im_type_in = itype.name; \
- itype.im_type_out = itype.name; \
- builtin_types.insert(itype.cname, itype); \
- }
- // The expected type for all integers in ptrcall is 'int64_t', so that's what we use for 'c_type'
- INSERT_INT_TYPE("sbyte", int8_t, int64_t);
- INSERT_INT_TYPE("short", int16_t, int64_t);
- INSERT_INT_TYPE("int", int32_t, int64_t);
- INSERT_INT_TYPE("long", int64_t, int64_t);
- INSERT_INT_TYPE("byte", uint8_t, int64_t);
- INSERT_INT_TYPE("ushort", uint16_t, int64_t);
- INSERT_INT_TYPE("uint", uint32_t, int64_t);
- INSERT_INT_TYPE("ulong", uint64_t, int64_t);
- }
- // Floating point types
- {
- // float
- itype = TypeInterface();
- itype.name = "float";
- itype.cname = itype.name;
- itype.proxy_name = "float";
- {
- // The expected type for 'float' in ptrcall is 'double'
- itype.c_in = "\t%0 %1_in = (%0)%1;\n";
- itype.c_out = "\treturn (%0)%1;\n";
- itype.c_type = "double";
- itype.c_type_in = "float";
- itype.c_type_out = "float";
- itype.c_arg_in = "&%s_in";
- }
- itype.cs_type = itype.proxy_name;
- itype.im_type_in = itype.proxy_name;
- itype.im_type_out = itype.proxy_name;
- builtin_types.insert(itype.cname, itype);
- // double
- itype = TypeInterface();
- itype.name = "double";
- itype.cname = itype.name;
- itype.proxy_name = "double";
- {
- itype.c_type = "double";
- itype.c_type_in = "double";
- itype.c_type_out = "double";
- itype.c_arg_in = "&%s";
- }
- itype.cs_type = itype.proxy_name;
- itype.im_type_in = itype.proxy_name;
- itype.im_type_out = itype.proxy_name;
- builtin_types.insert(itype.cname, itype);
- }
- // String
- itype = TypeInterface();
- itype.name = "String";
- itype.cname = itype.name;
- itype.proxy_name = "string";
- itype.c_in = "\t%0 %1_in = " C_METHOD_MONOSTR_TO_GODOT "(%1);\n";
- itype.c_out = "\treturn " C_METHOD_MONOSTR_FROM_GODOT "(%1);\n";
- itype.c_arg_in = "&%s_in";
- itype.c_type = itype.name;
- itype.c_type_in = "MonoString*";
- itype.c_type_out = "MonoString*";
- itype.cs_type = itype.proxy_name;
- itype.im_type_in = itype.proxy_name;
- itype.im_type_out = itype.proxy_name;
- builtin_types.insert(itype.cname, itype);
- // NodePath
- itype = TypeInterface();
- itype.name = "NodePath";
- itype.cname = itype.name;
- itype.proxy_name = "NodePath";
- itype.c_out = "\treturn memnew(NodePath(%1));\n";
- itype.c_type = itype.name;
- itype.c_type_in = itype.c_type + "*";
- itype.c_type_out = itype.c_type + "*";
- itype.cs_type = itype.proxy_name;
- itype.cs_in = "NodePath." CS_SMETHOD_GETINSTANCE "(%0)";
- itype.cs_out = "return new %2(%0(%1));";
- itype.im_type_in = "IntPtr";
- itype.im_type_out = "IntPtr";
- builtin_types.insert(itype.cname, itype);
- // RID
- itype = TypeInterface();
- itype.name = "RID";
- itype.cname = itype.name;
- itype.proxy_name = "RID";
- itype.c_out = "\treturn memnew(RID(%1));\n";
- itype.c_type = itype.name;
- itype.c_type_in = itype.c_type + "*";
- itype.c_type_out = itype.c_type + "*";
- itype.cs_type = itype.proxy_name;
- itype.cs_in = "RID." CS_SMETHOD_GETINSTANCE "(%0)";
- itype.cs_out = "return new %2(%0(%1));";
- itype.im_type_in = "IntPtr";
- itype.im_type_out = "IntPtr";
- builtin_types.insert(itype.cname, itype);
- // Variant
- itype = TypeInterface();
- itype.name = "Variant";
- itype.cname = itype.name;
- itype.proxy_name = "object";
- itype.c_in = "\t%0 %1_in = " C_METHOD_MANAGED_TO_VARIANT "(%1);\n";
- itype.c_out = "\treturn " C_METHOD_MANAGED_FROM_VARIANT "(%1);\n";
- itype.c_arg_in = "&%s_in";
- itype.c_type = itype.name;
- itype.c_type_in = "MonoObject*";
- itype.c_type_out = "MonoObject*";
- itype.cs_type = itype.proxy_name;
- itype.im_type_in = "object";
- itype.im_type_out = itype.proxy_name;
- builtin_types.insert(itype.cname, itype);
- // VarArg (fictitious type to represent variable arguments)
- itype = TypeInterface();
- itype.name = "VarArg";
- itype.cname = itype.name;
- itype.proxy_name = "object[]";
- itype.c_in = "\t%0 %1_in = " C_METHOD_MONOARRAY_TO(Array) "(%1);\n";
- itype.c_arg_in = "&%s_in";
- itype.c_type = "Array";
- itype.c_type_in = "MonoArray*";
- itype.cs_type = "params object[]";
- itype.im_type_in = "object[]";
- builtin_types.insert(itype.cname, itype);
- #define INSERT_ARRAY_FULL(m_name, m_type, m_proxy_t) \
- { \
- itype = TypeInterface(); \
- itype.name = #m_name; \
- itype.cname = itype.name; \
- itype.proxy_name = #m_proxy_t "[]"; \
- itype.c_in = "\t%0 %1_in = " C_METHOD_MONOARRAY_TO(m_type) "(%1);\n"; \
- itype.c_out = "\treturn " C_METHOD_MONOARRAY_FROM(m_type) "(%1);\n"; \
- itype.c_arg_in = "&%s_in"; \
- itype.c_type = #m_type; \
- itype.c_type_in = "MonoArray*"; \
- itype.c_type_out = "MonoArray*"; \
- itype.cs_type = itype.proxy_name; \
- itype.im_type_in = itype.proxy_name; \
- itype.im_type_out = itype.proxy_name; \
- builtin_types.insert(itype.name, itype); \
- }
- #define INSERT_ARRAY(m_type, m_proxy_t) INSERT_ARRAY_FULL(m_type, m_type, m_proxy_t)
- INSERT_ARRAY(PoolIntArray, int);
- INSERT_ARRAY_FULL(PoolByteArray, PoolByteArray, byte);
- #ifdef REAL_T_IS_DOUBLE
- INSERT_ARRAY(PoolRealArray, double);
- #else
- INSERT_ARRAY(PoolRealArray, float);
- #endif
- INSERT_ARRAY(PoolStringArray, string);
- INSERT_ARRAY(PoolColorArray, Color);
- INSERT_ARRAY(PoolVector2Array, Vector2);
- INSERT_ARRAY(PoolVector3Array, Vector3);
- #undef INSERT_ARRAY
- // Array
- itype = TypeInterface();
- itype.name = "Array";
- itype.cname = itype.name;
- itype.proxy_name = itype.name;
- itype.c_out = "\treturn memnew(Array(%1));\n";
- itype.c_type = itype.name;
- itype.c_type_in = itype.c_type + "*";
- itype.c_type_out = itype.c_type + "*";
- itype.cs_type = BINDINGS_NAMESPACE_COLLECTIONS "." + itype.proxy_name;
- itype.cs_in = "%0." CS_SMETHOD_GETINSTANCE "()";
- itype.cs_out = "return new " + itype.cs_type + "(%0(%1));";
- itype.im_type_in = "IntPtr";
- itype.im_type_out = "IntPtr";
- builtin_types.insert(itype.cname, itype);
- // Dictionary
- itype = TypeInterface();
- itype.name = "Dictionary";
- itype.cname = itype.name;
- itype.proxy_name = itype.name;
- itype.c_out = "\treturn memnew(Dictionary(%1));\n";
- itype.c_type = itype.name;
- itype.c_type_in = itype.c_type + "*";
- itype.c_type_out = itype.c_type + "*";
- itype.cs_type = BINDINGS_NAMESPACE_COLLECTIONS "." + itype.proxy_name;
- itype.cs_in = "%0." CS_SMETHOD_GETINSTANCE "()";
- itype.cs_out = "return new " + itype.cs_type + "(%0(%1));";
- itype.im_type_in = "IntPtr";
- itype.im_type_out = "IntPtr";
- builtin_types.insert(itype.cname, itype);
- // void (fictitious type to represent the return type of methods that do not return anything)
- itype = TypeInterface();
- itype.name = "void";
- itype.cname = itype.name;
- itype.proxy_name = itype.name;
- itype.c_type = itype.name;
- itype.c_type_in = itype.c_type;
- itype.c_type_out = itype.c_type;
- itype.cs_type = itype.proxy_name;
- itype.im_type_in = itype.proxy_name;
- itype.im_type_out = itype.proxy_name;
- builtin_types.insert(itype.cname, itype);
- }
- void BindingsGenerator::_populate_global_constants() {
- int global_constants_count = GlobalConstants::get_global_constant_count();
- if (global_constants_count > 0) {
- Map<String, DocData::ClassDoc>::Element *match = EditorHelp::get_doc_data()->class_list.find("@GlobalScope");
- CRASH_COND_MSG(!match, "Could not find '@GlobalScope' in DocData.");
- const DocData::ClassDoc &global_scope_doc = match->value();
- for (int i = 0; i < global_constants_count; i++) {
- String constant_name = GlobalConstants::get_global_constant_name(i);
- const DocData::ConstantDoc *const_doc = NULL;
- for (int j = 0; j < global_scope_doc.constants.size(); j++) {
- const DocData::ConstantDoc &curr_const_doc = global_scope_doc.constants[j];
- if (curr_const_doc.name == constant_name) {
- const_doc = &curr_const_doc;
- break;
- }
- }
- int constant_value = GlobalConstants::get_global_constant_value(i);
- StringName enum_name = GlobalConstants::get_global_constant_enum(i);
- ConstantInterface iconstant(constant_name, snake_to_pascal_case(constant_name, true), constant_value);
- iconstant.const_doc = const_doc;
- if (enum_name != StringName()) {
- EnumInterface ienum(enum_name);
- List<EnumInterface>::Element *enum_match = global_enums.find(ienum);
- if (enum_match) {
- enum_match->get().constants.push_back(iconstant);
- } else {
- ienum.constants.push_back(iconstant);
- global_enums.push_back(ienum);
- }
- } else {
- global_constants.push_back(iconstant);
- }
- }
- for (List<EnumInterface>::Element *E = global_enums.front(); E; E = E->next()) {
- EnumInterface &ienum = E->get();
- TypeInterface enum_itype;
- enum_itype.is_enum = true;
- enum_itype.name = ienum.cname.operator String();
- enum_itype.cname = ienum.cname;
- enum_itype.proxy_name = enum_itype.name;
- TypeInterface::postsetup_enum_type(enum_itype);
- enum_types.insert(enum_itype.cname, enum_itype);
- int prefix_length = _determine_enum_prefix(ienum);
- // HARDCODED: The Error enum have the prefix 'ERR_' for everything except 'OK' and 'FAILED'.
- if (ienum.cname == name_cache.enum_Error) {
- if (prefix_length > 0) { // Just in case it ever changes
- ERR_PRINT("Prefix for enum '" _STR(Error) "' is not empty.");
- }
- prefix_length = 1; // 'ERR_'
- }
- _apply_prefix_to_enum_constants(ienum, prefix_length);
- }
- }
- // HARDCODED
- List<StringName> hardcoded_enums;
- hardcoded_enums.push_back("Vector3.Axis");
- for (List<StringName>::Element *E = hardcoded_enums.front(); E; E = E->next()) {
- // These enums are not generated and must be written manually (e.g.: Vector3.Axis)
- // Here, we assume core types do not begin with underscore
- TypeInterface enum_itype;
- enum_itype.is_enum = true;
- enum_itype.name = E->get().operator String();
- enum_itype.cname = E->get();
- enum_itype.proxy_name = enum_itype.name;
- TypeInterface::postsetup_enum_type(enum_itype);
- enum_types.insert(enum_itype.cname, enum_itype);
- }
- }
- void BindingsGenerator::_initialize_blacklisted_methods() {
- blacklisted_methods["Object"].push_back("to_string"); // there is already ToString
- blacklisted_methods["Object"].push_back("_to_string"); // override ToString instead
- blacklisted_methods["Object"].push_back("_init"); // never called in C# (TODO: implement it)
- }
- void BindingsGenerator::_log(const char *p_format, ...) {
- if (log_print_enabled) {
- va_list list;
- va_start(list, p_format);
- OS::get_singleton()->print("%s", str_format(p_format, list).utf8().get_data());
- va_end(list);
- }
- }
- void BindingsGenerator::_initialize() {
- initialized = false;
- EditorHelp::generate_doc();
- enum_types.clear();
- _initialize_blacklisted_methods();
- bool obj_type_ok = _populate_object_type_interfaces();
- ERR_FAIL_COND_MSG(!obj_type_ok, "Failed to generate object type interfaces");
- _populate_builtin_type_interfaces();
- _populate_global_constants();
- // Generate internal calls (after populating type interfaces and global constants)
- core_custom_icalls.clear();
- editor_custom_icalls.clear();
- for (OrderedHashMap<StringName, TypeInterface>::Element E = obj_types.front(); E; E = E.next())
- _generate_method_icalls(E.get());
- initialized = true;
- }
- static String generate_all_glue_option = "--generate-mono-glue";
- static String generate_cs_glue_option = "--generate-mono-cs-glue";
- static String generate_cpp_glue_option = "--generate-mono-cpp-glue";
- static void handle_cmdline_options(String glue_dir_path, String cs_dir_path, String cpp_dir_path) {
- BindingsGenerator bindings_generator;
- bindings_generator.set_log_print_enabled(true);
- if (!bindings_generator.is_initialized()) {
- ERR_PRINT("Failed to initialize the bindings generator");
- return;
- }
- if (glue_dir_path.length()) {
- if (bindings_generator.generate_glue(glue_dir_path) != OK) {
- ERR_PRINT(generate_all_glue_option + ": Failed to generate the C++ glue.");
- }
- if (bindings_generator.generate_cs_api(glue_dir_path.plus_file(API_SOLUTION_NAME)) != OK) {
- ERR_PRINT(generate_all_glue_option + ": Failed to generate the C# API.");
- }
- }
- if (cs_dir_path.length()) {
- if (bindings_generator.generate_cs_api(cs_dir_path) != OK) {
- ERR_PRINT(generate_cs_glue_option + ": Failed to generate the C# API.");
- }
- }
- if (cpp_dir_path.length()) {
- if (bindings_generator.generate_glue(cpp_dir_path) != OK) {
- ERR_PRINT(generate_cpp_glue_option + ": Failed to generate the C++ glue.");
- }
- }
- }
- void BindingsGenerator::handle_cmdline_args(const List<String> &p_cmdline_args) {
- const int NUM_OPTIONS = 2;
- String glue_dir_path;
- String cs_dir_path;
- String cpp_dir_path;
- int options_left = NUM_OPTIONS;
- bool exit_godot = false;
- const List<String>::Element *elem = p_cmdline_args.front();
- while (elem && options_left) {
- if (elem->get() == generate_all_glue_option) {
- const List<String>::Element *path_elem = elem->next();
- if (path_elem) {
- glue_dir_path = path_elem->get();
- elem = elem->next();
- } else {
- ERR_PRINT(generate_all_glue_option + ": No output directory specified (expected path to '{GODOT_ROOT}/modules/mono/glue').");
- exit_godot = true;
- }
- --options_left;
- } else if (elem->get() == generate_cs_glue_option) {
- const List<String>::Element *path_elem = elem->next();
- if (path_elem) {
- cs_dir_path = path_elem->get();
- elem = elem->next();
- } else {
- ERR_PRINT(generate_cs_glue_option + ": No output directory specified.");
- exit_godot = true;
- }
- --options_left;
- } else if (elem->get() == generate_cpp_glue_option) {
- const List<String>::Element *path_elem = elem->next();
- if (path_elem) {
- cpp_dir_path = path_elem->get();
- elem = elem->next();
- } else {
- ERR_PRINT(generate_cpp_glue_option + ": No output directory specified.");
- exit_godot = true;
- }
- --options_left;
- }
- elem = elem->next();
- }
- if (glue_dir_path.length() || cs_dir_path.length() || cpp_dir_path.length()) {
- handle_cmdline_options(glue_dir_path, cs_dir_path, cpp_dir_path);
- exit_godot = true;
- }
- if (exit_godot) {
- // Exit once done
- Main::cleanup(true);
- ::exit(0);
- }
- }
- #endif
|