pythonmonkey.cc File Reference

This file defines the pythonmonkey module, along with its various functions. More...

#include "include/modules/pythonmonkey/pythonmonkey.hh"
#include "include/setSpiderMonkeyException.hh"
#include "include/JSFunctionProxy.hh"
#include "include/JSMethodProxy.hh"
#include "include/JSArrayIterProxy.hh"
#include "include/JSArrayProxy.hh"
#include "include/JSObjectIterProxy.hh"
#include "include/JSObjectKeysProxy.hh"
#include "include/JSObjectValuesProxy.hh"
#include "include/JSObjectItemsProxy.hh"
#include "include/JSObjectProxy.hh"
#include "include/JSStringProxy.hh"
#include "include/pyTypeFactory.hh"
#include "include/PyEventLoop.hh"
#include "include/internalBinding.hh"
#include <jsapi.h>
#include <jsfriendapi.h>
#include <js/friend/ErrorMessages.h>
#include <js/friend/DOMProxy.h>
#include <js/CompilationAndEvaluation.h>
#include <js/ContextOptions.h>
#include <js/Class.h>
#include <js/Date.h>
#include <js/Initialization.h>
#include <js/Object.h>
#include <js/Proxy.h>
#include <js/SourceText.h>
#include <js/Symbol.h>
#include <Python.h>
#include <datetime.h>
#include "include/pyshim.hh"
#include <unordered_map>
#include <vector>
#include <cassert>

Include dependency graph for pythonmonkey.cc:

Classes
struct	NullObject

Functions
void	updateCharBufferPointers ()
	During a GC, string buffers may have moved, so we need to re-point our JSStringProxies The char buffer pointer obtained by previous JS::Get{Latin1,TwoByte}LinearStringChars calls remains valid only as long as no GC occurs.
void	pythonmonkeyGCCallback (JSContext *cx, JSGCStatus status, JS::GCReason reason, void *data)
void	nurseryCollectionCallback (JSContext *cx, JS::GCNurseryProgress progress, JS::GCReason reason, void *data)
bool	functionRegistryCallback (JSContext *cx, unsigned int argc, JS::Value *vp)
PyObject *	getPythonMonkeyNull ()
PyObject *	getPythonMonkeyBigInt ()
PyMODINIT_FUNC	PyInit_pythonmonkey (void)
	Initialization function for the module. Starts the JSContext, creates the global object, and sets cleanup functions.

Variables
JS::PersistentRootedObject	jsFunctionRegistry
PyTypeObject	JSObjectProxyType
	Struct for the JSObjectProxyType, used by all JSObjectProxy objects.
PyTypeObject	JSStringProxyType
	Struct for the JSStringProxyType, used by all JSStringProxy objects.
PyTypeObject	JSFunctionProxyType
	Struct for the JSFunctionProxyType, used by all JSFunctionProxy objects.
PyTypeObject	JSMethodProxyType
	Struct for the JSMethodProxyType, used by all JSMethodProxy objects.
PyTypeObject	JSArrayProxyType
	Struct for the JSArrayProxyType, used by all JSArrayProxy objects.
PyTypeObject	JSArrayIterProxyType
	Struct for the JSArrayProxyType, used by all JSArrayProxy objects.
PyTypeObject	JSObjectIterProxyType
	Struct for the JSArrayProxyType, used by all JSArrayProxy objects.
PyTypeObject	JSObjectKeysProxyType
	Struct for the JSObjectKeysProxyType, used by all JSObjectKeysProxy objects.
PyTypeObject	JSObjectValuesProxyType
	Struct for the JSObjectValuesProxyType, used by all JSObjectValuesProxy objects.
PyTypeObject	JSObjectItemsProxyType
	Struct for the JSObjectItemsProxyType, used by all JSObjectItemsProxy objects.
PyMethodDef	PythonMonkeyMethods []
	Array of method definitions for the pythonmonkey module.
struct PyModuleDef	pythonmonkey
	Module definition for the pythonmonkey module.
PyObject *	SpiderMonkeyError = NULL
	PyObject for spidermonkey error type.

Detailed Description

This file defines the pythonmonkey module, along with its various functions.

Author

Caleb Aikens (caleb.nosp@m.@dis.nosp@m.tribu.nosp@m.tive.nosp@m..netw.nosp@m.ork) and Philippe Laporte (phili.nosp@m.ppe@.nosp@m.distr.nosp@m.ibut.nosp@m.ive.n.nosp@m.etwo.nosp@m.rk)

Date

2023-03-29

Copyright

Copyright (c) 2023-2024 Distributive Corp.

