godot.hpp 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252
  1. /**************************************************************************/
  2. /* godot.hpp */
  3. /**************************************************************************/
  4. /* This file is part of: */
  5. /* GODOT ENGINE */
  6. /* https://godotengine.org */
  7. /**************************************************************************/
  8. /* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
  9. /* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
  10. /* */
  11. /* Permission is hereby granted, free of charge, to any person obtaining */
  12. /* a copy of this software and associated documentation files (the */
  13. /* "Software"), to deal in the Software without restriction, including */
  14. /* without limitation the rights to use, copy, modify, merge, publish, */
  15. /* distribute, sublicense, and/or sell copies of the Software, and to */
  16. /* permit persons to whom the Software is furnished to do so, subject to */
  17. /* the following conditions: */
  18. /* */
  19. /* The above copyright notice and this permission notice shall be */
  20. /* included in all copies or substantial portions of the Software. */
  21. /* */
  22. /* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
  23. /* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
  24. /* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
  25. /* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
  26. /* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
  27. /* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
  28. /* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
  29. /**************************************************************************/
  30. #ifndef GODOT_GODOT_HPP
  31. #define GODOT_GODOT_HPP
  32. #include <gdextension_interface.h>
  33. namespace godot {
  34. namespace internal {
  35. extern "C" GDExtensionInterfaceGetProcAddress gdextension_interface_get_proc_address;
  36. extern "C" GDExtensionClassLibraryPtr library;
  37. extern "C" void *token;
  38. extern "C" GDExtensionGodotVersion godot_version;
  39. // All of the GDExtension interface functions.
  40. extern "C" GDExtensionInterfaceGetGodotVersion gdextension_interface_get_godot_version;
  41. extern "C" GDExtensionInterfaceMemAlloc gdextension_interface_mem_alloc;
  42. extern "C" GDExtensionInterfaceMemRealloc gdextension_interface_mem_realloc;
  43. extern "C" GDExtensionInterfaceMemFree gdextension_interface_mem_free;
  44. extern "C" GDExtensionInterfacePrintError gdextension_interface_print_error;
  45. extern "C" GDExtensionInterfacePrintErrorWithMessage gdextension_interface_print_error_with_message;
  46. extern "C" GDExtensionInterfacePrintWarning gdextension_interface_print_warning;
  47. extern "C" GDExtensionInterfacePrintWarningWithMessage gdextension_interface_print_warning_with_message;
  48. extern "C" GDExtensionInterfacePrintScriptError gdextension_interface_print_script_error;
  49. extern "C" GDExtensionInterfacePrintScriptErrorWithMessage gdextension_interface_print_script_error_with_message;
  50. extern "C" GDExtensionInterfaceGetNativeStructSize gdextension_interface_get_native_struct_size;
  51. extern "C" GDExtensionInterfaceVariantNewCopy gdextension_interface_variant_new_copy;
  52. extern "C" GDExtensionInterfaceVariantNewNil gdextension_interface_variant_new_nil;
  53. extern "C" GDExtensionInterfaceVariantDestroy gdextension_interface_variant_destroy;
  54. extern "C" GDExtensionInterfaceVariantCall gdextension_interface_variant_call;
  55. extern "C" GDExtensionInterfaceVariantCallStatic gdextension_interface_variant_call_static;
  56. extern "C" GDExtensionInterfaceVariantEvaluate gdextension_interface_variant_evaluate;
  57. extern "C" GDExtensionInterfaceVariantSet gdextension_interface_variant_set;
  58. extern "C" GDExtensionInterfaceVariantSetNamed gdextension_interface_variant_set_named;
  59. extern "C" GDExtensionInterfaceVariantSetKeyed gdextension_interface_variant_set_keyed;
  60. extern "C" GDExtensionInterfaceVariantSetIndexed gdextension_interface_variant_set_indexed;
  61. extern "C" GDExtensionInterfaceVariantGet gdextension_interface_variant_get;
  62. extern "C" GDExtensionInterfaceVariantGetNamed gdextension_interface_variant_get_named;
  63. extern "C" GDExtensionInterfaceVariantGetKeyed gdextension_interface_variant_get_keyed;
  64. extern "C" GDExtensionInterfaceVariantGetIndexed gdextension_interface_variant_get_indexed;
  65. extern "C" GDExtensionInterfaceVariantIterInit gdextension_interface_variant_iter_init;
  66. extern "C" GDExtensionInterfaceVariantIterNext gdextension_interface_variant_iter_next;
  67. extern "C" GDExtensionInterfaceVariantIterGet gdextension_interface_variant_iter_get;
  68. extern "C" GDExtensionInterfaceVariantHash gdextension_interface_variant_hash;
  69. extern "C" GDExtensionInterfaceVariantRecursiveHash gdextension_interface_variant_recursive_hash;
  70. extern "C" GDExtensionInterfaceVariantHashCompare gdextension_interface_variant_hash_compare;
  71. extern "C" GDExtensionInterfaceVariantBooleanize gdextension_interface_variant_booleanize;
  72. extern "C" GDExtensionInterfaceVariantDuplicate gdextension_interface_variant_duplicate;
  73. extern "C" GDExtensionInterfaceVariantStringify gdextension_interface_variant_stringify;
  74. extern "C" GDExtensionInterfaceVariantGetType gdextension_interface_variant_get_type;
  75. extern "C" GDExtensionInterfaceVariantHasMethod gdextension_interface_variant_has_method;
  76. extern "C" GDExtensionInterfaceVariantHasMember gdextension_interface_variant_has_member;
  77. extern "C" GDExtensionInterfaceVariantHasKey gdextension_interface_variant_has_key;
  78. extern "C" GDExtensionInterfaceVariantGetTypeName gdextension_interface_variant_get_type_name;
  79. extern "C" GDExtensionInterfaceVariantCanConvert gdextension_interface_variant_can_convert;
  80. extern "C" GDExtensionInterfaceVariantCanConvertStrict gdextension_interface_variant_can_convert_strict;
  81. extern "C" GDExtensionInterfaceGetVariantFromTypeConstructor gdextension_interface_get_variant_from_type_constructor;
  82. extern "C" GDExtensionInterfaceGetVariantToTypeConstructor gdextension_interface_get_variant_to_type_constructor;
  83. extern "C" GDExtensionInterfaceVariantGetPtrOperatorEvaluator gdextension_interface_variant_get_ptr_operator_evaluator;
  84. extern "C" GDExtensionInterfaceVariantGetPtrBuiltinMethod gdextension_interface_variant_get_ptr_builtin_method;
  85. extern "C" GDExtensionInterfaceVariantGetPtrConstructor gdextension_interface_variant_get_ptr_constructor;
  86. extern "C" GDExtensionInterfaceVariantGetPtrDestructor gdextension_interface_variant_get_ptr_destructor;
  87. extern "C" GDExtensionInterfaceVariantConstruct gdextension_interface_variant_construct;
  88. extern "C" GDExtensionInterfaceVariantGetPtrSetter gdextension_interface_variant_get_ptr_setter;
  89. extern "C" GDExtensionInterfaceVariantGetPtrGetter gdextension_interface_variant_get_ptr_getter;
  90. extern "C" GDExtensionInterfaceVariantGetPtrIndexedSetter gdextension_interface_variant_get_ptr_indexed_setter;
  91. extern "C" GDExtensionInterfaceVariantGetPtrIndexedGetter gdextension_interface_variant_get_ptr_indexed_getter;
  92. extern "C" GDExtensionInterfaceVariantGetPtrKeyedSetter gdextension_interface_variant_get_ptr_keyed_setter;
  93. extern "C" GDExtensionInterfaceVariantGetPtrKeyedGetter gdextension_interface_variant_get_ptr_keyed_getter;
  94. extern "C" GDExtensionInterfaceVariantGetPtrKeyedChecker gdextension_interface_variant_get_ptr_keyed_checker;
  95. extern "C" GDExtensionInterfaceVariantGetConstantValue gdextension_interface_variant_get_constant_value;
  96. extern "C" GDExtensionInterfaceVariantGetPtrUtilityFunction gdextension_interface_variant_get_ptr_utility_function;
  97. extern "C" GDExtensionInterfaceStringNewWithLatin1Chars gdextension_interface_string_new_with_latin1_chars;
  98. extern "C" GDExtensionInterfaceStringNewWithUtf8Chars gdextension_interface_string_new_with_utf8_chars;
  99. extern "C" GDExtensionInterfaceStringNewWithUtf16Chars gdextension_interface_string_new_with_utf16_chars;
  100. extern "C" GDExtensionInterfaceStringNewWithUtf32Chars gdextension_interface_string_new_with_utf32_chars;
  101. extern "C" GDExtensionInterfaceStringNewWithWideChars gdextension_interface_string_new_with_wide_chars;
  102. extern "C" GDExtensionInterfaceStringNewWithLatin1CharsAndLen gdextension_interface_string_new_with_latin1_chars_and_len;
  103. extern "C" GDExtensionInterfaceStringNewWithUtf8CharsAndLen gdextension_interface_string_new_with_utf8_chars_and_len;
  104. extern "C" GDExtensionInterfaceStringNewWithUtf16CharsAndLen gdextension_interface_string_new_with_utf16_chars_and_len;
  105. extern "C" GDExtensionInterfaceStringNewWithUtf32CharsAndLen gdextension_interface_string_new_with_utf32_chars_and_len;
  106. extern "C" GDExtensionInterfaceStringNewWithWideCharsAndLen gdextension_interface_string_new_with_wide_chars_and_len;
  107. extern "C" GDExtensionInterfaceStringToLatin1Chars gdextension_interface_string_to_latin1_chars;
  108. extern "C" GDExtensionInterfaceStringToUtf8Chars gdextension_interface_string_to_utf8_chars;
  109. extern "C" GDExtensionInterfaceStringToUtf16Chars gdextension_interface_string_to_utf16_chars;
  110. extern "C" GDExtensionInterfaceStringToUtf32Chars gdextension_interface_string_to_utf32_chars;
  111. extern "C" GDExtensionInterfaceStringToWideChars gdextension_interface_string_to_wide_chars;
  112. extern "C" GDExtensionInterfaceStringOperatorIndex gdextension_interface_string_operator_index;
  113. extern "C" GDExtensionInterfaceStringOperatorIndexConst gdextension_interface_string_operator_index_const;
  114. extern "C" GDExtensionInterfaceStringOperatorPlusEqString gdextension_interface_string_operator_plus_eq_string;
  115. extern "C" GDExtensionInterfaceStringOperatorPlusEqChar gdextension_interface_string_operator_plus_eq_char;
  116. extern "C" GDExtensionInterfaceStringOperatorPlusEqCstr gdextension_interface_string_operator_plus_eq_cstr;
  117. extern "C" GDExtensionInterfaceStringOperatorPlusEqWcstr gdextension_interface_string_operator_plus_eq_wcstr;
  118. extern "C" GDExtensionInterfaceStringOperatorPlusEqC32str gdextension_interface_string_operator_plus_eq_c32str;
  119. extern "C" GDExtensionInterfaceStringResize gdextension_interface_string_resize;
  120. extern "C" GDExtensionInterfaceStringNameNewWithLatin1Chars gdextension_interface_string_name_new_with_latin1_chars;
  121. extern "C" GDExtensionInterfaceXmlParserOpenBuffer gdextension_interface_xml_parser_open_buffer;
  122. extern "C" GDExtensionInterfaceFileAccessStoreBuffer gdextension_interface_file_access_store_buffer;
  123. extern "C" GDExtensionInterfaceFileAccessGetBuffer gdextension_interface_file_access_get_buffer;
  124. extern "C" GDExtensionInterfaceWorkerThreadPoolAddNativeGroupTask gdextension_interface_worker_thread_pool_add_native_group_task;
  125. extern "C" GDExtensionInterfaceWorkerThreadPoolAddNativeTask gdextension_interface_worker_thread_pool_add_native_task;
  126. extern "C" GDExtensionInterfacePackedByteArrayOperatorIndex gdextension_interface_packed_byte_array_operator_index;
  127. extern "C" GDExtensionInterfacePackedByteArrayOperatorIndexConst gdextension_interface_packed_byte_array_operator_index_const;
  128. extern "C" GDExtensionInterfacePackedColorArrayOperatorIndex gdextension_interface_packed_color_array_operator_index;
  129. extern "C" GDExtensionInterfacePackedColorArrayOperatorIndexConst gdextension_interface_packed_color_array_operator_index_const;
  130. extern "C" GDExtensionInterfacePackedFloat32ArrayOperatorIndex gdextension_interface_packed_float32_array_operator_index;
  131. extern "C" GDExtensionInterfacePackedFloat32ArrayOperatorIndexConst gdextension_interface_packed_float32_array_operator_index_const;
  132. extern "C" GDExtensionInterfacePackedFloat64ArrayOperatorIndex gdextension_interface_packed_float64_array_operator_index;
  133. extern "C" GDExtensionInterfacePackedFloat64ArrayOperatorIndexConst gdextension_interface_packed_float64_array_operator_index_const;
  134. extern "C" GDExtensionInterfacePackedInt32ArrayOperatorIndex gdextension_interface_packed_int32_array_operator_index;
  135. extern "C" GDExtensionInterfacePackedInt32ArrayOperatorIndexConst gdextension_interface_packed_int32_array_operator_index_const;
  136. extern "C" GDExtensionInterfacePackedInt64ArrayOperatorIndex gdextension_interface_packed_int64_array_operator_index;
  137. extern "C" GDExtensionInterfacePackedInt64ArrayOperatorIndexConst gdextension_interface_packed_int64_array_operator_index_const;
  138. extern "C" GDExtensionInterfacePackedStringArrayOperatorIndex gdextension_interface_packed_string_array_operator_index;
  139. extern "C" GDExtensionInterfacePackedStringArrayOperatorIndexConst gdextension_interface_packed_string_array_operator_index_const;
  140. extern "C" GDExtensionInterfacePackedVector2ArrayOperatorIndex gdextension_interface_packed_vector2_array_operator_index;
  141. extern "C" GDExtensionInterfacePackedVector2ArrayOperatorIndexConst gdextension_interface_packed_vector2_array_operator_index_const;
  142. extern "C" GDExtensionInterfacePackedVector3ArrayOperatorIndex gdextension_interface_packed_vector3_array_operator_index;
  143. extern "C" GDExtensionInterfacePackedVector3ArrayOperatorIndexConst gdextension_interface_packed_vector3_array_operator_index_const;
  144. extern "C" GDExtensionInterfaceArrayOperatorIndex gdextension_interface_array_operator_index;
  145. extern "C" GDExtensionInterfaceArrayOperatorIndexConst gdextension_interface_array_operator_index_const;
  146. extern "C" GDExtensionInterfaceArrayRef gdextension_interface_array_ref;
  147. extern "C" GDExtensionInterfaceArraySetTyped gdextension_interface_array_set_typed;
  148. extern "C" GDExtensionInterfaceDictionaryOperatorIndex gdextension_interface_dictionary_operator_index;
  149. extern "C" GDExtensionInterfaceDictionaryOperatorIndexConst gdextension_interface_dictionary_operator_index_const;
  150. extern "C" GDExtensionInterfaceObjectMethodBindCall gdextension_interface_object_method_bind_call;
  151. extern "C" GDExtensionInterfaceObjectMethodBindPtrcall gdextension_interface_object_method_bind_ptrcall;
  152. extern "C" GDExtensionInterfaceObjectDestroy gdextension_interface_object_destroy;
  153. extern "C" GDExtensionInterfaceGlobalGetSingleton gdextension_interface_global_get_singleton;
  154. extern "C" GDExtensionInterfaceObjectGetInstanceBinding gdextension_interface_object_get_instance_binding;
  155. extern "C" GDExtensionInterfaceObjectSetInstanceBinding gdextension_interface_object_set_instance_binding;
  156. extern "C" GDExtensionInterfaceObjectSetInstance gdextension_interface_object_set_instance;
  157. extern "C" GDExtensionInterfaceObjectGetClassName gdextension_interface_object_get_class_name;
  158. extern "C" GDExtensionInterfaceObjectCastTo gdextension_interface_object_cast_to;
  159. extern "C" GDExtensionInterfaceObjectGetInstanceFromId gdextension_interface_object_get_instance_from_id;
  160. extern "C" GDExtensionInterfaceObjectGetInstanceId gdextension_interface_object_get_instance_id;
  161. extern "C" GDExtensionInterfaceObjectHasScriptMethod gdextension_interface_object_has_script_method;
  162. extern "C" GDExtensionInterfaceObjectCallScriptMethod gdextension_interface_object_call_script_method;
  163. extern "C" GDExtensionInterfaceCallableCustomCreate gdextension_interface_callable_custom_create;
  164. extern "C" GDExtensionInterfaceCallableCustomGetUserData gdextension_interface_callable_custom_get_userdata;
  165. extern "C" GDExtensionInterfaceRefGetObject gdextension_interface_ref_get_object;
  166. extern "C" GDExtensionInterfaceRefSetObject gdextension_interface_ref_set_object;
  167. extern "C" GDExtensionInterfaceScriptInstanceCreate2 gdextension_interface_script_instance_create2;
  168. extern "C" GDExtensionInterfacePlaceHolderScriptInstanceCreate gdextension_interface_placeholder_script_instance_create;
  169. extern "C" GDExtensionInterfacePlaceHolderScriptInstanceUpdate gdextension_interface_placeholder_script_instance_update;
  170. extern "C" GDExtensionInterfaceClassdbConstructObject gdextension_interface_classdb_construct_object;
  171. extern "C" GDExtensionInterfaceClassdbGetMethodBind gdextension_interface_classdb_get_method_bind;
  172. extern "C" GDExtensionInterfaceClassdbGetClassTag gdextension_interface_classdb_get_class_tag;
  173. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClass2 gdextension_interface_classdb_register_extension_class2;
  174. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassMethod gdextension_interface_classdb_register_extension_class_method;
  175. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassVirtualMethod gdextension_interface_classdb_register_extension_class_virtual_method;
  176. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassIntegerConstant gdextension_interface_classdb_register_extension_class_integer_constant;
  177. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassProperty gdextension_interface_classdb_register_extension_class_property;
  178. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassPropertyIndexed gdextension_interface_classdb_register_extension_class_property_indexed;
  179. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassPropertyGroup gdextension_interface_classdb_register_extension_class_property_group;
  180. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassPropertySubgroup gdextension_interface_classdb_register_extension_class_property_subgroup;
  181. extern "C" GDExtensionInterfaceClassdbRegisterExtensionClassSignal gdextension_interface_classdb_register_extension_class_signal;
  182. extern "C" GDExtensionInterfaceClassdbUnregisterExtensionClass gdextension_interface_classdb_unregister_extension_class;
  183. extern "C" GDExtensionInterfaceGetLibraryPath gdextension_interface_get_library_path;
  184. extern "C" GDExtensionInterfaceEditorAddPlugin gdextension_interface_editor_add_plugin;
  185. extern "C" GDExtensionInterfaceEditorRemovePlugin gdextension_interface_editor_remove_plugin;
  186. } // namespace internal
  187. enum ModuleInitializationLevel {
  188. MODULE_INITIALIZATION_LEVEL_CORE = GDEXTENSION_INITIALIZATION_CORE,
  189. MODULE_INITIALIZATION_LEVEL_SERVERS = GDEXTENSION_INITIALIZATION_SERVERS,
  190. MODULE_INITIALIZATION_LEVEL_SCENE = GDEXTENSION_INITIALIZATION_SCENE,
  191. MODULE_INITIALIZATION_LEVEL_EDITOR = GDEXTENSION_INITIALIZATION_EDITOR,
  192. MODULE_INITIALIZATION_LEVEL_MAX
  193. };
  194. class GDExtensionBinding {
  195. public:
  196. using Callback = void (*)(ModuleInitializationLevel p_level);
  197. struct InitData {
  198. GDExtensionInitializationLevel minimum_initialization_level = GDEXTENSION_INITIALIZATION_CORE;
  199. Callback init_callback = nullptr;
  200. Callback terminate_callback = nullptr;
  201. };
  202. class InitDataList {
  203. int data_count = 0;
  204. int data_capacity = 0;
  205. InitData **data = nullptr;
  206. public:
  207. void add(InitData *p_cb);
  208. ~InitDataList();
  209. };
  210. static bool api_initialized;
  211. static int level_initialized[MODULE_INITIALIZATION_LEVEL_MAX];
  212. static InitDataList initdata;
  213. static GDExtensionBool init(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, InitData *p_init_data, GDExtensionInitialization *r_initialization);
  214. public:
  215. static void initialize_level(void *p_userdata, GDExtensionInitializationLevel p_level);
  216. static void deinitialize_level(void *p_userdata, GDExtensionInitializationLevel p_level);
  217. class InitObject {
  218. GDExtensionInterfaceGetProcAddress get_proc_address;
  219. GDExtensionClassLibraryPtr library;
  220. GDExtensionInitialization *initialization;
  221. mutable InitData *init_data = nullptr;
  222. public:
  223. InitObject(GDExtensionInterfaceGetProcAddress p_get_proc_address, GDExtensionClassLibraryPtr p_library, GDExtensionInitialization *r_initialization);
  224. void register_initializer(Callback p_init) const;
  225. void register_terminator(Callback p_init) const;
  226. void set_minimum_library_initialization_level(ModuleInitializationLevel p_level) const;
  227. GDExtensionBool init() const;
  228. };
  229. };
  230. } // namespace godot
  231. #endif // GODOT_GODOT_HPP