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


/// `interface nsIWyciwygChannel : nsIChannel`
///

/// ```text
/// /**
///  * A channel to  manage all cache-related interactions for layout
///  * when it is dealing with dynamic pages created through
///  * document.write(). This interface provides methods that will
///  * help layout save dynamic pages in cache for future retrievals.
///  */
/// ```
///

// 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 nsIWyciwygChannel {
    vtable: *const nsIWyciwygChannelVTable,

    /// 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 nsIWyciwygChannel.
unsafe impl XpCom for nsIWyciwygChannel {
    const IID: nsIID = nsID(0x8b8f3341, 0x46da, 0x40f5,
        [0xa1, 0x6f, 0x41, 0xa9, 0x1f, 0x5d, 0x25, 0xdd]);
}

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

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

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

    /* void writeToCacheEntry (in AString aData); */
    pub WriteToCacheEntry: unsafe extern "system" fn (this: *const nsIWyciwygChannel, aData: &::nsstring::nsAString) -> nsresult,

    /* void closeCacheEntry (in nsresult reason); */
    pub CloseCacheEntry: unsafe extern "system" fn (this: *const nsIWyciwygChannel, reason: nsresult) -> nsresult,

    /* void setSecurityInfo (in nsISupports aSecurityInfo); */
    pub SetSecurityInfo: unsafe extern "system" fn (this: *const nsIWyciwygChannel, aSecurityInfo: *const nsISupports) -> nsresult,

    /* void setCharsetAndSource (in long aSource, in ACString aCharset); */
    pub SetCharsetAndSource: unsafe extern "system" fn (this: *const nsIWyciwygChannel, aSource: libc::int32_t, aCharset: &::nsstring::nsACString) -> nsresult,

    /* ACString getCharsetAndSource (out long aSource); */
    pub GetCharsetAndSource: unsafe extern "system" fn (this: *const nsIWyciwygChannel, aSource: *mut libc::int32_t, _retval: &mut ::nsstring::nsACString) -> 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 nsIWyciwygChannel {

    /// ```text
    /// /**
    ///    * Append data to the cache entry; opens the cache entry if necessary.
    ///    */
    /// ```
    ///

    /// `void writeToCacheEntry (in AString aData);`
    #[inline]
    pub unsafe fn WriteToCacheEntry(&self, aData: &::nsstring::nsAString) -> nsresult {
        ((*self.vtable).WriteToCacheEntry)(self, aData)
    }


    /// ```text
    /// /**
    ///    * Close the cache entry; subsequent writes have undefined behavior.
    ///    */
    /// ```
    ///

    /// `void closeCacheEntry (in nsresult reason);`
    #[inline]
    pub unsafe fn CloseCacheEntry(&self, reason: nsresult) -> nsresult {
        ((*self.vtable).CloseCacheEntry)(self, reason)
    }


    /// ```text
    /// /**
    ///    * Set the wyciwyg channels security info
    ///    */
    /// ```
    ///

    /// `void setSecurityInfo (in nsISupports aSecurityInfo);`
    #[inline]
    pub unsafe fn SetSecurityInfo(&self, aSecurityInfo: *const nsISupports) -> nsresult {
        ((*self.vtable).SetSecurityInfo)(self, aSecurityInfo)
    }


    /// ```text
    /// /**
    ///    * Store and read a charset and charset source on the wyciwyg channel.  These
    ///    * are opaque values to the channel; consumers who set them should know what
    ///    * they mean.
    ///    */
    /// ```
    ///

    /// `void setCharsetAndSource (in long aSource, in ACString aCharset);`
    #[inline]
    pub unsafe fn SetCharsetAndSource(&self, aSource: libc::int32_t, aCharset: &::nsstring::nsACString) -> nsresult {
        ((*self.vtable).SetCharsetAndSource)(self, aSource, aCharset)
    }


    /// ```text
    /// /**
    ///    * The return value is the charset.  Throws if either the charset or the
    ///    * source cannot be retrieved.  This is guaranteed to return a nonzero source
    ///    * and a nonempty charset if it does not throw.
    ///    */
    /// ```
    ///

    /// `ACString getCharsetAndSource (out long aSource);`
    #[inline]
    pub unsafe fn GetCharsetAndSource(&self, aSource: *mut libc::int32_t, _retval: &mut ::nsstring::nsACString) -> nsresult {
        ((*self.vtable).GetCharsetAndSource)(self, aSource, _retval)
    }


}