diff options
Diffstat (limited to 'classrapidxml_1_1memory__pool.html')
| -rw-r--r-- | classrapidxml_1_1memory__pool.html | 811 |
1 files changed, 811 insertions, 0 deletions
diff --git a/classrapidxml_1_1memory__pool.html b/classrapidxml_1_1memory__pool.html new file mode 100644 index 00000000..748d0d7d --- /dev/null +++ b/classrapidxml_1_1memory__pool.html @@ -0,0 +1,811 @@ +<!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.13"/> +<meta name="viewport" content="width=device-width, initial-scale=1"/> +<title>YAGE: rapidxml::memory_pool< Ch > Class Template 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="navtreedata.js"></script> +<script type="text/javascript" src="navtree.js"></script> +<script type="text/javascript"> + $(document).ready(initResizable); +</script> +<link href="search/search.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="search/searchdata.js"></script> +<script type="text/javascript" src="search/search.js"></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 id="projectalign" style="padding-left: 0.5em;"> + <div id="projectname">YAGE +  <span id="projectnumber">v0.1.1</span> + </div> + <div id="projectbrief">Yet Another Game Engine</div> + </td> + </tr> + </tbody> +</table> +</div> +<!-- end header part --> +<!-- Generated by Doxygen 1.8.13 --> +<script type="text/javascript"> +var searchBox = new SearchBox("searchBox", "search",false,'Search'); +</script> +<script type="text/javascript" src="menudata.js"></script> +<script type="text/javascript" src="menu.js"></script> +<script type="text/javascript"> +$(function() { + initMenu('',true,false,'search.php','Search'); + $(document).ready(function() { init_search(); }); +}); +</script> +<div id="main-nav"></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('classrapidxml_1_1memory__pool.html','');}); +</script> +<div id="doc-content"> +<!-- window showing the filter options --> +<div id="MSearchSelectWindow" + onmouseover="return searchBox.OnSearchSelectShow()" + onmouseout="return searchBox.OnSearchSelectHide()" + onkeydown="return searchBox.OnSearchSelectKey(event)"> +</div> + +<!-- iframe showing the search results (closed by default) --> +<div id="MSearchResultsWindow"> +<iframe src="javascript:void(0)" frameborder="0" + name="MSearchResults" id="MSearchResults"> +</iframe> +</div> + +<div class="header"> + <div class="summary"> +<a href="#nested-classes">Classes</a> | +<a href="#pub-methods">Public Member Functions</a> | +<a href="#pri-methods">Private Member Functions</a> | +<a href="#pri-attribs">Private Attributes</a> | +<a href="classrapidxml_1_1memory__pool-members.html">List of all members</a> </div> + <div class="headertitle"> +<div class="title">rapidxml::memory_pool< Ch > Class Template Reference</div> </div> +</div><!--header--> +<div class="contents"> + +<p>This class is used by the parser to create new nodes and attributes, without overheads of dynamic memory allocation. In most cases, you will not need to use this class directly. However, if you need to create nodes manually or modify names/values of nodes, you are encouraged to use <a class="el" href="classrapidxml_1_1memory__pool.html" title="This class is used by the parser to create new nodes and attributes, without overheads of dynamic mem...">memory_pool</a> of relevant <a class="el" href="classrapidxml_1_1xml__document.html" title="This class represents root of the DOM hierarchy. It is also an xml_node and a memory_pool through pub...">xml_document</a> to allocate the memory. Not only is this faster than allocating them by using <code>new</code> operator, but also their lifetime will be tied to the lifetime of document, possibly simplyfing memory management. <br /> +<br /> + Call <a class="el" href="classrapidxml_1_1memory__pool.html#a4118581c29ee9a2f6b55ebf7dac185f8" title="Allocates a new node from the pool, and optionally assigns name and value to it. If the allocation re...">allocate_node()</a> or <a class="el" href="classrapidxml_1_1memory__pool.html#a3de2a66c983336e006ea3844e244ed30" title="Allocates a new attribute from the pool, and optionally assigns name and value to it...">allocate_attribute()</a> functions to obtain new nodes or attributes from the pool. You can also call <a class="el" href="classrapidxml_1_1memory__pool.html#a171941b39d55b868358da97462185f58" title="Allocates a char array of given size from the pool, and optionally copies a given string to it...">allocate_string()</a> function to allocate strings. Such strings can then be used as names or values of nodes without worrying about their lifetime. Note that there is no <code>free()</code> function – all allocations are freed at once when <a class="el" href="classrapidxml_1_1memory__pool.html#aad377c835fdaed1cb2cc9df194cf84e4" title="Clears the pool. This causes memory occupied by nodes allocated by the pool to be freed...">clear()</a> function is called, or when the pool is destroyed. <br /> +<br /> + It is also possible to create a standalone <a class="el" href="classrapidxml_1_1memory__pool.html" title="This class is used by the parser to create new nodes and attributes, without overheads of dynamic mem...">memory_pool</a>, and use it to allocate nodes, whose lifetime will not be tied to any document. <br /> +<br /> + Pool maintains <code>RAPIDXML_STATIC_POOL_SIZE</code> bytes of statically allocated memory. Until static memory is exhausted, no dynamic memory allocations are done. When static memory is exhausted, pool allocates additional blocks of memory of size <code>RAPIDXML_DYNAMIC_POOL_SIZE</code> each, by using global <code>new[]</code> and <code>delete[]</code> operators. This behaviour can be changed by setting custom allocation routines. Use <a class="el" href="classrapidxml_1_1memory__pool.html#a84d3d8d2cdfc00501e1dcf26d889ae03" title="Sets or resets the user-defined memory allocation functions for the pool. This can only be called whe...">set_allocator()</a> function to set them. <br /> +<br /> + Allocations for nodes, attributes and strings are aligned at <code>RAPIDXML_ALIGNMENT</code> bytes. This value defaults to the size of pointer on target architecture. <br /> +<br /> + To obtain absolutely top performance from the parser, it is important that all nodes are allocated from a single, contiguous block of memory. Otherwise, cache misses when jumping between two (or more) disjoint blocks of memory can slow down parsing quite considerably. If required, you can tweak <code>RAPIDXML_STATIC_POOL_SIZE</code>, <code>RAPIDXML_DYNAMIC_POOL_SIZE</code> and <code>RAPIDXML_ALIGNMENT</code> to obtain best wasted memory to performance compromise. To do it, define their values before rapidxml.hpp file is included. + <a href="classrapidxml_1_1memory__pool.html#details">More...</a></p> + +<p><code>#include <<a class="el" href="rapidxml_8h_source.html">rapidxml.h</a>></code></p> +<div class="dynheader"> +Inheritance diagram for rapidxml::memory_pool< Ch >:</div> +<div class="dyncontent"> + <div class="center"> + <img src="classrapidxml_1_1memory__pool.png" usemap="#rapidxml::memory_5Fpool_3C_20Ch_20_3E_map" alt=""/> + <map id="rapidxml::memory_5Fpool_3C_20Ch_20_3E_map" name="rapidxml::memory_5Fpool_3C_20Ch_20_3E_map"> +<area href="classrapidxml_1_1xml__document.html" title="This class represents root of the DOM hierarchy. It is also an xml_node and a memory_pool through pub..." alt="rapidxml::xml_document< Ch >" shape="rect" coords="0,56,184,80"/> +</map> + </div></div> +<table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a> +Classes</h2></td></tr> +<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structrapidxml_1_1memory__pool_1_1header.html">header</a></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="pub-methods"></a> +Public Member Functions</h2></td></tr> +<tr class="memitem:a0b609da81dff28a19ebd704400788429"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a0b609da81dff28a19ebd704400788429">memory_pool</a> ()</td></tr> +<tr class="memdesc:a0b609da81dff28a19ebd704400788429"><td class="mdescLeft"> </td><td class="mdescRight">Constructs empty pool with default allocator functions. <a href="#a0b609da81dff28a19ebd704400788429">More...</a><br /></td></tr> +<tr class="separator:a0b609da81dff28a19ebd704400788429"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0a3e82126e59e4077f41e933130bb5a0"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a0a3e82126e59e4077f41e933130bb5a0">~memory_pool</a> ()</td></tr> +<tr class="memdesc:a0a3e82126e59e4077f41e933130bb5a0"><td class="mdescLeft"> </td><td class="mdescRight">Destroys pool and frees all the memory. This causes memory occupied by nodes allocated by the pool to be freed. Nodes allocated from the pool are no longer valid. <a href="#a0a3e82126e59e4077f41e933130bb5a0">More...</a><br /></td></tr> +<tr class="separator:a0a3e82126e59e4077f41e933130bb5a0"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4118581c29ee9a2f6b55ebf7dac185f8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a>< Ch > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a4118581c29ee9a2f6b55ebf7dac185f8">allocate_node</a> (<a class="el" href="namespacerapidxml.html#abb456db38f7efb746c4330eed6072a7c">node_type</a> type, const Ch *name=0, const Ch *value=0, std::size_t name_size=0, std::size_t value_size=0)</td></tr> +<tr class="memdesc:a4118581c29ee9a2f6b55ebf7dac185f8"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new node from the pool, and optionally assigns name and value to it. If the allocation request cannot be accomodated, this function will throw <code>std::bad_alloc</code>. If exceptions are disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function. <a href="#a4118581c29ee9a2f6b55ebf7dac185f8">More...</a><br /></td></tr> +<tr class="separator:a4118581c29ee9a2f6b55ebf7dac185f8"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a3de2a66c983336e006ea3844e244ed30"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrapidxml_1_1xml__attribute.html">xml_attribute</a>< Ch > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a3de2a66c983336e006ea3844e244ed30">allocate_attribute</a> (const Ch *name=0, const Ch *value=0, std::size_t name_size=0, std::size_t value_size=0)</td></tr> +<tr class="memdesc:a3de2a66c983336e006ea3844e244ed30"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a new attribute from the pool, and optionally assigns name and value to it. If the allocation request cannot be accomodated, this function will throw <code>std::bad_alloc</code>. If exceptions are disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function. <a href="#a3de2a66c983336e006ea3844e244ed30">More...</a><br /></td></tr> +<tr class="separator:a3de2a66c983336e006ea3844e244ed30"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a171941b39d55b868358da97462185f58"><td class="memItemLeft" align="right" valign="top">Ch * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a171941b39d55b868358da97462185f58">allocate_string</a> (const Ch *source=0, std::size_t size=0)</td></tr> +<tr class="memdesc:a171941b39d55b868358da97462185f58"><td class="mdescLeft"> </td><td class="mdescRight">Allocates a char array of given size from the pool, and optionally copies a given string to it. If the allocation request cannot be accomodated, this function will throw <code>std::bad_alloc</code>. If exceptions are disabled by defining RAPIDXML_NO_EXCEPTIONS, this function will call rapidxml::parse_error_handler() function. <a href="#a171941b39d55b868358da97462185f58">More...</a><br /></td></tr> +<tr class="separator:a171941b39d55b868358da97462185f58"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a0a10679fc17597d339a0dc107f8a94ac"><td class="memItemLeft" align="right" valign="top"><a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a>< Ch > * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a0a10679fc17597d339a0dc107f8a94ac">clone_node</a> (const <a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a>< Ch > *source, <a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a>< Ch > *result=0)</td></tr> +<tr class="memdesc:a0a10679fc17597d339a0dc107f8a94ac"><td class="mdescLeft"> </td><td class="mdescRight">Clones an <a class="el" href="classrapidxml_1_1xml__node.html" title="Class representing a node of XML document. Each node may have associated name and value strings...">xml_node</a> and its hierarchy of child nodes and attributes. Nodes and attributes are allocated from this memory pool. Names and values are not cloned, they are shared between the clone and the source. Result node can be optionally specified as a second parameter, in which case its contents will be replaced with cloned source node. This is useful when you want to clone entire document. <a href="#a0a10679fc17597d339a0dc107f8a94ac">More...</a><br /></td></tr> +<tr class="separator:a0a10679fc17597d339a0dc107f8a94ac"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aad377c835fdaed1cb2cc9df194cf84e4"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#aad377c835fdaed1cb2cc9df194cf84e4">clear</a> ()</td></tr> +<tr class="memdesc:aad377c835fdaed1cb2cc9df194cf84e4"><td class="mdescLeft"> </td><td class="mdescRight">Clears the pool. This causes memory occupied by nodes allocated by the pool to be freed. Any nodes or strings allocated from the pool will no longer be valid. <a href="#aad377c835fdaed1cb2cc9df194cf84e4">More...</a><br /></td></tr> +<tr class="separator:aad377c835fdaed1cb2cc9df194cf84e4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a84d3d8d2cdfc00501e1dcf26d889ae03"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a84d3d8d2cdfc00501e1dcf26d889ae03">set_allocator</a> (alloc_func *af, free_func *ff)</td></tr> +<tr class="memdesc:a84d3d8d2cdfc00501e1dcf26d889ae03"><td class="mdescLeft"> </td><td class="mdescRight">Sets or resets the user-defined memory allocation functions for the pool. This can only be called when no memory is allocated from the pool yet, otherwise results are undefined. Allocation function must not return invalid pointer on failure. It should either throw, stop the program, or use <code>longjmp()</code> function to pass control to other place of program. If it returns invalid pointer, results are undefined. <br /> +<br /> + User defined allocation functions must have the following forms: <br /> +<code> <br /> +void *allocate(std::size_t size); <br /> +void free(void *pointer); </code><br /> + <a href="#a84d3d8d2cdfc00501e1dcf26d889ae03">More...</a><br /></td></tr> +<tr class="separator:a84d3d8d2cdfc00501e1dcf26d889ae03"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-methods"></a> +Private Member Functions</h2></td></tr> +<tr class="memitem:a1076043ef092e327e59dd988c1ba82fb"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a1076043ef092e327e59dd988c1ba82fb">init</a> ()</td></tr> +<tr class="separator:a1076043ef092e327e59dd988c1ba82fb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a317396afc1812f08b64a1dd9cde4039b"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a317396afc1812f08b64a1dd9cde4039b">align</a> (char *ptr)</td></tr> +<tr class="separator:a317396afc1812f08b64a1dd9cde4039b"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a1aed504a747303352e05f61c6ccbbebb"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a1aed504a747303352e05f61c6ccbbebb">allocate_raw</a> (std::size_t size)</td></tr> +<tr class="separator:a1aed504a747303352e05f61c6ccbbebb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4e9cf53fa5f9da3a8f31b754bd94b4ec"><td class="memItemLeft" align="right" valign="top">void * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a4e9cf53fa5f9da3a8f31b754bd94b4ec">allocate_aligned</a> (std::size_t size)</td></tr> +<tr class="separator:a4e9cf53fa5f9da3a8f31b754bd94b4ec"><td class="memSeparator" colspan="2"> </td></tr> +</table><table class="memberdecls"> +<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pri-attribs"></a> +Private Attributes</h2></td></tr> +<tr class="memitem:a775205c5faa60b63385c24368d26d4e1"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a775205c5faa60b63385c24368d26d4e1">m_begin</a></td></tr> +<tr class="separator:a775205c5faa60b63385c24368d26d4e1"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a4a89ff677c72afc163d1855cefc28013"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a4a89ff677c72afc163d1855cefc28013">m_ptr</a></td></tr> +<tr class="separator:a4a89ff677c72afc163d1855cefc28013"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:a6c9a83514446842518c9ffb7a38b76eb"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#a6c9a83514446842518c9ffb7a38b76eb">m_end</a></td></tr> +<tr class="separator:a6c9a83514446842518c9ffb7a38b76eb"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:aacc5ca734ebfbef7f42251764eb396f4"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#aacc5ca734ebfbef7f42251764eb396f4">m_static_memory</a> [<a class="el" href="rapidxml_8h.html#a001304844ab478e3b213749fc8d72ca2">RAPIDXML_STATIC_POOL_SIZE</a>]</td></tr> +<tr class="separator:aacc5ca734ebfbef7f42251764eb396f4"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:ae8964773675d24f77a808356be773c1d"><td class="memItemLeft" align="right" valign="top">alloc_func * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#ae8964773675d24f77a808356be773c1d">m_alloc_func</a></td></tr> +<tr class="separator:ae8964773675d24f77a808356be773c1d"><td class="memSeparator" colspan="2"> </td></tr> +<tr class="memitem:af8f41565f4de167eb2f40ca20695f24d"><td class="memItemLeft" align="right" valign="top">free_func * </td><td class="memItemRight" valign="bottom"><a class="el" href="classrapidxml_1_1memory__pool.html#af8f41565f4de167eb2f40ca20695f24d">m_free_func</a></td></tr> +<tr class="separator:af8f41565f4de167eb2f40ca20695f24d"><td class="memSeparator" colspan="2"> </td></tr> +</table> +<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2> +<div class="textblock"><h3>template<class Ch = char><br /> +class rapidxml::memory_pool< Ch ></h3> + +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">Ch</td><td>Character type of created nodes. </td></tr> + </table> + </dd> +</dl> +</div><h2 class="groupheader">Constructor & Destructor Documentation</h2> +<a id="a0b609da81dff28a19ebd704400788429"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0b609da81dff28a19ebd704400788429">◆ </a></span>memory_pool()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::<a class="el" href="classrapidxml_1_1memory__pool.html">memory_pool</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a0a3e82126e59e4077f41e933130bb5a0"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0a3e82126e59e4077f41e933130bb5a0">◆ </a></span>~memory_pool()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::~<a class="el" href="classrapidxml_1_1memory__pool.html">memory_pool</a> </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<h2 class="groupheader">Member Function Documentation</h2> +<a id="a317396afc1812f08b64a1dd9cde4039b"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a317396afc1812f08b64a1dd9cde4039b">◆ </a></span>align()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">char* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::align </td> + <td>(</td> + <td class="paramtype">char * </td> + <td class="paramname"><em>ptr</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a4e9cf53fa5f9da3a8f31b754bd94b4ec"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4e9cf53fa5f9da3a8f31b754bd94b4ec">◆ </a></span>allocate_aligned()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::allocate_aligned </td> + <td>(</td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>size</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a3de2a66c983336e006ea3844e244ed30"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a3de2a66c983336e006ea3844e244ed30">◆ </a></span>allocate_attribute()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classrapidxml_1_1xml__attribute.html">xml_attribute</a><Ch>* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::allocate_attribute </td> + <td>(</td> + <td class="paramtype">const Ch * </td> + <td class="paramname"><em>name</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const Ch * </td> + <td class="paramname"><em>value</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>name_size</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>value_size</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">name</td><td>Name to assign to the attribute, or 0 to assign no name. </td></tr> + <tr><td class="paramname">value</td><td>Value to assign to the attribute, or 0 to assign no value. </td></tr> + <tr><td class="paramname">name_size</td><td>Size of name to assign, or 0 to automatically calculate size from name string. </td></tr> + <tr><td class="paramname">value_size</td><td>Size of value to assign, or 0 to automatically calculate size from value string. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated attribute. This pointer will never be NULL. </dd></dl> + +</div> +</div> +<a id="a4118581c29ee9a2f6b55ebf7dac185f8"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4118581c29ee9a2f6b55ebf7dac185f8">◆ </a></span>allocate_node()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a><Ch>* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::allocate_node </td> + <td>(</td> + <td class="paramtype"><a class="el" href="namespacerapidxml.html#abb456db38f7efb746c4330eed6072a7c">node_type</a> </td> + <td class="paramname"><em>type</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const Ch * </td> + <td class="paramname"><em>name</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">const Ch * </td> + <td class="paramname"><em>value</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>name_size</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>value_size</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">type</td><td>Type of node to create. </td></tr> + <tr><td class="paramname">name</td><td>Name to assign to the node, or 0 to assign no name. </td></tr> + <tr><td class="paramname">value</td><td>Value to assign to the node, or 0 to assign no value. </td></tr> + <tr><td class="paramname">name_size</td><td>Size of name to assign, or 0 to automatically calculate size from name string. </td></tr> + <tr><td class="paramname">value_size</td><td>Size of value to assign, or 0 to automatically calculate size from value string. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated node. This pointer will never be NULL. </dd></dl> + +</div> +</div> +<a id="a1aed504a747303352e05f61c6ccbbebb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1aed504a747303352e05f61c6ccbbebb">◆ </a></span>allocate_raw()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">char* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::allocate_raw </td> + <td>(</td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>size</em></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a171941b39d55b868358da97462185f58"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a171941b39d55b868358da97462185f58">◆ </a></span>allocate_string()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">Ch* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::allocate_string </td> + <td>(</td> + <td class="paramtype">const Ch * </td> + <td class="paramname"><em>source</em> = <code>0</code>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">std::size_t </td> + <td class="paramname"><em>size</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">source</td><td>String to initialize the allocated memory with, or 0 to not initialize it. </td></tr> + <tr><td class="paramname">size</td><td>Number of characters to allocate, or zero to calculate it automatically from source string length; if size is 0, source string must be specified and null terminated. </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated char array. This pointer will never be NULL. </dd></dl> + +</div> +</div> +<a id="aad377c835fdaed1cb2cc9df194cf84e4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aad377c835fdaed1cb2cc9df194cf84e4">◆ </a></span>clear()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::clear </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a0a10679fc17597d339a0dc107f8a94ac"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a0a10679fc17597d339a0dc107f8a94ac">◆ </a></span>clone_node()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname"><a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a><Ch>* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::clone_node </td> + <td>(</td> + <td class="paramtype">const <a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a>< Ch > * </td> + <td class="paramname"><em>source</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype"><a class="el" href="classrapidxml_1_1xml__node.html">xml_node</a>< Ch > * </td> + <td class="paramname"><em>result</em> = <code>0</code> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">source</td><td>Node to clone. </td></tr> + <tr><td class="paramname">result</td><td>Node to put results in, or 0 to automatically allocate result node </td></tr> + </table> + </dd> +</dl> +<dl class="section return"><dt>Returns</dt><dd>Pointer to cloned node. This pointer will never be NULL. </dd></dl> + +</div> +</div> +<a id="a1076043ef092e327e59dd988c1ba82fb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a1076043ef092e327e59dd988c1ba82fb">◆ </a></span>init()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::init </td> + <td>(</td> + <td class="paramname"></td><td>)</td> + <td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a84d3d8d2cdfc00501e1dcf26d889ae03"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a84d3d8d2cdfc00501e1dcf26d889ae03">◆ </a></span>set_allocator()</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">void <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::set_allocator </td> + <td>(</td> + <td class="paramtype">alloc_func * </td> + <td class="paramname"><em>af</em>, </td> + </tr> + <tr> + <td class="paramkey"></td> + <td></td> + <td class="paramtype">free_func * </td> + <td class="paramname"><em>ff</em> </td> + </tr> + <tr> + <td></td> + <td>)</td> + <td></td><td></td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">inline</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> +<dl class="params"><dt>Parameters</dt><dd> + <table class="params"> + <tr><td class="paramname">af</td><td>Allocation function, or 0 to restore default function </td></tr> + <tr><td class="paramname">ff</td><td>Free function, or 0 to restore default function </td></tr> + </table> + </dd> +</dl> + +</div> +</div> +<h2 class="groupheader">Member Data Documentation</h2> +<a id="ae8964773675d24f77a808356be773c1d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#ae8964773675d24f77a808356be773c1d">◆ </a></span>m_alloc_func</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">alloc_func* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::m_alloc_func</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a775205c5faa60b63385c24368d26d4e1"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a775205c5faa60b63385c24368d26d4e1">◆ </a></span>m_begin</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">char* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::m_begin</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a6c9a83514446842518c9ffb7a38b76eb"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a6c9a83514446842518c9ffb7a38b76eb">◆ </a></span>m_end</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">char* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::m_end</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="af8f41565f4de167eb2f40ca20695f24d"></a> +<h2 class="memtitle"><span class="permalink"><a href="#af8f41565f4de167eb2f40ca20695f24d">◆ </a></span>m_free_func</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">free_func* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::m_free_func</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="a4a89ff677c72afc163d1855cefc28013"></a> +<h2 class="memtitle"><span class="permalink"><a href="#a4a89ff677c72afc163d1855cefc28013">◆ </a></span>m_ptr</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">char* <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::m_ptr</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<a id="aacc5ca734ebfbef7f42251764eb396f4"></a> +<h2 class="memtitle"><span class="permalink"><a href="#aacc5ca734ebfbef7f42251764eb396f4">◆ </a></span>m_static_memory</h2> + +<div class="memitem"> +<div class="memproto"> +<div class="memtemplate"> +template<class Ch = char> </div> +<table class="mlabels"> + <tr> + <td class="mlabels-left"> + <table class="memname"> + <tr> + <td class="memname">char <a class="el" href="classrapidxml_1_1memory__pool.html">rapidxml::memory_pool</a>< Ch >::m_static_memory[<a class="el" href="rapidxml_8h.html#a001304844ab478e3b213749fc8d72ca2">RAPIDXML_STATIC_POOL_SIZE</a>]</td> + </tr> + </table> + </td> + <td class="mlabels-right"> +<span class="mlabels"><span class="mlabel">private</span></span> </td> + </tr> +</table> +</div><div class="memdoc"> + +</div> +</div> +<hr/>The documentation for this class was generated from the following file:<ul> +<li>include/YAGE/<a class="el" href="rapidxml_8h_source.html">rapidxml.h</a></li> +</ul> +</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="namespacerapidxml.html">rapidxml</a></li><li class="navelem"><a class="el" href="classrapidxml_1_1memory__pool.html">memory_pool</a></li> + <li class="footer">Generated on Sun Sep 3 2017 12:13:49 for YAGE by + <a href="http://www.doxygen.org/index.html"> + <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.13 </li> + </ul> +</div> +</body> +</html> |