|
Server : Apache/2.2.2 (Fedora) System : Linux App1.pathumtani.go.th 2.6.20-1.2320.fc5smp #1 SMP Tue Jun 12 19:40:16 EDT 2007 i686 User : apache ( 48) PHP Version : 5.2.9 Disable Function : NONE Directory : /usr/share/javadoc/antlr-2.7.4/antlr/ |
Upload File : |
<?xml version="1.0" encoding="US-ASCII"?>
<!DOCTYPE html PUBLIC "-//gnu.org///DTD XHTML 1.1 plus Target 1.0//EN" "../resources/xhtml11-target10.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><title>Grammar (antlr Javadoc)</title><script src="../resources/gjdoc.js" type="text/javascript"><!-- this comment required for konqueror 3.2.2 --></script><meta http-equiv="Content-Type" content="text/html; charset=US-ASCII"/><meta name="generator" content="GNU Gjdoc Standard Doclet"/><meta name="keywords" content="antlr.Grammar class"/><meta name="keywords" content="antlrTool"/><meta name="keywords" content="generator"/><meta name="keywords" content="theLLkAnalyzer"/><meta name="keywords" content="symbols"/><meta name="keywords" content="buildAST"/><meta name="keywords" content="analyzerDebug"/><meta name="keywords" content="interactive"/><meta name="keywords" content="superClass"/><meta name="keywords" content="tokenManager"/><meta name="keywords" content="exportVocab"/><meta name="keywords" content="importVocab"/><meta name="keywords" content="options"/><meta name="keywords" content="rules"/><meta name="keywords" content="preambleAction"/><meta name="keywords" content="className"/><meta name="keywords" content="fileName"/><meta name="keywords" content="classMemberAction"/><meta name="keywords" content="hasSyntacticPredicate"/><meta name="keywords" content="hasUserErrorHandling"/><meta name="keywords" content="maxk"/><meta name="keywords" content="traceRules"/><meta name="keywords" content="debuggingOutput"/><meta name="keywords" content="defaultErrorHandler"/><meta name="keywords" content="comment"/><meta name="keywords" content="define()"/><meta name="keywords" content="generate()"/><meta name="keywords" content="getClassName()"/><meta name="keywords" content="getDefaultErrorHandler()"/><meta name="keywords" content="getFilename()"/><meta name="keywords" content="getIntegerOption()"/><meta name="keywords" content="getOption()"/><meta name="keywords" content="getSuperClass()"/><meta name="keywords" content="getSymbol()"/><meta name="keywords" content="getSymbols()"/><meta name="keywords" content="hasOption()"/><meta name="keywords" content="isDefined()"/><meta name="keywords" content="processArguments()"/><meta name="keywords" content="setCodeGenerator()"/><meta name="keywords" content="setFilename()"/><meta name="keywords" content="setGrammarAnalyzer()"/><meta name="keywords" content="setOption()"/><meta name="keywords" content="setTokenManager()"/><meta name="keywords" content="toString()"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-layout.css" title="GNU Clean"/><link rel="stylesheet" type="text/css" href="../resources/gjdochtml-clean-color1.css" title="GNU Clean"/></head><body class="content class" onload="if(parent.contentPageLoaded)parent.contentPageLoaded(document.title)"><table class="navbar div top"><tr><td class="navbar div top"><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="Grammar-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex-1.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr><tr><td class="navi"><a href="../antlr/FileLineFormatter.html">Prev Class</a> | <a href="../antlr/GrammarAnalyzer.html">Next Class</a></td><td class="navi"><a href="../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="Grammar.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | <a href="#summary-fields">Field</a> | <a href="#summary-methods">Method</a> | <a href="#summary-constructors">Constr</a></td><td class="navi">Detail: Nested | <a href="#detail-fields">Field</a> | <a href="#detail-methods">Method</a> | <a href="#detail-constructors">Constr</a></td></tr></table><div class="class title outer"><h3 class="class title-package">antlr</h3><h1 class="class title-class">Class Grammar</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code><a href="file:/usr/share/javadoc/java/java/lang/Object.html">java.lang.Object</a></code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>antlr.Grammar</code></li><li></li></ul></li></ul></div><dl class="class subclasses"><dt class="class subclasses header"><b>Known Direct Subclasses:</b></dt><dd class="class subclasses header"><a href="../antlr/LexerGrammar.html" title="Class in antlr">LexerGrammar</a>, <a href="../antlr/ParserGrammar.html" title="Class in antlr">ParserGrammar</a>, <a href="../antlr/TreeWalkerGrammar.html" title="Class in antlr">TreeWalkerGrammar</a></dd></b></dt></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>public abstract class <b class="class synopsis name">Grammar</b></code></div><div class="class synopsis superclass"><code>extends <a href="file:/usr/share/javadoc/java/java/lang/Object.html" title="Class in ">Object</a></code></div></div><hr/><div class="class description">A Grammar holds a set of rules (which are stored
in a symbol table). Most of the time a grammar
needs a code generator and an LLkAnalyzer too.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><a name="summary-fields" id="summary-fields"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Field Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#analyzerDebug">analyzerDebug</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/Tool.html" title="Class in antlr">Tool</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#antlrTool">antlrTool</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#buildAST">buildAST</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/Token.html" title="Class in antlr">Token</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#classMemberAction">classMemberAction</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#className">className</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#comment">comment</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#debuggingOutput">debuggingOutput</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#defaultErrorHandler">defaultErrorHandler</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#exportVocab">exportVocab</a></code></dt><dd class="description">The name of the export vocabulary...used to generate the output
token types interchange file.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#fileName">fileName</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/CodeGenerator.html" title="Class in antlr">CodeGenerator</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#generator">generator</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#hasSyntacticPredicate">hasSyntacticPredicate</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#hasUserErrorHandling">hasUserErrorHandling</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#importVocab">importVocab</a></code></dt><dd class="description">The name of the import vocabulary.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#interactive">interactive</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#maxk">maxk</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected Hashtable</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#options">options</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/Token.html" title="Class in antlr">Token</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#preambleAction">preambleAction</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/collections/impl/Vector.html" title="Class in antlr.collections.impl">Vector</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#rules">rules</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#superClass">superClass</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected Hashtable</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#symbols">symbols</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/LLkGrammarAnalyzer.html" title="Interface in antlr">LLkGrammarAnalyzer</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#theLLkAnalyzer">theLLkAnalyzer</a></code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected <a href="../antlr/TokenManager.html" title="Interface in antlr">TokenManager</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#tokenManager">tokenManager</a></code></dt><dd class="description">The token manager associated with the grammar, if any.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#traceRules">traceRules</a></code></dt></dl></td></tr></table></dd></dl><a name="summary-constructors" id="summary-constructors"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Constructor Summary</h2></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#Grammar(String,antlr.Tool,String)">Grammar</a>(String className_, <a href="../antlr/Tool.html" title="Class in antlr">Tool</a> tool_, String superClass)</code></dt></dl></td></tr></table></dd></dl><a name="summary-methods" id="summary-methods"/><dl class="table container"><dd><table class="class summary" border="1" width="100%"><tr class="table header"><td colspan="2"><h2 class="table header">Method Summary</h2></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#define(antlr.RuleSymbol)">define</a>(<a href="../antlr/RuleSymbol.html" title="Class in antlr">RuleSymbol</a> rs)</code></dt><dd class="description">Define a rule </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">abstract void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#generate()">generate</a>()</code></dt><dd class="description">Top-level call to generate the code for this grammar </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getClassName()">getClassName</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getDefaultErrorHandler()">getDefaultErrorHandler</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getFilename()">getFilename</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getIntegerOption(String)">getIntegerOption</a>(String key)</code></dt><dd class="description">Get an integer option.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/Token.html" title="Class in antlr">Token</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getOption(String)">getOption</a>(String key)</code></dt><dd class="description">Get an option.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">protected abstract String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getSuperClass()">getSuperClass</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> <a href="../antlr/GrammarSymbol.html" title="Class in antlr">GrammarSymbol</a></code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getSymbol(String)">getSymbol</a>(String s)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> Enumeration</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#getSymbols()">getSymbols</a>()</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#hasOption(String)">hasOption</a>(String key)</code></dt><dd class="description">Check the existence of an option in the table
</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#isDefined(String)">isDefined</a>(String s)</code></dt><dd class="description">Is a rule symbol defined? (not used for tokens) </dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">abstract void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#processArguments(String[])">processArguments</a>(String[] args)</code></dt><dd class="description">Process command line arguments.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setCodeGenerator(antlr.CodeGenerator)">setCodeGenerator</a>(<a href="../antlr/CodeGenerator.html" title="Class in antlr">CodeGenerator</a> gen)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setFilename(String)">setFilename</a>(String s)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setGrammarAnalyzer(antlr.LLkGrammarAnalyzer)">setGrammarAnalyzer</a>(<a href="../antlr/LLkGrammarAnalyzer.html" title="Interface in antlr">LLkGrammarAnalyzer</a> a)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setOption(String,antlr.Token)">setOption</a>(String key, <a href="../antlr/Token.html" title="Class in antlr">Token</a> value)</code></dt><dd class="description">Set a generic option.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> void</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#setTokenManager(antlr.TokenManager)">setTokenManager</a>(<a href="../antlr/TokenManager.html" title="Interface in antlr">TokenManager</a> tokenManager_)</code></dt></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis"> String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#toString()">toString</a>()</code></dt><dd class="description">Print out the grammar without actions </dd></dl></td></tr></table></dd></dl><a name="detail-fields" id="detail-fields"/><h2 class="section header">Field Details</h2><div class="section"><a name="analyzerDebug" id="analyzerDebug"/><div class="member detail outer"><h3 class="member detail name">analyzerDebug</h3><pre class="member detail synopsis">protected boolean analyzerDebug</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="antlrTool" id="antlrTool"/><div class="member detail outer"><h3 class="member detail name">antlrTool</h3><pre class="member detail synopsis">protected <a href="../antlr/Tool.html" title="Class in antlr">Tool</a> antlrTool</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="buildAST" id="buildAST"/><div class="member detail outer"><h3 class="member detail name">buildAST</h3><pre class="member detail synopsis">protected boolean buildAST</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="classMemberAction" id="classMemberAction"/><div class="member detail outer"><h3 class="member detail name">classMemberAction</h3><pre class="member detail synopsis">protected <a href="../antlr/Token.html" title="Class in antlr">Token</a> classMemberAction</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="className" id="className"/><div class="member detail outer"><h3 class="member detail name">className</h3><pre class="member detail synopsis">protected String className</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="comment" id="comment"/><div class="member detail outer"><h3 class="member detail name">comment</h3><pre class="member detail synopsis">protected String comment</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="debuggingOutput" id="debuggingOutput"/><div class="member detail outer"><h3 class="member detail name">debuggingOutput</h3><pre class="member detail synopsis">protected boolean debuggingOutput</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="defaultErrorHandler" id="defaultErrorHandler"/><div class="member detail outer"><h3 class="member detail name">defaultErrorHandler</h3><pre class="member detail synopsis">protected boolean defaultErrorHandler</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="exportVocab" id="exportVocab"/><div class="member detail outer"><h3 class="member detail name">exportVocab</h3><pre class="member detail synopsis">protected String exportVocab</pre><blockquote class="member detail name"><div class="member detail description">The name of the export vocabulary...used to generate the output
token types interchange file.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="fileName" id="fileName"/><div class="member detail outer"><h3 class="member detail name">fileName</h3><pre class="member detail synopsis">protected String fileName</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="generator" id="generator"/><div class="member detail outer"><h3 class="member detail name">generator</h3><pre class="member detail synopsis">protected <a href="../antlr/CodeGenerator.html" title="Class in antlr">CodeGenerator</a> generator</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="hasSyntacticPredicate" id="hasSyntacticPredicate"/><div class="member detail outer"><h3 class="member detail name">hasSyntacticPredicate</h3><pre class="member detail synopsis">protected boolean hasSyntacticPredicate</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="hasUserErrorHandling" id="hasUserErrorHandling"/><div class="member detail outer"><h3 class="member detail name">hasUserErrorHandling</h3><pre class="member detail synopsis">protected boolean hasUserErrorHandling</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="importVocab" id="importVocab"/><div class="member detail outer"><h3 class="member detail name">importVocab</h3><pre class="member detail synopsis">protected String importVocab</pre><blockquote class="member detail name"><div class="member detail description">The name of the import vocabulary. "Initial conditions"
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="interactive" id="interactive"/><div class="member detail outer"><h3 class="member detail name">interactive</h3><pre class="member detail synopsis">protected boolean interactive</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="maxk" id="maxk"/><div class="member detail outer"><h3 class="member detail name">maxk</h3><pre class="member detail synopsis">protected int maxk</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="options" id="options"/><div class="member detail outer"><h3 class="member detail name">options</h3><pre class="member detail synopsis">protected Hashtable options</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="preambleAction" id="preambleAction"/><div class="member detail outer"><h3 class="member detail name">preambleAction</h3><pre class="member detail synopsis">protected <a href="../antlr/Token.html" title="Class in antlr">Token</a> preambleAction</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="rules" id="rules"/><div class="member detail outer"><h3 class="member detail name">rules</h3><pre class="member detail synopsis">protected <a href="../antlr/collections/impl/Vector.html" title="Class in antlr.collections.impl">Vector</a> rules</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="superClass" id="superClass"/><div class="member detail outer"><h3 class="member detail name">superClass</h3><pre class="member detail synopsis">protected String superClass</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="symbols" id="symbols"/><div class="member detail outer"><h3 class="member detail name">symbols</h3><pre class="member detail synopsis">protected Hashtable symbols</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="theLLkAnalyzer" id="theLLkAnalyzer"/><div class="member detail outer"><h3 class="member detail name">theLLkAnalyzer</h3><pre class="member detail synopsis">protected <a href="../antlr/LLkGrammarAnalyzer.html" title="Interface in antlr">LLkGrammarAnalyzer</a> theLLkAnalyzer</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="tokenManager" id="tokenManager"/><div class="member detail outer"><h3 class="member detail name">tokenManager</h3><pre class="member detail synopsis">protected <a href="../antlr/TokenManager.html" title="Interface in antlr">TokenManager</a> tokenManager</pre><blockquote class="member detail name"><div class="member detail description">The token manager associated with the grammar, if any.
// The token manager is responsible for maintaining the set of valid tokens, and
// is conceptually shared between the lexer and parser. This may be either a
// LexerGrammar or a ImportVocabTokenManager.
</div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="traceRules" id="traceRules"/><div class="member detail outer"><h3 class="member detail name">traceRules</h3><pre class="member detail synopsis">protected boolean traceRules</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-constructors" id="detail-constructors"/><h2 class="section header">Constructor Details</h2><div class="section"><a name="Grammar(String,antlr.Tool,String)" id="Grammar(String,antlr.Tool,String)"/><div class="member detail outer"><h3 class="member detail name">Grammar</h3><pre class="member detail synopsis">public Grammar(String className_,
<a href="../antlr/Tool.html" title="Class in antlr">Tool</a> tool_,
String superClass)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="define(antlr.RuleSymbol)" id="define(antlr.RuleSymbol)"/><div class="member detail outer"><h3 class="member detail name">define</h3><pre class="member detail synopsis">public void define(<a href="../antlr/RuleSymbol.html" title="Class in antlr">RuleSymbol</a> rs)</pre><blockquote class="member detail name"><div class="member detail description">Define a rule </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="generate()" id="generate()"/><div class="member detail outer"><h3 class="member detail name">generate</h3><pre class="member detail synopsis">public abstract void generate()
throws IOException</pre><blockquote class="member detail name"><div class="member detail description">Top-level call to generate the code for this grammar </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getClassName()" id="getClassName()"/><div class="member detail outer"><h3 class="member detail name">getClassName</h3><pre class="member detail synopsis">protected String getClassName()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getDefaultErrorHandler()" id="getDefaultErrorHandler()"/><div class="member detail outer"><h3 class="member detail name">getDefaultErrorHandler</h3><pre class="member detail synopsis">public boolean getDefaultErrorHandler()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getFilename()" id="getFilename()"/><div class="member detail outer"><h3 class="member detail name">getFilename</h3><pre class="member detail synopsis">public String getFilename()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getIntegerOption(String)" id="getIntegerOption(String)"/><div class="member detail outer"><h3 class="member detail name">getIntegerOption</h3><pre class="member detail synopsis">public int getIntegerOption(String key)
throws NumberFormatException</pre><blockquote class="member detail name"><div class="member detail description">Get an integer option. Given the name of the option find its
associated integer value. If the associated value is not an integer or
is not in the table, then throw an exception of type NumberFormatException.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">key</code><span class="separator"> - </span><span class="description">The name of the option</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The value associated with the key.</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getOption(String)" id="getOption(String)"/><div class="member detail outer"><h3 class="member detail name">getOption</h3><pre class="member detail synopsis">public <a href="../antlr/Token.html" title="Class in antlr">Token</a> getOption(String key)</pre><blockquote class="member detail name"><div class="member detail description">Get an option. Given the name of the option find its associated value.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">key</code><span class="separator"> - </span><span class="description">The name of the option</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">The value associated with the key, or null if the key has not been set.</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getSuperClass()" id="getSuperClass()"/><div class="member detail outer"><h3 class="member detail name">getSuperClass</h3><pre class="member detail synopsis">protected abstract String getSuperClass()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getSymbol(String)" id="getSymbol(String)"/><div class="member detail outer"><h3 class="member detail name">getSymbol</h3><pre class="member detail synopsis">public <a href="../antlr/GrammarSymbol.html" title="Class in antlr">GrammarSymbol</a> getSymbol(String s)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="getSymbols()" id="getSymbols()"/><div class="member detail outer"><h3 class="member detail name">getSymbols</h3><pre class="member detail synopsis">public Enumeration getSymbols()</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="hasOption(String)" id="hasOption(String)"/><div class="member detail outer"><h3 class="member detail name">hasOption</h3><pre class="member detail synopsis">public boolean hasOption(String key)</pre><blockquote class="member detail name"><div class="member detail description">Check the existence of an option in the table
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">key</code><span class="separator"> - </span><span class="description">The name of the option</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">true if the option is in the table</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="isDefined(String)" id="isDefined(String)"/><div class="member detail outer"><h3 class="member detail name">isDefined</h3><pre class="member detail synopsis">public boolean isDefined(String s)</pre><blockquote class="member detail name"><div class="member detail description">Is a rule symbol defined? (not used for tokens) </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="processArguments(String[])" id="processArguments(String[])"/><div class="member detail outer"><h3 class="member detail name">processArguments</h3><pre class="member detail synopsis">public abstract void processArguments(String[] args)</pre><blockquote class="member detail name"><div class="member detail description">Process command line arguments. Implemented in subclasses </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setCodeGenerator(antlr.CodeGenerator)" id="setCodeGenerator(antlr.CodeGenerator)"/><div class="member detail outer"><h3 class="member detail name">setCodeGenerator</h3><pre class="member detail synopsis">public void setCodeGenerator(<a href="../antlr/CodeGenerator.html" title="Class in antlr">CodeGenerator</a> gen)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setFilename(String)" id="setFilename(String)"/><div class="member detail outer"><h3 class="member detail name">setFilename</h3><pre class="member detail synopsis">public void setFilename(String s)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setGrammarAnalyzer(antlr.LLkGrammarAnalyzer)" id="setGrammarAnalyzer(antlr.LLkGrammarAnalyzer)"/><div class="member detail outer"><h3 class="member detail name">setGrammarAnalyzer</h3><pre class="member detail synopsis">public void setGrammarAnalyzer(<a href="../antlr/LLkGrammarAnalyzer.html" title="Interface in antlr">LLkGrammarAnalyzer</a> a)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setOption(String,antlr.Token)" id="setOption(String,antlr.Token)"/><div class="member detail outer"><h3 class="member detail name">setOption</h3><pre class="member detail synopsis">public boolean setOption(String key,
<a href="../antlr/Token.html" title="Class in antlr">Token</a> value)</pre><blockquote class="member detail name"><div class="member detail description">Set a generic option.
This associates a generic option key with a Token value.
No validation is performed by this method, although users of the value
(code generation and/or analysis) may require certain formats.
The value is stored as a token so that the location of an error
can be reported.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">key</code><span class="separator"> - </span><span class="description">The name of the option.</span></dd><dd class="item"><code class="name">value</code><span class="separator"> - </span><span class="description">The value to associate with the key.</span></dd></dl></div><div class="member detail return list"><dl><dt class="member detail return header"><b>Returns:</b></dt><dd class="member detail return item">true if the option was a valid generic grammar option, false o/w</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="setTokenManager(antlr.TokenManager)" id="setTokenManager(antlr.TokenManager)"/><div class="member detail outer"><h3 class="member detail name">setTokenManager</h3><pre class="member detail synopsis">public void setTokenManager(<a href="../antlr/TokenManager.html" title="Interface in antlr">TokenManager</a> tokenManager_)</pre><blockquote class="member detail name"><div class="member detail description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div><hr/><a name="toString()" id="toString()"/><div class="member detail outer"><h3 class="member detail name">toString</h3><pre class="member detail synopsis">public String toString()</pre><blockquote class="member detail name"><div class="member detail description">Print out the grammar without actions </div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div></blockquote></div></div><p class="navbar bottom spacer"> </p><table class="navbar div bottom"><tr><td><div class="navbar div top"><span class="navbar item enabled"><a href="../overview-summary.html">Overview</a></span> <span class="navbar item enabled"><a href="package-summary.html">Package</a></span> <span class="navbar item active">Class</span> <span class="navbar item enabled"><a href="Grammar-uses.html">Use</a></span> <span class="navbar item enabled"><a href="tree.html">Tree</a></span> <span class="navbar item enabled"><a href="../alphaindex-1.html">Index</a></span> <span class="navbar item enabled"><a href="../deprecated.html">Deprecated</a></span> <span class="navbar item enabled"><a href="../about.html">About</a></span></div></td></tr></table></body></html>