ffi

unicode-org · Jul 3, 2023 · 93712d5 · 93712d5
1 parent 3951186
commit 93712d5
Show file tree

Hide file tree

Showing 184 changed files with 1,817 additions and 1,652 deletions.
diff --git a/components/properties/src/props.rs b/components/properties/src/props.rs
@@ -100,12 +100,7 @@ impl<T: TrieValue> PropertyValueNameToEnumMapper<T> {
         }
     }
 
-    /// Construct a new one from loaded data
-    ///
-    /// Typically it is preferable to use methods on individual property value types
-    /// (like [`Script::get_name_to_enum_mapper()`]) instead.
-    #[doc(hidden)] // used for efficiency by FFI code
-    pub fn from_data<M>(data: DataPayload<M>) -> Self
+    pub(crate) fn from_data<M>(data: DataPayload<M>) -> Self
     where
         M: DataMarker<Yokeable = PropertyValueNameToEnumMapV1<'static>>,
     {
@@ -114,6 +109,14 @@ impl<T: TrieValue> PropertyValueNameToEnumMapper<T> {
             markers: PhantomData,
         }
     }
+
+    #[doc(hidden)] // used by FFI code
+    pub fn erase(self) -> PropertyValueNameToEnumMapper<u16> {
+        PropertyValueNameToEnumMapper {
+            map: self.map.cast(),
+            markers: PhantomData,
+        }
+    }
 }
 
 impl<T: TrieValue> PropertyValueNameToEnumMapperBorrowed<'_, T> {

diff --git a/docs/tutorials/cpp.md b/docs/tutorials/cpp.md
@@ -17,8 +17,8 @@ _We are still working on improving the user experience of using ICU4X from other
 - Inside the crate you can use `cargo build` to build the library
     - Be sure to pass `--release` to get an optimized build
     - Specify Cargo features with `--features ...`:
+        - `compiled_data` to include data (`ICU4XDataProvider::create_compiled()`)
         - `buffer_provider` for working with blob data providers (`ICU4XDataProvider::create_from_byte_slice()`)
-        - `provider_test` to include testing data (`ICU4XDataProvider::create_test()`)
         - `provider_fs` for loading data from the file system (`ICU4XDataProvider::create_fs()`). This also requires enabling a syntax on the `icu_provider` crate.
         - `logging` and `simple_logger` enable basic stdout logging of error metadata. Further loggers can be added on request.
         - `cpp_default` turns on a bunch of these and is useful for exploration, but should not be used in production as it enables `provider_test`
