Sched

OCaml version 4.07.1

Development Workflow Overview

Our development workflow will be to featurize the languauge parts of Schedch into small pieces so that they can be implemented in manageable vertical slices. To facilitate collaboration we will adopt a test-driven development methodology supported by effective use of git branching.

Feature Development Workflow

Our feature development workflow should proceed in four phases:

1. Test Creation.
2. Implementation.
3. Testing.
4. Merging.

Test Creation

• Pick a feature to implement. Check the team Trello board to see which features are available. Join the card so that others can know someone is working on that feature.

• Create a new git branch for the feature. Note: Create the new git branch off of the master branch and pull master first to ensure that you have the most up to date consistent version of the Schedch compiler.

• Write a smoke test. A smoke test consists of:

  1. A minimal Schedch program that uses the feature.
  2. The expected output of successfully running our compiler on the minimal program once the feature has been implemented.

  Name the minimal program file <feature>\_smoke\_test.sched and the expected output file <feature>\_smoke\_test.sched.output. Place both files in the tests directory. Add the smoke test to the testall.sh script.

• Write an integration test. An integration test consists of:

  1. A Schedch program that uses the feature in combination with one or more other features.
  2. The expected output of successfully running our compiler on the minimal program once the feature has been implemented.

  Name the program file <feature>\_int\_test.sched and the expected output file <feature>\_int\_test.sched.output. Place both files in the tests directory. Add the integration test to the testall.sh script.

Implementation

• Implement the feature. Happy hacking!

Testing

• make a test file with .sched extension inside tests/ directory for test generation. run ./tmptest.sh to make sure all previous tests pass.
• run ./tmptest.sh -t to keep the temporary output of the .sched file test output (AST, SAST, and codegen)
• if the outputs are good, run ./tmptest.sh -r to generate and replace the output files for comparison with the temporary files (.aout,.sout,.lout)
• if the new feature passes all tests, done!

Merging

• Update your local master branch.
• Merge your updated local master branch into your feature branch.
• Resolve any merge conflicts. Run all tests again. When in doubt, reach out to the author of any code you may be having particular issues with.
• Merge your feature branch into your local master branch and push to the GitHub repository.

Git Conventions

The master branch should always be in a consistent state. Changes should only be made to master once you have fully implemented a feature, tested it, and merged the latest version of master into your feature branch. This is a workflow that leverages the flexibility of Git and its branch features. Read more about it in Scott Chacon's lovely Git Book.

Compiling a Schedch Program

To compile a Schedch program to a native executable:

1. Compile to LLVM code using our Schedch compiler.
2. Compile the LLVM code using the LL compiler.
3. Compile the assembly code using the C compiler.

In bash commands:

./schedch.native -c program.schedch > program.ll
llc program.ll > program.s
cc -o program.exe program.s

4. Also, you can use the newly added compile.sh for compilation with automatic linking with the sched.c file.

usage is as follows: ./compile.sh path/to/your/file