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
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
use std::rc::Rc;
use crate::error::{RableError, Result};
use crate::token::{Token, TokenType};
mod brace_expansion;
mod expansions;
pub mod heredoc;
mod operators;
mod quotes;
pub mod word_builder;
mod words;
#[cfg(test)]
mod tests;
pub use heredoc::PendingHereDoc;
/// Immutable lexer configuration set at construction time.
#[derive(Debug, Clone, Copy)]
struct LexerConfig {
/// Whether extended glob patterns `@()`, `?()`, `*()`, `+()`, `!()` are enabled.
extglob: bool,
}
/// Mutable context flags the parser uses to inform the lexer.
/// Private — the parser interacts via methods on `Lexer`.
#[derive(Debug, Clone)]
pub struct LexerContext {
/// At command start position — reserved words are recognized.
pub command_start: bool,
/// Inside a `[[ ]]` conditional expression.
pub cond_expr: bool,
}
impl Default for LexerContext {
fn default() -> Self {
Self {
command_start: true,
cond_expr: false,
}
}
}
/// Hand-written context-sensitive lexer for bash.
pub struct Lexer {
input: Rc<[char]>,
pos: usize,
line: usize,
peeked: Option<Token>,
config: LexerConfig,
pub(crate) ctx: LexerContext,
/// Pending here-documents to be read after the next newline.
pub pending_heredocs: Vec<PendingHereDoc>,
/// Completed here-document contents (filled after newline).
pub heredoc_contents: Vec<String>,
/// End position (char index) of the most recently consumed token.
last_token_end: usize,
/// Which nested construct, if any, this lexer is a fork of.
/// See [`LexerMode`] for the per-mode behaviour.
mode: LexerMode,
/// Mirror of the owning `Parser::depth`, synced by `Parser::enter`
/// and `Parser::leave`. Read by `read_command_sub` so forked inner
/// parsers start at the outer depth — without this, nested `$(...)`
/// could blow the native stack before hitting `MAX_DEPTH`.
parser_depth: usize,
}
/// Which nested construct the lexer is parsing, if any.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LexerMode {
/// Top-level lexer, or a fork that is not inside a nested construct.
Normal,
/// Fork running inside a `$(...)` command substitution. Makes
/// `read_heredoc_body` accept a trailing close-paren on the
/// heredoc delimiter line and rewind it into the input so the
/// outer scanner or the fork's own grammar can consume it.
Cmdsub,
/// Fork running inside a backtick command substitution. Makes
/// `at_end` report end-of-input on a raw backtick so the forked
/// parser terminates at the closing delimiter. Backslash escape
/// pairs inside the body are consumed as two literal chars by
/// the word reader's existing backslash-escape branch, which
/// preserves the raw source slice that the outer lexer copies
/// back into `wb.value`.
Backtick,
}
impl Lexer {
// -- State API for parser --
/// Signal that the next word position is a command start.
pub const fn set_command_start(&mut self) {
self.ctx.command_start = true;
}
/// Signal entering a `[[ ]]` conditional expression context.
pub const fn enter_cond_expr(&mut self) {
self.ctx.cond_expr = true;
}
/// Signal leaving a `[[ ]]` conditional expression context.
pub const fn leave_cond_expr(&mut self) {
self.ctx.cond_expr = false;
}
}
impl Lexer {
pub fn new(source: &str, extglob: bool) -> Self {
Self {
input: source.chars().collect::<Vec<_>>().into(),
pos: 0,
line: 1,
peeked: None,
config: LexerConfig { extglob },
ctx: LexerContext::default(),
pending_heredocs: Vec::new(),
heredoc_contents: Vec::new(),
last_token_end: 0,
mode: LexerMode::Normal,
parser_depth: 0,
}
}
/// Forks a new lexer seeded at the current position, sharing the
/// source buffer. Fresh token/heredoc state. `mode` selects the
/// kind of nested construct the fork is parsing.
pub(crate) fn fork(&self, mode: LexerMode) -> Self {
Self {
input: Rc::clone(&self.input),
pos: self.pos,
line: self.line,
peeked: None,
config: self.config,
ctx: LexerContext::default(),
pending_heredocs: Vec::new(),
heredoc_contents: Vec::new(),
last_token_end: self.pos,
mode,
parser_depth: self.parser_depth,
}
}
pub(crate) const fn parser_depth(&self) -> usize {
self.parser_depth
}
pub(crate) const fn set_parser_depth(&mut self, depth: usize) {
self.parser_depth = depth;
}
/// Consumes the terminating `` ` `` byte at the end of a backtick
/// fork. Bypasses `at_end` (which returns true on that byte in
/// backtick mode). Only called by `parse_backtick_body`.
pub(crate) fn exit_backtick_fork(&mut self) -> Result<()> {
if self.input.get(self.pos).copied() != Some('`') {
return Err(RableError::matched_pair(
"unterminated backtick",
self.pos,
self.line,
));
}
self.pos += 1;
Ok(())
}
/// Returns the current position.
pub const fn pos(&self) -> usize {
self.pos
}
/// Returns the end position (char index) of the most recently consumed token.
pub const fn last_token_end(&self) -> usize {
self.last_token_end
}
/// Returns the current line number.
pub const fn line(&self) -> usize {
self.line
}
/// Returns the total input length.
pub fn input_len(&self) -> usize {
self.input.len()
}
/// Returns the character right after the current position (after peeked token).
/// Used to detect `((` — the first `(` is peeked as `LeftParen`,
/// and we check if the next raw character is also `(`.
pub fn char_after_peeked(&self) -> Option<char> {
// The peeked token consumed `(` at self.pos-1 (or wherever)
// We need to check the char at the current pos
self.input.get(self.pos).copied()
}
/// Returns true if at end of input.
pub fn at_end(&self) -> bool {
self.pos >= self.input.len()
}
/// Peeks at the current character without advancing.
fn peek_char(&self) -> Option<char> {
self.input.get(self.pos).copied()
}
/// Advances one character and returns it.
fn advance_char(&mut self) -> Option<char> {
let ch = self.input.get(self.pos).copied();
if let Some(c) = ch {
self.pos += 1;
if c == '\n' {
self.line += 1;
}
}
ch
}
/// Returns true if the fork is sitting on its closing delimiter
/// (raw backtick byte in backtick mode). Used by `read_token` to
/// emit `Eof` and by `read_word_token` to terminate word reading.
pub(crate) fn at_backtick_terminator(&self) -> bool {
self.mode == LexerMode::Backtick && self.input.get(self.pos).copied() == Some('`')
}
/// Skips blanks (spaces and tabs) and line continuations (`\<newline>`).
fn skip_blanks(&mut self) {
loop {
match self.peek_char() {
Some(' ' | '\t') => {
self.advance_char();
}
Some('\\') => {
// Line continuation: \<newline> → skip both
if self.input.get(self.pos + 1) == Some(&'\n') {
self.advance_char(); // skip \
self.advance_char(); // skip \n
} else {
break;
}
}
_ => break,
}
}
}
/// Skips a comment (from `#` to end of line).
fn skip_comment(&mut self) {
while let Some(c) = self.peek_char() {
if c == '\n' {
break;
}
self.advance_char();
}
}
/// Returns the next token, consuming it.
///
/// # Errors
///
/// Returns `RableError` on unterminated quotes or unexpected input.
pub fn next_token(&mut self) -> Result<Token> {
let tok = if let Some(tok) = self.peeked.take() {
tok
} else {
self.read_token()?
};
self.last_token_end = tok.pos + tok.value.len();
Ok(tok)
}
/// Peeks at the next token without consuming it.
///
/// # Errors
///
/// Returns `RableError` on unterminated quotes or unexpected input.
pub fn peek_token(&mut self) -> Result<&Token> {
if self.peeked.is_none() {
let tok = self.read_token()?;
self.peeked = Some(tok);
}
// SAFETY: we just set it above
self.peeked
.as_ref()
.ok_or_else(|| RableError::parse("unexpected end of input", self.pos, self.line))
}
/// Core tokenization: reads the next token from input.
fn read_token(&mut self) -> Result<Token> {
self.skip_blanks();
// Backtick fork: the closing `` ` `` is end-of-input for the
// forked parser's token stream. The byte is consumed by
// `Lexer::exit_backtick_fork` after `parse_list` returns.
if self.at_backtick_terminator() {
return Ok(Token::eof(self.pos, self.line));
}
// Skip comments — # starts a comment anywhere after whitespace
if self.peek_char() == Some('#') {
self.skip_comment();
self.skip_blanks();
}
if self.at_end() {
return Ok(Token::eof(self.pos, self.line));
}
let start = self.pos;
let line = self.line;
let ch = self
.peek_char()
.ok_or_else(|| RableError::parse("unexpected end of input", self.pos, self.line))?;
match ch {
'\n' => {
self.advance_char();
self.ctx.command_start = true;
// Read any pending here-documents after the newline
if !self.pending_heredocs.is_empty() {
self.read_pending_heredocs();
}
Ok(Token::new(TokenType::Newline, "\n", start, line))
}
'|' => self.read_pipe_operator(start, line),
'&' => self.read_ampersand_operator(start, line),
';' => self.read_semicolon_operator(start, line),
'(' => {
self.advance_char();
Ok(Token::new(TokenType::LeftParen, "(", start, line))
}
')' => {
self.advance_char();
Ok(Token::new(TokenType::RightParen, ")", start, line))
}
'<' => {
// Check for <( process substitution
if self.input.get(self.pos + 1) == Some(&'(') {
self.read_process_sub_word(start, line)
} else {
self.read_less_operator(start, line)
}
}
'>' => {
// Check for >( process substitution
if self.input.get(self.pos + 1) == Some(&'(') {
self.read_process_sub_word(start, line)
} else {
self.read_greater_operator(start, line)
}
}
_ => self.read_word_token(start, line),
}
}
/// Reads raw text until `))` for C-style for loops.
///
/// # Errors
///
/// Returns `RableError` if `))` is not found.
pub fn read_until_double_paren(&mut self) -> Result<String> {
// Clear any peeked token since we're reading raw
self.peeked = None;
let mut result = String::new();
let mut depth = 0i32;
loop {
match self.peek_char() {
Some(')') if depth == 0 => {
self.advance_char();
if self.peek_char() == Some(')') {
self.advance_char();
return Ok(result);
}
result.push(')');
}
Some('(') => {
self.advance_char();
depth += 1;
result.push('(');
}
Some(')') => {
self.advance_char();
depth -= 1;
result.push(')');
}
Some(c) => {
self.advance_char();
result.push(c);
}
None => {
return Err(RableError::matched_pair(
"unterminated ((",
self.pos,
self.line,
));
}
}
}
}
}