diff options
| author | realtradam <[email protected]> | 2022-04-01 04:02:25 -0400 |
|---|---|---|
| committer | realtradam <[email protected]> | 2022-04-01 04:02:25 -0400 |
| commit | 2ae12787183ceb253e8f6abfc57de009d5e71aab (patch) | |
| tree | db3d0cd6b3f310b09ecfbddc9d627fdbd3a40a0d /Readme.mdown | |
| parent | 2f93334dc43f92f50196f1c39c7fb9ce40f4c562 (diff) | |
| download | FelBind-2ae12787183ceb253e8f6abfc57de009d5e71aab.tar.gz FelBind-2ae12787183ceb253e8f6abfc57de009d5e71aab.zip | |
working function bindings
Diffstat (limited to 'Readme.mdown')
| -rw-r--r-- | Readme.mdown | 16 |
1 files changed, 9 insertions, 7 deletions
diff --git a/Readme.mdown b/Readme.mdown index 8ca731b..0bacf4d 100644 --- a/Readme.mdown +++ b/Readme.mdown @@ -4,7 +4,7 @@ [](https://ko-fi.com/tradam) -A binding assistant and generator for C/C++ to mruby(Under heavy WIP) +A binding assistant and generator for C(and maybe C++ later?) to mruby [Under heavy WIP] --- @@ -28,8 +28,11 @@ The defaults of FelBind make some assumptions on how you would like the resultin - `Test.some_function` - Structs are defined as classes under a module(by default `Test`) - `Test::MyStruct` +- Struct values are read or written to by using the snake_case version of their respective members + - `my_struct_object.value_example` + - `my_struct_object.value_example = 5` - Functions beginning with `Set` get bound as a method with `=` - - `SetSomeFunction(value)` => `some_function = value` + - `SetSomeFunction(value)` => `Test.some_function = value` - Functions beginning with `Get` get bound as a method without it - `GetSomeFunction()` => `some_function` @@ -37,16 +40,15 @@ The defaults of FelBind make some assumptions on how you would like the resultin - Wrapping functions that return or have parameters that are of the basic C types(int, float, char \*, etc) or their pointers(int \*, float \*, etc[except char *]) - Wrapping function that return or have parameters that are structs or their pointers -- Wrapping structs +- Wrapping structs into objects - Giving struct objects initializers and accessers ### What Doesn't Work: -- Binding C functions that begin with `Set` are bound incorrectly -- Making accessors for structs that contain structs -- kwargs should follow snake_case naming conventions +- Binding accessors for structs that contain structs or pointers +- Cloning struct objects - The config system -- Struct Aliases(might make this manually done) +- Struct Aliases(might make this manually done in the config system) ### What isnt currently planned to make work: |