move JFlex to CE source
[fedora-idea.git] / tools / lexer / jflex-1.4 / src / README
blob84ec73be88261be2951f47371e9f78548d3277d0
1 This directory contains the source code for JFlex.
3 For your convenience, the following generated lexer and parser files
4 are included in the distribution:
6 JFlex/LexScan.java  (lexer, generated from src/LexScan.flex)
7 JFlex/LexParse.java (parser, generated from src/LexParse.cup)
8 JFlex/sym.java      (parser symbols, generated from src/LexParse.cup)
11 Dependencies:
12 If you just want to compile the JFlex sources, no further tools are
13 necessary.  If you want to compile the ant task, you need the ant
14 classes in you class path, if you want to compile the unit tests, you
15 need the junit classes in yor class path.
17 To build everything from scratch:
18 In class path:
19 junit.jar    >= 3.8.1     [http://www.junit.org/]
20 ant.jar      >= 1.4       [optional, http://ant.apache.org/]
21 In ant lib dir:
22 java_cup.jar >= 0.10l     [http://www.cs.princeton.edu/~appel/modern/java/CUP/]
23 JFlex.jar    >= 1.4pre1   [http://www.jflex.de/]
26 Dir contents:
27 build.xml:
28   for use with the ant build tool [http://ant.apache.org/]
29   
30   Useful targets are:
31   jar:   recompiles all JFlex classes, generates lexer+parser 
32          only if necessary, zips up all compiled classes in
33          ../lib/JFlex.jar
35   build: cleans up everything and does a completely new build
37   realclean: deletes generated, temporary and *.class files
39 manifest:
40   jar manifest file for JFlex.jar
42 skeleton:
43   a skeleton file matching exactly the precompiled scanner skeleton.
44   Can be used together with the --skel option 
46 skeleton.nested:
47   a skeleton file that supports nested input streams (see the manual 
48   for the API). Can be used together with the --skel option
50 JFlex:
51   source files of package JFlex
53 JFlex/gui:
54   source files of package JFlex.gui
56 JFlex/anttask
57   source files of the JFlex Ant task (contributed by Rafal Mantiuk)
58   
59 JFlex/test
60   unit tests for JFlex
62 java_cup/runtime:
63   CUP v0.10k runtime classes, used by JFlex