ce06a8ac5f4a44ba3aa01d3e28acb10251ab3731
[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 <map>
11
12 #include "../fxcrt/fx_system.h"
13 #include "fx_dib.h"
14
15 typedef struct FT_FaceRec_* FXFT_Face;
16 typedef void* FXFT_Library;
17 class IFX_FontEncoding;
18 class CFX_PathData;
19 class CFX_SubstFont;
20 class CFX_FaceCache;
21 class CFX_FontMapper;
22 class IFX_SystemFontInfo;
23 class CFontFileFaceInfo;
24 #define FXFONT_FIXED_PITCH 0x01
25 #define FXFONT_SERIF 0x02
26 #define FXFONT_SYMBOLIC 0x04
27 #define FXFONT_SCRIPT 0x08
28 #define FXFONT_ITALIC 0x40
29 #define FXFONT_BOLD 0x40000
30 #define FXFONT_USEEXTERNATTR 0x80000
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  public:
54   CFX_Font();
55   ~CFX_Font();
56
57   FX_BOOL LoadSubst(const CFX_ByteString& face_name,
58                     FX_BOOL bTrueType,
59                     FX_DWORD flags,
60                     int weight,
61                     int italic_angle,
62                     int CharsetCP,
63                     FX_BOOL bVertical = FALSE);
64
65   FX_BOOL LoadEmbedded(const uint8_t* data, FX_DWORD size);
66
67   FX_BOOL LoadFile(IFX_FileRead* pFile);
68
69   FXFT_Face GetFace() const { return m_Face; }
70
71   const CFX_SubstFont* GetSubstFont() const { return m_pSubstFont; }
72
73   CFX_PathData* LoadGlyphPath(FX_DWORD glyph_index, int dest_width = 0);
74
75   int GetGlyphWidth(FX_DWORD glyph_index);
76
77   int GetAscent() const;
78
79   int GetDescent() const;
80
81   FX_BOOL GetGlyphBBox(FX_DWORD glyph_index, FX_RECT& bbox);
82
83   FX_BOOL IsItalic();
84
85   FX_BOOL IsBold();
86
87   FX_BOOL IsFixedWidth();
88
89   FX_BOOL IsVertical() const { return m_bVertical; }
90
91   CFX_WideString GetPsName() const;
92
93   CFX_ByteString GetFamilyName() const;
94
95   CFX_ByteString GetFaceName() const;
96
97   FX_BOOL IsTTFont();
98
99   FX_BOOL GetBBox(FX_RECT& bbox);
100
101   int GetHeight();
102
103   int GetULPos();
104
105   int GetULthickness();
106
107   int GetMaxAdvanceWidth();
108
109   FXFT_Face m_Face;
110
111   CFX_SubstFont* m_pSubstFont;
112   FX_BOOL IsEmbedded() { return m_bEmbedded; }
113
114   void AdjustMMParams(int glyph_index, int width, int weight);
115   uint8_t* m_pFontDataAllocation;
116   uint8_t* m_pFontData;
117   uint8_t* m_pGsubData;
118   FX_DWORD m_dwSize;
119   CFX_BinaryBuf m_OtfFontData;
120   void* m_hHandle;
121   void* m_pPlatformFont;
122   void* m_pPlatformFontCollection;
123   void* m_pDwFont;
124   FX_BOOL m_bDwLoaded;
125   void ReleasePlatformResource();
126
127   void DeleteFace();
128
129  protected:
130   FX_BOOL m_bEmbedded;
131   FX_BOOL m_bVertical;
132   void* m_pOwnedStream;
133 };
134 #define ENCODING_INTERNAL 0
135 #define ENCODING_UNICODE 1
136 class IFX_FontEncoding {
137  public:
138   virtual ~IFX_FontEncoding() {}
139
140   virtual FX_DWORD GlyphFromCharCode(FX_DWORD charcode) = 0;
141
142   virtual CFX_WideString UnicodeFromCharCode(FX_DWORD charcode) const = 0;
143
144   virtual FX_DWORD CharCodeFromUnicode(FX_WCHAR Unicode) const = 0;
145 };
146 IFX_FontEncoding* FXGE_CreateUnicodeEncoding(CFX_Font* pFont);
147 #define FXFONT_SUBST_MM 0x01
148 #define FXFONT_SUBST_GLYPHPATH 0x04
149 #define FXFONT_SUBST_CLEARTYPE 0x08
150 #define FXFONT_SUBST_TRANSFORM 0x10
151 #define FXFONT_SUBST_NONSYMBOL 0x20
152 #define FXFONT_SUBST_EXACT 0x40
153 #define FXFONT_SUBST_STANDARD 0x80
154 class CFX_SubstFont {
155  public:
156   CFX_SubstFont();
157
158   void* m_ExtHandle;
159
160   CFX_ByteString m_Family;
161
162   int m_Charset;
163
164   FX_DWORD m_SubstFlags;
165
166   int m_Weight;
167
168   int m_ItalicAngle;
169
170   FX_BOOL m_bSubstOfCJK;
171
172   int m_WeightCJK;
173
174   FX_BOOL m_bItlicCJK;
175 };
176 #define FX_FONT_FLAG_SERIF 0x01
177 #define FX_FONT_FLAG_FIXEDPITCH 0x02
178 #define FX_FONT_FLAG_ITALIC 0x04
179 #define FX_FONT_FLAG_BOLD 0x08
180 #define FX_FONT_FLAG_SYMBOLIC_SYMBOL 0x10
181 #define FX_FONT_FLAG_SYMBOLIC_DINGBATS 0x20
182 #define FX_FONT_FLAG_MULTIPLEMASTER 0x40
183 typedef struct {
184   const uint8_t* m_pFontData;
185   FX_DWORD m_dwSize;
186 } FoxitFonts;
187 class CFX_FontMgr {
188  public:
189   CFX_FontMgr();
190   ~CFX_FontMgr();
191   void InitFTLibrary();
192   FXFT_Face GetCachedFace(const CFX_ByteString& face_name,
193                           int weight,
194                           FX_BOOL bItalic,
195                           uint8_t*& pFontData);
196   FXFT_Face AddCachedFace(const CFX_ByteString& face_name,
197                           int weight,
198                           FX_BOOL bItalic,
199                           uint8_t* pData,
200                           FX_DWORD size,
201                           int face_index);
202   FXFT_Face GetCachedTTCFace(int ttc_size,
203                              FX_DWORD checksum,
204                              int font_offset,
205                              uint8_t*& pFontData);
206   FXFT_Face AddCachedTTCFace(int ttc_size,
207                              FX_DWORD checksum,
208                              uint8_t* pData,
209                              FX_DWORD size,
210                              int font_offset);
211   FXFT_Face GetFileFace(const FX_CHAR* filename, int face_index);
212   FXFT_Face GetFixedFace(const uint8_t* pData, FX_DWORD size, int face_index);
213   void ReleaseFace(FXFT_Face face);
214   void SetSystemFontInfo(IFX_SystemFontInfo* pFontInfo);
215   FXFT_Face FindSubstFont(const CFX_ByteString& face_name,
216                           FX_BOOL bTrueType,
217                           FX_DWORD flags,
218                           int weight,
219                           int italic_angle,
220                           int CharsetCP,
221                           CFX_SubstFont* pSubstFont);
222
223   void FreeCache();
224
225   FX_BOOL GetStandardFont(const uint8_t*& pFontData, FX_DWORD& size, int index);
226   CFX_FontMapper* m_pBuiltinMapper;
227   CFX_MapByteStringToPtr m_FaceMap;
228   FXFT_Library m_FTLibrary;
229   FoxitFonts m_ExternalFonts[16];
230 };
231 class IFX_FontEnumerator {
232  public:
233   virtual ~IFX_FontEnumerator() {}
234
235   virtual void HitFont() = 0;
236
237   virtual void Finish() = 0;
238 };
239 class IFX_AdditionalFontEnum {
240  public:
241   virtual ~IFX_AdditionalFontEnum() {}
242   virtual int CountFiles() = 0;
243   virtual IFX_FileStream* GetFontFile(int index) = 0;
244 };
245 class CFX_FontMapper {
246  public:
247   explicit CFX_FontMapper(CFX_FontMgr* mgr);
248   ~CFX_FontMapper();
249
250   void SetSystemFontInfo(IFX_SystemFontInfo* pFontInfo);
251   IFX_SystemFontInfo* GetSystemFontInfo() { return m_pFontInfo; }
252   void AddInstalledFont(const CFX_ByteString& name, int charset);
253   void LoadInstalledFonts();
254   CFX_ByteStringArray m_InstalledTTFonts;
255   void SetFontEnumerator(IFX_FontEnumerator* pFontEnumerator) {
256     m_pFontEnumerator = pFontEnumerator;
257   }
258   IFX_FontEnumerator* GetFontEnumerator() const { return m_pFontEnumerator; }
259   FXFT_Face FindSubstFont(const CFX_ByteString& face_name,
260                           FX_BOOL bTrueType,
261                           FX_DWORD flags,
262                           int weight,
263                           int italic_angle,
264                           int CharsetCP,
265                           CFX_SubstFont* pSubstFont);
266
267  private:
268   CFX_ByteString GetPSNameFromTT(void* hFont);
269   CFX_ByteString MatchInstalledFonts(const CFX_ByteString& norm_name);
270   FXFT_Face UseInternalSubst(CFX_SubstFont* pSubstFont,
271                              int iBaseFont,
272                              int italic_angle,
273                              int weight,
274                              int picthfamily);
275
276   FX_BOOL m_bListLoaded;
277   FXFT_Face m_MMFaces[2];
278   CFX_ByteString m_LastFamily;
279   CFX_DWordArray m_CharsetArray;
280   CFX_ByteStringArray m_FaceArray;
281   IFX_SystemFontInfo* m_pFontInfo;
282   FXFT_Face m_FoxitFaces[14];
283   IFX_FontEnumerator* m_pFontEnumerator;
284   CFX_FontMgr* const m_pFontMgr;
285 };
286
287 class IFX_SystemFontInfo {
288  public:
289   static IFX_SystemFontInfo* CreateDefault(const char** pUserPaths);
290   virtual void Release() = 0;
291
292   virtual FX_BOOL EnumFontList(CFX_FontMapper* pMapper) = 0;
293   virtual void* MapFont(int weight,
294                         FX_BOOL bItalic,
295                         int charset,
296                         int pitch_family,
297                         const FX_CHAR* face,
298                         int& iExact) = 0;
299   virtual void* GetFont(const FX_CHAR* face) = 0;
300   virtual FX_DWORD GetFontData(void* hFont,
301                                FX_DWORD table,
302                                uint8_t* buffer,
303                                FX_DWORD size) = 0;
304   virtual FX_BOOL GetFaceName(void* hFont, CFX_ByteString& name) = 0;
305   virtual FX_BOOL GetFontCharset(void* hFont, int& charset) = 0;
306   virtual int GetFaceIndex(void* hFont) { return 0; }
307   virtual void DeleteFont(void* hFont) = 0;
308   virtual void* RetainFont(void* hFont) { return NULL; }
309
310  protected:
311   virtual ~IFX_SystemFontInfo() {}
312 };
313
314 class CFX_FolderFontInfo : public IFX_SystemFontInfo {
315  public:
316   CFX_FolderFontInfo();
317   ~CFX_FolderFontInfo() override;
318   void AddPath(const CFX_ByteStringC& path);
319
320   // IFX_SytemFontInfo:
321   void Release() override;
322   FX_BOOL EnumFontList(CFX_FontMapper* pMapper) override;
323   void* MapFont(int weight,
324                 FX_BOOL bItalic,
325                 int charset,
326                 int pitch_family,
327                 const FX_CHAR* face,
328                 int& bExact) override;
329   void* GetFont(const FX_CHAR* face) override;
330   FX_DWORD GetFontData(void* hFont,
331                        FX_DWORD table,
332                        uint8_t* buffer,
333                        FX_DWORD size) override;
334   void DeleteFont(void* hFont) override;
335   FX_BOOL GetFaceName(void* hFont, CFX_ByteString& name) override;
336   FX_BOOL GetFontCharset(void* hFont, int& charset) override;
337
338  protected:
339   CFX_MapByteStringToPtr m_FontList;
340   CFX_ByteStringArray m_PathList;
341   CFX_FontMapper* m_pMapper;
342   void ScanPath(CFX_ByteString& path);
343   void ScanFile(CFX_ByteString& path);
344   void ReportFace(CFX_ByteString& path,
345                   FXSYS_FILE* pFile,
346                   FX_DWORD filesize,
347                   FX_DWORD offset);
348 };
349 class CFX_CountedFaceCache {
350  public:
351   CFX_FaceCache* m_Obj;
352   FX_DWORD m_nCount;
353 };
354
355 class CFX_FontCache {
356  public:
357   ~CFX_FontCache();
358   CFX_FaceCache* GetCachedFace(CFX_Font* pFont);
359   void ReleaseCachedFace(CFX_Font* pFont);
360   void FreeCache(FX_BOOL bRelease = FALSE);
361
362  private:
363   using CFX_FTCacheMap = std::map<FXFT_Face, CFX_CountedFaceCache*>;
364   CFX_FTCacheMap m_FTFaceMap;
365   CFX_FTCacheMap m_ExtFaceMap;
366 };
367 class CFX_AutoFontCache {
368  public:
369   CFX_AutoFontCache(CFX_FontCache* pFontCache, CFX_Font* pFont)
370       : m_pFontCache(pFontCache), m_pFont(pFont) {}
371   ~CFX_AutoFontCache() { m_pFontCache->ReleaseCachedFace(m_pFont); }
372   CFX_FontCache* m_pFontCache;
373   CFX_Font* m_pFont;
374 };
375 #define FX_FONTCACHE_DEFINE(pFontCache, pFont) \
376   CFX_AutoFontCache autoFontCache((pFontCache), (pFont))
377 class CFX_GlyphBitmap {
378  public:
379   int m_Top;
380   int m_Left;
381   CFX_DIBitmap m_Bitmap;
382 };
383 class CFX_FaceCache {
384  public:
385   ~CFX_FaceCache();
386   const CFX_GlyphBitmap* LoadGlyphBitmap(CFX_Font* pFont,
387                                          FX_DWORD glyph_index,
388                                          FX_BOOL bFontStyle,
389                                          const CFX_AffineMatrix* pMatrix,
390                                          int dest_width,
391                                          int anti_alias,
392                                          int& text_flags);
393   const CFX_PathData* LoadGlyphPath(CFX_Font* pFont,
394                                     FX_DWORD glyph_index,
395                                     int dest_width);
396
397   CFX_FaceCache(FXFT_Face face);
398
399  private:
400   FXFT_Face m_Face;
401   CFX_GlyphBitmap* RenderGlyph(CFX_Font* pFont,
402                                FX_DWORD glyph_index,
403                                FX_BOOL bFontStyle,
404                                const CFX_AffineMatrix* pMatrix,
405                                int dest_width,
406                                int anti_alias);
407   CFX_GlyphBitmap* RenderGlyph_Nativetext(CFX_Font* pFont,
408                                           FX_DWORD glyph_index,
409                                           const CFX_AffineMatrix* pMatrix,
410                                           int dest_width,
411                                           int anti_alias);
412   CFX_GlyphBitmap* LookUpGlyphBitmap(CFX_Font* pFont,
413                                      const CFX_AffineMatrix* pMatrix,
414                                      CFX_ByteStringC& FaceGlyphsKey,
415                                      FX_DWORD glyph_index,
416                                      FX_BOOL bFontStyle,
417                                      int dest_width,
418                                      int anti_alias);
419   CFX_MapByteStringToPtr m_SizeMap;
420   CFX_MapPtrToPtr m_PathMap;
421   CFX_DIBitmap* m_pBitmap;
422
423   void InitPlatform();
424   void DestroyPlatform();
425 };
426 typedef struct {
427   const CFX_GlyphBitmap* m_pGlyph;
428   int m_OriginX, m_OriginY;
429   FX_FLOAT m_fOriginX, m_fOriginY;
430 } FXTEXT_GLYPHPOS;
431 FX_RECT FXGE_GetGlyphsBBox(FXTEXT_GLYPHPOS* pGlyphAndPos,
432                            int nChars,
433                            int anti_alias,
434                            FX_FLOAT retinaScaleX = 1.0f,
435                            FX_FLOAT retinaScaleY = 1.0f);
436 class IFX_GSUBTable {
437  public:
438   static IFX_GSUBTable* Create(CFX_Font* pFont);
439   virtual ~IFX_GSUBTable() {}
440   virtual FX_BOOL GetVerticalGlyph(FX_DWORD glyphnum, FX_DWORD* vglyphnum) = 0;
441 };
442
443 #endif  // CORE_INCLUDE_FXGE_FX_FONT_H_