Function Documentation

functionRegistryCallback()

bool functionRegistryCallback	(	JSContext *	cx,
		unsigned int	argc,
		JS::Value *	vp
	)

getPythonMonkeyBigInt()

PyObject * getPythonMonkeyBigInt

(

)

getPythonMonkeyNull()

PyObject * getPythonMonkeyNull

(

)

nurseryCollectionCallback()

void nurseryCollectionCallback	(	JSContext *	cx,
		JS::GCNurseryProgress	progress,
		JS::GCReason	reason,
		void *	data
	)

PyInit_pythonmonkey()

PyMODINIT_FUNC PyInit_pythonmonkey

(

void

)

Initialization function for the module. Starts the JSContext, creates the global object, and sets cleanup functions.

Returns

PyObject* - The module object to be passed to the python user

pythonmonkeyGCCallback()

void pythonmonkeyGCCallback	(	JSContext *	cx,
		JSGCStatus	status,
		JS::GCReason	reason,
		void *	data
	)

updateCharBufferPointers()

void updateCharBufferPointers

(

)

During a GC, string buffers may have moved, so we need to re-point our JSStringProxies The char buffer pointer obtained by previous JS::Get{Latin1,TwoByte}LinearStringChars calls remains valid only as long as no GC occurs.

Variable Documentation

JSArrayIterProxyType

PyTypeObject JSArrayIterProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyListIter_Type.tp_name,
  .tp_basicsize = sizeof(JSArrayIterProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSArrayIterProxyMethodDefinitions::JSArrayIterProxy_dealloc,
  .tp_getattro = PyObject_GenericGetAttr,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Array proxy iterator"),
  .tp_traverse =  (traverseproc)JSArrayIterProxyMethodDefinitions::JSArrayIterProxy_traverse,
  .tp_clear = (inquiry)JSArrayIterProxyMethodDefinitions::JSArrayIterProxy_clear,
  .tp_iter = (getiterfunc)JSArrayIterProxyMethodDefinitions::JSArrayIterProxy_iter,
  .tp_iternext = (iternextfunc)JSArrayIterProxyMethodDefinitions::JSArrayIterProxy_next,
  .tp_methods = JSArrayIterProxy_methods,
  .tp_base = &PyListIter_Type
}

Struct for the JSArrayProxyType, used by all JSArrayProxy objects.

JSArrayProxyType

PyTypeObject JSArrayProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyList_Type.tp_name,
  .tp_basicsize = sizeof(JSArrayProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSArrayProxyMethodDefinitions::JSArrayProxy_dealloc,
  .tp_repr = (reprfunc)JSArrayProxyMethodDefinitions::JSArrayProxy_repr,
  .tp_as_sequence = &JSArrayProxy_sequence_methods,
  .tp_as_mapping = &JSArrayProxy_mapping_methods,
  .tp_getattro = (getattrofunc)JSArrayProxyMethodDefinitions::JSArrayProxy_get,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_LIST_SUBCLASS | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Array proxy list"),
  .tp_traverse = (traverseproc)JSArrayProxyMethodDefinitions::JSArrayProxy_traverse,
  .tp_clear = (inquiry)JSArrayProxyMethodDefinitions::JSArrayProxy_clear,
  .tp_richcompare = (richcmpfunc)JSArrayProxyMethodDefinitions::JSArrayProxy_richcompare,
  .tp_iter = (getiterfunc)JSArrayProxyMethodDefinitions::JSArrayProxy_iter,
  .tp_methods = JSArrayProxy_methods,
  .tp_base = &PyList_Type
}

Struct for the JSArrayProxyType, used by all JSArrayProxy objects.

JSFunctionProxyType

PyTypeObject JSFunctionProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = "pythonmonkey.JSFunctionProxy",
  .tp_basicsize = sizeof(JSFunctionProxy),
  .tp_dealloc = (destructor)JSFunctionProxyMethodDefinitions::JSFunctionProxy_dealloc,
  .tp_call = JSFunctionProxyMethodDefinitions::JSFunctionProxy_call,
  .tp_flags = Py_TPFLAGS_DEFAULT,
  .tp_doc = PyDoc_STR("Javascript Function proxy object"),
  .tp_new = JSFunctionProxyMethodDefinitions::JSFunctionProxy_new
}

Struct for the JSFunctionProxyType, used by all JSFunctionProxy objects.

jsFunctionRegistry

JS::PersistentRootedObject jsFunctionRegistry

// this is a FinalizationRegistry for JSFunctions that depend on Python functions. It is used to handle reference counts when the JSFunction is finalized

