exml 0.7.2

Pure Rust XML library based on libxml2
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

use std::{
    ffi::c_void,
    ptr::{drop_in_place, null_mut},
    rc::Rc,
};

use crate::{
    hash::{XmlHashTablePtr, xml_hash_free},
    libxml::{
        globals::{xml_free, xml_malloc},
        relaxng::{XmlRelaxNGPartitionPtr, XmlRelaxNGType, xml_relaxng_free_partition},
        xmlregexp::XmlRegexp,
    },
    tree::XmlNodePtr,
};

use super::{XmlRelaxNGParserCtxtPtr, XmlRelaxNGTypeLibraryPtr, xml_rng_perr_memory};

pub type XmlRelaxNGDefinePtr = *mut XmlRelaxNGDefine;

// TODO: all fieleds are used in only relaxng module.
#[repr(C)]
pub struct XmlRelaxNGDefine {
    pub(crate) typ: XmlRelaxNGType,               // the type of definition
    pub(crate) node: Option<XmlNodePtr>,          // the node in the source
    pub(crate) name: *mut u8,                     // the element local name if present
    pub(crate) ns: *mut u8,                       // the namespace local name if present
    pub(crate) value: *mut u8,                    // value when available
    pub(crate) data: *mut c_void,                 // data lib or specific pointer
    pub(crate) content: XmlRelaxNGDefinePtr,      // the expected content
    pub(crate) parent: XmlRelaxNGDefinePtr,       // the parent definition, if any
    pub(crate) next: XmlRelaxNGDefinePtr,         // list within grouping sequences
    pub(crate) attrs: XmlRelaxNGDefinePtr,        // list of attributes for elements
    pub(crate) name_class: XmlRelaxNGDefinePtr,   // the nameClass definition if any
    pub(crate) next_hash: XmlRelaxNGDefinePtr,    // next define in defs/refs hash tables
    pub(crate) depth: i16,                        // used for the cycle detection
    pub(crate) dflags: i16,                       // define related flags
    pub(crate) cont_model: Option<Rc<XmlRegexp>>, // a compiled content model if available
}

impl XmlRelaxNGDefine {
    #[doc(alias = "xmlRelaxNGDefName")]
    pub(crate) fn name(&self) -> &'static str {
        match self.typ {
            XmlRelaxNGType::Empty => "empty",
            XmlRelaxNGType::NotAllowed => "notAllowed",
            XmlRelaxNGType::Except => "except",
            XmlRelaxNGType::Text => "text",
            XmlRelaxNGType::Element => "element",
            XmlRelaxNGType::Datatype => "datatype",
            XmlRelaxNGType::Value => "value",
            XmlRelaxNGType::List => "list",
            XmlRelaxNGType::Attribute => "attribute",
            XmlRelaxNGType::Def => "def",
            XmlRelaxNGType::Ref => "ref",
            XmlRelaxNGType::Externalref => "externalRef",
            XmlRelaxNGType::Parentref => "parentRef",
            XmlRelaxNGType::Optional => "optional",
            XmlRelaxNGType::Zeroormore => "zeroOrMore",
            XmlRelaxNGType::Oneormore => "oneOrMore",
            XmlRelaxNGType::Choice => "choice",
            XmlRelaxNGType::Group => "group",
            XmlRelaxNGType::Interleave => "interleave",
            XmlRelaxNGType::Start => "start",
            XmlRelaxNGType::Noop => "noop",
            XmlRelaxNGType::Param => "param",
        }
    }
}

impl Default for XmlRelaxNGDefine {
    fn default() -> Self {
        Self {
            typ: XmlRelaxNGType::default(),
            node: None,
            name: null_mut(),
            ns: null_mut(),
            value: null_mut(),
            data: null_mut(),
            content: null_mut(),
            parent: null_mut(),
            next: null_mut(),
            attrs: null_mut(),
            name_class: null_mut(),
            next_hash: null_mut(),
            depth: 0,
            dflags: 0,
            cont_model: None,
        }
    }
}

/// Allocate a new RelaxNG define.
///
/// Returns the newly allocated structure or NULL in case or error
#[doc(alias = "xmlRelaxNGNewDefine")]
pub(crate) unsafe fn xml_relaxng_new_define(
    ctxt: XmlRelaxNGParserCtxtPtr,
    node: Option<XmlNodePtr>,
) -> XmlRelaxNGDefinePtr {
    unsafe {
        let ret: XmlRelaxNGDefinePtr = xml_malloc(size_of::<XmlRelaxNGDefine>()) as _;
        if ret.is_null() {
            xml_rng_perr_memory(ctxt, Some("allocating define\n"));
            return null_mut();
        }
        std::ptr::write(&mut *ret, XmlRelaxNGDefine::default());
        (*ctxt).def_tab.push(ret);
        (*ret).node = node;
        (*ret).depth = -1;
        ret
    }
}

/// Deallocate a RelaxNG define structure.
#[doc(alias = "xmlRelaxNGFreeDefine")]
pub(crate) unsafe fn xml_relaxng_free_define(define: XmlRelaxNGDefinePtr) {
    unsafe {
        if define.is_null() {
            return;
        }

        if (*define).typ == XmlRelaxNGType::Value && !(*define).attrs.is_null() {
            let lib: XmlRelaxNGTypeLibraryPtr = (*define).data as _;
            if !lib.is_null() {
                if let Some(freef) = (*lib).freef {
                    freef((*lib).data, (*define).attrs as _);
                }
            }
        }
        if !(*define).data.is_null() && (*define).typ == XmlRelaxNGType::Interleave {
            xml_relaxng_free_partition((*define).data as XmlRelaxNGPartitionPtr);
        }
        if !(*define).data.is_null() && (*define).typ == XmlRelaxNGType::Choice {
            xml_hash_free((*define).data as XmlHashTablePtr, None);
        }
        if !(*define).name.is_null() {
            xml_free((*define).name as _);
        }
        if !(*define).ns.is_null() {
            xml_free((*define).ns as _);
        }
        if !(*define).value.is_null() {
            xml_free((*define).value as _);
        }
        drop_in_place(define);
        xml_free(define as _);
    }
}