//
// DO NOT EDIT.  THIS FILE IS GENERATED FROM ../../../dist/idl/nsIASN1Sequence.idl
//


/// `interface nsIASN1Sequence : nsIASN1Object`
///

/// ```text
/// /**
///  * This represents a sequence of ASN.1 objects,
///  * where ASN.1 is "Abstract Syntax Notation number One".
///  *
///  * Overview of how this ASN1 interface is intended to
///  * work.
///  *
///  * First off, the nsIASN1Sequence is any type in ASN1
///  * that consists of sub-elements (ie SEQUENCE, SET)
///  * nsIASN1Printable Items are all the other types that
///  * can be viewed by themselves without interpreting further.
///  * Examples would include INTEGER, UTF-8 STRING, OID.
///  * These are not intended to directly reflect the numberous
///  * types that exist in ASN1, but merely an interface to ease
///  * producing a tree display the ASN1 structure of any DER
///  * object.
///  *
///  * The additional state information carried in this interface
///  * makes it fit for being used as the data structure
///  * when working with visual reprenstation of ASN.1 objects
///  * in a human user interface, like in a tree widget
///  * where open/close state of nodes must be remembered.
///  */
/// ```
///

// The actual type definition for the interface. This struct has methods
// declared on it which will call through its vtable. You never want to pass
// this type around by value, always pass it behind a reference.

#[repr(C)]
pub struct nsIASN1Sequence {
    vtable: *const nsIASN1SequenceVTable,

    /// This field is a phantomdata to ensure that the VTable type and any
    /// struct containing it is not safe to send across threads, as XPCOM is
    /// generally not threadsafe.
    ///
    /// XPCOM interfaces in general are not safe to send across threads.
    __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
}

// Implementing XpCom for an interface exposes its IID, which allows for easy
// use of the `.query_interface<T>` helper method. This also defines that
// method for nsIASN1Sequence.
unsafe impl XpCom for nsIASN1Sequence {
    const IID: nsIID = nsID(0xb6b957e6, 0x1dd1, 0x11b2,
        [0x89, 0xd7, 0xe3, 0x06, 0x24, 0xf5, 0x0b, 0x00]);
}

// We need to implement the RefCounted trait so we can be used with `RefPtr`.
// This trait teaches `RefPtr` how to manage our memory.
unsafe impl RefCounted for nsIASN1Sequence {
    #[inline]
    unsafe fn addref(&self) {
        self.AddRef();
    }
    #[inline]
    unsafe fn release(&self) {
        self.Release();
    }
}

// This trait is implemented on all types which can be coerced to from nsIASN1Sequence.
// It is used in the implementation of `fn coerce<T>`. We hide it from the
// documentation, because it clutters it up a lot.
#[doc(hidden)]
pub trait nsIASN1SequenceCoerce {
    /// Cheaply cast a value of this type from a `nsIASN1Sequence`.
    fn coerce_from(v: &nsIASN1Sequence) -> &Self;
}

// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIASN1SequenceCoerce for nsIASN1Sequence {
    #[inline]
    fn coerce_from(v: &nsIASN1Sequence) -> &Self {
        v
    }
}

impl nsIASN1Sequence {
    /// Cast this `nsIASN1Sequence` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIASN1SequenceCoerce>(&self) -> &T {
        T::coerce_from(self)
    }
}

// Every interface struct type implements `Deref` to its base interface. This
// causes methods on the base interfaces to be directly avaliable on the
// object. For example, you can call `.AddRef` or `.QueryInterface` directly
// on any interface which inherits from `nsISupports`.
impl ::std::ops::Deref for nsIASN1Sequence {
    type Target = nsIASN1Object;
    #[inline]
    fn deref(&self) -> &nsIASN1Object {
        unsafe {
            ::std::mem::transmute(self)
        }
    }
}

// Ensure we can use .coerce() to cast to our base types as well. Any type which
// our base interface can coerce from should be coercable from us as well.
impl<T: nsIASN1ObjectCoerce> nsIASN1SequenceCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIASN1Sequence) -> &Self {
        T::coerce_from(v)
    }
}

