ruby-bindgen 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (115) hide show
  1. checksums.yaml +7 -0
  2. data/CHANGELOG.md +7 -0
  3. data/LICENSE +25 -0
  4. data/README.md +68 -0
  5. data/Rakefile +8 -0
  6. data/bin/ruby-bindgen +133 -0
  7. data/docs/architecture.md +238 -0
  8. data/docs/c/c_bindings.md +65 -0
  9. data/docs/c/constants.md +21 -0
  10. data/docs/c/customizing.md +19 -0
  11. data/docs/c/filtering.md +24 -0
  12. data/docs/c/getting_started.md +56 -0
  13. data/docs/c/library_loading.md +53 -0
  14. data/docs/c/output.md +96 -0
  15. data/docs/c/types.md +61 -0
  16. data/docs/c/version_guards.md +105 -0
  17. data/docs/cmake/cmake_bindings.md +19 -0
  18. data/docs/cmake/filtering.md +26 -0
  19. data/docs/cmake/getting_started.md +52 -0
  20. data/docs/cmake/output.md +110 -0
  21. data/docs/configuration.md +351 -0
  22. data/docs/contributing.md +68 -0
  23. data/docs/cpp/buffers.md +24 -0
  24. data/docs/cpp/classes.md +139 -0
  25. data/docs/cpp/cpp_bindings.md +29 -0
  26. data/docs/cpp/customizing.md +124 -0
  27. data/docs/cpp/enums.md +42 -0
  28. data/docs/cpp/filtering.md +35 -0
  29. data/docs/cpp/getting_started.md +80 -0
  30. data/docs/cpp/iterators.md +94 -0
  31. data/docs/cpp/operators.md +170 -0
  32. data/docs/cpp/output.md +125 -0
  33. data/docs/cpp/templates.md +114 -0
  34. data/docs/examples.md +133 -0
  35. data/docs/index.md +133 -0
  36. data/docs/prior_art.md +37 -0
  37. data/docs/troubleshooting.md +243 -0
  38. data/docs/type_spelling.md +200 -0
  39. data/docs/updating_bindings.md +55 -0
  40. data/docs/version_guards.md +69 -0
  41. data/lib/ruby-bindgen/config.rb +63 -0
  42. data/lib/ruby-bindgen/generators/cmake/cmake.rb +171 -0
  43. data/lib/ruby-bindgen/generators/cmake/directory.erb +29 -0
  44. data/lib/ruby-bindgen/generators/cmake/guard.rb +55 -0
  45. data/lib/ruby-bindgen/generators/cmake/presets.erb +232 -0
  46. data/lib/ruby-bindgen/generators/cmake/project.erb +89 -0
  47. data/lib/ruby-bindgen/generators/ffi/callback.erb +1 -0
  48. data/lib/ruby-bindgen/generators/ffi/constant.erb +1 -0
  49. data/lib/ruby-bindgen/generators/ffi/enum_constant_decl.erb +1 -0
  50. data/lib/ruby-bindgen/generators/ffi/enum_decl.erb +4 -0
  51. data/lib/ruby-bindgen/generators/ffi/enum_decl_anonymous.erb +4 -0
  52. data/lib/ruby-bindgen/generators/ffi/ffi.rb +687 -0
  53. data/lib/ruby-bindgen/generators/ffi/field_decl.erb +1 -0
  54. data/lib/ruby-bindgen/generators/ffi/function.erb +5 -0
  55. data/lib/ruby-bindgen/generators/ffi/library.erb +39 -0
  56. data/lib/ruby-bindgen/generators/ffi/project.erb +18 -0
  57. data/lib/ruby-bindgen/generators/ffi/struct.erb +6 -0
  58. data/lib/ruby-bindgen/generators/ffi/translation_unit.erb +9 -0
  59. data/lib/ruby-bindgen/generators/ffi/typedef_decl.erb +1 -0
  60. data/lib/ruby-bindgen/generators/ffi/union.erb +6 -0
  61. data/lib/ruby-bindgen/generators/ffi/variable.erb +1 -0
  62. data/lib/ruby-bindgen/generators/ffi/version.erb +9 -0
  63. data/lib/ruby-bindgen/generators/ffi/version_method.erb +5 -0
  64. data/lib/ruby-bindgen/generators/generator.rb +52 -0
  65. data/lib/ruby-bindgen/generators/rice/auto_generated_base_class.erb +5 -0
  66. data/lib/ruby-bindgen/generators/rice/class.erb +31 -0
  67. data/lib/ruby-bindgen/generators/rice/class_template.erb +9 -0
  68. data/lib/ruby-bindgen/generators/rice/class_template_specialization.erb +10 -0
  69. data/lib/ruby-bindgen/generators/rice/constant.erb +9 -0
  70. data/lib/ruby-bindgen/generators/rice/constructor.erb +1 -0
  71. data/lib/ruby-bindgen/generators/rice/conversion_function.erb +4 -0
  72. data/lib/ruby-bindgen/generators/rice/cxx_iterator_method.erb +1 -0
  73. data/lib/ruby-bindgen/generators/rice/cxx_method.erb +6 -0
  74. data/lib/ruby-bindgen/generators/rice/enum_constant_decl.erb +7 -0
  75. data/lib/ruby-bindgen/generators/rice/enum_decl.erb +6 -0
  76. data/lib/ruby-bindgen/generators/rice/field_decl.erb +8 -0
  77. data/lib/ruby-bindgen/generators/rice/function.erb +6 -0
  78. data/lib/ruby-bindgen/generators/rice/function_pointer.rb +68 -0
  79. data/lib/ruby-bindgen/generators/rice/incomplete_class.erb +3 -0
  80. data/lib/ruby-bindgen/generators/rice/iterator_alias.erb +1 -0
  81. data/lib/ruby-bindgen/generators/rice/iterator_collector.rb +159 -0
  82. data/lib/ruby-bindgen/generators/rice/namespace.erb +5 -0
  83. data/lib/ruby-bindgen/generators/rice/non_member_operator_binary.erb +4 -0
  84. data/lib/ruby-bindgen/generators/rice/non_member_operator_inspect.erb +6 -0
  85. data/lib/ruby-bindgen/generators/rice/non_member_operator_unary.erb +4 -0
  86. data/lib/ruby-bindgen/generators/rice/operator[].erb +4 -0
  87. data/lib/ruby-bindgen/generators/rice/project.cpp.erb +18 -0
  88. data/lib/ruby-bindgen/generators/rice/project.hpp.erb +13 -0
  89. data/lib/ruby-bindgen/generators/rice/reference_qualifier.rb +495 -0
  90. data/lib/ruby-bindgen/generators/rice/rice.rb +1724 -0
  91. data/lib/ruby-bindgen/generators/rice/rice_include.hpp.erb +7 -0
  92. data/lib/ruby-bindgen/generators/rice/signature_builder.rb +230 -0
  93. data/lib/ruby-bindgen/generators/rice/template_resolver.rb +585 -0
  94. data/lib/ruby-bindgen/generators/rice/translation_unit.cpp.erb +40 -0
  95. data/lib/ruby-bindgen/generators/rice/translation_unit.hpp.erb +7 -0
  96. data/lib/ruby-bindgen/generators/rice/translation_unit.ipp.erb +3 -0
  97. data/lib/ruby-bindgen/generators/rice/type_index.rb +117 -0
  98. data/lib/ruby-bindgen/generators/rice/type_speller.rb +509 -0
  99. data/lib/ruby-bindgen/generators/rice/union.erb +5 -0
  100. data/lib/ruby-bindgen/generators/rice/variable.erb +5 -0
  101. data/lib/ruby-bindgen/inputter.rb +54 -0
  102. data/lib/ruby-bindgen/name_mapper.rb +65 -0
  103. data/lib/ruby-bindgen/namer.rb +138 -0
  104. data/lib/ruby-bindgen/outputter.rb +40 -0
  105. data/lib/ruby-bindgen/parser.rb +82 -0
  106. data/lib/ruby-bindgen/refinements/cursor.rb +57 -0
  107. data/lib/ruby-bindgen/refinements/string.rb +41 -0
  108. data/lib/ruby-bindgen/symbol_candidates.rb +282 -0
  109. data/lib/ruby-bindgen/symbol_entry.rb +21 -0
  110. data/lib/ruby-bindgen/symbols.rb +107 -0
  111. data/lib/ruby-bindgen/type_pointer_formatter.rb +35 -0
  112. data/lib/ruby-bindgen/version.rb +3 -0
  113. data/lib/ruby-bindgen.rb +19 -0
  114. data/ruby-bindgen.gemspec +52 -0
  115. metadata +260 -0
