|
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/java_cup/java_cup/ |
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>symbol (java_cup API)</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="java_cup.symbol class"/><meta name="keywords" content="_name"/><meta name="keywords" content="_stack_type"/><meta name="keywords" content="_use_count"/><meta name="keywords" content="_index"/><meta name="keywords" content="name()"/><meta name="keywords" content="stack_type()"/><meta name="keywords" content="use_count()"/><meta name="keywords" content="note_use()"/><meta name="keywords" content="index()"/><meta name="keywords" content="is_non_term()"/><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="symbol-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.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="../java_cup/sym.html">Prev Class</a> | <a href="../java_cup/symbol_part.html">Next Class</a></td><td class="navi"><a href="../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="symbol.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">java_cup</h3><h1 class="class title-class">Class symbol</h1></div><div class="class inheritance-tree"><ul class="inheritance 0"><li class="inheritance 0"><code>java.lang.Object</code></li><li><ul class="inheritance 1"><li class="inheritance 1"><code>java_cup.symbol</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="../java_cup/non_terminal.html" title="Class in java_cup">non_terminal</a>, <a href="../java_cup/terminal.html" title="Class in java_cup">terminal</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">symbol</b></code></div><div class="class synopsis superclass"><code>extends java.lang.Object</code></div></div><hr/><div class="class description">This abstract class serves as the base class for grammar symbols (i.e.,
both terminals and non-terminals). Each symbol has a name string, and
a string giving the type of object that the symbol will be represented by
on the runtime parse stack. In addition, each symbol maintains a use count
in order to detect symbols that are declared but never used, and an index
number that indicates where it appears in parse tables (index numbers are
unique within terminals or non terminals, but not across both).
</div><div class="taglet"><dl class="tag list"></dl><dt class="tag section header"><b>Version:</b></dt><dd>last updated: 7/3/96</dd></dl></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>Author:</b></dt><dd class="tag item">Frank Flannery</dd></dl></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"><dl class="tag list"><dt class="tag section header"><b>See Also:</b></dt><dd><a href="../java_cup/terminal.html"><code>terminal</code></a>, <a href="../java_cup/non_terminal.html"><code>non_terminal</code></a></dd></dl></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 int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#_index">_index</a></code></dt><dd class="description">Index of this symbol (terminal or non terminal) in the parse tables.</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="#_name">_name</a></code></dt><dd class="description">String for the human readable name of the symbol.</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="#_stack_type">_stack_type</a></code></dt><dd class="description">String for the type of object used for the symbol on the parse stack.</dd></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="#_use_count">_use_count</a></code></dt><dd class="description">Count of how many times the symbol appears in productions.</dd></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="#symbol(String)">symbol</a>(String nm)</code></dt><dd class="description">Constructor with default type.</dd></dl></td></tr><tr><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#symbol(String,String)">symbol</a>(String nm, String tp)</code></dt><dd class="description">Full constructor.</dd></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"> int</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#index()">index</a>()</code></dt><dd class="description">Index of this symbol (terminal or non terminal) in the parse tables.</dd></dl></td></tr><tr><td class="left" valign="top"><code class="synopsis">abstract boolean</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#is_non_term()">is_non_term</a>()</code></dt><dd class="description">Indicate if this is a non-terminal.</dd></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="#name()">name</a>()</code></dt><dd class="description">String for the human readable name of the symbol.</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="#note_use()">note_use</a>()</code></dt><dd class="description">Increment the use count.</dd></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="#stack_type()">stack_type</a>()</code></dt><dd class="description">String for the type of object used for the symbol on the parse stack.</dd></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">Convert to a string.</dd></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="#use_count()">use_count</a>()</code></dt><dd class="description">Count of how many times the symbol appears in productions.</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="_index" id="_index"/><div class="member detail outer"><h3 class="member detail name">_index</h3><pre class="member detail synopsis">protected int _index</pre><blockquote class="member detail name"><div class="member detail description">Index of this symbol (terminal or non terminal) in the parse tables.
Note: indexes are unique among terminals and unique among non terminals,
however, a terminal may have the same index as a non-terminal, etc.
</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="_name" id="_name"/><div class="member detail outer"><h3 class="member detail name">_name</h3><pre class="member detail synopsis">protected String _name</pre><blockquote class="member detail name"><div class="member detail description">String for the human readable name of the symbol. </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="_stack_type" id="_stack_type"/><div class="member detail outer"><h3 class="member detail name">_stack_type</h3><pre class="member detail synopsis">protected String _stack_type</pre><blockquote class="member detail name"><div class="member detail description">String for the type of object used for the symbol on the parse stack. </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="_use_count" id="_use_count"/><div class="member detail outer"><h3 class="member detail name">_use_count</h3><pre class="member detail synopsis">protected int _use_count</pre><blockquote class="member detail name"><div class="member detail description">Count of how many times the symbol appears in productions. </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="symbol(String)" id="symbol(String)"/><div class="member detail outer"><h3 class="member detail name">symbol</h3><pre class="member detail synopsis">public symbol(String nm)</pre><blockquote class="member detail name"><div class="member detail description">Constructor with default type.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">nm</code><span class="separator"> - </span><span class="description">the name of the symbol.</span></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="symbol(String,String)" id="symbol(String,String)"/><div class="member detail outer"><h3 class="member detail name">symbol</h3><pre class="member detail synopsis">public symbol(String nm,
String tp)</pre><blockquote class="member detail name"><div class="member detail description">Full constructor.
</div><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">nm</code><span class="separator"> - </span><span class="description">the name of the symbol.</span></dd><dd class="item"><code class="name">tp</code><span class="separator"> - </span><span class="description">a string with the type name.</span></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></div><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="index()" id="index()"/><div class="member detail outer"><h3 class="member detail name">index</h3><pre class="member detail synopsis">public int index()</pre><blockquote class="member detail name"><div class="member detail description">Index of this symbol (terminal or non terminal) in the parse tables.
Note: indexes are unique among terminals and unique among non terminals,
however, a terminal may have the same index as a non-terminal, etc.
</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="is_non_term()" id="is_non_term()"/><div class="member detail outer"><h3 class="member detail name">is_non_term</h3><pre class="member detail synopsis">public abstract boolean is_non_term()</pre><blockquote class="member detail name"><div class="member detail description">Indicate if this is a non-terminal. Here in the base class we
don't know, so this is abstract.
</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="name()" id="name()"/><div class="member detail outer"><h3 class="member detail name">name</h3><pre class="member detail synopsis">public String name()</pre><blockquote class="member detail name"><div class="member detail description">String for the human readable name of the symbol. </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="note_use()" id="note_use()"/><div class="member detail outer"><h3 class="member detail name">note_use</h3><pre class="member detail synopsis">public void note_use()</pre><blockquote class="member detail name"><div class="member detail description">Increment the use count. </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="stack_type()" id="stack_type()"/><div class="member detail outer"><h3 class="member detail name">stack_type</h3><pre class="member detail synopsis">public String stack_type()</pre><blockquote class="member detail name"><div class="member detail description">String for the type of object used for the symbol on the parse stack. </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">Convert to a string. </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="use_count()" id="use_count()"/><div class="member detail outer"><h3 class="member detail name">use_count</h3><pre class="member detail synopsis">public int use_count()</pre><blockquote class="member detail name"><div class="member detail description">Count of how many times the symbol appears in productions. </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="symbol-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.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>