ADDED: raylib header parser
This commit is contained in:
parent
0369ec9adf
commit
3c1c13b660
2 changed files with 741 additions and 0 deletions
58
parser/README.md
Normal file
58
parser/README.md
Normal file
|
@ -0,0 +1,58 @@
|
|||
## raylib parser
|
||||
|
||||
This parser scans [`raylib.h`](../src/raylib.h) to get information about `structs`, `enums` and `functions`.
|
||||
All data is separated into parts, usually as strings. The following types are used for data:
|
||||
|
||||
- `struct FunctionInfo`
|
||||
- `struct StructInfo`
|
||||
- `struct EnumInfo`
|
||||
|
||||
Check `raylib_parser.c` for details about those structs.
|
||||
|
||||
## Constraints
|
||||
|
||||
This parser is specifically designed to work with raylib.h, so, it has some constraints:
|
||||
|
||||
- Functions are expected as a single line with the following structure:
|
||||
```
|
||||
<retType> <name>(<paramType[0]> <paramName[0]>, <paramType[1]> <paramName[1]>); <desc>
|
||||
```
|
||||
Be careful with functions broken into several lines, it breaks the process!
|
||||
|
||||
- Structures are expected as several lines with the following form:
|
||||
```
|
||||
<desc>
|
||||
typedef struct <name> {
|
||||
<fieldType[0]> <fieldName[0]>; <fieldDesc[0]>
|
||||
<fieldType[1]> <fieldName[1]>; <fieldDesc[1]>
|
||||
<fieldType[2]> <fieldName[2]>; <fieldDesc[2]>
|
||||
} <name>;
|
||||
```
|
||||
- Enums are expected as several lines with the following form:
|
||||
```
|
||||
<desc>
|
||||
typedef enum {
|
||||
<valueName[0]> = <valueInt[0]>, <valueDesc[0]>
|
||||
<valueName[1]>,
|
||||
<valueName[2]>, <valueDesc[2]>
|
||||
<valueName[3]> <valueDesc[3]>
|
||||
} <name>;
|
||||
```
|
||||
|
||||
_NOTE: For enums, multiple options are supported:_
|
||||
|
||||
- If value is not provided, (<valueInt[i -1]> + 1) is assigned
|
||||
- Value description can be provided or not
|
||||
|
||||
## Additional notes
|
||||
|
||||
This parser _could_ work with other C header files if mentioned constraints are followed.
|
||||
|
||||
This parser **does not require `<string.h>` library**, all data is parsed directly from char buffers.
|
||||
|
||||
### LICENSE: zlib/libpng
|
||||
|
||||
raylib-parser is licensed under an unmodified zlib/libpng license, which is an OSI-certified,
|
||||
BSD-like license that allows static linking with closed source software:
|
||||
|
||||
Copyright (c) 2021 Ramon Santamaria (@raysan5)
|
Loading…
Add table
Add a link
Reference in a new issue