harfbuzz/src/hb.h

/*
 * 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
#define HB_H
#define HB_H_IN

#ifndef HB_EXTERN
#define HB_EXTERN extern
#endif

#include "hb-blob.h"
#include "hb-buffer.h"
#include "hb-common.h"
#include "hb-deprecated.h"
#include "hb-face.h"
#include "hb-font.h"
#include "hb-set.h"
#include "hb-shape.h"
#include "hb-shape-plan.h"
#include "hb-unicode.h"
#include "hb-version.h"

HB_BEGIN_DECLS
HB_END_DECLS

#undef HB_H_IN
#endif /* HB_H */
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00			`/*`
Update Copyright headers 2011-04-21 23:14:28 +02:00			`* Copyright © 2009 Red Hat, Inc.`
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00			`*`
Change header comment 2010-04-22 06:11:43 +02:00			`* This is part of HarfBuzz, a text shaping library.`
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00			`*`
			`* 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`
			`#define HB_H`
Make it an error to include non-top-level headers Users should #include <hb.h> (or hb-ft.h, hb-glib.h, etc), but never things like hb-shape.h directly. This makes it easier to refactor headers later on without breaking compatibility. 2012-04-12 19:17:44 +02:00			`#define HB_H_IN`
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00
Public headers: Decorate public symbols with HB_EXTERN This prepares the headers for exporting symbols using visibility attributes or __declspec(dllexport), so that we do not need to maintain symbols listing files, as this is what was and is done in GLib and GTK+. 2015-11-19 11:34:12 +01:00			`#ifndef HB_EXTERN`
			`#define HB_EXTERN extern`
			`#endif`

[HB] Add top-level header files 2009-08-02 21:35:31 +02:00			`#include "hb-blob.h"`
			`#include "hb-buffer.h"`
Start ft glue 2009-11-04 00:34:20 +01:00			`#include "hb-common.h"`
Add hb-deprecated.h, and rename a couple enum values Add deprecated alias for old name. 2013-08-27 02:39:00 +02:00			`#include "hb-deprecated.h"`
Separate face source code from font Makes documentation / introspection easier. 2013-08-27 00:49:07 +02:00			`#include "hb-face.h"`
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00			`#include "hb-font.h"`
Add hb_set_t 2012-04-24 04:41:09 +02:00			`#include "hb-set.h"`
Start ft glue 2009-11-04 00:34:20 +01:00			`#include "hb-shape.h"`
Bunch of independent changes (ouch) API additions: hb_segment_properties_t HB_SEGMENT_PROPERTIES_DEFAULT hb_segment_properties_equal() hb_segment_properties_hash() hb_buffer_set_segment_properties() hb_buffer_get_segment_properties() hb_ot_layout_glyph_class_t hb_shape_plan_t hb_shape_plan_create() hb_shape_plan_create_cached() hb_shape_plan_get_empty() hb_shape_plan_reference() hb_shape_plan_destroy() hb_shape_plan_set_user_data() hb_shape_plan_get_user_data() hb_shape_plan_execute() hb_ot_shape_plan_collect_lookups() API changes: Rename hb_ot_layout_feature_get_lookup_indexes() to hb_ot_layout_feature_get_lookups(). New header file: hb-shape-plan.h And a bunch of prototyped but not implemented stuff. Coming soon. (Tests fail because of the prototypes right now.) 2012-11-16 03:39:46 +01:00			`#include "hb-shape-plan.h"`
Start ft glue 2009-11-04 00:34:20 +01:00			`#include "hb-unicode.h"`
[API] Add version macros and functions Step version up to 0.5.0. Also, fix to pass "make distcheck" 2011-05-06 03:31:04 +02:00			`#include "hb-version.h"`
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00
Prefer C linkage 2010-07-23 21:11:18 +02:00			`HB_BEGIN_DECLS`
			`HB_END_DECLS`

Make it an error to include non-top-level headers Users should #include <hb.h> (or hb-ft.h, hb-glib.h, etc), but never things like hb-shape.h directly. This makes it easier to refactor headers later on without breaking compatibility. 2012-04-12 19:17:44 +02:00			`#undef HB_H_IN`
[HB] Add top-level header files 2009-08-02 21:35:31 +02:00			`#endif /* HB_H */`