kreuzberg 4.0.0.pre.rc.13 → 4.0.0.pre.rc.14
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.
- checksums.yaml +4 -4
- data/.gitignore +14 -14
- data/.rspec +3 -3
- data/.rubocop.yaml +1 -1
- data/.rubocop.yml +538 -538
- data/Gemfile +8 -8
- data/Gemfile.lock +105 -2
- data/README.md +454 -454
- data/Rakefile +33 -25
- data/Steepfile +47 -47
- data/examples/async_patterns.rb +341 -341
- data/ext/kreuzberg_rb/extconf.rb +45 -45
- data/ext/kreuzberg_rb/native/.cargo/config.toml +2 -2
- data/ext/kreuzberg_rb/native/Cargo.lock +6940 -6941
- data/ext/kreuzberg_rb/native/Cargo.toml +54 -54
- data/ext/kreuzberg_rb/native/README.md +425 -425
- data/ext/kreuzberg_rb/native/build.rs +15 -15
- data/ext/kreuzberg_rb/native/include/ieeefp.h +11 -11
- data/ext/kreuzberg_rb/native/include/msvc_compat/strings.h +14 -14
- data/ext/kreuzberg_rb/native/include/strings.h +20 -20
- data/ext/kreuzberg_rb/native/include/unistd.h +47 -47
- data/ext/kreuzberg_rb/native/src/lib.rs +3158 -3158
- data/extconf.rb +28 -28
- data/kreuzberg.gemspec +214 -214
- data/lib/kreuzberg/api_proxy.rb +142 -142
- data/lib/kreuzberg/cache_api.rb +81 -81
- data/lib/kreuzberg/cli.rb +55 -55
- data/lib/kreuzberg/cli_proxy.rb +127 -127
- data/lib/kreuzberg/config.rb +724 -724
- data/lib/kreuzberg/error_context.rb +80 -80
- data/lib/kreuzberg/errors.rb +118 -118
- data/lib/kreuzberg/extraction_api.rb +340 -340
- data/lib/kreuzberg/mcp_proxy.rb +186 -186
- data/lib/kreuzberg/ocr_backend_protocol.rb +113 -113
- data/lib/kreuzberg/post_processor_protocol.rb +86 -86
- data/lib/kreuzberg/result.rb +279 -279
- data/lib/kreuzberg/setup_lib_path.rb +80 -80
- data/lib/kreuzberg/validator_protocol.rb +89 -89
- data/lib/kreuzberg/version.rb +5 -5
- data/lib/kreuzberg.rb +109 -109
- data/lib/{pdfium.dll → libpdfium.dylib} +0 -0
- data/sig/kreuzberg/internal.rbs +184 -184
- data/sig/kreuzberg.rbs +546 -546
- data/spec/binding/cache_spec.rb +227 -227
- data/spec/binding/cli_proxy_spec.rb +85 -85
- data/spec/binding/cli_spec.rb +55 -55
- data/spec/binding/config_spec.rb +345 -345
- data/spec/binding/config_validation_spec.rb +283 -283
- data/spec/binding/error_handling_spec.rb +213 -213
- data/spec/binding/errors_spec.rb +66 -66
- data/spec/binding/plugins/ocr_backend_spec.rb +307 -307
- data/spec/binding/plugins/postprocessor_spec.rb +269 -269
- data/spec/binding/plugins/validator_spec.rb +274 -274
- data/spec/fixtures/config.toml +39 -39
- data/spec/fixtures/config.yaml +41 -41
- data/spec/fixtures/invalid_config.toml +4 -4
- data/spec/smoke/package_spec.rb +178 -178
- data/spec/spec_helper.rb +42 -42
- data/vendor/Cargo.toml +1 -1
- data/vendor/kreuzberg/Cargo.toml +5 -5
- data/vendor/kreuzberg/README.md +230 -230
- data/vendor/kreuzberg/benches/otel_overhead.rs +48 -48
- data/vendor/kreuzberg/build.rs +843 -843
- data/vendor/kreuzberg/src/api/error.rs +81 -81
- data/vendor/kreuzberg/src/api/handlers.rs +199 -199
- data/vendor/kreuzberg/src/api/mod.rs +79 -79
- data/vendor/kreuzberg/src/api/server.rs +353 -353
- data/vendor/kreuzberg/src/api/types.rs +170 -170
- data/vendor/kreuzberg/src/cache/mod.rs +1167 -1167
- data/vendor/kreuzberg/src/chunking/mod.rs +1877 -1877
- data/vendor/kreuzberg/src/chunking/processor.rs +220 -220
- data/vendor/kreuzberg/src/core/batch_mode.rs +95 -95
- data/vendor/kreuzberg/src/core/config.rs +1080 -1080
- data/vendor/kreuzberg/src/core/extractor.rs +1156 -1156
- data/vendor/kreuzberg/src/core/io.rs +329 -329
- data/vendor/kreuzberg/src/core/mime.rs +605 -605
- data/vendor/kreuzberg/src/core/mod.rs +47 -47
- data/vendor/kreuzberg/src/core/pipeline.rs +1184 -1184
- data/vendor/kreuzberg/src/embeddings.rs +500 -500
- data/vendor/kreuzberg/src/error.rs +431 -431
- data/vendor/kreuzberg/src/extraction/archive.rs +954 -954
- data/vendor/kreuzberg/src/extraction/docx.rs +398 -398
- data/vendor/kreuzberg/src/extraction/email.rs +854 -854
- data/vendor/kreuzberg/src/extraction/excel.rs +688 -688
- data/vendor/kreuzberg/src/extraction/html.rs +601 -601
- data/vendor/kreuzberg/src/extraction/image.rs +491 -491
- data/vendor/kreuzberg/src/extraction/libreoffice.rs +574 -574
- data/vendor/kreuzberg/src/extraction/markdown.rs +213 -213
- data/vendor/kreuzberg/src/extraction/mod.rs +81 -81
- data/vendor/kreuzberg/src/extraction/office_metadata/app_properties.rs +398 -398
- data/vendor/kreuzberg/src/extraction/office_metadata/core_properties.rs +247 -247
- data/vendor/kreuzberg/src/extraction/office_metadata/custom_properties.rs +240 -240
- data/vendor/kreuzberg/src/extraction/office_metadata/mod.rs +130 -130
- data/vendor/kreuzberg/src/extraction/office_metadata/odt_properties.rs +284 -284
- data/vendor/kreuzberg/src/extraction/pptx.rs +3100 -3100
- data/vendor/kreuzberg/src/extraction/structured.rs +490 -490
- data/vendor/kreuzberg/src/extraction/table.rs +328 -328
- data/vendor/kreuzberg/src/extraction/text.rs +269 -269
- data/vendor/kreuzberg/src/extraction/xml.rs +333 -333
- data/vendor/kreuzberg/src/extractors/archive.rs +447 -447
- data/vendor/kreuzberg/src/extractors/bibtex.rs +470 -470
- data/vendor/kreuzberg/src/extractors/docbook.rs +504 -504
- data/vendor/kreuzberg/src/extractors/docx.rs +400 -400
- data/vendor/kreuzberg/src/extractors/email.rs +157 -157
- data/vendor/kreuzberg/src/extractors/epub.rs +708 -708
- data/vendor/kreuzberg/src/extractors/excel.rs +345 -345
- data/vendor/kreuzberg/src/extractors/fictionbook.rs +492 -492
- data/vendor/kreuzberg/src/extractors/html.rs +407 -407
- data/vendor/kreuzberg/src/extractors/image.rs +219 -219
- data/vendor/kreuzberg/src/extractors/jats.rs +1054 -1054
- data/vendor/kreuzberg/src/extractors/jupyter.rs +368 -368
- data/vendor/kreuzberg/src/extractors/latex.rs +653 -653
- data/vendor/kreuzberg/src/extractors/markdown.rs +701 -701
- data/vendor/kreuzberg/src/extractors/mod.rs +429 -429
- data/vendor/kreuzberg/src/extractors/odt.rs +628 -628
- data/vendor/kreuzberg/src/extractors/opml.rs +635 -635
- data/vendor/kreuzberg/src/extractors/orgmode.rs +529 -529
- data/vendor/kreuzberg/src/extractors/pdf.rs +749 -749
- data/vendor/kreuzberg/src/extractors/pptx.rs +267 -267
- data/vendor/kreuzberg/src/extractors/rst.rs +577 -577
- data/vendor/kreuzberg/src/extractors/rtf.rs +809 -809
- data/vendor/kreuzberg/src/extractors/security.rs +484 -484
- data/vendor/kreuzberg/src/extractors/security_tests.rs +367 -367
- data/vendor/kreuzberg/src/extractors/structured.rs +142 -142
- data/vendor/kreuzberg/src/extractors/text.rs +265 -265
- data/vendor/kreuzberg/src/extractors/typst.rs +651 -651
- data/vendor/kreuzberg/src/extractors/xml.rs +147 -147
- data/vendor/kreuzberg/src/image/dpi.rs +164 -164
- data/vendor/kreuzberg/src/image/mod.rs +6 -6
- data/vendor/kreuzberg/src/image/preprocessing.rs +417 -417
- data/vendor/kreuzberg/src/image/resize.rs +89 -89
- data/vendor/kreuzberg/src/keywords/config.rs +154 -154
- data/vendor/kreuzberg/src/keywords/mod.rs +237 -237
- data/vendor/kreuzberg/src/keywords/processor.rs +275 -275
- data/vendor/kreuzberg/src/keywords/rake.rs +293 -293
- data/vendor/kreuzberg/src/keywords/types.rs +68 -68
- data/vendor/kreuzberg/src/keywords/yake.rs +163 -163
- data/vendor/kreuzberg/src/language_detection/mod.rs +985 -985
- data/vendor/kreuzberg/src/language_detection/processor.rs +219 -219
- data/vendor/kreuzberg/src/lib.rs +113 -113
- data/vendor/kreuzberg/src/mcp/mod.rs +35 -35
- data/vendor/kreuzberg/src/mcp/server.rs +2076 -2076
- data/vendor/kreuzberg/src/ocr/cache.rs +469 -469
- data/vendor/kreuzberg/src/ocr/error.rs +37 -37
- data/vendor/kreuzberg/src/ocr/hocr.rs +216 -216
- data/vendor/kreuzberg/src/ocr/mod.rs +58 -58
- data/vendor/kreuzberg/src/ocr/processor.rs +863 -863
- data/vendor/kreuzberg/src/ocr/table/mod.rs +4 -4
- data/vendor/kreuzberg/src/ocr/table/tsv_parser.rs +144 -144
- data/vendor/kreuzberg/src/ocr/tesseract_backend.rs +452 -452
- data/vendor/kreuzberg/src/ocr/types.rs +393 -393
- data/vendor/kreuzberg/src/ocr/utils.rs +47 -47
- data/vendor/kreuzberg/src/ocr/validation.rs +206 -206
- data/vendor/kreuzberg/src/panic_context.rs +154 -154
- data/vendor/kreuzberg/src/pdf/bindings.rs +44 -44
- data/vendor/kreuzberg/src/pdf/bundled.rs +346 -346
- data/vendor/kreuzberg/src/pdf/error.rs +130 -130
- data/vendor/kreuzberg/src/pdf/images.rs +139 -139
- data/vendor/kreuzberg/src/pdf/metadata.rs +489 -489
- data/vendor/kreuzberg/src/pdf/mod.rs +68 -68
- data/vendor/kreuzberg/src/pdf/rendering.rs +368 -368
- data/vendor/kreuzberg/src/pdf/table.rs +420 -420
- data/vendor/kreuzberg/src/pdf/text.rs +240 -240
- data/vendor/kreuzberg/src/plugins/extractor.rs +1044 -1044
- data/vendor/kreuzberg/src/plugins/mod.rs +212 -212
- data/vendor/kreuzberg/src/plugins/ocr.rs +639 -639
- data/vendor/kreuzberg/src/plugins/processor.rs +650 -650
- data/vendor/kreuzberg/src/plugins/registry.rs +1339 -1339
- data/vendor/kreuzberg/src/plugins/traits.rs +258 -258
- data/vendor/kreuzberg/src/plugins/validator.rs +967 -967
- data/vendor/kreuzberg/src/stopwords/mod.rs +1470 -1470
- data/vendor/kreuzberg/src/text/mod.rs +25 -25
- data/vendor/kreuzberg/src/text/quality.rs +697 -697
- data/vendor/kreuzberg/src/text/quality_processor.rs +219 -219
- data/vendor/kreuzberg/src/text/string_utils.rs +217 -217
- data/vendor/kreuzberg/src/text/token_reduction/cjk_utils.rs +164 -164
- data/vendor/kreuzberg/src/text/token_reduction/config.rs +100 -100
- data/vendor/kreuzberg/src/text/token_reduction/core.rs +796 -796
- data/vendor/kreuzberg/src/text/token_reduction/filters.rs +902 -902
- data/vendor/kreuzberg/src/text/token_reduction/mod.rs +160 -160
- data/vendor/kreuzberg/src/text/token_reduction/semantic.rs +619 -619
- data/vendor/kreuzberg/src/text/token_reduction/simd_text.rs +147 -147
- data/vendor/kreuzberg/src/types.rs +1055 -1055
- data/vendor/kreuzberg/src/utils/mod.rs +17 -17
- data/vendor/kreuzberg/src/utils/quality.rs +959 -959
- data/vendor/kreuzberg/src/utils/string_utils.rs +381 -381
- data/vendor/kreuzberg/stopwords/af_stopwords.json +53 -53
- data/vendor/kreuzberg/stopwords/ar_stopwords.json +482 -482
- data/vendor/kreuzberg/stopwords/bg_stopwords.json +261 -261
- data/vendor/kreuzberg/stopwords/bn_stopwords.json +400 -400
- data/vendor/kreuzberg/stopwords/br_stopwords.json +1205 -1205
- data/vendor/kreuzberg/stopwords/ca_stopwords.json +280 -280
- data/vendor/kreuzberg/stopwords/cs_stopwords.json +425 -425
- data/vendor/kreuzberg/stopwords/da_stopwords.json +172 -172
- data/vendor/kreuzberg/stopwords/de_stopwords.json +622 -622
- data/vendor/kreuzberg/stopwords/el_stopwords.json +849 -849
- data/vendor/kreuzberg/stopwords/en_stopwords.json +1300 -1300
- data/vendor/kreuzberg/stopwords/eo_stopwords.json +175 -175
- data/vendor/kreuzberg/stopwords/es_stopwords.json +734 -734
- data/vendor/kreuzberg/stopwords/et_stopwords.json +37 -37
- data/vendor/kreuzberg/stopwords/eu_stopwords.json +100 -100
- data/vendor/kreuzberg/stopwords/fa_stopwords.json +801 -801
- data/vendor/kreuzberg/stopwords/fi_stopwords.json +849 -849
- data/vendor/kreuzberg/stopwords/fr_stopwords.json +693 -693
- data/vendor/kreuzberg/stopwords/ga_stopwords.json +111 -111
- data/vendor/kreuzberg/stopwords/gl_stopwords.json +162 -162
- data/vendor/kreuzberg/stopwords/gu_stopwords.json +226 -226
- data/vendor/kreuzberg/stopwords/ha_stopwords.json +41 -41
- data/vendor/kreuzberg/stopwords/he_stopwords.json +196 -196
- data/vendor/kreuzberg/stopwords/hi_stopwords.json +227 -227
- data/vendor/kreuzberg/stopwords/hr_stopwords.json +181 -181
- data/vendor/kreuzberg/stopwords/hu_stopwords.json +791 -791
- data/vendor/kreuzberg/stopwords/hy_stopwords.json +47 -47
- data/vendor/kreuzberg/stopwords/id_stopwords.json +760 -760
- data/vendor/kreuzberg/stopwords/it_stopwords.json +634 -634
- data/vendor/kreuzberg/stopwords/ja_stopwords.json +136 -136
- data/vendor/kreuzberg/stopwords/kn_stopwords.json +84 -84
- data/vendor/kreuzberg/stopwords/ko_stopwords.json +681 -681
- data/vendor/kreuzberg/stopwords/ku_stopwords.json +64 -64
- data/vendor/kreuzberg/stopwords/la_stopwords.json +51 -51
- data/vendor/kreuzberg/stopwords/lt_stopwords.json +476 -476
- data/vendor/kreuzberg/stopwords/lv_stopwords.json +163 -163
- data/vendor/kreuzberg/stopwords/ml_stopwords.json +1 -1
- data/vendor/kreuzberg/stopwords/mr_stopwords.json +101 -101
- data/vendor/kreuzberg/stopwords/ms_stopwords.json +477 -477
- data/vendor/kreuzberg/stopwords/ne_stopwords.json +490 -490
- data/vendor/kreuzberg/stopwords/nl_stopwords.json +415 -415
- data/vendor/kreuzberg/stopwords/no_stopwords.json +223 -223
- data/vendor/kreuzberg/stopwords/pl_stopwords.json +331 -331
- data/vendor/kreuzberg/stopwords/pt_stopwords.json +562 -562
- data/vendor/kreuzberg/stopwords/ro_stopwords.json +436 -436
- data/vendor/kreuzberg/stopwords/ru_stopwords.json +561 -561
- data/vendor/kreuzberg/stopwords/si_stopwords.json +193 -193
- data/vendor/kreuzberg/stopwords/sk_stopwords.json +420 -420
- data/vendor/kreuzberg/stopwords/sl_stopwords.json +448 -448
- data/vendor/kreuzberg/stopwords/so_stopwords.json +32 -32
- data/vendor/kreuzberg/stopwords/st_stopwords.json +33 -33
- data/vendor/kreuzberg/stopwords/sv_stopwords.json +420 -420
- data/vendor/kreuzberg/stopwords/sw_stopwords.json +76 -76
- data/vendor/kreuzberg/stopwords/ta_stopwords.json +129 -129
- data/vendor/kreuzberg/stopwords/te_stopwords.json +54 -54
- data/vendor/kreuzberg/stopwords/th_stopwords.json +118 -118
- data/vendor/kreuzberg/stopwords/tl_stopwords.json +149 -149
- data/vendor/kreuzberg/stopwords/tr_stopwords.json +506 -506
- data/vendor/kreuzberg/stopwords/uk_stopwords.json +75 -75
- data/vendor/kreuzberg/stopwords/ur_stopwords.json +519 -519
- data/vendor/kreuzberg/stopwords/vi_stopwords.json +647 -647
- data/vendor/kreuzberg/stopwords/yo_stopwords.json +62 -62
- data/vendor/kreuzberg/stopwords/zh_stopwords.json +796 -796
- data/vendor/kreuzberg/stopwords/zu_stopwords.json +31 -31
- data/vendor/kreuzberg/tests/api_extract_multipart.rs +52 -52
- data/vendor/kreuzberg/tests/api_tests.rs +966 -966
- data/vendor/kreuzberg/tests/archive_integration.rs +545 -545
- data/vendor/kreuzberg/tests/batch_orchestration.rs +556 -556
- data/vendor/kreuzberg/tests/batch_processing.rs +318 -318
- data/vendor/kreuzberg/tests/bibtex_parity_test.rs +421 -421
- data/vendor/kreuzberg/tests/concurrency_stress.rs +533 -533
- data/vendor/kreuzberg/tests/config_features.rs +612 -612
- data/vendor/kreuzberg/tests/config_loading_tests.rs +416 -416
- data/vendor/kreuzberg/tests/core_integration.rs +510 -510
- data/vendor/kreuzberg/tests/csv_integration.rs +414 -414
- data/vendor/kreuzberg/tests/docbook_extractor_tests.rs +500 -500
- data/vendor/kreuzberg/tests/docx_metadata_extraction_test.rs +122 -122
- data/vendor/kreuzberg/tests/docx_vs_pandoc_comparison.rs +370 -370
- data/vendor/kreuzberg/tests/email_integration.rs +327 -327
- data/vendor/kreuzberg/tests/epub_native_extractor_tests.rs +275 -275
- data/vendor/kreuzberg/tests/error_handling.rs +402 -402
- data/vendor/kreuzberg/tests/fictionbook_extractor_tests.rs +228 -228
- data/vendor/kreuzberg/tests/format_integration.rs +164 -164
- data/vendor/kreuzberg/tests/helpers/mod.rs +142 -142
- data/vendor/kreuzberg/tests/html_table_test.rs +551 -551
- data/vendor/kreuzberg/tests/image_integration.rs +255 -255
- data/vendor/kreuzberg/tests/instrumentation_test.rs +139 -139
- data/vendor/kreuzberg/tests/jats_extractor_tests.rs +639 -639
- data/vendor/kreuzberg/tests/jupyter_extractor_tests.rs +704 -704
- data/vendor/kreuzberg/tests/keywords_integration.rs +479 -479
- data/vendor/kreuzberg/tests/keywords_quality.rs +509 -509
- data/vendor/kreuzberg/tests/latex_extractor_tests.rs +496 -496
- data/vendor/kreuzberg/tests/markdown_extractor_tests.rs +490 -490
- data/vendor/kreuzberg/tests/mime_detection.rs +429 -429
- data/vendor/kreuzberg/tests/ocr_configuration.rs +514 -514
- data/vendor/kreuzberg/tests/ocr_errors.rs +698 -698
- data/vendor/kreuzberg/tests/ocr_quality.rs +629 -629
- data/vendor/kreuzberg/tests/ocr_stress.rs +469 -469
- data/vendor/kreuzberg/tests/odt_extractor_tests.rs +674 -674
- data/vendor/kreuzberg/tests/opml_extractor_tests.rs +616 -616
- data/vendor/kreuzberg/tests/orgmode_extractor_tests.rs +822 -822
- data/vendor/kreuzberg/tests/pdf_integration.rs +45 -45
- data/vendor/kreuzberg/tests/pdfium_linking.rs +374 -374
- data/vendor/kreuzberg/tests/pipeline_integration.rs +1436 -1436
- data/vendor/kreuzberg/tests/plugin_ocr_backend_test.rs +776 -776
- data/vendor/kreuzberg/tests/plugin_postprocessor_test.rs +560 -560
- data/vendor/kreuzberg/tests/plugin_system.rs +927 -927
- data/vendor/kreuzberg/tests/plugin_validator_test.rs +783 -783
- data/vendor/kreuzberg/tests/registry_integration_tests.rs +587 -587
- data/vendor/kreuzberg/tests/rst_extractor_tests.rs +694 -694
- data/vendor/kreuzberg/tests/rtf_extractor_tests.rs +775 -775
- data/vendor/kreuzberg/tests/security_validation.rs +416 -416
- data/vendor/kreuzberg/tests/stopwords_integration_test.rs +888 -888
- data/vendor/kreuzberg/tests/test_fastembed.rs +631 -631
- data/vendor/kreuzberg/tests/typst_behavioral_tests.rs +1260 -1260
- data/vendor/kreuzberg/tests/typst_extractor_tests.rs +648 -648
- data/vendor/kreuzberg/tests/xlsx_metadata_extraction_test.rs +87 -87
- data/vendor/kreuzberg-ffi/Cargo.toml +1 -1
- data/vendor/kreuzberg-ffi/README.md +851 -851
- data/vendor/kreuzberg-ffi/build.rs +176 -176
- data/vendor/kreuzberg-ffi/cbindgen.toml +27 -27
- data/vendor/kreuzberg-ffi/kreuzberg-ffi.pc.in +12 -12
- data/vendor/kreuzberg-ffi/kreuzberg.h +1087 -1087
- data/vendor/kreuzberg-ffi/src/lib.rs +3616 -3616
- data/vendor/kreuzberg-ffi/src/panic_shield.rs +247 -247
- data/vendor/kreuzberg-ffi/tests.disabled/README.md +48 -48
- data/vendor/kreuzberg-ffi/tests.disabled/config_loading_tests.rs +299 -299
- data/vendor/kreuzberg-ffi/tests.disabled/config_tests.rs +346 -346
- data/vendor/kreuzberg-ffi/tests.disabled/extractor_tests.rs +232 -232
- data/vendor/kreuzberg-ffi/tests.disabled/plugin_registration_tests.rs +470 -470
- data/vendor/kreuzberg-tesseract/.commitlintrc.json +13 -13
- data/vendor/kreuzberg-tesseract/.crate-ignore +2 -2
- data/vendor/kreuzberg-tesseract/Cargo.lock +2933 -2933
- data/vendor/kreuzberg-tesseract/Cargo.toml +2 -2
- data/vendor/kreuzberg-tesseract/LICENSE +22 -22
- data/vendor/kreuzberg-tesseract/README.md +399 -399
- data/vendor/kreuzberg-tesseract/build.rs +1354 -1354
- data/vendor/kreuzberg-tesseract/patches/README.md +71 -71
- data/vendor/kreuzberg-tesseract/patches/tesseract.diff +199 -199
- data/vendor/kreuzberg-tesseract/src/api.rs +1371 -1371
- data/vendor/kreuzberg-tesseract/src/choice_iterator.rs +77 -77
- data/vendor/kreuzberg-tesseract/src/enums.rs +297 -297
- data/vendor/kreuzberg-tesseract/src/error.rs +81 -81
- data/vendor/kreuzberg-tesseract/src/lib.rs +145 -145
- data/vendor/kreuzberg-tesseract/src/monitor.rs +57 -57
- data/vendor/kreuzberg-tesseract/src/mutable_iterator.rs +197 -197
- data/vendor/kreuzberg-tesseract/src/page_iterator.rs +253 -253
- data/vendor/kreuzberg-tesseract/src/result_iterator.rs +286 -286
- data/vendor/kreuzberg-tesseract/src/result_renderer.rs +183 -183
- data/vendor/kreuzberg-tesseract/tests/integration_test.rs +211 -211
- data/vendor/rb-sys/.cargo_vcs_info.json +5 -5
- data/vendor/rb-sys/Cargo.lock +393 -393
- data/vendor/rb-sys/Cargo.toml +70 -70
- data/vendor/rb-sys/Cargo.toml.orig +57 -57
- data/vendor/rb-sys/LICENSE-APACHE +190 -190
- data/vendor/rb-sys/LICENSE-MIT +21 -21
- data/vendor/rb-sys/build/features.rs +111 -111
- data/vendor/rb-sys/build/main.rs +286 -286
- data/vendor/rb-sys/build/stable_api_config.rs +155 -155
- data/vendor/rb-sys/build/version.rs +50 -50
- data/vendor/rb-sys/readme.md +36 -36
- data/vendor/rb-sys/src/bindings.rs +21 -21
- data/vendor/rb-sys/src/hidden.rs +11 -11
- data/vendor/rb-sys/src/lib.rs +35 -35
- data/vendor/rb-sys/src/macros.rs +371 -371
- data/vendor/rb-sys/src/memory.rs +53 -53
- data/vendor/rb-sys/src/ruby_abi_version.rs +38 -38
- data/vendor/rb-sys/src/special_consts.rs +31 -31
- data/vendor/rb-sys/src/stable_api/compiled.c +179 -179
- data/vendor/rb-sys/src/stable_api/compiled.rs +257 -257
- data/vendor/rb-sys/src/stable_api/ruby_2_7.rs +324 -324
- data/vendor/rb-sys/src/stable_api/ruby_3_0.rs +332 -332
- data/vendor/rb-sys/src/stable_api/ruby_3_1.rs +325 -325
- data/vendor/rb-sys/src/stable_api/ruby_3_2.rs +323 -323
- data/vendor/rb-sys/src/stable_api/ruby_3_3.rs +339 -339
- data/vendor/rb-sys/src/stable_api/ruby_3_4.rs +339 -339
- data/vendor/rb-sys/src/stable_api.rs +260 -260
- data/vendor/rb-sys/src/symbol.rs +31 -31
- data/vendor/rb-sys/src/tracking_allocator.rs +330 -330
- data/vendor/rb-sys/src/utils.rs +89 -89
- data/vendor/rb-sys/src/value_type.rs +7 -7
- metadata +73 -4
- data/vendor/kreuzberg-ffi/kreuzberg-ffi-install.pc +0 -12
data/vendor/rb-sys/src/macros.rs
CHANGED
|
@@ -1,371 +1,371 @@
|
|
|
1
|
-
//! Implementation of Ruby macros.
|
|
2
|
-
//!
|
|
3
|
-
//! Since macros are rely on the C preprocessor, or defined as `inline` C
|
|
4
|
-
//! functions, they are not available when linking libruby. In order to use the
|
|
5
|
-
//! libruby macros from Rust, `rb-sys` implements them using the following
|
|
6
|
-
//! strategies:
|
|
7
|
-
//!
|
|
8
|
-
//! 1. For stable versions of Ruby, the macros are implemented as Rust functions
|
|
9
|
-
//! 2. For ruby-head, the macros are implemented as C functions that are linked
|
|
10
|
-
//! into the crate.
|
|
11
|
-
|
|
12
|
-
#![allow(rustdoc::broken_intra_doc_links)]
|
|
13
|
-
#![allow(non_upper_case_globals)]
|
|
14
|
-
#![allow(non_snake_case)]
|
|
15
|
-
|
|
16
|
-
use crate::rb_data_type_t;
|
|
17
|
-
use crate::ruby_value_type;
|
|
18
|
-
use crate::stable_api::get_default as api;
|
|
19
|
-
use crate::StableApiDefinition;
|
|
20
|
-
use crate::VALUE;
|
|
21
|
-
use std::ffi::c_void;
|
|
22
|
-
use std::os::raw::{c_char, c_long};
|
|
23
|
-
|
|
24
|
-
/// Emulates Ruby's "if" statement.
|
|
25
|
-
///
|
|
26
|
-
/// - @param[in] obj An arbitrary ruby object.
|
|
27
|
-
/// - @retval false `obj` is either ::RUBY_Qfalse or ::RUBY_Qnil.
|
|
28
|
-
/// - @retval true Anything else.
|
|
29
|
-
///
|
|
30
|
-
/// ```
|
|
31
|
-
/// use rb_sys::special_consts::*;
|
|
32
|
-
///
|
|
33
|
-
/// assert!(!TEST(Qfalse));
|
|
34
|
-
/// assert!(!TEST(Qnil));
|
|
35
|
-
/// assert!(TEST(Qtrue));
|
|
36
|
-
/// ```
|
|
37
|
-
#[inline]
|
|
38
|
-
pub fn TEST<T: Into<VALUE>>(obj: T) -> bool {
|
|
39
|
-
api().rb_test(obj.into())
|
|
40
|
-
}
|
|
41
|
-
|
|
42
|
-
/// Checks if the given object is nil.
|
|
43
|
-
///
|
|
44
|
-
/// - @param[in] obj An arbitrary ruby object.
|
|
45
|
-
/// - @retval true `obj` is ::RUBY_Qnil.
|
|
46
|
-
/// - @retval false Anything else.
|
|
47
|
-
///
|
|
48
|
-
/// ### Example
|
|
49
|
-
///
|
|
50
|
-
/// ```
|
|
51
|
-
/// use rb_sys::special_consts::*;
|
|
52
|
-
///
|
|
53
|
-
/// assert!(NIL_P(Qnil));
|
|
54
|
-
/// assert!(!NIL_P(Qtrue));
|
|
55
|
-
/// ```
|
|
56
|
-
#[inline]
|
|
57
|
-
pub fn NIL_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
58
|
-
api().nil_p(obj.into())
|
|
59
|
-
}
|
|
60
|
-
|
|
61
|
-
/// Checks if the given object is a so-called Fixnum.
|
|
62
|
-
///
|
|
63
|
-
/// - @param[in] obj An arbitrary ruby object.
|
|
64
|
-
/// - @retval true `obj` is a Fixnum.
|
|
65
|
-
/// - @retval false Anything else.
|
|
66
|
-
/// - @note Fixnum was a thing in the 20th century, but it is rather an implementation detail today.
|
|
67
|
-
#[inline]
|
|
68
|
-
pub fn FIXNUM_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
69
|
-
api().fixnum_p(obj.into())
|
|
70
|
-
}
|
|
71
|
-
|
|
72
|
-
/// Checks if the given object is a static symbol.
|
|
73
|
-
///
|
|
74
|
-
/// - @param[in] obj An arbitrary ruby object.
|
|
75
|
-
/// - @retval true `obj` is a static symbol
|
|
76
|
-
/// - @retval false Anything else.
|
|
77
|
-
/// - @see RB_DYNAMIC_SYM_P()
|
|
78
|
-
/// - @see RB_SYMBOL_P()
|
|
79
|
-
/// - @note These days there are static and dynamic symbols, just like we once had Fixnum/Bignum back in the old days.
|
|
80
|
-
#[inline]
|
|
81
|
-
pub fn STATIC_SYM_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
82
|
-
api().static_sym_p(obj.into())
|
|
83
|
-
}
|
|
84
|
-
|
|
85
|
-
/// Get the backend storage of a Ruby array.
|
|
86
|
-
///
|
|
87
|
-
/// ### Safety
|
|
88
|
-
///
|
|
89
|
-
/// This function is unsafe because it dereferences a raw pointer and returns
|
|
90
|
-
/// raw pointers to Ruby memory. The caller must ensure that the pointer stays live
|
|
91
|
-
/// for the duration of usage the the underlying array (by either GC marking or
|
|
92
|
-
/// keeping the RArray on the stack).
|
|
93
|
-
///
|
|
94
|
-
/// - @param[in] a An object of ::RArray.
|
|
95
|
-
/// - @return Its backend storage.
|
|
96
|
-
#[inline]
|
|
97
|
-
pub unsafe fn RARRAY_CONST_PTR<T: Into<VALUE>>(obj: T) -> *const VALUE {
|
|
98
|
-
api().rarray_const_ptr(obj.into())
|
|
99
|
-
}
|
|
100
|
-
|
|
101
|
-
/// Get the length of a Ruby array.
|
|
102
|
-
///
|
|
103
|
-
/// ### Safety
|
|
104
|
-
///
|
|
105
|
-
/// This function is unsafe because it dereferences a raw pointer in order to
|
|
106
|
-
/// access internal Ruby memory.
|
|
107
|
-
///
|
|
108
|
-
/// - @param[in] a An object of ::RArray.
|
|
109
|
-
/// - @return Its length.
|
|
110
|
-
#[inline]
|
|
111
|
-
pub unsafe fn RARRAY_LEN<T: Into<VALUE>>(obj: T) -> c_long {
|
|
112
|
-
api().rarray_len(obj.into())
|
|
113
|
-
}
|
|
114
|
-
|
|
115
|
-
/// Get the length of a Ruby string.
|
|
116
|
-
///
|
|
117
|
-
/// ### Safety
|
|
118
|
-
///
|
|
119
|
-
/// This function is unsafe because it dereferences a raw pointer in order to
|
|
120
|
-
/// access internal Ruby memory.
|
|
121
|
-
///
|
|
122
|
-
/// - @param[in] a An object of ::RString.
|
|
123
|
-
/// - @return Its length.
|
|
124
|
-
#[inline]
|
|
125
|
-
pub unsafe fn RSTRING_LEN<T: Into<VALUE>>(obj: T) -> c_long {
|
|
126
|
-
api().rstring_len(obj.into())
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
/// Get the backend storage of a Ruby string.
|
|
130
|
-
///
|
|
131
|
-
/// ### Safety
|
|
132
|
-
///
|
|
133
|
-
/// This function is unsafe because it dereferences a raw pointer and returns
|
|
134
|
-
/// raw pointers to Ruby memory.
|
|
135
|
-
///
|
|
136
|
-
/// - @param[in] a An object of ::RString.
|
|
137
|
-
/// - @return Its backend storage
|
|
138
|
-
#[inline]
|
|
139
|
-
pub unsafe fn RSTRING_PTR<T: Into<VALUE>>(obj: T) -> *const c_char {
|
|
140
|
-
api().rstring_ptr(obj.into())
|
|
141
|
-
}
|
|
142
|
-
|
|
143
|
-
/// Checks if the given object is a so-called Flonum.
|
|
144
|
-
///
|
|
145
|
-
/// @param[in] obj An arbitrary ruby object.
|
|
146
|
-
/// @retval true `obj` is a Flonum.
|
|
147
|
-
/// @retval false Anything else.
|
|
148
|
-
/// @see RB_FLOAT_TYPE_P()
|
|
149
|
-
/// @note These days there are Flonums and non-Flonum floats, just like we
|
|
150
|
-
/// once had Fixnum/Bignum back in the old days.
|
|
151
|
-
#[inline]
|
|
152
|
-
pub fn FLONUM_P<T: Into<VALUE>>(#[allow(unused)] obj: T) -> bool {
|
|
153
|
-
api().flonum_p(obj.into())
|
|
154
|
-
}
|
|
155
|
-
|
|
156
|
-
/// Checks if the given object is an immediate i.e. an object which has no
|
|
157
|
-
/// corresponding storage inside of the object space.
|
|
158
|
-
///
|
|
159
|
-
/// @param[in] obj An arbitrary ruby object.
|
|
160
|
-
/// @retval true `obj` is a Flonum.
|
|
161
|
-
/// @retval false Anything else.
|
|
162
|
-
/// @see RB_FLOAT_TYPE_P()
|
|
163
|
-
/// @note The concept of "immediate" is purely C specific.
|
|
164
|
-
#[inline]
|
|
165
|
-
pub fn IMMEDIATE_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
166
|
-
api().immediate_p(obj.into())
|
|
167
|
-
}
|
|
168
|
-
|
|
169
|
-
/// Checks if the given object is of enum ::ruby_special_consts.
|
|
170
|
-
///
|
|
171
|
-
/// @param[in] obj An arbitrary ruby object.
|
|
172
|
-
/// @retval true `obj` is a special constant.
|
|
173
|
-
/// @retval false Anything else.
|
|
174
|
-
///
|
|
175
|
-
/// ### Example
|
|
176
|
-
///
|
|
177
|
-
/// ```
|
|
178
|
-
/// use rb_sys::special_consts::*;
|
|
179
|
-
///
|
|
180
|
-
/// assert!(SPECIAL_CONST_P(Qnil));
|
|
181
|
-
/// assert!(SPECIAL_CONST_P(Qtrue));
|
|
182
|
-
/// assert!(SPECIAL_CONST_P(Qfalse));
|
|
183
|
-
/// ```
|
|
184
|
-
#[inline]
|
|
185
|
-
pub fn SPECIAL_CONST_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
186
|
-
api().special_const_p(obj.into())
|
|
187
|
-
}
|
|
188
|
-
|
|
189
|
-
/// Queries the type of the object.
|
|
190
|
-
///
|
|
191
|
-
/// @param[in] obj Object in question.
|
|
192
|
-
/// @pre `obj` must not be a special constant.
|
|
193
|
-
/// @return The type of `obj`.
|
|
194
|
-
///
|
|
195
|
-
/// # Safety
|
|
196
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
197
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
198
|
-
#[inline]
|
|
199
|
-
pub unsafe fn RB_BUILTIN_TYPE(obj: VALUE) -> ruby_value_type {
|
|
200
|
-
api().builtin_type(obj)
|
|
201
|
-
}
|
|
202
|
-
|
|
203
|
-
/// Queries if the object is an instance of ::rb_cInteger.
|
|
204
|
-
///
|
|
205
|
-
/// @param[in] obj Object in question.
|
|
206
|
-
/// @retval true It is.
|
|
207
|
-
/// @retval false It isn't.
|
|
208
|
-
///
|
|
209
|
-
/// # Safety
|
|
210
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
211
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
212
|
-
#[inline]
|
|
213
|
-
pub unsafe fn RB_INTEGER_TYPE_P(obj: VALUE) -> bool {
|
|
214
|
-
api().integer_type_p(obj)
|
|
215
|
-
}
|
|
216
|
-
|
|
217
|
-
/// Queries if the object is a dynamic symbol.
|
|
218
|
-
///
|
|
219
|
-
/// @param[in] obj Object in question.
|
|
220
|
-
/// @retval true It is.
|
|
221
|
-
/// @retval false It isn't.
|
|
222
|
-
///
|
|
223
|
-
/// # Safety
|
|
224
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
225
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
226
|
-
#[inline]
|
|
227
|
-
pub unsafe fn RB_DYNAMIC_SYM_P(obj: VALUE) -> bool {
|
|
228
|
-
api().dynamic_sym_p(obj)
|
|
229
|
-
}
|
|
230
|
-
|
|
231
|
-
/// Queries if the object is an instance of ::rb_cSymbol.
|
|
232
|
-
///
|
|
233
|
-
/// @param[in] obj Object in question.
|
|
234
|
-
/// @retval true It is.
|
|
235
|
-
/// @retval false It isn't.
|
|
236
|
-
///
|
|
237
|
-
/// # Safety
|
|
238
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
239
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
240
|
-
#[inline]
|
|
241
|
-
pub unsafe fn RB_SYMBOL_P(obj: VALUE) -> bool {
|
|
242
|
-
api().symbol_p(obj)
|
|
243
|
-
}
|
|
244
|
-
|
|
245
|
-
/// Identical to RB_BUILTIN_TYPE(), except it can also accept special constants.
|
|
246
|
-
///
|
|
247
|
-
/// @param[in] obj Object in question.
|
|
248
|
-
/// @return The type of `obj`.
|
|
249
|
-
///
|
|
250
|
-
/// # Safety
|
|
251
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
252
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
253
|
-
#[inline]
|
|
254
|
-
pub unsafe fn RB_TYPE(value: VALUE) -> ruby_value_type {
|
|
255
|
-
api().rb_type(value)
|
|
256
|
-
}
|
|
257
|
-
|
|
258
|
-
/// Queries if the given object is of given type.
|
|
259
|
-
///
|
|
260
|
-
/// @param[in] obj An object.
|
|
261
|
-
/// @param[in] t A type.
|
|
262
|
-
/// @retval true `obj` is of type `t`.
|
|
263
|
-
/// @retval false Otherwise.
|
|
264
|
-
///
|
|
265
|
-
/// # Safety
|
|
266
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
267
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
268
|
-
#[inline]
|
|
269
|
-
#[cfg(ruby_engine = "mri")] // truffleruby provides its own implementation
|
|
270
|
-
pub unsafe fn RB_TYPE_P(obj: VALUE, ty: ruby_value_type) -> bool {
|
|
271
|
-
api().type_p(obj, ty)
|
|
272
|
-
}
|
|
273
|
-
|
|
274
|
-
/// Queries if the object is an instance of ::rb_cFloat.
|
|
275
|
-
///
|
|
276
|
-
/// @param[in] obj Object in question.
|
|
277
|
-
/// @retval true It is.
|
|
278
|
-
/// @retval false It isn't.
|
|
279
|
-
///
|
|
280
|
-
/// # Safety
|
|
281
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
282
|
-
/// attemping to access the underlying [`RBasic`] struct.
|
|
283
|
-
#[inline]
|
|
284
|
-
pub unsafe fn RB_FLOAT_TYPE_P(obj: VALUE) -> bool {
|
|
285
|
-
api().float_type_p(obj)
|
|
286
|
-
}
|
|
287
|
-
|
|
288
|
-
/// Checks if the given object is an RTypedData.
|
|
289
|
-
///
|
|
290
|
-
/// @param[in] obj Object in question.
|
|
291
|
-
/// @retval true It is an RTypedData.
|
|
292
|
-
/// @retval false It isn't an RTypedData.
|
|
293
|
-
///
|
|
294
|
-
/// # Safety
|
|
295
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
296
|
-
/// accessing the underlying data structure.
|
|
297
|
-
#[inline]
|
|
298
|
-
pub unsafe fn RTYPEDDATA_P(obj: VALUE) -> bool {
|
|
299
|
-
api().rtypeddata_p(obj)
|
|
300
|
-
}
|
|
301
|
-
|
|
302
|
-
/// Checks if the given RTypedData is embedded.
|
|
303
|
-
///
|
|
304
|
-
/// @param[in] obj An RTypedData object.
|
|
305
|
-
/// @retval true The data is embedded in the object itself.
|
|
306
|
-
/// @retval false The data is stored separately.
|
|
307
|
-
///
|
|
308
|
-
/// # Safety
|
|
309
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
310
|
-
/// accessing the underlying data structure. The caller must ensure the object
|
|
311
|
-
/// is a valid RTypedData.
|
|
312
|
-
#[inline]
|
|
313
|
-
pub unsafe fn RTYPEDDATA_EMBEDDED_P(obj: VALUE) -> bool {
|
|
314
|
-
api().rtypeddata_embedded_p(obj)
|
|
315
|
-
}
|
|
316
|
-
|
|
317
|
-
/// Gets the data type information from an RTypedData object.
|
|
318
|
-
///
|
|
319
|
-
/// @param[in] obj An RTypedData object.
|
|
320
|
-
/// @return Pointer to the rb_data_type_t structure for this object.
|
|
321
|
-
///
|
|
322
|
-
/// # Safety
|
|
323
|
-
/// This function is unsafe because it dereferences a raw pointer to get
|
|
324
|
-
/// access to the underlying data type. The caller must ensure the object
|
|
325
|
-
/// is a valid RTypedData.
|
|
326
|
-
#[inline]
|
|
327
|
-
pub unsafe fn RTYPEDDATA_TYPE(obj: VALUE) -> *const rb_data_type_t {
|
|
328
|
-
api().rtypeddata_type(obj)
|
|
329
|
-
}
|
|
330
|
-
|
|
331
|
-
/// Gets the data pointer from an RTypedData object.
|
|
332
|
-
///
|
|
333
|
-
/// @param[in] obj An RTypedData object.
|
|
334
|
-
/// @return Pointer to the wrapped C struct.
|
|
335
|
-
///
|
|
336
|
-
/// # Safety
|
|
337
|
-
/// This function is unsafe because it dereferences a raw pointer to get
|
|
338
|
-
/// access to the underlying data. The caller must ensure the object
|
|
339
|
-
/// is a valid RTypedData.
|
|
340
|
-
#[inline]
|
|
341
|
-
pub unsafe fn RTYPEDDATA_GET_DATA(obj: VALUE) -> *mut c_void {
|
|
342
|
-
api().rtypeddata_get_data(obj)
|
|
343
|
-
}
|
|
344
|
-
|
|
345
|
-
/// Checks if the bignum is positive.
|
|
346
|
-
///
|
|
347
|
-
/// @param[in] b An object of RBignum.
|
|
348
|
-
/// @retval false `b` is less than zero.
|
|
349
|
-
/// @retval true Otherwise.
|
|
350
|
-
///
|
|
351
|
-
/// # Safety
|
|
352
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
353
|
-
/// accessing the underlying bignum structure.
|
|
354
|
-
#[inline]
|
|
355
|
-
pub unsafe fn RBIGNUM_POSITIVE_P(b: VALUE) -> bool {
|
|
356
|
-
api().bignum_positive_p(b)
|
|
357
|
-
}
|
|
358
|
-
|
|
359
|
-
/// Checks if the bignum is negative.
|
|
360
|
-
///
|
|
361
|
-
/// @param[in] b An object of RBignum.
|
|
362
|
-
/// @retval true `b` is less than zero.
|
|
363
|
-
/// @retval false Otherwise.
|
|
364
|
-
///
|
|
365
|
-
/// # Safety
|
|
366
|
-
/// This function is unsafe because it could dereference a raw pointer when
|
|
367
|
-
/// accessing the underlying bignum structure.
|
|
368
|
-
#[inline]
|
|
369
|
-
pub unsafe fn RBIGNUM_NEGATIVE_P(b: VALUE) -> bool {
|
|
370
|
-
api().bignum_negative_p(b)
|
|
371
|
-
}
|
|
1
|
+
//! Implementation of Ruby macros.
|
|
2
|
+
//!
|
|
3
|
+
//! Since macros are rely on the C preprocessor, or defined as `inline` C
|
|
4
|
+
//! functions, they are not available when linking libruby. In order to use the
|
|
5
|
+
//! libruby macros from Rust, `rb-sys` implements them using the following
|
|
6
|
+
//! strategies:
|
|
7
|
+
//!
|
|
8
|
+
//! 1. For stable versions of Ruby, the macros are implemented as Rust functions
|
|
9
|
+
//! 2. For ruby-head, the macros are implemented as C functions that are linked
|
|
10
|
+
//! into the crate.
|
|
11
|
+
|
|
12
|
+
#![allow(rustdoc::broken_intra_doc_links)]
|
|
13
|
+
#![allow(non_upper_case_globals)]
|
|
14
|
+
#![allow(non_snake_case)]
|
|
15
|
+
|
|
16
|
+
use crate::rb_data_type_t;
|
|
17
|
+
use crate::ruby_value_type;
|
|
18
|
+
use crate::stable_api::get_default as api;
|
|
19
|
+
use crate::StableApiDefinition;
|
|
20
|
+
use crate::VALUE;
|
|
21
|
+
use std::ffi::c_void;
|
|
22
|
+
use std::os::raw::{c_char, c_long};
|
|
23
|
+
|
|
24
|
+
/// Emulates Ruby's "if" statement.
|
|
25
|
+
///
|
|
26
|
+
/// - @param[in] obj An arbitrary ruby object.
|
|
27
|
+
/// - @retval false `obj` is either ::RUBY_Qfalse or ::RUBY_Qnil.
|
|
28
|
+
/// - @retval true Anything else.
|
|
29
|
+
///
|
|
30
|
+
/// ```
|
|
31
|
+
/// use rb_sys::special_consts::*;
|
|
32
|
+
///
|
|
33
|
+
/// assert!(!TEST(Qfalse));
|
|
34
|
+
/// assert!(!TEST(Qnil));
|
|
35
|
+
/// assert!(TEST(Qtrue));
|
|
36
|
+
/// ```
|
|
37
|
+
#[inline]
|
|
38
|
+
pub fn TEST<T: Into<VALUE>>(obj: T) -> bool {
|
|
39
|
+
api().rb_test(obj.into())
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
/// Checks if the given object is nil.
|
|
43
|
+
///
|
|
44
|
+
/// - @param[in] obj An arbitrary ruby object.
|
|
45
|
+
/// - @retval true `obj` is ::RUBY_Qnil.
|
|
46
|
+
/// - @retval false Anything else.
|
|
47
|
+
///
|
|
48
|
+
/// ### Example
|
|
49
|
+
///
|
|
50
|
+
/// ```
|
|
51
|
+
/// use rb_sys::special_consts::*;
|
|
52
|
+
///
|
|
53
|
+
/// assert!(NIL_P(Qnil));
|
|
54
|
+
/// assert!(!NIL_P(Qtrue));
|
|
55
|
+
/// ```
|
|
56
|
+
#[inline]
|
|
57
|
+
pub fn NIL_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
58
|
+
api().nil_p(obj.into())
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
/// Checks if the given object is a so-called Fixnum.
|
|
62
|
+
///
|
|
63
|
+
/// - @param[in] obj An arbitrary ruby object.
|
|
64
|
+
/// - @retval true `obj` is a Fixnum.
|
|
65
|
+
/// - @retval false Anything else.
|
|
66
|
+
/// - @note Fixnum was a thing in the 20th century, but it is rather an implementation detail today.
|
|
67
|
+
#[inline]
|
|
68
|
+
pub fn FIXNUM_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
69
|
+
api().fixnum_p(obj.into())
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/// Checks if the given object is a static symbol.
|
|
73
|
+
///
|
|
74
|
+
/// - @param[in] obj An arbitrary ruby object.
|
|
75
|
+
/// - @retval true `obj` is a static symbol
|
|
76
|
+
/// - @retval false Anything else.
|
|
77
|
+
/// - @see RB_DYNAMIC_SYM_P()
|
|
78
|
+
/// - @see RB_SYMBOL_P()
|
|
79
|
+
/// - @note These days there are static and dynamic symbols, just like we once had Fixnum/Bignum back in the old days.
|
|
80
|
+
#[inline]
|
|
81
|
+
pub fn STATIC_SYM_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
82
|
+
api().static_sym_p(obj.into())
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/// Get the backend storage of a Ruby array.
|
|
86
|
+
///
|
|
87
|
+
/// ### Safety
|
|
88
|
+
///
|
|
89
|
+
/// This function is unsafe because it dereferences a raw pointer and returns
|
|
90
|
+
/// raw pointers to Ruby memory. The caller must ensure that the pointer stays live
|
|
91
|
+
/// for the duration of usage the the underlying array (by either GC marking or
|
|
92
|
+
/// keeping the RArray on the stack).
|
|
93
|
+
///
|
|
94
|
+
/// - @param[in] a An object of ::RArray.
|
|
95
|
+
/// - @return Its backend storage.
|
|
96
|
+
#[inline]
|
|
97
|
+
pub unsafe fn RARRAY_CONST_PTR<T: Into<VALUE>>(obj: T) -> *const VALUE {
|
|
98
|
+
api().rarray_const_ptr(obj.into())
|
|
99
|
+
}
|
|
100
|
+
|
|
101
|
+
/// Get the length of a Ruby array.
|
|
102
|
+
///
|
|
103
|
+
/// ### Safety
|
|
104
|
+
///
|
|
105
|
+
/// This function is unsafe because it dereferences a raw pointer in order to
|
|
106
|
+
/// access internal Ruby memory.
|
|
107
|
+
///
|
|
108
|
+
/// - @param[in] a An object of ::RArray.
|
|
109
|
+
/// - @return Its length.
|
|
110
|
+
#[inline]
|
|
111
|
+
pub unsafe fn RARRAY_LEN<T: Into<VALUE>>(obj: T) -> c_long {
|
|
112
|
+
api().rarray_len(obj.into())
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/// Get the length of a Ruby string.
|
|
116
|
+
///
|
|
117
|
+
/// ### Safety
|
|
118
|
+
///
|
|
119
|
+
/// This function is unsafe because it dereferences a raw pointer in order to
|
|
120
|
+
/// access internal Ruby memory.
|
|
121
|
+
///
|
|
122
|
+
/// - @param[in] a An object of ::RString.
|
|
123
|
+
/// - @return Its length.
|
|
124
|
+
#[inline]
|
|
125
|
+
pub unsafe fn RSTRING_LEN<T: Into<VALUE>>(obj: T) -> c_long {
|
|
126
|
+
api().rstring_len(obj.into())
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
/// Get the backend storage of a Ruby string.
|
|
130
|
+
///
|
|
131
|
+
/// ### Safety
|
|
132
|
+
///
|
|
133
|
+
/// This function is unsafe because it dereferences a raw pointer and returns
|
|
134
|
+
/// raw pointers to Ruby memory.
|
|
135
|
+
///
|
|
136
|
+
/// - @param[in] a An object of ::RString.
|
|
137
|
+
/// - @return Its backend storage
|
|
138
|
+
#[inline]
|
|
139
|
+
pub unsafe fn RSTRING_PTR<T: Into<VALUE>>(obj: T) -> *const c_char {
|
|
140
|
+
api().rstring_ptr(obj.into())
|
|
141
|
+
}
|
|
142
|
+
|
|
143
|
+
/// Checks if the given object is a so-called Flonum.
|
|
144
|
+
///
|
|
145
|
+
/// @param[in] obj An arbitrary ruby object.
|
|
146
|
+
/// @retval true `obj` is a Flonum.
|
|
147
|
+
/// @retval false Anything else.
|
|
148
|
+
/// @see RB_FLOAT_TYPE_P()
|
|
149
|
+
/// @note These days there are Flonums and non-Flonum floats, just like we
|
|
150
|
+
/// once had Fixnum/Bignum back in the old days.
|
|
151
|
+
#[inline]
|
|
152
|
+
pub fn FLONUM_P<T: Into<VALUE>>(#[allow(unused)] obj: T) -> bool {
|
|
153
|
+
api().flonum_p(obj.into())
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
/// Checks if the given object is an immediate i.e. an object which has no
|
|
157
|
+
/// corresponding storage inside of the object space.
|
|
158
|
+
///
|
|
159
|
+
/// @param[in] obj An arbitrary ruby object.
|
|
160
|
+
/// @retval true `obj` is a Flonum.
|
|
161
|
+
/// @retval false Anything else.
|
|
162
|
+
/// @see RB_FLOAT_TYPE_P()
|
|
163
|
+
/// @note The concept of "immediate" is purely C specific.
|
|
164
|
+
#[inline]
|
|
165
|
+
pub fn IMMEDIATE_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
166
|
+
api().immediate_p(obj.into())
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
/// Checks if the given object is of enum ::ruby_special_consts.
|
|
170
|
+
///
|
|
171
|
+
/// @param[in] obj An arbitrary ruby object.
|
|
172
|
+
/// @retval true `obj` is a special constant.
|
|
173
|
+
/// @retval false Anything else.
|
|
174
|
+
///
|
|
175
|
+
/// ### Example
|
|
176
|
+
///
|
|
177
|
+
/// ```
|
|
178
|
+
/// use rb_sys::special_consts::*;
|
|
179
|
+
///
|
|
180
|
+
/// assert!(SPECIAL_CONST_P(Qnil));
|
|
181
|
+
/// assert!(SPECIAL_CONST_P(Qtrue));
|
|
182
|
+
/// assert!(SPECIAL_CONST_P(Qfalse));
|
|
183
|
+
/// ```
|
|
184
|
+
#[inline]
|
|
185
|
+
pub fn SPECIAL_CONST_P<T: Into<VALUE>>(obj: T) -> bool {
|
|
186
|
+
api().special_const_p(obj.into())
|
|
187
|
+
}
|
|
188
|
+
|
|
189
|
+
/// Queries the type of the object.
|
|
190
|
+
///
|
|
191
|
+
/// @param[in] obj Object in question.
|
|
192
|
+
/// @pre `obj` must not be a special constant.
|
|
193
|
+
/// @return The type of `obj`.
|
|
194
|
+
///
|
|
195
|
+
/// # Safety
|
|
196
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
197
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
198
|
+
#[inline]
|
|
199
|
+
pub unsafe fn RB_BUILTIN_TYPE(obj: VALUE) -> ruby_value_type {
|
|
200
|
+
api().builtin_type(obj)
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
/// Queries if the object is an instance of ::rb_cInteger.
|
|
204
|
+
///
|
|
205
|
+
/// @param[in] obj Object in question.
|
|
206
|
+
/// @retval true It is.
|
|
207
|
+
/// @retval false It isn't.
|
|
208
|
+
///
|
|
209
|
+
/// # Safety
|
|
210
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
211
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
212
|
+
#[inline]
|
|
213
|
+
pub unsafe fn RB_INTEGER_TYPE_P(obj: VALUE) -> bool {
|
|
214
|
+
api().integer_type_p(obj)
|
|
215
|
+
}
|
|
216
|
+
|
|
217
|
+
/// Queries if the object is a dynamic symbol.
|
|
218
|
+
///
|
|
219
|
+
/// @param[in] obj Object in question.
|
|
220
|
+
/// @retval true It is.
|
|
221
|
+
/// @retval false It isn't.
|
|
222
|
+
///
|
|
223
|
+
/// # Safety
|
|
224
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
225
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
226
|
+
#[inline]
|
|
227
|
+
pub unsafe fn RB_DYNAMIC_SYM_P(obj: VALUE) -> bool {
|
|
228
|
+
api().dynamic_sym_p(obj)
|
|
229
|
+
}
|
|
230
|
+
|
|
231
|
+
/// Queries if the object is an instance of ::rb_cSymbol.
|
|
232
|
+
///
|
|
233
|
+
/// @param[in] obj Object in question.
|
|
234
|
+
/// @retval true It is.
|
|
235
|
+
/// @retval false It isn't.
|
|
236
|
+
///
|
|
237
|
+
/// # Safety
|
|
238
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
239
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
240
|
+
#[inline]
|
|
241
|
+
pub unsafe fn RB_SYMBOL_P(obj: VALUE) -> bool {
|
|
242
|
+
api().symbol_p(obj)
|
|
243
|
+
}
|
|
244
|
+
|
|
245
|
+
/// Identical to RB_BUILTIN_TYPE(), except it can also accept special constants.
|
|
246
|
+
///
|
|
247
|
+
/// @param[in] obj Object in question.
|
|
248
|
+
/// @return The type of `obj`.
|
|
249
|
+
///
|
|
250
|
+
/// # Safety
|
|
251
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
252
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
253
|
+
#[inline]
|
|
254
|
+
pub unsafe fn RB_TYPE(value: VALUE) -> ruby_value_type {
|
|
255
|
+
api().rb_type(value)
|
|
256
|
+
}
|
|
257
|
+
|
|
258
|
+
/// Queries if the given object is of given type.
|
|
259
|
+
///
|
|
260
|
+
/// @param[in] obj An object.
|
|
261
|
+
/// @param[in] t A type.
|
|
262
|
+
/// @retval true `obj` is of type `t`.
|
|
263
|
+
/// @retval false Otherwise.
|
|
264
|
+
///
|
|
265
|
+
/// # Safety
|
|
266
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
267
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
268
|
+
#[inline]
|
|
269
|
+
#[cfg(ruby_engine = "mri")] // truffleruby provides its own implementation
|
|
270
|
+
pub unsafe fn RB_TYPE_P(obj: VALUE, ty: ruby_value_type) -> bool {
|
|
271
|
+
api().type_p(obj, ty)
|
|
272
|
+
}
|
|
273
|
+
|
|
274
|
+
/// Queries if the object is an instance of ::rb_cFloat.
|
|
275
|
+
///
|
|
276
|
+
/// @param[in] obj Object in question.
|
|
277
|
+
/// @retval true It is.
|
|
278
|
+
/// @retval false It isn't.
|
|
279
|
+
///
|
|
280
|
+
/// # Safety
|
|
281
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
282
|
+
/// attemping to access the underlying [`RBasic`] struct.
|
|
283
|
+
#[inline]
|
|
284
|
+
pub unsafe fn RB_FLOAT_TYPE_P(obj: VALUE) -> bool {
|
|
285
|
+
api().float_type_p(obj)
|
|
286
|
+
}
|
|
287
|
+
|
|
288
|
+
/// Checks if the given object is an RTypedData.
|
|
289
|
+
///
|
|
290
|
+
/// @param[in] obj Object in question.
|
|
291
|
+
/// @retval true It is an RTypedData.
|
|
292
|
+
/// @retval false It isn't an RTypedData.
|
|
293
|
+
///
|
|
294
|
+
/// # Safety
|
|
295
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
296
|
+
/// accessing the underlying data structure.
|
|
297
|
+
#[inline]
|
|
298
|
+
pub unsafe fn RTYPEDDATA_P(obj: VALUE) -> bool {
|
|
299
|
+
api().rtypeddata_p(obj)
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
/// Checks if the given RTypedData is embedded.
|
|
303
|
+
///
|
|
304
|
+
/// @param[in] obj An RTypedData object.
|
|
305
|
+
/// @retval true The data is embedded in the object itself.
|
|
306
|
+
/// @retval false The data is stored separately.
|
|
307
|
+
///
|
|
308
|
+
/// # Safety
|
|
309
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
310
|
+
/// accessing the underlying data structure. The caller must ensure the object
|
|
311
|
+
/// is a valid RTypedData.
|
|
312
|
+
#[inline]
|
|
313
|
+
pub unsafe fn RTYPEDDATA_EMBEDDED_P(obj: VALUE) -> bool {
|
|
314
|
+
api().rtypeddata_embedded_p(obj)
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
/// Gets the data type information from an RTypedData object.
|
|
318
|
+
///
|
|
319
|
+
/// @param[in] obj An RTypedData object.
|
|
320
|
+
/// @return Pointer to the rb_data_type_t structure for this object.
|
|
321
|
+
///
|
|
322
|
+
/// # Safety
|
|
323
|
+
/// This function is unsafe because it dereferences a raw pointer to get
|
|
324
|
+
/// access to the underlying data type. The caller must ensure the object
|
|
325
|
+
/// is a valid RTypedData.
|
|
326
|
+
#[inline]
|
|
327
|
+
pub unsafe fn RTYPEDDATA_TYPE(obj: VALUE) -> *const rb_data_type_t {
|
|
328
|
+
api().rtypeddata_type(obj)
|
|
329
|
+
}
|
|
330
|
+
|
|
331
|
+
/// Gets the data pointer from an RTypedData object.
|
|
332
|
+
///
|
|
333
|
+
/// @param[in] obj An RTypedData object.
|
|
334
|
+
/// @return Pointer to the wrapped C struct.
|
|
335
|
+
///
|
|
336
|
+
/// # Safety
|
|
337
|
+
/// This function is unsafe because it dereferences a raw pointer to get
|
|
338
|
+
/// access to the underlying data. The caller must ensure the object
|
|
339
|
+
/// is a valid RTypedData.
|
|
340
|
+
#[inline]
|
|
341
|
+
pub unsafe fn RTYPEDDATA_GET_DATA(obj: VALUE) -> *mut c_void {
|
|
342
|
+
api().rtypeddata_get_data(obj)
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
/// Checks if the bignum is positive.
|
|
346
|
+
///
|
|
347
|
+
/// @param[in] b An object of RBignum.
|
|
348
|
+
/// @retval false `b` is less than zero.
|
|
349
|
+
/// @retval true Otherwise.
|
|
350
|
+
///
|
|
351
|
+
/// # Safety
|
|
352
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
353
|
+
/// accessing the underlying bignum structure.
|
|
354
|
+
#[inline]
|
|
355
|
+
pub unsafe fn RBIGNUM_POSITIVE_P(b: VALUE) -> bool {
|
|
356
|
+
api().bignum_positive_p(b)
|
|
357
|
+
}
|
|
358
|
+
|
|
359
|
+
/// Checks if the bignum is negative.
|
|
360
|
+
///
|
|
361
|
+
/// @param[in] b An object of RBignum.
|
|
362
|
+
/// @retval true `b` is less than zero.
|
|
363
|
+
/// @retval false Otherwise.
|
|
364
|
+
///
|
|
365
|
+
/// # Safety
|
|
366
|
+
/// This function is unsafe because it could dereference a raw pointer when
|
|
367
|
+
/// accessing the underlying bignum structure.
|
|
368
|
+
#[inline]
|
|
369
|
+
pub unsafe fn RBIGNUM_NEGATIVE_P(b: VALUE) -> bool {
|
|
370
|
+
api().bignum_negative_p(b)
|
|
371
|
+
}
|