libmandoc-rs 0.10.0

Safe Rust interface to the vendored libmandoc parser and reference renderers
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
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190

//! Raw C ABI declarations. Snapshots are borrowed only for immediate copying.
use std::os::raw::{c_char, c_void};
#[cfg(feature = "render")]
use unicode_width::UnicodeWidthChar;
#[repr(C)]
pub(super) struct CDocument {
    pub(super) _private: [u8; 0],
}

#[repr(C)]
pub(super) struct CNode {
    pub(super) _private: [u8; 0],
}

#[repr(C)]
pub(super) struct CTableCell {
    pub(super) _private: [u8; 0],
}

#[repr(C)]
pub(super) struct CNodeView {
    pub(super) kind: i32,
    pub(super) macro_name: *const c_char,
    pub(super) text: *const c_char,
    pub(super) tag: *const c_char,
    pub(super) line: i32,
    pub(super) column: i32,
    pub(super) flow_epoch: usize,
    pub(super) flags: u32,
    pub(super) list_kind: i32,
    pub(super) definition_list_style: i32,
    pub(super) display_kind: i32,
    pub(super) font_kind: i32,
    pub(super) author_mode: i32,
    pub(super) compact: i32,
    pub(super) offset: *const c_char,
    pub(super) width: *const c_char,
    pub(super) enclosure_open: *const c_char,
    pub(super) enclosure_close: *const c_char,
    pub(super) equation: *const c_char,
    pub(super) table_cells: *const CTableCell,
    pub(super) child: *const CNode,
    pub(super) next: *const CNode,
}

#[repr(C)]
pub(super) struct CTableCellView {
    pub(super) text: *const c_char,
    pub(super) kind: i32,
    pub(super) text_block: i32,
    pub(super) vertical_continuation: i32,
    pub(super) column_span: u32,
    pub(super) row_span: u32,
    pub(super) alignment: i32,
    pub(super) next: *const CTableCell,
}

#[repr(C)]
pub(super) struct CSource {
    pub(super) path: *const c_char,
    pub(super) data: *const u8,
    pub(super) length: usize,
}

#[repr(C)]
pub(super) struct CResolvedSource {
    pub(super) path: *const c_char,
    pub(super) data: *const u8,
    pub(super) length: usize,
}

pub(super) type CSourceResolver =
    extern "C" fn(*mut c_void, *const c_char, *const c_char, *mut CResolvedSource) -> i32;

#[cfg(feature = "render")]
#[unsafe(no_mangle)]
extern "C" fn mant_mandoc_utf8_width(codepoint: i32) -> usize {
    u32::try_from(codepoint)
        .ok()
        .and_then(char::from_u32)
        .and_then(UnicodeWidthChar::width)
        .unwrap_or(0)
}

unsafe extern "C" {
    #[cfg(unix)]
    pub(super) fn mant_mandoc_parse_file(
        path: *const c_char,
        include_root: *const c_char,
        allow_include: i32,
        input_format: i32,
        operating_system: *const c_char,
    ) -> *mut CDocument;
    pub(super) fn mant_mandoc_parse_buffer(
        path: *const c_char,
        buffer: *const u8,
        length: usize,
        include_root: *const c_char,
        allow_include: i32,
        input_format: i32,
        operating_system: *const c_char,
        resolver: Option<CSourceResolver>,
        resolver_context: *mut c_void,
    ) -> *mut CDocument;
    pub(super) fn mant_mandoc_parse_bundle(
        root: *const c_char,
        sources: *const CSource,
        source_count: usize,
        input_format: i32,
        operating_system: *const c_char,
    ) -> *mut CDocument;
    #[cfg(all(feature = "render", unix))]
    pub(super) fn mant_mandoc_render_file(
        path: *const c_char,
        include_root: *const c_char,
        allow_include: i32,
        input_format: i32,
        operating_system: *const c_char,
        render_format: i32,
        render_width: usize,
        html_fragment: i32,
        output_limit: usize,
    ) -> *mut CDocument;
    #[cfg(feature = "render")]
    pub(super) fn mant_mandoc_render_buffer(
        path: *const c_char,
        buffer: *const u8,
        length: usize,
        include_root: *const c_char,
        allow_include: i32,
        input_format: i32,
        operating_system: *const c_char,
        render_format: i32,
        render_width: usize,
        html_fragment: i32,
        output_limit: usize,
        resolver: Option<CSourceResolver>,
        resolver_context: *mut c_void,
    ) -> *mut CDocument;
    #[cfg(feature = "render")]
    pub(super) fn mant_mandoc_render_bundle(
        root: *const c_char,
        sources: *const CSource,
        source_count: usize,
        input_format: i32,
        operating_system: *const c_char,
        render_format: i32,
        render_width: usize,
        html_fragment: i32,
        output_limit: usize,
    ) -> *mut CDocument;
    pub(super) fn mant_mandoc_document_free(document: *mut CDocument);
    pub(super) fn mant_mandoc_document_ok(document: *const CDocument) -> i32;
    pub(super) fn mant_mandoc_document_error(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_diagnostics(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_macroset(document: *const CDocument) -> i32;
    pub(super) fn mant_mandoc_document_title(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_section(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_volume(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_os(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_arch(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_name(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_date(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_alias_target(document: *const CDocument) -> *const c_char;
    pub(super) fn mant_mandoc_document_has_body(document: *const CDocument) -> i32;
    pub(super) fn mant_mandoc_document_equation_truncated(document: *const CDocument) -> i32;
    #[cfg(test)]
    pub(super) fn mant_mandoc_node_view_size() -> usize;
    #[cfg(test)]
    pub(super) fn mant_mandoc_table_cell_view_size() -> usize;
    pub(super) fn mant_mandoc_document_root(document: *const CDocument) -> *const CNode;
    pub(super) fn mant_mandoc_node_snapshot(
        document: *mut CDocument,
        node: *const CNode,
        view: *mut CNodeView,
    ) -> i32;
    pub(super) fn mant_mandoc_table_cell_snapshot(
        document: *const CDocument,
        cell: *const CTableCell,
        view: *mut CTableCellView,
    ) -> i32;
    #[cfg(feature = "render")]
    pub(super) fn mant_mandoc_document_output(document: *const CDocument) -> *const u8;
    #[cfg(feature = "render")]
    pub(super) fn mant_mandoc_document_output_length(document: *const CDocument) -> usize;
    #[cfg(feature = "render")]
    pub(super) fn mant_mandoc_document_render_status(document: *const CDocument) -> i32;
    #[cfg(all(feature = "render", test))]
    pub(super) fn mant_mandoc_ctype_locale() -> *const c_char;
}