| 1 |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| 2 |
<html xmlns="http://www.w3.org/1999/xhtml"> |
| 3 |
<!-- |
| 4 |
|
| 5 |
Copyright (c) 2006, Sun Microsystems, Inc. |
| 6 |
All rights reserved. |
| 7 |
|
| 8 |
Redistribution and use in source and binary forms, with or without |
| 9 |
modification, are permitted provided that the following conditions are met: |
| 10 |
|
| 11 |
* Redistributions of source code must retain the above copyright notice, |
| 12 |
this list of conditions and the following disclaimer. |
| 13 |
* Redistributions in binary form must reproduce the above copyright |
| 14 |
notice, this list of conditions and the following disclaimer in the |
| 15 |
documentation and/or other materials provided with the distribution. |
| 16 |
* Neither the name of the Sun Microsystems, Inc. nor the names of its |
| 17 |
contributors may be used to endorse or promote products derived from |
| 18 |
this software without specific prior written permission. |
| 19 |
|
| 20 |
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| 21 |
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| 22 |
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| 23 |
ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE |
| 24 |
LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| 25 |
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| 26 |
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| 27 |
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| 28 |
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| 29 |
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
| 30 |
THE POSSIBILITY OF SUCH DAMAGE. |
| 31 |
|
| 32 |
--> |
| 33 |
<head> |
| 34 |
<title>JavaCC Documentation Index</title> |
| 35 |
<!-- Changed by: Michael Van De Vanter, 14-Jan-2003 --> |
| 36 |
</head> |
| 37 |
<body bgcolor="#FFFFFF" > |
| 38 |
|
| 39 |
<h1>JavaCC [tm]: Documentation Index</h1> |
| 40 |
<p> |
| 41 |
By following the links from this page you should be able to obtain all |
| 42 |
necessary documentation on JavaCC [tm]. |
| 43 |
</p> |
| 44 |
<p> |
| 45 |
If you have further questions, please do not hesitate to |
| 46 |
<a href="mailinglist.html">contact us</a>. |
| 47 |
We recommend the following step-by-step process to learning JavaCC: |
| 48 |
</p> |
| 49 |
<ul> |
| 50 |
<li> |
| 51 |
Go through the simple examples that are available as part of the Java Compiler |
| 52 |
Compiler [tm] release. This is located under the <code>examples</code> directory in a |
| 53 |
directory called <code>SimpleExamples</code>. Read the file |
| 54 |
<a href="simpleREADME.html"><code>README</code></a> |
| 55 |
in this directory for complete instructions. |
| 56 |
</li> |
| 57 |
<li> |
| 58 |
Go through the tree building examples (that use JJTree) that are also available |
| 59 |
as part of the JavaCC release. This is located under the <code>examples</code> directory in a |
| 60 |
directory called <code>JJTreeExamples</code>. Read the file |
| 61 |
<a href="jjtreeREADME.html"><code>README</code></a> |
| 62 |
in this directory for complete instructions. |
| 63 |
</li> |
| 64 |
<li> |
| 65 |
Study the description of |
| 66 |
<a href="javaccgrm.html">the JavaCC grammar file</a>. |
| 67 |
This provides the complete syntax of the grammar file along with a detailed |
| 68 |
description of these constructs. There are also many examples in the <a href="http://javacc.dev.java.net/servlets/ProjectDocumentList?folderID=110">grammar repository</a>. |
| 69 |
</li> |
| 70 |
<li> |
| 71 |
<a href="commandline.html">Click here</a> to see the document that describes the |
| 72 |
command line input syntax. |
| 73 |
</li> |
| 74 |
<li> |
| 75 |
The <a href="apiroutines.html">JavaCC API routines</a> are a bunch of classes, |
| 76 |
methods, and variables which may be accessed from user code (typically from |
| 77 |
<a href="javaccgrm.html#prod22">actions - the <EM>java_block</EM> in the syntax</a>). |
| 78 |
</li> |
| 79 |
<li> |
| 80 |
<a href="JJTree.html">Click here</a> to get to the JJTree documentation. |
| 81 |
</li> |
| 82 |
<li> |
| 83 |
<a href="JJDoc.html">Click here</a> to get to the JJDoc documentation. |
| 84 |
</li> |
| 85 |
<li> |
| 86 |
Detailed JavaCC documentation is organized as a set |
| 87 |
of <em>minitutorials</em>, each on a separate topic. The following |
| 88 |
minitutorials are currently available: |
| 89 |
<ul> |
| 90 |
<li> |
| 91 |
<a href="lookahead.html">Lookahead MiniTutorial</a>: |
| 92 |
This is a complete guide to how lookahead processing is performed and provides |
| 93 |
tips on how to insert local lookahead specifications. |
| 94 |
</li> |
| 95 |
<li> |
| 96 |
<a href="tokenmanager.html">Token Manager MiniTutorial</a>: |
| 97 |
This is a description to how the token manager works. |
| 98 |
</li> |
| 99 |
<li> |
| 100 |
<a href="errorrecovery.html">Customizing Error Messages and Recovering From Errors</a>: |
| 101 |
This document describes how you can customize error messages and also recover |
| 102 |
from errors during parsing. |
| 103 |
</li> |
| 104 |
<li> |
| 105 |
<a href="CharStream.html">Using the Default Character Stream Readers</a>: |
| 106 |
This document describes the various ways in which you can use the default |
| 107 |
character stream reader classes that are generated by JavaCC. |
| 108 |
</li> |
| 109 |
</ul> |
| 110 |
</li> |
| 111 |
</ul> |
| 112 |
|
| 113 |
</body> |
| 114 |
</html> |