Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/widget/nsIStandaloneNativeMenu.idl
//
/// `interface nsIStandaloneNativeMenu : nsISupports`
///
/// ```text
/// /**
/// * Platform-independent interface to platform native menu objects.
/// */
/// ```
///
// 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 nsIStandaloneNativeMenu {
vtable: &'static nsIStandaloneNativeMenuVTable,
/// 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 nsIStandaloneNativeMenu.
unsafe impl XpCom for nsIStandaloneNativeMenu {
const IID: nsIID = nsID(0x7f7201eb, 0x510c, 0x4cef,
[0xbd, 0xf0, 0x04, 0xa1, 0x5a, 0x7a, 0x4a, 0x8c]);
}
// 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 nsIStandaloneNativeMenu {
#[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 nsIStandaloneNativeMenu.
// 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 nsIStandaloneNativeMenuCoerce {
/// Cheaply cast a value of this type from a `nsIStandaloneNativeMenu`.
fn coerce_from(v: &nsIStandaloneNativeMenu) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIStandaloneNativeMenuCoerce for nsIStandaloneNativeMenu {
#[inline]
fn coerce_from(v: &nsIStandaloneNativeMenu) -> &Self {
v
}
}
impl nsIStandaloneNativeMenu {
/// Cast this `nsIStandaloneNativeMenu` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIStandaloneNativeMenuCoerce>(&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 nsIStandaloneNativeMenu {
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> nsIStandaloneNativeMenuCoerce for T {
#[inline]
fn coerce_from(v: &nsIStandaloneNativeMenu) -> &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 nsIStandaloneNativeMenu
// 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 nsIStandaloneNativeMenuVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* void init (in Element aElement); */
pub Init: unsafe extern "system" fn (this: *const nsIStandaloneNativeMenu, aElement: *const libc::c_void) -> ::nserror::nsresult,
/* boolean menuWillOpen (); */
pub MenuWillOpen: unsafe extern "system" fn (this: *const nsIStandaloneNativeMenu, _retval: *mut bool) -> ::nserror::nsresult,
/* void activateNativeMenuItemAt (in AString anIndexString); */
pub ActivateNativeMenuItemAt: unsafe extern "system" fn (this: *const nsIStandaloneNativeMenu, anIndexString: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* void forceUpdateNativeMenuAt (in AString anIndexString); */
pub ForceUpdateNativeMenuAt: unsafe extern "system" fn (this: *const nsIStandaloneNativeMenu, anIndexString: *const ::nsstring::nsAString) -> ::nserror::nsresult,
/* void dump (); */
pub Dump: unsafe extern "system" fn (this: *const nsIStandaloneNativeMenu) -> ::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 nsIStandaloneNativeMenu {
/// ```text
/// /**
/// * Initialize the native menu using given XUL DOM element.
/// *
/// * @param aDOMElement A XUL DOM element of tag type |menu| or |menupopup|.
/// */
/// ```
///
/// `void init (in Element aElement);`
#[inline]
pub unsafe fn Init(&self, aElement: *const libc::c_void) -> ::nserror::nsresult {
((*self.vtable).Init)(self, aElement)
}
/// ```text
/// /**
/// * This method must be called before the menu is opened and displayed to the
/// * user. It allows the platform code to update the menu and also determine
/// * whether the menu should even be shown.
/// *
/// * @return true if the menu can be shown, false if it should not be shown
/// */
/// ```
///
/// `boolean menuWillOpen ();`
#[inline]
pub unsafe fn MenuWillOpen(&self, _retval: *mut bool) -> ::nserror::nsresult {
((*self.vtable).MenuWillOpen)(self, _retval)
}
/// ```text
/// /**
/// * Activate the native menu item specified by |anIndexString|. This method
/// * is intended to be used by the test suite.
/// *
/// * @param anIndexString string containing a list of indices separated by
/// * pipe ('|') characters
/// */
/// ```
///
/// `void activateNativeMenuItemAt (in AString anIndexString);`
#[inline]
pub unsafe fn ActivateNativeMenuItemAt(&self, anIndexString: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).ActivateNativeMenuItemAt)(self, anIndexString)
}
/// ```text
/// /**
/// * Force an update of the native menu item specified by |anIndexString|. This
/// * method is intended to be used by the test suite.
/// *
/// * @param anIndexString string containing a list of indices separated by
/// * pipe ('|') characters
/// */
/// ```
///
/// `void forceUpdateNativeMenuAt (in AString anIndexString);`
#[inline]
pub unsafe fn ForceUpdateNativeMenuAt(&self, anIndexString: *const ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).ForceUpdateNativeMenuAt)(self, anIndexString)
}
/// ```text
/// /**
/// * Print information about the menu structure to stdout. Only used for
/// * debugging.
/// */
/// ```
///
/// `void dump ();`
#[inline]
pub unsafe fn Dump(&self, ) -> ::nserror::nsresult {
((*self.vtable).Dump)(self, )
}
}