| Current Path : /usr/share/doc/libcaca-dev/html/ |
Linux ift1.ift-informatik.de 5.4.0-216-generic #236-Ubuntu SMP Fri Apr 11 19:53:21 UTC 2025 x86_64 |
| Current File : //usr/share/doc/libcaca-dev/html/group__caca__file.html |
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>libcaca documentation</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.8.17 -->
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">libcaca file IO<div class="ingroups"><a class="el" href="group__caca__attr.html">libcaca attribute definitions</a> » <a class="el" href="group__libcaca.html">libcaca basic functions</a> » <a class="el" href="group__caca__canvas.html">libcaca canvas drawing</a> » <a class="el" href="group__caca__dirty.html">libcaca dirty rectangle manipulation</a> » <a class="el" href="group__caca__transform.html">libcaca canvas transformation</a> » <a class="el" href="group__caca__attributes.html">libcaca attribute conversions</a> » <a class="el" href="group__caca__charset.html">libcaca character set conversions</a> » <a class="el" href="group__caca__primitives.html">libcaca primitives drawing</a> » <a class="el" href="group__caca__frame.html">libcaca canvas frame handling</a> » <a class="el" href="group__caca__dither.html">libcaca bitmap dithering</a> » <a class="el" href="group__caca__charfont.html">libcaca character font handling</a> » <a class="el" href="group__caca__font.html">libcaca bitmap font handling</a> » <a class="el" href="group__caca__figfont.html">libcaca FIGfont handling</a></div></div> </div>
</div><!--header-->
<div class="contents">
<p>These functions allow to read and write files in a platform-independent way.
<a href="#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__caca__importexport"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__importexport.html">libcaca importers/exporters from/to various</a></td></tr>
<tr class="memdesc:group__caca__importexport"><td class="mdescLeft"> </td><td class="mdescRight">formats <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga8fa9094ea6fa527f5744e03124e15350"><td class="memItemLeft" align="right" valign="top">__extern <a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#ga8fa9094ea6fa527f5744e03124e15350">caca_file_open</a> (char const *, const char *)</td></tr>
<tr class="memdesc:ga8fa9094ea6fa527f5744e03124e15350"><td class="mdescLeft"> </td><td class="mdescRight">Open a file for reading or writing. <a href="group__caca__file.html#ga8fa9094ea6fa527f5744e03124e15350">More...</a><br /></td></tr>
<tr class="separator:ga8fa9094ea6fa527f5744e03124e15350"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga9cfbd9087b8926512a2f90a47bb5ad0a"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#ga9cfbd9087b8926512a2f90a47bb5ad0a">caca_file_close</a> (<a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> *)</td></tr>
<tr class="memdesc:ga9cfbd9087b8926512a2f90a47bb5ad0a"><td class="mdescLeft"> </td><td class="mdescRight">Close a file handle. <a href="group__caca__file.html#ga9cfbd9087b8926512a2f90a47bb5ad0a">More...</a><br /></td></tr>
<tr class="separator:ga9cfbd9087b8926512a2f90a47bb5ad0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga95e84007baae9c0790dc3aeaa739c1c9"><td class="memItemLeft" align="right" valign="top">__extern uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#ga95e84007baae9c0790dc3aeaa739c1c9">caca_file_tell</a> (<a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> *)</td></tr>
<tr class="memdesc:ga95e84007baae9c0790dc3aeaa739c1c9"><td class="mdescLeft"> </td><td class="mdescRight">Return the position in a file handle. <a href="group__caca__file.html#ga95e84007baae9c0790dc3aeaa739c1c9">More...</a><br /></td></tr>
<tr class="separator:ga95e84007baae9c0790dc3aeaa739c1c9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaccb5348b4e700cae308b51d5f16de5c1"><td class="memItemLeft" align="right" valign="top">__extern size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#gaccb5348b4e700cae308b51d5f16de5c1">caca_file_read</a> (<a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> *, void *, size_t)</td></tr>
<tr class="memdesc:gaccb5348b4e700cae308b51d5f16de5c1"><td class="mdescLeft"> </td><td class="mdescRight">Read data from a file handle. <a href="group__caca__file.html#gaccb5348b4e700cae308b51d5f16de5c1">More...</a><br /></td></tr>
<tr class="separator:gaccb5348b4e700cae308b51d5f16de5c1"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gaee6aa813cac3c59fadec0f69a167a793"><td class="memItemLeft" align="right" valign="top">__extern size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#gaee6aa813cac3c59fadec0f69a167a793">caca_file_write</a> (<a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> *, const void *, size_t)</td></tr>
<tr class="memdesc:gaee6aa813cac3c59fadec0f69a167a793"><td class="mdescLeft"> </td><td class="mdescRight">Write data to a file handle. <a href="group__caca__file.html#gaee6aa813cac3c59fadec0f69a167a793">More...</a><br /></td></tr>
<tr class="separator:gaee6aa813cac3c59fadec0f69a167a793"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga7f7aed12abcb1503248a719553238f4e"><td class="memItemLeft" align="right" valign="top">__extern char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#ga7f7aed12abcb1503248a719553238f4e">caca_file_gets</a> (<a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> *, char *, int)</td></tr>
<tr class="memdesc:ga7f7aed12abcb1503248a719553238f4e"><td class="mdescLeft"> </td><td class="mdescRight">Read a line from a file handle. <a href="group__caca__file.html#ga7f7aed12abcb1503248a719553238f4e">More...</a><br /></td></tr>
<tr class="separator:ga7f7aed12abcb1503248a719553238f4e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga24bff06701f35fa718924b7e879715cc"><td class="memItemLeft" align="right" valign="top">__extern int </td><td class="memItemRight" valign="bottom"><a class="el" href="group__caca__file.html#ga24bff06701f35fa718924b7e879715cc">caca_file_eof</a> (<a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> *)</td></tr>
<tr class="memdesc:ga24bff06701f35fa718924b7e879715cc"><td class="mdescLeft"> </td><td class="mdescRight">Tell whether a file handle reached end of file. <a href="group__caca__file.html#ga24bff06701f35fa718924b7e879715cc">More...</a><br /></td></tr>
<tr class="separator:ga24bff06701f35fa718924b7e879715cc"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<h2 class="groupheader">Function Documentation</h2>
<a id="ga8fa9094ea6fa527f5744e03124e15350"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8fa9094ea6fa527f5744e03124e15350">◆ </a></span>caca_file_open()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern <a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a>* caca_file_open </td>
<td>(</td>
<td class="paramtype">char const * </td>
<td class="paramname"><em>path</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a caca file handle for a file. If the file is zipped, it is decompressed on the fly.</p>
<p>If an error occurs, NULL is returned and <b>errno</b> is set accordingly:</p><ul>
<li><code>ENOSTS</code> Function not implemented.</li>
<li><code>EINVAL</code> File not found or permission denied.</li>
</ul>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>The file path </td></tr>
<tr><td class="paramname">mode</td><td>The file open mode </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A file handle to <em>path</em>. </dd></dl>
<p class="reference">Referenced by <a class="el" href="group__caca__importexport.html#gaa47bfa2ea5cfe33b87fe7a919d5ff500">caca_import_canvas_from_file()</a>.</p>
</div>
</div>
<a id="ga9cfbd9087b8926512a2f90a47bb5ad0a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga9cfbd9087b8926512a2f90a47bb5ad0a">◆ </a></span>caca_file_close()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_file_close </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td>
<td class="paramname"><em>fp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Close and destroy the resources associated with a caca file handle.</p>
<p>This function is a wrapper for fclose() or, if available, gzclose().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>The file handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The return value of fclose() or gzclose(). </dd></dl>
<p class="reference">Referenced by <a class="el" href="group__caca__importexport.html#gaa47bfa2ea5cfe33b87fe7a919d5ff500">caca_import_canvas_from_file()</a>.</p>
</div>
</div>
<a id="ga95e84007baae9c0790dc3aeaa739c1c9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga95e84007baae9c0790dc3aeaa739c1c9">◆ </a></span>caca_file_tell()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern uint64_t caca_file_tell </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td>
<td class="paramname"><em>fp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the file handle position, in bytes.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>The file handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The current offset in the file handle. </dd></dl>
</div>
</div>
<a id="gaccb5348b4e700cae308b51d5f16de5c1"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaccb5348b4e700cae308b51d5f16de5c1">◆ </a></span>caca_file_read()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern size_t caca_file_read </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read data from a file handle and copy them into the given buffer.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>The file handle </td></tr>
<tr><td class="paramname">ptr</td><td>The destination buffer </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes read </dd></dl>
<p class="reference">Referenced by <a class="el" href="group__caca__importexport.html#gaa47bfa2ea5cfe33b87fe7a919d5ff500">caca_import_canvas_from_file()</a>.</p>
</div>
</div>
<a id="gaee6aa813cac3c59fadec0f69a167a793"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaee6aa813cac3c59fadec0f69a167a793">◆ </a></span>caca_file_write()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern size_t caca_file_write </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>ptr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write the contents of the given buffer to the file handle.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>The file handle </td></tr>
<tr><td class="paramname">ptr</td><td>The source buffer </td></tr>
<tr><td class="paramname">size</td><td>The number of bytes to write </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes written </dd></dl>
</div>
</div>
<a id="ga7f7aed12abcb1503248a719553238f4e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f7aed12abcb1503248a719553238f4e">◆ </a></span>caca_file_gets()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern char* caca_file_gets </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td>
<td class="paramname"><em>fp</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char * </td>
<td class="paramname"><em>s</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read one line of data from a file handle, up to one less than the given number of bytes. A trailing zero is appended to the data.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>The file handle </td></tr>
<tr><td class="paramname">s</td><td>The destination buffer </td></tr>
<tr><td class="paramname">size</td><td>The maximum number of bytes to read </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The number of bytes read, including the trailing zero </dd></dl>
</div>
</div>
<a id="ga24bff06701f35fa718924b7e879715cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga24bff06701f35fa718924b7e879715cc">◆ </a></span>caca_file_eof()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">__extern int caca_file_eof </td>
<td>(</td>
<td class="paramtype"><a class="el" href="caca_8h.html#a3e8b2f71ed96861283e0fe5172c15422">caca_file_t</a> * </td>
<td class="paramname"><em>fp</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the end-of-file status of the file handle.</p>
<p>This function is a wrapper for feof() or, if available, gzeof().</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fp</td><td>The file handle </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>1 if EOF was reached, 0 otherwise </dd></dl>
<p class="reference">Referenced by <a class="el" href="group__caca__importexport.html#gaa47bfa2ea5cfe33b87fe7a919d5ff500">caca_import_canvas_from_file()</a>.</p>
</div>
</div>
</div><!-- contents -->
</body>
</html>