Merge to XFA: Fix ALL the include guards.
[pdfium.git] / core / include / fxge / fx_font.h
1 // Copyright 2014 PDFium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
4  
5 // Original code copyright 2014 Foxit Software Inc. http://www.foxitsoftware.com
6
7 #ifndef CORE_INCLUDE_FXGE_FX_FONT_H_
8 #define CORE_INCLUDE_FXGE_FX_FONT_H_
9
10 #include "../fxcrt/fx_ext.h"
11 #include "fx_dib.h"
12
13 typedef struct FT_FaceRec_* FXFT_Face;
14 typedef void* FXFT_Library;
15 class IFX_FontEncoding;
16 class CFX_PathData;
17 class CFX_SubstFont;
18 class CFX_FaceCache;
19 class IFX_FontMapper;
20 class CFX_FontMapper;
21 class IFX_SystemFontInfo;
22 class CFontFileFaceInfo;
23 #define FXFONT_FIXED_PITCH              0x01
24 #define FXFONT_SERIF                    0x02
25 #define FXFONT_SYMBOLIC                 0x04
26 #define FXFONT_SCRIPT                   0x08
27 #define FXFONT_ITALIC                   0x40
28 #define FXFONT_BOLD                             0x40000
29 #define FXFONT_USEEXTERNATTR    0x80000
30 #define FXFONT_EXACTMATCH               0x80000000\r
31 #define FXFONT_CIDFONT                  0x100000
32 #define FXFONT_ANSI_CHARSET             0
33 #define FXFONT_DEFAULT_CHARSET  1
34 #define FXFONT_SYMBOL_CHARSET   2
35 #define FXFONT_SHIFTJIS_CHARSET 128
36 #define FXFONT_HANGEUL_CHARSET  129
37 #define FXFONT_GB2312_CHARSET   134
38 #define FXFONT_CHINESEBIG5_CHARSET      136
39 #define FXFONT_THAI_CHARSET             222
40 #define FXFONT_EASTEUROPE_CHARSET       238
41 #define FXFONT_RUSSIAN_CHARSET  204
42 #define FXFONT_GREEK_CHARSET    161
43 #define FXFONT_TURKISH_CHARSET  162
44 #define FXFONT_HEBREW_CHARSET   177
45 #define FXFONT_ARABIC_CHARSET   178
46 #define FXFONT_BALTIC_CHARSET   186
47 #define FXFONT_FF_FIXEDPITCH    1
48 #define FXFONT_FF_ROMAN                 (1<<4)
49 #define FXFONT_FF_SCRIPT                (4<<4)
50 #define FXFONT_FW_NORMAL                400
51 #define FXFONT_FW_BOLD                  700
52 class CFX_Font 
53 {
54 public:
55     CFX_Font();
56     ~CFX_Font();
57
58     FX_BOOL                                     LoadSubst(const CFX_ByteString& face_name, FX_BOOL bTrueType, FX_DWORD flags,
59                                       int weight, int italic_angle, int CharsetCP, FX_BOOL bVertical = FALSE);
60
61     FX_BOOL                                     LoadEmbedded(FX_LPCBYTE data, FX_DWORD size);
62
63         FX_BOOL                                 LoadFile(IFX_FileRead* pFile, int nFaceIndex = 0, int* pFaceCount = NULL);\r
64 \r
65     FX_BOOL                 LoadClone(const CFX_Font* pFont);\r
66 \r
67
68     FXFT_Face                           GetFace() const
69     {
70         return m_Face;
71     }
72
73
74     const CFX_SubstFont*        GetSubstFont() const
75     {
76         return m_pSubstFont;
77     }
78
79     CFX_PathData*                       LoadGlyphPath(FX_DWORD glyph_index, int dest_width = 0);
80
81     int                                         GetGlyphWidth(FX_DWORD glyph_index);
82
83     int                                         GetAscent() const;
84
85     int                                         GetDescent() const;
86
87     FX_BOOL                 GetGlyphBBox(FX_DWORD glyph_index, FX_RECT &bbox);
88
89     FX_BOOL                 IsItalic();
90
91     FX_BOOL                 IsBold();
92
93     FX_BOOL                 IsFixedWidth();
94
95     FX_BOOL                                     IsVertical() const
96     {
97         return m_bVertical;
98     }
99
100     CFX_WideString          GetPsName() const;
101
102
103     CFX_ByteString          GetFamilyName() const;
104
105     CFX_ByteString          GetFaceName() const;
106
107
108     FX_BOOL                 IsTTFont();
109
110     FX_BOOL                 GetBBox(FX_RECT &bbox);
111
112     int                     GetHeight();
113
114     int                     GetULPos();
115
116     int                     GetULthickness();
117
118     int                     GetMaxAdvanceWidth();
119
120     FXFT_Face                           m_Face;
121
122     CFX_SubstFont*                      m_pSubstFont;
123     FX_BOOL                                     IsEmbedded()
124     {
125         return m_bEmbedded;
126     }
127
128     void                                        AdjustMMParams(int glyph_index, int width, int weight);
129     FX_LPBYTE                           m_pFontDataAllocation;
130     FX_LPBYTE               m_pFontData;
131     FX_LPBYTE                           m_pGsubData;
132     FX_DWORD                m_dwSize;
133     CFX_BinaryBuf           m_OtfFontData;
134     void*                   m_hHandle;
135     void*                   m_pPlatformFont;
136     void*                   m_pPlatformFontCollection;
137     void*                   m_pDwFont;
138     FX_BOOL                 m_bDwLoaded;
139     void                    ReleasePlatformResource();
140
141     void                                        DeleteFace();
142 protected:
143
144     FX_BOOL                                     m_bEmbedded;
145     FX_BOOL                                     m_bVertical;
146     FX_BOOL                 m_bLogic;\r
147     void*                                       m_pOwnedStream;
148 };
149 #define ENCODING_INTERNAL               0
150 #define ENCODING_UNICODE                1
151 class IFX_FontEncoding 
152 {
153 public:
154     virtual ~IFX_FontEncoding() {}
155
156     virtual FX_DWORD            GlyphFromCharCode(FX_DWORD charcode) = 0;
157
158     virtual CFX_WideString      UnicodeFromCharCode(FX_DWORD charcode) const = 0;
159
160     virtual FX_DWORD            CharCodeFromUnicode(FX_WCHAR Unicode) const = 0;
161 };
162 IFX_FontEncoding* FXGE_CreateUnicodeEncoding(CFX_Font* pFont);
163 #define FXFM_ENC_TAG(a, b, c, d) (((FX_DWORD)(a) << 24) | ((FX_DWORD)(b) << 16) | ((FX_DWORD)(c) << 8) | (FX_DWORD)(d))\r
164 #define FXFM_ENCODING_NONE                              FXFM_ENC_TAG(0, 0, 0, 0)\r
165 #define FXFM_ENCODING_MS_SYMBOL                 FXFM_ENC_TAG('s', 'y', 'm', 'b')\r
166 #define FXFM_ENCODING_UNICODE                   FXFM_ENC_TAG('u', 'n', 'i', 'c')\r
167 #define FXFM_ENCODING_MS_SJIS                   FXFM_ENC_TAG('s', 'j', 'i', 's')\r
168 #define FXFM_ENCODING_MS_GB2312                 FXFM_ENC_TAG('g', 'b', ' ', ' ')\r
169 #define FXFM_ENCODING_MS_BIG5                   FXFM_ENC_TAG('b', 'i', 'g', '5')\r
170 #define FXFM_ENCODING_MS_WANSUNG                FXFM_ENC_TAG('w', 'a', 'n', 's')\r
171 #define FXFM_ENCODING_MS_JOHAB                  FXFM_ENC_TAG('j', 'o', 'h', 'a')\r
172 #define FXFM_ENCODING_ADOBE_STANDARD    FXFM_ENC_TAG('A', 'D', 'O', 'B')\r
173 #define FXFM_ENCODING_ADOBE_EXPERT              FXFM_ENC_TAG('A', 'D', 'B', 'E')\r
174 #define FXFM_ENCODING_ADOBE_CUSTOM              FXFM_ENC_TAG('A', 'D', 'B', 'C')\r
175 #define FXFM_ENCODING_ADOBE_LATIN_1             FXFM_ENC_TAG('l', 'a', 't', '1')\r
176 #define FXFM_ENCODING_OLD_LATIN_2               FXFM_ENC_TAG('l', 'a', 't', '2')\r
177 #define FXFM_ENCODING_APPLE_ROMAN               FXFM_ENC_TAG('a', 'r', 'm', 'n')\r
178 class IFX_FontEncodingEx : public IFX_FontEncoding\r
179 {\r
180 public:\r
181 \r
182     virtual FX_DWORD            GlyphIndexFromName(FX_LPCSTR pStrName) = 0;\r
183 \r
184     virtual CFX_ByteString      NameFromGlyphIndex(FX_DWORD dwGlyphIndex) = 0;\r
185 \r
186     virtual FX_DWORD            CharCodeFromGlyphIndex(FX_DWORD dwGlyphIndex) = 0;\r
187 };\r
188 IFX_FontEncodingEx*     FX_CreateFontEncodingEx(CFX_Font* pFont, FX_DWORD nEncodingID = FXFM_ENCODING_NONE);\r
189 #define FXFONT_SUBST_MM                         0x01
190 #define FXFONT_SUBST_GLYPHPATH          0x04
191 #define FXFONT_SUBST_CLEARTYPE          0x08
192 #define FXFONT_SUBST_TRANSFORM          0x10
193 #define FXFONT_SUBST_NONSYMBOL          0x20
194 #define FXFONT_SUBST_EXACT                      0x40
195 #define FXFONT_SUBST_STANDARD           0x80
196 class CFX_SubstFont 
197 {
198 public:
199
200     CFX_SubstFont();
201
202     FX_LPVOID                           m_ExtHandle;
203
204     CFX_ByteString                      m_Family;
205
206     int                                         m_Charset;
207
208     FX_DWORD                            m_SubstFlags;
209
210     int                                         m_Weight;
211
212     int                                         m_ItalicAngle;
213
214     FX_BOOL                                     m_bSubstOfCJK;
215
216     int                                         m_WeightCJK;
217
218     FX_BOOL                                     m_bItlicCJK;
219 };
220 #define FX_FONT_FLAG_SERIF              0x01
221 #define FX_FONT_FLAG_FIXEDPITCH                 0x02
222 #define FX_FONT_FLAG_ITALIC                             0x04
223 #define FX_FONT_FLAG_BOLD                               0x08
224 #define FX_FONT_FLAG_SYMBOLIC_SYMBOL    0x10
225 #define FX_FONT_FLAG_SYMBOLIC_DINGBATS  0x20
226 #define FX_FONT_FLAG_MULTIPLEMASTER             0x40
227 typedef struct {
228     FX_LPCBYTE  m_pFontData;
229     FX_DWORD    m_dwSize;
230 } FoxitFonts;
231 class CFX_FontMgr 
232 {
233 public:
234     CFX_FontMgr();
235     ~CFX_FontMgr();
236     void                        InitFTLibrary();
237     FXFT_Face           GetCachedFace(const CFX_ByteString& face_name,
238                                   int weight, FX_BOOL bItalic, FX_LPBYTE& pFontData);
239     FXFT_Face           AddCachedFace(const CFX_ByteString& face_name,
240                                   int weight, FX_BOOL bItalic, FX_LPBYTE pData, FX_DWORD size, int face_index);
241     FXFT_Face           GetCachedTTCFace(int ttc_size, FX_DWORD checksum,
242                                      int font_offset, FX_LPBYTE& pFontData);
243     FXFT_Face           AddCachedTTCFace(int ttc_size, FX_DWORD checksum,
244                                      FX_LPBYTE pData, FX_DWORD size, int font_offset);
245     FXFT_Face           GetFileFace(FX_LPCSTR filename, int face_index);
246     FXFT_Face           GetFixedFace(FX_LPCBYTE pData, FX_DWORD size, int face_index);
247     void                        ReleaseFace(FXFT_Face face);
248     void                        SetSystemFontInfo(IFX_SystemFontInfo* pFontInfo);
249     FXFT_Face           FindSubstFont(const CFX_ByteString& face_name, FX_BOOL bTrueType, FX_DWORD flags,
250                                   int weight, int italic_angle, int CharsetCP, CFX_SubstFont* pSubstFont);
251
252     void                        FreeCache();
253
254     FX_BOOL                     GetStandardFont(FX_LPCBYTE& pFontData, FX_DWORD& size, int index);
255     CFX_FontMapper*     m_pBuiltinMapper;
256     IFX_FontMapper*     m_pExtMapper;
257     CFX_MapByteStringToPtr      m_FaceMap;
258     FXFT_Library        m_FTLibrary;
259     FoxitFonts m_ExternalFonts[16];
260 };
261 class IFX_FontMapper 
262 {
263 public:
264
265     virtual ~IFX_FontMapper() {}
266
267     virtual FXFT_Face   FindSubstFont(const CFX_ByteString& face_name, FX_BOOL bTrueType, FX_DWORD flags,
268                                       int weight, int italic_angle, int CharsetCP, CFX_SubstFont* pSubstFont) = 0;
269
270     CFX_FontMgr*                m_pFontMgr;
271 };
272 class IFX_FontEnumerator
273 {
274 public:
275     virtual ~IFX_FontEnumerator() { }
276
277     virtual void                HitFont() = 0;
278
279     virtual void                Finish() = 0;
280 };
281 class IFX_AdditionalFontEnum
282 {
283 public:
284     virtual ~IFX_AdditionalFontEnum() { }
285     virtual int  CountFiles() = 0;
286     virtual IFX_FileStream* GetFontFile(int index) = 0;
287 };
288 class CFX_FontMapper : public IFX_FontMapper
289 {
290 public:
291     CFX_FontMapper();
292     virtual ~CFX_FontMapper();
293     void                        SetSystemFontInfo(IFX_SystemFontInfo* pFontInfo);
294     IFX_SystemFontInfo*         GetSystemFontInfo()
295     {
296         return m_pFontInfo;
297     }
298     void                        AddInstalledFont(const CFX_ByteString& name, int charset);
299     void                        LoadInstalledFonts();
300     CFX_ByteStringArray         m_InstalledTTFonts;
301     void                        SetFontEnumerator(IFX_FontEnumerator* pFontEnumerator)
302     {
303         m_pFontEnumerator = pFontEnumerator;
304     }
305     IFX_FontEnumerator*         GetFontEnumerator() const
306     {
307         return m_pFontEnumerator;
308     }
309     virtual FXFT_Face           FindSubstFont(const CFX_ByteString& face_name, FX_BOOL bTrueType, FX_DWORD flags,
310                                               int weight, int italic_angle, int CharsetCP, CFX_SubstFont* pSubstFont);
311     FXFT_Face                   FindSubstFontByUnicode(FX_DWORD dwUnicode, FX_DWORD flags, int weight, int italic_angle);\r
312     FX_BOOL                     IsBuiltinFace(const FXFT_Face face) const;
313
314 private:
315     static const size_t         MM_FACE_COUNT = 2;
316     static const size_t         FOXIT_FACE_COUNT = 14;
317     CFX_ByteString              GetPSNameFromTT(void* hFont);
318     CFX_ByteString              MatchInstalledFonts(const CFX_ByteString& norm_name);
319     FXFT_Face                   UseInternalSubst(CFX_SubstFont* pSubstFont, int iBaseFont, int italic_angle, int weight, int picthfamily);
320
321     FX_BOOL                     m_bListLoaded;
322     FXFT_Face                   m_MMFaces[MM_FACE_COUNT];
323     CFX_ByteString              m_LastFamily;
324     CFX_DWordArray              m_CharsetArray;
325     CFX_ByteStringArray         m_FaceArray;
326     IFX_SystemFontInfo*         m_pFontInfo;
327     FXFT_Face                   m_FoxitFaces[FOXIT_FACE_COUNT];
328     IFX_FontEnumerator*         m_pFontEnumerator;
329 };
330 class IFX_SystemFontInfo 
331 {
332 public:
333     static IFX_SystemFontInfo*  CreateDefault();
334     virtual void                Release() = 0;
335
336     virtual     FX_BOOL         EnumFontList(CFX_FontMapper* pMapper) = 0;
337     virtual void*               MapFont(int weight, FX_BOOL bItalic, int charset, int pitch_family, FX_LPCSTR face, FX_BOOL& bExact) = 0;
338     virtual void*               MapFontByUnicode(FX_DWORD dwUnicode, int weight, FX_BOOL bItalic, int pitch_family)\r
339     {\r
340         return NULL;\r
341     }\r
342     virtual void*               GetFont(FX_LPCSTR face) = 0;
343     virtual FX_DWORD    GetFontData(void* hFont, FX_DWORD table, FX_LPBYTE buffer, FX_DWORD size) = 0;
344     virtual FX_BOOL             GetFaceName(void* hFont, CFX_ByteString& name) = 0;
345     virtual FX_BOOL             GetFontCharset(void* hFont, int& charset) = 0;
346     virtual int                 GetFaceIndex(void* hFont)
347     {
348         return 0;
349     }
350     virtual void                DeleteFont(void* hFont) = 0;
351     virtual void*       RetainFont(void* hFont)
352     {
353         return NULL;
354     }
355 protected:
356     ~IFX_SystemFontInfo() { }
357 };
358 class CFX_FolderFontInfo : public IFX_SystemFontInfo
359 {
360 public:
361     CFX_FolderFontInfo();
362     virtual ~CFX_FolderFontInfo();
363     void                                AddPath(FX_BSTR path);
364     virtual void                Release();
365     virtual     FX_BOOL         EnumFontList(CFX_FontMapper* pMapper);
366     virtual void*               MapFont(int weight, FX_BOOL bItalic, int charset, int pitch_family, FX_LPCSTR face, FX_BOOL& bExact);
367     virtual void*               MapFontByUnicode(FX_DWORD dwUnicode, int weight, FX_BOOL bItalic, int pitch_family);\r
368     virtual void*               GetFont(FX_LPCSTR face);
369     virtual FX_DWORD    GetFontData(void* hFont, FX_DWORD table, FX_LPBYTE buffer, FX_DWORD size);
370     virtual void                DeleteFont(void* hFont);
371     virtual     FX_BOOL         GetFaceName(void* hFont, CFX_ByteString& name);
372     virtual FX_BOOL             GetFontCharset(void* hFont, int& charset);
373 protected:
374     CFX_MapByteStringToPtr      m_FontList;
375     CFX_ByteStringArray m_PathList;
376     CFX_FontMapper*             m_pMapper;
377     void                                ScanPath(CFX_ByteString& path);
378     void                                ScanFile(CFX_ByteString& path);
379     void                                ReportFace(CFX_ByteString& path, FXSYS_FILE* pFile, FX_DWORD filesize, FX_DWORD offset);
380 };
381 class CFX_CountedFaceCache 
382 {
383 public:
384     CFX_FaceCache*      m_Obj;
385     FX_DWORD            m_nCount;
386 };
387 typedef CFX_MapPtrTemplate<FXFT_Face, CFX_CountedFaceCache*> CFX_FTCacheMap;
388 class CFX_FontCache 
389 {
390 public:
391     ~CFX_FontCache();
392     CFX_FaceCache*                      GetCachedFace(CFX_Font* pFont);
393     void                                        ReleaseCachedFace(CFX_Font* pFont);
394     void                                        FreeCache(FX_BOOL bRelease = FALSE);
395
396 private:
397     CFX_FTCacheMap                      m_FTFaceMap;
398     CFX_FTCacheMap                      m_ExtFaceMap;
399 };
400 class CFX_AutoFontCache
401 {
402 public:
403     CFX_AutoFontCache(CFX_FontCache* pFontCache, CFX_Font* pFont)
404         : m_pFontCache(pFontCache)
405         , m_pFont(pFont)
406     {
407     }
408     ~CFX_AutoFontCache()
409     {
410         m_pFontCache->ReleaseCachedFace(m_pFont);
411     }
412     CFX_FontCache* m_pFontCache;
413     CFX_Font* m_pFont;
414 };
415 #define FX_FONTCACHE_DEFINE(pFontCache, pFont) CFX_AutoFontCache autoFontCache((pFontCache), (pFont))
416 class CFX_GlyphBitmap 
417 {
418 public:
419     int                                         m_Top;
420     int                                         m_Left;
421     CFX_DIBitmap                        m_Bitmap;
422 };
423 class CFX_FaceCache 
424 {
425 public:
426     ~CFX_FaceCache();
427     const CFX_GlyphBitmap*      LoadGlyphBitmap(CFX_Font* pFont, FX_DWORD glyph_index, FX_BOOL bFontStyle, const CFX_AffineMatrix* pMatrix,
428                                             int dest_width, int anti_alias, int& text_flags);
429     const CFX_PathData*         LoadGlyphPath(CFX_Font* pFont, FX_DWORD glyph_index, int dest_width);
430
431
432     CFX_FaceCache(FXFT_Face face);
433 private:
434     FXFT_Face                           m_Face;
435     CFX_GlyphBitmap*            RenderGlyph(CFX_Font* pFont, FX_DWORD glyph_index, FX_BOOL bFontStyle,
436                                         const CFX_AffineMatrix* pMatrix, int dest_width, int anti_alias);
437     CFX_GlyphBitmap*            RenderGlyph_Nativetext(CFX_Font* pFont, FX_DWORD glyph_index,
438             const CFX_AffineMatrix* pMatrix, int dest_width, int anti_alias);
439     CFX_GlyphBitmap*        LookUpGlyphBitmap(CFX_Font* pFont, const CFX_AffineMatrix* pMatrix, CFX_ByteStringC& FaceGlyphsKey,
440             FX_DWORD glyph_index, FX_BOOL bFontStyle, int dest_width, int anti_alias);
441     CFX_MapByteStringToPtr      m_SizeMap;
442     CFX_MapPtrToPtr                     m_PathMap;
443     CFX_DIBitmap*           m_pBitmap;
444     void*                   m_pPlatformGraphics;
445     void*                   m_pPlatformBitmap;
446     void*                   m_hDC;
447     void*                   m_hBitmap;
448     void*                   m_hOldBitmap;
449     void*                   m_hGdiFont;
450     void*                   m_hOldGdiFont;
451
452     void                                    InitPlatform();
453     void                                    DestroyPlatform();
454 };
455 typedef struct {
456     const CFX_GlyphBitmap*      m_pGlyph;
457     int                                 m_OriginX, m_OriginY;
458     FX_FLOAT                    m_fOriginX, m_fOriginY;
459 } FXTEXT_GLYPHPOS;
460 FX_RECT FXGE_GetGlyphsBBox(FXTEXT_GLYPHPOS* pGlyphAndPos, int nChars, int anti_alias, FX_FLOAT retinaScaleX = 1.0f, FX_FLOAT retinaScaleY = 1.0f);
461 FX_BOOL OutputGlyph(void* dib, int x, int y, CFX_Font* pFont, double font_size,
462                     CFX_AffineMatrix* pMatrix, unsigned long glyph_index, unsigned long argb);
463 FX_BOOL OutputText(void* dib, int x, int y, CFX_Font* pFont, double font_size,
464                    CFX_AffineMatrix* pText_matrix, unsigned short const* text, unsigned long argb);
465 class IFX_GSUBTable
466 {
467 public:
468     virtual void        Release() = 0;
469     virtual FX_BOOL GetVerticalGlyph(FX_DWORD glyphnum, FX_DWORD* vglyphnum) = 0;
470
471 protected:
472      ~IFX_GSUBTable() { }
473 };
474 IFX_GSUBTable* FXGE_CreateGSUBTable(CFX_Font* pFont);
475
476 #endif  // CORE_INCLUDE_FXGE_FX_FONT_H_