Move readme to root
This commit is contained in:
parent
021c65316e
commit
e9f824ee08
43
readme.md
Normal file
43
readme.md
Normal file
@ -0,0 +1,43 @@
|
||||
# Dqn
|
||||
Personal utility library.
|
||||
|
||||
## DqnInspect
|
||||
A simple C++ introspection metaprogram designed as a prebuild step and generates type information for the inspected types. It is a minimal single header file licensed in the public domain with only CRT dependencies. It is only able to parse C-like C++, i.e. Plain Old Data types only.
|
||||
|
||||
The generated file is written to stdout.
|
||||
|
||||
### Usage
|
||||
Annotate the C++ code using `DQN_INSPECT`, i.e.
|
||||
|
||||
```
|
||||
DQN_INSPECT struct Entity
|
||||
{
|
||||
V2 pos;
|
||||
V2 size;
|
||||
}
|
||||
|
||||
DQN_INSPECT enum struct SomeEnum
|
||||
{
|
||||
Hello,
|
||||
Foo
|
||||
}
|
||||
```
|
||||
|
||||
And then build DqnInspect by defining `DQN_INSPECT_EXECUTABLE_IMPLEMENTATION` before compiling and execute it as follows
|
||||
|
||||
`DqnInspect.exe SourceCode.h > SourceCodeInspected.h`
|
||||
|
||||
Include and use the file in code
|
||||
|
||||
```
|
||||
#include "DqnReflect.h"
|
||||
#include "SourceCode.h"
|
||||
#include "SourceCodeInspected.h"
|
||||
SomeEnum enum = SomeEnum::Hello;
|
||||
printf("%s\n", DqnInspect_EnumString(enum)); // prints Hello
|
||||
|
||||
Entity entity = {};
|
||||
DqnInspect_Struct const *inspector = DqnInspect_GetStruct(&entity);
|
||||
for (int i = 0; i < inspector->members_len; ++i)
|
||||
printf("%s\n", inspector->members[i].name);
|
||||
```
|
Loading…
Reference in New Issue
Block a user