## hb-common

hb-common

## Synopsis

    #define             HB_DIRECTION_REVERSE                (dir)
    #define             HB_LANGUAGE_INVALID
    #define             HB_TAG                              (c1,
                                                             c2,
                                                             c3,
                                                             c4)
    #define             HB_TAG_NONE
    #define             HB_UNTAG                            (tag)
    typedef             hb_bool_t;
    typedef             hb_codepoint_t;
    void                (*hb_destroy_func_t)                (void *user_data);
    hb_direction_t      hb_direction_from_string            (const char *str,
                                                             int len);
    enum                hb_direction_t;
    const char *        hb_direction_to_string              (hb_direction_t direction);
    hb_language_t       hb_language_from_string             (const char *str,
                                                             int len);
    hb_language_t       hb_language_get_default             (void);
    typedef             hb_language_t;
    const char *        hb_language_to_string               (hb_language_t language);
    typedef             hb_mask_t;
    typedef             hb_position_t;
    hb_script_t         hb_script_from_iso15924_tag         (hb_tag_t tag);
    hb_script_t         hb_script_from_string               (const char *s,
                                                             int len);
    hb_direction_t      hb_script_get_horizontal_direction  (hb_script_t script);
    enum                hb_script_t;
    hb_tag_t            hb_script_to_iso15924_tag           (hb_script_t script);
    hb_tag_t            hb_tag_from_string                  (const char *str,
                                                             int len);
    typedef             hb_tag_t;
    void                hb_tag_to_string                    (hb_tag_t tag,
                                                             char *buf);
                        hb_user_data_key_t;
                        hb_var_int_t;
    #define             HB_DIRECTION_IS_BACKWARD            (dir)
    #define             HB_DIRECTION_IS_FORWARD             (dir)
    #define             HB_DIRECTION_IS_HORIZONTAL          (dir)
    #define             HB_DIRECTION_IS_VALID               (dir)
    #define             HB_DIRECTION_IS_VERTICAL            (dir)

## Description

## Details

### HB_DIRECTION_REVERSE()

    #define HB_DIRECTION_REVERSE(dir) ((hb_direction_t) (((unsigned int) (dir)) ^ 1)) /* Direction must be valid */

### HB_LANGUAGE_INVALID

    #define HB_LANGUAGE_INVALID ((hb_language_t) NULL)

### HB_TAG()

    #define HB_TAG(c1,c2,c3,c4) ((hb_tag_t)((((uint8_t)(c1))<<24)|(((uint8_t)(c2))<<16)|(((uint8_t)(c3))<<8)|((uint8_t)(c4))))

### HB_TAG_NONE

    #define HB_TAG_NONE HB_TAG(0,0,0,0)

### HB_UNTAG()

    #define HB_UNTAG(tag)   ((uint8_t)((tag)>>24)), ((uint8_t)((tag)>>16)), ((uint8_t)((tag)>>8)), ((uint8_t)(tag))

### hb_bool_t

    typedef int hb_bool_t;

### hb_codepoint_t

    typedef uint32_t hb_codepoint_t;

### hb_destroy_func_t ()

    void                (*hb_destroy_func_t)                (void *user_data);

### hb_direction_from_string ()

    hb_direction_t      hb_direction_from_string            (const char *str,
                                                             int len);

`str` : | . [array length=len]

Since 1.0

### enum hb_direction_t

    typedef enum {
      HB_DIRECTION_INVALID = 0,
      HB_DIRECTION_LTR = 4,
      HB_DIRECTION_RTL,
      HB_DIRECTION_TTB,
      HB_DIRECTION_BTT
    } hb_direction_t;

`HB_DIRECTION_INVALID` |
`HB_DIRECTION_LTR` |
`HB_DIRECTION_RTL` |
`HB_DIRECTION_TTB` |
`HB_DIRECTION_BTT` |

### hb_direction_to_string ()

    const char *        hb_direction_to_string              (hb_direction_t direction);

Returns : | . [transfer none]

Since 1.0

### hb_language_from_string ()

    hb_language_t       hb_language_from_string             (const char *str,
                                                             int len);