JSMethodProxyType

PyTypeObject JSMethodProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = "pythonmonkey.JSMethodProxy",
  .tp_basicsize = sizeof(JSMethodProxy),
  .tp_dealloc = (destructor)JSMethodProxyMethodDefinitions::JSMethodProxy_dealloc,
  .tp_call = JSMethodProxyMethodDefinitions::JSMethodProxy_call,
  .tp_flags = Py_TPFLAGS_DEFAULT,
  .tp_doc = PyDoc_STR("Javascript Method proxy object"),
  .tp_new = JSMethodProxyMethodDefinitions::JSMethodProxy_new
}

Struct for the JSMethodProxyType, used by all JSMethodProxy objects.

JSObjectItemsProxyType

PyTypeObject JSObjectItemsProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyDictKeys_Type.tp_name,
  .tp_basicsize = sizeof(JSObjectItemsProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSObjectItemsProxyMethodDefinitions::JSObjectItemsProxy_dealloc,
  .tp_repr = (reprfunc)JSObjectItemsProxyMethodDefinitions::JSObjectItemsProxy_repr,
  
  .tp_as_sequence = &JSObjectItemsProxy_sequence_methods,
  .tp_getattro = PyObject_GenericGetAttr,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Object Items proxy"),
  .tp_traverse =  (traverseproc)JSObjectItemsProxyMethodDefinitions::JSObjectItemsProxy_traverse,
  .tp_clear = (inquiry)JSObjectItemsProxyMethodDefinitions::JSObjectItemsProxy_clear,
  
  .tp_iter = (getiterfunc)JSObjectItemsProxyMethodDefinitions::JSObjectItemsProxy_iter,
  .tp_methods = JSObjectItemsProxy_methods,
  .tp_getset = JSObjectItemsProxy_getset,
  .tp_base = &PyDictKeys_Type
}

Struct for the JSObjectItemsProxyType, used by all JSObjectItemsProxy objects.

JSObjectIterProxyType

PyTypeObject JSObjectIterProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyDictIterKey_Type.tp_name,
  .tp_basicsize = sizeof(JSObjectIterProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSObjectIterProxyMethodDefinitions::JSObjectIterProxy_dealloc,
  .tp_getattro = PyObject_GenericGetAttr,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Object proxy key iterator"),
  .tp_traverse =  (traverseproc)JSObjectIterProxyMethodDefinitions::JSObjectIterProxy_traverse,
  .tp_clear = (inquiry)JSObjectIterProxyMethodDefinitions::JSObjectIterProxy_clear,
  .tp_iter = (getiterfunc)JSObjectIterProxyMethodDefinitions::JSObjectIterProxy_iter,
  .tp_iternext = (iternextfunc)JSObjectIterProxyMethodDefinitions::JSObjectIterProxy_nextkey,
  .tp_methods = JSObjectIterProxy_methods,
  .tp_base = &PyDictIterKey_Type
}

Struct for the JSArrayProxyType, used by all JSArrayProxy objects.

JSObjectKeysProxyType

PyTypeObject JSObjectKeysProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyDictKeys_Type.tp_name,
  .tp_basicsize = sizeof(JSObjectKeysProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSObjectKeysProxyMethodDefinitions::JSObjectKeysProxy_dealloc,
  .tp_repr = (reprfunc)JSObjectKeysProxyMethodDefinitions::JSObjectKeysProxy_repr,
  .tp_as_number = &JSObjectKeysProxy_number_methods,
  .tp_as_sequence = &JSObjectKeysProxy_sequence_methods,
  .tp_getattro = PyObject_GenericGetAttr,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Object Keys proxy"),
  .tp_traverse =  (traverseproc)JSObjectKeysProxyMethodDefinitions::JSObjectKeysProxy_traverse,
  .tp_clear = (inquiry)JSObjectKeysProxyMethodDefinitions::JSObjectKeysProxy_clear,
  .tp_richcompare = (richcmpfunc)JSObjectKeysProxyMethodDefinitions::JSObjectKeysProxy_richcompare,
  .tp_iter = (getiterfunc)JSObjectKeysProxyMethodDefinitions::JSObjectKeysProxy_iter,
  .tp_methods = JSObjectKeysProxy_methods,
  .tp_getset = JSObjectKeysProxy_getset,
  .tp_base = &PyDictKeys_Type
}

Struct for the JSObjectKeysProxyType, used by all JSObjectKeysProxy objects.

JSObjectProxyType

