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