simple-locale 0.2.0

An interface to all manner of locale-related information.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126

/*!
Fetch locale-specific message formatting settings.

This module is relatively simple as only a small number of
settings are defined by POSIX for the messages category.

## Example

```
use simple_locale::settings::locale::{Category, get_locale};
use simple_locale::settings::messages::get_message_format;
use simple_locale::Locale;
use std::str::FromStr;

let locale = get_locale(&Category::Time).unwrap();
if locale == Locale::POSIX {
    let format = get_message_format();
    assert_eq!(format.yes_expression, Some("^[yY]".to_string()));
    assert_eq!(format.no_string, Some("no".to_string()));
} else {
    panic!("expecting POSIX locale");
}
```
*/

use crate::ffi::utils::*;
use crate::ffi::*;
use crate::settings::locale::Category;
use crate::{Locale, LocaleResult};

// ------------------------------------------------------------------------------------------------
// Public Types
// ------------------------------------------------------------------------------------------------

/// Settings related to message display.
#[derive(Debug, Clone, PartialEq)]
pub struct MessageFormat {
    /// An expression to validate 'yes' values.
    pub yes_expression: Option<String>,
    /// A default string for 'yes'.
    pub yes_string: Option<String>,
    /// An expression to validate 'no' values.
    pub no_expression: Option<String>,
    /// A default string for 'no'.
    pub no_string: Option<String>,
}

// ------------------------------------------------------------------------------------------------
// Public Functions
// ------------------------------------------------------------------------------------------------

/// Fetch the message formatting settings for the current locale.
pub fn get_message_format() -> MessageFormat {
    MessageFormat {
        yes_expression: get_nl_string(YESEXPR),
        yes_string: get_nl_string(YESSTR),
        no_expression: get_nl_string(NOEXPR),
        no_string: get_nl_string(NOSTR),
    }
}

/// Fetch the message formatting rules for a specified `Locale`.
///
/// # Arguments
///
/// * `locale` - The locale to query.
/// * `inherit_current` - Whether the specified locale should inherit
///   from the current locale.
///
/// If `inherit_current` is `false` the `locale` specified will be treated
/// as an entirely new and complete locale when calling the C
/// [`newlocale`](https://man.openbsd.org/newlocale.3) function. If it is
/// `true` the `locale` is assumed to be a partially specified one and inherits
/// any unspecified components from the current locale. For example, if the
/// current locale is `en_US.UTF-8` and the parameters passed are `_NZ` and
/// `true` then the resulting locale will be `en_NZ.UTF-8`.
pub fn get_message_format_for_locale(
    locale: Locale,
    inherit_current: bool,
) -> LocaleResult<MessageFormat> {
    get_format_for_locale(
        Category::Message,
        locale,
        &get_message_format,
        inherit_current,
    )
}

// ------------------------------------------------------------------------------------------------
// Unit Tests
// ------------------------------------------------------------------------------------------------

#[cfg(test)]
mod tests {
    use crate::settings::locale::{set_locale, Category};
    use crate::settings::messages::{get_message_format, get_message_format_for_locale};
    use crate::Locale;
    use std::str::FromStr;

    // --------------------------------------------------------------------------------------------
    #[test]
    fn test_get_message_format() {
        if set_locale(&Locale::POSIX, &Category::Message) {
            let format = get_message_format();
            println!("{:#?}", format);
            assert_eq!(format.yes_expression, Some("^[yY]".to_string()));
            assert_eq!(format.no_string, Some("no".to_string()));
        } else {
            panic!("set_locale returned false");
        }
    }

    // --------------------------------------------------------------------------------------------
    #[test]
    fn test_get_message_format_for_locale() {
        if set_locale(&Locale::POSIX, &Category::Message) {
            let format = get_message_format_for_locale(Locale::from_str("fr_FR").unwrap(), false);
            println!("{:#?}", format);
            let format = format.unwrap();
            assert_eq!(format.yes_expression, Some("^[oOyY].*".to_string()));
            assert_eq!(format.no_string, Some("no".to_string()));
        } else {
            panic!("set_locale returned false");
        }
    }
}