Linux Manuals session 3

FcFontSetCreate – Create a font set Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcFontSetCreate (void); DescriptionCreates an empty font set.

FcFontSetAdd – Add to a font set Synopsis#include <fontconfig/fontconfig.h> FcBool FcFontSetAdd (FcFontSet *s, FcPattern *font); DescriptionAdds a pattern to a font set. Note that the pattern is not copied before being inserted into the set. Returns FcFalse if the pattern cannot be inserted into the set (due to allocation failure). Otherwise returns FcTrue.

FcFontRenderPrepare – Prepare pattern for loading font file Synopsis#include <fontconfig/fontconfig.h> FcPattern * FcFontRenderPrepare (FcConfig *config, FcPattern *pat, FcPattern *font); DescriptionCreates 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…

FcFontMatch – Return best font Synopsis#include <fontconfig/fontconfig.h> FcPattern * FcFontMatch (FcConfig *config, FcPattern *p, FcResult *result); DescriptionFinds 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…

FcFontList – List fonts Synopsis#include <fontconfig/fontconfig.h> FcFontSet * FcFontList (FcConfig *config, FcPattern *p, FcObjectSet *os); DescriptionSelects 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.

FcFini – finalize fontconfig library Synopsis#include <fontconfig/fontconfig.h> void FcFini (void); DescriptionFrees all data structures allocated by previous calls to fontconfig functions. Fontconfig returns to an uninitialized state, requiring a new call to one of the FcInit functions before any other fontconfig function may be called.

FcFileScan – scan a font file Synopsis#include <fontconfig/fontconfig.h> FcBool FcFileScan (FcFontSet *set, FcStrSet *dirs, FcFileCache *cache, FcBlanks *blanks, const FcChar8 *file, FcBool force); DescriptionScans a single file and adds all fonts found to set. If force is FcTrue, then the file is scanned even if associated information is found in cache. If file is a…

FcFileIsDir – check whether a file is a directory Synopsis#include <fontconfig/fontconfig.h> FcBool FcFileIsDir (const FcChar8 *file); DescriptionReturns FcTrue if file is a directory, otherwise returns FcFalse.

FcDirScan – scan a font directory without caching it Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirScan (FcFontSet *set, FcStrSet *dirs, FcFileCache *cache, FcBlanks *blanks, const FcChar8 *dir, FcBool force); DescriptionIf cache is not zero or if force is FcFalse, this function currently returns FcFalse. Otherwise, it scans an entire directory and adds all fonts found to set. Any…

FcDirSave – DEPRECATED: formerly used to save a directory cache Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirSave (FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir); DescriptionThis function now does nothing aside from returning FcFalse. It used to creates the per-directory cache file for dir and populates it with the fonts in set and subdirectories in dirs. All of this…

FcDirCacheValid – check directory cache Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirCacheValid (const FcChar8 *dir); DescriptionReturns FcTrue if dir has an associated valid cache file, else returns FcFalse

FcDirCacheUnload – unload a cache file Synopsis#include <fontconfig/fontconfig.h> void FcDirCacheUnload (FcCache *cache); DescriptionThis function dereferences cache. When no other references to it remain, all memory associated with the cache will be freed.

FcDirCacheUnlink – Remove all caches related to dir Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirCacheUnlink (const FcChar8 *dir, FcConfig *config); DescriptionScans 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.

FcDirCacheRescan – Re-scan a directory cache Synopsis#include <fontconfig/fontconfig.h> FcCache * FcDirCacheRescan (const FcChar8 *dir, FcConfig *config); DescriptionRe-scan directories only at dir and update the cache. returns NULL if failed. Sinceversion 2.11.1

FcDirCacheRead – read or construct a directory cache Synopsis#include <fontconfig/fontconfig.h> FcCache * FcDirCacheRead (const FcChar8 *dir, FcBool force, FcConfig *config); DescriptionThis returns a cache for dir. If force is FcFalse, then an existing, valid cache file will be used. Otherwise, a new cache will be created by scanning the directory and that returned.

FcDirCacheLoadFile – load a cache file Synopsis#include <fontconfig/fontconfig.h> FcCache * FcDirCacheLoadFile (const FcChar8 *cache_file, struct stat *file_stat); DescriptionThis function loads a directory cache from cache_file. If file_stat is non-NULL, it will be filled with the results of stat(2) on the cache file.

FcDirCacheLoad – load a directory cache Synopsis#include <fontconfig/fontconfig.h> FcCache * FcDirCacheLoad (const FcChar8 *dir, FcConfig *config, FcChar8 **cache_file); DescriptionLoads the cache related to dir. If no cache file exists, returns NULL. The name of the cache file is returned in cache_file, unless that is NULL. See also FcDirCacheRead.

FcDirCacheDeleteUUID – Delete .uuid file Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirCacheDeleteUUID (const FcChar8 *dir, FcConfig *config); DescriptionThis is to delete .uuid file containing an UUID at a font directory of dir. Sinceversion 2.13.1

FcDirCacheCreateUUID – Create .uuid file at a directory Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirCacheCreateUUID (FcChar8 *dir, FcBoolforce, FcConfig *config); DescriptionThis is to create .uuid file containing an UUID at a font directory of dir. The UUID will be used to identify the font directory and is used to determine the cache filename if available. Sinceversion 2.12.92

FcDirCacheClean – Clean up a cache directory Synopsis#include <fontconfig/fontconfig.h> FcBool FcDirCacheClean (const FcChar8 *cache_dir, FcBoolverbose); DescriptionThis tries to clean up the cache directory of cache_dir. This returns FcTrue if the operation is successfully complete. otherwise FcFalse. Sinceversion 2.9.91