BF-31

.github/workflows/tests.yaml

@@ -34,6 +34,8 @@ jobs:
       - name: Build-Library
         if: ${{ steps.cache-spidermonkey.outputs.cache-hit != 'true' }}
         run: |
+          # Get number of CPU cores
+          CPUS=$(getconf _NPROCESSORS_ONLN 2>/dev/null || getconf NPROCESSORS_ONLN 2>/dev/null || echo 1)
           echo "Building SpiderMonkey"
           #install rust compiler
           curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh -s -- -y
@@ -48,14 +50,14 @@ jobs:
           mkdir _build
           cd _build
           ../configure --disable-jemalloc --with-system-zlib --with-intl-api --enable-optimize
-          make
+          make -j$CPUS
           sudo make install
           cd ../../../..
           echo "Building the library"
           mkdir build
           cd build
           cmake ..
-          cmake --build .
+          cmake --build . -j$CPUS
           echo "Build complete"
       - name: google-tests
         run: |

.gitignore

@@ -11,3 +11,4 @@ firefox-*/*
 firefox-*/
 tests/__pycache__/*
 tests/python/__pycache__/*
+Testing/Temporary

README.md

@@ -31,11 +31,11 @@ this package to execute our complex `dcp-client` library, which is written in JS
 - [done] JS exceptions propagate to Python
 - [done] Implement `eval()` function in Python which accepts JS code and returns JS->Python coerced values
 - [underway] NodeJS+NPM-compatible CommonJS module system
-- [underway] Python strings coerce to JS strings
+- [done] Python strings coerce to JS strings
 - [done] Python intrinsics coerce to JS intrinsics
 - Python dicts coerce to JS objects
 - Python `require` function, returns a coerced dict of module exports
-- Python functions coerce to JS function wrappers
+- [done] Python functions coerce to JS function wrappers
 - CommonJS module system .py loader, loads Python modules for use by JS
 - JS object->Python dict coercion supports inherited-property lookup (via __getattribute__?)
 - Python host environment supplies event loop, including EventEmitter, setTimeout, etc.
@@ -64,7 +64,7 @@ this package to execute our complex `dcp-client` library, which is written in JS
 2. In the build folder `cd` into the `tests` directory and run `ctest`.
     ```bash
     # From the root directory we do the following (after compiling the project)
-    $ cd buid/tests
+    $ cd build/tests
     $ ctest
     ```
     Alternatively, from the root directory, run ``./test_script.sh``

build_script.sh

@@ -1,3 +1,6 @@
+# Get number of CPU cores
+CPUS=$(getconf _NPROCESSORS_ONLN 2>/dev/null || getconf NPROCESSORS_ONLN 2>/dev/null || echo 1)
+
 DIR="build"
 if [  ! -d "$DIR" ]; then
   ### Take action if $DIR exists ###
@@ -6,4 +9,4 @@ fi
 
 cd build
 cmake ..
-cmake --build .
+cmake --build . -j$CPUS

include/IntType.hh

@@ -1,11 +1,11 @@
 /**
  * @file IntType.hh
- * @author Caleb Aikens (caleb@distributive.network) & Giovanni Tedesco (giovanni@distributive.network)
+ * @author Caleb Aikens (caleb@distributive.network) & Giovanni Tedesco (giovanni@distributive.network) & Tom Tang (xmader@distributive.network)
  * @brief Struct for representing python ints
- * @version 0.1
- * @date 2022-07-27
+ * @version 0.2
+ * @date 2023-03-16
  *
- * @copyright Copyright (c) 2022
+ * @copyright Copyright (c) 2023
  *
  */
 
@@ -15,19 +15,36 @@
 #include "PyType.hh"
 #include "TypeEnum.hh"
 
