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


/// `interface nsIBrowser : nsISupports`
///


// 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 nsIBrowser {
    vtable: *const nsIBrowserVTable,

    /// 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 nsIBrowser.
unsafe impl XpCom for nsIBrowser {
    const IID: nsIID = nsID(0x14e5a0cb, 0xe223, 0x4202,
        [0x95, 0xe8, 0xfe, 0x53, 0x27, 0x51, 0x93, 0xea]);
}

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

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

impl nsIBrowser {
    /// Cast this `nsIBrowser` to one of its base interfaces.
    #[inline]
    pub fn coerce<T: nsIBrowserCoerce>(&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 nsIBrowser {
    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> nsIBrowserCoerce for T {
    #[inline]
    fn coerce_from(v: &nsIBrowser) -> &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 nsIBrowser
// 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 nsIBrowserVTable {
    /// We need to include the members from the base interface's vtable at the start
    /// of the VTable definition.
    pub __base: nsISupportsVTable,

    /* readonly attribute nsIFrameLoader sameProcessAsFrameLoader; */
    pub GetSameProcessAsFrameLoader: unsafe extern "system" fn (this: *const nsIBrowser, aSameProcessAsFrameLoader: *mut *const nsIFrameLoader) -> nsresult,

    /* void dropLinks (in unsigned long linksCount, [array, size_is (linksCount)] in wstring links, in nsIPrincipal aTriggeringPrincipal); */
    pub DropLinks: unsafe extern "system" fn (this: *const nsIBrowser, linksCount: libc::uint32_t, links: *mut *const libc::int16_t, aTriggeringPrincipal: *const nsIPrincipal) -> nsresult,

    /* void swapBrowsers (in nsIBrowser aOtherBrowser, in unsigned long aFlags); */
    pub SwapBrowsers: unsafe extern "system" fn (this: *const nsIBrowser, aOtherBrowser: *const nsIBrowser, aFlags: libc::uint32_t) -> nsresult,

    /* void closeBrowser (); */
    pub CloseBrowser: unsafe extern "system" fn (this: *const nsIBrowser) -> 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 nsIBrowser {
    /// ```text
    /// /**
    ///    * Flags for controlling the behavior of swapBrowsers
    ///    */
    /// /**
    ///    * The default options. This is used for swapping browsers between windows
    ///    */
    /// ```
    ///

    pub const SWAP_DEFAULT: i64 = 0;

    /// ```text
    /// /**
    ///    * If this bit is set, swapping the browsers will not swap the permanentKey of
    ///    * the browsers. This is used when performing cross process loads by swapping
    ///    * browsers.
    ///    */
    /// ```
    ///

    pub const SWAP_KEEP_PERMANENT_KEY: i64 = 1;

    /// ```text
    /// /**
    ///    * Gets an optional frame loader that is "related" to this browser.
    ///    * If this exists, then we should attempt to use the same content parent as
    ///    * this frame loader for any new tab parents.  For example, view source
    ///    * browsers set this to the frame loader for the original content to ensure
    ///    * they are loaded in the same process as the content.
    ///    */
    /// ```
    ///

    /// `readonly attribute nsIFrameLoader sameProcessAsFrameLoader;`
    #[inline]
    pub unsafe fn GetSameProcessAsFrameLoader(&self, aSameProcessAsFrameLoader: *mut *const nsIFrameLoader) -> nsresult {
        ((*self.vtable).GetSameProcessAsFrameLoader)(self, aSameProcessAsFrameLoader)
    }



    /// `void dropLinks (in unsigned long linksCount, [array, size_is (linksCount)] in wstring links, in nsIPrincipal aTriggeringPrincipal);`
    #[inline]
    pub unsafe fn DropLinks(&self, linksCount: libc::uint32_t, links: *mut *const libc::int16_t, aTriggeringPrincipal: *const nsIPrincipal) -> nsresult {
        ((*self.vtable).DropLinks)(self, linksCount, links, aTriggeringPrincipal)
    }


    /// ```text
    /// /**
    ///    * Swapping of frameloaders are usually initiated from a frameloader owner
    ///    * or other components operating on frameloader owners. This is done by calling
    ///    * swapFrameLoaders at MozFrameLoaderOwner webidl interface.
    ///    *
    ///    * This function aimed to provide the other way around -
    ///    * if the swapping is initiated from frameloader itself or other platform level
    ///    * components, it uses this interface to delegate the swapping request to
    ///    * frameloader owners and ask them to re-initiate frameloader swapping, so that
    ///    * frameloader owners such as <xul:browser> can setup their properties and /
    ///    * or listeners properly on swapping.
    ///    */
    /// ```
    ///

    /// `void swapBrowsers (in nsIBrowser aOtherBrowser, in unsigned long aFlags);`
    #[inline]
    pub unsafe fn SwapBrowsers(&self, aOtherBrowser: *const nsIBrowser, aFlags: libc::uint32_t) -> nsresult {
        ((*self.vtable).SwapBrowsers)(self, aOtherBrowser, aFlags)
    }


    /// ```text
    /// /**
    ///    * Close the browser (usually means to remove a tab).
    ///    */
    /// ```
    ///

    /// `void closeBrowser ();`
    #[inline]
    pub unsafe fn CloseBrowser(&self, ) -> nsresult {
        ((*self.vtable).CloseBrowser)(self, )
    }


}