Browse Source

some more documentation

master
anon 8 months ago
parent
commit
ae98518b57
1 changed files with 7 additions and 0 deletions
  1. +7
    -0
      README.md

+ 7
- 0
README.md View File

@@ -4,6 +4,13 @@ A regex engine.
### Syntax
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) |
| :----: | :---------------------: |
| . | |


Loading…
Cancel
Save