Clean up CPDF_AnnotList.
[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   CFX_FontMapper* GetBuiltinMapper() const { return m_pBuiltinMapper.get(); }
213   FXFT_Library GetFTLibrary() const { return m_FTLibrary; }
214
215  private:
216   void InitFTLibrary();
217
218   nonstd::unique_ptr<CFX_FontMapper> m_pBuiltinMapper;
219   std::map<CFX_ByteString, CTTFontDesc*> m_FaceMap;
220   FXFT_Library m_FTLibrary;
221 };
222
223 class IFX_FontEnumerator {
224  public:
225   virtual void HitFont() = 0;
226
227   virtual void Finish() = 0;
228
229  protected:
230   virtual ~IFX_FontEnumerator() {}
231 };
232
233 class IFX_AdditionalFontEnum {
234  public:
235   virtual int CountFiles() = 0;
236   virtual IFX_FileStream* GetFontFile(int index) = 0;
237
238  protected:
239   virtual ~IFX_AdditionalFontEnum() {}
240 };
241
242 class CFX_FontMapper {
243  public:
244   explicit CFX_FontMapper(CFX_FontMgr* mgr);
245   ~CFX_FontMapper();
246
247   void SetSystemFontInfo(IFX_SystemFontInfo* pFontInfo);
248   IFX_SystemFontInfo* GetSystemFontInfo() { return m_pFontInfo; }
249   void AddInstalledFont(const CFX_ByteString& name, int charset);
250   void LoadInstalledFonts();
251   CFX_ByteStringArray m_InstalledTTFonts;
252   void SetFontEnumerator(IFX_FontEnumerator* pFontEnumerator) {
253     m_pFontEnumerator = pFontEnumerator;
254   }
255   IFX_FontEnumerator* GetFontEnumerator() const { return m_pFontEnumerator; }
256   FXFT_Face FindSubstFont(const CFX_ByteString& face_name,
257                           FX_BOOL bTrueType,
258                           FX_DWORD flags,
259                           int weight,
260                           int italic_angle,
261                           int CharsetCP,
262                           CFX_SubstFont* pSubstFont);
263
264  private:
265   static const size_t MM_FACE_COUNT = 2;
266   static const size_t FOXIT_FACE_COUNT = 14;
267
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[MM_FACE_COUNT];
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[FOXIT_FACE_COUNT];
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   std::map<CFX_ByteString, CFX_FontFaceInfo*> 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   void* GetSubstFont(const CFX_ByteString& face);
349   void* FindFont(int weight,
350                  FX_BOOL bItalic,
351                  int charset,
352                  int pitch_family,
353                  const FX_CHAR* family,
354                  FX_BOOL bMatchName);
355 };
356 class CFX_CountedFaceCache {
357  public:
358   CFX_FaceCache* m_Obj;
359   FX_DWORD m_nCount;
360 };
361
362 class CFX_FontCache {
363  public:
364   ~CFX_FontCache();
365   CFX_FaceCache* GetCachedFace(CFX_Font* pFont);
366   void ReleaseCachedFace(CFX_Font* pFont);
367   void FreeCache(FX_BOOL bRelease = FALSE);
368
369  private:
370   using CFX_FTCacheMap = std::map<FXFT_Face, CFX_CountedFaceCache*>;
371   CFX_FTCacheMap m_FTFaceMap;
372   CFX_FTCacheMap m_ExtFaceMap;
373 };
374 class CFX_AutoFontCache {
375  public:
376   CFX_AutoFontCache(CFX_FontCache* pFontCache, CFX_Font* pFont)
377       : m_pFontCache(pFontCache), m_pFont(pFont) {}
378   ~CFX_AutoFontCache() { m_pFontCache->ReleaseCachedFace(m_pFont); }
379   CFX_FontCache* m_pFontCache;
380   CFX_Font* m_pFont;
381 };
382 #define FX_FONTCACHE_DEFINE(pFontCache, pFont) \
383   CFX_AutoFontCache autoFontCache((pFontCache), (pFont))
384 class CFX_GlyphBitmap {
385  public:
386   int m_Top;
387   int m_Left;
388   CFX_DIBitmap m_Bitmap;
389 };
390 class CFX_FaceCache {
391  public:
392   ~CFX_FaceCache();
393   const CFX_GlyphBitmap* LoadGlyphBitmap(CFX_Font* pFont,
394                                          FX_DWORD glyph_index,
395                                          FX_BOOL bFontStyle,
396                                          const CFX_AffineMatrix* pMatrix,
397                                          int dest_width,
398                                          int anti_alias,
399                                          int& text_flags);
400   const CFX_PathData* LoadGlyphPath(CFX_Font* pFont,
401                                     FX_DWORD glyph_index,
402                                     int dest_width);
403
404   CFX_FaceCache(FXFT_Face face);
405
406  private:
407   FXFT_Face m_Face;
408   CFX_GlyphBitmap* RenderGlyph(CFX_Font* pFont,
409                                FX_DWORD glyph_index,
410                                FX_BOOL bFontStyle,
411                                const CFX_AffineMatrix* pMatrix,
412                                int dest_width,
413                                int anti_alias);
414   CFX_GlyphBitmap* RenderGlyph_Nativetext(CFX_Font* pFont,
415                                           FX_DWORD glyph_index,
416                                           const CFX_AffineMatrix* pMatrix,
417                                           int dest_width,
418                                           int anti_alias);
419   CFX_GlyphBitmap* LookUpGlyphBitmap(CFX_Font* pFont,
420                                      const CFX_AffineMatrix* pMatrix,
421                                      CFX_ByteStringC& FaceGlyphsKey,
422                                      FX_DWORD glyph_index,
423                                      FX_BOOL bFontStyle,
424                                      int dest_width,
425                                      int anti_alias);
426   std::map<CFX_ByteString, CFX_SizeGlyphCache*> m_SizeMap;
427   CFX_MapPtrToPtr m_PathMap;
428   CFX_DIBitmap* m_pBitmap;
429
430   void InitPlatform();
431   void DestroyPlatform();
432 };
433 typedef struct {
434   const CFX_GlyphBitmap* m_pGlyph;
435   int m_OriginX, m_OriginY;
436   FX_FLOAT m_fOriginX, m_fOriginY;
437 } FXTEXT_GLYPHPOS;
438 FX_RECT FXGE_GetGlyphsBBox(FXTEXT_GLYPHPOS* pGlyphAndPos,
439                            int nChars,
440                            int anti_alias,
441                            FX_FLOAT retinaScaleX = 1.0f,
442                            FX_FLOAT retinaScaleY = 1.0f);
443
444 class IFX_GSUBTable {
445  public:
446   static IFX_GSUBTable* Create(CFX_Font* pFont);
447   virtual FX_BOOL GetVerticalGlyph(FX_DWORD glyphnum, FX_DWORD* vglyphnum) = 0;
448
449  protected:
450   virtual ~IFX_GSUBTable() {}
451 };
452
453 CFX_ByteString GetNameFromTT(const uint8_t* name_table, FX_DWORD name);
454
455 int PDF_GetStandardFontName(CFX_ByteString* name);
456
457 #endif  // CORE_INCLUDE_FXGE_FX_FONT_H_