Deploying to gh-pages from @ 1fae32c 🚀

db/dc8/pythontarget_8h.html

@@ -148,6 +148,12 @@
 <tr class="separator:a0f16ef4bd6f5ce18c46b2ada2fd3f86f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a4edcc011de4a45d924a03a3125d4cf91" id="r_a4edcc011de4a45d924a03a3125d4cf91"><td class="memItemLeft" align="right" valign="top">PyObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a4edcc011de4a45d924a03a3125d4cf91">get_python_function</a> (<a class="el" href="../../d6/d1d/lf__types_8h.html#a4505c08c065b48840a30eedd9845cce2">string</a> module, <a class="el" href="../../d6/d1d/lf__types_8h.html#a4505c08c065b48840a30eedd9845cce2">string</a> class, int instance_id, <a class="el" href="../../d6/d1d/lf__types_8h.html#a4505c08c065b48840a30eedd9845cce2">string</a> func)</td></tr>
 <tr class="separator:a4edcc011de4a45d924a03a3125d4cf91"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aac1ca878d52a3d35b91545265b609c00" id="r_aac1ca878d52a3d35b91545265b609c00"><td class="memItemLeft" align="right" valign="top">PyObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aac1ca878d52a3d35b91545265b609c00">load_serializer</a> (<a class="el" href="../../d6/d1d/lf__types_8h.html#a4505c08c065b48840a30eedd9845cce2">string</a> package_name)</td></tr>
+<tr class="separator:aac1ca878d52a3d35b91545265b609c00"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ad1b50ff09c749298ebc55199e7d820fc" id="r_ad1b50ff09c749298ebc55199e7d820fc"><td class="memItemLeft" align="right" valign="top">PyObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad1b50ff09c749298ebc55199e7d820fc">custom_serialize</a> (PyObject *obj, PyObject *custom_serializer)</td></tr>
+<tr class="separator:ad1b50ff09c749298ebc55199e7d820fc"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aadb88a2052337f26c767421a4f4b7c43" id="r_aadb88a2052337f26c767421a4f4b7c43"><td class="memItemLeft" align="right" valign="top">PyObject *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#aadb88a2052337f26c767421a4f4b7c43">custom_deserialize</a> (PyObject *serialized_pyobject, PyObject *custom_serializer)</td></tr>
+<tr class="separator:aadb88a2052337f26c767421a4f4b7c43"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a543f7a99c5c0d688350df1dd90ea81bd" id="r_a543f7a99c5c0d688350df1dd90ea81bd"><td class="memItemLeft" align="right" valign="top">PyMODINIT_FUNC&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a543f7a99c5c0d688350df1dd90ea81bd">GEN_NAME</a> (PyInit_, MODULE_NAME)(void)</td></tr>
 <tr class="separator:a543f7a99c5c0d688350df1dd90ea81bd"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
@@ -322,6 +328,64 @@ <h2 class="memtitle"><span class="permalink"><a href="#aac49a7141b078d4cc789090b
 <p>First, the void* pointer is stored in a PyCapsule. If the port is not a multiport, the value and is_present fields are copied verbatim. These feilds then can be accessed from the Python code as port.value and port.is_present. If the value is absent, it will be set to None.</p>
 <p>For multiports, the value of the port_capsule (i.e., port.value) is always set to None and is_present is set to false. Individual ports can then later be accessed in Python code as port[idx]. </p>
 
