summaryrefslogtreecommitdiff
path: root/Build/source/texk/dvisvgm/dvisvgm-1.9.1/src/Font.h
blob: ed862a9f16575201585cb2fe9ee72c65776f38e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
/*************************************************************************
** Font.h                                                               **
**                                                                      **
** This file is part of dvisvgm -- the DVI to SVG converter             **
** Copyright (C) 2005-2015 Martin Gieseking <martin.gieseking@uos.de>   **
**                                                                      **
** This program is free software; you can redistribute it and/or        **
** modify it under the terms of the GNU General Public License as       **
** published by the Free Software Foundation; either version 3 of       **
** the License, or (at your option) any later version.                  **
**                                                                      **
** This program is distributed in the hope that it will be useful, but  **
** WITHOUT ANY WARRANTY; without even the implied warranty of           **
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the         **
** GNU General Public License for more details.                         **
**                                                                      **
** You should have received a copy of the GNU General Public License    **
** along with this program; if not, see <http://www.gnu.org/licenses/>. **
*************************************************************************/

#ifndef DVISVGM_FONT_H
#define DVISVGM_FONT_H

#include <map>
#include <string>
#include <vector>
#include "Character.h"
#include "CharMapID.h"
#include "Color.h"
#include "FontCache.h"
#include "FontEncoding.h"
#include "FontMap.h"
#include "FontMetrics.h"
#include "GFGlyphTracer.h"
#include "Glyph.h"
#include "GraphicPath.h"
#include "MessageException.h"
#include "RangeMap.h"
#include "ToUnicodeMap.h"
#include "VFActions.h"
#include "VFReader.h"
#include "types.h"


struct FontStyle;


struct GlyphMetrics
{
	GlyphMetrics () : wl(0), wr(0), h(0), d(0) {}
	GlyphMetrics (double wwl, double wwr, double hh, double dd) : wl(wwl), wr(wwr), h(hh), d(dd) {}
	double wl, wr, h, d;
};


/** Abstract base for all font classes. */
struct Font {
	virtual ~Font () {}
	virtual Font* clone (double ds, double sc) const =0;
	virtual const Font* uniqueFont () const =0;
	virtual std::string name () const =0;
	virtual double designSize () const =0;
	virtual double scaledSize () const =0;
	virtual double scaleFactor () const     {return scaledSize()/designSize();}
	virtual double charWidth (int c) const =0;
	virtual double charDepth (int c) const =0;
	virtual double charHeight (int c) const =0;
	virtual double italicCorr (int c) const =0;
	virtual const FontMetrics* getMetrics () const =0;
	virtual const char* path () const =0;
	virtual const char* filename () const;
	virtual const FontEncoding* encoding () const;
	virtual bool getGlyph (int c, Glyph &glyph, GFGlyphTracer::Callback *cb=0) const =0;
	virtual void getGlyphMetrics (int c, bool vertical, GlyphMetrics &metrics) const;
	virtual UInt32 unicode (UInt32 c) const;
	virtual void tidy () const {}
	virtual bool findAndAssignBaseFontMap () {return true;}
	virtual bool verticalLayout () const     {return getMetrics() ? getMetrics()->verticalLayout() : false;}
	virtual bool verifyChecksums () const    {return true;}
	virtual int fontIndex () const           {return 0;}
	virtual const FontStyle* style () const  {return 0;}
	virtual Color color () const             {return Color::BLACK;}
	virtual const FontMap::Entry* fontMapEntry () const;
};


/** Empty font without any glyphs. Instances of this class are used
 *  if no physical or virtual font file can be found.
 *  The metric values returned by the member functions are based on cmr10. */
