Gecko [ naturenectar.co.uk ]

Name	Size	Permission	Date
hb-aat-layout.h	51.54 KB	-rw-r--r--	2020-12-27 00:01
hb-aat.h	1.21 KB	-rw-r--r--	2020-12-27 00:01
hb-blob.h	4.05 KB	-rw-r--r--	2020-12-27 00:01
hb-buffer.h	20.52 KB	-rw-r--r--	2020-12-27 00:01
hb-common.h	24.47 KB	-rw-r--r--	2020-12-27 00:01
hb-deprecated.h	5.95 KB	-rw-r--r--	2020-12-27 00:01
hb-draw.h	3.12 KB	-rw-r--r--	2020-12-27 00:01
hb-face.h	3.78 KB	-rw-r--r--	2020-12-27 00:01
hb-font.h	28.7 KB	-rw-r--r--	2020-12-27 00:01
hb-ft.h	4.05 KB	-rw-r--r--	2020-12-27 00:01
hb-glib.h	1.59 KB	-rw-r--r--	2020-12-27 00:01
hb-gobject-enums.h	5.1 KB	-rw-r--r--	2024-04-02 17:01
hb-gobject-structs.h	3.68 KB	-rw-r--r--	2020-12-27 00:01
hb-gobject.h	1.3 KB	-rw-r--r--	2020-12-27 00:01
hb-graphite2.h	1.68 KB	-rw-r--r--	2020-12-27 00:01
hb-icu.h	1.49 KB	-rw-r--r--	2020-12-27 00:01
hb-map.h	2.56 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-color.h	3.86 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-deprecated.h	3.19 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-font.h	1.33 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-layout.h	15.82 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-math.h	7.69 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-meta.h	2.43 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-metrics.h	5.6 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-name.h	3.68 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-shape.h	1.67 KB	-rw-r--r--	2020-12-27 00:01
hb-ot-var.h	5.02 KB	-rw-r--r--	2020-12-27 00:01
hb-ot.h	1.47 KB	-rw-r--r--	2020-12-27 00:01
hb-set.h	4.26 KB	-rw-r--r--	2020-12-27 00:01
hb-shape-plan.h	3.97 KB	-rw-r--r--	2020-12-27 00:01
hb-shape.h	1.79 KB	-rw-r--r--	2020-12-27 00:01
hb-style.h	1.32 KB	-rw-r--r--	2020-12-27 00:01
hb-subset.h	2.87 KB	-rw-r--r--	2020-12-27 00:01
hb-unicode.h	23.05 KB	-rw-r--r--	2020-12-27 00:01
hb-version.h	1.79 KB	-rw-r--r--	2020-12-27 00:01
hb.h	1.5 KB	-rw-r--r--	2020-12-27 00:01

Rename

/*
 * Copyright © 2009  Red Hat, Inc.
 *
 *  This is part of HarfBuzz, a text shaping library.
 *
 * Permission is hereby granted, without written agreement and without
 * license or royalty fees, to use, copy, modify, and distribute this
 * software and its documentation for any purpose, provided that the
 * above copyright notice and the following two paragraphs appear in
 * all copies of this software.
 *
 * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
 * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
 * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 *
 * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
 * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
 * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
 * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
 *
 * Red Hat Author(s): Behdad Esfahbod
 */

#ifndef HB_H_IN
#error "Include <hb.h> instead."
#endif

#ifndef HB_BLOB_H
#define HB_BLOB_H

#include "hb-common.h"

HB_BEGIN_DECLS

/**
 * hb_memory_mode_t:
 * @HB_MEMORY_MODE_DUPLICATE
 * @HB_MEMORY_MODE_READONLY
 * @HB_MEMORY_MODE_WRITABLE
 * @HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE
 *
 * Data type holding the memory modes available to
 * client programs.
 *
 * Regarding these various memory-modes:
 *
 * - In no case shall the HarfBuzz client modify memory
 *   that is passed to HarfBuzz in a blob.  If there is
 *   any such possibility, @HB_MEMORY_MODE_DUPLICATE should be used
 *   such that HarfBuzz makes a copy immediately,
 *
 * - Use @HB_MEMORY_MODE_READONLY otherwise, unless you really really
 *   really know what you are doing,
 *
 * - @HB_MEMORY_MODE_WRITABLE is appropriate if you really made a
 *   copy of data solely for the purpose of passing to
 *   HarfBuzz and doing that just once (no reuse!),
 *
 * - If the font is mmap()ed, it's okay to use
 *   @HB_MEMORY_READONLY_MAY_MAKE_WRITABLE, however, using that mode
 *   correctly is very tricky.  Use @HB_MEMORY_MODE_READONLY instead.
 **/
typedef enum {
  HB_MEMORY_MODE_DUPLICATE,
  HB_MEMORY_MODE_READONLY,
  HB_MEMORY_MODE_WRITABLE,
  HB_MEMORY_MODE_READONLY_MAY_MAKE_WRITABLE
} hb_memory_mode_t;

/**
 * hb_blob_t:
 *
 * Data type for blobs. A blob wraps a chunk of binary
 * data and facilitates its lifecycle management between
 * a client program and HarfBuzz.
 *
 **/
typedef struct hb_blob_t hb_blob_t;

HB_EXTERN hb_blob_t *
hb_blob_create (const char        *data,
		unsigned int       length,
		hb_memory_mode_t   mode,
		void              *user_data,
		hb_destroy_func_t  destroy);

HB_EXTERN hb_blob_t *
hb_blob_create_from_file (const char *file_name);

/* Always creates with MEMORY_MODE_READONLY.
 * Even if the parent blob is writable, we don't
 * want the user of the sub-blob to be able to
 * modify the parent data as that data may be
 * shared among multiple sub-blobs.
 */
HB_EXTERN hb_blob_t *
hb_blob_create_sub_blob (hb_blob_t    *parent,
			 unsigned int  offset,
			 unsigned int  length);

HB_EXTERN hb_blob_t *
hb_blob_copy_writable_or_fail (hb_blob_t *blob);

HB_EXTERN hb_blob_t *
hb_blob_get_empty (void);

HB_EXTERN hb_blob_t *
hb_blob_reference (hb_blob_t *blob);

HB_EXTERN void
hb_blob_destroy (hb_blob_t *blob);

HB_EXTERN hb_bool_t
hb_blob_set_user_data (hb_blob_t          *blob,
		       hb_user_data_key_t *key,
		       void *              data,
		       hb_destroy_func_t   destroy,
		       hb_bool_t           replace);

HB_EXTERN void *
hb_blob_get_user_data (hb_blob_t          *blob,
		       hb_user_data_key_t *key);

HB_EXTERN void
hb_blob_make_immutable (hb_blob_t *blob);

HB_EXTERN hb_bool_t
hb_blob_is_immutable (hb_blob_t *blob);

HB_EXTERN unsigned int
hb_blob_get_length (hb_blob_t *blob);

HB_EXTERN const char *
hb_blob_get_data (hb_blob_t *blob, unsigned int *length);

HB_EXTERN char *
hb_blob_get_data_writable (hb_blob_t *blob, unsigned int *length);

HB_END_DECLS

#endif /* HB_BLOB_H */