holds a complete configuration of the library; More...

#include <cpp_fontconfig/Config.h>

Public Member Functions
bool	appFontAddDir (const Char8_t *dir)
	Add fonts from directory to font database. More...

bool	appFontAddFile (const Char8_t *file)
	Add font file to font database. More...

void	appFontClear ()
	Remove all app fonts from font database. More...

bool	buildFonts ()
	Build font database. More...

void	createTagFile () const
	Create CACHEDIR.TAG at cache directory. More...

RefPtr< FontSet >	fontList (RefPtr< Pattern > p, RefPtr< ObjectSet > os)
	List fonts. More...

RefPtr< Pattern >	fontMatch (RefPtr< Pattern > p, Result_t &result)
	Return best font. More...

RefPtr< FontSet >	fontSetList (RefPtr< FontSet > *sets, int nsets, RefPtr< Pattern > p, RefPtr< ObjectSet > os)
	List fonts from a set of font sets. More...

RefPtr< Pattern >	fontSetMatch (RefPtr< FontSet > *sets, int nsets, RefPtr< Pattern > pattern, Result_t &result)
	Return the best font from a set of font sets. More...

RefPtr< FontSet >	fontSetSort (RefPtr< FontSet > sets, int nsets, RefPtr< Pattern > p, bool trim, RefPtr< CharSet > csp, Result_t &result)
	Return list of matching fonts. More...

RefPtr< FontSet >	fontSort (RefPtr< Pattern > p, bool trim, RefPtr< CharSet > *csp, Result_t &result)
	Return list of matching fonts. More...

RefPtr< Blanks >	getBlanks ()
	DEPRECATED used to return per-user cache filename. More...

RefPtr< StrList >	getCacheDirs () const
	return the list of directories searched for cache files More...

RefPtr< StrList >	getConfigDirs ()
	Get config directories. More...

RefPtr< StrList >	getConfigFiles ()
	Get config files. More...

RefPtr< StrList >	getFontDirs ()
	Get font directories. More...

RefPtr< FontSet >	getFonts (SetName_t set)
	Get config font set. More...

int	getRescanInterval ()
	Get config rescan interval. More...

ConfigDelegate *	operator-> ()

const ConfigDelegate *	operator-> () const

bool	parseAndLoad (const Char8_t *file, bool complain)
	load a configuration file More...

RefPtr< Pattern >	renderPrepare (RefPtr< Pattern > pat, RefPtr< Pattern > font)
	Prepare pattern for loading font file. More...

bool	setCurrent ()
	Set configuration as default. More...

bool	setRescanInterval (int rescanInterval)
	Set config rescan interval. More...

bool	substitute (RefPtr< Pattern > p, MatchKind_t kind)
	Execute substitutions. More...

bool	substituteWithPat (RefPtr< Pattern > p, RefPtr< Pattern > p_pat, MatchKind_t kind)
	Execute substitutions. More...

bool	unlink (const Char8_t *dir)
	Remove all caches related to `dir`. More...

bool	upToDate ()
	Check timestamps on config files. More...

Private Member Functions
	ConfigDelegate (FcConfig *ptr)
	wrap constructor More...

	ConfigDelegate (const ConfigDelegate &other)
	not copy-constructable More...

ConfigDelegate &	operator= (const ConfigDelegate &other)
	not assignable More...

Private Attributes
FcConfig *	m_ptr

Friends
class	RefPtr< Config >

Detailed Description

holds a complete configuration of the library;

there is one default configuration, other can be constructed from XML data structures. All public entry points that need global data can take an optional FcConfig* argument; passing 0 uses the default configuration. FcConfig objects hold two sets of fonts, the first contains those specified by the configuration, the second set holds those added by the application at run-time. Interfaces that need to reference a particular set use one of the FcSetName enumerated values.

An FcConfig object holds the internal representation of a configuration. There is a default configuration which applications may use by passing 0 to any function using the data within an FcConfig.

Definition at line 58 of file Config.h.

Constructor & Destructor Documentation

fontconfig::ConfigDelegate::ConfigDelegate ( FcConfig * ptr )

inlineexplicitprivate

wrap constructor

wraps the pointer with this interface, does nothing else, only called by RefPtr<Atomic>

Definition at line 68 of file Config.h.

fontconfig::ConfigDelegate::ConfigDelegate ( const ConfigDelegate & other )

private

not copy-constructable

Member Function Documentation

bool fontconfig::ConfigDelegate::appFontAddDir ( const Char8_t * dir )

Add fonts from directory to font database.

Scans the specified directory for fonts, adding each one found to the application-specific set of fonts. Returns FcFalse if the fonts cannot be added (due to allocation failure). Otherwise returns FcTrue. If config is NULL, the current configuration is used.

bool fontconfig::ConfigDelegate::appFontAddFile ( const Char8_t * file )

Add font file to font database.

