Generated file

Copy as Markdown

Other Tools

//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/browser/components/shell/nsIMacShellService.idl
//
/// `interface nsIMacShellService : nsIShellService`
///
// 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 nsIMacShellService {
vtable: &'static nsIMacShellServiceVTable,
/// 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
// 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 nsIMacShellService.
unsafe impl XpCom for nsIMacShellService {
const IID: nsIID = nsID(0x6732dbda, 0x8f80, 0x4221,
[0x84, 0x01, 0xac, 0x94, 0x32, 0x8f, 0xa5, 0x25]);
}
// 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 nsIMacShellService {
#[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 nsIMacShellService.
// 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 nsIMacShellServiceCoerce {
/// Cheaply cast a value of this type from a `nsIMacShellService`.
fn coerce_from(v: &nsIMacShellService) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIMacShellServiceCoerce for nsIMacShellService {
#[inline]
fn coerce_from(v: &nsIMacShellService) -> &Self {
v
}
}
impl nsIMacShellService {
/// Cast this `nsIMacShellService` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIMacShellServiceCoerce>(&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 nsIMacShellService {
type Target = nsIShellService;
#[inline]
fn deref(&self) -> &nsIShellService {
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: nsIShellServiceCoerce> nsIMacShellServiceCoerce for T {
#[inline]
fn coerce_from(v: &nsIMacShellService) -> &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 nsIMacShellService
// 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 nsIMacShellServiceVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsIShellServiceVTable,
/* void showDesktopPreferences (); */
pub ShowDesktopPreferences: unsafe extern "system" fn (this: *const nsIMacShellService) -> ::nserror::nsresult,
/* void showSecurityPreferences (in ACString aPaneID); */
pub ShowSecurityPreferences: unsafe extern "system" fn (this: *const nsIMacShellService, aPaneID: *const ::nsstring::nsACString) -> ::nserror::nsresult,
/* Array<Array<AString>> getAvailableApplicationsForProtocol (in ACString protocol); */
pub GetAvailableApplicationsForProtocol: unsafe extern "system" fn (this: *const nsIMacShellService, protocol: *const ::nsstring::nsACString, _retval: *mut thin_vec::ThinVec<thin_vec::ThinVec<::nsstring::nsString>>) -> ::nserror::nsresult,
/* readonly attribute boolean canSetAsDefaultHandler; */
pub GetCanSetAsDefaultHandler: unsafe extern "system" fn (this: *const nsIMacShellService, aCanSetAsDefaultHandler: *mut bool) -> ::nserror::nsresult,
/* [implicit_jscontext] Promise setAsDefaultHandlerFor (in AString aFileExtensionOrProtocol); */
/// Unable to generate binding because `jscontext is unsupported`
pub SetAsDefaultHandlerFor: *const ::libc::c_void,
/* boolean isDefaultHandlerFor (in AString aFileExtensionOrProtocol); */
pub IsDefaultHandlerFor: unsafe extern "system" fn (this: *const nsIMacShellService, aFileExtensionOrProtocol: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult,
/* boolean isDefaultHandlerAWebBrowserFor (in AString aFileExtensionOrProtocol); */
pub IsDefaultHandlerAWebBrowserFor: unsafe extern "system" fn (this: *const nsIMacShellService, aFileExtensionOrProtocol: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult,
/* boolean enableLaunchOnLogin (); */
pub EnableLaunchOnLogin: unsafe extern "system" fn (this: *const nsIMacShellService, _retval: *mut bool) -> ::nserror::nsresult,
/* boolean disableLaunchOnLogin (); */
pub DisableLaunchOnLogin: unsafe extern "system" fn (this: *const nsIMacShellService, _retval: *mut bool) -> ::nserror::nsresult,
/* boolean getLaunchOnLoginEnabled (); */
pub GetLaunchOnLoginEnabled: unsafe extern "system" fn (this: *const nsIMacShellService, _retval: *mut bool) -> ::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 nsIMacShellService {
/// ```text
/// /**
/// * Opens the desktop preferences, e.g. for after setting the background.
/// */
/// ```
///
/// `void showDesktopPreferences ();`
#[inline]
pub unsafe fn ShowDesktopPreferences(&self, ) -> ::nserror::nsresult {
((*self.vtable).ShowDesktopPreferences)(self, )
}
/// ```text
/// /**
/// * @param aPaneID used by macOS to identify the pane to open.
/// * Example arguments:
/// * * "" - use the default Security and Privacy pane.
/// * * General
/// * * Privacy
/// * * Privacy_AllFiles
/// * * Privacy_Camera
/// * * Privacy_Microphone
/// */
/// ```
///
/// `void showSecurityPreferences (in ACString aPaneID);`
#[inline]
pub unsafe fn ShowSecurityPreferences(&self, aPaneID: *const ::nsstring::nsACString) -> ::nserror::nsresult {
((*self.vtable).ShowSecurityPreferences)(self, aPaneID)
}
/// `Array<Array<AString>> getAvailableApplicationsForProtocol (in ACString protocol);`
#[inline]
pub unsafe fn GetAvailableApplicationsForProtocol(&self, protocol: *const ::nsstring::nsACString, _retval: *mut thin_vec::ThinVec<thin_vec::ThinVec<::nsstring::nsString>>) -> ::nserror::nsresult {
((*self.vtable).GetAvailableApplicationsForProtocol)(self, protocol, _retval)
}
/// ```text
/// /**
/// * Whether setting Firefox as the default handler for a file extension or
/// * protocol is supported on this system. The underlying NSWorkspace API
/// * requires macOS 12, so this is false on older versions, where the other
/// * default-handler members are no-ops.
/// */
/// ```
///
/// `readonly attribute boolean canSetAsDefaultHandler;`
#[inline]
pub unsafe fn GetCanSetAsDefaultHandler(&self, aCanSetAsDefaultHandler: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetCanSetAsDefaultHandler)(self, aCanSetAsDefaultHandler)
}
/// ```text
/// /**
/// * Set Firefox as the default handler for the given file extension (like
/// * ".pdf") or protocol (like "https") via NSWorkspace. A leading "." marks a
/// * file extension; anything else is treated as a URL scheme. macOS may ask the
/// * user to confirm the change; the returned promise resolves only once that
/// * interaction completes.
/// *
/// * @return {Promise<boolean>} Resolves true if the change was applied (i.e.
/// * the user confirmed), false otherwise (the user declined, it failed,
/// * or canSetAsDefaultHandler is false).
/// */
/// ```
///
/// `[implicit_jscontext] Promise setAsDefaultHandlerFor (in AString aFileExtensionOrProtocol);`
const _SetAsDefaultHandlerFor: () = ();
/// ```text
/// /**
/// * Whether Firefox is the current default handler for the given file
/// * extension (like ".pdf") or protocol (like "https"). A leading "." marks a
/// * file extension; anything else is treated as a URL scheme.
/// *
/// * @return true if Firefox is the default handler. Always false when
/// * canSetAsDefaultHandler is false (macOS older than 12).
/// */
/// ```
///
/// `boolean isDefaultHandlerFor (in AString aFileExtensionOrProtocol);`
#[inline]
pub unsafe fn IsDefaultHandlerFor(&self, aFileExtensionOrProtocol: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).IsDefaultHandlerFor)(self, aFileExtensionOrProtocol, _retval)
}
/// ```text
/// /**
/// * @return true if the application currently registered as the default
/// * handler for the given file extension (like ".pdf") or protocol
/// * (like "https") is also a web browser, i.e. it is registered to open
/// * "https" URLs. Used to restrict replacing the default handler to the
/// * case where another browser currently owns it, so we don't displace
/// * a dedicated app such as Preview or Acrobat. A leading "." marks a
/// * file extension; anything else is treated as a URL scheme. Always
/// * false on macOS older than 12.
/// */
/// ```
///
/// `boolean isDefaultHandlerAWebBrowserFor (in AString aFileExtensionOrProtocol);`
#[inline]
pub unsafe fn IsDefaultHandlerAWebBrowserFor(&self, aFileExtensionOrProtocol: *const ::nsstring::nsAString, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).IsDefaultHandlerAWebBrowserFor)(self, aFileExtensionOrProtocol, _retval)
}
/// `boolean enableLaunchOnLogin ();`
#[inline]
pub unsafe fn EnableLaunchOnLogin(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).EnableLaunchOnLogin)(self, _retval)
}
/// `boolean disableLaunchOnLogin ();`
#[inline]
pub unsafe fn DisableLaunchOnLogin(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).DisableLaunchOnLogin)(self, _retval)
}
/// `boolean getLaunchOnLoginEnabled ();`
#[inline]
pub unsafe fn GetLaunchOnLoginEnabled(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetLaunchOnLoginEnabled)(self, _retval)
}
}