@@ -0,0 +1,232 @@
1
+ {
2
+ "version": 6,
3
+ "configurePresets": [
4
+ {
5
+ "name": "base",
6
+ "hidden": true,
7
+ "generator": "Ninja",
8
+ "binaryDir": "${sourceDir}/build/${presetName}",
9
+ "installDir": "${sourceDir}/install/${presetName}",
10
+ "cacheVariables": {
11
+ "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
12
+ "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -fvisibility=hidden -fvisibility-inlines-hidden"
13
+ }
14
+ },
15
+ {
16
+ "name": "linux-debug",
17
+ "inherits": "base",
18
+ "displayName": "Linux Debug",
19
+ "cacheVariables": {
20
+ "CMAKE_BUILD_TYPE": "Debug",
21
+ "CMAKE_CXX_FLAGS_DEBUG": "-ggdb3 -O0 -fno-omit-frame-pointer -fno-inline -fno-optimize-sibling-calls"
22
+ },
23
+ "condition": {
24
+ "type": "equals",
25
+ "lhs": "${hostSystemName}",
26
+ "rhs": "Linux"
27
+ }
28
+ },
29
+ {
30
+ "name": "linux-release",
31
+ "inherits": "base",
32
+ "displayName": "Linux Release",
33
+ "cacheVariables": {
34
+ "CMAKE_BUILD_TYPE": "Release",
35
+ "CMAKE_CXX_FLAGS_RELEASE": "-O3 -DNDEBUG",
36
+ "CMAKE_INTERPROCEDURAL_OPTIMIZATION": "ON",
37
+ "CMAKE_SHARED_LINKER_FLAGS_RELEASE": "-Wl,--exclude-libs,ALL -Wl,--strip-all"
38
+ },
39
+ "condition": {
40
+ "type": "equals",
41
+ "lhs": "${hostSystemName}",
42
+ "rhs": "Linux"
43
+ }
44
+ },
45
+ {
46
+ "name": "macos-debug",
47
+ "inherits": "base",
48
+ "displayName": "macOS Debug",
49
+ "cacheVariables": {
50
+ "CMAKE_BUILD_TYPE": "Debug",
51
+ "CMAKE_CXX_FLAGS": "-Wall -Wno-unused-private-field -ftemplate-backtrace-limit=0 -fvisibility=hidden -fvisibility-inlines-hidden",
52
+ "CMAKE_CXX_FLAGS_DEBUG": "-g3 -Og -fno-omit-frame-pointer -fno-inline"
53
+ },
54
+ "condition": {
55
+ "type": "equals",
56
+ "lhs": "${hostSystemName}",
57
+ "rhs": "Darwin"
58
+ }
59
+ },
60
+ {
61
+ "name": "macos-release",
62
+ "inherits": "base",
63
+ "displayName": "macOS Release",
64
+ "cacheVariables": {
65
+ "CMAKE_BUILD_TYPE": "Release",
66
+ "CMAKE_CXX_FLAGS": "-Wall -Wno-unused-private-field -ftemplate-backtrace-limit=0 -fvisibility=hidden -fvisibility-inlines-hidden",
67
+ "CMAKE_CXX_FLAGS_RELEASE": "-O3 -DNDEBUG",
68
+ "CMAKE_INTERPROCEDURAL_OPTIMIZATION": "ON",
69
+ "CMAKE_SHARED_LINKER_FLAGS_RELEASE": "-Wl,-dead_strip -Wl,-x"
70
+ },
71
+ "condition": {
72
+ "type": "equals",
73
+ "lhs": "${hostSystemName}",
74
+ "rhs": "Darwin"
75
+ }
76
+ },
77
+ {
78
+ "name": "mingw-debug",
79
+ "inherits": "base",
80
+ "displayName": "Mingw x64 Debug",
81
+ "cacheVariables": {
82
+ "CMAKE_BUILD_TYPE": "Debug",
83
+ "CMAKE_CXX_COMPILER": "g++.exe",
84
+ "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -Wa,-mbig-obj -fvisibility=hidden -fvisibility-inlines-hidden",
85
+ "CMAKE_CXX_FLAGS_DEBUG": "-g3 -Og -fno-omit-frame-pointer -fno-inline -gsplit-dwarf",
86
+ "CMAKE_EXE_LINKER_FLAGS": "-fuse-ld=lld",
87
+ "CMAKE_SHARED_LINKER_FLAGS": "-fuse-ld=lld"
88
+ },
89
+ "condition": {
90
+ "type": "equals",
91
+ "lhs": "${hostSystemName}",
92
+ "rhs": "Windows"
93
+ }
94
+ },
95
+ {
96
+ "name": "mingw-release",
97
+ "inherits": "base",
98
+ "displayName": "Mingw x64 Release",
99
+ "cacheVariables": {
100
+ "CMAKE_BUILD_TYPE": "Release",
101
+ "CMAKE_CXX_COMPILER": "g++.exe",
102
+ "CMAKE_CXX_FLAGS": "-Wall -ftemplate-backtrace-limit=0 -Wa,-mbig-obj -fvisibility=hidden -fvisibility-inlines-hidden",
103
+ "CMAKE_CXX_FLAGS_RELEASE": "-O3 -DNDEBUG",
104
+ "CMAKE_EXE_LINKER_FLAGS": "-fuse-ld=lld",
105
+ "CMAKE_SHARED_LINKER_FLAGS": "-fuse-ld=lld",
106
+ "CMAKE_SHARED_LINKER_FLAGS_RELEASE": "-Wl,--exclude-all-symbols"
107
+ },
108
+ "condition": {
109
+ "type": "equals",
110
+ "lhs": "${hostSystemName}",
111
+ "rhs": "Windows"
112
+ }
113
+ },
114
+ {
115
+ "name": "windows-base",
116
+ "hidden": true,
117
+ "generator": "Ninja",
118
+ "binaryDir": "${sourceDir}/build/${presetName}",
119
+ "installDir": "${sourceDir}/install/${presetName}",
120
+ "toolchainFile": "$env{VCPKG_ROOT}\\scripts\\buildsystems\\vcpkg.cmake",
121
+ "cacheVariables": {
122
+ "CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
123
+ "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE"
124
+ },
125
+ "condition": {
126
+ "type": "equals",
127
+ "lhs": "${hostSystemName}",
128
+ "rhs": "Windows"
129
+ }
130
+ },
131
+ {
132
+ "name": "msvc-debug",
133
+ "inherits": "windows-base",
134
+ "displayName": "MSVC x64 Debug",
135
+ "cacheVariables": {
136
+ "CMAKE_BUILD_TYPE": "Debug",
137
+ "CMAKE_CXX_COMPILER": "cl.exe",
138
+ "CMAKE_CXX_FLAGS_DEBUG": "/Od",
139
+ "CMAKE_MSVC_DEBUG_INFORMATION_FORMAT": "ProgramDatabase"
140
+ }
141
+ },
142
+ {
143
+ "name": "msvc-release",
144
+ "inherits": "windows-base",
145
+ "displayName": "MSVC x64 Release",
146
+ "cacheVariables": {
147
+ "CMAKE_BUILD_TYPE": "Release",
148
+ "CMAKE_CXX_COMPILER": "cl.exe",
149
+ "CMAKE_CXX_FLAGS_RELEASE": "/O2 /DNDEBUG",
150
+ "CMAKE_INTERPROCEDURAL_OPTIMIZATION": "ON",
151
+ "CMAKE_MSVC_DEBUG_INFORMATION_FORMAT": "ProgramDatabase"
152
+ }
153
+ },
154
+ {
155
+ "name": "clang-windows-debug",
156
+ "inherits": "windows-base",
157
+ "displayName": "Clang Windows Debug",
158
+ "cacheVariables": {
159
+ "CMAKE_BUILD_TYPE": "Debug",
160
+ "CMAKE_CXX_COMPILER": "clang-cl.exe",
161
+ "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE /clang:-Wno-unused-private-field",
162
+ "CMAKE_CXX_FLAGS_DEBUG": "/Od /Zi"
163
+ }
164
+ },
165
+ {
166
+ "name": "clang-windows-release",
167
+ "inherits": "windows-base",
168
+ "displayName": "Clang Windows Release",
169
+ "cacheVariables": {
170
+ "CMAKE_BUILD_TYPE": "Release",
171
+ "CMAKE_CXX_COMPILER": "clang-cl.exe",
172
+ "CMAKE_CXX_FLAGS": "/EHs /W4 /bigobj /utf-8 /D_CRT_SECURE_NO_DEPRECATE /D_CRT_NONSTDC_NO_DEPRECATE /clang:-Wno-unused-private-field",
173
+ "CMAKE_CXX_FLAGS_RELEASE": "/O2 /DNDEBUG",
174
+ "CMAKE_INTERPROCEDURAL_OPTIMIZATION": "ON"
175
+ }
176
+ }
177
+ ],
178
+ "buildPresets": [
179
+ {
180
+ "name": "linux-debug",
181
+ "displayName": "Build Linux Debug",
182
+ "configurePreset": "linux-debug",
183
+ "jobs": 6
184
+ },
185
+ {
186
+ "name": "linux-release",
187
+ "displayName": "Build Linux Release",
188
+ "configurePreset": "linux-release",
189
+ "jobs": 6
190
+ },
191
+ {
192
+ "name": "macos-debug",
193
+ "displayName": "Build macOS Debug",
194
+ "configurePreset": "macos-debug"
195
+ },
196
+ {
197
+ "name": "macos-release",
198
+ "displayName": "Build macOS Release",
199
+ "configurePreset": "macos-release"
200
+ },
201
+ {
202
+ "name": "msvc-debug",
203
+ "displayName": "Build MSVC x64 Debug",
204
+ "configurePreset": "msvc-debug"
205
+ },
206
+ {
207
+ "name": "msvc-release",
208
+ "displayName": "Build MSVC x64 Release",
209
+ "configurePreset": "msvc-release"
210
+ },
211
+ {
212
+ "name": "clang-windows-debug",
213
+ "displayName": "Build Clang Windows Debug",
214
+ "configurePreset": "clang-windows-debug"
215
+ },
216
+ {
217
+ "name": "clang-windows-release",
218
+ "displayName": "Build Clang Windows Release",
219
+ "configurePreset": "clang-windows-release"
220
+ },
221
+ {
222
+ "name": "mingw-debug",
223
+ "displayName": "Build Mingw x64 Debug",
224
+ "configurePreset": "mingw-debug"
225
+ },
226
+ {
227
+ "name": "mingw-release",
228
+ "displayName": "Build Mingw x64 Release",
229
+ "configurePreset": "mingw-release"
230
+ }
231
+ ]
232
+ }
@@ -0,0 +1,89 @@
1
+ # Generated by ruby-bindgen (<%= RubyBindgen::VERSION %>)
2
+
3
+ cmake_minimum_required(VERSION 3.26)
4
+
5
+ set(CMAKE_CXX_STANDARD 17)
6
+ set(CMAKE_CXX_STANDARD_REQUIRED ON)
7
+
8
+ project("<%= project %>" LANGUAGES CXX)
9
+
10
+ # Create the Extension Library
11
+ if (MSVC)
12
+ add_library(${CMAKE_PROJECT_NAME} SHARED)
13
+ else ()
14
+ add_library(${CMAKE_PROJECT_NAME} MODULE)
15
+ endif ()
16
+
17
+ # Fetch Rice from GitHub
18
+ include(FetchContent)
19
+
20
+ FetchContent_Declare(
21
+ rice
22
+ GIT_REPOSITORY https://github.com/ruby-rice/rice.git
23
+ GIT_TAG master
24
+ )
25
+ FetchContent_MakeAvailable(rice)
26
+
27
+ # Configure Ruby Detection
28
+ list(PREPEND CMAKE_MODULE_PATH "${rice_SOURCE_DIR}")
29
+
30
+ # Find Ruby
31
+ find_package(Ruby REQUIRED)
32
+
33
+ target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE
34
+ Ruby::Module
35
+ )
36
+
37
+ # Link to Rice
38
+ target_link_libraries(${CMAKE_PROJECT_NAME} PRIVATE
39
+ Rice::Rice
40
+ )
41
+
42
+ # Include Directories
43
+ <% include_dirs.each do |dir| -%>
44
+ target_include_directories(${CMAKE_PROJECT_NAME} PRIVATE
45
+ "<%= dir %>"
46
+ )
47
+ <% end -%>
48
+
49
+ # Configure Extension Output
50
+ get_target_property(RUBY_EXT_SUFFIX Ruby::Ruby INTERFACE_RUBY_EXTENSION_SUFFIX)
51
+
52
+ set_target_properties(${CMAKE_PROJECT_NAME} PROPERTIES
53
+ PREFIX ""
54
+ SUFFIX "${RUBY_EXT_SUFFIX}"
55
+ OUTPUT_NAME "<%= project %>"
56
+ CXX_VISIBILITY_PRESET hidden
57
+ VISIBILITY_INLINES_HIDDEN ON
58
+ WINDOWS_EXPORT_ALL_SYMBOLS OFF
59
+ RUNTIME_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/../lib/${Ruby_VERSION_MAJOR}.${Ruby_VERSION_MINOR}"
60
+ LIBRARY_OUTPUT_DIRECTORY "${CMAKE_SOURCE_DIR}/../lib"
61
+ )
62
+
63
+ # Subdirectories
64
+ <% directories.each do |directory| -%>
65
+ add_subdirectory("<%= directory.relative_path_from(directory.parent) %>")
66
+ <% end -%>
67
+
68
+ # Sources
69
+ <% if !files.empty? -%>
70
+ target_sources(${CMAKE_PROJECT_NAME} PRIVATE
71
+ <% files.each do |file| -%>
72
+ "<%= file.relative_path_from(file.parent) %>"
73
+ <% end -%>
74
+ )
75
+ <% end -%>
76
+ <% guarded_entries.each do |entry| -%>
77
+ if(<%= entry.condition %>)
78
+ <% entry.directories.each do |directory| -%>
79
+ add_subdirectory("<%= directory.relative_path_from(directory.parent) %>")
80
+ <% end -%>
81
+ <% if !entry.files.empty? -%>
82
+ target_sources(${CMAKE_PROJECT_NAME} PRIVATE
83
+ <% entry.files.each do |file| -%>
84
+ "<%= file.relative_path_from(file.parent) %>"
85
+ <% end -%>
86
+ )
87
+ <% end -%>
88
+ endif()
89
+ <% end -%>
@@ -0,0 +1 @@
1
+ callback :<%= ruby %>, [<%= parameter_types.join(", ") %>], <%= figure_ffi_type(result_type, :callback_return) %>
@@ -0,0 +1 @@
1
+ <%= name %> = <%= value %>
@@ -0,0 +1 @@
1
+ :<%= cursor.spelling %>, <%= cursor.enum_value %>
@@ -0,0 +1,4 @@
1
+
2
+ <%= cursor.ruby_name %> = enum(
3
+ <%= children %>
4
+ )
@@ -0,0 +1,4 @@
1
+
2
+ enum(
3
+ <%= children %>
4
+ )