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