https://github.com/therebelrobot/whitespace

A Codewars Kata, whitespace is an esoteric imperative programming language, implemented in javascript
https://github.com/therebelrobot/whitespace

Last synced: 9 days ago
JSON representation

A Codewars Kata, whitespace is an esoteric imperative programming language, implemented in javascript

• Host: GitHub
• URL: https://github.com/therebelrobot/whitespace
• Owner: therebelrobot
• Created: 2015-09-09T15:16:42.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2015-09-09T15:45:45.000Z (over 9 years ago)
• Last Synced: 2024-11-08T11:19:29.572Z (2 months ago)
• Language: JavaScript
• Homepage:
• Size: 141 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Whitespace

A [Codewars Kata](http://www.codewars.com/kata/whitespace-interpreter)

[Whitespace](http://compsoc.dur.ac.uk/whitespace/tutorial.php) is an esoteric programming language that uses only three characters:

- `[space]` or ` ` (ASCII 32)

- `[tab]` or `\t` (ASCII 9)

- `[line-feed]` or `\n` (ASCII 10)

Whitespace is an imperative, stack-based programming language, including features such as subroutines.

Each command in whitespace begins with an _Instruction Modification Parameter_ (IMP).

### IMPs

- [space]: Stack Manipulation

- [tab][space]: Arithmetic

- [tab][tab]: Heap Access

- [tab][line-feed]: Input/Output

- [line-feed]: Flow Control

There are two types of data a command may be passed: numbers and labels.

#### Parsing Numbers

- Numbers begin with a `[sign]` symbol. The sign symbol is either `[tab]` -> **negative**, or `[space]` -> **positive**. 

- Numbers end with a `[terminal]` symbol: `[line-feed]`. 

- Between the sign symbol and the terminal symbol are binary digits `[space]` -> **binary-0**, or `[tab]` -> **binary-1**. 

- A number expression `[sign][terminal]` will be treated as **zero**. 

- The expression of just `[terminal]` should **throw an error**. _(The Haskell implementation is inconsistent about this.)_ 

#### Parsing Labels

- Labels begin with any number of `[tab]` and `[space]` characters. 

- Labels end with a **terminal** symbol: `[line-feed]`.

- Unlike with numbers, the expression of just `[terminal]` is **valid**. 

- Labels **must** be unique. 

- A label **may** be declared either before or after a command that refers to it. 

### Input/Output

As stated earlier, there commands may read data from input or write to output.

#### Parsing Input

Whitespace will accept input either characters or integers. Due to the lack of an input stream mechanism, the input will be passed as a string to the interpreter function.

- Reading a character involves simply taking a character from the input stream. 

- Reading an integer involves parsing a decimal or hexadecimal number from the current position of the input stream, up to and terminated by a line-feed character. 

- The original implementation being in Haskell has stricter requirements for parsing an integer. 

- The Javascript and Coffeescript implementations will accept any number that can be parsed by the **parseInt** function as a single parameter. 

- The Python implementations will accept any number that can be parsed by the **int** function as a single parameter. 

- An error should be thrown if the input ends before parsing is complete. _(This is a non-issue for the Haskell implementation, as it expects user input)_ 

#### Writing Output

- For a number, append the output string with the number's string value. 

- For a character, simply append the output string with the character. 

### Commands

Notation: **_n_** specifies the parameter, `[number]` or `[label]`.

**Errors should be thrown** for invalid numbers, labels, and heap addresses, or if there are not enough items on the stack to complete an operation (unless otherwise specified). In addition, an error should be thrown for unclean termination.

#### IMP `[space]` - Stack Manipulation

- `[space]` (number): Push _n_ onto the stack.

- `[tab][space]` (number): Duplicate the _n_th value from the top of the stack.

- `[tab][line-feed]` (number): Discard the top _n_ values below the top of the stack from the stack. (_For **n**<**0** or **n**>=**stack.length**, remove everything but the top value._)

- `[line-feed][space]`: Duplicate the top value on the stack.

- `[line-feed][tab]`: Swap the top two value on the stack.

- `[line-feed][line-feed]`: Discard the top value on the stack.

#### IMP `[tab][space]` - Arithmetic

- `[space][space]`: Pop `a` and `b`, then push `b+a`.

- `[space][tab]`: Pop `a` and `b`, then push `b-a`.

- `[space][line-feed]`: Pop `a` and `b`, then push `b*a`.

- `[tab][space]`: Pop `a` and `b`, then push `b/a`

- - If `a` is zero, throw an error.    

- - ***Note that the result is defined as the floor of the quotient.**

- `[tab][tab]`: Pop `a` and `b`, then push `b%a`

- - If `a` is zero, throw an error.

- - ***Note that the result is defined as the remainder after division and sign (+/-) of the divisor (a).**

#### IMP `[tab][tab]` - Heap Access

- `[space]`: Pop `a` and `b`, then store `a` at heap address `b`.

- `[tab]`: Pop `a` and then push the value at heap address `a` onto the stack.

#### IMP `[tab][line-feed]` - Input/Output

- `[space][space]`: Pop a value off the stack and output it as a **character**.

- `[space][tab]`: Pop a value off the stack and output it as a **number**.

- `[tab][space]`: Read a **character** from input, `a`, Pop a value off the stack, `b`, then store the ASCII value of `a` at heap address `b`.

- `[tab][tab]`: Read a **number** from input, `a`, Pop a value off the stack, `b`, then store `a` at heap address `b`.

#### IMP `[line-feed]` - Flow Control

- `[space][space]` (label): Mark a location in the program with label _n_.

- `[space][tab]` (label): Call a subroutine with the location specified by label _n_.

- `[space][line-feed]` (label): Jump unconditionally to the position specified by label _n_.

- `[tab][space]` (label): Pop a value off the stack and jump to the label specified by _n_ **if** the value is zero.

- `[tab][tab]` (label): Pop a value off the stack and jump to the label specified by _n_ **if** the value is less than zero.

- `[tab][line-feed]`: Exit a subroutine and return control to the location from which the subroutine was called.

- `[line-feed][line-feed]`: Exit the program.

Note that in Javascript and Coffeescript, the modulus operator is implemented differently than it was in the original Whitespace interpreter, which was influenced by it being defined in Haskell. Javascript and Coffeescript also lack integer division operations. There is no difference between Whitespace and Python in the same regard. Therefore, the Javascript and Coffeescript interpreters require a little extra attention in regard to the implementation in regard to integer division and the modulus operator (See: [floored division in the Wikipedia article "Modulo operation"](https://en.wikipedia.org/wiki/Modulo_operation#Remainder_calculation_for_the_modulo_operation).