orlandodarhill / waxeye
watch download tarball
public
Forks1Right
Watchers6Right
Description: Waxeye makes language development easy and fun. It uses scanner-less parsing, grammar testing, automatic AST generation and language independent, modular parsing expression grammars (PEGs). Currently, supports C, Java, Python, Ruby and Scheme.
Homepage: http://waxeye.org/
Clone URL: git://github.com/orlandodarhill/waxeye.git
waxeye / README
100644 129 lines (81 sloc) 2.979 kb
raw blame history 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

 
============================================
| Waxeye Parser Generator                  |
| v 0.7.0                                  |
| www.waxeye.org                           |
| Copyright (C) 2008 Orlando D. A. R. Hill |
============================================
 
 
What is Waxeye?
===============
 
Waxeye makes language development easy and fun. With Waxeye, you can rapidly
explore ideas for the syntax of your language.
 
Whether you are creating a full programming language, a domain-specific
language or just a simple data format, Waxeye will get you there faster.
 
 
Features
========
 
* Scanner-less Parsing
 
* Language Independent, Reusable Grammars
 
* Modular, Composable Grammars
 
* Grammar Testing
 
* Automatic AST Generation
 
* Choice of Programming Language
  - C
  - Java
  - Python
  - Ruby
  - Scheme
 
 
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 MzScheme v4; either with DrScheme or alone.
   http://download.plt-scheme.org
 
2. Install Waxeye's backend for PLT Scheme.
   Unix, OSX:
   sudo ln -s /usr/local/waxeye/src/scheme/waxeye /usr/local/plt/lib/plt/collects/
 
   Windows:
   Copy the directory 'src/scheme/waxeye' into your PLT-Scheme 'collects'
   directory. For example, that might be 'C:\Program Files\PLT\collects'.
 
3. Build Waxeye
   Unix, OSX:
   ./build/unix
 
   Windows:
 
   - If your PLT-Scheme installation isn't 'C:\Program Files\PLT' 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.
 
   - When the script has finished, press 'y' then 'Enter' to remove the
   temporary files.
 
 
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