dietrich/Pslink
1
0
Fork 0
Code Issues 2 Pull Requests Projects Releases 1 Activity

update documentation on i18n

Browse Source
This commit is contained in:
Franz Dietrich 2021-05-24 14:29:14 +02:00
parent 9d42b010c1
commit a2781003c6
1 changed files with 12 additions and 48 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
app/src/i18n.rs
View File

@ -4,8 +4,7 @@ use fluent::{FluentArgs, FluentBundle, FluentResource};
use strum_macros::{AsRefStr, Display, EnumIter, EnumString}; use strum_macros::{AsRefStr, Display, EnumIter, EnumString};
use unic_langid::LanguageIdentifier; use unic_langid::LanguageIdentifier;
// ------ I18n ------ // A struct containing the functions and the current language to query the localized strings.
#[derive(Clone)] #[derive(Clone)]
pub struct I18n { pub struct I18n {
lang: Lang, lang: Lang,
@ -19,6 +18,7 @@ impl std::fmt::Debug for I18n {
} }
impl I18n { impl I18n {
/// Create a new translator struct
#[must_use] #[must_use]
pub fn new(lang: Lang) -> Self { pub fn new(lang: Lang) -> Self {
Self { Self {
@ -27,24 +27,27 @@ impl I18n {
} }
} }
/// Get the current language
#[must_use] #[must_use]
pub const fn lang(&self) -> &Lang { pub const fn lang(&self) -> &Lang {
&self.lang &self.lang
} }
/// Set the current language
pub fn set_lang(&mut self, lang: Lang) -> &Self { pub fn set_lang(&mut self, lang: Lang) -> &Self {
self.lang = lang; self.lang = lang;
self.ftl_bundle = Arc::new(lang.create_ftl_bundle()); self.ftl_bundle = Arc::new(lang.create_ftl_bundle());
self self
} }
/// Get a localized string. Optionally with parameters provided in `args`.
pub fn translate(&self, key: impl AsRef<str>, args: Option<&FluentArgs>) -> String { pub fn translate(&self, key: impl AsRef<str>, args: Option<&FluentArgs>) -> String {
let msg = self let msg = self
.ftl_bundle .ftl_bundle
.get_message(key.as_ref()) .get_message(key.as_ref())
.expect("get fluent message"); .expect("Failed to get fluent message for key {}");
let pattern = msg.value().expect("get value for fluent message"); let pattern = msg.value().expect("Failed to parse pattern");
self.ftl_bundle self.ftl_bundle
.format_pattern(pattern, args, &mut vec![]) .format_pattern(pattern, args, &mut vec![])
@ -52,8 +55,8 @@ impl I18n {
} }
} }
// ------ Lang ------ /// An `enum` containing the available languages.
/// To add an additional language add it to this enum aswell as an appropriate file into the locales folder.
#[allow(clippy::upper_case_acronyms)] #[allow(clippy::upper_case_acronyms)]
#[derive(Debug, Copy, Clone, Display, EnumIter, EnumString, AsRefStr, Eq, PartialEq)] #[derive(Debug, Copy, Clone, Display, EnumIter, EnumString, AsRefStr, Eq, PartialEq)]
pub enum Lang { pub enum Lang {
@ -64,6 +67,7 @@ pub enum Lang {
} }
impl Lang { impl Lang {
/// Prettyprint the language name
#[must_use] #[must_use]
pub const fn label(self) -> &'static str { pub const fn label(self) -> &'static str {
match self { match self {
@ -72,6 +76,7 @@ impl Lang {
} }
} }
/// include the fluent messages into the binary
#[must_use] #[must_use]
pub const fn ftl_messages(self) -> &'static str { pub const fn ftl_messages(self) -> &'static str {
macro_rules! include_ftl_messages { macro_rules! include_ftl_messages {
@ -92,6 +97,7 @@ impl Lang {
.expect("parse Lang to LanguageIdentifier") .expect("parse Lang to LanguageIdentifier")
} }
/// Create and initialize a fluent bundle.
#[must_use] #[must_use]
pub fn create_ftl_bundle(self) -> FluentBundle<FluentResource> { pub fn create_ftl_bundle(self) -> FluentBundle<FluentResource> {
let ftl_resource = let ftl_resource =
@ -103,45 +109,3 @@ impl Lang {
} }
} }
// ------ create_t ------
/// Convenience macro to improve readability of `view`s with many translations.
///
/// # Example
///
///```rust,no_run
/// fn view(model: &Model) -> Node<Msg> {
/// let args_male_sg = fluent_args![
/// "userName" => "Stephan",
/// "userGender" => "male",
/// ];
///
/// create_t!(model.i18n);
/// div![
/// p![t!("hello-world")],
/// p![t!("hello-user", args_male_sg)],
/// ]
/// }
///```
#[macro_export]
macro_rules! create_t {
( $i18n:expr ) => {
// This replaces $d with $ in the inner macro.
seed::with_dollar_sign! {
($d:tt) => {
macro_rules! t {
{ $d key:expr } => {
{
$i18n.translate($d key, None)
}
};
{ $d key:expr, $d args:expr } => {
{
$i18n.translate($d key, Some(&$d args))
}
};
}
}
}
};
}