//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/browser/components/shell/nsISecondaryTile.idl
//
/// `interface nsISecondaryTileListener : nsISupports`
///
/// ```text
/// /**
/// * Provides functions that are called (on the main thread) when the secondary
/// * tile creation or deletion finishes.
/// */
/// ```
///
// 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 nsISecondaryTileListener {
vtable: &'static nsISecondaryTileListenerVTable,
/// 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 nsISecondaryTileListener.
unsafe impl XpCom for nsISecondaryTileListener {
const IID: nsIID = nsID(0x338038ab, 0xc803, 0x46f4,
[0x95, 0xa3, 0xc6, 0x00, 0xd0, 0x05, 0x4a, 0x21]);
}
// 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 nsISecondaryTileListener {
#[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 nsISecondaryTileListener.
// 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 nsISecondaryTileListenerCoerce {
/// Cheaply cast a value of this type from a `nsISecondaryTileListener`.
fn coerce_from(v: &nsISecondaryTileListener) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsISecondaryTileListenerCoerce for nsISecondaryTileListener {
#[inline]
fn coerce_from(v: &nsISecondaryTileListener) -> &Self {
v
}
}
impl nsISecondaryTileListener {
/// Cast this `nsISecondaryTileListener` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsISecondaryTileListenerCoerce>(&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 nsISecondaryTileListener {
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> nsISecondaryTileListenerCoerce for T {
#[inline]
fn coerce_from(v: &nsISecondaryTileListener) -> &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 nsISecondaryTileListener
// 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 nsISecondaryTileListenerVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void succeeded (in boolean accepted); */
pub Succeeded: unsafe extern "system" fn (this: *const nsISecondaryTileListener, accepted: bool) -> ::nserror::nsresult,
/* void failed (in long aHresult); */
pub Failed: unsafe extern "system" fn (this: *const nsISecondaryTileListener, aHresult: i32) -> ::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 nsISecondaryTileListener {
/// `void succeeded (in boolean accepted);`
#[inline]
pub unsafe fn Succeeded(&self, accepted: bool) -> ::nserror::nsresult {
((*self.vtable).Succeeded)(self, accepted)
}
/// `void failed (in long aHresult);`
#[inline]
pub unsafe fn Failed(&self, aHresult: i32) -> ::nserror::nsresult {
((*self.vtable).Failed)(self, aHresult)
}
}
/// `interface nsISecondaryTileService : nsISupports`
///
/// ```text
/// /**
/// * Provides an interface to Windows' secondary tile APIs.
/// *
/// * Secondary tiles provide a way for apps to display additional entrypoints
/// * within Windows. Right now, this only adds them to the taskbar, such that
/// * they will open the browser with the provided command line arguments when
/// * clicked.
/// *
/// * This API doesn't appear to work on non-MSIX Windows installs. Furthermore,
/// * you probably want to use ShellService.requestCreateAndPinSecondaryTile and
/// * ShellService.requestDeleteSecondaryTile to get nice JS promises instead of
/// * XPCOM callbacks.
/// */
/// ```
///
// 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 nsISecondaryTileService {
vtable: &'static nsISecondaryTileServiceVTable,
/// 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 nsISecondaryTileService.
unsafe impl XpCom for nsISecondaryTileService {
const IID: nsIID = nsID(0xf30f4087, 0xbac4, 0x4c51,
[0xb7, 0x19, 0x27, 0x5b, 0xc2, 0x92, 0xcb, 0x01]);
}
// 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 nsISecondaryTileService {
#[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 nsISecondaryTileService.
// 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 nsISecondaryTileServiceCoerce {
/// Cheaply cast a value of this type from a `nsISecondaryTileService`.
fn coerce_from(v: &nsISecondaryTileService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsISecondaryTileServiceCoerce for nsISecondaryTileService {
#[inline]
fn coerce_from(v: &nsISecondaryTileService) -> &Self {
v
}
}
impl nsISecondaryTileService {
/// Cast this `nsISecondaryTileService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsISecondaryTileServiceCoerce>(&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 nsISecondaryTileService {
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> nsISecondaryTileServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsISecondaryTileService) -> &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 nsISecondaryTileService
// 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 nsISecondaryTileServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void requestCreateAndPin (in ACString aTileId, in AString aName, in ACString aIconPath, in Array<ACString> aArguments, in nsISecondaryTileListener aListener); */
pub RequestCreateAndPin: unsafe extern "system" fn (this: *const nsISecondaryTileService, aTileId: *const ::nsstring::nsACString, aName: *const ::nsstring::nsAString, aIconPath: *const ::nsstring::nsACString, aArguments: *const thin_vec::ThinVec<::nsstring::nsCString>, aListener: *const nsISecondaryTileListener) -> ::nserror::nsresult,
/* void requestDelete (in ACString aTileId, in nsISecondaryTileListener aListener); */
pub RequestDelete: unsafe extern "system" fn (this: *const nsISecondaryTileService, aTileId: *const ::nsstring::nsACString, aListener: *const nsISecondaryTileListener) -> ::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 nsISecondaryTileService {
/// ```text
/// /**
/// * Requests to create a new secondary tile and pin it to the taskbar.
/// *
/// * From JavaScript, you'll likely prefer to use
/// * ShellService.requestCreateAndPinSecondaryTile, since that allows using a
/// * JS promise.
/// *
/// * @param aTileId The ID to associate with the tile. Needs to be unique, and
/// * must not contain any slashes or backslashes.
/// * @param aName The name of the tile, which will be visible to the user.
/// * @param aIconPath The path to the icon to associate with the tile. Once
/// * the callback is called, the icon won't be used anymore.
/// * @param aArguments Arguments the system should pass to the browser when
/// * the user clicks on the secondary tile.
/// * @param aListener Callbacks that will run when the tile creation is
/// * completed.
/// * @throws NS_ERROR_INVALID_ARG if the tile ID contains a slash or backslash.
/// */
/// ```
///
/// `void requestCreateAndPin (in ACString aTileId, in AString aName, in ACString aIconPath, in Array<ACString> aArguments, in nsISecondaryTileListener aListener);`
#[inline]
pub unsafe fn RequestCreateAndPin(&self, aTileId: *const ::nsstring::nsACString, aName: *const ::nsstring::nsAString, aIconPath: *const ::nsstring::nsACString, aArguments: *const thin_vec::ThinVec<::nsstring::nsCString>, aListener: *const nsISecondaryTileListener) -> ::nserror::nsresult {
((*self.vtable).RequestCreateAndPin)(self, aTileId, aName, aIconPath, aArguments, aListener)
}
/// ```text
/// /**
/// * Requests to delete a secondary tile from the taskbar.
/// *
/// * From JavaScript, you'll likely prefer to use
/// * ShellService.requestDeleteSecondaryTile, since that allows using a JS
/// * promise.
/// *
/// * @param aTileId The ID that was used with nsISecondaryTile::requestCreate.
/// * @param aListener Callbacks that will run when the tile creation is
/// * completed.
/// * @throws NS_ERROR_INVALID_ARG if the tile ID contains a slash or backslash.
/// */
/// ```
///
/// `void requestDelete (in ACString aTileId, in nsISecondaryTileListener aListener);`
#[inline]
pub unsafe fn RequestDelete(&self, aTileId: *const ::nsstring::nsACString, aListener: *const nsISecondaryTileListener) -> ::nserror::nsresult {
((*self.vtable).RequestDelete)(self, aTileId, aListener)
}
}