Introduce icu_preferences

Author: zbraniecki

Cargo.lock

@@ -65,6 +65,7 @@ members = [
     "utils/ixdtf",
     "utils/litemap",
     "utils/pattern",
+    "utils/preferences",
     "utils/resb",
     "utils/tinystr",
     "utils/tzif",

Cargo.toml

@@ -358,6 +358,11 @@ impl Keywords {
         }
     }
 
+    /// Produce an ordered iterator over key-value pairs
+    pub fn iter(&self) -> impl Iterator<Item = (&Key, &Value)> {
+        self.0.iter()
+    }
+
     pub(crate) fn for_each_subtag_str<E, F>(&self, f: &mut F) -> Result<(), E>
     where
         F: FnMut(&str) -> Result<(), E>,

components/locid/src/extensions/unicode/keywords.rs

@@ -191,6 +191,15 @@ macro_rules! extensions_unicode_value {
             );
         R
     }};
+    ($value:literal, $value2:literal) => {{
+        let v: &str = concat!($value, "-", $value2);
+        let R: $crate::extensions::unicode::Value =
+            match $crate::extensions::unicode::Value::try_from_bytes(v.as_bytes()) {
+                Ok(r) => r,
+                _ => panic!(concat!("Invalid Unicode extension value: ", $value)),
+            };
+        R
+    }};
 }
 #[doc(inline)]
 pub use extensions_unicode_value as value;

components/locid/src/extensions/unicode/value.rs

@@ -0,0 +1,29 @@
+# This file is part of ICU4X. For terms of use, please see the file
+# called LICENSE at the top level of the ICU4X source tree
+# (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+[package]
+name = "icu_preferences"
+description = "API for resolving preferences"
+version = "0.0.1"
+categories = ["internationalization"]
+license-file = "LICENSE"
+
+authors.workspace = true
+edition.workspace = true
+include.workspace = true
+repository.workspace = true
+rust-version.workspace = true
+
+[package.metadata.workspaces]
+independent = true
+
+[package.metadata.docs.rs]
+all-features = true
+
+[dependencies]
+icu_locid = { workspace = true }
+tinystr = { workspace = true }
+
+[dev-dependencies]
+icu_datetime = { workspace = true }

utils/preferences/Cargo.toml

@@ -0,0 +1,44 @@
+UNICODE LICENSE V3
+
+COPYRIGHT AND PERMISSION NOTICE
+
+Copyright © 2020-2023 Unicode, Inc.
+
+NOTICE TO USER: Carefully read the following legal agreement. BY
+DOWNLOADING, INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR
+SOFTWARE, YOU UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE
+TERMS AND CONDITIONS OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT
+DOWNLOAD, INSTALL, COPY, DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE.
+
+Permission is hereby granted, free of charge, to any person obtaining a
+copy of data files and any associated documentation (the "Data Files") or
+software and any associated documentation (the "Software") to deal in the
+Data Files or Software without restriction, including without limitation
+the rights to use, copy, modify, merge, publish, distribute, and/or sell
+copies of the Data Files or Software, and to permit persons to whom the
+Data Files or Software are furnished to do so, provided that either (a)
+this copyright and permission notice appear with all copies of the Data
+Files or Software, or (b) this copyright and permission notice appear in
+associated Documentation.
+
+THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
+KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
+THIRD PARTY RIGHTS.
+
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE
+BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES,
+OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
+WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
+ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA
+FILES OR SOFTWARE.
+
+Except as contained in this notice, the name of a copyright holder shall
+not be used in advertising or otherwise to promote the sale, use or other
+dealings in these Data Files or Software without prior written
+authorization of the copyright holder.
+
+—
+
+Portions of ICU4X may have been adapted from ICU4C and/or ICU4J.
+ICU 1.8.1 to ICU 57.1 © 1995-2016 International Business Machines Corporation and others.

utils/preferences/LICENSE

@@ -0,0 +1 @@
+pub mod unicode;

utils/preferences/README.md

@@ -0,0 +1,9 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+#[non_exhaustive]
+pub enum Error {
+    UnknownKeyword,
+    UnknownKeywordValue,
+}

utils/preferences/src/extensions/mod.rs

@@ -0,0 +1,34 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+#![allow(non_snake_case)]
+
+use crate::enum_keyword;
+
+// https://github.com/unicode-org/cldr/blob/main/common/bcp47/calendar.xml
+enum_keyword!(IslamicCalendar {
+    "umalqura" => Umalqura,
+    "tbla" => Tbla,
+    "civil" => Civil,
+    "rgsa" => Rgsa
+});
+
+enum_keyword!(Calendar {
+    "buddhist" => Buddhist,
+    "chinese" => Chinese,
+    "coptic" => Coptic,
+    "dangi" => Dangi,
+    "ethioaa" => Ethioaa,
+    "ethiopic" => Ethiopic,
+    "gregory" => Gregory,
+    "hebrew" => Hebrew,
+    "indian" => Indian,
+    "islamic" => Islamic(IslamicCalendar) {
+        "umalqura" => Umalqura
+    },
+    "iso8601" => Iso8601,
+    "japanese" => Japanese,
+    "persian" => Persian,
+    "roc" => Roc
+}, "ca");

