Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/widget/nsITouchBarHelper.idl
//
/// `interface nsITouchBarHelper : nsISupports`
///
/// ```text
/// /**
/// * Back-to-frontend communication for the Touch Bar
/// */
/// ```
///
// 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 nsITouchBarHelper {
vtable: &'static nsITouchBarHelperVTable,
/// 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 nsITouchBarHelper.
unsafe impl XpCom for nsITouchBarHelper {
const IID: nsIID = nsID(0xea109912, 0x3acc, 0x48de,
[0xb6, 0x79, 0xc2, 0x3b, 0x6a, 0x12, 0x2d, 0xa5]);
}
// 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 nsITouchBarHelper {
#[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 nsITouchBarHelper.
// 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 nsITouchBarHelperCoerce {
/// Cheaply cast a value of this type from a `nsITouchBarHelper`.
fn coerce_from(v: &nsITouchBarHelper) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsITouchBarHelperCoerce for nsITouchBarHelper {
#[inline]
fn coerce_from(v: &nsITouchBarHelper) -> &Self {
v
}
}
impl nsITouchBarHelper {
/// Cast this `nsITouchBarHelper` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsITouchBarHelperCoerce>(&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 nsITouchBarHelper {
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> nsITouchBarHelperCoerce for T {
#[inline]
fn coerce_from(v: &nsITouchBarHelper) -> &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 nsITouchBarHelper
// 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 nsITouchBarHelperVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* readonly attribute AString activeUrl; */
pub GetActiveUrl: unsafe extern "system" fn (this: *const nsITouchBarHelper, aActiveUrl: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute AString activeTitle; */
pub GetActiveTitle: unsafe extern "system" fn (this: *const nsITouchBarHelper, aActiveTitle: *mut ::nsstring::nsAString) -> ::nserror::nsresult,
/* readonly attribute boolean isUrlbarFocused; */
pub GetIsUrlbarFocused: unsafe extern "system" fn (this: *const nsITouchBarHelper, aIsUrlbarFocused: *mut bool) -> ::nserror::nsresult,
/* void toggleFocusUrlbar (); */
pub ToggleFocusUrlbar: unsafe extern "system" fn (this: *const nsITouchBarHelper) -> ::nserror::nsresult,
/* void unfocusUrlbar (); */
pub UnfocusUrlbar: unsafe extern "system" fn (this: *const nsITouchBarHelper) -> ::nserror::nsresult,
/* attribute nsIArray allItems; */
pub GetAllItems: unsafe extern "system" fn (this: *const nsITouchBarHelper, aAllItems: *mut *const nsIArray) -> ::nserror::nsresult,
/* attribute nsIArray allItems; */
pub SetAllItems: unsafe extern "system" fn (this: *const nsITouchBarHelper, aAllItems: *const nsIArray) -> ::nserror::nsresult,
/* readonly attribute Document document; */
pub GetDocument: unsafe extern "system" fn (this: *const nsITouchBarHelper, aDocument: *mut *const libc::c_void) -> ::nserror::nsresult,
/* nsITouchBarInput getTouchBarInput (in string aInputName); */
pub GetTouchBarInput: unsafe extern "system" fn (this: *const nsITouchBarHelper, aInputName: *const libc::c_char, _retval: *mut *const nsITouchBarInput) -> ::nserror::nsresult,
/* void insertRestrictionInUrlbar (in string aToken); */
pub InsertRestrictionInUrlbar: unsafe extern "system" fn (this: *const nsITouchBarHelper, aToken: *const libc::c_char) -> ::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 nsITouchBarHelper {
/// ```text
/// /**
/// * Returns the active browser's URL.
/// */
/// ```
///
/// `readonly attribute AString activeUrl;`
#[inline]
pub unsafe fn GetActiveUrl(&self, aActiveUrl: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetActiveUrl)(self, aActiveUrl)
}
/// ```text
/// /**
/// * Return the active browser's page title.
/// */
/// ```
///
/// `readonly attribute AString activeTitle;`
#[inline]
pub unsafe fn GetActiveTitle(&self, aActiveTitle: *mut ::nsstring::nsAString) -> ::nserror::nsresult {
((*self.vtable).GetActiveTitle)(self, aActiveTitle)
}
/// ```text
/// /**
/// * Return true if the Urlbar has focus.
/// */
/// ```
///
/// `readonly attribute boolean isUrlbarFocused;`
#[inline]
pub unsafe fn GetIsUrlbarFocused(&self, aIsUrlbarFocused: *mut bool) -> ::nserror::nsresult {
((*self.vtable).GetIsUrlbarFocused)(self, aIsUrlbarFocused)
}
/// ```text
/// /**
/// * Toggles Urlbar focus.
/// */
/// ```
///
/// `void toggleFocusUrlbar ();`
#[inline]
pub unsafe fn ToggleFocusUrlbar(&self, ) -> ::nserror::nsresult {
((*self.vtable).ToggleFocusUrlbar)(self, )
}
/// ```text
/// /**
/// * Unfocuses the Urlbar.
/// */
/// ```
///
/// `void unfocusUrlbar ();`
#[inline]
pub unsafe fn UnfocusUrlbar(&self, ) -> ::nserror::nsresult {
((*self.vtable).UnfocusUrlbar)(self, )
}
/// ```text
/// /**
/// * Returns all available Touch Bar Inputs in an nsIArray
/// * of nsITouchBarInput objects.
/// */
/// ```
///
/// `attribute nsIArray allItems;`
#[inline]
pub unsafe fn GetAllItems(&self, aAllItems: *mut *const nsIArray) -> ::nserror::nsresult {
((*self.vtable).GetAllItems)(self, aAllItems)
}
/// ```text
/// /**
/// * Returns all available Touch Bar Inputs in an nsIArray
/// * of nsITouchBarInput objects.
/// */
/// ```
///
/// `attribute nsIArray allItems;`
#[inline]
pub unsafe fn SetAllItems(&self, aAllItems: *const nsIArray) -> ::nserror::nsresult {
((*self.vtable).SetAllItems)(self, aAllItems)
}
/// ```text
/// /**
/// * The context in which this nsITouchBarHelper exists. Required to create
/// * an imgLoader to load our SVG icons.
/// */
/// ```
///
/// `readonly attribute Document document;`
#[inline]
pub unsafe fn GetDocument(&self, aDocument: *mut *const libc::c_void) -> ::nserror::nsresult {
((*self.vtable).GetDocument)(self, aDocument)
}
/// ```text
/// /**
/// * Returns the requested TouchBarInput.
/// * Exposed for testing.
/// */
/// ```
///
/// `nsITouchBarInput getTouchBarInput (in string aInputName);`
#[inline]
pub unsafe fn GetTouchBarInput(&self, aInputName: *const libc::c_char, _retval: *mut *const nsITouchBarInput) -> ::nserror::nsresult {
((*self.vtable).GetTouchBarInput)(self, aInputName, _retval)
}
/// ```text
/// /**
/// * Inserts a search restriction string in the Urlbar.
/// * Exposed for testing.
/// */
/// ```
///
/// `void insertRestrictionInUrlbar (in string aToken);`
#[inline]
pub unsafe fn InsertRestrictionInUrlbar(&self, aToken: *const libc::c_char) -> ::nserror::nsresult {
((*self.vtable).InsertRestrictionInUrlbar)(self, aToken)
}
}