Documentation

Creates an empty configuration.

Sets the current default configuration to config. Implicitly calls FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count in config since 2.12.0.

Returns the current default configuration, legacy impure function!

Returns the current default configuration. WARNING: Might not behave correctly around calls to setCurrent, but given how many APIs expect a config this makes pure code easier to write.

Checks all of the files related to config and returns whether any of them has been modified since the configuration was created.

Return the current user's home directory, if it is available & if using it is enabled.

If given True, then Fontconfig will use various files which are specified relative to the user's home directory (using the ~ notation in the configuration). When its False, then all use of the home directory in these contexts will be disabled. The previous setting of the value is returned.

Builds the set of available fonts for the given configuration. Note that any changes to the configuration after this call (through parseAndLoad or parseAndLoadFromMemory) have indeterminate effects. (On the other hand, application fonts can still be modified through appFontAddFile, appFontAddDir and appFontClear).

Returns the list of font directories specified in the configuration files. Does not include any subdirectories.

Returns the list of font directories. This includes the configured font directories along with any directories below those in the filesystem.

Returns the list of known configuration files used to generate given config.

returns a string list containing all of the directories that fontconfig will search when attempting to load a cache file for a font directory.

Returns one of the two sets of fonts from the configuration as specified by set.

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.

Sets the rescan interval. An interval setting of zero disables automatic checks.

Adds an application-specific font to the configuration.

Scans the specified directory for fonts, adding each one found to the application-specific set of fonts.

Clears the set of application-specific fonts.

Performs the sequence of pattern modification operations tagged by kind. If kind is MatchPattern then those tagged as pattern operations are applied, else if kind is MatchFont those tagged as font operations are applied & p_pat is used for <test> elements with target=pattern.

Finds the font in sets most closely matching pattern and returns the result of fontRenderPrepare for that font and the provided pattern.

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.

The returned FcFontSet references FcPattern structures which may be shared by the return value from multiple FcFontSort calls, applications must not modify these patterns.

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.

Selects fonts matching p, creates patterns from those fonts containing only the given objects and returns the set of unique such patterns.

Given the specified external entity name, return the associated filename. This provides applications a way to convert various configuration file references into filename form.

An empty name indicates that the default configuration file should be used; which file this references can be overridden with the FONTCONFIG_FILE environment variable. Next, if the name starts with ~, it refers to a file in the current users home directory. Otherwise if the name doesn't start with /, it refers to a file in the default config dir; the built-in default directory can be overridden with the FONTCONFIG_PATH environment variable.

The result of this function is affected by the FONTCONFIG_SYSROOT environment variable or equivalent functionality.

Walks the configuration in path and constructs the internal representation in conf. Any include files referenced from within path will be loaded and parsed. If complain is False, no warning will be displayed if path does not exist. Error and warning messages will be output to stderr. Throws an exception if some error occurred while loading the file, either a parse error, semantic error or allocation failure. After all configuration files or strings have been loaded, with FcConfigParseAndLoad inclusive-or FcConfigParseAndLoadFromMemory, call FcConfigBuildFonts to build the font database.

Walks the configuration in buf and constructs the internal representation in conf. Any includes files referenced from within buf will be loaded and dparsed. If complain is False, no warning will be displayed if file does not exist. Error and warning messages will be output to stderr. Throws an exception if fsome error occurred while loading the file, either a parse error, semantic error or allocation failure. After all configuration files or strings have been loaded, with FcConfigParseAndLoad inclusive-or FcConfigParseAndLoadFromMemory, call FcConfigBuildFonts to build the font database.

Obtains the system root directory in conf if available. All files (including file properties in patterns) obtained from this conf are relative to this system root directory.

Set root as the system root directory. All file paths used or created with this conf (including file properties in patterns) will be considered or made relative to this root. This allows a host to generate caches for targets at build time. This also allows a cache to be re-targeted to a different base directory if FcConfigGetSysRoot is used to resolve file paths. When setting this on the current config this causes changing current config (calls FcConfigSetCurrent()).

Which set of fonts to retrieve.

Which pattern modifications to apply during substituteWithPat.