Add translation support

jackpot51 · jackpot51 · commit b2998f431714 · 2023-10-30T09:34:36.000-06:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -11,6 +11,10 @@ fontdb = "0.15.0"
 lazy_static = "1.4.0"
 log = "0.4.20"
 rfd = "0.12.0"
+# Internationalization
+i18n-embed = { version = "0.13.4", features = ["fluent-system", "desktop-requester"] }
+i18n-embed-fl = "0.6.4"
+rust-embed = "6.3.0"
 
 [dependencies.cosmic-text]
 git = "https://github.com/pop-os/cosmic-text"
diff --git a/i18n.toml b/i18n.toml
@@ -0,0 +1,4 @@
+fallback_language = "en"
+
+[fluent]
+assets_dir = "i18n"
diff --git a/i18n/en/cosmic_edit.ftl b/i18n/en/cosmic_edit.ftl
@@ -0,0 +1,49 @@
+new-document = New document
+open-project = Open project
+
+# Menu
+
+## File
+file = File
+new-file = New file
+new-window = New window
+open-file = Open file...
+open-recent = Open recent
+todo = TODO
+save = Save
+save-as = Save as...
+revert-all-changes = Revert all changes
+document-statistics = Document statistics...
+document-type = Document type...
+encoding = Encoding...
+print = Print
+quit = Quit
+
+## Edit
+edit = Edit
+undo = Undo
+redo = Redo
+cut = Cut
+copy = Copy
+paste = Pate
+find = Find
+replace = Replace
+spell-check = Spell check...
+
+## View
+view = View
+indentation = Indentation
+
+### Indentation
+automatic-indentation = Automatic Indentation
+tab-width = Tab width: {$tab_width}
+convert-indentation-to-spaces = Convert indentation to spaces
+convert-indentation-to-tabs = Convert indentation to tabs
+
+word-wrap = Word wrap
+show-line-numbers = Show line numbers
+highlight-current-line = Highlight current line
+syntax-highlighting = Syntax highlighting...
+settings = Settings...
+keyboard-shortcuts = Keyboard shortcuts...
+about-cosmic-text-editor = About COSMIC Text Editor
diff --git a/src/localize.rs b/src/localize.rs
@@ -0,0 +1,46 @@
+use i18n_embed::{
+    fluent::{fluent_language_loader, FluentLanguageLoader},
+    DefaultLocalizer, LanguageLoader, Localizer,
+};
+use rust_embed::RustEmbed;
+
+#[derive(RustEmbed)]
+#[folder = "i18n/"]
+struct Localizations;
+
+lazy_static::lazy_static! {
+    pub static ref LANGUAGE_LOADER: FluentLanguageLoader = {
+        let loader: FluentLanguageLoader = fluent_language_loader!();
+
+        loader
+            .load_fallback_language(&Localizations)
+            .expect("Error while loading fallback language");
+
+        loader
+    };
+}
+
+#[macro_export]
+macro_rules! fl {
+    ($message_id:literal) => {{
+        i18n_embed_fl::fl!($crate::localize::LANGUAGE_LOADER, $message_id)
+    }};
+
+    ($message_id:literal, $($args:expr),*) => {{
+        i18n_embed_fl::fl!($crate::localize::LANGUAGE_LOADER, $message_id, $($args), *)
+    }};
+}
+
+// Get the `Localizer` to be used for localizing this library.
+pub fn localizer() -> Box<dyn Localizer> {
+    Box::from(DefaultLocalizer::new(&*LANGUAGE_LOADER, &Localizations))
+}
+
+pub fn localize() {
+    let localizer = localizer();
+    let requested_languages = i18n_embed::DesktopLanguageRequester::requested_languages();
+
+    if let Err(error) = localizer.select(&requested_languages) {
+        eprintln!("Error while loading language for App List {}", error);
+    }
+}
diff --git a/src/main.rs b/src/main.rs
@@ -18,6 +18,8 @@ use std::{
     sync::Mutex,
 };
 
+mod localize;
+
 use self::menu::menu_bar;
 mod menu;
 
