Imported Upstream version 2.6.4
[platform/upstream/harfbuzz.git] / src / hb-ot-meta.h
1 /*
2  * Copyright © 2019  Ebrahim Byagowi
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
25 #ifndef HB_OT_H_IN
26 #error "Include <hb-ot.h> instead."
27 #endif
28
29 #ifndef HB_OT_META_H
30 #define HB_OT_META_H
31
32 #include "hb.h"
33
34 HB_BEGIN_DECLS
35
36 /**
37  * hb_ot_meta_tag_t:
38  * @HB_OT_META_TAG_DESIGN_LANGUAGES: Design languages. Text, using only
39  * Basic Latin (ASCII) characters. Indicates languages and/or scripts
40  * for the user audiences that the font was primarily designed for.
41  * @HB_OT_META_TAG_SUPPORTED_LANGUAGES: Supported languages. Text, using
42  * only Basic Latin (ASCII) characters. Indicates languages and/or scripts
43  * that the font is declared to be capable of supporting.
44  *
45  * Known metadata tags from https://docs.microsoft.com/en-us/typography/opentype/spec/meta
46  *
47  * Since: 2.6.0
48  **/
49 typedef enum {
50 /*
51    HB_OT_META_TAG_APPL          = HB_TAG ('a','p','p','l'),
52    HB_OT_META_TAG_BILD          = HB_TAG ('b','i','l','d'),
53 */
54   HB_OT_META_TAG_DESIGN_LANGUAGES       = HB_TAG ('d','l','n','g'),
55   HB_OT_META_TAG_SUPPORTED_LANGUAGES    = HB_TAG ('s','l','n','g'),
56
57   _HB_OT_META_TAG_MAX_VALUE = HB_TAG_MAX_SIGNED /*< skip >*/
58 } hb_ot_meta_tag_t;
59
60 HB_EXTERN unsigned int
61 hb_ot_meta_get_entry_tags (hb_face_t        *face,
62                            unsigned int      start_offset,
63                            unsigned int     *entries_count, /* IN/OUT.  May be NULL. */
64                            hb_ot_meta_tag_t *entries        /* OUT.     May be NULL. */);
65
66 HB_EXTERN hb_blob_t *
67 hb_ot_meta_reference_entry (hb_face_t *face, hb_ot_meta_tag_t meta_tag);
68
69 HB_END_DECLS
70
71 #endif /* HB_OT_META_H */