`str` : | . [array length=len]

Since 1.0

### hb_language_get_default ()

    hb_language_t       hb_language_get_default             (void);

Since 1.0

### hb_language_t

    typedef const struct hb_language_impl_t *hb_language_t;

### hb_language_to_string ()

    const char *        hb_language_to_string               (hb_language_t language);

Returns : | . [transfer none]

Since 1.0

### hb_mask_t

    typedef uint32_t hb_mask_t;

### hb_position_t

    typedef int32_t hb_position_t;

### hb_script_from_iso15924_tag ()

    hb_script_t         hb_script_from_iso15924_tag         (hb_tag_t tag);

Since 1.0

### hb_script_from_string ()

    hb_script_t         hb_script_from_string               (const char *s,
                                                             int len);

`s` : | . [array length=len]

Since 1.0

### hb_script_get_horizontal_direction ()

    hb_direction_t      hb_script_get_horizontal_direction  (hb_script_t script);

Since 1.0

### enum hb_script_t

    typedef enum {
      /*1.1*/ HB_SCRIPT_COMMON			= HB_TAG ('Z','y','y','y'),
      /*1.1*/ HB_SCRIPT_INHERITED			= HB_TAG ('Z','i','n','h'),
      /*5.0*/ HB_SCRIPT_UNKNOWN			= HB_TAG ('Z','z','z','z'),

      /*1.1*/ HB_SCRIPT_ARABIC			= HB_TAG ('A','r','a','b'),
      /*1.1*/ HB_SCRIPT_ARMENIAN			= HB_TAG ('A','r','m','n'),
      /*1.1*/ HB_SCRIPT_BENGALI			= HB_TAG ('B','e','n','g'),
      /*1.1*/ HB_SCRIPT_CYRILLIC			= HB_TAG ('C','y','r','l'),
      /*1.1*/ HB_SCRIPT_DEVANAGARI			= HB_TAG ('D','e','v','a'),
      /*1.1*/ HB_SCRIPT_GEORGIAN			= HB_TAG ('G','e','o','r'),
      /*1.1*/ HB_SCRIPT_GREEK			= HB_TAG ('G','r','e','k'),
      /*1.1*/ HB_SCRIPT_GUJARATI			= HB_TAG ('G','u','j','r'),
      /*1.1*/ HB_SCRIPT_GURMUKHI			= HB_TAG ('G','u','r','u'),
      /*1.1*/ HB_SCRIPT_HANGUL			= HB_TAG ('H','a','n','g'),
      /*1.1*/ HB_SCRIPT_HAN				= HB_TAG ('H','a','n','i'),
      /*1.1*/ HB_SCRIPT_HEBREW			= HB_TAG ('H','e','b','r'),
      /*1.1*/ HB_SCRIPT_HIRAGANA			= HB_TAG ('H','i','r','a'),
      /*1.1*/ HB_SCRIPT_KANNADA			= HB_TAG ('K','n','d','a'),
      /*1.1*/ HB_SCRIPT_KATAKANA			= HB_TAG ('K','a','n','a'),
      /*1.1*/ HB_SCRIPT_LAO				= HB_TAG ('L','a','o','o'),
      /*1.1*/ HB_SCRIPT_LATIN			= HB_TAG ('L','a','t','n'),
      /*1.1*/ HB_SCRIPT_MALAYALAM			= HB_TAG ('M','l','y','m'),
      /*1.1*/ HB_SCRIPT_ORIYA			= HB_TAG ('O','r','y','a'),
      /*1.1*/ HB_SCRIPT_TAMIL			= HB_TAG ('T','a','m','l'),
      /*1.1*/ HB_SCRIPT_TELUGU			= HB_TAG ('T','e','l','u'),
      /*1.1*/ HB_SCRIPT_THAI			= HB_TAG ('T','h','a','i'),

      /*2.0*/ HB_SCRIPT_TIBETAN			= HB_TAG ('T','i','b','t'),

      /*3.0*/ HB_SCRIPT_BOPOMOFO			= HB_TAG ('B','o','p','o'),
      /*3.0*/ HB_SCRIPT_BRAILLE			= HB_TAG ('B','r','a','i'),
      /*3.0*/ HB_SCRIPT_CANADIAN_SYLLABICS		= HB_TAG ('C','a','n','s'),
      /*3.0*/ HB_SCRIPT_CHEROKEE			= HB_TAG ('C','h','e','r'),
      /*3.0*/ HB_SCRIPT_ETHIOPIC			= HB_TAG ('E','t','h','i'),
      /*3.0*/ HB_SCRIPT_KHMER			= HB_TAG ('K','h','m','r'),
      /*3.0*/ HB_SCRIPT_MONGOLIAN			= HB_TAG ('M','o','n','g'),
      /*3.0*/ HB_SCRIPT_MYANMAR			= HB_TAG ('M','y','m','r'),
      /*3.0*/ HB_SCRIPT_OGHAM			= HB_TAG ('O','g','a','m'),
      /*3.0*/ HB_SCRIPT_RUNIC			= HB_TAG ('R','u','n','r'),
      /*3.0*/ HB_SCRIPT_SINHALA			= HB_TAG ('S','i','n','h'),
      /*3.0*/ HB_SCRIPT_SYRIAC			= HB_TAG ('S','y','r','c'),
      /*3.0*/ HB_SCRIPT_THAANA			= HB_TAG ('T','h','a','a'),
      /*3.0*/ HB_SCRIPT_YI				= HB_TAG ('Y','i','i','i'),

      /*3.1*/ HB_SCRIPT_DESERET			= HB_TAG ('D','s','r','t'),
      /*3.1*/ HB_SCRIPT_GOTHIC			= HB_TAG ('G','o','t','h'),
      /*3.1*/ HB_SCRIPT_OLD_ITALIC			= HB_TAG ('I','t','a','l'),

      /*3.2*/ HB_SCRIPT_BUHID			= HB_TAG ('B','u','h','d'),
      /*3.2*/ HB_SCRIPT_HANUNOO			= HB_TAG ('H','a','n','o'),
      /*3.2*/ HB_SCRIPT_TAGALOG			= HB_TAG ('T','g','l','g'),
      /*3.2*/ HB_SCRIPT_TAGBANWA			= HB_TAG ('T','a','g','b'),

      /*4.0*/ HB_SCRIPT_CYPRIOT			= HB_TAG ('C','p','r','t'),
      /*4.0*/ HB_SCRIPT_LIMBU			= HB_TAG ('L','i','m','b'),
      /*4.0*/ HB_SCRIPT_LINEAR_B			= HB_TAG ('L','i','n','b'),
      /*4.0*/ HB_SCRIPT_OSMANYA			= HB_TAG ('O','s','m','a'),
      /*4.0*/ HB_SCRIPT_SHAVIAN			= HB_TAG ('S','h','a','w'),
      /*4.0*/ HB_SCRIPT_TAI_LE			= HB_TAG ('T','a','l','e'),
      /*4.0*/ HB_SCRIPT_UGARITIC			= HB_TAG ('U','g','a','r'),

      /*4.1*/ HB_SCRIPT_BUGINESE			= HB_TAG ('B','u','g','i'),
      /*4.1*/ HB_SCRIPT_COPTIC			= HB_TAG ('C','o','p','t'),
      /*4.1*/ HB_SCRIPT_GLAGOLITIC			= HB_TAG ('G','l','a','g'),
      /*4.1*/ HB_SCRIPT_KHAROSHTHI			= HB_TAG ('K','h','a','r'),
      /*4.1*/ HB_SCRIPT_NEW_TAI_LUE			= HB_TAG ('T','a','l','u'),
      /*4.1*/ HB_SCRIPT_OLD_PERSIAN			= HB_TAG ('X','p','e','o'),
      /*4.1*/ HB_SCRIPT_SYLOTI_NAGRI		= HB_TAG ('S','y','l','o'),
      /*4.1*/ HB_SCRIPT_TIFINAGH			= HB_TAG ('T','f','n','g'),

      /*5.0*/ HB_SCRIPT_BALINESE			= HB_TAG ('B','a','l','i'),
      /*5.0*/ HB_SCRIPT_CUNEIFORM			= HB_TAG ('X','s','u','x'),
      /*5.0*/ HB_SCRIPT_NKO				= HB_TAG ('N','k','o','o'),
      /*5.0*/ HB_SCRIPT_PHAGS_PA			= HB_TAG ('P','h','a','g'),
      /*5.0*/ HB_SCRIPT_PHOENICIAN			= HB_TAG ('P','h','n','x'),

      /*5.1*/ HB_SCRIPT_CARIAN			= HB_TAG ('C','a','r','i'),
      /*5.1*/ HB_SCRIPT_CHAM			= HB_TAG ('C','h','a','m'),
      /*5.1*/ HB_SCRIPT_KAYAH_LI			= HB_TAG ('K','a','l','i'),
      /*5.1*/ HB_SCRIPT_LEPCHA			= HB_TAG ('L','e','p','c'),
      /*5.1*/ HB_SCRIPT_LYCIAN			= HB_TAG ('L','y','c','i'),
      /*5.1*/ HB_SCRIPT_LYDIAN			= HB_TAG ('L','y','d','i'),
      /*5.1*/ HB_SCRIPT_OL_CHIKI			= HB_TAG ('O','l','c','k'),
      /*5.1*/ HB_SCRIPT_REJANG			= HB_TAG ('R','j','n','g'),
      /*5.1*/ HB_SCRIPT_SAURASHTRA			= HB_TAG ('S','a','u','r'),
      /*5.1*/ HB_SCRIPT_SUNDANESE			= HB_TAG ('S','u','n','d'),
      /*5.1*/ HB_SCRIPT_VAI				= HB_TAG ('V','a','i','i'),

      /*5.2*/ HB_SCRIPT_AVESTAN			= HB_TAG ('A','v','s','t'),
      /*5.2*/ HB_SCRIPT_BAMUM			= HB_TAG ('B','a','m','u'),
      /*5.2*/ HB_SCRIPT_EGYPTIAN_HIEROGLYPHS = HB_TAG ('E','g','y','p'),
      /*5.2*/ HB_SCRIPT_IMPERIAL_ARAMAIC		= HB_TAG ('A','r','m','i'),
      /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PAHLAVI = HB_TAG ('P','h','l','i'),
      /*5.2*/ HB_SCRIPT_INSCRIPTIONAL_PARTHIAN = HB_TAG ('P','r','t','i'),
      /*5.2*/ HB_SCRIPT_JAVANESE			= HB_TAG ('J','a','v','a'),
      /*5.2*/ HB_SCRIPT_KAITHI			= HB_TAG ('K','t','h','i'),
      /*5.2*/ HB_SCRIPT_LISU			= HB_TAG ('L','i','s','u'),
      /*5.2*/ HB_SCRIPT_MEETEI_MAYEK		= HB_TAG ('M','t','e','i'),
      /*5.2*/ HB_SCRIPT_OLD_SOUTH_ARABIAN		= HB_TAG ('S','a','r','b'),
      /*5.2*/ HB_SCRIPT_OLD_TURKIC			= HB_TAG ('O','r','k','h'),
      /*5.2*/ HB_SCRIPT_SAMARITAN			= HB_TAG ('S','a','m','r'),
      /*5.2*/ HB_SCRIPT_TAI_THAM			= HB_TAG ('L','a','n','a'),
      /*5.2*/ HB_SCRIPT_TAI_VIET			= HB_TAG ('T','a','v','t'),

      /*6.0*/ HB_SCRIPT_BATAK			= HB_TAG ('B','a','t','k'),
      /*6.0*/ HB_SCRIPT_BRAHMI			= HB_TAG ('B','r','a','h'),
      /*6.0*/ HB_SCRIPT_MANDAIC			= HB_TAG ('M','a','n','d'),

      /*6.1*/ HB_SCRIPT_CHAKMA			= HB_TAG ('C','a','k','m'),
      /*6.1*/ HB_SCRIPT_MEROITIC_CURSIVE		= HB_TAG ('M','e','r','c'),
      /*6.1*/ HB_SCRIPT_MEROITIC_HIEROGLYPHS = HB_TAG ('M','e','r','o'),
      /*6.1*/ HB_SCRIPT_MIAO			= HB_TAG ('P','l','r','d'),
      /*6.1*/ HB_SCRIPT_SHARADA			= HB_TAG ('S','h','r','d'),
      /*6.1*/ HB_SCRIPT_SORA_SOMPENG		= HB_TAG ('S','o','r','a'),
      /*6.1*/ HB_SCRIPT_TAKRI			= HB_TAG ('T','a','k','r'),

      /* No script set. */
      /*---*/ HB_SCRIPT_INVALID			= HB_TAG_NONE,

      /* Dummy value to ensure any hb_tag_t value can be passed/stored as hb_script_t
       * without risking undefined behavior. */
      /*---*/ _HB_SCRIPT_MAX_VALUE			= HB_TAG_MAX
    } hb_script_t;

