OLD | NEW |
1 /* | 1 /* |
2 * Copyright © 2009 Red Hat, Inc. | 2 * Copyright © 2009 Red Hat, Inc. |
3 * | 3 * |
4 * This is part of HarfBuzz, a text shaping library. | 4 * This is part of HarfBuzz, a text shaping library. |
5 * | 5 * |
6 * Permission is hereby granted, without written agreement and without | 6 * Permission is hereby granted, without written agreement and without |
7 * license or royalty fees, to use, copy, modify, and distribute this | 7 * license or royalty fees, to use, copy, modify, and distribute this |
8 * software and its documentation for any purpose, provided that the | 8 * software and its documentation for any purpose, provided that the |
9 * above copyright notice and the following two paragraphs appear in | 9 * above copyright notice and the following two paragraphs appear in |
10 * all copies of this software. | 10 * all copies of this software. |
(...skipping 18 matching lines...) Expand all Loading... |
29 #endif | 29 #endif |
30 | 30 |
31 #ifndef HB_BLOB_H | 31 #ifndef HB_BLOB_H |
32 #define HB_BLOB_H | 32 #define HB_BLOB_H |
33 | 33 |
34 #include "hb-common.h" | 34 #include "hb-common.h" |
35 | 35 |
36 HB_BEGIN_DECLS | 36 HB_BEGIN_DECLS |
37 | 37 |
38 | 38 |
| 39 /* |
| 40 * Note re various memory-modes: |
| 41 * |
| 42 * - In no case shall the HarfBuzz client modify memory |
| 43 * that is passed to HarfBuzz in a blob. If there is |
| 44 * any such possibility, MODE_DUPLICATE should be used |
| 45 * such that HarfBuzz makes a copy immediately, |
| 46 * |
| 47 * - Use MODE_READONLY otherse, unless you really really |
| 48 * really know what you are doing, |
| 49 * |
| 50 * - MODE_WRITABLE is appropriate if you relaly made a |
| 51 * copy of data solely for the purpose of passing to |
| 52 * HarfBuzz and doing that just once (no reuse!), |
| 53 * |
| 54 * - If the font is mmap()ed, it's ok to use |
| 55 * READONLY_MAY_MAKE_WRITABLE, however, there were |
| 56 * design problems with that mode, so HarfBuzz do not |
| 57 * really use it anymore. If not sure, use MODE_READONLY. |
| 58 */ |
39 typedef enum { | 59 typedef enum { |
40 HB_MEMORY_MODE_DUPLICATE, | 60 HB_MEMORY_MODE_DUPLICATE, |
41 HB_MEMORY_MODE_READONLY, | 61 HB_MEMORY_MODE_READONLY, |
42 HB_MEMORY_MODE_WRITABLE, | 62 HB_MEMORY_MODE_WRITABLE, |
43 HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE | 63 HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE |
44 } hb_memory_mode_t; | 64 } hb_memory_mode_t; |
45 | 65 |
46 typedef struct hb_blob_t hb_blob_t; | 66 typedef struct hb_blob_t hb_blob_t; |
47 | 67 |
48 hb_blob_t * | 68 hb_blob_t * |
49 hb_blob_create (const char *data, | 69 hb_blob_create (const char *data, |
50 unsigned int length, | 70 unsigned int length, |
51 hb_memory_mode_t mode, | 71 hb_memory_mode_t mode, |
52 void *user_data, | 72 void *user_data, |
53 hb_destroy_func_t destroy); | 73 hb_destroy_func_t destroy); |
54 | 74 |
| 75 /* Always creates with MEMORY_MODE_READONLY. |
| 76 * Even if the parent blob is writable, we don't |
| 77 * want the user of the sub-blob to be able to |
| 78 * modify the parent data as that data may be |
| 79 * shared among multiple sub-blobs. |
| 80 */ |
55 hb_blob_t * | 81 hb_blob_t * |
56 hb_blob_create_sub_blob (hb_blob_t *parent, | 82 hb_blob_create_sub_blob (hb_blob_t *parent, |
57 unsigned int offset, | 83 unsigned int offset, |
58 unsigned int length); | 84 unsigned int length); |
59 | 85 |
60 hb_blob_t * | 86 hb_blob_t * |
61 hb_blob_get_empty (void); | 87 hb_blob_get_empty (void); |
62 | 88 |
63 hb_blob_t * | 89 hb_blob_t * |
64 hb_blob_reference (hb_blob_t *blob); | 90 hb_blob_reference (hb_blob_t *blob); |
(...skipping 27 matching lines...) Expand all Loading... |
92 const char * | 118 const char * |
93 hb_blob_get_data (hb_blob_t *blob, unsigned int *length); | 119 hb_blob_get_data (hb_blob_t *blob, unsigned int *length); |
94 | 120 |
95 char * | 121 char * |
96 hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length); | 122 hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length); |
97 | 123 |
98 | 124 |
99 HB_END_DECLS | 125 HB_END_DECLS |
100 | 126 |
101 #endif /* HB_BLOB_H */ | 127 #endif /* HB_BLOB_H */ |
OLD | NEW |