BOOP!: How to Right Code.

A novel problem-solving tool for students of introductory computer science. This is designed to promote structured thinking, strong design choices, self-reflection and a well-probed problem-solving stream.

Language Syntax

The ICS language syntax is designed to be simple and intuitive, allowing users to write structured documents easily. There are only 5 syntax features to know:

• Sections follow tag-based hierarchy (similar to HTML!). A line with an open tag (e.g. requires: ) should contain the tag only. Start writing the content from the next > > - line onwards.

• Main-tags (intuitively, these are the 'broad' sections) use double angle brackets (<< >>).

• Sub-tags (intuitively, these are the sub-sections) use a simple tag_name: format

• A main-tag MUST have all its sub-tags, even if they are empty. This is to ensure that the document is well-structured and complete.

• Comments are started using //.

Note: Currently 'newline' (i.e. different lines appearing on different lines in the compiled version) is only supported in 'proof', specifically 'induction', and 'blueprint'. The other sections will soon support newlines.

Header Block

Every submission must inlcude a header in the following format. All fields of the header are mandatory.

<< header

assignment : Assignment 5: Sorting & Searching
student : Vaani Goenka
date : 15th June 2025
collaborators : None

header >>

Syntax in action: B O O P !

1. Problem Block

<< problem 1 : "Title of the Problem"

    ... (all other BOOP blocks go here)

 problem >>

• Every problem must be enclosed within a problem block. Failure to do so might result in a blank submission despite other BOOP tags.
• 'problem' must be followed by a number, a colon and the title of the problem in double quotes as shown above.
• Proper error message for the above is in progress.

2. Blueprint

This main-section is intended for the user to lay out the correctness criteria of their program i.e. what are the characeteristics (formally) of the input and output that must hold true for the program to be considered correct.

<< blueprint  

     requires : <br>
     [conditions that must hold before execution] \
     ensures : <br>
     [conditions that must hold after execution]

 blueprint >>

3. Operational Steps

This section is for the user to explain their algorithm (process) for solving the given problem as if to a human.

<< operational steps 

     step 1 : Considering the base case n=0, we can think of the problem as one....\
     step n : We eventually reach n=0 because we are subtracting at every step so the base case....

 operational steps >>

4. Ocaml Code

Write your standard ICS-friendly OCaml code here. It will be validated by the ICS OCaml validator.

<< ocaml code 

   (* Write your code in regular OCaml syntax, following ICS guidelines *) 

ocaml code >>

The status of your code is then reflected in the compiled version as so:

Errors in your code will appear in a pop-up during compilation, but will not stop compilation. Your submission will be compiled and your PDF will have your code marked as invalid according to ICS syntax.

5. 📖 Proof

This section is intended for the user to provide a complete and formal proof that their program satisfies the given correctness criteria in the blueprint.

Proof by induction would look like:

<< proof  
<< induction  
base case : <br>
... <br>
induction hypothesis : <br>
... <br>
indutive step : <br>
...<br>

proof >>

Loop invariants would look like:

<< proof 
<< invariant 
pre-condition : <br>
...  <br>
after the ith step : <br>
... <br>
after the (i+1)th step : <br>
...<br>
post-condition : <br>
...<br>
invariant >>

proof >>

Usage:

1. Install dependencies in your working folder (Assuming you have opam installed. opam is the package manager for OCaml.)

opam install dune ocaml odoc ppxlib

2. Create your .ics file in your working folder
3. Open the command palette (Cmd+Shift+P on mac or Ctrl+Shift+P on windows)
4. Type ICS
5. Select ICS: Compile ICS
6. Your PDF opens up in your default PDF viewer.

Please note that the dropdown option: 'Compile for assignment [#1](https://github.com/vaaniGO/ICSLang/issues/1)' is a test option and not relevant to current users!

Information for Instructors

Customisation for compilation

Instructors may modify the file src/assignment_1.txt (for assignment_1 example) by simply specifying the flags they wish to allow as follows:

const allowed_flags = "-allow_for_loops";

All allowed flags are:

-allow_for_loops -allow_while_loops -allow_mutability -allow_lambdas

By default, none of these are set to allowed.
Currently, there is a test command available on opening the command palette saying compile for assignment [#1](https://github.com/vaaniGO/ICSLang/issues/1). This applies instructor modifications to assignment_1.txt effectively in compilation.

Modifcations to instructor pipeline are in progress.

Acknowledgements

Thank you to Prof Aalok D. Thakkar for his guidance and mentorship.

Version Info

Developer and Maintainer: Vaani Goenka vaani.goenka_ug2024@ashoka.edu.in
Changelog
0.5.4
Second major release
OCaml code validation
Instructor discretion to add plugins to customise validation
Better extension features like collapsing sections
Newline bug fixed
Better error messages, PDF generation error fixed!