gir_parser/
interface.rs

1use xmlserde_derives::XmlDeserialize;
2
3use crate::{
4    attribute::Attribute,
5    callback::Callback,
6    class::Implements,
7    constant::Constant,
8    documentation::{DocDeprecated, DocStability, DocVersion, Documentation, SourcePosition},
9    field::Field,
10    function::{Function, FunctionInline},
11    method::{Method, MethodInline},
12    prelude::*,
13    property::Property,
14    signal::Signal,
15    version::Version,
16    virtual_method::VirtualMethod,
17    Stability,
18};
19
20#[derive(Clone, Debug, XmlDeserialize)]
21#[xmlserde(root = b"prerequisite")]
22#[xmlserde(deny_unknown_fields)]
23pub struct Prerequisite {
24    #[xmlserde(name = b"name", ty = "attr")]
25    name: String,
26}
27
28impl Prerequisite {
29    pub fn name(&self) -> &str {
30        &self.name
31    }
32}
33
34#[derive(Clone, Debug, XmlDeserialize)]
35#[xmlserde(root = b"interface")]
36#[xmlserde(deny_unknown_fields)]
37pub struct Interface {
38    #[xmlserde(name = b"name", ty = "attr")]
39    name: String,
40    #[xmlserde(name = b"c:symbol-prefix", ty = "attr")]
41    symbol_prefix: Option<String>,
42    #[xmlserde(name = b"c:type", ty = "attr")]
43    c_type: Option<String>,
44    #[xmlserde(name = b"glib:type-name", ty = "attr")]
45    g_type_name: String,
46    #[xmlserde(name = b"glib:get-type", ty = "attr")]
47    g_get_type: String,
48    #[xmlserde(name = b"glib:type-struct", ty = "attr")]
49    g_type_struct: Option<String>,
50    // Common attributes
51    #[xmlserde(name = b"introspectable", ty = "attr")]
52    introspectable: Option<bool>,
53    #[xmlserde(name = b"deprecated", ty = "attr")]
54    deprecated: Option<bool>,
55    #[xmlserde(name = b"version", ty = "attr")]
56    version: Option<Version>,
57    #[xmlserde(name = b"deprecated-version", ty = "attr")]
58    deprecated_version: Option<Version>,
59    #[xmlserde(name = b"stability", ty = "attr")]
60    stability: Option<Stability>,
61    // Documentation
62    #[xmlserde(name = b"doc", ty = "child")]
63    doc: Option<Documentation>,
64    #[xmlserde(name = b"doc-deprecated", ty = "child")]
65    doc_deprecated: Option<DocDeprecated>,
66    #[xmlserde(name = b"doc-stability", ty = "child")]
67    doc_stability: Option<DocStability>,
68    #[xmlserde(name = b"doc-version", ty = "child")]
69    doc_version: Option<DocVersion>,
70    #[xmlserde(name = b"source-position", ty = "child")]
71    source_position: Option<SourcePosition>,
72    // Attributes: 0 or more
73    #[xmlserde(name = b"attribute", ty = "child")]
74    attributes: Vec<Attribute>,
75
76    #[xmlserde(name = b"prerequisite", ty = "child")]
77    prerequisites: Vec<Prerequisite>,
78
79    #[xmlserde(name = b"implements", ty = "child")]
80    implements: Vec<Implements>,
81
82    #[xmlserde(name = b"function", ty = "child")]
83    functions: Vec<Function>,
84
85    #[xmlserde(name = b"function-inline", ty = "child")]
86    inline_functions: Vec<FunctionInline>,
87
88    #[xmlserde(name = b"constructor", ty = "child")]
89    constructors: Vec<Function>,
90
91    #[xmlserde(name = b"method", ty = "child")]
92    methods: Vec<Method>,
93
94    #[xmlserde(name = b"inline-methods", ty = "child")]
95    inline_methods: Vec<MethodInline>,
96
97    #[xmlserde(name = b"virtual-method", ty = "child")]
98    virtual_methods: Vec<VirtualMethod>,
99
100    #[xmlserde(name = b"field", ty = "child")]
101    fields: Vec<Field>,
102
103    #[xmlserde(name = b"property", ty = "child")]
104    properties: Vec<Property>,
105
106    #[xmlserde(name = b"glib:signal", ty = "child")]
107    signals: Vec<Signal>,
108
109    #[xmlserde(name = b"callback", ty = "child")]
110    callbacks: Vec<Callback>,
111
112    #[xmlserde(name = b"constant", ty = "child")]
113    constants: Vec<Constant>,
114}
115
116impl Interface {
117    pub fn name(&self) -> &str {
118        &self.name
119    }
120
121    pub fn symbol_prefix(&self) -> Option<&str> {
122        self.symbol_prefix.as_deref()
123    }
124
125    pub fn c_type(&self) -> Option<&str> {
126        self.c_type.as_deref()
127    }
128
129    pub fn g_type_name(&self) -> &str {
130        &self.g_type_name
131    }
132
133    pub fn g_get_type(&self) -> &str {
134        &self.g_get_type
135    }
136
137    pub fn g_type_struct(&self) -> Option<&str> {
138        self.g_type_struct.as_deref()
139    }
140
141    pub fn prerequisites(&self) -> &[Prerequisite] {
142        &self.prerequisites
143    }
144
145    pub fn implements(&self) -> &[Implements] {
146        &self.implements
147    }
148
149    pub fn constructors(&self) -> &[Function] {
150        &self.constructors
151    }
152
153    pub fn methods(&self) -> &[Method] {
154        &self.methods
155    }
156
157    pub fn inlined_methods(&self) -> &[MethodInline] {
158        &self.inline_methods
159    }
160
161    pub fn functions(&self) -> &[Function] {
162        &self.functions
163    }
164
165    pub fn inlined_functions(&self) -> &[FunctionInline] {
166        &self.inline_functions
167    }
168
169    pub fn virtual_methods(&self) -> &[VirtualMethod] {
170        &self.virtual_methods
171    }
172
173    pub fn fields(&self) -> &[Field] {
174        &self.fields
175    }
176
177    pub fn properties(&self) -> &[Property] {
178        &self.properties
179    }
180
181    pub fn signals(&self) -> &[Signal] {
182        &self.signals
183    }
184
185    pub fn constants(&self) -> &[Constant] {
186        &self.constants
187    }
188
189    pub fn callbacks(&self) -> &[Callback] {
190        &self.callbacks
191    }
192}
193
194impl_documentable!(Interface);
195impl_attributable!(Interface);
196impl_info!(Interface);
gir_parser/interface.rs

gir_parser/
interface.rs
