binding_generator.py 61 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622
  1. #!/usr/bin/env python
  2. import json
  3. import re
  4. import shutil
  5. from pathlib import Path
  6. def print_file_list(api_filepath, output_dir, headers=False, sources=False):
  7. api = {}
  8. end = ";"
  9. with open(api_filepath) as api_file:
  10. api = json.load(api_file)
  11. include_gen_folder = Path(output_dir) / "gen" / "include" / "godot_cpp"
  12. source_gen_folder = Path(output_dir) / "gen" / "src"
  13. for builtin_class in api["builtin_classes"]:
  14. if is_pod_type(builtin_class["name"]):
  15. continue
  16. header_filename = include_gen_folder / "variant" / (camel_to_snake(builtin_class["name"]) + ".hpp")
  17. source_filename = source_gen_folder / "variant" / (camel_to_snake(builtin_class["name"]) + ".cpp")
  18. if headers:
  19. print(str(header_filename.as_posix()), end=end)
  20. if sources:
  21. print(str(source_filename.as_posix()), end=end)
  22. for engine_class in api["classes"]:
  23. header_filename = include_gen_folder / "classes" / (camel_to_snake(engine_class["name"]) + ".hpp")
  24. source_filename = source_gen_folder / "classes" / (camel_to_snake(engine_class["name"]) + ".cpp")
  25. if headers:
  26. print(str(header_filename.as_posix()), end=end)
  27. if sources:
  28. print(str(source_filename.as_posix()), end=end)
  29. utility_functions_header_path = include_gen_folder / "variant" / "utility_functions.hpp"
  30. utility_functions_source_path = source_gen_folder / "variant" / "utility_functions.cpp"
  31. global_constants_header_path = include_gen_folder / "classes" / "global_constants.hpp"
  32. if headers:
  33. print(str(utility_functions_header_path.as_posix()), end=end)
  34. print(str(global_constants_header_path.as_posix()), end=end)
  35. if sources:
  36. print(str(utility_functions_source_path.as_posix()), end=end)
  37. def generate_bindings(api_filepath, use_template_get_node, output_dir="."):
  38. api = None
  39. target_dir = Path(output_dir) / "gen"
  40. with open(api_filepath) as api_file:
  41. api = json.load(api_file)
  42. shutil.rmtree(target_dir, ignore_errors=True)
  43. target_dir.mkdir(parents=True)
  44. generate_global_constants(api, target_dir)
  45. generate_builtin_bindings(api, target_dir, "float_64")
  46. generate_engine_classes_bindings(api, target_dir, use_template_get_node)
  47. generate_utility_functions(api, target_dir)
  48. builtin_classes = []
  49. # Key is class name, value is boolean where True means the class is refcounted.
  50. engine_classes = {}
  51. def generate_builtin_bindings(api, output_dir, build_config):
  52. global builtin_classes
  53. include_gen_folder = Path(output_dir) / "include" / "godot_cpp" / "variant"
  54. source_gen_folder = Path(output_dir) / "src" / "variant"
  55. include_gen_folder.mkdir(parents=True, exist_ok=True)
  56. source_gen_folder.mkdir(parents=True, exist_ok=True)
  57. # Store types beforehand.
  58. for builtin_api in api["builtin_classes"]:
  59. if is_pod_type(builtin_api["name"]):
  60. continue
  61. builtin_classes.append(builtin_api["name"])
  62. builtin_sizes = {}
  63. for size_list in api["builtin_class_sizes"]:
  64. if size_list["build_configuration"] == build_config:
  65. for size in size_list["sizes"]:
  66. builtin_sizes[size["name"]] = size["size"]
  67. break
  68. # Create a file for Variant size, since that class isn't generated.
  69. variant_size_filename = include_gen_folder / "variant_size.hpp"
  70. with variant_size_filename.open("+w") as variant_size_file:
  71. variant_size_source = []
  72. add_header("variant_size.hpp", variant_size_source)
  73. header_guard = "GODOT_CPP_VARIANT_SIZE_HPP"
  74. variant_size_source.append(f"#ifndef {header_guard}")
  75. variant_size_source.append(f"#define {header_guard}")
  76. variant_size_source.append(f'#define GODOT_CPP_VARIANT_SIZE {builtin_sizes["Variant"]}')
  77. variant_size_source.append(f"#endif // ! {header_guard}")
  78. variant_size_file.write("\n".join(variant_size_source))
  79. for builtin_api in api["builtin_classes"]:
  80. if is_pod_type(builtin_api["name"]):
  81. continue
  82. size = builtin_sizes[builtin_api["name"]]
  83. header_filename = include_gen_folder / (camel_to_snake(builtin_api["name"]) + ".hpp")
  84. source_filename = source_gen_folder / (camel_to_snake(builtin_api["name"]) + ".cpp")
  85. # Check used classes for header include
  86. used_classes = set()
  87. fully_used_classes = set()
  88. class_name = builtin_api["name"]
  89. if "constructors" in builtin_api:
  90. for constructor in builtin_api["constructors"]:
  91. if "arguments" in constructor:
  92. for argument in constructor["arguments"]:
  93. if is_included(argument["type"], class_name):
  94. if "default_value" in argument and argument["type"] != "Variant":
  95. fully_used_classes.add(argument["type"])
  96. else:
  97. used_classes.add(argument["type"])
  98. if "methods" in builtin_api:
  99. for method in builtin_api["methods"]:
  100. if "arguments" in method:
  101. for argument in method["arguments"]:
  102. if is_included(argument["type"], class_name):
  103. if "default_value" in argument and argument["type"] != "Variant":
  104. fully_used_classes.add(argument["type"])
  105. else:
  106. used_classes.add(argument["type"])
  107. if "return_type" in method:
  108. if is_included(method["return_type"], class_name):
  109. used_classes.add(method["return_type"])
  110. if "members" in builtin_api:
  111. for member in builtin_api["members"]:
  112. if is_included(member["type"], class_name):
  113. used_classes.add(member["type"])
  114. if "indexing_return_type" in builtin_api:
  115. if is_included(builtin_api["indexing_return_type"], class_name):
  116. used_classes.add(builtin_api["indexing_return_type"])
  117. if "operators" in builtin_api:
  118. for operator in builtin_api["operators"]:
  119. if "right_type" in operator:
  120. if is_included(operator["right_type"], class_name):
  121. used_classes.add(operator["right_type"])
  122. for type_name in fully_used_classes:
  123. if type_name in used_classes:
  124. used_classes.remove(type_name)
  125. with header_filename.open("w+") as header_file:
  126. header_file.write(generate_builtin_class_header(builtin_api, size, used_classes, fully_used_classes))
  127. with source_filename.open("w+") as source_file:
  128. source_file.write(generate_builtin_class_source(builtin_api, size, used_classes, fully_used_classes))
  129. # Create a header with all builtin types for convenience.
  130. builtin_header_filename = include_gen_folder / "builtin_types.hpp"
  131. with builtin_header_filename.open("w+") as builtin_header_file:
  132. builtin_header = []
  133. add_header("builtin_types.hpp", builtin_header)
  134. builtin_header.append("#ifndef GODOT_CPP_BUILTIN_TYPES_HPP")
  135. builtin_header.append("#define GODOT_CPP_BUILTIN_TYPES_HPP")
  136. builtin_header.append("")
  137. for builtin in builtin_classes:
  138. builtin_header.append(f"#include <godot_cpp/variant/{camel_to_snake(builtin)}.hpp>")
  139. builtin_header.append("")
  140. builtin_header.append("#endif // ! GODOT_CPP_BUILTIN_TYPES_HPP")
  141. builtin_header_file.write("\n".join(builtin_header))
  142. def generate_builtin_class_header(builtin_api, size, used_classes, fully_used_classes):
  143. result = []
  144. class_name = builtin_api["name"]
  145. snake_class_name = camel_to_snake(class_name).upper()
  146. header_guard = f"GODOT_CPP_{snake_class_name}_HPP"
  147. add_header(f"{snake_class_name.lower()}.hpp", result)
  148. result.append(f"#ifndef {header_guard}")
  149. result.append(f"#define {header_guard}")
  150. result.append("")
  151. result.append("#include <godot_cpp/core/defs.hpp>")
  152. result.append("")
  153. # Special cases.
  154. if class_name == "String":
  155. result.append("#include <godot_cpp/variant/char_string.hpp>")
  156. for include in fully_used_classes:
  157. result.append(f"#include <godot_cpp/{get_include_path(include)}>")
  158. if len(fully_used_classes) > 0:
  159. result.append("")
  160. result.append(f"#include <godot/gdnative_interface.h>")
  161. result.append("")
  162. result.append("namespace godot {")
  163. result.append("")
  164. for type_name in used_classes:
  165. result.append(f"class {type_name};")
  166. if len(used_classes) > 0:
  167. result.append("")
  168. result.append(f"class {class_name} {{")
  169. result.append(f"\tstatic constexpr size_t {snake_class_name}_SIZE = {size};")
  170. result.append(f"\tuint8_t opaque[{snake_class_name}_SIZE] {{ 0 }};")
  171. result.append(
  172. f"\t_FORCE_INLINE_ GDNativeTypePtr ptr() const {{ return const_cast<uint8_t (*)[{snake_class_name}_SIZE]>(&opaque); }}"
  173. )
  174. result.append("")
  175. result.append("\tfriend class Variant;")
  176. result.append("")
  177. result.append("\tstatic struct _MethodBindings {")
  178. if "constructors" in builtin_api:
  179. for constructor in builtin_api["constructors"]:
  180. result.append(f'\t\tGDNativePtrConstructor constructor_{constructor["index"]};')
  181. if builtin_api["has_destructor"]:
  182. result.append("\t\tGDNativePtrDestructor destructor;")
  183. if "methods" in builtin_api:
  184. for method in builtin_api["methods"]:
  185. result.append(f'\t\tGDNativePtrBuiltInMethod method_{method["name"]};')
  186. if "members" in builtin_api:
  187. for member in builtin_api["members"]:
  188. result.append(f'\t\tGDNativePtrSetter member_{member["name"]}_setter;')
  189. result.append(f'\t\tGDNativePtrGetter member_{member["name"]}_getter;')
  190. if "indexing_return_type" in builtin_api:
  191. result.append(f"\t\tGDNativePtrIndexedSetter indexed_setter;")
  192. result.append(f"\t\tGDNativePtrIndexedGetter indexed_getter;")
  193. if "is_keyed" in builtin_api and builtin_api["is_keyed"]:
  194. result.append(f"\t\tGDNativePtrKeyedSetter keyed_setter;")
  195. result.append(f"\t\tGDNativePtrKeyedGetter keyed_getter;")
  196. result.append(f"\t\tGDNativePtrKeyedChecker keyed_checker;")
  197. if "operators" in builtin_api:
  198. for operator in builtin_api["operators"]:
  199. if "right_type" in operator:
  200. result.append(
  201. f'\t\tGDNativePtrOperatorEvaluator operator_{get_operator_id_name(operator["name"])}_{operator["right_type"]};'
  202. )
  203. else:
  204. result.append(f'\t\tGDNativePtrOperatorEvaluator operator_{get_operator_id_name(operator["name"])};')
  205. result.append("\t} _method_bindings;")
  206. result.append("")
  207. result.append("\tstatic void init_bindings();")
  208. result.append("")
  209. result.append("public:")
  210. if "constructors" in builtin_api:
  211. for constructor in builtin_api["constructors"]:
  212. method_signature = f"\t{class_name}("
  213. if "arguments" in constructor:
  214. method_signature += make_function_parameters(
  215. constructor["arguments"], include_default=True, for_builtin=True
  216. )
  217. method_signature += ");"
  218. result.append(method_signature)
  219. # Special cases.
  220. if class_name == "String" or class_name == "StringName" or class_name == "NodePath":
  221. result.append(f"\t{class_name}(const char *from);")
  222. result.append(f"\t{class_name}(const wchar_t *from);")
  223. result.append(f"\t{class_name}(const char16_t *from);")
  224. result.append(f"\t{class_name}(const char32_t *from);")
  225. if "constants" in builtin_api:
  226. axis_constants_count = 0
  227. for constant in builtin_api["constants"]:
  228. # Special case: Vector3.Axis is the only enum in the bindings.
  229. # It's technically not supported by Variant but works for direct access.
  230. if class_name == "Vector3" and constant["name"].startswith("AXIS"):
  231. if axis_constants_count == 0:
  232. result.append("\tenum Axis {")
  233. result.append(f'\t\t{constant["name"]} = {constant["value"]},')
  234. axis_constants_count += 1
  235. if axis_constants_count == 3:
  236. result.append("\t};")
  237. else:
  238. result.append(f'\tstatic const {correct_type(constant["type"])} {constant["name"]};')
  239. if builtin_api["has_destructor"]:
  240. result.append(f"\t~{class_name}();")
  241. method_list = []
  242. if "methods" in builtin_api:
  243. for method in builtin_api["methods"]:
  244. method_list.append(method["name"])
  245. vararg = method["is_vararg"]
  246. if vararg:
  247. result.append("\ttemplate<class... Args>")
  248. method_signature = "\t"
  249. if "is_static" in method and method["is_static"]:
  250. method_signature += "static "
  251. if "return_type" in method:
  252. method_signature += f'{correct_type(method["return_type"])} '
  253. else:
  254. method_signature += "void "
  255. method_signature += f'{method["name"]}('
  256. method_arguments = []
  257. if "arguments" in method:
  258. method_arguments = method["arguments"]
  259. method_signature += make_function_parameters(
  260. method_arguments, include_default=True, for_builtin=True, is_vararg=vararg
  261. )
  262. method_signature += ")"
  263. if method["is_const"]:
  264. method_signature += " const"
  265. method_signature += ";"
  266. result.append(method_signature)
  267. # Special cases.
  268. if class_name == "String":
  269. result.append("\tCharString utf8() const;")
  270. result.append("\tCharString ascii() const;")
  271. result.append("\tChar16String utf16() const;")
  272. result.append("\tChar32String utf32() const;")
  273. result.append("\tCharWideString wide_string() const;")
  274. if "members" in builtin_api:
  275. for member in builtin_api["members"]:
  276. if f'get_{member["name"]}' not in method_list:
  277. result.append(f'\t{correct_type(member["type"])} get_{member["name"]}() const;')
  278. if f'set_{member["name"]}' not in method_list:
  279. result.append(f'\tvoid set_{member["name"]}({type_for_parameter(member["type"])}value);')
  280. if "operators" in builtin_api:
  281. for operator in builtin_api["operators"]:
  282. if operator["name"] not in ["in", "xor"]:
  283. if "right_type" in operator:
  284. result.append(
  285. f'\t{correct_type(operator["return_type"])} operator{operator["name"]}({type_for_parameter(operator["right_type"])}other) const;'
  286. )
  287. else:
  288. result.append(
  289. f'\t{correct_type(operator["return_type"])} operator{operator["name"].replace("unary", "")}() const;'
  290. )
  291. # Special cases.
  292. if class_name == "String":
  293. result.append("String &operator=(const char *p_str);")
  294. result.append("String &operator=(const wchar_t *p_str);")
  295. result.append("String &operator=(const char16_t *p_str);")
  296. result.append("String &operator=(const char32_t *p_str);")
  297. result.append("bool operator==(const char *p_str) const;")
  298. result.append("bool operator==(const wchar_t *p_str) const;")
  299. result.append("bool operator==(const char16_t *p_str) const;")
  300. result.append("bool operator==(const char32_t *p_str) const;")
  301. result.append("bool operator!=(const char *p_str) const;")
  302. result.append("bool operator!=(const wchar_t *p_str) const;")
  303. result.append("bool operator!=(const char16_t *p_str) const;")
  304. result.append("bool operator!=(const char32_t *p_str) const;")
  305. result.append("};")
  306. if class_name == "String":
  307. result.append("")
  308. result.append("bool operator==(const char *p_chr, const String &p_str);")
  309. result.append("bool operator==(const wchar_t *p_chr, const String &p_str);")
  310. result.append("bool operator==(const char16_t *p_chr, const String &p_str);")
  311. result.append("bool operator==(const char32_t *p_chr, const String &p_str);")
  312. result.append("bool operator!=(const char *p_chr, const String &p_str);")
  313. result.append("bool operator!=(const wchar_t *p_chr, const String &p_str);")
  314. result.append("bool operator!=(const char16_t *p_chr, const String &p_str);")
  315. result.append("bool operator!=(const char32_t *p_chr, const String &p_str);")
  316. result.append("String operator+(const char *p_chr, const String &p_str);")
  317. result.append("String operator+(const wchar_t *p_chr, const String &p_str);")
  318. result.append("String operator+(const char16_t *p_chr, const String &p_str);")
  319. result.append("String operator+(const char32_t *p_chr, const String &p_str);")
  320. result.append("")
  321. result.append("} // namespace godot")
  322. result.append(f"#endif // ! {header_guard}")
  323. return "\n".join(result)
  324. def generate_builtin_class_source(builtin_api, size, used_classes, fully_used_classes):
  325. result = []
  326. class_name = builtin_api["name"]
  327. snake_class_name = camel_to_snake(class_name)
  328. enum_type_name = f"GDNATIVE_VARIANT_TYPE_{snake_class_name.upper()}"
  329. add_header(f"{snake_class_name}.cpp", result)
  330. result.append("")
  331. result.append(f"#include <godot_cpp/variant/{snake_class_name}.hpp>")
  332. result.append("")
  333. result.append("#include <godot_cpp/core/binder_common.hpp>")
  334. result.append("")
  335. result.append("#include <godot_cpp/godot.hpp>")
  336. result.append("")
  337. # Only used since the "fully used" is included in header already.
  338. for include in used_classes:
  339. result.append(f"#include <godot_cpp/{get_include_path(include)}>")
  340. if len(used_classes) > 0:
  341. result.append("")
  342. result.append("#include <godot_cpp/core/builtin_ptrcall.hpp>")
  343. result.append("")
  344. result.append("namespace godot {")
  345. result.append("")
  346. result.append(f"{class_name}::_MethodBindings {class_name}::_method_bindings;")
  347. result.append("")
  348. result.append(f"void {class_name}::init_bindings() {{")
  349. if "constructors" in builtin_api:
  350. for constructor in builtin_api["constructors"]:
  351. result.append(
  352. f'\t_method_bindings.constructor_{constructor["index"]} = internal::interface->variant_get_ptr_constructor({enum_type_name}, {constructor["index"]});'
  353. )
  354. if builtin_api["has_destructor"]:
  355. result.append(
  356. f"\t_method_bindings.destructor = internal::interface->variant_get_ptr_destructor({enum_type_name});"
  357. )
  358. if "methods" in builtin_api:
  359. for method in builtin_api["methods"]:
  360. # TODO: Add error check for hash mismatch.
  361. result.append(
  362. f'\t_method_bindings.method_{method["name"]} = internal::interface->variant_get_ptr_builtin_method({enum_type_name}, "{method["name"]}", {method["hash"]});'
  363. )
  364. if "members" in builtin_api:
  365. for member in builtin_api["members"]:
  366. result.append(
  367. f'\t_method_bindings.member_{member["name"]}_setter = internal::interface->variant_get_ptr_setter({enum_type_name}, "{member["name"]}");'
  368. )
  369. result.append(
  370. f'\t_method_bindings.member_{member["name"]}_getter = internal::interface->variant_get_ptr_getter({enum_type_name}, "{member["name"]}");'
  371. )
  372. if "indexing_return_type" in builtin_api:
  373. result.append(
  374. f"\t_method_bindings.indexed_setter = internal::interface->variant_get_ptr_indexed_setter({enum_type_name});"
  375. )
  376. result.append(
  377. f"\t_method_bindings.indexed_getter = internal::interface->variant_get_ptr_indexed_getter({enum_type_name});"
  378. )
  379. if "is_keyed" in builtin_api and builtin_api["is_keyed"]:
  380. result.append(
  381. f"\t_method_bindings.keyed_setter = internal::interface->variant_get_ptr_keyed_setter({enum_type_name});"
  382. )
  383. result.append(
  384. f"\t_method_bindings.keyed_getter = internal::interface->variant_get_ptr_keyed_getter({enum_type_name});"
  385. )
  386. result.append(
  387. f"\t_method_bindings.keyed_checker = internal::interface->variant_get_ptr_keyed_checker({enum_type_name});"
  388. )
  389. if "operators" in builtin_api:
  390. for operator in builtin_api["operators"]:
  391. if "right_type" in operator:
  392. result.append(
  393. f'\t_method_bindings.operator_{get_operator_id_name(operator["name"])}_{operator["right_type"]} = internal::interface->variant_get_ptr_operator_evaluator(GDNATIVE_VARIANT_OP_{get_operator_id_name(operator["name"]).upper()}, {enum_type_name}, GDNATIVE_VARIANT_TYPE_{camel_to_snake(operator["right_type"]).upper()});'
  394. )
  395. else:
  396. result.append(
  397. f'\t_method_bindings.operator_{get_operator_id_name(operator["name"])} = internal::interface->variant_get_ptr_operator_evaluator(GDNATIVE_VARIANT_OP_{get_operator_id_name(operator["name"]).upper()}, {enum_type_name}, GDNATIVE_VARIANT_TYPE_NIL);'
  398. )
  399. result.append("}")
  400. result.append("")
  401. if "constructors" in builtin_api:
  402. for constructor in builtin_api["constructors"]:
  403. method_signature = f"{class_name}::{class_name}("
  404. if "arguments" in constructor:
  405. method_signature += make_function_parameters(
  406. constructor["arguments"], include_default=False, for_builtin=True
  407. )
  408. method_signature += ") {"
  409. result.append(method_signature)
  410. method_call = (
  411. f'\tinternal::_call_builtin_constructor(_method_bindings.constructor_{constructor["index"]}, &opaque'
  412. )
  413. if "arguments" in constructor:
  414. method_call += ", "
  415. arguments = []
  416. for argument in constructor["arguments"]:
  417. (encode, arg_name) = get_encoded_arg(
  418. argument["name"],
  419. argument["type"],
  420. argument["meta"] if "meta" in argument else None,
  421. )
  422. result += encode
  423. arguments.append(arg_name)
  424. method_call += ", ".join(arguments)
  425. method_call += ");"
  426. result.append(method_call)
  427. result.append("}")
  428. result.append("")
  429. if builtin_api["has_destructor"]:
  430. result.append(f"{class_name}::~{class_name}() {{")
  431. result.append("\t_method_bindings.destructor(&opaque);")
  432. result.append("}")
  433. result.append("")
  434. method_list = []
  435. if "methods" in builtin_api:
  436. for method in builtin_api["methods"]:
  437. method_list.append(method["name"])
  438. if "is_vararg" in method and method["is_vararg"]:
  439. # Done in the header because of the template.
  440. continue
  441. method_signature = make_signature(class_name, method, for_builtin=True)
  442. result.append(method_signature + "{")
  443. method_call = "\t"
  444. if "return_type" in method:
  445. method_call += f'return internal::_call_builtin_method_ptr_ret<{correct_type(method["return_type"])}>('
  446. else:
  447. method_call += f"internal::_call_builtin_method_ptr_no_ret("
  448. method_call += f'_method_bindings.method_{method["name"]}, '
  449. if "is_static" in method and method["is_static"]:
  450. method_call += "nullptr"
  451. else:
  452. method_call += "(GDNativeTypePtr)&opaque"
  453. if "arguments" in method:
  454. arguments = []
  455. method_call += ", "
  456. for argument in method["arguments"]:
  457. (encode, arg_name) = get_encoded_arg(
  458. argument["name"],
  459. argument["type"],
  460. argument["meta"] if "meta" in argument else None,
  461. )
  462. result += encode
  463. arguments.append(arg_name)
  464. method_call += ", ".join(arguments)
  465. method_call += ");"
  466. result.append(method_call)
  467. result.append("}")
  468. result.append("")
  469. if "members" in builtin_api:
  470. for member in builtin_api["members"]:
  471. if f'get_{member["name"]}' not in method_list:
  472. result.append(f'{correct_type(member["type"])} {class_name}::get_{member["name"]}() const {{')
  473. result.append(
  474. f'\treturn internal::_call_builtin_ptr_getter<{correct_type(member["type"])}>(_method_bindings.member_{member["name"]}_getter, (const GDNativeTypePtr)&opaque);'
  475. )
  476. result.append("}")
  477. if f'set_{member["name"]}' not in method_list:
  478. result.append(f'void {class_name}::set_{member["name"]}({type_for_parameter(member["type"])}value) {{')
  479. (encode, arg_name) = get_encoded_arg("value", member["type"], None)
  480. result += encode
  481. result.append(
  482. f'\t_method_bindings.member_{member["name"]}_setter((const GDNativeTypePtr)&opaque, (const GDNativeTypePtr){arg_name});'
  483. )
  484. result.append("}")
  485. result.append("")
  486. if "operators" in builtin_api:
  487. for operator in builtin_api["operators"]:
  488. if operator["name"] not in ["in", "xor"]:
  489. if "right_type" in operator:
  490. result.append(
  491. f'{correct_type(operator["return_type"])} {class_name}::operator{operator["name"]}({type_for_parameter(operator["right_type"])}other) const {{'
  492. )
  493. (encode, arg_name) = get_encoded_arg("other", operator["right_type"], None)
  494. result += encode
  495. result.append(
  496. f'\treturn internal::_call_builtin_operator_ptr<{correct_type(operator["return_type"])}>(_method_bindings.operator_{get_operator_id_name(operator["name"])}_{operator["right_type"]}, (const GDNativeTypePtr)&opaque, (const GDNativeTypePtr){arg_name});'
  497. )
  498. result.append("}")
  499. else:
  500. result.append(
  501. f'{correct_type(operator["return_type"])} {class_name}::operator{operator["name"].replace("unary", "")}() const {{'
  502. )
  503. result.append(
  504. f'\treturn internal::_call_builtin_operator_ptr<{correct_type(operator["return_type"])}>(_method_bindings.operator_{get_operator_id_name(operator["name"])}, (const GDNativeTypePtr)&opaque, (const GDNativeTypePtr)nullptr);'
  505. )
  506. result.append("}")
  507. result.append("")
  508. result.append("} //namespace godot")
  509. return "\n".join(result)
  510. def generate_engine_classes_bindings(api, output_dir, use_template_get_node):
  511. global engine_classes
  512. include_gen_folder = Path(output_dir) / "include" / "godot_cpp" / "classes"
  513. source_gen_folder = Path(output_dir) / "src" / "classes"
  514. include_gen_folder.mkdir(parents=True, exist_ok=True)
  515. source_gen_folder.mkdir(parents=True, exist_ok=True)
  516. # First create map of classes.
  517. for class_api in api["classes"]:
  518. # TODO: Properly setup this singleton since it conflicts with ClassDB in the bindings.
  519. if class_api["name"] == "ClassDB":
  520. continue
  521. engine_classes[class_api["name"]] = class_api["is_refcounted"]
  522. for native_struct in api["native_structures"]:
  523. engine_classes[native_struct["name"]] = False
  524. for class_api in api["classes"]:
  525. # TODO: Properly setup this singleton since it conflicts with ClassDB in the bindings.
  526. if class_api["name"] == "ClassDB":
  527. continue
  528. # Check used classes for header include.
  529. used_classes = set()
  530. fully_used_classes = set()
  531. class_name = class_api["name"]
  532. header_filename = include_gen_folder / (camel_to_snake(class_api["name"]) + ".hpp")
  533. source_filename = source_gen_folder / (camel_to_snake(class_api["name"]) + ".cpp")
  534. if "methods" in class_api:
  535. for method in class_api["methods"]:
  536. if "arguments" in method:
  537. for argument in method["arguments"]:
  538. type_name = argument["type"]
  539. if type_name.endswith("*"):
  540. type_name = type_name[:-1]
  541. if is_included(type_name, class_name):
  542. if is_enum(type_name):
  543. fully_used_classes.add(get_enum_class(type_name))
  544. elif "default_value" in argument:
  545. fully_used_classes.add(type_name)
  546. else:
  547. used_classes.add(type_name)
  548. if is_refcounted(type_name):
  549. fully_used_classes.add("Ref")
  550. if "return_value" in method:
  551. type_name = method["return_value"]["type"]
  552. if type_name.endswith("*"):
  553. type_name = type_name[:-1]
  554. print("New type name ", type_name)
  555. if is_included(type_name, class_name):
  556. if is_enum(type_name):
  557. fully_used_classes.add(get_enum_class(type_name))
  558. elif is_variant(type_name):
  559. fully_used_classes.add(type_name)
  560. else:
  561. used_classes.add(type_name)
  562. if is_refcounted(type_name):
  563. fully_used_classes.add("Ref")
  564. if "members" in class_api:
  565. for member in class_api["members"]:
  566. if is_included(member["type"], class_name):
  567. if is_enum(member["type"]):
  568. fully_used_classes.add(get_enum_class(member["type"]))
  569. else:
  570. used_classes.add(member["type"])
  571. if is_refcounted(member["type"]):
  572. fully_used_classes.add("Ref")
  573. if "inherits" in class_api:
  574. if is_included(class_api["inherits"], class_name):
  575. fully_used_classes.add(class_api["inherits"])
  576. if is_refcounted(class_api["name"]):
  577. fully_used_classes.add("Ref")
  578. else:
  579. fully_used_classes.add("Wrapped")
  580. for type_name in fully_used_classes:
  581. if type_name in used_classes:
  582. used_classes.remove(type_name)
  583. with header_filename.open("w+") as header_file:
  584. header_file.write(
  585. generate_engine_class_header(class_api, used_classes, fully_used_classes, use_template_get_node)
  586. )
  587. with source_filename.open("w+") as source_file:
  588. source_file.write(
  589. generate_engine_class_source(class_api, used_classes, fully_used_classes, use_template_get_node)
  590. )
  591. for native_struct in api["native_structures"]:
  592. struct_name = native_struct["name"]
  593. snake_struct_name = camel_to_snake(struct_name)
  594. header_filename = include_gen_folder / (snake_struct_name + ".hpp")
  595. result = []
  596. add_header(f"{snake_struct_name}.hpp", result)
  597. header_guard = f"GODOT_CPP_{snake_struct_name.upper()}_HPP"
  598. result.append(f"#ifndef {header_guard}")
  599. result.append(f"#define {header_guard}")
  600. result.append("")
  601. result.append("namespace godot {")
  602. result.append("")
  603. result.append(f"struct {struct_name} {{")
  604. for field in native_struct["format"].split(","):
  605. result.append(f"\t{field};")
  606. result.append("};")
  607. result.append("")
  608. result.append("} // namespace godot")
  609. result.append("")
  610. result.append(f"#endif // ! {header_guard}")
  611. with header_filename.open("w+") as header_file:
  612. header_file.write("\n".join(result))
  613. def generate_engine_class_header(class_api, used_classes, fully_used_classes, use_template_get_node):
  614. result = []
  615. class_name = class_api["name"]
  616. snake_class_name = camel_to_snake(class_name).upper()
  617. add_header(f"{snake_class_name.lower()}.hpp", result)
  618. header_guard = f"GODOT_CPP_{snake_class_name}_HPP"
  619. result.append(f"#ifndef {header_guard}")
  620. result.append(f"#define {header_guard}")
  621. result.append("")
  622. for included in fully_used_classes:
  623. result.append(f"#include <godot_cpp/{get_include_path(included)}>")
  624. if len(fully_used_classes) > 0:
  625. result.append("")
  626. if class_name != "Object":
  627. result.append("#include <godot_cpp/core/class_db.hpp>")
  628. result.append("")
  629. result.append("#include <type_traits>")
  630. result.append("")
  631. result.append("namespace godot {")
  632. result.append("")
  633. for type_name in used_classes:
  634. result.append(f"class {type_name};")
  635. if len(used_classes) > 0:
  636. result.append("")
  637. inherits = class_api["inherits"] if "inherits" in class_api else "Wrapped"
  638. result.append(f"class {class_name} : public {inherits} {{")
  639. result.append(f"\tGDNATIVE_CLASS({class_name}, {inherits})")
  640. result.append("")
  641. result.append("public:")
  642. if "enums" in class_api:
  643. for enum_api in class_api["enums"]:
  644. result.append(f'\tenum {enum_api["name"]} {{')
  645. for value in enum_api["values"]:
  646. result.append(f'\t\t{value["name"]} = {value["value"]},')
  647. result.append("\t};")
  648. result.append("")
  649. if "methods" in class_api:
  650. for method in class_api["methods"]:
  651. if method["is_virtual"]:
  652. # Will be done later.
  653. continue
  654. vararg = "is_vararg" in method and method["is_vararg"]
  655. method_signature = "\t"
  656. if vararg:
  657. method_signature += "private: "
  658. method_signature += make_signature(
  659. class_name, method, for_header=True, use_template_get_node=use_template_get_node
  660. )
  661. result.append(method_signature + ";")
  662. if vararg:
  663. # Add templated version.
  664. result += make_varargs_template(method)
  665. # Virtuals now.
  666. for method in class_api["methods"]:
  667. if not method["is_virtual"]:
  668. continue
  669. method_signature = "\t"
  670. method_signature += make_signature(
  671. class_name, method, for_header=True, use_template_get_node=use_template_get_node
  672. )
  673. result.append(method_signature + ";")
  674. result.append("protected:")
  675. result.append("\ttemplate <class T>")
  676. result.append("\tstatic void register_virtuals() {")
  677. if class_name != "Object":
  678. result.append(f"\t\t{inherits}::register_virtuals<T>();")
  679. if "methods" in class_api:
  680. for method in class_api["methods"]:
  681. if not method["is_virtual"]:
  682. continue
  683. method_name = escape_identifier(method["name"])
  684. result.append(
  685. f"\t\tif constexpr (!std::is_same_v<decltype(&{class_name}::{method_name}),decltype(&T::{method_name})>) {{"
  686. )
  687. result.append(f"\t\t\tBIND_VIRTUAL_METHOD(T, {method_name});")
  688. result.append("\t\t}")
  689. result.append("\t}")
  690. result.append("")
  691. result.append("public:")
  692. # Special cases.
  693. if class_name == "Object":
  694. result.append("")
  695. result.append("\ttemplate<class T>")
  696. result.append("\tstatic T *cast_to(Object *p_object);")
  697. elif use_template_get_node and class_name == "Node":
  698. result.append("\ttemplate<class T>")
  699. result.append(
  700. "\tT *get_node(const NodePath &p_path) const { return Object::cast_to<T>(get_node_internal(p_path)); }"
  701. )
  702. # Constructor.
  703. result.append("")
  704. result.append(f"\t{class_name}();")
  705. result.append("")
  706. result.append("};")
  707. result.append("")
  708. result.append("} // namespace godot")
  709. result.append(f"#endif // ! {header_guard}")
  710. return "\n".join(result)
  711. def generate_engine_class_source(class_api, used_classes, fully_used_classes, use_template_get_node):
  712. result = []
  713. class_name = class_api["name"]
  714. snake_class_name = camel_to_snake(class_name)
  715. inherits = class_api["inherits"] if "inherits" in class_api else "Wrapped"
  716. add_header(f"{snake_class_name}.cpp", result)
  717. result.append(f"#include <godot_cpp/classes/{snake_class_name}.hpp>")
  718. result.append("")
  719. result.append(f"#include <godot_cpp/core/engine_ptrcall.hpp>")
  720. result.append(f"#include <godot_cpp/core/error_macros.hpp>")
  721. result.append("")
  722. for included in used_classes:
  723. result.append(f"#include <godot_cpp/{get_include_path(included)}>")
  724. if len(used_classes) > 0:
  725. result.append(f"")
  726. result.append("namespace godot {")
  727. result.append("")
  728. if "methods" in class_api:
  729. for method in class_api["methods"]:
  730. if method["is_virtual"]:
  731. # Will be done later
  732. continue
  733. vararg = "is_vararg" in method and method["is_vararg"]
  734. # Method signature.
  735. method_signature = make_signature(class_name, method, use_template_get_node=use_template_get_node)
  736. result.append(method_signature + " {")
  737. # Method body.
  738. result.append(
  739. f'\tstatic GDNativeMethodBindPtr ___method_bind = internal::interface->classdb_get_method_bind("{class_name}", "{method["name"]}", {method["hash"]});'
  740. )
  741. method_call = "\t"
  742. has_return = "return_value" in method and method["return_value"]["type"] != "void"
  743. if has_return:
  744. result.append(
  745. f'\tCHECK_METHOD_BIND_RET(___method_bind, {get_default_value_for_type(method["return_value"]["type"])});'
  746. )
  747. else:
  748. result.append(f"\tCHECK_METHOD_BIND(___method_bind);")
  749. is_ref = False
  750. if not vararg:
  751. if has_return:
  752. return_type = method["return_value"]["type"]
  753. meta_type = method["return_value"]["meta"] if "meta" in method["return_value"] else None
  754. if is_pod_type(return_type) or is_variant(return_type) or is_enum(return_type):
  755. method_call += f"return internal::_call_native_mb_ret<{correct_type(return_type, meta_type)}>(___method_bind, _owner"
  756. elif is_refcounted(return_type):
  757. method_call += f"return Ref<{return_type}>::___internal_constructor(internal::_call_native_mb_ret_obj<{return_type}>(___method_bind, _owner"
  758. is_ref = True
  759. else:
  760. method_call += f"return ({correct_type(return_type)})internal::_call_native_mb_ret_obj<{return_type}>(___method_bind, _owner"
  761. else:
  762. method_call += f"internal::_call_native_mb_no_ret(___method_bind, _owner"
  763. if "arguments" in method:
  764. method_call += ", "
  765. arguments = []
  766. for argument in method["arguments"]:
  767. (encode, arg_name) = get_encoded_arg(
  768. argument["name"],
  769. argument["type"],
  770. argument["meta"] if "meta" in argument else None,
  771. )
  772. result += encode
  773. arguments.append(arg_name)
  774. method_call += ", ".join(arguments)
  775. else: # vararg.
  776. result.append("\tGDNativeCallError error;")
  777. result.append("\tVariant ret;")
  778. method_call += "internal::interface->object_method_bind_call(___method_bind, _owner, (const GDNativeVariantPtr *)args, arg_count, &ret, &error"
  779. if is_ref:
  780. method_call += ")" # Close Ref<> constructor.
  781. method_call += ");"
  782. result.append(method_call)
  783. if vararg and ("return_value" in method and method["return_value"]["type"] != "void"):
  784. result.append("\treturn ret;")
  785. result.append("}")
  786. result.append("")
  787. # Virtuals now.
  788. for method in class_api["methods"]:
  789. if not method["is_virtual"]:
  790. continue
  791. method_signature = make_signature(class_name, method, use_template_get_node=use_template_get_node)
  792. method_signature += " {"
  793. if "return_value" in method and correct_type(method["return_value"]["type"]) != "void":
  794. result.append(method_signature)
  795. result.append(f'\treturn {get_default_value_for_type(method["return_value"]["type"])};')
  796. result.append("}")
  797. else:
  798. method_signature += "}"
  799. result.append(method_signature)
  800. result.append("")
  801. # Constructor.
  802. result.append(f"{class_name}::{class_name}() : {inherits}(godot::internal::empty_constructor()) {{")
  803. result.append(
  804. f'\tstatic GDNativeClassConstructor constructor = internal::interface->classdb_get_constructor("{class_name}");'
  805. )
  806. result.append("\t_owner = (GodotObject *)constructor();")
  807. result.append(
  808. f"\tinternal::interface->object_set_instance_binding((GDNativeObjectPtr)_owner, internal::token, this, &{class_name}::___binding_callbacks);"
  809. )
  810. result.append("}")
  811. result.append("")
  812. result.append("} // namespace godot ")
  813. return "\n".join(result)
  814. def generate_global_constants(api, output_dir):
  815. include_gen_folder = Path(output_dir) / "include" / "godot_cpp" / "classes"
  816. source_gen_folder = Path(output_dir) / "src" / "classes"
  817. include_gen_folder.mkdir(parents=True, exist_ok=True)
  818. source_gen_folder.mkdir(parents=True, exist_ok=True)
  819. # Generate header
  820. header = []
  821. add_header("global_constants.hpp", header)
  822. header_filename = include_gen_folder / "global_constants.hpp"
  823. header_guard = "GODOT_CPP_GLOBAL_CONSTANTS_HPP"
  824. header.append(f"#ifndef {header_guard}")
  825. header.append(f"#define {header_guard}")
  826. header.append("")
  827. header.append("namespace godot {")
  828. header.append("")
  829. for constant in api["global_constants"]:
  830. header.append(f'\tconst int {escape_identifier(constant["name"])} = {constant["value"]};')
  831. header.append("")
  832. for enum_def in api["global_enums"]:
  833. if enum_def["name"].startswith("Variant."):
  834. continue
  835. header.append(f'\tenum {enum_def["name"]} {{')
  836. for value in enum_def["values"]:
  837. header.append(f'\t\t{value["name"]} = {value["value"]},')
  838. header.append("\t};")
  839. header.append("")
  840. header.append("} // namespace godot")
  841. header.append("")
  842. header.append(f"#endif // ! {header_guard}")
  843. with header_filename.open("w+") as header_file:
  844. header_file.write("\n".join(header))
  845. def generate_utility_functions(api, output_dir):
  846. include_gen_folder = Path(output_dir) / "include" / "godot_cpp" / "variant"
  847. source_gen_folder = Path(output_dir) / "src" / "variant"
  848. include_gen_folder.mkdir(parents=True, exist_ok=True)
  849. source_gen_folder.mkdir(parents=True, exist_ok=True)
  850. # Generate header.
  851. header = []
  852. add_header("utility_functions.hpp", header)
  853. header_filename = include_gen_folder / "utility_functions.hpp"
  854. header_guard = "GODOT_CPP_UTILITY_FUNCTIONS_HPP"
  855. header.append(f"#ifndef {header_guard}")
  856. header.append(f"#define {header_guard}")
  857. header.append("")
  858. header.append("#include <godot_cpp/variant/builtin_types.hpp>")
  859. header.append("#include <godot_cpp/variant/variant.hpp>")
  860. header.append("")
  861. header.append("#include <array>")
  862. header.append("")
  863. header.append("namespace godot {")
  864. header.append("")
  865. header.append("class UtilityFunctions {")
  866. header.append("public:")
  867. for function in api["utility_functions"]:
  868. vararg = "is_vararg" in function and function["is_vararg"]
  869. function_signature = "\t"
  870. function_signature += make_signature("UtilityFunctions", function, for_header=True, static=True)
  871. header.append(function_signature + ";")
  872. if vararg:
  873. # Add templated version.
  874. header += make_varargs_template(function, static=True)
  875. header.append("};")
  876. header.append("")
  877. header.append("} // namespace godot")
  878. header.append("")
  879. header.append(f"#endif // ! {header_guard}")
  880. with header_filename.open("w+") as header_file:
  881. header_file.write("\n".join(header))
  882. # Generate source.
  883. source = []
  884. add_header("utility_functions.cpp", source)
  885. source_filename = source_gen_folder / "utility_functions.cpp"
  886. source.append("#include <godot_cpp/variant/utility_functions.hpp>")
  887. source.append("")
  888. source.append("#include <godot_cpp/core/error_macros.hpp>")
  889. source.append("#include <godot_cpp/core/engine_ptrcall.hpp>")
  890. source.append("")
  891. source.append("namespace godot {")
  892. source.append("")
  893. for function in api["utility_functions"]:
  894. vararg = "is_vararg" in function and function["is_vararg"]
  895. function_signature = make_signature("UtilityFunctions", function)
  896. source.append(function_signature + " {")
  897. # Function body.
  898. source.append(
  899. f'\tstatic GDNativePtrUtilityFunction ___function = internal::interface->variant_get_ptr_utility_function("{function["name"]}", {function["hash"]});'
  900. )
  901. has_return = "return_type" in function and function["return_type"] != "void"
  902. if has_return:
  903. source.append(
  904. f'\tCHECK_METHOD_BIND_RET(___function, {get_default_value_for_type(function["return_type"])});'
  905. )
  906. else:
  907. source.append(f"\tCHECK_METHOD_BIND(___function);")
  908. function_call = "\t"
  909. if not vararg:
  910. if has_return:
  911. function_call += "return "
  912. if function["return_type"] == "Object":
  913. function_call += "internal::_call_utility_ret_obj(___function"
  914. else:
  915. function_call += f'internal::_call_utility_ret<{correct_type(function["return_type"])}>(___function'
  916. else:
  917. function_call += "internal::_call_utility_no_ret(___function"
  918. if "arguments" in function:
  919. function_call += ", "
  920. arguments = []
  921. for argument in function["arguments"]:
  922. (encode, arg_name) = get_encoded_arg(
  923. argument["name"],
  924. argument["type"],
  925. argument["meta"] if "meta" in argument else None,
  926. )
  927. source += encode
  928. arguments.append(arg_name)
  929. function_call += ", ".join(arguments)
  930. else:
  931. source.append("\tVariant ret;")
  932. function_call += "___function(&ret, (const GDNativeVariantPtr *)args, arg_count"
  933. function_call += ");"
  934. source.append(function_call)
  935. if vararg and has_return:
  936. source.append("\treturn ret;")
  937. source.append("}")
  938. source.append("")
  939. source.append("} // namespace godot")
  940. with source_filename.open("w+") as source_file:
  941. source_file.write("\n".join(source))
  942. # Helper functions.
  943. def camel_to_snake(name):
  944. name = re.sub("(.)([A-Z][a-z]+)", r"\1_\2", name)
  945. name = re.sub("([a-z0-9])([A-Z])", r"\1_\2", name)
  946. return name.replace("2_D", "2D").replace("3_D", "3D").lower()
  947. def make_function_parameters(parameters, include_default=False, for_builtin=False, is_vararg=False):
  948. signature = []
  949. for index, par in enumerate(parameters):
  950. parameter = type_for_parameter(par["type"], par["meta"] if "meta" in par else None)
  951. parameter_name = escape_identifier(par["name"])
  952. if len(parameter_name) == 0:
  953. parameter_name = "arg_" + str(index + 1)
  954. parameter += parameter_name
  955. if include_default and "default_value" in par and (not for_builtin or par["type"] != "Variant"):
  956. parameter += " = "
  957. if is_enum(par["type"]):
  958. parameter_type = correct_type(par["type"])
  959. if parameter_type == "void":
  960. parameter_type = "Variant"
  961. parameter += f"({parameter_type})"
  962. parameter += correct_default_value(par["default_value"], par["type"])
  963. signature.append(parameter)
  964. if is_vararg:
  965. signature.append("const Args&... args")
  966. return ", ".join(signature)
  967. def type_for_parameter(type_name, meta=None):
  968. if type_name == "void":
  969. return "Variant "
  970. elif is_pod_type(type_name) and type_name != "Nil" or is_enum(type_name):
  971. return f"{correct_type(type_name, meta)} "
  972. elif is_variant(type_name) or is_refcounted(type_name):
  973. return f"const {correct_type(type_name)} &"
  974. else:
  975. return f"{correct_type(type_name)}"
  976. def get_include_path(type_name):
  977. base_dir = ""
  978. if type_name == "Object":
  979. base_dir = "core"
  980. elif is_variant(type_name):
  981. base_dir = "variant"
  982. else:
  983. base_dir = "classes"
  984. return f"{base_dir}/{camel_to_snake(type_name)}.hpp"
  985. def get_encoded_arg(arg_name, type_name, type_meta):
  986. result = []
  987. name = escape_identifier(arg_name)
  988. arg_type = correct_type(type_name)
  989. if is_pod_type(arg_type):
  990. result.append(f"\t{get_gdnative_type(arg_type)} {name}_encoded;")
  991. result.append(f"\tPtrToArg<{correct_type(type_name, type_meta)}>::encode({name}, &{name}_encoded);")
  992. name = f"&{name}_encoded"
  993. elif is_engine_class(type_name):
  994. name = f"{name}->_owner"
  995. else:
  996. name = f"&{name}"
  997. return (result, name)
  998. def make_signature(
  999. class_name, function_data, for_header=False, use_template_get_node=True, for_builtin=False, static=False
  1000. ):
  1001. function_signature = ""
  1002. is_vararg = "is_vararg" in function_data and function_data["is_vararg"]
  1003. if for_header:
  1004. if "is_virtual" in function_data and function_data["is_virtual"]:
  1005. function_signature += "virtual "
  1006. if is_vararg:
  1007. function_signature += "private: "
  1008. if static:
  1009. function_signature += "static "
  1010. return_type = "void"
  1011. return_meta = None
  1012. if "return_type" in function_data:
  1013. return_type = correct_type(function_data["return_type"])
  1014. elif "return_value" in function_data:
  1015. return_type = function_data["return_value"]["type"]
  1016. return_meta = function_data["return_value"]["meta"] if "meta" in function_data["return_value"] else None
  1017. function_signature += correct_type(
  1018. return_type,
  1019. return_meta,
  1020. )
  1021. if not function_signature.endswith("*"):
  1022. function_signature += " "
  1023. if not for_header:
  1024. function_signature += f"{class_name}::"
  1025. function_signature += escape_identifier(function_data["name"])
  1026. if is_vararg or (
  1027. not for_builtin and use_template_get_node and class_name == "Node" and function_data["name"] == "get_node"
  1028. ):
  1029. function_signature += "_internal"
  1030. function_signature += "("
  1031. arguments = function_data["arguments"] if "arguments" in function_data else []
  1032. if not is_vararg:
  1033. function_signature += make_function_parameters(arguments, for_header, for_builtin, is_vararg)
  1034. else:
  1035. function_signature += "const Variant **args, GDNativeInt arg_count"
  1036. function_signature += ")"
  1037. if "is_const" in function_data and function_data["is_const"]:
  1038. function_signature += " const"
  1039. return function_signature
  1040. def make_varargs_template(function_data, static=False):
  1041. result = []
  1042. function_signature = "\tpublic: template<class... Args> "
  1043. if static:
  1044. function_signature += "static "
  1045. return_type = "void"
  1046. return_meta = None
  1047. if "return_type" in function_data:
  1048. return_type = correct_type(function_data["return_type"])
  1049. elif "return_value" in function_data:
  1050. return_type = function_data["return_value"]["type"]
  1051. return_meta = function_data["return_value"]["meta"] if "meta" in function_data["return_value"] else None
  1052. function_signature += correct_type(
  1053. return_type,
  1054. return_meta,
  1055. )
  1056. if not function_signature.endswith("*"):
  1057. function_signature += " "
  1058. function_signature += f'{escape_identifier(function_data["name"])}'
  1059. method_arguments = []
  1060. if "arguments" in function_data:
  1061. method_arguments = function_data["arguments"]
  1062. function_signature += "("
  1063. is_vararg = "is_vararg" in function_data and function_data["is_vararg"]
  1064. function_signature += make_function_parameters(method_arguments, include_default=True, is_vararg=is_vararg)
  1065. function_signature += ")"
  1066. if "is_const" in function_data and function_data["is_const"]:
  1067. function_signature += " const"
  1068. function_signature += " {"
  1069. result.append(function_signature)
  1070. args_array = f"\t\tstd::array<Variant, {len(method_arguments)} + sizeof...(Args)> variant_args {{ "
  1071. for argument in method_arguments:
  1072. if argument["type"] == "Variant":
  1073. args_array += argument["name"]
  1074. else:
  1075. args_array += f'Variant({argument["name"]})'
  1076. args_array += ", "
  1077. args_array += "Variant(args)... };"
  1078. result.append(args_array)
  1079. result.append(f"\t\tstd::array<const Variant *, {len(method_arguments)} + sizeof...(Args)> call_args;")
  1080. result.append("\t\tfor(size_t i = 0; i < variant_args.size(); i++) {")
  1081. result.append("\t\t\tcall_args[i] = &variant_args[i];")
  1082. result.append("\t\t}")
  1083. call_line = "\t\t"
  1084. if "return_value" in function_data and function_data["return_value"]["type"] != "void":
  1085. call_line += "return "
  1086. call_line += f'{escape_identifier(function_data["name"])}_internal(call_args.data(), variant_args.size());'
  1087. result.append(call_line)
  1088. result.append("\t}")
  1089. return result
  1090. # Engine idiosyncrasies.
  1091. def is_pod_type(type_name):
  1092. """
  1093. Those are types for which no class should be generated.
  1094. """
  1095. return type_name in [
  1096. "Nil",
  1097. "void",
  1098. "int",
  1099. "float",
  1100. "bool",
  1101. ]
  1102. def is_enum(type_name):
  1103. return type_name.startswith("enum::")
  1104. def get_enum_class(enum_name: str):
  1105. if "." in enum_name:
  1106. return enum_name.replace("enum::", "").split(".")[0]
  1107. else:
  1108. return "GlobalConstants"
  1109. def get_enum_name(enum_name: str):
  1110. return enum_name.replace("enum::", "").split(".")[-1]
  1111. def is_variant(type_name):
  1112. return type_name == "Variant" or type_name in builtin_classes or type_name == "Nil"
  1113. def is_engine_class(type_name):
  1114. global engine_classes
  1115. return type_name == "Object" or type_name in engine_classes
  1116. def is_refcounted(type_name):
  1117. return type_name in engine_classes and engine_classes[type_name]
  1118. def is_included(type_name, current_type):
  1119. """
  1120. Check if a builtin type should be included.
  1121. This removes Variant and POD types from inclusion, and the current type.
  1122. """
  1123. to_include = get_enum_class(type_name) if is_enum(type_name) else type_name
  1124. if to_include == current_type or is_pod_type(to_include):
  1125. return False
  1126. if to_include == "GlobalConstants" or to_include == "UtilityFunctions":
  1127. return True
  1128. return is_engine_class(to_include) or is_variant(to_include)
  1129. def correct_default_value(value, type_name):
  1130. value_map = {
  1131. "null": "nullptr",
  1132. '""': "String()",
  1133. '&""': "StringName()",
  1134. "[]": "Array()",
  1135. "{}": "Dictionary()",
  1136. "Transform2D(1, 0, 0, 1, 0, 0)": "Transform2D()", # Default transform.
  1137. "Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)": "Transform3D()", # Default transform.
  1138. }
  1139. if value in value_map:
  1140. return value_map[value]
  1141. if value == "":
  1142. return f"{type_name}()"
  1143. return value
  1144. def correct_type(type_name, meta=None):
  1145. type_conversion = {"float": "double", "int": "int64_t", "Nil": "Variant"}
  1146. if meta != None:
  1147. if "int" in meta:
  1148. return f"{meta}_t"
  1149. else:
  1150. return meta
  1151. if type_name in type_conversion:
  1152. return type_conversion[type_name]
  1153. if is_enum(type_name):
  1154. base_class = get_enum_class(type_name)
  1155. if base_class == "GlobalConstants":
  1156. return f"{get_enum_name(type_name)}"
  1157. return f"{base_class}::{get_enum_name(type_name)}"
  1158. if is_refcounted(type_name):
  1159. return f"Ref<{type_name}>"
  1160. if type_name == "Object" or is_engine_class(type_name):
  1161. return f"{type_name} *"
  1162. if type_name.endswith("*"):
  1163. return f"{type_name[:-1]} *"
  1164. return type_name
  1165. def get_gdnative_type(type_name):
  1166. type_conversion_map = {
  1167. "bool": "uint32_t",
  1168. "int": "int64_t",
  1169. "float": "double",
  1170. }
  1171. if type_name in type_conversion_map:
  1172. return type_conversion_map[type_name]
  1173. return type_name
  1174. def escape_identifier(id):
  1175. cpp_keywords_map = {
  1176. "class": "_class",
  1177. "char": "_char",
  1178. "short": "_short",
  1179. "bool": "_bool",
  1180. "int": "_int",
  1181. "default": "_default",
  1182. "case": "_case",
  1183. "switch": "_switch",
  1184. "export": "_export",
  1185. "template": "_template",
  1186. "new": "new_",
  1187. "operator": "_operator",
  1188. "typeof": "type_of",
  1189. "typename": "type_name",
  1190. }
  1191. if id in cpp_keywords_map:
  1192. return cpp_keywords_map[id]
  1193. return id
  1194. def get_operator_id_name(op):
  1195. op_id_map = {
  1196. "==": "equal",
  1197. "!=": "not_equal",
  1198. "<": "less",
  1199. "<=": "less_equal",
  1200. ">": "greater",
  1201. ">=": "greater_equal",
  1202. "+": "add",
  1203. "-": "subtract",
  1204. "*": "multiply",
  1205. "/": "divide",
  1206. "unary-": "negate",
  1207. "unary+": "positive",
  1208. "%": "module",
  1209. "<<": "shift_left",
  1210. ">>": "shift_right",
  1211. "&": "bit_and",
  1212. "|": "bit_or",
  1213. "^": "bit_xor",
  1214. "~": "bit_negate",
  1215. "and": "and",
  1216. "or": "or",
  1217. "xor": "xor",
  1218. "not": "not",
  1219. "and": "and",
  1220. "in": "in",
  1221. }
  1222. return op_id_map[op]
  1223. def get_default_value_for_type(type_name):
  1224. if type_name == "int":
  1225. return "0"
  1226. if type_name == "float":
  1227. return "0.0"
  1228. if type_name == "bool":
  1229. return "false"
  1230. if is_enum(type_name):
  1231. return f"{correct_type(type_name)}(0)"
  1232. if is_variant(type_name):
  1233. return f"{type_name}()"
  1234. if is_refcounted(type_name):
  1235. return f"Ref<{type_name}>()"
  1236. return "nullptr"
  1237. header = """\
  1238. /*************************************************************************/
  1239. /* $filename */
  1240. /*************************************************************************/
  1241. /* This file is part of: */
  1242. /* GODOT ENGINE */
  1243. /* https://godotengine.org */
  1244. /*************************************************************************/
  1245. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  1246. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  1247. /* */
  1248. /* Permission is hereby granted, free of charge, to any person obtaining */
  1249. /* a copy of this software and associated documentation files (the */
  1250. /* "Software"), to deal in the Software without restriction, including */
  1251. /* without limitation the rights to use, copy, modify, merge, publish, */
  1252. /* distribute, sublicense, and/or sell copies of the Software, and to */
  1253. /* permit persons to whom the Software is furnished to do so, subject to */
  1254. /* the following conditions: */
  1255. /* */
  1256. /* The above copyright notice and this permission notice shall be */
  1257. /* included in all copies or substantial portions of the Software. */
  1258. /* */
  1259. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  1260. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  1261. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  1262. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  1263. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  1264. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  1265. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  1266. /*************************************************************************/
  1267. """
  1268. def add_header(filename, lines):
  1269. desired_length = len(header.split("\n")[0])
  1270. pad_spaces = desired_length - 6 - len(filename)
  1271. for num, line in enumerate(header.split("\n")):
  1272. if num == 1:
  1273. new_line = f"/* {filename}{' ' * pad_spaces}*/"
  1274. lines.append(new_line)
  1275. else:
  1276. lines.append(line)
  1277. lines.append("// THIS FILE IS GENERATED. EDITS WILL BE LOST.")
  1278. lines.append("")