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

Add doxygen documentation

Browse Source
This commit is contained in:
Natalia Portillo
2025-10-11 01:35:43 +01:00
parent 61850a9520
commit 697b755b1e
646 changed files with 124953 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

179
docs/html/data_8h.html Normal file
View File

@@ -0,0 +1,179 @@
<!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/structs/data.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('data_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">data.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>On-disk layout structures for data-bearing and geometry blocks.
<a href="#details">More...</a></p>
<div class="textblock"><code>#include &lt;stdint.h&gt;</code><br />
</div>
<p><a href="data_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-nested-classes" class="groupheader"><a id="nested-classes" name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:BlockHeader" id="r_BlockHeader"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structBlockHeader.html">BlockHeader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Header preceding the compressed data payload of a data block (BlockType::DataBlock). <a href="structBlockHeader.html#details">More...</a><br /></td></tr>
<tr class="memitem:GeometryBlockHeader" id="r_GeometryBlockHeader"><td class="memItemLeft" align="right" valign="top">struct &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structGeometryBlockHeader.html">GeometryBlockHeader</a></td></tr>
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Legacy CHS style logical geometry metadata (BlockType::GeometryBlock). <a href="structGeometryBlockHeader.html#details">More...</a><br /></td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 id="header-typedef-members" class="groupheader"><a id="typedef-members" name="typedef-members"></a>
Typedefs</h2></td></tr>
<tr class="memitem:a1ca609714b5efe0b8571c14c51fd4609" id="r_a1ca609714b5efe0b8571c14c51fd4609"><td class="memItemLeft" align="right" valign="top">typedef struct BlockHeader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a1ca609714b5efe0b8571c14c51fd4609">BlockHeader</a></td></tr>
<tr class="memitem:ac4dce55b0edbc0bfdef3fcc84c63a78d" id="r_ac4dce55b0edbc0bfdef3fcc84c63a78d"><td class="memItemLeft" align="right" valign="top">typedef struct GeometryBlockHeader&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac4dce55b0edbc0bfdef3fcc84c63a78d">GeometryBlockHeader</a></td></tr>
</table>
<a name="details" id="details"></a><h2 id="header-details" class="groupheader">Detailed Description</h2>
<div class="textblock"><p>On-disk layout structures for data-bearing and geometry blocks. </p>
<p>These packed structures describe the headers that precede variable-length payloads inside blocks whose identifiers are enumerated in <a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3">BlockType</a>. All integer fields are stored little-endian on disk. The library currently assumes a little-endian host; if ported to a big-endian architecture explicit byte swapping will be required.</p>
<p>Layout of a data block (BlockType::DataBlock): <a class="el" href="structBlockHeader.html" title="Header preceding the compressed data payload of a data block (BlockType::DataBlock).">BlockHeader</a> (sizeof(BlockHeader) bytes) Compressed payload (cmpLength bytes)</p>
<p>Payload decoding:</p><ul>
<li>Apply the algorithm indicated by <a class="el" href="structBlockHeader.html#ad68963422fd2a5f6d0e0be751cbef559">BlockHeader::compression</a> (<a class="el" href="enums_8h.html#affec749ed88365143745313ae9168263">CompressionType</a>) to the cmpLength bytes following the header to obtain exactly <a class="el" href="structBlockHeader.html#a1f9f3204a10090709b28d0df4bb547e5">BlockHeader::length</a> bytes.</li>
<li>The uncompressed data MUST be an integer multiple of <a class="el" href="structBlockHeader.html#a5bd50f95c8c1f91e5013a1a154690beb">BlockHeader::sectorSize</a>.</li>
<li>A CRC64-ECMA is provided for both compressed (cmpCrc64) and uncompressed (crc64) forms to allow validation at either stage of the pipeline.</li>
</ul>
<p>Geometry block (BlockType::GeometryBlock) has a <a class="el" href="structGeometryBlockHeader.html">GeometryBlockHeader</a> followed by no additional fixed payload in the current format version; it conveys legacy CHS-style logical geometry metadata.</p>
<dl class="section warning"><dt>Warning</dt><dd>These structs are packed; do not take their address and assume natural alignment. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="enums_8h.html#a54420623f26ab6bb61042b41cccf37a3" title="List of known block types contained in an Aaru image.">BlockType</a> </dd>
<dd>
<a class="el" href="enums_8h.html#ad8ed01ff3ff33333d8e19db4d2818bb6" title="List of known data types stored within an Aaru image.">DataType</a> </dd>
<dd>
<a class="el" href="enums_8h.html#affec749ed88365143745313ae9168263" title="List of known compression types.">CompressionType</a> </dd></dl>
<p class="definition">Definition in file <a class="el" href="data_8h_source.html">data.h</a>.</p>
</div><a name="doc-typedef-members" id="doc-typedef-members"></a><h2 id="header-doc-typedef-members" class="groupheader">Typedef Documentation</h2>
<a id="a1ca609714b5efe0b8571c14c51fd4609" name="a1ca609714b5efe0b8571c14c51fd4609"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1ca609714b5efe0b8571c14c51fd4609">&#9670;&#160;</a></span>BlockHeader</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct BlockHeader BlockHeader</td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a id="ac4dce55b0edbc0bfdef3fcc84c63a78d" name="ac4dce55b0edbc0bfdef3fcc84c63a78d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac4dce55b0edbc0bfdef3fcc84c63a78d">&#9670;&#160;</a></span>GeometryBlockHeader</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">typedef struct GeometryBlockHeader GeometryBlockHeader</td>
</tr>
</table>
</div><div class="memdoc">
</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="dir_6387aeb6e475a334d8dc12d69f21999e.html">structs</a></li><li class="navelem"><a href="data_8h.html">data.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>