RubyGems - gsf - Versions diffs - 3.0.9-x64-mingw32 - Mend

gsf 3.0.9-x64-mingw32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (166) hide show

data/vendor/local/share/gtk-doc/html/gsf/gsf-Input-from-unstructured-files.html ADDED Viewed

@@ -0,0 +1,887 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+<head>
+<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<title>GSF Reference Manual: Input from unstructured files</title>
+<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
+<link rel="home" href="index.html" title="GSF Reference Manual">
+<link rel="up" href="io.html" title="Basic Input/Output">
+<link rel="prev" href="io.html" title="Basic Input/Output">
+<link rel="next" href="gsf-Output-to-unstructured-files.html" title="Output to unstructured files">
+<meta name="generator" content="GTK-Doc V1.20 (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="10"><tr valign="middle">
+<td width="100%" align="left" class="shortcuts">
+<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span>
+                  <a href="#gsf-Input-from-unstructured-files.description" class="shortcut">Description</a></span><span id="nav_hierarchy"> <span class="dim">|</span>
+                  <a href="#gsf-Input-from-unstructured-files.object-hierarchy" class="shortcut">Object Hierarchy</a></span><span id="nav_properties"> <span class="dim">|</span>
+                  <a href="#gsf-Input-from-unstructured-files.properties" class="shortcut">Properties</a></span>
+</td>
+<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td>
+<td><a accesskey="u" href="io.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td>
+<td><a accesskey="p" href="io.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td>
+<td><a accesskey="n" href="gsf-Output-to-unstructured-files.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td>
+</tr></table>
+<div class="refentry">
+<a name="gsf-Input-from-unstructured-files"></a><div class="titlepage"></div>
+<div class="refnamediv"><table width="100%"><tr>
+<td valign="top">
+<h2><span class="refentrytitle"><a name="gsf-Input-from-unstructured-files.top_of_page"></a>Input from unstructured files</span></h2>
+<p>Input from unstructured files</p>
+</td>
+<td class="gallery_image" valign="top" align="right"></td>
+</tr></table></div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.functions"></a><h2>Functions</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="functions_return">
+<col class="functions_name">
+</colgroup>
+<tbody>
+<tr>
+<td class="function_type">
+<span class="returnvalue">guint8</span> const *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-read" title="gsf_input_read ()">gsf_input_read</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-tell" title="gsf_input_tell ()">gsf_input_tell</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-seek" title="gsf_input_seek ()">gsf_input_seek</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-container" title="gsf_input_container ()">gsf_input_container</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-dup" title="gsf_input_dup ()">gsf_input_dup</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-size" title="gsf_input_size ()">gsf_input_size</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-eof" title="gsf_input_eof ()">gsf_input_eof</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-remaining" title="gsf_input_remaining ()">gsf_input_remaining</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GQuark</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-error-id" title="gsf_input_error_id ()">gsf_input_error_id</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-sibling" title="gsf_input_sibling ()">gsf_input_sibling</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">GQuark</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-error" title="gsf_input_error ()">gsf_input_error</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">char</span> const   *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-name" title="gsf_input_name ()">gsf_input_name</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-set-name-from-filename" title="gsf_input_set_name_from_filename ()">gsf_input_set_name_from_filename</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-proxy-new" title="gsf_input_proxy_new ()">gsf_input_proxy_new</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-proxy-new-section" title="gsf_input_proxy_new_section ()">gsf_input_proxy_new_section</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<span class="returnvalue">gboolean</span>
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-copy" title="gsf_input_copy ()">gsf_input_copy</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+<tr>
+<td class="function_type">
+<a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+</td>
+<td class="function_name">
+<a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-uncompress" title="gsf_input_uncompress ()">gsf_input_uncompress</a> <span class="c_punctuation">()</span>
+</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.properties"></a><h2>Properties</h2>
+<div class="informaltable"><table border="0">
+<colgroup>
+<col width="150px" class="properties_type">
+<col width="300px" class="properties_name">
+<col width="200px" class="properties_flags">
+</colgroup>
+<tbody>
+<tr>
+<td class="property_type">
+<a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *</td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--container" title="The “container” property">container</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gboolean</span></td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--eof" title="The “eof” property">eof</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type">
+<span class="type">GDateTime</span> *</td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--modtime" title="The “modtime” property">modtime</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type">
+<span class="type">gchar</span> *</td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--name" title="The “name” property">name</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gint64</span></td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--position" title="The “position” property">position</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gint64</span></td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--remaining" title="The “remaining” property">remaining</a></td>
+<td class="property_flags">Read</td>
+</tr>
+<tr>
+<td class="property_type"><span class="type">gint64</span></td>
+<td class="property_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput--size" title="The “size” property">size</a></td>
+<td class="property_flags">Read</td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<a name="GsfInput"></a><a name="GsfInputProxy"></a><div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.other"></a><h2>Types and Values</h2>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="name">
+<col class="description">
+</colgroup>
+<tbody>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput-struct" title="GsfInput">GsfInput</a></td>
+</tr>
+<tr>
+<td class="datatype_keyword"> </td>
+<td class="function_name"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInputProxy-struct" title="GsfInputProxy">GsfInputProxy</a></td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.object-hierarchy"></a><h2>Object Hierarchy</h2>
+<pre class="screen">    GObject
+    <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput">GsfInput</a>
+    <span class="lineart">│</span>   <span class="lineart">╰──</span> GsfInputProxy
+    <span class="lineart">╰──</span> GsfInput
+        <span class="lineart">├──</span> <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile">GsfInfile</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Compression.html#GsfInputGZip">GsfInputGZip</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-memory.html#GsfInputMemory">GsfInputMemory</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInputProxy">GsfInputProxy</a>
+        <span class="lineart">├──</span> <a class="link" href="gsf-Reading-and-Writing-from-local-files-and-directories.html#GsfInputStdio">GsfInputStdio</a>
+        <span class="lineart">╰──</span> <a class="link" href="gsf-Text.html#GsfInputTextline">GsfInputTextline</a>
+</pre>
+</div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.description"></a><h2>Description</h2>
+<p>
+</p>
+</div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.functions_details"></a><h2>Functions</h2>
+<div class="refsect2">
+<a name="gsf-input-read"></a><h3>gsf_input_read ()</h3>
+<pre class="programlisting"><span class="returnvalue">guint8</span> const *
+gsf_input_read (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
+                <em class="parameter"><code><span class="type">size_t</span> num_bytes</code></em>,
+                <em class="parameter"><code><span class="type">guint8</span> *optional_buffer</code></em>);</pre>
+<p>Read at least <em class="parameter"><code>num_bytes</code></em>
+.  Does not change the current position if there
+is an error.  Will only read if the entire amount can be read.  Invalidates
+the buffer associated with previous calls to gsf_input_read.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.2.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>num_bytes</p></td>
+<td class="parameter_description"><p>number of bytes to read</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>optional_buffer</p></td>
+<td class="parameter_description"><p>Pointer to destination memory area</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.2.6"></a><h4>Returns</h4>
+<p> pointer to the buffer or <code class="literal">NULL</code> if there is an error or 0
+bytes are requested.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-tell"></a><h3>gsf_input_tell ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+gsf_input_tell (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.3.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.3.5"></a><h4>Returns</h4>
+<p> the current offset in the file.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-seek"></a><h3>gsf_input_seek ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_input_seek (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
+                <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> offset</code></em>,
+                <em class="parameter"><code><span class="type">GSeekType</span> whence</code></em>);</pre>
+<p>Move the current location in the input stream.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.4.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>offset</p></td>
+<td class="parameter_description"><p>target offset</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>whence</p></td>
+<td class="parameter_description"><p>determines whether the offset is relative to the beginning or
+the end of the stream, or to the current location.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.4.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> on error.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-container"></a><h3>gsf_input_container ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="returnvalue">GsfInfile</span></a> *
+gsf_input_container (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.5.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.5.5"></a><h4>Returns</h4>
+<p> <em class="parameter"><code>input</code></em>
+'s container, potentially <code class="literal">NULL</code>. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-dup"></a><h3>gsf_input_dup ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_dup (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
+               <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<p>Duplicates input <em class="parameter"><code>src</code></em>
+ leaving the new one at the same offset.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.6.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>The input to duplicate</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p> place to store a <span class="type">GError</span> if anything goes wrong. </p></td>
+<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>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.6.6"></a><h4>Returns</h4>
+<p> the duplicate, or <code class="literal">NULL</code> on error. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-size"></a><h3>gsf_input_size ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+gsf_input_size (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.7.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>The input</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.7.5"></a><h4>Returns</h4>
+<p> the total number of bytes in the input or -1 on error</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-eof"></a><h3>gsf_input_eof ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_input_eof (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
+<p>Are we at the end of the file?</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.8.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.8.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the input is at the eof.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-remaining"></a><h3>gsf_input_remaining ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="returnvalue">gsf_off_t</span></a>
+gsf_input_remaining (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.9.4"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.9.5"></a><h4>Returns</h4>
+<p> the number of bytes left in the file.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-error-id"></a><h3>gsf_input_error_id ()</h3>
+<pre class="programlisting"><span class="returnvalue">GQuark</span>
+gsf_input_error_id (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.10.4"></a><h4>Returns</h4>
+<p> A utility quark to flag a <span class="type">GError</span> as being an input problem.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-sibling"></a><h3>gsf_input_sibling ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_sibling (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> const *input</code></em>,
+                   <em class="parameter"><code><span class="type">char</span> const *name</code></em>,
+                   <em class="parameter"><code><span class="type">GError</span> **err</code></em>);</pre>
+<p>UNIMPLEMENTED BY ANY BACKEND
+	and it is probably unnecessary.   gsf_input_get_container provides
+	enough power to do what is necessary.</p>
+<p>Attempts to open a 'sibling' of <em class="parameter"><code>input</code></em>
+.  The caller is responsible for
+managing the resulting object.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.11.6"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>The input</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>name</p></td>
+<td class="parameter_description"><p>name.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>err</p></td>
+<td class="parameter_description"><p> place to store a <span class="type">GError</span> if anything goes wrong. </p></td>
+<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>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.11.7"></a><h4>Returns</h4>
+<p> A related <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> or <code class="literal">NULL</code> on failure. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-error"></a><h3>gsf_input_error ()</h3>
+<pre class="programlisting"><span class="returnvalue">GQuark</span>
+gsf_input_error (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
+<div class="warning"><p><code class="literal">gsf_input_error</code> is deprecated and should not be used in newly-written code.</p></div>
+<p>Deprecated as of GSF 1.12.0; use <a class="link" href="gsf-Input-from-unstructured-files.html#gsf-input-error-id" title="gsf_input_error_id ()"><code class="function">gsf_input_error_id()</code></a> instead.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.12.6"></a><h4>Returns</h4>
+<p> A utility quark to flag a <span class="type">GError</span> as being an input problem.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-name"></a><h3>gsf_input_name ()</h3>
+<pre class="programlisting"><span class="returnvalue">char</span> const   *
+gsf_input_name (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>);</pre>
+<p>The name of the input stream.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.13.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.13.6"></a><h4>Returns</h4>
+<p> <em class="parameter"><code>input</code></em>
+'s name in utf8 form, or <code class="literal">NULL</code> if it
+has no name. </p>
+<p><span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-set-name-from-filename"></a><h3>gsf_input_set_name_from_filename ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_input_set_name_from_filename (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
+                                  <em class="parameter"><code><span class="type">char</span> const *filename</code></em>);</pre>
+<p>protected.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.14.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>the input stream</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>filename</p></td>
+<td class="parameter_description"><p>the (fs-sys encoded) filename</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.14.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> if the assignment was ok.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-proxy-new"></a><h3>gsf_input_proxy_new ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_proxy_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>);</pre>
+<p>This creates a new proxy to the entire, given input source.  See
+gsf_input_proxy_new_section for details.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.15.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>source</p></td>
+<td class="parameter_description"><p>The underlying data source.</p></td>
+<td class="parameter_annotations"> </td>
+</tr></tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.15.6"></a><h4>Returns</h4>
+<p> a new input object.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-proxy-new-section"></a><h3>gsf_input_proxy_new_section ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_proxy_new_section (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *source</code></em>,
+                             <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> offset</code></em>,
+                             <em class="parameter"><code><a class="link" href="gsf-utils.html#gsf-off-t" title="gsf_off_t"><span class="type">gsf_off_t</span></a> size</code></em>);</pre>
+<p>This creates a new proxy to a section of the given source.  The new
+object will have its own current position, but any operation on it
+can change the source's position.</p>
+<p>If a proxy to a proxy is created, the intermediate proxy is short-
+circuited.</p>
+<p>This function will ref the source.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.16.7"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>source</p></td>
+<td class="parameter_description"><p>The underlying data source.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>offset</p></td>
+<td class="parameter_description"><p>Offset into source for start of section.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>size</p></td>
+<td class="parameter_description"><p>Length of section.</p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.16.8"></a><h4>Returns</h4>
+<p> a new input object.</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-copy"></a><h3>gsf_input_copy ()</h3>
+<pre class="programlisting"><span class="returnvalue">gboolean</span>
+gsf_input_copy (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *input</code></em>,
+                <em class="parameter"><code><a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a> *output</code></em>);</pre>
+<p>Copy the contents from <em class="parameter"><code>input</code></em>
+ to <em class="parameter"><code>output</code></em>
+ from their respective
+current positions. So if you want to be sure to copy *everything*,
+make sure to call gsf_input_seek (input, 0, G_SEEK_SET) and
+gsf_output_seek (output, 0, G_SEEK_SET) first, if applicable.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.17.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody>
+<tr>
+<td class="parameter_name"><p>input</p></td>
+<td class="parameter_description"><p>a non-null <a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+<tr>
+<td class="parameter_name"><p>output</p></td>
+<td class="parameter_description"><p>a non-null <a class="link" href="gsf-Output-to-unstructured-files.html#GsfOutput"><span class="type">GsfOutput</span></a></p></td>
+<td class="parameter_annotations"> </td>
+</tr>
+</tbody>
+</table></div>
+</div>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.17.6"></a><h4>Returns</h4>
+<p> <code class="literal">TRUE</code> on success</p>
+<p></p>
+</div>
+</div>
+<hr>
+<div class="refsect2">
+<a name="gsf-input-uncompress"></a><h3>gsf_input_uncompress ()</h3>
+<pre class="programlisting"><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="returnvalue">GsfInput</span></a> *
+gsf_input_uncompress (<em class="parameter"><code><a class="link" href="gsf-Input-from-unstructured-files.html#GsfInput"><span class="type">GsfInput</span></a> *src</code></em>);</pre>
+<p>This functions takes ownership of the incoming reference and yields a
+new one as its output.</p>
+<div class="refsect3">
+<a name="id-1.6.3.2.10.18.5"></a><h4>Parameters</h4>
+<div class="informaltable"><table width="100%" border="0">
+<colgroup>
+<col width="150px" class="parameters_name">
+<col class="parameters_description">
+<col width="200px" class="parameters_annotations">
+</colgroup>
+<tbody><tr>
+<td class="parameter_name"><p>src</p></td>
+<td class="parameter_description"><p> stream to be uncompressed. </p></td>
+<td class="parameter_annotations"><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 class="refsect3">
+<a name="id-1.6.3.2.10.18.6"></a><h4>Returns</h4>
+<p> A stream equivalent to the source stream,
+but uncompressed if the source was compressed. </p>
+<p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
+</div>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.other_details"></a><h2>Types and Values</h2>
+<div class="refsect2">
+<a name="GsfInput-struct"></a><h3>GsfInput</h3>
+<pre class="programlisting">typedef struct _GsfInput GsfInput;</pre>
+<p>Class representing an input stream.</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInputProxy-struct"></a><h3>GsfInputProxy</h3>
+<pre class="programlisting">typedef struct _GsfInputProxy GsfInputProxy;</pre>
+<p>
+</p>
+</div>
+</div>
+<div class="refsect1">
+<a name="gsf-Input-from-unstructured-files.property-details"></a><h2>Property Details</h2>
+<div class="refsect2">
+<a name="GsfInput--container"></a><h3>The <code class="literal">“container”</code> property</h3>
+<pre class="programlisting">  “container”                <a class="link" href="gsf-Infile-reading-structed-files.html#GsfInfile"><span class="type">GsfInfile</span></a> *</pre>
+<p>The container, optionally <code class="literal">NULL</code>, in which this input lives.</p>
+<p>Flags: Read</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInput--eof"></a><h3>The <code class="literal">“eof”</code> property</h3>
+<pre class="programlisting">  “eof”                      <span class="type">gboolean</span></pre>
+<p><code class="literal">TRUE</code> if the end of the file has been reached.</p>
+<p>Flags: Read</p>
+<p>Default value: FALSE</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInput--modtime"></a><h3>The <code class="literal">“modtime”</code> property</h3>
+<pre class="programlisting">  “modtime”                  <span class="type">GDateTime</span> *</pre>
+<p>The time the input was last updated.  This represents the
+timestamp from the originating file or <em class="parameter"><code>GsfInfile</code></em>
+ member.
+It is not supported by all derived classes.</p>
+<p>Flags: Read</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInput--name"></a><h3>The <code class="literal">“name”</code> property</h3>
+<pre class="programlisting">  “name”                     <span class="type">gchar</span> *</pre>
+<p>The input's name.</p>
+<p>Flags: Read</p>
+<p>Default value: NULL</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInput--position"></a><h3>The <code class="literal">“position”</code> property</h3>
+<pre class="programlisting">  “position”                 <span class="type">gint64</span></pre>
+<p>The current position in the input.</p>
+<p>Flags: Read</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInput--remaining"></a><h3>The <code class="literal">“remaining”</code> property</h3>
+<pre class="programlisting">  “remaining”                <span class="type">gint64</span></pre>
+<p>The number of bytes remaining in the file.</p>
+<p>Flags: Read</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 0</p>
+</div>
+<hr>
+<div class="refsect2">
+<a name="GsfInput--size"></a><h3>The <code class="literal">“size”</code> property</h3>
+<pre class="programlisting">  “size”                     <span class="type">gint64</span></pre>
+<p>The total number of bytes in the file.</p>
+<p>Flags: Read</p>
+<p>Allowed values: &gt;= 0</p>
+<p>Default value: 0</p>
+</div>
+</div>
+</div>
+<div class="footer">
+<hr>
+          Generated by GTK-Doc V1.20</div>
+</body>
+</html>