src/hb-blob.h

   1 /*
   2  * Copyright © 2009  Red Hat, Inc.
   3  *
   4  *  This is part of HarfBuzz, a text shaping library.
   5  *
   6  * Permission is hereby granted, without written agreement and without
   7  * license or royalty fees, to use, copy, modify, and distribute this
   8  * software and its documentation for any purpose, provided that the
   9  * above copyright notice and the following two paragraphs appear in
  10  * all copies of this software.
  11  *
  12  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
  13  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
  14  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
  15  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
  16  * DAMAGE.
  17  *
  18  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
  19  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
  20  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
  21  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
  22  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
  23  *
  24  * Red Hat Author(s): Behdad Esfahbod
  25  */
  26
  27 #ifndef HB_BLOB_H
  28 #define HB_BLOB_H
  29
  30 #include "hb-common.h"
  31
  32 HB_BEGIN_DECLS
  33
  34
  35 typedef enum {
  36   HB_MEMORY_MODE_DUPLICATE,
  37   HB_MEMORY_MODE_READONLY,
  38   HB_MEMORY_MODE_WRITABLE,
  39   HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE
  40 } hb_memory_mode_t;
  41
  42 typedef struct _hb_blob_t hb_blob_t;
  43
  44 hb_blob_t *
  45 hb_blob_create (const char        *data,
  46                 unsigned int       length,
  47                 hb_memory_mode_t   mode,
  48                 void              *user_data,
  49                 hb_destroy_func_t  destroy);
  50
  51 hb_blob_t *
  52 hb_blob_create_sub_blob (hb_blob_t    *parent,
  53                          unsigned int  offset,
  54                          unsigned int  length);
  55
  56 hb_blob_t *
  57 hb_blob_get_empty (void);
  58
  59 hb_blob_t *
  60 hb_blob_reference (hb_blob_t *blob);
  61
  62 void
  63 hb_blob_destroy (hb_blob_t *blob);
  64
  65 hb_bool_t
  66 hb_blob_set_user_data (hb_blob_t          *blob,
  67                        hb_user_data_key_t *key,
  68                        void *              data,
  69                        hb_destroy_func_t   destroy);
  70
  71
  72 void *
  73 hb_blob_get_user_data (hb_blob_t          *blob,
  74                        hb_user_data_key_t *key);
  75
  76
  77 void
  78 hb_blob_make_immutable (hb_blob_t *blob);
  79
  80 hb_bool_t
  81 hb_blob_is_immutable (hb_blob_t *blob);
  82
  83
  84 unsigned int
  85 hb_blob_get_length (hb_blob_t *blob);
  86
  87 const char *
  88 hb_blob_get_data (hb_blob_t *blob, unsigned int *length);
  89
  90 char *
  91 hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length);
  92
  93
  94 HB_END_DECLS
  95
  96 #endif /* HB_BLOB_H */