Skip to content

Latest commit

 

History

History
189 lines (147 loc) · 5.83 KB

README.md

File metadata and controls

189 lines (147 loc) · 5.83 KB
Raw

 __    __   _______  .______       _______  _______  __      
|  |  |  | |       \ |   _  \     |   ____||   ____||  |     
|  |  |  | |  .--.  ||  |_)  |    |  |__   |  |__   |  |     
|  |  |  | |  |  |  ||      /     |   __|  |   __|  |  |     
|  `--'  | |  '--'  ||  |\  \----.|  |____ |  |     |  `----.
 \______/  |_______/ | _| `._____||_______||__|     |_______|

repo-size tag license

⭐ Star us on GitHub — it helps!

UDRefl

Ubpa Dynamic Reflection

Extremely fast and powerful C++20 dynamic reflection library

Documentaion ->

How to Use

the example code is here, other examples is here

Suppose you need to reflect struct Vec

struct Vec {
  float x;
  float y;
  float norm() const {
    return std::sqrt(x * x + y * y);
  }
};

Manual registration

Mngr.RegisterType<Vec>();
Mngr.AddField<&Vec::x>("x");
Mngr.AddField<&Vec::y>("y");
Mngr.AddMethod<&Vec::norm>("norm");

Iterate over members

for (auto&& [name, info] : FieldRange_of<Vec>)
  std::cout << name.GetView() << std::endl;

for (auto&& [name, info] : MethodRange_of<Vec>)
  std::cout << name.GetView() << std::endl;

Constructing types

SharedObject v = Mngr.MakeShared(Type_of<Vec>);
std::cout << v.GetType().GetName() << std::endl; // prints "Vec"

Set/get variables

v.Var("x") = 3;
v.Var("y") = 4;
std::cout << "x: " << v.Var("x") << std::endl;

Invoke Methods

std::cout << "norm: " << v.Invoke("norm") << std::endl;

Iterate over variables

for (auto&& [name, var] : v.GetVars())
  std::cout << name.GetView() << ": " << var << std::endl;

other example

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.