#include <IGlyphUtils.h>

Inheritance diagram for IGlyphUtils:

Public Types
enum	{ kDefaultIID = IID_IGLYPHUTILS }

Public Member Functions
virtual UTF32TextChar	GlyphToCharacter (IPMFont font, Text::GlyphID id, UTF32TextChar userArea=nil)=0

virtual UTF32TextChar	GetUnicodeForGlyphID (IPMFont *font, const Text::GlyphID &glyphID) const =0

virtual PMString	GetUnicodeName (const UTF32TextChar &c)=0

virtual void	InsertTheCharacter (ISelectionManager selMgr, IPMFont font, const GlyphEntry baseGlyphEntry, const GlyphEntry alternateGlyphEntry, bool16 selectChar=kFalse, bool16 setFont=kFalse)=0

virtual int32	GetSelectionGlyphSet (IPMFont font, IFontInstance fontInstance, const WideString &chars, Text::GlyphID glyph, GlyphSet *glyphSet, GlyphSet::GlyphSortOrder sortOrder=GlyphSet::kNoOrder)=0

virtual int32	GetGlyphListGlyphSet (IPMFont font, IFontInstance fontInstance, Text::GlyphID glyphs, int32 numGlyphs, GlyphSet glyphSet, GlyphSet::GlyphSortOrder sortOrder=GlyphSet::kNoOrder)=0

virtual bool16	GetGlyphHasAlternate (IPMFont font, Text::GlyphID glyph, const char tag=nil)=0

virtual unsigned	GetGlyphAlternateCount (IPMFont font, Text::GlyphID glyph, const char tag=nil)=0

virtual int32	GetEntireFont (IPMFont font, GlyphSet glyphSet, GlyphSet::GlyphSortOrder sortOrder=GlyphSet::kNoOrder)=0

virtual int32	GetFilteredGlyphs (IPMFont font, GlyphSet glyphSet, GlyphFilterProcList &includeFilterProcList, GlyphFilterProcList &excludeFilterProcList, GlyphSet::GlyphSortOrder sortOrder=GlyphSet::kNoOrder)=0

virtual int32	GetOTFFeatureGlyphSet (const char tags, int32 numTags, IPMFont font, GlyphSet *glyphSet, GlyphSet::GlyphSortOrder sortOrder=GlyphSet::kNoOrder)=0

virtual bool16	GetOTFFeature (IPMFont font, IFontInstance fontInstance, const GlyphEntry baseGlyph, const GlyphEntry alternate, char *tagBuffer, int32 &choice)=0

virtual int32	GetGlyphsForFeatureAccessInfo (const char tags, int32 numTags, IPMFont font, GlyphSet *glyphSet)=0

virtual int32	GetGlyphAccessInfo (Text::GlyphID glyphID, IPMFont font, GlyphAccessData glyphAccessData)=0

virtual bool16	TestFeatureSubstitution (IFontInstance fontInstance, const WideString &textString, char tags, int32 *choices, int32 numFeatures, Text::GlyphID testGlyphID)=0

virtual void	GetOTFAttribute (char tags, int32 choice, AttributeBossList attrBossList, OpenTypeFeatureList &featureList, int32 &form, IFontInstance *fontInstance, const WideString &stringToApply, Text::GlyphID g)=0

virtual bool	GlyphFormIsKnown (ITextAttrGlyphForm::GlyphForm feature) const =0

virtual bool	IsGlyphFormFeature (int32 feature) const =0

virtual bool	IsGlyphFormFeature (const char *feature) const =0

virtual ITextAttrGlyphForm::GlyphForm	GlyphFormFromFeature (int32 feature) const =0

virtual ITextAttrGlyphForm::GlyphForm	GlyphFormFromFeature (const char *feature) const =0

virtual int32	GlyphFormToFeatureInt (ITextAttrGlyphForm::GlyphForm feature) const =0

virtual const char *	GlyphFormToFeatureChars (ITextAttrGlyphForm::GlyphForm feature) const =0

virtual const char *	GlyphFormDescriptiveString (ITextAttrGlyphForm::GlyphForm feature) const =0

virtual ITextAttrGlyphForm::GlyphForm	GlyphFormIncrement (ITextAttrGlyphForm::GlyphForm &) const =0

virtual ITextAttrGlyphForm::GlyphForm	GlyphFormDecrement (ITextAttrGlyphForm::GlyphForm &) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Utilities for dealing with glyphs.

