Debian Codegraph @

doc/html/gsf-Compression.html

raw
1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2 <html>
3 <head>
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>Compression: GSF Reference Manual</title>
6 <meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
7 <link rel="home" href="index.html" title="GSF Reference Manual">
8 <link rel="up" href="parsers.html" title="Stream Parsers">
9 <link rel="prev" href="gsf-Zip.html" title="Zip files">
10 <link rel="next" href="gsf-MS-OLE2.html" title="MS OLE2">
11 <meta name="generator" content="GTK-Doc V1.34.0 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
13 </head>
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle">
16 <td width="100%" align="left" class="shortcuts">
17 <a href="#" class="shortcut">Top</a><span id="nav_description">  <span class="dim">|</span> 
18 <a href="#gsf-Compression.description" class="shortcut">Description</a></span><span id="nav_hierarchy">  <span class="dim">|</span> 
19 <a href="#gsf-Compression.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties">  <span class="dim">|</span> 
20 <a href="#gsf-Compression.properties" class="shortcut">Properties</a></span>
21 </td>
22 <td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
23 <td><a accesskey="u" href="parsers.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
24 <td><a accesskey="p" href="gsf-Zip.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
25 <td><a accesskey="n" href="gsf-MS-OLE2.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
26 </tr></table>
27 <div class="refentry">
28 <a name="gsf-Compression"></a><div class="titlepage"></div>
29 <div class="refnamediv"><table width="100%"><tr>
30 <td valign="top">
31 <h2><span class="refentrytitle"><a name="gsf-Compression.top_of_page"></a>Compression</span></h2>
32 <p>Compression</p>
33 </td>
34 <td class="gallery_image" valign="top" align="right"></td>
35 </tr></table></div>
36 <div class="refsect1">
37 <a name="gsf-Compression.functions"></a><h2>Functions</h2>
38 <div class="informaltable"><table class="informaltable" width="100%" border="0">
39 <colgroup>
40 <col width="150px" class="functions_proto_type">
41 <col class="functions_proto_name">
42 </colgroup>
43 <tbody>
44 <tr>
45 <td class="function_type">
46 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
47 </td>
48 <td class="function_name">
49 <a class="link" href="gsf-Compression.html#gsf-input-gzip-new" title="gsf_input_gzip_new ()">gsf_input_gzip_new</a> <span class="c_punctuation">()</span>
50 </td>
51 </tr>
52 <tr>
53 <td class="function_type">
54 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
55 </td>
56 <td class="function_name">
57 <a class="link" href="gsf-Compression.html#gsf-input-memory-new-from-bzip" title="gsf_input_memory_new_from_bzip ()">gsf_input_memory_new_from_bzip</a> <span class="c_punctuation">()</span>
58 </td>
59 </tr>
60 <tr>
61 <td class="function_type">
62 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
63 </td>
64 <td class="function_name">
65 <a class="link" href="gsf-Compression.html#gsf-output-gzip-new" title="gsf_output_gzip_new ()">gsf_output_gzip_new</a> <span class="c_punctuation">()</span>
66 </td>
67 </tr>
68 <tr>
69 <td class="function_type">
70 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
71 </td>
72 <td class="function_name">
73 <a class="link" href="gsf-Compression.html#gsf-output-bzip-new" title="gsf_output_bzip_new ()">gsf_output_bzip_new</a> <span class="c_punctuation">()</span>
74 </td>
75 </tr>
76 </tbody>
77 </table></div>
78 </div>
79 <div class="refsect1">
80 <a name="gsf-Compression.properties"></a><h2>Properties</h2>
81 <div class="informaltable"><table class="informaltable" border="0">
82 <colgroup>
83 <col width="150px" class="properties_type">
84 <col width="300px" class="properties_name">
85 <col width="200px" class="properties_flags">
86 </colgroup>
87 <tbody>
88 <tr>
89 <td class="property_type"><span class="type">gboolean</span></td>
90 <td class="property_name"><a class="link" href="gsf-Compression.html#GsfInputGZip--raw" title="The “raw” property">raw</a></td>
91 <td class="property_flags">Read / Write / Construct Only</td>
92 </tr>
93 <tr>
94 <td class="property_type">
95 <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *</td>
96 <td class="property_name"><a class="link" href="gsf-Compression.html#GsfInputGZip--source" title="The “source” property">source</a></td>
97 <td class="property_flags">Read / Write / Construct Only</td>
98 </tr>
99 <tr>
100 <td class="property_type"><span class="type">gint64</span></td>
101 <td class="property_name"><a class="link" href="gsf-Compression.html#GsfInputGZip--uncompressed-size" title="The “uncompressed-size” property">uncompressed-size</a></td>
102 <td class="property_flags">Read / Write / Construct Only</td>
103 </tr>
104 <tr>
105 <td class="property_type"><span class="type">int</span></td>
106 <td class="property_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip--deflate-level" title="The “deflate-level” property">deflate-level</a></td>
107 <td class="property_flags">Read / Write</td>
108 </tr>
109 <tr>
110 <td class="property_type"><span class="type">gboolean</span></td>
111 <td class="property_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip--raw" title="The “raw” property">raw</a></td>
112 <td class="property_flags">Read / Write / Construct Only</td>
113 </tr>
114 <tr>
115 <td class="property_type">
116 <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</td>
117 <td class="property_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip--sink" title="The “sink” property">sink</a></td>
118 <td class="property_flags">Read / Write / Construct Only</td>
119 </tr>
120 </tbody>
121 </table></div>
122 </div>
123 <a name="GsfInputGZip"></a><a name="GsfOutputGZip"></a><a name="GsfOutputBzip"></a><div class="refsect1">
124 <a name="gsf-Compression.other"></a><h2>Types and Values</h2>
125 <div class="informaltable"><table class="informaltable" width="100%" border="0">
126 <colgroup>
127 <col width="150px" class="other_proto_type">
128 <col class="other_proto_name">
129 </colgroup>
130 <tbody>
131 <tr>
132 <td class="datatype_keyword"> </td>
133 <td class="function_name"><a class="link" href="gsf-Compression.html#GsfInputGZip-struct" title="GsfInputGZip">GsfInputGZip</a></td>
134 </tr>
135 <tr>
136 <td class="datatype_keyword"> </td>
137 <td class="function_name"><a class="link" href="gsf-Compression.html#GsfOutputGZip-struct" title="GsfOutputGZip">GsfOutputGZip</a></td>
138 </tr>
139 <tr>
140 <td class="datatype_keyword"> </td>
141 <td class="function_name"><a class="link" href="gsf-Compression.html#GsfOutputBzip-struct" title="GsfOutputBzip">GsfOutputBzip</a></td>
142 </tr>
143 </tbody>
144 </table></div>
145 </div>
146 <div class="refsect1">
147 <a name="gsf-Compression.object-hierarchy"></a><h2>Object Hierarchy</h2>
148 <pre class="screen"> GObject
149 <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
150 <span class="lineart">│</span> <span class="lineart">╰──</span> GsfInputGZip
151 <span class="lineart">╰──</span> <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput">GsfOutput</a>
152 <span class="lineart">├──</span> GsfOutputBzip
153 <span class="lineart">╰──</span> GsfOutputGZip
154 </pre>
155 </div>
156 <div class="refsect1">
157 <a name="gsf-Compression.description"></a><h2>Description</h2>
158 </div>
159 <div class="refsect1">
160 <a name="gsf-Compression.functions_details"></a><h2>Functions</h2>
161 <div class="refsect2">
162 <a name="gsf-input-gzip-new"></a><h3>gsf_input_gzip_new ()</h3>
163 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
164 gsf_input_gzip_new (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
165 <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
166 <p>Adds a reference to <em class="parameter"><code>source</code></em>
167 .</p>
168 <div class="refsect3">
169 <a name="gsf-input-gzip-new.parameters"></a><h4>Parameters</h4>
170 <div class="informaltable"><table class="informaltable" width="100%" border="0">
171 <colgroup>
172 <col width="150px" class="parameters_name">
173 <col class="parameters_description">
174 <col width="200px" class="parameters_annotations">
175 </colgroup>
176 <tbody>
177 <tr>
178 <td class="parameter_name"><p>source</p></td>
179 <td class="parameter_description"><p>The underlying data source.</p></td>
180 <td class="parameter_annotations"> </td>
181 </tr>
182 <tr>
183 <td class="parameter_name"><p>err</p></td>
184 <td class="parameter_description"><p>place to store a <span class="type">GError</span> if anything goes wrong. </p></td>
185 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
186 </tr>
187 </tbody>
188 </table></div>
189 </div>
190 <div class="refsect3">
191 <a name="gsf-input-gzip-new.returns"></a><h4>Returns</h4>
192 <p> a new file or <code class="literal">NULL</code>.</p>
193 </div>
194 </div>
195 <hr>
196 <div class="refsect2">
197 <a name="gsf-input-memory-new-from-bzip"></a><h3>gsf_input_memory_new_from_bzip ()</h3>
198 <pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
199 gsf_input_memory_new_from_bzip (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
200 <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
201 <div class="refsect3">
202 <a name="gsf-input-memory-new-from-bzip.parameters"></a><h4>Parameters</h4>
203 <div class="informaltable"><table class="informaltable" width="100%" border="0">
204 <colgroup>
205 <col width="150px" class="parameters_name">
206 <col class="parameters_description">
207 <col width="200px" class="parameters_annotations">
208 </colgroup>
209 <tbody>
210 <tr>
211 <td class="parameter_name"><p>source</p></td>
212 <td class="parameter_description"><p>a <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
213 <td class="parameter_annotations"> </td>
214 </tr>
215 <tr>
216 <td class="parameter_name"><p>err</p></td>
217 <td class="parameter_description"><p>place to store a <span class="type">GError</span> if anything goes wrong. </p></td>
218 <td class="parameter_annotations"><span class="annotation">[<acronym title="NULL is OK, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span></td>
219 </tr>
220 </tbody>
221 </table></div>
222 </div>
223 <div class="refsect3">
224 <a name="gsf-input-memory-new-from-bzip.returns"></a><h4>Returns</h4>
225 <p> a new <a class="link" href="gsf-memory.html#GsfInputMemory"><span class="type">GsfInputMemory</span></a> or <code class="literal">NULL</code>.</p>
226 </div>
227 </div>
228 <hr>
229 <div class="refsect2">
230 <a name="gsf-output-gzip-new"></a><h3>gsf_output_gzip_new ()</h3>
231 <pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
232 gsf_output_gzip_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
233 <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
234 <p>Adds a reference to <em class="parameter"><code>sink</code></em>
235 .</p>
236 <div class="refsect3">
237 <a name="gsf-output-gzip-new.parameters"></a><h4>Parameters</h4>
238 <div class="informaltable"><table class="informaltable" width="100%" border="0">
239 <colgroup>
240 <col width="150px" class="parameters_name">
241 <col class="parameters_description">
242 <col width="200px" class="parameters_annotations">
243 </colgroup>
244 <tbody>
245 <tr>
246 <td class="parameter_name"><p>sink</p></td>
247 <td class="parameter_description"><p>The underlying data source.</p></td>
248 <td class="parameter_annotations"> </td>
249 </tr>
250 <tr>
251 <td class="parameter_name"><p>err</p></td>
252 <td class="parameter_description"><p>optionally <code class="literal">NULL</code>.</p></td>
253 <td class="parameter_annotations"> </td>
254 </tr>
255 </tbody>
256 </table></div>
257 </div>
258 <div class="refsect3">
259 <a name="gsf-output-gzip-new.returns"></a><h4>Returns</h4>
260 <p> a new file or <code class="literal">NULL</code>.</p>
261 </div>
262 </div>
263 <hr>
264 <div class="refsect2">
265 <a name="gsf-output-bzip-new"></a><h3>gsf_output_bzip_new ()</h3>
266 <pre class="programlisting"><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="returnvalue">GsfOutput</span></a> *
267 gsf_output_bzip_new (<em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *sink</code></em>,
268 <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
269 <p>Adds a reference to <em class="parameter"><code>sink</code></em>
270 .</p>
271 <div class="refsect3">
272 <a name="gsf-output-bzip-new.parameters"></a><h4>Parameters</h4>
273 <div class="informaltable"><table class="informaltable" width="100%" border="0">
274 <colgroup>
275 <col width="150px" class="parameters_name">
276 <col class="parameters_description">
277 <col width="200px" class="parameters_annotations">
278 </colgroup>
279 <tbody>
280 <tr>
281 <td class="parameter_name"><p>sink</p></td>
282 <td class="parameter_description"><p>The underlying data source.</p></td>
283 <td class="parameter_annotations"> </td>
284 </tr>
285 <tr>
286 <td class="parameter_name"><p>err</p></td>
287 <td class="parameter_description"><p>optionally <code class="literal">NULL</code>.</p></td>
288 <td class="parameter_annotations"> </td>
289 </tr>
290 </tbody>
291 </table></div>
292 </div>
293 <div class="refsect3">
294 <a name="gsf-output-bzip-new.returns"></a><h4>Returns</h4>
295 <p> a new file or <code class="literal">NULL</code>.</p>
296 </div>
297 </div>
298 </div>
299 <div class="refsect1">
300 <a name="gsf-Compression.other_details"></a><h2>Types and Values</h2>
301 <div class="refsect2">
302 <a name="GsfInputGZip-struct"></a><h3>GsfInputGZip</h3>
303 <pre class="programlisting">typedef struct _GsfInputGZip GsfInputGZip;</pre>
304 </div>
305 <hr>
306 <div class="refsect2">
307 <a name="GsfOutputGZip-struct"></a><h3>GsfOutputGZip</h3>
308 <pre class="programlisting">typedef struct _GsfOutputGZip GsfOutputGZip;</pre>
309 </div>
310 <hr>
311 <div class="refsect2">
312 <a name="GsfOutputBzip-struct"></a><h3>GsfOutputBzip</h3>
313 <pre class="programlisting">typedef struct _GsfOutputBzip GsfOutputBzip;</pre>
314 </div>
315 </div>
316 <div class="refsect1">
317 <a name="gsf-Compression.property-details"></a><h2>Property Details</h2>
318 <div class="refsect2">
319 <a name="GsfInputGZip--raw"></a><h3>The <code class="literal">“raw”</code> property</h3>
320 <pre class="programlisting"> “raw” <span class="type">gboolean</span></pre>
321 <p>Whether to read compressed data with no header and no trailer.</p>
322 <p>Owner: GsfInputGZip</p>
323 <p>Flags: Read / Write / Construct Only</p>
324 <p>Default value: FALSE</p>
325 </div>
326 <hr>
327 <div class="refsect2">
328 <a name="GsfInputGZip--source"></a><h3>The <code class="literal">“source”</code> property</h3>
329 <pre class="programlisting"> “source” <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *</pre>
330 <p>Where the compressed data comes from.</p>
331 <p>Owner: GsfInputGZip</p>
332 <p>Flags: Read / Write / Construct Only</p>
333 </div>
334 <hr>
335 <div class="refsect2">
336 <a name="GsfInputGZip--uncompressed-size"></a><h3>The <code class="literal">“uncompressed-size”</code> property</h3>
337 <pre class="programlisting"> “uncompressed-size” <span class="type">gint64</span></pre>
338 <p>The source's uncompressed size.</p>
339 <p>Owner: GsfInputGZip</p>
340 <p>Flags: Read / Write / Construct Only</p>
341 <p>Allowed values: &gt;= -1</p>
342 <p>Default value: -1</p>
343 </div>
344 <hr>
345 <div class="refsect2">
346 <a name="GsfOutputGZip--deflate-level"></a><h3>The <code class="literal">“deflate-level”</code> property</h3>
347 <pre class="programlisting"> “deflate-level” <span class="type">int</span></pre>
348 <p>The level of deflate compression used, zero meaning none and -1 meaning the zlib default.</p>
349 <p>Owner: GsfOutputGZip</p>
350 <p>Flags: Read / Write</p>
351 <p>Allowed values: [-1,9]</p>
352 <p>Default value: -1</p>
353 </div>
354 <hr>
355 <div class="refsect2">
356 <a name="GsfOutputGZip--raw"></a><h3>The <code class="literal">“raw”</code> property</h3>
357 <pre class="programlisting"> “raw” <span class="type">gboolean</span></pre>
358 <p>Whether to write compressed data with no header/tailer.</p>
359 <p>Owner: GsfOutputGZip</p>
360 <p>Flags: Read / Write / Construct Only</p>
361 <p>Default value: FALSE</p>
362 </div>
363 <hr>
364 <div class="refsect2">
365 <a name="GsfOutputGZip--sink"></a><h3>The <code class="literal">“sink”</code> property</h3>
366 <pre class="programlisting"> “sink” <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *</pre>
367 <p>Where the compressed data is written.</p>
368 <p>Owner: GsfOutputGZip</p>
369 <p>Flags: Read / Write / Construct Only</p>
370 </div>
371 </div>
372 </div>
373 <div class="footer">
374 <hr>Generated by GTK-Doc V1.34.0</div>
375 </body>
376 </html>