michael@0: /*
michael@0:  * Copyright © 2009  Red Hat, Inc.
michael@0:  *
michael@0:  *  This is part of HarfBuzz, a text shaping library.
michael@0:  *
michael@0:  * Permission is hereby granted, without written agreement and without
michael@0:  * license or royalty fees, to use, copy, modify, and distribute this
michael@0:  * software and its documentation for any purpose, provided that the
michael@0:  * above copyright notice and the following two paragraphs appear in
michael@0:  * all copies of this software.
michael@0:  *
michael@0:  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
michael@0:  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
michael@0:  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
michael@0:  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
michael@0:  * DAMAGE.
michael@0:  *
michael@0:  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
michael@0:  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
michael@0:  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
michael@0:  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
michael@0:  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
michael@0:  *
michael@0:  * Red Hat Author(s): Behdad Esfahbod
michael@0:  */
michael@0: 
michael@0: #ifndef HB_H_IN
michael@0: #error "Include <hb.h> instead."
michael@0: #endif
michael@0: 
michael@0: #ifndef HB_BLOB_H
michael@0: #define HB_BLOB_H
michael@0: 
michael@0: #include "hb-common.h"
michael@0: 
michael@0: HB_BEGIN_DECLS
michael@0: 
michael@0: 
michael@0: /*
michael@0:  * Note re various memory-modes:
michael@0:  *
michael@0:  * - In no case shall the HarfBuzz client modify memory
michael@0:  *   that is passed to HarfBuzz in a blob.  If there is
michael@0:  *   any such possibility, MODE_DUPLICATE should be used
michael@0:  *   such that HarfBuzz makes a copy immediately,
michael@0:  *
michael@0:  * - Use MODE_READONLY otherse, unless you really really
michael@0:  *   really know what you are doing,
michael@0:  *
michael@0:  * - MODE_WRITABLE is appropriate if you relaly made a
michael@0:  *   copy of data solely for the purpose of passing to
michael@0:  *   HarfBuzz and doing that just once (no reuse!),
michael@0:  *
michael@0:  * - If the font is mmap()ed, it's ok to use
michael@0:  *   READONLY_MAY_MAKE_WRITABLE, however, there were
michael@0:  *   design problems with that mode, so HarfBuzz do not
michael@0:  *   really use it anymore.  If not sure, use MODE_READONLY.
michael@0:  */
michael@0: typedef enum {
michael@0:   HB_MEMORY_MODE_DUPLICATE,
michael@0:   HB_MEMORY_MODE_READONLY,
michael@0:   HB_MEMORY_MODE_WRITABLE,
michael@0:   HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE
michael@0: } hb_memory_mode_t;
michael@0: 
michael@0: typedef struct hb_blob_t hb_blob_t;
michael@0: 
michael@0: hb_blob_t *
michael@0: hb_blob_create (const char        *data,
michael@0: 		unsigned int       length,
michael@0: 		hb_memory_mode_t   mode,
michael@0: 		void              *user_data,
michael@0: 		hb_destroy_func_t  destroy);
michael@0: 
michael@0: /* Always creates with MEMORY_MODE_READONLY.
michael@0:  * Even if the parent blob is writable, we don't
michael@0:  * want the user of the sub-blob to be able to
michael@0:  * modify the parent data as that data may be
michael@0:  * shared among multiple sub-blobs.
michael@0:  */
michael@0: hb_blob_t *
michael@0: hb_blob_create_sub_blob (hb_blob_t    *parent,
michael@0: 			 unsigned int  offset,
michael@0: 			 unsigned int  length);
michael@0: 
michael@0: hb_blob_t *
michael@0: hb_blob_get_empty (void);
michael@0: 
michael@0: hb_blob_t *
michael@0: hb_blob_reference (hb_blob_t *blob);
michael@0: 
michael@0: void
michael@0: hb_blob_destroy (hb_blob_t *blob);
michael@0: 
michael@0: hb_bool_t
michael@0: hb_blob_set_user_data (hb_blob_t          *blob,
michael@0: 		       hb_user_data_key_t *key,
michael@0: 		       void *              data,
michael@0: 		       hb_destroy_func_t   destroy,
michael@0: 		       hb_bool_t           replace);
michael@0: 
michael@0: 
michael@0: void *
michael@0: hb_blob_get_user_data (hb_blob_t          *blob,
michael@0: 		       hb_user_data_key_t *key);
michael@0: 
michael@0: 
michael@0: void
michael@0: hb_blob_make_immutable (hb_blob_t *blob);
michael@0: 
michael@0: hb_bool_t
michael@0: hb_blob_is_immutable (hb_blob_t *blob);
michael@0: 
michael@0: 
michael@0: unsigned int
michael@0: hb_blob_get_length (hb_blob_t *blob);
michael@0: 
michael@0: const char *
michael@0: hb_blob_get_data (hb_blob_t *blob, unsigned int *length);
michael@0: 
michael@0: char *
michael@0: hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length);
michael@0: 
michael@0: 
michael@0: HB_END_DECLS
michael@0: 
michael@0: #endif /* HB_BLOB_H */