@@ -39,6 +41,8 @@ lazy_static::lazy_static! {
 fn main() -> Result<(), Box<dyn std::error::Error>> {
     env_logger::Builder::from_env(env_logger::Env::default().default_filter_or("info")).init();
 
+    localize::localize();
+
     let settings = Settings::default().size_limits(Limits::NONE.min_width(400.0).min_height(200.0));
     let flags = ();
     cosmic::app::run::<App>(settings, flags)?;
@@ -303,7 +307,7 @@ impl cosmic::Application for App {
             app.nav_model
                 .insert()
                 .icon(icon::from_name("folder-open-symbolic").size(16).icon())
-                .text("Open project");
+                .text(fl!("open-project"));
         }
 
         // Open an empty file if no arguments provided
diff --git a/src/menu.rs b/src/menu.rs
@@ -11,12 +11,12 @@ use cosmic::{
     Element,
 };
 
-use crate::{Config, Message};
+use crate::{fl, Config, Message};
 
 pub fn menu_bar<'a>(config: &Config) -> Element<'a, Message> {
     //TODO: port to libcosmic
     let menu_root = |label| {
-        widget::button(label)
+        widget::button(widget::text(label))
             .padding([4, 12])
             .style(theme::Button::MenuRoot)
     };
@@ -36,84 +36,89 @@ pub fn menu_bar<'a>(config: &Config) -> Element<'a, Message> {
         );
     }
 
-    let menu_folder = |label| menu_button!(label, horizontal_space(Length::Fill), ">");
+    let menu_folder =
+        |label| menu_button!(widget::text(label), horizontal_space(Length::Fill), ">");
 
-    let menu_item = |label, message| MenuTree::new(menu_button!(label).on_press(message));
+    let menu_item =
+        |label, message| MenuTree::new(menu_button!(widget::text(label)).on_press(message));
 
     let menu_key = |label, key, message| {
-        MenuTree::new(menu_button!(label, horizontal_space(Length::Fill), key).on_press(message))
+        MenuTree::new(
+            menu_button!(widget::text(label), horizontal_space(Length::Fill), key)
+                .on_press(message),
+        )
     };
 
     MenuBar::new(vec![
         MenuTree::with_children(
-            menu_root("File"),
+            menu_root(fl!("file")),
             vec![
-                menu_key("New file", "Ctrl + N", Message::New),
-                menu_key("New window", "Ctrl + Shift + N", Message::Todo),
+                menu_key(fl!("new-file"), "Ctrl + N", Message::New),
+                menu_key(fl!("new-window"), "Ctrl + Shift + N", Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_key("Open file...", "Ctrl + O", Message::OpenFileDialog),
+                menu_key(fl!("open-file"), "Ctrl + O", Message::OpenFileDialog),
                 MenuTree::with_children(
-                    menu_folder("Open recent"),
-                    vec![menu_item("TODO", Message::Todo)],
+                    menu_folder(fl!("open-recent")),
+                    vec![menu_item(fl!("todo"), Message::Todo)],
                 ),
                 MenuTree::new(horizontal_rule(1)),
-                menu_key("Save", "Ctrl + S", Message::Save),
-                menu_key("Save as...", "Ctrl + Shift + S", Message::Todo),
+                menu_key(fl!("save"), "Ctrl + S", Message::Save),
+                menu_key(fl!("save-as"), "Ctrl + Shift + S", Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_item("Revert all changes", Message::Todo),
+                menu_item(fl!("revert-all-changes"), Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_item("Document statistics...", Message::Todo),
-                menu_item("Document type...", Message::Todo),
-                menu_item("Encoding...", Message::Todo),
-                menu_item("Print", Message::Todo),
+                menu_item(fl!("document-statistics"), Message::Todo),
+                menu_item(fl!("document-type"), Message::Todo),
+                menu_item(fl!("encoding"), Message::Todo),
+                menu_item(fl!("print"), Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_key("Quit", "Ctrl + Q", Message::Todo),
+                menu_key(fl!("quit"), "Ctrl + Q", Message::Todo),
             ],
         ),
         MenuTree::with_children(
-            menu_root("Edit"),
+            menu_root(fl!("edit")),
             vec![
-                menu_key("Undo", "Ctrl + Z", Message::Todo),
-                menu_key("Redo", "Ctrl + Shift + Z", Message::Todo),
+                menu_key(fl!("undo"), "Ctrl + Z", Message::Todo),
+                menu_key(fl!("redo"), "Ctrl + Shift + Z", Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_key("Cut", "Ctrl + X", Message::Todo),
-                menu_key("Copy", "Ctrl + C", Message::Todo),
-                menu_key("Paste", "Ctrl + V", Message::Todo),
+                menu_key(fl!("cut"), "Ctrl + X", Message::Todo),
+                menu_key(fl!("copy"), "Ctrl + C", Message::Todo),
+                menu_key(fl!("paste"), "Ctrl + V", Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_key("Find", "Ctrl + F", Message::Todo),
-                menu_key("Replace", "Ctrl + H", Message::Todo),
+                menu_key(fl!("find"), "Ctrl + F", Message::Todo),
+                menu_key(fl!("replace"), "Ctrl + H", Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_item("Spell check...", Message::Todo),
+                menu_item(fl!("spell-check"), Message::Todo),
             ],
         ),
         MenuTree::with_children(
-            menu_root("View"),
+            menu_root(fl!("view")),
             vec![
                 MenuTree::with_children(
-                    menu_folder("Indentation"),
+                    menu_folder(fl!("indentation")),
                     vec![
-                        menu_item("Automatic indentation", Message::Todo),
+                        menu_item(fl!("automatic-indentation"), Message::Todo),
                         MenuTree::new(horizontal_rule(1)),
-                        menu_item("Tab width: 1", Message::Todo),
-                        menu_item("Tab width: 2", Message::Todo),
-                        menu_item("Tab width: 4", Message::Todo),
-                        menu_item("Tab width: 8", Message::Todo),
+                        menu_item(fl!("tab-width", tab_width = 1), Message::Todo),
+                        menu_item(fl!("tab-width", tab_width = 2), Message::Todo),
+                        menu_item(fl!("tab-width", tab_width = 4), Message::Todo),
+                        menu_item(fl!("tab-width", tab_width = 8), Message::Todo),
                         MenuTree::new(horizontal_rule(1)),
-                        menu_item("Convert indentation to spaces", Message::Todo),
-                        menu_item("Convert indentation to tabs", Message::Todo),
+                        menu_item(fl!("convert-indentation-to-spaces"), Message::Todo),
+                        menu_item(fl!("convert-indentation-to-tabs"), Message::Todo),
                     ],
                 ),
                 MenuTree::new(horizontal_rule(1)),
-                menu_item("Word wrap", Message::Todo),
-                menu_item("Show line numbers", Message::Todo),
-                menu_item("Highlight current line", Message::Todo),
-                menu_item("Syntax highlighting...", Message::Todo),
+                menu_item(fl!("word-wrap"), Message::Todo),
+                menu_item(fl!("show-line-numbers"), Message::Todo),
+                menu_item(fl!("highlight-current-line"), Message::Todo),
+                menu_item(fl!("syntax-highlighting"), Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_key("Settings...", "Ctrl + ,", Message::Todo),
+                menu_key(fl!("settings"), "Ctrl + ,", Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_item("Keyboard shortcuts...", Message::Todo),
+                menu_item(fl!("keyboard-shortcuts"), Message::Todo),
                 MenuTree::new(horizontal_rule(1)),
-                menu_item("About COSMIC Text Editor", Message::Todo),
+                menu_item(fl!("about-cosmic-text-editor"), Message::Todo),
             ],
         ),
     ])
diff --git a/src/tab.rs b/src/tab.rs
@@ -3,7 +3,7 @@
 use cosmic_text::{Attrs, Buffer, Edit, Metrics, SyntaxEditor, ViEditor, Wrap};
 use std::{fs, path::PathBuf, sync::Mutex};
 
-use crate::{Config, FONT_SYSTEM, SYNTAX_SYSTEM};
+use crate::{fl, Config, FONT_SYSTEM, SYNTAX_SYSTEM};
 
 static FONT_SIZES: &'static [Metrics] = &[
     Metrics::new(10.0, 14.0), // Caption
@@ -104,7 +104,7 @@ impl Tab {
                 None => format!("{}", path.display()),
             }
         } else {
-            "New document".to_string()
+            fl!("new-document")
         }
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -3,7 +3,7 @@`
`3`	`3`	`use cosmic_text::{Attrs, Buffer, Edit, Metrics, SyntaxEditor, ViEditor, Wrap};`
`4`	`4`	`use std::{fs, path::PathBuf, sync::Mutex};`
`5`	`5`
`6`		`-use crate::{Config, FONT_SYSTEM, SYNTAX_SYSTEM};`
	`6`	`+use crate::{fl, Config, FONT_SYSTEM, SYNTAX_SYSTEM};`
`7`	`7`
`8`	`8`	`static FONT_SIZES: &'static [Metrics] = &[`
`9`	`9`	`Metrics::new(10.0, 14.0), // Caption`
`@@ -104,7 +104,7 @@ impl Tab {`
`104`	`104`	`None => format!("{}", path.display()),`
`105`	`105`	`}`
`106`	`106`	`} else {`
`107`		`- "New document".to_string()`
	`107`	`+ fl!("new-document")`
`108`	`108`	`}`
`109`	`109`	`}`
`110`	`110`	`}`