<!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"/> <title>BeeCrypt: include/beecrypt/api.h File Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.7.3 --> <div id="top"> <div id="titlearea"> <table cellspacing="0" cellpadding="0"> <tbody> <tr style="height: 56px;"> <td style="padding-left: 0.5em;"> <div id="projectname">BeeCrypt <span id="projectnumber">4.2.1</span></div> </td> </tr> </tbody> </table> </div> <div id="navrow1" class="tabs"> <ul class="tablist"> <li><a href="index.html"><span>Main Page</span></a></li> <li><a href="pages.html"><span>Related Pages</span></a></li> <li><a href="modules.html"><span>Modules</span></a></li> <li><a href="annotated.html"><span>Data Structures</span></a></li> <li class="current"><a href="files.html"><span>Files</span></a></li> </ul> </div> <div id="navrow2" class="tabs2"> <ul class="tablist"> <li><a href="files.html"><span>File List</span></a></li> <li><a href="globals.html"><span>Globals</span></a></li> </ul> </div> </div> <div class="header"> <div class="summary"> <a href="#define-members">Defines</a> | <a href="#typedef-members">Typedefs</a> </div> <div class="headertitle"> <h1>include/beecrypt/api.h File Reference</h1> </div> </div> <div class="contents"> <p>BeeCrypt API, portability headers. <a href="#_details">More...</a></p> <div class="textblock"><code>#include "beecrypt/gnu.h"</code><br/> </div><div class="textblock"><div class="dynheader"> Include dependency graph for api.h:</div> <div class="dyncontent"> <div class="center"><img src="api_8h__incl.png" border="0" usemap="#include_2beecrypt_2api_8h" alt=""/></div> <map name="include_2beecrypt_2api_8h" id="include_2beecrypt_2api_8h"> </map> </div> </div> <p><a href="api_8h_source.html">Go to the source code of this file.</a></p> <table class="memberdecls"> <tr><td colspan="2"><h2><a name="define-members"></a> Defines</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a4f699d64328623c51b22f3b3f1ff4150">BEECRYPTAPI</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a6f5fb8b5b1eff54641a3539493b0ae25">BEECRYPTCXXAPI</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#af576bf8ffa22a44e53018c67095ffbf0">assert</a>(x)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#ab61aff55a4da7ead1de4cca6d2cd55a8">ROTL32</a>(x, s)   (((x) << (s)) | ((x) >> (32 - (s))))</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a2f072a06ce099ce74350d4fa78c00f9e">ROTR32</a>(x, s)   (((x) >> (s)) | ((x) << (32 - (s))))</td></tr> <tr><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a734f86802d97461df10fc14af148aae1">ROTR64</a>(x, s)   (((x) >> (s)) | ((x) << (64 - (s))))</td></tr> <tr><td colspan="2"><h2><a name="typedef-members"></a> Typedefs</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef int8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#ad7f749722d705466d6db175d0e1c2df6">jbyte</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef int16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a8436c228414d8b882086f54981175525">jshort</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef int32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a36d2d2d6848d7f576b7f8875f95efd1e">jint</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef int64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a6c3e7e2cbf647998ac1eb3dd10890d37">jlong</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#af15c8b821f6a554997c2fa4893c31951">jchar</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef float </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a5d393cee6f500e76ac60e7e29279bf17">jfloat</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef double </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#a4dbf307878725eebfb852c2800a951fa">jdouble</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#af807108d471a7c68e58df13068048e03">mpw</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">typedef uint16_t </td><td class="memItemRight" valign="bottom"><a class="el" href="api_8h.html#ae200b19ced3c771d1198b7b4610f0116">mphw</a></td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <div class="textblock"><p>BeeCrypt API, portability headers. </p> <dl class="author"><dt><b>Author:</b></dt><dd>Bob Deblier <<a href="mailto:bob.deblier@telenet.be">bob.deblier@telenet.be</a>> </dd></dl> </div><hr/><h2>Define Documentation</h2> <a class="anchor" id="af576bf8ffa22a44e53018c67095ffbf0"></a><!-- doxytag: member="api.h::assert" ref="af576bf8ffa22a44e53018c67095ffbf0" args="(x)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define assert</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">x</td><td>)</td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4f699d64328623c51b22f3b3f1ff4150"></a><!-- doxytag: member="api.h::BEECRYPTAPI" ref="a4f699d64328623c51b22f3b3f1ff4150" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define BEECRYPTAPI</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a6f5fb8b5b1eff54641a3539493b0ae25"></a><!-- doxytag: member="api.h::BEECRYPTCXXAPI" ref="a6f5fb8b5b1eff54641a3539493b0ae25" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define BEECRYPTCXXAPI</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ab61aff55a4da7ead1de4cca6d2cd55a8"></a><!-- doxytag: member="api.h::ROTL32" ref="ab61aff55a4da7ead1de4cca6d2cd55a8" args="(x, s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ROTL32</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">x, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">s </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   (((x) << (s)) | ((x) >> (32 - (s))))</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a2f072a06ce099ce74350d4fa78c00f9e"></a><!-- doxytag: member="api.h::ROTR32" ref="a2f072a06ce099ce74350d4fa78c00f9e" args="(x, s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ROTR32</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">x, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">s </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   (((x) >> (s)) | ((x) << (32 - (s))))</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a734f86802d97461df10fc14af148aae1"></a><!-- doxytag: member="api.h::ROTR64" ref="a734f86802d97461df10fc14af148aae1" args="(x, s)" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">#define ROTR64</td> <td>(</td> <td class="paramtype"> </td> <td class="paramname">x, </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype"> </td> <td class="paramname">s </td> </tr> <tr> <td></td> <td>)</td> <td></td><td>   (((x) >> (s)) | ((x) << (64 - (s))))</td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Typedef Documentation</h2> <a class="anchor" id="ab8ef12fab634c171394422d0ee8baf94"></a><!-- doxytag: member="api.h::byte" ref="ab8ef12fab634c171394422d0ee8baf94" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef uint8_t <a class="el" href="api_8h.html#ab8ef12fab634c171394422d0ee8baf94">byte</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ad7f749722d705466d6db175d0e1c2df6"></a><!-- doxytag: member="api.h::jbyte" ref="ad7f749722d705466d6db175d0e1c2df6" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int8_t <a class="el" href="api_8h.html#ad7f749722d705466d6db175d0e1c2df6">jbyte</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af15c8b821f6a554997c2fa4893c31951"></a><!-- doxytag: member="api.h::jchar" ref="af15c8b821f6a554997c2fa4893c31951" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef uint16_t <a class="el" href="api_8h.html#af15c8b821f6a554997c2fa4893c31951">jchar</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a4dbf307878725eebfb852c2800a951fa"></a><!-- doxytag: member="api.h::jdouble" ref="a4dbf307878725eebfb852c2800a951fa" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef double <a class="el" href="api_8h.html#a4dbf307878725eebfb852c2800a951fa">jdouble</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a5d393cee6f500e76ac60e7e29279bf17"></a><!-- doxytag: member="api.h::jfloat" ref="a5d393cee6f500e76ac60e7e29279bf17" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef float <a class="el" href="api_8h.html#a5d393cee6f500e76ac60e7e29279bf17">jfloat</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a36d2d2d6848d7f576b7f8875f95efd1e"></a><!-- doxytag: member="api.h::jint" ref="a36d2d2d6848d7f576b7f8875f95efd1e" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int32_t <a class="el" href="api_8h.html#a36d2d2d6848d7f576b7f8875f95efd1e">jint</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a6c3e7e2cbf647998ac1eb3dd10890d37"></a><!-- doxytag: member="api.h::jlong" ref="a6c3e7e2cbf647998ac1eb3dd10890d37" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int64_t <a class="el" href="api_8h.html#a6c3e7e2cbf647998ac1eb3dd10890d37">jlong</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a8436c228414d8b882086f54981175525"></a><!-- doxytag: member="api.h::jshort" ref="a8436c228414d8b882086f54981175525" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef int16_t <a class="el" href="api_8h.html#a8436c228414d8b882086f54981175525">jshort</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="ae200b19ced3c771d1198b7b4610f0116"></a><!-- doxytag: member="api.h::mphw" ref="ae200b19ced3c771d1198b7b4610f0116" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef uint16_t <a class="el" href="api_8h.html#ae200b19ced3c771d1198b7b4610f0116">mphw</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="af807108d471a7c68e58df13068048e03"></a><!-- doxytag: member="api.h::mpw" ref="af807108d471a7c68e58df13068048e03" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">typedef uint32_t <a class="el" href="api_8h.html#af807108d471a7c68e58df13068048e03">mpw</a></td> </tr> </table> </div> <div class="memdoc"> </div> </div> </div> <hr class="footer"/><address class="footer"><small>Generated on Sun Apr 10 2011 20:49:30 for BeeCrypt by  <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.3 </small></address> </body> </html>