PoDoFo  1.0.0-dev
Public Member Functions | Protected Member Functions | Friends | List of all members
PoDoFo::PdfBuiltInEncoding Class Referenceabstract

A common base class for built-in encodings which are known by name. More...

#include <PdfEncodingMap.h>

Inheritance diagram for PoDoFo::PdfBuiltInEncoding:
PoDoFo::PdfEncodingMapOneByte PoDoFo::PdfEncodingMap PoDoFo::PdfPredefinedEncoding PoDoFo::PdfStandardEncoding PoDoFo::PdfSymbolEncoding PoDoFo::PdfZapfDingbatsEncoding PoDoFo::PdfMacExpertEncoding PoDoFo::PdfMacRomanEncoding PoDoFo::PdfWinAnsiEncoding

Public Member Functions

const PdfNameGetName () const
 Get the name of this encoding. More...
 
- Public Member Functions inherited from PoDoFo::PdfEncodingMap
bool TryGetNextCharCode (std::string_view::iterator &it, const std::string_view::iterator &end, PdfCharCode &codeUnit) const
 Try decode next char code from utf8 string range.
 
bool TryGetCharCode (char32_t codePoint, PdfCharCode &codeUnit) const
 Try get next char code unit from unicode code point.
 
bool TryGetCharCode (const unicodeview &codePoints, PdfCharCode &codeUnit) const
 Get the char code from a span of unicode code points. More...
 
bool TryGetCharCode (unsigned cid, PdfCharCode &codeUnit) const
 Try get next char code unit from cid.
 
bool TryGetNextCID (std::string_view::iterator &it, const std::string_view::iterator &end, PdfCID &cid) const
 Try decode next cid from from encoded string range.
 
bool TryGetNextCodePoints (std::string_view::iterator &it, const std::string_view::iterator &end, CodePointSpan &codePoints) const
 Try decode next code points from encoded string range.
 
bool TryGetCodePoints (const PdfCharCode &codeUnit, CodePointSpan &codePoints) const
 Try get code points from char code unit. More...
 
PdfEncodingMapType GetType () const
 Type of encoding, may be Simple or CMap. More...
 
virtual PdfPredefinedEncodingType GetPredefinedEncodingType () const
 True if the encoding is builtin in a font program.
 
virtual bool HasLigaturesSupport () const
 True if the encoding has ligatures support.
 
bool TryGetExportObject (PdfIndirectObjectList &objects, PdfName &name, PdfObject *&obj) const
 Get an export object that will be used during font init. More...
 

Protected Member Functions

bool tryGetCharCode (char32_t codePoint, PdfCharCode &codeUnit) const override
 Try get char code unit from unicode code point.
 
bool tryGetCodePoints (const PdfCharCode &codeUnit, const unsigned *cidId, CodePointSpan &codePoints) const override
 Get code points from a code unit. More...
 
virtual const char32_t * GetToUnicodeTable () const =0
 Gets a table of 256 short values which are the big endian Unicode code points that are assigned to the 256 values of this encoding. More...
 
- Protected Member Functions inherited from PoDoFo::PdfEncodingMapOneByte
void AppendToUnicodeEntries (OutputStream &stream, charbuff &temp) const override
 During a WriteToUnicodeCMap append "beginbfchar" and "beginbfrange" entries. More...
 
void AppendCIDMappingEntries (OutputStream &stream, const PdfFont &font, charbuff &temp) const override
 During a PdfEncoding::ExportToFont() append "begincidchar" and/or "begincidrange" entries. More...
 
const PdfEncodingLimits & GetLimits () const override
 
- Protected Member Functions inherited from PoDoFo::PdfEncodingMap
virtual bool tryGetNextCharCode (std::string_view::iterator &it, const std::string_view::iterator &end, PdfCharCode &codeUnit) const
 Try get next char code unit from a utf8 string range. More...
 
virtual bool tryGetCharCodeSpan (const unicodeview &ligature, PdfCharCode &codeUnit) const
 Try get next char code unit from a ligature. More...
 
virtual void getExportObject (PdfIndirectObjectList &objects, PdfName &name, PdfObject *&obj) const
 Get an export object that will be used during font init. More...
 
virtual int GetWModeRaw () const
 A code that specifies the writing mode for any CIDFont with which this map is combined (make sense when this is a CMap) More...
 
virtual void AppendCodeSpaceRange (OutputStream &stream, charbuff &temp) const
 

Friends

class PdfFontMetricsFreetype
 
class PdfPredefinedEncoding
 
class PdfStandardEncoding
 
class PdfSymbolEncoding
 
class PdfZapfDingbatsEncoding
 
class AppleLatin1Encoding
 

Additional Inherited Members

- Static Protected Member Functions inherited from PoDoFo::PdfEncodingMap
static void AppendUTF16CodeTo (OutputStream &stream, char32_t codePoint, std::u16string &u16tmp)
 
static void AppendUTF16CodeTo (OutputStream &stream, const unicodeview &codePoints, std::u16string &u16tmp)
 

Detailed Description

A common base class for built-in encodings which are known by name.

Member Function Documentation

◆ GetName()

const PdfName& PoDoFo::PdfBuiltInEncoding::GetName ( ) const
inline

Get the name of this encoding.

Returns
the name of this encoding.

◆ GetToUnicodeTable()

virtual const char32_t* PoDoFo::PdfBuiltInEncoding::GetToUnicodeTable ( ) const
protectedpure virtual

Gets a table of 256 short values which are the big endian Unicode code points that are assigned to the 256 values of this encoding.

This table is used internally to convert an encoded string of this encoding to and from Unicode.

Returns
an array of 256 big endian Unicode code points

Implemented in PoDoFo::PdfZapfDingbatsEncoding, PoDoFo::PdfSymbolEncoding, PoDoFo::PdfStandardEncoding, PoDoFo::PdfMacExpertEncoding, PoDoFo::PdfMacRomanEncoding, and PoDoFo::PdfWinAnsiEncoding.

◆ tryGetCodePoints()

bool PdfBuiltInEncoding::tryGetCodePoints ( const PdfCharCode codeUnit,
const unsigned *  cidId,
CodePointSpan codePoints 
) const
overrideprotectedvirtual

Get code points from a code unit.

Parameters
cidIdCID identifier that if available some encodings can benefit to fetch code points faster

Implements PoDoFo::PdfEncodingMap.


The documentation for this class was generated from the following files: