1/* Pango
2 * pango-coverage.h: Coverage sets for fonts
3 *
4 * Copyright (C) 2000 Red Hat Software
5 *
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Library General Public
8 * License as published by the Free Software Foundation; either
9 * version 2 of the License, or (at your option) any later version.
10 *
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Library General Public License for more details.
15 *
16 * You should have received a copy of the GNU Library General Public
17 * License along with this library; if not, write to the
18 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 * Boston, MA 02111-1307, USA.
20 */
21
22#ifndef __PANGO_COVERAGE_H__
23#define __PANGO_COVERAGE_H__
24
25#include <glib.h>
26
27G_BEGIN_DECLS
28
29/**
30 * PangoCoverage:
31 *
32 * The #PangoCoverage structure represents a map from Unicode characters
33 * to #PangoCoverageLevel. It is an opaque structure with no public fields.
34 */
35typedef struct _PangoCoverage PangoCoverage;
36
37/**
38 * PangoCoverageLevel:
39 * @PANGO_COVERAGE_NONE: The character is not representable with the font.
40 * @PANGO_COVERAGE_FALLBACK: The character is represented in a way that may be
41 * comprehensible but is not the correct graphical form.
42 * For instance, a Hangul character represented as a
43 * a sequence of Jamos, or a Latin transliteration of a Cyrillic word.
44 * @PANGO_COVERAGE_APPROXIMATE: The character is represented as basically the correct
45 * graphical form, but with a stylistic variant inappropriate for
46 * the current script.
47 * @PANGO_COVERAGE_EXACT: The character is represented as the correct graphical form.
48 *
49 * Used to indicate how well a font can represent a particular Unicode
50 * character point for a particular script.
51 */
52typedef enum {
53 PANGO_COVERAGE_NONE,
54 PANGO_COVERAGE_FALLBACK,
55 PANGO_COVERAGE_APPROXIMATE,
56 PANGO_COVERAGE_EXACT
57} PangoCoverageLevel;
58
59PangoCoverage * pango_coverage_new (void);
60PangoCoverage * pango_coverage_ref (PangoCoverage *coverage);
61void pango_coverage_unref (PangoCoverage *coverage);
62PangoCoverage * pango_coverage_copy (PangoCoverage *coverage);
63PangoCoverageLevel pango_coverage_get (PangoCoverage *coverage,
64 int index_);
65void pango_coverage_set (PangoCoverage *coverage,
66 int index_,
67 PangoCoverageLevel level);
68void pango_coverage_max (PangoCoverage *coverage,
69 PangoCoverage *other);
70
71void pango_coverage_to_bytes (PangoCoverage *coverage,
72 guchar **bytes,
73 int *n_bytes);
74PangoCoverage *pango_coverage_from_bytes (guchar *bytes,
75 int n_bytes);
76
77G_END_DECLS
78
79#endif /* __PANGO_COVERAGE_H__ */
80