`HB_SCRIPT_COMMON` |
`HB_SCRIPT_INHERITED` |
`HB_SCRIPT_UNKNOWN` |
`HB_SCRIPT_ARABIC` |
`HB_SCRIPT_ARMENIAN` |
`HB_SCRIPT_BENGALI` |
`HB_SCRIPT_CYRILLIC` |
`HB_SCRIPT_DEVANAGARI` |
`HB_SCRIPT_GEORGIAN` |
`HB_SCRIPT_GREEK` |
`HB_SCRIPT_GUJARATI` |
`HB_SCRIPT_GURMUKHI` |
`HB_SCRIPT_HANGUL` |
`HB_SCRIPT_HAN` |
`HB_SCRIPT_HEBREW` |
`HB_SCRIPT_HIRAGANA` |
`HB_SCRIPT_KANNADA` |
`HB_SCRIPT_KATAKANA` |
`HB_SCRIPT_LAO` |
`HB_SCRIPT_LATIN` |
`HB_SCRIPT_MALAYALAM` |
`HB_SCRIPT_ORIYA` |
`HB_SCRIPT_TAMIL` |
`HB_SCRIPT_TELUGU` |
`HB_SCRIPT_THAI` |
`HB_SCRIPT_TIBETAN` |
`HB_SCRIPT_BOPOMOFO` |
`HB_SCRIPT_BRAILLE` |
`HB_SCRIPT_CANADIAN_SYLLABICS` |
`HB_SCRIPT_CHEROKEE` |
`HB_SCRIPT_ETHIOPIC` |
`HB_SCRIPT_KHMER` |
`HB_SCRIPT_MONGOLIAN` |
`HB_SCRIPT_MYANMAR` |
`HB_SCRIPT_OGHAM` |
`HB_SCRIPT_RUNIC` |
`HB_SCRIPT_SINHALA` |
`HB_SCRIPT_SYRIAC` |
`HB_SCRIPT_THAANA` |
`HB_SCRIPT_YI` |
`HB_SCRIPT_DESERET` |
`HB_SCRIPT_GOTHIC` |
`HB_SCRIPT_OLD_ITALIC` |
`HB_SCRIPT_BUHID` |
`HB_SCRIPT_HANUNOO` |
`HB_SCRIPT_TAGALOG` |
`HB_SCRIPT_TAGBANWA` |
`HB_SCRIPT_CYPRIOT` |
`HB_SCRIPT_LIMBU` |
`HB_SCRIPT_LINEAR_B` |
`HB_SCRIPT_OSMANYA` |
`HB_SCRIPT_SHAVIAN` |
`HB_SCRIPT_TAI_LE` |
`HB_SCRIPT_UGARITIC` |
`HB_SCRIPT_BUGINESE` |
`HB_SCRIPT_COPTIC` |
`HB_SCRIPT_GLAGOLITIC` |
`HB_SCRIPT_KHAROSHTHI` |
`HB_SCRIPT_NEW_TAI_LUE` |
`HB_SCRIPT_OLD_PERSIAN` |
`HB_SCRIPT_SYLOTI_NAGRI` |
`HB_SCRIPT_TIFINAGH` |
`HB_SCRIPT_BALINESE` |
`HB_SCRIPT_CUNEIFORM` |
`HB_SCRIPT_NKO` |
`HB_SCRIPT_PHAGS_PA` |
`HB_SCRIPT_PHOENICIAN` |
`HB_SCRIPT_CARIAN` |
`HB_SCRIPT_CHAM` |
`HB_SCRIPT_KAYAH_LI` |
`HB_SCRIPT_LEPCHA` |
`HB_SCRIPT_LYCIAN` |
`HB_SCRIPT_LYDIAN` |
`HB_SCRIPT_OL_CHIKI` |
`HB_SCRIPT_REJANG` |
`HB_SCRIPT_SAURASHTRA` |
`HB_SCRIPT_SUNDANESE` |
`HB_SCRIPT_VAI` |
`HB_SCRIPT_AVESTAN` |
`HB_SCRIPT_BAMUM` |
`HB_SCRIPT_EGYPTIAN_HIEROGLYPHS` |
`HB_SCRIPT_IMPERIAL_ARAMAIC` |
`HB_SCRIPT_INSCRIPTIONAL_PAHLAVI` |
`HB_SCRIPT_INSCRIPTIONAL_PARTHIAN` |
`HB_SCRIPT_JAVANESE` |
`HB_SCRIPT_KAITHI` |
`HB_SCRIPT_LISU` |
`HB_SCRIPT_MEETEI_MAYEK` |
`HB_SCRIPT_OLD_SOUTH_ARABIAN` |
`HB_SCRIPT_OLD_TURKIC` |
`HB_SCRIPT_SAMARITAN` |
`HB_SCRIPT_TAI_THAM` |
`HB_SCRIPT_TAI_VIET` |
`HB_SCRIPT_BATAK` |
`HB_SCRIPT_BRAHMI` |
`HB_SCRIPT_MANDAIC` |
`HB_SCRIPT_CHAKMA` |
`HB_SCRIPT_MEROITIC_CURSIVE` |
`HB_SCRIPT_MEROITIC_HIEROGLYPHS` |
`HB_SCRIPT_MIAO` |
`HB_SCRIPT_SHARADA` |
`HB_SCRIPT_SORA_SOMPENG` |
`HB_SCRIPT_TAKRI` |
`HB_SCRIPT_INVALID` |
`_HB_SCRIPT_MAX_VALUE` |

