idalib 0.9.0+9.3.260327

Idiomatic bindings to IDA SDK
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
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143

use std::ffi::CStr;
use std::marker::PhantomData;

use bitflags::bitflags;

use crate::ffi::BADADDR;
use crate::ffi::name::{
    get_nlist_ea, get_nlist_idx, get_nlist_name, get_nlist_size, is_in_nlist, is_public_name,
    is_weak_name,
};

use crate::Address;
use crate::idb::IDB;

pub type NameIndex = usize;

pub struct NameList<'a> {
    _marker: PhantomData<&'a IDB>,
}

bitflags! {
    #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
    pub struct NameProperties: u8 {
        const PUBLIC = 0x01;
        const WEAK = 0x02;
    }
}

#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
pub struct Name {
    address: Address,
    name: String,
    index: NameIndex,
    properties: NameProperties,
}

impl Name {
    pub fn address(&self) -> Address {
        self.address
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn is_public(&self) -> bool {
        self.properties.contains(NameProperties::PUBLIC)
    }

    pub fn is_weak(&self) -> bool {
        self.properties.contains(NameProperties::WEAK)
    }
}

impl<'a> NameList<'a> {
    pub(crate) fn new(_: &'a IDB) -> Self {
        Self {
            _marker: PhantomData,
        }
    }

    pub fn get_by_index(&self, index: NameIndex) -> Option<Name> {
        let addr = self.get_address_by_index(index)?;
        let name = unsafe { get_nlist_name(index) };
        if name.is_null() {
            return None;
        }

        let name = unsafe { CStr::from_ptr(name) }.to_string_lossy().into_owned();

        let mut properties = NameProperties::empty();

        if unsafe { is_public_name(addr.into()) } {
            properties.insert(NameProperties::PUBLIC);
        }

        if unsafe { is_weak_name(addr.into()) } {
            properties.insert(NameProperties::WEAK);
        }

        Some(Name {
            address: addr,
            name,
            index,
            properties,
        })
    }

    pub fn get_closest_by_address(&self, address: Address) -> Option<Name> {
        let index = unsafe { get_nlist_idx(address.into()) };
        self.get_by_index(index)
    }

    pub fn get_address_by_index(&self, index: NameIndex) -> Option<Address> {
        let addr = unsafe { get_nlist_ea(index) };
        if addr == BADADDR {
            None
        } else {
            Some(addr.into())
        }
    }

    pub fn has_name(&self, address: Address) -> bool {
        unsafe { is_in_nlist(address.into()) }
    }

    pub fn len(&self) -> usize {
        unsafe { get_nlist_size() }
    }

    pub fn is_empty(&self) -> bool {
        self.len() == 0
    }

    pub fn iter(&self) -> NameListIter<'_, 'a> {
        NameListIter {
            name_list: self,
            current_index: 0,
        }
    }
}

pub struct NameListIter<'s, 'a> {
    name_list: &'s NameList<'a>,
    current_index: NameIndex,
}

impl<'s, 'a> Iterator for NameListIter<'s, 'a> {
    type Item = Name;

    fn next(&mut self) -> Option<Self::Item> {
        while self.current_index < self.name_list.len() {
            let name = self.name_list.get_by_index(self.current_index);

            self.current_index += 1;

            if name.is_some() {
                return name;
            }
        }
        None
    }
}