lief 1.0.0

Official Rust bindings for LIEF
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

//! This module wraps a PDB compilation unit

use lief_ffi as ffi;

use std::marker::PhantomData;

use crate::DeclOpt;
use crate::common::{FromFFI, into_optional};
use crate::declare_fwd_iterator;

use super::build_metadata::BuildMetadata;
use super::function::Functions;

/// This structure represents a CompilationUnit (or Module) in a PDB file
pub struct CompilationUnit<'a> {
    ptr: cxx::UniquePtr<ffi::PDB_CompilationUnit>,
    _owner: PhantomData<&'a ()>,
}

impl FromFFI<ffi::PDB_CompilationUnit> for CompilationUnit<'_> {
    fn from_ffi(ptr: cxx::UniquePtr<ffi::PDB_CompilationUnit>) -> Self {
        Self {
            ptr,
            _owner: PhantomData,
        }
    }
}

impl CompilationUnit<'_> {
    /// Name (or path) to the COFF object (`.obj`) associated with this
    /// compilation unit (e.g. `e:\obj.amd64fre\minkernel\ntos\hvl\mp\objfre\amd64\hvlp.obj`)
    pub fn module_name(&self) -> String {
        self.ptr.module_name().to_string()
    }

    /// Name of path to the original binary object (COFF, Archive) in which
    /// the compilation unit was located before being linked.
    /// e.g. `e:\obj.amd64fre\minkernel\ntos\hvl\mp\objfre\amd64\hvl.lib`
    pub fn object_filename(&self) -> String {
        self.ptr.object_filename().to_string()
    }

    /// Return an iterator over the [`crate::pdb::Function`] defined in this compilation unit.
    /// If the PDB does not contain or has an empty DBI stream, it returns
    /// an empty iterator.
    pub fn functions(&self) -> Functions<'_> {
        Functions::new(self.ptr.functions())
    }

    /// Iterator over the sources files (as string) that compose this compilation unit.
    /// These files include the **header** (`.h, .hpp`, ...).
    pub fn sources(&self) -> Sources<'_> {
        Sources::new(self.ptr.sources())
    }

    /// Return build metadata such as the version of the compiler or
    /// the original source language of this compilation unit
    pub fn build_metadata(&self) -> Option<BuildMetadata<'_>> {
        into_optional(self.ptr.build_metadata())
    }

    /// Generate a C/C++ definition for the functions defined in this
    /// compilation unit.
    pub fn to_decl(&self) -> String {
        self.ptr.to_decl().to_string()
    }

    /// Same as [`CompilationUnit::to_decl`] but with the given configuration
    pub fn to_decl_with_opt(&self, opt: &DeclOpt) -> String {
        self.ptr.to_decl_with_opt(&opt.to_ffi()).to_string()
    }
}

impl std::fmt::Display for CompilationUnit<'_> {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        write!(f, "{}", self.ptr.to_string())
    }
}

declare_fwd_iterator!(
    CompilationUnits,
    CompilationUnit<'a>,
    ffi::PDB_CompilationUnit,
    ffi::PDB_DebugInfo,
    ffi::PDB_DebugInfo_it_compilation_units
);

pub struct Sources<'a> {
    #[doc(hidden)]
    pub it: cxx::UniquePtr<ffi::PDB_CompilationUnit_it_sources>,
    _owner: PhantomData<&'a ffi::PDB_CompilationUnit>,
}

impl Sources<'_> {
    #[doc(hidden)]
    pub fn new(it: cxx::UniquePtr<ffi::PDB_CompilationUnit_it_sources>) -> Self {
        Self {
            it,
            _owner: PhantomData,
        }
    }
}

impl Iterator for Sources<'_> {
    type Item = String;
    fn next(&mut self) -> Option<Self::Item> {
        let string = self.it.as_mut().unwrap().next().to_string();
        // c.f. comment in rust/LIEF/PDB/CompilationUnit.hpp
        if string == "[LIEF_STOP]" {
            None
        } else {
            Some(string)
        }
    }
}