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