struct EmptyFont : public Font
{
	public:
		EmptyFont (std::string name) : _fontname(name) {}
		Font* clone (double ds, double sc) const  {return new EmptyFont(*this);}
		const Font* uniqueFont () const           {return this;}
		std::string name () const                 {return _fontname;}
		double designSize () const                {return 10;}    // cmr10 design size in pt
		double scaledSize () const                {return 10;}    // cmr10 scaled size in pt
		double charWidth (int c) const            {return 9.164;} // width of cmr10's 'M' in pt
		double charHeight (int c) const           {return 6.833;} // height of cmr10's 'M' in pt
		double charDepth (int c) const            {return 0;}
		double italicCorr (int c) const           {return 0;}
		const FontMetrics* getMetrics () const    {return 0;}
		const char* path () const                 {return 0;}
		bool getGlyph (int c, Glyph &glyph, GFGlyphTracer::Callback *cb=0) const {return false;}

	private:
		std::string _fontname;
};


/** Interface for all physical fonts. */
class PhysicalFont : public virtual Font
{
	public:
		enum Type {MF, OTF, PFB, TTC, TTF, UNKNOWN};

		static Font* create (std::string name, UInt32 checksum, double dsize, double ssize, PhysicalFont::Type type);
		static Font* create (std::string name, int fontindex, UInt32 checksum, double dsize, double ssize);
		virtual Type type () const =0;
		virtual bool getGlyph (int c, Glyph &glyph, GFGlyphTracer::Callback *cb=0) const;
		virtual bool getExactGlyphBox (int c, BoundingBox &bbox, GFGlyphTracer::Callback *cb=0) const;
		virtual bool getExactGlyphBox (int c, GlyphMetrics &metrics, bool vertical, GFGlyphTracer::Callback *cb=0) const;
		virtual bool isCIDFont () const;
		virtual int hAdvance () const;
		virtual double hAdvance (int c) const;
		virtual double vAdvance (int c) const;
		std::string glyphName (int c) const;
		virtual int unitsPerEm () const;
		virtual double scaledAscent () const;
		virtual int ascent () const;
		virtual int descent () const;
		virtual int traceAllGlyphs (bool includeCached, GFGlyphTracer::Callback *cb=0) const;
		virtual int collectCharMapIDs (std::vector<CharMapID> &charmapIDs) const;
		virtual CharMapID getCharMapID () const =0;
		virtual void setCharMapID (const CharMapID &id) {}
		virtual Character decodeChar (UInt32 c) const;
		const char* path () const;

	protected:
		bool createGF (std::string &gfname) const;

	public:
		static bool EXACT_BBOX;
		static bool KEEP_TEMP_FILES;
		static const char *CACHE_PATH; ///< path to cache directory (0 if caching is disabled)
		static double METAFONT_MAG;    ///< magnification factor for Metafont calls

	protected:
		static FontCache _cache;
};


/** Interface for all virtual fonts. */
class VirtualFont : public virtual Font
{
	friend class FontManager;
	public:
		typedef std::vector<UInt8> DVIVector;

	public:
		static Font* create (std::string name, UInt32 checksum, double dsize, double ssize);
		virtual const DVIVector* getDVI (int c) const =0;
		bool getGlyph (int c, Glyph &glyph, GFGlyphTracer::Callback *cb=0) const {return false;}

	protected:
		virtual void assignChar (UInt32 c, DVIVector *dvi) =0;
};


class TFMFont : public virtual Font
{
	public:
		TFMFont (std::string name, UInt32 checksum, double dsize, double ssize);
		~TFMFont ();
		const FontMetrics* getMetrics () const;
		std::string name () const   {return _fontname;}
		double designSize () const  {return _dsize;}
		double scaledSize () const  {return _ssize;}
		double charWidth (int c) const;
		double charDepth (int c) const;
		double charHeight (int c) const;
		double italicCorr (int c) const;
		bool verifyChecksums () const;

	private:
		mutable FontMetrics *_metrics;
		std::string _fontname;
		UInt32 _checksum; ///< cheksum to be compared with TFM checksum
		double _dsize;    ///< design size in PS point units
		double _ssize;    ///< scaled size in PS point units
};


