RubyGems - libmspack - Versions diffs - 0.10.1 → 0.10.1.2 - Mend

libmspack 0.10.1 → 0.10.1.2

Files changed (355) hide show

data/ext/libmspack/doc/html/structmspack__system.html DELETED Viewed

@@ -1,404 +0,0 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<html xmlns="http://www.w3.org/1999/xhtml">
-<head>
-<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
-<meta http-equiv="X-UA-Compatible" content="IE=9"/>
-<meta name="generator" content="Doxygen 1.8.13"/>
-<meta name="viewport" content="width=device-width, initial-scale=1"/>
-<title>libmspack: mspack_system Struct Reference</title>
-<link href="tabs.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="jquery.js"></script>
-<script type="text/javascript" src="dynsections.js"></script>
-<link href="search/search.css" rel="stylesheet" type="text/css"/>
-<script type="text/javascript" src="search/searchdata.js"></script>
-<script type="text/javascript" src="search/search.js"></script>
-<link href="doxygen.css" rel="stylesheet" type="text/css" />
-</head>
-<body>
-<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
-<div id="titlearea">
-<table cellspacing="0" cellpadding="0">
- <tbody>
- <tr style="height: 56px;">
-  <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">libmspack
-   </div>
-  </td>
- </tr>
- </tbody>
-</table>
-</div>
-<!-- end header part -->
-<!-- Generated by Doxygen 1.8.13 -->
-<script type="text/javascript">
-var searchBox = new SearchBox("searchBox", "search",false,'Search');
-</script>
-<script type="text/javascript" src="menudata.js"></script>
-<script type="text/javascript" src="menu.js"></script>
-<script type="text/javascript">
-$(function() {
-  initMenu('',true,false,'search.php','Search');
-  $(document).ready(function() { init_search(); });
-});
-</script>
-<div id="main-nav"></div>
-<!-- window showing the filter options -->
-<div id="MSearchSelectWindow"
-     onmouseover="return searchBox.OnSearchSelectShow()"
-     onmouseout="return searchBox.OnSearchSelectHide()"
-     onkeydown="return searchBox.OnSearchSelectKey(event)">
-</div>
-<!-- iframe showing the search results (closed by default) -->
-<div id="MSearchResultsWindow">
-<iframe src="javascript:void(0)" frameborder="0"
-        name="MSearchResults" id="MSearchResults">
-</iframe>
-</div>
-</div><!-- top -->
-<div class="header">
-  <div class="summary">
-<a href="#pub-attribs">Data Fields</a>  </div>
-  <div class="headertitle">
-<div class="title">mspack_system Struct Reference</div>  </div>
-</div><!--header-->
-<div class="contents">
-<p>A structure which abstracts file I/O and memory management.
- <a href="structmspack__system.html#details">More...</a></p>
-<p><code>#include &lt;<a class="el" href="mspack_8h_source.html">mspack.h</a>&gt;</code></p>
-<div class="dynheader">
-Collaboration diagram for mspack_system:</div>
-<div class="dyncontent">
-<div class="center"><img src="structmspack__system__coll__graph.png" border="0" usemap="#mspack__system_coll__map" alt="Collaboration graph"/></div>
-<map name="mspack__system_coll__map" id="mspack__system_coll__map">
-<area shape="rect" id="node2" href="structmspack__file.html" title="A structure which represents an open file handle. " alt="" coords="19,5,111,32"/>
-</map>
-<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
-<table class="memberdecls">
-<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
-Data Fields</h2></td></tr>
-<tr class="memitem:a908dd0c7eecc8fe0d61584f69896df0c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structmspack__file.html">mspack_file</a> *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c">open</a> )(struct <a class="el" href="structmspack__system.html">mspack_system</a> *self, const char *filename, int mode)</td></tr>
-<tr class="memdesc:a908dd0c7eecc8fe0d61584f69896df0c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Opens a file for reading, writing, appending or updating.  <a href="#a908dd0c7eecc8fe0d61584f69896df0c">More...</a><br /></td></tr>
-<tr class="separator:a908dd0c7eecc8fe0d61584f69896df0c"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a86073da10c2b30b1ff75dd0d82a3ba8d"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a86073da10c2b30b1ff75dd0d82a3ba8d">close</a> )(struct <a class="el" href="structmspack__file.html">mspack_file</a> *file)</td></tr>
-<tr class="memdesc:a86073da10c2b30b1ff75dd0d82a3ba8d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Closes a previously opened file.  <a href="#a86073da10c2b30b1ff75dd0d82a3ba8d">More...</a><br /></td></tr>
-<tr class="separator:a86073da10c2b30b1ff75dd0d82a3ba8d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a121acf7277cde3b96d4c59e259b01ad6"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a121acf7277cde3b96d4c59e259b01ad6">read</a> )(struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, void *buffer, int bytes)</td></tr>
-<tr class="memdesc:a121acf7277cde3b96d4c59e259b01ad6"><td class="mdescLeft">&#160;</td><td class="mdescRight">Reads a given number of bytes from an open file.  <a href="#a121acf7277cde3b96d4c59e259b01ad6">More...</a><br /></td></tr>
-<tr class="separator:a121acf7277cde3b96d4c59e259b01ad6"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:abac465118be5ef7a9f21a273c48769a5"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#abac465118be5ef7a9f21a273c48769a5">write</a> )(struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, void *buffer, int bytes)</td></tr>
-<tr class="memdesc:abac465118be5ef7a9f21a273c48769a5"><td class="mdescLeft">&#160;</td><td class="mdescRight">Writes a given number of bytes to an open file.  <a href="#abac465118be5ef7a9f21a273c48769a5">More...</a><br /></td></tr>
-<tr class="separator:abac465118be5ef7a9f21a273c48769a5"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:afb2a70ca48bbc9487c8f2d4c525f94c4"><td class="memItemLeft" align="right" valign="top">int(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#afb2a70ca48bbc9487c8f2d4c525f94c4">seek</a> )(struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, off_t offset, int mode)</td></tr>
-<tr class="memdesc:afb2a70ca48bbc9487c8f2d4c525f94c4"><td class="mdescLeft">&#160;</td><td class="mdescRight">Seeks to a specific file offset within an open file.  <a href="#afb2a70ca48bbc9487c8f2d4c525f94c4">More...</a><br /></td></tr>
-<tr class="separator:afb2a70ca48bbc9487c8f2d4c525f94c4"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a91b831a5fbc3ad14908702d55d5cb9d8"><td class="memItemLeft" align="right" valign="top">off_t(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a91b831a5fbc3ad14908702d55d5cb9d8">tell</a> )(struct <a class="el" href="structmspack__file.html">mspack_file</a> *file)</td></tr>
-<tr class="memdesc:a91b831a5fbc3ad14908702d55d5cb9d8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the current file position (in bytes) of the given file.  <a href="#a91b831a5fbc3ad14908702d55d5cb9d8">More...</a><br /></td></tr>
-<tr class="separator:a91b831a5fbc3ad14908702d55d5cb9d8"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a9954de59172a04aac2a5edc4803e9e38"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a9954de59172a04aac2a5edc4803e9e38">message</a> )(struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, const char *format,...)</td></tr>
-<tr class="memdesc:a9954de59172a04aac2a5edc4803e9e38"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to send messages from the library to the user.  <a href="#a9954de59172a04aac2a5edc4803e9e38">More...</a><br /></td></tr>
-<tr class="separator:a9954de59172a04aac2a5edc4803e9e38"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab4542f055c67fb13ae96aef15b4d0646"><td class="memItemLeft" align="right" valign="top">void *(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#ab4542f055c67fb13ae96aef15b4d0646">alloc</a> )(struct <a class="el" href="structmspack__system.html">mspack_system</a> *self, size_t bytes)</td></tr>
-<tr class="memdesc:ab4542f055c67fb13ae96aef15b4d0646"><td class="mdescLeft">&#160;</td><td class="mdescRight">Allocates memory.  <a href="#ab4542f055c67fb13ae96aef15b4d0646">More...</a><br /></td></tr>
-<tr class="separator:ab4542f055c67fb13ae96aef15b4d0646"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:adc2493d00d2d6a4e442ae9a02cc2eba3"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#adc2493d00d2d6a4e442ae9a02cc2eba3">free</a> )(void *ptr)</td></tr>
-<tr class="memdesc:adc2493d00d2d6a4e442ae9a02cc2eba3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Frees memory.  <a href="#adc2493d00d2d6a4e442ae9a02cc2eba3">More...</a><br /></td></tr>
-<tr class="separator:adc2493d00d2d6a4e442ae9a02cc2eba3"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a97c3960d5bdf646bae92de8fb64ba67b"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a97c3960d5bdf646bae92de8fb64ba67b">copy</a> )(void *src, void *dest, size_t bytes)</td></tr>
-<tr class="memdesc:a97c3960d5bdf646bae92de8fb64ba67b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Copies from one region of memory to another.  <a href="#a97c3960d5bdf646bae92de8fb64ba67b">More...</a><br /></td></tr>
-<tr class="separator:a97c3960d5bdf646bae92de8fb64ba67b"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a8c64d1bd9b6b0ac9455cfde19ccb61b2"><td class="memItemLeft" align="right" valign="top">void *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmspack__system.html#a8c64d1bd9b6b0ac9455cfde19ccb61b2">null_ptr</a></td></tr>
-<tr class="memdesc:a8c64d1bd9b6b0ac9455cfde19ccb61b2"><td class="mdescLeft">&#160;</td><td class="mdescRight">A null pointer to mark the end of <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a>.  <a href="#a8c64d1bd9b6b0ac9455cfde19ccb61b2">More...</a><br /></td></tr>
-<tr class="separator:a8c64d1bd9b6b0ac9455cfde19ccb61b2"><td class="memSeparator" colspan="2">&#160;</td></tr>
-</table>
-<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>A structure which abstracts file I/O and memory management. </p>
-<p>The library always uses the <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> structure for interaction with the file system and to allocate, free and copy all memory. It also uses it to send literal messages to the library user.</p>
-<p>When the library is compiled normally, passing NULL to a compressor or decompressor constructor will result in a default <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> being used, where all methods are implemented with the standard C library. However, all constructors support being given a custom created <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> structure, with the library user's own methods. This allows for more abstract interaction, such as reading and writing files directly to memory, or from a network socket or pipe.</p>
-<p>Implementors of an <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> structure should read all documentation entries for every structure member, and write methods which conform to those standards. </p>
-</div><h2 class="groupheader">Field Documentation</h2>
-<a id="ab4542f055c67fb13ae96aef15b4d0646"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#ab4542f055c67fb13ae96aef15b4d0646">&#9670;&nbsp;</a></span>alloc</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void*(* mspack_system::alloc) (struct <a class="el" href="structmspack__system.html">mspack_system</a> *self, size_t bytes)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Allocates memory. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> structure whose <a class="el" href="structmspack__system.html#ab4542f055c67fb13ae96aef15b4d0646" title="Allocates memory. ">alloc()</a> method is being called. </td></tr>
-    <tr><td class="paramname">bytes</td><td>the number of bytes to allocate </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>a pointer to the requested number of bytes, or NULL if not enough memory is available </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#adc2493d00d2d6a4e442ae9a02cc2eba3" title="Frees memory. ">free()</a> </dd></dl>
-</div>
-</div>
-<a id="a86073da10c2b30b1ff75dd0d82a3ba8d"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a86073da10c2b30b1ff75dd0d82a3ba8d">&#9670;&nbsp;</a></span>close</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void(* mspack_system::close) (struct <a class="el" href="structmspack__file.html">mspack_file</a> *file)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Closes a previously opened file. </p>
-<p>If any memory was allocated for this particular file handle, it should be freed at this time.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">file</td><td>the file to close </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a> </dd></dl>
-</div>
-</div>
-<a id="a97c3960d5bdf646bae92de8fb64ba67b"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a97c3960d5bdf646bae92de8fb64ba67b">&#9670;&nbsp;</a></span>copy</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void(* mspack_system::copy) (void *src, void *dest, size_t bytes)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Copies from one region of memory to another. </p>
-<p>The regions of memory are guaranteed not to overlap, are usually less than 256 bytes, and may not be aligned. Please note that the source parameter comes before the destination parameter, unlike the standard C function memcpy().</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">src</td><td>the region of memory to copy from </td></tr>
-    <tr><td class="paramname">dest</td><td>the region of memory to copy to </td></tr>
-    <tr><td class="paramname">bytes</td><td>the size of the memory region, in bytes </td></tr>
-  </table>
-  </dd>
-</dl>
-</div>
-</div>
-<a id="adc2493d00d2d6a4e442ae9a02cc2eba3"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#adc2493d00d2d6a4e442ae9a02cc2eba3">&#9670;&nbsp;</a></span>free</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void(* mspack_system::free) (void *ptr)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Frees memory. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">ptr</td><td>the memory to be freed. NULL is accepted and ignored. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#ab4542f055c67fb13ae96aef15b4d0646" title="Allocates memory. ">alloc()</a> </dd></dl>
-</div>
-</div>
-<a id="a9954de59172a04aac2a5edc4803e9e38"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a9954de59172a04aac2a5edc4803e9e38">&#9670;&nbsp;</a></span>message</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void(* mspack_system::message) (struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, const char *format,...)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Used to send messages from the library to the user. </p>
-<p>Occasionally, the library generates warnings or other messages in plain english to inform the human user. These are informational only and can be ignored if not wanted.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">file</td><td>may be a file handle returned from <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a> if this message pertains to a specific open file, or NULL if not related to a specific file. </td></tr>
-    <tr><td class="paramname">format</td><td>a printf() style format string. It does NOT include a trailing newline. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a> </dd></dl>
-</div>
-</div>
-<a id="a8c64d1bd9b6b0ac9455cfde19ccb61b2"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a8c64d1bd9b6b0ac9455cfde19ccb61b2">&#9670;&nbsp;</a></span>null_ptr</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">void* mspack_system::null_ptr</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>A null pointer to mark the end of <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a>. </p>
-<p>It must equal NULL.</p>
-<p>Should the <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> structure extend in the future, this NULL will be seen, rather than have an invalid method pointer called. </p>
-</div>
-</div>
-<a id="a908dd0c7eecc8fe0d61584f69896df0c"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a908dd0c7eecc8fe0d61584f69896df0c">&#9670;&nbsp;</a></span>open</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">struct <a class="el" href="structmspack__file.html">mspack_file</a>*(* mspack_system::open) (struct <a class="el" href="structmspack__system.html">mspack_system</a> *self, const char *filename, int mode)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Opens a file for reading, writing, appending or updating. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">self</td><td>a self-referential pointer to the <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> structure whose <a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a> method is being called. If this pointer is required by <a class="el" href="structmspack__system.html#a86073da10c2b30b1ff75dd0d82a3ba8d" title="Closes a previously opened file. ">close()</a>, <a class="el" href="structmspack__system.html#a121acf7277cde3b96d4c59e259b01ad6" title="Reads a given number of bytes from an open file. ">read()</a>, <a class="el" href="structmspack__system.html#abac465118be5ef7a9f21a273c48769a5" title="Writes a given number of bytes to an open file. ">write()</a>, <a class="el" href="structmspack__system.html#afb2a70ca48bbc9487c8f2d4c525f94c4" title="Seeks to a specific file offset within an open file. ">seek()</a> or <a class="el" href="structmspack__system.html#a91b831a5fbc3ad14908702d55d5cb9d8" title="Returns the current file position (in bytes) of the given file. ">tell()</a>, it should be stored in the result structure at this time. </td></tr>
-    <tr><td class="paramname">filename</td><td>the file to be opened. It is passed directly from the library caller without being modified, so it is up to the caller what this parameter actually represents. </td></tr>
-    <tr><td class="paramname">mode</td><td>one of <a class="el" href="mspack_8h.html#a817255b35e433f4adcf907fc97f9b63f" title="mspack_system::open() mode: open existing file for reading. ">MSPACK_SYS_OPEN_READ</a> (open an existing file for reading), <a class="el" href="mspack_8h.html#a77508ef49eff6a98f39a3b5021c5c51f" title="mspack_system::open() mode: open new file for writing ">MSPACK_SYS_OPEN_WRITE</a> (open a new file for writing), <a class="el" href="mspack_8h.html#ae9f356d2f22c7c236b9bdad87b25b18b" title="mspack_system::open() mode: open existing file for writing ">MSPACK_SYS_OPEN_UPDATE</a> (open an existing file for reading/writing from the start of the file) or <a class="el" href="mspack_8h.html#a05310a4221173aabf06ab99d09d7504e" title="mspack_system::open() mode: open existing file for writing ">MSPACK_SYS_OPEN_APPEND</a> (open an existing file for reading/writing from the end of the file) </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>a pointer to a <a class="el" href="structmspack__file.html" title="A structure which represents an open file handle. ">mspack_file</a> structure. This structure officially contains no members, its true contents are up to the <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> implementor. It should contain whatever is needed for other <a class="el" href="structmspack__system.html" title="A structure which abstracts file I/O and memory management. ">mspack_system</a> methods to operate. Returning the NULL pointer indicates an error condition. </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a86073da10c2b30b1ff75dd0d82a3ba8d" title="Closes a previously opened file. ">close()</a>, <a class="el" href="structmspack__system.html#a121acf7277cde3b96d4c59e259b01ad6" title="Reads a given number of bytes from an open file. ">read()</a>, <a class="el" href="structmspack__system.html#abac465118be5ef7a9f21a273c48769a5" title="Writes a given number of bytes to an open file. ">write()</a>, <a class="el" href="structmspack__system.html#afb2a70ca48bbc9487c8f2d4c525f94c4" title="Seeks to a specific file offset within an open file. ">seek()</a>, <a class="el" href="structmspack__system.html#a91b831a5fbc3ad14908702d55d5cb9d8" title="Returns the current file position (in bytes) of the given file. ">tell()</a>, <a class="el" href="structmspack__system.html#a9954de59172a04aac2a5edc4803e9e38" title="Used to send messages from the library to the user. ">message()</a> </dd></dl>
-</div>
-</div>
-<a id="a121acf7277cde3b96d4c59e259b01ad6"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a121acf7277cde3b96d4c59e259b01ad6">&#9670;&nbsp;</a></span>read</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mspack_system::read) (struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, void *buffer, int bytes)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Reads a given number of bytes from an open file. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">file</td><td>the file to read from </td></tr>
-    <tr><td class="paramname">buffer</td><td>the location where the read bytes should be stored </td></tr>
-    <tr><td class="paramname">bytes</td><td>the number of bytes to read from the file. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>the number of bytes successfully read (this can be less than the number requested), zero to mark the end of file, or less than zero to indicate an error. The library does not "retry" reads and assumes short reads are due to EOF, so you should avoid returning short reads because of transient errors. </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a>, <a class="el" href="structmspack__system.html#abac465118be5ef7a9f21a273c48769a5" title="Writes a given number of bytes to an open file. ">write()</a> </dd></dl>
-</div>
-</div>
-<a id="afb2a70ca48bbc9487c8f2d4c525f94c4"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#afb2a70ca48bbc9487c8f2d4c525f94c4">&#9670;&nbsp;</a></span>seek</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mspack_system::seek) (struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, off_t offset, int mode)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Seeks to a specific file offset within an open file. </p>
-<p>Sometimes the library needs to know the length of a file. It does this by seeking to the end of the file with seek(file, 0, MSPACK_SYS_SEEK_END), then calling <a class="el" href="structmspack__system.html#a91b831a5fbc3ad14908702d55d5cb9d8" title="Returns the current file position (in bytes) of the given file. ">tell()</a>. Implementations may want to make a special case for this.</p>
-<p>Due to the potentially varying 32/64 bit datatype off_t on some architectures, the <a class="el" href="mspack_8h.html#a3a94be2216dd1e835733acb7c4645fca" title="System self-test function, to ensure both library and calling program can use one another...">MSPACK_SYS_SELFTEST</a> macro MUST be used before using the library. If not, the error caused by the library passing an inappropriate stackframe to <a class="el" href="structmspack__system.html#afb2a70ca48bbc9487c8f2d4c525f94c4" title="Seeks to a specific file offset within an open file. ">seek()</a> is subtle and hard to trace.</p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">file</td><td>the file to be seeked </td></tr>
-    <tr><td class="paramname">offset</td><td>an offset to seek, measured in bytes </td></tr>
-    <tr><td class="paramname">mode</td><td>one of <a class="el" href="mspack_8h.html#a80228888f03f72c392e138373acfc74e" title="mspack_system::seek() mode: seek relative to start of file ">MSPACK_SYS_SEEK_START</a> (the offset should be measured from the start of the file), <a class="el" href="mspack_8h.html#a9b90c177e3582571d0155c4597f85168" title="mspack_system::seek() mode: seek relative to current offset ">MSPACK_SYS_SEEK_CUR</a> (the offset should be measured from the current file offset) or <a class="el" href="mspack_8h.html#a24e4d3889d52558e7f0c703db94270d6" title="mspack_system::seek() mode: seek relative to end of file ">MSPACK_SYS_SEEK_END</a> (the offset should be measured from the end of the file) </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>zero for success, non-zero for an error </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a>, <a class="el" href="structmspack__system.html#a91b831a5fbc3ad14908702d55d5cb9d8" title="Returns the current file position (in bytes) of the given file. ">tell()</a> </dd></dl>
-</div>
-</div>
-<a id="a91b831a5fbc3ad14908702d55d5cb9d8"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a91b831a5fbc3ad14908702d55d5cb9d8">&#9670;&nbsp;</a></span>tell</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">off_t(* mspack_system::tell) (struct <a class="el" href="structmspack__file.html">mspack_file</a> *file)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Returns the current file position (in bytes) of the given file. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">file</td><td>the file whose file position is wanted </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>the current file position of the file </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a>, <a class="el" href="structmspack__system.html#afb2a70ca48bbc9487c8f2d4c525f94c4" title="Seeks to a specific file offset within an open file. ">seek()</a> </dd></dl>
-</div>
-</div>
-<a id="abac465118be5ef7a9f21a273c48769a5"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#abac465118be5ef7a9f21a273c48769a5">&#9670;&nbsp;</a></span>write</h2>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname">int(* mspack_system::write) (struct <a class="el" href="structmspack__file.html">mspack_file</a> *file, void *buffer, int bytes)</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-<p>Writes a given number of bytes to an open file. </p>
-<dl class="params"><dt>Parameters</dt><dd>
-  <table class="params">
-    <tr><td class="paramname">file</td><td>the file to write to </td></tr>
-    <tr><td class="paramname">buffer</td><td>the location where the written bytes should be read from </td></tr>
-    <tr><td class="paramname">bytes</td><td>the number of bytes to write to the file. </td></tr>
-  </table>
-  </dd>
-</dl>
-<dl class="section return"><dt>Returns</dt><dd>the number of bytes successfully written, this can be less than the number requested. Zero or less can indicate an error where no bytes at all could be written. All cases where less bytes were written than requested are considered by the library to be an error. </dd></dl>
-<dl class="section see"><dt>See also</dt><dd><a class="el" href="structmspack__system.html#a908dd0c7eecc8fe0d61584f69896df0c" title="Opens a file for reading, writing, appending or updating. ">open()</a>, <a class="el" href="structmspack__system.html#a121acf7277cde3b96d4c59e259b01ad6" title="Reads a given number of bytes from an open file. ">read()</a> </dd></dl>
-</div>
-</div>
-<hr/>The documentation for this struct was generated from the following file:<ul>
-<li><a class="el" href="mspack_8h_source.html">mspack.h</a></li>
-</ul>
-</div><!-- contents -->
-<!-- start footer part -->
-<hr class="footer"/><address class="footer"><small>
-Generated by &#160;<a href="http://www.doxygen.org/index.html">
-<img class="footer" src="doxygen.png" alt="doxygen"/>
-</a> 1.8.13
-</small></address>
-</body>
-</html>

data/ext/libmspack/doc/html/structmspack__system__coll__graph.map DELETED Viewed

@@ -1,3 +0,0 @@
-<map id="mspack_system" name="mspack_system">
-<area shape="rect" id="node2" href="$structmspack__file.html" title="A structure which represents an open file handle. " alt="" coords="19,5,111,32"/>
-</map>

data/ext/libmspack/doc/html/structmspack__system__coll__graph.md5 DELETED Viewed

	@@ -1 +0,0 @@
1	- e40a67e12ce5cf814de84801f58d7372

data/ext/libmspack/doc/html/structmspack__system__coll__graph.png DELETED Viewed

Binary file