xref: /aosp_15_r20/external/harfbuzz_ng/src/hb-blob.cc (revision 2d1272b857b1f7575e6e246373e1cb218663db8a)
1*2d1272b8SAndroid Build Coastguard Worker /*
2*2d1272b8SAndroid Build Coastguard Worker  * Copyright © 2009  Red Hat, Inc.
3*2d1272b8SAndroid Build Coastguard Worker  * Copyright © 2018  Ebrahim Byagowi
4*2d1272b8SAndroid Build Coastguard Worker  *
5*2d1272b8SAndroid Build Coastguard Worker  *  This is part of HarfBuzz, a text shaping library.
6*2d1272b8SAndroid Build Coastguard Worker  *
7*2d1272b8SAndroid Build Coastguard Worker  * Permission is hereby granted, without written agreement and without
8*2d1272b8SAndroid Build Coastguard Worker  * license or royalty fees, to use, copy, modify, and distribute this
9*2d1272b8SAndroid Build Coastguard Worker  * software and its documentation for any purpose, provided that the
10*2d1272b8SAndroid Build Coastguard Worker  * above copyright notice and the following two paragraphs appear in
11*2d1272b8SAndroid Build Coastguard Worker  * all copies of this software.
12*2d1272b8SAndroid Build Coastguard Worker  *
13*2d1272b8SAndroid Build Coastguard Worker  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14*2d1272b8SAndroid Build Coastguard Worker  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15*2d1272b8SAndroid Build Coastguard Worker  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16*2d1272b8SAndroid Build Coastguard Worker  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
17*2d1272b8SAndroid Build Coastguard Worker  * DAMAGE.
18*2d1272b8SAndroid Build Coastguard Worker  *
19*2d1272b8SAndroid Build Coastguard Worker  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20*2d1272b8SAndroid Build Coastguard Worker  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21*2d1272b8SAndroid Build Coastguard Worker  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
22*2d1272b8SAndroid Build Coastguard Worker  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23*2d1272b8SAndroid Build Coastguard Worker  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24*2d1272b8SAndroid Build Coastguard Worker  *
25*2d1272b8SAndroid Build Coastguard Worker  * Red Hat Author(s): Behdad Esfahbod
26*2d1272b8SAndroid Build Coastguard Worker  */
27*2d1272b8SAndroid Build Coastguard Worker 
28*2d1272b8SAndroid Build Coastguard Worker #include "hb.hh"
29*2d1272b8SAndroid Build Coastguard Worker #include "hb-blob.hh"
30*2d1272b8SAndroid Build Coastguard Worker 
31*2d1272b8SAndroid Build Coastguard Worker #ifdef HAVE_SYS_MMAN_H
32*2d1272b8SAndroid Build Coastguard Worker #ifdef HAVE_UNISTD_H
33*2d1272b8SAndroid Build Coastguard Worker #include <unistd.h>
34*2d1272b8SAndroid Build Coastguard Worker #endif /* HAVE_UNISTD_H */
35*2d1272b8SAndroid Build Coastguard Worker #include <sys/mman.h>
36*2d1272b8SAndroid Build Coastguard Worker #endif /* HAVE_SYS_MMAN_H */
37*2d1272b8SAndroid Build Coastguard Worker 
38*2d1272b8SAndroid Build Coastguard Worker 
39*2d1272b8SAndroid Build Coastguard Worker /**
40*2d1272b8SAndroid Build Coastguard Worker  * SECTION: hb-blob
41*2d1272b8SAndroid Build Coastguard Worker  * @title: hb-blob
42*2d1272b8SAndroid Build Coastguard Worker  * @short_description: Binary data containers
43*2d1272b8SAndroid Build Coastguard Worker  * @include: hb.h
44*2d1272b8SAndroid Build Coastguard Worker  *
45*2d1272b8SAndroid Build Coastguard Worker  * Blobs wrap a chunk of binary data to handle lifecycle management of data
46*2d1272b8SAndroid Build Coastguard Worker  * while it is passed between client and HarfBuzz.  Blobs are primarily used
47*2d1272b8SAndroid Build Coastguard Worker  * to create font faces, but also to access font face tables, as well as
48*2d1272b8SAndroid Build Coastguard Worker  * pass around other binary data.
49*2d1272b8SAndroid Build Coastguard Worker  **/
50*2d1272b8SAndroid Build Coastguard Worker 
51*2d1272b8SAndroid Build Coastguard Worker 
52*2d1272b8SAndroid Build Coastguard Worker /**
53*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_create: (skip)
54*2d1272b8SAndroid Build Coastguard Worker  * @data: Pointer to blob data.
55*2d1272b8SAndroid Build Coastguard Worker  * @length: Length of @data in bytes.
56*2d1272b8SAndroid Build Coastguard Worker  * @mode: Memory mode for @data.
57*2d1272b8SAndroid Build Coastguard Worker  * @user_data: Data parameter to pass to @destroy.
58*2d1272b8SAndroid Build Coastguard Worker  * @destroy: (nullable): Callback to call when @data is not needed anymore.
59*2d1272b8SAndroid Build Coastguard Worker  *
60*2d1272b8SAndroid Build Coastguard Worker  * Creates a new "blob" object wrapping @data.  The @mode parameter is used
61*2d1272b8SAndroid Build Coastguard Worker  * to negotiate ownership and lifecycle of @data.
62*2d1272b8SAndroid Build Coastguard Worker  *
63*2d1272b8SAndroid Build Coastguard Worker  * Return value: New blob, or the empty blob if something failed or if @length is
64*2d1272b8SAndroid Build Coastguard Worker  * zero.  Destroy with hb_blob_destroy().
65*2d1272b8SAndroid Build Coastguard Worker  *
66*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
67*2d1272b8SAndroid Build Coastguard Worker  **/
68*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_create(const char * data,unsigned int length,hb_memory_mode_t mode,void * user_data,hb_destroy_func_t destroy)69*2d1272b8SAndroid Build Coastguard Worker hb_blob_create (const char        *data,
70*2d1272b8SAndroid Build Coastguard Worker 		unsigned int       length,
71*2d1272b8SAndroid Build Coastguard Worker 		hb_memory_mode_t   mode,
72*2d1272b8SAndroid Build Coastguard Worker 		void              *user_data,
73*2d1272b8SAndroid Build Coastguard Worker 		hb_destroy_func_t  destroy)
74*2d1272b8SAndroid Build Coastguard Worker {
75*2d1272b8SAndroid Build Coastguard Worker   if (!length)
76*2d1272b8SAndroid Build Coastguard Worker   {
77*2d1272b8SAndroid Build Coastguard Worker     if (destroy)
78*2d1272b8SAndroid Build Coastguard Worker       destroy (user_data);
79*2d1272b8SAndroid Build Coastguard Worker     return hb_blob_get_empty ();
80*2d1272b8SAndroid Build Coastguard Worker   }
81*2d1272b8SAndroid Build Coastguard Worker 
82*2d1272b8SAndroid Build Coastguard Worker   hb_blob_t *blob = hb_blob_create_or_fail (data, length, mode,
83*2d1272b8SAndroid Build Coastguard Worker 					    user_data, destroy);
84*2d1272b8SAndroid Build Coastguard Worker   return likely (blob) ? blob : hb_blob_get_empty ();
85*2d1272b8SAndroid Build Coastguard Worker }
86*2d1272b8SAndroid Build Coastguard Worker 
87*2d1272b8SAndroid Build Coastguard Worker /**
88*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_create_or_fail: (skip)
89*2d1272b8SAndroid Build Coastguard Worker  * @data: Pointer to blob data.
90*2d1272b8SAndroid Build Coastguard Worker  * @length: Length of @data in bytes.
91*2d1272b8SAndroid Build Coastguard Worker  * @mode: Memory mode for @data.
92*2d1272b8SAndroid Build Coastguard Worker  * @user_data: Data parameter to pass to @destroy.
93*2d1272b8SAndroid Build Coastguard Worker  * @destroy: (nullable): Callback to call when @data is not needed anymore.
94*2d1272b8SAndroid Build Coastguard Worker  *
95*2d1272b8SAndroid Build Coastguard Worker  * Creates a new "blob" object wrapping @data.  The @mode parameter is used
96*2d1272b8SAndroid Build Coastguard Worker  * to negotiate ownership and lifecycle of @data.
97*2d1272b8SAndroid Build Coastguard Worker  *
98*2d1272b8SAndroid Build Coastguard Worker  * Note that this function returns a freshly-allocated empty blob even if @length
99*2d1272b8SAndroid Build Coastguard Worker  * is zero. This is in contrast to hb_blob_create(), which returns the singleton
100*2d1272b8SAndroid Build Coastguard Worker  * empty blob (as returned by hb_blob_get_empty()) if @length is zero.
101*2d1272b8SAndroid Build Coastguard Worker  *
102*2d1272b8SAndroid Build Coastguard Worker  * Return value: New blob, or `NULL` if failed.  Destroy with hb_blob_destroy().
103*2d1272b8SAndroid Build Coastguard Worker  *
104*2d1272b8SAndroid Build Coastguard Worker  * Since: 2.8.2
105*2d1272b8SAndroid Build Coastguard Worker  **/
106*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_create_or_fail(const char * data,unsigned int length,hb_memory_mode_t mode,void * user_data,hb_destroy_func_t destroy)107*2d1272b8SAndroid Build Coastguard Worker hb_blob_create_or_fail (const char        *data,
108*2d1272b8SAndroid Build Coastguard Worker 			unsigned int       length,
109*2d1272b8SAndroid Build Coastguard Worker 			hb_memory_mode_t   mode,
110*2d1272b8SAndroid Build Coastguard Worker 			void              *user_data,
111*2d1272b8SAndroid Build Coastguard Worker 			hb_destroy_func_t  destroy)
112*2d1272b8SAndroid Build Coastguard Worker {
113*2d1272b8SAndroid Build Coastguard Worker   hb_blob_t *blob;
114*2d1272b8SAndroid Build Coastguard Worker 
115*2d1272b8SAndroid Build Coastguard Worker   if (length >= 1u << 31 ||
116*2d1272b8SAndroid Build Coastguard Worker       !(blob = hb_object_create<hb_blob_t> ()))
117*2d1272b8SAndroid Build Coastguard Worker   {
118*2d1272b8SAndroid Build Coastguard Worker     if (destroy)
119*2d1272b8SAndroid Build Coastguard Worker       destroy (user_data);
120*2d1272b8SAndroid Build Coastguard Worker     return nullptr;
121*2d1272b8SAndroid Build Coastguard Worker   }
122*2d1272b8SAndroid Build Coastguard Worker 
123*2d1272b8SAndroid Build Coastguard Worker   blob->data = data;
124*2d1272b8SAndroid Build Coastguard Worker   blob->length = length;
125*2d1272b8SAndroid Build Coastguard Worker   blob->mode = mode;
126*2d1272b8SAndroid Build Coastguard Worker 
127*2d1272b8SAndroid Build Coastguard Worker   blob->user_data = user_data;
128*2d1272b8SAndroid Build Coastguard Worker   blob->destroy = destroy;
129*2d1272b8SAndroid Build Coastguard Worker 
130*2d1272b8SAndroid Build Coastguard Worker   if (blob->mode == HB_MEMORY_MODE_DUPLICATE) {
131*2d1272b8SAndroid Build Coastguard Worker     blob->mode = HB_MEMORY_MODE_READONLY;
132*2d1272b8SAndroid Build Coastguard Worker     if (!blob->try_make_writable ())
133*2d1272b8SAndroid Build Coastguard Worker     {
134*2d1272b8SAndroid Build Coastguard Worker       hb_blob_destroy (blob);
135*2d1272b8SAndroid Build Coastguard Worker       return nullptr;
136*2d1272b8SAndroid Build Coastguard Worker     }
137*2d1272b8SAndroid Build Coastguard Worker   }
138*2d1272b8SAndroid Build Coastguard Worker 
139*2d1272b8SAndroid Build Coastguard Worker   return blob;
140*2d1272b8SAndroid Build Coastguard Worker }
141*2d1272b8SAndroid Build Coastguard Worker 
142*2d1272b8SAndroid Build Coastguard Worker static void
_hb_blob_destroy(void * data)143*2d1272b8SAndroid Build Coastguard Worker _hb_blob_destroy (void *data)
144*2d1272b8SAndroid Build Coastguard Worker {
145*2d1272b8SAndroid Build Coastguard Worker   hb_blob_destroy ((hb_blob_t *) data);
146*2d1272b8SAndroid Build Coastguard Worker }
147*2d1272b8SAndroid Build Coastguard Worker 
148*2d1272b8SAndroid Build Coastguard Worker /**
149*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_create_sub_blob:
150*2d1272b8SAndroid Build Coastguard Worker  * @parent: Parent blob.
151*2d1272b8SAndroid Build Coastguard Worker  * @offset: Start offset of sub-blob within @parent, in bytes.
152*2d1272b8SAndroid Build Coastguard Worker  * @length: Length of sub-blob.
153*2d1272b8SAndroid Build Coastguard Worker  *
154*2d1272b8SAndroid Build Coastguard Worker  * Returns a blob that represents a range of bytes in @parent.  The new
155*2d1272b8SAndroid Build Coastguard Worker  * blob is always created with #HB_MEMORY_MODE_READONLY, meaning that it
156*2d1272b8SAndroid Build Coastguard Worker  * will never modify data in the parent blob.  The parent data is not
157*2d1272b8SAndroid Build Coastguard Worker  * expected to be modified, and will result in undefined behavior if it
158*2d1272b8SAndroid Build Coastguard Worker  * is.
159*2d1272b8SAndroid Build Coastguard Worker  *
160*2d1272b8SAndroid Build Coastguard Worker  * Makes @parent immutable.
161*2d1272b8SAndroid Build Coastguard Worker  *
162*2d1272b8SAndroid Build Coastguard Worker  * Return value: New blob, or the empty blob if something failed or if
163*2d1272b8SAndroid Build Coastguard Worker  * @length is zero or @offset is beyond the end of @parent's data.  Destroy
164*2d1272b8SAndroid Build Coastguard Worker  * with hb_blob_destroy().
165*2d1272b8SAndroid Build Coastguard Worker  *
166*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
167*2d1272b8SAndroid Build Coastguard Worker  **/
168*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_create_sub_blob(hb_blob_t * parent,unsigned int offset,unsigned int length)169*2d1272b8SAndroid Build Coastguard Worker hb_blob_create_sub_blob (hb_blob_t    *parent,
170*2d1272b8SAndroid Build Coastguard Worker 			 unsigned int  offset,
171*2d1272b8SAndroid Build Coastguard Worker 			 unsigned int  length)
172*2d1272b8SAndroid Build Coastguard Worker {
173*2d1272b8SAndroid Build Coastguard Worker   hb_blob_t *blob;
174*2d1272b8SAndroid Build Coastguard Worker 
175*2d1272b8SAndroid Build Coastguard Worker   if (!length || !parent || offset >= parent->length)
176*2d1272b8SAndroid Build Coastguard Worker     return hb_blob_get_empty ();
177*2d1272b8SAndroid Build Coastguard Worker 
178*2d1272b8SAndroid Build Coastguard Worker   hb_blob_make_immutable (parent);
179*2d1272b8SAndroid Build Coastguard Worker 
180*2d1272b8SAndroid Build Coastguard Worker   blob = hb_blob_create (parent->data + offset,
181*2d1272b8SAndroid Build Coastguard Worker 			 hb_min (length, parent->length - offset),
182*2d1272b8SAndroid Build Coastguard Worker 			 HB_MEMORY_MODE_READONLY,
183*2d1272b8SAndroid Build Coastguard Worker 			 hb_blob_reference (parent),
184*2d1272b8SAndroid Build Coastguard Worker 			 _hb_blob_destroy);
185*2d1272b8SAndroid Build Coastguard Worker 
186*2d1272b8SAndroid Build Coastguard Worker   return blob;
187*2d1272b8SAndroid Build Coastguard Worker }
188*2d1272b8SAndroid Build Coastguard Worker 
189*2d1272b8SAndroid Build Coastguard Worker /**
190*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_copy_writable_or_fail:
191*2d1272b8SAndroid Build Coastguard Worker  * @blob: A blob.
192*2d1272b8SAndroid Build Coastguard Worker  *
193*2d1272b8SAndroid Build Coastguard Worker  * Makes a writable copy of @blob.
194*2d1272b8SAndroid Build Coastguard Worker  *
195*2d1272b8SAndroid Build Coastguard Worker  * Return value: The new blob, or nullptr if allocation failed
196*2d1272b8SAndroid Build Coastguard Worker  *
197*2d1272b8SAndroid Build Coastguard Worker  * Since: 1.8.0
198*2d1272b8SAndroid Build Coastguard Worker  **/
199*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_copy_writable_or_fail(hb_blob_t * blob)200*2d1272b8SAndroid Build Coastguard Worker hb_blob_copy_writable_or_fail (hb_blob_t *blob)
201*2d1272b8SAndroid Build Coastguard Worker {
202*2d1272b8SAndroid Build Coastguard Worker   blob = hb_blob_create (blob->data,
203*2d1272b8SAndroid Build Coastguard Worker 			 blob->length,
204*2d1272b8SAndroid Build Coastguard Worker 			 HB_MEMORY_MODE_DUPLICATE,
205*2d1272b8SAndroid Build Coastguard Worker 			 nullptr,
206*2d1272b8SAndroid Build Coastguard Worker 			 nullptr);
207*2d1272b8SAndroid Build Coastguard Worker 
208*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (blob == hb_blob_get_empty ()))
209*2d1272b8SAndroid Build Coastguard Worker     blob = nullptr;
210*2d1272b8SAndroid Build Coastguard Worker 
211*2d1272b8SAndroid Build Coastguard Worker   return blob;
212*2d1272b8SAndroid Build Coastguard Worker }
213*2d1272b8SAndroid Build Coastguard Worker 
214*2d1272b8SAndroid Build Coastguard Worker /**
215*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_get_empty:
216*2d1272b8SAndroid Build Coastguard Worker  *
217*2d1272b8SAndroid Build Coastguard Worker  * Returns the singleton empty blob.
218*2d1272b8SAndroid Build Coastguard Worker  *
219*2d1272b8SAndroid Build Coastguard Worker  * See TODO:link object types for more information.
220*2d1272b8SAndroid Build Coastguard Worker  *
221*2d1272b8SAndroid Build Coastguard Worker  * Return value: (transfer full): The empty blob.
222*2d1272b8SAndroid Build Coastguard Worker  *
223*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
224*2d1272b8SAndroid Build Coastguard Worker  **/
225*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_get_empty()226*2d1272b8SAndroid Build Coastguard Worker hb_blob_get_empty ()
227*2d1272b8SAndroid Build Coastguard Worker {
228*2d1272b8SAndroid Build Coastguard Worker   return const_cast<hb_blob_t *> (&Null (hb_blob_t));
229*2d1272b8SAndroid Build Coastguard Worker }
230*2d1272b8SAndroid Build Coastguard Worker 
231*2d1272b8SAndroid Build Coastguard Worker /**
232*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_reference: (skip)
233*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob.
234*2d1272b8SAndroid Build Coastguard Worker  *
235*2d1272b8SAndroid Build Coastguard Worker  * Increases the reference count on @blob.
236*2d1272b8SAndroid Build Coastguard Worker  *
237*2d1272b8SAndroid Build Coastguard Worker  * See TODO:link object types for more information.
238*2d1272b8SAndroid Build Coastguard Worker  *
239*2d1272b8SAndroid Build Coastguard Worker  * Return value: @blob.
240*2d1272b8SAndroid Build Coastguard Worker  *
241*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
242*2d1272b8SAndroid Build Coastguard Worker  **/
243*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_reference(hb_blob_t * blob)244*2d1272b8SAndroid Build Coastguard Worker hb_blob_reference (hb_blob_t *blob)
245*2d1272b8SAndroid Build Coastguard Worker {
246*2d1272b8SAndroid Build Coastguard Worker   return hb_object_reference (blob);
247*2d1272b8SAndroid Build Coastguard Worker }
248*2d1272b8SAndroid Build Coastguard Worker 
249*2d1272b8SAndroid Build Coastguard Worker /**
250*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_destroy: (skip)
251*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob.
252*2d1272b8SAndroid Build Coastguard Worker  *
253*2d1272b8SAndroid Build Coastguard Worker  * Decreases the reference count on @blob, and if it reaches zero, destroys
254*2d1272b8SAndroid Build Coastguard Worker  * @blob, freeing all memory, possibly calling the destroy-callback the blob
255*2d1272b8SAndroid Build Coastguard Worker  * was created for if it has not been called already.
256*2d1272b8SAndroid Build Coastguard Worker  *
257*2d1272b8SAndroid Build Coastguard Worker  * See TODO:link object types for more information.
258*2d1272b8SAndroid Build Coastguard Worker  *
259*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
260*2d1272b8SAndroid Build Coastguard Worker  **/
261*2d1272b8SAndroid Build Coastguard Worker void
hb_blob_destroy(hb_blob_t * blob)262*2d1272b8SAndroid Build Coastguard Worker hb_blob_destroy (hb_blob_t *blob)
263*2d1272b8SAndroid Build Coastguard Worker {
264*2d1272b8SAndroid Build Coastguard Worker   if (!hb_object_destroy (blob)) return;
265*2d1272b8SAndroid Build Coastguard Worker 
266*2d1272b8SAndroid Build Coastguard Worker   hb_free (blob);
267*2d1272b8SAndroid Build Coastguard Worker }
268*2d1272b8SAndroid Build Coastguard Worker 
269*2d1272b8SAndroid Build Coastguard Worker /**
270*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_set_user_data: (skip)
271*2d1272b8SAndroid Build Coastguard Worker  * @blob: An #hb_blob_t
272*2d1272b8SAndroid Build Coastguard Worker  * @key: The user-data key to set
273*2d1272b8SAndroid Build Coastguard Worker  * @data: A pointer to the user data to set
274*2d1272b8SAndroid Build Coastguard Worker  * @destroy: (nullable): A callback to call when @data is not needed anymore
275*2d1272b8SAndroid Build Coastguard Worker  * @replace: Whether to replace an existing data with the same key
276*2d1272b8SAndroid Build Coastguard Worker  *
277*2d1272b8SAndroid Build Coastguard Worker  * Attaches a user-data key/data pair to the specified blob.
278*2d1272b8SAndroid Build Coastguard Worker  *
279*2d1272b8SAndroid Build Coastguard Worker  * Return value: `true` if success, `false` otherwise
280*2d1272b8SAndroid Build Coastguard Worker  *
281*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
282*2d1272b8SAndroid Build Coastguard Worker  **/
283*2d1272b8SAndroid Build Coastguard Worker hb_bool_t
hb_blob_set_user_data(hb_blob_t * blob,hb_user_data_key_t * key,void * data,hb_destroy_func_t destroy,hb_bool_t replace)284*2d1272b8SAndroid Build Coastguard Worker hb_blob_set_user_data (hb_blob_t          *blob,
285*2d1272b8SAndroid Build Coastguard Worker 		       hb_user_data_key_t *key,
286*2d1272b8SAndroid Build Coastguard Worker 		       void *              data,
287*2d1272b8SAndroid Build Coastguard Worker 		       hb_destroy_func_t   destroy,
288*2d1272b8SAndroid Build Coastguard Worker 		       hb_bool_t           replace)
289*2d1272b8SAndroid Build Coastguard Worker {
290*2d1272b8SAndroid Build Coastguard Worker   return hb_object_set_user_data (blob, key, data, destroy, replace);
291*2d1272b8SAndroid Build Coastguard Worker }
292*2d1272b8SAndroid Build Coastguard Worker 
293*2d1272b8SAndroid Build Coastguard Worker /**
294*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_get_user_data: (skip)
295*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob
296*2d1272b8SAndroid Build Coastguard Worker  * @key: The user-data key to query
297*2d1272b8SAndroid Build Coastguard Worker  *
298*2d1272b8SAndroid Build Coastguard Worker  * Fetches the user data associated with the specified key,
299*2d1272b8SAndroid Build Coastguard Worker  * attached to the specified font-functions structure.
300*2d1272b8SAndroid Build Coastguard Worker  *
301*2d1272b8SAndroid Build Coastguard Worker  * Return value: (transfer none): A pointer to the user data
302*2d1272b8SAndroid Build Coastguard Worker  *
303*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
304*2d1272b8SAndroid Build Coastguard Worker  **/
305*2d1272b8SAndroid Build Coastguard Worker void *
hb_blob_get_user_data(const hb_blob_t * blob,hb_user_data_key_t * key)306*2d1272b8SAndroid Build Coastguard Worker hb_blob_get_user_data (const hb_blob_t    *blob,
307*2d1272b8SAndroid Build Coastguard Worker 		       hb_user_data_key_t *key)
308*2d1272b8SAndroid Build Coastguard Worker {
309*2d1272b8SAndroid Build Coastguard Worker   return hb_object_get_user_data (blob, key);
310*2d1272b8SAndroid Build Coastguard Worker }
311*2d1272b8SAndroid Build Coastguard Worker 
312*2d1272b8SAndroid Build Coastguard Worker 
313*2d1272b8SAndroid Build Coastguard Worker /**
314*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_make_immutable:
315*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob
316*2d1272b8SAndroid Build Coastguard Worker  *
317*2d1272b8SAndroid Build Coastguard Worker  * Makes a blob immutable.
318*2d1272b8SAndroid Build Coastguard Worker  *
319*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
320*2d1272b8SAndroid Build Coastguard Worker  **/
321*2d1272b8SAndroid Build Coastguard Worker void
hb_blob_make_immutable(hb_blob_t * blob)322*2d1272b8SAndroid Build Coastguard Worker hb_blob_make_immutable (hb_blob_t *blob)
323*2d1272b8SAndroid Build Coastguard Worker {
324*2d1272b8SAndroid Build Coastguard Worker   if (hb_object_is_immutable (blob))
325*2d1272b8SAndroid Build Coastguard Worker     return;
326*2d1272b8SAndroid Build Coastguard Worker 
327*2d1272b8SAndroid Build Coastguard Worker   hb_object_make_immutable (blob);
328*2d1272b8SAndroid Build Coastguard Worker }
329*2d1272b8SAndroid Build Coastguard Worker 
330*2d1272b8SAndroid Build Coastguard Worker /**
331*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_is_immutable:
332*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob.
333*2d1272b8SAndroid Build Coastguard Worker  *
334*2d1272b8SAndroid Build Coastguard Worker  * Tests whether a blob is immutable.
335*2d1272b8SAndroid Build Coastguard Worker  *
336*2d1272b8SAndroid Build Coastguard Worker  * Return value: `true` if @blob is immutable, `false` otherwise
337*2d1272b8SAndroid Build Coastguard Worker  *
338*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
339*2d1272b8SAndroid Build Coastguard Worker  **/
340*2d1272b8SAndroid Build Coastguard Worker hb_bool_t
hb_blob_is_immutable(hb_blob_t * blob)341*2d1272b8SAndroid Build Coastguard Worker hb_blob_is_immutable (hb_blob_t *blob)
342*2d1272b8SAndroid Build Coastguard Worker {
343*2d1272b8SAndroid Build Coastguard Worker   return hb_object_is_immutable (blob);
344*2d1272b8SAndroid Build Coastguard Worker }
345*2d1272b8SAndroid Build Coastguard Worker 
346*2d1272b8SAndroid Build Coastguard Worker 
347*2d1272b8SAndroid Build Coastguard Worker /**
348*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_get_length:
349*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob.
350*2d1272b8SAndroid Build Coastguard Worker  *
351*2d1272b8SAndroid Build Coastguard Worker  * Fetches the length of a blob's data.
352*2d1272b8SAndroid Build Coastguard Worker  *
353*2d1272b8SAndroid Build Coastguard Worker  * Return value: the length of @blob data in bytes.
354*2d1272b8SAndroid Build Coastguard Worker  *
355*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
356*2d1272b8SAndroid Build Coastguard Worker  **/
357*2d1272b8SAndroid Build Coastguard Worker unsigned int
hb_blob_get_length(hb_blob_t * blob)358*2d1272b8SAndroid Build Coastguard Worker hb_blob_get_length (hb_blob_t *blob)
359*2d1272b8SAndroid Build Coastguard Worker {
360*2d1272b8SAndroid Build Coastguard Worker   return blob->length;
361*2d1272b8SAndroid Build Coastguard Worker }
362*2d1272b8SAndroid Build Coastguard Worker 
363*2d1272b8SAndroid Build Coastguard Worker /**
364*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_get_data:
365*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob.
366*2d1272b8SAndroid Build Coastguard Worker  * @length: (out): The length in bytes of the data retrieved
367*2d1272b8SAndroid Build Coastguard Worker  *
368*2d1272b8SAndroid Build Coastguard Worker  * Fetches the data from a blob.
369*2d1272b8SAndroid Build Coastguard Worker  *
370*2d1272b8SAndroid Build Coastguard Worker  * Returns: (nullable) (transfer none) (array length=length): the byte data of @blob.
371*2d1272b8SAndroid Build Coastguard Worker  *
372*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
373*2d1272b8SAndroid Build Coastguard Worker  **/
374*2d1272b8SAndroid Build Coastguard Worker const char *
hb_blob_get_data(hb_blob_t * blob,unsigned int * length)375*2d1272b8SAndroid Build Coastguard Worker hb_blob_get_data (hb_blob_t *blob, unsigned int *length)
376*2d1272b8SAndroid Build Coastguard Worker {
377*2d1272b8SAndroid Build Coastguard Worker   if (length)
378*2d1272b8SAndroid Build Coastguard Worker     *length = blob->length;
379*2d1272b8SAndroid Build Coastguard Worker 
380*2d1272b8SAndroid Build Coastguard Worker   return blob->data;
381*2d1272b8SAndroid Build Coastguard Worker }
382*2d1272b8SAndroid Build Coastguard Worker 
383*2d1272b8SAndroid Build Coastguard Worker /**
384*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_get_data_writable:
385*2d1272b8SAndroid Build Coastguard Worker  * @blob: a blob.
386*2d1272b8SAndroid Build Coastguard Worker  * @length: (out): output length of the writable data.
387*2d1272b8SAndroid Build Coastguard Worker  *
388*2d1272b8SAndroid Build Coastguard Worker  * Tries to make blob data writable (possibly copying it) and
389*2d1272b8SAndroid Build Coastguard Worker  * return pointer to data.
390*2d1272b8SAndroid Build Coastguard Worker  *
391*2d1272b8SAndroid Build Coastguard Worker  * Fails if blob has been made immutable, or if memory allocation
392*2d1272b8SAndroid Build Coastguard Worker  * fails.
393*2d1272b8SAndroid Build Coastguard Worker  *
394*2d1272b8SAndroid Build Coastguard Worker  * Returns: (transfer none) (array length=length): Writable blob data,
395*2d1272b8SAndroid Build Coastguard Worker  * or `NULL` if failed.
396*2d1272b8SAndroid Build Coastguard Worker  *
397*2d1272b8SAndroid Build Coastguard Worker  * Since: 0.9.2
398*2d1272b8SAndroid Build Coastguard Worker  **/
399*2d1272b8SAndroid Build Coastguard Worker char *
hb_blob_get_data_writable(hb_blob_t * blob,unsigned int * length)400*2d1272b8SAndroid Build Coastguard Worker hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length)
401*2d1272b8SAndroid Build Coastguard Worker {
402*2d1272b8SAndroid Build Coastguard Worker   if (hb_object_is_immutable (blob) ||
403*2d1272b8SAndroid Build Coastguard Worker      !blob->try_make_writable ())
404*2d1272b8SAndroid Build Coastguard Worker   {
405*2d1272b8SAndroid Build Coastguard Worker     if (length) *length = 0;
406*2d1272b8SAndroid Build Coastguard Worker     return nullptr;
407*2d1272b8SAndroid Build Coastguard Worker   }
408*2d1272b8SAndroid Build Coastguard Worker 
409*2d1272b8SAndroid Build Coastguard Worker   if (length) *length = blob->length;
410*2d1272b8SAndroid Build Coastguard Worker   return const_cast<char *> (blob->data);
411*2d1272b8SAndroid Build Coastguard Worker }
412*2d1272b8SAndroid Build Coastguard Worker 
413*2d1272b8SAndroid Build Coastguard Worker 
414*2d1272b8SAndroid Build Coastguard Worker bool
try_make_writable_inplace_unix()415*2d1272b8SAndroid Build Coastguard Worker hb_blob_t::try_make_writable_inplace_unix ()
416*2d1272b8SAndroid Build Coastguard Worker {
417*2d1272b8SAndroid Build Coastguard Worker #if defined(HAVE_SYS_MMAN_H) && defined(HAVE_MPROTECT)
418*2d1272b8SAndroid Build Coastguard Worker   uintptr_t pagesize = -1, mask, length;
419*2d1272b8SAndroid Build Coastguard Worker   const char *addr;
420*2d1272b8SAndroid Build Coastguard Worker 
421*2d1272b8SAndroid Build Coastguard Worker #if defined(HAVE_SYSCONF) && defined(_SC_PAGE_SIZE)
422*2d1272b8SAndroid Build Coastguard Worker   pagesize = (uintptr_t) sysconf (_SC_PAGE_SIZE);
423*2d1272b8SAndroid Build Coastguard Worker #elif defined(HAVE_SYSCONF) && defined(_SC_PAGESIZE)
424*2d1272b8SAndroid Build Coastguard Worker   pagesize = (uintptr_t) sysconf (_SC_PAGESIZE);
425*2d1272b8SAndroid Build Coastguard Worker #elif defined(HAVE_GETPAGESIZE)
426*2d1272b8SAndroid Build Coastguard Worker   pagesize = (uintptr_t) getpagesize ();
427*2d1272b8SAndroid Build Coastguard Worker #endif
428*2d1272b8SAndroid Build Coastguard Worker 
429*2d1272b8SAndroid Build Coastguard Worker   if ((uintptr_t) -1L == pagesize) {
430*2d1272b8SAndroid Build Coastguard Worker     DEBUG_MSG_FUNC (BLOB, this, "failed to get pagesize: %s", strerror (errno));
431*2d1272b8SAndroid Build Coastguard Worker     return false;
432*2d1272b8SAndroid Build Coastguard Worker   }
433*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this, "pagesize is %lu", (unsigned long) pagesize);
434*2d1272b8SAndroid Build Coastguard Worker 
435*2d1272b8SAndroid Build Coastguard Worker   mask = ~(pagesize-1);
436*2d1272b8SAndroid Build Coastguard Worker   addr = (const char *) (((uintptr_t) this->data) & mask);
437*2d1272b8SAndroid Build Coastguard Worker   length = (const char *) (((uintptr_t) this->data + this->length + pagesize-1) & mask)  - addr;
438*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this,
439*2d1272b8SAndroid Build Coastguard Worker 		  "calling mprotect on [%p..%p] (%lu bytes)",
440*2d1272b8SAndroid Build Coastguard Worker 		  addr, addr+length, (unsigned long) length);
441*2d1272b8SAndroid Build Coastguard Worker   if (-1 == mprotect ((void *) addr, length, PROT_READ | PROT_WRITE)) {
442*2d1272b8SAndroid Build Coastguard Worker     DEBUG_MSG_FUNC (BLOB, this, "mprotect failed: %s", strerror (errno));
443*2d1272b8SAndroid Build Coastguard Worker     return false;
444*2d1272b8SAndroid Build Coastguard Worker   }
445*2d1272b8SAndroid Build Coastguard Worker 
446*2d1272b8SAndroid Build Coastguard Worker   this->mode = HB_MEMORY_MODE_WRITABLE;
447*2d1272b8SAndroid Build Coastguard Worker 
448*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this,
449*2d1272b8SAndroid Build Coastguard Worker 		  "successfully made [%p..%p] (%lu bytes) writable\n",
450*2d1272b8SAndroid Build Coastguard Worker 		  addr, addr+length, (unsigned long) length);
451*2d1272b8SAndroid Build Coastguard Worker   return true;
452*2d1272b8SAndroid Build Coastguard Worker #else
453*2d1272b8SAndroid Build Coastguard Worker   return false;
454*2d1272b8SAndroid Build Coastguard Worker #endif
455*2d1272b8SAndroid Build Coastguard Worker }
456*2d1272b8SAndroid Build Coastguard Worker 
457*2d1272b8SAndroid Build Coastguard Worker bool
try_make_writable_inplace()458*2d1272b8SAndroid Build Coastguard Worker hb_blob_t::try_make_writable_inplace ()
459*2d1272b8SAndroid Build Coastguard Worker {
460*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this, "making writable inplace\n");
461*2d1272b8SAndroid Build Coastguard Worker 
462*2d1272b8SAndroid Build Coastguard Worker   if (this->try_make_writable_inplace_unix ())
463*2d1272b8SAndroid Build Coastguard Worker     return true;
464*2d1272b8SAndroid Build Coastguard Worker 
465*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this, "making writable -> FAILED\n");
466*2d1272b8SAndroid Build Coastguard Worker 
467*2d1272b8SAndroid Build Coastguard Worker   /* Failed to make writable inplace, mark that */
468*2d1272b8SAndroid Build Coastguard Worker   this->mode = HB_MEMORY_MODE_READONLY;
469*2d1272b8SAndroid Build Coastguard Worker   return false;
470*2d1272b8SAndroid Build Coastguard Worker }
471*2d1272b8SAndroid Build Coastguard Worker 
472*2d1272b8SAndroid Build Coastguard Worker bool
try_make_writable()473*2d1272b8SAndroid Build Coastguard Worker hb_blob_t::try_make_writable ()
474*2d1272b8SAndroid Build Coastguard Worker {
475*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!length))
476*2d1272b8SAndroid Build Coastguard Worker     mode = HB_MEMORY_MODE_WRITABLE;
477*2d1272b8SAndroid Build Coastguard Worker 
478*2d1272b8SAndroid Build Coastguard Worker   if (this->mode == HB_MEMORY_MODE_WRITABLE)
479*2d1272b8SAndroid Build Coastguard Worker     return true;
480*2d1272b8SAndroid Build Coastguard Worker 
481*2d1272b8SAndroid Build Coastguard Worker   if (this->mode == HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE && this->try_make_writable_inplace ())
482*2d1272b8SAndroid Build Coastguard Worker     return true;
483*2d1272b8SAndroid Build Coastguard Worker 
484*2d1272b8SAndroid Build Coastguard Worker   if (this->mode == HB_MEMORY_MODE_WRITABLE)
485*2d1272b8SAndroid Build Coastguard Worker     return true;
486*2d1272b8SAndroid Build Coastguard Worker 
487*2d1272b8SAndroid Build Coastguard Worker 
488*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this, "current data is -> %p\n", this->data);
489*2d1272b8SAndroid Build Coastguard Worker 
490*2d1272b8SAndroid Build Coastguard Worker   char *new_data;
491*2d1272b8SAndroid Build Coastguard Worker 
492*2d1272b8SAndroid Build Coastguard Worker   new_data = (char *) hb_malloc (this->length);
493*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!new_data))
494*2d1272b8SAndroid Build Coastguard Worker     return false;
495*2d1272b8SAndroid Build Coastguard Worker 
496*2d1272b8SAndroid Build Coastguard Worker   DEBUG_MSG_FUNC (BLOB, this, "dupped successfully -> %p\n", this->data);
497*2d1272b8SAndroid Build Coastguard Worker 
498*2d1272b8SAndroid Build Coastguard Worker   hb_memcpy (new_data, this->data, this->length);
499*2d1272b8SAndroid Build Coastguard Worker   this->destroy_user_data ();
500*2d1272b8SAndroid Build Coastguard Worker   this->mode = HB_MEMORY_MODE_WRITABLE;
501*2d1272b8SAndroid Build Coastguard Worker   this->data = new_data;
502*2d1272b8SAndroid Build Coastguard Worker   this->user_data = new_data;
503*2d1272b8SAndroid Build Coastguard Worker   this->destroy = hb_free;
504*2d1272b8SAndroid Build Coastguard Worker 
505*2d1272b8SAndroid Build Coastguard Worker   return true;
506*2d1272b8SAndroid Build Coastguard Worker }
507*2d1272b8SAndroid Build Coastguard Worker 
508*2d1272b8SAndroid Build Coastguard Worker /*
509*2d1272b8SAndroid Build Coastguard Worker  * Mmap
510*2d1272b8SAndroid Build Coastguard Worker  */
511*2d1272b8SAndroid Build Coastguard Worker 
512*2d1272b8SAndroid Build Coastguard Worker #ifndef HB_NO_OPEN
513*2d1272b8SAndroid Build Coastguard Worker #ifdef HAVE_MMAP
514*2d1272b8SAndroid Build Coastguard Worker # if !defined(HB_NO_RESOURCE_FORK) && defined(__APPLE__)
515*2d1272b8SAndroid Build Coastguard Worker #  include <sys/paths.h>
516*2d1272b8SAndroid Build Coastguard Worker # endif
517*2d1272b8SAndroid Build Coastguard Worker # include <sys/types.h>
518*2d1272b8SAndroid Build Coastguard Worker # include <sys/stat.h>
519*2d1272b8SAndroid Build Coastguard Worker # include <fcntl.h>
520*2d1272b8SAndroid Build Coastguard Worker #endif
521*2d1272b8SAndroid Build Coastguard Worker 
522*2d1272b8SAndroid Build Coastguard Worker #ifdef _WIN32
523*2d1272b8SAndroid Build Coastguard Worker # include <windows.h>
524*2d1272b8SAndroid Build Coastguard Worker #else
525*2d1272b8SAndroid Build Coastguard Worker # ifndef O_BINARY
526*2d1272b8SAndroid Build Coastguard Worker #  define O_BINARY 0
527*2d1272b8SAndroid Build Coastguard Worker # endif
528*2d1272b8SAndroid Build Coastguard Worker #endif
529*2d1272b8SAndroid Build Coastguard Worker 
530*2d1272b8SAndroid Build Coastguard Worker #ifndef MAP_NORESERVE
531*2d1272b8SAndroid Build Coastguard Worker # define MAP_NORESERVE 0
532*2d1272b8SAndroid Build Coastguard Worker #endif
533*2d1272b8SAndroid Build Coastguard Worker 
534*2d1272b8SAndroid Build Coastguard Worker struct hb_mapped_file_t
535*2d1272b8SAndroid Build Coastguard Worker {
536*2d1272b8SAndroid Build Coastguard Worker   char *contents;
537*2d1272b8SAndroid Build Coastguard Worker   unsigned long length;
538*2d1272b8SAndroid Build Coastguard Worker #ifdef _WIN32
539*2d1272b8SAndroid Build Coastguard Worker   HANDLE mapping;
540*2d1272b8SAndroid Build Coastguard Worker #endif
541*2d1272b8SAndroid Build Coastguard Worker };
542*2d1272b8SAndroid Build Coastguard Worker 
543*2d1272b8SAndroid Build Coastguard Worker #if (defined(HAVE_MMAP) || defined(_WIN32)) && !defined(HB_NO_MMAP)
544*2d1272b8SAndroid Build Coastguard Worker static void
_hb_mapped_file_destroy(void * file_)545*2d1272b8SAndroid Build Coastguard Worker _hb_mapped_file_destroy (void *file_)
546*2d1272b8SAndroid Build Coastguard Worker {
547*2d1272b8SAndroid Build Coastguard Worker   hb_mapped_file_t *file = (hb_mapped_file_t *) file_;
548*2d1272b8SAndroid Build Coastguard Worker #ifdef HAVE_MMAP
549*2d1272b8SAndroid Build Coastguard Worker   munmap (file->contents, file->length);
550*2d1272b8SAndroid Build Coastguard Worker #elif defined(_WIN32)
551*2d1272b8SAndroid Build Coastguard Worker   UnmapViewOfFile (file->contents);
552*2d1272b8SAndroid Build Coastguard Worker   CloseHandle (file->mapping);
553*2d1272b8SAndroid Build Coastguard Worker #else
554*2d1272b8SAndroid Build Coastguard Worker   assert (0); // If we don't have mmap we shouldn't reach here
555*2d1272b8SAndroid Build Coastguard Worker #endif
556*2d1272b8SAndroid Build Coastguard Worker 
557*2d1272b8SAndroid Build Coastguard Worker   hb_free (file);
558*2d1272b8SAndroid Build Coastguard Worker }
559*2d1272b8SAndroid Build Coastguard Worker #endif
560*2d1272b8SAndroid Build Coastguard Worker 
561*2d1272b8SAndroid Build Coastguard Worker #ifdef _PATH_RSRCFORKSPEC
562*2d1272b8SAndroid Build Coastguard Worker static int
_open_resource_fork(const char * file_name,hb_mapped_file_t * file)563*2d1272b8SAndroid Build Coastguard Worker _open_resource_fork (const char *file_name, hb_mapped_file_t *file)
564*2d1272b8SAndroid Build Coastguard Worker {
565*2d1272b8SAndroid Build Coastguard Worker   size_t name_len = strlen (file_name);
566*2d1272b8SAndroid Build Coastguard Worker   size_t len = name_len + sizeof (_PATH_RSRCFORKSPEC);
567*2d1272b8SAndroid Build Coastguard Worker 
568*2d1272b8SAndroid Build Coastguard Worker   char *rsrc_name = (char *) hb_malloc (len);
569*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!rsrc_name)) return -1;
570*2d1272b8SAndroid Build Coastguard Worker 
571*2d1272b8SAndroid Build Coastguard Worker   strncpy (rsrc_name, file_name, name_len);
572*2d1272b8SAndroid Build Coastguard Worker   strncpy (rsrc_name + name_len, _PATH_RSRCFORKSPEC,
573*2d1272b8SAndroid Build Coastguard Worker 	   sizeof (_PATH_RSRCFORKSPEC));
574*2d1272b8SAndroid Build Coastguard Worker 
575*2d1272b8SAndroid Build Coastguard Worker   int fd = open (rsrc_name, O_RDONLY | O_BINARY, 0);
576*2d1272b8SAndroid Build Coastguard Worker   hb_free (rsrc_name);
577*2d1272b8SAndroid Build Coastguard Worker 
578*2d1272b8SAndroid Build Coastguard Worker   if (fd != -1)
579*2d1272b8SAndroid Build Coastguard Worker   {
580*2d1272b8SAndroid Build Coastguard Worker     struct stat st;
581*2d1272b8SAndroid Build Coastguard Worker     if (fstat (fd, &st) != -1)
582*2d1272b8SAndroid Build Coastguard Worker       file->length = (unsigned long) st.st_size;
583*2d1272b8SAndroid Build Coastguard Worker     else
584*2d1272b8SAndroid Build Coastguard Worker     {
585*2d1272b8SAndroid Build Coastguard Worker       close (fd);
586*2d1272b8SAndroid Build Coastguard Worker       fd = -1;
587*2d1272b8SAndroid Build Coastguard Worker     }
588*2d1272b8SAndroid Build Coastguard Worker   }
589*2d1272b8SAndroid Build Coastguard Worker 
590*2d1272b8SAndroid Build Coastguard Worker   return fd;
591*2d1272b8SAndroid Build Coastguard Worker }
592*2d1272b8SAndroid Build Coastguard Worker #endif
593*2d1272b8SAndroid Build Coastguard Worker 
594*2d1272b8SAndroid Build Coastguard Worker /**
595*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_create_from_file:
596*2d1272b8SAndroid Build Coastguard Worker  * @file_name: A font filename
597*2d1272b8SAndroid Build Coastguard Worker  *
598*2d1272b8SAndroid Build Coastguard Worker  * Creates a new blob containing the data from the
599*2d1272b8SAndroid Build Coastguard Worker  * specified binary font file.
600*2d1272b8SAndroid Build Coastguard Worker  *
601*2d1272b8SAndroid Build Coastguard Worker  * The filename is passed directly to the system on all platforms,
602*2d1272b8SAndroid Build Coastguard Worker  * except on Windows, where the filename is interpreted as UTF-8.
603*2d1272b8SAndroid Build Coastguard Worker  * Only if the filename is not valid UTF-8, it will be interpreted
604*2d1272b8SAndroid Build Coastguard Worker  * according to the system codepage.
605*2d1272b8SAndroid Build Coastguard Worker  *
606*2d1272b8SAndroid Build Coastguard Worker  * Returns: An #hb_blob_t pointer with the content of the file,
607*2d1272b8SAndroid Build Coastguard Worker  * or hb_blob_get_empty() if failed.
608*2d1272b8SAndroid Build Coastguard Worker  *
609*2d1272b8SAndroid Build Coastguard Worker  * Since: 1.7.7
610*2d1272b8SAndroid Build Coastguard Worker  **/
611*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_create_from_file(const char * file_name)612*2d1272b8SAndroid Build Coastguard Worker hb_blob_create_from_file (const char *file_name)
613*2d1272b8SAndroid Build Coastguard Worker {
614*2d1272b8SAndroid Build Coastguard Worker   hb_blob_t *blob = hb_blob_create_from_file_or_fail (file_name);
615*2d1272b8SAndroid Build Coastguard Worker   return likely (blob) ? blob : hb_blob_get_empty ();
616*2d1272b8SAndroid Build Coastguard Worker }
617*2d1272b8SAndroid Build Coastguard Worker 
618*2d1272b8SAndroid Build Coastguard Worker /**
619*2d1272b8SAndroid Build Coastguard Worker  * hb_blob_create_from_file_or_fail:
620*2d1272b8SAndroid Build Coastguard Worker  * @file_name: A filename
621*2d1272b8SAndroid Build Coastguard Worker  *
622*2d1272b8SAndroid Build Coastguard Worker  * Creates a new blob containing the data from the specified file.
623*2d1272b8SAndroid Build Coastguard Worker  *
624*2d1272b8SAndroid Build Coastguard Worker  * The filename is passed directly to the system on all platforms,
625*2d1272b8SAndroid Build Coastguard Worker  * except on Windows, where the filename is interpreted as UTF-8.
626*2d1272b8SAndroid Build Coastguard Worker  * Only if the filename is not valid UTF-8, it will be interpreted
627*2d1272b8SAndroid Build Coastguard Worker  * according to the system codepage.
628*2d1272b8SAndroid Build Coastguard Worker  *
629*2d1272b8SAndroid Build Coastguard Worker  * Returns: An #hb_blob_t pointer with the content of the file,
630*2d1272b8SAndroid Build Coastguard Worker  * or `NULL` if failed.
631*2d1272b8SAndroid Build Coastguard Worker  *
632*2d1272b8SAndroid Build Coastguard Worker  * Since: 2.8.2
633*2d1272b8SAndroid Build Coastguard Worker  **/
634*2d1272b8SAndroid Build Coastguard Worker hb_blob_t *
hb_blob_create_from_file_or_fail(const char * file_name)635*2d1272b8SAndroid Build Coastguard Worker hb_blob_create_from_file_or_fail (const char *file_name)
636*2d1272b8SAndroid Build Coastguard Worker {
637*2d1272b8SAndroid Build Coastguard Worker   /* Adopted from glib's gmappedfile.c with Matthias Clasen and
638*2d1272b8SAndroid Build Coastguard Worker      Allison Lortie permission but changed a lot to suit our need. */
639*2d1272b8SAndroid Build Coastguard Worker #if defined(HAVE_MMAP) && !defined(HB_NO_MMAP)
640*2d1272b8SAndroid Build Coastguard Worker   hb_mapped_file_t *file = (hb_mapped_file_t *) hb_calloc (1, sizeof (hb_mapped_file_t));
641*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!file)) return nullptr;
642*2d1272b8SAndroid Build Coastguard Worker 
643*2d1272b8SAndroid Build Coastguard Worker   int fd = open (file_name, O_RDONLY | O_BINARY, 0);
644*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (fd == -1)) goto fail_without_close;
645*2d1272b8SAndroid Build Coastguard Worker 
646*2d1272b8SAndroid Build Coastguard Worker   struct stat st;
647*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (fstat (fd, &st) == -1)) goto fail;
648*2d1272b8SAndroid Build Coastguard Worker 
649*2d1272b8SAndroid Build Coastguard Worker   file->length = (unsigned long) st.st_size;
650*2d1272b8SAndroid Build Coastguard Worker 
651*2d1272b8SAndroid Build Coastguard Worker #ifdef _PATH_RSRCFORKSPEC
652*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (file->length == 0))
653*2d1272b8SAndroid Build Coastguard Worker   {
654*2d1272b8SAndroid Build Coastguard Worker     int rfd = _open_resource_fork (file_name, file);
655*2d1272b8SAndroid Build Coastguard Worker     if (rfd != -1)
656*2d1272b8SAndroid Build Coastguard Worker     {
657*2d1272b8SAndroid Build Coastguard Worker       close (fd);
658*2d1272b8SAndroid Build Coastguard Worker       fd = rfd;
659*2d1272b8SAndroid Build Coastguard Worker     }
660*2d1272b8SAndroid Build Coastguard Worker   }
661*2d1272b8SAndroid Build Coastguard Worker #endif
662*2d1272b8SAndroid Build Coastguard Worker 
663*2d1272b8SAndroid Build Coastguard Worker   file->contents = (char *) mmap (nullptr, file->length, PROT_READ,
664*2d1272b8SAndroid Build Coastguard Worker 				  MAP_PRIVATE | MAP_NORESERVE, fd, 0);
665*2d1272b8SAndroid Build Coastguard Worker 
666*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (file->contents == MAP_FAILED)) goto fail;
667*2d1272b8SAndroid Build Coastguard Worker 
668*2d1272b8SAndroid Build Coastguard Worker   close (fd);
669*2d1272b8SAndroid Build Coastguard Worker 
670*2d1272b8SAndroid Build Coastguard Worker   return hb_blob_create_or_fail (file->contents, file->length,
671*2d1272b8SAndroid Build Coastguard Worker 				 HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE, (void *) file,
672*2d1272b8SAndroid Build Coastguard Worker 				 (hb_destroy_func_t) _hb_mapped_file_destroy);
673*2d1272b8SAndroid Build Coastguard Worker 
674*2d1272b8SAndroid Build Coastguard Worker fail:
675*2d1272b8SAndroid Build Coastguard Worker   close (fd);
676*2d1272b8SAndroid Build Coastguard Worker fail_without_close:
677*2d1272b8SAndroid Build Coastguard Worker   hb_free (file);
678*2d1272b8SAndroid Build Coastguard Worker 
679*2d1272b8SAndroid Build Coastguard Worker #elif defined(_WIN32) && !defined(HB_NO_MMAP)
680*2d1272b8SAndroid Build Coastguard Worker   hb_mapped_file_t *file = (hb_mapped_file_t *) hb_calloc (1, sizeof (hb_mapped_file_t));
681*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!file)) return nullptr;
682*2d1272b8SAndroid Build Coastguard Worker 
683*2d1272b8SAndroid Build Coastguard Worker   HANDLE fd;
684*2d1272b8SAndroid Build Coastguard Worker   int conversion;
685*2d1272b8SAndroid Build Coastguard Worker   unsigned int size = strlen (file_name) + 1;
686*2d1272b8SAndroid Build Coastguard Worker   wchar_t * wchar_file_name = (wchar_t *) hb_malloc (sizeof (wchar_t) * size);
687*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!wchar_file_name)) goto fail_without_close;
688*2d1272b8SAndroid Build Coastguard Worker 
689*2d1272b8SAndroid Build Coastguard Worker   /* Assume file name is given in UTF-8 encoding */
690*2d1272b8SAndroid Build Coastguard Worker   conversion = MultiByteToWideChar(CP_UTF8, MB_ERR_INVALID_CHARS, file_name, -1, wchar_file_name, size);
691*2d1272b8SAndroid Build Coastguard Worker   if (conversion <= 0)
692*2d1272b8SAndroid Build Coastguard Worker   {
693*2d1272b8SAndroid Build Coastguard Worker     /* Conversion failed due to invalid UTF-8 characters,
694*2d1272b8SAndroid Build Coastguard Worker        Repeat conversion based on system code page */
695*2d1272b8SAndroid Build Coastguard Worker     mbstowcs(wchar_file_name, file_name, size);
696*2d1272b8SAndroid Build Coastguard Worker   }
697*2d1272b8SAndroid Build Coastguard Worker #if !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP)
698*2d1272b8SAndroid Build Coastguard Worker   {
699*2d1272b8SAndroid Build Coastguard Worker     CREATEFILE2_EXTENDED_PARAMETERS ceparams = { 0 };
700*2d1272b8SAndroid Build Coastguard Worker     ceparams.dwSize = sizeof(CREATEFILE2_EXTENDED_PARAMETERS);
701*2d1272b8SAndroid Build Coastguard Worker     ceparams.dwFileAttributes = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED & 0xFFFF;
702*2d1272b8SAndroid Build Coastguard Worker     ceparams.dwFileFlags = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED & 0xFFF00000;
703*2d1272b8SAndroid Build Coastguard Worker     ceparams.dwSecurityQosFlags = FILE_ATTRIBUTE_NORMAL | FILE_FLAG_OVERLAPPED & 0x000F0000;
704*2d1272b8SAndroid Build Coastguard Worker     ceparams.lpSecurityAttributes = nullptr;
705*2d1272b8SAndroid Build Coastguard Worker     ceparams.hTemplateFile = nullptr;
706*2d1272b8SAndroid Build Coastguard Worker     fd = CreateFile2 (wchar_file_name, GENERIC_READ, FILE_SHARE_READ,
707*2d1272b8SAndroid Build Coastguard Worker 		      OPEN_EXISTING, &ceparams);
708*2d1272b8SAndroid Build Coastguard Worker   }
709*2d1272b8SAndroid Build Coastguard Worker #else
710*2d1272b8SAndroid Build Coastguard Worker   fd = CreateFileW (wchar_file_name, GENERIC_READ, FILE_SHARE_READ, nullptr,
711*2d1272b8SAndroid Build Coastguard Worker 		    OPEN_EXISTING, FILE_ATTRIBUTE_NORMAL|FILE_FLAG_OVERLAPPED,
712*2d1272b8SAndroid Build Coastguard Worker 		    nullptr);
713*2d1272b8SAndroid Build Coastguard Worker #endif
714*2d1272b8SAndroid Build Coastguard Worker   hb_free (wchar_file_name);
715*2d1272b8SAndroid Build Coastguard Worker 
716*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (fd == INVALID_HANDLE_VALUE)) goto fail_without_close;
717*2d1272b8SAndroid Build Coastguard Worker 
718*2d1272b8SAndroid Build Coastguard Worker #if !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP)
719*2d1272b8SAndroid Build Coastguard Worker   {
720*2d1272b8SAndroid Build Coastguard Worker     LARGE_INTEGER length;
721*2d1272b8SAndroid Build Coastguard Worker     GetFileSizeEx (fd, &length);
722*2d1272b8SAndroid Build Coastguard Worker     file->length = length.LowPart;
723*2d1272b8SAndroid Build Coastguard Worker     file->mapping = CreateFileMappingFromApp (fd, nullptr, PAGE_READONLY, length.QuadPart, nullptr);
724*2d1272b8SAndroid Build Coastguard Worker   }
725*2d1272b8SAndroid Build Coastguard Worker #else
726*2d1272b8SAndroid Build Coastguard Worker   file->length = (unsigned long) GetFileSize (fd, nullptr);
727*2d1272b8SAndroid Build Coastguard Worker   file->mapping = CreateFileMapping (fd, nullptr, PAGE_READONLY, 0, 0, nullptr);
728*2d1272b8SAndroid Build Coastguard Worker #endif
729*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!file->mapping)) goto fail;
730*2d1272b8SAndroid Build Coastguard Worker 
731*2d1272b8SAndroid Build Coastguard Worker #if !WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_DESKTOP) && WINAPI_FAMILY_PARTITION(WINAPI_PARTITION_APP)
732*2d1272b8SAndroid Build Coastguard Worker   file->contents = (char *) MapViewOfFileFromApp (file->mapping, FILE_MAP_READ, 0, 0);
733*2d1272b8SAndroid Build Coastguard Worker #else
734*2d1272b8SAndroid Build Coastguard Worker   file->contents = (char *) MapViewOfFile (file->mapping, FILE_MAP_READ, 0, 0, 0);
735*2d1272b8SAndroid Build Coastguard Worker #endif
736*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!file->contents)) goto fail;
737*2d1272b8SAndroid Build Coastguard Worker 
738*2d1272b8SAndroid Build Coastguard Worker   CloseHandle (fd);
739*2d1272b8SAndroid Build Coastguard Worker   return hb_blob_create_or_fail (file->contents, file->length,
740*2d1272b8SAndroid Build Coastguard Worker 				 HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE, (void *) file,
741*2d1272b8SAndroid Build Coastguard Worker 				 (hb_destroy_func_t) _hb_mapped_file_destroy);
742*2d1272b8SAndroid Build Coastguard Worker 
743*2d1272b8SAndroid Build Coastguard Worker fail:
744*2d1272b8SAndroid Build Coastguard Worker   CloseHandle (fd);
745*2d1272b8SAndroid Build Coastguard Worker fail_without_close:
746*2d1272b8SAndroid Build Coastguard Worker   hb_free (file);
747*2d1272b8SAndroid Build Coastguard Worker 
748*2d1272b8SAndroid Build Coastguard Worker #endif
749*2d1272b8SAndroid Build Coastguard Worker 
750*2d1272b8SAndroid Build Coastguard Worker   /* The following tries to read a file without knowing its size beforehand
751*2d1272b8SAndroid Build Coastguard Worker      It's used as a fallback for systems without mmap or to read from pipes */
752*2d1272b8SAndroid Build Coastguard Worker   unsigned long len = 0, allocated = BUFSIZ * 16;
753*2d1272b8SAndroid Build Coastguard Worker   char *data = (char *) hb_malloc (allocated);
754*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!data)) return nullptr;
755*2d1272b8SAndroid Build Coastguard Worker 
756*2d1272b8SAndroid Build Coastguard Worker   FILE *fp = fopen (file_name, "rb");
757*2d1272b8SAndroid Build Coastguard Worker   if (unlikely (!fp)) goto fread_fail_without_close;
758*2d1272b8SAndroid Build Coastguard Worker 
759*2d1272b8SAndroid Build Coastguard Worker   while (!feof (fp))
760*2d1272b8SAndroid Build Coastguard Worker   {
761*2d1272b8SAndroid Build Coastguard Worker     if (allocated - len < BUFSIZ)
762*2d1272b8SAndroid Build Coastguard Worker     {
763*2d1272b8SAndroid Build Coastguard Worker       allocated *= 2;
764*2d1272b8SAndroid Build Coastguard Worker       /* Don't allocate and go more than ~536MB, our mmap reader still
765*2d1272b8SAndroid Build Coastguard Worker 	 can cover files like that but lets limit our fallback reader */
766*2d1272b8SAndroid Build Coastguard Worker       if (unlikely (allocated > (2 << 28))) goto fread_fail;
767*2d1272b8SAndroid Build Coastguard Worker       char *new_data = (char *) hb_realloc (data, allocated);
768*2d1272b8SAndroid Build Coastguard Worker       if (unlikely (!new_data)) goto fread_fail;
769*2d1272b8SAndroid Build Coastguard Worker       data = new_data;
770*2d1272b8SAndroid Build Coastguard Worker     }
771*2d1272b8SAndroid Build Coastguard Worker 
772*2d1272b8SAndroid Build Coastguard Worker     unsigned long addition = fread (data + len, 1, allocated - len, fp);
773*2d1272b8SAndroid Build Coastguard Worker 
774*2d1272b8SAndroid Build Coastguard Worker     int err = ferror (fp);
775*2d1272b8SAndroid Build Coastguard Worker #ifdef EINTR // armcc doesn't have it
776*2d1272b8SAndroid Build Coastguard Worker     if (unlikely (err == EINTR)) continue;
777*2d1272b8SAndroid Build Coastguard Worker #endif
778*2d1272b8SAndroid Build Coastguard Worker     if (unlikely (err)) goto fread_fail;
779*2d1272b8SAndroid Build Coastguard Worker 
780*2d1272b8SAndroid Build Coastguard Worker     len += addition;
781*2d1272b8SAndroid Build Coastguard Worker   }
782*2d1272b8SAndroid Build Coastguard Worker 	fclose (fp);
783*2d1272b8SAndroid Build Coastguard Worker 
784*2d1272b8SAndroid Build Coastguard Worker   return hb_blob_create_or_fail (data, len, HB_MEMORY_MODE_WRITABLE, data,
785*2d1272b8SAndroid Build Coastguard Worker 				 (hb_destroy_func_t) hb_free);
786*2d1272b8SAndroid Build Coastguard Worker 
787*2d1272b8SAndroid Build Coastguard Worker fread_fail:
788*2d1272b8SAndroid Build Coastguard Worker   fclose (fp);
789*2d1272b8SAndroid Build Coastguard Worker fread_fail_without_close:
790*2d1272b8SAndroid Build Coastguard Worker   hb_free (data);
791*2d1272b8SAndroid Build Coastguard Worker   return nullptr;
792*2d1272b8SAndroid Build Coastguard Worker }
793*2d1272b8SAndroid Build Coastguard Worker #endif /* !HB_NO_OPEN */
794