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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
|
use fluent_syntax::ast;
/// [`FluentAttribute`] is a component of a compound [`FluentMessage`].
///
/// It represents a key-value pair providing a translation of a component
/// of a user interface widget localized by the given message.
///
/// # Example
///
/// ```
/// use fluent_bundle::{FluentResource, FluentBundle};
///
/// let source = r#"
///
/// confirm-modal = Are you sure?
/// .confirm = Yes
/// .cancel = No
/// .tooltip = Closing the window will lose all unsaved data.
///
/// "#;
///
/// let resource = FluentResource::try_new(source.to_string())
/// .expect("Failed to parse the resource.");
///
/// let mut bundle = FluentBundle::default();
/// bundle.add_resource(resource)
/// .expect("Failed to add a resource.");
///
/// let msg = bundle.get_message("confirm-modal")
/// .expect("Failed to retrieve a message.");
///
/// let mut err = vec![];
///
/// let attributes = msg.attributes().map(|attr| {
/// bundle.format_pattern(attr.value(), None, &mut err)
/// }).collect::<Vec<_>>();
///
/// assert_eq!(attributes[0], "Yes");
/// assert_eq!(attributes[1], "No");
/// assert_eq!(attributes[2], "Closing the window will lose all unsaved data.");
/// ```
#[derive(Debug, PartialEq)]
pub struct FluentAttribute<'m> {
node: &'m ast::Attribute<&'m str>,
}
impl<'m> FluentAttribute<'m> {
/// Retrieves an id of an attribute.
///
/// # Example
///
/// ```
/// # use fluent_bundle::{FluentResource, FluentBundle};
/// # let source = r#"
/// # confirm-modal =
/// # .confirm = Yes
/// # "#;
/// # let resource = FluentResource::try_new(source.to_string())
/// # .expect("Failed to parse the resource.");
/// # let mut bundle = FluentBundle::default();
/// # bundle.add_resource(resource)
/// # .expect("Failed to add a resource.");
/// let msg = bundle.get_message("confirm-modal")
/// .expect("Failed to retrieve a message.");
///
/// let attr1 = msg.attributes().next()
/// .expect("Failed to retrieve an attribute.");
///
/// assert_eq!(attr1.id(), "confirm");
/// ```
pub fn id(&self) -> &'m str {
&self.node.id.name
}
/// Retrieves an value of an attribute.
///
/// # Example
///
/// ```
/// # use fluent_bundle::{FluentResource, FluentBundle};
/// # let source = r#"
/// # confirm-modal =
/// # .confirm = Yes
/// # "#;
/// # let resource = FluentResource::try_new(source.to_string())
/// # .expect("Failed to parse the resource.");
/// # let mut bundle = FluentBundle::default();
/// # bundle.add_resource(resource)
/// # .expect("Failed to add a resource.");
/// let msg = bundle.get_message("confirm-modal")
/// .expect("Failed to retrieve a message.");
///
/// let attr1 = msg.attributes().next()
/// .expect("Failed to retrieve an attribute.");
///
/// let mut err = vec![];
///
/// let value = attr1.value();
/// assert_eq!(
/// bundle.format_pattern(value, None, &mut err),
/// "Yes"
/// );
/// ```
pub fn value(&self) -> &'m ast::Pattern<&'m str> {
&self.node.value
}
}
impl<'m> From<&'m ast::Attribute<&'m str>> for FluentAttribute<'m> {
fn from(attr: &'m ast::Attribute<&'m str>) -> Self {
FluentAttribute { node: attr }
}
}
/// [`FluentMessage`] is a basic translation unit of the Fluent system.
///
/// The instance of a message is returned from the
/// [`FluentBundle::get_message`](crate::bundle::FluentBundle::get_message)
/// method, for the lifetime of the [`FluentBundle`](crate::bundle::FluentBundle) instance.
///
/// # Example
///
/// ```
/// use fluent_bundle::{FluentResource, FluentBundle};
///
/// let source = r#"
///
/// hello-world = Hello World!
///
/// "#;
///
/// let resource = FluentResource::try_new(source.to_string())
/// .expect("Failed to parse the resource.");
///
/// let mut bundle = FluentBundle::default();
/// bundle.add_resource(resource)
/// .expect("Failed to add a resource.");
///
/// let msg = bundle.get_message("hello-world")
/// .expect("Failed to retrieve a message.");
///
/// assert!(msg.value().is_some());
/// ```
///
/// That value can be then passed to
/// [`FluentBundle::format_pattern`](crate::bundle::FluentBundle::format_pattern) to be formatted
/// within the context of a given [`FluentBundle`](crate::bundle::FluentBundle) instance.
///
/// # Compound Message
///
/// A message may contain a `value`, but it can also contain a list of [`FluentAttribute`] elements.
///
/// If a message contains attributes, it is called a "compound" message.
///
/// In such case, the message contains a list of key-value attributes that represent
/// different translation values associated with a single translation unit.
///
/// This is useful for scenarios where a [`FluentMessage`] is associated with a
/// complex User Interface widget which has multiple attributes that need to be translated.
/// ```text
/// confirm-modal = Are you sure?
/// .confirm = Yes
/// .cancel = No
/// .tooltip = Closing the window will lose all unsaved data.
/// ```
#[derive(Debug, PartialEq)]
pub struct FluentMessage<'m> {
node: &'m ast::Message<&'m str>,
}
impl<'m> FluentMessage<'m> {
/// Retrieves an option of a [`ast::Pattern`](fluent_syntax::ast::Pattern).
///
/// # Example
///
/// ```
/// # use fluent_bundle::{FluentResource, FluentBundle};
/// # let source = r#"
/// # hello-world = Hello World!
/// # "#;
/// # let resource = FluentResource::try_new(source.to_string())
/// # .expect("Failed to parse the resource.");
/// # let mut bundle = FluentBundle::default();
/// # bundle.add_resource(resource)
/// # .expect("Failed to add a resource.");
/// let msg = bundle.get_message("hello-world")
/// .expect("Failed to retrieve a message.");
///
/// if let Some(value) = msg.value() {
/// let mut err = vec![];
/// assert_eq!(
/// bundle.format_pattern(value, None, &mut err),
/// "Hello World!"
/// );
/// # assert_eq!(err.len(), 0);
/// }
/// ```
pub fn value(&self) -> Option<&'m ast::Pattern<&'m str>> {
self.node.value.as_ref()
}
/// An iterator over [`FluentAttribute`] elements.
///
/// # Example
///
/// ```
/// # use fluent_bundle::{FluentResource, FluentBundle};
/// # let source = r#"
/// # hello-world =
/// # .label = This is a label
/// # .accesskey = C
/// # "#;
/// # let resource = FluentResource::try_new(source.to_string())
/// # .expect("Failed to parse the resource.");
/// # let mut bundle = FluentBundle::default();
/// # bundle.add_resource(resource)
/// # .expect("Failed to add a resource.");
/// let msg = bundle.get_message("hello-world")
/// .expect("Failed to retrieve a message.");
///
/// let mut err = vec![];
///
/// for attr in msg.attributes() {
/// let _ = bundle.format_pattern(attr.value(), None, &mut err);
/// }
/// # assert_eq!(err.len(), 0);
/// ```
pub fn attributes(&self) -> impl Iterator<Item = FluentAttribute<'m>> {
self.node.attributes.iter().map(Into::into)
}
/// Retrieve a single [`FluentAttribute`] element.
///
/// # Example
///
/// ```
/// # use fluent_bundle::{FluentResource, FluentBundle};
/// # let source = r#"
/// # hello-world =
/// # .label = This is a label
/// # .accesskey = C
/// # "#;
/// # let resource = FluentResource::try_new(source.to_string())
/// # .expect("Failed to parse the resource.");
/// # let mut bundle = FluentBundle::default();
/// # bundle.add_resource(resource)
/// # .expect("Failed to add a resource.");
/// let msg = bundle.get_message("hello-world")
/// .expect("Failed to retrieve a message.");
///
/// let mut err = vec![];
///
/// if let Some(attr) = msg.get_attribute("label") {
/// assert_eq!(
/// bundle.format_pattern(attr.value(), None, &mut err),
/// "This is a label"
/// );
/// }
/// # assert_eq!(err.len(), 0);
/// ```
pub fn get_attribute(&self, key: &str) -> Option<FluentAttribute<'m>> {
self.node
.attributes
.iter()
.find(|attr| attr.id.name == key)
.map(Into::into)
}
}
impl<'m> From<&'m ast::Message<&'m str>> for FluentMessage<'m> {
fn from(msg: &'m ast::Message<&'m str>) -> Self {
FluentMessage { node: msg }
}
}
|
