diff options
| author | realtradam <[email protected]> | 2022-03-12 22:01:56 -0500 |
|---|---|---|
| committer | realtradam <[email protected]> | 2022-03-12 22:01:56 -0500 |
| commit | f3d972c829a6f1e0bc00906d9e4220ef37db3ba2 (patch) | |
| tree | bd727278d7dec6580af5af7991270821d580517a /Readme.mdown | |
| parent | 3acb6c636d1ffac07e1dedbbdc22cb88fb16fada (diff) | |
| download | FelBind-f3d972c829a6f1e0bc00906d9e4220ef37db3ba2.tar.gz FelBind-f3d972c829a6f1e0bc00906d9e4220ef37db3ba2.zip | |
fix readme
Diffstat (limited to 'Readme.mdown')
| -rw-r--r-- | Readme.mdown | 44 |
1 files changed, 22 insertions, 22 deletions
diff --git a/Readme.mdown b/Readme.mdown index 06d29bf..bfda7ce 100644 --- a/Readme.mdown +++ b/Readme.mdown @@ -6,40 +6,40 @@ A binding assistant and generator for C/C++ to mruby(Under heavy WIP) - --- +--- ### How I plan for it to work: 1. Run the scanner which will generate a glue.json file. This json file will contain all functions(and their params) as well as all structs(and their params) - 2. Create a configuration file where you can reference specific functions and how you want their bindings to be generated differently +2. Create a configuration file where you can reference specific functions and how you want their bindings to be generated differently - for example, under what module or class a function should belong - if a certain param should use self instead of passing in something - ignore some functions if you dont need them - insert bindings you made yourself - 3. Run the generator with the configuration file - this generates the resulting binding code +3. Run the generator with the configuration file - this generates the resulting binding code #### Todo: - - [X] parse C files for function and struct declarations - - [X] plan for DSL for configuration file - - [ ] create generator's default output +- [X] parse C files for function and struct declarations +- [X] plan for DSL for configuration file +- [ ] create generator's default output - [X] phase 1 - bind returnless, paramless functions - [X] phase 2 - bind standard type return functions(e.g string or int), but still paramless - - bool - - int - - float - - double - - string + - bool + - int + - float + - double + - string - [X] phase 3 - bind standard type return or params -- [X] phase 4 - bind struct construction(returning struct objects) - - [X] returning structs - - [X] accessors for values inside structs - - [X] bind struct initializer + - [X] phase 4 - bind struct construction(returning struct objects) + - [X] returning structs + - [X] accessors for values inside structs + - [X] bind struct initializer - [ ] phase 5 - bind remaining struct related things - - [ ] struct as params of functions - - [ ] fix structs inside of structs - - [ ] for initilization - - [ ] for accessors - - [ ] clean up code - - [ ] have generator use config DSL file to customize bindings - - [ ] do it all again for C++ + - [ ] struct as params of functions + - [ ] fix structs inside of structs + - [ ] for initilization + - [ ] for accessors +- [ ] clean up code +- [ ] have generator use config DSL file to customize bindings +- [ ] do it all again for C++ |
