zng_ext_l10n/
types.rs

Help
1use std::{borrow::Cow, collections::HashMap, fmt, mem, ops, path::PathBuf, sync::Arc};
2
3use fluent::types::FluentNumber;
4use once_cell::sync::Lazy;
5use semver::Version;
6use zng_ext_fs_watcher::WatcherReadStatus;
7use zng_layout::context::LayoutDirection;
8use zng_txt::{ToTxt, Txt};
9use zng_var::{ArcEq, ArcVar, BoxedVar, IntoVar, LocalVar, ReadOnlyArcVar, Var, VarValue, context_var, impl_from_and_into_var};
10
11use crate::{L10N, lang, service::L10N_SV};
12
13/// Handle to multiple localization resources.
14#[derive(Clone, Debug)]
15pub struct LangResources(pub Vec<LangResource>);
16impl ops::Deref for LangResources {
17    type Target = Vec<LangResource>;
18
19    fn deref(&self) -> &Self::Target {
20        &self.0
21    }
22}
23impl ops::DerefMut for LangResources {
24    fn deref_mut(&mut self) -> &mut Self::Target {
25        &mut self.0
26    }
27}
28impl LangResources {
29    /// Wait for all the resources to load.
30    pub async fn wait(&self) {
31        for res in &self.0 {
32            res.wait().await;
33        }
34    }
35
36    /// Drop all handles without dropping the resource.
37    pub fn perm(self) {
38        for res in self.0 {
39            res.perm()
40        }
41    }
42}
43
44/// Handle to a localization resource.
45#[derive(Clone)]
46#[must_use = "resource can unload if dropped"]
47pub struct LangResource {
48    pub(super) res: BoxedVar<Option<ArcEq<fluent::FluentResource>>>,
49    pub(super) status: BoxedVar<LangResourceStatus>,
50}
51
52impl fmt::Debug for LangResource {
53    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
54        f.debug_struct("LangResource")
55            .field("status", &self.status.get())
56            .finish_non_exhaustive()
57    }
58}
59impl LangResource {
60    /// Read-only variable with the resource.
61    pub fn resource(&self) -> &BoxedVar<Option<ArcEq<fluent::FluentResource>>> {
62        &self.res
63    }
64
65    /// Read-only variable with the resource status.
66    pub fn status(&self) -> &BoxedVar<LangResourceStatus> {
67        &self.status
68    }
69
70    /// Drop the handle without unloading the resource.
71    pub fn perm(self) {
72        L10N_SV.write().push_perm_resource(self);
73    }
74
75    /// Await resource status to not be loading.
76    pub async fn wait(&self) {
77        while matches!(self.status.get(), LangResourceStatus::Loading) {
78            self.status.wait_update().await;
79        }
80    }
81}
82
83/// Status of a localization resource.
84#[derive(Clone, Debug)]
85pub enum LangResourceStatus {
86    /// Resource not available.
87    ///
88    /// This can change if the localization directory changes, or the file is created.
89    NotAvailable,
90    /// Resource is loading.
91    Loading,
92    /// Resource loaded ok.
93    Loaded,
94    /// Resource failed to load.
95    ///
96    /// This can be any IO or parse errors. If the resource if *not found* the status is set to
97    /// `NotAvailable`, not an error. Localization messages fallback on error just like they do
98    /// for not available.
99    Errors(StatusError),
100}
101impl fmt::Display for LangResourceStatus {
102    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
103        match self {
104            LangResourceStatus::NotAvailable => write!(f, "not available"),
105            LangResourceStatus::Loading => write!(f, "loading…"),
106            LangResourceStatus::Loaded => write!(f, "loaded"),
107            LangResourceStatus::Errors(e) => {
108                writeln!(f, "errors:")?;
109                for e in e {
110                    writeln!(f, "   {e}")?;
111                }
112                Ok(())
113            }
114        }
115    }
116}
117impl PartialEq for LangResourceStatus {
118    fn eq(&self, other: &Self) -> bool {
119        match (self, other) {
120            (Self::Errors(a), Self::Errors(b)) => a.is_empty() && b.is_empty(),
121            _ => core::mem::discriminant(self) == core::mem::discriminant(other),
122        }
123    }
124}
125impl Eq for LangResourceStatus {}
126impl WatcherReadStatus<StatusError> for LangResourceStatus {
127    fn idle() -> Self {
128        Self::Loaded
129    }
130
131    fn reading() -> Self {
132        Self::Loading
133    }
134
135    fn read_error(e: StatusError) -> Self {
136        Self::Errors(e)
137    }
138}
139impl WatcherReadStatus<LangResourceStatus> for LangResourceStatus {
140    fn idle() -> Self {
141        Self::Loaded
142    }
143
144    fn reading() -> Self {
145        Self::Loading
146    }
147
148    fn read_error(e: LangResourceStatus) -> Self {
149        e
150    }
151}
152
153type StatusError = Vec<Arc<dyn std::error::Error + Send + Sync>>;
154
155/// Localized message variable builder.
156///
157/// See [`L10N.message`] for more details.
158///
159/// [`L10N.message`]: L10N::message
160pub struct L10nMessageBuilder {
161    pub(super) file: LangFilePath,
162    pub(super) id: Txt,
163    pub(super) attribute: Txt,
164    pub(super) fallback: Txt,
165    pub(super) args: Vec<(Txt, BoxedVar<L10nArgument>)>,
166}
167impl L10nMessageBuilder {
168    /// Add a format arg variable.
169    pub fn arg(mut self, name: Txt, value: impl IntoVar<L10nArgument>) -> Self {
170        self.args.push((name, value.into_var().boxed()));
171        self
172    }
173    #[doc(hidden)]
174    pub fn l10n_arg(self, name: &'static str, value: impl Var<L10nArgument>) -> Self {
175        self.arg(Txt::from_static(name), value)
176    }
177
178    /// Build the message var for the given languages.
179    pub fn build_for(self, lang: impl Into<Langs>) -> impl Var<Txt> {
180        L10N_SV
181            .write()
182            .localized_message(lang.into(), self.file, self.id, self.attribute, self.fallback, self.args)
183    }
184
185    /// Build the message var for the contextual language.
186    pub fn build(self) -> impl Var<Txt> {
187        let Self {
188            file,
189            id,
190            attribute,
191            fallback,
192            args,
193        } = self;
194        LANG_VAR.flat_map(move |l| {
195            L10N_SV.write().localized_message(
196                l.clone(),
197                file.clone(),
198                id.clone(),
199                attribute.clone(),
200                fallback.clone(),
201                args.clone(),
202            )
203        })
204    }
205}
206
207/// Represents an argument value for a localization message.
208///
209/// See [`L10nMessageBuilder::arg`] for more details.
210#[derive(Clone, Debug, PartialEq)]
211pub enum L10nArgument {
212    /// String.
213    Txt(Txt),
214    /// Number, with optional style details.
215    Number(FluentNumber),
216}
217impl_from_and_into_var! {
218    fn from(txt: Txt) -> L10nArgument {
219        L10nArgument::Txt(txt)
220    }
221    fn from(txt: &'static str) -> L10nArgument {
222        L10nArgument::Txt(Txt::from_static(txt))
223    }
224    fn from(txt: String) -> L10nArgument {
225        L10nArgument::Txt(Txt::from(txt))
226    }
227    fn from(t: char) -> L10nArgument {
228        L10nArgument::Txt(Txt::from_char(t))
229    }
230    fn from(number: FluentNumber) -> L10nArgument {
231        L10nArgument::Number(number)
232    }
233    fn from(b: bool) -> L10nArgument {
234        b.to_txt().into()
235    }
236}
237macro_rules! impl_from_and_into_var_number {
238    ($($literal:tt),+) => {
239        impl_from_and_into_var! {
240            $(
241                fn from(number: $literal) -> L10nArgument {
242                    FluentNumber::from(number).into()
243                }
244            )+
245        }
246    }
247}
248impl_from_and_into_var_number! {
249    u8, i8, u16, i16, u32, i32, u64, i64, u128, i128, usize, isize, f32, f64
250}
251impl L10nArgument {
252    /// Borrow argument as a fluent value.
253    pub fn fluent_value(&self) -> fluent::FluentValue {
254        match self {
255            L10nArgument::Txt(t) => fluent::FluentValue::String(Cow::Borrowed(t.as_str())),
256            L10nArgument::Number(n) => fluent::FluentValue::Number(n.clone()),
257        }
258    }
259    /// Clone argument as a fluent value.
260    pub fn to_fluent_value(&self) -> fluent::FluentValue<'static> {
261        match self {
262            L10nArgument::Txt(t) => fluent::FluentValue::String(Cow::Owned(t.to_string())),
263            L10nArgument::Number(n) => fluent::FluentValue::Number(n.clone()),
264        }
265    }
266}
267
268#[doc(hidden)]
269pub struct L10nSpecialize<T>(pub Option<T>);
270#[doc(hidden)]
271pub trait IntoL10nVar {
272    type Var: Var<L10nArgument>;
273    fn to_l10n_var(&mut self) -> Self::Var;
274}
275
276impl<T: Into<L10nArgument>> IntoL10nVar for L10nSpecialize<T> {
277    type Var = LocalVar<L10nArgument>;
278
279    fn to_l10n_var(&mut self) -> Self::Var {
280        LocalVar(self.0.take().unwrap().into())
281    }
282}
283impl<T: VarValue + Into<L10nArgument>> IntoL10nVar for &mut L10nSpecialize<ArcVar<T>> {
284    type Var = ReadOnlyArcVar<L10nArgument>;
285
286    fn to_l10n_var(&mut self) -> Self::Var {
287        self.0.take().unwrap().map_into()
288    }
289}
290impl<V: Var<L10nArgument>> IntoL10nVar for &mut &mut L10nSpecialize<V> {
291    type Var = V;
292
293    fn to_l10n_var(&mut self) -> Self::Var {
294        self.0.take().unwrap()
295    }
296}
297
298context_var! {
299    /// Language of text in a widget context.
300    ///
301    /// Is [`L10N.app_lang`] by default.
302    ///
303    /// [`L10N.app_lang`]: L10N::app_lang
304    pub static LANG_VAR: Langs = L10N.app_lang();
305}
306
307/// Identifies the language, region and script of text.
308///
309/// Use the [`lang!`] macro to construct one, it does compile-time validation.
310///
311/// Use the [`unic_langid`] crate for more advanced operations such as runtime parsing and editing identifiers, this
312/// type is just an alias for the core struct of that crate.
313///
314/// [`unic_langid`]: https://docs.rs/unic-langid
315#[derive(PartialEq, Eq, Hash, Clone, Default, PartialOrd, Ord, serde::Serialize, serde::Deserialize)]
316#[serde(transparent)]
317pub struct Lang(pub unic_langid::LanguageIdentifier);
318impl Lang {
319    /// Returns character direction of the language.
320    pub fn direction(&self) -> LayoutDirection {
321        crate::from_unic_char_direction(self.0.character_direction())
322    }
323
324    /// Compares a language to another allowing for either side to use the missing fields as wildcards.
325    ///
326    /// This allows for matching between `en` (treated as `en-*-*-*`) and `en-US`.
327    pub fn matches(&self, other: &Self, self_as_range: bool, other_as_range: bool) -> bool {
328        self.0.matches(&other.0, self_as_range, other_as_range)
329    }
330}
331impl ops::Deref for Lang {
332    type Target = unic_langid::LanguageIdentifier;
333
334    fn deref(&self) -> &Self::Target {
335        &self.0
336    }
337}
338impl fmt::Debug for Lang {
339    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
340        write!(f, "{}", self.0)
341    }
342}
343impl fmt::Display for Lang {
344    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
345        write!(f, "{}", self.0)
346    }
347}
348impl std::str::FromStr for Lang {
349    type Err = unic_langid::LanguageIdentifierError;
350
351    fn from_str(s: &str) -> Result<Self, Self::Err> {
352        let s = s.trim();
353        if s.is_empty() {
354            return Ok(lang!(und));
355        }
356        unic_langid::LanguageIdentifier::from_str(s).map(Lang)
357    }
358}
359
360/// List of languages, in priority order.
361#[derive(Clone, PartialEq, Eq, Default, Hash, serde::Serialize, serde::Deserialize)]
362#[serde(transparent)]
363pub struct Langs(pub Vec<Lang>);
364impl fmt::Debug for Langs {
365    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
366        struct DisplayLangs<'a>(&'a [Lang]);
367        impl fmt::Debug for DisplayLangs<'_> {
368            fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
369                f.debug_list().entries(self.0.iter()).finish()
370            }
371        }
372        if f.alternate() {
373            f.debug_tuple("Langs").field(&DisplayLangs(&self.0)).finish()
374        } else {
375            fmt::Debug::fmt(&DisplayLangs(&self.0), f)
376        }
377    }
378}
379impl Langs {
380    /// The first lang on the list or `und` if the list is empty.
381    pub fn best(&self) -> &Lang {
382        static NONE: Lazy<Lang> = Lazy::new(|| lang!(und));
383        self.first().unwrap_or(&NONE)
384    }
385}
386impl ops::Deref for Langs {
387    type Target = Vec<Lang>;
388
389    fn deref(&self) -> &Self::Target {
390        &self.0
391    }
392}
393impl ops::DerefMut for Langs {
394    fn deref_mut(&mut self) -> &mut Self::Target {
395        &mut self.0
396    }
397}
398impl_from_and_into_var! {
399    fn from(lang: Lang) -> Langs {
400        Langs(vec![lang])
401    }
402    fn from(lang: Option<Lang>) -> Langs {
403        Langs(lang.into_iter().collect())
404    }
405}
406impl fmt::Display for Langs {
407    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
408        let mut sep = "";
409        for l in self.iter() {
410            write!(f, "{sep}{l}")?;
411            sep = ", ";
412        }
413        Ok(())
414    }
415}
416impl std::str::FromStr for Langs {
417    type Err = unic_langid::LanguageIdentifierError;
418
419    fn from_str(s: &str) -> Result<Self, Self::Err> {
420        if s.trim().is_empty() {
421            return Ok(Langs(vec![]));
422        }
423        let mut r = Self(vec![]);
424        for lang in s.split(',') {
425            r.0.push(lang.trim().parse()?)
426        }
427        Ok(r)
428    }
429}
430
431/// Represents a map of [`Lang`] keys that can be partially matched.
432#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
433#[serde(transparent)]
434pub struct LangMap<V> {
435    inner: Vec<(Lang, V)>,
436}
437impl<V> Default for LangMap<V> {
438    fn default() -> Self {
439        Self { inner: Default::default() }
440    }
441}
442impl<V> LangMap<V> {
443    /// New empty default.
444    pub fn new() -> Self {
445        LangMap::default()
446    }
447
448    /// New empty with pre-allocated capacity.
449    pub fn with_capacity(capacity: usize) -> Self {
450        LangMap {
451            inner: Vec::with_capacity(capacity),
452        }
453    }
454
455    fn exact_i(&self, lang: &Lang) -> Option<usize> {
456        for (i, (key, _)) in self.inner.iter().enumerate() {
457            if key == lang {
458                return Some(i);
459            }
460        }
461        None
462    }
463
464    fn best_i(&self, lang: &Lang) -> Option<usize> {
465        let mut best = None;
466        let mut best_weight = 0;
467
468        for (i, (key, _)) in self.inner.iter().enumerate() {
469            if lang.matches(key, true, true) {
470                let mut weight = 1;
471                let mut eq = 0;
472
473                if key.language == lang.language {
474                    weight += 128;
475                    eq += 1;
476                }
477                if key.region == lang.region {
478                    weight += 40;
479                    eq += 1;
480                }
481                if key.script == lang.script {
482                    weight += 20;
483                    eq += 1;
484                }
485
486                if eq == 3 && lang.variants().zip(key.variants()).all(|(a, b)| a == b) {
487                    return Some(i);
488                }
489
490                if best_weight < weight {
491                    best_weight = weight;
492                    best = Some(i);
493                }
494            }
495        }
496
497        best
498    }
499
500    /// Returns the best match to `lang` currently in the map.
501    pub fn best_match(&self, lang: &Lang) -> Option<&Lang> {
502        if let Some(i) = self.best_i(lang) {
503            Some(&self.inner[i].0)
504        } else {
505            None
506        }
507    }
508
509    /// Returns the best match for `lang`.
510    pub fn get(&self, lang: &Lang) -> Option<&V> {
511        if let Some(i) = self.best_i(lang) {
512            Some(&self.inner[i].1)
513        } else {
514            None
515        }
516    }
517
518    /// Returns the exact match for `lang`.
519    pub fn get_exact(&self, lang: &Lang) -> Option<&V> {
520        if let Some(i) = self.exact_i(lang) {
521            Some(&self.inner[i].1)
522        } else {
523            None
524        }
525    }
526
527    /// Returns the best match for `lang`.
528    pub fn get_mut(&mut self, lang: &Lang) -> Option<&mut V> {
529        if let Some(i) = self.best_i(lang) {
530            Some(&mut self.inner[i].1)
531        } else {
532            None
533        }
534    }
535
536    /// Returns the exact match for `lang`.
537    pub fn get_exact_mut(&mut self, lang: &Lang) -> Option<&mut V> {
538        if let Some(i) = self.exact_i(lang) {
539            Some(&mut self.inner[i].1)
540        } else {
541            None
542        }
543    }
544
545    /// Returns the current value or insert `new` and return a reference to it.
546    pub fn get_exact_or_insert(&mut self, lang: Lang, new: impl FnOnce() -> V) -> &mut V {
547        if let Some(i) = self.exact_i(&lang) {
548            return &mut self.inner[i].1;
549        }
550        let i = self.inner.len();
551        self.inner.push((lang, new()));
552        &mut self.inner[i].1
553    }
554
555    /// Insert the value with the exact match of `lang`.
556    ///
557    /// Returns the previous exact match.
558    pub fn insert(&mut self, lang: Lang, value: V) -> Option<V> {
559        if let Some(i) = self.exact_i(&lang) {
560            Some(mem::replace(&mut self.inner[i].1, value))
561        } else {
562            self.inner.push((lang, value));
563            None
564        }
565    }
566
567    /// Remove the exact match of `lang`.
568    pub fn remove(&mut self, lang: &Lang) -> Option<V> {
569        if let Some(i) = self.exact_i(lang) {
570            Some(self.inner.swap_remove(i).1)
571        } else {
572            None
573        }
574    }
575
576    /// Remove all exact and partial matches of `lang`.
577    ///
578    /// Returns a count of items removed.
579    pub fn remove_all(&mut self, lang: &Lang) -> usize {
580        let mut count = 0;
581        self.inner.retain(|(key, _)| {
582            let rmv = lang.matches(key, true, false);
583            if rmv {
584                count += 1
585            }
586            !rmv
587        });
588        count
589    }
590
591    /// Remove the last inserted lang.
592    pub fn pop(&mut self) -> Option<(Lang, V)> {
593        self.inner.pop()
594    }
595
596    /// Returns if the map is empty.
597    pub fn is_empty(&self) -> bool {
598        self.inner.is_empty()
599    }
600
601    /// Returns the number of languages in the map.
602    pub fn len(&self) -> usize {
603        self.inner.len()
604    }
605
606    /// Remove all entries.
607    pub fn clear(&mut self) {
608        self.inner.clear()
609    }
610
611    /// Iterator over lang keys.
612    pub fn keys(&self) -> impl std::iter::ExactSizeIterator<Item = &Lang> {
613        self.inner.iter().map(|(k, _)| k)
614    }
615
616    /// Iterator over values.
617    pub fn values(&self) -> impl std::iter::ExactSizeIterator<Item = &V> {
618        self.inner.iter().map(|(_, v)| v)
619    }
620
621    /// Iterator over values.
622    pub fn values_mut(&mut self) -> impl std::iter::ExactSizeIterator<Item = &mut V> {
623        self.inner.iter_mut().map(|(_, v)| v)
624    }
625
626    /// Into iterator of values.
627    pub fn into_values(self) -> impl std::iter::ExactSizeIterator<Item = V> {
628        self.inner.into_iter().map(|(_, v)| v)
629    }
630
631    /// Iterate over key-value pairs.
632    pub fn iter(&self) -> impl std::iter::ExactSizeIterator<Item = (&Lang, &V)> {
633        self.inner.iter().map(|(k, v)| (k, v))
634    }
635
636    /// Iterate over key-value pairs with mutable values.
637    pub fn iter_mut(&mut self) -> impl std::iter::ExactSizeIterator<Item = (&Lang, &mut V)> {
638        self.inner.iter_mut().map(|(k, v)| (&*k, v))
639    }
640}
641impl<V> LangMap<HashMap<LangFilePath, V>> {
642    /// Returns the match for `lang` and `file`.
643    pub fn get_file(&self, lang: &Lang, file: &LangFilePath) -> Option<&V> {
644        let files = self.get(lang)?;
645        if let Some(exact) = files.get(file) {
646            return Some(exact);
647        }
648        Self::best_file(files, file).map(|(_, v)| v)
649    }
650
651    /// Returns the best match to `lang` and `file` currently in the map.
652    pub fn best_file_match(&self, lang: &Lang, file: &LangFilePath) -> Option<&LangFilePath> {
653        let files = self.get(lang)?;
654        if let Some((exact, _)) = files.get_key_value(file) {
655            return Some(exact);
656        }
657        Self::best_file(files, file).map(|(k, _)| k)
658    }
659
660    fn best_file<'a>(files: &'a HashMap<LangFilePath, V>, file: &LangFilePath) -> Option<(&'a LangFilePath, &'a V)> {
661        let mut best = None;
662        let mut best_dist = u64::MAX;
663        for (k, v) in files {
664            if let Some(d) = k.matches(file) {
665                if d < best_dist {
666                    best = Some((k, v));
667                    best_dist = d;
668                }
669            }
670        }
671        best
672    }
673}
674impl<V> IntoIterator for LangMap<V> {
675    type Item = (Lang, V);
676
677    type IntoIter = std::vec::IntoIter<(Lang, V)>;
678
679    fn into_iter(self) -> Self::IntoIter {
680        self.inner.into_iter()
681    }
682}
683impl<V: PartialEq> PartialEq for LangMap<V> {
684    fn eq(&self, other: &Self) -> bool {
685        if self.len() != other.len() {
686            return false;
687        }
688        for (k, v) in &self.inner {
689            if other.get_exact(k) != Some(v) {
690                return false;
691            }
692        }
693        true
694    }
695}
696impl<V: Eq> Eq for LangMap<V> {}
697
698/// Errors found parsing a fluent resource file.
699#[derive(Clone, Debug)]
700pub struct FluentParserErrors(pub Vec<fluent_syntax::parser::ParserError>);
701impl fmt::Display for FluentParserErrors {
702    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
703        let mut sep = "";
704        for e in &self.0 {
705            write!(f, "{sep}{e}")?;
706            sep = "\n";
707        }
708        Ok(())
709    }
710}
711impl std::error::Error for FluentParserErrors {
712    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
713        if self.0.len() == 1 { Some(&self.0[0]) } else { None }
714    }
715}
716
717/// Localization resource file path in the localization directory.
718///
719/// In the default directory layout, localization dependencies are collected using `cargo zng l10n`
720/// and copied to `l10n/{lang}/deps/{name}/{version}/`, and localization for the app ([`is_current_app`])
721/// is placed in `l10n/{lang}/`.
722///
723/// [`is_current_app`]: Self::is_current_app
724#[derive(Debug, Clone, serde::Serialize, serde::Deserialize)]
725pub struct LangFilePath {
726    /// Package name.
727    pub pkg_name: Txt,
728    /// Package version.
729    pub pkg_version: Version,
730    /// The file name.
731    pub file: Txt,
732}
733impl Ord for LangFilePath {
734    fn cmp(&self, other: &Self) -> std::cmp::Ordering {
735        let self_pkg = self.actual_pkg_data();
736        let other_pkg = other.actual_pkg_data();
737        match self_pkg.0.cmp(other_pkg.0) {
738            core::cmp::Ordering::Equal => {}
739            ord => return ord,
740        }
741        match self_pkg.1.cmp(other_pkg.1) {
742            core::cmp::Ordering::Equal => {}
743            ord => return ord,
744        }
745        self.file().cmp(&other.file())
746    }
747}
748impl PartialOrd for LangFilePath {
749    fn partial_cmp(&self, other: &Self) -> Option<std::cmp::Ordering> {
750        Some(self.cmp(other))
751    }
752}
753impl std::hash::Hash for LangFilePath {
754    fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
755        self.actual_pkg_data().hash(state);
756        self.file().hash(state);
757    }
758}
759impl Eq for LangFilePath {}
760impl PartialEq for LangFilePath {
761    fn eq(&self, other: &Self) -> bool {
762        self.actual_pkg_data() == other.actual_pkg_data() && self.file() == other.file()
763    }
764}
765impl LangFilePath {
766    /// New from package name, version and file.
767    pub fn new(pkg_name: impl Into<Txt>, pkg_version: Version, file: impl Into<Txt>) -> Self {
768        Self {
769            pkg_name: pkg_name.into(),
770            pkg_version,
771            file: file.into(),
772        }
773    }
774
775    /// Gets a file in the current app.
776    ///
777    /// This value indicates that the localization resources are directly on the `l10n/{lang?}/` directories, not
778    /// in the dependencies directories.
779    ///
780    /// See [`zng_env::about()`] for more details.
781    pub fn current_app(file: impl Into<Txt>) -> LangFilePath {
782        let about = zng_env::about();
783        Self::new(about.pkg_name.clone(), about.version.clone(), file.into())
784    }
785
786    /// Gets if this file is in the [`current_app`] resources, or the `pkg_name` is empty or the `pkg_version.pre` is `#.#.#-local`.
787    ///
788    /// [`current_app`]: Self::current_app
789    pub fn is_current_app(&self) -> bool {
790        self.is_current_app_no_check() || {
791            let about = zng_env::about();
792            self.pkg_name == about.pkg_name && self.pkg_version == about.version
793        }
794    }
795
796    fn is_current_app_no_check(&self) -> bool {
797        self.pkg_name.is_empty() || self.pkg_version.pre.as_str() == "local"
798    }
799
800    fn actual_pkg_data(&self) -> (&Txt, &Version) {
801        if self.is_current_app_no_check() {
802            let about = zng_env::about();
803            (&about.pkg_name, &about.version)
804        } else {
805            (&self.pkg_name, &self.pkg_version)
806        }
807    }
808
809    /// Gets the normalized package name.
810    ///
811    /// This is the app package name if [`is_current_app`], otherwise is just the `pkg_name` value.
812    ///
813    /// [`is_current_app`]: Self::is_current_app
814    pub fn pkg_name(&self) -> Txt {
815        self.actual_pkg_data().0.clone()
816    }
817
818    /// Gets the normalized package version.
819    ///
820    /// This is the app version if [`is_current_app`], otherwise is just the `pkg_version` value.
821    ///
822    /// [`is_current_app`]: Self::is_current_app
823    pub fn pkg_version(&self) -> Version {
824        self.actual_pkg_data().1.clone()
825    }
826
827    /// Gets the normalized file name.
828    ///
829    /// This `"_"` for empty file or the file.
830    pub fn file(&self) -> Txt {
831        if self.file.is_empty() {
832            Txt::from_char('_')
833        } else {
834            self.file.clone()
835        }
836    }
837
838    /// Get the file path, relative to the localization dir.
839    ///
840    /// * Empty file name is the same as `_`.
841    /// * If package [`is_current_app`] gets `{lang}/{file}.ftl`.
842    /// * Else if is another package gets `{lang}/deps/{pkg_name}/{pkg_version}/{file}.ftl`.
843    ///
844    /// [`is_current_app`]: Self::is_current_app
845    pub fn to_path(&self, lang: &Lang) -> PathBuf {
846        let mut file = self.file.as_str();
847        if file.is_empty() {
848            file = "_";
849        }
850        if self.is_current_app() {
851            format!("{lang}/{file}.ftl")
852        } else {
853            format!("{lang}/deps/{}/{}/{file}.ftl", self.pkg_name, self.pkg_version)
854        }
855        .into()
856    }
857
858    /// Gets a value that indicates if the resources represented by `self` can be used for `search`.
859    ///
860    /// The number indicates the quality of the match:
861    ///
862    /// * `0` is an exact match.
863    /// * `b1` is a match with only version `build` differences.
864    /// * `b10` is a match with only version `pre` differences.
865    /// * `(0..u16::MAX) << 16` is a match with only `patch` differences and the absolute distance.
866    /// * `(0..u16::MAX) << 16 * 2` is a match with `minor` differences and the absolute distance.
867    /// * `(0..u16::MAX) << 16 * 3` is a match with `major` differences and the absolute distance.
868    /// * `None`` is a `pkg_name` mismatch.
869    pub fn matches(&self, search: &Self) -> Option<u64> {
870        let (self_name, self_version) = self.actual_pkg_data();
871        let (search_name, search_version) = search.actual_pkg_data();
872
873        if self_name != search_name {
874            return None;
875        }
876
877        fn dist(a: u64, b: u64, shift: u64) -> u64 {
878            let (l, s) = match a.cmp(&b) {
879                std::cmp::Ordering::Equal => return 0,
880                std::cmp::Ordering::Less => (b, a),
881                std::cmp::Ordering::Greater => (a, b),
882            };
883
884            (l - s).min(u16::MAX as u64) << (16 * shift)
885        }
886
887        let mut d = 0;
888        if self_version.build != search_version.build {
889            d = 1;
890        }
891        if self_version.pre != search_version.pre {
892            d |= 0b10;
893        }
894
895        d |= dist(self_version.patch, search_version.patch, 1);
896        d |= dist(self_version.minor, search_version.minor, 2);
897        d |= dist(self_version.major, search_version.major, 3);
898
899        Some(d)
900    }
901}
902impl_from_and_into_var! {
903    fn from(file: Txt) -> LangFilePath {
904        LangFilePath::current_app(file)
905    }
906
907    fn from(file: &'static str) -> LangFilePath {
908        LangFilePath::current_app(file)
909    }
910
911    fn from(file: String) -> LangFilePath {
912        LangFilePath::current_app(file)
913    }
914}
915
916#[cfg(test)]
917mod tests {
918    use super::*;
919
920    #[test]
921    fn file_matches() {
922        fn check(a: &str, b: &str, c: &str) {
923            let ap = LangFilePath::new("name", a.parse().unwrap(), "file");
924            let bp = LangFilePath::new("name", b.parse().unwrap(), "file");
925            let cp = LangFilePath::new("name", c.parse().unwrap(), "file");
926
927            let ab = ap.matches(&bp);
928            let ac = ap.matches(&cp);
929
930            assert!(ab < ac, "expected {a}.matches({b}) < {a}.matches({c})")
931        }
932
933        check("0.0.0", "0.0.1", "0.1.0");
934        check("0.0.1", "0.1.0", "1.0.0");
935        check("0.0.0-pre", "0.0.0-pre+build", "0.0.0-other+build");
936        check("0.0.0+build", "0.0.0+build", "0.0.0+other");
937        check("0.0.1", "0.0.2", "0.0.3");
938        check("0.1.0", "0.2.0", "0.3.0");
939        check("1.0.0", "2.0.0", "3.0.0");
940        check("1.0.0", "1.1.0", "2.0.0");
941    }
942}
zng_ext_l10n/types.rs

zng_ext_l10n/
types.rs