+#include <jsapi.h>
+
 #include <Python.h>
 
 #include <iostream>
 
 /**
- * @brief This struct represents the 'int' type in Python, which is represented as a 'long' in C++. It inherits from the PyType struct
+ * @brief This struct represents the 'int' type (arbitrary-precision) in Python. It inherits from the PyType struct
  */
 struct IntType : public PyType {
 public:
   IntType(PyObject *object);
   IntType(long n);
+
+  /**
+   * @brief Construct a new IntType object from a JS::BigInt.
+   *
+   * @param cx - javascript context pointer
+   * @param str - JS::BigInt pointer
+   */
+  IntType(JSContext *cx, JS::BigInt *bigint);
+
   const TYPE returnType = TYPE::INT;
-  long getValue() const;
+
+  /**
+   * @brief Convert the IntType object to a JS::BigInt
+   *
+   * @param cx - javascript context pointer
+   */
+  JS::BigInt *toJsBigInt(JSContext *cx);
 
 protected:
   virtual void print(std::ostream &os) const override;

include/jsTypeFactory.hh

@@ -16,12 +16,35 @@
 
 #include <jsapi.h>
 
+
+struct PythonExternalString;
+
+/**
+ * @brief Function that makes a UTF16-encoded copy of a UCS4 string
+ *
+ * @param chars - pointer to the UCS4-encoded string
+ * @param length - length of chars in code points
+ * @param outStr - UTF16-encoded out-parameter string
+ * @return size_t - length of outStr (counting surrogate pairs as 2)
+ */
+size_t UCS4ToUTF16(const uint32_t *chars, size_t length, uint16_t *outStr);
 /**
- * @brief Function that takes a PyType and returns a corresponding JS::Value, doing shared memory management when necessary
+ * @brief Function that takes a PyObject and returns a corresponding JS::Value, doing shared memory management when necessary
  *
+ * @param cx - Pointer to the JSContext
  * @param object - Pointer to the PyObject who's type and value we wish to encapsulate
  * @return JS::Value - A JS::Value corresponding to the PyType
  */
-JS::Value jsTypeFactory(PyObject *object);
+JS::Value jsTypeFactory(JSContext *cx, PyObject *object);
 
+/**
+ * @brief Helper function for jsTypeFactory to create a JSFunction* through JS_NewFunction that knows how to call a python function.
+ *
+ * @param cx - Pointer to the JSContext
+ * @param argc - The number of arguments the JSFunction expects
+ * @param vp - The return value of the JSFunction
+ * @return true - Function executed successfully
+ * @return false - Function did not execute successfully and an exception has been set
+ */
+bool callPyFunc(JSContext *cx, unsigned int argc, JS::Value *vp);
 #endif

include/modules/pythonmonkey/pythonmonkey.hh

@@ -19,10 +19,12 @@
 
 #include <Python.h>
 
-#define PythonMonkey_Null PyObject_GetAttrString(PyState_FindModule(&pythonmonkey), "null") /**< macro for python null object*/
+#define PythonMonkey_Null   PyObject_GetAttrString(PyState_FindModule(&pythonmonkey), "null")   /**< macro for pythonmonkey.null object*/
+#define PythonMonkey_BigInt PyObject_GetAttrString(PyState_FindModule(&pythonmonkey), "bigint") /**< macro for pythonmonkey.bigint class object */
 
 static JSContext *GLOBAL_CX; /**< pointer to PythonMonkey's JSContext */
 static JS::Rooted<JSObject *> *global; /**< pointer to the global object of PythonMonkey's JSContext */
+static JSAutoRealm *autoRealm; /**< pointer to PythonMonkey's AutoRealm */
 
 /**
  * @brief Destroys the JSContext and deletes associated memory. Called when python quits or faces a fatal exception.

include/pyTypeFactory.hh

@@ -31,11 +31,11 @@ PyType *pyTypeFactory(PyObject *object);
  * @brief Function that takes a JS::Value and returns a corresponding PyType* object, doing shared memory management when necessary
  *
  * @param cx - Pointer to the javascript context of the JS::Value
- * @param global - Pointer to the javascript global object
+ * @param thisObj - Pointer to the JS `this` object for the value's scope
  * @param rval - Pointer to the JS::Value who's type and value we wish to encapsulate
  * @return PyType* - Pointer to a PyType object corresponding to the JS::Value
  */
-PyType *pyTypeFactory(JSContext *cx, JS::Rooted<JSObject *> *global, JS::Rooted<JS::Value> *rval);
+PyType *pyTypeFactory(JSContext *cx, JS::Rooted<JSObject *> *thisObj, JS::Rooted<JS::Value> *rval);
 
 /**
  * @brief Helper function for pyTypeFactory to create FuncTypes through PyCFunction_New

setup.sh

@@ -1,7 +1,10 @@
-apt-get update --yes
-apt-get upgrade --yes
-apt-get install cmake python3-dev python3-pytest doxygen graphviz gcovr llvm m4 --yes
-curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh -s -- -y #install rust compiler
+# Get number of CPU cores
+CPUS=$(getconf _NPROCESSORS_ONLN 2>/dev/null || getconf NPROCESSORS_ONLN 2>/dev/null || echo 1)
+
+sudo apt-get update --yes
+sudo apt-get upgrade --yes
+sudo apt-get install cmake python3-dev python3-pytest doxygen graphviz gcovr llvm g++ pkg-config m4 --yes
+sudo curl --proto '=https' --tlsv1.3 https://sh.rustup.rs -sSf | sh -s -- -y #install rust compiler
 wget -q https://ftp.mozilla.org/pub/firefox/releases/102.2.0esr/source/firefox-102.2.0esr.source.tar.xz
 tar xf firefox-102.2.0esr.source.tar.xz
 cd firefox-102.2.0/js
@@ -13,5 +16,5 @@ chmod +x ./configure
 mkdir _build
 cd _build
 ../configure --disable-jemalloc --with-system-zlib --with-intl-api --enable-optimize
-make
-make install
+make -j$CPUS
+sudo make install

src/CMakeLists.txt

@@ -1,12 +1,7 @@
 include_directories(${CMAKE_CURRENT_LIST_DIR})
 
-#list(APPEND EXPLORE_SOURCE_FILES  ${SOURCE_FILES} "${CMAKE_SOURCE_DIR}/src/modules/explore/explore.cc")
 list(APPEND PYTHONMONKEY_SOURCE_FILES ${SOURCE_FILES} "${CMAKE_SOURCE_DIR}/src/modules/pythonmonkey/pythonmonkey.cc")
 
-# add_library(explore SHARED
-#     ${EXPLORE_SOURCE_FILES}
-# )
-
 add_library(pythonmonkey SHARED
     ${PYTHONMONKEY_SOURCE_FILES}
 )
@@ -16,18 +11,9 @@ execute_process(
     OUTPUT_VARIABLE pyloc
 )
 
-# target_include_directories(explore  PUBLIC ..)
 target_include_directories(pythonmonkey PUBLIC ..)
 
 if(WIN32)
-  # set_target_properties(
-  #   explore
-  #   PROPERTIES
-  #     PREFIX ""
-  #     SUFFIX ".pyd"
-  #     OUTPUT_NAME "explore"
-  #     CXX_STANDARD 17
-  # )
   set_target_properties(
     pythonmonkey
     PROPERTIES
@@ -37,23 +23,16 @@ if(WIN32)
       CXX_STANDARD 17
   )
 elseif(UNIX)
-  # set_target_properties(
-  #   explore
-  #   PROPERTIES 
-  #     PREFIX ""
-  #     SUFFIX ".so"
-  # )
   set_target_properties(
     pythonmonkey
     PROPERTIES
     PREFIX ""
     SUFFIX ".so"
   )
 endif()
-# target_link_libraries(explore ${PYTHON_LIBRARIES})
+
 target_link_libraries(pythonmonkey ${PYTHON_LIBRARIES})
 target_link_libraries(pythonmonkey ${SPIDERMONKEY_LIBRARIES})
 
-# target_include_directories(explore PRIVATE ${PYTHON_INCLUDE_DIR})
 target_include_directories(pythonmonkey PRIVATE ${PYTHON_INCLUDE_DIR})
 target_include_directories(pythonmonkey PRIVATE ${SPIDERMONKEY_INCLUDE_DIR})