7#ifndef PDF_FONT_METRICS_H
8#define PDF_FONT_METRICS_H
11#include "PdfCMapEncoding.h"
12#include "PdfCIDToGIDMap.h"
13#include <podofo/auxiliary/Matrix.h>
14#include <podofo/auxiliary/Corners.h>
16FORWARD_DECLARE_FREETYPE();
23using GlyphMetricsListConstPtr = std::shared_ptr<const std::vector<double>>;
39 friend class PdfFontObject;
41 friend class PdfFontMetricsBase;
42 friend class PdfFontMetricsFreetype;
61 unsigned GetGlyphCount()
const;
74 double GetGlyphWidth(
unsigned gid)
const;
75 bool TryGetGlyphWidth(
unsigned gid,
double&
width)
const;
94 virtual void SubstituteGIDs(std::vector<unsigned>&
gids,
139 bool HasFontFileData()
const;
154 virtual const PdfObject* GetFontFileObject()
const;
178 virtual std::string_view GetFontNameRaw()
const;
189 std::string_view GeFontFamilyNameSafe()
const;
193 virtual unsigned char GetSubsetPrefixLength()
const;
200 std::string_view GetPostScriptNameRough()
const;
202 virtual PdfFontStretch GetFontStretch()
const = 0;
207 unsigned GetWeight()
const;
208 virtual int GetWeightRaw()
const = 0;
218 Corners GetBoundingBox()
const;
225 double GetItalicAngle()
const;
235 double GetAscent()
const;
246 double GetDescent()
const;
251 double GetCapHeight()
const;
256 double GetStemV()
const;
260 double GetLeading()
const;
261 virtual double GetLeadingRaw()
const = 0;
267 double GetXHeight()
const;
268 virtual double GetXHeightRaw()
const = 0;
273 double GetStemH()
const;
274 virtual double GetStemHRaw()
const = 0;
278 double GetAvgWidth()
const;
279 virtual double GetAvgWidthRaw()
const = 0;
283 double GetMaxWidth()
const;
284 virtual double GetMaxWidthRaw()
const = 0;
288 double GetDefaultWidth()
const;
289 virtual double GetDefaultWidthRaw()
const = 0;
298 virtual bool IsObjectLoaded()
const;
300 bool IsStandard14FontMetrics()
const;
302 virtual bool IsStandard14FontMetrics(PdfStandard14FontType&
std14Font)
const;
306 virtual const Matrix& GetMatrix()
const;
310 bool IsType1Kind()
const;
314 bool IsTrueTypeKind()
const;
320 bool IsPdfSymbolic()
const;
326 bool IsPdfNonSymbolic()
const;
336 virtual std::unique_ptr<PdfCMapEncoding> CreateToUnicodeMap(
const PdfEncodingLimits&
limitHints)
const;
339 const std::string& GetFilePath()
const {
return m_FilePath; }
340 unsigned GetFaceIndex()
const {
return m_FaceIndex; }
343 virtual PdfFontType GetFontType()
const;
352 virtual bool getIsBoldHint()
const = 0;
353 virtual bool getIsItalicHint()
const = 0;
354 virtual const datahandle& GetFontFileDataHandle()
const = 0;
355 virtual FT_Face GetFaceHandle()
const = 0;
357 virtual unsigned GetGlyphCountFontProgram()
const;
358 virtual bool TryGetGlyphWidthFontProgram(
unsigned gid,
double&
width)
const;
361 bool HasParsedWidths()
const;
363 unsigned GetParsedWidthsCount()
const;
369 void SetParsedWidths(GlyphMetricsListConstPtr&&
parsedWidths);
372 static std::unique_ptr<const PdfFontMetrics> CreateFromFile(
const std::string_view&
filepath,
unsigned faceIndex,
378 static std::unique_ptr<PdfFontMetrics> CreateFromFace(
FT_Face face, std::unique_ptr<charbuff>&&
buffer,
383 std::unique_ptr<const PdfFontMetrics> CreateMergedMetrics(
bool skipNormalization)
const;
393 PdfCIDToGIDMapConstPtr GetTrueTypeBuiltinCIDToGIDMap()
const;
396 void initFamilyFontNameSafe();
404 std::string m_FilePath;
405 std::string m_FamilyFontNameSafe;
406 GlyphMetricsListConstPtr m_ParsedWidths;
408 unsigned m_FaceIndex;
411class PODOFO_API PdfFontMetricsBase :
public PdfFontMetrics
413 friend class PdfFontMetricsStandard14;
414 friend class PdfFontMetricsObject;
417 PdfFontMetricsBase();
420 ~PdfFontMetricsBase();
423 const datahandle& GetFontFileDataHandle() const override final;
424 FT_Face GetFaceHandle() const override final;
425 virtual datahandle getFontFileDataHandle() const = 0;
An unoriented rectangle defined by 2 points.
Definition Corners.h:20
The PDF dictionary data type of PoDoFo (inherits from PdfDataContainer, the base class for such repre...
Definition PdfDictionary.h:82
PdfDifferenceEncoding is an encoding, which is based on either the fonts encoding or a predefined enc...
Definition PdfDifferenceEncoding.h:118
This factory creates a PdfEncoding from an existing object in the PDF.
Definition PdfEncodingFactory.h:20
PdfEncodingMap used by legacy encodings like PdfBuiltInEncoding or PdfDifferenceEncoding that can def...
Definition PdfEncodingMap.h:254
This class assists PdfDocument with caching font information.
Definition PdfFontManager.h:54
This abstract class provides access to font metrics information.
Definition PdfFontMetrics.h:36
virtual bool TryGetItalicAngle(double &value) const =0
Get the italic angle of this font.
virtual bool TryGetBoundingBox(Corners &value) const =0
Create the bounding box vector in PDF units.
virtual bool TryGetStemV(double &value) const =0
The thickness, measured horizontally, of the dominant vertical stems of glyphs in the font.
virtual unsigned GetFontFileLength3() const =0
Get /Length3 value for the font file, if available.
virtual double GetUnderlinePosition() const =0
Return the position of the underline for the current font size in PDF units.
GlyphMetricsListConstPtr GetParsedWidths() const
Retrieve the parsed width from a /W or /Widths entry, if available.
Definition PdfFontMetrics.h:367
virtual bool HasUnicodeMapping() const =0
Determines if the metrics has a valid Unicode code point to gid map.
virtual double GetStrikeThroughPosition() const =0
Return the position of the strikethrough for the current font size in PDF units.
virtual double GetUnderlineThickness() const =0
Get the width of the underline for the current font size in PDF units.
virtual bool TryGetGID(char32_t codePoint, unsigned &gid) const =0
Try to retrieve the mapped gid from Unicode code point.
virtual unsigned GetFontFileLength2() const =0
Get /Length2 value for the font file, if available.
virtual std::string_view GetBaseFontName() const =0
Get a semantical base name for the font that can be used to compose the final name,...
virtual double GetLineSpacing() const =0
Retrieve the line spacing for this font.
virtual unsigned GetFontFileLength1() const =0
Get /Length1 value for the font file, if available.
virtual bool TryGetCapHeight(double &value) const =0
The vertical coordinate of the top of flat capital letters, measured from the baseline.
virtual bool TryGetDescent(double &value) const =0
Get the descent of this font in PDF units for the current font size.
virtual double GetStrikeThroughThickness() const =0
Get the width of the strikethrough for the current font size in PDF units.
virtual bool TryGetAscent(double &value) const =0
Get the ascent of this font in PDF units for the current font size.
virtual std::string_view GetFontName() const =0
Get the actual /FontName, eg.
virtual std::string_view GetFontFamilyName() const =0
Get the actual /FontFamily, eg.
This is a common base class for simple, non CID-keyed fonts like Type1, TrueType and Type3.
Definition PdfFontSimple.h:20
Before you can draw text on a PDF document, you have to create a font object first.
Definition PdfFont.h:45
This class represents a PDF indirect Object in memory.
Definition PdfObject.h:35
Convenient type for char array storage and/or buffer with std::string compatibility.
Definition basetypes.h:38
A const data provider that can hold a view to a static segments or a shared buffer.
Definition basetypes.h:144
SPDX-FileCopyrightText: (C) 2022 Francesco Pretto ceztko@gmail.com SPDX-License-Identifier: LGPL-2....
Definition basetypes.h:16
PdfGlyphAccess
When accessing a glyph, there may be a difference in the glyph ID to retrieve the widths or to index ...
Definition PdfDeclarations.h:323
PdfFontFileType
Definition PdfDeclarations.h:296
@ Create
Create a new file or truncate existing one for writing/reading.
cspan< char > bufferview
Convenient read-only char buffer span.
Definition basetypes.h:19
std::shared_ptr< const PdfFontMetrics > PdfFontMetricsConstPtr
Convenience typedef for a const PdfEncoding shared ptr.
Definition PdfFontMetrics.h:27
PdfFontStyle
Font style flags used during searches.
Definition PdfDeclarations.h:310
PdfFontDescriptorFlags
Enum for the font descriptor flags.
Definition PdfDeclarations.h:252
std::shared_ptr< const PdfEncodingMap > PdfEncodingMapConstPtr
Convenience typedef for a const /Encoding map entry shared ptr.
Definition PdfEncodingMap.h:355