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 285
// // DO NOT EDIT. THIS FILE IS GENERATED FROM ../../../dist/idl/mozIColorAnalyzer.idl // /// `interface mozIRepresentativeColorCallback : 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 mozIRepresentativeColorCallback { vtable: *const mozIRepresentativeColorCallbackVTable, /// 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 mozIRepresentativeColorCallback. unsafe impl XpCom for mozIRepresentativeColorCallback { const IID: nsIID = nsID(0xe4089e21, 0x71b6, 0x40af, [0xb5, 0x46, 0x33, 0xc2, 0x1b, 0x90, 0xe8, 0x74]); } // 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 mozIRepresentativeColorCallback { #[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 mozIRepresentativeColorCallback. // 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 mozIRepresentativeColorCallbackCoerce { /// Cheaply cast a value of this type from a `mozIRepresentativeColorCallback`. fn coerce_from(v: &mozIRepresentativeColorCallback) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl mozIRepresentativeColorCallbackCoerce for mozIRepresentativeColorCallback { #[inline] fn coerce_from(v: &mozIRepresentativeColorCallback) -> &Self { v } } impl mozIRepresentativeColorCallback { /// Cast this `mozIRepresentativeColorCallback` to one of its base interfaces. #[inline] pub fn coerce<T: mozIRepresentativeColorCallbackCoerce>(&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 mozIRepresentativeColorCallback { 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> mozIRepresentativeColorCallbackCoerce for T { #[inline] fn coerce_from(v: &mozIRepresentativeColorCallback) -> &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 mozIRepresentativeColorCallback // 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 mozIRepresentativeColorCallbackVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void onComplete (in boolean success, [optional] in unsigned long color); */ pub OnComplete: unsafe extern "system" fn (this: *const mozIRepresentativeColorCallback, success: bool, color: libc::uint32_t) -> 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 mozIRepresentativeColorCallback { /// ```text /// /** /// * Will be called when color analysis finishes. /// * /// * @param success /// * True if analysis was successful, false otherwise. /// * Analysis can fail if the image is transparent, imageURI doesn't /// * resolve to a valid image, or the image is too big. /// * /// * @param color /// * The representative color as an integer in RGB form. /// * e.g. 0xFF0102 == rgb(255,1,2) /// * If success is false, color is not provided. /// */ /// ``` /// /// `void onComplete (in boolean success, [optional] in unsigned long color);` #[inline] pub unsafe fn OnComplete(&self, success: bool, color: libc::uint32_t) -> nsresult { ((*self.vtable).OnComplete)(self, success, color) } } /// `interface mozIColorAnalyzer : 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 mozIColorAnalyzer { vtable: *const mozIColorAnalyzerVTable, /// 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 mozIColorAnalyzer. unsafe impl XpCom for mozIColorAnalyzer { const IID: nsIID = nsID(0xd056186c, 0x28a0, 0x494e, [0xaa, 0xcc, 0x9e, 0x43, 0x37, 0x72, 0xb1, 0x43]); } // 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 mozIColorAnalyzer { #[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 mozIColorAnalyzer. // 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 mozIColorAnalyzerCoerce { /// Cheaply cast a value of this type from a `mozIColorAnalyzer`. fn coerce_from(v: &mozIColorAnalyzer) -> &Self; } // The trivial implementation: We can obviously coerce ourselves to ourselves. impl mozIColorAnalyzerCoerce for mozIColorAnalyzer { #[inline] fn coerce_from(v: &mozIColorAnalyzer) -> &Self { v } } impl mozIColorAnalyzer { /// Cast this `mozIColorAnalyzer` to one of its base interfaces. #[inline] pub fn coerce<T: mozIColorAnalyzerCoerce>(&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 mozIColorAnalyzer { 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> mozIColorAnalyzerCoerce for T { #[inline] fn coerce_from(v: &mozIColorAnalyzer) -> &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 mozIColorAnalyzer // 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 mozIColorAnalyzerVTable { /// We need to include the members from the base interface's vtable at the start /// of the VTable definition. pub __base: nsISupportsVTable, /* void findRepresentativeColor (in nsIURI imageURI, in mozIRepresentativeColorCallback callback); */ pub FindRepresentativeColor: unsafe extern "system" fn (this: *const mozIColorAnalyzer, imageURI: *const nsIURI, callback: *const mozIRepresentativeColorCallback) -> 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 mozIColorAnalyzer { /// ```text /// /** /// * Given an image URI, find the most representative color for that image /// * based on the frequency of each color. Preference is given to colors that /// * are more interesting. Avoids the background color if it can be /// * discerned. Ignores sufficiently transparent colors. /// * /// * This is intended to be used on favicon images. Larger images take longer /// * to process, especially those with a larger number of unique colors. If /// * imageURI points to an image that has more than 128^2 pixels, this method /// * will fail before analyzing it for performance reasons. /// * /// * @param imageURI /// * A URI pointing to the image - ideally a data: URI, but any scheme /// * that will load when setting the src attribute of a DOM img element /// * should work. /// * @param callback /// * Function to call when the representative color is found or an /// * error occurs. /// */ /// ``` /// /// `void findRepresentativeColor (in nsIURI imageURI, in mozIRepresentativeColorCallback callback);` #[inline] pub unsafe fn FindRepresentativeColor(&self, imageURI: *const nsIURI, callback: *const mozIRepresentativeColorCallback) -> nsresult { ((*self.vtable).FindRepresentativeColor)(self, imageURI, callback) } }