Mercurial > repos > rliterman > csp2

annotate CSP2/CSP2_env/env-d9b9114564458d9d-741b3de822f2aaca6c6caa4325c4afce/include/harfbuzz/hb-blob.h @ 69:33d812a61356

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