Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Waxeye is an easy to use parser generator based on parsing expression grammars (PEGs). Supports C, Java, Javascript, Python, Ruby and Scheme.
branch: master

This branch is 28 commits behind orlandohill:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
build
docs
grammars
src
test
LICENSE
README

README

============================================
| Waxeye Parser Generator                  |
| www.waxeye.org                           |
| v 0.8.0                                  |
============================================


What is Waxeye?
===============

Waxeye is an easy to use parser generator based on parsing expression grammars.


Features
========

* Choice of Programming Language
  - C
  - Java
  - Javascript
  - Python
  - Ruby
  - Scheme

* Scanner-less Parsing

* Automatic AST Generation

* Language Independent, Reusable Grammars

* Modular, Composable Grammars

* Grammar Testing


User Manual
===========

Waxeye's user manual is in 'docs/manual.html'. The latest version is also
online at http://waxeye.org/manual.html.


Installation
============

Unix, OSX:
1. Extract the files of the distribution.

2. Copy the 'waxeye' directory to where you wish to install it.

3. Add the 'bin/waxeye' binary to your search path. e.g. If you have '~/bin' in
   your PATH and installed waxeye to '/usr/local/waxeye' then you might do the
   following. ln -s /usr/local/waxeye/bin/waxeye ~/bin/


Windows:
1. Extract the files of the distribution.

2. Copy the 'waxeye' directory to where you wish to install it.


Building
========

1. Install Racket
   http://racket-lang.org

2. Install Waxeye's backend for Scheme.
   Unix, OSX:
   sudo ln -s /usr/local/waxeye/src/scheme/waxeye /usr/local/racket/lib/racket/collects/

   Windows:
   Copy the directory 'src/scheme/waxeye' into your Racket 'collects'
   directory. For example, 'C:\Program Files\Racket\collects'.

3. Build Waxeye
   Unix, OSX:
   ./build/unix

   Windows:

   - If your Racket installation isn't 'C:\Program Files\Racket', then you will
   need to modify 'build\exe.bat' to use the correct path.

   - From your Waxeye installation directory, run the 'build\exe.bat' script in a
   command prompt.


Running
=======

Unix, OSX:
Use 'waxeye'.

Windows:
Use a command prompt to run `waxeye.exe`. Note: If using the interpreter under
Windows, you will need to press 'Ctrl-z' and then 'Enter' after the input you
want to interpret.


License
=======

MIT/X11 - All files (except the user manual) are under the permissive MIT/X11
license.

GNU FDL - Waxeye's user manual is under the GNU Free Documentation License.
This includes the files 'doc/book/book' and 'doc/manual.html'.


Support
=======

Feel free to contact me, if you are having trouble or want to give feedback.

Either email me directly:
orlandodarhill at Gmail.com

Or signup and post on the mailing list:
https://lists.sourceforge.net/lists/listinfo/waxeye-users
Something went wrong with that request. Please try again.