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