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
metadata ADDED
@@ -0,0 +1,260 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: ruby-bindgen
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.0
5
+ platform: ruby
6
+ authors:
7
+ - Charlie Savage
8
+ bindir: bin
9
+ cert_chain: []
10
+ date: 1980-01-02 00:00:00.000000000 Z
11
+ dependencies:
12
+ - !ruby/object:Gem::Dependency
13
+ name: ffi
14
+ requirement: !ruby/object:Gem::Requirement
15
+ requirements:
16
+ - - ">="
17
+ - !ruby/object:Gem::Version
18
+ version: '1.16'
19
+ type: :runtime
20
+ prerelease: false
21
+ version_requirements: !ruby/object:Gem::Requirement
22
+ requirements:
23
+ - - ">="
24
+ - !ruby/object:Gem::Version
25
+ version: '1.16'
26
+ - !ruby/object:Gem::Dependency
27
+ name: ffi-clang
28
+ requirement: !ruby/object:Gem::Requirement
29
+ requirements:
30
+ - - ">="
31
+ - !ruby/object:Gem::Version
32
+ version: 0.16.0
33
+ type: :runtime
34
+ prerelease: false
35
+ version_requirements: !ruby/object:Gem::Requirement
36
+ requirements:
37
+ - - ">="
38
+ - !ruby/object:Gem::Version
39
+ version: 0.16.0
40
+ - !ruby/object:Gem::Dependency
41
+ name: minitest
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '0'
47
+ type: :development
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '0'
54
+ - !ruby/object:Gem::Dependency
55
+ name: minitest-reporters
56
+ requirement: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: '0'
61
+ type: :development
62
+ prerelease: false
63
+ version_requirements: !ruby/object:Gem::Requirement
64
+ requirements:
65
+ - - ">="
66
+ - !ruby/object:Gem::Version
67
+ version: '0'
68
+ - !ruby/object:Gem::Dependency
69
+ name: rake
70
+ requirement: !ruby/object:Gem::Requirement
71
+ requirements:
72
+ - - ">="
73
+ - !ruby/object:Gem::Version
74
+ version: '0'
75
+ type: :development
76
+ prerelease: false
77
+ version_requirements: !ruby/object:Gem::Requirement
78
+ requirements:
79
+ - - ">="
80
+ - !ruby/object:Gem::Version
81
+ version: '0'
82
+ - !ruby/object:Gem::Dependency
83
+ name: simplecov
84
+ requirement: !ruby/object:Gem::Requirement
85
+ requirements:
86
+ - - ">="
87
+ - !ruby/object:Gem::Version
88
+ version: '0'
89
+ type: :development
90
+ prerelease: false
91
+ version_requirements: !ruby/object:Gem::Requirement
92
+ requirements:
93
+ - - ">="
94
+ - !ruby/object:Gem::Version
95
+ version: '0'
96
+ - !ruby/object:Gem::Dependency
97
+ name: simplecov-cobertura
98
+ requirement: !ruby/object:Gem::Requirement
99
+ requirements:
100
+ - - ">="
101
+ - !ruby/object:Gem::Version
102
+ version: '0'
103
+ type: :development
104
+ prerelease: false
105
+ version_requirements: !ruby/object:Gem::Requirement
106
+ requirements:
107
+ - - ">="
108
+ - !ruby/object:Gem::Version
109
+ version: '0'
110
+ description: |
111
+ ruby-bindgen reads C and C++ headers with libclang and emits Ruby bindings.
112
+ It supports three output formats: Rice C++ source for high-fidelity C++ wrappers,
113
+ raw FFI for plain C libraries, and CMake build files to compile the generated
114
+ extensions. Bindings are driven from a YAML configuration that controls header
115
+ matching, symbol filtering, name mapping, and version guards. Battle-tested
116
+ against OpenCV (thousands of classes) and PROJ.
117
+ executables:
118
+ - ruby-bindgen
119
+ extensions: []
120
+ extra_rdoc_files: []
121
+ files:
122
+ - CHANGELOG.md
123
+ - LICENSE
124
+ - README.md
125
+ - Rakefile
126
+ - bin/ruby-bindgen
127
+ - docs/architecture.md
128
+ - docs/c/c_bindings.md
129
+ - docs/c/constants.md
130
+ - docs/c/customizing.md
131
+ - docs/c/filtering.md
132
+ - docs/c/getting_started.md
133
+ - docs/c/library_loading.md
134
+ - docs/c/output.md
135
+ - docs/c/types.md
136
+ - docs/c/version_guards.md
137
+ - docs/cmake/cmake_bindings.md
138
+ - docs/cmake/filtering.md
139
+ - docs/cmake/getting_started.md
140
+ - docs/cmake/output.md
141
+ - docs/configuration.md
142
+ - docs/contributing.md
143
+ - docs/cpp/buffers.md
144
+ - docs/cpp/classes.md
145
+ - docs/cpp/cpp_bindings.md
146
+ - docs/cpp/customizing.md
147
+ - docs/cpp/enums.md
148
+ - docs/cpp/filtering.md
149
+ - docs/cpp/getting_started.md
150
+ - docs/cpp/iterators.md
151
+ - docs/cpp/operators.md
152
+ - docs/cpp/output.md
153
+ - docs/cpp/templates.md
154
+ - docs/examples.md
155
+ - docs/index.md
156
+ - docs/prior_art.md
157
+ - docs/troubleshooting.md
158
+ - docs/type_spelling.md
159
+ - docs/updating_bindings.md
160
+ - docs/version_guards.md
161
+ - lib/ruby-bindgen.rb
162
+ - lib/ruby-bindgen/config.rb
163
+ - lib/ruby-bindgen/generators/cmake/cmake.rb
164
+ - lib/ruby-bindgen/generators/cmake/directory.erb
165
+ - lib/ruby-bindgen/generators/cmake/guard.rb
166
+ - lib/ruby-bindgen/generators/cmake/presets.erb
167
+ - lib/ruby-bindgen/generators/cmake/project.erb
168
+ - lib/ruby-bindgen/generators/ffi/callback.erb
169
+ - lib/ruby-bindgen/generators/ffi/constant.erb
170
+ - lib/ruby-bindgen/generators/ffi/enum_constant_decl.erb
171
+ - lib/ruby-bindgen/generators/ffi/enum_decl.erb
172
+ - lib/ruby-bindgen/generators/ffi/enum_decl_anonymous.erb
173
+ - lib/ruby-bindgen/generators/ffi/ffi.rb
174
+ - lib/ruby-bindgen/generators/ffi/field_decl.erb
175
+ - lib/ruby-bindgen/generators/ffi/function.erb
176
+ - lib/ruby-bindgen/generators/ffi/library.erb
177
+ - lib/ruby-bindgen/generators/ffi/project.erb
178
+ - lib/ruby-bindgen/generators/ffi/struct.erb
179
+ - lib/ruby-bindgen/generators/ffi/translation_unit.erb
180
+ - lib/ruby-bindgen/generators/ffi/typedef_decl.erb
181
+ - lib/ruby-bindgen/generators/ffi/union.erb
182
+ - lib/ruby-bindgen/generators/ffi/variable.erb
183
+ - lib/ruby-bindgen/generators/ffi/version.erb
184
+ - lib/ruby-bindgen/generators/ffi/version_method.erb
185
+ - lib/ruby-bindgen/generators/generator.rb
186
+ - lib/ruby-bindgen/generators/rice/auto_generated_base_class.erb
187
+ - lib/ruby-bindgen/generators/rice/class.erb
188
+ - lib/ruby-bindgen/generators/rice/class_template.erb
189
+ - lib/ruby-bindgen/generators/rice/class_template_specialization.erb
190
+ - lib/ruby-bindgen/generators/rice/constant.erb
191
+ - lib/ruby-bindgen/generators/rice/constructor.erb
192
+ - lib/ruby-bindgen/generators/rice/conversion_function.erb
193
+ - lib/ruby-bindgen/generators/rice/cxx_iterator_method.erb
194
+ - lib/ruby-bindgen/generators/rice/cxx_method.erb
195
+ - lib/ruby-bindgen/generators/rice/enum_constant_decl.erb
196
+ - lib/ruby-bindgen/generators/rice/enum_decl.erb
197
+ - lib/ruby-bindgen/generators/rice/field_decl.erb
198
+ - lib/ruby-bindgen/generators/rice/function.erb
199
+ - lib/ruby-bindgen/generators/rice/function_pointer.rb
200
+ - lib/ruby-bindgen/generators/rice/incomplete_class.erb
201
+ - lib/ruby-bindgen/generators/rice/iterator_alias.erb
202
+ - lib/ruby-bindgen/generators/rice/iterator_collector.rb
203
+ - lib/ruby-bindgen/generators/rice/namespace.erb
204
+ - lib/ruby-bindgen/generators/rice/non_member_operator_binary.erb
205
+ - lib/ruby-bindgen/generators/rice/non_member_operator_inspect.erb
206
+ - lib/ruby-bindgen/generators/rice/non_member_operator_unary.erb
207
+ - lib/ruby-bindgen/generators/rice/operator[].erb
208
+ - lib/ruby-bindgen/generators/rice/project.cpp.erb
209
+ - lib/ruby-bindgen/generators/rice/project.hpp.erb
210
+ - lib/ruby-bindgen/generators/rice/reference_qualifier.rb
211
+ - lib/ruby-bindgen/generators/rice/rice.rb
212
+ - lib/ruby-bindgen/generators/rice/rice_include.hpp.erb
213
+ - lib/ruby-bindgen/generators/rice/signature_builder.rb
214
+ - lib/ruby-bindgen/generators/rice/template_resolver.rb
215
+ - lib/ruby-bindgen/generators/rice/translation_unit.cpp.erb
216
+ - lib/ruby-bindgen/generators/rice/translation_unit.hpp.erb
217
+ - lib/ruby-bindgen/generators/rice/translation_unit.ipp.erb
218
+ - lib/ruby-bindgen/generators/rice/type_index.rb
219
+ - lib/ruby-bindgen/generators/rice/type_speller.rb
220
+ - lib/ruby-bindgen/generators/rice/union.erb
221
+ - lib/ruby-bindgen/generators/rice/variable.erb
222
+ - lib/ruby-bindgen/inputter.rb
223
+ - lib/ruby-bindgen/name_mapper.rb
224
+ - lib/ruby-bindgen/namer.rb
225
+ - lib/ruby-bindgen/outputter.rb
226
+ - lib/ruby-bindgen/parser.rb
227
+ - lib/ruby-bindgen/refinements/cursor.rb
228
+ - lib/ruby-bindgen/refinements/string.rb
229
+ - lib/ruby-bindgen/symbol_candidates.rb
230
+ - lib/ruby-bindgen/symbol_entry.rb
231
+ - lib/ruby-bindgen/symbols.rb
232
+ - lib/ruby-bindgen/type_pointer_formatter.rb
233
+ - lib/ruby-bindgen/version.rb
234
+ - ruby-bindgen.gemspec
235
+ homepage: https://github.com/ruby-rice/ruby-bindgen/
236
+ licenses:
237
+ - BSD-2-Clause
238
+ metadata:
239
+ bug_tracker_uri: https://github.com/ruby-rice/ruby-bindgen/issues
240
+ changelog_uri: https://github.com/ruby-rice/ruby-bindgen/blob/main/CHANGELOG.md
241
+ documentation_uri: https://ruby-rice.github.io/ruby-bindgen/
242
+ source_code_uri: https://github.com/ruby-rice/ruby-bindgen
243
+ rdoc_options: []
244
+ require_paths:
245
+ - lib
246
+ required_ruby_version: !ruby/object:Gem::Requirement
247
+ requirements:
248
+ - - ">="
249
+ - !ruby/object:Gem::Version
250
+ version: 3.2.0
251
+ required_rubygems_version: !ruby/object:Gem::Requirement
252
+ requirements:
253
+ - - ">="
254
+ - !ruby/object:Gem::Version
255
+ version: '0'
256
+ requirements: []
257
+ rubygems_version: 4.0.6
258
+ specification_version: 4
259
+ summary: C and C++ binding generator for Ruby
260
+ test_files: []