// This struct represents the interface's VTable. A pointer to a statically
// allocated version of this struct is at the beginning of every nsIASN1Sequence
// object. It contains one pointer field for each method in the interface. In
// the case where we can't generate a binding for a method, we include a void
// pointer.
#[doc(hidden)]
#[repr(C)]
pub struct nsIASN1SequenceVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsIASN1ObjectVTable,

    /* attribute nsIMutableArray ASN1Objects; */
    pub GetASN1Objects: unsafe extern "system" fn (this: *const nsIASN1Sequence, aASN1Objects: *mut *const nsIMutableArray) -> nsresult,

    /* attribute nsIMutableArray ASN1Objects; */
    pub SetASN1Objects: unsafe extern "system" fn (this: *const nsIASN1Sequence, aASN1Objects: *const nsIMutableArray) -> nsresult,

    /* attribute boolean isValidContainer; */
    pub GetIsValidContainer: unsafe extern "system" fn (this: *const nsIASN1Sequence, aIsValidContainer: *mut bool) -> nsresult,

    /* attribute boolean isValidContainer; */
    pub SetIsValidContainer: unsafe extern "system" fn (this: *const nsIASN1Sequence, aIsValidContainer: bool) -> nsresult,

    /* attribute boolean isExpanded; */
    pub GetIsExpanded: unsafe extern "system" fn (this: *const nsIASN1Sequence, aIsExpanded: *mut bool) -> nsresult,

    /* attribute boolean isExpanded; */
    pub SetIsExpanded: unsafe extern "system" fn (this: *const nsIASN1Sequence, aIsExpanded: bool) -> nsresult,
}


// The implementations of the function wrappers which are exposed to rust code.
// Call these methods rather than manually calling through the VTable struct.
impl nsIASN1Sequence {

    /// ```text
    /// /**
    ///    *  The array of objects stored in the sequence.
    ///    */
    /// ```
    ///

    /// `attribute nsIMutableArray ASN1Objects;`
    #[inline]
    pub unsafe fn GetASN1Objects(&self, aASN1Objects: *mut *const nsIMutableArray) -> nsresult {
        ((*self.vtable).GetASN1Objects)(self, aASN1Objects)
    }


    /// ```text
    /// /**
    ///    *  The array of objects stored in the sequence.
    ///    */
    /// ```
    ///

    /// `attribute nsIMutableArray ASN1Objects;`
    #[inline]
    pub unsafe fn SetASN1Objects(&self, aASN1Objects: *const nsIMutableArray) -> nsresult {
        ((*self.vtable).SetASN1Objects)(self, aASN1Objects)
    }


    /// ```text
    /// /**
    ///    *  Whether the node at this position in the ASN.1 data structure
    ///    *  sequence contains sub elements understood by the
    ///    *  application.
    ///    */
    /// ```
    ///

    /// `attribute boolean isValidContainer;`
    #[inline]
    pub unsafe fn GetIsValidContainer(&self, aIsValidContainer: *mut bool) -> nsresult {
        ((*self.vtable).GetIsValidContainer)(self, aIsValidContainer)
    }


    /// ```text
    /// /**
    ///    *  Whether the node at this position in the ASN.1 data structure
    ///    *  sequence contains sub elements understood by the
    ///    *  application.
    ///    */
    /// ```
    ///

    /// `attribute boolean isValidContainer;`
    #[inline]
    pub unsafe fn SetIsValidContainer(&self, aIsValidContainer: bool) -> nsresult {
        ((*self.vtable).SetIsValidContainer)(self, aIsValidContainer)
    }


    /// ```text
    /// /**
    ///    *  Whether the contained objects should be shown or hidden.
    ///    *  A UI implementation can use this flag to store the current
    ///    *  expansion state when shown in a tree widget.
    ///    */
    /// ```
    ///

    /// `attribute boolean isExpanded;`
    #[inline]
    pub unsafe fn GetIsExpanded(&self, aIsExpanded: *mut bool) -> nsresult {
        ((*self.vtable).GetIsExpanded)(self, aIsExpanded)
    }


    /// ```text
    /// /**
    ///    *  Whether the contained objects should be shown or hidden.
    ///    *  A UI implementation can use this flag to store the current
    ///    *  expansion state when shown in a tree widget.
    ///    */
    /// ```
    ///

    /// `attribute boolean isExpanded;`
    #[inline]
    pub unsafe fn SetIsExpanded(&self, aIsExpanded: bool) -> nsresult {
        ((*self.vtable).SetIsExpanded)(self, aIsExpanded)
    }


}