Member Function Documentation

virtual int32 IGlyphUtils::GetEntireFont	(	IPMFont *	font,
		GlyphSet *	glyphSet,
		GlyphSet::GlyphSortOrder	sortOrder = `GlyphSet::kNoOrder`
	)

pure virtual

Get all glyphs in font

Parameters

font	font to get glyphs in
glyphSet	OUT all glyphs in font
sortOrder	how the returned glyph set should be sorted

Returns: int32 number of glyphs in glyphSet

virtual int32 IGlyphUtils::GetFilteredGlyphs	(	IPMFont *	font,
		GlyphSet *	glyphSet,
		GlyphFilterProcList &	includeFilterProcList,
		GlyphFilterProcList &	excludeFilterProcList,
		GlyphSet::GlyphSortOrder	sortOrder = `GlyphSet::kNoOrder`
	)

pure virtual

Get all glyphs in a font that satisfy the given filter function (typically from UnicodeClass).

Parameters

font	font to get glyphs for
glyphSet	OUT filtered glyphs in font meeting the filter function(s) condition(s).
includeFilterProcList	a list of function pointers to use to filter "in" the glyphs in the font, typically from UnicodeClass.h. GlyphFilterProcList filterArray; filterArray.push_back(&UnicodeClass::IsPunctuationOpen()); filterArray.push_back(&UnicodeClass::IsPunctuationClose());
excludeFilterProcList	a list of function pointers to use to further filter "out" the glyphs in the font captured by the includeFilterProcList, typically from UnicodeClass.h.
sortOrder	how the returned glyph set should be sorted

Returns: int32 number of glyphs in glyphSet

See Also: UnicodeClass.h for type definitions for filter procs.

virtual int32 IGlyphUtils::GetGlyphAccessInfo	(	Text::GlyphID	glyphID,
		IPMFont *	font,
		GlyphAccessData *	glyphAccessData
	)

pure virtual

Sets glyphAccessData->fDesiredTag to global gDesiredTag. Calls IPMFont::GetOTGlyphAccess. External code should not use this and call IPMFont::GetOTGlyphAccess instead.

Parameters

glyphID	glyph id to get access for
font	font glyph id is in
glyphAccessData	access data

Returns: int32 0 if success. 1 if failure.

virtual unsigned IGlyphUtils::GetGlyphAlternateCount	(	IPMFont *	font,
		Text::GlyphID	glyph,
		const char *	tag = `nil`
	)

pure virtual

Determine how many alternate with a given OpenType feature tag the glyph has.

Parameters

font	font to look for alternate glyph in
glyph	glyph to look for alternate
tag	OpenType feature tag to look for. 'aalt' if set to nil.

Returns: uint16 the number of alternates with the OpenType feature tag.

virtual bool16 IGlyphUtils::GetGlyphHasAlternate	(	IPMFont *	font,
		Text::GlyphID	glyph,
		const char *	tag = `nil`
	)

pure virtual

Determine if glyph has alternate with a given OpenType feature tag.

Parameters

font	font to look for alternate glyph in
glyph	glyph to look for alternate
tag	OpenType feature tag to look for. 'aalt' if set to nil.

Returns: bool16 kTrue if there is an alternate with OpenType feature tag.

virtual int32 IGlyphUtils::GetGlyphListGlyphSet	(	IPMFont *	font,
		IFontInstance *	fontInstance,
		Text::GlyphID *	glyphs,
		int32	numGlyphs,
		GlyphSet *	glyphSet,
		GlyphSet::GlyphSortOrder	sortOrder = `GlyphSet::kNoOrder`
	)

pure virtual

Get alternates for glyphs

Parameters

font	font to get glyph alternates in
fontInstance	font instance to get glyph alternates in. needs to be an instance of font
glyphs	glyphs to find alternates for
numGlyphs	number of glyphs. must be < 20 (kMaxStrikes).
glyphSet	OUT set of glyph alternates.
sortOrder	how the returned glyph set should be sorted

Returns: int32 returns length of glyphset. returns 0 if numGlyphs was >=20.

virtual int32 IGlyphUtils::GetGlyphsForFeatureAccessInfo	(	const char *	tags,
		int32	numTags,
		IPMFont *	font,
		GlyphSet *	glyphSet
	)

pure virtual

Get glyphs for a OpenType feature

Parameters

