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

@@ -19,14 +19,12 @@
 //! let mut loc: Locale = "en-US-a-foo-faa".parse().expect("Parsing failed.");
 //! ```
 
-mod subtag;
-
 use crate::parser::ParserError;
 use crate::parser::SubtagIterator;
 use crate::shortvec::ShortBoxSlice;
-use alloc::vec::Vec;
 #[doc(inline)]
-pub use subtag::{subtag, Subtag};
+pub use crate::subtags::{subtag, Subtag};
+use alloc::vec::Vec;
 
 /// A list of [`Other Use Extensions`] as defined in [`Unicode Locale
 /// Identifier`] specification.

components/locid/src/extensions/other/mod.rs

@@ -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

@@ -4,6 +4,7 @@
 
 use crate::parser::{ParserError, SubtagIterator};
 use crate::shortvec::ShortBoxSlice;
+use crate::subtags::Subtag;
 use core::ops::RangeInclusive;
 use core::str::FromStr;
 use tinystr::TinyAsciiStr;
@@ -32,7 +33,7 @@ use tinystr::TinyAsciiStr;
 /// assert_eq!(value!("true").to_string(), "");
 /// ```
 #[derive(Debug, PartialEq, Eq, Clone, Hash, PartialOrd, Ord, Default)]
-pub struct Value(ShortBoxSlice<TinyAsciiStr<{ *VALUE_LENGTH.end() }>>);
+pub struct Value(pub ShortBoxSlice<TinyAsciiStr<{ *VALUE_LENGTH.end() }>>);
 
 const VALUE_LENGTH: RangeInclusive<usize> = 3..=8;
 const TRUE_VALUE: TinyAsciiStr<8> = tinystr::tinystr!(8, "true");
@@ -90,6 +91,41 @@ impl Value {
         self.0.single()
     }
 
+    pub fn first_subtag_matches(&self, input: &str) -> bool {
+        if let Some(s) = self.0.get(0) {
+            s == input
+        } else {
+            false
+        }
+    }
+
+    pub fn second_subtag_matches(&self, input: &str) -> bool {
+        if let Some(s) = self.0.get(1) {
+            s == input
+        } else {
+            false
+        }
+    }
+
+    pub fn second_subtag_is_empty(&self) -> bool {
+        self.0.get(1).is_none()
+    }
+
+    pub fn second_subtag(&self) -> Self {
+        Self::from_tinystr(self.0.get(1).copied())
+    }
+
+    pub fn unshift_subtag(&mut self) -> Option<Subtag> {
+        let mut subtags = self.0.clone().to_vec();
+        if subtags.is_empty() {
+            None
+        } else {
+            let first = subtags.remove(0);
+            self.0 = subtags.into();
+            Some(Subtag(first))
+        }
+    }
+
     #[doc(hidden)]
     pub const fn from_tinystr(subtag: Option<TinyAsciiStr<8>>) -> Self {
         match subtag {
@@ -191,6 +227,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

@@ -22,7 +22,7 @@ macro_rules! impl_tinystr_subtag {
         #[cfg_attr(feature = "serde", derive(serde::Serialize))]
         #[repr(transparent)]
         $(#[$doc])*
-        pub struct $name(tinystr::TinyAsciiStr<$len_end>);
+        pub struct $name(pub tinystr::TinyAsciiStr<$len_end>);
 
         impl $name {
             /// A constructor which takes a UTF-8 slice, parses it and

components/locid/src/helpers.rs

@@ -72,7 +72,7 @@ mod locale;
 mod macros;
 mod ordering;
 mod parser;
-mod shortvec;
+pub mod shortvec;
 
 pub use langid::LanguageIdentifier;
 pub use locale::Locale;

components/locid/src/lib.rs

@@ -66,7 +66,7 @@ impl<T> Default for ShortBoxSliceInner<T> {
 ///
 /// Supports mutation but always reallocs when mutated.
 #[derive(Debug, Clone, PartialEq, Eq, Hash, PartialOrd, Ord)]
-pub(crate) struct ShortBoxSlice<T>(ShortBoxSliceInner<T>);
+pub struct ShortBoxSlice<T>(ShortBoxSliceInner<T>);
 
 impl<T> Default for ShortBoxSlice<T> {
     fn default() -> Self {

components/locid/src/shortvec/mod.rs

@@ -60,3 +60,38 @@ pub use script::{script, Script};
 #[doc(inline)]
 pub use variant::{variant, Variant};
 pub use variants::Variants;
+
+impl_tinystr_subtag!(
+    /// A single item used in a list of [`Private`](super::Private) extensions.
+    ///
+    /// The subtag has to be an ASCII alphanumerical string no shorter than
+    /// one character and no longer than eight.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use icu::locid::extensions::private::Subtag;
+    ///
+    /// let subtag1: Subtag = "Foo".parse().expect("Failed to parse a Subtag.");
+    ///
+    /// assert_eq!(subtag1.as_str(), "foo");
+    /// ```
+    Subtag,
+    subtags,
+    subtag,
+    subtags_subtag,
+    1..=8,
+    s,
+    s.is_ascii_alphanumeric(),
+    s.to_ascii_lowercase(),
+    s.is_ascii_alphanumeric() && s.is_ascii_lowercase(),
+    InvalidExtension,
+    ["foo12"],
+    ["toolooong"],
+);
+
+impl Subtag {
+    pub(crate) const fn valid_key(v: &[u8]) -> bool {
+        2 <= v.len() && v.len() <= 8
+    }
+}

components/locid/src/subtags/mod.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,10 @@
+// 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]
+#[derive(Debug)]
+pub enum Error {
+    UnknownKeyword,
+    InvalidKeywordValue,
+}

utils/preferences/src/extensions/mod.rs

@@ -0,0 +1,35 @@
+// 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,
+        "civil" => Civil
+    },
+    "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");