macho-cpp 0.5.1

C++ RTTI, vtable, and ABI inference for Mach-O images
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

#![deny(missing_docs)]
//! C++ RTTI, vtable, and architecture-aware ABI inference.
//!
//! Depend on this crate directly for C++ structure recovery without the `macho`
//! façade: build a [`VtableIndex`] or [`build_typeinfo_index`] from a
//! [`macho_core::MachoFile`] or a borrowed byte source.

pub use macho_core::{format, model};

/// The error module.
pub mod error;
#[cfg(feature = "fixups")]
pub(crate) use error::Error;
pub use error::{CppError, CppErrorKind, Result};

#[cfg(feature = "abi")]
pub mod abi;
mod abi_types;
#[cfg(feature = "itanium-rtti")]
mod strict_rtti;
#[cfg(feature = "itanium-rtti")]
mod strict_vtable;
#[cfg(feature = "fixups")]
/// The typeinfo module.
pub mod typeinfo;
/// The types module.
pub mod types;
#[cfg(feature = "fixups")]
/// The vtable module.
pub mod vtable;

pub use abi_types::{ArgumentTypeHint, CppBodyAnalysis, CppBodyKind, CppReturnChannel};
#[cfg(feature = "itanium-rtti")]
pub use strict_rtti::{
    ItaniumBaseRecord, ItaniumPointeeRecord, ItaniumTypeInfoFamily, ItaniumTypeInfoRecord,
    StrictPointerAuthentication, StrictPointerEncoding, StrictPointerObservation,
    StrictPointerTarget, StrictRttiBatch, StrictRttiConservation, StrictRttiGap, StrictRttiGapCode,
    StrictRttiLimits, StrictRttiObservation, StrictRttiObservationKind, StrictRttiOutcome,
    StrictRttiRecord, decode_strict_rtti, decode_strict_rtti_from_source,
};
#[cfg(feature = "itanium-rtti")]
pub use strict_vtable::{
    ItaniumThunkAdjustment, ItaniumVtableAddressPointRecord, ItaniumVtableAddressPointSource,
    ItaniumVtableAmbiguousWordRecord, ItaniumVtableExtentSource, ItaniumVtableGroupRecord,
    ItaniumVtableOffsetRecord, ItaniumVtableOffsetRole, ItaniumVtableSlotRecord,
    ItaniumVtableSlotRole, ItaniumVtableSymbolKind, ItaniumVttEntryRecord, ItaniumVttRecord,
    StrictVtableBatch, StrictVtableLimits, StrictVtableRecord, decode_strict_vtables,
    decode_strict_vtables_from_source,
};
#[cfg(feature = "fixups")]
pub use typeinfo::{build_typeinfo_index, build_typeinfo_index_from_source};
pub use types::{
    CppBaseClass, CppConfidence, CppEvidence, CppEvidenceKind, CppTypeInfoKind, CppTypeInfoNode,
};
#[cfg(feature = "fixups")]
pub use vtable::{SlotTarget, VtableEntry, VtableIndex, VtableSlot};

#[cfg(feature = "fixups")]
use crate::model::macho_file::MachoFile;

#[cfg(feature = "fixups")]
fn parse_source<'data, S>(source: &'data S) -> Result<MachoFile<'data>>
where
    S: AsRef<[u8]> + ?Sized,
{
    match macho_core::parse(source.as_ref())? {
        macho_core::model::container::MachoContainer::Thin(macho) => Ok(macho),
        macho_core::model::container::MachoContainer::Fat(_) => Err(Error::unsupported(
            "borrowed source contains a universal Mach-O; select an architecture explicitly",
        )),
    }
}