Skip to content

Remove error field and related checks from PreferenceManager #669

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
NSoiffer merged 1 commit into from
Aug 12, 2026
Merged

Remove error field and related checks from PreferenceManager #669

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
61 changes: 7 additions & 54 deletions src/prefs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,7 +216,6 @@ thread_local!{
#[derive(Debug, Default)]
pub struct PreferenceManager {
rules_dir: PathBuf, // full path to rules dir
error: String, // empty/default string if fields are set, otherwise error message
user_prefs: Preferences, // prefs that come from reading prefs.yaml (system and user locations)
api_prefs: Preferences, // prefs set by API calls (along with some defaults not in the user settings such as "pitch")
sys_prefs_file: Option<FileAndTime>, // the system prefs.yaml file
Expand All @@ -238,17 +237,13 @@ pub struct PreferenceManager {
impl fmt::Display for PreferenceManager {
fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
writeln!(f, "PreferenceManager:")?;
if !self.error.is_empty() {
writeln!(f, " not initialized!!! Error is {}", self.error)?;
} else {
writeln!(f, " user prefs:\n{}", self.user_prefs)?;
writeln!(f, " api prefs:\n{}", self.api_prefs)?;
writeln!(f, " style files: {:?}", self.speech.as_path())?;
writeln!(f, " unicode files: {:?}", self.speech_unicode.as_path())?;
writeln!(f, " intent files: {:?}", self.intent.as_path())?;
writeln!(f, " speech definition files: {:?}", self.speech_defs)?;
writeln!(f, " braille definition files: {:?}", self.braille_defs)?;
}
writeln!(f, " user prefs:\n{}", self.user_prefs)?;
writeln!(f, " api prefs:\n{}", self.api_prefs)?;
writeln!(f, " style files: {:?}", self.speech.as_path())?;
writeln!(f, " unicode files: {:?}", self.speech_unicode.as_path())?;
writeln!(f, " intent files: {:?}", self.intent.as_path())?;
writeln!(f, " speech definition files: {:?}", self.speech_defs)?;
writeln!(f, " braille definition files: {:?}", self.braille_defs)?;
return Ok(());
}
}
Expand Down Expand Up @@ -290,10 +285,6 @@ impl PreferenceManager {
return PREF_MANAGER.with( |pm| pm.clone() );
}

pub fn get_error(&self) -> &str {
return &self.error;
}

/// Return a `PreferenceHashMap` that is the merger of the api prefs onto the user prefs.
pub fn merge_prefs(&self) -> PreferenceHashMap {
let mut merged_prefs = self.user_prefs.prefs.clone();
Expand Down Expand Up @@ -680,10 +671,6 @@ impl PreferenceManager {

/// Return the speech rule style file locations.
pub fn get_rule_file(&self, name: &RulesFor) -> &Path {
if !self.error.is_empty() {
panic!("Internal error: get_rule_file called on invalid PreferenceManager -- error message\n{}", self.error);
};

let files = match name {
RulesFor::Intent => &self.intent,
RulesFor::Speech => &self.speech,
Expand All @@ -696,37 +683,22 @@ impl PreferenceManager {

/// Return the unicode.yaml file locations.
pub fn get_speech_unicode_file(&self) ->(&Path, &Path) {
if !self.error.is_empty() {
panic!("Internal error: get_speech_unicode_file called on invalid PreferenceManager -- error message\n{}", self.error);
};
return (self.speech_unicode.as_path(), self.speech_unicode_full.as_path());
}

/// Return the unicode.yaml file locations.
pub fn get_braille_unicode_file(&self) -> (&Path, &Path) {
if !self.error.is_empty() {
panic!("Internal error: get_braille_unicode_file called on invalid PreferenceManager -- error message\n{}", self.error);
};

return (self.braille_unicode.as_path(), self.braille_unicode_full.as_path());
}

/// Return the definitions.yaml file locations.
pub fn get_definitions_file(&self, use_speech_defs: bool) -> &Path {
if !self.error.is_empty() {
panic!("Internal error: get_definitions_file called on invalid PreferenceManager -- error message\n{}", self.error);
};

let defs_file = if use_speech_defs {&self.speech_defs} else {&self.braille_defs};
return defs_file;
}

/// Return the TTS engine currently in use.
pub fn get_tts(&self) -> TTS {
if !self.error.is_empty() {
panic!("Internal error: get_tts called on invalid PreferenceManager -- error message\n{}", self.error);
};

let tts: String = self.pref_to_string("TTS");
return tts.parse().unwrap_or_else(|_| {
warn!("found unknown value for TTS: '{tts}'");
Expand All @@ -740,9 +712,6 @@ impl PreferenceManager {
/// If this happens, the preference is not set and an error is returned.
/// If "LanguageAuto" is set, we assume "Language" has already be checked to be "Auto"
pub fn set_string_pref(&mut self, key: &str, value: &str) -> Result<()> {
if !self.error.is_empty() {
panic!("Internal error: set_string_pref called on invalid PreferenceManager -- error message\n{}", self.error);
};

// verify language, braille, and SpeechStyle because these are used as access into the file system
// should be an ascii string with only letters, dashes, and underscores
Expand Down Expand Up @@ -820,27 +789,15 @@ impl PreferenceManager {
/// Set the number-valued preference.
/// All number-valued preferences are stored with type `f64`.
pub fn set_api_float_pref(&mut self, key: &str, value: f64) {
if !self.error.is_empty() {
panic!("Internal error: set_api_float_pref called on invalid PreferenceManager -- error message\n{}", self.error);
};

self.api_prefs.prefs.insert(key.to_string(), Yaml::Real(value.to_string()));
}

pub fn set_api_boolean_pref(&mut self, key: &str, value: bool) {
if !self.error.is_empty() {
panic!("Internal error: set_api_boolean_pref called on invalid PreferenceManager -- error message\n{}", self.error);
};

self.api_prefs.prefs.insert(key.to_string(), Yaml::Boolean(value));
}

/// Return the current speech rate.
pub fn get_rate(&self) -> f64 {
if !self.error.is_empty() {
panic!("Internal error: get_rate called on invalid PreferenceManager -- error message\n{}", self.error);
};

return match &self.pref_to_string("Rate").parse::<f64>() {
Ok(val) => *val,
Err(_) => {
Expand Down Expand Up @@ -883,10 +840,6 @@ impl PreferenceManager {
/// set_preference() is the function that should be called.
/// This differs from set_preference in that the user preferences are changed, not the api ones
pub fn set_user_prefs(&mut self, key: &str, value: &str) -> Result<()> {
if !self.error.is_empty() {
panic!("Internal error: set_user_prefs called on invalid PreferenceManager -- error message\n{}", self.error);
};

self.reset_files_from_preference_change(key, value)?;
let is_decimal_separators_changed = key == "DecimalSeparator" && self.user_prefs.prefs.get("DecimalSeparator").unwrap().as_str().unwrap() != value;
let is_language_changed = key == "Language" && self.user_prefs.prefs.get("Language").unwrap().as_str().unwrap() != value;
Expand Down
Loading