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


/// `interface nsIVersionComparator : nsISupports`
///

/// ```text
/// /**
///  * Version strings are dot-separated sequences of version-parts.
///  *
///  * A version-part consists of up to four parts, all of which are optional:
///  *
///  * <number-a><string-b><number-c><string-d (everything else)>
///  *
///  * A version-part may also consist of a single asterisk "*" which indicates
///  * "infinity".
///  *
///  * Numbers are base-10, and are zero if left out.
///  * Strings are compared bytewise.
///  *
///  * For additional backwards compatibility, if "string-b" is "+" then
///  * "number-a" is incremented by 1 and "string-b" becomes "pre".
///  *
///  * 1.0pre1
///  * < 1.0pre2
///  *   < 1.0 == 1.0.0 == 1.0.0.0
///  *     < 1.1pre == 1.1pre0 == 1.0+
///  *       < 1.1pre1a
///  *         < 1.1pre1
///  *           < 1.1pre10a
///  *             < 1.1pre10
///  *
///  * Although not required by this interface, it is recommended that
///  * numbers remain within the limits of a signed char, i.e. -127 to 128.
///  */
/// ```
///

// 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 nsIVersionComparator {
    vtable: *const nsIVersionComparatorVTable,

    /// 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 nsIVersionComparator.
unsafe impl XpCom for nsIVersionComparator {
    const IID: nsIID = nsID(0xe6cd620a, 0xedbb, 0x41d2,
        [0x9e, 0x42, 0x9a, 0x2f, 0xfc, 0x81, 0x07, 0xf3]);
}

// 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 nsIVersionComparator {
    #[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 nsIVersionComparator.
// 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 nsIVersionComparatorCoerce {
    /// Cheaply cast a value of this type from a `nsIVersionComparator`.
    fn coerce_from(v: &nsIVersionComparator) -> &Self;
}

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

impl nsIVersionComparator {
    /// Cast this `nsIVersionComparator` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIVersionComparatorCoerce>(&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 nsIVersionComparator {
    type Target = nsISupports;
    #[inline]
    fn deref(&self) -> &nsISupports {
        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: nsISupportsCoerce> nsIVersionComparatorCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIVersionComparator) -> &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 nsIVersionComparator
// 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 nsIVersionComparatorVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* long compare (in ACString A, in ACString B); */
    pub Compare: unsafe extern "system" fn (this: *const nsIVersionComparator, A: &::nsstring::nsACString, B: &::nsstring::nsACString, _retval: *mut libc::int32_t) -> 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 nsIVersionComparator {

    /// ```text
    /// /**
    ///    * Compare two version strings
    ///    * @param   A   The first version
    ///    * @param   B   The second version
    ///    * @returns < 0 if A < B
    ///    *          = 0 if A == B
    ///    *          > 0 if A > B
    ///    */
    /// ```
    ///

    /// `long compare (in ACString A, in ACString B);`
    #[inline]
    pub unsafe fn Compare(&self, A: &::nsstring::nsACString, B: &::nsstring::nsACString, _retval: *mut libc::int32_t) -> nsresult {
        ((*self.vtable).Compare)(self, A, B, _retval)
    }


}