/usr/share/doc/libucommon-dev/a00200.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 | <!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"/>
<title>UCommon: ucommon/persist.h File Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.3 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</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>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul>
</div>
</div>
<div class="contents">
<h1>ucommon/persist.h File Reference</h1>
<p>The GNU Common C++ persistance engine by Daniel Silverstone.
<a href="#_details">More...</a></p>
<code>#include <<a class="el" href="a00201_source.html">ucommon/platform.h</a>></code><br/>
<code>#include <iostream></code><br/>
<code>#include <string></code><br/>
<code>#include <vector></code><br/>
<code>#include <deque></code><br/>
<code>#include <map></code><br/>
<div class="dynheader">
Include dependency graph for persist.h:</div>
<div class="dynsection">
<div class="center"><img src="a00257.png" border="0" usemap="#ucommon_2persist_8h_map" alt=""/></div>
<map name="ucommon_2persist_8h_map" id="ucommon_2persist_8h">
<area shape="rect" id="node3" href="a00201.html" title="Various miscelanous platform specific headers and defines." alt="" coords="511,83,668,112"/></map>
</div>
<div class="dynheader">
This graph shows which files directly or indirectly include this file:</div>
<div class="dynsection">
<div class="center"><img src="a00258.png" border="0" usemap="#ucommon_2persist_8hdep_map" alt=""/></div>
<map name="ucommon_2persist_8hdep_map" id="ucommon_2persist_8hdep">
<area shape="rect" id="node3" href="a00210.html" title="Top level include file for the GNU uCommon C++ core library." alt="" coords="73,83,241,112"/><area shape="rect" id="node5" href="a00202.html" title="This library holds the ucommon scripting engine code." alt="" coords="5,160,144,189"/><area shape="rect" id="node7" href="a00203.html" title="This library holds basic crytographic functions and secure socket support for use..." alt="" coords="168,160,315,189"/></map>
</div>
<p><a href="a00200_source.html">Go to the source code of this file.</a></p>
<table border="0" cellpadding="0" cellspacing="0">
<tr><td colspan="2"><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00106.html">ucc::PersistEngine</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Stream serialization of persistent classes. <a href="a00106.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00107.html">ucc::PersistObject</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight"><a class="el" href="a00107.html" title="PersistObject.">PersistObject</a>. <a href="a00107.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00175.html">ucc::TypeManager</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Type manager for persistance engine. <a href="a00175.html#_details">More...</a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">class </td><td class="memItemRight" valign="bottom"><a class="el" href="a00176.html">ucc::TypeManager::registration</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This manages a registration to the typemanager - attempting to remove problems with the optimisers. <a href="a00176.html#_details">More...</a><br/></td></tr>
<tr><td colspan="2"><h2>Namespaces</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">namespace </td><td class="memItemRight" valign="bottom"><a class="el" href="a00214.html">ucc</a></td></tr>
<p><tr><td class="mdescLeft"> </td><td class="mdescRight"><p>Common namespace for all ucommon objects. </p>
<br/></td></tr>
</p>
<tr><td colspan="2"><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a7df6645fae18e96d06803c9e110b5f15"></a><!-- doxytag: member="persist.h::CCXX_ENGINEREAD_REF" ref="a7df6645fae18e96d06803c9e110b5f15" args="(valref)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_ENGINEREAD_REF</b>(valref) readBinary((uint8_t*)&valref,sizeof(valref))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2c0cd884a6ed71a178ef1569190c5e16"></a><!-- doxytag: member="persist.h::CCXX_ENGINEWRITE_REF" ref="a2c0cd884a6ed71a178ef1569190c5e16" args="(valref)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_ENGINEWRITE_REF</b>(valref) writeBinary((const uint8_t*)&valref,sizeof(valref))</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adec91652f546e9365041e28d1a254fa8"></a><!-- doxytag: member="persist.h::CCXX_RE" ref="adec91652f546e9365041e28d1a254fa8" args="(ar, ob)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_RE</b>(ar, ob) ar.read(ob); return ar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5adf584403ed6f629cf3dbf3b2974dd7"></a><!-- doxytag: member="persist.h::CCXX_WE" ref="a5adf584403ed6f629cf3dbf3b2974dd7" args="(ar, ob)" -->
#define </td><td class="memItemRight" valign="bottom"><b>CCXX_WE</b>(ar, ob) ar.write(ob); return ar</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>DECLARE_PERSISTENCE</b>(ClassType)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><b>IMPLEMENT_PERSISTENCE</b>(ClassType, FullyQualifiedName)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a007a79d2deffc2a4a09bcce1943a6ecb"></a><!-- doxytag: member="persist.h::NS_PREFIX" ref="a007a79d2deffc2a4a09bcce1943a6ecb" args="" -->
#define </td><td class="memItemRight" valign="bottom"><b>NS_PREFIX</b> ucc::</td></tr>
<tr><td colspan="2"><h2>Typedefs</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4d2f2ac61b07256ba62551124fbbcf56"></a><!-- doxytag: member="persist.h::NewPersistObjectFunction" ref="a4d2f2ac61b07256ba62551124fbbcf56" args=")(void)" -->
typedef class PersistObject *(* </td><td class="memItemRight" valign="bottom"><b>ucc::NewPersistObjectFunction</b> )(void)</td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>The GNU Common C++ persistance engine by Daniel Silverstone. </p>
<p>Definition in file <a class="el" href="a00200_source.html">persist.h</a>.</p>
<hr/><h2>Define Documentation</h2>
<a class="anchor" id="a0063bc0eb4e47f3fd4b0662d31656838"></a><!-- doxytag: member="persist.h::DECLARE_PERSISTENCE" ref="a0063bc0eb4e47f3fd4b0662d31656838" args="(ClassType)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define DECLARE_PERSISTENCE</td>
<td>(</td>
<td class="paramtype">ClassType </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment"><span class="keyword">public</span>: \
<span class="keyword">friend</span> NS_PREFIX PersistEngine& operator>>( NS_PREFIX PersistEngine& ar, ClassType *&ob); \
<span class="keyword">friend</span> NS_PREFIX PersistEngine& operator<<( NS_PREFIX PersistEngine& ar, ClassType <span class="keyword">const</span> &ob); \
<span class="keyword">friend</span> NS_PREFIX PersistObject *createNew##ClassType(); \
<span class="keyword">virtual</span> <span class="keyword">const</span> <span class="keywordtype">char</span>* getPersistenceID() <span class="keyword">const</span>; \
<span class="keyword">static</span> NS_PREFIX TypeManager::Registration registrationFor##ClassType;
</pre></div>
<p>Definition at line <a class="el" href="a00200_source.html#l00105">105</a> of file <a class="el" href="a00200_source.html">persist.h</a>.</p>
</div>
</div>
<a class="anchor" id="a518a5354fd7cb859b9534d7806cc883c"></a><!-- doxytag: member="persist.h::IMPLEMENT_PERSISTENCE" ref="a518a5354fd7cb859b9534d7806cc883c" args="(ClassType, FullyQualifiedName)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define IMPLEMENT_PERSISTENCE</td>
<td>(</td>
<td class="paramtype">ClassType, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">FullyQualifiedName </td>
<td class="paramname"></td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<b>Value:</b><div class="fragment"><pre class="fragment">NS_PREFIX PersistObject *createNew##ClassType() { <span class="keywordflow">return</span> <span class="keyword">new</span> ClassType; } \
<span class="keyword">const</span> <span class="keywordtype">char</span>* ClassType::getPersistenceID()<span class="keyword"> const </span>{<span class="keywordflow">return</span> FullyQualifiedName;} \
NS_PREFIX PersistEngine& operator>>(NS_PREFIX PersistEngine& ar, ClassType &ob) \
{ ar >> (NS_PREFIX PersistObject &) ob; <span class="keywordflow">return</span> ar; } \
NS_PREFIX PersistEngine& operator>>(NS_PREFIX PersistEngine& ar, ClassType *&ob) \
{ ar >> (NS_PREFIX PersistObject *&) ob; <span class="keywordflow">return</span> ar; } \
NS_PREFIX PersistEngine& operator<<(NS_PREFIX PersistEngine& ar, ClassType <span class="keyword">const</span> &ob) \
{ ar << (NS_PREFIX PersistObject <span class="keyword">const</span> *)&ob; <span class="keywordflow">return</span> ar; } \
NS_PREFIX TypeManager::Registration \
ClassType::registrationFor##ClassType(FullyQualifiedName, \
createNew##ClassType);
</pre></div>
<p>Definition at line <a class="el" href="a00200_source.html#l00113">113</a> of file <a class="el" href="a00200_source.html">persist.h</a>.</p>
</div>
</div>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:09 2010 for UCommon by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address>
</body>
</html>
|