pocketpy/include/pocketpy/pocketpy.h

#pragma once

#include <stdint.h>
#include <stdbool.h>
#include <stddef.h>

#include "pocketpy/config.h"
#include "pocketpy/export.h"
#include "pocketpy/linalg.h"

#ifdef __cplusplus
extern "C" {
#endif

/************* Public Types *************/

/// A opaque type that represents a python object. You cannot access its members directly.
typedef struct py_TValue py_TValue;
/// An integer that represents a python identifier. This is to achieve string pooling and fast name
/// resolution.
typedef uint16_t py_Name;
/// An integer that represents a python type. `0` is invalid.
typedef int16_t py_Type;
/// A 64-bit integer type. Corresponds to `int` in python.
typedef int64_t py_i64;
/// A 64-bit floating-point type. Corresponds to `float` in python.
typedef double py_f64;
/// A generic destructor function.
typedef void (*py_Dtor)(void*);

/// A string view type. It is helpful for passing strings which are not null-terminated.
typedef struct c11_sv {
    const char* data;
    int size;
} c11_sv;

/// A struct contains the callbacks of the VM.
typedef struct py_Callbacks {
    /// Used by `__import__` to load source code of a module.
    char* (*importfile)(const char*);
    /// Used by `print` to output a string.
    void (*print)(const char*);
} py_Callbacks;

#define PY_RAISE
#define PY_RETURN

/// A generic reference to a python object.
typedef py_TValue* py_Ref;
/// A reference which has the same lifespan as the python object.
typedef py_TValue* py_ObjectRef;
/// A global reference which has the same lifespan as the VM.
typedef py_TValue* py_GlobalRef;
/// A specific location in the value stack of the VM.
typedef py_TValue* py_StackRef;
/// An item reference to a container object. It invalidates when the container is modified.
typedef py_TValue* py_ItemRef;
/// An output reference for returning a value.
typedef py_TValue* py_OutRef;

/// Native function signature.
/// @param argc number of arguments.
/// @param argv array of arguments. Use `py_arg(i)` macro to get the i-th argument.
/// @return `true` if the function is successful or `false` if an exception is raised.
typedef bool (*py_CFunction)(int argc, py_StackRef argv) PY_RAISE PY_RETURN;

/// Python compiler modes.
/// + `EXEC_MODE`: for statements.
/// + `EVAL_MODE`: for expressions.
/// + `SINGLE_MODE`: for REPL or jupyter notebook execution.
enum py_CompileMode { EXEC_MODE, EVAL_MODE, SINGLE_MODE };

/// A shorthand for `True`.
PK_EXPORT extern py_GlobalRef py_True;
/// A shorthand for `False`.
PK_EXPORT extern py_GlobalRef py_False;
/// A shorthand for `None`.
PK_EXPORT extern py_GlobalRef py_None;
/// A shorthand for `nil`. `nil` is not a valid python object.
PK_EXPORT extern py_GlobalRef py_NIL;

/************* Global Setup *************/

/// Initialize pocketpy and the default VM.
PK_EXPORT void py_initialize();
/// Finalize pocketpy and free all VMs.
PK_EXPORT void py_finalize();
/// Get the current VM index.
PK_EXPORT int py_currentvm();
/// Switch to a VM.
/// @param index index of the VM ranging from 0 to 16 (exclusive). `0` is the default VM.
PK_EXPORT void py_switchvm(int index);
/// Reset the current VM.
PK_EXPORT void py_resetvm();
/// Get the current VM context. This is used for user-defined data.
PK_EXPORT void* py_getvmctx();
/// Set the current VM context. This is used for user-defined data.
PK_EXPORT void py_setvmctx(void* ctx);
/// Set `sys.argv`. Used for storing command-line arguments.
PK_EXPORT void py_sys_setargv(int argc, char** argv);
/// Setup the callbacks for the current VM.
PK_EXPORT py_Callbacks* py_callbacks();

/// Run a source string.
/// @param source source string.
/// @param filename filename (for error messages).
/// @param mode compile mode. Use `EXEC_MODE` for statements `EVAL_MODE` for expressions.
/// @param module target module. Use NULL for the main module.
/// @return `true` if the execution is successful or `false` if an exception is raised.
PK_EXPORT bool py_exec(const char* source,
                       const char* filename,
                       enum py_CompileMode mode,
                       py_Ref module) PY_RAISE PY_RETURN;

/// Evaluate a source string. Equivalent to `py_exec(source, "<string>", EVAL_MODE, module)`.
PK_EXPORT bool py_eval(const char* source, py_Ref module) PY_RAISE PY_RETURN;

/// Run a source string with smart interpretation.
/// Example:
/// `py_newstr(py_r0(), "abc");`
/// `py_newint(py_r1(), 123);`
/// `py_smartexec("print(_0, _1)", NULL, py_r0(), py_r1());`
/// `// "abc 123" will be printed`.
PK_EXPORT bool py_smartexec(const char* source, py_Ref module, ...) PY_RAISE PY_RETURN;
/// Evaluate a source string with smart interpretation.
/// Example:
/// `py_newstr(py_r0(), "abc");`
/// `py_smarteval("len(_)", NULL, py_r0());`
/// `int res = py_toint(py_retval());`
/// `// res will be 3`.
PK_EXPORT bool py_smarteval(const char* source, py_Ref module, ...) PY_RAISE PY_RETURN;

/// Compile a source string into a code object.
/// Use python's `exec()` or `eval()` to execute it.
PK_EXPORT bool py_compile(const char* source,
                          const char* filename,
                          enum py_CompileMode mode,
                          bool is_dynamic) PY_RAISE PY_RETURN;

/// Python equivalent to `globals()`.
PK_EXPORT void py_newglobals(py_OutRef);
/// Python equivalent to `locals()`.
/// @return a temporary object, which expires on the associated function return.
PK_EXPORT void py_newlocals(py_OutRef);

/************* Values Creation *************/

/// Create an `int` object.
PK_EXPORT void py_newint(py_OutRef, py_i64);
/// Create a `float` object.
PK_EXPORT void py_newfloat(py_OutRef, py_f64);
/// Create a `bool` object.
PK_EXPORT void py_newbool(py_OutRef, bool);
/// Create a `str` object from a null-terminated string (utf-8).
PK_EXPORT void py_newstr(py_OutRef, const char*);
/// Create a `str` object from a char array (utf-8).
PK_EXPORT void py_newstrn(py_OutRef, const char*, int);
/// Create a `bytes` object with `n` UNINITIALIZED bytes.
PK_EXPORT unsigned char* py_newbytes(py_OutRef, int n);
/// Create a `None` object.
PK_EXPORT void py_newnone(py_OutRef);
/// Create a `NotImplemented` object.
PK_EXPORT void py_newnotimplemented(py_OutRef);
/// Create a `...` object.
PK_EXPORT void py_newellipsis(py_OutRef);
/// Create a `nil` object. `nil` is an invalid representation of an object.
/// Don't use it unless you know what you are doing.
PK_EXPORT void py_newnil(py_OutRef);
/// Create a `tuple` with `n` UNINITIALIZED elements.
/// You should initialize all elements before using it.
PK_EXPORT void py_newtuple(py_OutRef, int n);
/// Create an empty `list`.
PK_EXPORT void py_newlist(py_OutRef);
/// Create a `list` with `n` UNINITIALIZED elements.
/// You should initialize all elements before using it.
PK_EXPORT void py_newlistn(py_OutRef, int n);
/// Create an empty `dict`.
PK_EXPORT void py_newdict(py_OutRef);
/// Create an UNINITIALIZED `slice` object.
/// You should use `py_setslot()` to set `start`, `stop`, and `step`.
PK_EXPORT void py_newslice(py_OutRef);
/// Create a `nativefunc` object.
PK_EXPORT void py_newnativefunc(py_OutRef, py_CFunction);
/// Create a `function` object.
PK_EXPORT py_Name py_newfunction(py_OutRef out,
                                 const char* sig,
                                 py_CFunction f,
                                 const char* docstring,
                                 int slots);
/// Create a `boundmethod` object.
PK_EXPORT void py_newboundmethod(py_OutRef out, py_Ref self, py_Ref func);

/************* Name Convertions *************/

/// Convert a null-terminated string to a name.
PK_EXPORT py_Name py_name(const char*);
/// Convert a name to a null-terminated string.
PK_EXPORT const char* py_name2str(py_Name);
/// Convert a `c11_sv` to a name.
PK_EXPORT py_Name py_namev(c11_sv);
/// Convert a name to a `c11_sv`.
PK_EXPORT c11_sv py_name2sv(py_Name);

#define py_ismagicname(name) (name <= __missing__)

/************* Meta Operations *************/

/// Create a new type.
/// @param name name of the type.
/// @param base base type.
/// @param module module where the type is defined. Use `NULL` for built-in types.
/// @param dtor destructor function. Use `NULL` if not needed.
PK_EXPORT py_Type py_newtype(const char* name,
                             py_Type base,
                             const py_GlobalRef module,
                             py_Dtor dtor);

/// Create a new object.
/// @param out output reference.
/// @param type type of the object.
/// @param slots number of slots. Use `-1` to create a `__dict__`.
/// @param udsize size of your userdata.
/// @return pointer to the userdata.
PK_EXPORT void* py_newobject(py_OutRef out, py_Type type, int slots, int udsize);

/************* Type Cast *************/

/// Convert an `int` object in python to `int64_t`.
PK_EXPORT py_i64 py_toint(py_Ref);
/// Convert a `float` object in python to `double`.
PK_EXPORT py_f64 py_tofloat(py_Ref);
/// Cast a `int` or `float` object in python to `double`.
/// If successful, return true and set the value to `out`.
/// Otherwise, return false and raise `TypeError`.
PK_EXPORT bool py_castfloat(py_Ref, py_f64* out) PY_RAISE;
/// Cast a `int` object in python to `int64_t`.
PK_EXPORT bool py_castint(py_Ref, py_i64* out) PY_RAISE;
/// Convert a `bool` object in python to `bool`.
PK_EXPORT bool py_tobool(py_Ref);
/// Convert a `type` object in python to `py_Type`.
PK_EXPORT py_Type py_totype(py_Ref);
/// Convert a `str` object in python to null-terminated string.
PK_EXPORT const char* py_tostr(py_Ref);
/// Convert a `str` object in python to char array.
PK_EXPORT const char* py_tostrn(py_Ref, int* size);
/// Convert a `str` object in python to `c11_sv`.
PK_EXPORT c11_sv py_tosv(py_Ref);
/// Convert a `bytes` object in python to char array.
PK_EXPORT unsigned char* py_tobytes(py_Ref, int* size);
/// Convert a user-defined object to its userdata.
PK_EXPORT void* py_touserdata(py_Ref);

#define py_isint(self) py_istype(self, tp_int)
#define py_isfloat(self) py_istype(self, tp_float)
#define py_isbool(self) py_istype(self, tp_bool)
#define py_isstr(self) py_istype(self, tp_str)
#define py_islist(self) py_istype(self, tp_list)
#define py_istuple(self) py_istype(self, tp_tuple)
#define py_isdict(self) py_istype(self, tp_dict)

#define py_isnil(self) py_istype(self, 0)
#define py_isnone(self) py_istype(self, tp_NoneType)

/// Get the type of the object.
PK_EXPORT py_Type py_typeof(py_Ref self);
/// Get type by module and name. e.g. `py_gettype("time", py_name("struct_time"))`.
/// Return `0` if not found.
PK_EXPORT py_Type py_gettype(const char* module, py_Name name);
/// Check if the object is exactly the given type.
PK_EXPORT bool py_istype(py_Ref, py_Type);
/// Check if the object is an instance of the given type.
PK_EXPORT bool py_isinstance(py_Ref obj, py_Type type);
/// Check if the derived type is a subclass of the base type.
PK_EXPORT bool py_issubclass(py_Type derived, py_Type base);

/// Get the magic method from the given type only.
/// The returned reference is always valid. However, its value may be `nil`.
PK_EXPORT py_GlobalRef py_tpgetmagic(py_Type type, py_Name name);
/// Search the magic method from the given type to the base type.
/// Return `NULL` if not found.
PK_EXPORT py_GlobalRef py_tpfindmagic(py_Type, py_Name name);
/// Search the name from the given type to the base type.
/// Return `NULL` if not found.
PK_EXPORT py_ItemRef py_tpfindname(py_Type, py_Name name);

/// Get the type object of the given type.
PK_EXPORT py_GlobalRef py_tpobject(py_Type type);
/// Get the type name.
PK_EXPORT const char* py_tpname(py_Type type);
/// Call a type to create a new instance.
PK_EXPORT bool py_tpcall(py_Type type, int argc, py_Ref argv) PY_RAISE PY_RETURN;

/// Check if the object is an instance of the given type.
/// Raise `TypeError` if the check fails.
PK_EXPORT bool py_checktype(py_Ref self, py_Type type) PY_RAISE;

#define py_checkint(self) py_checktype(self, tp_int)
#define py_checkfloat(self) py_checktype(self, tp_float)
#define py_checkbool(self) py_checktype(self, tp_bool)
#define py_checkstr(self) py_checktype(self, tp_str)

/************* References *************/

/// Get the i-th register.
/// All registers are located in a contiguous memory.
PK_EXPORT py_GlobalRef py_getreg(int i);
/// Set the i-th register.
PK_EXPORT void py_setreg(int i, py_Ref val);

#define py_r0() py_getreg(0)
#define py_r1() py_getreg(1)
#define py_r2() py_getreg(2)
#define py_r3() py_getreg(3)
#define py_r4() py_getreg(4)
#define py_r5() py_getreg(5)
#define py_r6() py_getreg(6)
#define py_r7() py_getreg(7)

/// Get variable in the `__main__` module.
PK_EXPORT py_ItemRef py_getglobal(py_Name name);
/// Set variable in the `__main__` module.
PK_EXPORT void py_setglobal(py_Name name, py_Ref val);
/// Get variable in the `builtins` module.
PK_EXPORT py_ItemRef py_getbuiltin(py_Name name);

/// Equivalent to `*dst = *src`.
PK_EXPORT void py_assign(py_Ref dst, py_Ref src);
/// Get the last return value.
PK_EXPORT py_GlobalRef py_retval();

/// Get an item from the object's `__dict__`.
/// Return `NULL` if not found.
PK_EXPORT py_ItemRef py_getdict(py_Ref self, py_Name name);
/// Set an item to the object's `__dict__`.
PK_EXPORT void py_setdict(py_Ref self, py_Name name, py_Ref val);
/// Delete an item from the object's `__dict__`.
/// Return `true` if the deletion is successful.
PK_EXPORT bool py_deldict(py_Ref self, py_Name name);
/// Prepare an insertion to the object's `__dict__`.
PK_EXPORT py_ItemRef py_emplacedict(py_Ref self, py_Name name);
/// Apply a function to all items in the object's `__dict__`.
/// Return `true` if the function is successful for all items.
/// NOTE: Be careful if `f` modifies the object's `__dict__`.
PK_EXPORT bool
    py_applydict(py_Ref self, bool (*f)(py_Name name, py_Ref val, void* ctx), void* ctx) PY_RAISE;

/// Get the i-th slot of the object.
/// The object must have slots and `i` must be in valid range.
PK_EXPORT py_ObjectRef py_getslot(py_Ref self, int i);
/// Set the i-th slot of the object.
PK_EXPORT void py_setslot(py_Ref self, int i, py_Ref val);

/************* Inspection *************/

/// Get the current `function` object on the stack.
/// Return `NULL` if not available.
/// NOTE: This function should be placed at the beginning of your decl-based bindings.
PK_EXPORT py_StackRef py_inspect_currentfunction();
/// Get the current `module` object where the code is executed.
/// Return `NULL` if not available.
PK_EXPORT py_GlobalRef py_inspect_currentmodule();

/************* Bindings *************/

/// Bind a function to the object via "decl-based" style.
/// @param obj the target object.
/// @param sig signature of the function. e.g. `add(x, y)`.
/// @param f function to bind.
PK_EXPORT void py_bind(py_Ref obj, const char* sig, py_CFunction f);
/// Bind a method to type via "argc-based" style.
/// @param type the target type.
/// @param name name of the method.
/// @param f function to bind.
PK_EXPORT void py_bindmethod(py_Type type, const char* name, py_CFunction f);
/// Bind a function to the object via "argc-based" style.
/// @param obj the target object.
/// @param name name of the function.
/// @param f function to bind.
PK_EXPORT void py_bindfunc(py_Ref obj, const char* name, py_CFunction f);
/// Bind a property to type.
/// @param type the target type.
/// @param name name of the property.
/// @param getter getter function.
/// @param setter setter function. Use `NULL` if not needed.
PK_EXPORT void
    py_bindproperty(py_Type type, const char* name, py_CFunction getter, py_CFunction setter);

#define py_bindmagic(type, __magic__, f) py_newnativefunc(py_tpgetmagic((type), __magic__), (f))

#define PY_CHECK_ARGC(n)                                                                           \
    if(argc != n) return TypeError("expected %d arguments, got %d", n, argc)

#define PY_CHECK_ARG_TYPE(i, type)                                                                 \
    if(!py_checktype(py_arg(i), type)) return false

#define py_offset(p, i) ((py_Ref)((char*)p + ((i) << 4)))
#define py_arg(i) py_offset(argv, i)

/************* Python Equivalents *************/

/// Python equivalent to `getattr(self, name)`.
PK_EXPORT bool py_getattr(py_Ref self, py_Name name) PY_RAISE PY_RETURN;
/// Python equivalent to `setattr(self, name, val)`.
PK_EXPORT bool py_setattr(py_Ref self, py_Name name, py_Ref val) PY_RAISE;
/// Python equivalent to `delattr(self, name)`.
PK_EXPORT bool py_delattr(py_Ref self, py_Name name) PY_RAISE;
/// Python equivalent to `self[key]`.
PK_EXPORT bool py_getitem(py_Ref self, py_Ref key) PY_RAISE PY_RETURN;
/// Python equivalent to `self[key] = val`.
PK_EXPORT bool py_setitem(py_Ref self, py_Ref key, py_Ref val) PY_RAISE;
/// Python equivalent to `del self[key]`.
PK_EXPORT bool py_delitem(py_Ref self, py_Ref key) PY_RAISE;

/// Perform a binary operation.
/// The result will be set to `py_retval()`.
/// The stack remains unchanged after the operation.
PK_EXPORT bool py_binaryop(py_Ref lhs, py_Ref rhs, py_Name op, py_Name rop) PY_RAISE PY_RETURN;

#define py_binaryadd(lhs, rhs) py_binaryop(lhs, rhs, __add__, __radd__)
#define py_binarysub(lhs, rhs) py_binaryop(lhs, rhs, __sub__, __rsub__)
#define py_binarymul(lhs, rhs) py_binaryop(lhs, rhs, __mul__, __rmul__)
#define py_binarytruediv(lhs, rhs) py_binaryop(lhs, rhs, __truediv__, __rtruediv__)
#define py_binaryfloordiv(lhs, rhs) py_binaryop(lhs, rhs, __floordiv__, __rfloordiv__)
#define py_binarymod(lhs, rhs) py_binaryop(lhs, rhs, __mod__, __rmod__)
#define py_binarypow(lhs, rhs) py_binaryop(lhs, rhs, __pow__, __rpow__)

#define py_binarylshift(lhs, rhs) py_binaryop(lhs, rhs, __lshift__, 0)
#define py_binaryrshift(lhs, rhs) py_binaryop(lhs, rhs, __rshift__, 0)
#define py_binaryand(lhs, rhs) py_binaryop(lhs, rhs, __and__, 0)
#define py_binaryor(lhs, rhs) py_binaryop(lhs, rhs, __or__, 0)
#define py_binaryxor(lhs, rhs) py_binaryop(lhs, rhs, __xor__, 0)
#define py_binarymatmul(lhs, rhs) py_binaryop(lhs, rhs, __matmul__, 0)

/************* Stack Operations *************/

/// Get the i-th object from the top of the stack.
/// `i` should be negative, e.g. (-1) means TOS.
PK_EXPORT py_StackRef py_peek(int i);
/// Push the object to the stack.
PK_EXPORT void py_push(py_Ref src);
/// Push a `nil` object to the stack.
PK_EXPORT void py_pushnil();
/// Push a `None` object to the stack.
PK_EXPORT void py_pushnone();
/// Push a `py_Name` to the stack. This is used for keyword arguments.
PK_EXPORT void py_pushname(py_Name name);
/// Pop an object from the stack.
PK_EXPORT void py_pop();
/// Shrink the stack by n.
PK_EXPORT void py_shrink(int n);
/// Get a temporary variable from the stack.
PK_EXPORT py_StackRef py_pushtmp();
/// Get the unbound method of the object.
/// Assume the object is located at the top of the stack.
/// If return true:  `[self] -> [unbound, self]`.
/// If return false: `[self] -> [self]` (no change).
PK_EXPORT bool py_pushmethod(py_Name name);
/// Call a callable object.
/// Assume `argc + kwargc` arguments are already pushed to the stack.
/// The result will be set to `py_retval()`.
/// The stack size will be reduced by `argc + kwargc`.
PK_EXPORT bool py_vectorcall(uint16_t argc, uint16_t kwargc) PY_RAISE PY_RETURN;
/// Evaluate an expression and push the result to the stack.
/// This function is used for testing.
PK_EXPORT bool py_pusheval(const char* expr, py_GlobalRef module) PY_RAISE;

/************* Modules *************/

/// Create a new module.
PK_EXPORT py_GlobalRef py_newmodule(const char* path);
/// Get a module by path.
PK_EXPORT py_GlobalRef py_getmodule(const char* path);

/// Import a module.
/// The result will be set to `py_retval()`.
/// -1: error, 0: not found, 1: success
PK_EXPORT int py_import(const char* path) PY_RAISE;

/************* Errors *************/

/// Raise an exception by type and message. Always return false.
PK_EXPORT bool py_exception(py_Type type, const char* fmt, ...) PY_RAISE;
/// Raise an expection object. Always return false.
PK_EXPORT bool py_raise(py_Ref) PY_RAISE;
/// Print the current exception.
/// The exception will be set as handled.
PK_EXPORT void py_printexc();
/// Format the current exception and return a null-terminated string.
/// The result should be freed by the caller.
/// The exception will be set as handled.
PK_EXPORT char* py_formatexc();
/// Check if an exception is raised.
PK_EXPORT bool py_checkexc(bool ignore_handled);
/// Check if the exception is an instance of the given type.
/// This function is roughly equivalent to python's `except <T> as e:` block.
/// If match, the exception will be stored in `py_retval()` as handled.
PK_EXPORT bool py_matchexc(py_Type type) PY_RETURN;
/// Clear the current exception.
/// @param p0 the unwinding point. Use `NULL` if not needed.
PK_EXPORT void py_clearexc(py_StackRef p0);

#define NameError(n) py_exception(tp_NameError, "name '%n' is not defined", (n))
#define TypeError(...) py_exception(tp_TypeError, __VA_ARGS__)
#define RuntimeError(...) py_exception(tp_RuntimeError, __VA_ARGS__)
#define ValueError(...) py_exception(tp_ValueError, __VA_ARGS__)
#define IndexError(...) py_exception(tp_IndexError, __VA_ARGS__)
#define ImportError(...) py_exception(tp_ImportError, __VA_ARGS__)
#define ZeroDivisionError(...) py_exception(tp_ZeroDivisionError, __VA_ARGS__)
#define AttributeError(self, n)                                                                    \
    py_exception(tp_AttributeError, "'%t' object has no attribute '%n'", (self)->type, (n))
#define UnboundLocalError(n)                                                                       \
    py_exception(tp_UnboundLocalError, "local variable '%n' referenced before assignment", (n))

PK_EXPORT bool StopIteration() PY_RAISE;
PK_EXPORT bool KeyError(py_Ref key) PY_RAISE;

/************* Operators *************/

/// Python equivalent to `bool(val)`.
/// 1: true, 0: false, -1: error
PK_EXPORT int py_bool(py_Ref val) PY_RAISE;
/// Compare two objects.
/// 1: lhs == rhs, 0: lhs != rhs, -1: error
PK_EXPORT int py_equal(py_Ref lhs, py_Ref rhs) PY_RAISE;
/// Compare two objects.
/// 1: lhs < rhs, 0: lhs >= rhs, -1: error
PK_EXPORT int py_less(py_Ref lhs, py_Ref rhs) PY_RAISE;

#define py_eq(lhs, rhs) py_binaryop(lhs, rhs, __eq__, __eq__)
#define py_ne(lhs, rhs) py_binaryop(lhs, rhs, __ne__, __ne__)
#define py_lt(lhs, rhs) py_binaryop(lhs, rhs, __lt__, __gt__)
#define py_le(lhs, rhs) py_binaryop(lhs, rhs, __le__, __ge__)
#define py_gt(lhs, rhs) py_binaryop(lhs, rhs, __gt__, __lt__)
#define py_ge(lhs, rhs) py_binaryop(lhs, rhs, __ge__, __le__)

/// Get the hash value of the object.
PK_EXPORT bool py_hash(py_Ref, py_i64* out) PY_RAISE;
/// Get the iterator of the object.
PK_EXPORT bool py_iter(py_Ref) PY_RAISE PY_RETURN;
/// Get the next element from the iterator.
/// 1: success, 0: StopIteration, -1: error
PK_EXPORT int py_next(py_Ref) PY_RAISE PY_RETURN;
/// Python equivalent to `lhs is rhs`.
PK_EXPORT bool py_isidentical(py_Ref, py_Ref);
/// Call a function.
/// It prepares the stack and then performs a `vectorcall(argc, 0, false)`.
/// The result will be set to `py_retval()`.
/// The stack remains unchanged after the operation.
PK_EXPORT bool py_call(py_Ref f, int argc, py_Ref argv) PY_RAISE PY_RETURN;

#ifndef NDEBUG
/// Call a `py_CFunction` in a safe way.
/// This function does extra checks to help you debug `py_CFunction`.
PK_EXPORT bool py_callcfunc(py_CFunction f, int argc, py_Ref argv) PY_RAISE PY_RETURN;
#else
#define py_callcfunc(f, argc, argv) (f((argc), (argv)))
#endif

/// Python equivalent to `str(val)`.
PK_EXPORT bool py_str(py_Ref val) PY_RAISE PY_RETURN;
/// Python equivalent to `repr(val)`.
PK_EXPORT bool py_repr(py_Ref val) PY_RAISE PY_RETURN;
/// Python equivalent to `len(val)`.
PK_EXPORT bool py_len(py_Ref val) PY_RAISE PY_RETURN;
/// Python equivalent to `json.dumps(val)`.
PK_EXPORT bool py_json_dumps(py_Ref val) PY_RAISE PY_RETURN;
/// Python equivalent to `json.loads(val)`.
PK_EXPORT bool py_json_loads(const char* source) PY_RAISE PY_RETURN;

/************* Unchecked Functions *************/

PK_EXPORT py_ObjectRef py_tuple_data(py_Ref self);
PK_EXPORT py_ObjectRef py_tuple_getitem(py_Ref self, int i);
PK_EXPORT void py_tuple_setitem(py_Ref self, int i, py_Ref val);
PK_EXPORT int py_tuple_len(py_Ref self);

PK_EXPORT py_ItemRef py_list_data(py_Ref self);
PK_EXPORT py_ItemRef py_list_getitem(py_Ref self, int i);
PK_EXPORT void py_list_setitem(py_Ref self, int i, py_Ref val);
PK_EXPORT void py_list_delitem(py_Ref self, int i);
PK_EXPORT int py_list_len(py_Ref self);
PK_EXPORT void py_list_swap(py_Ref self, int i, int j);
PK_EXPORT void py_list_append(py_Ref self, py_Ref val);
PK_EXPORT py_ItemRef py_list_emplace(py_Ref self);
PK_EXPORT void py_list_clear(py_Ref self);
PK_EXPORT void py_list_insert(py_Ref self, int i, py_Ref val);

/// -1: error, 0: not found, 1: found
PK_EXPORT int py_dict_getitem(py_Ref self, py_Ref key) PY_RAISE PY_RETURN;
/// true: success, false: error
PK_EXPORT bool py_dict_setitem(py_Ref self, py_Ref key, py_Ref val) PY_RAISE;
/// -1: error, 0: not found, 1: found (and deleted)
PK_EXPORT int py_dict_delitem(py_Ref self, py_Ref key) PY_RAISE;
/// -1: error, 0: not found, 1: found
PK_EXPORT int py_dict_getitem_by_str(py_Ref self, const char* key) PY_RAISE PY_RETURN;
/// true: success, false: error
PK_EXPORT bool py_dict_setitem_by_str(py_Ref self, const char* key, py_Ref val) PY_RAISE;
/// -1: error, 0: not found, 1: found (and deleted)
PK_EXPORT int py_dict_delitem_by_str(py_Ref self, const char* key) PY_RAISE;
/// true: success, false: error
PK_EXPORT bool
    py_dict_apply(py_Ref self, bool (*f)(py_Ref key, py_Ref val, void* ctx), void* ctx) PY_RAISE;
/// noexcept
PK_EXPORT int py_dict_len(py_Ref self);

/************* linalg module *************/
void py_newvec2(py_OutRef out, c11_vec2);
void py_newvec3(py_OutRef out, c11_vec3);
void py_newvec2i(py_OutRef out, c11_vec2i);
void py_newvec3i(py_OutRef out, c11_vec3i);
c11_mat3x3* py_newmat3x3(py_OutRef out);
c11_vec2 py_tovec2(py_Ref self);
c11_vec3 py_tovec3(py_Ref self);
c11_vec2i py_tovec2i(py_Ref self);
c11_vec3i py_tovec3i(py_Ref self);
c11_mat3x3* py_tomat3x3(py_Ref self);

/************* Others *************/

/// An utility function to read a line from stdin for REPL.
PK_EXPORT int py_replinput(char* buf, int max_size);

/// Python favored string formatting.
/// %d: int
/// %i: py_i64 (int64_t)
/// %f: py_f64 (double)
/// %s: const char*
/// %q: c11_sv
/// %v: c11_sv
/// %c: char
/// %p: void*
/// %t: py_Type
/// %n: py_Name

enum py_MagicNames {
    py_MagicNames__NULL,  // 0 is reserved

#define MAGIC_METHOD(x) x,
#include "pocketpy/xmacros/magics.h"
#undef MAGIC_METHOD
};

enum py_PredefinedTypes {
    tp_nil = 0,
    tp_object = 1,
    tp_type,  // py_Type
    tp_int,
    tp_float,
    tp_bool,
    tp_str,
    tp_str_iterator,
    tp_list,   // c11_vector
    tp_tuple,  // N slots
    tp_array_iterator,
    tp_slice,  // 3 slots (start, stop, step)
    tp_range,
    tp_range_iterator,
    tp_module,
    tp_function,
    tp_nativefunc,
    tp_boundmethod,
    tp_super,          // 1 slot + py_Type
    tp_BaseException,  // 2 slots (arg + inner_exc)
    tp_Exception,
    tp_bytes,
    tp_namedict,
    tp_locals,
    tp_code,
    tp_dict,
    tp_dict_items,    // 1 slot
    tp_property,      // 2 slots (getter + setter)
    tp_star_wrapper,  // 1 slot + int level
    tp_staticmethod,  // 1 slot
    tp_classmethod,   // 1 slot
    tp_NoneType,
    tp_NotImplementedType,
    tp_ellipsis,
    tp_generator,
    /* builtin exceptions */
    tp_SystemExit,
    tp_KeyboardInterrupt,
    tp_StopIteration,
    tp_SyntaxError,
    tp_StackOverflowError,
    tp_IOError,
    tp_OSError,
    tp_NotImplementedError,
    tp_TypeError,
    tp_IndexError,
    tp_ValueError,
    tp_RuntimeError,
    tp_ZeroDivisionError,
    tp_NameError,
    tp_UnboundLocalError,
    tp_AttributeError,
    tp_ImportError,
    tp_AssertionError,
    tp_KeyError,
    /* Extended */
    tp_vec2,
    tp_vec3,
    tp_vec2i,
    tp_vec3i,
    tp_mat3x3,
};

#ifdef __cplusplus
}
#endif