Adds an application-specific font to the configuration. Returns FcFalse if the fonts cannot be added (due to allocation failure). Otherwise returns FcTrue. If config is NULL, the current configuration is used.

void fontconfig::ConfigDelegate::appFontClear ( )

Remove all app fonts from font database.

Clears the set of application-specific fonts. If config is NULL, the current configuration is used.

bool fontconfig::ConfigDelegate::buildFonts ( )

Build font database.

Builds the set of available fonts for the given configuration. Note that any changes to the configuration after this call have indeterminate effects. Returns FcFalse if this operation runs out of memory. If config is NULL, the current configuration is used.

void fontconfig::ConfigDelegate::createTagFile ( ) const

Create CACHEDIR.TAG at cache directory.

This tries to create CACHEDIR.TAG file at the cache directory registered to config.

RefPtr<FontSet> fontconfig::ConfigDelegate::fontList	(	RefPtr< Pattern >	p,
		RefPtr< ObjectSet >	os
	)

List fonts.

Selects fonts matching p, creates patterns from those fonts containing only the objects in os and returns the set of unique such patterns. If config is NULL, the default configuration is checked to be up to date, and used.

RefPtr<Pattern> fontconfig::ConfigDelegate::fontMatch	(	RefPtr< Pattern >	p,
		Result_t &	result
	)

Return best font.

Finds the font in sets most closely matching pattern and returns the result of FcFontRenderPrepare for that font and the provided pattern. This function should be called only after FcConfigSubstitute and FcDefaultSubstitute have been called for p; otherwise the results will not be correct. If config is NULL, the current configuration is used.

RefPtr<FontSet> fontconfig::ConfigDelegate::fontSetList	(	RefPtr< FontSet > *	sets,
		int	nsets,
		RefPtr< Pattern >	p,
		RefPtr< ObjectSet >	os
	)

List fonts from a set of font sets.

Selects fonts matching pattern from sets, creates patterns from those fonts containing only the objects in object_set and returns the set of unique such patterns. If config is NULL, the default configuration is checked to be up to date, and used.

RefPtr<Pattern> fontconfig::ConfigDelegate::fontSetMatch	(	RefPtr< FontSet > *	sets,
		int	nsets,
		RefPtr< Pattern >	pattern,
		Result_t &	result
	)

Return the best font from a set of font sets.

Finds the font in sets most closely matching pattern and returns the result of FcFontRenderPrepare for that font and the provided pattern. This function should be called only after FcConfigSubstitute and FcDefaultSubstitute have been called for pattern; otherwise the results will not be correct. If config is NULL, the current configuration is used. Returns NULL if an error occurs during this process.

RefPtr<FontSet> fontconfig::ConfigDelegate::fontSetSort	(	RefPtr< FontSet > *	sets,
		int	nsets,
		RefPtr< Pattern >	p,
		bool	trim,
		RefPtr< CharSet > *	csp,
		Result_t &	result
	)

Return list of matching fonts.

Returns the list of fonts from sets sorted by closeness to pattern. If trim is FcTrue, elements in the list which don't include Unicode coverage not provided by earlier elements in the list are elided. The union of Unicode coverage of all of the fonts is returned in csp, if csp is not NULL. This function should be called only after FcConfigSubstitute and FcDefaultSubstitute have been called for p; otherwise the results will not be correct.

The returned FcFontSet references FcPattern structures which may be shared by the return value from multiple FcFontSort calls, applications cannot modify these patterns. Instead, they should be passed, along with pattern to FcFontRenderPrepare which combines them into a complete pattern.

The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy.

RefPtr<FontSet> fontconfig::ConfigDelegate::fontSort	(	RefPtr< Pattern >	p,
		bool	trim,
		RefPtr< CharSet > *	csp,
		Result_t &	result
	)

Return list of matching fonts.

Returns the list of fonts sorted by closeness to p. If trim is FcTrue, elements in the list which don't include Unicode coverage not provided by earlier elements in the list are elided. The union of Unicode coverage of all of the fonts is returned in csp, if csp is not NULL. This function should be called only after FcConfigSubstitute and FcDefaultSubstitute have been called for p; otherwise the results will not be correct.

The returned FcFontSet references FcPattern structures which may be shared by the return value from multiple FcFontSort calls, applications must not modify these patterns. Instead, they should be passed, along with p to FcFontRenderPrepare which combines them into a complete pattern.

The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy. If config is NULL, the current configuration is used.

RefPtr<Blanks> fontconfig::ConfigDelegate::getBlanks ( )

DEPRECATED used to return per-user cache filename.

With fontconfig no longer using per-user cache files, this function now simply returns NULL to indicate that no per-user file exists.Get config blanks Returns the FcBlanks object associated with the given configuration, if no blanks were present in the configuration, this function will return 0. The returned FcBlanks object if not NULL, is valid as long as the owning FcConfig is alive. If config is NULL, the current configuration is used.

