jpayne@69
|
1 /*
|
jpayne@69
|
2 * Copyright © 2018 Ebrahim Byagowi.
|
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
|
jpayne@69
|
25 #ifndef HB_OT_H_IN
|
jpayne@69
|
26 #error "Include <hb-ot.h> instead."
|
jpayne@69
|
27 #endif
|
jpayne@69
|
28
|
jpayne@69
|
29 #ifndef HB_OT_NAME_H
|
jpayne@69
|
30 #define HB_OT_NAME_H
|
jpayne@69
|
31
|
jpayne@69
|
32 #include "hb.h"
|
jpayne@69
|
33
|
jpayne@69
|
34 HB_BEGIN_DECLS
|
jpayne@69
|
35
|
jpayne@69
|
36
|
jpayne@69
|
37 /**
|
jpayne@69
|
38 * hb_ot_name_id_t:
|
jpayne@69
|
39 * @HB_OT_NAME_ID_INVALID: Value to represent a nonexistent name ID.
|
jpayne@69
|
40 *
|
jpayne@69
|
41 * An integral type representing an OpenType 'name' table name identifier.
|
jpayne@69
|
42 * There are predefined name IDs, as well as name IDs return from other
|
jpayne@69
|
43 * API. These can be used to fetch name strings from a font face.
|
jpayne@69
|
44 *
|
jpayne@69
|
45 * Since: 2.0.0
|
jpayne@69
|
46 **/
|
jpayne@69
|
47 enum
|
jpayne@69
|
48 {
|
jpayne@69
|
49 HB_OT_NAME_ID_COPYRIGHT = 0,
|
jpayne@69
|
50 HB_OT_NAME_ID_FONT_FAMILY = 1,
|
jpayne@69
|
51 HB_OT_NAME_ID_FONT_SUBFAMILY = 2,
|
jpayne@69
|
52 HB_OT_NAME_ID_UNIQUE_ID = 3,
|
jpayne@69
|
53 HB_OT_NAME_ID_FULL_NAME = 4,
|
jpayne@69
|
54 HB_OT_NAME_ID_VERSION_STRING = 5,
|
jpayne@69
|
55 HB_OT_NAME_ID_POSTSCRIPT_NAME = 6,
|
jpayne@69
|
56 HB_OT_NAME_ID_TRADEMARK = 7,
|
jpayne@69
|
57 HB_OT_NAME_ID_MANUFACTURER = 8,
|
jpayne@69
|
58 HB_OT_NAME_ID_DESIGNER = 9,
|
jpayne@69
|
59 HB_OT_NAME_ID_DESCRIPTION = 10,
|
jpayne@69
|
60 HB_OT_NAME_ID_VENDOR_URL = 11,
|
jpayne@69
|
61 HB_OT_NAME_ID_DESIGNER_URL = 12,
|
jpayne@69
|
62 HB_OT_NAME_ID_LICENSE = 13,
|
jpayne@69
|
63 HB_OT_NAME_ID_LICENSE_URL = 14,
|
jpayne@69
|
64 /*HB_OT_NAME_ID_RESERVED = 15,*/
|
jpayne@69
|
65 HB_OT_NAME_ID_TYPOGRAPHIC_FAMILY = 16,
|
jpayne@69
|
66 HB_OT_NAME_ID_TYPOGRAPHIC_SUBFAMILY = 17,
|
jpayne@69
|
67 HB_OT_NAME_ID_MAC_FULL_NAME = 18,
|
jpayne@69
|
68 HB_OT_NAME_ID_SAMPLE_TEXT = 19,
|
jpayne@69
|
69 HB_OT_NAME_ID_CID_FINDFONT_NAME = 20,
|
jpayne@69
|
70 HB_OT_NAME_ID_WWS_FAMILY = 21,
|
jpayne@69
|
71 HB_OT_NAME_ID_WWS_SUBFAMILY = 22,
|
jpayne@69
|
72 HB_OT_NAME_ID_LIGHT_BACKGROUND = 23,
|
jpayne@69
|
73 HB_OT_NAME_ID_DARK_BACKGROUND = 24,
|
jpayne@69
|
74 HB_OT_NAME_ID_VARIATIONS_PS_PREFIX = 25,
|
jpayne@69
|
75
|
jpayne@69
|
76 HB_OT_NAME_ID_INVALID = 0xFFFF
|
jpayne@69
|
77 };
|
jpayne@69
|
78
|
jpayne@69
|
79 typedef unsigned int hb_ot_name_id_t;
|
jpayne@69
|
80
|
jpayne@69
|
81
|
jpayne@69
|
82 /**
|
jpayne@69
|
83 * hb_ot_name_entry_t:
|
jpayne@69
|
84 * @name_id: name ID
|
jpayne@69
|
85 * @language: language
|
jpayne@69
|
86 *
|
jpayne@69
|
87 * Structure representing a name ID in a particular language.
|
jpayne@69
|
88 *
|
jpayne@69
|
89 * Since: 2.1.0
|
jpayne@69
|
90 **/
|
jpayne@69
|
91 typedef struct hb_ot_name_entry_t
|
jpayne@69
|
92 {
|
jpayne@69
|
93 hb_ot_name_id_t name_id;
|
jpayne@69
|
94 /*< private >*/
|
jpayne@69
|
95 hb_var_int_t var;
|
jpayne@69
|
96 /*< public >*/
|
jpayne@69
|
97 hb_language_t language;
|
jpayne@69
|
98 } hb_ot_name_entry_t;
|
jpayne@69
|
99
|
jpayne@69
|
100 HB_EXTERN const hb_ot_name_entry_t *
|
jpayne@69
|
101 hb_ot_name_list_names (hb_face_t *face,
|
jpayne@69
|
102 unsigned int *num_entries /* OUT */);
|
jpayne@69
|
103
|
jpayne@69
|
104
|
jpayne@69
|
105 HB_EXTERN unsigned int
|
jpayne@69
|
106 hb_ot_name_get_utf8 (hb_face_t *face,
|
jpayne@69
|
107 hb_ot_name_id_t name_id,
|
jpayne@69
|
108 hb_language_t language,
|
jpayne@69
|
109 unsigned int *text_size /* IN/OUT */,
|
jpayne@69
|
110 char *text /* OUT */);
|
jpayne@69
|
111
|
jpayne@69
|
112 HB_EXTERN unsigned int
|
jpayne@69
|
113 hb_ot_name_get_utf16 (hb_face_t *face,
|
jpayne@69
|
114 hb_ot_name_id_t name_id,
|
jpayne@69
|
115 hb_language_t language,
|
jpayne@69
|
116 unsigned int *text_size /* IN/OUT */,
|
jpayne@69
|
117 uint16_t *text /* OUT */);
|
jpayne@69
|
118
|
jpayne@69
|
119 HB_EXTERN unsigned int
|
jpayne@69
|
120 hb_ot_name_get_utf32 (hb_face_t *face,
|
jpayne@69
|
121 hb_ot_name_id_t name_id,
|
jpayne@69
|
122 hb_language_t language,
|
jpayne@69
|
123 unsigned int *text_size /* IN/OUT */,
|
jpayne@69
|
124 uint32_t *text /* OUT */);
|
jpayne@69
|
125
|
jpayne@69
|
126
|
jpayne@69
|
127 HB_END_DECLS
|
jpayne@69
|
128
|
jpayne@69
|
129 #endif /* HB_OT_NAME_H */
|