AuroraSupport/AuroraInterfaces
1
1
Fork 0
Code Issues 1 Pull Requests Releases 4 Wiki Activity

Merge branch 'master' of https://gitea.reece.sx/AuroraSupport/AuroraInterfaces

Browse Source
This commit is contained in:
Reece Wilson 2021-10-28 23:49:02 +01:00
commit e2c742082c
1 changed files with 28 additions and 19 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

47
README.md
View File

@ -5,7 +5,7 @@ This library implements the macros required to define Aurora style interfaces. D
## Example usage:
#### In your common header:
```
```c
#if defined(MY_LIB_GEN_BINDINGS)
#define LIB_INTERFACE(name, list) AUI_INTERFACE_IMPL(name, list)
#define
@ -14,7 +14,7 @@ This library implements the macros required to define Aurora style interfaces. D
```
#### In your public API:
```
```c
LIB_INTERFACE(IInputMouseSubscriber,
AUI_METHOD(void, onButtonPress, (AuUInt8, mb)),
AUI_METHOD(void, onButtonTick, (AuUInt8, mb)),
@ -23,26 +23,19 @@ LIB_INTERFACE(IInputMouseSubscriber,
```
#### In a dedicated translation unit:
```
```c++
#define MY_LIB_GEN_BINDINGS
#include <...>
#include <AuroraForEach.hpp>
#include <AuroraInterfaces.hpp>
#include <[MyPublicAPI].hpp>
```
#### Usage Runtime Binding and Modern C++
#### Usage: C++ inheritance (covers SWIG and CppSharp)
```
// My language binding
IInputMouseSubscriberFunctional test;
test.onButtonPress = [](AuUInt8 btn)
{
#include <AuroraForEach.hpp>
#include <AuroraInterfaces.hpp>
#include <[MyPublicAPI].hpp>
};
AuSPtr<IInputMouseSubscriber> handle = AuUnsafeRaiiToShared(&test);
// use handle with an Aurora API
```
#### Usage C++ Native, SWIG, and CppSharp
```
struct MyEventHandler : public IInputMouseSubscriber
{
void onButtonPress(AuUInt8 mb) override;
@ -50,8 +43,24 @@ struct MyEventHandler : public IInputMouseSubscriber
void onButtonUp(AuUInt8 mb) override;
};
auto handle = AuMakeShared<MyEventHandler>();
static AuSPtr<IInputMouseSubscriber> MyMouseSubscriber()
{
return AuMakeShared<MyEventHandler>();
}
```
#### Usage: Runtime bindings and modern C++
``` c++
// My language binding
auto test = AuMakeShared<IInputMouseSubscriberFunctional>();
test->onButtonPress = [](AuUInt8 btn)
{
};
```
## Dependencies
* [AuroraForEach](https://git.reece.sx/AuroraSupport/AuroraForEach) [header only]
##### Not recommended for small projects and/or people with a shred of sanity left
##### Possibly useful for API developers
##### Possibly useful for API developers