tiny-calc

Final assignment for the module C963 Foundations of Programming (Grundlagen der Programmierung) from the first semester of my bachelor's degree.

Task

Given, for example, a term in the form: c + * 3.1 4 + 7 8 With the interpretation:

• c + * 3.1 4 + 7 8 the cosine of the result from + * 3.1 4 + 7 8
• + * 3.1 4 + 7 8 is interpreted as: Add * 3.1 4 and + 7 8
• * 3.1 4 is interpreted as the multiplication of 3.1 and 4
• + 7 8 is interpreted as the addition of 7 and 8

Write a calculator, that evaluates any expression of this form.

Project Structure

• src/: Source code of the project lives here
• tests/: Snapshot test files live here
• build/: Temporary folder that contains build artifacts
• COMPILE.txt: Command for compiling a release build of the project
• TEST.txt: Documents all test cases and their user-perceived output
• build.py: Compiles the project for development and generates COMPILE.txt
• test.py: Validates snapshot tests and generates TEST.txt
• justfile: Defines the just * commands

Building

Make sure that you have a modern version of gcc installed before building. Needs C++23 support.

To build the project simply execute the command found in COMPILE.txt.

Development

Setup

Make sure that you have these tools installed before doing a development build or running the tests:

• just https://github.com/casey/just
• gcc https://gcc.gnu.org
• clang-format https://clang.llvm.org
• git https://git-scm.com
• python https://www.python.org

And the following are optional (speed up build times):

• sccache https://github.com/mozilla/sccache
• mold https://github.com/rui314/mold

Scripts

• List all just commands via just --list
• just build or just b are used to build the project
• just run or just r are used to build and run the project
• just test or just t are used to run all tests
• just format to apply fromatting to all C++ files located in src/

Tipps

Prefix the compile command with SCCACHE_RECACHE=1 when changing build.py to force scache to use the new configuration and recompile everything.

Example:

# changed compiler flags in build.py
$ SCCACHE_RECACHE=1 just run
# everything gets recompiled and then tiny-calc gets run