inline-python-0.3.0.0: include/inline-python.h

#pragma once

#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <Rts.h>


// Available since 3.13
#ifndef PyCFunctionFast
typedef _PyCFunctionFast PyCFunctionFast;
#endif

// Available since 3.13
//
// We define here compat dummy which always says No
#ifndef Py_IsFinalizing
#define Py_IsFinalizing(x) 0
#endif

// General initialization of internal on C side
void inline_py_initialize(void);


// ================================================================
// Callbacks
// ================================================================

// Wrap haskell callback using METH_NOARGS calling convention
PyObject *inline_py_callback_METH_NOARGS(PyCFunction fun);

// Wrap haskell callback using METH_O calling convention
PyObject *inline_py_callback_METH_O(PyCFunction fun);

// Wrap haskell callback using METH_FASTCALL calling convention
PyObject *inline_py_callback_METH_FASTCALL(PyCFunctionFast fun);



// ================================================================
// Marhsalling
// ================================================================

// Unpack iterable into array of PyObjects. Iterable must contain
// exactly N elements.
//
// On success returns 0 and fills `out` with N PyObjects
//
// On failure return -1. Content of out is then undefined and it
// doesn't contain live python objects. If failure is due to python
// exception it's not cleared.
int inline_py_unpack_iterable(
    PyObject  *iterable,
    int        n,
    PyObject **out
    );

// Python's C API only gained public function to create integers of
// arbitrary size in 3.13. We have to use internals for earlier
// versions.
PyObject* inline_py_Integer_ToPy(
    void*  buf,    // Buffer holding number 
    size_t size,   // Buffer size in bytes
    int    sign    // Sign of number (0 is +, 1 is -)
);

// Compute size of buffer which can hold decoded number 
// and satistfy Integer's requirements
//
// See: NOTE: [Integer encoding/decoding]
//
// PRECONDITION: parameter must instance of PyLong. This is not
//               checked.
// PRECONDITION: passed number must be positive
ssize_t inline_py_Long_ByteSize(PyObject* p);

// Parse python integral number into buffer. This is compatibility
// shim.
//
// PRECONDITION: parameter must instance of PyLong. This is not
//               checked.
void inline_py_Integer_FromPy(
    PyObject* p,
    void*     buf,
    size_t    size
);



// ================================================================
// runPyAsync & Async exceptions
// ================================================================

// Force clear error possibly raised by PyThreadState_SetAsyncExc
//
// Ordinary PyErr_Clear doesn't work. One needed python interpreter to
// perform somce work in order to see raised exception.
void inline_py_clear_error(void);

// Initialize thread local storage as used by runPyAsync
void inline_py_init_state(void *stack);

// Delete thread local storage used by runPyAsync
void inline_py_free_state(void);

// Return stable pointer to stack from TLS
void* inline_py_get_state(void);



// ================================================================
// inline_python module
// ================================================================

// Function pointers to be set from haskell side

// String representation of an exception
extern PyObject* (*inline_py_haskell_error_repr)(void*);
// String representation of exception type
extern PyObject* (*inline_py_haskell_error_tyrepr)(void*);


PyMODINIT_FUNC PyInit_inline_python(void);

// Obtain type for async exception.
PyObject* inline_py_AsyncCancelled();

// Obtain type for wrapper for haskell exceptions.
PyObject* inline_py_HaskellError();

// Create python object wrapping haskell exception
PyObject* inline_py_HaskellError_create(void* exc_ptr);

// Get StablePtr held by exception. Python object must be of type
// HaskellError
void* inline_py_HaskellError_get_stableptr(PyObject* err);