13ec15fd8577ce4f15239f0c7fab2b04fd3d204a
[platform/upstream/harfbuzz.git] / src / hb-old / harfbuzz-external.h
1 /*
2  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
3  *
4  * This is part of HarfBuzz, an OpenType Layout engine 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 HARFBUZZ_EXTERNAL_H
26 #define HARFBUZZ_EXTERNAL_H
27
28 #define HB_H_IN
29 #include <hb-unicode.h>
30 #include "harfbuzz-global.h"
31
32 HB_BEGIN_HEADER
33
34 /* This header contains some methods that are not part of
35    Harfbuzz itself, but referenced by it.
36    They need to be provided by the application/library
37 */
38
39
40 typedef enum 
41 {
42     HB_Mark_NonSpacing          = HB_UNICODE_GENERAL_CATEGORY_NON_SPACING_MARK,         /* Mn */
43     HB_Mark_SpacingCombining    = HB_UNICODE_GENERAL_CATEGORY_SPACING_MARK,             /* Mc */
44     HB_Mark_Enclosing           = HB_UNICODE_GENERAL_CATEGORY_ENCLOSING_MARK,           /* Me */
45
46     HB_Number_DecimalDigit      = HB_UNICODE_GENERAL_CATEGORY_DECIMAL_NUMBER,           /* Nd */
47     HB_Number_Letter            = HB_UNICODE_GENERAL_CATEGORY_LETTER_NUMBER,            /* Nl */
48     HB_Number_Other             = HB_UNICODE_GENERAL_CATEGORY_OTHER_NUMBER,             /* No */
49
50     HB_Separator_Space          = HB_UNICODE_GENERAL_CATEGORY_SPACE_SEPARATOR,          /* Zs */
51     HB_Separator_Line           = HB_UNICODE_GENERAL_CATEGORY_LINE_SEPARATOR,           /* Zl */
52     HB_Separator_Paragraph      = HB_UNICODE_GENERAL_CATEGORY_PARAGRAPH_SEPARATOR,      /* Zp */
53
54     HB_Other_Control            = HB_UNICODE_GENERAL_CATEGORY_CONTROL,                  /* Cc */
55     HB_Other_Format             = HB_UNICODE_GENERAL_CATEGORY_FORMAT,                   /* Cf */
56     HB_Other_Surrogate          = HB_UNICODE_GENERAL_CATEGORY_SURROGATE,                /* Cs */
57     HB_Other_PrivateUse         = HB_UNICODE_GENERAL_CATEGORY_PRIVATE_USE,              /* Co */
58     HB_Other_NotAssigned        = HB_UNICODE_GENERAL_CATEGORY_UNASSIGNED,               /* Cn */
59
60     HB_Letter_Uppercase         = HB_UNICODE_GENERAL_CATEGORY_UPPERCASE_LETTER,         /* Lu */
61     HB_Letter_Lowercase         = HB_UNICODE_GENERAL_CATEGORY_LOWERCASE_LETTER,         /* Ll */
62     HB_Letter_Titlecase         = HB_UNICODE_GENERAL_CATEGORY_TITLECASE_LETTER,         /* Lt */
63     HB_Letter_Modifier          = HB_UNICODE_GENERAL_CATEGORY_MODIFIER_LETTER,          /* Lm */
64     HB_Letter_Other             = HB_UNICODE_GENERAL_CATEGORY_OTHER_LETTER,             /* Lo */
65
66     HB_Punctuation_Connector    = HB_UNICODE_GENERAL_CATEGORY_CONNECT_PUNCTUATION,      /* Pc */
67     HB_Punctuation_Dash         = HB_UNICODE_GENERAL_CATEGORY_DASH_PUNCTUATION,         /* Pd */
68     HB_Punctuation_Open         = HB_UNICODE_GENERAL_CATEGORY_OPEN_PUNCTUATION,         /* Ps */
69     HB_Punctuation_Close        = HB_UNICODE_GENERAL_CATEGORY_CLOSE_PUNCTUATION,        /* Pe */
70     HB_Punctuation_InitialQuote = HB_UNICODE_GENERAL_CATEGORY_INITIAL_PUNCTUATION,      /* Pi */
71     HB_Punctuation_FinalQuote   = HB_UNICODE_GENERAL_CATEGORY_FINAL_PUNCTUATION,        /* Pf */
72     HB_Punctuation_Other        = HB_UNICODE_GENERAL_CATEGORY_OTHER_PUNCTUATION,        /* Po */
73
74     HB_Symbol_Math              = HB_UNICODE_GENERAL_CATEGORY_MATH_SYMBOL,              /* Sm */
75     HB_Symbol_Currency          = HB_UNICODE_GENERAL_CATEGORY_CURRENCY_SYMBOL,          /* Sc */
76     HB_Symbol_Modifier          = HB_UNICODE_GENERAL_CATEGORY_MODIFIER_SYMBOL,          /* Sk */
77     HB_Symbol_Other             = HB_UNICODE_GENERAL_CATEGORY_OTHER_SYMBOL              /* So */
78 } HB_CharCategory;
79
80
81 static inline HB_CharCategory HB_GetUnicodeCharCategory(HB_UChar32 ch)
82 {
83   return (HB_CharCategory) hb_unicode_general_category (hb_unicode_funcs_get_default (), ch);
84 }
85
86 static inline int HB_GetUnicodeCharCombiningClass(HB_UChar32 ch)
87 {
88   return hb_unicode_combining_class (hb_unicode_funcs_get_default (), ch);
89 }
90
91 static inline HB_UChar16 HB_GetMirroredChar(HB_UChar16 ch)
92 {
93   return hb_unicode_mirroring (hb_unicode_funcs_get_default (), ch);
94 }
95
96 static inline void HB_GetUnicodeCharProperties(HB_UChar32 ch, HB_CharCategory *category, int *combiningClass)
97 {
98   if (category)
99     *category = HB_GetUnicodeCharCategory (ch);
100   if (combiningClass)
101     *combiningClass = HB_GetUnicodeCharCombiningClass (ch);
102 }
103
104 HB_END_HEADER
105
106 #endif