A small compiler, written in Swift, compiling the Bitsy language
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bitsy-swift.xcodeproj Run the Swift 3.0 Migrator 😱 Sep 14, 2016
bitsy-swift Typo fixes and clarifications throughout the doc comments Sep 15, 2016
samples
.gitignore Add a user friendly build process Aug 13, 2016
LICENSE.md Add the MIT License Aug 13, 2016
README.md Updates to the README, including a new resource Sep 15, 2016
build.sh Add a user friendly build process Aug 13, 2016
runbitsy Add several example Bitsy programs Aug 13, 2016

README.md

BitsySwift

BitsySwift is a compiler for the Bitsy language implemented in Swift. It is currently the canonical implementation of Bitsy.

Bitsy

Bitsy is a programming language which aims to be the best language to implement when building your first compiler or interpreter. It is a resource for programmers learning about language implementation.

To learn more about Bitsy or to try implementing it yourself, in your favorite language, check out the runnable, test based language specification, BitsySpec.

You can read more about the motivation behind creating Bitsy on the ScopeLift Blog.

I'll be speaking about creating Bitsy and implementing it in Swift at 360iDev and Indie DevStock. If you're attending either, be sure to say hello!

Requirements

This version of BitsySwift has been tested with:

  • OS X/macOS 10.11 (El Capitan) or later
  • Xcode 8.0
  • Swift 3.0

Linux support is currently limited by Swift Foundation but should come eventually.

Installation

To 'install' the compiler, simply clone and build the repository. You must have Xcode and the xcodebuild utility installed.

git clone https://github.com/apbendi/bitsy-swift.git
cd bitsy-swift
./build.sh

Usage

Once built, you can use the runbitsy script to conveniently build and immediately run any .bitsy file.

./runbitsy samples/collatz.bitsy # Print the Collatz sequence for 7
22
11
34
17
52
26
13
40
20
10
5
16
8
4
2
1

Note: The runbitsy script currently hangs for Bitsy programs which accept user input, though the binaries themselves run fine. Any bash experts know why?

Alternatively, you may directly use the bitsy-swift command line utility directly for additional options:

bin/bitsy-swift --help
Usage: bin/bitsy-swift [options]
  -v, --version:
      Print the version of bitsy-swift
  -h, --help:
      Display bitsy-swift usage
  -c, --read-cli:
      Read Bitsy code from the command line, terminated by a '.'
  -o, --output:
      Specify a name for the binary output
  -e, --emit-cli:
      Emit intermediate compilation to command line
  -r, --run-delete:
      Immediately run and delete the compiled binary
  -i, --retain-intermediate:
      Retain results of intermediate representation

Resources

While Bitsy has been created partially in response to a perceived lack of approachable resources for learning language implementation, there are still some good places to start.

Contributing

Contributions of all types are welcome! Open an issue, create a pull request, or just ask a question. The only requirement is that you be respectful of others.

Please checkout the BitsySpec repo and join the discussion to codify version 1.0 of the Bitsy language specification.