lldb 0.0.11

Rust-like bindings to the public LLDB API. LLDB is the debugger from the LLVM project and is the system debugger on macOS.
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

// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

use crate::{sys, SBAddress, SBData, SBStream, SBTarget};
use std::ffi::CStr;
use std::fmt;

/// A machine instruction.
pub struct SBInstruction {
    /// The underlying raw `SBInstructionRef`.
    pub raw: sys::SBInstructionRef,
}

impl SBInstruction {
    /// Construct a new `SBInstruction`.
    pub(crate) fn wrap(raw: sys::SBInstructionRef) -> SBInstruction {
        SBInstruction { raw }
    }

    /// Construct a new `Some(SBInstruction)` or `None`.
    #[allow(dead_code)]
    pub(crate) fn maybe_wrap(raw: sys::SBInstructionRef) -> Option<SBInstruction> {
        if unsafe { sys::SBInstructionIsValid(raw) } {
            Some(SBInstruction { raw })
        } else {
            None
        }
    }

    /// Check whether or not this is a valid `SBInstruction` value.
    pub fn is_valid(&self) -> bool {
        unsafe { sys::SBInstructionIsValid(self.raw) }
    }

    /// Get the address of the instruction.
    pub fn address(&self) -> SBAddress {
        SBAddress::wrap(unsafe { sys::SBInstructionGetAddress(self.raw) })
    }

    #[allow(missing_docs)]
    pub fn mnemonic(&self, target: &SBTarget) -> &str {
        unsafe {
            match CStr::from_ptr(sys::SBInstructionGetMnemonic(self.raw, target.raw)).to_str() {
                Ok(s) => s,
                _ => panic!("Invalid string?"),
            }
        }
    }

    #[allow(missing_docs)]
    pub fn operands(&self, target: &SBTarget) -> &str {
        unsafe {
            match CStr::from_ptr(sys::SBInstructionGetOperands(self.raw, target.raw)).to_str() {
                Ok(s) => s,
                _ => panic!("Invalid string?"),
            }
        }
    }

    #[allow(missing_docs)]
    pub fn comment(&self, target: &SBTarget) -> &str {
        unsafe {
            match CStr::from_ptr(sys::SBInstructionGetComment(self.raw, target.raw)).to_str() {
                Ok(s) => s,
                _ => panic!("Invalid string?"),
            }
        }
    }

    #[allow(missing_docs)]
    pub fn data(&self, target: &SBTarget) -> SBData {
        SBData::wrap(unsafe { sys::SBInstructionGetData(self.raw, target.raw) })
    }

    #[allow(missing_docs)]
    pub fn byte_size(&self) -> usize {
        unsafe { sys::SBInstructionGetByteSize(self.raw) }
    }

    #[allow(missing_docs)]
    pub fn is_branch(&self) -> bool {
        unsafe { sys::SBInstructionDoesBranch(self.raw) }
    }

    #[allow(missing_docs)]
    pub fn has_delay_slot(&self) -> bool {
        unsafe { sys::SBInstructionHasDelaySlot(self.raw) }
    }
}

impl Clone for SBInstruction {
    fn clone(&self) -> SBInstruction {
        SBInstruction {
            raw: unsafe { sys::CloneSBInstruction(self.raw) },
        }
    }
}

impl fmt::Debug for SBInstruction {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        let stream = SBStream::new();
        unsafe { sys::SBInstructionGetDescription(self.raw, stream.raw) };
        write!(fmt, "SBInstruction {{ {} }}", stream.data())
    }
}

impl Drop for SBInstruction {
    fn drop(&mut self) {
        unsafe { sys::DisposeSBInstruction(self.raw) };
    }
}

unsafe impl Send for SBInstruction {}
unsafe impl Sync for SBInstruction {}