From cf591eddfa59839c2620ebf119727f069b965dfe Mon Sep 17 00:00:00 2001 From: Spartan322 Date: Thu, 9 Nov 2023 23:14:58 -0500 Subject: Add ClassBinding helpers OV_BIND_METHOD OV_BIND_SMETHOD OV_BIND_SMETHOD_L Change _bind_methods to use ClassBinding helpers Add utility/StringLiteral Make `GameSingleton::singleton` inline Move `OpenVic::Checksum` implementation to source file Update scripts to ce1aef8d7d9d5ba9851a1abdd981d3b796024079 --- extension/src/openvic-extension/Checksum.cpp | 34 +++++ extension/src/openvic-extension/Checksum.hpp | 27 +--- extension/src/openvic-extension/GameSingleton.cpp | 147 +++++++++------------ extension/src/openvic-extension/GameSingleton.hpp | 2 +- extension/src/openvic-extension/MapMesh.cpp | 22 +-- .../openvic-extension/utility/ClassBindings.hpp | 90 +++++++++++++ .../openvic-extension/utility/StringLiteral.hpp | 106 +++++++++++++++ 7 files changed, 316 insertions(+), 112 deletions(-) create mode 100644 extension/src/openvic-extension/Checksum.cpp create mode 100644 extension/src/openvic-extension/utility/ClassBindings.hpp create mode 100644 extension/src/openvic-extension/utility/StringLiteral.hpp (limited to 'extension/src/openvic-extension') diff --git a/extension/src/openvic-extension/Checksum.cpp b/extension/src/openvic-extension/Checksum.cpp new file mode 100644 index 0000000..6da5afe --- /dev/null +++ b/extension/src/openvic-extension/Checksum.cpp @@ -0,0 +1,34 @@ +#include "Checksum.hpp" + +#include +#include + +#include "openvic-extension/utility/ClassBindings.hpp" + +using namespace OpenVic; +using namespace godot; + +void Checksum::_bind_methods() { + OV_BIND_METHOD(Checksum::get_checksum_text); +} + +Checksum* Checksum::get_singleton() { + return _checksum; +} + +Checksum::Checksum() { + ERR_FAIL_COND(_checksum != nullptr); + _checksum = this; +} + +Checksum::~Checksum() { + ERR_FAIL_COND(_checksum != this); + _checksum = nullptr; +} + +/* REQUIREMENTS: + * DAT-8 + */ +godot::String Checksum::get_checksum_text() { + return godot::String("1234abcd"); +} diff --git a/extension/src/openvic-extension/Checksum.hpp b/extension/src/openvic-extension/Checksum.hpp index c5d8daf..2b2f959 100644 --- a/extension/src/openvic-extension/Checksum.hpp +++ b/extension/src/openvic-extension/Checksum.hpp @@ -1,6 +1,8 @@ #pragma once #include +#include +#include namespace OpenVic { class Checksum : public godot::Object { @@ -10,30 +12,15 @@ namespace OpenVic { static inline Checksum* _checksum = nullptr; protected: - static void _bind_methods() { - godot::ClassDB::bind_method(godot::D_METHOD("get_checksum_text"), &Checksum::get_checksum_text); - } + static void _bind_methods(); public: - static inline Checksum* get_singleton() { - return _checksum; - } + static Checksum* get_singleton(); - inline Checksum() { - ERR_FAIL_COND(_checksum != nullptr); - _checksum = this; - } - inline ~Checksum() { - ERR_FAIL_COND(_checksum != this); - _checksum = nullptr; - } + Checksum(); + ~Checksum(); // END BOILERPLATE - /* REQUIREMENTS: - * DAT-8 - */ - inline godot::String get_checksum_text() { - return godot::String("1234abcd"); - } + godot::String get_checksum_text(); }; } diff --git a/extension/src/openvic-extension/GameSingleton.cpp b/extension/src/openvic-extension/GameSingleton.cpp index 311b602..9dae7f2 100644 --- a/extension/src/openvic-extension/GameSingleton.cpp +++ b/extension/src/openvic-extension/GameSingleton.cpp @@ -1,11 +1,14 @@ #include "GameSingleton.hpp" +#include +#include #include #include #include "openvic-extension/LoadLocalisation.hpp" #include "openvic-extension/Utilities.hpp" +#include "openvic-extension/utility/ClassBindings.hpp" using namespace godot; using namespace OpenVic; @@ -14,94 +17,76 @@ using OpenVic::Utilities::godot_to_std_string; using OpenVic::Utilities::std_to_godot_string; using OpenVic::Utilities::std_view_to_godot_string; -GameSingleton* GameSingleton::singleton = nullptr; - -#define BM ClassDB::bind_method -#define BSM ClassDB::bind_static_method - void GameSingleton::_bind_methods() { - BSM("GameSingleton", D_METHOD("setup_logger"), &GameSingleton::setup_logger); - BM(D_METHOD("load_defines_compatibility_mode", "file_paths"), &GameSingleton::load_defines_compatibility_mode); - BSM( - "GameSingleton", D_METHOD("search_for_game_path", "hint_path"), &GameSingleton::search_for_game_path, DEFVAL(String {}) - ); - BM(D_METHOD("lookup_file", "path"), &GameSingleton::lookup_file); - BM(D_METHOD("setup_game"), &GameSingleton::setup_game); - - BM(D_METHOD("get_province_index_from_uv_coords", "coords"), &GameSingleton::get_province_index_from_uv_coords); - BM(D_METHOD("get_province_info_from_index", "index"), &GameSingleton::get_province_info_from_index); - BM(D_METHOD("get_width"), &GameSingleton::get_width); - BM(D_METHOD("get_height"), &GameSingleton::get_height); - BM(D_METHOD("get_aspect_ratio"), &GameSingleton::get_aspect_ratio); - BM(D_METHOD("get_terrain_texture"), &GameSingleton::get_terrain_texture); - BM(D_METHOD("get_province_shape_image_subdivisions"), &GameSingleton::get_province_shape_image_subdivisions); - BM(D_METHOD("get_province_shape_texture"), &GameSingleton::get_province_shape_texture); - BM(D_METHOD("get_province_colour_texture"), &GameSingleton::get_province_colour_texture); - - BM(D_METHOD("get_mapmode_count"), &GameSingleton::get_mapmode_count); - BM(D_METHOD("get_mapmode_identifier", "index"), &GameSingleton::get_mapmode_identifier); - BM(D_METHOD("set_mapmode", "identifier"), &GameSingleton::set_mapmode); - BM(D_METHOD("get_selected_province_index"), &GameSingleton::get_selected_province_index); - BM(D_METHOD("set_selected_province", "index"), &GameSingleton::set_selected_province); - - BM(D_METHOD("expand_building", "province_index", "building_type_identifier"), &GameSingleton::expand_building); - - BM(D_METHOD("set_paused", "paused"), &GameSingleton::set_paused); - BM(D_METHOD("toggle_paused"), &GameSingleton::toggle_paused); - BM(D_METHOD("is_paused"), &GameSingleton::is_paused); - BM(D_METHOD("increase_speed"), &GameSingleton::increase_speed); - BM(D_METHOD("decrease_speed"), &GameSingleton::decrease_speed); - BM(D_METHOD("can_increase_speed"), &GameSingleton::can_increase_speed); - BM(D_METHOD("can_decrease_speed"), &GameSingleton::can_decrease_speed); - BM(D_METHOD("get_longform_date"), &GameSingleton::get_longform_date); - BM(D_METHOD("try_tick"), &GameSingleton::try_tick); + OV_BIND_SMETHOD(setup_logger); + + OV_BIND_METHOD(GameSingleton::load_defines_compatibility_mode, { "file_paths" }); + OV_BIND_SMETHOD(search_for_game_path, { "hint_path" }, DEFVAL(String {})); + + OV_BIND_METHOD(GameSingleton::lookup_file, { "path" }); + OV_BIND_METHOD(GameSingleton::setup_game); + + OV_BIND_METHOD(GameSingleton::get_province_index_from_uv_coords, { "coords" }); + OV_BIND_METHOD(GameSingleton::get_province_info_from_index, { "index" }); + + OV_BIND_METHOD(GameSingleton::get_width); + OV_BIND_METHOD(GameSingleton::get_height); + OV_BIND_METHOD(GameSingleton::get_aspect_ratio); + OV_BIND_METHOD(GameSingleton::get_terrain_texture); + OV_BIND_METHOD(GameSingleton::get_province_shape_image_subdivisions); + OV_BIND_METHOD(GameSingleton::get_province_shape_texture); + OV_BIND_METHOD(GameSingleton::get_province_colour_texture); + + OV_BIND_METHOD(GameSingleton::get_mapmode_count); + OV_BIND_METHOD(GameSingleton::get_mapmode_identifier); + OV_BIND_METHOD(GameSingleton::set_mapmode, { "identifier" }); + OV_BIND_METHOD(GameSingleton::get_selected_province_index); + OV_BIND_METHOD(GameSingleton::set_selected_province, { "index" }); + + OV_BIND_METHOD(GameSingleton::expand_building, { "province_index", "building_type_identifier" }); + + OV_BIND_METHOD(GameSingleton::set_paused, { "paused" }); + OV_BIND_METHOD(GameSingleton::toggle_paused); + OV_BIND_METHOD(GameSingleton::is_paused); + OV_BIND_METHOD(GameSingleton::increase_speed); + OV_BIND_METHOD(GameSingleton::decrease_speed); + OV_BIND_METHOD(GameSingleton::can_increase_speed); + OV_BIND_METHOD(GameSingleton::can_decrease_speed); + OV_BIND_METHOD(GameSingleton::get_longform_date); + OV_BIND_METHOD(GameSingleton::try_tick); ADD_SIGNAL(MethodInfo("state_updated")); ADD_SIGNAL(MethodInfo("province_selected", PropertyInfo(Variant::INT, "index"))); - BSM("GameSingleton", D_METHOD("get_province_info_province_key"), &GameSingleton::get_province_info_province_key); - BSM("GameSingleton", D_METHOD("get_province_info_region_key"), &GameSingleton::get_province_info_region_key); - BSM("GameSingleton", D_METHOD("get_province_info_life_rating_key"), &GameSingleton::get_province_info_life_rating_key); - BSM("GameSingleton", D_METHOD("get_province_info_terrain_type_key"), &GameSingleton::get_province_info_terrain_type_key); - BSM( - "GameSingleton", D_METHOD("get_province_info_total_population_key"), - &GameSingleton::get_province_info_total_population_key - ); - BSM("GameSingleton", D_METHOD("get_province_info_pop_types_key"), &GameSingleton::get_province_info_pop_types_key); - BSM( - "GameSingleton", D_METHOD("get_province_info_pop_ideologies_key"), - &GameSingleton::get_province_info_pop_ideologies_key - ); - BSM("GameSingleton", D_METHOD("get_province_info_pop_cultures_key"), &GameSingleton::get_province_info_pop_cultures_key); - BSM("GameSingleton", D_METHOD("get_province_info_rgo_key"), &GameSingleton::get_province_info_rgo_key); - BSM("GameSingleton", D_METHOD("get_province_info_buildings_key"), &GameSingleton::get_province_info_buildings_key); - - BSM("GameSingleton", D_METHOD("get_building_info_building_key"), &GameSingleton::get_building_info_building_key); - BSM("GameSingleton", D_METHOD("get_building_info_level_key"), &GameSingleton::get_building_info_level_key); - BSM( - "GameSingleton", D_METHOD("get_building_info_expansion_state_key"), - &GameSingleton::get_building_info_expansion_state_key - ); - BSM("GameSingleton", D_METHOD("get_building_info_start_date_key"), &GameSingleton::get_building_info_start_date_key); - BSM("GameSingleton", D_METHOD("get_building_info_end_date_key"), &GameSingleton::get_building_info_end_date_key); - BSM( - "GameSingleton", D_METHOD("get_building_info_expansion_progress_key"), - &GameSingleton::get_building_info_expansion_progress_key + OV_BIND_SMETHOD(get_province_info_province_key); + OV_BIND_SMETHOD(get_province_info_region_key); + OV_BIND_SMETHOD(get_province_info_life_rating_key); + OV_BIND_SMETHOD(get_province_info_terrain_type_key); + OV_BIND_SMETHOD(get_province_info_total_population_key); + OV_BIND_SMETHOD(get_province_info_pop_types_key); + OV_BIND_SMETHOD(get_province_info_pop_ideologies_key); + OV_BIND_SMETHOD(get_province_info_pop_cultures_key); + OV_BIND_SMETHOD(get_province_info_rgo_key); + OV_BIND_SMETHOD(get_province_info_buildings_key); + + OV_BIND_SMETHOD(get_building_info_building_key); + OV_BIND_SMETHOD(get_building_info_level_key); + OV_BIND_SMETHOD(get_building_info_expansion_state_key); + OV_BIND_SMETHOD(get_building_info_start_date_key); + OV_BIND_SMETHOD(get_building_info_end_date_key); + OV_BIND_SMETHOD(get_building_info_expansion_progress_key); + + OV_BIND_SMETHOD(get_piechart_info_size_key); + OV_BIND_SMETHOD(get_piechart_info_colour_key); + + OV_BIND_SMETHOD( + draw_pie_chart, + { "image", "stopAngles", "colours", "radius", "shadow_displacement", "shadow_tightness", "shadow_radius", + "shadow_thickness", "trim_colour", "trim_size", "gradient_falloff", "gradient_base", "donut", "donut_inner_trim", + "donut_inner_radius" } ); - BSM("GameSingleton", D_METHOD("get_piechart_info_size_key"), &GameSingleton::get_piechart_info_size_key); - BSM("GameSingleton", D_METHOD("get_piechart_info_colour_key"), &GameSingleton::get_piechart_info_colour_key); - - BSM( - "GameSingleton", - D_METHOD( - "draw_pie_chart", "image", "stopAngles", "colours", "radius", "shadow_displacement", "shadow_tightness", - "shadow_radius", "shadow_thickness", "trim_colour", "trim_size", "gradient_falloff", "gradient_base", "donut", - "donut_inner_trim", "donut_inner_radius" - ), - &GameSingleton::draw_pie_chart - ); - BSM("GameSingleton", D_METHOD("load_image", "path"), &GameSingleton::load_image); + OV_BIND_SMETHOD(load_image, { "path" }); } void GameSingleton::draw_pie_chart( diff --git a/extension/src/openvic-extension/GameSingleton.hpp b/extension/src/openvic-extension/GameSingleton.hpp index 1d92ef0..ec26c3c 100644 --- a/extension/src/openvic-extension/GameSingleton.hpp +++ b/extension/src/openvic-extension/GameSingleton.hpp @@ -11,7 +11,7 @@ namespace OpenVic { class GameSingleton : public godot::Object { GDCLASS(GameSingleton, godot::Object) - static GameSingleton* singleton; + inline static GameSingleton* singleton = nullptr; GameManager game_manager; Dataloader dataloader; diff --git a/extension/src/openvic-extension/MapMesh.cpp b/extension/src/openvic-extension/MapMesh.cpp index e407391..a557105 100644 --- a/extension/src/openvic-extension/MapMesh.cpp +++ b/extension/src/openvic-extension/MapMesh.cpp @@ -2,24 +2,26 @@ #include +#include "openvic-extension/utility/ClassBindings.hpp" + using namespace godot; using namespace OpenVic; void MapMesh::_bind_methods() { - ClassDB::bind_method(D_METHOD("set_aspect_ratio", "ratio"), &MapMesh::set_aspect_ratio); - ClassDB::bind_method(D_METHOD("get_aspect_ratio"), &MapMesh::get_aspect_ratio); + OV_BIND_METHOD(MapMesh::set_aspect_ratio, { "ratio" }); + OV_BIND_METHOD(MapMesh::get_aspect_ratio); - ClassDB::bind_method(D_METHOD("set_repeat_proportion", "proportion"), &MapMesh::set_repeat_proportion); - ClassDB::bind_method(D_METHOD("get_repeat_proportion"), &MapMesh::get_repeat_proportion); + OV_BIND_METHOD(MapMesh::set_repeat_proportion, { "proportion" }); + OV_BIND_METHOD(MapMesh::get_repeat_proportion); - ClassDB::bind_method(D_METHOD("set_subdivide_width", "divisions"), &MapMesh::set_subdivide_width); - ClassDB::bind_method(D_METHOD("get_subdivide_width"), &MapMesh::get_subdivide_width); + OV_BIND_METHOD(MapMesh::set_subdivide_width, { "divisions" }); + OV_BIND_METHOD(MapMesh::get_subdivide_width); - ClassDB::bind_method(D_METHOD("set_subdivide_depth", "divisions"), &MapMesh::set_subdivide_depth); - ClassDB::bind_method(D_METHOD("get_subdivide_depth"), &MapMesh::get_subdivide_depth); + OV_BIND_METHOD(MapMesh::set_subdivide_depth, { "divisions" }); + OV_BIND_METHOD(MapMesh::get_subdivide_depth); - ClassDB::bind_method(D_METHOD("get_core_aabb"), &MapMesh::get_core_aabb); - ClassDB::bind_method(D_METHOD("is_valid_uv_coord"), &MapMesh::is_valid_uv_coord); + OV_BIND_METHOD(MapMesh::get_core_aabb); + OV_BIND_METHOD(MapMesh::is_valid_uv_coord); ADD_PROPERTY( PropertyInfo(Variant::FLOAT, "aspect_ratio", PROPERTY_HINT_NONE, "suffix:m"), "set_aspect_ratio", "get_aspect_ratio" diff --git a/extension/src/openvic-extension/utility/ClassBindings.hpp b/extension/src/openvic-extension/utility/ClassBindings.hpp new file mode 100644 index 0000000..616250b --- /dev/null +++ b/extension/src/openvic-extension/utility/ClassBindings.hpp @@ -0,0 +1,90 @@ +#pragma once + +#include +#include +#include +#include + +#include +#include + +#include "openvic-extension/utility/StringLiteral.hpp" + +namespace godot { + class Object; +} + +#define OV_BIND_METHOD(Function, ...) \ + ::OpenVic::detail::bind_method<::OpenVic::detail::get_function_name<#Function>()>(&Function __VA_OPT__(, ) __VA_ARGS__) + +#define OV_BIND_SMETHOD(Function, ...) \ + ::OpenVic::detail::bind_static_method<::OpenVic::detail::get_function_name<#Function>()>( \ + get_class_static(), &Function __VA_OPT__(, ) __VA_ARGS__ \ + ) + +#define OV_BIND_SMETHOD_T(ClassType, Function, ...) \ + ::OpenVic::detail::bind_static_method()>( \ + &Function __VA_OPT__(, ) __VA_ARGS__ \ + ) + +namespace OpenVic::detail { + template + concept IsFunctionPointer = std::is_function_v>; + template + concept IsMemberFunctionPointer = std::is_member_function_pointer_v; + + template + consteval auto get_function_name() { + constexpr auto result = [] { + constexpr auto prefix = std::string_view { "::" }; + + constexpr std::string_view in_sv = In; + constexpr auto start = in_sv.find_last_of(prefix); + + if constexpr (start == std::string_view::npos) { + return In; + } else { + constexpr auto result = in_sv.substr(start + 1); + return StringLiteral { result }; + } + }(); + + return result; + } + + template + void bind_method(Func func, std::initializer_list arg_names, DefaultsT&&... defaults) { + godot::MethodDefinition definition { Name.data() }; + definition.args = { arg_names }; + godot::ClassDB::bind_method(definition, func, defaults...); + } + + template + void bind_method(Func func, DefaultsT&&... defaults) { + bind_method(func, {}, defaults...); + } + + template + void bind_static_method( + godot::StringName class_name, Func func, std::initializer_list arg_names, DefaultsT&&... defaults + ) { + godot::MethodDefinition definition { Name.data() }; + definition.args = { arg_names }; + godot::ClassDB::bind_static_method(class_name, definition, func, defaults...); + } + + template + void bind_static_method(godot::StringName class_name, Func func, DefaultsT&&... defaults) { + bind_static_method(class_name, func, {}, defaults...); + } + + template ClassT, StringLiteral Name, IsFunctionPointer Func, typename... DefaultsT> + void bind_static_method(Func func, std::initializer_list arg_names, DefaultsT&&... defaults) { + bind_static_method(ClassT::get_class_static(), func, arg_names, defaults...); + } + + template ClassT, StringLiteral Name, IsFunctionPointer Func, typename... DefaultsT> + void bind_static_method(Func func, DefaultsT&&... defaults) { + bind_static_method(func, {}, defaults...); + } +} diff --git a/extension/src/openvic-extension/utility/StringLiteral.hpp b/extension/src/openvic-extension/utility/StringLiteral.hpp new file mode 100644 index 0000000..90b18cd --- /dev/null +++ b/extension/src/openvic-extension/utility/StringLiteral.hpp @@ -0,0 +1,106 @@ +#pragma once + +#include +#include +#include +#include +#include +#include + +namespace OpenVic { + template + struct StringLiteral { + constexpr StringLiteral(const char (&str)[N]) { + std::copy_n(str, N, value); + } + + consteval StringLiteral(std::string_view string) { + assert(string.size() == N); + std::copy_n(string.begin(), N, value); + } + + char value[N]; + static const constexpr std::integral_constant size {}; + + struct iterator { + using iterator_concept [[maybe_unused]] = std::contiguous_iterator_tag; + using difference_type = std::ptrdiff_t; + using element_type = const char; // element_type is a reserved name that must be used in the definition + using pointer = element_type*; + using reference = element_type&; + + constexpr iterator() = default; + constexpr iterator(pointer p) : _ptr(p) {} + constexpr reference operator*() const { + return *_ptr; + } + constexpr pointer operator->() const { + return _ptr; + } + constexpr auto& operator++() { + _ptr++; + return *this; + } + constexpr auto operator++(int) { + auto tmp = *this; + ++(*this); + return tmp; + } + constexpr iterator& operator+=(int i) { + _ptr += i; + return *this; + } + constexpr iterator operator+(const difference_type other) const { + return _ptr + other; + } + constexpr friend iterator operator+(const difference_type value, const iterator& other) { + return other + value; + } + constexpr iterator& operator--() { + _ptr--; + return *this; + } + constexpr iterator operator--(int) { + iterator tmp = *this; + --(*this); + return tmp; + } + constexpr iterator& operator-=(int i) { + _ptr -= i; + return *this; + } + constexpr difference_type operator-(const iterator& other) const { + return _ptr - other._ptr; + } + constexpr iterator operator-(const difference_type other) const { + return _ptr - other; + } + friend iterator operator-(const difference_type value, const iterator& other) { + return other - value; + } + constexpr reference operator[](difference_type idx) const { + return _ptr[idx]; + } + constexpr auto operator<=>(const iterator&) const = default; // three-way comparison C++20 + + private: + pointer _ptr; + }; + + constexpr iterator begin() const { + return iterator { &value }; + } + + constexpr iterator end() const { + return iterator { &value + N }; + } + + constexpr operator std::string_view() const { + return std::string_view { value, N }; + } + + constexpr decltype(auto) data() const { + return static_cast(*this).data(); + } + }; +} -- cgit v1.2.3-56-ga3b1