gfx/harfbuzz/src/hb-blob.h@925c144e1f1f (annotated)
gfx/harfbuzz/src/hb-blob.h
Fri, 16 Jan 2015 18:13:44 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Fri, 16 Jan 2015 18:13:44 +0100
- branch
- TOR_BUG_9701
- changeset 14
- 925c144e1f1f
- permissions
- -rw-r--r--
Integrate suggestion from review to improve consistency with existing code.
| michael@0 | 1 | /* |
| michael@0 | 2 | * Copyright © 2009 Red Hat, Inc. |
| michael@0 | 3 | * |
| michael@0 | 4 | * This is part of HarfBuzz, a text shaping library. |
| michael@0 | 5 | * |
| michael@0 | 6 | * Permission is hereby granted, without written agreement and without |
| michael@0 | 7 | * license or royalty fees, to use, copy, modify, and distribute this |
| michael@0 | 8 | * software and its documentation for any purpose, provided that the |
| michael@0 | 9 | * above copyright notice and the following two paragraphs appear in |
| michael@0 | 10 | * all copies of this software. |
| michael@0 | 11 | * |
| michael@0 | 12 | * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR |
| michael@0 | 13 | * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES |
| michael@0 | 14 | * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN |
| michael@0 | 15 | * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH |
| michael@0 | 16 | * DAMAGE. |
| michael@0 | 17 | * |
| michael@0 | 18 | * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING, |
| michael@0 | 19 | * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND |
| michael@0 | 20 | * FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS |
| michael@0 | 21 | * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO |
| michael@0 | 22 | * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS. |
| michael@0 | 23 | * |
| michael@0 | 24 | * Red Hat Author(s): Behdad Esfahbod |
| michael@0 | 25 | */ |
| michael@0 | 26 | |
| michael@0 | 27 | #ifndef HB_H_IN |
| michael@0 | 28 | #error "Include <hb.h> instead." |
| michael@0 | 29 | #endif |
| michael@0 | 30 | |
| michael@0 | 31 | #ifndef HB_BLOB_H |
| michael@0 | 32 | #define HB_BLOB_H |
| michael@0 | 33 | |
| michael@0 | 34 | #include "hb-common.h" |
| michael@0 | 35 | |
| michael@0 | 36 | HB_BEGIN_DECLS |
| michael@0 | 37 | |
| michael@0 | 38 | |
| michael@0 | 39 | /* |
| michael@0 | 40 | * Note re various memory-modes: |
| michael@0 | 41 | * |
| michael@0 | 42 | * - In no case shall the HarfBuzz client modify memory |
| michael@0 | 43 | * that is passed to HarfBuzz in a blob. If there is |
| michael@0 | 44 | * any such possibility, MODE_DUPLICATE should be used |
| michael@0 | 45 | * such that HarfBuzz makes a copy immediately, |
| michael@0 | 46 | * |
| michael@0 | 47 | * - Use MODE_READONLY otherse, unless you really really |
| michael@0 | 48 | * really know what you are doing, |
| michael@0 | 49 | * |
| michael@0 | 50 | * - MODE_WRITABLE is appropriate if you relaly made a |
| michael@0 | 51 | * copy of data solely for the purpose of passing to |
| michael@0 | 52 | * HarfBuzz and doing that just once (no reuse!), |
| michael@0 | 53 | * |
| michael@0 | 54 | * - If the font is mmap()ed, it's ok to use |
| michael@0 | 55 | * READONLY_MAY_MAKE_WRITABLE, however, there were |
| michael@0 | 56 | * design problems with that mode, so HarfBuzz do not |
| michael@0 | 57 | * really use it anymore. If not sure, use MODE_READONLY. |
| michael@0 | 58 | */ |
| michael@0 | 59 | typedef enum { |
| michael@0 | 60 | HB_MEMORY_MODE_DUPLICATE, |
| michael@0 | 61 | HB_MEMORY_MODE_READONLY, |
| michael@0 | 62 | HB_MEMORY_MODE_WRITABLE, |
| michael@0 | 63 | HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE |
| michael@0 | 64 | } hb_memory_mode_t; |
| michael@0 | 65 | |
| michael@0 | 66 | typedef struct hb_blob_t hb_blob_t; |
| michael@0 | 67 | |
| michael@0 | 68 | hb_blob_t * |
| michael@0 | 69 | hb_blob_create (const char *data, |
| michael@0 | 70 | unsigned int length, |
| michael@0 | 71 | hb_memory_mode_t mode, |
| michael@0 | 72 | void *user_data, |
| michael@0 | 73 | hb_destroy_func_t destroy); |
| michael@0 | 74 | |
| michael@0 | 75 | /* Always creates with MEMORY_MODE_READONLY. |
| michael@0 | 76 | * Even if the parent blob is writable, we don't |
| michael@0 | 77 | * want the user of the sub-blob to be able to |
| michael@0 | 78 | * modify the parent data as that data may be |
| michael@0 | 79 | * shared among multiple sub-blobs. |
| michael@0 | 80 | */ |
| michael@0 | 81 | hb_blob_t * |
| michael@0 | 82 | hb_blob_create_sub_blob (hb_blob_t *parent, |
| michael@0 | 83 | unsigned int offset, |
| michael@0 | 84 | unsigned int length); |
| michael@0 | 85 | |
| michael@0 | 86 | hb_blob_t * |
| michael@0 | 87 | hb_blob_get_empty (void); |
| michael@0 | 88 | |
| michael@0 | 89 | hb_blob_t * |
| michael@0 | 90 | hb_blob_reference (hb_blob_t *blob); |
| michael@0 | 91 | |
| michael@0 | 92 | void |
| michael@0 | 93 | hb_blob_destroy (hb_blob_t *blob); |
| michael@0 | 94 | |
| michael@0 | 95 | hb_bool_t |
| michael@0 | 96 | hb_blob_set_user_data (hb_blob_t *blob, |
| michael@0 | 97 | hb_user_data_key_t *key, |
| michael@0 | 98 | void * data, |
| michael@0 | 99 | hb_destroy_func_t destroy, |
| michael@0 | 100 | hb_bool_t replace); |
| michael@0 | 101 | |
| michael@0 | 102 | |
| michael@0 | 103 | void * |
| michael@0 | 104 | hb_blob_get_user_data (hb_blob_t *blob, |
| michael@0 | 105 | hb_user_data_key_t *key); |
| michael@0 | 106 | |
| michael@0 | 107 | |
| michael@0 | 108 | void |
| michael@0 | 109 | hb_blob_make_immutable (hb_blob_t *blob); |
| michael@0 | 110 | |
| michael@0 | 111 | hb_bool_t |
| michael@0 | 112 | hb_blob_is_immutable (hb_blob_t *blob); |
| michael@0 | 113 | |
| michael@0 | 114 | |
| michael@0 | 115 | unsigned int |
| michael@0 | 116 | hb_blob_get_length (hb_blob_t *blob); |
| michael@0 | 117 | |
| michael@0 | 118 | const char * |
| michael@0 | 119 | hb_blob_get_data (hb_blob_t *blob, unsigned int *length); |
| michael@0 | 120 | |
| michael@0 | 121 | char * |
| michael@0 | 122 | hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length); |
| michael@0 | 123 | |
| michael@0 | 124 | |
| michael@0 | 125 | HB_END_DECLS |
| michael@0 | 126 | |
| michael@0 | 127 | #endif /* HB_BLOB_H */ |
