xoudini / regex

A regular expression matcher built using Swift.

Regex

A regular expression matcher built using Swift.

Documentation

The auto-generated documentation is available here.

• Project specification
• Implementation document
• Testing document
• Test coverage
• Performance comparison with grep
• User guide
• Syntax sheet

Reports

• Week 1
• Week 2
• Week 3
• Week 4
• Week 5
• Week 6

Running the project

The latest compiled binaries for macOS and Linux can be found in the latest release.

macOS

The most straight-forward way is to simply install Xcode, but downloading the Swift distribution should be enough.

1. Install Xcode 10.2 from the App Store.
2. Open the workspace (Regex.xcworkspace) in Xcode.
3. Select the scheme for the command-line application.
4. Tests can be run with the key combination ⌘ + U. The program can be executed with the key combination ⌘ + R, or by pressing the ▶ button.

Linux

1. Install Swift 5.0, following the instructions under the title Linux.
2. The tests and executable can the be run using the commands swift test and swift run, respectively.

Docker

For those who have Docker installed and don't feel like installing Swift.

1. Run make container in the root directory of the repository.
2. Once the container is up and running, the tests and executable can the be run using the commands swift test and swift run, respectively.