PyTypeObject JSObjectProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyDict_Type.tp_name,
  .tp_basicsize = sizeof(JSObjectProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSObjectProxyMethodDefinitions::JSObjectProxy_dealloc,
  .tp_repr = (reprfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_repr,
  .tp_as_number = &JSObjectProxy_number_methods,
  .tp_as_sequence = &JSObjectProxy_sequence_methods,
  .tp_as_mapping = &JSObjectProxy_mapping_methods,
  .tp_getattro = (getattrofunc)JSObjectProxyMethodDefinitions::JSObjectProxy_get,
  .tp_setattro = (setattrofunc)JSObjectProxyMethodDefinitions::JSObjectProxy_assign,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_DICT_SUBCLASS | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Object proxy dict"),
  .tp_traverse = (traverseproc)JSObjectProxyMethodDefinitions::JSObjectProxy_traverse,
  .tp_clear = (inquiry)JSObjectProxyMethodDefinitions::JSObjectProxy_clear,
  .tp_richcompare = (richcmpfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_richcompare,
  .tp_iter = (getiterfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_iter,
  .tp_iternext = (iternextfunc)JSObjectProxyMethodDefinitions::JSObjectProxy_iter_next,
  .tp_methods = JSObjectProxy_methods,
  .tp_base = &PyDict_Type
}

Struct for the JSObjectProxyType, used by all JSObjectProxy objects.

JSObjectValuesProxyType

PyTypeObject JSObjectValuesProxyType

Initial value:

= {
  .ob_base = PyVarObject_HEAD_INIT(NULL, 0)
  .tp_name = PyDictValues_Type.tp_name,
  .tp_basicsize = sizeof(JSObjectValuesProxy),
  .tp_itemsize = 0,
  .tp_dealloc = (destructor)JSObjectValuesProxyMethodDefinitions::JSObjectValuesProxy_dealloc,
  .tp_repr = (reprfunc)JSObjectValuesProxyMethodDefinitions::JSObjectValuesProxy_repr,
  .tp_as_sequence = &JSObjectValuesProxy_sequence_methods,
  .tp_getattro = PyObject_GenericGetAttr,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
  .tp_doc = PyDoc_STR("Javascript Object Values proxy"),
  .tp_traverse =  (traverseproc)JSObjectValuesProxyMethodDefinitions::JSObjectValuesProxy_traverse,
  .tp_clear = (inquiry)JSObjectValuesProxyMethodDefinitions::JSObjectValuesProxy_clear,
  .tp_iter = (getiterfunc)JSObjectValuesProxyMethodDefinitions::JSObjectValuesProxy_iter,
  .tp_methods = JSObjectValuesProxy_methods,
  .tp_getset = JSObjectValuesProxy_getset,
  .tp_base = &PyDictValues_Type
}

Struct for the JSObjectValuesProxyType, used by all JSObjectValuesProxy objects.

JSStringProxyType

PyTypeObject JSStringProxyType

Initial value:

= {
  .tp_name = PyUnicode_Type.tp_name,
  .tp_basicsize = sizeof(JSStringProxy),
  .tp_dealloc = (destructor)JSStringProxyMethodDefinitions::JSStringProxy_dealloc,
  .tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_UNICODE_SUBCLASS,
  .tp_doc = PyDoc_STR("Javascript String proxy"),
  .tp_methods = JSStringProxy_methods,
  .tp_base = &PyUnicode_Type
}

Struct for the JSStringProxyType, used by all JSStringProxy objects.

pythonmonkey

struct PyModuleDef pythonmonkey

Initial value:

=
{
  PyModuleDef_HEAD_INIT,
  "pythonmonkey",                                   
  "A module for python to JS interoperability",   
  -1,                                           
  PythonMonkeyMethods
}

Module definition for the pythonmonkey module.

PythonMonkeyMethods

PyMethodDef PythonMonkeyMethods[]

Initial value:

= {
  {"eval", eval, METH_VARARGS, "Javascript evaluator in Python"},
  {"wait", waitForEventLoop, METH_NOARGS, "The event-loop shield. Blocks until all asynchronous jobs finish."},
  {"stop", closeAllPending, METH_NOARGS, "Cancel all pending event-loop jobs."},
  {"isCompilableUnit", isCompilableUnit, METH_VARARGS, "Hint if a string might be compilable Javascript"},
  {"collect", collect, METH_VARARGS, "Calls the Spidermonkey garbage collector"},
  {NULL, NULL, 0, NULL}
}

Array of method definitions for the pythonmonkey module.

SpiderMonkeyError

PyObject* SpiderMonkeyError = NULL

PyObject for spidermonkey error type.