mirror of
https://codeberg.org/scip/pcp.git
synced 2025-12-17 12:00:56 +01:00
309 lines
14 KiB
HTML
309 lines
14 KiB
HTML
|
<!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"/>
|
||
|
|
<title>libpcp: Z85</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="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 style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">libpcp
|
||
|
|
 <span id="projectnumber">0.2.1</span>
|
||
|
|
</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.2 -->
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="modules.html"><span>Modules</span></a></li>
|
||
|
|
<li><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li><a href="files.html"><span>Files</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Z85</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Z85 Encoding functions.
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:ga53084383405976192b642f4cdf8f0f7b"><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Z85.html#ga53084383405976192b642f4cdf8f0f7b">pcp_padfour</a> (unsigned char *src, size_t srclen, size_t *dstlen)</td></tr>
|
||
|
|
<tr class="memdesc:ga53084383405976192b642f4cdf8f0f7b"><td class="mdescLeft"> </td><td class="mdescRight">Zero-pad some input data. <a href="#ga53084383405976192b642f4cdf8f0f7b"></a><br/></td></tr>
|
||
|
|
<tr class="separator:ga53084383405976192b642f4cdf8f0f7b"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga71e7c229ead7f5294c6694f1c0ed9b1e"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Z85.html#ga71e7c229ead7f5294c6694f1c0ed9b1e">pcp_unpadfour</a> (unsigned char *src, size_t srclen)</td></tr>
|
||
|
|
<tr class="memdesc:ga71e7c229ead7f5294c6694f1c0ed9b1e"><td class="mdescLeft"> </td><td class="mdescRight">Unpad padded input data. <a href="#ga71e7c229ead7f5294c6694f1c0ed9b1e"></a><br/></td></tr>
|
||
|
|
<tr class="separator:ga71e7c229ead7f5294c6694f1c0ed9b1e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga9dacad0a9799e2b467d8725ef53d71dd"><td class="memItemLeft" align="right" valign="top">unsigned char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Z85.html#ga9dacad0a9799e2b467d8725ef53d71dd">pcp_z85_decode</a> (char *z85block, size_t *dstlen)</td></tr>
|
||
|
|
<tr class="memdesc:ga9dacad0a9799e2b467d8725ef53d71dd"><td class="mdescLeft"> </td><td class="mdescRight">Decode data from Z85 encoding. <a href="#ga9dacad0a9799e2b467d8725ef53d71dd"></a><br/></td></tr>
|
||
|
|
<tr class="separator:ga9dacad0a9799e2b467d8725ef53d71dd"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga1e2ba864abfab7902b3779b048f9eacf"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Z85.html#ga1e2ba864abfab7902b3779b048f9eacf">pcp_z85_encode</a> (unsigned char *raw, size_t srclen, size_t *dstlen)</td></tr>
|
||
|
|
<tr class="memdesc:ga1e2ba864abfab7902b3779b048f9eacf"><td class="mdescLeft"> </td><td class="mdescRight">Encode data to Z85 encoding. <a href="#ga1e2ba864abfab7902b3779b048f9eacf"></a><br/></td></tr>
|
||
|
|
<tr class="separator:ga1e2ba864abfab7902b3779b048f9eacf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ga28321ec07e0f34765349eadd30668275"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Z85.html#ga28321ec07e0f34765349eadd30668275">pcp_readz85file</a> (FILE *infile)</td></tr>
|
||
|
|
<tr class="memdesc:ga28321ec07e0f34765349eadd30668275"><td class="mdescLeft"> </td><td class="mdescRight">Read a Z85 encoded file. <a href="#ga28321ec07e0f34765349eadd30668275"></a><br/></td></tr>
|
||
|
|
<tr class="separator:ga28321ec07e0f34765349eadd30668275"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:gab16e85136e20e707c559e851d04e083c"><td class="memItemLeft" align="right" valign="top">char * </td><td class="memItemRight" valign="bottom"><a class="el" href="group__Z85.html#gab16e85136e20e707c559e851d04e083c">pcp_readz85string</a> (unsigned char *input, size_t bufsize)</td></tr>
|
||
|
|
<tr class="memdesc:gab16e85136e20e707c559e851d04e083c"><td class="mdescLeft"> </td><td class="mdescRight">Read a Z85 encoded string. <a href="#gab16e85136e20e707c559e851d04e083c"></a><br/></td></tr>
|
||
|
|
<tr class="separator:gab16e85136e20e707c559e851d04e083c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<p>Z85 Encoding functions. </p>
|
||
|
|
<p>The Z85 encoding format is described here: <a href="http://rfc.zeromq.org/spec:32">ZeroMQ Spec.32</a>. It's part of <a href="http://zeromq.org">ZeroMQ</a>. Z85 is based on ASCII85 with a couple of modifications (portability, readability etc).</p>
|
||
|
|
<p>To fulfil the requirements of the ZeroMQ Z85 functions, PCP does some additional preparations of raw input before actually doing the encoding, since the input for zmq_z85_encode() must be divisible by 4. Therefore we pad the input with zeroes and remove them after decoding. </p>
|
||
|
|
<h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a class="anchor" id="ga53084383405976192b642f4cdf8f0f7b"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">unsigned char* pcp_padfour </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">unsigned char * </td>
|
||
|
|
<td class="paramname"><em>src</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>srclen</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t * </td>
|
||
|
|
<td class="paramname"><em>dstlen</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Zero-pad some input data. </p>
|
||
|
|
<p>This function allocates new memory for the returned data. It puts the original pointer into it and adds a number of zeros so that the result has a size divisable by 4.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Unpadded data. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srclen</td><td>Size of unpadded data. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstlen</td><td>Returned size of padded data (pointer to int).</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a pointer to the padded data. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga28321ec07e0f34765349eadd30668275"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">char* pcp_readz85file </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">FILE * </td>
|
||
|
|
<td class="paramname"><em>infile</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Read a Z85 encoded file. </p>
|
||
|
|
<p>Reads a file and returns the raw Z85 encoded string. It ignores newlines, comments and Headerstrings.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">infile</td><td>FILE stream to read from.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Raw Z85 encoded string with comments, headers and newlines removed. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="gab16e85136e20e707c559e851d04e083c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">char* pcp_readz85string </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">unsigned char * </td>
|
||
|
|
<td class="paramname"><em>input</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>bufsize</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Read a Z85 encoded string. </p>
|
||
|
|
<p>Parses the given input string and returns the raw Z85 encoded string. It ignores newlines, comments and Headerstrings.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">input</td><td>Z85 encoded string. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">bufsize</td><td>Size of the string.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Raw Z85 encoded string with comments, headers and newlines removed. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga71e7c229ead7f5294c6694f1c0ed9b1e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">size_t pcp_unpadfour </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">unsigned char * </td>
|
||
|
|
<td class="paramname"><em>src</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>srclen</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unpad padded input data. </p>
|
||
|
|
<p>It just calculates the size of the unpadded result (size - all trailing zeroes). Doesn't allocate any memory or modify anything.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">src</td><td>Padded data. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srclen</td><td>Size of padded data.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns the unpadded size of the data. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga9dacad0a9799e2b467d8725ef53d71dd"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">unsigned char* pcp_z85_decode </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">char * </td>
|
||
|
|
<td class="paramname"><em>z85block</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t * </td>
|
||
|
|
<td class="paramname"><em>dstlen</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Decode data from Z85 encoding. </p>
|
||
|
|
<p>The input <em>z85block</em> may contain newlines which will be removed.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">z85block</td><td>The Z85 encoded string. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstlen</td><td>Returned size of decoded data (pointer to int).</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a newly allocated pointer to the decoded data. If decoding failed, returns NULL. Check fatals_if_any(). </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ga1e2ba864abfab7902b3779b048f9eacf"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">char* pcp_z85_encode </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">unsigned char * </td>
|
||
|
|
<td class="paramname"><em>raw</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t </td>
|
||
|
|
<td class="paramname"><em>srclen</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">size_t * </td>
|
||
|
|
<td class="paramname"><em>dstlen</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Encode data to Z85 encoding. </p>
|
||
|
|
<p>Beside Z85 encoding it also adds a newline everiy 72 characters.</p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">raw</td><td>Pointer to raw data. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">srclen</td><td>Size of the data. </td></tr>
|
||
|
|
<tr><td class="paramdir">[in]</td><td class="paramname">dstlen</td><td>Returned size of encoded data (pointer to int).</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>Returns a string (char array) containing the Z85 encoded data. </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated on Thu Feb 20 2014 19:59:14 for libpcp by  <a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
||
|
|
</a> 1.8.2
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|