Copy as Markdown
Other Tools
//
// DO NOT EDIT. THIS FILE IS GENERATED FROM $SRCDIR/accessible/interfaces/nsIAccessibleTextLeafRange.idl
//
/// `interface nsIAccessibleTextLeafPoint : nsISupports`
///
// 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 nsIAccessibleTextLeafPoint {
vtable: &'static nsIAccessibleTextLeafPointVTable,
/// 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 nsIAccessibleTextLeafPoint.
unsafe impl XpCom for nsIAccessibleTextLeafPoint {
const IID: nsIID = nsID(0x9181e777, 0x8954, 0x4f8f,
[0x8c, 0xee, 0x32, 0xf9, 0x77, 0x1e, 0x40, 0xd7]);
}
// 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 nsIAccessibleTextLeafPoint {
#[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 nsIAccessibleTextLeafPoint.
// 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 nsIAccessibleTextLeafPointCoerce {
/// Cheaply cast a value of this type from a `nsIAccessibleTextLeafPoint`.
fn coerce_from(v: &nsIAccessibleTextLeafPoint) -> &Self;
}
// The trivial implementation: We can obviously coerce ourselves to ourselves.
impl nsIAccessibleTextLeafPointCoerce for nsIAccessibleTextLeafPoint {
#[inline]
fn coerce_from(v: &nsIAccessibleTextLeafPoint) -> &Self {
v
}
}
impl nsIAccessibleTextLeafPoint {
/// Cast this `nsIAccessibleTextLeafPoint` to one of its base interfaces.
#[inline]
pub fn coerce<T: nsIAccessibleTextLeafPointCoerce>(&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 nsIAccessibleTextLeafPoint {
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> nsIAccessibleTextLeafPointCoerce for T {
#[inline]
fn coerce_from(v: &nsIAccessibleTextLeafPoint) -> &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 nsIAccessibleTextLeafPoint
// 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 nsIAccessibleTextLeafPointVTable {
/// We need to include the members from the base interface's vtable at the start
/// of the VTable definition.
pub __base: nsISupportsVTable,
/* attribute nsIAccessible accessible; */
pub GetAccessible: unsafe extern "system" fn (this: *const nsIAccessibleTextLeafPoint, aAccessible: *mut*const nsIAccessible) -> ::nserror::nsresult,
/* attribute nsIAccessible accessible; */
pub SetAccessible: unsafe extern "system" fn (this: *const nsIAccessibleTextLeafPoint, aAccessible: *const nsIAccessible) -> ::nserror::nsresult,
/* attribute long offset; */
pub GetOffset: unsafe extern "system" fn (this: *const nsIAccessibleTextLeafPoint, aOffset: *mut i32) -> ::nserror::nsresult,
/* attribute long offset; */
pub SetOffset: unsafe extern "system" fn (this: *const nsIAccessibleTextLeafPoint, aOffset: i32) -> ::nserror::nsresult,
/* nsIAccessibleTextLeafPoint findBoundary (in AccessibleTextBoundary aBoundaryType, in unsigned long aDirection, in unsigned long aFlags); */
pub FindBoundary: unsafe extern "system" fn (this: *const nsIAccessibleTextLeafPoint, aBoundaryType: AccessibleTextBoundary, aDirection: u32, aFlags: u32, _retval: *mut *const nsIAccessibleTextLeafPoint) -> ::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 nsIAccessibleTextLeafPoint {
pub const DIRECTION_NEXT: i32 = 0;
pub const DIRECTION_PREVIOUS: i32 = 1;
pub const BOUNDARY_FLAG_DEFAULT: u32 = 0;
pub const BOUNDARY_FLAG_INCLUDE_ORIGIN: u32 = 1;
pub const BOUNDARY_FLAG_STOP_IN_EDITABLE: u32 = 2;
pub const BOUNDARY_FLAG_SKIP_LIST_ITEM_MARKER: u32 = 4;
/// `attribute nsIAccessible accessible;`
#[inline]
pub unsafe fn GetAccessible(&self, aAccessible: *mut*const nsIAccessible) -> ::nserror::nsresult {
((*self.vtable).GetAccessible)(self, aAccessible)
}
/// `attribute nsIAccessible accessible;`
#[inline]
pub unsafe fn SetAccessible(&self, aAccessible: *const nsIAccessible) -> ::nserror::nsresult {
((*self.vtable).SetAccessible)(self, aAccessible)
}
/// `attribute long offset;`
#[inline]
pub unsafe fn GetOffset(&self, aOffset: *mut i32) -> ::nserror::nsresult {
((*self.vtable).GetOffset)(self, aOffset)
}
/// `attribute long offset;`
#[inline]
pub unsafe fn SetOffset(&self, aOffset: i32) -> ::nserror::nsresult {
((*self.vtable).SetOffset)(self, aOffset)
}
/// ```text
/// /**
/// * Find a boundary (word start, line start, etc.) in a specific direction.
/// * If no boundary is found, the start/end of the document is returned
/// * (depending on the direction).
/// *
/// * @param aBoundaryType [in] the boundary type to search for
/// * @param aDirection [in] search next or previous
/// * @param aFlags [in] optional flags for search
/// */
/// ```
///
/// `nsIAccessibleTextLeafPoint findBoundary (in AccessibleTextBoundary aBoundaryType, in unsigned long aDirection, in unsigned long aFlags);`
#[inline]
pub unsafe fn FindBoundary(&self, aBoundaryType: AccessibleTextBoundary, aDirection: u32, aFlags: u32, _retval: *mut *const nsIAccessibleTextLeafPoint) -> ::nserror::nsresult {
((*self.vtable).FindBoundary)(self, aBoundaryType, aDirection, aFlags, _retval)
}
}