lldb 0.0.12

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

// 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, SBBroadcaster, SBStream};
use std::ffi::CStr;
use std::fmt;

/// An event.
pub struct SBEvent {
    /// The underlying raw `SBEventRef`.
    pub raw: sys::SBEventRef,
}

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

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

    #[allow(missing_docs)]
    pub fn new() -> SBEvent {
        Self::wrap(unsafe { sys::CreateSBEvent() })
    }

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

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

    #[allow(missing_docs)]
    pub fn event_type(&self) -> u32 {
        unsafe { sys::SBEventGetType(self.raw) }
    }

    #[allow(missing_docs)]
    pub fn broadcaster(&self) -> SBBroadcaster {
        SBBroadcaster::wrap(unsafe { sys::SBEventGetBroadcaster(self.raw) })
    }

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

    #[allow(missing_docs)]
    pub fn broadcaster_matches_ref(&self, broadcaster: &SBBroadcaster) -> bool {
        unsafe { sys::SBEventBroadcasterMatchesRef(self.raw, broadcaster.raw) }
    }
}

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

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

impl Default for SBEvent {
    fn default() -> Self {
        Self::new()
    }
}

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

unsafe impl Send for SBEvent {}
unsafe impl Sync for SBEvent {}