Giter Club home page Giter Club logo

bashorun407 / monty Goto Github PK

View Code? Open in Web Editor NEW
1.0 1.0 1.0 20 KB

Learning Objectives At the end of this project, you are expected to be able to explain to anyone, without the help of Google: General What do LIFO and FIFO mean What is a stack, and when to use it What is a queue, and when to use it What are the common implementations of stacks and queues What are the most common use cases of stacks and queues What is the proper way to use global variables Copyright - Plagiarism You are tasked to come up with solutions for the tasks below yourself to meet with the above learning objectives. You will not be able to meet the objectives of this or any following project by copying and pasting someone else’s work. You are not allowed to publish any content of this project. Any form of plagiarism is strictly forbidden and will result in removal from the program. Requirements General Allowed editors: vi, vim, emacs All your files will be compiled on Ubuntu 20.04 LTS using gcc, using the options -Wall -Werror -Wextra -pedantic -std=c89 All your files should end with a new line A README.md file, at the root of the folder of the project is mandatory Your code should use the Betty style. It will be checked using betty-style.pl and betty-doc.pl You allowed to use a maximum of one global variable No more than 5 functions per file You are allowed to use the C standard library The prototypes of all your functions should be included in your header file called monty.h Don’t forget to push your header file All your header files should be include guarded You are expected to do the tasks in the order shown in the project GitHub There should be one project repository per group. If you clone/fork/whatever a project repository with the same name before the second deadline, you risk a 0% score. More Info Data structures Please use the following data structures for this project. Don’t forget to include them in your header file. /** * struct stack_s - doubly linked list representation of a stack (or queue) * @n: integer * @prev: points to the previous element of the stack (or queue) * @next: points to the next element of the stack (or queue) * * Description: doubly linked list node structure * for stack, queues, LIFO, FIFO */ typedef struct stack_s { int n; struct stack_s *prev; struct stack_s *next; } stack_t; /** * struct instruction_s - opcode and its function * @opcode: the opcode * @f: function to handle the opcode * * Description: opcode and its function * for stack, queues, LIFO, FIFO */ typedef struct instruction_s { char *opcode; void (*f)(stack_t **stack, unsigned int line_number); } instruction_t; Compilation & Output Your code will be compiled this way: $ gcc -Wall -Werror -Wextra -pedantic -std=c89 *.c -o monty Any output must be printed on stdout Any error message must be printed on stderr Here is a link to a GitHub repository that could help you making sure your errors are printed on stderr Tests We strongly encourage you to work all together on a set of tests The Monty language 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. 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: julien@ubuntu:~/monty$ cat -e bytecodes/000.m push 0$ push 1$ push 2$ push 3$ pall $ push 4$ push 5 $ push 6 $ pall$ julien@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: julien@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!$ julien@ubuntu:~/monty$ 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 is the line number where the instruction appears. Line numbers always start at 1 The monty program runs the bytecodes line by line and stop if either: it executed properly every line of the file it finds an error in the file an error occured 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, …)

License: MIT License

C 91.24% Brainfuck 8.76%

monty's Introduction

🐍 Monty Interpreter

Welcome to the Monty Bytecode Interpreter. This interpreter was built in the C language and is compliant with ISO90, ISO99, & ISO11. It reads Monty bytecode files of any extension (preferably .m although it doesn't matter), and interprets the opcodes contained.

Our interpreter can be run as either a stack (LIFO) or queue (FIFO). Mode can be switched mid-script. The interpreter can handle a variety of Monty opcodes, including printing, mathematical operations, and more - all handled opcodes are listed below.

🏃 Getting Started

⚠️ Prerequisites

  • Must have git installed.

  • Must have repository cloned.

$ sudo apt-get install git

⬇️ Installing and Using

Clone the repository into a new directory:

$ git clone https://github.com/BennettDixon/monty.git

Compile with the following:

gcc -Wall -Werror -Wextra -pedantic *.c -o monty

Run the interpreter on a file:

./monty file.m

🔧 Monty Opcodes

  • push

    • Usage: push <int>
    • Pushes an element to the stack.
    • The parameter <int> must be an integer.
  • pall

    • Prints all values in the stack/queue, starting from the top.
  • pint

    • Prints the top value of the stack/queue.
  • pop

    • Removes the top element of the stack/queue.
  • swap

    • Swaps the top two elements of the stack/queue.
  • nop

    • Does not do anything.
  • add

    • Adds the top two elements of the stack/queue.
    • The result is stored in the second element from the top and the top element is popped.
  • sub

    • Subtracts the top element of the stack/queue from the second element from the top.
    • The result is stored in the second element from the top and the top element is removed.
  • mul

    • Multiplies the top two elements of the stack/queue.
    • The result is stored in the second element from the top and the top element is removed.
  • div

    • Divides the second element from the top of the stack/queue by the top element.
    • The result is stored in the second element from the top and the top element is removed.
  • mod

    • Computes the modulus of the second element from the top of the stack/queue divided by the top element.
    • The result is stored in the second element from the top and the top element is removed.
  • pchar

    • Prints the character value of the top element of the stack/queue.
    • The integer at the top is treated as an ASCII value.
  • pstr

    • Prints the string contained in the stack/queue.
    • Prints characters element by element until the stack/queue is empty, a value is 0, or an error occurs.
  • rotl

    • Rotates the top element of the stack/queue to the bottom.
  • rotr

    • Rotates the bottom element of the stack/queue to the top.
  • stack

    • Switches a queue to stack mode.
  • queue

    • Switches a stack to queue mode.

▶️ Opcodes preceeded by a # are treated as comments and the corresponding line is ignored.

▶️ Lines can be empty and can contain any number of spaces before or after an opcode and its argument (only the first opcode and/or argument is taken into account).

📋 Examples

Note, Monty Interpreter runs in the default mode of STACK mode. Meaning it uses a stack. To switch to queue mode, see examples below.

Push values onto the stack and print them all, or the top of the stack/front of queue.

$ cat push_pall_pint.m
push 1
push 2
push 3
pall
pint
$ ./monty push_pall_pint.m
3
2
1
3

Using mathmatical operations to add, multiply, divide, etc. Takes the second from the top and performs the operation on the top: second_from_top / top, second_from_top - top, etc. Then assigns that to the second_from_top and pops the top element off the stack.

$ cat math.m
push 3
push 2
push 1
pall
mul
pall
$ ./monty math.m
1
2
3
1
6

Entering queue mode to perform all operations in FIFO (queue) mode instead of default LIFO (stack) mode. Note: does not change current stack, sets front of queue to top of stack.

$ cat queue.m
queue
push 1
push 2
push 3
pall
stack
push 4
push 5
push 6
pall
$ ./monty queue.m
1
2
3
6
5
4
1
2
3

📚 Coding Style Tests

Strictly followed Betty style guide. To install

$ git clone https://github.com/holbertonschool/Betty.git

$ cd Betty; ./install.sh

📝 Version

  • 0.1.0

📘 Authors

🔍 License

This project is licensed under the MIT License - see the LICENSE.md file for details

📣 Acknowledgments

  • Holberton School (providing guidance)
  • Stack Overflow (help on various memory errors (not leaks))

monty's People

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.