Browse Source

+ license & readme

tags/0.1
song.li 2 years ago
parent
commit
f42c7a5c49
3 changed files with 58 additions and 0 deletions
  1. 21
    0
      LICENSE
  2. 37
    0
      README.md
  3. BIN
      Tref.h

+ 21
- 0
LICENSE View File

@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2018 crazybie

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 37
- 0
README.md View File

@@ -0,0 +1,37 @@
# Tref: A *T*iny compile time *ref*lection system.

## Features:
- Only utilize C++17 language features, no external preprocessor needed.
- Reflect at compile time with minimal runtime overhead.
- Simple syntax.
- Normal class reflection.
- Class template reflection.
- Reflect element with additional meta data.
- Enum class reflection, support user defined value and meta for each item.
- Reflect external types of third-party code.
- Reflect class level and instance level variables and functions.
- Reflect nested member types.
- Reflect overloaded functions.
- Factory pattern: introspect all sub-classes from one base class.

## TODO:
- Reflect function details, e.g. arguments and return type.
- Specify a new name for reflected element.

## Examples

- See TrefTest.cpp.

## License

The MIT License

```
Copyright (C) 2018 crazybie<soniced@sina.com>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```

BIN
Tref.h View File


Loading…
Cancel
Save