doylet/Dqn
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Remove old readme

Browse Source
This commit is contained in:
Doyle 2019-02-23 15:42:11 +11:00
parent e9f824ee08
commit bdb6ca3352
1 changed files with 0 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
Code/readme.md
View File

@ -1,43 +0,0 @@
# 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);
```