/usr/share/gtk-doc/html/dee-1.0/dee-1.0-DeeSerializable.html is in libdee-doc 1.0.10-3.
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 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>DeeSerializable</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
<link rel="home" href="index.html" title="Dee Reference Manual">
<link rel="up" href="ch04.html" title="Resources and Serialization">
<link rel="prev" href="dee-1.0-DeeResourceManager.html" title="DeeResourceManager">
<link rel="next" href="object-tree.html" title="Object Hierarchy">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="dee-1.0-DeeResourceManager.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch04.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">Dee Reference Manual</th>
<td><a accesskey="n" href="object-tree.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#dee-1.0-DeeSerializable.synopsis" class="shortcut">Top</a>
|
<a href="#dee-1.0-DeeSerializable.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="dee-1.0-DeeSerializable"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="dee-1.0-DeeSerializable.top_of_page"></a>DeeSerializable</span></h2>
<p>DeeSerializable — Interface for classes that can serialize to and from <span class="type">GVariant</span>s</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="dee-1.0-DeeSerializable.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">
#include <dee.h>
struct <a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableIface" title="struct DeeSerializableIface">DeeSerializableIface</a>;
<span class="returnvalue">GObject</span> * (<a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableParseFunc" title="DeeSerializableParseFunc ()">*DeeSerializableParseFunc</a>) (<em class="parameter"><code><span class="type">GVariant</span> *data</code></em>);
<span class="returnvalue">GVariant</span> * <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-externalize" title="dee_serializable_externalize ()">dee_serializable_externalize</a> (<em class="parameter"><code><span class="type">DeeSerializable</span> *self</code></em>);
<span class="returnvalue">GObject</span> * <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-parse" title="dee_serializable_parse ()">dee_serializable_parse</a> (<em class="parameter"><code><span class="type">GVariant</span> *data</code></em>,
<em class="parameter"><code><span class="type">GType</span> type</code></em>);
<span class="returnvalue">GObject</span> * <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-parse-external" title="dee_serializable_parse_external ()">dee_serializable_parse_external</a> (<em class="parameter"><code><span class="type">GVariant</span> *data</code></em>);
<span class="returnvalue">void</span> <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-register-parser" title="dee_serializable_register_parser ()">dee_serializable_register_parser</a> (<em class="parameter"><code><span class="type">GType</span> type</code></em>,
<em class="parameter"><code>const <span class="type">GVariantType</span> *vtype</code></em>,
<em class="parameter"><code><a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableParseFunc" title="DeeSerializableParseFunc ()"><span class="type">DeeSerializableParseFunc</span></a> parse_func</code></em>);
<span class="returnvalue">GVariant</span> * <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-serialize" title="dee_serializable_serialize ()">dee_serializable_serialize</a> (<em class="parameter"><code><span class="type">DeeSerializable</span> *self</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeSerializable.description"></a><h2>Description</h2>
<p>
Interface for classes that can serialize to and from <span class="type">GVariant</span>s.
</p>
<p>
There are two serialization concepts supported by this API:
<span class="emphasis"><em>serialization</em></span> and <span class="emphasis"><em>externalization</em></span>.
A serialized instance is created with <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-serialize" title="dee_serializable_serialize ()"><code class="function">dee_serializable_serialize()</code></a> and can
be read back with <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-parse" title="dee_serializable_parse ()"><code class="function">dee_serializable_parse()</code></a> provided you know the correct
<span class="type">GType</span> for the serialized data. The <span class="type">GVariant</span> representation of your
serialized data is guaranteed to be exactly as you implement yourself in the
<em class="parameter"><code>serialize</code></em> vfunc of the <a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableIface" title="struct DeeSerializableIface"><span class="type">DeeSerializableIface</span></a>.
</p>
<p>
With externalized instances you don't have to know the correct GType to
recreate the instance. The <span class="type">GType</span> is encoded in the data itself. When you're
using <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-externalize" title="dee_serializable_externalize ()"><code class="function">dee_serializable_externalize()</code></a> your data will be wrapped in a container
format with the required object metadata to read it back. For this reason
<a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-parse-external" title="dee_serializable_parse_external ()"><code class="function">dee_serializable_parse_external()</code></a> doesn't require you to pass in the <span class="type">GType</span>
you want to deserialize.
</p>
<p>
</p>
<div class="refsect2">
<a name="dee-1.0-DeeSerializable.on_subclasses"></a><h3>On Subclasses of DeeSerializable Types</h3>
<p>
As a rule of thumb you need to re-implement the <span class="type">DeeSerializable</span> interface
and install parse functions with <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-register-parser" title="dee_serializable_register_parser ()"><code class="function">dee_serializable_register_parser()</code></a> every
time you create a new class derived from a <span class="type">DeeSerializable</span> superclass.
</p>
<p>
In case a subclass does not provide it's own serialization interface
Dee will recurse upwards in the type hierarchy and use the serialization and
parser implementations of the first superclass with the required behaviour.
This means that the parsed instance will <span class="emphasis"><em>not</em></span> be an
instance of the subclass but only of the serializable superclass.
Caveat emptor.
</p>
</div>
<p>
</p>
</div>
<div class="refsect1">
<a name="dee-1.0-DeeSerializable.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="DeeSerializableIface"></a><h3>struct DeeSerializableIface</h3>
<pre class="programlisting">struct DeeSerializableIface {
GTypeInterface g_iface;
GVariant* (*serialize) (DeeSerializable *self);
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="DeeSerializableParseFunc"></a><h3>DeeSerializableParseFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> * (*DeeSerializableParseFunc) (<em class="parameter"><code><span class="type">GVariant</span> *data</code></em>);</pre>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>A <span class="type">GVariant</span> with type signature as passed to
<a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-register-parser" title="dee_serializable_register_parser ()"><code class="function">dee_serializable_register_parser()</code></a> when the parser was registered.
The variant is not referenced.</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly constructed <span class="type">GObject</span> of the <span class="type">GType</span>
used when registering the parser. Note that since
the environment guarantees that the input data is valid
according to the registration information this function
can not fail. Thus <code class="literal">NULL</code> is not a valid return value. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-serializable-externalize"></a><h3>dee_serializable_externalize ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> * dee_serializable_externalize (<em class="parameter"><code><span class="type">DeeSerializable</span> *self</code></em>);</pre>
<p>
Build an externalized form of <em class="parameter"><code>self</code></em> which can be used together with
<a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-parse-external" title="dee_serializable_parse_external ()"><code class="function">dee_serializable_parse_external()</code></a> to rebuild a copy of <em class="parameter"><code>self</code></em>.
</p>
<p>
It is important to note that the variant returned from this method does
not have the same type signature as returned from a call to
<a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-serialize" title="dee_serializable_serialize ()"><code class="function">dee_serializable_serialize()</code></a>. Externalization will wrap the serialized data
in a container format with versioning information and headers with type
information.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The instance to externalize</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A floating reference to a <span class="type">GVariant</span> with the externalized data.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-serializable-parse"></a><h3>dee_serializable_parse ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> * dee_serializable_parse (<em class="parameter"><code><span class="type">GVariant</span> *data</code></em>,
<em class="parameter"><code><span class="type">GType</span> type</code></em>);</pre>
<p>
Reconstruct a <span class="type">DeeSerializable</span> from <span class="type">GVariant</span> data. For this function
to work you need to register a parser with
<a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-register-parser" title="dee_serializable_register_parser ()"><code class="function">dee_serializable_register_parser()</code></a>. Any native Dee class will do so
automatically.
</p>
<p>
This method only works on data created with <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-serialize" title="dee_serializable_serialize ()"><code class="function">dee_serializable_serialize()</code></a>
and <span class="emphasis"><em>not</em></span> with data from <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-externalize" title="dee_serializable_externalize ()"><code class="function">dee_serializable_externalize()</code></a>.
</p>
<p>
Since a <a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableParseFunc" title="DeeSerializableParseFunc ()"><span class="type">DeeSerializableParseFunc</span></a> is not allowed to fail - by contract -
it can be guaranteed that this function only returns <code class="literal">NULL</code> in case there
is no known parser for <em class="parameter"><code>type</code></em> and <span class="type">GVariant</span> signature of <em class="parameter"><code>data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The <span class="type">GVariant</span> data to parse. If this is a floating reference it will
be consumed</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The <span class="type">GType</span> of the class to instantiate from <em class="parameter"><code>data</code></em>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly constructed <span class="type">GObject</span> build from <em class="parameter"><code>data</code></em>
or <code class="literal">NULL</code> in case no parser has been registered for the given
<span class="type">GType</span> or variant signature. Free with <code class="function">g_object_unref()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-serializable-parse-external"></a><h3>dee_serializable_parse_external ()</h3>
<pre class="programlisting"><span class="returnvalue">GObject</span> * dee_serializable_parse_external (<em class="parameter"><code><span class="type">GVariant</span> *data</code></em>);</pre>
<p>
Reconstruct a <span class="type">DeeSerializable</span> from <span class="type">GVariant</span> data. For this function
to work you need to register a parser with
<a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-register-parser" title="dee_serializable_register_parser ()"><code class="function">dee_serializable_register_parser()</code></a>. Any native Dee class will do so
automatically.
</p>
<p>
This method only works on data created with <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-externalize" title="dee_serializable_externalize ()"><code class="function">dee_serializable_externalize()</code></a>
and <span class="emphasis"><em>not</em></span> with data from <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-serialize" title="dee_serializable_serialize ()"><code class="function">dee_serializable_serialize()</code></a>.
</p>
<p>
Since a <a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableParseFunc" title="DeeSerializableParseFunc ()"><span class="type">DeeSerializableParseFunc</span></a> is not allowed to fail - by contract -
it can be guaranteed that this function only returns <code class="literal">NULL</code> in case there
is no known parser for the <span class="type">GType</span> or <span class="type">GVariant</span> signature of <em class="parameter"><code>data</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>The <span class="type">GVariant</span> data to parse</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A newly constructed <span class="type">GObject</span> build from <em class="parameter"><code>data</code></em>
or <code class="literal">NULL</code> in case no parser has been registered for the given
<span class="type">GType</span> or variant signature. Free with <code class="function">g_object_unref()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-serializable-register-parser"></a><h3>dee_serializable_register_parser ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> dee_serializable_register_parser (<em class="parameter"><code><span class="type">GType</span> type</code></em>,
<em class="parameter"><code>const <span class="type">GVariantType</span> *vtype</code></em>,
<em class="parameter"><code><a class="link" href="dee-1.0-DeeSerializable.html#DeeSerializableParseFunc" title="DeeSerializableParseFunc ()"><span class="type">DeeSerializableParseFunc</span></a> parse_func</code></em>);</pre>
<p>
Register a parser that can convert <span class="type">GVariant</span> data into an instance of
a given <span class="type">GType</span>. Note that you can register more than one parser for the
same <span class="type">GType</span> provided that you give them different variant type signatures.
</p>
<p>
If there is already a parser registered for the given <em class="parameter"><code>type</code></em> and <em class="parameter"><code>vtype</code></em>
it will be silently replaced.
</p>
<p>
The recommended behaviour is that <span class="type">GObject</span> classes register their parsers in
their respective class init functions.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>type</code></em> :</span></p></td>
<td>The <span class="type">GType</span> of the object class to register a parser for</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>vtype</code></em> :</span></p></td>
<td>Variants to be converted must have this signature</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>parse_func</code></em> :</span></p></td>
<td>A function to convert <span class="type">GVariant</span> data into an instance of the
given <em class="parameter"><code>type</code></em>.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="dee-serializable-serialize"></a><h3>dee_serializable_serialize ()</h3>
<pre class="programlisting"><span class="returnvalue">GVariant</span> * dee_serializable_serialize (<em class="parameter"><code><span class="type">DeeSerializable</span> *self</code></em>);</pre>
<p>
Build a clean serialized representation of <em class="parameter"><code>self</code></em>. The signature of the
returned variant is entirely determined by the underlying implementation.
You can recreate a serialized instance by calling <a class="link" href="dee-1.0-DeeSerializable.html#dee-serializable-parse" title="dee_serializable_parse ()"><code class="function">dee_serializable_parse()</code></a>
provided that you know the correct <span class="type">GType</span> for the serialized instance.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
<td>The instance to serialize</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>A reference to a <span class="type">GVariant</span> with
the serialized data. The variants type signature is entirely
dependent of the underlying implementation. Free using
<code class="function">g_variant_unref()</code>. <span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span>
</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.18</div>
</body>
</html>
|