asa is both an executable binary that can be run, and a library that can be used in Rust programs.

Installing the command-line executable

Assuming you have Rust/Cargo installed, run this command in a terminal:

cargo install asa

It will make the asa command available in your PATH if you've allowed the PATH to be modified when installing Rust. cargo uninstall asa uninstalls.

Adding `asa` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add asa

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

asa = "1.0.0"

The asa library will be automatically available globally. Read the asa library documentation.

Back to the crate overview.

Readme

Advanced Subleq Assembler

This Subleq assembler assembles a custom language, called Sublang, into Subleq

Features

Interpreter and debugger
Friendly and detailed assembler feedback
Powerful macros
Syntax sugar for common constructs like dereferencing
Optional typing system
Fully fledged standard library including routines and high level control flow constructs like If or While
Fine grained control over your code and the assembler
Module and inclusion system
16-bit
Extensive documentation

What is Subleq?

Subleq or SUBtract and jump if Less than or EQual to zero is an assembly language that has only the SUBLEQ instruction, which has three operands: A, B, C. The value at memory address A is subtracted from the value at address B. If the resulting number is less than or equal to zero, a jump takes place to address C. Otherwise the next instruction is executed. Since there is only one instruction, the assembly does not contain opcodes. So: SUBLEQ 1 2 3 would just be 1 2 3

A very basic subleq interpreter written in Python would look as follows

pc = 0
while True:
    a = mem[pc]
    b = mem[pc + 1]
    c = mem[pc + 2]

    result = mem[b] - mem[a]
    mem[b] = result
    if result <= 0:
        pc = c
    else:
        pc += 3

Most subleq implementations, this one included, also include the IO operations: INPUT, OUTPUT and HALT. These can be achieved by respectively having A = -1, B = -1 and C = -1. INPUT and OUTPUT read or write singular ASCII characters

Installation

cargo install asa or download the binary from the releases tab

Usage

asa MySubleq.sbl

Syntax highlighting

See https://github.com/Kat9-123/sublang-highlighting

Project status

This project is functionally complete, but the documentation for the assembler, Sublang and Sublib is still lacking. As is the Sublib itself, which isn't finished yet

Installing the command-line executable

Adding asa library as a dependency

Adding `asa` library as a dependency