-
-
Notifications
You must be signed in to change notification settings - Fork 814
/
smartquote.rs
374 lines (339 loc) · 11.1 KB
/
smartquote.rs
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
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
use ecow::EcoString;
use unicode_segmentation::UnicodeSegmentation;
use crate::diag::{bail, StrResult};
use crate::foundations::{array, cast, dict, elem, Array, Dict, FromValue, Smart, Str};
use crate::layout::Dir;
use crate::syntax::is_newline;
use crate::text::{Lang, Region};
/// A language-aware quote that reacts to its context.
///
/// Automatically turns into an appropriate opening or closing quote based on
/// the active [text language]($text.lang).
///
/// # Example
/// ```example
/// "This is in quotes."
///
/// #set text(lang: "de")
/// "Das ist in Anführungszeichen."
///
/// #set text(lang: "fr")
/// "C'est entre guillemets."
/// ```
///
/// # Syntax
/// This function also has dedicated syntax: The normal quote characters
/// (`'` and `"`). Typst automatically makes your quotes smart.
#[elem(name = "smartquote")]
pub struct SmartQuoteElem {
/// Whether this should be a double quote.
#[default(true)]
pub double: bool,
/// Whether smart quotes are enabled.
///
/// To disable smartness for a single quote, you can also escape it with a
/// backslash.
///
/// ```example
/// #set smartquote(enabled: false)
///
/// These are "dumb" quotes.
/// ```
#[default(true)]
pub enabled: bool,
/// Whether to use alternative quotes.
///
/// Does nothing for languages that don't have alternative quotes, or if
/// explicit quotes were set.
///
/// ```example
/// #set text(lang: "de")
/// #set smartquote(alternative: true)
///
/// "Das ist in anderen Anführungszeichen."
/// ```
#[default(false)]
pub alternative: bool,
/// The quotes to use.
///
/// - When set to `{auto}`, the appropriate single quotes for the
/// [text language]($text.lang) will be used. This is the default.
/// - Custom quotes can be passed as a string, array, or dictionary of either
/// - [string]($str): a string consisting of two characters containing the
/// opening and closing double quotes (characters here refer to Unicode
/// grapheme clusters)
/// - [array]($array): an array containing the opening and closing double
/// quotes
/// - [dictionary]($dictionary): an array containing the double and single
/// quotes, each specified as either `{auto}`, string, or array
///
/// ```example
/// #set text(lang: "de")
/// 'Das sind normale Anführungszeichen.'
///
/// #set smartquote(quotes: "()")
/// "Das sind eigene Anführungszeichen."
///
/// #set smartquote(quotes: (single: ("[[", "]]"), double: auto))
/// 'Das sind eigene Anführungszeichen.'
/// ```
#[borrowed]
pub quotes: Smart<SmartQuoteDict>,
}
/// State machine for smart quote substitution.
#[derive(Debug, Clone)]
pub struct SmartQuoter {
/// How many quotes have been opened.
quote_depth: usize,
/// Whether an opening quote might follow.
expect_opening: bool,
/// Whether the last character was numeric.
last_num: bool,
/// The previous type of quote character, if it was an opening quote.
prev_quote_type: Option<bool>,
}
impl SmartQuoter {
/// Start quoting.
pub fn new() -> Self {
Self {
quote_depth: 0,
expect_opening: true,
last_num: false,
prev_quote_type: None,
}
}
/// Process the last seen character.
pub fn last(&mut self, c: char, is_quote: bool) {
self.expect_opening = is_ignorable(c) || is_opening_bracket(c);
self.last_num = c.is_numeric();
if !is_quote {
self.prev_quote_type = None;
}
}
/// Process and substitute a quote.
pub fn quote<'a>(
&mut self,
quotes: &SmartQuotes<'a>,
double: bool,
peeked: Option<char>,
) -> &'a str {
let peeked = peeked.unwrap_or(' ');
let mut expect_opening = self.expect_opening;
if let Some(prev_double) = self.prev_quote_type.take() {
if double != prev_double {
expect_opening = true;
}
}
if expect_opening {
self.quote_depth += 1;
self.prev_quote_type = Some(double);
quotes.open(double)
} else if self.quote_depth > 0
&& (peeked.is_ascii_punctuation() || is_ignorable(peeked))
{
self.quote_depth -= 1;
quotes.close(double)
} else if self.last_num {
quotes.prime(double)
} else {
quotes.fallback(double)
}
}
}
impl Default for SmartQuoter {
fn default() -> Self {
Self::new()
}
}
fn is_ignorable(c: char) -> bool {
c.is_whitespace() || is_newline(c)
}
fn is_opening_bracket(c: char) -> bool {
matches!(c, '(' | '{' | '[')
}
/// Decides which quotes to substitute smart quotes with.
pub struct SmartQuotes<'s> {
/// The opening single quote.
pub single_open: &'s str,
/// The closing single quote.
pub single_close: &'s str,
/// The opening double quote.
pub double_open: &'s str,
/// The closing double quote.
pub double_close: &'s str,
}
impl<'s> SmartQuotes<'s> {
/// Create a new `Quotes` struct with the given quotes, optionally falling
/// back to the defaults for a language and region.
///
/// The language should be specified as an all-lowercase ISO 639-1 code, the
/// region as an all-uppercase ISO 3166-alpha2 code.
///
/// Currently, the supported languages are: English, Czech, Danish, German,
/// Swiss / Liechtensteinian German, Estonian, Icelandic, Lithuanian,
/// Latvian, Slovak, Slovenian, Spanish, Bosnian, Finnish, Swedish, French,
/// Hungarian, Polish, Romanian, Japanese, Traditional Chinese, Russian, and
/// Norwegian.
///
/// For unknown languages, the English quotes are used as fallback.
pub fn new(
quotes: &'s Smart<SmartQuoteDict>,
lang: Lang,
region: Option<Region>,
alternative: bool,
) -> Self {
let region = region.as_ref().map(Region::as_str);
let default = ("‘", "’", "“", "”");
let low_high = ("‚", "‘", "„", "“");
let (single_open, single_close, double_open, double_close) = match lang.as_str() {
"de" if matches!(region, Some("CH" | "LI")) => match alternative {
false => ("‹", "›", "«", "»"),
true => low_high,
},
"cs" | "da" | "de" | "sk" | "sl" if alternative => ("›", "‹", "»", "«"),
"cs" | "de" | "et" | "is" | "lt" | "lv" | "sk" | "sl" => low_high,
"da" => ("‘", "’", "“", "”"),
"fr" | "ru" if alternative => default,
"fr" => ("‹\u{00A0}", "\u{00A0}›", "«\u{00A0}", "\u{00A0}»"),
"fi" | "sv" if alternative => ("’", "’", "»", "»"),
"bs" | "fi" | "sv" => ("’", "’", "”", "”"),
"es" if matches!(region, Some("ES") | None) => ("“", "”", "«", "»"),
"hu" | "pl" | "ro" => ("’", "’", "„", "”"),
"no" | "nb" | "nn" if alternative => low_high,
"ru" | "no" | "nb" | "nn" | "ua" => ("’", "’", "«", "»"),
"gr" => ("‘", "’", "«", "»"),
_ if lang.dir() == Dir::RTL => ("’", "‘", "”", "“"),
_ => default,
};
fn inner_or_default<'s>(
quotes: Smart<&'s SmartQuoteDict>,
f: impl FnOnce(&'s SmartQuoteDict) -> Smart<&'s SmartQuoteSet>,
default: [&'s str; 2],
) -> [&'s str; 2] {
match quotes.and_then(f) {
Smart::Auto => default,
Smart::Custom(SmartQuoteSet { open, close }) => {
[open, close].map(|s| s.as_str())
}
}
}
let quotes = quotes.as_ref();
let [single_open, single_close] =
inner_or_default(quotes, |q| q.single.as_ref(), [single_open, single_close]);
let [double_open, double_close] =
inner_or_default(quotes, |q| q.double.as_ref(), [double_open, double_close]);
Self {
single_open,
single_close,
double_open,
double_close,
}
}
/// The opening quote.
fn open(&self, double: bool) -> &'s str {
if double {
self.double_open
} else {
self.single_open
}
}
/// The closing quote.
fn close(&self, double: bool) -> &'s str {
if double {
self.double_close
} else {
self.single_close
}
}
/// Which character should be used as a prime.
fn prime(&self, double: bool) -> &'static str {
if double {
"″"
} else {
"′"
}
}
/// Which character should be used as a fallback quote.
fn fallback(&self, double: bool) -> &'static str {
if double {
"\""
} else {
"’"
}
}
}
/// An opening and closing quote.
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub struct SmartQuoteSet {
open: EcoString,
close: EcoString,
}
cast! {
SmartQuoteSet,
self => array![self.open, self.close].into_value(),
value: Array => {
let [open, close] = array_to_set(value)?;
Self { open, close }
},
value: Str => {
let [open, close] = str_to_set(value.as_str())?;
Self { open, close }
},
}
fn str_to_set(value: &str) -> StrResult<[EcoString; 2]> {
let mut iter = value.graphemes(true);
match (iter.next(), iter.next(), iter.next()) {
(Some(open), Some(close), None) => Ok([open.into(), close.into()]),
_ => {
let count = value.graphemes(true).count();
bail!(
"expected 2 characters, found {count} character{}",
if count > 1 { "s" } else { "" }
);
}
}
}
fn array_to_set(value: Array) -> StrResult<[EcoString; 2]> {
let value = value.as_slice();
if value.len() != 2 {
bail!(
"expected 2 quotes, found {} quote{}",
value.len(),
if value.len() > 1 { "s" } else { "" }
);
}
let open: EcoString = value[0].clone().cast()?;
let close: EcoString = value[1].clone().cast()?;
Ok([open, close])
}
/// A dict of single and double quotes.
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub struct SmartQuoteDict {
double: Smart<SmartQuoteSet>,
single: Smart<SmartQuoteSet>,
}
cast! {
SmartQuoteDict,
self => dict! { "double" => self.double, "single" => self.single }.into_value(),
mut value: Dict => {
let keys = ["double", "single"];
let double = value
.take("double")
.ok()
.map(FromValue::from_value)
.transpose()?
.unwrap_or(Smart::Auto);
let single = value
.take("single")
.ok()
.map(FromValue::from_value)
.transpose()?
.unwrap_or(Smart::Auto);
value.finish(&keys)?;
Self { single, double }
},
value: SmartQuoteSet => Self {
double: Smart::Custom(value),
single: Smart::Auto,
},
}