utils/preferences/src/extensions/unicode/errors.rs

@@ -0,0 +1,11 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+crate::enum_keyword!(Collation {
+    "standard" => Standard,
+    "search" => Search,
+    "phonetic" => Phonetic,
+    "pinyin" => Pinyin,
+    "searchjl" => Searchjl
+}, "co");

utils/preferences/src/extensions/unicode/keywords/calendar.rs

@@ -0,0 +1,13 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::struct_keyword;
+use icu_locid::extensions::unicode::Value;
+use tinystr::TinyAsciiStr;
+
+struct_keyword!(Currency, "cu", TinyAsciiStr<3>, |input: &Value| {
+    //XXX: Validate
+    let i = TinyAsciiStr::from_str(&input.to_string()).unwrap();
+    Ok(Currency(i))
+});

utils/preferences/src/extensions/unicode/keywords/collation.rs

@@ -0,0 +1,8 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+crate::enum_keyword!(CurrencyFormat {
+    "standard" => Standard,
+    "account" => Account
+}, "cf");

utils/preferences/src/extensions/unicode/keywords/currency.rs

@@ -0,0 +1,13 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::struct_keyword;
+use icu_locid::extensions::unicode::Value;
+use icu_locid::subtags::Script;
+use std::str::FromStr;
+
+struct_keyword!(DictionaryBreak, "dx", Script, |input: &Value| {
+    let i = Script::from_str(&input.to_string()).unwrap();
+    Ok(DictionaryBreak(i))
+});

utils/preferences/src/extensions/unicode/keywords/currency_format.rs

@@ -0,0 +1,11 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::enum_keyword;
+
+enum_keyword!(Emoji {
+    "emoji" => Emoji,
+    "text" => Text,
+    "default" => Default
+}, "em");

utils/preferences/src/extensions/unicode/keywords/dictionary_break.rs

@@ -0,0 +1,15 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::enum_keyword;
+
+enum_keyword!(FirstDay {
+    "sun" => Sun,
+    "mon" => Mon,
+    "tue" => Tue,
+    "wed" => Wed,
+    "thu" => Thu,
+    "fri" => Fri,
+    "sat" => Sat
+}, "fw");

utils/preferences/src/extensions/unicode/keywords/emoji.rs

@@ -0,0 +1,12 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::enum_keyword;
+
+enum_keyword!(HourCycle {
+    "h11" => H11,
+    "h12" => H12,
+    "h23" => H23,
+    "h24" => H24,
+}, "hc");

utils/preferences/src/extensions/unicode/keywords/first_day.rs

@@ -0,0 +1,11 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::enum_keyword;
+
+enum_keyword!(LineBreak {
+    "strict" => Strict,
+    "normal" => Normal,
+    "loose" => Loose,
+}, "lb");

utils/preferences/src/extensions/unicode/keywords/hour_cycle.rs

@@ -0,0 +1,29 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::extensions::unicode::errors::Error;
+use crate::keyword_list;
+use crate::preferences::PreferenceKey;
+use icu_locid::extensions::unicode;
+
+keyword_list!(Keyword {
+    calendar::Calendar,
+    currency_format::CurrencyFormat,
+    collation::Collation,
+    currency::Currency,
+    dictionary_break::DictionaryBreak,
+    emoji::Emoji,
+    first_day::FirstDay,
+    hour_cycle::HourCycle,
+    line_break::LineBreak,
+    numbering_system::NumberingSystem
+    // lw line break word
+    // ms meaurement system
+    // mu measurement unit
+    // rg region override
+    // sd region subdivision
+    // ss sentence supression
+    // tz timezone
+    // va variant
+});

utils/preferences/src/extensions/unicode/keywords/line_break.rs

@@ -0,0 +1,19 @@
+// This file is part of ICU4X. For terms of use, please see the file
+// called LICENSE at the top level of the ICU4X source tree
+// (online at: https://github.com/unicode-org/icu4x/blob/main/LICENSE ).
+
+use crate::extensions::unicode::errors::Error;
+use crate::struct_keyword;
+use icu_locid::extensions::unicode::Value;
+use tinystr::TinyAsciiStr;
+
+struct_keyword!(NumberingSystem, "nu", TinyAsciiStr<8>, |input: &Value| {
+    //XXX: Perf
+    let s = input.to_string();
+    let v = TinyAsciiStr::from_str(&s);
+    if let Ok(v) = v {
+        Ok(NumberingSystem(v))
+    } else {
+        Err(Error::UnknownKeywordValue)
+    }
+});