JSEN is the counterpart of JSON. Where JSON encapsulate data, JSEN encapsulate code, moreover JSON can encapsulate JSEN and JSEN can encapsulate JSON in a sort of Yin-Yang paradigm. Primarely JSEN extends the homoiconicity of JavaScript, giving the possibility to create, execute and manipulate programs in a finer grain manner than what is currently possible with JavaScript. The JSEN object define a Virtual Language, providing a set of functions to manipulate JSEN data structures that can be used to store executable statements or run them in a concurent multi-threding environment through a JSEN Virtual Machine (JSENVM, JZENVM, nJZENVM ). A description of all pure JSEN statements, the JSENThreadClass and the JSENVM API can be found here in this repository. Several examples and test are included here as part of the documentation.
You can find a more comprensive description of JSEN if the following paper:
Title: From JSON to JSEN through Virtual Languages
URL: https://www.ronpub.com/OJWT_2021v8i1n01_Ceravola.pdf
JSEN can be installed simply by copying the src folder into your projects or by using npm install jsen-lang.
The documentation is built using jsdoc. You can generate/udpate it by running npm run docs.
The generated documentation can be found in doc/html.
In the folder JSEN/examples/tutorial there is a quick tutorial made by 2 files:
- JSEN/examples/tutorial/tutorialJSEN-JavaScript.js
- JSEN/examples/tutorial/tutorialJSEN-JSEN.js
The tutorial is designed to be browsed by having the 2 files visible at the same time, side-by-side, alligned with line number. The tutorial is subdivided in sections, each section in one file correspond to the equivalent section in the other files (same line numbers). The tutorial is meant to introduce JSEN by showing the equivalence to JavaScript. This way simplify the understanding of the JSEN syntax.
-
JSEN: is the main class implementing the JSEN Virtual Language. It defines all virtual statements and serialization/deserialization functions.
-
JSENVM: is a powerful JSNE Virtual Machine that can:
- Execute JSEN code (JSENVM.run())
- Provide singleton implementation
- Define/execute/control concurrent JSEN threads (extensive API)
- Provide a programmatic debugger for JSEN threads (step, breakpoints, ...)
- Provide JSEN threads sources and execution status
-
JZENVM: a stip-down implementation of a JSEN Virtual Machine in 100 lines of code able to run concurrent JSEN threads. It is useful for understanding the basic JSEN principle. It has a limited JSEN Virtual Language implementation. Among others, it is used to automate JSEN test suite.
-
nJSENVM: a nano implementation of a JSEN Virtual Machine limited to the execution of a single JSEN program and with a very limited Virtual Language set. Its definitively the starting point to understand the JSEN concept.
-
JSENThreadClass: its a more advanced concept for JSEN code encapsulation. allow the implementation of active-objects in JSEN. Its definitively the best way to encapsulate JSEN threads making them more independent and self-sufficient.
JSENStudio is an interactive visual debugger for JSEN code. It can visualize threas sources, show execution line trace and display/plot thread status.
Usage of JSEN Studio
This repository contains several examples, some are executable, some just illustrate the usage of JSEN/JSENVM.
-
JSEN/examples/simpleJSENExample.js
RUN in console: node simpleJSENExample.js
This simple example show the basic concept for defining and executing a JSEN simple example with JSENVM (full VM).
-
JSEN/examples/simpleJZENExample.js
RUN in console: node simpleJZENExample.js
This simple example show the basic concept for defining and executing a JSEN simple example with JZENVM (simple VM).
-
JSEN/examples/selfSleepExample.js
RUN in console: node selfSleepExample.js
This example show how to get own thread id into a running JSEN thread. The example shows how a thread can use its id to suspend itself.
-
JSEN/examples/Benchmark/JSENBenchmark.js
RUN in console: node JSENBenchmark.js
This example shows performances of JSEN compared to pure JavaScript. It is also a good example showing the same algoritm implemented in pure JavaScrip and JSEN (so you can learn JSEN quiclky).
-
JSEN/examples/JSENBrowserExample/JSENExample.js
RUN in broser: file:///..your..repo..path.../JSEN/examples/JSENBrowserExample/JSENExample.html
This example shows 3 threads that controls, each of them, the selection of an Ace editor. You can see here how to start different threads. Open the browser JavaScript console to see the output of the execution.
-
JSEN/examples/JSENBrowserExample/JSENExample2.js
RUN in broser: file:///..your..repo..path.../JSEN/examples/JSENBrowserExample/JSENExample2.html
This example shows 3 threads that animates a red ball into a div. You can see here how to start/stop/renew different threads. Open the browser JavaScript console to see the output of the execution.
-
JSEN/examples/JSENStudio/JSENExample1.js
RUN in browser: file:///..your..repo..path.../JSEN/JSENStudio/index.html?jsenSrc=../examples/JSENStudio/JSENExample1.js
This example shows the execution of 4 different threads each doing something different. It demonstrate how the JSEN Studio debugger works. To start the example click on the play button in the JSEN Studio VCR control icons. To stop, click the stop button. To step (once threads are stopped), double click the play button.
-
JSEN/examples/JSENStudio/JSENExample2.js & JSENExample2Setup.js
RUN in browser: file:///..your..repo..path.../JSEN/JSENStudio/index.html?jsenSrc=../examples/JSENStudio/JSENExample2Setup.js,JSENExample2.js
This example shows threads synchronized with each other. It shows usage of signalInit/Notify/Wait and sleep. It also shows how to load more scripts in the JSENStudio (...?jsenSrc=script1,script2,script3,... NOTE: script without path will use a previously specified script path)
-
JSEN/JSENStudio/index.html
RUN in browser: file:///..your..repo..path.../JSEN/JSENStudio/index.html?
This example executes JSEN/examples/JSENStudio/JSENExample1.js by default.
-
JSEN/examples/concurrentExample1.js
RUN in console: node concurrentExample1.js
This example shows how to execute several threads.
-
JSEN/examples/execExample.js
RUN in console: node execExample.js
Demonstrate usage of JSENVM.exec().
-
JSEN/examples/async1.js
This example shows the comparison of asyncronous implementation of some algorithms. It is useful to notice the differences in the solutions.
-
JSEN/examples/Avatar/Ego.js
This example shows the usage of JSEN code extracted from a real application.
-
JSEN/examples/tutorial/exampleDBInJSEN.js
This example shows the usage of JSEN code extracted from a real application.
-
JSEN/examples/JZENPorting/*
In this folder there are some examples (not fully implemented) that shows how JSEN could be ported to other languages. It shows example of porting to Java, Matlab and Python. Some of them require further work to be completely supporting the JSEN virtual language.
In the folder JSEN/test, there is a full test suite for JSEN and both JSENVM
and JZENVM Virtual Machines. Its a useful reference to learn about the usage
of JSEN.
NOTE: the test suite for JSENVM uses JZENVM to automate the tests ;-)
This project is licensed under the BSD 3-clause license - see the LICENSE.md file for details. The code presented here is original and do not depend on external software.
The copyright holders are not liable for any damage(s) incurred due to improper use of this software.
- Antonello Ceravola
- Catalina Ioan
- Frank Joublin