Skip to content

Parse optionals and repeats without regexes #1826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 15, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 54 additions & 25 deletions mdbook-spec/src/grammar/parser.rs
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ impl Parser<'_> {
return Ok(None);
};

let mut kind = if self.take_str("U+") {
let kind = if self.take_str("U+") {
self.parse_unicode()?
} else if self.input[self.index..]
.chars()
Expand Down Expand Up @@ -246,30 +246,13 @@ impl Parser<'_> {
} else {
return Ok(None);
};

static REPEAT_RE: LazyLock<Regex> =
LazyLock::new(|| Regex::new(r"^ ?(\*\?|\+\?|\?|\*|\+)").unwrap());
static RANGE_RE: LazyLock<Regex> =
LazyLock::new(|| Regex::new(r"^\{([0-9]+)?\.\.([0-9]+)?\}").unwrap());
if let Some(cap) = self.take_re(&REPEAT_RE) {
kind = match &cap[1] {
"?" => ExpressionKind::Optional(box_kind(kind)),
"*" => ExpressionKind::Repeat(box_kind(kind)),
"*?" => ExpressionKind::RepeatNonGreedy(box_kind(kind)),
"+" => ExpressionKind::RepeatPlus(box_kind(kind)),
"+?" => ExpressionKind::RepeatPlusNonGreedy(box_kind(kind)),
s => panic!("unexpected `{s}`"),
};
} else if let Some(cap) = self.take_re(&RANGE_RE) {
let a = cap.get(1).map(|m| m.as_str().parse::<u32>().unwrap());
let b = cap.get(2).map(|m| m.as_str().parse::<u32>().unwrap());
match (a, b) {
(Some(a), Some(b)) if b < a => bail!(self, "range {a}..{b} is malformed"),
_ => {}
}
kind = ExpressionKind::RepeatRange(box_kind(kind), a, b);
}

let kind = match self.peek() {
Some(b'?') => self.parse_optional(kind)?,
Some(b'*') => self.parse_repeat(kind)?,
Some(b'+') => self.parse_repeat_plus(kind)?,
Some(b'{') => self.parse_repeat_range(kind)?,
_ => kind,
};
let suffix = self.parse_suffix()?;
let footnote = self.parse_footnote()?;

Expand Down Expand Up @@ -370,6 +353,52 @@ impl Parser<'_> {
}
}

/// Parse `?` after expression.
fn parse_optional(&mut self, kind: ExpressionKind) -> Result<ExpressionKind> {
self.expect("?", "expected `?`")?;
Ok(ExpressionKind::Optional(box_kind(kind)))
}

/// Parse `*` | `*?` after expression.
fn parse_repeat(&mut self, kind: ExpressionKind) -> Result<ExpressionKind> {
self.expect("*", "expected `*`")?;
Ok(if self.take_str("?") {
ExpressionKind::RepeatNonGreedy(box_kind(kind))
} else {
ExpressionKind::Repeat(box_kind(kind))
})
}

/// Parse `+` | `+?` after expression.
fn parse_repeat_plus(&mut self, kind: ExpressionKind) -> Result<ExpressionKind> {
self.expect("+", "expected `+`")?;
Ok(if self.take_str("?") {
ExpressionKind::RepeatPlusNonGreedy(box_kind(kind))
} else {
ExpressionKind::RepeatPlus(box_kind(kind))
})
}

/// Parse `{a..}` | `{..b}` | `{a..b}` after expression.
fn parse_repeat_range(&mut self, kind: ExpressionKind) -> Result<ExpressionKind> {
self.expect("{", "expected `{`")?;
let a = self.take_while(&|x| x.is_ascii_digit());
let Ok(a) = (!a.is_empty()).then(|| a.parse::<u32>()).transpose() else {
bail!(self, "malformed range start");
};
self.expect("..", "expected `..`")?;
let b = self.take_while(&|x| x.is_ascii_digit());
let Ok(b) = (!b.is_empty()).then(|| b.parse::<u32>()).transpose() else {
bail!(self, "malformed range end");
};
match (a, b) {
(Some(a), Some(b)) if b < a => bail!(self, "range {a}..{b} is malformed"),
_ => {}
}
self.expect("}", "expected `}`")?;
Ok(ExpressionKind::RepeatRange(box_kind(kind), a, b))
}

fn parse_suffix(&mut self) -> Result<Option<String>> {
if !self.take_str(" _") {
return Ok(None);
Expand Down
2 changes: 1 addition & 1 deletion src/items/generics.md
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ r[items.generics.where]

r[items.generics.where.syntax]
```grammar,items
WhereClause -> `where` ( WhereClauseItem `,` )* WhereClauseItem ?
WhereClause -> `where` ( WhereClauseItem `,` )* WhereClauseItem?

WhereClauseItem ->
LifetimeWhereClauseItem
Expand Down
4 changes: 2 additions & 2 deletions src/patterns.md
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,7 @@ r[patterns.ident]

r[patterns.ident.syntax]
```grammar,patterns
IdentifierPattern -> `ref`? `mut`? IDENTIFIER (`@` PatternNoTopAlt ) ?
IdentifierPattern -> `ref`? `mut`? IDENTIFIER ( `@` PatternNoTopAlt )?
```

r[patterns.ident.intro]
Expand Down Expand Up @@ -704,7 +704,7 @@ r[patterns.struct.syntax]
```grammar,patterns
StructPattern ->
PathInExpression `{`
StructPatternElements ?
StructPatternElements?
`}`

StructPatternElements ->
Expand Down