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
|
//! Title occurs in [definition][] and [label end][label_end].
//!
//! They’re formed with the following BNF:
//!
//! ```bnf
//! ; Restriction: no blank lines.
//! ; Restriction: markers must match (in case of `(` with `)`).
//! title ::= marker [ *( code - '\\' | '\\' [ marker ] ) ] marker
//! marker ::= '"' | '\'' | '('
//! ```
//!
//! Titles can be double quoted (`"a"`), single quoted (`'a'`), or
//! parenthesized (`(a)`).
//!
//! Titles can contain line endings and whitespace, but they are not allowed to
//! contain blank lines.
//! They are allowed to be blank themselves.
//!
//! The title is interpreted as the [string][] content type.
//! That means that [character escapes][character_escape] and
//! [character references][character_reference] are allowed.
//!
//! ## References
//!
//! * [`micromark-factory-title/index.js` in `micromark`](https://github.com/micromark/micromark/blob/main/packages/micromark-factory-title/dev/index.js)
//!
//! [definition]: crate::construct::definition
//! [string]: crate::content::string
//! [character_escape]: crate::construct::character_escape
//! [character_reference]: crate::construct::character_reference
//! [label_end]: crate::construct::label_end
use super::partial_space_or_tab::{space_or_tab_eol_with_options, EolOptions};
use crate::subtokenize::link;
use crate::token::Token;
use crate::tokenizer::{Code, ContentType, State, StateFnResult, Tokenizer};
/// Configuration.
///
/// You must pass the token types in that are used.
#[derive(Debug)]
pub struct Options {
/// Token for the whole title.
pub title: Token,
/// Token for the marker.
pub marker: Token,
/// Token for the string inside the quotes.
pub string: Token,
}
/// Type of title.
#[derive(Debug, PartialEq)]
enum Kind {
/// In a parenthesized (`(` and `)`) title.
///
/// ## Example
///
/// ```markdown
/// (a)
/// ```
Paren,
/// In a double quoted (`"`) title.
///
/// ## Example
///
/// ```markdown
/// "a"
/// ```
Double,
/// In a single quoted (`'`) title.
///
/// ## Example
///
/// ```markdown
/// 'a'
/// ```
Single,
}
impl Kind {
/// Turn the kind into a [char].
///
/// > 👉 **Note**: a closing paren is used for `Kind::Paren`.
fn as_char(&self) -> char {
match self {
Kind::Paren => ')',
Kind::Double => '"',
Kind::Single => '\'',
}
}
/// Turn a [char] into a kind.
///
/// > 👉 **Note**: an opening paren must be used for `Kind::Paren`.
///
/// ## Panics
///
/// Panics if `char` is not `(`, `"`, or `'`.
fn from_char(char: char) -> Kind {
match char {
'(' => Kind::Paren,
'"' => Kind::Double,
'\'' => Kind::Single,
_ => unreachable!("invalid char"),
}
}
/// Turn [Code] into a kind.
///
/// > 👉 **Note**: an opening paren must be used for `Kind::Paren`.
///
/// ## Panics
///
/// Panics if `code` is not `Code::Char('(' | '"' | '\'')`.
fn from_code(code: Code) -> Kind {
match code {
Code::Char(char) => Kind::from_char(char),
_ => unreachable!("invalid code"),
}
}
}
/// State needed to parse titles.
#[derive(Debug)]
struct Info {
/// Whether we’ve seen data.
connect: bool,
/// Kind of title.
kind: Kind,
/// Configuration.
options: Options,
}
/// Before a title.
///
/// ```markdown
/// > | "a"
/// ^
/// ```
pub fn start(tokenizer: &mut Tokenizer, code: Code, options: Options) -> StateFnResult {
match code {
Code::Char('"' | '\'' | '(') => {
let info = Info {
connect: false,
kind: Kind::from_code(code),
options,
};
tokenizer.enter(info.options.title.clone());
tokenizer.enter(info.options.marker.clone());
tokenizer.consume(code);
tokenizer.exit(info.options.marker.clone());
(State::Fn(Box::new(|t, c| begin(t, c, info))), None)
}
_ => (State::Nok, None),
}
}
/// After the opening marker.
///
/// This is also used when at the closing marker.
///
/// ```markdown
/// > | "a"
/// ^
/// ```
fn begin(tokenizer: &mut Tokenizer, code: Code, info: Info) -> StateFnResult {
match code {
Code::Char(char) if char == info.kind.as_char() => {
tokenizer.enter(info.options.marker.clone());
tokenizer.consume(code);
tokenizer.exit(info.options.marker.clone());
tokenizer.exit(info.options.title);
(State::Ok, None)
}
_ => {
tokenizer.enter(info.options.string.clone());
at_break(tokenizer, code, info)
}
}
}
/// At something, before something else.
///
/// ```markdown
/// > | "a"
/// ^
/// ```
fn at_break(tokenizer: &mut Tokenizer, code: Code, mut info: Info) -> StateFnResult {
match code {
Code::Char(char) if char == info.kind.as_char() => {
tokenizer.exit(info.options.string.clone());
begin(tokenizer, code, info)
}
Code::None => (State::Nok, None),
Code::CarriageReturnLineFeed | Code::Char('\n' | '\r') => tokenizer.go(
space_or_tab_eol_with_options(EolOptions {
content_type: Some(ContentType::String),
connect: info.connect,
}),
|t, c| {
info.connect = true;
at_break(t, c, info)
},
)(tokenizer, code),
_ => {
tokenizer.enter_with_content(Token::Data, Some(ContentType::String));
if info.connect {
let index = tokenizer.events.len() - 1;
link(&mut tokenizer.events, index);
} else {
info.connect = true;
}
title(tokenizer, code, info)
}
}
}
/// In title text.
///
/// ```markdown
/// > | "a"
/// ^
/// ```
fn title(tokenizer: &mut Tokenizer, code: Code, info: Info) -> StateFnResult {
match code {
Code::Char(char) if char == info.kind.as_char() => {
tokenizer.exit(Token::Data);
at_break(tokenizer, code, info)
}
Code::None | Code::CarriageReturnLineFeed | Code::Char('\n' | '\r') => {
tokenizer.exit(Token::Data);
at_break(tokenizer, code, info)
}
Code::Char('\\') => {
tokenizer.consume(code);
(State::Fn(Box::new(|t, c| escape(t, c, info))), None)
}
_ => {
tokenizer.consume(code);
(State::Fn(Box::new(|t, c| title(t, c, info))), None)
}
}
}
/// After `\`, in title text.
///
/// ```markdown
/// > | "a\*b"
/// ^
/// ```
fn escape(tokenizer: &mut Tokenizer, code: Code, info: Info) -> StateFnResult {
match code {
Code::Char(char) if char == info.kind.as_char() => {
tokenizer.consume(code);
(State::Fn(Box::new(|t, c| title(t, c, info))), None)
}
_ => title(tokenizer, code, info),
}
}
|
