HOT PI

team hot pi more like team not high amirite
more like team thought die
but then team fought rye
and then team shot high
and then team dot... sigh
and then team not bye
cuz team hot pi

Pi Features

This project is a compiler from a C-like language of our invention called Hot-Pi to x_86 Assembly.

It was made by Aaditya Murthy, Jake Crabtree, Jake Crouch, Liz Rego, Daniel Wong, Mayuri Raja, Misha Shaposhnikov, Rishab Goel, Rushi Shah, Sindhu Reddy, Smitha Nagar, and Jiaming Chen primarily over the course of one week.

Language Constructs

Primitive Type System
- Booleans
- Longs
- Chars
Pointers
Switch Statements
Arrays
Strings
Function Pointers
Comments
Macros
Structs
Scoped variables
Mature Error Reporting
- Mispelled keyword detection
- Useful messages for all errors
- Mismatched brackets/parentheses and reconstructed expressions
- Color-coded output

Built-in Support for

Sound
Graphics

Neat Extras

Random Number Generator
Delays
Bell Keyword

Contributing

Github reminders

Don't forget to git pull before doing anything in order to avoid merge conflicts. When in doubt, git pull before making any changes to the directory (editing files, etc.). Get into the habit of doing git pull as soon as you cd into the directory and before you leave it.

How to do stuff:

Begin to do stuff:

First clone this repo using git clone https://github.com/2016rshah/pi.git and enter the created directory.
Use git checkout -b <your branch name> to create a new branch and switch to it.
You can now make commits to this branch without modifying master.

After someone else does something, you may want to incorporate that into your branch. To do so (starting from your branch right after you commit/push to your branch):

Use git fetch to get all the remote work other people have done
Use git merge origin/master to merge the remote version of master into your branch
Resolve conflicts by editing the files that are conflicting and fixing everything with <<<<< ... ==== ... >>>> or whatever
After you've successfully resolved all merge conflicts, do make clean test to ensure everything still passes
Use git checkout master to switch to the real deal
Use git merge <YOUR_BRANCH_NAME> to grab everything from your (newly merged) branch into the master branch
Use git push origin master to finish off 😄
If you are going to add more changes, switch back to your branch.

Adding/Removing/Editing tests

The test can be found in their own directory. Basically, you make changes to the code in the p5.c file in the main directory, but edit tests in the test directory. Then, you can run make clean test from the main directory and everything will get synced up and run. Message me if you have any questions/I didn't explain this well enough.

Guidelines:

General

master should only contain functioning code (see instructions above)
Whenever you add a test called like foo.fun and foo.ok run the following command also: printf("\nfoo\n") >> .gitignore which will make sure unecessary files don't flood our folder (obviously replace foo with the name of the test)

Style

If anyone cares to maintain the style of my original code:

Indent with 4 spaces
{ on same line
newline before } always
no newline between } and else
space between relevant keywords (if, while) and (
no space between function name and (
variables, structs, and unions use _ separated lowercase
function names are in camelCase with the initial letter in lowercase

Documentation

Tokenization
- The input is converted into a list of tokens.
- To add a new token, create a new entry in the token_type enum and add a conditional case inside getToken. If the token is a keyword, the additional case should be inside the islower case.
Variable Namespace
- The variable namespace is handled by tries.
- Global and local namespaces have different tries. The global namespace root is pointed to by global_root_ptr. Local namespaces are discarded after each function is parsed.
- var_num is a variable regarding the state of the variable. It is 0 if the variable is never referenced (the node was created because one of its children was referenced). For a global variable, it is 1 if it is referenced. In the local namespace, it is the parameter number (first argument is has var_num 1).
- If variables need to be associated with additional information (types?), that information should probably be added to trie_node.
Expression Evaluation
- expression causes the result of the expression evaluation to be placed in %rax and maintains the values of all other registers.
- e4 places its result in %r15 and may modify %r12, %r13, and %r14.
- e3 places its result in %r14 and may modify %r12 and %r13.
- e2 places its result in %r13 and may modify %r12.
- e1 places its result in %r12.
Function Calls
- Parameters are located on the top of the stack in reverse order before the function is called (parameter 1 is at %rsp, parameter 2 is at %rsp + 8, and so on before the function is called).
- At the beginning of each function call, the original value of %rbp will be stored, and %rbp will be set to the address of the old %rbp (the address after the return value; if parameter 7 exists it will be located at %rbp + 16). %rbp is restored at the end of the function call.

2016rshah / pi