aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2025-12-16 19:24:40 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
a56b6d83fcc1a1ba9e1bd15fd6f9a5d047034e7b
libaaruformat/docs/html/endian_8h.html

191 lines
9.5 KiB
HTML
Raw Normal View History

Add doxygen documentation
2025-10-11 01:35:43 +01:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.14.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>libaaruformat: include/aaruformat/endian.h File 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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">libaaruformat<span id="projectnumber">&#160;1.0</span>
</div>
<div id="projectbrief">Aaru Data Preservation Suite - Format Library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.14.0 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search/",'.html');
</script>
<script type="text/javascript">
$(function() { codefold.init(); });
</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',true);
$(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(function(){initNavTree('endian_8h.html','',''); });
</script>
<div id="container">
<div id="doc-content">
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="headertitle"><div class="title">endian.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="endian_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-define-members" class="groupheader"><a id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ad409605fabe125b1d222acb94a3f480f" id="r_ad409605fabe125b1d222acb94a3f480f"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ad409605fabe125b1d222acb94a3f480f">bswap_16</a>(x)</td></tr>
<tr class="memitem:a5bcbf8b6ee067af4c2fd60ef3bdb39d2" id="r_a5bcbf8b6ee067af4c2fd60ef3bdb39d2"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a5bcbf8b6ee067af4c2fd60ef3bdb39d2">bswap_32</a>(x)</td></tr>
<tr class="memitem:a0c0b427a2547aa727e2c5262a174e26b" id="r_a0c0b427a2547aa727e2c5262a174e26b"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a0c0b427a2547aa727e2c5262a174e26b">bswap_64</a>(x)</td></tr>
</table>
<a name="doc-define-members" id="doc-define-members"></a><h2 id="header-doc-define-members" class="groupheader">Macro Definition Documentation</h2>
<a id="ad409605fabe125b1d222acb94a3f480f" name="ad409605fabe125b1d222acb94a3f480f"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad409605fabe125b1d222acb94a3f480f">&#9670;&#160;</a></span>bswap_16</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bswap_16</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line">((uint16_t)((((uint16_t)(x) &amp; 0xff00) &gt;&gt; 8) | (((uint16_t)(x) &amp; 0x00ff) &lt;&lt; 8)))</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="endian_8h_source.html#l00077">77</a> of file <a class="el" href="endian_8h_source.html">endian.h</a>.</p>
</div>
</div>
<a id="a5bcbf8b6ee067af4c2fd60ef3bdb39d2" name="a5bcbf8b6ee067af4c2fd60ef3bdb39d2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a5bcbf8b6ee067af4c2fd60ef3bdb39d2">&#9670;&#160;</a></span>bswap_32</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bswap_32</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ((uint32_t)((((uint32_t)(x) &amp; 0xff000000) &gt;&gt; 24) | (((uint32_t)(x) &amp; 0x00ff0000) &gt;&gt; 8) | \</div>
<div class="line"> (((uint32_t)(x) &amp; 0x0000ff00) &lt;&lt; 8) | (((uint32_t)(x) &amp; 0x000000ff) &lt;&lt; 24)))</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="endian_8h_source.html#l00078">78</a> of file <a class="el" href="endian_8h_source.html">endian.h</a>.</p>
</div>
</div>
<a id="a0c0b427a2547aa727e2c5262a174e26b" name="a0c0b427a2547aa727e2c5262a174e26b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a0c0b427a2547aa727e2c5262a174e26b">&#9670;&#160;</a></span>bswap_64</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define bswap_64</td>
<td>(</td>
<td class="paramtype"></td> <td class="paramname"><span class="paramname"><em>x</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<b>Value:</b><div class="fragment"><div class="line"> ((uint64_t)((((uint64_t)(x) &amp; 0xff00000000000000ULL) &gt;&gt; 56) | (((uint64_t)(x) &amp; 0x00ff000000000000ULL) &gt;&gt; 40) | \</div>
<div class="line"> (((uint64_t)(x) &amp; 0x0000ff0000000000ULL) &gt;&gt; 24) | (((uint64_t)(x) &amp; 0x000000ff00000000ULL) &gt;&gt; 8) | \</div>
<div class="line"> (((uint64_t)(x) &amp; 0x00000000ff000000ULL) &lt;&lt; 8) | (((uint64_t)(x) &amp; 0x0000000000ff0000ULL) &lt;&lt; 24) | \</div>
<div class="line"> (((uint64_t)(x) &amp; 0x000000000000ff00ULL) &lt;&lt; 40) | (((uint64_t)(x) &amp; 0x00000000000000ffULL) &lt;&lt; 56)))</div>
</div><!-- fragment -->
<p class="definition">Definition at line <a class="el" href="endian_8h_source.html#l00081">81</a> of file <a class="el" href="endian_8h_source.html">endian.h</a>.</p>
Update documentation.
2025-10-21 14:23:35 +01:00
<p class="reference">Referenced by <a class="el" href="verify_8c_source.html#l00130">aaruf_verify_image()</a>, <a class="el" href="data_8c_source.html#l00071">process_data_block()</a>, <a class="el" href="blocks_2dump_8c_source.html#l00107">process_dumphw_block()</a>, <a class="el" href="optical_8c_source.html#l00111">process_tracks_block()</a>, <a class="el" href="index__v1_8c_source.html#l00225">verify_index_v1()</a>, <a class="el" href="index__v2_8c_source.html#l00227">verify_index_v2()</a>, and <a class="el" href="index__v3_8c_source.html#l00408">verify_index_v3()</a>.</p>
Add doxygen documentation
2025-10-11 01:35:43 +01:00
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="page-nav" class="page-nav-panel">
<div id="page-nav-resize-handle"></div>
<div id="page-nav-tree">
<div id="page-nav-contents">
</div><!-- page-nav-contents -->
</div><!-- page-nav-tree -->
</div><!-- page-nav -->
</div><!-- container -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a href="dir_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a href="dir_aeff2545c9dfcfc842fe9d84b123cb31.html">aaruformat</a></li><li class="navelem"><a href="endian_8h.html">endian.h</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.14.0 </li>
</ul>
</div>
</body>
</html>
Reference in New Issue Copy Permalink