|
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>CSharpCharFormatter (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.CSharpCharFormatter class"/><meta name="keywords" content="escapeChar()"/><meta name="keywords" content="escapeString()"/><meta name="keywords" content="literalChar()"/><meta name="keywords" content="literalString()"/><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="CSharpCharFormatter-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/CSharpBlockFinishingInfo.html">Prev Class</a> | <a href="../antlr/CSharpCodeGenerator.html">Next Class</a></td><td class="navi"><a href="../index.html" title="Show in a frameset" target="_top">Frames</a> | <a href="CSharpCharFormatter.html" title="Show without frames" target="_top">No Frames</a> </td></tr><tr><td class="navi">Summary: Nested | Field | <a href="#summary-methods">Method</a> | Constr</td><td class="navi">Detail: Nested | Field | <a href="#detail-methods">Method</a> | Constr</td></tr></table><div class="class title outer"><h3 class="class title-package">antlr</h3><h1 class="class title-class">Class CSharpCharFormatter</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.CSharpCharFormatter</code></li><li></li></ul></li></ul></div><dl class="class knownimplementing"><dt class="header"><b>Implemented Interfaces:</b></dt><dd class="item"><a href="../antlr/CharFormatter.html" title="Interface in antlr">CharFormatter</a></dd></dl><hr/><div class="class synopsis outer"><div class="class synopsis declaration"><code>(package private) class <b class="class synopsis name">CSharpCharFormatter</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 class="class synopsis implements"><code>implements <a href="../antlr/CharFormatter.html" title="Interface in antlr">CharFormatter</a></code></div></div><hr/><div class="class description"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><div class="taglet"></div><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"> String</code></td><td class="right"><dl class="list"><dt class="synopsis"><code><a href="#escapeChar(int,boolean)">escapeChar</a>(int c, boolean forCharLiteral)</code></dt><dd class="description">Given a character value, return a string representing the character
that can be embedded inside a string literal or character literal
This works for Java/C/C++ code-generation and languages with compatible
special-character-escapment.</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="#escapeString(String)">escapeString</a>(String s)</code></dt><dd class="description">Converts a String into a representation that can be use as a literal
when surrounded by double-quotes.</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="#literalChar(int)">literalChar</a>(int c)</code></dt><dd class="description">Given a character value, return a string representing the character
literal that can be recognized by the target language compiler.</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="#literalString(String)">literalString</a>(String s)</code></dt><dd class="description">Converts a String into a string literal
This works for languages that use double-quotes for string literals.</dd></dl></td></tr></table></dd></dl><a name="detail-methods" id="detail-methods"/><h2 class="section header">Method Details</h2><div class="section"><a name="escapeChar(int,boolean)" id="escapeChar(int,boolean)"/><div class="member detail outer"><h3 class="member detail name">escapeChar</h3><pre class="member detail synopsis">public String escapeChar(int c,
boolean forCharLiteral)</pre><blockquote class="member detail name"><div class="member detail description">Given a character value, return a string representing the character
that can be embedded inside a string literal or character literal
This works for Java/C/C++ code-generation and languages with compatible
special-character-escapment.
Code-generators for languages should override this method.
</div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../antlr/CharFormatter.html#escapeChar(int,boolean)">escapeChar</a> in interface <a href="../antlr/CharFormatter.html" title="Interface in antlr">CharFormatter</a></dd></dl><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">c</code><span class="separator"> - </span><span class="description">The character of interest.</span></dd><dd class="item"><code class="name">forCharLiteral</code><span class="separator"> - </span><span class="description">true to escape for char literal, false for string literal</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="escapeString(String)" id="escapeString(String)"/><div class="member detail outer"><h3 class="member detail name">escapeString</h3><pre class="member detail synopsis">public String escapeString(String s)</pre><blockquote class="member detail name"><div class="member detail description">Converts a String into a representation that can be use as a literal
when surrounded by double-quotes.
</div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../antlr/CharFormatter.html#escapeString(String)">escapeString</a> in interface <a href="../antlr/CharFormatter.html" title="Interface in antlr">CharFormatter</a></dd></dl><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">s</code><span class="separator"> - </span><span class="description">The String to be changed into a literal</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="literalChar(int)" id="literalChar(int)"/><div class="member detail outer"><h3 class="member detail name">literalChar</h3><pre class="member detail synopsis">public String literalChar(int c)</pre><blockquote class="member detail name"><div class="member detail description">Given a character value, return a string representing the character
literal that can be recognized by the target language compiler.
This works for languages that use single-quotes for character literals.
Code-generators for languages should override this method.
</div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../antlr/CharFormatter.html#literalChar(int)">literalChar</a> in interface <a href="../antlr/CharFormatter.html" title="Interface in antlr">CharFormatter</a></dd></dl><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">c</code><span class="separator"> - </span><span class="description">The character of interest.</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="literalString(String)" id="literalString(String)"/><div class="member detail outer"><h3 class="member detail name">literalString</h3><pre class="member detail synopsis">public String literalString(String s)</pre><blockquote class="member detail name"><div class="member detail description">Converts a String into a string literal
This works for languages that use double-quotes for string literals.
Code-generators for languages should override this method.
</div><dl class="member detail specified by list"><dt class="member detail specified by header"><b>Specified by:</b></dt><dd class="member detail specified by item"><a href="../antlr/CharFormatter.html#literalString(String)">literalString</a> in interface <a href="../antlr/CharFormatter.html" title="Interface in antlr">CharFormatter</a></dd></dl><div class="parameter"><dl><dt class="header"><b>Parameters:</b></dt><dd class="item"><code class="name">s</code><span class="separator"> - </span><span class="description">The String to be changed into a literal</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><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="CSharpCharFormatter-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>