aaru-dps/libaaruformat
1
0
Fork 0
mirror of https://github.com/aaru-dps/libaaruformat.git synced 2026-09-17 20:34:18 +00:00
Code Issues 3 Packages Projects Releases Wiki Activity

Update doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-12-31 10:59:13 +00:00
parent 48259087f8
commit e962e3443e
467 changed files with 14662 additions and 13929 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
docs/html/header_8h_source.html
View File

@@ -150,33 +150,31 @@ $(function(){initNavTree('header_8h_source.html','',''); });
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3"> 117</a></span> int64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3">lastWrittenTime</a>; </div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a69ff1a1dbdaf0501e6488451b7270b51"> 118</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a69ff1a1dbdaf0501e6488451b7270b51">guid</a>[<a class="code hl_define" href="header_8h.html#a57c99b24137b82f12950e79ffbd2fb7a">GUID_SIZE</a>]; </div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#ac55c9959435ff7b62a72ec8243ebe1c8"> 119</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#ac55c9959435ff7b62a72ec8243ebe1c8">blockAlignmentShift</a>; </div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a520d6f22b18a42fee0c6d72fbe3e064d"> 120</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a520d6f22b18a42fee0c6d72fbe3e064d">dataShift</a>; </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a35c4fa9c7e21cdea332efdb34383abad"> 121</a></span> uint8_t <a class="code hl_variable" href="structAaruHeaderV2.html#a35c4fa9c7e21cdea332efdb34383abad">tableShift</a>; </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03"> 122</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03">featureCompatible</a>; </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444"> 123</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444">featureCompatibleRo</a>; </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a"> 124</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a">featureIncompatible</a>; </div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="header_8h.html#a369effc2c0aea490cf0309c686ce54c6"> 125</a></span>} <a class="code hl_struct" href="structAaruHeaderV2.html">AaruHeaderV2</a>;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#abc1b56bbb9310ea37e1c73b4e5bbf8bc"> 120</a></span> uint16_t <a class="code hl_variable" href="structAaruHeaderV2.html#abc1b56bbb9310ea37e1c73b4e5bbf8bc">biggestSectorSize</a>; </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03"> 121</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03">featureCompatible</a>; </div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444"> 122</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444">featureCompatibleRo</a>; </div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno"><a class="line" href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a"> 123</a></span> uint64_t <a class="code hl_variable" href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a">featureIncompatible</a>; </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno"><a class="line" href="header_8h.html#a369effc2c0aea490cf0309c686ce54c6"> 124</a></span>} <a class="code hl_struct" href="structAaruHeaderV2.html">AaruHeaderV2</a>;</div>
</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span> </div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno"> 129</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_HEADER_H</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"> 125</span> </div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno"> 126</span><span class="preprocessor">#pragma pack(pop)</span></div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno"> 127</span> </div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"> 128</span><span class="preprocessor">#endif </span><span class="comment">// LIBAARUFORMAT_HEADER_H</span></div>
<div class="ttc" id="aheader_8h_html_a57c99b24137b82f12950e79ffbd2fb7a"><div class="ttname"><a href="header_8h.html#a57c99b24137b82f12950e79ffbd2fb7a">GUID_SIZE</a></div><div class="ttdeci">#define GUID_SIZE</div><div class="ttdoc">Size in bytes of GUID / UUID-like binary identifier.</div><div class="ttdef"><b>Definition</b> <a href="#l00060">header.h:60</a></div></div>
<div class="ttc" id="aheader_8h_html_ab17964dacc36dca03ec5e75aa40a4502"><div class="ttname"><a href="header_8h.html#ab17964dacc36dca03ec5e75aa40a4502">AARU_HEADER_APP_NAME_LEN</a></div><div class="ttdeci">#define AARU_HEADER_APP_NAME_LEN</div><div class="ttdoc">Size in bytes (UTF-16LE) of application name field (32 UTF-16 code units).</div><div class="ttdef"><b>Definition</b> <a href="#l00059">header.h:59</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html"><div class="ttname"><a href="structAaruHeaderV2.html">AaruHeaderV2</a></div><div class="ttdoc">Version 2 container header with GUID, alignment shifts, and feature negotiation bitmaps.</div><div class="ttdef"><b>Definition</b> <a href="#l00106">header.h:107</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a0afcf9a5f565a9053351f44234c90dc3"><div class="ttname"><a href="structAaruHeaderV2.html#a0afcf9a5f565a9053351f44234c90dc3">AaruHeaderV2::application</a></div><div class="ttdeci">uint8_t application[64]</div><div class="ttdoc">UTF-8 creator application name (fixed 64 bytes).</div><div class="ttdef"><b>Definition</b> <a href="#l00109">header.h:109</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a1c26feafd945328f8f1854b523a0f03c"><div class="ttname"><a href="structAaruHeaderV2.html#a1c26feafd945328f8f1854b523a0f03c">AaruHeaderV2::applicationMajorVersion</a></div><div class="ttdeci">uint8_t applicationMajorVersion</div><div class="ttdoc">Creator application major version.</div><div class="ttdef"><b>Definition</b> <a href="#l00112">header.h:112</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a27af1bfabbc7650471a6010475116697"><div class="ttname"><a href="structAaruHeaderV2.html#a27af1bfabbc7650471a6010475116697">AaruHeaderV2::identifier</a></div><div class="ttdeci">uint64_t identifier</div><div class="ttdoc">File magic (AARU_MAGIC).</div><div class="ttdef"><b>Definition</b> <a href="#l00108">header.h:108</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a35c4fa9c7e21cdea332efdb34383abad"><div class="ttname"><a href="structAaruHeaderV2.html#a35c4fa9c7e21cdea332efdb34383abad">AaruHeaderV2::tableShift</a></div><div class="ttdeci">uint8_t tableShift</div><div class="ttdoc">log2 sectors spanned by each primary DDT entry (0 = single-level).</div><div class="ttdef"><b>Definition</b> <a href="#l00121">header.h:121</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a3a3a71ed3c7d48791a450b822c05ea2a"><div class="ttname"><a href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a">AaruHeaderV2::featureIncompatible</a></div><div class="ttdeci">uint64_t featureIncompatible</div><div class="ttdoc">Feature bits: any unimplemented -&gt; abort (cannot open safely).</div><div class="ttdef"><b>Definition</b> <a href="#l00124">header.h:124</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a3a3a71ed3c7d48791a450b822c05ea2a"><div class="ttname"><a href="structAaruHeaderV2.html#a3a3a71ed3c7d48791a450b822c05ea2a">AaruHeaderV2::featureIncompatible</a></div><div class="ttdeci">uint64_t featureIncompatible</div><div class="ttdoc">Feature bits: any unimplemented -&gt; abort (cannot open safely).</div><div class="ttdef"><b>Definition</b> <a href="#l00123">header.h:123</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a45bc7e2afc9008ce6f4ae1dba93bdac3"><div class="ttname"><a href="structAaruHeaderV2.html#a45bc7e2afc9008ce6f4ae1dba93bdac3">AaruHeaderV2::lastWrittenTime</a></div><div class="ttdeci">int64_t lastWrittenTime</div><div class="ttdoc">Last modification FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="#l00117">header.h:117</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a4c3f5ccfe34123e402d1b7641d0d6c03"><div class="ttname"><a href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03">AaruHeaderV2::featureCompatible</a></div><div class="ttdeci">uint64_t featureCompatible</div><div class="ttdoc">Feature bits: unimplemented bits are ignorable (still R/W safe).</div><div class="ttdef"><b>Definition</b> <a href="#l00122">header.h:122</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a4c3f5ccfe34123e402d1b7641d0d6c03"><div class="ttname"><a href="structAaruHeaderV2.html#a4c3f5ccfe34123e402d1b7641d0d6c03">AaruHeaderV2::featureCompatible</a></div><div class="ttdeci">uint64_t featureCompatible</div><div class="ttdoc">Feature bits: unimplemented bits are ignorable (still R/W safe).</div><div class="ttdef"><b>Definition</b> <a href="#l00121">header.h:121</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a4ec4b1d593f5a0af19f6d7b8eaeada40"><div class="ttname"><a href="structAaruHeaderV2.html#a4ec4b1d593f5a0af19f6d7b8eaeada40">AaruHeaderV2::indexOffset</a></div><div class="ttdeci">uint64_t indexOffset</div><div class="ttdoc">Absolute byte offset to primary index block (MUST be &gt; 0; 0 =&gt; corrupt/unreadable).</div><div class="ttdef"><b>Definition</b> <a href="#l00115">header.h:115</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a520d6f22b18a42fee0c6d72fbe3e064d"><div class="ttname"><a href="structAaruHeaderV2.html#a520d6f22b18a42fee0c6d72fbe3e064d">AaruHeaderV2::dataShift</a></div><div class="ttdeci">uint8_t dataShift</div><div class="ttdoc">log2 sectors/items per block-index increment in DDT entries (2^dataShift).</div><div class="ttdef"><b>Definition</b> <a href="#l00120">header.h:120</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a5ae79accbb8ba2762d01a63ad334ee60"><div class="ttname"><a href="structAaruHeaderV2.html#a5ae79accbb8ba2762d01a63ad334ee60">AaruHeaderV2::applicationMinorVersion</a></div><div class="ttdeci">uint8_t applicationMinorVersion</div><div class="ttdoc">Creator application minor / patch version.</div><div class="ttdef"><b>Definition</b> <a href="#l00113">header.h:113</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a69ff1a1dbdaf0501e6488451b7270b51"><div class="ttname"><a href="structAaruHeaderV2.html#a69ff1a1dbdaf0501e6488451b7270b51">AaruHeaderV2::guid</a></div><div class="ttdeci">uint8_t guid[16]</div><div class="ttdoc">128-bit image GUID (binary, not text); stable across children.</div><div class="ttdef"><b>Definition</b> <a href="#l00118">header.h:118</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a81b114ab2b1fa786f64e9e914af3ba27"><div class="ttname"><a href="structAaruHeaderV2.html#a81b114ab2b1fa786f64e9e914af3ba27">AaruHeaderV2::mediaType</a></div><div class="ttdeci">uint32_t mediaType</div><div class="ttdoc">Media type enumeration (value from MediaType).</div><div class="ttdef"><b>Definition</b> <a href="#l00114">header.h:114</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a9dae72bee3d161760dbbe389e4a70444"><div class="ttname"><a href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444">AaruHeaderV2::featureCompatibleRo</a></div><div class="ttdeci">uint64_t featureCompatibleRo</div><div class="ttdoc">Feature bits: unimplemented -&gt; degrade to read-only access.</div><div class="ttdef"><b>Definition</b> <a href="#l00123">header.h:123</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_a9dae72bee3d161760dbbe389e4a70444"><div class="ttname"><a href="structAaruHeaderV2.html#a9dae72bee3d161760dbbe389e4a70444">AaruHeaderV2::featureCompatibleRo</a></div><div class="ttdeci">uint64_t featureCompatibleRo</div><div class="ttdoc">Feature bits: unimplemented -&gt; degrade to read-only access.</div><div class="ttdef"><b>Definition</b> <a href="#l00122">header.h:122</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_abc1b56bbb9310ea37e1c73b4e5bbf8bc"><div class="ttname"><a href="structAaruHeaderV2.html#abc1b56bbb9310ea37e1c73b4e5bbf8bc">AaruHeaderV2::biggestSectorSize</a></div><div class="ttdeci">uint16_t biggestSectorSize</div><div class="ttdoc">size of biggest sector in the image (in bytes).</div><div class="ttdef"><b>Definition</b> <a href="#l00120">header.h:120</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_ac55c9959435ff7b62a72ec8243ebe1c8"><div class="ttname"><a href="structAaruHeaderV2.html#ac55c9959435ff7b62a72ec8243ebe1c8">AaruHeaderV2::blockAlignmentShift</a></div><div class="ttdeci">uint8_t blockAlignmentShift</div><div class="ttdoc">log2 block alignment (block size alignment = 2^blockAlignmentShift bytes).</div><div class="ttdef"><b>Definition</b> <a href="#l00119">header.h:119</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_ae2d6d3c7bc0a1956fb246cf7acbddeeb"><div class="ttname"><a href="structAaruHeaderV2.html#ae2d6d3c7bc0a1956fb246cf7acbddeeb">AaruHeaderV2::imageMinorVersion</a></div><div class="ttdeci">uint8_t imageMinorVersion</div><div class="ttdoc">Container format minor version.</div><div class="ttdef"><b>Definition</b> <a href="#l00111">header.h:111</a></div></div>
<div class="ttc" id="astructAaruHeaderV2_html_ae849dae5af5cf31b1b815ef67b3c621f"><div class="ttname"><a href="structAaruHeaderV2.html#ae849dae5af5cf31b1b815ef67b3c621f">AaruHeaderV2::creationTime</a></div><div class="ttdeci">int64_t creationTime</div><div class="ttdoc">Creation FILETIME (100 ns since 1601-01-01 UTC).</div><div class="ttdef"><b>Definition</b> <a href="#l00116">header.h:116</a></div></div>