class PhysicalFontProxy : public PhysicalFont
{
	friend class PhysicalFontImpl;
	public:
		Font* clone (double ds, double sc) const    {return new PhysicalFontProxy(*this, ds, sc);}
		const Font* uniqueFont () const             {return _pf;}
		std::string name () const                   {return _pf->name();}
		double designSize () const                  {return _dsize;}
		double scaledSize () const                  {return _ssize;}
		double charWidth (int c) const              {return _pf->charWidth(c);}
		double charDepth (int c) const              {return _pf->charDepth(c);}
		double charHeight (int c) const             {return _pf->charHeight(c);}
		double italicCorr (int c) const             {return _pf->italicCorr(c);}
		const FontMetrics* getMetrics () const      {return _pf->getMetrics();}
		Type type () const                          {return _pf->type();}
		UInt32 unicode (UInt32 c) const             {return _pf->unicode(c);}
		int fontIndex () const                      {return _pf->fontIndex();}
		const FontStyle* style () const             {return _pf->style();}
		const FontMap::Entry* fontMapEntry () const {return _pf->fontMapEntry();}
		const FontEncoding* encoding () const       {return _pf->encoding();}
		CharMapID getCharMapID () const             {return _pf->getCharMapID();}
		int collectCharMapIDs (std::vector<CharMapID> &charmapIDs) const {return _pf->collectCharMapIDs(charmapIDs);}

	protected:
		PhysicalFontProxy (const PhysicalFont *font, double ds, double ss) : _pf(font), _dsize(ds), _ssize(ss) {}
		PhysicalFontProxy (const PhysicalFontProxy &proxy, double ds, double ss) : _pf(proxy._pf), _dsize(ds), _ssize(ss) {}

	private:
		const PhysicalFont *_pf;
		double _dsize;  ///< design size in PS point units
		double _ssize;  ///< scaled size in PS point units
};


class PhysicalFontImpl : public PhysicalFont, public TFMFont
{
	friend class PhysicalFont;
	public:
		~PhysicalFontImpl();
		Font* clone (double ds, double ss) const    {return new PhysicalFontProxy(this, ds, ss);}
		const Font* uniqueFont () const             {return this;}
		Type type () const                          {return _filetype;}
		int fontIndex() const                       {return _fontIndex;}
		const FontStyle* style () const             {return _fontMapEntry ? &_fontMapEntry->style : 0;}
		const FontMap::Entry* fontMapEntry () const {return _fontMapEntry;}
		const FontEncoding* encoding () const;
		UInt32 unicode (UInt32 c) const;
		bool findAndAssignBaseFontMap ();
		void tidy () const;
		CharMapID getCharMapID () const             {return _charmapID;}

	protected:
		PhysicalFontImpl (std::string name, int fontindex, UInt32 checksum, double dsize, double ssize, PhysicalFont::Type type);

	private:
		Type _filetype;
		int _fontIndex;
		const FontMap::Entry *_fontMapEntry;
		FontEncodingPair _encodingPair;
		CharMapID _charmapID;  ///< ID of the font's charmap to use
		const RangeMap *_localCharMap;
};


class NativeFont : public PhysicalFont
{
	public:
		virtual NativeFont* clone (double ptsize, const FontStyle &style, Color color) const =0;
		virtual Font* clone (double ds, double sc) const =0;
		std::string name () const;
		Type type () const;
		double designSize () const               {return _ptsize;}
		double scaledSize () const               {return _ptsize;}
		double charWidth (int c) const;
		double charDepth (int c) const;
		double charHeight (int c) const;
		double italicCorr (int c) const          {return 0;}
		const FontMetrics* getMetrics () const   {return 0;}
		const FontStyle* style () const          {return &_style;}
		Color color () const                     {return _color;}
		const FontMap::Entry* fontMapEntry () const {return 0;}
		static std::string uniqueName (const std::string &path, const FontStyle &style);

	protected:
		NativeFont (double ptsize, const FontStyle &style, Color color) : _ptsize(ptsize), _style(style), _color(color) {}

	private:
		double _ptsize;    ///< font size in PS point units
		FontStyle _style;
		Color _color;
};


