native_api_1c_core 0.9.4

Core library for Native API 1C
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

use std::ffi::{c_long, c_ushort};

use super::{provided_types::TVariant, string_utils::os_string_nil};

/// Message codes that can be used in `Connection::add_error` method
/// to specify message type.
/// See [1C documentation](https://its.1c.ru/db/content/metod8dev/src/developers/platform/i8103221.htm#_com_infomessage)
pub enum MessageCode {
    /// Error without icon
    None = 1000,
    /// Error with ">" icon
    Ordinary = 1001,
    /// Error with "!" icon
    Attention = 1002,
    /// Error with "!!" icon
    Important = 1003,
    /// Error with "!!!" icon
    VeryImportant = 1004,
    /// Error with "i" icon
    Info = 1005,
    /// Error with "err" icon
    Fail = 1006,
    /// Shows a dialog with "MB_ICONEXCLAMATION" icon
    DialogAttention = 1007,
    /// Shows a dialog with "MB_ICONINFORMATION" icon
    DialogInfo = 1008,
    /// Shows a dialog with "MB_ICONERROR" icon
    DialogFail = 1009,
}

/// VTable for Connection object, derived from Native API interface. See original
/// C++ implementation in [example project](https://its.1c.ru/db/files/1CITS/EXE/VNCOMPS/VNCOMPS.zip)
/// from 1C documentation
#[repr(C)]
struct ConnectionVTable {
    dtor: usize,
    #[cfg(target_family = "unix")]
    dtor2: usize,
    add_error: unsafe extern "system" fn(
        &Connection,
        c_ushort,
        *const u16,
        *const u16,
        c_long,
    ) -> bool,
    read: unsafe extern "system" fn(
        &Connection,
        *mut u16,
        &mut TVariant,
        c_long,
        *mut *mut u16,
    ) -> bool,
    write:
        unsafe extern "system" fn(&Connection, *mut u16, &mut TVariant) -> bool,
    register_profile_as:
        unsafe extern "system" fn(&Connection, *mut u16) -> bool,
    set_event_buffer_depth:
        unsafe extern "system" fn(&Connection, c_long) -> bool,
    get_event_buffer_depth: unsafe extern "system" fn(&Connection) -> c_long,
    external_event: unsafe extern "system" fn(
        &Connection,
        *mut u16,
        *mut u16,
        *mut u16,
    ) -> bool,
    clean_event_buffer: unsafe extern "system" fn(&Connection),
    set_status_line: unsafe extern "system" fn(&Connection, *mut u16) -> bool,
    reset_status_line: unsafe extern "system" fn(&Connection),
}

/// Connection object, used to communicate with 1C platform after the AddIn is loaded
#[repr(C)]
pub struct Connection {
    vptr1: &'static ConnectionVTable,
}

impl Connection {
    /// Equivalent to `AddError` from Native API interface and is used to add an error to the 1C platform
    /// # Arguments
    /// * `code` - message code, see [MessageCode](enum.MessageCode)
    /// * `source` - source of the error
    /// * `description` - description of the error
    /// # Returns
    /// `bool` - operation success status
    pub fn add_error(
        &self,
        code: MessageCode,
        source: &str,
        description: &str,
    ) -> bool {
        unsafe {
            let source_wstr = os_string_nil(source);
            let description_wstr = os_string_nil(description);
            (self.vptr1.add_error)(
                self,
                code as u16,
                source_wstr.as_ptr(),
                description_wstr.as_ptr(),
                0,
            )
        }
    }

    /// Equivalent to `ExternalEvent` from Native API interface and is used to send an external event to the 1C platform
    /// # Arguments
    /// * `caller` - name of the event caller
    /// * `name` - name of the event
    /// * `data` - data of the event
    /// # Returns
    /// `bool` - operation success status
    pub fn external_event(&self, caller: &str, name: &str, data: &str) -> bool {
        unsafe {
            let mut caller_wstr = os_string_nil(caller);
            let mut name_wstr = os_string_nil(name);
            let mut data_wstr = os_string_nil(data);
            (self.vptr1.external_event)(
                self,
                caller_wstr.as_mut_ptr(),
                name_wstr.as_mut_ptr(),
                data_wstr.as_mut_ptr(),
            )
        }
    }

    /// Equivalent to `SetEventBufferDepth` from Native API interface
    /// # Arguments
    /// * `depth` - new event buffer depth
    pub fn set_event_buffer_depth(&self, depth: c_long) -> bool {
        unsafe { (self.vptr1.set_event_buffer_depth)(self, depth) }
    }

    /// Equivalent to `GetEventBufferDepth` from Native API interface
    /// # Returns
    /// `c_long` - current event buffer depth
    pub fn get_event_buffer_depth(&self) -> c_long {
        unsafe { (self.vptr1.get_event_buffer_depth)(self) }
    }
}