gir_parser/
record.rs

1use xmlserde_derives::XmlDeserialize;
2
3use crate::{
4    attribute::Attribute,
5    documentation::{DocDeprecated, DocStability, DocVersion, Documentation, SourcePosition},
6    field::Field,
7    function::{Function, FunctionInline},
8    method::{Method, MethodInline},
9    prelude::*,
10    union::Union,
11    version::Version,
12    Stability,
13};
14
15#[derive(Clone, Debug, XmlDeserialize)]
16#[xmlserde(root = b"record")]
17#[xmlserde(deny_unknown_fields)]
18pub struct Record {
19    #[xmlserde(name = b"name", ty = "attr")]
20    name: Option<String>,
21    #[xmlserde(name = b"c:type", ty = "attr")]
22    c_type: Option<String>,
23    /// Deprecated and replaced by `opaque` & `pointer`
24    #[xmlserde(name = b"disguised", ty = "attr")]
25    disguised: Option<bool>,
26    #[xmlserde(name = b"pointer", ty = "attr")]
27    pointer: Option<bool>,
28    #[xmlserde(name = b"opaque", ty = "attr")]
29    opaque: Option<bool>,
30    #[xmlserde(name = b"foreign", ty = "attr")]
31    foreign: Option<bool>,
32    #[xmlserde(name = b"glib:is-gtype-struct-for", ty = "attr")]
33    g_is_gtype_struct_for: Option<String>,
34    #[xmlserde(name = b"glib:type-name", ty = "attr")]
35    g_type_name: Option<String>,
36    #[xmlserde(name = b"glib:get-type", ty = "attr")]
37    g_get_type: Option<String>,
38    #[xmlserde(name = b"c:symbol-prefix", ty = "attr")]
39    symbol_prefix: Option<String>,
40    #[xmlserde(name = b"copy-function", ty = "attr")]
41    copy_function: Option<String>,
42    #[xmlserde(name = b"free-function", ty = "attr")]
43    free_function: Option<String>,
44
45    // Common attributes
46    #[xmlserde(name = b"introspectable", ty = "attr")]
47    introspectable: Option<bool>,
48    #[xmlserde(name = b"deprecated", ty = "attr")]
49    deprecated: Option<bool>,
50    #[xmlserde(name = b"version", ty = "attr")]
51    version: Option<Version>,
52    #[xmlserde(name = b"deprecated-version", ty = "attr")]
53    deprecated_version: Option<Version>,
54    #[xmlserde(name = b"stability", ty = "attr")]
55    stability: Option<Stability>,
56    // Documentation
57    #[xmlserde(name = b"doc", ty = "child")]
58    doc: Option<Documentation>,
59    #[xmlserde(name = b"doc-deprecated", ty = "child")]
60    doc_deprecated: Option<DocDeprecated>,
61    #[xmlserde(name = b"doc-stability", ty = "child")]
62    doc_stability: Option<DocStability>,
63    #[xmlserde(name = b"doc-version", ty = "child")]
64    doc_version: Option<DocVersion>,
65    #[xmlserde(name = b"source-position", ty = "child")]
66    source_position: Option<SourcePosition>,
67    // Attributes: 0 or more
68    #[xmlserde(name = b"attribute", ty = "child")]
69    attributes: Vec<Attribute>,
70
71    #[xmlserde(name = b"field", ty = "child")]
72    fields: Vec<Field>,
73    #[xmlserde(name = b"union", ty = "child")]
74    unions: Vec<Union>,
75
76    #[xmlserde(name = b"function", ty = "child")]
77    functions: Vec<Function>,
78    #[xmlserde(name = b"function-inline", ty = "child")]
79    inline_functions: Vec<FunctionInline>,
80
81    #[xmlserde(name = b"method", ty = "child")]
82    methods: Vec<Method>,
83    #[xmlserde(name = b"inline-methods", ty = "child")]
84    inline_methods: Vec<MethodInline>,
85
86    #[xmlserde(name = b"constructor", ty = "child")]
87    constructors: Vec<Function>,
88}
89
90impl Record {
91    pub fn name(&self) -> Option<&str> {
92        self.name.as_deref()
93    }
94
95    pub fn c_type(&self) -> Option<&str> {
96        self.c_type.as_deref()
97    }
98
99    pub fn is_disguised(&self) -> bool {
100        self.disguised.unwrap_or(false)
101    }
102
103    pub fn is_opaque(&self) -> bool {
104        self.opaque.unwrap_or(false)
105    }
106
107    pub fn is_pointer(&self) -> bool {
108        self.pointer.unwrap_or(false)
109    }
110
111    pub fn is_foreign(&self) -> bool {
112        self.foreign.unwrap_or(false)
113    }
114
115    pub fn g_is_gtype_struct_for(&self) -> Option<&str> {
116        self.g_is_gtype_struct_for.as_deref()
117    }
118
119    pub fn g_type_name(&self) -> Option<&str> {
120        self.g_type_name.as_deref()
121    }
122
123    pub fn g_get_type(&self) -> Option<&str> {
124        self.g_get_type.as_deref()
125    }
126
127    pub fn symbol_prefix(&self) -> Option<&str> {
128        self.symbol_prefix.as_deref()
129    }
130
131    pub fn copy_function(&self) -> Option<&str> {
132        self.copy_function.as_deref()
133    }
134
135    pub fn free_function(&self) -> Option<&str> {
136        self.free_function.as_deref()
137    }
138
139    pub fn fields(&self) -> &[Field] {
140        &self.fields
141    }
142
143    pub fn unions(&self) -> &[Union] {
144        &self.unions
145    }
146
147    pub fn methods(&self) -> &[Method] {
148        &self.methods
149    }
150
151    pub fn inlined_methods(&self) -> &[MethodInline] {
152        &self.inline_methods
153    }
154
155    pub fn functions(&self) -> &[Function] {
156        &self.functions
157    }
158
159    pub fn inlined_functions(&self) -> &[FunctionInline] {
160        &self.inline_functions
161    }
162
163    pub fn constructors(&self) -> &[Function] {
164        &self.constructors
165    }
166}
167
168impl_info!(Record);
169impl_attributable!(Record);
170impl_documentable!(Record);
gir_parser/record.rs

gir_parser/
record.rs
