1 /****************************************************************************
2  *
3  * ftwinfnt.h
4  *
5  *   FreeType API for accessing Windows fnt-specific data.
6  *
7  * Copyright (C) 2003-2019 by
8  * David Turner, Robert Wilhelm, and Werner Lemberg.
9  *
10  * This file is part of the FreeType project, and may only be used,
11  * modified, and distributed under the terms of the FreeType project
12  * license, LICENSE.TXT.  By continuing to use, modify, or distribute
13  * this file you indicate that you have read the license and
14  * understand and accept it fully.
15  *
16  */
17 
18 
19 #ifndef FTWINFNT_H_
20 #define FTWINFNT_H_
21 
22 #include <ft2build.h>
23 #include FT_FREETYPE_H
24 
25 #ifdef FREETYPE_H
26 #error "freetype.h of FreeType 1 has been loaded!"
27 #error "Please fix the directory search order for header files"
28 #error "so that freetype.h of FreeType 2 is found first."
29 #endif
30 
31 
32 FT_BEGIN_HEADER
33 
34 
35   /**************************************************************************
36    *
37    * @section:
38    *   winfnt_fonts
39    *
40    * @title:
41    *   Window FNT Files
42    *
43    * @abstract:
44    *   Windows FNT-specific API.
45    *
46    * @description:
47    *   This section contains the declaration of Windows FNT-specific
48    *   functions.
49    *
50    */
51 
52 
53   /**************************************************************************
54    *
55    * @enum:
56    *   FT_WinFNT_ID_XXX
57    *
58    * @description:
59    *   A list of valid values for the `charset` byte in @FT_WinFNT_HeaderRec.
60    *   Exact mapping tables for the various 'cpXXXX' encodings (except for
61    *   'cp1361') can be found at 'ftp://ftp.unicode.org/Public/' in the
62    *   `MAPPINGS/VENDORS/MICSFT/WINDOWS` subdirectory.  'cp1361' is roughly a
63    *   superset of `MAPPINGS/OBSOLETE/EASTASIA/KSC/JOHAB.TXT`.
64    *
65    * @values:
66    *   FT_WinFNT_ID_DEFAULT ::
67    *     This is used for font enumeration and font creation as a 'don't
68    *     care' value.  Valid font files don't contain this value.  When
69    *     querying for information about the character set of the font that is
70    *     currently selected into a specified device context, this return
71    *     value (of the related Windows API) simply denotes failure.
72    *
73    *   FT_WinFNT_ID_SYMBOL ::
74    *     There is no known mapping table available.
75    *
76    *   FT_WinFNT_ID_MAC ::
77    *     Mac Roman encoding.
78    *
79    *   FT_WinFNT_ID_OEM ::
80    *     From Michael Poettgen <michael@poettgen.de>:
81    *
82    *     The 'Windows Font Mapping' article says that `FT_WinFNT_ID_OEM` is
83    *     used for the charset of vector fonts, like `modern.fon`,
84    *     `roman.fon`, and `script.fon` on Windows.
85    *
86    *     The 'CreateFont' documentation says: The `FT_WinFNT_ID_OEM` value
87    *     specifies a character set that is operating-system dependent.
88    *
89    *     The 'IFIMETRICS' documentation from the 'Windows Driver Development
90    *     Kit' says: This font supports an OEM-specific character set.  The
91    *     OEM character set is system dependent.
92    *
93    *     In general OEM, as opposed to ANSI (i.e., 'cp1252'), denotes the
94    *     second default codepage that most international versions of Windows
95    *     have.  It is one of the OEM codepages from
96    *
97    *     https://docs.microsoft.com/en-us/windows/desktop/intl/code-page-identifiers
98    *     ,
99    *
100    *     and is used for the 'DOS boxes', to support legacy applications.  A
101    *     German Windows version for example usually uses ANSI codepage 1252
102    *     and OEM codepage 850.
103    *
104    *   FT_WinFNT_ID_CP874 ::
105    *     A superset of Thai TIS 620 and ISO 8859-11.
106    *
107    *   FT_WinFNT_ID_CP932 ::
108    *     A superset of Japanese Shift-JIS (with minor deviations).
109    *
110    *   FT_WinFNT_ID_CP936 ::
111    *     A superset of simplified Chinese GB 2312-1980 (with different
112    *     ordering and minor deviations).
113    *
114    *   FT_WinFNT_ID_CP949 ::
115    *     A superset of Korean Hangul KS~C 5601-1987 (with different ordering
116    *     and minor deviations).
117    *
118    *   FT_WinFNT_ID_CP950 ::
119    *     A superset of traditional Chinese Big~5 ETen (with different
120    *     ordering and minor deviations).
121    *
122    *   FT_WinFNT_ID_CP1250 ::
123    *     A superset of East European ISO 8859-2 (with slightly different
124    *     ordering).
125    *
126    *   FT_WinFNT_ID_CP1251 ::
127    *     A superset of Russian ISO 8859-5 (with different ordering).
128    *
129    *   FT_WinFNT_ID_CP1252 ::
130    *     ANSI encoding.  A superset of ISO 8859-1.
131    *
132    *   FT_WinFNT_ID_CP1253 ::
133    *     A superset of Greek ISO 8859-7 (with minor modifications).
134    *
135    *   FT_WinFNT_ID_CP1254 ::
136    *     A superset of Turkish ISO 8859-9.
137    *
138    *   FT_WinFNT_ID_CP1255 ::
139    *     A superset of Hebrew ISO 8859-8 (with some modifications).
140    *
141    *   FT_WinFNT_ID_CP1256 ::
142    *     A superset of Arabic ISO 8859-6 (with different ordering).
143    *
144    *   FT_WinFNT_ID_CP1257 ::
145    *     A superset of Baltic ISO 8859-13 (with some deviations).
146    *
147    *   FT_WinFNT_ID_CP1258 ::
148    *     For Vietnamese.  This encoding doesn't cover all necessary
149    *     characters.
150    *
151    *   FT_WinFNT_ID_CP1361 ::
152    *     Korean (Johab).
153    */
154 
155 #define FT_WinFNT_ID_CP1252    0
156 #define FT_WinFNT_ID_DEFAULT   1
157 #define FT_WinFNT_ID_SYMBOL    2
158 #define FT_WinFNT_ID_MAC      77
159 #define FT_WinFNT_ID_CP932   128
160 #define FT_WinFNT_ID_CP949   129
161 #define FT_WinFNT_ID_CP1361  130
162 #define FT_WinFNT_ID_CP936   134
163 #define FT_WinFNT_ID_CP950   136
164 #define FT_WinFNT_ID_CP1253  161
165 #define FT_WinFNT_ID_CP1254  162
166 #define FT_WinFNT_ID_CP1258  163
167 #define FT_WinFNT_ID_CP1255  177
168 #define FT_WinFNT_ID_CP1256  178
169 #define FT_WinFNT_ID_CP1257  186
170 #define FT_WinFNT_ID_CP1251  204
171 #define FT_WinFNT_ID_CP874   222
172 #define FT_WinFNT_ID_CP1250  238
173 #define FT_WinFNT_ID_OEM     255
174 
175 
176   /**************************************************************************
177    *
178    * @struct:
179    *   FT_WinFNT_HeaderRec
180    *
181    * @description:
182    *   Windows FNT Header info.
183    */
184   typedef struct  FT_WinFNT_HeaderRec_
185   {
186     FT_UShort  version;
187     FT_ULong   file_size;
188     FT_Byte    copyright[60];
189     FT_UShort  file_type;
190     FT_UShort  nominal_point_size;
191     FT_UShort  vertical_resolution;
192     FT_UShort  horizontal_resolution;
193     FT_UShort  ascent;
194     FT_UShort  internal_leading;
195     FT_UShort  external_leading;
196     FT_Byte    italic;
197     FT_Byte    underline;
198     FT_Byte    strike_out;
199     FT_UShort  weight;
200     FT_Byte    charset;
201     FT_UShort  pixel_width;
202     FT_UShort  pixel_height;
203     FT_Byte    pitch_and_family;
204     FT_UShort  avg_width;
205     FT_UShort  max_width;
206     FT_Byte    first_char;
207     FT_Byte    last_char;
208     FT_Byte    default_char;
209     FT_Byte    break_char;
210     FT_UShort  bytes_per_row;
211     FT_ULong   device_offset;
212     FT_ULong   face_name_offset;
213     FT_ULong   bits_pointer;
214     FT_ULong   bits_offset;
215     FT_Byte    reserved;
216     FT_ULong   flags;
217     FT_UShort  A_space;
218     FT_UShort  B_space;
219     FT_UShort  C_space;
220     FT_UShort  color_table_offset;
221     FT_ULong   reserved1[4];
222 
223   } FT_WinFNT_HeaderRec;
224 
225 
226   /**************************************************************************
227    *
228    * @struct:
229    *   FT_WinFNT_Header
230    *
231    * @description:
232    *   A handle to an @FT_WinFNT_HeaderRec structure.
233    */
234   typedef struct FT_WinFNT_HeaderRec_*  FT_WinFNT_Header;
235 
236 
237   /**************************************************************************
238    *
239    * @function:
240    *    FT_Get_WinFNT_Header
241    *
242    * @description:
243    *    Retrieve a Windows FNT font info header.
244    *
245    * @input:
246    *    face ::
247    *      A handle to the input face.
248    *
249    * @output:
250    *    aheader ::
251    *      The WinFNT header.
252    *
253    * @return:
254    *   FreeType error code.  0~means success.
255    *
256    * @note:
257    *   This function only works with Windows FNT faces, returning an error
258    *   otherwise.
259    */
260   FT_EXPORT( FT_Error )
261   FT_Get_WinFNT_Header( FT_Face               face,
262                         FT_WinFNT_HeaderRec  *aheader );
263 
264   /* */
265 
266 
267 FT_END_HEADER
268 
269 #endif /* FTWINFNT_H_ */
270 
271 
272 /* END */
273 
274 
275 /* Local Variables: */
276 /* coding: utf-8    */
277 /* End:             */
278