+</div>
+</div>
+<a id="aadb88a2052337f26c767421a4f4b7c43" name="aadb88a2052337f26c767421a4f4b7c43"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aadb88a2052337f26c767421a4f4b7c43">&#9670;&#160;</a></span>custom_deserialize()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">PyObject * custom_deserialize </td>
+          <td>(</td>
+          <td class="paramtype">PyObject *</td>          <td class="paramname"><span class="paramname"><em>serialized_pyobject</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">PyObject *</td>          <td class="paramname"><span class="paramname"><em>custom_serializer</em></span>&#160;)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Deserialize Python object from a bytes object using external serializer </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">serialized_pyobject</td><td>The serialized bytes Python object </td></tr>
+    <tr><td class="paramname">custom_serializer</td><td>The custom Serializer class </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Deserialized Python object </dd></dl>
+
+</div>
+</div>
+<a id="ad1b50ff09c749298ebc55199e7d820fc" name="ad1b50ff09c749298ebc55199e7d820fc"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ad1b50ff09c749298ebc55199e7d820fc">&#9670;&#160;</a></span>custom_serialize()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">PyObject * custom_serialize </td>
+          <td>(</td>
+          <td class="paramtype">PyObject *</td>          <td class="paramname"><span class="paramname"><em>obj</em></span>, </td>
+        </tr>
+        <tr>
+          <td class="paramkey"></td>
+          <td></td>
+          <td class="paramtype">PyObject *</td>          <td class="paramname"><span class="paramname"><em>custom_serializer</em></span>&#160;)</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Serialize Python object to a bytes object using external serializer </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">obj</td><td>The Python object to serialize </td></tr>
+    <tr><td class="paramname">custom_serializer</td><td>The custom Serializer class </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Serialized Python bytes object </dd></dl>
+
 </div>
 </div>
 <a id="a543f7a99c5c0d688350df1dd90ea81bd" name="a543f7a99c5c0d688350df1dd90ea81bd"></a>
@@ -404,6 +468,30 @@ <h2 class="memtitle"><span class="permalink"><a href="#a4edcc011de4a45d924a03a31
 </li>
 </ul>
 
+</div>
+</div>
+<a id="aac1ca878d52a3d35b91545265b609c00" name="aac1ca878d52a3d35b91545265b609c00"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aac1ca878d52a3d35b91545265b609c00">&#9670;&#160;</a></span>load_serializer()</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">PyObject * load_serializer </td>
+          <td>(</td>
+          <td class="paramtype"><a class="el" href="../../d6/d1d/lf__types_8h.html#a4505c08c065b48840a30eedd9845cce2">string</a></td>          <td class="paramname"><span class="paramname"><em>package_name</em></span></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+<p>Load the Serializer class from package name </p><dl class="params"><dt>Parameters</dt><dd>
+  <table class="params">
+    <tr><td class="paramname">package_name</td><td>Name of the python package to load </td></tr>
+  </table>
+  </dd>
+</dl>
+<dl class="section return"><dt>Returns</dt><dd>Initialized Serializer class </dd></dl>
+
 </div>
 </div>
 <a id="ac17112817f2b0d419f4c8c590fc772ac" name="ac17112817f2b0d419f4c8c590fc772ac"></a>

db/dc8/pythontarget_8h.js

@@ -7,8 +7,11 @@ var pythontarget_8h =
     [ "TOSTRING", "db/dc8/pythontarget_8h.html#a9063e80f8777300c93afde6e6f4c9cea", null ],
     [ "convert_C_action_to_py", "db/dc8/pythontarget_8h.html#a0f16ef4bd6f5ce18c46b2ada2fd3f86f", null ],
     [ "convert_C_port_to_py", "db/dc8/pythontarget_8h.html#aac49a7141b078d4cc789090b068d3760", null ],
+    [ "custom_deserialize", "db/dc8/pythontarget_8h.html#aadb88a2052337f26c767421a4f4b7c43", null ],
+    [ "custom_serialize", "db/dc8/pythontarget_8h.html#ad1b50ff09c749298ebc55199e7d820fc", null ],
     [ "GEN_NAME", "db/dc8/pythontarget_8h.html#a543f7a99c5c0d688350df1dd90ea81bd", null ],
     [ "get_python_function", "db/dc8/pythontarget_8h.html#a4edcc011de4a45d924a03a3125d4cf91", null ],
+    [ "load_serializer", "db/dc8/pythontarget_8h.html#aac1ca878d52a3d35b91545265b609c00", null ],
     [ "py_main", "db/dc8/pythontarget_8h.html#ac17112817f2b0d419f4c8c590fc772ac", null ],
     [ "py_package_directory", "db/dc8/pythontarget_8h.html#ad7a9ed2af2b471cf5b08aa20eeac0ee9", null ],
     [ "py_request_stop", "db/dc8/pythontarget_8h.html#a1a013caac994b0b05697d0006bf8efcf", null ],

db/dc8/pythontarget_8h_source.html

@@ -155,18 +155,24 @@
 <div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span> </div>
 <div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span>PyObject* <a class="code hl_function" href="../../db/dc8/pythontarget_8h.html#a4edcc011de4a45d924a03a3125d4cf91">get_python_function</a>(<span class="keywordtype">string</span> module, <span class="keywordtype">string</span> <span class="keyword">class</span>, <span class="keywordtype">int</span> instance_id, <span class="keywordtype">string</span> func);</div>
 <div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span> </div>
-<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">/*</span></div>
-<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment"> * The Python runtime will call this function to initialize the module.</span></div>
-<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment"> * The name of this function is dynamically generated to follow</span></div>
-<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment"> * the requirement of PyInit_MODULE_NAME. Since the MODULE_NAME is not</span></div>
-<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment"> * known prior to compile time, the GEN_NAME macro is used.</span></div>
-<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment"> * The generated function will have the name PyInit_MODULE_NAME.</span></div>
-<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span><span class="comment"> * For example for a module named LinguaFrancaFoo, this function</span></div>
-<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"> * will be called PyInit_LinguaFrancaFoo</span></div>
-<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment"> */</span></div>
-<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span>PyMODINIT_FUNC <a class="code hl_define" href="../../db/dc8/pythontarget_8h.html#a3cd389b61ffd75be923fd4ba3b981b91">GEN_NAME</a>(PyInit_, MODULE_NAME)(void);</div>
-<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span> </div>
-<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="preprocessor">#endif </span><span class="comment">// PYTHON_TARGET_H</span></div>
+<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span>PyObject* <a class="code hl_function" href="../../db/dc8/pythontarget_8h.html#aac1ca878d52a3d35b91545265b609c00">load_serializer</a>(<span class="keywordtype">string</span> package_name);</div>
+<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span> </div>
+<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span>PyObject* <a class="code hl_function" href="../../db/dc8/pythontarget_8h.html#ad1b50ff09c749298ebc55199e7d820fc">custom_serialize</a>(PyObject* obj, PyObject* custom_serializer);</div>
+<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span> </div>
+<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span>PyObject* <a class="code hl_function" href="../../db/dc8/pythontarget_8h.html#aadb88a2052337f26c767421a4f4b7c43">custom_deserialize</a>(PyObject* serialized_pyobject, PyObject* custom_serializer);</div>
+<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span> </div>
+<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">/*</span></div>
+<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment"> * The Python runtime will call this function to initialize the module.</span></div>
+<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment"> * The name of this function is dynamically generated to follow</span></div>
+<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment"> * the requirement of PyInit_MODULE_NAME. Since the MODULE_NAME is not</span></div>
+<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment"> * known prior to compile time, the GEN_NAME macro is used.</span></div>
+<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span><span class="comment"> * The generated function will have the name PyInit_MODULE_NAME.</span></div>
+<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"> * For example for a module named LinguaFrancaFoo, this function</span></div>
+<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment"> * will be called PyInit_LinguaFrancaFoo</span></div>
+<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment"> */</span></div>
+<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span>PyMODINIT_FUNC <a class="code hl_define" href="../../db/dc8/pythontarget_8h.html#a3cd389b61ffd75be923fd4ba3b981b91">GEN_NAME</a>(PyInit_, MODULE_NAME)(void);</div>
+<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span> </div>
+<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="preprocessor">#endif </span><span class="comment">// PYTHON_TARGET_H</span></div>
 <div class="ttc" id="apython__action_8h_html"><div class="ttname"><a href="../../dc/ddc/python__action_8h.html">python_action.h</a></div></div>
 <div class="ttc" id="apython__port_8h_html"><div class="ttname"><a href="../../d0/d5e/python__port_8h.html">python_port.h</a></div></div>
 <div class="ttc" id="apython__tag_8h_html"><div class="ttname"><a href="../../d0/de6/python__tag_8h.html">python_tag.h</a></div></div>
@@ -179,10 +185,13 @@
 <div class="ttc" id="apythontarget_8h_html_a9de058b2babd69a4ed9046fccc6e4f47"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#a9de058b2babd69a4ed9046fccc6e4f47">top_level_environment</a></div><div class="ttdeci">environment_t * top_level_environment</div><div class="ttdef"><b>Definition</b> pythontarget.c:60</div></div>
 <div class="ttc" id="apythontarget_8h_html_a9e1b0c9440f6e68b2d223b8fdb77fdca"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#a9e1b0c9440f6e68b2d223b8fdb77fdca">global_pickler</a></div><div class="ttdeci">PyObject * global_pickler</div><div class="ttdef"><b>Definition</b> pythontarget.c:58</div></div>
 <div class="ttc" id="apythontarget_8h_html_aa31dfccd134fe1fd4890c76b361f4a12"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#aa31dfccd134fe1fd4890c76b361f4a12">py_schedule_copy</a></div><div class="ttdeci">PyObject * py_schedule_copy(PyObject *self, PyObject *args)</div><div class="ttdef"><b>Definition</b> pythontarget.c:120</div></div>
+<div class="ttc" id="apythontarget_8h_html_aac1ca878d52a3d35b91545265b609c00"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#aac1ca878d52a3d35b91545265b609c00">load_serializer</a></div><div class="ttdeci">PyObject * load_serializer(string package_name)</div><div class="ttdef"><b>Definition</b> pythontarget.c:699</div></div>
 <div class="ttc" id="apythontarget_8h_html_aac49a7141b078d4cc789090b068d3760"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#aac49a7141b078d4cc789090b068d3760">convert_C_port_to_py</a></div><div class="ttdeci">PyObject * convert_C_port_to_py(void *port, int width)</div><div class="ttdef"><b>Definition</b> pythontarget.c:446</div></div>
 <div class="ttc" id="apythontarget_8h_html_aad4157279f7160ddf49504923ab04ec8"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#aad4157279f7160ddf49504923ab04ec8">globalPythonModule</a></div><div class="ttdeci">PyObject * globalPythonModule</div><div class="ttdef"><b>Definition</b> pythontarget.c:51</div></div>
+<div class="ttc" id="apythontarget_8h_html_aadb88a2052337f26c767421a4f4b7c43"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#aadb88a2052337f26c767421a4f4b7c43">custom_deserialize</a></div><div class="ttdeci">PyObject * custom_deserialize(PyObject *serialized_pyobject, PyObject *custom_serializer)</div><div class="ttdef"><b>Definition</b> pythontarget.c:739</div></div>
 <div class="ttc" id="apythontarget_8h_html_ac17112817f2b0d419f4c8c590fc772ac"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#ac17112817f2b0d419f4c8c590fc772ac">py_main</a></div><div class="ttdeci">PyObject * py_main(PyObject *self, PyObject *args)</div><div class="ttdef"><b>Definition</b> pythontarget.c:279</div></div>
 <div class="ttc" id="apythontarget_8h_html_ac7d72669abb0c6c907e9572da4962525"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#ac7d72669abb0c6c907e9572da4962525">py_schedule</a></div><div class="ttdeci">PyObject * py_schedule(PyObject *self, PyObject *args)</div><div class="ttdef"><b>Definition</b> pythontarget.c:77</div></div>
+<div class="ttc" id="apythontarget_8h_html_ad1b50ff09c749298ebc55199e7d820fc"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#ad1b50ff09c749298ebc55199e7d820fc">custom_serialize</a></div><div class="ttdeci">PyObject * custom_serialize(PyObject *obj, PyObject *custom_serializer)</div><div class="ttdef"><b>Definition</b> pythontarget.c:724</div></div>
 <div class="ttc" id="apythontarget_8h_html_ad7a9ed2af2b471cf5b08aa20eeac0ee9"><div class="ttname"><a href="../../db/dc8/pythontarget_8h.html#ad7a9ed2af2b471cf5b08aa20eeac0ee9">py_package_directory</a></div><div class="ttdeci">PyObject * py_package_directory(PyObject *self, PyObject *args)</div><div class="ttdoc">Return the root project directory path as a string.</div><div class="ttdef"><b>Definition</b> pythontarget.c:175</div></div>
 <div class="ttc" id="astructenvironment__t_html"><div class="ttname"><a href="../../d2/d01/structenvironment__t.html">environment_t</a></div><div class="ttdoc">Execution environment. This struct contains information about the execution environment....</div><div class="ttdef"><b>Definition</b> environment.h:49</div></div>
 </div><!-- fragment --></div><!-- contents -->