Zxc200611/pocketpy
1
0
Fork 0
mirror of https://github.com/pocketpy/pocketpy synced 2025-10-20 19:40:18 +00:00
Code Issues Packages Projects Releases Wiki Activity

...

Browse Source
This commit is contained in:
blueloveTH 2023-09-30 15:21:25 +08:00
parent c5f9d57583
commit cdc2d23b2c
1 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
docs/bindings.md
View File

@ -15,21 +15,15 @@ It takes a C header file and generates a python module stub (`*.pyi`) and a C++
## Manual bindings ## Manual bindings
!!! pkpy uses an universal signature to wrap a function pointer as a python function or method that can be called in python code, i.e `NativeFuncC`.
This document is working in progress.
!!!
pkpy allows to wrap a function pointer as a python function or method that can be called in python code.
This function pointer has the following signature:
```cpp ```cpp
typedef PyObject* (*NativeFuncC)(VM*, ArgsView); typedef PyObject* (*NativeFuncC)(VM*, ArgsView);
``` ```
+ The first argument is the pointer of `VM` instance. + The first argument is the pointer of `VM` instance.
+ The second argument is an array-like object indicates the arguments list. You can use `[]` operator to get the element. + The second argument is an array-like object indicates the arguments list. You can use `[]` operator to get the element and call `size()` to get the length of the array.
+ The return value is a `PyObject*`, which should not be `nullptr`. If there is no return value, return `vm->None`. + The return value is a `PyObject*`, which should not be `nullptr`. If there is no return value, return `vm->None`.
### Bind a function or method ### Bind a function or method
Use `vm->bind` to bind a function or method. Use `vm->bind` to bind a function or method.
@ -40,21 +34,25 @@ Use `vm->bind` to bind a function or method.
```cpp ```cpp
vm->bind(obj, "add(a: int, b: int) -> int", [](VM* vm, ArgsView args){ vm->bind(obj, "add(a: int, b: int) -> int", [](VM* vm, ArgsView args){
int a = CAST(int, args[0]); int a = py_cast<int>(vm, args[0]);
int b = CAST(int, args[1]); int b = py_cast<int>(vm, args[1]);
return VAR(a + b); return py_var(vm, a + b);
}); });
// or you can provide a docstring // or you can provide a docstring
vm->bind(obj, vm->bind(obj,
"add(a: int, b: int) -> int", "add(a: int, b: int) -> int",
"add two integers", [](VM* vm, ArgsView args){ "add two integers", [](VM* vm, ArgsView args){
int a = CAST(int, args[0]); int a = py_cast<int>(vm, args[0]);
int b = CAST(int, args[1]); int b = py_cast<int>(vm, args[1]);
return VAR(a + b); return py_var(vm, a + b);
}); });
``` ```
!!!
Other documents are working in progress.
!!!
### Bind a property ### Bind a property
a property is a python's `property` that attached to a type instance with a getter and an optional setter. It is a data descriptor. A property redirects attribute access to specific functions. a property is a python's `property` that attached to a type instance with a getter and an optional setter. It is a data descriptor. A property redirects attribute access to specific functions.