xmloxide 0.4.2

A pure Rust reimplementation of libxml2 — memory-safe XML/HTML parsing
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

//! Serialization FFI functions.
#![allow(unsafe_code, clippy::missing_safety_doc)]

use std::ffi::CStr;
use std::os::raw::c_char;

use crate::serial::SerializeOptions;
use crate::tree::Document;

use super::strings::to_c_string;
use super::{clear_last_error, set_last_error};

/// Serializes a document to an XML string.
///
/// Returns a caller-owned C string that must be freed with
/// `xmloxide_free_string`. Returns null on failure.
///
/// # Safety
///
/// `doc` must be a valid document pointer.
#[no_mangle]
pub unsafe extern "C" fn xmloxide_serialize(doc: *const Document) -> *mut c_char {
    clear_last_error();
    if doc.is_null() {
        set_last_error("null document pointer");
        return std::ptr::null_mut();
    }
    // SAFETY: Null check above. Caller guarantees `doc` is a valid pointer from a parse function.
    let doc = unsafe { &*doc };
    let output = crate::serial::serialize(doc);
    to_c_string(&output)
}

/// Serializes a document to a pretty-printed XML string.
///
/// Uses the default two-space indentation. Returns a caller-owned C string
/// that must be freed with `xmloxide_free_string`. Returns null on failure.
///
/// # Safety
///
/// `doc` must be a valid document pointer.
#[no_mangle]
pub unsafe extern "C" fn xmloxide_serialize_pretty(doc: *const Document) -> *mut c_char {
    clear_last_error();
    if doc.is_null() {
        set_last_error("null document pointer");
        return std::ptr::null_mut();
    }
    // SAFETY: Null check above. Caller guarantees `doc` is a valid pointer from a parse function.
    let doc = unsafe { &*doc };
    let opts = SerializeOptions::default().indent(true);
    let output = crate::serial::serialize_with_options(doc, &opts);
    to_c_string(&output)
}

/// Serializes a document to a pretty-printed XML string with a custom indent.
///
/// `indent_str` is the string used for each indentation level (e.g., `"\t"`
/// or `"    "`). Returns a caller-owned C string that must be freed with
/// `xmloxide_free_string`. Returns null on failure.
///
/// # Safety
///
/// `doc` must be a valid document pointer. `indent_str` must be a valid
/// null-terminated UTF-8 string.
#[no_mangle]
pub unsafe extern "C" fn xmloxide_serialize_pretty_custom(
    doc: *const Document,
    indent_str: *const c_char,
) -> *mut c_char {
    clear_last_error();
    if doc.is_null() {
        set_last_error("null document pointer");
        return std::ptr::null_mut();
    }
    if indent_str.is_null() {
        set_last_error("null indent_str pointer");
        return std::ptr::null_mut();
    }
    // SAFETY: Null checks above. Caller guarantees valid pointers.
    let doc = unsafe { &*doc };
    let c_indent = unsafe { CStr::from_ptr(indent_str) };
    let Ok(indent) = c_indent.to_str() else {
        set_last_error("invalid UTF-8 in indent_str");
        return std::ptr::null_mut();
    };
    let opts = SerializeOptions::default().indent(true).indent_str(indent);
    let output = crate::serial::serialize_with_options(doc, &opts);
    to_c_string(&output)
}

/// Serializes a document to an HTML string.
///
/// Returns a caller-owned C string that must be freed with
/// `xmloxide_free_string`. Returns null on failure.
///
/// # Safety
///
/// `doc` must be a valid document pointer.
#[no_mangle]
pub unsafe extern "C" fn xmloxide_serialize_html(doc: *const Document) -> *mut c_char {
    clear_last_error();
    if doc.is_null() {
        set_last_error("null document pointer");
        return std::ptr::null_mut();
    }
    // SAFETY: Null check above. Caller guarantees `doc` is a valid pointer from a parse function.
    let doc = unsafe { &*doc };
    let output = crate::serial::html::serialize_html(doc);
    to_c_string(&output)
}

/// Serializes a document to an HTML5 string.
///
/// Uses the WHATWG HTML serialization algorithm: void elements are not
/// self-closed, raw text elements (`<script>`, `<style>`) are not escaped,
/// and foreign content (`SVG`/`MathML`) uses self-closing tags when empty.
///
/// Returns a caller-owned C string that must be freed with
/// `xmloxide_free_string`. Returns null on failure.
///
/// # Safety
///
/// `doc` must be a valid document pointer.
#[no_mangle]
pub unsafe extern "C" fn xmloxide_serialize_html5(doc: *const Document) -> *mut c_char {
    clear_last_error();
    if doc.is_null() {
        set_last_error("null document pointer");
        return std::ptr::null_mut();
    }
    // SAFETY: Null check above. Caller guarantees `doc` is a valid pointer from a parse function.
    let doc = unsafe { &*doc };
    let output = crate::serial::html::serialize_html5(doc);
    to_c_string(&output)
}