jpayne@69: /*
jpayne@69:  * Copyright © 2018  Ebrahim Byagowi.
jpayne@69:  *
jpayne@69:  *  This is part of HarfBuzz, a text shaping library.
jpayne@69:  *
jpayne@69:  * Permission is hereby granted, without written agreement and without
jpayne@69:  * license or royalty fees, to use, copy, modify, and distribute this
jpayne@69:  * software and its documentation for any purpose, provided that the
jpayne@69:  * above copyright notice and the following two paragraphs appear in
jpayne@69:  * all copies of this software.
jpayne@69:  *
jpayne@69:  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
jpayne@69:  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
jpayne@69:  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
jpayne@69:  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
jpayne@69:  * DAMAGE.
jpayne@69:  *
jpayne@69:  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
jpayne@69:  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
jpayne@69:  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
jpayne@69:  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
jpayne@69:  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
jpayne@69:  */
jpayne@69: 
jpayne@69: #ifndef HB_OT_H_IN
jpayne@69: #error "Include <hb-ot.h> instead."
jpayne@69: #endif
jpayne@69: 
jpayne@69: #ifndef HB_OT_NAME_H
jpayne@69: #define HB_OT_NAME_H
jpayne@69: 
jpayne@69: #include "hb.h"
jpayne@69: 
jpayne@69: HB_BEGIN_DECLS
jpayne@69: 
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_ot_name_id_t:
jpayne@69:  * @HB_OT_NAME_ID_INVALID: Value to represent a nonexistent name ID.
jpayne@69:  *
jpayne@69:  * An integral type representing an OpenType 'name' table name identifier.
jpayne@69:  * There are predefined name IDs, as well as name IDs return from other
jpayne@69:  * API.  These can be used to fetch name strings from a font face.
jpayne@69:  *
jpayne@69:  * Since: 2.0.0
jpayne@69:  **/
jpayne@69: enum
jpayne@69: {
jpayne@69:   HB_OT_NAME_ID_COPYRIGHT		= 0,
jpayne@69:   HB_OT_NAME_ID_FONT_FAMILY		= 1,
jpayne@69:   HB_OT_NAME_ID_FONT_SUBFAMILY		= 2,
jpayne@69:   HB_OT_NAME_ID_UNIQUE_ID		= 3,
jpayne@69:   HB_OT_NAME_ID_FULL_NAME		= 4,
jpayne@69:   HB_OT_NAME_ID_VERSION_STRING		= 5,
jpayne@69:   HB_OT_NAME_ID_POSTSCRIPT_NAME		= 6,
jpayne@69:   HB_OT_NAME_ID_TRADEMARK		= 7,
jpayne@69:   HB_OT_NAME_ID_MANUFACTURER		= 8,
jpayne@69:   HB_OT_NAME_ID_DESIGNER		= 9,
jpayne@69:   HB_OT_NAME_ID_DESCRIPTION		= 10,
jpayne@69:   HB_OT_NAME_ID_VENDOR_URL		= 11,
jpayne@69:   HB_OT_NAME_ID_DESIGNER_URL		= 12,
jpayne@69:   HB_OT_NAME_ID_LICENSE			= 13,
jpayne@69:   HB_OT_NAME_ID_LICENSE_URL		= 14,
jpayne@69: /*HB_OT_NAME_ID_RESERVED		= 15,*/
jpayne@69:   HB_OT_NAME_ID_TYPOGRAPHIC_FAMILY	= 16,
jpayne@69:   HB_OT_NAME_ID_TYPOGRAPHIC_SUBFAMILY	= 17,
jpayne@69:   HB_OT_NAME_ID_MAC_FULL_NAME		= 18,
jpayne@69:   HB_OT_NAME_ID_SAMPLE_TEXT		= 19,
jpayne@69:   HB_OT_NAME_ID_CID_FINDFONT_NAME	= 20,
jpayne@69:   HB_OT_NAME_ID_WWS_FAMILY		= 21,
jpayne@69:   HB_OT_NAME_ID_WWS_SUBFAMILY		= 22,
jpayne@69:   HB_OT_NAME_ID_LIGHT_BACKGROUND	= 23,
jpayne@69:   HB_OT_NAME_ID_DARK_BACKGROUND		= 24,
jpayne@69:   HB_OT_NAME_ID_VARIATIONS_PS_PREFIX	= 25,
jpayne@69: 
jpayne@69:   HB_OT_NAME_ID_INVALID			= 0xFFFF
jpayne@69: };
jpayne@69: 
jpayne@69: typedef unsigned int hb_ot_name_id_t;
jpayne@69: 
jpayne@69: 
jpayne@69: /**
jpayne@69:  * hb_ot_name_entry_t:
jpayne@69:  * @name_id: name ID
jpayne@69:  * @language: language
jpayne@69:  *
jpayne@69:  * Structure representing a name ID in a particular language.
jpayne@69:  *
jpayne@69:  * Since: 2.1.0
jpayne@69:  **/
jpayne@69: typedef struct hb_ot_name_entry_t
jpayne@69: {
jpayne@69:   hb_ot_name_id_t name_id;
jpayne@69:   /*< private >*/
jpayne@69:   hb_var_int_t    var;
jpayne@69:   /*< public >*/
jpayne@69:   hb_language_t   language;
jpayne@69: } hb_ot_name_entry_t;
jpayne@69: 
jpayne@69: HB_EXTERN const hb_ot_name_entry_t *
jpayne@69: hb_ot_name_list_names (hb_face_t    *face,
jpayne@69: 		       unsigned int *num_entries /* OUT */);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_EXTERN unsigned int
jpayne@69: hb_ot_name_get_utf8 (hb_face_t       *face,
jpayne@69: 		     hb_ot_name_id_t  name_id,
jpayne@69: 		     hb_language_t    language,
jpayne@69: 		     unsigned int    *text_size /* IN/OUT */,
jpayne@69: 		     char            *text      /* OUT */);
jpayne@69: 
jpayne@69: HB_EXTERN unsigned int
jpayne@69: hb_ot_name_get_utf16 (hb_face_t       *face,
jpayne@69: 		      hb_ot_name_id_t  name_id,
jpayne@69: 		      hb_language_t    language,
jpayne@69: 		      unsigned int    *text_size /* IN/OUT */,
jpayne@69: 		      uint16_t        *text      /* OUT */);
jpayne@69: 
jpayne@69: HB_EXTERN unsigned int
jpayne@69: hb_ot_name_get_utf32 (hb_face_t       *face,
jpayne@69: 		      hb_ot_name_id_t  name_id,
jpayne@69: 		      hb_language_t    language,
jpayne@69: 		      unsigned int    *text_size /* IN/OUT */,
jpayne@69: 		      uint32_t        *text      /* OUT */);
jpayne@69: 
jpayne@69: 
jpayne@69: HB_END_DECLS
jpayne@69: 
jpayne@69: #endif /* HB_OT_NAME_H */