15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)/* 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Copyright © 2009 Red Hat, Inc. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * This is part of HarfBuzz, a text shaping library. 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Permission is hereby granted, without written agreement and without 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * license or royalty fees, to use, copy, modify, and distribute this 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * software and its documentation for any purpose, provided that the 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * above copyright notice and the following two paragraphs appear in 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * all copies of this software. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * DAMAGE. 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) * Red Hat Author(s): Behdad Esfahbod 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) */ 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef HB_H_IN 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#error "Include <hb.h> instead." 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef HB_BLOB_H 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define HB_BLOB_H 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "hb-common.h" 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)HB_BEGIN_DECLS 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 39c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* 40c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Note re various memory-modes: 41c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 42c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * - In no case shall the HarfBuzz client modify memory 43c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * that is passed to HarfBuzz in a blob. If there is 44c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * any such possibility, MODE_DUPLICATE should be used 45c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * such that HarfBuzz makes a copy immediately, 46c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 47c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * - Use MODE_READONLY otherse, unless you really really 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * really know what you are doing, 49c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 50c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * - MODE_WRITABLE is appropriate if you relaly made a 51c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * copy of data solely for the purpose of passing to 52c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * HarfBuzz and doing that just once (no reuse!), 53c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * 54c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * - If the font is mmap()ed, it's ok to use 55c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * READONLY_MAY_MAKE_WRITABLE, however, there were 56c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * design problems with that mode, so HarfBuzz do not 57c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * really use it anymore. If not sure, use MODE_READONLY. 58c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef enum { 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HB_MEMORY_MODE_DUPLICATE, 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HB_MEMORY_MODE_READONLY, 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HB_MEMORY_MODE_WRITABLE, 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} hb_memory_mode_t; 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)typedef struct hb_blob_t hb_blob_t; 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_t * 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_create (const char *data, 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int length, 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) hb_memory_mode_t mode, 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void *user_data, 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) hb_destroy_func_t destroy); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 75c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles)/* Always creates with MEMORY_MODE_READONLY. 76c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * Even if the parent blob is writable, we don't 77c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * want the user of the sub-blob to be able to 78c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * modify the parent data as that data may be 79c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) * shared among multiple sub-blobs. 80c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) */ 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_t * 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_create_sub_blob (hb_blob_t *parent, 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int offset, 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) unsigned int length); 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_t * 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_get_empty (void); 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_t * 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_reference (hb_blob_t *blob); 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_destroy (hb_blob_t *blob); 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_bool_t 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_set_user_data (hb_blob_t *blob, 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) hb_user_data_key_t *key, 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void * data, 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) hb_destroy_func_t destroy, 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) hb_bool_t replace); 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void * 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_get_user_data (hb_blob_t *blob, 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) hb_user_data_key_t *key); 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)void 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_make_immutable (hb_blob_t *blob); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_bool_t 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_is_immutable (hb_blob_t *blob); 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)unsigned int 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_get_length (hb_blob_t *blob); 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)const char * 1195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_get_data (hb_blob_t *blob, unsigned int *length); 1205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)char * 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length); 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)HB_END_DECLS 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif /* HB_BLOB_H */ 128