@@ -50,10 +50,8 @@ int main() {
     // Create a locale object representing Bangla
     ICU4XLocale locale = ICU4XLocale::create_from_string("bn").ok().value();
 
-    // Use a testing data provider
-    // Production code probably should use create_fs() or create_from_byte_slice()
-    // with data generated by icu4x-datagen
-    ICU4XDataProvider dp = ICU4XDataProvider::create_test();
+    // Use compiled data
+    ICU4XDataProvider dp = ICU4XDataProvider::create_compiled();
 
     // Create a formatter object with the appropriate settings
     ICU4XFixedDecimalFormatter fdf = ICU4XFixedDecimalFormatter::create_with_grouping_strategy(

diff --git a/ffi/capi_cdylib/Cargo.toml b/ffi/capi_cdylib/Cargo.toml
@@ -43,6 +43,7 @@ icu_provider = { version = "1.2.0", path = "../../provider/core", default-featur
 default = ["icu_capi/default"]
 any_provider = ["icu_capi/any_provider"]
 buffer_provider = ["icu_capi/buffer_provider"]
+compiled_data = ["icu_capi/compiled_data"]
 provider_fs = ["icu_capi/provider_fs"] # Indirectly implies buffer_provider
 provider_test = ["icu_capi/provider_test"]
 logging = ["icu_capi/logging"]

diff --git a/ffi/capi_staticlib/Cargo.toml b/ffi/capi_staticlib/Cargo.toml
@@ -43,6 +43,7 @@ icu_provider = { version = "1.2.0", path = "../../provider/core", default-featur
 default = ["icu_capi/default"]
 any_provider = ["icu_capi/any_provider"]
 buffer_provider = ["icu_capi/buffer_provider"]
+compiled_data = ["icu_capi/compiled_data"]
 provider_fs = ["icu_capi/provider_fs"] # Indirectly implies buffer_provider
 provider_test = ["icu_capi/provider_test"]
 logging = ["icu_capi/logging"]

diff --git a/ffi/diplomat/Cargo.toml b/ffi/diplomat/Cargo.toml
@@ -38,7 +38,7 @@ max_combination_size = 2
 
 # Please keep the features list in sync with the icu_capi_staticlib/icu_capi_cdylib crates (except for components features)
 [features]
-default = ["any_provider", "default_components"]
+default = ["compiled_data", "default_components"]
 any_provider = []
 buffer_provider = [
     "dep:icu_provider_blob",
@@ -67,7 +67,7 @@ logging = ["icu_provider/log_error_context", "dep:log"]
 simple_logger = ["dep:simple_logger"]
 
 # meta feature for things we enable by default in C and C++
-cpp_default = ["provider_test", "logging", "simple_logger"]
+cpp_default = ["logging", "simple_logger"]
 
 # meta feature for things we enable by default in wasm
 wasm_default = ["buffer_provider", "logging"]
@@ -93,6 +93,20 @@ icu_properties = ["dep:icu_properties", "dep:icu_collections", "dep:unicode-bidi
 icu_segmenter = ["dep:icu_segmenter"]
 icu_timezone = ["dep:icu_timezone", "dep:icu_calendar"]
 
+compiled_data = [
+    "icu_calendar?/compiled_data",
+    "icu_collator?/compiled_data",
+    "icu_datetime?/compiled_data",
+    "icu_decimal?/compiled_data",
+    "icu_displaynames?/compiled_data",
+    "icu_list?/compiled_data",
+    "icu_locid_transform?/compiled_data",
+    "icu_normalizer?/compiled_data",
+    "icu_plurals?/compiled_data",
+    "icu_properties?/compiled_data",
+    "icu_segmenter?/compiled_data",
+    "icu_timezone?/compiled_data",
+]
 
 [dependencies]
 # Mandatory ICU4X components and utils

diff --git a/ffi/diplomat/c/examples/fixeddecimal/test.c b/ffi/diplomat/c/examples/fixeddecimal/test.c
@@ -14,7 +14,7 @@ int main() {
         return 1;
     }
     ICU4XLocale* locale = locale_result.ok;
-    ICU4XDataProvider* provider = ICU4XDataProvider_create_test();
+    ICU4XDataProvider* provider = ICU4XDataProvider_create_compiled();
 
     ICU4XFixedDecimal* decimal = ICU4XFixedDecimal_create_from_u64(1000007);
 

diff --git a/ffi/diplomat/c/examples/fixeddecimal_tiny/icu_capi_staticlib_tiny/Cargo.lock b/ffi/diplomat/c/examples/fixeddecimal_tiny/icu_capi_staticlib_tiny/Cargo.lock
diff --git a/ffi/diplomat/c/examples/locale/test.c b/ffi/diplomat/c/examples/locale/test.c
@@ -183,7 +183,7 @@ int main() {
     ICU4XLocale_destroy(locale);
 
     // Create a LocaleCanonicalizer and LocaleExpander.
-    ICU4XDataProvider* provider = ICU4XDataProvider_create_test();
+    ICU4XDataProvider* provider = ICU4XDataProvider_create_compiled();
     diplomat_result_box_ICU4XLocaleCanonicalizer_ICU4XError result2 = ICU4XLocaleCanonicalizer_create(provider);
     if (!result2.is_ok) {
         printf("Could not construct Locale Canonicalizer");

diff --git a/ffi/diplomat/c/examples/pluralrules/test.c b/ffi/diplomat/c/examples/pluralrules/test.c
@@ -14,7 +14,7 @@ int main() {
         return 1;
     }
     ICU4XLocale* locale = locale_result.ok;
-    ICU4XDataProvider* provider = ICU4XDataProvider_create_test();
+    ICU4XDataProvider* provider = ICU4XDataProvider_create_compiled();
     diplomat_result_box_ICU4XPluralRules_ICU4XError plural_result = ICU4XPluralRules_create_cardinal(provider, locale);
     if (!plural_result.is_ok) {
         printf("Failed to create PluralRules\n");

diff --git a/ffi/diplomat/c/include/ICU4XDataProvider.h b/ffi/diplomat/c/include/ICU4XDataProvider.h
diff --git a/ffi/diplomat/c/include/ICU4XLocaleDisplayNamesFormatter.h b/ffi/diplomat/c/include/ICU4XLocaleDisplayNamesFormatter.h
diff --git a/ffi/diplomat/c/include/ICU4XRegionDisplayNames.h b/ffi/diplomat/c/include/ICU4XRegionDisplayNames.h
diff --git a/ffi/diplomat/cpp/docs/source/calendar_ffi.rst b/ffi/diplomat/cpp/docs/source/calendar_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/collator_ffi.rst b/ffi/diplomat/cpp/docs/source/collator_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/datetime_formatter_ffi.rst b/ffi/diplomat/cpp/docs/source/datetime_formatter_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/decimal_ffi.rst b/ffi/diplomat/cpp/docs/source/decimal_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/displaynames_ffi.rst b/ffi/diplomat/cpp/docs/source/displaynames_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/fallbacker_ffi.rst b/ffi/diplomat/cpp/docs/source/fallbacker_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/list_ffi.rst b/ffi/diplomat/cpp/docs/source/list_ffi.rst
diff --git a/ffi/diplomat/cpp/docs/source/locale_ffi.rst b/ffi/diplomat/cpp/docs/source/locale_ffi.rst