sacbase/sac-compiler repository overview

⁠SaC Compiler

This Docker image provides everything needed to compile and run Single Assignment C (SaC) programs. You do not need to install SaC on your computer.

⁠1. Start the SaC environment

From inside the folder where your SaC files are located, run:

docker run -it --rm \
  -v "$PWD:/workspace" \
  sacbase/sac-compiler:latest

You are now inside the SaC environment. Your current directory on your computer (PWD) is now available under /home.

⁠What does the Docker command do?

• -it gives you an interactive terminal inside the container.
• --rm automatically removes the container when you exit. Files in the mounted directory are not removed.
• -v "$PWD:/workspace" mounts your current directory as /workspace inside the container. Files you create there are therefore stored on your computer.
• sacbase/sac-compiler:latest specifies the Docker image to use.

⁠Optional: Create an alias

You can create an alias so you don't have to type the full Docker command every time:

alias saccompiler='docker run -it --rm -v "$PWD:/workspace" sacbase/sac-compiler:latest'

You can then start the SaC environment with:

saccompiler

The alias only lasts for the current terminal session. To make it permanent, add the alias command to your shell's configuration file, such as ~/.bashrc or ~/.zshrc.

⁠2. Compile and run

Inside the container:

sac2c program.sac
./a.out

The source files and generated files are stored in your normal directory on your computer because it is mounted as /home.

⁠3. Finish

When you are done:

exit

The Docker container is automatically removed. Files in the mounted directory are not deleted.

⁠Updating the image

We generate a fresh image every week for both environments. To update the Docker image to the latest version, run:

docker pull sacbase/sac-compiler:latest

To pull or run a specific image, use sacbase/sac-compiler:yyyy-ww instead, where yyyy is the year, and ww is the week number.