gir_parser/

interface.rs

use xmlserde_derives::XmlDeserialize;

use crate::{
    attribute::Attribute,
    callable::Callable,
    callback::Callback,
    class::Implements,
    constant::Constant,
    documentation::{DocDeprecated, DocStability, DocVersion, Documentation, SourcePosition},
    field::Field,
    function::{Function, FunctionInline},
    method::{Method, MethodInline},
    prelude::*,
    property::Property,
    signal::Signal,
    version::Version,
    virtual_method::VirtualMethod,
    Record, Stability, Union,
};

#[derive(Clone, Debug, PartialEq, Eq, Hash, XmlDeserialize)]
#[xmlserde(root = b"prerequisite")]
#[xmlserde(deny_unknown_fields)]
pub struct Prerequisite {
    #[xmlserde(name = b"name", ty = "attr")]
    name: String,
}

impl Prerequisite {
    pub fn name(&self) -> &str {
        &self.name
    }
}

#[derive(Clone, Debug, PartialEq, Eq, XmlDeserialize)]
// FIXME: The `Type` / `AnyType` fields are quite huge and some boxing would
// probably be useful here but `xmlserde` does not seem to support that.
#[allow(clippy::large_enum_variant)]
pub enum InterfaceField {
    #[xmlserde(name = b"field")]
    Field(Field),
    #[xmlserde(name = b"union")]
    Union(Union),
    #[xmlserde(name = b"record")]
    Record(Record),
    #[xmlserde(name = b"callback")]
    Callback(Callback),
}

#[derive(Clone, Debug, XmlDeserialize)]
#[xmlserde(root = b"interface")]
#[xmlserde(deny_unknown_fields)]
pub struct Interface {
    #[xmlserde(name = b"name", ty = "attr")]
    name: String,
    #[xmlserde(name = b"c:symbol-prefix", ty = "attr")]
    symbol_prefix: Option<String>,
    #[xmlserde(name = b"c:type", ty = "attr")]
    c_type: Option<String>,
    #[xmlserde(name = b"glib:type-name", ty = "attr")]
    g_type_name: String,
    #[xmlserde(name = b"glib:get-type", ty = "attr")]
    g_get_type: String,
    #[xmlserde(name = b"glib:type-struct", ty = "attr")]
    g_type_struct: Option<String>,
    // Common attributes
    #[xmlserde(name = b"introspectable", ty = "attr")]
    introspectable: Option<bool>,
    #[xmlserde(name = b"deprecated", ty = "attr")]
    deprecated: Option<bool>,
    #[xmlserde(name = b"version", ty = "attr")]
    version: Option<Version>,
    #[xmlserde(name = b"deprecated-version", ty = "attr")]
    deprecated_version: Option<Version>,
    #[xmlserde(name = b"stability", ty = "attr")]
    stability: Option<Stability>,
    // Documentation
    #[xmlserde(name = b"doc", ty = "child")]
    doc: Option<Documentation>,
    #[xmlserde(name = b"doc-deprecated", ty = "child")]
    doc_deprecated: Option<DocDeprecated>,
    #[xmlserde(name = b"doc-stability", ty = "child")]
    doc_stability: Option<DocStability>,
    #[xmlserde(name = b"doc-version", ty = "child")]
    doc_version: Option<DocVersion>,
    #[xmlserde(name = b"source-position", ty = "child")]
    source_position: Option<SourcePosition>,
    // Attributes: 0 or more
    #[xmlserde(name = b"attribute", ty = "child")]
    attributes: Vec<Attribute>,

    #[xmlserde(name = b"prerequisite", ty = "child")]
    prerequisites: Vec<Prerequisite>,

    #[xmlserde(name = b"implements", ty = "child")]
    implements: Vec<Implements>,

    #[xmlserde(name = b"function-inline", ty = "child")]
    inline_functions: Vec<FunctionInline>,

    #[xmlserde(name = b"inline-methods", ty = "child")]
    inline_methods: Vec<MethodInline>,

    #[xmlserde(name = b"virtual-method", ty = "child")]
    virtual_methods: Vec<VirtualMethod>,

    #[xmlserde(ty = "untag")]
    fields: Vec<InterfaceField>,
    #[xmlserde(ty = "untag")]
    callables: Vec<Callable>,

    #[xmlserde(name = b"property", ty = "child")]
    properties: Vec<Property>,

    #[xmlserde(name = b"glib:signal", ty = "child")]
    signals: Vec<Signal>,

    #[xmlserde(name = b"constant", ty = "child")]
    constants: Vec<Constant>,
}

impl Interface {
    pub fn name(&self) -> &str {
        &self.name
    }

    pub fn symbol_prefix(&self) -> Option<&str> {
        self.symbol_prefix.as_deref()
    }

    pub fn c_type(&self) -> Option<&str> {
        self.c_type.as_deref()
    }

    pub fn g_type_name(&self) -> &str {
        &self.g_type_name
    }

    pub fn g_get_type(&self) -> &str {
        &self.g_get_type
    }

    pub fn g_type_struct(&self) -> Option<&str> {
        self.g_type_struct.as_deref()
    }

    pub fn prerequisites(&self) -> &[Prerequisite] {
        &self.prerequisites
    }

    pub fn implements(&self) -> &[Implements] {
        &self.implements
    }

    pub fn callables(&self) -> &[Callable] {
        &self.callables
    }

    pub fn constructors(&self) -> impl Iterator<Item = &Function> {
        self.callables.iter().filter_map(|c| match c {
            Callable::Constructor(f) => Some(f),
            _ => None,
        })
    }

    pub fn methods(&self) -> impl Iterator<Item = &Method> {
        self.callables.iter().filter_map(|c| match c {
            Callable::Method(m) => Some(m),
            _ => None,
        })
    }

    pub fn inlined_methods(&self) -> &[MethodInline] {
        &self.inline_methods
    }

    pub fn functions(&self) -> impl Iterator<Item = &Function> {
        self.callables.iter().filter_map(|c| match c {
            Callable::Function(f) => Some(f),
            _ => None,
        })
    }

    pub fn inlined_functions(&self) -> &[FunctionInline] {
        &self.inline_functions
    }

    pub fn virtual_methods(&self) -> &[VirtualMethod] {
        &self.virtual_methods
    }

    pub fn fields(&self) -> &[InterfaceField] {
        &self.fields
    }

    pub fn properties(&self) -> &[Property] {
        &self.properties
    }

    pub fn signals(&self) -> &[Signal] {
        &self.signals
    }

    pub fn constants(&self) -> &[Constant] {
        &self.constants
    }
}

impl_documentable!(Interface);
impl_attributable!(Interface);
impl_info!(Interface);