1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238
// 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::provider::*;
use crate::{LocaleExpander, LocaleTransformError};
use icu_locid::subtags::Script;
use icu_locid::LanguageIdentifier;
use icu_provider::prelude::*;
/// Represents the direction of a script.
///
/// [`LocaleDirectionality`] can be used to get this information.
#[derive(Debug, PartialEq, Eq, Clone, Copy)]
#[non_exhaustive]
pub enum Direction {
/// The script is left-to-right.
LeftToRight,
/// The script is right-to-left.
RightToLeft,
}
/// Provides methods to determine the direction of a locale.
///
/// # Examples
///
/// ```
/// use icu::locid::locale;
/// use icu::locid_transform::{Direction, LocaleDirectionality};
///
/// let ld = LocaleDirectionality::new();
///
/// assert_eq!(ld.get(&locale!("en")), Some(Direction::LeftToRight));
/// ```
#[derive(Debug)]
pub struct LocaleDirectionality {
script_direction: DataPayload<ScriptDirectionV1Marker>,
expander: LocaleExpander,
}
#[cfg(feature = "compiled_data")]
impl Default for LocaleDirectionality {
fn default() -> Self {
Self::new()
}
}
impl LocaleDirectionality {
/// Creates a [`LocaleDirectionality`] from compiled data.
///
/// This includes limited likely subtags data, see [`LocaleExpander::new()`].
#[cfg(feature = "compiled_data")]
pub const fn new() -> Self {
Self::new_with_expander(LocaleExpander::new())
}
// Note: This is a custom impl because the bounds on `try_new_unstable` don't suffice
#[doc = icu_provider::gen_any_buffer_unstable_docs!(ANY, Self::new)]
pub fn try_new_with_any_provider(
provider: &(impl AnyProvider + ?Sized),
) -> Result<LocaleDirectionality, LocaleTransformError> {
let expander = LocaleExpander::try_new_with_any_provider(provider)?;
Self::try_new_with_expander_unstable(&provider.as_downcasting(), expander)
}
// Note: This is a custom impl because the bounds on `try_new_unstable` don't suffice
#[doc = icu_provider::gen_any_buffer_unstable_docs!(BUFFER, Self::new)]
#[cfg(feature = "serde")]
pub fn try_new_with_buffer_provider(
provider: &(impl BufferProvider + ?Sized),
) -> Result<LocaleDirectionality, LocaleTransformError> {
let expander = LocaleExpander::try_new_with_buffer_provider(provider)?;
Self::try_new_with_expander_unstable(&provider.as_deserializing(), expander)
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::new)]
pub fn try_new_unstable<P>(provider: &P) -> Result<LocaleDirectionality, LocaleTransformError>
where
P: DataProvider<ScriptDirectionV1Marker>
+ DataProvider<LikelySubtagsForLanguageV1Marker>
+ DataProvider<LikelySubtagsForScriptRegionV1Marker>
+ ?Sized,
{
let expander = LocaleExpander::try_new_unstable(provider)?;
Self::try_new_with_expander_unstable(provider, expander)
}
/// Creates a [`LocaleDirectionality`] with a custom [`LocaleExpander`] and compiled data.
///
/// This allows using [`LocaleExpander::new_extended()`] with data for all locales.
///
/// # Examples
///
/// ```
/// use icu::locid::locale;
/// use icu::locid_transform::{
/// Direction, LocaleDirectionality, LocaleExpander,
/// };
///
/// let ld_default = LocaleDirectionality::new();
///
/// assert_eq!(ld_default.get(&locale!("jbn")), None);
///
/// let expander = LocaleExpander::new_extended();
/// let ld_extended = LocaleDirectionality::new_with_expander(expander);
///
/// assert_eq!(
/// ld_extended.get(&locale!("jbn")),
/// Some(Direction::RightToLeft)
/// );
/// ```
#[cfg(feature = "compiled_data")]
pub const fn new_with_expander(expander: LocaleExpander) -> Self {
LocaleDirectionality {
script_direction: DataPayload::from_static_ref(
crate::provider::Baked::SINGLETON_LOCID_TRANSFORM_SCRIPT_DIR_V1,
),
expander,
}
}
#[doc = icu_provider::gen_any_buffer_unstable_docs!(UNSTABLE, Self::new_with_expander)]
pub fn try_new_with_expander_unstable<P>(
provider: &P,
expander: LocaleExpander,
) -> Result<LocaleDirectionality, LocaleTransformError>
where
P: DataProvider<ScriptDirectionV1Marker> + ?Sized,
{
let script_direction = provider.load(Default::default())?.take_payload()?;
Ok(LocaleDirectionality {
script_direction,
expander,
})
}
/// Returns the script direction of the given locale.
///
/// Note that the direction is a property of the script of a locale, not of the language. As such,
/// when given a locale without an associated script tag (i.e., `locale!("en")` vs. `locale!("en-Latn")`),
/// this method first tries to infer the script using the language and region before returning its direction.
///
/// If you already have a script struct and want to get its direction, you should use
/// `Locale::from(Some(my_script))` and call this method.
///
/// This method will return `None` if either a locale's script cannot be determined, or there is no information
/// for the script.
///
/// # Examples
///
/// Using an existing locale:
///
/// ```
/// use icu::locid::locale;
/// use icu::locid_transform::{Direction, LocaleDirectionality};
///
/// let ld = LocaleDirectionality::new();
///
/// assert_eq!(ld.get(&locale!("en-US")), Some(Direction::LeftToRight));
///
/// assert_eq!(ld.get(&locale!("ar")), Some(Direction::RightToLeft));
///
/// assert_eq!(ld.get(&locale!("en-Arab")), Some(Direction::RightToLeft));
///
/// assert_eq!(ld.get(&locale!("foo")), None);
/// ```
///
/// Using a script directly:
///
/// ```
/// use icu::locid::subtags::script;
/// use icu::locid::Locale;
/// use icu::locid_transform::{Direction, LocaleDirectionality};
///
/// let ld = LocaleDirectionality::new();
///
/// assert_eq!(
/// ld.get(&Locale::from(Some(script!("Latn")))),
/// Some(Direction::LeftToRight)
/// );
/// ```
pub fn get(&self, locale: impl AsRef<LanguageIdentifier>) -> Option<Direction> {
let script = self.expander.get_likely_script(locale.as_ref())?;
if self.script_in_ltr(script) {
Some(Direction::LeftToRight)
} else if self.script_in_rtl(script) {
Some(Direction::RightToLeft)
} else {
None
}
}
/// Returns whether the given locale is right-to-left.
///
/// Note that if this method returns `false`, the locale is either left-to-right or
/// the [`LocaleDirectionality`] does not include data for the locale.
/// You should use [`LocaleDirectionality::get`] if you need to differentiate between these cases.
///
/// See [`LocaleDirectionality::get`] for more information.
pub fn is_right_to_left(&self, locale: impl AsRef<LanguageIdentifier>) -> bool {
self.expander
.get_likely_script(locale.as_ref())
.map(|s| self.script_in_rtl(s))
.unwrap_or(false)
}
/// Returns whether the given locale is left-to-right.
///
/// Note that if this method returns `false`, the locale is either right-to-left or
/// the [`LocaleDirectionality`] does not include data for the locale.
/// You should use [`LocaleDirectionality::get`] if you need to differentiate between these cases.
///
/// See [`LocaleDirectionality::get`] for more information.
pub fn is_left_to_right(&self, locale: impl AsRef<LanguageIdentifier>) -> bool {
self.expander
.get_likely_script(locale.as_ref())
.map(|s| self.script_in_ltr(s))
.unwrap_or(false)
}
fn script_in_rtl(&self, script: Script) -> bool {
self.script_direction
.get()
.rtl
.binary_search(&script.into_tinystr().to_unvalidated())
.is_ok()
}
fn script_in_ltr(&self, script: Script) -> bool {
self.script_direction
.get()
.ltr
.binary_search(&script.into_tinystr().to_unvalidated())
.is_ok()
}
}