tags	OpenType features to get glyphs for
numTags	number of OpenType features
font	font to get glyphs in
glyphSet	OUT glyphs with OpenType features

Returns: int32 1 if has alternates. 0 if no alternates.

virtual void IGlyphUtils::GetOTFAttribute	(	char *	tags,
		int32	choice,
		AttributeBossList *	attrBossList,
		OpenTypeFeatureList &	featureList,
		int32 &	form,
		IFontInstance *	fontInstance,
		const WideString &	stringToApply,
		Text::GlyphID	g
	)

pure virtual

Get an attribute for an open type feature. Return if a suitable one was found.

Parameters

tags	OpenType feature to get attribute for
choice	value of OTF feature chosen from tags array
attrBossList	OUT attribute for the open type feature
featureList	OUT
form	OUT
fontInstance	font instance to get attribute for.
stringToApply	string to get OTF attribute for
g	glyphID to get OTF attribute for

virtual bool16 IGlyphUtils::GetOTFFeature	(	IPMFont *	font,
		IFontInstance *	fontInstance,
		const GlyphEntry *	baseGlyph,
		const GlyphEntry *	alternate,
		char *	tagBuffer,
		int32 &	choice
	)

pure virtual

Try and find an open type feature for the font/glyph combo. Return if a suitable one was found. Probably INTERNAL use only.

Parameters

font	font glyph id is in
fontInstance	font instance to get OTF feature for. needs to be an instance of font
baseGlyph	entry of base glyph
alternate	entry of alternate glyph
tags	OpenType features to get glyphs for
choice	OUT return index value of OTF feature chosen from tags array.

Returns: bool16 whether the particular feature was found

virtual int32 IGlyphUtils::GetOTFFeatureGlyphSet	(	const char *	tags,
		int32	numTags,
		IPMFont *	font,
		GlyphSet *	glyphSet,
		GlyphSet::GlyphSortOrder	sortOrder = `GlyphSet::kNoOrder`
	)

pure virtual

Get glyphs for a OpenType feature. Also sets global gDesiredTag that is used by GetGlyphAccessInfo for what OpenType feature to prefer.

Parameters

tags	OpenType features to get glyphs for
numTags	number of OpenType features
font	font to get glyphs in
glyphSet	OUT glyphs with OpenType features
sortOrder	how the returned glyph set should be sorted

Returns: int32 number of glyphs in glyphSet

virtual int32 IGlyphUtils::GetSelectionGlyphSet	(	IPMFont *	font,
		IFontInstance *	fontInstance,
		const WideString &	chars,
		Text::GlyphID	glyph,
		GlyphSet *	glyphSet,
		GlyphSet::GlyphSortOrder	sortOrder = `GlyphSet::kNoOrder`
	)

pure virtual

Gets alternate glyph values for a given glyph.

Parameters

font	font to get glyph alternates in
fontInstance	font instance to get glyph alternates in. needs to be an instance of font
chars	unicode value(s) for glyph. multiple values only if glyph is a combination of unicode values like a ligature.
glyph	glyph to get alternates for
glyphSet	OUT set of glyph alternates.
sortOrder	how the returned glyph set should be sorted

Returns: int32 returns length of glyphset.

virtual UTF32TextChar IGlyphUtils::GetUnicodeForGlyphID	(	IPMFont *	font,
		const Text::GlyphID &	glyphID
	)		const

pure virtual

Gets a unicode character value for a glyph id. Uses GlyphToCharacter to get its work done. Will also get a unicode value for glyphs in OpenType features. Return first character for glyphs composed of multiple characters.

Parameters

*font	font glyphid is from
glyphID	glyph id to get character value

Returns: unicode character value. Will return characters in private use area. May return 0.

virtual PMString IGlyphUtils::GetUnicodeName ( const UTF32TextChar & c )

pure virtual

Return a string for the name of the unicode character.

Parameters

c	the UTF32TextChar character to look up the name for

Returns: the Unicode name of the character. Maybe be missing for some characters, will return empty string in this case.

virtual const char* IGlyphUtils::GlyphFormDescriptiveString ( ITextAttrGlyphForm::GlyphForm feature ) const

pure virtual

GlyphFormDescriptiveString

Parameters

feature IN, the GlyphForm whose description string you want.

Returns: The descriptive string.

virtual ITextAttrGlyphForm::GlyphForm IGlyphUtils::GlyphFormFromFeature ( int32 feature ) const

pure virtual

GlyphFormFromFeature

