Deployed 7334149 with MkDocs version: 1.5.3

cubicap · Mar 8, 2024 · c0c34fb · c0c34fb
commit c0c34fb
Show file tree

Hide file tree

Showing 480 changed files with 219,805 additions and 0 deletions.
diff --git a/.nojekyll b/.nojekyll
diff --git a/404.html b/404.html
diff --git a/CNAME b/CNAME
@@ -0,0 +1 @@
+machine.jaculus.org
diff --git a/assets/.doxy/doxygen/doxygen/annotated.md b/assets/.doxy/doxygen/doxygen/annotated.md
@@ -0,0 +1,82 @@
+
+# Class List
+
+
+Here are the classes, structs, unions and interfaces with brief descriptions:
+
+* **namespace** [**jac**](namespacejac.md)     
+    * **class** [**ArrayBufferWrapper**](classjac_1_1ArrayBufferWrapper.md) _A wrapper for JSValue with ArrayBuffer type with RAII._     
+    * **class** [**ArrayWrapper**](classjac_1_1ArrayWrapper.md) _A wrapper for JSValue with Array type with RAII._     
+    * **class** [**Atom**](classjac_1_1Atom.md) _A wrapper around JSAtom with RAII. In the context of QuickJS,_ [_**Atom**_](classjac_1_1Atom.md) _is used to represent identifiers of properties, variables, functions, etc._    
+    * **class** [**BasicStreamFeature**](classjac_1_1BasicStreamFeature.md)     
+    * **class** [**Class**](classjac_1_1Class.md)     
+    * **struct** [**ComposeMachine**](structjac_1_1ComposeMachine.md) 
+    * **struct** [**ComposeMachine&lt; Base &gt;**](structjac_1_1ComposeMachine_3_01Base_01_4.md) 
+    * **struct** [**ComposeMachine&lt; Base, FirstFeature, MFeatures... &gt;**](structjac_1_1ComposeMachine_3_01Base_00_01FirstFeature_00_01MFeatures_8_8_8_01_4.md) 
+    * **class** [**ContextRef**](classjac_1_1ContextRef.md) _A wrapper around JSContext\* providing some related functionality._     
+    * **struct** [**ConvTraits**](structjac_1_1ConvTraits.md)     
+    * **struct** [**ConvTraits&lt; bool &gt;**](structjac_1_1ConvTraits_3_01bool_01_4.md)     
+    * **struct** [**ConvTraits&lt; std::chrono::milliseconds &gt;**](structjac_1_1ConvTraits_3_01std_1_1chrono_1_1milliseconds_01_4.md)     
+    * **class** [**EventLoopFeature**](classjac_1_1EventLoopFeature.md)     
+    * **class** [**EventLoopTerminal**](classjac_1_1EventLoopTerminal.md)     
+    * **class** [**EventQueueFeature**](classjac_1_1EventQueueFeature.md)     
+    * **class** [**ExceptionWrapper**](classjac_1_1ExceptionWrapper.md) _An exception wrapper which can either wrap a JSValue or contain an exception description and can be thrown into JS as a specific Error type._     
+    * **class** [**File**](classjac_1_1File.md)     
+    * **struct** [**FileProtoBuilder**](structjac_1_1FileProtoBuilder.md)     
+    * **class** [**FilesystemFeature**](classjac_1_1FilesystemFeature.md)     
+        * **class** [**Path**](classjac_1_1FilesystemFeature_1_1Path.md)     
+    * **class** [**FunctionFactory**](classjac_1_1FunctionFactory.md) _Various methods for wrapping C++ functions into javascript functions._     
+    * **class** [**FunctionWrapper**](classjac_1_1FunctionWrapper.md) _A wrapper for JSValue with Function type with RAII._     
+    * **class** [**MachineBase**](classjac_1_1MachineBase.md)     
+    * **class** [**Module**](classjac_1_1Module.md) _A wrapper around JSModuleDef that allows for easy exporting of values._     
+    * **class** [**ModuleLoaderFeature**](classjac_1_1ModuleLoaderFeature.md)     
+    * **class** [**ObjectWrapper**](classjac_1_1ObjectWrapper.md) _A wrapper for JSValue with Object type with RAII._     
+    * **class** [**OsWritable**](classjac_1_1OsWritable.md)     
+    * **class** [**Plugin**](classjac_1_1Plugin.md) _A base class for all plugins._     
+    * **class** [**PluginHandle**](classjac_1_1PluginHandle.md) _A handle which can be used to retrieve a plugin from a machine._     
+    * **class** [**PluginHolderFeature**](classjac_1_1PluginHolderFeature.md) _An MFeature that allows for inserting plugins into the machine and retrieving them using PluginHandeles._     
+    * **class** [**PluginManager**](classjac_1_1PluginManager.md) _A class for managing groups of plugins and initializing them all at once._     
+    * **class** [**PromiseWrapper**](classjac_1_1PromiseWrapper.md) _A wrapper for JSValue with Promise type with RAII._     
+    * **namespace** [**ProtoBuilder**](namespacejac_1_1ProtoBuilder.md)     
+        * **struct** [**Callable**](structjac_1_1ProtoBuilder_1_1Callable.md) _A base class for javascript classes with callable instances._     
+        * **struct** [**LifetimeHandles**](structjac_1_1ProtoBuilder_1_1LifetimeHandles.md) _A base class used to add handles for lifetime events of an instance._     
+        * **struct** [**Opaque**](structjac_1_1ProtoBuilder_1_1Opaque.md) _A base class for javascript classes with opaque data._     
+        * **struct** [**Properties**](structjac_1_1ProtoBuilder_1_1Properties.md) _A base class for javascript classes with added properties._     
+    * **class** [**Readable**](classjac_1_1Readable.md)     
+    * **struct** [**ReadableProtoBuilder**](structjac_1_1ReadableProtoBuilder.md)     
+    * **class** [**ReadableRef**](classjac_1_1ReadableRef.md)     
+    * **struct** [**SgnUnwrap**](structjac_1_1SgnUnwrap.md) 
+    * **struct** [**SgnUnwrap&lt; Res(Args...)&gt;**](structjac_1_1SgnUnwrap_3_01Res_07Args_8_8_8_08_4.md)     
+    * **class** [**StdioFeature**](classjac_1_1StdioFeature.md)     
+    * **class** [**StringView**](classjac_1_1StringView.md) _A wrapper around QuickJS C-string with automatic memory management._     
+    * **class** [**TimersFeature**](classjac_1_1TimersFeature.md)     
+    * **class** [**ValueWrapper**](classjac_1_1ValueWrapper.md) _A wrapper around JSValue with RAII._     
+    * **class** [**Writable**](classjac_1_1Writable.md)     
+    * **struct** [**WritableProtoBuilder**](structjac_1_1WritableProtoBuilder.md)     
+    * **class** [**WritableRef**](classjac_1_1WritableRef.md)     
+    * **namespace** [**detail**](namespacejac_1_1detail.md)     
+        * **struct** [**FloatConvBase**](structjac_1_1detail_1_1FloatConvBase.md)     
+        * **struct** [**IntConvBase**](structjac_1_1detail_1_1IntConvBase.md)     
+        * **struct** [**is\_base\_of\_template\_impl**](structjac_1_1detail_1_1is__base__of__template__impl.md)     
+            * **struct** [**check**](structjac_1_1detail_1_1is__base__of__template__impl_1_1check.md) 
+            * **struct** [**check&lt; A, std::void\_t&lt; A&lt; Derived &gt; &gt; &gt;**](structjac_1_1detail_1_1is__base__of__template__impl_1_1check_3_01A_00_01std_1_1void__t_3_01A_3_01Derived_01_4_01_4_01_4.md) 
+    * **struct** [**is\_base\_of\_template**](structjac_1_1is__base__of__template.md) _Checks if a type is derived from a template class._ 
+* **class** [**Fs**](classjac_1_1FilesystemFeature_1_1Fs.md)     
+* **class** [**Stdio**](classjac_1_1StdioFeature_1_1Stdio.md)     
+* **class** [**CompareTimer**](classjac_1_1TimersFeature_1_1CompareTimer.md)     
+* **class** [**Timer**](classjac_1_1TimersFeature_1_1Timer.md)     
+* **namespace** [**noal**](namespacenoal.md)     
+    * **class** [**callableany**](classnoal_1_1callableany.md) 
+    * **class** [**callableany&lt; Func, Res(Args...)&gt;**](classnoal_1_1callableany_3_01Func_00_01Res_07Args_8_8_8_08_4.md)     
+    * **class** [**funcptr**](classnoal_1_1funcptr.md)     
+    * **class** [**function**](classnoal_1_1function.md) 
+    * **class** [**function&lt; Res(Args...), dataSize &gt;**](classnoal_1_1function_3_01Res_07Args_8_8_8_08_00_01dataSize_01_4.md)     
+    * **class** [**memberconstfuncptr**](classnoal_1_1memberconstfuncptr.md)     
+    * **class** [**memberfuncptr**](classnoal_1_1memberfuncptr.md)     
+    * **struct** [**signatureHelper**](structnoal_1_1signatureHelper.md) 
+    * **struct** [**signatureHelper&lt; Res(Func::\*)(Args...) & &gt;**](structnoal_1_1signatureHelper_3_01Res_07Func_1_1_5_08_07Args_8_8_8_08_01_6_01_4.md)     
+    * **struct** [**signatureHelper&lt; Res(Func::\*)(Args...) const & &gt;**](structnoal_1_1signatureHelper_3_01Res_07Func_1_1_5_08_07Args_8_8_8_08_01const_01_6_01_4.md)     
+    * **struct** [**signatureHelper&lt; Res(Func::\*)(Args...) const &gt;**](structnoal_1_1signatureHelper_3_01Res_07Func_1_1_5_08_07Args_8_8_8_08_01const_01_4.md)     
+    * **struct** [**signatureHelper&lt; Res(Func::\*)(Args...)&gt;**](structnoal_1_1signatureHelper_3_01Res_07Func_1_1_5_08_07Args_8_8_8_08_4.md)     
+* **namespace** [**std**](namespacestd.md) 
+
diff --git a/assets/.doxy/doxygen/doxygen/atom_8h.md b/assets/.doxy/doxygen/doxygen/atom_8h.md
@@ -0,0 +1,97 @@
+
+
+# File atom.h
+
+
+
+[**FileList**](files.md) **>** [**jac**](dir_256037ad7d0c306238e2bc4f945d341d.md) **>** [**machine**](dir_10e7d6e7bc593e38e57ffe1bab5ed259.md) **>** [**atom.h**](atom_8h.md)
+
+[Go to the source code of this file](atom_8h_source.md)
+
+
+
+* `#include <quickjs.h>`
+* `#include <ostream>`
+* `#include <string>`
+* `#include "internal/declarations.h"`
+* `#include "context.h"`
+* `#include "stringView.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Namespaces
+
+| Type | Name |
+| ---: | :--- |
+| namespace | [**jac**](namespacejac.md) <br> |
+
+
+## Classes
+
+| Type | Name |
+| ---: | :--- |
+| class | [**Atom**](classjac_1_1Atom.md) <br>_A wrapper around JSAtom with RAII. In the context of QuickJS,_ [_**Atom**_](classjac_1_1Atom.md) _is used to represent identifiers of properties, variables, functions, etc._ |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `src/jac/machine/atom.h`
+
diff --git a/assets/.doxy/doxygen/doxygen/atom_8h_source.md b/assets/.doxy/doxygen/doxygen/atom_8h_source.md
@@ -0,0 +1,113 @@
+
+
+# File atom.h
+
+[**File List**](files.md) **>** [**jac**](dir_256037ad7d0c306238e2bc4f945d341d.md) **>** [**machine**](dir_10e7d6e7bc593e38e57ffe1bab5ed259.md) **>** [**atom.h**](atom_8h.md)
+
+[Go to the documentation of this file](atom_8h.md)
+
+```C++
+
+#pragma once
+
+#include <quickjs.h>
+
+#include <ostream>
+#include <string>
+
+#include "internal/declarations.h"
+
+#include "context.h"
+#include "stringView.h"
+
+
+namespace jac {
+
+
+template<typename T=int>
+constexpr bool static_false() {
+    return false;
+};
+
+
+class Atom {
+protected:
+    ContextRef _ctx;
+    JSAtom _atom;
+public:
+    Atom(ContextRef ctx, JSAtom atom) : _ctx(ctx), _atom(atom) {}
+    Atom(const Atom &other):
+        _ctx(other._ctx),
+        _atom(JS_DupAtom(_ctx, other._atom))
+    {}
+    Atom(Atom &&other) : _ctx(other._ctx), _atom(other._atom) {
+        other._atom = JS_ATOM_NULL;
+        other._ctx = nullptr;
+    }
+
+    Atom& operator=(const Atom &other) {
+        if (_ctx) {
+            JS_FreeAtom(_ctx, _atom);
+        }
+        _atom = JS_DupAtom(_ctx, other._atom);
+        _ctx = other._ctx;
+
+        return *this;
+    }
+
+    Atom& operator=(Atom &&other) {
+        if (_ctx) {
+            JS_FreeAtom(_ctx, _atom);
+        }
+        _atom = other._atom;
+        _ctx = other._ctx;
+        other._atom = JS_ATOM_NULL;
+        other._ctx = nullptr;
+        return *this;
+    }
+
+    ~Atom() {
+        if (_ctx) {
+            JS_FreeAtom(_ctx, _atom);
+        }
+    }
+
+    StringView toString() const {
+        return { _ctx, JS_AtomToCString(_ctx, _atom) };
+    }
+
+    std::pair<ContextRef, JSAtom> loot() {
+        JSAtom atom_ = _atom;
+        ContextRef ctx_ = this->_ctx;
+        _ctx = nullptr;
+        _atom = JS_ATOM_NULL;
+        return {ctx_, atom_};
+    }
+
+    JSAtom& get() {
+        return _atom;
+    }
+
+    static Atom create(ContextRef ctx, uint32_t value) {
+        return { ctx, JS_NewAtomUInt32(ctx, value) };
+    }
+
+    static Atom create(ContextRef ctx, const char* value) {
+        return { ctx, JS_NewAtom(ctx, value) };
+    }
+
+    static Atom create(ContextRef ctx, std::string value) {
+        return create(ctx, value.c_str());
+    }
+
+    friend std::ostream& operator<<(std::ostream& os, Atom& val) {
+        os << val.toString().c_str();
+        return os;
+    }
+};
+
+
+}  // namespace jac
+
+```
+
diff --git a/assets/.doxy/doxygen/doxygen/basicStreamFeature_8h.md b/assets/.doxy/doxygen/doxygen/basicStreamFeature_8h.md
@@ -0,0 +1,99 @@
+
+
+# File basicStreamFeature.h
+
+
+
+[**FileList**](files.md) **>** [**features**](dir_6f95e06b732314161804ab1ef73c9681.md) **>** [**basicStreamFeature.h**](basicStreamFeature_8h.md)
+
+[Go to the source code of this file](basicStreamFeature_8h_source.md)
+
+
+
+* `#include <jac/machine/class.h>`
+* `#include <jac/machine/functionFactory.h>`
+* `#include <jac/machine/machine.h>`
+* `#include <jac/machine/values.h>`
+* `#include <string>`
+* `#include "types/streams.h"`
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Namespaces
+
+| Type | Name |
+| ---: | :--- |
+| namespace | [**jac**](namespacejac.md) <br> |
+
+
+## Classes
+
+| Type | Name |
+| ---: | :--- |
+| class | [**BasicStreamFeature**](classjac_1_1BasicStreamFeature.md) &lt;class Next&gt;<br> |
+| struct | [**ReadableProtoBuilder**](structjac_1_1ReadableProtoBuilder.md) <br> |
+| struct | [**WritableProtoBuilder**](structjac_1_1WritableProtoBuilder.md) <br> |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `src/jac/features/basicStreamFeature.h`
+