Shakespeare Compiler written in Python, splc.py
This is a compiler from SPL to C that implements the majority of the Shakespeare programming language invented by Kalle Hasselstrom and Jon Aslund, I take no credit for inventing the language.
This software is free to edit, use, or sell, but I wouldn't mind if you attached the following copyright notice to any work that utilizes this project.
Copyright © 2014-2015 Sam Donow
sad3@williams.edu
drsam94@gmail.com
This compiler implements most features of the Shakespeare Programming language described at http://shakespearelang.sourceforge.net/report/shakespeare/
The following features not in the original language spec is implemented but is a work in progress:
In the original language spec, goto statements take the form let us proceed to scene III
, let us return to act I
,
etc. As this is both awkward and non-Shakesperian, I have made it so that you can use the name of an act or scene (not case,
punctuation, or whitespace sensitive) in place of a this awkward structure. Therefore, if you had
Act I: The Forest
.
Then the sentence let us return to the forest
is equivalent to let us return to act I
.
Like standard gotos, you can not jump to a scene within an act other than the one you are currently in.
In the original language, everything after the comma in a declaration, such as:
Romeo, an evil octopus.
is ignored: so in the above, though octopus is not a Shakespearean noun, this is allowed. However, the spec does not make it clear what the initial value of a variable should be, which would lead to undefined behavior. In SPL, you can put a noun phrase after Romeo, and it will be evaluated to a number, so for example
Romeo, a good man.
will assign 2 to Romeo. Any non-legal noun phrase will assign 0 instead (as though it had been ignored).
The original SPL specification does not include any keyword to allow generation of random numbers. This compiler supports keywords to allow random integer generation, by beginning a sentence with "let fate" or "let fortune", e.g. "Let fortune decide your future!". The text after the keyword is ignored. By default the RNG is seeded with the time, but to manually seed the RNG, use the statements "The die is cast by ()", which seeds the RNG based on the remainder of the sentence (e.g. "The die is cast by Romeo" seeds the RNG based on Romeo's value. Alternatively, you can use "Alea iacta est." which seeds the RNG based on Julius Caesar's value. Not recommended if Caesar isn't in the play.
The following are planned features not in the original language spec that may be implemented in later versions of this compiler.
- Support for word replaces of functions: If the goal of Shakespeare is to make programs look like plays, then it is sub-optimal having to use words like "square root" all over the place, so I may add a way to define equivalent words for math functions in a text file.
To use spl, simply run
$ ./spl [Input File]
$ ./a.out
Or, if you would like, you can run
$ python splc.py [Input File] > [Output File]
$ gcc [Output File] -lm
$ ./a.out
This version also includes an interpreter that converts to Python instead of to C. It can use used as follows:
$ python python/splpy.py [Input File] > python/[Output File].py
$ python python/[Output File].py
e.g.:
$ python python/splpy.py examples/floatingpoint.spl > floatingpoint.py
$ python python/floatingpoint.py
If you're feeling adventurous you can comment out the print statement at the very end of splpy.py and uncomment the exec statement, which allows you to skip the second step above, so you'd run it as:
$ python python/splpy.py [Input File]
The spl script should work in any bash terminal, on Windows, the explicit python method should work if you have all of the right programs installed. I may at some time get around to writing a .bat script for Windows users.
Dependencies:
- Python (2.X or 3.X)
- gcc