Skip to content

Latest commit

 

History

History
89 lines (74 loc) · 5.47 KB

README.md

File metadata and controls

89 lines (74 loc) · 5.47 KB
Raw

Mima-Interpreter

Simple Interpreter for the Minimal Machine with debug mode and a couple of config options.

How to write a Program

  • The entire code needs to be written in a text-file, which must have the extension ".mima"
  • Every command must be written in a new line, followed by its parameter (if necessary). The two have to be seperated by a whitespace.
  • All code under the code: keyword will be executed
  • Every program needs to end with HALT
  • Text may be added after the "HALT" command
  • All numbers used inside of the Program must be in Two's Complement format (Wikipedia)
  • If a provided number is not in x-Bit format, it will be filled with leading 0's until it is (LDC 10 in 4-Bit format will automatically be converted to LDC 0010)

How to define storage cells that already have a value

  • You can define storage cells anywhere in your file (with the exception of between the code: Keyword and the HALT command)
  • You define storage cells in format: (adress:value) , where adress will be the name of the cell (any String not containing whitespaces) and value will be the stored value (In Two's Complement format)
  • You dont have to define all the storage you will need, if you try to store a value at a non-existent cell using STV adress, a cell with name adress will be created
  • You have to to write all storage cells directly after the storage: keyword and put the :endStorage keyword directly under your storage cells

(See example.mima for demonstration)

Overview of valid Commands

  • LDC x | loads the Number x into the Akkumulator
  • LDV a | loads the Value at the adress a into the Akkumulator
  • STV a | stores the Value in the Akkumulator at the adress a
  • ADD a | adds the Value stored at the adress a to the Value in the Akkumulator
  • EQL a | writes the Two's Complement Value of -1 into the Akkumulator if the Value in the Akkumulator equals the Value at adress a, and 0 if not
  • AND a | writes 1 into the Akkumulator if the Value in the Akkumulator and the Value at adress a both are 1, and 0 if not
  • OR a | writes 1 into the Akkumulator if the Value in the Akkumulator or the Value at adress a, or both are 1, and 0 if not
  • XOR a | writes 1 into the Akkumulator if either the Value in the Akkumulator, or the Value at adress a, but not both, are 1, and 0 if not
  • JMN y | continues the code execution at the line labeled with y, if the Value in the Akkumulator is negative
  • JMP y | continues the code execution at the line labeled with y, regardless of the Value in the Akkumulator
  • NOT | negates the Two's Complement Value in the Akkumulator (every 1 turns into a 0 and vice versa)
  • RAR | rotates the Two's Complement Value in the Akkumulator one Bit to the right, filling with 0's (10011 --> 01001)
  • HALT | stops the execution of the program. Every program has to end with this command!

As of version 1.2, all commads can be suffixed with a label, which will be used for jumping to that line.

(e.g. LDC 10 label, JMP label will jump to the line with the LDC command)

.config file guide

  • The .config file is used to configure the Interpreter
  • The .config file needs to be in the same directory as the Mima.py file
  • The .config file needs to be named ".config" (basically just don't change the name of the file if you clone this repo)
  • The first line of the .config file specifies the Bit-Length of the Akkumulator and the Storage Cells (The default is 4 as that's the Bit-Length of the example program)
  • The second line of the .config file specifies the folder where the Interpreter will look for the .mima files (The default is None, which means the Interpreter will look in the mimaCode folder in the same directory as the Mima.py file)
  • The third line of the .config file specifies if you want to allow "circular overflow" during addition (The default is False, which means that "circular overflow" will not be allowed, i.e. overflow will be cut off at the Bit-Length of the Akkumulator)

circular overflow means that if you add two numbers that are too big for the Akkumulator, the overflow will be added to the Akkumulator after the normal Addition

(e.g. if you add 1111 and 0001 in a 4-Bit Akkumulator, you get 0000 with an overflow of 0001, this overflow will then be added to 0000 to get the final result of 0001)

How to execute your code

  • python 3.x has to be installed (see Guide)
  • click module needs to be installed: 
    pip install click

The command:

python Mima.py (Path to .mima file)

will run the specified .mima file (assuming you run the command from the folder that Mima.py is saved in).

For example:

python Mima.py myProgram.mima

will run myProgram.mima, which is stored in the mimaCode folder in the same directory as Mima.py.

How to use the debug mode

The command:

python Mima.py (Path to .mima file) --d

will run the specified file in debug mode. For example:

python Mima.py myProgram.mima --d

In debug mode, your code will be executed line by line, showing you:

  • the line number
  • the executed command (including parameters)
  • the current value in the Akkumulator
  • the current value in all of the storage cells

To continue to the next line just hit enter.

Note that the shown values are the values after the command has been executed.