anon/jeger
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

some more documentation

Browse Source
This commit is contained in:
anon 2023-09-20 13:33:18 +02:00
parent 0c0ee07caf
commit ae98518b57
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@ -4,6 +4,13 @@ A regex engine.
### Syntax ### Syntax
The aim was to follow Vim's regex syntax. Esoteric special characters such as "\zs" are not implemented, however the just is supported. The aim was to follow Vim's regex syntax. Esoteric special characters such as "\zs" are not implemented, however the just is supported.
```C
match_t * regex_match(const regex_t * const regex, const char * const string, const bool start_of_string);
```
Returns a sentinel terminated array of `match_t` objects.
The sentinel object is defined as `(match_t){ .position = -1, .width = -1, };`.
The position and width of non-sentinel `match_t`s is guaranteed to be => 0.
| Symbol | Meaning (TODO: fill in) | | Symbol | Meaning (TODO: fill in) |
| :----: | :---------------------: | | :----: | :---------------------: |
| . | | | . | |