Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ubpa/udrefl
Ubpa Dynamic Reflection
https://github.com/ubpa/udrefl
cpp cpp20 reflection
Last synced: 25 days ago
JSON representation
Ubpa Dynamic Reflection
- Host: GitHub
- URL: https://github.com/ubpa/udrefl
- Owner: Ubpa
- License: mit
- Created: 2020-07-19T08:11:21.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-03-05T13:46:24.000Z (over 2 years ago)
- Last Synced: 2024-10-12T16:21:06.892Z (25 days ago)
- Topics: cpp, cpp20, reflection
- Language: C++
- Homepage:
- Size: 933 KB
- Stars: 354
- Watchers: 11
- Forks: 58
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
```
__ __ _______ .______ _______ _______ __
| | | | | \ | _ \ | ____|| ____|| |
| | | | | .--. || |_) | | |__ | |__ | |
| | | | | | | || / | __| | __| | |
| `--' | | '--' || |\ \----.| |____ | | | `----.
\______/ |_______/ | _| `._____||_______||__| |_______|
```
[](https://github.com/Ubpa/UDRefl/archive/master.zip) [](https://github.com/Ubpa/UDRefl/tags) [](LICENSE)
⭐ Star us on GitHub — it helps!
# UDRefl
> **U**bpa **D**ynamic **R**eflection
Extremely **fast** and **powerful** C++20 dynamic reflection library
## Documentaion [->](doc/)
- [to-do](doc/todo.md)
- [change log](doc/change_log.md)
- manual (TODO)
- overview
- [中文](doc/overview_zh_CN.md)
- introduction
- [English](doc/introduction_en_US.md)
- [中文](doc/introduction_zh_CN.md)
## How to Use
> the example code is [here](src/test/00_readme/main.cpp), other examples is [here](https://github.com/Ubpa/UDRefl#other-example)
Suppose you need to reflect `struct Vec`
```c++
struct Vec {
float x;
float y;
float norm() const {
return std::sqrt(x * x + y * y);
}
};
```
### Manual registration
```c++
Mngr.RegisterType();
Mngr.AddField<&Vec::x>("x");
Mngr.AddField<&Vec::y>("y");
Mngr.AddMethod<&Vec::norm>("norm");
```
### Iterate over members
```c++
for (auto&& [name, info] : FieldRange_of)
std::cout << name.GetView() << std::endl;
for (auto&& [name, info] : MethodRange_of)
std::cout << name.GetView() << std::endl;
```
### Constructing types
```c++
SharedObject v = Mngr.MakeShared(Type_of);
std::cout << v.GetType().GetName() << std::endl; // prints "Vec"
```
### Set/get variables
```c++
v.Var("x") = 3;
v.Var("y") = 4;
std::cout << "x: " << v.Var("x") << std::endl;
```
### Invoke Methods
```c++
std::cout << "norm: " << v.Invoke("norm") << std::endl;
```
### Iterate over variables
```c++
for (auto&& [name, var] : v.GetVars())
std::cout << name.GetView() << ": " << var << std::endl;
```
### other example
- [const & static](src/test/02_const_static/main.cpp)
- [method](src/test/03_method/main.cpp)
- [enum](src/test/04_enum/main.cpp)
- [overload](src/test/05_overload/main.cpp)
- [inheritance](src/test/06_inheritance/main.cpp)
- [virtual inheritance](src/test/07_virtual/main.cpp)
- [attr](src/test/08_attr/main.cpp)
- [lifetime (ctor, dtor)](src/test/09_lifecycle/main.cpp)
- [dynamic field](src/test/10_dynamic/main.cpp)
- [invoke](src/test/11_invoke/main.cpp)
- [meta function](src/test/12_Meta/main.cpp)
- [reference](src/test/13_ref/main.cpp)
- [serialize](src/test/15_serializer/main.cpp)
- [container](src/test/16_container/main.cpp)
- [compatible](src/test/17_compatible/main.cpp)
- [tuple](src/test/18_tuple/main.cpp)
- [pointer](src/test/19_pointer/main.cpp)
- [array](src/test/20_array/main.cpp)
- [string](src/test/21_string/main.cpp)
- [variant](src/test/22_variant/main.cpp)
- [optional](src/test/23_optional/main.cpp)
- [bootstrap](src/test/ext/00_bootstrap/main.cpp)
- [[data-driven] `RegisterType`](src/test/24_dd_type/main.cpp)
## Features
- global fields, methods or enums
- classes with **single**-, **multiple**- and **virtual**-inheritance
- constructors (arbitrary argument count) and destructors
- methods (**virtual**, **abstract**, **overloaded**, arbitrary argument count) : you can pass arguments by a buffer (on stack or heap)
- ability to invoke methods of classes from any arbitrary class level
- argument type auto **convertion** when invoking method
- no header pollution: the reflection information is created in the cpp file to minimize compile time when modifying the data
- working with custom types without the need of having the declaration of the type available at compile time (useful for plugins)
- possibility to add additional **attribute** to all reflection objects
- reference
- pointer, array
- standard container, iterator
- **meta** function
- operations: `operator +`, `operator-`, ...
- container: `begin`, `end`, `empty`, `size`, ...
- bootstrap
- **no** macro usage
- **no** rtti required
- **no** exceptions (this feature come with cost and is also regularly disabled on consoles)
- **no** external compiler or tool needed, only standard ISO C++20
## Compiler compatibility
- Clang/LLVM >= 10.0
- GCC >= 10.0
- MSVC >= 1926
> Tested platforms:
>
> - Windows 10: VS2019 16.8.5
>
> - Ubuntu 20: GCC 10.2, Clang 11.0
>
> - MacOS 11.0 : GCC 10.2
>
> > AppleClang 12 and Clang 11 is not supported
## Licensing
You can copy and paste the license summary from below.
```
MIT License
Copyright (c) 2020 Ubpa
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.
```