Simple synchronous programming language
Project description
Compass
Disclaimer: This is a personal side-project
Compass :compass: is a small programming language with strong inpiration from Esterel. It is a synchronous programming language meant to build finite state machines easily for your C code.
Unlike Esterel, Compass is very bare bones and uses a rather trivial compilation process, which can lead to very different behaviours for code that looks similar.
The ABRO code example adapted for Compass looks like :arrow_down_small:
module abro(input A, input B, input R, output O)
each R seq {
par {
await A;
await B;
};
emit O;
}
endmodule
Installation
The Compass compiler is distributed as a Python source package. To install it, one can run :arrow_down_small:
# Fetch the source code
git clone https://github.com/roadelou/compass.git
# Go into the repository
cd compass
# Install the python package
pip3 install .
A PyPi package is also available for the compiler, and it can be installed with pip3 install roadelou_compass
:tada:
Usage
Once the compiler is installed, it can be used from the terminal through the compass
command. Basic usage is :arrow_down_small:
# This will output a C file called abro_compass.c
compass abro.cmps
# To compile the header file to use the C code
compass --lang header abro.cmps
# To compile a CLI interface to test the module
compass --lang debug abro.cmps
Examples
Some examples of the language can be found in the examples folder.
Features
The version of compass in the repository supports:
input
andoutput
signalslocal
variableseach
,par
,seq
,await
andemit
statements- Conditional tests with
if
,elif
,else
andendif
- The ability to use submodules within a module with the
extern
andsubmodule
keywords - Many C-inspired operators for expressions
:warning: Be careful about the syntax for end-of lines. The ;
operator should only be used to separate several statements in a list of statements, i.e. only in seq
and par
blocks. The last ;
is optional by the way.
METADATA
Field | Value |
---|---|
:pencil: Contributors | roadelou |
:email: Contacts | |
:date: Creation Date | 2021-03-12 |
:bulb: Language | Markdown Document |
EOF
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for roadelou_compass-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3fe5c130595b765d84c1d99ba6d3f7ea74d08a8462a4839504e46bc10a4b3b86 |
|
MD5 | 99a4da739494f81e9f947d2eec0d906c |
|
BLAKE2b-256 | 645c18785f735c7cfa95329c257d71b15f1f27048aa4ba5da53d0e7d78e2f3e7 |