objc2_core_graphics/generated/
CGPDFScanner.rs

1//! This file has been automatically generated by `objc2`'s `header-translator`.
2//! DO NOT EDIT
3use core::cell::UnsafeCell;
4use core::ffi::*;
5use core::marker::{PhantomData, PhantomPinned};
6#[cfg(feature = "objc2")]
7use objc2::__framework_prelude::*;
8
9use crate::*;
10
11/// [Apple's documentation](https://developer.apple.com/documentation/coregraphics/cgpdfscanner?language=objc)
12#[repr(C)]
13#[derive(Debug)]
14pub struct CGPDFScanner {
15    inner: [u8; 0],
16    _p: UnsafeCell<PhantomData<(*const UnsafeCell<()>, PhantomPinned)>>,
17}
18
19#[cfg(feature = "objc2")]
20unsafe impl RefEncode for CGPDFScanner {
21    const ENCODING_REF: Encoding = Encoding::Pointer(&Encoding::Struct("CGPDFScanner", &[]));
22}
23
24/// [Apple's documentation](https://developer.apple.com/documentation/coregraphics/cgpdfscannerref?language=objc)
25pub type CGPDFScannerRef = *mut CGPDFScanner;
26
27impl CGPDFScanner {
28    /// # Safety
29    ///
30    /// - `cs` must be a valid pointer.
31    /// - `table` must be a valid pointer or null.
32    /// - `info` must be a valid pointer or null.
33    #[doc(alias = "CGPDFScannerCreate")]
34    #[cfg(all(feature = "CGPDFContentStream", feature = "CGPDFOperatorTable"))]
35    #[inline]
36    pub unsafe fn create(
37        cs: CGPDFContentStreamRef,
38        table: CGPDFOperatorTableRef,
39        info: *mut c_void,
40    ) -> CGPDFScannerRef {
41        extern "C-unwind" {
42            fn CGPDFScannerCreate(
43                cs: CGPDFContentStreamRef,
44                table: CGPDFOperatorTableRef,
45                info: *mut c_void,
46            ) -> CGPDFScannerRef;
47        }
48        unsafe { CGPDFScannerCreate(cs, table, info) }
49    }
50
51    /// # Safety
52    ///
53    /// `scanner` must be a valid pointer or null.
54    #[doc(alias = "CGPDFScannerRetain")]
55    #[inline]
56    pub unsafe fn retain(scanner: CGPDFScannerRef) -> CGPDFScannerRef {
57        extern "C-unwind" {
58            fn CGPDFScannerRetain(scanner: CGPDFScannerRef) -> CGPDFScannerRef;
59        }
60        unsafe { CGPDFScannerRetain(scanner) }
61    }
62
63    /// # Safety
64    ///
65    /// `scanner` must be a valid pointer or null.
66    #[doc(alias = "CGPDFScannerRelease")]
67    #[inline]
68    pub unsafe fn release(scanner: CGPDFScannerRef) {
69        extern "C-unwind" {
70            fn CGPDFScannerRelease(scanner: CGPDFScannerRef);
71        }
72        unsafe { CGPDFScannerRelease(scanner) }
73    }
74
75    /// # Safety
76    ///
77    /// `scanner` must be a valid pointer or null.
78    #[doc(alias = "CGPDFScannerScan")]
79    #[inline]
80    pub unsafe fn scan(scanner: CGPDFScannerRef) -> bool {
81        extern "C-unwind" {
82            fn CGPDFScannerScan(scanner: CGPDFScannerRef) -> bool;
83        }
84        unsafe { CGPDFScannerScan(scanner) }
85    }
86
87    /// # Safety
88    ///
89    /// `scanner` must be a valid pointer.
90    #[doc(alias = "CGPDFScannerGetContentStream")]
91    #[cfg(feature = "CGPDFContentStream")]
92    #[inline]
93    pub unsafe fn content_stream(scanner: CGPDFScannerRef) -> CGPDFContentStreamRef {
94        extern "C-unwind" {
95            fn CGPDFScannerGetContentStream(scanner: CGPDFScannerRef) -> CGPDFContentStreamRef;
96        }
97        unsafe { CGPDFScannerGetContentStream(scanner) }
98    }
99
100    /// # Safety
101    ///
102    /// - `scanner` must be a valid pointer.
103    /// - `value` must be a valid pointer or null.
104    #[doc(alias = "CGPDFScannerPopObject")]
105    #[cfg(feature = "CGPDFObject")]
106    #[inline]
107    pub unsafe fn pop_object(scanner: CGPDFScannerRef, value: *mut CGPDFObjectRef) -> bool {
108        extern "C-unwind" {
109            fn CGPDFScannerPopObject(scanner: CGPDFScannerRef, value: *mut CGPDFObjectRef) -> bool;
110        }
111        unsafe { CGPDFScannerPopObject(scanner, value) }
112    }
113
114    /// # Safety
115    ///
116    /// - `scanner` must be a valid pointer.
117    /// - `value` must be a valid pointer or null.
118    #[doc(alias = "CGPDFScannerPopBoolean")]
119    #[cfg(feature = "CGPDFObject")]
120    #[inline]
121    pub unsafe fn pop_boolean(scanner: CGPDFScannerRef, value: *mut CGPDFBoolean) -> bool {
122        extern "C-unwind" {
123            fn CGPDFScannerPopBoolean(scanner: CGPDFScannerRef, value: *mut CGPDFBoolean) -> bool;
124        }
125        unsafe { CGPDFScannerPopBoolean(scanner, value) }
126    }
127
128    /// # Safety
129    ///
130    /// - `scanner` must be a valid pointer.
131    /// - `value` must be a valid pointer or null.
132    #[doc(alias = "CGPDFScannerPopInteger")]
133    #[cfg(feature = "CGPDFObject")]
134    #[inline]
135    pub unsafe fn pop_integer(scanner: CGPDFScannerRef, value: *mut CGPDFInteger) -> bool {
136        extern "C-unwind" {
137            fn CGPDFScannerPopInteger(scanner: CGPDFScannerRef, value: *mut CGPDFInteger) -> bool;
138        }
139        unsafe { CGPDFScannerPopInteger(scanner, value) }
140    }
141
142    /// # Safety
143    ///
144    /// - `scanner` must be a valid pointer.
145    /// - `value` must be a valid pointer or null.
146    #[doc(alias = "CGPDFScannerPopNumber")]
147    #[cfg(feature = "CGPDFObject")]
148    #[inline]
149    pub unsafe fn pop_number(scanner: CGPDFScannerRef, value: *mut CGPDFReal) -> bool {
150        extern "C-unwind" {
151            fn CGPDFScannerPopNumber(scanner: CGPDFScannerRef, value: *mut CGPDFReal) -> bool;
152        }
153        unsafe { CGPDFScannerPopNumber(scanner, value) }
154    }
155
156    /// # Safety
157    ///
158    /// - `scanner` must be a valid pointer.
159    /// - `value` must be a valid pointer or null.
160    #[doc(alias = "CGPDFScannerPopName")]
161    #[inline]
162    pub unsafe fn pop_name(scanner: CGPDFScannerRef, value: *mut *const c_char) -> bool {
163        extern "C-unwind" {
164            fn CGPDFScannerPopName(scanner: CGPDFScannerRef, value: *mut *const c_char) -> bool;
165        }
166        unsafe { CGPDFScannerPopName(scanner, value) }
167    }
168
169    /// # Safety
170    ///
171    /// - `scanner` must be a valid pointer.
172    /// - `value` must be a valid pointer or null.
173    #[doc(alias = "CGPDFScannerPopString")]
174    #[cfg(feature = "CGPDFString")]
175    #[inline]
176    pub unsafe fn pop_string(scanner: CGPDFScannerRef, value: *mut CGPDFStringRef) -> bool {
177        extern "C-unwind" {
178            fn CGPDFScannerPopString(scanner: CGPDFScannerRef, value: *mut CGPDFStringRef) -> bool;
179        }
180        unsafe { CGPDFScannerPopString(scanner, value) }
181    }
182
183    /// # Safety
184    ///
185    /// - `scanner` must be a valid pointer.
186    /// - `value` must be a valid pointer or null.
187    #[doc(alias = "CGPDFScannerPopArray")]
188    #[cfg(feature = "CGPDFArray")]
189    #[inline]
190    pub unsafe fn pop_array(scanner: CGPDFScannerRef, value: *mut CGPDFArrayRef) -> bool {
191        extern "C-unwind" {
192            fn CGPDFScannerPopArray(scanner: CGPDFScannerRef, value: *mut CGPDFArrayRef) -> bool;
193        }
194        unsafe { CGPDFScannerPopArray(scanner, value) }
195    }
196
197    /// # Safety
198    ///
199    /// - `scanner` must be a valid pointer.
200    /// - `value` must be a valid pointer or null.
201    #[doc(alias = "CGPDFScannerPopDictionary")]
202    #[cfg(feature = "CGPDFDictionary")]
203    #[inline]
204    pub unsafe fn pop_dictionary(scanner: CGPDFScannerRef, value: *mut CGPDFDictionaryRef) -> bool {
205        extern "C-unwind" {
206            fn CGPDFScannerPopDictionary(
207                scanner: CGPDFScannerRef,
208                value: *mut CGPDFDictionaryRef,
209            ) -> bool;
210        }
211        unsafe { CGPDFScannerPopDictionary(scanner, value) }
212    }
213
214    /// # Safety
215    ///
216    /// - `scanner` must be a valid pointer.
217    /// - `value` must be a valid pointer or null.
218    #[doc(alias = "CGPDFScannerPopStream")]
219    #[cfg(feature = "CGPDFStream")]
220    #[inline]
221    pub unsafe fn pop_stream(scanner: CGPDFScannerRef, value: *mut CGPDFStreamRef) -> bool {
222        extern "C-unwind" {
223            fn CGPDFScannerPopStream(scanner: CGPDFScannerRef, value: *mut CGPDFStreamRef) -> bool;
224        }
225        unsafe { CGPDFScannerPopStream(scanner, value) }
226    }
227
228    /// # Safety
229    ///
230    /// `s` must be a valid pointer.
231    #[doc(alias = "CGPDFScannerStop")]
232    #[inline]
233    pub unsafe fn stop(s: CGPDFScannerRef) {
234        extern "C-unwind" {
235            fn CGPDFScannerStop(s: CGPDFScannerRef);
236        }
237        unsafe { CGPDFScannerStop(s) }
238    }
239}
240
241extern "C-unwind" {
242    #[cfg(all(feature = "CGPDFContentStream", feature = "CGPDFOperatorTable"))]
243    #[deprecated = "renamed to `CGPDFScanner::create`"]
244    pub fn CGPDFScannerCreate(
245        cs: CGPDFContentStreamRef,
246        table: CGPDFOperatorTableRef,
247        info: *mut c_void,
248    ) -> CGPDFScannerRef;
249}
250
251extern "C-unwind" {
252    #[deprecated = "renamed to `CGPDFScanner::retain`"]
253    pub fn CGPDFScannerRetain(scanner: CGPDFScannerRef) -> CGPDFScannerRef;
254}
255
256extern "C-unwind" {
257    #[deprecated = "renamed to `CGPDFScanner::release`"]
258    pub fn CGPDFScannerRelease(scanner: CGPDFScannerRef);
259}
260
261extern "C-unwind" {
262    #[deprecated = "renamed to `CGPDFScanner::scan`"]
263    pub fn CGPDFScannerScan(scanner: CGPDFScannerRef) -> bool;
264}
265
266extern "C-unwind" {
267    #[cfg(feature = "CGPDFContentStream")]
268    #[deprecated = "renamed to `CGPDFScanner::content_stream`"]
269    pub fn CGPDFScannerGetContentStream(scanner: CGPDFScannerRef) -> CGPDFContentStreamRef;
270}
271
272extern "C-unwind" {
273    #[cfg(feature = "CGPDFObject")]
274    #[deprecated = "renamed to `CGPDFScanner::pop_object`"]
275    pub fn CGPDFScannerPopObject(scanner: CGPDFScannerRef, value: *mut CGPDFObjectRef) -> bool;
276}
277
278extern "C-unwind" {
279    #[cfg(feature = "CGPDFObject")]
280    #[deprecated = "renamed to `CGPDFScanner::pop_boolean`"]
281    pub fn CGPDFScannerPopBoolean(scanner: CGPDFScannerRef, value: *mut CGPDFBoolean) -> bool;
282}
283
284extern "C-unwind" {
285    #[cfg(feature = "CGPDFObject")]
286    #[deprecated = "renamed to `CGPDFScanner::pop_integer`"]
287    pub fn CGPDFScannerPopInteger(scanner: CGPDFScannerRef, value: *mut CGPDFInteger) -> bool;
288}
289
290extern "C-unwind" {
291    #[cfg(feature = "CGPDFObject")]
292    #[deprecated = "renamed to `CGPDFScanner::pop_number`"]
293    pub fn CGPDFScannerPopNumber(scanner: CGPDFScannerRef, value: *mut CGPDFReal) -> bool;
294}
295
296extern "C-unwind" {
297    #[deprecated = "renamed to `CGPDFScanner::pop_name`"]
298    pub fn CGPDFScannerPopName(scanner: CGPDFScannerRef, value: *mut *const c_char) -> bool;
299}
300
301extern "C-unwind" {
302    #[cfg(feature = "CGPDFString")]
303    #[deprecated = "renamed to `CGPDFScanner::pop_string`"]
304    pub fn CGPDFScannerPopString(scanner: CGPDFScannerRef, value: *mut CGPDFStringRef) -> bool;
305}
306
307extern "C-unwind" {
308    #[cfg(feature = "CGPDFArray")]
309    #[deprecated = "renamed to `CGPDFScanner::pop_array`"]
310    pub fn CGPDFScannerPopArray(scanner: CGPDFScannerRef, value: *mut CGPDFArrayRef) -> bool;
311}
312
313extern "C-unwind" {
314    #[cfg(feature = "CGPDFDictionary")]
315    #[deprecated = "renamed to `CGPDFScanner::pop_dictionary`"]
316    pub fn CGPDFScannerPopDictionary(
317        scanner: CGPDFScannerRef,
318        value: *mut CGPDFDictionaryRef,
319    ) -> bool;
320}
321
322extern "C-unwind" {
323    #[cfg(feature = "CGPDFStream")]
324    #[deprecated = "renamed to `CGPDFScanner::pop_stream`"]
325    pub fn CGPDFScannerPopStream(scanner: CGPDFScannerRef, value: *mut CGPDFStreamRef) -> bool;
326}
327
328extern "C-unwind" {
329    #[deprecated = "renamed to `CGPDFScanner::stop`"]
330    pub fn CGPDFScannerStop(s: CGPDFScannerRef);
331}
objc2_core_graphics/generated/CGPDFScanner.rs

objc2_core_graphics/generated/
CGPDFScanner.rs
