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
// SPDX-FileCopyrightText: 2026 Sébastien Helleu <flashcode@flashtux.org>
//
// SPDX-License-Identifier: GPL-3.0-or-later
//! Implementation of the `escapes` rule: check missing/extra escape characters.
use crate::checker::Checker;
use crate::diagnostic::{Diagnostic, Severity};
use crate::po::entry::Entry;
use crate::po::message::Message;
use crate::rules::rule::RuleChecker;
pub struct EscapesRule;
impl RuleChecker for EscapesRule {
fn name(&self) -> &'static str {
"escapes"
}
fn is_default(&self) -> bool {
true
}
fn is_check(&self) -> bool {
true
}
fn severity(&self) -> Severity {
Severity::Error
}
/// Check for missing or extra escape characters (`\\` and `\`) in the translation.
///
/// Wrong entry:
/// ```text
/// msgid "this is a \"test\""
/// msgstr "ceci est un \\\"test\\\""
/// ```
///
/// Correct entry:
/// ```text
/// msgid "this is a \"test\""
/// msgstr "ceci est un \"test\""
/// ```
///
/// Diagnostics reported with severity [`error`](Severity::Error):
/// - `missing escaped escape characters '\\' (# / #)`
/// - `extra escaped escape characters '\\' (# / #)`
/// - `missing escaped escape characters '\' (# / #)`
/// - `extra escaped escape characters '\' (# / #)`
fn check_msg(
&self,
checker: &Checker,
_entry: &Entry,
msgid: &Message,
msgstr: &Message,
) -> Vec<Diagnostic> {
let id_esc: Vec<_> = msgid
.value
.match_indices("\\\\")
.map(|(idx, value)| (idx, idx + value.len()))
.collect();
let str_esc: Vec<_> = msgstr
.value
.match_indices("\\\\")
.map(|(idx, value)| (idx, idx + value.len()))
.collect();
match id_esc.len().cmp(&str_esc.len()) {
std::cmp::Ordering::Greater => {
vec![
self.new_diag(
checker,
format!(
"missing escaped escape characters '\\\\' ({} / {})",
id_esc.len(),
str_esc.len()
),
)
.with_msgs_hl(msgid, &id_esc, msgstr, &str_esc),
]
}
std::cmp::Ordering::Less => {
vec![
self.new_diag(
checker,
format!(
"extra escaped escape characters '\\\\' ({} / {})",
id_esc.len(),
str_esc.len()
),
)
.with_msgs_hl(msgid, &id_esc, msgstr, &str_esc),
]
}
std::cmp::Ordering::Equal => {
let id_esc: Vec<_> = msgid
.value
.match_indices('\\')
.map(|(idx, value)| (idx, idx + value.len()))
.collect();
let str_esc: Vec<_> = msgstr
.value
.match_indices('\\')
.map(|(idx, value)| (idx, idx + value.len()))
.collect();
match id_esc.len().cmp(&str_esc.len()) {
std::cmp::Ordering::Greater => {
vec![
self.new_diag(
checker,
format!(
"missing escape characters '\\' ({} / {})",
id_esc.len(),
str_esc.len()
),
)
.with_msgs_hl(msgid, &id_esc, msgstr, &str_esc),
]
}
std::cmp::Ordering::Less => {
vec![
self.new_diag(
checker,
format!(
"extra escape characters '\\' ({} / {})",
id_esc.len(),
str_esc.len()
),
)
.with_msgs_hl(msgid, &id_esc, msgstr, &str_esc),
]
}
std::cmp::Ordering::Equal => vec![],
}
}
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::{diagnostic::Diagnostic, rules::rule::Rules};
fn check_escapes(content: &str) -> Vec<Diagnostic> {
let mut checker = Checker::new(content.as_bytes());
let rules = Rules::new(vec![Box::new(EscapesRule {})]);
checker.do_all_checks(&rules);
checker.diagnostics
}
#[test]
fn test_no_escapes() {
let diags = check_escapes(
r#"
msgid "tested"
msgstr "testé"
"#,
);
assert!(diags.is_empty());
}
#[test]
fn test_escapes_ok() {
let diags = check_escapes(
r#"
msgid "tested: \ \n "
msgstr "testé : \ \n "
"#,
);
assert!(diags.is_empty());
}
#[test]
fn test_escaped_escape_char_error() {
let diags = check_escapes(
r#"
msgid "tested\\\\"
msgstr "testé"
msgid "tested"
msgstr "testé\\\\"
"#,
);
assert_eq!(diags.len(), 2);
let diag = &diags[0];
assert_eq!(diag.severity, Severity::Error);
assert_eq!(
diag.message,
"missing escaped escape characters '\\\\' (1 / 0)"
);
let diag = &diags[1];
assert_eq!(diag.severity, Severity::Error);
assert_eq!(
diag.message,
"extra escaped escape characters '\\\\' (0 / 1)"
);
}
#[test]
fn test_escaped_char_error_noqa() {
let diags = check_escapes(
r#"
#, noqa:escapes
msgid "tested\\"
msgstr "testé"
"#,
);
assert!(diags.is_empty());
}
#[test]
fn test_escaped_char_error() {
let diags = check_escapes(
r#"
msgid "tested\\"
msgstr "testé"
msgid "tested"
msgstr "testé\\"
"#,
);
assert_eq!(diags.len(), 2);
let diag = &diags[0];
assert_eq!(diag.severity, Severity::Error);
assert_eq!(diag.message, "missing escape characters '\\' (1 / 0)");
let diag = &diags[1];
assert_eq!(diag.severity, Severity::Error);
assert_eq!(diag.message, "extra escape characters '\\' (0 / 1)");
}
}