binding_generator.py 59 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562
  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. engine_classes[class_api["name"]] = class_api["is_refcounted"]
  519. for class_api in api["classes"]:
  520. # Check used classes for header include.
  521. used_classes = set()
  522. fully_used_classes = set()
  523. class_name = class_api["name"]
  524. header_filename = include_gen_folder / (camel_to_snake(class_api["name"]) + ".hpp")
  525. source_filename = source_gen_folder / (camel_to_snake(class_api["name"]) + ".cpp")
  526. if "methods" in class_api:
  527. for method in class_api["methods"]:
  528. if "arguments" in method:
  529. for argument in method["arguments"]:
  530. if is_included(argument["type"], class_name):
  531. if is_enum(argument["type"]):
  532. fully_used_classes.add(get_enum_class(argument["type"]))
  533. elif "default_value" in argument:
  534. fully_used_classes.add(argument["type"])
  535. else:
  536. used_classes.add(argument["type"])
  537. if is_refcounted(argument["type"]):
  538. fully_used_classes.add("Ref")
  539. if "return_value" in method:
  540. if is_included(method["return_value"]["type"], class_name):
  541. if is_enum(method["return_value"]["type"]):
  542. fully_used_classes.add(get_enum_class(method["return_value"]["type"]))
  543. elif is_variant(method["return_value"]["type"]):
  544. fully_used_classes.add(method["return_value"]["type"])
  545. else:
  546. used_classes.add(method["return_value"]["type"])
  547. if is_refcounted(method["return_value"]["type"]):
  548. fully_used_classes.add("Ref")
  549. if "members" in class_api:
  550. for member in class_api["members"]:
  551. if is_included(member["type"], class_name):
  552. if is_enum(member["type"]):
  553. fully_used_classes.add(get_enum_class(member["type"]))
  554. else:
  555. used_classes.add(member["type"])
  556. if is_refcounted(member["type"]):
  557. fully_used_classes.add("Ref")
  558. if "inherits" in class_api:
  559. if is_included(class_api["inherits"], class_name):
  560. fully_used_classes.add(class_api["inherits"])
  561. if is_refcounted(class_api["name"]):
  562. fully_used_classes.add("Ref")
  563. else:
  564. fully_used_classes.add("Wrapped")
  565. for type_name in fully_used_classes:
  566. if type_name in used_classes:
  567. used_classes.remove(type_name)
  568. with header_filename.open("w+") as header_file:
  569. header_file.write(
  570. generate_engine_class_header(class_api, used_classes, fully_used_classes, use_template_get_node)
  571. )
  572. with source_filename.open("w+") as source_file:
  573. source_file.write(
  574. generate_engine_class_source(class_api, used_classes, fully_used_classes, use_template_get_node)
  575. )
  576. def generate_engine_class_header(class_api, used_classes, fully_used_classes, use_template_get_node):
  577. result = []
  578. class_name = class_api["name"]
  579. snake_class_name = camel_to_snake(class_name).upper()
  580. add_header(f"{snake_class_name.lower()}.hpp", result)
  581. header_guard = f"GODOT_CPP_{snake_class_name}_HPP"
  582. result.append(f"#ifndef {header_guard}")
  583. result.append(f"#define {header_guard}")
  584. result.append("")
  585. for included in fully_used_classes:
  586. result.append(f"#include <godot_cpp/{get_include_path(included)}>")
  587. if len(fully_used_classes) > 0:
  588. result.append("")
  589. if class_name != "Object":
  590. result.append("#include <godot_cpp/core/class_db.hpp>")
  591. result.append("")
  592. result.append("#include <type_traits>")
  593. result.append("")
  594. result.append("namespace godot {")
  595. result.append("")
  596. for type_name in used_classes:
  597. result.append(f"class {type_name};")
  598. if len(used_classes) > 0:
  599. result.append("")
  600. inherits = class_api["inherits"] if "inherits" in class_api else "Wrapped"
  601. result.append(f"class {class_name} : public {inherits} {{")
  602. result.append(f"\tGDNATIVE_CLASS({class_name}, {inherits})")
  603. result.append("")
  604. result.append("public:")
  605. if "enums" in class_api:
  606. for enum_api in class_api["enums"]:
  607. result.append(f'\tenum {enum_api["name"]} {{')
  608. for value in enum_api["values"]:
  609. result.append(f'\t\t{value["name"]} = {value["value"]},')
  610. result.append("\t};")
  611. result.append("")
  612. if "methods" in class_api:
  613. for method in class_api["methods"]:
  614. if method["is_virtual"]:
  615. # Will be done later.
  616. continue
  617. vararg = "is_vararg" in method and method["is_vararg"]
  618. method_signature = "\t"
  619. if vararg:
  620. method_signature += "private: "
  621. method_signature += make_signature(
  622. class_name, method, for_header=True, use_template_get_node=use_template_get_node
  623. )
  624. result.append(method_signature + ";")
  625. if vararg:
  626. # Add templated version.
  627. result += make_varargs_template(method)
  628. # Virtuals now.
  629. for method in class_api["methods"]:
  630. if not method["is_virtual"]:
  631. continue
  632. method_signature = "\t"
  633. method_signature += make_signature(class_name, method, for_header=True, use_template_get_node=use_template_get_node)
  634. result.append(method_signature + ";")
  635. result.append("protected:")
  636. result.append("\ttemplate <class T>")
  637. result.append("\tstatic void register_virtuals() {")
  638. if class_name != "Object":
  639. result.append(f"\t\t{inherits}::register_virtuals<T>();")
  640. if "methods" in class_api:
  641. for method in class_api["methods"]:
  642. if not method["is_virtual"]:
  643. continue
  644. method_name = escape_identifier(method["name"])
  645. result.append(f"\t\tif constexpr (!std::is_same_v<decltype(&{class_name}::{method_name}),decltype(&T::{method_name})>) {{")
  646. result.append(f"\t\t\tBIND_VIRTUAL_METHOD(T, {method_name});")
  647. result.append("\t\t}")
  648. result.append("\t}")
  649. result.append("")
  650. result.append("public:")
  651. # Special cases.
  652. if class_name == "Object":
  653. result.append("")
  654. result.append("\ttemplate<class T>")
  655. result.append("\tstatic T *cast_to(Object *p_object);")
  656. elif use_template_get_node and class_name == "Node":
  657. result.append("\ttemplate<class T>")
  658. result.append("\tT *get_node(const NodePath &p_path) const { return Object::cast_to<T>(get_node_internal(p_path)); }")
  659. # Constructor.
  660. result.append("")
  661. result.append(f"\t{class_name}();")
  662. result.append("")
  663. result.append("};")
  664. result.append("")
  665. result.append("} // namespace godot")
  666. result.append(f"#endif // ! {header_guard}")
  667. return "\n".join(result)
  668. def generate_engine_class_source(class_api, used_classes, fully_used_classes, use_template_get_node):
  669. result = []
  670. class_name = class_api["name"]
  671. snake_class_name = camel_to_snake(class_name)
  672. inherits = class_api["inherits"] if "inherits" in class_api else "Wrapped"
  673. add_header(f"{snake_class_name}.cpp", result)
  674. result.append(f"#include <godot_cpp/classes/{snake_class_name}.hpp>")
  675. result.append("")
  676. result.append(f"#include <godot_cpp/core/engine_ptrcall.hpp>")
  677. result.append(f"#include <godot_cpp/core/error_macros.hpp>")
  678. result.append("")
  679. for included in used_classes:
  680. result.append(f"#include <godot_cpp/{get_include_path(included)}>")
  681. if len(used_classes) > 0:
  682. result.append(f"")
  683. result.append("namespace godot {")
  684. result.append("")
  685. if "methods" in class_api:
  686. for method in class_api["methods"]:
  687. if method["is_virtual"]:
  688. # Will be done later
  689. continue
  690. vararg = "is_vararg" in method and method["is_vararg"]
  691. # Method signature.
  692. method_signature = make_signature(class_name, method, use_template_get_node=use_template_get_node)
  693. result.append(method_signature + " {")
  694. # Method body.
  695. result.append(
  696. f'\tstatic GDNativeMethodBindPtr ___method_bind = internal::interface->classdb_get_method_bind("{class_name}", "{method["name"]}", {method["hash"]});'
  697. )
  698. method_call = "\t"
  699. has_return = "return_value" in method and method["return_value"]["type"] != "void"
  700. if has_return:
  701. result.append(
  702. f'\tCHECK_METHOD_BIND_RET(___method_bind, {get_default_value_for_type(method["return_value"]["type"])});'
  703. )
  704. else:
  705. result.append(f"\tCHECK_METHOD_BIND(___method_bind);")
  706. is_ref = False
  707. if not vararg:
  708. if has_return:
  709. return_type = method["return_value"]["type"]
  710. meta_type = method["return_value"]["meta"] if "meta" in method["return_value"] else None
  711. if is_pod_type(return_type) or is_variant(return_type) or is_enum(return_type):
  712. method_call += f"return internal::_call_native_mb_ret<{correct_type(return_type, meta_type)}>(___method_bind, _owner"
  713. elif is_refcounted(return_type):
  714. method_call += f"return Ref<{return_type}>::___internal_constructor(internal::_call_native_mb_ret_obj<{return_type}>(___method_bind, _owner"
  715. is_ref = True
  716. else:
  717. method_call += f"return ({correct_type(return_type)})internal::_call_native_mb_ret_obj<{return_type}>(___method_bind, _owner"
  718. else:
  719. method_call += f"internal::_call_native_mb_no_ret(___method_bind, _owner"
  720. if "arguments" in method:
  721. method_call += ", "
  722. arguments = []
  723. for argument in method["arguments"]:
  724. (encode, arg_name) = get_encoded_arg(
  725. argument["name"],
  726. argument["type"],
  727. argument["meta"] if "meta" in argument else None,
  728. )
  729. result += encode
  730. arguments.append(arg_name)
  731. method_call += ", ".join(arguments)
  732. else: # vararg.
  733. result.append("\tGDNativeCallError error;")
  734. result.append("\tVariant ret;")
  735. method_call += "internal::interface->object_method_bind_call(___method_bind, _owner, (const GDNativeVariantPtr *)args, arg_count, &ret, &error"
  736. if is_ref:
  737. method_call += ")" # Close Ref<> constructor.
  738. method_call += ");"
  739. result.append(method_call)
  740. if vararg and ("return_value" in method and method["return_value"]["type"] != "void"):
  741. result.append("\treturn ret;")
  742. result.append("}")
  743. result.append("")
  744. # Virtuals now.
  745. for method in class_api["methods"]:
  746. if not method["is_virtual"]:
  747. continue
  748. method_signature = make_signature(class_name, method, use_template_get_node=use_template_get_node)
  749. method_signature += " {"
  750. if "return_value" in method and correct_type(method["return_value"]["type"]) != "void":
  751. result.append(method_signature)
  752. result.append(f'\treturn {get_default_value_for_type(method["return_value"]["type"])};')
  753. result.append("}")
  754. else:
  755. method_signature += "}"
  756. result.append(method_signature)
  757. result.append("")
  758. # Constructor.
  759. result.append(f"{class_name}::{class_name}() : {inherits}(godot::internal::empty_constructor()) {{")
  760. result.append(
  761. f'\tstatic GDNativeClassConstructor constructor = internal::interface->classdb_get_constructor("{class_name}");'
  762. )
  763. result.append("\t_owner = (GodotObject *)constructor();")
  764. result.append(
  765. f"\tinternal::interface->object_set_instance_binding((GDNativeObjectPtr)_owner, internal::token, this, &{class_name}::___binding_callbacks);"
  766. )
  767. result.append("}")
  768. result.append("")
  769. result.append("} // namespace godot ")
  770. return "\n".join(result)
  771. def generate_global_constants(api, output_dir):
  772. include_gen_folder = Path(output_dir) / "include" / "godot_cpp" / "classes"
  773. source_gen_folder = Path(output_dir) / "src" / "classes"
  774. include_gen_folder.mkdir(parents=True, exist_ok=True)
  775. source_gen_folder.mkdir(parents=True, exist_ok=True)
  776. # Generate header
  777. header = []
  778. add_header("global_constants.hpp", header)
  779. header_filename = include_gen_folder / "global_constants.hpp"
  780. header_guard = "GODOT_CPP_GLOBAL_CONSTANTS_HPP"
  781. header.append(f"#ifndef {header_guard}")
  782. header.append(f"#define {header_guard}")
  783. header.append("")
  784. header.append("namespace godot {")
  785. header.append("")
  786. for constant in api["global_constants"]:
  787. header.append(f'\tconst int {escape_identifier(constant["name"])} = {constant["value"]};')
  788. header.append("")
  789. for enum_def in api["global_enums"]:
  790. if enum_def["name"].startswith("Variant."):
  791. continue
  792. header.append(f'\tenum {enum_def["name"]} {{')
  793. for value in enum_def["values"]:
  794. header.append(f'\t\t{value["name"]} = {value["value"]},')
  795. header.append("\t};")
  796. header.append("")
  797. header.append("} // namespace godot")
  798. header.append("")
  799. header.append(f"#endif // ! {header_guard}")
  800. with header_filename.open("w+") as header_file:
  801. header_file.write("\n".join(header))
  802. def generate_utility_functions(api, output_dir):
  803. include_gen_folder = Path(output_dir) / "include" / "godot_cpp" / "variant"
  804. source_gen_folder = Path(output_dir) / "src" / "variant"
  805. include_gen_folder.mkdir(parents=True, exist_ok=True)
  806. source_gen_folder.mkdir(parents=True, exist_ok=True)
  807. # Generate header.
  808. header = []
  809. add_header("utility_functions.hpp", header)
  810. header_filename = include_gen_folder / "utility_functions.hpp"
  811. header_guard = "GODOT_CPP_UTILITY_FUNCTIONS_HPP"
  812. header.append(f"#ifndef {header_guard}")
  813. header.append(f"#define {header_guard}")
  814. header.append("")
  815. header.append("#include <godot_cpp/variant/builtin_types.hpp>")
  816. header.append("#include <godot_cpp/variant/variant.hpp>")
  817. header.append("")
  818. header.append("#include <array>")
  819. header.append("")
  820. header.append("namespace godot {")
  821. header.append("")
  822. header.append("class UtilityFunctions {")
  823. header.append("public:")
  824. for function in api["utility_functions"]:
  825. vararg = "is_vararg" in function and function["is_vararg"]
  826. function_signature = "\t"
  827. function_signature += make_signature("UtilityFunctions", function, for_header=True, static=True)
  828. header.append(function_signature + ";")
  829. if vararg:
  830. # Add templated version.
  831. header += make_varargs_template(function, static=True)
  832. header.append("};")
  833. header.append("")
  834. header.append("} // namespace godot")
  835. header.append("")
  836. header.append(f"#endif // ! {header_guard}")
  837. with header_filename.open("w+") as header_file:
  838. header_file.write("\n".join(header))
  839. # Generate source.
  840. source = []
  841. add_header("utility_functions.cpp", source)
  842. source_filename = source_gen_folder / "utility_functions.cpp"
  843. source.append("#include <godot_cpp/variant/utility_functions.hpp>")
  844. source.append("")
  845. source.append("#include <godot_cpp/core/error_macros.hpp>")
  846. source.append("#include <godot_cpp/core/engine_ptrcall.hpp>")
  847. source.append("")
  848. source.append("namespace godot {")
  849. source.append("")
  850. for function in api["utility_functions"]:
  851. vararg = "is_vararg" in function and function["is_vararg"]
  852. function_signature = make_signature("UtilityFunctions", function)
  853. source.append(function_signature + " {")
  854. # Function body.
  855. source.append(
  856. f'\tstatic GDNativePtrUtilityFunction ___function = internal::interface->variant_get_ptr_utility_function("{function["name"]}", {function["hash"]});'
  857. )
  858. has_return = "return_type" in function and function["return_type"] != "void"
  859. if has_return:
  860. source.append(
  861. f'\tCHECK_METHOD_BIND_RET(___function, {get_default_value_for_type(function["return_type"])});'
  862. )
  863. else:
  864. source.append(f"\tCHECK_METHOD_BIND(___function);")
  865. function_call = "\t"
  866. if not vararg:
  867. if has_return:
  868. function_call += "return "
  869. if function["return_type"] == "Object":
  870. function_call += "internal::_call_utility_ret_obj(___function"
  871. else:
  872. function_call += f'internal::_call_utility_ret<{correct_type(function["return_type"])}>(___function'
  873. else:
  874. function_call += "internal::_call_utility_no_ret(___function"
  875. if "arguments" in function:
  876. function_call += ", "
  877. arguments = []
  878. for argument in function["arguments"]:
  879. (encode, arg_name) = get_encoded_arg(
  880. argument["name"],
  881. argument["type"],
  882. argument["meta"] if "meta" in argument else None,
  883. )
  884. source += encode
  885. arguments.append(arg_name)
  886. function_call += ", ".join(arguments)
  887. else:
  888. source.append("\tVariant ret;")
  889. function_call += "___function(&ret, (const GDNativeVariantPtr *)args, arg_count"
  890. function_call += ");"
  891. source.append(function_call)
  892. if vararg and has_return:
  893. source.append("\treturn ret;")
  894. source.append("}")
  895. source.append("")
  896. source.append("} // namespace godot")
  897. with source_filename.open("w+") as source_file:
  898. source_file.write("\n".join(source))
  899. # Helper functions.
  900. def camel_to_snake(name):
  901. name = re.sub("(.)([A-Z][a-z]+)", r"\1_\2", name)
  902. name = re.sub("([a-z0-9])([A-Z])", r"\1_\2", name)
  903. return name.replace("2_D", "2D").replace("3_D", "3D").lower()
  904. def make_function_parameters(parameters, include_default=False, for_builtin=False, is_vararg=False):
  905. signature = []
  906. for index, par in enumerate(parameters):
  907. parameter = type_for_parameter(par["type"], par["meta"] if "meta" in par else None)
  908. parameter_name = escape_identifier(par["name"])
  909. if len(parameter_name) == 0:
  910. parameter_name = "arg_" + str(index + 1)
  911. parameter += parameter_name
  912. if include_default and "default_value" in par and (not for_builtin or par["type"] != "Variant"):
  913. parameter += " = "
  914. if is_enum(par["type"]):
  915. parameter_type = correct_type(par["type"])
  916. if parameter_type == "void":
  917. parameter_type = "Variant"
  918. parameter += f'({parameter_type})'
  919. parameter += correct_default_value(par["default_value"], par["type"])
  920. signature.append(parameter)
  921. if is_vararg:
  922. signature.append("const Args&... args")
  923. return ", ".join(signature)
  924. def type_for_parameter(type_name, meta=None):
  925. if type_name == "void":
  926. return "Variant "
  927. elif is_pod_type(type_name) and type_name != "Nil" or is_enum(type_name):
  928. return f"{correct_type(type_name, meta)} "
  929. elif is_variant(type_name) or is_refcounted(type_name):
  930. return f"const {correct_type(type_name)} &"
  931. else:
  932. return f"{correct_type(type_name)}"
  933. def get_include_path(type_name):
  934. base_dir = ""
  935. if type_name == "Object":
  936. base_dir = "core"
  937. elif is_variant(type_name):
  938. base_dir = "variant"
  939. else:
  940. base_dir = "classes"
  941. return f"{base_dir}/{camel_to_snake(type_name)}.hpp"
  942. def get_encoded_arg(arg_name, type_name, type_meta):
  943. result = []
  944. name = escape_identifier(arg_name)
  945. arg_type = correct_type(type_name)
  946. if is_pod_type(arg_type):
  947. result.append(f"\t{get_gdnative_type(arg_type)} {name}_encoded;")
  948. result.append(f"\tPtrToArg<{correct_type(type_name, type_meta)}>::encode({name}, &{name}_encoded);")
  949. name = f"&{name}_encoded"
  950. elif is_engine_class(type_name):
  951. name = f"{name}->_owner"
  952. else:
  953. name = f"&{name}"
  954. return (result, name)
  955. def make_signature(class_name, function_data, for_header=False, use_template_get_node=True, for_builtin=False, static=False):
  956. function_signature = ""
  957. is_vararg = "is_vararg" in function_data and function_data["is_vararg"]
  958. if for_header:
  959. if "is_virtual" in function_data and function_data["is_virtual"]:
  960. function_signature += "virtual "
  961. if is_vararg:
  962. function_signature += "private: "
  963. if static:
  964. function_signature += "static "
  965. return_type = "void"
  966. return_meta = None
  967. if "return_type" in function_data:
  968. return_type = correct_type(function_data["return_type"])
  969. elif "return_value" in function_data:
  970. return_type = function_data["return_value"]["type"]
  971. return_meta = function_data["return_value"]["meta"] if "meta" in function_data["return_value"] else None
  972. function_signature += correct_type(
  973. return_type,
  974. return_meta,
  975. )
  976. if not function_signature.endswith("*"):
  977. function_signature += " "
  978. if not for_header:
  979. function_signature += f"{class_name}::"
  980. function_signature += escape_identifier(function_data["name"])
  981. if is_vararg or (
  982. not for_builtin and use_template_get_node and class_name == "Node" and function_data["name"] == "get_node"
  983. ):
  984. function_signature += "_internal"
  985. function_signature += "("
  986. arguments = function_data["arguments"] if "arguments" in function_data else []
  987. if not is_vararg:
  988. function_signature += make_function_parameters(arguments, for_header, for_builtin, is_vararg)
  989. else:
  990. function_signature += "const Variant **args, GDNativeInt arg_count"
  991. function_signature += ")"
  992. if "is_const" in function_data and function_data["is_const"]:
  993. function_signature += " const"
  994. return function_signature
  995. def make_varargs_template(function_data, static=False):
  996. result = []
  997. function_signature = "\tpublic: template<class... Args> "
  998. if static:
  999. function_signature += "static "
  1000. return_type = "void"
  1001. return_meta = None
  1002. if "return_type" in function_data:
  1003. return_type = correct_type(function_data["return_type"])
  1004. elif "return_value" in function_data:
  1005. return_type = function_data["return_value"]["type"]
  1006. return_meta = function_data["return_value"]["meta"] if "meta" in function_data["return_value"] else None
  1007. function_signature += correct_type(
  1008. return_type,
  1009. return_meta,
  1010. )
  1011. if not function_signature.endswith("*"):
  1012. function_signature += " "
  1013. function_signature += f'{escape_identifier(function_data["name"])}'
  1014. method_arguments = []
  1015. if "arguments" in function_data:
  1016. method_arguments = function_data["arguments"]
  1017. function_signature += "("
  1018. is_vararg = "is_vararg" in function_data and function_data["is_vararg"]
  1019. function_signature += make_function_parameters(method_arguments, include_default=True, is_vararg=is_vararg)
  1020. function_signature += ")"
  1021. if "is_const" in function_data and function_data["is_const"]:
  1022. function_signature += " const"
  1023. function_signature += " {"
  1024. result.append(function_signature)
  1025. args_array = f"\t\tstd::array<Variant, {len(method_arguments)} + sizeof...(Args)> variant_args {{ "
  1026. for argument in method_arguments:
  1027. if argument["type"] == "Variant":
  1028. args_array += argument["name"]
  1029. else:
  1030. args_array += f'Variant({argument["name"]})'
  1031. args_array += ", "
  1032. args_array += "Variant(args)... };"
  1033. result.append(args_array)
  1034. result.append(f"\t\tstd::array<const Variant *, {len(method_arguments)} + sizeof...(Args)> call_args;")
  1035. result.append("\t\tfor(size_t i = 0; i < variant_args.size(); i++) {")
  1036. result.append("\t\t\tcall_args[i] = &variant_args[i];")
  1037. result.append("\t\t}")
  1038. call_line = "\t\t"
  1039. if "return_value" in function_data and function_data["return_value"]["type"] != "void":
  1040. call_line += "return "
  1041. call_line += f'{escape_identifier(function_data["name"])}_internal(call_args.data(), variant_args.size());'
  1042. result.append(call_line)
  1043. result.append("\t}")
  1044. return result
  1045. # Engine idiosyncrasies.
  1046. def is_pod_type(type_name):
  1047. """
  1048. Those are types for which no class should be generated.
  1049. """
  1050. return type_name in [
  1051. "Nil",
  1052. "void",
  1053. "int",
  1054. "float",
  1055. "bool",
  1056. ]
  1057. def is_enum(type_name):
  1058. return type_name.startswith("enum::")
  1059. def get_enum_class(enum_name: str):
  1060. if "." in enum_name:
  1061. return enum_name.replace("enum::", "").split(".")[0]
  1062. else:
  1063. return "GlobalConstants"
  1064. def get_enum_name(enum_name: str):
  1065. return enum_name.replace("enum::", "").split(".")[-1]
  1066. def is_variant(type_name):
  1067. return type_name == "Variant" or type_name in builtin_classes or type_name == "Nil"
  1068. def is_engine_class(type_name):
  1069. return type_name in engine_classes
  1070. def is_refcounted(type_name):
  1071. return type_name in engine_classes and engine_classes[type_name]
  1072. def is_included(type_name, current_type):
  1073. """
  1074. Check if a builtin type should be included.
  1075. This removes Variant and POD types from inclusion, and the current type.
  1076. """
  1077. to_include = get_enum_class(type_name) if is_enum(type_name) else type_name
  1078. return to_include != current_type and not is_pod_type(to_include)
  1079. def correct_default_value(value, type_name):
  1080. value_map = {
  1081. "null": "nullptr",
  1082. '""': "String()",
  1083. '&""': "StringName()",
  1084. "[]": "Array()",
  1085. "{}": "Dictionary()",
  1086. "Transform2D(1, 0, 0, 1, 0, 0)": "Transform2D()", # Default transform.
  1087. "Transform3D(1, 0, 0, 0, 1, 0, 0, 0, 1, 0, 0, 0)": "Transform3D()", # Default transform.
  1088. }
  1089. if value in value_map:
  1090. return value_map[value]
  1091. if value == "":
  1092. return f"{type_name}()"
  1093. return value
  1094. def correct_type(type_name, meta=None):
  1095. type_conversion = {"float": "double", "int": "int64_t", "Nil": "Variant"}
  1096. if meta != None:
  1097. if "int" in meta:
  1098. return f"{meta}_t"
  1099. else:
  1100. return meta
  1101. if type_name in type_conversion:
  1102. return type_conversion[type_name]
  1103. if is_enum(type_name):
  1104. base_class = get_enum_class(type_name)
  1105. if base_class == "GlobalConstants":
  1106. return f"{get_enum_name(type_name)}"
  1107. return f"{base_class}::{get_enum_name(type_name)}"
  1108. if is_refcounted(type_name):
  1109. return f"Ref<{type_name}>"
  1110. if type_name == "Object" or is_engine_class(type_name):
  1111. return f"{type_name} *"
  1112. return type_name
  1113. def get_gdnative_type(type_name):
  1114. type_conversion_map = {
  1115. "bool": "uint32_t",
  1116. "int": "int64_t",
  1117. "float": "double",
  1118. }
  1119. if type_name in type_conversion_map:
  1120. return type_conversion_map[type_name]
  1121. return type_name
  1122. def escape_identifier(id):
  1123. cpp_keywords_map = {
  1124. "class": "_class",
  1125. "char": "_char",
  1126. "short": "_short",
  1127. "bool": "_bool",
  1128. "int": "_int",
  1129. "default": "_default",
  1130. "case": "_case",
  1131. "switch": "_switch",
  1132. "export": "_export",
  1133. "template": "_template",
  1134. "new": "new_",
  1135. "operator": "_operator",
  1136. "typeof": "type_of",
  1137. "typename": "type_name",
  1138. }
  1139. if id in cpp_keywords_map:
  1140. return cpp_keywords_map[id]
  1141. return id
  1142. def get_operator_id_name(op):
  1143. op_id_map = {
  1144. "==": "equal",
  1145. "!=": "not_equal",
  1146. "<": "less",
  1147. "<=": "less_equal",
  1148. ">": "greater",
  1149. ">=": "greater_equal",
  1150. "+": "add",
  1151. "-": "subtract",
  1152. "*": "multiply",
  1153. "/": "divide",
  1154. "unary-": "negate",
  1155. "unary+": "positive",
  1156. "%": "module",
  1157. "<<": "shift_left",
  1158. ">>": "shift_right",
  1159. "&": "bit_and",
  1160. "|": "bit_or",
  1161. "^": "bit_xor",
  1162. "~": "bit_negate",
  1163. "and": "and",
  1164. "or": "or",
  1165. "xor": "xor",
  1166. "not": "not",
  1167. "and": "and",
  1168. "in": "in",
  1169. }
  1170. return op_id_map[op]
  1171. def get_default_value_for_type(type_name):
  1172. if type_name == "int":
  1173. return "0"
  1174. if type_name == "float":
  1175. return "0.0"
  1176. if type_name == "bool":
  1177. return "false"
  1178. if is_enum(type_name):
  1179. return f"{correct_type(type_name)}(0)"
  1180. if is_variant(type_name):
  1181. return f"{type_name}()"
  1182. if is_refcounted(type_name):
  1183. return f"Ref<{type_name}>()"
  1184. return "nullptr"
  1185. header = """\
  1186. /*************************************************************************/
  1187. /* $filename */
  1188. /*************************************************************************/
  1189. /* This file is part of: */
  1190. /* GODOT ENGINE */
  1191. /* https://godotengine.org */
  1192. /*************************************************************************/
  1193. /* Copyright (c) 2007-2021 Juan Linietsky, Ariel Manzur. */
  1194. /* Copyright (c) 2014-2021 Godot Engine contributors (cf. AUTHORS.md). */
  1195. /* */
  1196. /* Permission is hereby granted, free of charge, to any person obtaining */
  1197. /* a copy of this software and associated documentation files (the */
  1198. /* "Software"), to deal in the Software without restriction, including */
  1199. /* without limitation the rights to use, copy, modify, merge, publish, */
  1200. /* distribute, sublicense, and/or sell copies of the Software, and to */
  1201. /* permit persons to whom the Software is furnished to do so, subject to */
  1202. /* the following conditions: */
  1203. /* */
  1204. /* The above copyright notice and this permission notice shall be */
  1205. /* included in all copies or substantial portions of the Software. */
  1206. /* */
  1207. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  1208. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  1209. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
  1210. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  1211. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  1212. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  1213. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  1214. /*************************************************************************/
  1215. """
  1216. def add_header(filename, lines):
  1217. desired_length = len(header.split("\n")[0])
  1218. pad_spaces = desired_length - 6 - len(filename)
  1219. for num, line in enumerate(header.split("\n")):
  1220. if num == 1:
  1221. new_line = f"/* {filename}{' ' * pad_spaces}*/"
  1222. lines.append(new_line)
  1223. else:
  1224. lines.append(line)
  1225. lines.append("// THIS FILE IS GENERATED. EDITS WILL BE LOST.")
  1226. lines.append("")