hfs_btree.hpp

1. Overview

The hfs_btree.hpp file implements generic HFS+ B-tree node parsing and traversal.

This is an interface and data-contract file. It declares the public and internal types used by this subsystem, allowing implementation files and callers to share a stable compile-time contract.

Its paired source or interface file is hfs_btree.cpp.

Primary responsibilities:

  • Read B-tree headers and nodes
  • Decode record offsets and keys
  • Traverse index and leaf nodes
  • Support catalog, extents and attributes trees

2. File Identity and Scope

  • Source path: src/hfs_btree.hpp
  • Language: C++
  • File role: interface and data-contract file
  • Physical lines: 183
  • Non-empty lines: 160
  • SHA-256: 74e4b19828da6045a74251d1c9965d84b0ee802781bcd7e3b5805d232de91c46

Declared namespaces:

  • hfs

3. Dependencies

3.2 Standard and External Headers

  • cstdint
  • functional
  • string
  • vector

These dependencies define the file’s compile-time integration with the recovery engine, GTK interface, on-disk format decoders, operating-system services, or C++ standard library.

4. Declared Types

  • struct NodeDescriptor.
  • struct HeaderRec.
  • struct CatalogKey.

5. Constants and Configuration Values

  • constexpr int8_t kBTLeafNode=-1
  • constexpr int8_t kBTIndexNode=0
  • constexpr int8_t kBTHeaderNode=1
  • constexpr int8_t kBTMapNode=2
  • constexpr uint8_t kHFSCaseFolding=0xCF
  • constexpr uint8_t kHFSBinaryCompare=0xBC
  • constexpr uint8_t kHFSBTreeType=0xFF
  • constexpr uint8_t kUserBTreeType=0x80
  • constexpr uint8_t kReservedBTreeType=0x00
  • constexpr int16_t kHFSPlusFolderRecord=0x0001
  • constexpr int16_t kHFSPlusFileRecord=0x0002
  • constexpr int16_t kHFSPlusFolderThreadRecord=0x0003
  • constexpr int16_t kHFSPlusFileThreadRecord=0x0004

6. Data Members and Persistent State

The interface declares the following state-bearing members:

  • constexpr int8_t kBTLeafNode=-1
  • constexpr int8_t kBTIndexNode=0
  • constexpr int8_t kBTHeaderNode=1
  • constexpr int8_t kBTMapNode=2
  • constexpr uint8_t kHFSCaseFolding=0xCF
  • constexpr uint8_t kHFSBinaryCompare=0xBC
  • constexpr uint8_t kHFSBTreeType=0xFF
  • constexpr uint8_t kUserBTreeType=0x80
  • constexpr uint8_t kReservedBTreeType=0x00
  • uint32_t fLink {0}
  • uint32_t bLink {0}
  • int8_t kind {0}
  • uint8_t height {0}
  • uint16_t numRecords {0}
  • uint16_t treeDepth {0}
  • uint32_t rootNode {0}
  • uint32_t leafRecords {0}
  • uint32_t firstLeafNode {0}
  • uint32_t lastLeafNode {0}
  • uint16_t nodeSize {0}
  • uint16_t maxKeyLength {0}
  • uint32_t totalNodes {0}
  • uint32_t freeNodes {0}
  • uint32_t clumpSize {0}
  • uint8_t btreeType {0}
  • uint8_t keyCompareType {0}
  • uint32_t attributes {0}
  • constexpr int16_t kHFSPlusFolderRecord=0x0001
  • constexpr int16_t kHFSPlusFileRecord=0x0002
  • constexpr int16_t kHFSPlusFolderThreadRecord=0x0003
  • constexpr int16_t kHFSPlusFileThreadRecord=0x0004
  • uint32_t parentID {0}
  • uint16_t nameLength {0}
  • const unsigned char*name_utf16be {nullptr}
  • uint16_t total_key_bytes {0}

These members hold configuration, parser context, UI widgets, source references, progress state, recovered metadata, or temporary resources according to the owning type.

7. API and Function Inventory

The following callable interfaces or definitions were detected:

  • bool parse_node_descriptor(const unsigned char*buf,NodeDescriptor&out) – Reads or derives the requested information and returns or stores the decoded result.
  • bool parse_header_rec(const unsigned char*buf,HeaderRec&out) – Reads or derives the requested information and returns or stores the decoded result.
  • uint16_t node_record_offset(const unsigned char*node_buf,uint16_t nodeSize,uint16_t numRecords,uint16_t i) – Implements the operation identified by this API and updates or returns the associated state.
  • uint16_t node_record_length(const unsigned char*node_buf,uint16_t nodeSize,uint16_t numRecords,uint16_t i) – Implements the operation identified by this API and updates or returns the associated state.
  • bool parse_catalog_key(const unsigned char*key_buf,uint32_t max_bytes,CatalogKey&out) – Reads or derives the requested information and returns or stores the decoded result.
  • uint32_t catalog_record_body_offset(const unsigned char*record_buf,uint32_t record_len) – Implements the operation identified by this API and updates or returns the associated state.
  • bool walk_btree(const HeaderRec&header,const NodeReader&read_node,const LeafRecordCallback&on_leaf,std::vector<std::string>&logs,std::string&error) – Implements the operation identified by this API and updates or returns the associated state.

8. Operational Flow

The subsystem represented by this file normally participates in the following flow:

  1. Read B-tree headers and nodes.
  2. Decode record offsets and keys.
  3. Traverse index and leaf nodes.
  4. Support catalog, extents and attributes trees.
  5. Expose or execute the detected APIs: parse_node_descriptor, parse_header_rec, node_record_offset, node_record_length, parse_catalog_key, catalog_record_body_offset, walk_btree.
  6. Return explicit results, progress data, recovered records, or diagnostics to the calling layer.

9. Validation and Error Handling

  • Errors are propagated through Boolean results, error strings, logs, exceptions, or status records depending on the API.
  • Byte offsets, sizes and lengths must be validated before arithmetic and before every read to avoid overflow and out-of-bounds access.

10. Runtime, Concurrency, and Resource Management

  • Deterministic behavior: callers depend on explicit return values and stable data structures to distinguish successful recovery from partial or invalid results.

11. Security and Data-Recovery Considerations

  • Recovery code should prefer read-only source access and avoid writing to the original damaged medium.
  • Raw devices and image files are treated as untrusted binary input; every offset and length must remain bounded by the source size.

12. Implementation Considerations

  • Changes to public declarations can affect every translation unit that includes this header and should preserve binary and source compatibility where required.
  • State-bearing members should have explicit ownership and initialization semantics, especially for references, pointers, file descriptors and GTK widgets.

13. Integration with the Recovery Pipeline

  • The file belongs to the source-discovery, parsing or support layer.
  • Its results feed scanner, recovery or reporting modules through shared models.
  • The API should remain deterministic so higher layers can combine results safely.

14. Licensing and Provenance

No explicit copyright or software-license statement was detected in the opening section of this individual file. Distribution terms should therefore be verified against the project-level license and repository metadata.

The SHA-256 value in this document can be used to associate the generated documentation with the exact source version analyzed.

Published on:
Last updated on: