Aspose::Pdf::PdfASymbolicFontEncodingStrategy Class Reference

This class describes rules which can be used to tune process of copying encoding data for cases when TrueType symbolic font has more than one encoding. Some PDF documents after conversion into PDF/A format could give an error "More than one encoding in symbolic TrueType font's cmap". What is a reason of this error? All TrueType symbolic fonts have special table "cmap" in it's internal data. This table maps character codes to glyph indices. And this table could contain different encoding subtables which describe encodings used. See advanced info about cmap tables at https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6cmap.html. Usually cmap table contains several encoding subtables, but PDF/A standard requires that either only one encoding subtable must be left for this font in PDF/A document or there must be a (3,0) encoding subtable among this font subtables. And key question here - what data must be taken from another subtables to copy into destination encoding table (3,0)? Majority of fonts have 'well-formed' cmap tables where every encoding subtable is fully consistent with another subtable. But some fonts have cmap tables with collisions - where for example one subtable has glyph index 100 for unicode 100, but another subtable has glyph index 200 for the same unicode 100. To solve this problems special strategy needed. By default following strategy used: mac subtable(1,0) is looked for. If this table is found, only this data used to fill destination table (3,0). If mac subtable is not found then all subtables except (3,0) are iterated and used to copy data into destination (3,0) subtable. Also mapping for every unicode(unicode, glyph index) is copied into destination table only if destination table does not have this unicode at current moment. So, for example if first subtabe has glyph index 100 for unicode 100, and next subtable has glyph index 200 for the same unicode 100, only data from first subtable (unicode=100, glyph index = 100) will be copied. So each previous subtable takes precedence over the next. Properties of this class PdfASymbolicFontEncodingStrategy help tune default behaviour. If property PreferredCmapEncodingTable of type QueueItem::CMapEncodingTableType is set, then relevant subtable will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::CMapEncodingTableType has no sense in this case, cause it points on the same mac subtable (1,0) which will be used by default. Property CmapEncodingTablesPriorityQueue discards all priorities for any subtable. If this property is set, then only subtables from declared queue will be used in specified order. If subtables specified are not found then default iteration of all subtables and copy strategy described above will be used. Object QueueItem specifies encoding subtable used. This subtable can be set via combination of members(PlatformID, PlatformSpecificId) or via QueueItem::CMapEncodingTableType enumeration. In case when the font has no (3,0) subtable some other subtable will be used to maintain the PDF/A compatibility. The choice of the subtable to use is made under the same rules as described earlier, so that PreferredCmapEncodingTable and CmapEncodingTablesPriorityQueue properties are used to determine the resultant subtable, and if the font doesn't have the requested subtable(s) either then any existant subtable will be used. More...

#include "PdfFormatConversionOptions.h"

Inherits System::Object.

Classes

class  QueueItem
 Specifies encoding subtable. Each encoding subtable has unique combination of parameters (PlatformID, PlatformSpecificId). Enumeration CMapEncodingTableType and property CMapEncodingTable were implemented to make easier set of encoding subtable needed. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API PdfASymbolicFontEncodingStrategy::QueueItem::CMapEncodingTableType get_PreferredCmapEncodingTable () const
 Specifies subtable which will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::CMapEncodingTableType has no sense in this case. More...
 
ASPOSE_PDF_SHARED_API void set_PreferredCmapEncodingTable (PdfASymbolicFontEncodingStrategy::QueueItem::CMapEncodingTableType value)
 Specifies subtable which will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::CMapEncodingTableType has no sense in this case. More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< System::Collections::Generic::Queue< System::SharedPtr< PdfASymbolicFontEncodingStrategy::QueueItem > > > & get_CmapEncodingTablesPriorityQueue () const
 Specifies queue of encoding subtables to process. More...
 
ASPOSE_PDF_SHARED_API void set_CmapEncodingTablesPriorityQueue (System::SharedPtr< System::Collections::Generic::Queue< System::SharedPtr< PdfASymbolicFontEncodingStrategy::QueueItem >>> value)
 Specifies queue of encoding subtables to process. More...
 
ASPOSE_PDF_SHARED_API PdfASymbolicFontEncodingStrategy ()
 Constructor. Sets default subtable (mac 1,0) More...
 
ASPOSE_PDF_SHARED_API PdfASymbolicFontEncodingStrategy (System::SharedPtr< System::Collections::Generic::Queue< System::SharedPtr< PdfASymbolicFontEncodingStrategy::QueueItem >>> priorityQueue)
 Constructor More...
 
ASPOSE_PDF_SHARED_API PdfASymbolicFontEncodingStrategy (PdfASymbolicFontEncodingStrategy::QueueItem::CMapEncodingTableType preferredEncodingTable)
 Constructor More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () const
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

This class describes rules which can be used to tune process of copying encoding data for cases when TrueType symbolic font has more than one encoding. Some PDF documents after conversion into PDF/A format could give an error "More than one encoding in symbolic TrueType font's cmap". What is a reason of this error? All TrueType symbolic fonts have special table "cmap" in it's internal data. This table maps character codes to glyph indices. And this table could contain different encoding subtables which describe encodings used. See advanced info about cmap tables at https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6cmap.html. Usually cmap table contains several encoding subtables, but PDF/A standard requires that either only one encoding subtable must be left for this font in PDF/A document or there must be a (3,0) encoding subtable among this font subtables. And key question here - what data must be taken from another subtables to copy into destination encoding table (3,0)? Majority of fonts have 'well-formed' cmap tables where every encoding subtable is fully consistent with another subtable. But some fonts have cmap tables with collisions - where for example one subtable has glyph index 100 for unicode 100, but another subtable has glyph index 200 for the same unicode 100. To solve this problems special strategy needed. By default following strategy used: mac subtable(1,0) is looked for. If this table is found, only this data used to fill destination table (3,0). If mac subtable is not found then all subtables except (3,0) are iterated and used to copy data into destination (3,0) subtable. Also mapping for every unicode(unicode, glyph index) is copied into destination table only if destination table does not have this unicode at current moment. So, for example if first subtabe has glyph index 100 for unicode 100, and next subtable has glyph index 200 for the same unicode 100, only data from first subtable (unicode=100, glyph index = 100) will be copied. So each previous subtable takes precedence over the next. Properties of this class PdfASymbolicFontEncodingStrategy help tune default behaviour. If property PreferredCmapEncodingTable of type QueueItem::CMapEncodingTableType is set, then relevant subtable will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::CMapEncodingTableType has no sense in this case, cause it points on the same mac subtable (1,0) which will be used by default. Property CmapEncodingTablesPriorityQueue discards all priorities for any subtable. If this property is set, then only subtables from declared queue will be used in specified order. If subtables specified are not found then default iteration of all subtables and copy strategy described above will be used. Object QueueItem specifies encoding subtable used. This subtable can be set via combination of members(PlatformID, PlatformSpecificId) or via QueueItem::CMapEncodingTableType enumeration. In case when the font has no (3,0) subtable some other subtable will be used to maintain the PDF/A compatibility. The choice of the subtable to use is made under the same rules as described earlier, so that PreferredCmapEncodingTable and CmapEncodingTablesPriorityQueue properties are used to determine the resultant subtable, and if the font doesn't have the requested subtable(s) either then any existant subtable will be used.

Constructor & Destructor Documentation

◆ PdfASymbolicFontEncodingStrategy() [1/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfASymbolicFontEncodingStrategy::PdfASymbolicFontEncodingStrategy ( )

Constructor. Sets default subtable (mac 1,0)

◆ PdfASymbolicFontEncodingStrategy() [2/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfASymbolicFontEncodingStrategy::PdfASymbolicFontEncodingStrategy ( System::SharedPtr< System::Collections::Generic::Queue< System::SharedPtr< PdfASymbolicFontEncodingStrategy::QueueItem >>>  priorityQueue)

Constructor

Parameters
priorityQueuequeue of encoding subtables to iterate

◆ PdfASymbolicFontEncodingStrategy() [3/3]

ASPOSE_PDF_SHARED_API Aspose::Pdf::PdfASymbolicFontEncodingStrategy::PdfASymbolicFontEncodingStrategy ( PdfASymbolicFontEncodingStrategy::QueueItem::CMapEncodingTableType  preferredEncodingTable)

Constructor

Parameters
preferredEncodingTableencoding subtable which will be used in precedence to mac subtable(1,0)

Member Function Documentation

◆ get_CmapEncodingTablesPriorityQueue()

ASPOSE_PDF_SHARED_API const System::SharedPtr<System::Collections::Generic::Queue<System::SharedPtr<PdfASymbolicFontEncodingStrategy::QueueItem> > >& Aspose::Pdf::PdfASymbolicFontEncodingStrategy::get_CmapEncodingTablesPriorityQueue ( ) const

Specifies queue of encoding subtables to process.

◆ get_PreferredCmapEncodingTable()

ASPOSE_PDF_SHARED_API PdfASymbolicFontEncodingStrategy::QueueItem::CMapEncodingTableType Aspose::Pdf::PdfASymbolicFontEncodingStrategy::get_PreferredCmapEncodingTable ( ) const

Specifies subtable which will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::CMapEncodingTableType has no sense in this case.

◆ set_CmapEncodingTablesPriorityQueue()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PdfASymbolicFontEncodingStrategy::set_CmapEncodingTablesPriorityQueue ( System::SharedPtr< System::Collections::Generic::Queue< System::SharedPtr< PdfASymbolicFontEncodingStrategy::QueueItem >>>  value)

Specifies queue of encoding subtables to process.

◆ set_PreferredCmapEncodingTable()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::PdfASymbolicFontEncodingStrategy::set_PreferredCmapEncodingTable ( PdfASymbolicFontEncodingStrategy::QueueItem::CMapEncodingTableType  value)

Specifies subtable which will be used in precedence to mac subtable(1,0). Value 'MacTable' from enumeration QueueItem::CMapEncodingTableType has no sense in this case.