relay_pattern/
lib.rs

1//! A glob like pattern used throught Relay and its APIs.
2//!
3//! # Behaviour
4//!
5//! A pattern is similar to a glob but without support for brace expansions and without any support
6//! for filesystem specific behaviour like platform dependent separators and file extension
7//! matching.
8//!
9//! By default a [`Pattern`] does not support any separator characters.
10//! For example `*` usually only matches up to the next path separator (often platform dependent),
11//! in a [`Pattern`] `*` matches all characters. Optional support for a single separator character
12//! is available.
13//!
14//! The empty glob `""` never matches.
15//!
16//! # Syntax
17//!
18//! Basic glob like syntax is supported with Unix style negations.
19//!
20//! * `?` matches any single character.
21//! * `*` matches any number of any characters, including none.
22//! * `[abc]` matches one character in the given bracket.
23//! * `[!abc]` matches one character that is not in the given bracket.
24//! * `[a-z]` matches one character in the given range.
25//! * `[!a-z]` matches one character that is not in the given range.
26//! * `{a,b}` matches any pattern within the alternation group.
27//! * `\` escapes any of the above special characters and treats it as a literal.
28//!
29//! # Complexity
30//!
31//! Patterns can be limited to a maximum complexity using [`PatternBuilder::max_complexity`].
32//! Complexity of a pattern is calculated by the amount of possible combinations created with
33//! alternations.
34//!
35//! For example, the pattern `{foo,bar}` has a complexity of 2, the pattern `{foo,bar}/{*.html,*.js,*.css}`
36//! has a complexity of `2 * 3`.
37//!
38//! For untrusted user input it is highly recommended to limit the maximum complexity.
39
40use std::fmt;
41use std::num::NonZeroUsize;
42
43mod typed;
44mod wildmatch;
45
46pub use typed::*;
47
48/// Pattern parsing error.
49#[derive(Debug)]
50pub struct Error {
51    pattern: String,
52    kind: ErrorKind,
53}
54
55#[derive(Debug)]
56enum ErrorKind {
57    /// The specified range is invalid. The `end` character is lexicographically
58    /// after the `start` character.
59    InvalidRange(char, char),
60    /// Unbalanced character class. The pattern contains unbalanced `[`, `]` characters.
61    UnbalancedCharacterClass,
62    /// Character class is invalid and cannot be parsed.
63    InvalidCharacterClass,
64    /// Nested alternates are not valid.
65    NestedAlternates,
66    /// Unbalanced alternates. The pattern contains unbalanced `{`, `}` characters.
67    UnbalancedAlternates,
68    /// Dangling escape character.
69    DanglingEscape,
70    /// The pattern's complexity exceeds the maximum allowed complexity.
71    Complexity {
72        complexity: u64,
73        max_complexity: u64,
74    },
75}
76
77impl std::error::Error for Error {}
78
79impl fmt::Display for Error {
80    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
81        write!(f, "Error parsing pattern '{}': ", self.pattern)?;
82        match &self.kind {
83            ErrorKind::InvalidRange(start, end) => {
84                write!(f, "Invalid character range `{start}-{end}`")
85            }
86            ErrorKind::UnbalancedCharacterClass => write!(f, "Unbalanced character class"),
87            ErrorKind::InvalidCharacterClass => write!(f, "Invalid character class"),
88            ErrorKind::NestedAlternates => write!(f, "Nested alternates"),
89            ErrorKind::UnbalancedAlternates => write!(f, "Unbalanced alternates"),
90            ErrorKind::DanglingEscape => write!(f, "Dangling escape"),
91            ErrorKind::Complexity { complexity, max_complexity } =>
92                write!(f, "Pattern complexity ({complexity}) exceeds maximum allowed complexity ({max_complexity})"),
93        }
94    }
95}
96
97/// `Pattern` represents a successfully parsed Relay pattern.
98#[derive(Debug, Clone)]
99pub struct Pattern {
100    pattern: String,
101    options: Options,
102    strategy: MatchStrategy,
103}
104
105impl Pattern {
106    /// Create a new [`Pattern`] from a string with the default settings.
107    pub fn new(pattern: &str) -> Result<Self, Error> {
108        Self::builder(pattern).build()
109    }
110
111    /// Create a new [`PatternBuilder`]. The builder can be used to adjust the
112    /// pattern settings.
113    pub fn builder(pattern: &str) -> PatternBuilder {
114        PatternBuilder {
115            pattern,
116            options: Options::default(),
117            max_complexity: u64::MAX,
118        }
119    }
120
121    /// Returns `true` if the pattern matches the passed string.
122    pub fn is_match(&self, haystack: &str) -> bool {
123        self.strategy.is_match(haystack, self.options)
124    }
125}
126
127impl fmt::Display for Pattern {
128    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
129        f.write_str(&self.pattern)
130    }
131}
132
133/// A collection of [`Pattern`]s sharing the same configuration.
134#[derive(Debug, Clone)]
135pub struct Patterns {
136    strategies: Vec<MatchStrategy>,
137    options: Options,
138}
139
140impl Patterns {
141    /// Creates an empty [`Patterns`] instance which never matches anything.
142    ///
143    /// ```
144    /// # use relay_pattern::Patterns;
145    /// let patterns = Patterns::empty();
146    ///
147    /// assert!(!patterns.is_match(""));
148    /// assert!(!patterns.is_match("foobar"));
149    /// ```
150    pub fn empty() -> Self {
151        Self {
152            strategies: Vec::new(),
153            options: Options::default(),
154        }
155    }
156
157    /// Returns a [`PatternsBuilder`].
158    pub fn builder() -> PatternsBuilder {
159        PatternsBuilder {
160            options: Options::default(),
161        }
162    }
163
164    /// Returns `true` if any of the contained patterns matches the passed string.
165    pub fn is_match(&self, haystack: &str) -> bool {
166        self.strategies
167            .iter()
168            .any(|s| s.is_match(haystack, self.options))
169    }
170
171    /// Returns `true` if this instance contains no patterns.
172    ///
173    /// An empty [`Patterns`] never matches any input.
174    pub fn is_empty(&self) -> bool {
175        self.strategies.is_empty()
176    }
177}
178
179/// A builder for a [`Pattern`].
180#[derive(Debug)]
181pub struct PatternBuilder<'a> {
182    pattern: &'a str,
183    max_complexity: u64,
184    options: Options,
185}
186
187impl PatternBuilder<'_> {
188    /// If enabled matches the pattern case insensitive.
189    ///
190    /// This is disabled by default.
191    pub fn case_insensitive(&mut self, enabled: bool) -> &mut Self {
192        self.options.case_insensitive = enabled;
193        self
194    }
195
196    /// Sets the max complexity for this pattern.
197    ///
198    /// Attempting to build a pattern with a complexity higher
199    /// than the maximum specified here will fail.
200    ///
201    /// Defaults to `u64::MAX`.
202    pub fn max_complexity(&mut self, max_complexity: u64) -> &mut Self {
203        self.max_complexity = max_complexity;
204        self
205    }
206
207    /// Build a new [`Pattern`] from the passed pattern and configured options.
208    pub fn build(&self) -> Result<Pattern, Error> {
209        let mut parser = Parser::new(self.pattern, self.options);
210        parser.parse().map_err(|kind| Error {
211            pattern: self.pattern.to_owned(),
212            kind,
213        })?;
214
215        if parser.complexity > self.max_complexity {
216            return Err(Error {
217                pattern: self.pattern.to_owned(),
218                kind: ErrorKind::Complexity {
219                    complexity: parser.complexity,
220                    max_complexity: self.max_complexity,
221                },
222            });
223        }
224
225        let strategy =
226            MatchStrategy::from_tokens(parser.tokens, self.options).map_err(|kind| Error {
227                pattern: self.pattern.to_owned(),
228                kind,
229            })?;
230
231        Ok(Pattern {
232            pattern: self.pattern.to_owned(),
233            options: self.options,
234            strategy,
235        })
236    }
237}
238
239/// A builder for a collection of [`Patterns`].
240#[derive(Debug)]
241pub struct PatternsBuilder {
242    options: Options,
243}
244
245impl PatternsBuilder {
246    /// If enabled matches the pattern case insensitive.
247    ///
248    /// This is disabled by default.
249    pub fn case_insensitive(&mut self, enabled: bool) -> &mut Self {
250        self.options.case_insensitive = enabled;
251        self
252    }
253
254    /// Returns a [`PatternsBuilderConfigured`] builder which allows adding patterns.
255    pub fn patterns(&mut self) -> PatternsBuilderConfigured {
256        PatternsBuilderConfigured {
257            strategies: Vec::new(),
258            options: self.options,
259        }
260    }
261
262    /// Adds a pattern to the builder and returns the resulting [`PatternsBuilderConfigured`].
263    pub fn add(&mut self, pattern: &str) -> Result<PatternsBuilderConfigured, Error> {
264        let mut builder = PatternsBuilderConfigured {
265            strategies: Vec::with_capacity(1),
266            options: self.options,
267        };
268        builder.add(pattern)?;
269        Ok(builder)
270    }
271}
272
273/// A [`PatternsBuilder`] with all options configured.
274///
275/// The second step after [`PatternsBuilder`].
276#[derive(Debug)]
277pub struct PatternsBuilderConfigured {
278    strategies: Vec<MatchStrategy>,
279    options: Options,
280}
281
282impl PatternsBuilderConfigured {
283    /// Adds a pattern to the builder.
284    pub fn add(&mut self, pattern: &str) -> Result<&mut Self, Error> {
285        let mut parser = Parser::new(pattern, self.options);
286        parser.parse().map_err(|kind| Error {
287            pattern: pattern.to_owned(),
288            kind,
289        })?;
290
291        let strategy =
292            MatchStrategy::from_tokens(parser.tokens, self.options).map_err(|kind| Error {
293                pattern: pattern.to_owned(),
294                kind,
295            })?;
296
297        self.strategies.push(strategy);
298
299        Ok(self)
300    }
301
302    /// Builds a [`Patterns`] from the contained patterns.
303    pub fn build(self) -> Patterns {
304        Patterns {
305            strategies: self.strategies,
306            options: self.options,
307        }
308    }
309
310    /// Returns [`Patterns`] containing all added patterns and removes them from the builder.
311    ///
312    /// The builder can still be used afterwards, it keeps the configuration.
313    pub fn take(&mut self) -> Patterns {
314        Patterns {
315            strategies: std::mem::take(&mut self.strategies),
316            options: self.options,
317        }
318    }
319}
320
321/// Options to influence [`Pattern`] matching behaviour.
322#[derive(Debug, Clone, Copy, Default)]
323struct Options {
324    case_insensitive: bool,
325}
326
327/// Matching strategy for a [`Pattern`].
328///
329/// Certain patterns can be matched more efficiently while the complex
330/// patterns fallback to [`wildmatch::is_match`].
331#[derive(Debug, Clone)]
332enum MatchStrategy {
333    /// The pattern is a single literal string.
334    ///
335    /// The stored string is converted to lowercase for case insensitive patterns.
336    ///
337    /// Example pattern: `foobar`.
338    Literal(Literal),
339    /// The pattern only has a single wildcard in the end and can be
340    /// matched with a simple prefix check.
341    ///
342    /// The stored string is converted to lowercase for case insensitive patterns.
343    ///
344    /// Example pattern: `foobar*`.
345    Prefix(Literal),
346    /// The pattern only has a single wildcard at the start and can be
347    /// matched with a simple suffix check.
348    ///
349    /// The stored string is converted to lowercase for case insensitive patterns.
350    ///
351    /// Example pattern: `*foobar`.
352    Suffix(Literal),
353    /// The pattern is surrounded with wildcards and contains a literal in the middle
354    /// and can be matched with a simple contains check.
355    ///
356    /// The stored string is converted to lowercase for case insensitive patterns.
357    ///
358    /// Example pattern: `*foobar*`.
359    Contains(Literal),
360    /// The pattern always evaluates to a static boolean.
361    ///
362    /// Example: `*`
363    Static(bool),
364    /// The pattern is complex and needs to be evaluated using [`wildmatch`].
365    Wildmatch(Tokens),
366    // Possible future optimizations for `Any` variations:
367    // Examples: `??`. `??suffix`, `prefix??` and `?contains?`.
368}
369
370impl MatchStrategy {
371    /// Create a [`MatchStrategy`] from [`Tokens`].
372    fn from_tokens(mut tokens: Tokens, _options: Options) -> Result<Self, ErrorKind> {
373        let s = match tokens.as_mut_slice() {
374            [] => Self::Static(false),
375            [Token::Wildcard] => Self::Static(true),
376            [Token::Literal(literal)] => Self::Literal(std::mem::take(literal)),
377            [Token::Literal(literal), Token::Wildcard] => Self::Prefix(std::mem::take(literal)),
378            [Token::Wildcard, Token::Literal(literal)] => Self::Suffix(std::mem::take(literal)),
379            [Token::Wildcard, Token::Literal(literal), Token::Wildcard] => {
380                Self::Contains(std::mem::take(literal))
381            }
382            _ => Self::Wildmatch(tokens),
383        };
384
385        Ok(s)
386    }
387
388    /// Returns `true` if the pattern matches the passed string.
389    pub fn is_match(&self, haystack: &str, options: Options) -> bool {
390        match &self {
391            MatchStrategy::Literal(literal) => match_literal(literal, haystack, options),
392            MatchStrategy::Prefix(prefix) => match_prefix(prefix, haystack, options),
393            MatchStrategy::Suffix(suffix) => match_suffix(suffix, haystack, options),
394            MatchStrategy::Contains(contains) => match_contains(contains, haystack, options),
395            MatchStrategy::Static(matches) => *matches,
396            MatchStrategy::Wildmatch(tokens) => wildmatch::is_match(haystack, tokens, options),
397        }
398    }
399}
400
401#[inline(always)]
402fn match_literal(literal: &Literal, haystack: &str, options: Options) -> bool {
403    if options.case_insensitive {
404        // Can't do an explicit len compare first here `literal.len() == haystack.len()`,
405        // the amount of characters can change when converting case.
406        let mut literal = literal.as_case_converted_str().chars();
407        let mut haystack = haystack.chars().flat_map(|c| c.to_lowercase());
408
409        loop {
410            match (literal.next(), haystack.next()) {
411                // Both iterators exhausted -> literal matches.
412                (None, None) => break true,
413                // Either iterator exhausted while the other one is not -> no match.
414                (None, _) | (_, None) => break false,
415                (Some(p), Some(h)) if p != h => break false,
416                _ => {}
417            }
418        }
419    } else {
420        literal.as_case_converted_str() == haystack
421    }
422}
423
424#[inline(always)]
425fn match_prefix(prefix: &Literal, haystack: &str, options: Options) -> bool {
426    if options.case_insensitive {
427        let mut prefix = prefix.as_case_converted_str().chars();
428        let mut haystack = haystack.chars().flat_map(|c| c.to_lowercase());
429
430        loop {
431            match (prefix.next(), haystack.next()) {
432                // If the prefix is exhausted it matched.
433                (None, _) => break true,
434                // If the haystack is exhausted, but the pattern is not -> no match.
435                (Some(_), None) => break false,
436                (Some(p), Some(h)) if p != h => break false,
437                _ => {}
438            }
439        }
440    } else {
441        haystack.starts_with(prefix.as_case_converted_str())
442    }
443}
444
445#[inline(always)]
446fn match_suffix(suffix: &Literal, haystack: &str, options: Options) -> bool {
447    if options.case_insensitive {
448        let mut suffix = suffix.as_case_converted_str().chars().rev();
449        let mut haystack = haystack.chars().flat_map(|c| c.to_lowercase()).rev();
450
451        loop {
452            match (suffix.next(), haystack.next()) {
453                // If the prefix is exhausted it matched.
454                (None, _) => break true,
455                // If the haystack is exhausted, but the pattern is not -> no match.
456                (Some(_), None) => break false,
457                (Some(s), Some(h)) if s != h => break false,
458                _ => {}
459            }
460        }
461    } else {
462        haystack.ends_with(suffix.as_case_converted_str())
463    }
464}
465
466#[inline(always)]
467fn match_contains(contains: &Literal, haystack: &str, options: Options) -> bool {
468    if options.case_insensitive {
469        let haystack = haystack.to_lowercase();
470        memchr::memmem::find(haystack.as_bytes(), contains.as_case_converted_bytes()).is_some()
471    } else {
472        memchr::memmem::find(haystack.as_bytes(), contains.as_case_converted_bytes()).is_some()
473    }
474}
475
476struct Parser<'a> {
477    chars: std::iter::Peekable<std::str::Chars<'a>>,
478    tokens: Tokens,
479    alternates: Option<Vec<Tokens>>,
480    current_literal: Option<String>,
481    options: Options,
482    complexity: u64,
483}
484
485impl<'a> Parser<'a> {
486    fn new(pattern: &'a str, options: Options) -> Self {
487        Self {
488            chars: pattern.chars().peekable(),
489            tokens: Default::default(),
490            alternates: None,
491            current_literal: None,
492            options,
493            complexity: 0,
494        }
495    }
496
497    fn parse(&mut self) -> Result<(), ErrorKind> {
498        while let Some(c) = self.advance() {
499            match c {
500                '?' => self.push_token(Token::Any(NonZeroUsize::MIN)),
501                '*' => self.push_token(Token::Wildcard),
502                '[' => self.parse_class()?,
503                ']' => return Err(ErrorKind::UnbalancedCharacterClass),
504                '{' => self.start_alternates()?,
505                '}' => self.end_alternates()?,
506                '\\' => match self.advance() {
507                    Some(c) => self.push_literal(c),
508                    None => return Err(ErrorKind::DanglingEscape),
509                },
510                ',' if self.alternates.is_some() => {
511                    self.finish_literal();
512                    // safe to unwrap, we just checked for `some`.
513                    let alternates = self.alternates.as_mut().unwrap();
514                    alternates.push(Tokens::default());
515                }
516                c => self.push_literal(c),
517            }
518        }
519
520        // Finish off the parsing with creating a token for any remaining literal buffered.
521        self.finish_literal();
522
523        Ok(())
524    }
525
526    fn start_alternates(&mut self) -> Result<(), ErrorKind> {
527        if self.alternates.is_some() {
528            return Err(ErrorKind::NestedAlternates);
529        }
530        self.finish_literal();
531        self.alternates = Some(vec![Tokens::default()]);
532        Ok(())
533    }
534
535    fn end_alternates(&mut self) -> Result<(), ErrorKind> {
536        self.finish_literal();
537        match self.alternates.take() {
538            None => return Err(ErrorKind::UnbalancedAlternates),
539            Some(alternates) => {
540                if !alternates.is_empty() {
541                    self.complexity = self
542                        .complexity
543                        .max(1)
544                        .saturating_mul(alternates.len() as u64);
545                    self.push_token(Token::Alternates(alternates));
546                }
547            }
548        }
549
550        Ok(())
551    }
552
553    fn parse_class(&mut self) -> Result<(), ErrorKind> {
554        let negated = self.advance_if(|c| c == '!');
555
556        let mut ranges = Ranges::default();
557
558        let mut first = true;
559        let mut in_range = false;
560        loop {
561            let Some(c) = self.advance() else {
562                return Err(ErrorKind::UnbalancedCharacterClass);
563            };
564
565            match c {
566                // Another opening bracket is invalid, literal `[` need to be escaped.
567                '[' => return Err(ErrorKind::InvalidCharacterClass),
568                ']' => break,
569                '-' => {
570                    if first {
571                        ranges.push(Range::single('-'));
572                    } else if in_range {
573                        // safe to unwrap, `in_range` is only true if there is already
574                        // a range pushed.
575                        ranges.last_mut().unwrap().set_end('-')?;
576                        in_range = false;
577                    } else {
578                        assert!(!ranges.is_empty());
579                        in_range = true;
580                    }
581                }
582                c => {
583                    let c = match c {
584                        '\\' => self.advance().ok_or(ErrorKind::DanglingEscape)?,
585                        c => c,
586                    };
587
588                    if in_range {
589                        // safe to unwrap, `in_range` is only true if there is already
590                        // a range pushed.
591                        ranges.last_mut().unwrap().set_end(c)?;
592                        in_range = false;
593                    } else {
594                        ranges.push(Range::single(c))
595                    }
596                }
597            }
598
599            first = false;
600        }
601
602        if in_range {
603            // A pattern which ends with a `-`.
604            ranges.push(Range::single('-'));
605        }
606
607        self.push_token(Token::Class { negated, ranges });
608
609        Ok(())
610    }
611
612    /// Pushes a new character into the currently active literal token.
613    ///
614    /// Starts a new literal token if there is none already.
615    fn push_literal(&mut self, c: char) {
616        self.current_literal.get_or_insert_with(String::new).push(c);
617    }
618
619    /// Finishes and pushes the currently in progress literal token.
620    fn finish_literal(&mut self) {
621        if let Some(literal) = self.current_literal.take() {
622            self.push_token(Token::Literal(Literal::new(literal, self.options)));
623        }
624    }
625
626    /// Pushes the passed `token` and finishes the currently in progress literal token.
627    fn push_token(&mut self, token: Token) {
628        self.finish_literal();
629        match self.alternates.as_mut() {
630            Some(alternates) => match alternates.last_mut() {
631                Some(tokens) => tokens.push(token),
632                None => {
633                    let mut tokens = Tokens::default();
634                    tokens.push(token);
635                    alternates.push(tokens);
636                }
637            },
638            None => self.tokens.push(token),
639        }
640    }
641
642    fn advance(&mut self) -> Option<char> {
643        self.chars.next()
644    }
645
646    fn advance_if(&mut self, matcher: impl FnOnce(char) -> bool) -> bool {
647        if self.peek().is_some_and(matcher) {
648            let _ = self.advance();
649            true
650        } else {
651            false
652        }
653    }
654
655    fn peek(&mut self) -> Option<char> {
656        self.chars.peek().copied()
657    }
658}
659
660/// A container of tokens.
661///
662/// Automatically folds redundant tokens.
663///
664/// The contained tokens are guaranteed to uphold the following invariants:
665/// - A [`Token::Wildcard`] is never followed by [`Token::Wildcard`].
666/// - A [`Token::Any`] is never followed by [`Token::Any`].
667/// - A [`Token::Literal`] is never followed by [`Token::Literal`].
668/// - A [`Token::Class`] is never empty.
669#[derive(Clone, Debug, Default)]
670struct Tokens(Vec<Token>);
671
672impl Tokens {
673    fn push(&mut self, mut token: Token) {
674        // Normalize / clean the token.
675        if let Token::Alternates(mut alternates) = token {
676            let mut contains_empty = false;
677            let mut contains_wildcard = false;
678            alternates.retain_mut(|alternate| {
679                if alternate.0.is_empty() {
680                    contains_empty = true;
681                    return false;
682                }
683
684                if matches!(alternate.0.as_slice(), [Token::Wildcard]) {
685                    contains_wildcard = true;
686                }
687
688                true
689            });
690
691            // At this point `alternates` contains only the nonempty branches
692            // and we additionally know
693            // * if one of the branches was just a wildcard
694            // * if there were any empty branches.
695            //
696            // We can push different tokens based on this.
697            if contains_wildcard {
698                // Case: {foo,*,} -> reduces to *
699                token = Token::Wildcard;
700            } else if alternates.len() == 1 {
701                if contains_empty {
702                    // Case: {foo*bar,} -> Optional(foo*bar)
703                    token = Token::Optional(alternates.remove(0));
704                } else {
705                    // Case: {foo*bar} -> remove the alternation and
706                    // push foo*bar directly
707                    for t in alternates.remove(0).0 {
708                        self.push(t);
709                    }
710                    return;
711                }
712            } else if alternates.len() > 1 {
713                if contains_empty {
714                    // Case: {foo,bar,} -> Optional({foo,bar})
715                    token = Token::Optional(Tokens(vec![Token::Alternates(alternates)]));
716                } else {
717                    // Case: {foo, bar} -> can stay as it is
718                    token = Token::Alternates(alternates);
719                }
720            } else {
721                // Case: {,,,} -> reduces to {}
722                return;
723            }
724        }
725
726        match (self.0.last_mut(), token) {
727            // Collapse Any's.
728            (Some(Token::Any(n)), Token::Any(n2)) => *n = n.saturating_add(n2.get()),
729            // We can collapse multiple wildcards into a single one.
730            // TODO: separator special handling (?)
731            (Some(Token::Wildcard), Token::Wildcard) => {}
732            // Collapse multiple literals into one.
733            (Some(Token::Literal(ref mut last)), Token::Literal(s)) => last.push(&s),
734            // Ignore empty class tokens.
735            (_, Token::Class { negated: _, ranges }) if ranges.is_empty() => {}
736            // Everything else is just another token.
737            (_, token) => self.0.push(token),
738        }
739    }
740
741    fn as_mut_slice(&mut self) -> &mut [Token] {
742        self.0.as_mut_slice()
743    }
744
745    fn as_slice(&self) -> &[Token] {
746        self.0.as_slice()
747    }
748}
749
750/// Represents a token in a Relay pattern.
751#[derive(Clone, Debug)]
752enum Token {
753    /// A literal token.
754    Literal(Literal),
755    /// The any token `?` and how many `?` are seen in a row.
756    Any(NonZeroUsize),
757    /// The wildcard token `*`.
758    Wildcard,
759    /// A class token `[abc]` or its negated variant `[!abc]`.
760    Class { negated: bool, ranges: Ranges },
761    /// A list of nested alternate tokens `{a,b}`.
762    Alternates(Vec<Tokens>),
763    /// A list of optional tokens.
764    ///
765    /// This has no syntax of its own, it's parsed
766    /// from alternatives containing empty branches
767    /// like `{a,b,}`.
768    Optional(Tokens),
769}
770
771/// A string literal.
772///
773/// The contained literal is only available as a case converted string.
774/// Depending on whether the pattern is case sensitive or case insensitive the literal is either
775/// the original string or converted to lowercase.
776#[derive(Clone, Debug, Default)]
777struct Literal(String);
778
779impl Literal {
780    /// Creates a new literal from `s` and `options`.
781    fn new(s: String, options: Options) -> Self {
782        match options.case_insensitive {
783            false => Self(s),
784            true => Self(s.to_lowercase()),
785        }
786    }
787
788    /// Adds a literal to this literal.
789    ///
790    /// This function does not validate case conversion, both literals must be for the same caseing.
791    fn push(&mut self, Literal(other): &Literal) {
792        self.0.push_str(other);
793    }
794
795    /// Returns a reference to the case converted string.
796    fn as_case_converted_str(&self) -> &str {
797        &self.0
798    }
799
800    /// Returns a reference to the case converted string as bytes.
801    fn as_case_converted_bytes(&self) -> &[u8] {
802        self.as_case_converted_str().as_bytes()
803    }
804}
805
806/// A [`Range`] contains whatever is contained between `[` and `]` of
807/// a glob pattern, except the negation.
808///
809/// For example the pattern `[a-z]` contains the range from `a` to `z`,
810/// the pattern `[ax-zbf-h]` contains the ranges `x-z`, `f-h`, `a-a` and `b-b`.
811#[derive(Clone, Debug, Default)]
812enum Ranges {
813    /// An empty, default range not containing any characters.
814    ///
815    /// The empty range matches nothing.
816    #[default]
817    Empty,
818    /// The pattern only contains a single range.
819    ///
820    /// For example: `[a]` or `[a-z]`.
821    Single(Range),
822    /// The pattern contains more than one range.
823    ///
824    /// The `Empty` and `Single` states are just explicit and optimized
825    /// cases for `Multiple` with a vector containing zero or just one range.
826    Multiple(Vec<Range>),
827}
828
829impl Ranges {
830    /// Pushes another range into the current [`Range`].
831    ///
832    /// Returns [`Error`] if the range starts with a lexicographically larger character than it
833    /// ends with.
834    fn push(&mut self, range: Range) {
835        match self {
836            Self::Empty => *self = Self::Single(range),
837            Self::Single(single) => *self = Self::Multiple(vec![*single, range]),
838            Self::Multiple(ref mut v) => v.push(range),
839        }
840    }
841
842    /// Returns a mutable reference to the last range contained.
843    fn last_mut(&mut self) -> Option<&mut Range> {
844        match self {
845            Ranges::Empty => None,
846            Ranges::Single(range) => Some(range),
847            Ranges::Multiple(ranges) => ranges.last_mut(),
848        }
849    }
850
851    /// Returns `true` if there is no contained range.
852    fn is_empty(&self) -> bool {
853        match self {
854            Ranges::Empty => true,
855            Ranges::Single(_) => false,
856            Ranges::Multiple(ranges) => {
857                // While not technically wrong, the invariant should uphold.
858                debug_assert!(!ranges.is_empty());
859                ranges.is_empty()
860            }
861        }
862    }
863
864    /// Returns `true` if the character `c` is contained matches any contained range.
865    #[inline(always)]
866    fn contains(&self, c: char) -> bool {
867        // TODO: optimize this into a `starts_with` which gets a `&str`, this can be optimized to
868        // byte matches
869        match self {
870            Self::Empty => false,
871            Self::Single(range) => range.contains(c),
872            Self::Multiple(ranges) => ranges.iter().any(|range| range.contains(c)),
873        }
874    }
875}
876
877/// Represents a character range in a [`Token::Class`].
878#[derive(Clone, Copy, Debug)]
879struct Range {
880    start: char,
881    end: char,
882}
883
884impl Range {
885    /// Create a new range which matches a single character.
886    fn single(c: char) -> Self {
887        Self { start: c, end: c }
888    }
889
890    /// Changes the end of the range to a new character.
891    ///
892    /// Returns an error if the new end character is lexicographically before
893    /// the start character.
894    fn set_end(&mut self, end: char) -> Result<(), ErrorKind> {
895        if self.start > end {
896            return Err(ErrorKind::InvalidRange(self.start, end));
897        }
898        self.end = end;
899        Ok(())
900    }
901
902    /// Returns `true` if the character `c` is contained in the range.
903    #[inline(always)]
904    fn contains(&self, c: char) -> bool {
905        self.start <= c && c <= self.end
906    }
907}
908
909#[cfg(test)]
910mod tests {
911    use super::*;
912
913    macro_rules! assert_pattern {
914        ($pattern:expr, $s:expr $(,$options:tt)?) => {{
915            let mut pattern = Pattern::builder($pattern);
916            for opt in stringify!($($options)?).chars() {
917                match opt {
918                    'i' => { pattern.case_insensitive(true); }
919                    _ => {}
920                }
921            }
922            let pattern = pattern.build().unwrap();
923            assert!(
924                pattern.is_match($s),
925                "expected pattern '{}' to match '{}' - {pattern:?}",
926                $pattern,
927                $s
928            );
929        }};
930        ($pattern:expr, NOT $s:expr $(,$options:tt)?) => {{
931            let mut pattern = Pattern::builder($pattern);
932            for opt in stringify!($($options)?).chars() {
933                match opt {
934                    'i' => { pattern.case_insensitive(true); }
935                    _ => {}
936                }
937            }
938            let pattern = pattern.build().unwrap();
939            assert!(
940                !pattern.is_match($s),
941                "expected pattern '{}' to not match '{}' - {pattern:?}",
942                $pattern,
943                $s
944            );
945        }};
946    }
947
948    macro_rules! assert_strategy {
949        ($pattern:expr, $expected:pat) => {{
950            let pattern = Pattern::new($pattern).unwrap();
951            let kind = match &pattern.strategy {
952                MatchStrategy::Literal(_) => "Literal",
953                MatchStrategy::Prefix(_) => "Prefix",
954                MatchStrategy::Suffix(_) => "Suffix",
955                MatchStrategy::Contains(_) => "Contains",
956                MatchStrategy::Static(_) => "Static",
957                MatchStrategy::Wildmatch(_) => "Wildmatch",
958            };
959            assert_eq!(
960                kind,
961                stringify!($expected),
962                "expected pattern '{}' to have strategy '{}' - {pattern:?}",
963                $pattern,
964                stringify!($expected)
965            );
966        }};
967    }
968
969    macro_rules! assert_invalid {
970        ($pattern:expr) => {{
971            if let Ok(pattern) = Pattern::new($pattern) {
972                assert!(
973                    false,
974                    "expected pattern '{}' to not compile - {pattern:?}",
975                    $pattern
976                );
977            }
978        }};
979    }
980
981    #[test]
982    fn test_empty() {
983        assert_pattern!("", NOT "");
984        assert_pattern!("", NOT "foo");
985    }
986
987    #[test]
988    fn test_literal() {
989        assert_pattern!("foo", "foo");
990        assert_pattern!("foo", NOT "fOo");
991        assert_pattern!("foo", NOT "FOO");
992        assert_pattern!(r"f\{\}o", "f{}o");
993        assert_pattern!(r"f\}o", "f}o");
994        assert_pattern!(r"f\{o", "f{o");
995        assert_pattern!(r"f\{b,a,r\}o", "f{b,a,r}o");
996        assert_pattern!(r"f\\o", r"f\o");
997        assert_pattern!("fඞo", "fඞo");
998    }
999
1000    #[test]
1001    fn test_literal_case_insensitive() {
1002        assert_pattern!("foo", "foo", i);
1003        assert_pattern!("foo", "fOo", i);
1004        assert_pattern!("fOo", "Foo", i);
1005        assert_pattern!("İ", "i\u{307}", i);
1006        assert_pattern!("İ", "i̇", i);
1007    }
1008
1009    #[test]
1010    fn test_literal_strategy() {
1011        assert_strategy!("foo", Literal);
1012        assert_strategy!(r"f\{b,a,r\}o", Literal);
1013        assert_strategy!(r"f\\o", Literal);
1014        assert_strategy!("fඞo", Literal);
1015    }
1016
1017    #[test]
1018    fn test_prefix() {
1019        assert_pattern!("foo*", "foo___");
1020        assert_pattern!("foo*", "foo");
1021        assert_pattern!("foo**", "foo");
1022        assert_pattern!("foo*?*", NOT "foo");
1023        assert_pattern!("foo*?*", "foo_");
1024        assert_pattern!("foo*?*?", "foo_____");
1025        assert_pattern!("foo*?*?", NOT "foo");
1026        assert_pattern!("foo*?*?", "foo__");
1027        assert_pattern!("foo*?*?", "foo_____");
1028        assert_pattern!("foo**", "foo___");
1029        assert_pattern!("foo*?*", "foo___");
1030        assert_pattern!("foo*?*?", "foo___");
1031        assert_pattern!("foo*", "fooඞ");
1032        assert_pattern!("ඞ*", "ඞfoo");
1033        assert_pattern!("foo*", NOT "___");
1034        assert_pattern!("foo*", NOT "fo");
1035        assert_pattern!("foo*", NOT "fob");
1036        assert_pattern!("foo*", NOT "boo");
1037        assert_pattern!("foo*", NOT "Foo");
1038        assert_pattern!("foo*", NOT "FOO___");
1039
1040        // No special slash handling
1041        assert_pattern!("foo/bar*", "foo/bar___");
1042        assert_pattern!("foo*", "foo/bar___");
1043        assert_pattern!("foo*", NOT "/foo");
1044    }
1045
1046    #[test]
1047    fn test_prefix_case_insensitive() {
1048        assert_pattern!("foo*", "foo___", i);
1049        assert_pattern!("foo*", "fOo___", i);
1050        assert_pattern!("foo*", "FOO___", i);
1051        assert_pattern!("fOo*", "FOO___", i);
1052        assert_pattern!("fOo*", "Foo___", i);
1053
1054        assert_pattern!("İ*", "İ___", i);
1055        assert_pattern!("İ*", "İ", i);
1056        assert_pattern!("İ*", "i̇", i);
1057        assert_pattern!("İ*", "i\u{307}___", i);
1058        assert_pattern!("İ*", NOT "i____", i);
1059    }
1060
1061    #[test]
1062    fn test_prefix_strategy() {
1063        assert_strategy!("foo*", Prefix);
1064        assert_strategy!("foo**", Prefix);
1065        assert_strategy!("foo?*", Wildmatch);
1066    }
1067
1068    #[test]
1069    fn test_suffix() {
1070        assert_pattern!("*foo", "___foo");
1071        assert_pattern!("*foo", "foo");
1072        assert_pattern!("**foo", "foo");
1073        assert_pattern!("*?*foo", NOT "foo");
1074        assert_pattern!("*?*foo", "_foo");
1075        assert_pattern!("*?*foo", "_____foo");
1076        assert_pattern!("?*?*foo", NOT "foo");
1077        assert_pattern!("?*?*foo", NOT "_foo");
1078        assert_pattern!("?*?*foo", "__foo");
1079        assert_pattern!("?*?*foo", "_____foo");
1080        assert_pattern!("**foo", "___foo");
1081        assert_pattern!("*?*foo", "___foo");
1082        assert_pattern!("*?*?foo", "__foo");
1083        assert_pattern!("*foo", "ඞfoo");
1084        assert_pattern!("*ඞ", "fooඞ");
1085        assert_pattern!("*foo", NOT "bar");
1086        assert_pattern!("*foo", NOT "fo");
1087        assert_pattern!("*foo", NOT "fob");
1088        assert_pattern!("*foo", NOT "boo");
1089        assert_pattern!("*foo", NOT "Foo");
1090        assert_pattern!("*foo", NOT "___FOO");
1091
1092        // No special slash handling
1093        assert_pattern!("*foo/bar", "___foo/bar");
1094        assert_pattern!("*bar", "___foo/bar");
1095        assert_pattern!("*foo", NOT "foo/");
1096    }
1097
1098    #[test]
1099    fn test_suffix_case_insensitive() {
1100        assert_pattern!("foo*", "foo___", i);
1101        assert_pattern!("foo*", "fOo___", i);
1102        assert_pattern!("foo*", "FOO___", i);
1103        assert_pattern!("fOo*", "FOO___", i);
1104        assert_pattern!("fOo*", "Foo___", i);
1105
1106        assert_pattern!("*İ", "___İ", i);
1107        assert_pattern!("*İ", "İ", i);
1108        assert_pattern!("*İ", "i̇", i);
1109        assert_pattern!("*İ", "___i\u{307}", i);
1110        assert_pattern!("*İ", NOT "___i", i);
1111    }
1112
1113    #[test]
1114    fn test_suffix_strategy() {
1115        assert_strategy!("*foo", Suffix);
1116        assert_strategy!("**foo", Suffix);
1117        assert_strategy!("*?foo", Wildmatch);
1118    }
1119
1120    #[test]
1121    fn test_contains() {
1122        assert_pattern!("*foo*", "foo");
1123        assert_pattern!("*foo*", "foo___");
1124        assert_pattern!("*foo*", "___foo");
1125        assert_pattern!("*foo*", "___foo___");
1126        assert_pattern!("*foo*", NOT "___fo");
1127        assert_pattern!("*foo*", NOT "oo___");
1128        assert_pattern!("*foo*", NOT "___fo___");
1129        assert_pattern!("*foo*", NOT "fඞo");
1130        assert_pattern!("*foo*", NOT "___fOo___");
1131        assert_pattern!("*foo*", NOT "___FOO___");
1132
1133        // No special slash handling
1134        assert_pattern!("*foo*", "foo");
1135        assert_pattern!("*foo*", "foo_/_");
1136        assert_pattern!("*foo*", "_/_foo");
1137        assert_pattern!("*foo*", "_/_foo_/_");
1138        assert_pattern!("*f/o*", "_/_f/o_/_");
1139    }
1140
1141    #[test]
1142    fn test_contains_case_insensitive() {
1143        assert_pattern!("*foo*", "foo", i);
1144        assert_pattern!("*foo*", "fOo", i);
1145        assert_pattern!("*fOo*", "Foo", i);
1146        assert_pattern!("*foo*", "___foo___", i);
1147        assert_pattern!("*foo*", "___fOo___", i);
1148        assert_pattern!("*foo*", "___FOO___", i);
1149        assert_pattern!("*fOo*", "___FOO___", i);
1150        assert_pattern!("*fOo*", "___Foo___", i);
1151
1152        assert_pattern!("*İ*", "___İ___", i);
1153        assert_pattern!("*İ*", "İ", i);
1154        assert_pattern!("*İ*", "___İ", i);
1155        assert_pattern!("*İ*", "İ___", i);
1156        assert_pattern!("*İ*", "___İ___", i);
1157        assert_pattern!("*İ*", "i̇", i);
1158        assert_pattern!("*İ*", "___i̇", i);
1159        assert_pattern!("*İ*", "i̇___", i);
1160        assert_pattern!("*İ*", "___i̇___", i);
1161        assert_pattern!("*İ*", "___i\u{307}", i);
1162        assert_pattern!("*İ*", "i\u{307}___", i);
1163        assert_pattern!("*İ*", "___i\u{307}___", i);
1164        assert_pattern!("*İ*", NOT "i", i);
1165        assert_pattern!("*İ*", NOT "i___", i);
1166        assert_pattern!("*İ*", NOT "___i", i);
1167        assert_pattern!("*İ*", NOT "___i___", i);
1168    }
1169
1170    #[test]
1171    fn test_contains_strategy() {
1172        assert_strategy!("*foo*", Contains);
1173        assert_strategy!("**foo**", Contains);
1174        assert_strategy!("*?foo*", Wildmatch);
1175        assert_strategy!("*foo?*", Wildmatch);
1176        assert_strategy!("*foo*?", Wildmatch);
1177        assert_strategy!("?*foo*", Wildmatch);
1178    }
1179
1180    #[test]
1181    fn test_wildcard() {
1182        assert_pattern!("*", "");
1183        assert_pattern!("*", "a");
1184        assert_pattern!("*", "\n");
1185        assert_pattern!("*", "\n\n");
1186        assert_pattern!("*", "\na\n");
1187        assert_pattern!("*", "\na\nb\nc");
1188        assert_pattern!("*", "ඞfooඞfooඞ");
1189
1190        // No special slash handling
1191        assert_pattern!("*", "/");
1192        assert_pattern!("*", "_/");
1193        assert_pattern!("*", "/_");
1194        assert_pattern!("*", "_/_");
1195        assert_pattern!("*", "/?/?/");
1196    }
1197
1198    #[test]
1199    fn test_wildcard_strategy() {
1200        assert_strategy!("*", Static);
1201        assert_strategy!("{*}", Static);
1202        assert_strategy!("{*,}", Static);
1203        assert_strategy!("{foo,*}", Static);
1204        assert_strategy!("{foo,*}?{*,bar}", Wildmatch);
1205        assert_strategy!("{*,}?{*,}", Wildmatch);
1206    }
1207
1208    #[test]
1209    fn test_any() {
1210        assert_pattern!("?", NOT "");
1211        assert_pattern!("?", "ඞ");
1212        assert_pattern!("?", "?");
1213        assert_pattern!("?", "\n");
1214        assert_pattern!("?", "_");
1215        assert_pattern!("?", NOT "aa");
1216        assert_pattern!("?", NOT "aaaaaaaaaaaaaaaaaa");
1217        assert_pattern!("??", "aa");
1218        assert_pattern!("??", NOT "aaa");
1219        assert_pattern!("a?a?a", "aaaaa");
1220        assert_pattern!("a?a?a", "abaca");
1221        assert_pattern!("a?a?a", NOT "ab_ca");
1222        assert_pattern!("a?a?a", NOT "aaAaa");
1223        assert_pattern!("???????????x???????????", "???????????x???????????");
1224        assert_pattern!("???????????x???????????", "??______???x?????_?????");
1225        assert_pattern!("???????????x???????????", NOT "?______???x?????_?????");
1226        assert_pattern!("???????????x???????????", NOT "??______???_?????_?????");
1227        assert_pattern!(
1228            "??????????????????????????????????????????????????",
1229            "?????????????????????????????????????????????????!"
1230        );
1231        assert_pattern!("foo?bar", "foo?bar");
1232        assert_pattern!("foo?bar", "foo!bar");
1233        assert_pattern!("a??a", "aඞඞa");
1234
1235        // No special slash handling
1236        assert_pattern!("?", "/");
1237    }
1238
1239    #[test]
1240    fn test_any_wildcard() {
1241        assert_pattern!("??*", NOT "");
1242        assert_pattern!("??*", NOT "a");
1243        assert_pattern!("??*", "ab");
1244        assert_pattern!("??*", "abc");
1245        assert_pattern!("??*", "abcde");
1246
1247        assert_pattern!("*??", NOT "");
1248        assert_pattern!("*??", NOT "a");
1249        assert_pattern!("*??", "ab");
1250        assert_pattern!("*??", "abc");
1251        assert_pattern!("*??", "abcde");
1252
1253        assert_pattern!("*??*", NOT "");
1254        assert_pattern!("*??*", NOT "a");
1255        assert_pattern!("*??*", "ab");
1256        assert_pattern!("*??*", "abc");
1257        assert_pattern!("*??*", "abcde");
1258
1259        assert_pattern!("*?*?*", NOT "");
1260        assert_pattern!("*?*?*", NOT "a");
1261        assert_pattern!("*?*?*", "ab");
1262        assert_pattern!("*?*?*", "abc");
1263        assert_pattern!("*?*?*", "abcde");
1264    }
1265
1266    #[test]
1267    fn test_escapes() {
1268        assert_pattern!(r"f\\o", r"f\o");
1269        assert_pattern!(r"f\*o", r"f*o");
1270        assert_pattern!(r"f\*o", NOT r"f\*o");
1271        assert_pattern!(r"f\\*o", r"f\*o");
1272        assert_pattern!(r"f\\*o", r"f\o");
1273        assert_pattern!(r"f\\*o", r"f\___o");
1274        assert_pattern!(r"f\\\*o", r"f\*o");
1275        assert_pattern!(r"f\[\]o", r"f[]o");
1276        assert_pattern!(r"f\[?\]o", r"f[?]o");
1277        assert_pattern!(r"f\[a-z\]o", r"f[a-z]o");
1278        assert_pattern!(r"f\[o", r"f[o");
1279        assert_pattern!(r"f\]o", r"f]o");
1280        assert_pattern!(r"\[", r"[");
1281    }
1282
1283    #[test]
1284    fn test_invalid() {
1285        assert_invalid!(r"\");
1286        assert_invalid!(r"f\");
1287        assert_invalid!(r"*\");
1288        assert_invalid!("[");
1289        assert_invalid!("[a-z");
1290        assert_invalid!(r"[a-z\");
1291        assert_invalid!("[[]");
1292        assert_invalid!("[]]");
1293        assert_invalid!("]");
1294        assert_invalid!("[a-z");
1295        assert_invalid!("[b-a]");
1296        assert_invalid!("[a-A]");
1297    }
1298
1299    #[test]
1300    fn test_classes() {
1301        assert_pattern!("[]", NOT "");
1302        assert_pattern!("[]", NOT "_");
1303        assert_pattern!("[a]", "a");
1304        assert_pattern!("[a]", NOT "[a]");
1305        assert_pattern!("[a]", NOT "b");
1306        assert_pattern!("[a]", NOT "A");
1307        assert_pattern!("[ඞ]", "ඞ");
1308        assert_pattern!("[ඞ]", NOT "a");
1309        assert_pattern!("[ඞa]", "a");
1310        assert_pattern!("[aඞ]", "ඞ");
1311        assert_pattern!("[ඞa]", NOT "b");
1312        assert_pattern!("[ab]", "a");
1313        assert_pattern!("[ab]", "b");
1314        assert_pattern!("[ab]", NOT "c");
1315        assert_pattern!("x[ab]x", "xax");
1316        assert_pattern!("x[ab]x", "xbx");
1317        assert_pattern!("x[ab]x", NOT "xBx");
1318        assert_pattern!("x[ab]x", NOT "xcx");
1319        assert_pattern!("x[ab]x", NOT "aax");
1320        assert_pattern!("x[ab]x", NOT "xaa");
1321        assert_pattern!("x[ab]x", NOT "xaax");
1322        assert_pattern!("x[ab]x", NOT "xxax");
1323        assert_pattern!("x[ab]x", NOT "xaxx");
1324        assert_pattern!("[a-b]", "a");
1325        assert_pattern!("[a-b]", "b");
1326        assert_pattern!("[a-b]", NOT "c");
1327        assert_pattern!("[a-c]", "a");
1328        assert_pattern!("[a-c]", "b");
1329        assert_pattern!("[a-c]", "c");
1330        assert_pattern!("[a-c]", NOT "d");
1331        assert_pattern!("[a-c]", NOT "1");
1332        assert_pattern!("[a-c]", NOT "ඞ");
1333        assert_pattern!("[A-z]", "a");
1334        assert_pattern!("[A-z]", "z");
1335        assert_pattern!("[A-z]", "["); // `[` is actually inbetween here in the ascii table
1336        assert_pattern!("[A-z]", "A");
1337        assert_pattern!("[A-z]", "Z");
1338        assert_pattern!("[A-z]", NOT "0");
1339        assert_pattern!("[0-9]", "0");
1340        assert_pattern!("[0-9]", "1");
1341        assert_pattern!("[0-9]", "2");
1342        assert_pattern!("[0-9]", "3");
1343        assert_pattern!("[0-9]", "4");
1344        assert_pattern!("[0-9]", "5");
1345        assert_pattern!("[0-9]", "6");
1346        assert_pattern!("[0-9]", "7");
1347        assert_pattern!("[0-9]", "8");
1348        assert_pattern!("[0-9]", "9");
1349        assert_pattern!(
1350            "[0-9a-bX-ZfF][0-9a-bX-ZfF][0-9a-bX-ZfF][0-9a-bX-ZfF]",
1351            "3bYf"
1352        );
1353        assert_pattern!(
1354            "[0-9a-bX-ZfF][0-9a-bX-ZfF][0-9a-bX-ZfF][0-9a-bX-ZfF]",
1355            NOT "3cYf"
1356        );
1357        assert_pattern!(
1358            "[0-9a-bX-ZfF][0-9a-bX-ZfF][0-9a-bX-ZfF][0-9a-bX-ZfF]",
1359            NOT "3ඞYf"
1360        );
1361        assert_pattern!("[0-9]", NOT "a9");
1362        assert_pattern!("[0-9]", NOT "9a");
1363        assert_pattern!("[0-9]", NOT "a9a");
1364        assert_pattern!("[0-9]", NOT "");
1365        assert_pattern!("[0-9!]", "!");
1366        assert_pattern!("[0-9][a-b]", NOT "");
1367        assert_pattern!("[0-9][a-b]", NOT "a");
1368        assert_pattern!("[0-9][a-b]", NOT "a0");
1369        assert_pattern!("[0-9][a-b]", "0a");
1370        assert_pattern!(r"a[\]a\-]b", "aab");
1371
1372        // TODO: lenient: assert_pattern!("a[]-]b", NOT "aab");
1373        // TODO: lenient: assert_pattern!("]", "]");
1374        // TODO: lenient: assert_pattern!("a[]-]b", "a-]b");
1375        // TODO: lenient: assert_pattern!("a[]-]b", "a]b");
1376        // TODO: lenient: assert_pattern!("a[]]b", "a]b");
1377
1378        // Escapes in character classes
1379        assert_pattern!(r"[\\]", r"\");
1380        assert_pattern!(r"[\\]", NOT "a");
1381        assert_pattern!(r"[\]]", "]");
1382        assert_pattern!(r"[\]]", NOT "a");
1383        assert_pattern!(r"[\[]", "[");
1384        assert_pattern!(r"[\[]", NOT "a");
1385        assert_pattern!(r"[\]]", NOT r"\");
1386
1387        assert_pattern!("a[X-]b", "a-b");
1388        assert_pattern!("a[X-]b", "aXb");
1389    }
1390
1391    #[test]
1392    fn test_classes_case_insensitive() {
1393        assert_pattern!("[a]", "a", i);
1394        assert_pattern!("[a]", "A", i);
1395        assert_pattern!("x[ab]x", "xAX", i);
1396        assert_pattern!("x[ab]x", "XBx", i);
1397        assert_pattern!("x[ab]x", NOT "Xcx", i);
1398        assert_pattern!("x[ab]x", NOT "aAx", i);
1399        assert_pattern!("x[ab]x", NOT "xAa", i);
1400        assert_pattern!("[ǧ]", "Ǧ", i);
1401        assert_pattern!("[Ǧ]", "ǧ", i);
1402    }
1403
1404    #[test]
1405    fn test_classes_negated() {
1406        assert_pattern!("[!]", NOT "");
1407        assert_pattern!("[!a]", "b");
1408        assert_pattern!("[!a]", "A");
1409        assert_pattern!("[!a]", "B");
1410        assert_pattern!("[!b]", NOT "b");
1411        assert_pattern!("[!ab]", NOT "a");
1412        assert_pattern!("[!ab]", NOT "b");
1413        assert_pattern!("[!ab]", "c");
1414        assert_pattern!("x[!ab]x", "xcx");
1415        assert_pattern!("x[!ab]x", NOT "xax");
1416        assert_pattern!("x[!ab]x", NOT "xbx");
1417        assert_pattern!("x[!ab]x", NOT "xxcx");
1418        assert_pattern!("x[!ab]x", NOT "xcxx");
1419        assert_pattern!("x[!ab]x", NOT "xc");
1420        assert_pattern!("x[!ab]x", NOT "cx");
1421        assert_pattern!("x[!ab]x", NOT "x");
1422        assert_pattern!("[!a-c]", NOT "a");
1423        assert_pattern!("[!a-c]", NOT "b");
1424        assert_pattern!("[!a-c]", NOT "c");
1425        assert_pattern!("[!a-c]", "d");
1426        assert_pattern!("[!a-c]", "A");
1427        assert_pattern!("[!a-c]", "ඞ");
1428        assert_pattern!(r"[!a-c\\]", "d");
1429        assert_pattern!(r"[!a-c\\]", NOT r"\");
1430        assert_pattern!(r"[!\]]", "a");
1431        assert_pattern!(r"[!\]]", NOT "]");
1432        assert_pattern!(r"[!!]", "a");
1433        assert_pattern!(r"[!!]", NOT "!");
1434    }
1435
1436    #[test]
1437    fn test_classes_negated_case_insensitive() {
1438        assert_pattern!("[!a]", "b", i);
1439        assert_pattern!("[!a]", "B", i);
1440        assert_pattern!("[!b]", NOT "b", i);
1441        assert_pattern!("[!b]", NOT "B", i);
1442        assert_pattern!("[!ab]", NOT "a", i);
1443        assert_pattern!("[!ab]", NOT "A", i);
1444        assert_pattern!("[!ab]", NOT "b", i);
1445        assert_pattern!("[!ab]", NOT "B", i);
1446        assert_pattern!("[!ab]", "c", i);
1447        assert_pattern!("[!ab]", "C", i);
1448    }
1449
1450    #[test]
1451    fn test_alternates() {
1452        assert_pattern!("{}foo{}", "foo");
1453        assert_pattern!("foo{}bar", "foobar");
1454        assert_pattern!("foo{}{}bar", "foobar");
1455        assert_pattern!("{foo}", "foo");
1456        assert_pattern!("{foo}", NOT "fOo");
1457        assert_pattern!("{foo}", NOT "bar");
1458        assert_pattern!("{foo,bar}", "foo");
1459        assert_pattern!("{foo,bar}", "bar");
1460        assert_pattern!("{foo,bar}", NOT "Foo");
1461        assert_pattern!("{foo,bar}", NOT "fOo");
1462        assert_pattern!("{foo,bar}", NOT "BAR");
1463        assert_pattern!("{foo,bar}", NOT "fooo");
1464        assert_pattern!("{foo,bar}", NOT "baar");
1465        assert_pattern!("{foo,bar,}baz", "foobaz");
1466        assert_pattern!("{foo,bar,}baz", "barbaz");
1467        assert_pattern!("{foo,bar,}baz", "baz");
1468        assert_pattern!("{foo,,bar}baz", "foobaz");
1469        assert_pattern!("{foo,,bar}baz", "barbaz");
1470        assert_pattern!("{foo,,bar}baz", "baz");
1471        assert_pattern!("{,foo,bar}baz", "foobaz");
1472        assert_pattern!("{,foo,bar}baz", "barbaz");
1473        assert_pattern!("{,foo,bar}baz", "baz");
1474        assert_pattern!("{foo*bar}", "foobar");
1475        assert_pattern!("{foo*bar}", "fooooobar");
1476        assert_pattern!("{foo*bar}", NOT "");
1477        assert_pattern!("{foo*bar,}", "foobar");
1478        assert_pattern!("{foo*bar,}", "fooooobar");
1479        assert_pattern!("{foo*bar,}", "");
1480        assert_pattern!("{foo*bar,baz}", "foobar");
1481        assert_pattern!("{foo*bar,baz}", "fooooobar");
1482        assert_pattern!("{foo*bar,baz}", "baz");
1483        assert_pattern!("{foo*bar,baz}", NOT "");
1484        assert_pattern!("{foo*bar,baz,}", "foobar");
1485        assert_pattern!("{foo*bar,baz,}", "fooooobar");
1486        assert_pattern!("{foo*bar,baz,}", "baz");
1487        assert_pattern!("{foo*bar,baz,}", "");
1488        assert_pattern!("{,,,,}", NOT "");
1489        assert_pattern!("{[fb][oa][or]}", "foo");
1490        assert_pattern!("{[fb][oa][or]}", "bar");
1491        assert_pattern!("{[fb][oa][or],baz}", "foo");
1492        assert_pattern!("{[fb][oa][or],baz}", "bar");
1493        assert_pattern!("{[fb][oa][or],baz}", "baz");
1494        assert_pattern!("{baz,[fb][oa][or]}", "baz");
1495        assert_pattern!("{baz,[fb][oa][or]}", "foo");
1496        assert_pattern!("{baz,[fb][oa][or]}", "bar");
1497        assert_pattern!("{baz,[fb][oa][or]}", "bor");
1498        assert_pattern!("{baz,[fb][oa][or]}", NOT "barr");
1499        assert_pattern!("{baz,[fb][oa][or]}", NOT "boz");
1500        assert_pattern!("{baz,[fb][oa][or]}", NOT "fbar");
1501        assert_pattern!("{baz,[fb][oa][or]}", NOT "bAr");
1502        assert_pattern!("{baz,[fb][oa][or]}", NOT "Foo");
1503        assert_pattern!("{baz,[fb][oa][or]}", NOT "Bar");
1504        assert_pattern!("{baz,b[aA]r}", NOT "bAz");
1505        assert_pattern!("{baz,b[!aA]r}", NOT "bar");
1506        assert_pattern!("{baz,b[!aA]r}", "bXr");
1507        assert_pattern!("{[a-z],[0-9]}", "a");
1508        assert_pattern!("{[a-z],[0-9]}", "3");
1509        assert_pattern!("a{[a-z],[0-9]}a", "a3a");
1510        assert_pattern!("a{[a-z],[0-9]}a", "aba");
1511        assert_pattern!("a{[a-z],[0-9]}a", NOT "aAa");
1512        assert_pattern!("a{[a-z],?}a", "aXa");
1513        assert_pattern!(r"a{[a-z],\?}a", "a?a");
1514        assert_pattern!(r"a{[a-z],\?}a", NOT "aXa");
1515        assert_pattern!(r"a{[a-z],\?}a", NOT r"a\a");
1516        assert_pattern!(r"a{\[\],\{\}}a", "a[]a");
1517        assert_pattern!(r"a{\[\],\{\}}a", "a{}a");
1518        assert_pattern!(r"a{\[\],\{\}}a", NOT "a[}a");
1519        assert_pattern!(r"a{\[\],\{\}}a", NOT "a{]a");
1520        assert_pattern!(r"a{\[\],\{\}}a", NOT "a[a");
1521        assert_pattern!(r"a{\[\],\{\}}a", NOT "a]a");
1522        assert_pattern!(r"a{\[\],\{\}}a", NOT "a{a");
1523        assert_pattern!(r"a{\[\],\{\}}a", NOT "a}a");
1524        assert_pattern!("foo/{*.js,*.html}", "foo/.js");
1525        assert_pattern!("foo/{*.js,*.html}", "foo/.html");
1526        assert_pattern!("foo/{*.js,*.html}", "foo/bar.js");
1527        assert_pattern!("foo/{*.js,*.html}", "foo/bar.html");
1528        assert_pattern!("foo/{*.js,*.html}", NOT "foo/bar.png");
1529        assert_pattern!("foo/{*.js,*.html}", NOT "bar/bar.js");
1530        assert_pattern!("{foo,abc}{def,bar}", "foodef");
1531        assert_pattern!("{foo,abc}{def,bar}", "foobar");
1532        assert_pattern!("{foo,abc}{def,bar}", "abcdef");
1533        assert_pattern!("{foo,abc}{def,bar}", "abcbar");
1534        assert_pattern!("{foo,abc}{def,bar}", NOT "foofoo");
1535        assert_pattern!("{foo,abc}{def,bar}", NOT "fooabc");
1536        assert_pattern!("{foo,abc}{def,bar}", NOT "defdef");
1537        assert_pattern!("{foo,abc}{def,bar}", NOT "defabc");
1538    }
1539
1540    #[test]
1541    fn test_alternate_strategy() {
1542        // Empty alternates can be simplified.
1543        assert_strategy!("{}foo{}", Literal);
1544        assert_strategy!("foo{}bar", Literal);
1545        assert_strategy!("foo{}{}{}bar", Literal);
1546        assert_strategy!("foo{,,,}bar", Literal);
1547    }
1548
1549    #[test]
1550    fn test_alternates_case_insensitive() {
1551        assert_pattern!("{foo}", "foo", i);
1552        assert_pattern!("{foo}", "fOo", i);
1553        assert_pattern!("{foo}", NOT "bar", i);
1554        assert_pattern!("{foo,bar}", "foo", i);
1555        assert_pattern!("{foo,bar}", "bar", i);
1556        assert_pattern!("{foo,bar}", "Foo", i);
1557        assert_pattern!("{foo,bar}", "fOo", i);
1558        assert_pattern!("{foo,bar}", "BAR", i);
1559        assert_pattern!("{foo,bar}", NOT "bao", i);
1560        assert_pattern!("{f[o0-9]o,b[a]r}", "foo", i);
1561        assert_pattern!("{f[o0-9]o,b[a]r}", "fOo", i);
1562        assert_pattern!("{f[o0-9]o,b[a]r}", "f1o", i);
1563        assert_pattern!("{f[o0-9]o,b[a]r}", "foO", i);
1564        assert_pattern!("{f[o0-9]o,b[a]r}", "FOO", i);
1565        assert_pattern!("{f[o0-9]o,b[a]r}", "bar", i);
1566        assert_pattern!("{f[o0-9]o,b[a]r}", "bAr", i);
1567        assert_pattern!("{f[o0-9]o,b[a]r}", "baR", i);
1568        assert_pattern!("{f[o0-9]o,b[a]r}", "BAR", i);
1569        assert_pattern!("{f[o0-9]o,b[!a]r}", "foo", i);
1570        assert_pattern!("{f[o0-9]o,b[!a]r}", "bXr", i);
1571        assert_pattern!("{f[o0-9]o,b[!a]r}", NOT "bar", i);
1572        assert_pattern!("{f[o0-9]o,b[!a]r}", NOT "bAr", i);
1573    }
1574
1575    #[test]
1576    fn test_complex() {
1577        assert_pattern!("*?", "\n");
1578        assert_pattern!("?*", "\n");
1579        assert_pattern!("*?*", "\n");
1580        assert_pattern!("1.18.[!0-4].*", "1.18.5.");
1581        assert_pattern!("1.18.[!0-4].*", "1.18.5.aBc");
1582        assert_pattern!("1.18.[!0-4].*", NOT "1.18.3.abc");
1583        assert_pattern!("!*!*.md", "!foo!.md"); // no `!` outside of character classes
1584        assert_pattern!("foo*foofoo*foobar", "foofoofooxfoofoobar");
1585        assert_pattern!("foo*fooFOO*fOobar", "fooFoofooXfoofooBAR", i);
1586        assert_pattern!("[0-9]*a", "0aaaaaaaaa", i);
1587        assert_pattern!("[0-9]*Bar[x]", "0foobarx", i);
1588
1589        assert_pattern!(
1590            r"/api/0/organizations/\{organization_slug\}/event*",
1591            "/api/0/organizations/{organization_slug}/event/foobar"
1592        );
1593        assert_pattern!(
1594            r"/api/0/organizations/\{organization_slug\}/event*",
1595            NOT r"/api/0/organizations/\{organization_slug\}/event/foobar"
1596        );
1597
1598        assert_pattern!(
1599            "*b??{foo,bar,baz,with}*cr{x,y,z,?}zyl[a-z]ng{suffix,pr?*ix}*it?**?uallymatches",
1600            "foobarwithacrazylongprefixandanditactuallymatches"
1601        );
1602        assert_pattern!(
1603            "*b??{foo,bar,baz,with}*cr{x,y,z,?}zyl[a-z]ng{suffix,pr?*ix}*it?**?uallymatches",
1604            "FOOBARWITHACRAZYLONGPREFIXANDANDITACTUALLYMATCHES",
1605            i
1606        );
1607    }
1608
1609    /// Tests collected by [Kirk J Krauss].
1610    ///
1611    /// Kirk J Krauss: http://developforperformance.com/MatchingWildcards_AnImprovedAlgorithmForBigData.html.
1612    #[test]
1613    fn test_kirk_j_krauss() {
1614        // Case with first wildcard after total match.
1615        assert_pattern!("Hi*", "Hi");
1616
1617        // Case with mismatch after '*'
1618        assert_pattern!("ab*d", NOT "abc");
1619
1620        // Cases with repeating character sequences.
1621        assert_pattern!("*ccd", "abcccd");
1622        assert_pattern!("*issip*ss*", "mississipissippi");
1623        assert_pattern!("xxxx*zzy*fffff", NOT "xxxx*zzzzzzzzy*f");
1624        assert_pattern!("xxx*zzy*f", "xxxx*zzzzzzzzy*f");
1625        assert_pattern!("xxxx*zzy*fffff", NOT "xxxxzzzzzzzzyf");
1626        assert_pattern!("xxxx*zzy*f", "xxxxzzzzzzzzyf");
1627        assert_pattern!("xy*z*xyz", "xyxyxyzyxyz");
1628        assert_pattern!("*sip*", "mississippi");
1629        assert_pattern!("xy*xyz", "xyxyxyxyz");
1630        assert_pattern!("mi*sip*", "mississippi");
1631        assert_pattern!("*abac*", "ababac");
1632        assert_pattern!("*abac*", "ababac");
1633        assert_pattern!("a*zz*", "aaazz");
1634        assert_pattern!("*12*23", NOT "a12b12");
1635        assert_pattern!("a12b", NOT "a12b12");
1636        assert_pattern!("*12*12*", "a12b12");
1637
1638        // From DDJ reader Andy Belf
1639        assert_pattern!("*a?b", "caaab");
1640
1641        // Additional cases where the '*' char appears in the tame string.
1642        assert_pattern!("*", "*");
1643        assert_pattern!("a*b", "a*abab");
1644        assert_pattern!("a*", "a*r");
1645        assert_pattern!("a*aar", NOT "a*ar");
1646
1647        // More double wildcard scenarios.
1648        assert_pattern!("XY*Z*XYz", "XYXYXYZYXYz");
1649        assert_pattern!("*SIP*", "missisSIPpi");
1650        assert_pattern!("*issip*PI", "mississipPI");
1651        assert_pattern!("xy*xyz", "xyxyxyxyz");
1652        assert_pattern!("mi*sip*", "miSsissippi");
1653        assert_pattern!("mi*Sip*", NOT "miSsissippi");
1654        assert_pattern!("*Abac*", "abAbac");
1655        assert_pattern!("*Abac*", "abAbac");
1656        assert_pattern!("a*zz*", "aAazz");
1657        assert_pattern!("*12*23", NOT "A12b12");
1658        assert_pattern!("*12*12*", "a12B12");
1659        assert_pattern!("*oWn*", "oWn");
1660
1661        // Completely tame (no wildcards) cases.
1662        assert_pattern!("bLah", "bLah");
1663        assert_pattern!("bLaH", NOT "bLah");
1664
1665        // Simple mixed wildcard tests suggested by Marlin Deckert.
1666        assert_pattern!("*?", "a");
1667        assert_pattern!("*?", "ab");
1668        assert_pattern!("*?", "abc");
1669
1670        // More mixed wildcard tests including coverage for false positives.
1671        assert_pattern!("??", NOT "a");
1672        assert_pattern!("?*?", "ab");
1673        assert_pattern!("*?*?*", "ab");
1674        assert_pattern!("?**?*?", "abc");
1675        assert_pattern!("?**?*&?", NOT "abc");
1676        assert_pattern!("?b*??", "abcd");
1677        assert_pattern!("?a*??", NOT "abcd");
1678        assert_pattern!("?**?c?", "abcd");
1679        assert_pattern!("?**?d?", NOT "abcd");
1680        assert_pattern!("?*b*?*d*?", "abcde");
1681
1682        // Single-character-match cases.
1683        assert_pattern!("bL?h", "bLah");
1684        assert_pattern!("bLa?", NOT "bLaaa");
1685        assert_pattern!("bLa?", "bLah");
1686        assert_pattern!("?Lah", NOT "bLaH");
1687        assert_pattern!("?LaH", "bLaH");
1688
1689        // Many-wildcard scenarios.
1690        assert_pattern!(
1691            "a*a*a*a*a*a*aa*aaa*a*a*b",
1692            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
1693        );
1694        assert_pattern!(
1695            "*a*b*ba*ca*a*aa*aaa*fa*ga*b*",
1696            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1697        );
1698        assert_pattern!(
1699            "*a*b*ba*ca*a*x*aaa*fa*ga*b*",
1700            NOT "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1701        );
1702        assert_pattern!(
1703            "*a*b*ba*ca*aaaa*fa*ga*gggg*b*",
1704            NOT "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1705        );
1706        assert_pattern!(
1707            "*a*b*ba*ca*aaaa*fa*ga*ggg*b*",
1708            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1709        );
1710        assert_pattern!("*aabbaa*a*", "aaabbaabbaab");
1711        assert_pattern!(
1712            "a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*",
1713            "a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*"
1714        );
1715        assert_pattern!("*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*", "aaaaaaaaaaaaaaaaa");
1716        assert_pattern!(
1717            "*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*a*",
1718            NOT "aaaaaaaaaaaaaaaa"
1719        );
1720        assert_pattern!(
1721            "abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*",
1722            NOT "abc*abcd*abcde*abcdef*abcdefg*abcdefgh*abcdefghi*abcdefghij*abcdefghijk*abcdefghijkl*abcdefghijklm*abcdefghijklmn"
1723        );
1724        assert_pattern!(
1725            "abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*",
1726            "abc*abcd*abcde*abcdef*abcdefg*abcdefgh*abcdefghi*abcdefghij*abcdefghijk*abcdefghijkl*abcdefghijklm*abcdefghijklmn"
1727        );
1728        assert_pattern!("abc*abc*abc*abc*abc", NOT "abc*abcd*abcd*abc*abcd");
1729        assert_pattern!(
1730            "abc*abc*abc*abc*abc*abc*abc*abc*abc*abc*abcd",
1731            "abc*abcd*abcd*abc*abcd*abcd*abc*abcd*abc*abc*abcd"
1732        );
1733        assert_pattern!("********a********b********c********", "abc");
1734        assert_pattern!("abc", NOT "********a********b********c********");
1735        assert_pattern!("********a********b********b********", NOT "abc");
1736        assert_pattern!("***a*b*c***", "*abc*");
1737
1738        // A case-insensitive algorithm test.
1739        assert_pattern!("*issip*PI", "mississippi", i);
1740
1741        // Tests suggested by other DDJ readers
1742        assert_pattern!("?", NOT "");
1743        assert_pattern!("*?", NOT "");
1744        // assert_pattern!("", ""); - Removed, relay-pattern behaves differently for empty strings.
1745        assert_pattern!("", NOT "a");
1746
1747        // Tame tests:
1748        assert_pattern!("abd", NOT "abc");
1749
1750        // Cases with repeating character sequences.
1751        assert_pattern!("abcccd", "abcccd");
1752        assert_pattern!("mississipissippi", "mississipissippi");
1753        assert_pattern!("xxxxzzzzzzzzyfffff", NOT "xxxxzzzzzzzzyf");
1754        assert_pattern!("xxxxzzzzzzzzyf", "xxxxzzzzzzzzyf");
1755        assert_pattern!("xxxxzzy.fffff", NOT "xxxxzzzzzzzzyf");
1756        assert_pattern!("xxxxzzzzzzzzyf", "xxxxzzzzzzzzyf");
1757        assert_pattern!("xyxyxyzyxyz", "xyxyxyzyxyz");
1758        assert_pattern!("mississippi", "mississippi");
1759        assert_pattern!("xyxyxyxyz", "xyxyxyxyz");
1760        assert_pattern!("m ississippi", "m ississippi");
1761        assert_pattern!("ababac?", NOT "ababac");
1762        assert_pattern!("ababac", NOT "dababac");
1763        assert_pattern!("aaazz", "aaazz");
1764        assert_pattern!("1212", NOT "a12b12");
1765        assert_pattern!("a12b", NOT "a12b12");
1766        assert_pattern!("a12b12", "a12b12");
1767
1768        // A mix of cases
1769        assert_pattern!("n", "n");
1770        assert_pattern!("aabab", "aabab");
1771        assert_pattern!("ar", "ar");
1772        assert_pattern!("aaar", NOT "aar");
1773        assert_pattern!("XYXYXYZYXYz", "XYXYXYZYXYz");
1774        assert_pattern!("missisSIPpi", "missisSIPpi");
1775        assert_pattern!("mississipPI", "mississipPI");
1776        assert_pattern!("xyxyxyxyz", "xyxyxyxyz");
1777        assert_pattern!("miSsissippi", "miSsissippi");
1778        assert_pattern!("miSsisSippi", NOT "miSsissippi");
1779        assert_pattern!("abAbac", "abAbac");
1780        assert_pattern!("abAbac", "abAbac");
1781        assert_pattern!("aAazz", "aAazz");
1782        assert_pattern!("A12b123", NOT "A12b12");
1783        assert_pattern!("a12B12", "a12B12");
1784        assert_pattern!("oWn", "oWn");
1785        assert_pattern!("bLah", "bLah");
1786        assert_pattern!("bLaH", NOT "bLah");
1787
1788        // Single '?' cases.
1789        assert_pattern!("a", "a");
1790        assert_pattern!("a?", "ab");
1791        assert_pattern!("ab?", "abc");
1792
1793        // Mixed '?' cases.
1794        assert_pattern!("??", NOT "a");
1795        assert_pattern!("??", "ab");
1796        assert_pattern!("???", "abc");
1797        assert_pattern!("????", "abcd");
1798        assert_pattern!("????", NOT "abc");
1799        assert_pattern!("?b??", "abcd");
1800        assert_pattern!("?a??", NOT "abcd");
1801        assert_pattern!("??c?", "abcd");
1802        assert_pattern!("??d?", NOT "abcd");
1803        assert_pattern!("?b?d*?", "abcde");
1804
1805        // Longer string scenarios.
1806        assert_pattern!(
1807            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
1808            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab"
1809        );
1810        assert_pattern!(
1811            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab",
1812            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1813        );
1814        assert_pattern!(
1815            "abababababababababababababababababababaacacacacacacacadaeafagahaiajaxalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab",
1816            NOT "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1817        );
1818        assert_pattern!(
1819            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaggggagaaaaaaaab",
1820            NOT "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1821        );
1822        assert_pattern!(
1823            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab",
1824            "abababababababababababababababababababaacacacacacacacadaeafagahaiajakalaaaaaaaaaaaaaaaaaffafagaagggagaaaaaaaab"
1825        );
1826        assert_pattern!("aaabbaabbaab", "aaabbaabbaab");
1827        assert_pattern!(
1828            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
1829            "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
1830        );
1831        assert_pattern!("aaaaaaaaaaaaaaaaa", "aaaaaaaaaaaaaaaaa");
1832        assert_pattern!("aaaaaaaaaaaaaaaaa", NOT "aaaaaaaaaaaaaaaa");
1833        assert_pattern!(
1834            "abcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabcabc",
1835            NOT "abcabcdabcdeabcdefabcdefgabcdefghabcdefghiabcdefghijabcdefghijkabcdefghijklabcdefghijklmabcdefghijklmn"
1836        );
1837        assert_pattern!(
1838            "abcabcdabcdeabcdefabcdefgabcdefghabcdefghiabcdefghijabcdefghijkabcdefghijklabcdefghijklmabcdefghijklmn",
1839            "abcabcdabcdeabcdefabcdefgabcdefghabcdefghiabcdefghijabcdefghijkabcdefghijklabcdefghijklmabcdefghijklmn"
1840        );
1841        assert_pattern!("abcabc?abcabcabc", NOT "abcabcdabcdabcabcd");
1842        assert_pattern!(
1843            "abcabc?abc?abcabc?abc?abc?bc?abc?bc?bcd",
1844            "abcabcdabcdabcabcdabcdabcabcdabcabcabcd"
1845        );
1846        assert_pattern!("?abc?", "?abc?");
1847    }
1848
1849    #[test]
1850    fn test_builder_complexity() {
1851        assert!(Pattern::builder("{foo,bar}")
1852            .max_complexity(1)
1853            .build()
1854            .is_err());
1855        assert!(Pattern::builder("{foo,bar}")
1856            .max_complexity(2)
1857            .build()
1858            .is_ok());
1859        assert!(Pattern::builder("{foo,bar}/{*.html,*.js,*.css}")
1860            .max_complexity(5)
1861            .build()
1862            .is_err());
1863        assert!(Pattern::builder("{foo,bar}/{*.html,*.js,*.css}")
1864            .max_complexity(6)
1865            .build()
1866            .is_ok());
1867    }
1868
1869    #[test]
1870    fn test_patterns() {
1871        let patterns = Patterns::builder()
1872            .add("foobaR")
1873            .unwrap()
1874            .add("a*")
1875            .unwrap()
1876            .add("*a")
1877            .unwrap()
1878            .add("[0-9]*baz")
1879            .unwrap()
1880            .take();
1881
1882        assert!(patterns.is_match("foobaR"));
1883        assert!(patterns.is_match("abc"));
1884        assert!(patterns.is_match("cba"));
1885        assert!(patterns.is_match("3baz"));
1886        assert!(patterns.is_match("123456789baz"));
1887        assert!(!patterns.is_match("foobar"));
1888        assert!(!patterns.is_match("FOOBAR"));
1889    }
1890
1891    #[test]
1892    fn test_patterns_case_insensitive() {
1893        let patterns = Patterns::builder()
1894            .case_insensitive(true)
1895            .add("fOObar")
1896            .unwrap()
1897            .add("a*")
1898            .unwrap()
1899            .add("*a")
1900            .unwrap()
1901            .add("[0-9]*baz")
1902            .unwrap()
1903            .take();
1904
1905        assert!(patterns.is_match("FooBar"));
1906        assert!(patterns.is_match("abC"));
1907        assert!(patterns.is_match("cbA"));
1908        assert!(patterns.is_match("3BAZ"));
1909        assert!(patterns.is_match("123456789baz"));
1910        assert!(!patterns.is_match("b"));
1911    }
1912
1913    #[test]
1914    fn test_patterns_take_clears_builder() {
1915        let mut builder = Patterns::builder().add("foo").unwrap();
1916
1917        let patterns = builder.take();
1918        assert!(patterns.is_match("foo"));
1919        assert!(!patterns.is_match("bar"));
1920
1921        builder.add("bar").unwrap();
1922        let patterns = builder.build();
1923        assert!(!patterns.is_match("foo"));
1924        assert!(patterns.is_match("bar"));
1925    }
1926}
relay_pattern/lib.rs

relay_pattern/
lib.rs