class NativeFontProxy : public NativeFont
{
	friend class NativeFontImpl;
	public:
		NativeFont* clone (double ptsize, const FontStyle &style, Color color) const {
			return new NativeFontProxy(this, ptsize, style, color);
		}

		Font* clone (double ds, double sc) const {return new NativeFontProxy(this , sc, *style(), color());}
		const Font* uniqueFont () const          {return _nfont;}
		const char* path () const                {return _nfont->path();}
		Character decodeChar (UInt32 c) const    {return _nfont->decodeChar(c);}
		UInt32 unicode (UInt32 c) const          {return _nfont->unicode(c);}
		CharMapID getCharMapID () const          {return _nfont->getCharMapID();}

	protected:
		NativeFontProxy (const NativeFont *nfont, double ptsize, const FontStyle &style, Color color)
			: NativeFont(ptsize, style, color), _nfont(nfont) {}

	private:
		const NativeFont *_nfont;
};


class NativeFontImpl : public NativeFont
{
	public:
		NativeFontImpl (const std::string &fname, double ptsize, const FontStyle &style, Color color)
			: NativeFont(ptsize, style, color), _path(fname) {}

		NativeFont* clone (double ptsize, const FontStyle &style, Color color) const {
			return new NativeFontProxy(this, ptsize, style, color);
		}

		Font* clone (double ds, double sc) const {return new NativeFontProxy(this , sc, *style(), color());}
		const Font* uniqueFont () const          {return this;}
		const char* path () const                {return _path.c_str();}
		bool findAndAssignBaseFontMap ();
		CharMapID getCharMapID () const          {return CharMapID::NONE;}
		Character decodeChar (UInt32 c) const;
		UInt32 unicode (UInt32 c) const;

	private:
		std::string _path;
		ToUnicodeMap _toUnicodeMap; ///< maps from char indexes to unicode points
};


class VirtualFontProxy : public VirtualFont
{
	friend class VirtualFontImpl;
	public:
		Font* clone (double ds, double ss) const {return new VirtualFontProxy(*this, ds, ss);}
		const Font* uniqueFont () const          {return _vf;}
		std::string name () const                {return _vf->name();}
		const DVIVector* getDVI (int c) const    {return _vf->getDVI(c);}
		double designSize () const               {return _dsize;}
		double scaledSize () const               {return _ssize;}
		double charWidth (int c) const           {return _vf->charWidth(c);}
		double charDepth (int c) const           {return _vf->charDepth(c);}
		double charHeight (int c) const          {return _vf->charHeight(c);}
		double italicCorr (int c) const          {return _vf->italicCorr(c);}
		const FontMetrics* getMetrics () const   {return _vf->getMetrics();}
		const char* path () const                {return _vf->path();}

	protected:
		VirtualFontProxy (const VirtualFont *font, double ds, double ss) : _vf(font), _dsize(ds), _ssize(ss) {}
		VirtualFontProxy (const VirtualFontProxy &proxy, double ds, double ss) : _vf(proxy._vf), _dsize(ds), _ssize(ss) {}
		void assignChar (UInt32 c, DVIVector *dvi) {delete dvi;}

	private:
		const VirtualFont *_vf;
		double _dsize;  ///< design size in PS point units
		double _ssize;  ///< scaled size in PS point units
};


class VirtualFontImpl : public VirtualFont, public TFMFont
{
	friend class VirtualFont;
	public:
		~VirtualFontImpl ();
		Font* clone (double ds, double ss) const {return new VirtualFontProxy(this, ds, ss);}
		const Font* uniqueFont () const   {return this;}
		const DVIVector* getDVI (int c) const;
		const char* path () const;

	protected:
		VirtualFontImpl (std::string name, UInt32 checksum, double dsize, double ssize);
		void assignChar (UInt32 c, DVIVector *dvi);

	private:
		std::map<UInt32, DVIVector*> _charDefs; ///< dvi subroutines defining the characters
};


struct FontException : public MessageException
{
	FontException (std::string msg) : MessageException(msg) {}
};

#endif