Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/dom/interfaces/sidebar/nsIWebProtocolHandlerRegistrar.idl
//
/// `interface nsIWebProtocolHandlerRegistrar : nsISupports`
///
/// ```text
/// /**
/// * nsIWebProtocolHandlerRegistrar
/// *
/// * Applications wishing to use web protocol handlers need to implement this
/// * interface. Typically they will prompt the user to confirm adding an entry
/// * to the local list.
/// *
/// * The component must have the contract id defined below so that the Navigator
/// * implementation can invoke it.
/// */
/// ```
///
// 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 nsIWebProtocolHandlerRegistrar {
vtable: &'static nsIWebProtocolHandlerRegistrarVTable,
/// This field is a phantomdata to ensure that the VTable type and any
/// struct containing it is not safe to send across threads by default, as
/// XPCOM is generally not threadsafe.
///
/// If this type is marked as [rust_sync], there will be explicit `Send` and
/// `Sync` implementations on this type, which will override the inherited
/// negative impls from `Rc`.
__nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>,
// Make the rust compiler aware that there might be interior mutability
// in what actually implements the interface. This works around UB
// introduced by https://github.com/llvm/llvm-project/commit/01859da84bad95fd51d6a03b08b60c660e642a4f
// that a rust lint would make blatantly obvious, but doesn't exist.
// This prevents optimizations, but those optimizations weren't available
// before rustc switched to LLVM 16, and they now cause problems because
// of the UB.
// Until there's a lint available to find all our UB, it's simpler to
// avoid the UB in the first place, at the cost of preventing optimizations
// in places that don't cause UB. But again, those optimizations weren't
// available before.
__maybe_interior_mutability: ::std::cell::UnsafeCell<[u8; 0]>,
}
// 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 nsIWebProtocolHandlerRegistrar.
unsafe impl XpCom for nsIWebProtocolHandlerRegistrar {
const IID: nsIID = nsID(0x1ce9ef8d, 0xf462, 0x49ca,
[0xb8, 0xe9, 0xc9, 0x46, 0xc4, 0xf3, 0x7d, 0x6e]);
}
// 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 nsIWebProtocolHandlerRegistrar {
#[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 nsIWebProtocolHandlerRegistrar.
// 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 nsIWebProtocolHandlerRegistrarCoerce {
/// Cheaply cast a value of this type from a `nsIWebProtocolHandlerRegistrar`.
fn coerce_from(v: &nsIWebProtocolHandlerRegistrar) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIWebProtocolHandlerRegistrarCoerce for nsIWebProtocolHandlerRegistrar {
#[inline]
fn coerce_from(v: &nsIWebProtocolHandlerRegistrar) -> &Self {
v
}
}
impl nsIWebProtocolHandlerRegistrar {
/// Cast this `nsIWebProtocolHandlerRegistrar` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIWebProtocolHandlerRegistrarCoerce>(&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 nsIWebProtocolHandlerRegistrar {
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> nsIWebProtocolHandlerRegistrarCoerce for T {
#[inline]
fn coerce_from(v: &nsIWebProtocolHandlerRegistrar) -> &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 nsIWebProtocolHandlerRegistrar
// 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 nsIWebProtocolHandlerRegistrarVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void registerProtocolHandler (in AString protocol, in nsIURI uri, in AString title, in nsIURI documentURI, in nsISupports windowOrBrowser); */
pub RegisterProtocolHandler: unsafe extern "system" fn (this: *const nsIWebProtocolHandlerRegistrar, protocol: *const ::nsstring::nsAString, uri: *const nsIURI, title: *const ::nsstring::nsAString, documentURI: *const nsIURI, windowOrBrowser: *const nsISupports) -> ::nserror::nsresult,
/* void removeProtocolHandler (in AString protocol, in AString uri); */
pub RemoveProtocolHandler: unsafe extern "system" fn (this: *const nsIWebProtocolHandlerRegistrar, protocol: *const ::nsstring::nsAString, uri: *const ::nsstring::nsAString) -> ::nserror::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 nsIWebProtocolHandlerRegistrar {
/// ```text
/// /**
/// * See documentation in Navigator.webidl
/// * The additional contentWindow param for this method represents the dom
/// * content window from which the method has been called, or its browser window.
/// */
/// ```
///
/// `void registerProtocolHandler (in AString protocol, in nsIURI uri, in AString title, in nsIURI documentURI, in nsISupports windowOrBrowser);`
#[inline]
pub unsafe fn RegisterProtocolHandler(&self, protocol: *const ::nsstring::nsAString, uri: *const nsIURI, title: *const ::nsstring::nsAString, documentURI: *const nsIURI, windowOrBrowser: *const nsISupports) -> ::nserror::nsresult {
((*self.vtable).RegisterProtocolHandler)(self, protocol, uri, title, documentURI, windowOrBrowser)
}
/// ```text
/// /**
/// * Removes a registered protocol handler
/// *
/// * While registerProtocolHandler is exposed on Navigator, unregistering
/// * is exposed through the UI code.
/// * @param protocol
/// * The protocol scheme to remove a service handler for
/// * @param uri
/// * The uri of the service handler to remove
/// */
/// ```
///
/// `void removeProtocolHandler (in AString protocol, in AString uri);`
#[inline]
pub unsafe fn RemoveProtocolHandler(&self, protocol: *const ::nsstring::nsAString, uri: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).RemoveProtocolHandler)(self, protocol, uri)
}
}