README.md

The Monty Language Interpreter

Monty 0.98 is a scripting language that is first compiled into Monty byte codes (Just like Python). It relies on a unique stack, with specific instructions to manipulate it. The goal of this project is to create an interpreter for Monty ByteCodes files. The monty interpreter is designed to execute instructions in a Monty ByteCode file.

Installation and uninstalling: How to install the program

1. First, clone this repository:

```
vagrant@ubuntu:~$ git clone https://github.com/Ebuube/Monty_language.git
```

2. Change into this newly created directory:

```
vagrant@ubuntu:~$ cd Monty_language
vagrant@ubuntu:~/Monty_language$
```

3. Then run the Makefile
   
   

   #Note: Ensure you have gcc and make installed on your system before running the Makefile.

   vagrant@ubuntu:~/Monty_language$ make
   

   If you don't have make utility installed, check out how to install it. For Ubuntu, you can look at this documentation How to install make on Ubuntu

5. Confirm installation by running the monty command on a sample bytecode file and expect the result shown below. Example:

```
vagrant@ubuntu:~$ cat bytecode.m
push 1
push 2
push 3
add
pint
push 4
pall
vagrant@ubuntu:~$ monty bytecode.m
5
4
5
1
vagrant@ubuntu:~$
```

#Note: Once installed, you can use monty anywhere in your machine :).

To Uninstall

Change into the repository you cloned and run the clean target of make thus:

```
vagrant@ubuntu:~/Monty_language$ make clean
```

If the repo has been deleted or is no where to be found, you can easily unisintall 'monty' by removing the binary file from the /usr/bin directory thus:

```
vagrant@ubuntu:~$ sudo rm /usr/bin/monty
```

Execution: How to use the monty program

The monty program

• Usage: monty file
  • where file is the path to the file containing Monty byte code

• If the user does not give any file or more than one argument to your program, print the error message USAGE: monty file, followed by a new line, and exit with the status EXIT_FAILURE

• If, for any reason, it’s not possible to open the file, print the error message Error: Can't open file <file>, followed by a new line, and exit with the status EXIT_FAILURE
  • where <file> is the name of the file

• If the file contains an invalid instruction, print the error message L<line_number>: unknown instruction <opcode>, followed by a new line, and exit with the status EXIT_FAILURE
  • where line_number is the line number where the instruction appears.
  • Line numbers always start at 1

• The monty program runs the byte codes line by line and stop if either:
  • it executed properly every line of the file
  • it finds an error in the file
  • an error occurred

• If you can’t malloc anymore, print the error message Error: malloc failed, followed by a new line, and exit with status EXIT_FAILURE.

• You have to use malloc and free and are not allowed to use any other function from man malloc (realloc, calloc, …)

Example: Given a monty byte code file named 00.m in the bytecodes directory, we can execute it thus...

vagrant@ubuntu:~/monty$ cat -e bytecodes/00.m
push 1$
push 2$
push 3$
pall$
vagrant@ubuntu:~/monty$ monty bytecodes/00.m
3
2
1
vagrant@ubuntu:~/monty$

opcodes: Available opcodes

• push: Usage: push <int>
  • This pushes an (integer) element to the stack.

• pall: Usage: pall
  • This prints all the values on the stack, starting from the top of the stack.

• pint: Usage: pint
  • This prints the value at the top of the stack, followed by a new line.

• pop: Usage: pop
  • This removes the top element of the stack, but doesn't print or return it.

• swap: Usage: swap
  • This swaps the top two elements of the stack.

• add: Usage: add
  • This adds the top two element of the stack. The result is stored in the second top element of the stack, and the top element is removed, so that at the end:
    • The top element of the stack contains the result
    • The stack is one element shorter

• nop: Usage: nop
  • This opcode does not do anything.

• sub: Usage: sub
  • This subtracts the top element of the stack from the second top element. Then removes the top element of the stack so that the stack becomes one element shorter. The result is store in the currently top element of the stack.

• div: Usage: div
  • This divides the top element of the stack by the second top element. Then removes the top element of the stack so that the stack becomes one element shorter. The result is store in the currently top element of the stack.

• mul: Usage: mul
  • This multiply the second top element of the stack with the top element. Then removes the top element of the stack so that the stack becomes one element shorter. The result is store in the currently top element of the stack.

• mod: Usage: mod
  • This computes the rest of the division of the second top element of the stack by the top element of the stack. Then removes the top element of the stack so that the stack becomes one element shorter. The result is store in the currently top element of the stack.

• pchar: Usage: pchar
  • This prints the character at the top of the stack, followed by a new line. The value at the top of the stack must be a valid decimal representation of an ASCII character. In other words, it should be in the range 0 - 127 inclusive.

• pstr: Usage: pstr
  • This prints the string starting at the top of the stack, followed by a new line. The string stops when either:
    • the stack is over
    • the value of the element is 0
    • the value of the element is not in the ASCII table If the stack is empty, print only new line.

• rotl: Usage: rotl
  • This rotates the stack to the top. The top element of the stack becomes the last one, and the second top element of the stack becomes the first one.

• rotr: Usage: rotr
  • This rotates the stack to the bottom. The last element of the stack becomes the top element of the stack.

• stack: Usage: stack
  • Set the format of the data to a stack (LIFO). This is the default behaviour of the program :).

• queue: Usage: queue
  • Set the format of the data to a queue (FIFO).

Note: When switching mode:

* The top of the stack becomes the front of the queue.
* The front of the queue becomes the top of the stack.

Comments

You can create a comment in a bytecode file by starting the line with an hash #. You can as well have blank lines in your file. Example: In a file named bytecode.m

```
vagrant@ubuntu:~$ cat bytecode.m
# Load new elements
push 4
push 3

# Print all elements
pall

#I may not give space immediately after the comment
# I may decide to do so, equally :)
```

Warning: Values outside INT_MIN - INT_MAX (both exclusive) can't be used as data values for the stack

File format: Monty instruction file format

Monty byte code files

Files containing Monty byte codes usually have the .m extension. Most of the industry uses this standard but it is not required by the specification of the language. There is not more than one instruction per line. There can be any number of spaces before or after the opcode and its argument:

Given a directory named bytecodes that contains Monty byte codes.

vagrant@ubuntu:~/monty$ cat -e bytecodes/000.m
push 0$
push 1$
push 2$
  push 3$
                   pall    $
push 4$
    push 5    $
      push    6        $
pall$
vagrant@ubuntu:~/monty$

Monty byte code files can contain blank lines (empty or made of spaces only, and any additional text after the opcode or its required argument is not taken into account:

vagrant@ubuntu:~/monty$ cat -e bytecodes/001.m
push 0 Push 0 onto the stack$
push 1 Push 1 onto the stack$
$
push 2$
  push 3$
                   pall    $
$
$
                           $
push 4$
$
    push 5    $
      push    6        $
$
pall This is the end of our program. Monty is awesome!$
vagrant@ubuntu:~/monty$

Dependencies

• You must have the make utility installed on your system
• You must have gcc compiler on your system

Further Reading

Creating an Interpreter for Monty Byte codes Using C Programming Language
Monty Language: Implementing Stacks & Queues

Acknowledgements