RefPtr<StrList> fontconfig::ConfigDelegate::getCacheDirs ( ) const

return the list of directories searched for cache files

FcConfigGetCacheDirs returns a string list containing all of the directories that fontconfig will search when attempting to load a cache file for a font directory. If config is NULL, the current configuration is used.

RefPtr<StrList> fontconfig::ConfigDelegate::getConfigDirs ( )

Get config directories.

RefPtr<StrList> fontconfig::ConfigDelegate::getConfigFiles ( )

Get config files.

Returns the list of known configuration files used to generate config. If config is NULL, the current configuration is used.

RefPtr<StrList> fontconfig::ConfigDelegate::getFontDirs ( )

Get font directories.

Returns the list of font directories specified in the configuration files for config. Does not include any subdirectories. If config is NULL, the current configuration is used.

RefPtr<FontSet> fontconfig::ConfigDelegate::getFonts ( SetName_t set )

Get config font set.

Returns one of the two sets of fonts from the configuration as specified by set. This font set is owned by the library and must not be modified or freed. If config is NULL, the current configuration is used.

int fontconfig::ConfigDelegate::getRescanInterval ( )

Get config rescan interval.

Returns the interval between automatic checks of the configuration (in seconds) specified in config. The configuration is checked during a call to FcFontList when this interval has passed since the last check. An interval setting of zero disables automatic checks. If config is NULL, the current configuration is used.

ConfigDelegate* fontconfig::ConfigDelegate::operator-> ( )

inline

Definition at line 81 of file Config.h.

const ConfigDelegate* fontconfig::ConfigDelegate::operator-> ( ) const

inline

Definition at line 82 of file Config.h.

ConfigDelegate& fontconfig::ConfigDelegate::operator= ( const ConfigDelegate & other )

private

not assignable

bool fontconfig::ConfigDelegate::parseAndLoad	(	const Char8_t *	file,
		bool	complain
	)

load a configuration file

Walks the configuration in 'file' and constructs the internal representation in 'config'. Any include files referenced from within 'file' will be loaded and parsed. If 'complain' is FcFalse, no warning will be displayed if 'file' does not exist. Error and warning messages will be output to stderr. Returns FcFalse if some error occurred while loading the file, either a parse error, semantic error or allocation failure. Otherwise returns FcTrue.

RefPtr<Pattern> fontconfig::ConfigDelegate::renderPrepare	(	RefPtr< Pattern >	pat,
		RefPtr< Pattern >	font
	)

Prepare pattern for loading font file.

Creates a new pattern consisting of elements of font not appearing in pat, elements of pat not appearing in font and the best matching value from pat for elements appearing in both. The result is passed to FcConfigSubstituteWithPat with kind FcMatchFont and then returned.

bool fontconfig::ConfigDelegate::setCurrent ( )

Set configuration as default.

Sets the current default configuration to config. Implicitly calls FcConfigBuildFonts if necessary, returning FcFalse if that call fails.

bool fontconfig::ConfigDelegate::setRescanInterval ( int rescanInterval )

Set config rescan interval.

Sets the rescan interval. Returns FcFalse if the interval cannot be set (due to allocation failure). Otherwise returns FcTrue. An interval setting of zero disables automatic checks. If config is NULL, the current configuration is used.

bool fontconfig::ConfigDelegate::substitute	(	RefPtr< Pattern >	p,
		MatchKind_t	kind
	)

Execute substitutions.

Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue. If config is NULL, the current configuration is used.

bool fontconfig::ConfigDelegate::substituteWithPat	(	RefPtr< Pattern >	p,
		RefPtr< Pattern >	p_pat,
		MatchKind_t	kind
	)

Execute substitutions.

Performs the sequence of pattern modification operations, if kind is FcMatchPattern, then those tagged as pattern operations are applied, else if kind is FcMatchFont, those tagged as font operations are applied and p_pat is used for test elements with target=pattern. Returns FcFalse if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue. If config is NULL, the current configuration is used.

bool fontconfig::ConfigDelegate::unlink ( const Char8_t * dir )

Remove all caches related to dir.

Scans the cache directories in config, removing any instances of the cache file for dir. Returns FcFalse when some internal error occurs (out of memory, etc). Errors actually unlinking any files are ignored.

bool fontconfig::ConfigDelegate::upToDate ( )

Check timestamps on config files.

Checks all of the files related to config and returns whether any of them has been modified since the configuration was created. If config is NULL, the current configuration is used.

Friends And Related Function Documentation

friend class RefPtr< Config >

friend

Definition at line 79 of file Config.h.

Member Data Documentation

FcConfig* fontconfig::ConfigDelegate::m_ptr

private

Definition at line 61 of file Config.h.

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

include/cpp_fontconfig/Config.h

Public Member Functions

Private Member Functions

Private Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation