added license comments
[framework/uifw/harfbuzz.git] / harfbuzz-0.1 / include / harfbuzz-global.h
1 /*
2  * Copyright (C) 2008 Nokia Corporation and/or its subsidiary(-ies)
3  * Copyright (C) 2007  Red Hat, Inc.
4  *
5  * This is part of HarfBuzz, an OpenType Layout engine library.
6  *
7  * Permission is hereby granted, without written agreement and without
8  * license or royalty fees, to use, copy, modify, and distribute this
9  * software and its documentation for any purpose, provided that the
10  * above copyright notice and the following two paragraphs appear in
11  * all copies of this software.
12  *
13  * IN NO EVENT SHALL THE COPYRIGHT HOLDER BE LIABLE TO ANY PARTY FOR
14  * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
15  * ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN
16  * IF THE COPYRIGHT HOLDER HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH
17  * DAMAGE.
18  *
19  * THE COPYRIGHT HOLDER SPECIFICALLY DISCLAIMS ANY WARRANTIES, INCLUDING,
20  * BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
21  * FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
22  * ON AN "AS IS" BASIS, AND THE COPYRIGHT HOLDER HAS NO OBLIGATION TO
23  * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
24  *
25  */
26
27 #ifndef HARFBUZZ_GLOBAL_H
28 #define HARFBUZZ_GLOBAL_H
29
30 #include <stdlib.h>
31 #include <string.h>
32
33 #ifdef __cplusplus
34 #define HB_BEGIN_HEADER  extern "C" {
35 #define HB_END_HEADER  }
36 #else
37 #define HB_BEGIN_HEADER  /* nothing */
38 #define HB_END_HEADER  /* nothing */
39 #endif
40
41 HB_BEGIN_HEADER
42
43 #ifndef FALSE
44 #define FALSE 0
45 #endif
46
47 #ifndef TRUE
48 #define TRUE (!FALSE)
49 #endif
50
51 #ifndef false
52 #define false 0
53 #endif
54
55 #ifndef true
56 #define true (!FALSE)
57 #endif
58
59 #define HB_MAKE_TAG( _x1, _x2, _x3, _x4 ) \
60           ( ( (HB_UInt)_x1 << 24 ) |     \
61             ( (HB_UInt)_x2 << 16 ) |     \
62             ( (HB_UInt)_x3 <<  8 ) |     \
63               (HB_UInt)_x4         )
64
65 typedef char hb_int8;
66 typedef unsigned char hb_uint8;
67 typedef short hb_int16;
68 typedef unsigned short hb_uint16;
69 typedef int hb_int32;
70 typedef unsigned int hb_uint32;
71
72 typedef hb_uint8 HB_Bool;
73 typedef hb_uint8 bool;
74
75 typedef hb_uint8 HB_Byte;
76 typedef hb_uint16 HB_UShort;
77 typedef hb_uint32 HB_UInt;
78 typedef hb_int8 HB_Char;
79 typedef hb_int16 HB_Short;
80 typedef hb_int32 HB_Int;
81
82 typedef hb_uint16 HB_UChar16;
83 typedef hb_uint32 HB_UChar32;
84 typedef hb_uint32 HB_Glyph;
85 typedef hb_int32 HB_Fixed; /* 26.6 */
86
87 #define HB_FIXED_CONSTANT(v) ((v) * 64)
88 #define HB_FIXED_ROUND(v) (((v)+32) & -64)
89
90 typedef hb_int32 HB_16Dot16; /* 16.16 */
91
92 typedef void * HB_Pointer;
93 typedef hb_uint32 HB_Tag;
94
95 typedef enum {
96   /* no error */
97   HB_Err_Ok                           = 0x0000,
98   HB_Err_Not_Covered                  = 0xFFFF,
99
100   /* _hb_err() is called whenever returning the following errors,
101    * and in a couple places for HB_Err_Not_Covered too. */
102
103   /* programmer error */
104   HB_Err_Invalid_Argument             = 0x1A66,
105
106   /* font error */
107   HB_Err_Invalid_SubTable_Format      = 0x157F,
108   HB_Err_Invalid_SubTable             = 0x1570,
109   HB_Err_Read_Error                   = 0x6EAD,
110
111   /* system error */
112   HB_Err_Out_Of_Memory                = 0xDEAD
113 } HB_Error;
114
115 typedef struct {
116     HB_Fixed x;
117     HB_Fixed y;
118 } HB_FixedPoint;
119
120 typedef struct HB_Font_ *HB_Font;
121 typedef struct HB_StreamRec_ *HB_Stream;
122 typedef struct HB_FaceRec_ *HB_Face;
123
124 HB_END_HEADER
125
126 #endif