### hb_script_to_iso15924_tag ()

    hb_tag_t            hb_script_to_iso15924_tag           (hb_script_t script);

Since 1.0

### hb_tag_from_string ()

    hb_tag_t            hb_tag_from_string                  (const char *str,
                                                             int len);

`str` : | . [array length=len]

Since 1.0

### hb_tag_t

    typedef uint32_t hb_tag_t;

### hb_tag_to_string ()

    void                hb_tag_to_string                    (hb_tag_t tag,
                                                             char *buf);

`buf` : | . [array fixed-size=4]

Since 1.0

### hb_user_data_key_t

    typedef struct {
    } hb_user_data_key_t;

### hb_var_int_t

    typedef union _hb_var_int_t {
      uint32_t u32;
      int32_t i32;
      uint16_t u16[2];
      int16_t i16[2];
      uint8_t u8[4];
      int8_t i8[4];
    } hb_var_int_t;

### HB_DIRECTION_IS_BACKWARD()

    #define HB_DIRECTION_IS_BACKWARD(dir) ((((unsigned int) (dir)) & ~2U) == 5)

### HB_DIRECTION_IS_FORWARD()

    #define HB_DIRECTION_IS_FORWARD(dir) ((((unsigned int) (dir)) & ~2U) == 4)

### HB_DIRECTION_IS_HORIZONTAL()

    #define HB_DIRECTION_IS_HORIZONTAL(dir) ((((unsigned int) (dir)) & ~1U) == 4)

### HB_DIRECTION_IS_VALID()

    #define HB_DIRECTION_IS_VALID(dir) ((((unsigned int) (dir)) & ~3U) == 4)

### HB_DIRECTION_IS_VERTICAL()

    #define HB_DIRECTION_IS_VERTICAL(dir) ((((unsigned int) (dir)) & ~1U) == 6)