<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>ANTLR3C: include/antlr3string.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">ANTLR3C
 <span id="projectnumber">3.3.1</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('antlr3string_8h.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#nested-classes">Data Structures</a> |
<a href="#typedef-members">Typedefs</a> </div>
<div class="headertitle">
<div class="title">antlr3string.h File Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Simple string interface allows indiscriminate allocation of strings such that they can be allocated all over the place and released in one chunk via a string factory - saves lots of hassle in remembering what strings were allocated where.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include <<a class="el" href="antlr3defs_8h.html">antlr3defs.h</a>></code><br/>
<code>#include <<a class="el" href="antlr3collections_8h.html">antlr3collections.h</a>></code><br/>
</div><div class="textblock"><div class="dynheader">
Include dependency graph for antlr3string.h:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3string_8h__incl.png" border="0" usemap="#include_2antlr3string_8h" alt=""/></div>
<map name="include_2antlr3string_8h" id="include_2antlr3string_8h">
<area shape="rect" id="node2" href="antlr3defs_8h.html" title="Basic type and constant definitions for ANTLR3 Runtime. " alt="" coords="1559,229,1701,256"/><area shape="rect" id="node25" href="antlr3collections_8h.html" title="antlr3collections.h" alt="" coords="1630,80,1841,107"/><area shape="rect" id="node3" href="antlr3errors_8h.html" title="antlr3errors.h" alt="" coords="5,304,168,331"/><area shape="rect" id="node23" href="antlr3interfaces_8h.html" title="Declarations for all the antlr3 C runtime interfaces/classes. " alt="" coords="2900,304,3103,331"/><area shape="rect" id="node24" href="antlr3convertutf_8h.html" title="antlr3convertutf.h" alt="" coords="3127,304,3329,331"/><area shape="rect" id="node26" href="antlr3bitset_8h.html" title="Defines the basic structures of an ANTLR3 bitset. " alt="" coords="1668,155,1831,181"/></map>
</div>
</div><div class="textblock"><div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dyncontent">
<div class="center"><img src="antlr3string_8h__dep__incl.png" border="0" usemap="#include_2antlr3string_8hdep" alt=""/></div>
<map name="include_2antlr3string_8hdep" id="include_2antlr3string_8hdep">
<area shape="rect" id="node2" href="antlr3string_8c.html" title="Implementation of the ANTLR3 string and string factory classes. " alt="" coords="505,80,708,107"/><area shape="rect" id="node3" href="antlr3_8h.html" title="include/antlr3.h" alt="" coords="1550,603,1732,629"/><area shape="rect" id="node9" href="antlr3basetree_8h.html" title="Definition of the ANTLR3 base tree. " alt="" coords="1501,80,1763,107"/><area shape="rect" id="node11" href="antlr3basetreeadaptor_8h.html" title="Definition of the ANTLR3 base tree adaptor. " alt="" coords="1685,229,2016,256"/><area shape="rect" id="node13" href="antlr3commontreeadaptor_8h.html" title="Definition of the ANTLR3 common tree adaptor. " alt="" coords="1100,304,1452,331"/><area shape="rect" id="node15" href="antlr3commontreenodestream_8h.html" title="Definition of the ANTLR3 common tree node stream. " alt="" coords="605,379,987,405"/><area shape="rect" id="node32" href="antlr3tokenstream_8h.html" title="Defines the interface for an ANTLR3 common token stream. " alt="" coords="1765,379,2056,405"/><area shape="rect" id="node35" href="antlr3input_8h.html" title="Defines the basic structures used to manipulate character streams from any input source. " alt="" coords="2148,304,2380,331"/><area shape="rect" id="node4" href="antlr3collections_8c.html" title="Provides a number of useful functions that are roughly equivalent to java HashTable and List for the ..." alt="" coords="953,677,1204,704"/><area shape="rect" id="node5" href="antlr3commontoken_8c.html" title="src/antlr3commontoken.c" alt="" coords="1229,677,1480,704"/><area shape="rect" id="node6" href="antlr3debughandlers_8c.html" title="Provides the debugging functions invoked by a recognizer built using the debug generator mode of the ..." alt="" coords="1505,677,1776,704"/><area shape="rect" id="node7" href="antlr3encodings_8c.html" title="src/antlr3encodings.c" alt="" coords="1801,677,2033,704"/><area shape="rect" id="node8" href="antlr3filestream_8c.html" title="The ANTLR3 C filestream is used when the source character stream is a filesystem based input set and ..." alt="" coords="2057,677,2300,704"/><area shape="rect" id="node10" href="antlr3basetree_8c.html" title="src/antlr3basetree.c" alt="" coords="1362,155,1584,181"/><area shape="rect" id="node29" href="antlr3commontree_8h.html" title="include/antlr3commontree.h" alt="" coords="783,229,1064,256"/><area shape="rect" id="node31" href="antlr3debugeventlistener_8h.html" title="The definition of all debugging events that a recognizer can trigger. " alt="" coords="1609,155,1972,181"/><area shape="rect" id="node34" href="antlr3parsetree_8h.html" title="Abstraction of Common tree to provide payload and string representation of node. " alt="" coords="1067,155,1337,181"/><area shape="rect" id="node12" href="antlr3basetreeadaptor_8c.html" title="Contains the base functions that all tree adaptors start with. " alt="" coords="1730,304,2021,331"/><area shape="rect" id="node14" href="antlr3commontreeadaptor_8c.html" title="This is the standard tree adaptor used by the C runtime unless the grammar source file says to use an..." alt="" coords="1120,379,1432,405"/><area shape="rect" id="node25" href="antlr3rewritestreams_8h.html" title="include/antlr3rewritestreams.h" alt="" coords="311,528,632,555"/><area shape="rect" id="node16" href="antlr3commontreenodestream_8c.html" title="Defines the implementation of the common node stream the default tree node stream used by ANTLR..." alt="" coords="625,453,967,480"/><area shape="rect" id="node17" href="antlr3baserecognizer_8h.html" title="Defines the basic structure to support recognizing by either a lexer, parser, or tree parser..." alt="" coords="1145,453,1467,480"/><area shape="rect" id="node27" href="antlr3treeparser_8h.html" title="include/antlr3treeparser.h" alt="" coords="4,528,285,555"/><area shape="rect" id="node18" href="antlr3baserecognizer_8c.html" title="Contains the base functions that all recognizers require. " alt="" coords="1220,528,1501,555"/><area shape="rect" id="node19" href="antlr3cyclicdfa_8h.html" title="include/antlr3cyclicdfa.h" alt="" coords="657,528,928,555"/><area shape="rect" id="node21" href="antlr3lexer_8h.html" title="Base interface for any ANTLR3 lexer. " alt="" coords="1780,528,2012,555"/><area shape="rect" id="node23" href="antlr3parser_8h.html" title="Base implementation of an ANTLR3 parser. " alt="" coords="953,528,1196,555"/><area shape="rect" id="node20" href="antlr3cyclicdfa_8c.html" title="src/antlr3cyclicdfa.c" alt="" coords="677,603,909,629"/><area shape="rect" id="node22" href="antlr3lexer_8c.html" title="Base implementation of an antlr 3 lexer. " alt="" coords="1800,603,1992,629"/><area shape="rect" id="node24" href="antlr3parser_8c.html" title="Implementation of the base functionality for an ANTLR3 parser. " alt="" coords="973,603,1176,629"/><area shape="rect" id="node26" href="antlr3rewritestreams_8c.html" title="Implementation of token/tree streams that are used by the tree re-write rules to manipulate the token..." alt="" coords="331,603,612,629"/><area shape="rect" id="node28" href="antlr3treeparser_8c.html" title="Implementation of the tree parser and overrides for the base recognizer. " alt="" coords="24,603,267,629"/><area shape="rect" id="node30" href="antlr3commontree_8c.html" title="src/antlr3commontree.c" alt="" coords="833,304,1076,331"/><area shape="rect" id="node33" href="antlr3tokenstream_8c.html" title="Default implementation of CommonTokenStream. " alt="" coords="1781,453,2032,480"/><area shape="rect" id="node36" href="antlr3inputstream_8c.html" title="Base functions to initialize and manipulate any input stream. " alt="" coords="2133,379,2384,405"/></map>
</div>
</div><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html">ANTLR3_STRING_FACTORY_struct</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes. <a href="struct_a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">ANTLR3_STRING_struct</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft"> </td><td class="mdescRight">Base string class tracks the allocations and provides simple string tracking functions. <a href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html#details">More...</a><br/></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:aa1e5fe84257d5bc8215f75def2b3b5b9"><td class="memItemLeft" align="right" valign="top">typedef struct <a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">ANTLR3_STRING_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3string_8h.html#aa1e5fe84257d5bc8215f75def2b3b5b9">ANTLR3_STRING</a></td></tr>
<tr class="memdesc:aa1e5fe84257d5bc8215f75def2b3b5b9"><td class="mdescLeft"> </td><td class="mdescRight">Base string class tracks the allocations and provides simple string tracking functions. <a href="#aa1e5fe84257d5bc8215f75def2b3b5b9">More...</a><br/></td></tr>
<tr class="separator:aa1e5fe84257d5bc8215f75def2b3b5b9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4f36a0b76f37ee9f544ac1511034131a"><td class="memItemLeft" align="right" valign="top">typedef struct <br class="typebreak"/>
<a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html">ANTLR3_STRING_FACTORY_struct</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="antlr3string_8h.html#a4f36a0b76f37ee9f544ac1511034131a">ANTLR3_STRING_FACTORY</a></td></tr>
<tr class="memdesc:a4f36a0b76f37ee9f544ac1511034131a"><td class="mdescLeft"> </td><td class="mdescRight">Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes. <a href="#a4f36a0b76f37ee9f544ac1511034131a">More...</a><br/></td></tr>
<tr class="separator:a4f36a0b76f37ee9f544ac1511034131a"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Simple string interface allows indiscriminate allocation of strings such that they can be allocated all over the place and released in one chunk via a string factory - saves lots of hassle in remembering what strings were allocated where. </p>
</div><h2 class="groupheader">Typedef Documentation</h2>
<a class="anchor" id="aa1e5fe84257d5bc8215f75def2b3b5b9"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g__struct.html">ANTLR3_STRING_struct</a>
<a class="el" href="antlr3string_8h.html#aa1e5fe84257d5bc8215f75def2b3b5b9">ANTLR3_STRING</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Base string class tracks the allocations and provides simple string tracking functions. </p>
<p>Mostly you can work directly on the string for things that don't reallocate it, like strchr() etc. Perhaps someone will want to provide implementations for UTF8 and so on. </p>
</div>
</div>
<a class="anchor" id="a4f36a0b76f37ee9f544ac1511034131a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct <a class="el" href="struct_a_n_t_l_r3___s_t_r_i_n_g___f_a_c_t_o_r_y__struct.html">ANTLR3_STRING_FACTORY_struct</a>
<a class="el" href="antlr3string_8h.html#a4f36a0b76f37ee9f544ac1511034131a">ANTLR3_STRING_FACTORY</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Definition of the string factory interface, which creates and tracks strings for you of various shapes and sizes. </p>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="antlr3string_8h.html">antlr3string.h</a></li>
<li class="footer">Generated on Tue Jan 7 2014 21:45:19 for ANTLR3C by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
</ul>
</div>
</body>
</html>
