@@ -10,7 +10,9 @@ and set limits.
1010Boolean flags are specified by their name, and can be negated by prefixing with ` ! `
1111other flags should specify their value immediately after the flag name.
1212
13+
1314## Example
15+
1416```
1517%grmtools {
1618 allow_wholeline_comments
@@ -20,30 +22,33 @@ other flags should specify their value immediately after the flag name.
2022%%
2123. "rule"
2224```
23- ## List of flags:
2425
25- | Flag | Value | Required | Regex[ ^ regex ] |
26- | ---------------------------| -------| ----------| ---------------|
27- | ` posix_escapes ` | bool | &cross ; | &cross ; |
28- | Enable compatibility with posix escape sequences. |
29- | ` allow_wholeline_comment ` | bool | &cross ; | &cross ; |
30- | Enables c++ style ` // comments ` at the start of lines. |
31- | The ` / ` character may require escaping when used in a regex. |
32- | ` case_insensitive ` | bool | &cross ; | &checkmark ; |
33- | ` dot_matches_new_line ` | bool | &cross ; | &checkmark ; |
34- | ` multi_line ` | bool | &cross ; | &checkmark ; |
35- | ` octal ` | bool | &cross ; | &checkmark ; |
36- | ` swap_greed ` | bool | &cross ; | &checkmark ; |
37- | ` ignore_whitespace ` | bool | &cross ; | &checkmark ; |
38- | ` unicode ` | bool | &cross ; | &checkmark ; |
39- | ` size_limit ` | usize | &cross ; | &checkmark ; |
40- | ` dfa_size_limit ` | usize | &cross ; | &checkmark ; |
41- | ` nest_limit ` | u32 | &cross ; | &checkmark ; |
4226
27+ ## List of flags:
4328
29+ | Flag | Value | Required | Regex[ ^ regex ] |
30+ | -------------------------------| -------| ----------| ---------------|
31+ | ` posix_escapes ` [ ^ † ] | bool | &cross ; | &cross ; |
32+ | ` allow_wholeline_comment ` [ ^ ‡ ] | bool | &cross ; | &cross ; |
33+ | ` case_insensitive ` | bool | &cross ; | &checkmark ; |
34+ | ` dot_matches_new_line ` | bool | &cross ; | &checkmark ; |
35+ | ` multi_line ` | bool | &cross ; | &checkmark ; |
36+ | ` octal ` | bool | &cross ; | &checkmark ; |
37+ | ` swap_greed ` | bool | &cross ; | &checkmark ; |
38+ | ` ignore_whitespace ` | bool | &cross ; | &checkmark ; |
39+ | ` unicode ` | bool | &cross ; | &checkmark ; |
40+ | ` size_limit ` | usize | &cross ; | &checkmark ; |
41+ | ` dfa_size_limit ` | usize | &cross ; | &checkmark ; |
42+ | ` nest_limit ` | u32 | &cross ; | &checkmark ; |
43+
44+ [ ^ † ] : Enable compatibility with posix escape sequences.
45+ [ ^ ‡ ] : Enables rust style ` // comments ` at the start of lines.
46+ Which requires escaping of ` / ` when used in a regex.
4447[ ^ regex ] : &checkmark ; Flag gets passed directly to ` regex::RegexBuilder ` .
4548
49+
4650## Flags affecting Posix compatibility
51+
4752As discussed in [ Lex compatibility] ( lexcompatibility.md ) the default behaviors of grmtools and rust's regex
4853library have differed from that of posix lex.
4954
0 commit comments