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

Update doxygen documentation.

Browse Source
This commit is contained in:
Natalia Portillo
2025-12-12 12:25:02 +00:00
parent 03c091fdee
commit 2daf7a6a48
172 changed files with 12502 additions and 10684 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/html/internal_8h_source.html
View File

@@ -160,7 +160,7 @@ $(function(){initNavTree('internal_8h_source.html','',''); });
<div class="ttc" id="ainternal_8h_html_a1906cbcaef9f44b8ac4360beb70a0120"><div class="ttname"><a href="internal_8h.html#a1906cbcaef9f44b8ac4360beb70a0120">set_ddt_entry_v2</a></div><div class="ttdeci">bool set_ddt_entry_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l00988">ddt_v2.c:988</a></div></div>
<div class="ttc" id="ainternal_8h_html_a1baad6508d1cde5a712794e956fb3d3c"><div class="ttname"><a href="internal_8h.html#a1baad6508d1cde5a712794e956fb3d3c">process_index_v2</a></div><div class="ttdeci">UT_array * process_index_v2(aaruformat_context *ctx)</div><div class="ttdoc">Processes an index block (version 2) from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v2_8c_source.html#l00081">index_v2.c:81</a></div></div>
<div class="ttc" id="ainternal_8h_html_a1caeae710ee5e1dd356e43b3b659e9c0"><div class="ttname"><a href="internal_8h.html#a1caeae710ee5e1dd356e43b3b659e9c0">process_ddt_v2</a></div><div class="ttdeci">int32_t process_ddt_v2(aaruformat_context *ctx, IndexEntry *entry, bool *found_user_data_ddt)</div><div class="ttdoc">Processes a DDT v2 block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l00096">ddt_v2.c:96</a></div></div>
<div class="ttc" id="ainternal_8h_html_a2402812f5e04ba16765208c0b70fa6c5"><div class="ttname"><a href="internal_8h.html#a2402812f5e04ba16765208c0b70fa6c5">aaruf_close_current_block</a></div><div class="ttdeci">int32_t aaruf_close_current_block(aaruformat_context *ctx)</div><div class="ttdoc">Finalizes and writes the current data block to the AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l01403">write.c:1403</a></div></div>
<div class="ttc" id="ainternal_8h_html_a2402812f5e04ba16765208c0b70fa6c5"><div class="ttname"><a href="internal_8h.html#a2402812f5e04ba16765208c0b70fa6c5">aaruf_close_current_block</a></div><div class="ttdeci">int32_t aaruf_close_current_block(aaruformat_context *ctx)</div><div class="ttdoc">Finalizes and writes the current data block to the AaruFormat image file.</div><div class="ttdef"><b>Definition</b> <a href="write_8c_source.html#l01427">write.c:1427</a></div></div>
<div class="ttc" id="ainternal_8h_html_a26e5fd58cdfd39948f1b724fafffcdc2"><div class="ttname"><a href="internal_8h.html#a26e5fd58cdfd39948f1b724fafffcdc2">decode_ddt_entry_v1</a></div><div class="ttdeci">int32_t decode_ddt_entry_v1(aaruformat_context *ctx, uint64_t sector_address, uint64_t *offset, uint64_t *block_offset, uint8_t *sector_status)</div><div class="ttdoc">Decodes a DDT v1 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v1_8c_source.html#l00405">ddt_v1.c:405</a></div></div>
<div class="ttc" id="ainternal_8h_html_a28d844a06cecbbf436d825a3c99ff0eb"><div class="ttname"><a href="internal_8h.html#a28d844a06cecbbf436d825a3c99ff0eb">process_data_block</a></div><div class="ttdeci">int32_t process_data_block(aaruformat_context *ctx, IndexEntry *entry)</div><div class="ttdoc">Processes a data block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="data_8c_source.html#l00071">data.c:71</a></div></div>
<div class="ttc" id="ainternal_8h_html_a36c1cca0e4cea9c2e0dffb582b836f6f"><div class="ttname"><a href="internal_8h.html#a36c1cca0e4cea9c2e0dffb582b836f6f">get_filetime_uint64</a></div><div class="ttdeci">uint64_t get_filetime_uint64()</div><div class="ttdoc">Gets the current time as a 64-bit FILETIME value.</div><div class="ttdef"><b>Definition</b> <a href="time_8c_source.html#l00045">time.c:45</a></div></div>
@@ -169,18 +169,18 @@ $(function(){initNavTree('internal_8h_source.html','',''); });
<div class="ttc" id="ainternal_8h_html_a43974d4c183240be30d49ff09ef7b8c2"><div class="ttname"><a href="internal_8h.html#a43974d4c183240be30d49ff09ef7b8c2">process_metadata_block</a></div><div class="ttdeci">void process_metadata_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00035">metadata.c:35</a></div></div>
<div class="ttc" id="ainternal_8h_html_a565eace88f86c500249be1f2a89a1c60"><div class="ttname"><a href="internal_8h.html#a565eace88f86c500249be1f2a89a1c60">process_checksum_block</a></div><div class="ttdeci">void process_checksum_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a checksum block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="checksum_8c_source.html#l00039">checksum.c:39</a></div></div>
<div class="ttc" id="ainternal_8h_html_a5d3b1092abc36a27a441a01a8a0b3b48"><div class="ttname"><a href="internal_8h.html#a5d3b1092abc36a27a441a01a8a0b3b48">process_index_v1</a></div><div class="ttdeci">UT_array * process_index_v1(aaruformat_context *ctx)</div><div class="ttdoc">Processes an index block (version 1) from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v1_8c_source.html#l00079">index_v1.c:79</a></div></div>
<div class="ttc" id="ainternal_8h_html_a5e0397faed8aea27c5a6a3881875de54"><div class="ttname"><a href="internal_8h.html#a5e0397faed8aea27c5a6a3881875de54">process_cicm_block</a></div><div class="ttdeci">void process_cicm_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a CICM XML metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00306">metadata.c:306</a></div></div>
<div class="ttc" id="ainternal_8h_html_a69ff2e68fe4d92a2d2d469ac69f41d82"><div class="ttname"><a href="internal_8h.html#a69ff2e68fe4d92a2d2d469ac69f41d82">set_ddt_multi_level_v2</a></div><div class="ttdeci">bool set_ddt_multi_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a multi-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01092">ddt_v2.c:1092</a></div></div>
<div class="ttc" id="ainternal_8h_html_a7471ae33a70bae7e3aa93a52f8e519ca"><div class="ttname"><a href="internal_8h.html#a7471ae33a70bae7e3aa93a52f8e519ca">set_ddt_single_level_v2</a></div><div class="ttdeci">bool set_ddt_single_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a single-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01023">ddt_v2.c:1023</a></div></div>
<div class="ttc" id="ainternal_8h_html_a5e0397faed8aea27c5a6a3881875de54"><div class="ttname"><a href="internal_8h.html#a5e0397faed8aea27c5a6a3881875de54">process_cicm_block</a></div><div class="ttdeci">void process_cicm_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a CICM XML metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00311">metadata.c:311</a></div></div>
<div class="ttc" id="ainternal_8h_html_a69ff2e68fe4d92a2d2d469ac69f41d82"><div class="ttname"><a href="internal_8h.html#a69ff2e68fe4d92a2d2d469ac69f41d82">set_ddt_multi_level_v2</a></div><div class="ttdeci">bool set_ddt_multi_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a multi-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01096">ddt_v2.c:1096</a></div></div>
<div class="ttc" id="ainternal_8h_html_a7471ae33a70bae7e3aa93a52f8e519ca"><div class="ttname"><a href="internal_8h.html#a7471ae33a70bae7e3aa93a52f8e519ca">set_ddt_single_level_v2</a></div><div class="ttdeci">bool set_ddt_single_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a single-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01024">ddt_v2.c:1024</a></div></div>
<div class="ttc" id="ainternal_8h_html_a7db9f44b931877b306de9cf7cd1deed2"><div class="ttname"><a href="internal_8h.html#a7db9f44b931877b306de9cf7cd1deed2">generate_random_bytes</a></div><div class="ttdeci">void generate_random_bytes(uint8_t *buffer, size_t length)</div><div class="ttdoc">Generates cryptographically strong random bytes.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00480">helpers.c:480</a></div></div>
<div class="ttc" id="ainternal_8h_html_a805d607b45bb8ad8a3e6b0bcfabe3265"><div class="ttname"><a href="internal_8h.html#a805d607b45bb8ad8a3e6b0bcfabe3265">decode_ddt_entry_v2</a></div><div class="ttdeci">int32_t decode_ddt_entry_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t *offset, uint64_t *block_offset, uint8_t *sector_status)</div><div class="ttdoc">Decodes a DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l00507">ddt_v2.c:507</a></div></div>
<div class="ttc" id="ainternal_8h_html_a81d410de6727d95a85b827067e1a8bc6"><div class="ttname"><a href="internal_8h.html#a81d410de6727d95a85b827067e1a8bc6">process_geometry_block</a></div><div class="ttdeci">void process_geometry_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a logical geometry block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00246">metadata.c:246</a></div></div>
<div class="ttc" id="ainternal_8h_html_a8241636367dc185ee88d1dc5af9caf59"><div class="ttname"><a href="internal_8h.html#a8241636367dc185ee88d1dc5af9caf59">set_ddt_tape</a></div><div class="ttdeci">bool set_ddt_tape(aaruformat_context *ctx, uint64_t sector_address, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a DDT entry for tape media using a hash-based lookup table.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01768">ddt_v2.c:1768</a></div></div>
<div class="ttc" id="ainternal_8h_html_a81d410de6727d95a85b827067e1a8bc6"><div class="ttname"><a href="internal_8h.html#a81d410de6727d95a85b827067e1a8bc6">process_geometry_block</a></div><div class="ttdeci">void process_geometry_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a logical geometry block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00251">metadata.c:251</a></div></div>
<div class="ttc" id="ainternal_8h_html_a8241636367dc185ee88d1dc5af9caf59"><div class="ttname"><a href="internal_8h.html#a8241636367dc185ee88d1dc5af9caf59">set_ddt_tape</a></div><div class="ttdeci">bool set_ddt_tape(aaruformat_context *ctx, uint64_t sector_address, uint64_t offset, uint64_t block_offset, uint8_t sector_status, uint64_t *ddt_entry)</div><div class="ttdoc">Sets a DDT entry for tape media using a hash-based lookup table.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l01782">ddt_v2.c:1782</a></div></div>
<div class="ttc" id="ainternal_8h_html_a829bbac3c17b60efd8f93188a8de8278"><div class="ttname"><a href="internal_8h.html#a829bbac3c17b60efd8f93188a8de8278">process_tape_files_block</a></div><div class="ttdeci">void process_tape_files_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a tape file metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="tape_8c_source.html#l00126">tape.c:126</a></div></div>
<div class="ttc" id="ainternal_8h_html_a83aff4d408ab17f8f350cb03b0e12ef6"><div class="ttname"><a href="internal_8h.html#a83aff4d408ab17f8f350cb03b0e12ef6">decode_ddt_multi_level_v2</a></div><div class="ttdeci">int32_t decode_ddt_multi_level_v2(aaruformat_context *ctx, uint64_t sector_address, bool negative, uint64_t *offset, uint64_t *block_offset, uint8_t *sector_status)</div><div class="ttdoc">Decodes a multi-level DDT v2 entry for a given sector address.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v2_8c_source.html#l00724">ddt_v2.c:724</a></div></div>
<div class="ttc" id="ainternal_8h_html_a84003ec881425a7b28ec24cb48d19f02"><div class="ttname"><a href="internal_8h.html#a84003ec881425a7b28ec24cb48d19f02">process_aaru_metadata_json_block</a></div><div class="ttdeci">void process_aaru_metadata_json_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes an Aaru metadata JSON block from the image stream during image opening.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00470">metadata.c:470</a></div></div>
<div class="ttc" id="ainternal_8h_html_a84003ec881425a7b28ec24cb48d19f02"><div class="ttname"><a href="internal_8h.html#a84003ec881425a7b28ec24cb48d19f02">process_aaru_metadata_json_block</a></div><div class="ttdeci">void process_aaru_metadata_json_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes an Aaru metadata JSON block from the image stream during image opening.</div><div class="ttdef"><b>Definition</b> <a href="blocks_2metadata_8c_source.html#l00475">metadata.c:475</a></div></div>
<div class="ttc" id="ainternal_8h_html_a89ed93d216c4dce0ae5e2acccf8cc2b4"><div class="ttname"><a href="internal_8h.html#a89ed93d216c4dce0ae5e2acccf8cc2b4">verify_index_v1</a></div><div class="ttdeci">int32_t verify_index_v1(aaruformat_context *ctx)</div><div class="ttdoc">Verifies the integrity of an index block (version 1) in the image stream.</div><div class="ttdef"><b>Definition</b> <a href="index__v1_8c_source.html#l00225">index_v1.c:225</a></div></div>
<div class="ttc" id="ainternal_8h_html_aa76718b0402b1a28be3d563d5e62028e"><div class="ttname"><a href="internal_8h.html#aa76718b0402b1a28be3d563d5e62028e">process_tape_partitions_block</a></div><div class="ttdeci">void process_tape_partitions_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a tape partition metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="tape_8c_source.html#l00346">tape.c:346</a></div></div>
<div class="ttc" id="ainternal_8h_html_aa76718b0402b1a28be3d563d5e62028e"><div class="ttname"><a href="internal_8h.html#aa76718b0402b1a28be3d563d5e62028e">process_tape_partitions_block</a></div><div class="ttdeci">void process_tape_partitions_block(aaruformat_context *ctx, const IndexEntry *entry)</div><div class="ttdoc">Processes a tape partition metadata block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="tape_8c_source.html#l00347">tape.c:347</a></div></div>
<div class="ttc" id="ainternal_8h_html_aaae42bff244df727b6c029f58d4957df"><div class="ttname"><a href="internal_8h.html#aaae42bff244df727b6c029f58d4957df">parse_options</a></div><div class="ttdeci">aaru_options parse_options(const char *options)</div><div class="ttdoc">Parses the options string for AaruFormat image creation/opening.</div><div class="ttdef"><b>Definition</b> <a href="options_8c_source.html#l00038">options.c:38</a></div></div>
<div class="ttc" id="ainternal_8h_html_abaf38090f967423898b99e0455751c07"><div class="ttname"><a href="internal_8h.html#abaf38090f967423898b99e0455751c07">process_ddt_v1</a></div><div class="ttdeci">int32_t process_ddt_v1(aaruformat_context *ctx, IndexEntry *entry, bool *found_user_data_ddt)</div><div class="ttdoc">Processes a DDT v1 block from the image stream.</div><div class="ttdef"><b>Definition</b> <a href="ddt__v1_8c_source.html#l00085">ddt_v1.c:85</a></div></div>
<div class="ttc" id="ainternal_8h_html_ac93ebc6d918745be56b680e19bf7e8d5"><div class="ttname"><a href="internal_8h.html#ac93ebc6d918745be56b680e19bf7e8d5">compare_extents</a></div><div class="ttdeci">int compare_extents(const void *a, const void *b)</div><div class="ttdoc">Comparison function for sorting DumpExtent arrays by start sector.</div><div class="ttdef"><b>Definition</b> <a href="helpers_8c_source.html#l00459">helpers.c:459</a></div></div>