Parameters

feature IN, the 4-character OpenType feature tag, stuffed into a 32-bit integer. The integer is the platform result of treating the char pointer as an int32 pointer.

Returns: The GlyphForm corresponding to the feature, or kNoForm if !FeatureInPurview (feature)

virtual ITextAttrGlyphForm::GlyphForm IGlyphUtils::GlyphFormFromFeature ( const char * feature ) const

pure virtual

GlyphFormFromFeature

Parameters

feature IN, the 4-character OpenType feature tag.

Returns: The GlyphForm corresponding to the feature, or kNoForm if !FeatureInPurview (feature)

virtual bool IGlyphUtils::GlyphFormIsKnown ( ITextAttrGlyphForm::GlyphForm feature ) const

pure virtual

GlyphFormIsKnown

Parameters

feature IN, the feature whose value you want to confirm is a legal value.

Returns: true if the glyph form is known (< ITextAttrGlyphForm::kBeyondEndForm)

virtual const char* IGlyphUtils::GlyphFormToFeatureChars ( ITextAttrGlyphForm::GlyphForm feature ) const

pure virtual

GlyphFormToFeatureChars

Parameters

feature IN, the GlyphForm whose OpenType tag you want.

Returns: The OpenType feature tag corresponding to 'feature', represented as characters.

virtual int32 IGlyphUtils::GlyphFormToFeatureInt ( ITextAttrGlyphForm::GlyphForm feature ) const

pure virtual

GlyphFormToFeatureInt

Parameters

feature IN, the GlyphForm whose OpenType tag you want.

Returns: The OpenType feature tag corresponding to 'feature', with the characters stuffed into an int. The integer is the platform result of treating the char pointer as an int32 pointer.

virtual UTF32TextChar IGlyphUtils::GlyphToCharacter	(	IPMFont *	font,
		Text::GlyphID	id,
		UTF32TextChar *	userArea = `nil`
	)

pure virtual

Gets a unicode character value for a glyph id

Parameters

*font	font glyphid is from
id	glyph id to get character value
*userArea	OUT if not nil and character value is in private use area 0 is returned and userArea contains the private use area unicode value.

Returns: unicode character value. 0 if in PUA area and userArea is not nil.

virtual void IGlyphUtils::InsertTheCharacter	(	ISelectionManager *	selMgr,
		IPMFont *	font,
		const GlyphEntry *	baseGlyphEntry,
		const GlyphEntry *	alternateGlyphEntry,
		bool16	selectChar = `kFalse`,
		bool16	setFont = `kFalse`
	)

pure virtual

Inserts a glyph into textmodel

Parameters

*setMgr	selection manager
*font	font of glyph.
*baseGlyphEntry	entry of base glyph
*alternateGlyphEntry	entry of alternate glyph
selectChar	select glyph inserted
setFont	set font of glyph to font passed in. font is restored to previous font after insertion

Returns: unicode character value. 0 if in PUA area and userArea is not nil.

virtual bool IGlyphUtils::IsGlyphFormFeature ( int32 feature ) const

pure virtual

IsGlyphFormFeature

Parameters

feature IN, the 4-character OpenType feature tag, stuffed into a 32-bit integer. The integer is the platform result of treating the char pointer as an int32 pointer.

Returns: whether the supplied feature is one covered by this class (i.e., it's in GlyphForm.)

virtual bool IGlyphUtils::IsGlyphFormFeature ( const char * feature ) const

pure virtual

IsGlyphFormFeature

Parameters

feature IN, the 4-character OpenType feature tag.

Returns: whether the supplied feature is one covered by this class (i.e., it's in GlyphForm.)

virtual bool16 IGlyphUtils::TestFeatureSubstitution	(	IFontInstance *	fontInstance,
		const WideString &	textString,
		char *	tags,
		int32 *	choices,
		int32	numFeatures,
		Text::GlyphID	testGlyphID
	)

pure virtual

Description Probably INTERNAL use only.

Parameters

fontInstance	font instance to test out application of OTF features. needs to be an instance of font
textString	a string of length 1 to apply OTF the feature to
tags	OpenType features array
choices	array of choice for features. count is the same as numFeatures.
numFeatures	number of features in features variable
testGlyphID

Returns: kTrue if feature can be applied, kFalse if not

See Also: IFontInstance.h, ApplyFeatures

Public Types

Public Member Functions

Detailed Description

Member Function Documentation