translate help msgs + globally export xlat macros

Author: squell

src/lib.rs

@@ -6,6 +6,7 @@ pub(crate) mod common;
 pub(crate) mod cutils;
 pub(crate) mod defaults;
 pub(crate) mod exec;
+#[macro_use]
 pub(crate) mod gettext;
 pub(crate) mod log;
 pub(crate) mod pam;
@@ -22,10 +23,3 @@ pub use visudo::main as visudo_main;
 
 #[cfg(feature = "do-not-use-all-features")]
 compile_error!("Refusing to compile using 'cargo --all-features' --- please read the README");
-
-//FIXME: this is here to ensure xlat! is used (with gettext disabled) and that
-// the Convert trait is exercised.
-#[allow(unused)]
-fn simulate_use() -> String {
-    gettext::xlat!("{answer}", answer = 42)
-}

src/pam/converse.rs

@@ -2,7 +2,6 @@ use std::ffi::{c_int, c_void};
 use std::time::Duration;
 
 use crate::cutils::string_from_ptr;
-use crate::gettext::xlat;
 use crate::pam::rpassword::Hidden;
 use crate::system::signal::{self, SignalSet};
 

src/pam/error.rs

@@ -4,7 +4,6 @@ use std::path::PathBuf;
 use std::str::Utf8Error;
 
 use crate::cutils::string_from_ptr;
-use crate::gettext::xlat_write;
 
 use super::sys::*;
 

src/pam/mod.rs

@@ -7,7 +7,6 @@ use std::{
     time::Duration,
 };
 
-use crate::gettext::xlat;
 use crate::system::signal::{self, SignalSet};
 
 use converse::ConverserData;

src/sudo/cli/help.rs

@@ -1,13 +1,20 @@
-pub const USAGE_MSG: &str = "\
+pub fn usage_msg() -> &'static str {
+    xlat!(
+        "\
 usage: sudo -h | -K | -k | -V
 usage: sudo [-BknS] [-p prompt] [-D directory] [-g group] [-u user] [-i | -s] [command [arg ...]]
 usage: sudo -v [-BknS] [-p prompt] [-g group] [-u user]
 usage: sudo -l [-BknS] [-p prompt] [-U user] [-g group] [-u user] [command [arg ...]]
-usage: sudo -e [-BknS] [-p prompt] [-D directory] [-g group] [-u user] file ...";
+usage: sudo -e [-BknS] [-p prompt] [-D directory] [-g group] [-u user] file ..."
+    )
+}
 
-const DESCRIPTOR: &str = "sudo - run commands as another user";
+fn descriptor() -> &'static str {
+    xlat!("sudo - run commands as another user")
+}
 
-const HELP_MSG: &str = "Options:
+fn help_msg() -> &'static str {
+    xlat!("Options:
   -B, --bell                    ring bell when prompting
   -D, --chdir=directory         change the working directory before running command
   -g, --group=group             run command as the specified group name or ID
@@ -24,8 +31,9 @@ const HELP_MSG: &str = "Options:
   -u, --user=user               run command (or edit file) as specified user name or ID
   -V, --version                 display version information and exit
   -v, --validate                update user's timestamp without running a command
-  --                            stop processing command line arguments";
+  --                            stop processing command line arguments")
+}
 
 pub fn long_help_message() -> String {
-    format!("{DESCRIPTOR}\n{USAGE_MSG}\n{HELP_MSG}")
+    format!("{}\n{}\n{}", descriptor(), usage_msg(), help_msg())
 }

src/sudo/cli/help_edit.rs

@@ -1,11 +1,18 @@
-pub const USAGE_MSG: &str = "\
+pub fn usage_msg() -> &'static str {
+    xlat!(
+        "\
 usage: sudoedit -h | -V
-usage: sudoedit [-BknS] [-p prompt] [-g group] [-u user] file ...";
+usage: sudoedit [-BknS] [-p prompt] [-g group] [-u user] file ..."
+    )
+}
 
-const DESCRIPTOR: &str = "sudo - edit files as another user";
+fn descriptor() -> &'static str {
+    xlat!("sudo - edit files as another user")
+}
 
-const HELP_MSG: &str = "Options:
-Options:
+fn help_msg() -> &'static str {
+    xlat!(
+        "Options:
   -B, --bell                    ring bell when prompting
   -g, --group=group             run command as the specified group name or ID
   -h, --help                    display help message and exit
@@ -16,8 +23,10 @@ Options:
   -u, --user=user               run command (or edit file) as specified user
                                 name or ID
   -V, --version                 display version information and exit
-  --                            stop processing command line arguments";
+  --                            stop processing command line arguments"
+    )
+}
 
 pub fn long_help_message() -> String {
-    format!("{DESCRIPTOR}\n{USAGE_MSG}\n{HELP_MSG}")
+    format!("{}\n{}\n{}", descriptor(), usage_msg(), help_msg())
 }

src/sudo/cli/mod.rs

@@ -4,7 +4,6 @@ use std::os::unix::ffi::OsStrExt;
 use std::{borrow::Cow, mem};
 
 use crate::common::{SudoPath, SudoString};
-use crate::gettext::xlat;
 use crate::log::user_warn;
 
 pub mod help;

src/sudo/edit.rs

@@ -10,7 +10,6 @@ use std::{io, process};
 
 use crate::common::SudoPath;
 use crate::exec::ExitReason;
-use crate::gettext::xlat;
 use crate::log::{user_error, user_info};
 use crate::system::file::{create_temporary_dir, FileLock};
 use crate::system::wait::{Wait, WaitError, WaitOptions};

src/sudo/mod.rs

@@ -73,10 +73,10 @@ fn sudo_process() -> Result<(), Error> {
     let usage_msg: &str;
     let long_help: fn() -> String;
     if cli::is_sudoedit(std::env::args().next()) {
-        usage_msg = cli::help_edit::USAGE_MSG;
+        usage_msg = cli::help_edit::usage_msg();
         long_help = cli::help_edit::long_help_message;
     } else {
-        usage_msg = cli::help::USAGE_MSG;
+        usage_msg = cli::help::usage_msg();
         long_help = cli::help::long_help_message;
     }
 

src/sudo/pipeline.rs

@@ -7,7 +7,6 @@ use super::diagnostic;
 use crate::common::resolve::{AuthUser, CurrentUser};
 use crate::common::{Context, Error};
 use crate::exec::ExitReason;
-use crate::gettext::xlat;
 use crate::log::{auth_info, auth_warn};
 use crate::pam::PamContext;
 use crate::sudo::env::environment;