1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/nsIClassInfo.idl // /// `interface nsIClassInfo : nsISupports` /// /// ```text /// /** /// * Provides information about a specific implementation class. If you want /// * your class to implement nsIClassInfo, see nsIClassInfoImpl.h for /// * instructions--you most likely do not want to inherit from nsIClassInfo. /// */ /// ``` /// // 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 nsIClassInfo { vtable: *const nsIClassInfoVTable, /// This field is a phantomdata to ensure that the VTable type and any /// struct containing it is not safe to send across threads, as XPCOM is /// generally not threadsafe. /// /// XPCOM interfaces in general are not safe to send across threads. __nosync: ::std::marker::PhantomData<::std::rc::Rc<u8>>, } // 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 nsIClassInfo. unsafe impl XpCom for nsIClassInfo { const IID: nsIID = nsID(0xa60569d7, 0xd401, 0x4677, [0xba, 0x63, 0x2a, 0xa5, 0x97, 0x1a, 0xf2, 0x5d]); } // 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 nsIClassInfo { #[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 nsIClassInfo. // 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 nsIClassInfoCoerce { /// Cheaply cast a value of this type from a `nsIClassInfo`. fn coerce_from(v: &nsIClassInfo) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl nsIClassInfoCoerce for nsIClassInfo { #[inline] fn coerce_from(v: &nsIClassInfo) -> &Self { v } } impl nsIClassInfo { /// Cast this `nsIClassInfo` to one of its base interfaces. #[inline] pub fn coerce<T: nsIClassInfoCoerce>(&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 nsIClassInfo { 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> nsIClassInfoCoerce for T { #[inline] fn coerce_from(v: &nsIClassInfo) -> &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 nsIClassInfo // 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 nsIClassInfoVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void getInterfaces (out uint32_t count, [array, size_is (count), retval] out nsIIDPtr array); */ pub GetInterfaces: unsafe extern "system" fn (this: *const nsIClassInfo, count: *mut uint32_t, array: *mut *mut *mut nsIID) -> nsresult, /* nsIXPCScriptable getScriptableHelper (); */ pub GetScriptableHelper: unsafe extern "system" fn (this: *const nsIClassInfo, _retval: *mut *const nsIXPCScriptable) -> nsresult, /* readonly attribute AUTF8String contractID; */ pub GetContractID: unsafe extern "system" fn (this: *const nsIClassInfo, aContractID: &mut ::nsstring::nsACString) -> nsresult, /* readonly attribute AUTF8String classDescription; */ pub GetClassDescription: unsafe extern "system" fn (this: *const nsIClassInfo, aClassDescription: &mut ::nsstring::nsACString) -> nsresult, /* readonly attribute nsCIDPtr classID; */ pub GetClassID: unsafe extern "system" fn (this: *const nsIClassInfo, aClassID: *mut *mut nsCID) -> nsresult, /* readonly attribute uint32_t flags; */ pub GetFlags: unsafe extern "system" fn (this: *const nsIClassInfo, aFlags: *mut uint32_t) -> nsresult, /* [noscript] readonly attribute nsCID classIDNoAlloc; */ pub GetClassIDNoAlloc: unsafe extern "system" fn (this: *const nsIClassInfo, aClassIDNoAlloc: *mut nsCID) -> 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 nsIClassInfo { /// ```text /// /** /// * Bitflags for 'flags' attribute. /// */ /// ``` /// pub const SINGLETON: i64 = 1; pub const THREADSAFE: i64 = 2; pub const MAIN_THREAD_ONLY: i64 = 4; pub const DOM_OBJECT: i64 = 8; pub const PLUGIN_OBJECT: i64 = 16; pub const SINGLETON_CLASSINFO: i64 = 32; /// ```text /// /** /// * 'flags' attribute bitflag: whether objects of this type implement /// * nsIContent. /// */ /// ``` /// pub const CONTENT_NODE: i64 = 64; pub const RESERVED: i64 = 2147483648; /// ```text /// /** /// * Get an ordered list of the interface ids that instances of the class /// * promise to implement. Note that nsISupports is an implicit member /// * of any such list and need not be included. /// * /// * Should set *count = 0 and *array = null and return NS_OK if getting the /// * list is not supported. /// */ /// ``` /// /// `void getInterfaces (out uint32_t count, [array, size_is (count), retval] out nsIIDPtr array);` #[inline] pub unsafe fn GetInterfaces(&self, count: *mut uint32_t, array: *mut *mut *mut nsIID) -> nsresult { ((*self.vtable).GetInterfaces)(self, count, array) } /// ```text /// /** /// * Return an object to assist XPConnect in supplying JavaScript-specific /// * behavior to callers of the instance object, or null if not needed. /// */ /// ``` /// /// `nsIXPCScriptable getScriptableHelper ();` #[inline] pub unsafe fn GetScriptableHelper(&self, _retval: *mut *const nsIXPCScriptable) -> nsresult { ((*self.vtable).GetScriptableHelper)(self, _retval) } /// ```text /// /** /// * A contract ID through which an instance of this class can be created /// * (or accessed as a service, if |flags & SINGLETON|), or null/void. /// */ /// ``` /// /// `readonly attribute AUTF8String contractID;` #[inline] pub unsafe fn GetContractID(&self, aContractID: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetContractID)(self, aContractID) } /// ```text /// /** /// * A human readable string naming the class, or null/void. /// */ /// ``` /// /// `readonly attribute AUTF8String classDescription;` #[inline] pub unsafe fn GetClassDescription(&self, aClassDescription: &mut ::nsstring::nsACString) -> nsresult { ((*self.vtable).GetClassDescription)(self, aClassDescription) } /// ```text /// /** /// * A class ID through which an instance of this class can be created /// * (or accessed as a service, if |flags & SINGLETON|), or null. /// */ /// ``` /// /// `readonly attribute nsCIDPtr classID;` #[inline] pub unsafe fn GetClassID(&self, aClassID: *mut *mut nsCID) -> nsresult { ((*self.vtable).GetClassID)(self, aClassID) } /// `readonly attribute uint32_t flags;` #[inline] pub unsafe fn GetFlags(&self, aFlags: *mut uint32_t) -> nsresult { ((*self.vtable).GetFlags)(self, aFlags) } /// ```text /// /** /// * Also a class ID through which an instance of this class can be created /// * (or accessed as a service, if |flags & SINGLETON|). If the class does /// * not have a CID, it should return NS_ERROR_NOT_AVAILABLE. This attribute /// * exists so C++ callers can avoid allocating and freeing a CID, as would /// * happen if they used classID. /// */ /// ``` /// /// `[noscript] readonly attribute nsCID classIDNoAlloc;` #[inline] pub unsafe fn GetClassIDNoAlloc(&self, aClassIDNoAlloc: *mut nsCID) -> nsresult { ((*self.vtable).GetClassIDNoAlloc)(self, aClassIDNoAlloc) } }