                Fontconfig Developers Reference, Version 2.18.0

Copyright © 2002 Keith Packard

Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that the
above copyright notice appear in all copies and that both that copyright notice
and this permission notice appear in supporting documentation, and that the name
of the author(s) not be used in advertising or publicity pertaining to
distribution of the software without specific, written prior permission. The
authors make no representations about the suitability of this software for any
purpose. It is provided "as is" without express or implied warranty.

THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL THE
AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY
DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

          ────────────────────────────────────────────────────────────

Table of Contents

[1]DESCRIPTION

[2]FUNCTIONAL OVERVIEW

[3]Datatypes

[4]FUNCTIONS

DESCRIPTION

Fontconfig is a library designed to provide system-wide font configuration,
customization and application access.

════════════════════════════════════════════════════════════════════════════════

FUNCTIONAL OVERVIEW

Fontconfig contains two essential modules, the configuration module which builds
an internal configuration from XML files and the matching module which accepts
font patterns and returns the nearest matching font.

════════════════════════════════════════════════════════════════════════════════

  FONT CONFIGURATION

The configuration module consists of the FcConfig datatype, libexpat and
FcConfigParse which walks over an XML tree and amends a configuration with data
found within. From an external perspective, configuration of the library
consists of generating a valid XML tree and feeding that to FcConfigParse. The
only other mechanism provided to applications for changing the running
configuration is to add fonts and directories to the list of
application-provided font files.

The intent is to make font configurations relatively static, and shared by as
many applications as possible. It is hoped that this will lead to more stable
font selection when passing names from one application to another. XML was
chosen as a configuration file format because it provides a format which is easy
for external agents to edit while retaining the correct structure and syntax.

Font configuration is separate from font matching; applications needing to do
their own matching can access the available fonts from the library and perform
private matching. The intent is to permit applications to pick and choose
appropriate functionality from the library instead of forcing them to choose
between this library and a private configuration mechanism. The hope is that
this will ensure that configuration of fonts for all applications can be
centralized in one place. Centralizing font configuration will simplify and
regularize font installation and customization.

════════════════════════════════════════════════════════════════════════════════

  FONT PROPERTIES

While font patterns may contain essentially any properties, there are some well
known properties with associated types. Fontconfig uses some of these properties
for font matching and font completion. Others are provided as a convenience for
the application's rendering mechanism.

                 Property Definitions

    Property       C Preprocessor Symbol  Type    Description
    ----------------------------------------------------
    family         FC_FAMILY              String  Font family names
    familylang     FC_FAMILYLANG          String  Language corresponding to
                                                  each family name
    style          FC_STYLE               String  Font style. Overrides weight
                                                  and slant
    stylelang      FC_STYLELANG           String  Language corresponding to
                                                  each style name
    fullname       FC_FULLNAME            String  Font face full name where
                                                  different from family and
                                                  family + style
    fullnamelang   FC_FULLNAMELANG        String  Language corresponding to
                                                  each fullname
    slant          FC_SLANT               Int     Italic, oblique or roman
    weight         FC_WEIGHT              Int     Light, medium, demibold,
                                                  bold or black
    width          FC_WIDTH               Int     Condensed, normal or expanded
    size           FC_SIZE                Double  Point size
    aspect         FC_ASPECT              Double  Stretches glyphs horizontally
                                                  before hinting
    pixelsize      FC_PIXEL_SIZE          Double  Pixel size
    spacing        FC_SPACING             Int     Proportional, dual-width,
                                                  monospace or charcell
    foundry        FC_FOUNDRY             String  Font foundry name
    antialias      FC_ANTIALIAS           Bool    Whether glyphs can be
                                                  antialiased
    hintstyle      FC_HINT_STYLE          Int     Automatic hinting style
    hinting        FC_HINTING             Bool    Whether the rasterizer should
                                                  use hinting
    verticallayout FC_VERTICAL_LAYOUT     Bool    Use vertical layout
    autohint       FC_AUTOHINT            Bool    Use autohinter instead of
                                                  normal hinter
    globaladvance  FC_GLOBAL_ADVANCE      Bool    Use font global advance data (deprecated)
    file           FC_FILE                String  The filename holding the font
                                                  relative to the config's sysroot
    index          FC_INDEX               Int     The index of the font within
                                                  the file
    ftface         FC_FT_FACE             FT_Face Use the specified FreeType
                                                  face object
    rasterizer     FC_RASTERIZER          String  Which rasterizer is in use (deprecated)
    outline        FC_OUTLINE             Bool    Whether the glyphs are outlines
    scalable       FC_SCALABLE            Bool    Whether the glyphs are outlines or have color
    dpi            FC_DPI                 Double  Target dots per inch
    rgba           FC_RGBA                Int     unknown, rgb, bgr, vrgb,
                                                  vbgr, none - subpixel geometry
    scale          FC_SCALE               Double  Scale factor for point->pixel
                                                  conversions (deprecated)
    minspace       FC_MINSPACE            Bool    Eliminate leading from line
                                                  spacing
    matrix         FC_MATRIX              Matrix  Hold an affine transformation
    charset        FC_CHARSET             CharSet Unicode chars encoded by
                                                  the font
    lang           FC_LANG                LangSet Set of RFC-3066-style
                                                  languages this font supports
    fontversion    FC_FONTVERSION         Int     Version number of the font
    capability     FC_CAPABILITY          String  List of layout capabilities in
                                                  the font
    fontformat     FC_FONTFORMAT          String  String name of the font format
    embolden       FC_EMBOLDEN            Bool    Rasterizer should
                                                  synthetically embolden the font
    embeddedbitmap FC_EMBEDDED_BITMAP     Bool    Use the embedded bitmap instead
                                                  of the outline
    decorative     FC_DECORATIVE          Bool    Whether the style is a decorative
                                                  variant
    lcdfilter      FC_LCD_FILTER          Int     Type of LCD filter
    namelang       FC_NAMELANG            String  Language name to be used for the
                                                  default value of familylang,
                                                  stylelang and fullnamelang
    fontfeatures   FC_FONT_FEATURES       String  List of extra feature tags in
                                                  OpenType to be enabled
    prgname        FC_PRGNAME             String  Name of the running program
    hash           FC_HASH                String  SHA256 hash value of the font data
                                                  with "sha256:" prefix (deprecated)
    postscriptname FC_POSTSCRIPT_NAME     String  Font name in PostScript
    color          FC_COLOR               Bool    Whether any glyphs have color
    symbol         FC_SYMBOL              Bool    Whether font uses MS symbol-font encoding
    fontvariations FC_FONT_VARIATIONS     String  comma-separated string of axes in variable font
    variable       FC_VARIABLE            Bool    Whether font is Variable Font
    fonthashint    FC_FONT_HAS_HINT       Bool    Whether font has hinting
    order          FC_ORDER               Int     Order number of the font
    desktop        FC_DESKTOP_NAME        String  Current desktop name
    namedinstance  FC_NAMED_INSTANCE      Bool    Whether font is a named instance
    fontwrapper    FC_FONT_WRAPPER        String  The font wrapper format
    genericfamily  FC_GENERIC_FAMILY      Int     Type of Generic Family corresponding
                                                  to FC_FAMILY_* constants


════════════════════════════════════════════════════════════════════════════════

Datatypes

Fontconfig uses abstract data types to hide internal implementation details for
most data structures. A few structures are exposed where appropriate.

════════════════════════════════════════════════════════════════════════════════

  FcChar8, FcChar16, FcChar32, FcBool

These are primitive data types; the FcChar* types hold precisely the number of
bits stated (if supported by the C implementation). FcBool holds one of two C
preprocessor symbols: FcFalse or FcTrue.

════════════════════════════════════════════════════════════════════════════════

  FcMatrix

An FcMatrix holds an affine transformation, usually used to reshape glyphs. A
small set of matrix operations are provided to manipulate these.

        typedef struct _FcMatrix {
                double xx, xy, yx, yy;
        } FcMatrix;


════════════════════════════════════════════════════════════════════════════════

  FcCharSet

An FcCharSet is an abstract type that holds the set of encoded Unicode chars in
a font. Operations to build and compare these sets are provided.

════════════════════════════════════════════════════════════════════════════════

  FcLangSet

An FcLangSet is an abstract type that holds the set of languages supported by a
font. Operations to build and compare these sets are provided. These are
computed for a font based on orthographic information built into the fontconfig
library. Fontconfig has orthographies for all of the ISO 639-1 languages except
for MS, NA, PA, PS, QU, RN, RW, SD, SG, SN, SU and ZA. If you have orthographic
information for any of these languages, please submit them.

════════════════════════════════════════════════════════════════════════════════

  FcLangResult

An FcLangResult is an enumeration used to return the results of comparing two
language strings or FcLangSet objects. FcLangEqual means the objects match
language and territory. FcLangDifferentTerritory means the objects match in
language but differ in territory. FcLangDifferentLang means the objects differ
in language.

════════════════════════════════════════════════════════════════════════════════

  FcType

Tags the kind of data stored in an FcValue.

════════════════════════════════════════════════════════════════════════════════

  FcValue

An FcValue object holds a single value with one of a number of different types.
The 'type' tag indicates which member is valid.

        typedef struct _FcValue {
                FcType type;
                union {
                        const FcChar8 *s;
                        int i;
                        FcBool b;
                        double d;
                        const FcMatrix *m;
                        const FcCharSet *c;
                        void *f;
                        const FcLangSet *l;
                        const FcRange   *r;
                } u;
        } FcValue;


                  FcValue Members

        Type            Union member    Datatype
        --------------------------------
        FcTypeVoid      (none)          (none)
        FcTypeInteger   i               int
        FcTypeDouble    d               double
        FcTypeString    s               FcChar8 *
        FcTypeBool      b               b
        FcTypeMatrix    m               FcMatrix *
        FcTypeCharSet   c               FcCharSet *
        FcTypeFTFace    f               void * (FT_Face)
        FcTypeLangSet   l               FcLangSet *
        FcTypeRange     r               FcRange *


════════════════════════════════════════════════════════════════════════════════

  FcPattern, FcPatternIter

An FcPattern holds a set of names with associated value lists; each name refers
to a property of a font. FcPatterns are used as inputs to the matching code as
well as holding information about specific fonts. Each property can hold one or
more values; conventionally all of the same type, although the interface doesn't
demand that. An FcPatternIter is used during iteration to access properties in
FcPattern.

════════════════════════════════════════════════════════════════════════════════

  FcFontSet

        typedef struct _FcFontSet {
                int nfont;
                int sfont;
                FcPattern **fonts;
        } FcFontSet;


An FcFontSet contains a list of FcPatterns. Internally fontconfig uses this data
structure to hold sets of fonts. Externally, fontconfig returns the results of
listing fonts in this format. 'nfont' holds the number of patterns in the
'fonts' array; 'sfont' is used to indicate the size of that array.

════════════════════════════════════════════════════════════════════════════════

  FcStrSet, FcStrList

FcStrSet holds a list of strings that can be appended to and enumerated. Its
unique characteristic is that the enumeration works even while strings are
appended during enumeration. FcStrList is used during enumeration to safely and
correctly walk the list of strings even while that list is edited in the middle
of enumeration.

════════════════════════════════════════════════════════════════════════════════

  FcObjectSet

        typedef struct _FcObjectSet {
                int nobject;
                int sobject;
                const char **objects;
        } FcObjectSet;


holds a set of names and is used to specify which fields from fonts are placed
in the the list of returned patterns when listing fonts.

════════════════════════════════════════════════════════════════════════════════

  FcObjectType

        typedef struct _FcObjectType {
                const char *object;
                FcType type;
        } FcObjectType;


marks the type of a pattern element generated when parsing font names.
Applications can add new object types so that font names may contain the new
elements.

════════════════════════════════════════════════════════════════════════════════

  FcConstant

        typedef struct _FcConstant {
            const FcChar8 *name;
            const char *object;
            int value;
        } FcConstant;


Provides for symbolic constants for new pattern elements. When 'name' is seen in
a font name, an 'object' element is created with value 'value'.

════════════════════════════════════════════════════════════════════════════════

  FcBlanks

holds a list of Unicode chars which are expected to be blank; unexpectedly blank
chars are assumed to be invalid and are elided from the charset associated with
the font.

FcBlanks is deprecated and should not be used in newly written code. It is still
accepted by some functions for compatibility with older code but will be removed
in the future.

════════════════════════════════════════════════════════════════════════════════

  FcFileCache

holds the per-user cache information for use while loading the font database.
This is built automatically for the current configuration when that is loaded.
Applications must always pass '0' when one is requested.

════════════════════════════════════════════════════════════════════════════════

  FcConfig

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.

════════════════════════════════════════════════════════════════════════════════

  FcSetName

Specifies one of the two sets of fonts available in a configuration; FcSetSystem
for those fonts specified in the configuration and FcSetApplication which holds
fonts provided by the application.

════════════════════════════════════════════════════════════════════════════════

  FcResult

Used as a return type for functions manipulating FcPattern objects.

      FcResult Values
        Result Code             Meaning
        -----------------------------------------------------------
        FcResultMatch           Object exists with the specified ID
        FcResultNoMatch         Object doesn't exist at all
        FcResultTypeMismatch    Object exists, but the type doesn't match
        FcResultNoId            Object exists, but has fewer values
                                than specified
        FcResultOutOfMemory     malloc failed


════════════════════════════════════════════════════════════════════════════════

  FcAtomic

Used for locking access to configuration files. Provides a safe way to update
configuration files.

════════════════════════════════════════════════════════════════════════════════

  FcCache

Holds information about the fonts contained in a single directory. Normal
applications need not worry about this as caches for font access are
automatically managed by the library. Applications dealing with cache management
may want to use some of these objects in their work, however the included
'fc-cache' program generally suffices for all of that.

════════════════════════════════════════════════════════════════════════════════

FUNCTIONS

These are grouped by functionality, often using the main data type being
manipulated.

════════════════════════════════════════════════════════════════════════════════

  Initialization

Table of Contents

[5]FcInitLoadConfig -- load configuration

[6]FcInitLoadConfigAndFonts -- load configuration and font data

[7]FcInit -- initialize fontconfig library

[8]FcFini -- finalize fontconfig library

[9]FcGetVersion -- library version number

[10]FcInitReinitialize -- re-initialize library

[11]FcInitBringUptoDate -- reload configuration files if needed

These functions provide some control over how the library is initialized.

                                FcInitLoadConfig

Name

FcInitLoadConfig -- load configuration

Synopsis

#include <fontconfig/fontconfig.h>


FcConfig * FcInitLoadConfig(void);

Description

Loads the default configuration file and returns the resulting configuration.
Does not load any font information.

                            FcInitLoadConfigAndFonts

Name

FcInitLoadConfigAndFonts -- load configuration and font data

Synopsis

#include <fontconfig/fontconfig.h>


FcConfig * FcInitLoadConfigAndFonts(void);

Description

Loads the default configuration file and builds information about the available
fonts. Returns the resulting configuration.

                                     FcInit

Name

FcInit -- initialize fontconfig library

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcInit(void);

Description

Loads the default configuration file and the fonts referenced therein and sets
the default configuration to that result. Returns whether this process succeeded
or not. If the default configuration has already been loaded, this routine does
nothing and returns FcTrue.

                                     FcFini

Name

FcFini -- finalize fontconfig library

Synopsis

#include <fontconfig/fontconfig.h>


void FcFini(void);

Description

Frees 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.

                                  FcGetVersion

Name

FcGetVersion -- library version number

Synopsis

#include <fontconfig/fontconfig.h>


int FcGetVersion(void);

Description

Returns the version number of the library.

                               FcInitReinitialize

Name

FcInitReinitialize -- re-initialize library

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcInitReinitialize(void);

Description

Forces the default configuration file to be reloaded and resets the default
configuration. Returns FcFalse if the configuration cannot be reloaded (due to
configuration file errors, allocation failures or other issues) and leaves the
existing configuration unchanged. Otherwise returns FcTrue.

                              FcInitBringUptoDate

Name

FcInitBringUptoDate -- reload configuration files if needed

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcInitBringUptoDate(void);

Description

Checks the rescan interval in the default configuration, checking the
configuration if the interval has passed and reloading the configuration if when
any changes are detected. Returns FcFalse if the configuration cannot be
reloaded (see FcInitReinitialize). Otherwise returns FcTrue.

════════════════════════════════════════════════════════════════════════════════

  FcPattern

Table of Contents

[12]FcPatternCreate -- Create a pattern

[13]FcPatternDuplicate -- Copy a pattern

[14]FcPatternReference -- Increment pattern reference count

[15]FcPatternDestroy -- Destroy a pattern

[16]FcPatternObjectCount -- Returns the number of the object

[17]FcPatternEqual -- Compare patterns

[18]FcPatternEqualSubset -- Compare portions of patterns

[19]FcPatternFilter -- Filter the objects of pattern

[20]FcPatternHash -- Compute a pattern hash value

[21]FcPatternAdd -- Add a value to a pattern

[22]FcPatternAddWeak -- Add a value to a pattern with weak binding

[23]FcPatternAdd-Type -- Add a typed value to a pattern

[24]FcPatternGetWithBinding -- Return a value with binding from a pattern

[25]FcPatternGet -- Return a value from a pattern

[26]FcPatternGet-Type -- Return a typed value from a pattern

[27]FcPatternBuild -- Create patterns from arguments

[28]FcPatternDel -- Delete a property from a pattern

[29]FcPatternRemove -- Remove one object of the specified type from the pattern

[30]FcPatternIterStart -- Initialize the iterator with the first iterator in the
pattern

[31]FcPatternIterNext -- 

[32]FcPatternIterEqual -- Compare iterators

[33]FcPatternFindIter -- Set the iterator to point to the object in the pattern

[34]FcPatternIterIsValid -- Check whether the iterator is valid or not

[35]FcPatternIterGetObject -- Returns an object name which the iterator point to

[36]FcPatternIterValueCount -- Returns the number of the values which the
iterator point to

[37]FcPatternIterGetValue -- Returns a value which the iterator point to

[38]FcPatternPrint -- Print a pattern for debugging

[39]FcDefaultSubstitute -- Perform default substitutions in a pattern

[40]FcConfigSetDefaultSubstitute -- Perform default substitutions in a pattern

[41]FcNameParse -- Parse a pattern string

[42]FcNameUnparse -- Convert a pattern back into a string that can be parsed

[43]FcPatternFormat -- Format a pattern into a string according to a format
specifier

An FcPattern is an opaque type that holds both patterns to match against the
available fonts, as well as the information about each font.

                                FcPatternCreate

Name

FcPatternCreate -- Create a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcPatternCreate(void);

Description

Creates a pattern with no properties; used to build patterns from scratch.

                               FcPatternDuplicate

Name

FcPatternDuplicate -- Copy a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcPatternDuplicate(const FcPattern *p);

Description

Copy a pattern, returning a new pattern that matches p. Each pattern may be
modified without affecting the other.

                               FcPatternReference

Name

FcPatternReference -- Increment pattern reference count

Synopsis

#include <fontconfig/fontconfig.h>


void FcPatternReference(FcPattern *p);

Description

Add another reference to p. Patterns are freed only when the reference count
reaches zero.

                                FcPatternDestroy

Name

FcPatternDestroy -- Destroy a pattern

Synopsis

#include <fontconfig/fontconfig.h>


void FcPatternDestroy(FcPattern *p);

Description

Decrement the pattern reference count. If all references are gone, destroys the
pattern, in the process destroying all related values.

                              FcPatternObjectCount

Name

FcPatternObjectCount -- Returns the number of the object

Synopsis

#include <fontconfig/fontconfig.h>


int FcPatternObjectCount(const FcPattern *p);

Description

Returns the number of the object p has.

Since

version 2.13.1

                                 FcPatternEqual

Name

FcPatternEqual -- Compare patterns

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternEqual(const FcPattern *pa, const FcPattern *pb);

Description

Returns whether pa and pb are exactly alike.

                              FcPatternEqualSubset

Name

FcPatternEqualSubset -- Compare portions of patterns

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternEqualSubset(const FcPattern *pa, const FcPattern *pb, const
FcObjectSet *os);

Description

Returns whether pa and pb have exactly the same values for all of the objects in
os.

                                FcPatternFilter

Name

FcPatternFilter -- Filter the objects of pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcPatternFilter(FcPattern *p, const FcObjectSet *os);

Description

Returns a new pattern that only has those objects from p that are in os. If os
is NULL, a duplicate of p is returned.

                                 FcPatternHash

Name

FcPatternHash -- Compute a pattern hash value

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcPatternHash(const FcPattern *p);

Description

Returns a 32-bit number which is the same for any two patterns which are equal.

                                  FcPatternAdd

Name

FcPatternAdd -- Add a value to a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternAdd(FcPattern *p, const char *object, FcValue value, FcBool
append);

Description

Adds a single value to the list of values associated with the property named
object. If append is FcTrue, the value is added at the end of any existing list,
otherwise it is inserted at the beginning. value is saved (with FcValueSave)
when inserted into the pattern so that the library retains no reference to any
application-supplied data structure.

                                FcPatternAddWeak

Name

FcPatternAddWeak -- Add a value to a pattern with weak binding

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternAddWeak(FcPattern *p, const char *object, FcValue value, FcBool
append);

Description

FcPatternAddWeak is essentially the same as FcPatternAdd except that any values
added to the list have binding weak instead of strong.

                               FcPatternAdd-Type

Name

FcPatternAddInteger, FcPatternAddDouble, FcPatternAddString, FcPatternAddMatrix,
FcPatternAddCharSet, FcPatternAddBool, FcPatternAddFTFace, FcPatternAddLangSet,
FcPatternAddRange -- Add a typed value to a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternAddInteger(FcPattern *p, const char *object, int i);

FcBool FcPatternAddDouble(FcPattern *p, const char *object, double d);

FcBool FcPatternAddString(FcPattern *p, const char *object, const FcChar8 *s);

FcBool FcPatternAddMatrix(FcPattern *p, const char *object, const FcMatrix *m);

FcBool FcPatternAddCharSet(FcPattern *p, const char *object, const FcCharSet
*c);

FcBool FcPatternAddBool(FcPattern *p, const char *object, FcBool b);

FcBool FcPatternAddFTFace(FcPattern *p, const char *object, const FT_Face f);

FcBool FcPatternAddLangSet(FcPattern *p, const char *object, const FcLangSet
*l);

FcBool FcPatternAddRange(FcPattern *p, const char *object, const FcRange *r);

Description

These are all convenience functions that insert objects of the specified type
into the pattern. Use these in preference to FcPatternAdd as they will provide
compile-time typechecking. These all append values to any existing list of
values. FcPatternAddRange are available since 2.11.91.

                            FcPatternGetWithBinding

Name

FcPatternGetWithBinding -- Return a value with binding from a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcResult FcPatternGetWithBinding(FcPattern *p, const char *object, int id,
FcValue *v, FcValueBinding *b);

Description

Returns in v the id'th value and b binding for that associated with the property
object. The Value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value.

Since

version 2.12.5

                                  FcPatternGet

Name

FcPatternGet -- Return a value from a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcResult FcPatternGet(FcPattern *p, const char *object, int id, FcValue *v);

Description

Returns in v the id'th value associated with the property object. The value
returned is not a copy, but rather refers to the data stored within the pattern
directly. Applications must not free this value.

                               FcPatternGet-Type

Name

FcPatternGetInteger, FcPatternGetDouble, FcPatternGetString, FcPatternGetMatrix,
FcPatternGetCharSet, FcPatternGetBool, FcPatternGetFTFace, FcPatternGetLangSet,
FcPatternGetRange -- Return a typed value from a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcResult FcPatternGetInteger(FcPattern *p, const char *object, int n, int *i);

FcResult FcPatternGetDouble(FcPattern *p, const char *object, int n, double *d);

FcResult FcPatternGetString(FcPattern *p, const char *object, int n, FcChar8
**s);

FcResult FcPatternGetMatrix(FcPattern *p, const char *object, int n, FcMatrix
**s);

FcResult FcPatternGetCharSet(FcPattern *p, const char *object, int n, FcCharSet
**c);

FcResult FcPatternGetBool(FcPattern *p, const char *object, int n, FcBool *b);

FcResult FcPatternGetFTFace(FcPattern *p, const char *object, int n, FT_Face
*f);

FcResult FcPatternGetLangSet(FcPattern *p, const char *object, int n, FcLangSet
**l);

FcResult FcPatternGetRange(FcPattern *p, const char *object, int n, FcRange
**r);

Description

These are convenience functions that call FcPatternGet and verify that the
returned data is of the expected type. They return FcResultTypeMismatch if this
is not the case. Note that these (like FcPatternGet) do not make a copy of any
data structure referenced by the return value. Use these in preference to
FcPatternGet to provide compile-time typechecking. FcPatternGetRange are
available since 2.11.91.

                                 FcPatternBuild

Name

FcPatternBuild, FcPatternVaBuild, FcPatternVapBuild -- Create patterns from
arguments

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcPatternBuild(FcPattern *pattern, ...);

FcPattern * FcPatternVaBuild(FcPattern *pattern, va_list va);

void FcPatternVapBuild(FcPattern *result, FcPattern *pattern, va_list va);

Description

Builds a pattern using a list of objects, types and values. Each value to be
entered in the pattern is specified with three arguments:

 1. Object name, a string describing the property to be added.

 2. Object type, one of the FcType enumerated values

 3. Value, not an FcValue, but the raw type as passed to any of the
    FcPatternAdd<type> functions. Must match the type of the second argument.

The argument list is terminated by a null object name, no object type nor value
need be passed for this. The values are added to `pattern', if `pattern' is
null, a new pattern is created. In either case, the pattern is returned. Example

pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);

FcPatternVaBuild is used when the arguments are already in the form of a varargs
value. FcPatternVapBuild is a macro version of FcPatternVaBuild which returns
its result directly in the result variable.

                                  FcPatternDel

Name

FcPatternDel -- Delete a property from a pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternDel(FcPattern *p, const char *object);

Description

Deletes all values associated with the property `object', returning whether the
property existed or not.

                                FcPatternRemove

Name

FcPatternRemove -- Remove one object of the specified type from the pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternRemove(FcPattern *p, const char *object, int id);

Description

Removes the value associated with the property `object' at position `id',
returning whether the property existed and had a value at that position or not.

                               FcPatternIterStart

Name

FcPatternIterStart -- Initialize the iterator with the first iterator in the
pattern

Synopsis

#include <fontconfig/fontconfig.h>


void FcPatternIterStart(const FcPattern *p, FcPatternIter *iter);

Description

Initialize iter with the first iterator in p. If there are no objects in p, iter
will not have any valid data.

Since

version 2.13.1

                               FcPatternIterNext

Name

FcPatternIterNext -- 

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternIterNext(const FcPattern *p, FcPatternIter *iter);

Description

Set iter to point to the next object in p and returns FcTrue if iter has been
changed to the next object. returns FcFalse otherwise.

Since

version 2.13.1

                               FcPatternIterEqual

Name

FcPatternIterEqual -- Compare iterators

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternIterEqual(const FcPattern *p1, FcPatternIter *i1, const
FcPattern *p2, FcPatternIter *i2);

Description

Return FcTrue if both i1 and i2 point to same object and contains same values.
return FcFalse otherwise.

Since

version 2.13.1

                               FcPatternFindIter

Name

FcPatternFindIter -- Set the iterator to point to the object in the pattern

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternFindIter(const FcPattern *p, FcPatternIter *iter, const char
*object);

Description

Set iter to point to object in p if any and returns FcTrue. returns FcFalse
otherwise.

Since

version 2.13.1

                              FcPatternIterIsValid

Name

FcPatternIterIsValid -- Check whether the iterator is valid or not

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcPatternIterIsValid(const FcPattern *p, FcPatternIter :iter);

Description

Returns FcTrue if iter point to the valid entry in p. returns FcFalse otherwise.

Since

version 2.13.1

                             FcPatternIterGetObject

Name

FcPatternIterGetObject -- Returns an object name which the iterator point to

Synopsis

#include <fontconfig/fontconfig.h>


const char * FcPatternIterGetObject(const FcPattern *p, FcPatternIter *iter);

Description

Returns an object name in p which iter point to. returns NULL if iter isn't
valid.

Since

version 2.13.1

                            FcPatternIterValueCount

Name

FcPatternIterValueCount -- Returns the number of the values which the iterator
point to

Synopsis

#include <fontconfig/fontconfig.h>


int FcPatternIterValueCount(const FcPattern *p, FcPatternIter *iter);

Description

Returns the number of the values in the object which iter point to. if iter
isn't valid, returns 0.

Since

version 2.13.1

                             FcPatternIterGetValue

Name

FcPatternIterGetValue -- Returns a value which the iterator point to

Synopsis

#include <fontconfig/fontconfig.h>


FcResult FcPatternIterGetValue(const FcPattern *p, FcPatternIter *iter, int id,
FcValue *v, FcValueBinding *b);

Description

Returns in v the id'th value which iter point to. also binding to b if given.
The value returned is not a copy, but rather refers to the data stored within
the pattern directly. Applications must not free this value.

Since

version 2.13.1

                                 FcPatternPrint

Name

FcPatternPrint -- Print a pattern for debugging

Synopsis

#include <fontconfig/fontconfig.h>


void FcPatternPrint(const FcPattern *p);

Description

Prints an easily readable version of the pattern to stdout. There is no
provision for reparsing data in this format, it's just for diagnostics and
debugging.

                              FcDefaultSubstitute

Name

FcDefaultSubstitute -- Perform default substitutions in a pattern

Synopsis

#include <fontconfig/fontconfig.h>


void FcDefaultSubstitute(FcPattern *pattern);

Description

Supplies default values for underspecified font patterns:

  • Patterns without a specified style or weight are set to Medium

  • Patterns without a specified style or slant are set to Roman

  • Patterns without a specified pixel size are given one computed from any
    specified point size (default 12), dpi (default 75) and scale (default 1).

This function has been replaced by FcConfigSetDefaultSubstitute and will be
deprecated.

                          FcConfigSetDefaultSubstitute

Name

FcConfigSetDefaultSubstitute -- Perform default substitutions in a pattern

Synopsis

#include <fontconfig/fontconfig.h>


void FcConfigSetDefaultSubstitute(FcConfig *config, FcPattern *pattern);

Description

Supplies default values for underspecified font patterns:

  • Patterns without a specified style or weight are set to Medium

  • Patterns without a specified style or slant are set to Roman

  • Patterns without a specified pixel size are given one computed from any
    specified point size (default 12), dpi (default 75) and scale (default 1).

Since

version 2.17.0

                                  FcNameParse

Name

FcNameParse -- Parse a pattern string

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcNameParse(const FcChar8 *name);

Description

Converts name from the standard text format described above into a pattern.

                                 FcNameUnparse

Name

FcNameUnparse -- Convert a pattern back into a string that can be parsed

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcNameUnparse(FcPattern *pat);

Description

Converts the given pattern into the standard text format described above. The
return value is not static, but instead refers to newly allocated memory which
should be freed by the caller using free().

                                FcPatternFormat

Name

FcPatternFormat -- Format a pattern into a string according to a format
specifier

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcPatternFormat(FcPattern *pat, const FcChar8 *format);

Description

Converts given pattern pat into text described by the format specifier format.
The return value refers to newly allocated memory which should be freed by the
caller using free(), or NULL if format is invalid.

 The format is loosely modeled after printf-style format string. The format
string is composed of zero or more directives: ordinary characters (not "%"),
which are copied unchanged to the output stream; and tags which are interpreted
to construct text from the pattern in a variety of ways (explained below).
Special characters can be escaped using backslash. C-string style special
characters like \n and \r are also supported (this is useful when the format
string is not a C string literal). It is advisable to always escape curly braces
that are meant to be copied to the output as ordinary characters.

 Each tag is introduced by the character "%", followed by an optional minimum
field width, followed by tag contents in curly braces ({}). If the minimum field
width value is provided the tag will be expanded and the result padded to
achieve the minimum width. If the minimum field width is positive, the padding
will right-align the text. Negative field width will left-align. The rest of
this section describes various supported tag contents and their expansion.

 A simple tag is one where the content is an identifier. When simple tags are
expanded, the named identifier will be looked up in pattern and the resulting
list of values returned, joined together using comma. For example, to print the
family name and style of the pattern, use the format "%{family} %{style}\n". To
extend the family column to forty characters use "%-40{family}%{style}\n".

 Simple tags expand to list of all values for an element. To only choose one of
the values, one can index using the syntax "%{elt[idx]}". For example, to get
the first family name only, use "%{family[0]}".

 If a simple tag ends with "=" and the element is found in the pattern, the name
of the element followed by "=" will be output before the list of values. For
example, "%{weight=}" may expand to the string "weight=80". Or to the empty
string if pattern does not have weight set.

 If a simple tag starts with ":" and the element is found in the pattern, ":"
will be printed first. For example, combining this with the =, the format
"%{:weight=}" may expand to ":weight=80" or to the empty string if pattern does
not have weight set.

 If a simple tag contains the string ":-", the rest of the the tag contents will
be used as a default string. The default string is output if the element is not
found in the pattern. For example, the format "%{:weight=:-123}" may expand to
":weight=80" or to the string ":weight=123" if pattern does not have weight
set.

 A count tag is one that starts with the character "#" followed by an element
name, and expands to the number of values for the element in the pattern. For
example, "%{#family}" expands to the number of family names pattern has set,
which may be zero.

 A sub-expression tag is one that expands a sub-expression. The tag contents are
the sub-expression to expand placed inside another set of curly braces.
Sub-expression tags are useful for aligning an entire sub-expression, or to
apply converters (explained later) to the entire sub-expression output. For
example, the format "%40{{%{family} %{style}}}" expands the sub-expression to
construct the family name followed by the style, then takes the entire string
and pads it on the left to be at least forty characters.

 A filter-out tag is one starting with the character "-" followed by a
comma-separated list of element names, followed by a sub-expression enclosed in
curly braces. The sub-expression will be expanded but with a pattern that has
the listed elements removed from it. For example, the format
"%{-size,pixelsize{sub-expr}}" will expand "sub-expr" with pattern sans the size
and pixelsize elements.

 A filter-in tag is one starting with the character "+" followed by a
comma-separated list of element names, followed by a sub-expression enclosed in
curly braces. The sub-expression will be expanded but with a pattern that only
has the listed elements from the surrounding pattern. For example, the format
"%{+family,familylang{sub-expr}}" will expand "sub-expr" with a sub-pattern
consisting only the family and family lang elements of pattern.

 A conditional tag is one starting with the character "?" followed by a
comma-separated list of element conditions, followed by two sub-expression
enclosed in curly braces. An element condition can be an element name, in which
case it tests whether the element is defined in pattern, or the character "!"
followed by an element name, in which case the test is negated. The conditional
passes if all the element conditions pass. The tag expands the first
sub-expression if the conditional passes, and expands the second sub-expression
otherwise. For example, the format "%{?size,dpi,!pixelsize{pass}{fail}}" will
expand to "pass" if pattern has size and dpi elements but no pixelsize element,
and to "fail" otherwise.

 An enumerate tag is one starting with the string "[]" followed by a
comma-separated list of element names, followed by a sub-expression enclosed in
curly braces. The list of values for the named elements are walked in parallel
and the sub-expression expanded each time with a pattern just having a single
value for those elements, starting from the first value and continuing as long
as any of those elements has a value. For example, the format
"%{[]family,familylang{%{family} (%{familylang})\n}}" will expand the pattern
"%{family} (%{familylang})\n" with a pattern having only the first value of the
family and familylang elements, then expands it with the second values, then the
third, etc.

 As a special case, if an enumerate tag has only one element, and that element
has only one value in the pattern, and that value is of type FcLangSet, the
individual languages in the language set are enumerated.

 A builtin tag is one starting with the character "=" followed by a builtin
name. The following builtins are defined:

unparse

        Expands to the result of calling FcNameUnparse() on the pattern.

fcmatch

        Expands to the output of the default output format of the fc-match
        command on the pattern, without the final newline.

fclist

        Expands to the output of the default output format of the fc-list
        command on the pattern, without the final newline.

fccat

        Expands to the output of the default output format of the fc-cat command
        on the pattern, without the final newline.

pkgkit

        Expands to the list of PackageKit font() tags for the pattern. Currently
        this includes tags for each family name, and each language from the
        pattern, enumerated and sanitized into a set of tags terminated by
        newline. Package management systems can use these tags to tag their
        packages accordingly.

For example, the format "%{+family,style{%{=unparse}}}\n" will expand to an
unparsed name containing only the family and style element values from pattern.

 The contents of any tag can be followed by a set of zero or more converters. A
converter is specified by the character "|" followed by the converter name and
arguments. The following converters are defined:

basename

        Replaces text with the results of calling FcStrBasename() on it.

dirname

        Replaces text with the results of calling FcStrDirname() on it.

downcase

        Replaces text with the results of calling FcStrDowncase() on it.

shescape

        Escapes text for one level of shell expansion. (Escapes single-quotes,
        also encloses text in single-quotes.)

cescape

        Escapes text such that it can be used as part of a C string literal.
        (Escapes backslash and double-quotes.)

xmlescape

        Escapes text such that it can be used in XML and HTML. (Escapes
        less-than, greater-than, and ampersand.)

delete(chars)

        Deletes all occurrences of each of the characters in chars from the
        text. FIXME: This converter is not UTF-8 aware yet.

escape(chars)

        Escapes all occurrences of each of the characters in chars by prepending
        it by the first character in chars. FIXME: This converter is not UTF-8
        aware yet.

translate(from,to)

        Translates all occurrences of each of the characters in from by
        replacing them with their corresponding character in to. If to has fewer
        characters than from, it will be extended by repeating its last
        character. FIXME: This converter is not UTF-8 aware yet.

const

        Replace text against a targeted element with the result of calling
        FcNameGetConstantNameFrom(). If text isn't none of any constant name, it
        simply fails.

For example, the format "%{family|downcase|delete( )}\n" will expand to the
values of the family element in pattern, lower-cased and with spaces removed.

Since

version 2.9.0

════════════════════════════════════════════════════════════════════════════════

  FcFontSet

Table of Contents

[44]FcFontSetCreate -- Create a font set

[45]FcFontSetDestroy -- Destroy a font set

[46]FcFontSetAdd -- Add to a font set

[47]FcFontSetList -- List fonts from a set of font sets

[48]FcFontSetMatch -- Return the best font from a set of font sets

[49]FcFontSetPrint -- Print a set of patterns to stdout

[50]FcFontSetSort -- Return list of matching fonts

[51]FcFontSetSortDestroy -- DEPRECATED destroy a font set

An FcFontSet simply holds a list of patterns; these are used to return the
results of listing available fonts.

                                FcFontSetCreate

Name

FcFontSetCreate -- Create a font set

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcFontSetCreate(void);

Description

Creates an empty font set.

                                FcFontSetDestroy

Name

FcFontSetDestroy -- Destroy a font set

Synopsis

#include <fontconfig/fontconfig.h>


void FcFontSetDestroy(FcFontSet *s);

Description

Destroys a font set. Note that this destroys any referenced patterns as well.

                                  FcFontSetAdd

Name

FcFontSetAdd -- Add to a font set

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcFontSetAdd(FcFontSet *s, FcPattern *font);

Description

Adds 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.

                                 FcFontSetList

Name

FcFontSetList -- List fonts from a set of font sets

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcFontSetList(FcConfig *config, FcFontSet **sets, int nsets,
FcPattern *pattern, FcObjectSet *object_set);

Description

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.

                                 FcFontSetMatch

Name

FcFontSetMatch -- Return the best font from a set of font sets

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcFontSetMatch(FcConfig *config, FcFontSet **sets, int nsets,
FcPattern *pattern, FcResult *result);

Description

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.

                                 FcFontSetPrint

Name

FcFontSetPrint -- Print a set of patterns to stdout

Synopsis

#include <fontconfig/fontconfig.h>


void FcFontSetPrint(FcFontSet *set);

Description

This function is useful for diagnosing font related issues, printing the
complete contents of every pattern in set. The format of the output is designed
to be of help to users and developers, and may change at any time.

                                 FcFontSetSort

Name

FcFontSetSort -- Return list of matching fonts

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcFontSetSort(FcConfig *config, FcFontSet **sets, int nsets,
FcPattern *pattern, FcBool trim, FcCharSet **csp, FcResult *result);

Description

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.

                              FcFontSetSortDestroy

Name

FcFontSetSortDestroy -- DEPRECATED destroy a font set

Synopsis

#include <fontconfig/fontconfig.h>


void FcFontSetSortDestroy(FcFontSet *set);

Description

This function is DEPRECATED. FcFontSetSortDestroy destroys set by calling
FcFontSetDestroy. Applications should use FcFontSetDestroy directly instead.

════════════════════════════════════════════════════════════════════════════════

  FcObjectSet

Table of Contents

[52]FcObjectSetCreate -- Create an object set

[53]FcObjectSetAdd -- Add to an object set

[54]FcObjectSetDestroy -- Destroy an object set

[55]FcObjectSetBuild -- Build object set from args

An FcObjectSet holds a list of pattern property names; it is used to indicate
which properties are to be returned in the patterns from FcFontList.

                               FcObjectSetCreate

Name

FcObjectSetCreate -- Create an object set

Synopsis

#include <fontconfig/fontconfig.h>


FcObjectSet * FcObjectSetCreate(void);

Description

Creates an empty set.

                                 FcObjectSetAdd

Name

FcObjectSetAdd -- Add to an object set

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcObjectSetAdd(FcObjectSet *os, const char *object);

Description

Adds a property name to the set. Returns FcFalse if the property name cannot be
inserted into the set (due to allocation failure). Otherwise returns FcTrue.

                               FcObjectSetDestroy

Name

FcObjectSetDestroy -- Destroy an object set

Synopsis

#include <fontconfig/fontconfig.h>


void FcObjectSetDestroy(FcObjectSet *os);

Description

Destroys an object set.

                                FcObjectSetBuild

Name

FcObjectSetBuild, FcObjectSetVaBuild, FcObjectSetVapBuild -- Build object set
from args

Synopsis

#include <fontconfig/fontconfig.h>


FcObjectSet * FcObjectSetBuild(const char *first, ...);

FcObjectSet * FcObjectSetVaBuild(const char *first, va_list va);

void FcObjectSetVapBuild(FcObjectSet *result, const char *first, va_list va);

Description

These build an object set from a null-terminated list of property names.
FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns the
result in the result variable directly.

════════════════════════════════════════════════════════════════════════════════

  FreeType specific functions

Table of Contents

[56]FcFreeTypeCharIndex -- map Unicode to glyph id

[57]FcFreeTypeCharSet -- compute Unicode coverage

[58]FcFreeTypeCharSetAndSpacing -- compute Unicode coverage and spacing type

[59]FcFreeTypeQuery -- compute pattern from font file (and index)

[60]FcFreeTypeQueryAll -- compute all patterns from font file (and index)

[61]FcFreeTypeQueryFace -- compute pattern from FT_Face

While the fontconfig library doesn't insist that FreeType be used as the
rasterization mechanism for fonts, it does provide some convenience functions.

                              FcFreeTypeCharIndex

Name

FcFreeTypeCharIndex -- map Unicode to glyph id

Synopsis

#include <fontconfig.h>
#include <fcfreetype.h>


FT_UInt FcFreeTypeCharIndex(FT_Face face, FcChar32 ucs4);

Description

Maps a Unicode char to a glyph index. This function uses information from
several possible underlying encoding tables to work around broken fonts. As a
result, this function isn't designed to be used in performance sensitive areas;
results from this function are intended to be cached by higher level functions.

                               FcFreeTypeCharSet

Name

FcFreeTypeCharSet -- compute Unicode coverage

Synopsis

#include <fontconfig.h>
#include <fcfreetype.h>


FcCharSet * FcFreeTypeCharSet(FT_Face face, FcBlanks *blanks);

Description

Scans a FreeType face and returns the set of encoded Unicode chars. FcBlanks is
deprecated, blanks is ignored and accepted only for compatibility with older
code.

                          FcFreeTypeCharSetAndSpacing

Name

FcFreeTypeCharSetAndSpacing -- compute Unicode coverage and spacing type

Synopsis

#include <fontconfig.h>
#include <fcfreetype.h>


FcCharSet * FcFreeTypeCharSetAndSpacing(FT_Face face, FcBlanks *blanks, int
*spacing);

Description

Scans a FreeType face and returns the set of encoded Unicode chars. FcBlanks is
deprecated, blanks is ignored and accepted only for compatibility with older
code. spacing receives the computed spacing type of the font, one of FC_MONO for
a font where all glyphs have the same width, FC_DUAL, where the font has glyphs
in precisely two widths, one twice as wide as the other, or FC_PROPORTIONAL
where the font has glyphs of many widths.

                                FcFreeTypeQuery

Name

FcFreeTypeQuery -- compute pattern from font file (and index)

Synopsis

#include <fontconfig.h>
#include <fcfreetype.h>


FcPattern * FcFreeTypeQuery(const FcChar8 *file, int id, FcBlanks *blanks, int
*count);

Description

Constructs a pattern representing the 'id'th face in 'file'. The number of faces
in 'file' is returned in 'count'. FcBlanks is deprecated, blanks is ignored and
accepted only for compatibility with older code.

                               FcFreeTypeQueryAll

Name

FcFreeTypeQueryAll -- compute all patterns from font file (and index)

Synopsis

#include <fontconfig.h>
#include <fcfreetype.h>


unsigned int FcFreeTypeQueryAll(const FcChar8 *file, int id, FcBlanks *blanks,
int *count, FcFontSet *set);

Description

Constructs patterns found in 'file'. If id is -1, then all patterns found in
'file' are added to 'set'. Otherwise, this function works exactly like
FcFreeTypeQuery(). The number of faces in 'file' is returned in 'count'. The
number of patterns added to 'set' is returned. FcBlanks is deprecated, blanks is
ignored and accepted only for compatibility with older code.

Since

version 2.12.91

                              FcFreeTypeQueryFace

Name

FcFreeTypeQueryFace -- compute pattern from FT_Face

Synopsis

#include <fontconfig.h>
#include <fcfreetype.h>


FcPattern * FcFreeTypeQueryFace(const FT_Face face, const FcChar8 *file, int id,
FcBlanks *blanks);

Description

Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY). FcBlanks
is deprecated, blanks is ignored and accepted only for compatibility with older
code.

════════════════════════════════════════════════════════════════════════════════

  Fontations specific functions

Table of Contents

[62]FcFontationsQueryAll -- compute all patterns from font file (and index)

For font indexing, an alternative backend based on the Fontations set of font
libraries is in development. The indexing functions are exposed as Fontations
specific functions.

                              FcFontationsQueryAll

Name

FcFontationsQueryAll -- compute all patterns from font file (and index)

Synopsis

#include <fontconfig.h>
#include <fcfontations.h>


unsigned int FcFontationsQueryAll(const FcChar8 *file, int id, FcBlanks *blanks,
int *count, FcFontSet *set);

Description

UNSTABLE feature. Constructs patterns found in 'file'. Currently pattern is
incomplete compared to FcFreeTypeQueryAll() and may deviate from what FreeType
indexing produces. Not supported yet, but will follow: If id is -1, then all
patterns found in 'file' are added to 'set'. Otherwise, this function works
exactly like FcFreeTypeQueryAll()/FcFreeTypeQuery(). The number of faces in
'file' is returned in 'count'. The number of patterns added to 'set' is
returned. FcBlanks is deprecated, blanks is ignored and accepted only for
compatibility with older code.

Since

version 2.17.0

════════════════════════════════════════════════════════════════════════════════

  FcValue

Table of Contents

[63]FcValueDestroy -- Free a value

[64]FcValueSave -- Copy a value

[65]FcValuePrint -- Print a value to stdout

[66]FcValueEqual -- Test two values for equality

FcValue is a structure containing a type tag and a union of all possible
datatypes. The tag is an enum of type FcType and is intended to provide a
measure of run-time typechecking, although that depends on careful programming.

                                 FcValueDestroy

Name

FcValueDestroy -- Free a value

Synopsis

#include <fontconfig/fontconfig.h>


void FcValueDestroy(FcValue v);

Description

Frees any memory referenced by v. Values of type FcTypeString, FcTypeMatrix and
FcTypeCharSet reference memory, the other types do not.

                                  FcValueSave

Name

FcValueSave -- Copy a value

Synopsis

#include <fontconfig/fontconfig.h>


FcValue FcValueSave(FcValue v);

Description

Returns a copy of v duplicating any object referenced by it so that v may be
safely destroyed without harming the new value.

                                  FcValuePrint

Name

FcValuePrint -- Print a value to stdout

Synopsis

#include <fontconfig/fontconfig.h>


void FcValuePrint(FcValue v);

Description

Prints a human-readable representation of v to stdout. The format should not be
considered part of the library specification as it may change in the future.

                                  FcValueEqual

Name

FcValueEqual -- Test two values for equality

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcValueEqual(FcValue v_a, FcValue v_b);

Description

Compares two values. Integers and Doubles are compared as numbers; otherwise the
two values have to be the same type to be considered equal. Strings are compared
ignoring case.

════════════════════════════════════════════════════════════════════════════════

  FcCharSet

Table of Contents

[67]FcCharSetCreate -- Create an empty character set

[68]FcCharSetDestroy -- Destroy a character set

[69]FcCharSetAddChar -- Add a character to a charset

[70]FcCharSetDelChar -- Delete a character from a charset

[71]FcCharSetCopy -- Copy a charset

[72]FcCharSetEqual -- Compare two charsets

[73]FcCharSetIntersect -- Intersect charsets

[74]FcCharSetUnion -- Add charsets

[75]FcCharSetSubtract -- Subtract charsets

[76]FcCharSetMerge -- Merge charsets

[77]FcCharSetHasChar -- Check a charset for a char

[78]FcCharSetCount -- Count entries in a charset

[79]FcCharSetIntersectCount -- Intersect and count charsets

[80]FcCharSetSubtractCount -- Subtract and count charsets

[81]FcCharSetIsSubset -- Test for charset inclusion

[82]FcCharSetFirstPage -- Start enumerating charset contents

[83]FcCharSetNextPage -- Continue enumerating charset contents

[84]FcCharSetCoverage -- DEPRECATED return coverage for a Unicode page

[85]FcCharSetNew -- DEPRECATED alias for FcCharSetCreate

An FcCharSet is a boolean array indicating a set of Unicode chars. Those
associated with a font are marked constant and cannot be edited. FcCharSets may
be reference counted internally to reduce memory consumption; this may be
visible to applications as the result of FcCharSetCopy may return it's argument,
and that CharSet may remain unmodifiable.

                                FcCharSetCreate

Name

FcCharSetCreate -- Create an empty character set

Synopsis

#include <fontconfig/fontconfig.h>


FcCharSet * FcCharSetCreate(void);

Description

FcCharSetCreate allocates and initializes a new empty character set object.

                                FcCharSetDestroy

Name

FcCharSetDestroy -- Destroy a character set

Synopsis

#include <fontconfig/fontconfig.h>


void FcCharSetDestroy(FcCharSet *fcs);

Description

FcCharSetDestroy decrements the reference count fcs. If the reference count
becomes zero, all memory referenced is freed.

                                FcCharSetAddChar

Name

FcCharSetAddChar -- Add a character to a charset

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcCharSetAddChar(FcCharSet *fcs, FcChar32 ucs4);

Description

FcCharSetAddChar adds a single Unicode char to the set, returning FcFalse on
failure, either as a result of a constant set or from running out of memory.

                                FcCharSetDelChar

Name

FcCharSetDelChar -- Delete a character from a charset

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcCharSetDelChar(FcCharSet *fcs, FcChar32 ucs4);

Description

FcCharSetDelChar deletes a single Unicode char from the set, returning FcFalse
on failure, either as a result of a constant set or from running out of memory.

Since

version 2.9.0

                                 FcCharSetCopy

Name

FcCharSetCopy -- Copy a charset

Synopsis

#include <fontconfig/fontconfig.h>


FcCharSet * FcCharSetCopy(FcCharSet *src);

Description

Makes a copy of src; note that this may not actually do anything more than
increment the reference count on src.

                                 FcCharSetEqual

Name

FcCharSetEqual -- Compare two charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcCharSetEqual(const FcCharSet *a, const FcCharSet *b);

Description

Returns whether a and b contain the same set of Unicode chars.

                               FcCharSetIntersect

Name

FcCharSetIntersect -- Intersect charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcCharSet * FcCharSetIntersect(const FcCharSet *a, const FcCharSet *b);

Description

Returns a set including only those chars found in both a and b.

                                 FcCharSetUnion

Name

FcCharSetUnion -- Add charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcCharSet * FcCharSetUnion(const FcCharSet *a, const FcCharSet *b);

Description

Returns a set including only those chars found in either a or b.

                               FcCharSetSubtract

Name

FcCharSetSubtract -- Subtract charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcCharSet * FcCharSetSubtract(const FcCharSet *a, const FcCharSet *b);

Description

Returns a set including only those chars found in a but not b.

                                 FcCharSetMerge

Name

FcCharSetMerge -- Merge charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcCharSetMerge(FcCharSet *a, const FcCharSet *b, FcBool *changed);

Description

Adds all chars in b to a. In other words, this is an in-place version of
FcCharSetUnion. If changed is not NULL, then it returns whether any new chars
from b were added to a. Returns FcFalse on failure, either when a is a constant
set or from running out of memory.

                                FcCharSetHasChar

Name

FcCharSetHasChar -- Check a charset for a char

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcCharSetHasChar(const FcCharSet *fcs, FcChar32 ucs4);

Description

Returns whether fcs contains the char ucs4.

                                 FcCharSetCount

Name

FcCharSetCount -- Count entries in a charset

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcCharSetCount(const FcCharSet *a);

Description

Returns the total number of Unicode chars in a.

                            FcCharSetIntersectCount

Name

FcCharSetIntersectCount -- Intersect and count charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcCharSetIntersectCount(const FcCharSet *a, const FcCharSet *b);

Description

Returns the number of chars that are in both a and b.

                             FcCharSetSubtractCount

Name

FcCharSetSubtractCount -- Subtract and count charsets

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcCharSetSubtractCount(const FcCharSet *a, const FcCharSet *b);

Description

Returns the number of chars that are in a but not in b.

                               FcCharSetIsSubset

Name

FcCharSetIsSubset -- Test for charset inclusion

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcCharSetIsSubset(const FcCharSet *a, const FcCharSet *b);

Description

Returns whether a is a subset of b.

                               FcCharSetFirstPage

Name

FcCharSetFirstPage -- Start enumerating charset contents

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcCharSetFirstPage(const FcCharSet *a, FcChar32[FC_CHARSET_MAP_SIZE]
map, FcChar32 *next);

Description

Builds an array of bits in map marking the first page of Unicode coverage of a.
*next is set to contains the base code point for the next page in a. Returns the
base code point for the page, or FC_CHARSET_DONE if a contains no pages. As an
example, if FcCharSetFirstPage returns 0x300 and fills map with

0xffffffff 0xffffffff 0x01000008 0x44300002 0xffffd7f0 0xfffffffb 0xffff7fff 0xffff0003

Then the page contains code points 0x300 through 0x33f (the first 64 code points
on the page) because map[0] and map[1] both have all their bits set. It also
contains code points 0x343 (0x300 + 32*2 + (4-1)) and 0x35e (0x300 + 32*2 +
(31-1)) because map[2] has the 4th and 31st bits set. The code points
represented by map[3] and later are left as an exercise for the reader ;).

                               FcCharSetNextPage

Name

FcCharSetNextPage -- Continue enumerating charset contents

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcCharSetNextPage(const FcCharSet *a, FcChar32[FC_CHARSET_MAP_SIZE]
map, FcChar32 *next);

Description

Builds an array of bits in map marking the Unicode coverage of a for page
containing *next (see the FcCharSetFirstPage description for details). *next is
set to contains the base code point for the next page in a. Returns the base of
code point for the page, or FC_CHARSET_DONE if a does not contain *next.

                               FcCharSetCoverage

Name

FcCharSetCoverage -- DEPRECATED return coverage for a Unicode page

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcCharSetCoverage(const FcCharSet *a, FcChar32 page, FcChar32[8]
result);

Description

DEPRECATED This function returns a bitmask in result which indicates which code
points in page are included in a. FcCharSetCoverage returns the next page in the
charset which has any coverage.

                                  FcCharSetNew

Name

FcCharSetNew -- DEPRECATED alias for FcCharSetCreate

Synopsis

#include <fontconfig/fontconfig.h>


FcCharSet * FcCharSetNew(void);

Description

FcCharSetNew is a DEPRECATED alias for FcCharSetCreate.

════════════════════════════════════════════════════════════════════════════════

  FcLangSet

Table of Contents

[86]FcLangSetCreate -- create a langset object

[87]FcLangSetDestroy -- destroy a langset object

[88]FcLangSetCopy -- copy a langset object

[89]FcLangSetAdd -- add a language to a langset

[90]FcLangSetDel -- delete a language from a langset

[91]FcLangSetUnion -- Add langsets

[92]FcLangSetSubtract -- Subtract langsets

[93]FcLangSetCompare -- compare language sets

[94]FcLangSetContains -- check langset subset relation

[95]FcLangSetEqual -- test for matching langsets

[96]FcLangSetHash -- return a hash value for a langset

[97]FcLangSetHasLang -- test langset for language support

[98]FcGetDefaultLangs -- Get the default languages list

[99]FcConfigGetDefaultLangs -- Get the default languages list

[100]FcLangSetGetLangs -- get the list of languages in the langset

[101]FcGetLangs -- Get list of languages

[102]FcLangNormalize -- Normalize the language string

[103]FcLangGetCharSet -- Get character map for a language

An FcLangSet is a set of language names (each of which include language and an
optional territory). They are used when selecting fonts to indicate which
languages the fonts need to support. Each font is marked, using language
orthography information built into fontconfig, with the set of supported
languages.

                                FcLangSetCreate

Name

FcLangSetCreate -- create a langset object

Synopsis

#include <fontconfig/fontconfig.h>


FcLangSet * FcLangSetCreate(void);

Description

FcLangSetCreate creates a new FcLangSet object.

                                FcLangSetDestroy

Name

FcLangSetDestroy -- destroy a langset object

Synopsis

#include <fontconfig/fontconfig.h>


void FcLangSetDestroy(FcLangSet *ls);

Description

FcLangSetDestroy destroys a FcLangSet object, freeing all memory associated with
it.

                                 FcLangSetCopy

Name

FcLangSetCopy -- copy a langset object

Synopsis

#include <fontconfig/fontconfig.h>


FcLangSet * FcLangSetCopy(const FcLangSet *ls);

Description

FcLangSetCopy creates a new FcLangSet object and populates it with the contents
of ls.

                                  FcLangSetAdd

Name

FcLangSetAdd -- add a language to a langset

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcLangSetAdd(FcLangSet *ls, const FcChar8 *lang);

Description

lang is added to ls. lang should be of the form Ll-Tt where Ll is a two or three
letter language from ISO 639 and Tt is a territory from ISO 3166.

                                  FcLangSetDel

Name

FcLangSetDel -- delete a language from a langset

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcLangSetDel(FcLangSet *ls, const FcChar8 *lang);

Description

lang is removed from ls. lang should be of the form Ll-Tt where Ll is a two or
three letter language from ISO 639 and Tt is a territory from ISO 3166.

Since

version 2.9.0

                                 FcLangSetUnion

Name

FcLangSetUnion -- Add langsets

Synopsis

#include <fontconfig/fontconfig.h>


FcLangSet * FcLangSetUnion(const FcLangSet *ls_a, const FcLangSet *ls_b);

Description

Returns a set including only those languages found in either ls_a or ls_b.

Since

version 2.9.0

                               FcLangSetSubtract

Name

FcLangSetSubtract -- Subtract langsets

Synopsis

#include <fontconfig/fontconfig.h>


FcLangSet * FcLangSetSubtract(const FcLangSet *ls_a, const FcLangSet *ls_b);

Description

Returns a set including only those languages found in ls_a but not in ls_b.

Since

version 2.9.0

                                FcLangSetCompare

Name

FcLangSetCompare -- compare language sets

Synopsis

#include <fontconfig/fontconfig.h>


FcLangResult FcLangSetCompare(const FcLangSet *ls_a, const FcLangSet *ls_b);

Description

FcLangSetCompare compares language coverage for ls_a and ls_b. If they share any
language and territory pair, this function returns FcLangEqual. If they share a
language but differ in which territory that language is for, this function
returns FcLangDifferentTerritory. If they share no languages in common, this
function returns FcLangDifferentLang.

                               FcLangSetContains

Name

FcLangSetContains -- check langset subset relation

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcLangSetContains(const FcLangSet *ls_a, const FcLangSet *ls_b);

Description

FcLangSetContains returns FcTrue if ls_a contains every language in ls_b. ls_a
will 'contain' a language from ls_b if ls_a has exactly the language, or either
the language or ls_a has no territory.

                                 FcLangSetEqual

Name

FcLangSetEqual -- test for matching langsets

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcLangSetEqual(const FcLangSet *ls_a, const FcLangSet *ls_b);

Description

Returns FcTrue if and only if ls_a supports precisely the same language and
territory combinations as ls_b.

                                 FcLangSetHash

Name

FcLangSetHash -- return a hash value for a langset

Synopsis

#include <fontconfig/fontconfig.h>


FcChar32 FcLangSetHash(const FcLangSet *ls);

Description

This function returns a value which depends solely on the languages supported by
ls. Any language which equals ls will have the same result from FcLangSetHash.
However, two langsets with the same hash value may not be equal.

                                FcLangSetHasLang

Name

FcLangSetHasLang -- test langset for language support

Synopsis

#include <fontconfig/fontconfig.h>


FcLangResult FcLangSetHasLang(const FcLangSet *ls, const FcChar8 *lang);

Description

FcLangSetHasLang checks whether ls supports lang. If ls has a matching language
and territory pair, this function returns FcLangEqual. If ls has a matching
language but differs in which territory that language is for, this function
returns FcLangDifferentTerritory. If ls has no matching language, this function
returns FcLangDifferentLang.

                               FcGetDefaultLangs

Name

FcGetDefaultLangs -- Get the default languages list

Synopsis

#include <fontconfig/fontconfig.h>


FcStrSet * FcGetDefaultLangs(void);

Description

Returns a string set of the default languages according to the environment
variables on the system. This function looks for them in order of FC_LANG,
LC_ALL, LC_CTYPE and LANG then. If there are no valid values in those
environment variables, "en" will be set as fallback.

This function has been replaced by FcConfigGetDefaultLangs and will be
deprecated.

Since

version 2.9.91

                            FcConfigGetDefaultLangs

Name

FcConfigGetDefaultLangs -- Get the default languages list

Synopsis

#include <fontconfig/fontconfig.h>


FcStrSet * FcConfigGetDefaultLangs(FcConfig *config);

Description

Returns a string set of the default languages according to the environment
variables on the system. This function looks for them in order of FC_LANG,
LC_ALL, LC_CTYPE and LANG then. If there are no valid values in those
environment variables, "en" will be set as fallback.

Since

version 2.17.0

                               FcLangSetGetLangs

Name

FcLangSetGetLangs -- get the list of languages in the langset

Synopsis

#include <fontconfig/fontconfig.h>


FcStrSet * FcLangSetGetLangs(const FcLangSet *ls);

Description

Returns a string set of all languages in langset.

                                   FcGetLangs

Name

FcGetLangs -- Get list of languages

Synopsis

#include <fontconfig/fontconfig.h>


FcStrSet * FcGetLangs(void);

Description

Returns a string set of all known languages.

                                FcLangNormalize

Name

FcLangNormalize -- Normalize the language string

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcLangNormalize(const FcChar8 *lang);

Description

Returns a string to make lang suitable on fontconfig.

Since

version 2.10.91

                                FcLangGetCharSet

Name

FcLangGetCharSet -- Get character map for a language

Synopsis

#include <fontconfig/fontconfig.h>


const FcCharSet * FcLangGetCharSet(const FcChar8 *lang);

Description

Returns the FcCharMap for a language.

════════════════════════════════════════════════════════════════════════════════

  FcMatrix

Table of Contents

[104]FcMatrixInit -- initialize an FcMatrix structure

[105]FcMatrixCopy -- Copy a matrix

[106]FcMatrixEqual -- Compare two matrices

[107]FcMatrixMultiply -- Multiply matrices

[108]FcMatrixRotate -- Rotate a matrix

[109]FcMatrixScale -- Scale a matrix

[110]FcMatrixShear -- Shear a matrix

FcMatrix structures hold an affine transformation in matrix form.

                                  FcMatrixInit

Name

FcMatrixInit -- initialize an FcMatrix structure

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixInit(FcMatrix *matrix);

Description

FcMatrixInit initializes matrix to the identity matrix.

                                  FcMatrixCopy

Name

FcMatrixCopy -- Copy a matrix

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixCopy(const FcMatrix *matrix);

Description

FcMatrixCopy allocates a new FcMatrix and copies mat into it.

                                 FcMatrixEqual

Name

FcMatrixEqual -- Compare two matrices

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixEqual(const FcMatrix *matrix1, const FcMatrix *matrix2);

Description

FcMatrixEqual compares matrix1 and matrix2 returning FcTrue when they are equal
and FcFalse when they are not.

                                FcMatrixMultiply

Name

FcMatrixMultiply -- Multiply matrices

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixMultiply(FcMatrix *result, const FcMatrix *matrix1, const FcMatrix
*matrix2);

Description

FcMatrixMultiply multiplies matrix1 and matrix2 storing the result in result.

                                 FcMatrixRotate

Name

FcMatrixRotate -- Rotate a matrix

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixRotate(FcMatrix *matrix, double cos, double sin);

Description

FcMatrixRotate rotates matrix by the angle who's sine is sin and cosine is cos.
This is done by multiplying by the matrix:

  cos -sin
  sin  cos

                                 FcMatrixScale

Name

FcMatrixScale -- Scale a matrix

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixScale(FcMatrix *matrix, double sx, double dy);

Description

FcMatrixScale multiplies matrix x values by sx and y values by dy. This is done
by multiplying by the matrix:

   sx  0
   0   dy

                                 FcMatrixShear

Name

FcMatrixShear -- Shear a matrix

Synopsis

#include <fontconfig/fontconfig.h>


void FcMatrixShear(FcMatrix *matrix, double sh, double sv);

Description

FcMatrixShare shears matrix horizontally by sh and vertically by sv. This is
done by multiplying by the matrix:

  1  sh
  sv  1

════════════════════════════════════════════════════════════════════════════════

  FcRange

Table of Contents

[111]FcRangeCopy -- Copy a range object

[112]FcRangeCreateDouble -- create a range object for double

[113]FcRangeCreateInteger -- create a range object for integer

[114]FcRangeDestroy -- destroy a range object

[115]FcRangeGetDouble -- Get the range in double

An FcRange holds two variables to indicate a range in between.

                                  FcRangeCopy

Name

FcRangeCopy -- Copy a range object

Synopsis

#include <fontconfig/fontconfig.h>


FcRange * FcRangeCopy(const FcRange *range);

Description

FcRangeCopy creates a new FcRange object and populates it with the contents of
range.

Since

version 2.11.91

                              FcRangeCreateDouble

Name

FcRangeCreateDouble -- create a range object for double

Synopsis

#include <fontconfig/fontconfig.h>


FcRange * FcRangeCreateDouble(double begin, double end);

Description

FcRangeCreateDouble creates a new FcRange object with double sized value.

Since

version 2.11.91

                              FcRangeCreateInteger

Name

FcRangeCreateInteger -- create a range object for integer

Synopsis

#include <fontconfig/fontconfig.h>


FcRange * FcRangeCreateInteger(int begin, int end);

Description

FcRangeCreateInteger creates a new FcRange object with integer sized value.

Since

version 2.11.91

                                 FcRangeDestroy

Name

FcRangeDestroy -- destroy a range object

Synopsis

#include <fontconfig/fontconfig.h>


void FcRangeDestroy(FcRange *range);

Description

FcRangeDestroy destroys a FcRange object, freeing all memory associated with it.

Since

version 2.11.91

                                FcRangeGetDouble

Name

FcRangeGetDouble -- Get the range in double

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcRangeGetDouble(const FcRange *range, double *begin, double *end);

Description

Returns in begin and end as the range.

Since

version 2.11.91

════════════════════════════════════════════════════════════════════════════════

  FcConfigFile

Table of Contents

[116]FcConfigFileGenerate -- Generate a configuration for fonts at the given
font path

Generate a configuration in XML format from a font file

                              FcConfigFileGenerate

Name

FcConfigFileGenerate -- Generate a configuration for fonts at the given font
path

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcConfigFileGenerate(FcConfig *config, FcPattern *pat, const FcChar8
*font_path);

Description

Generate a configuration in XML format for fonts at the given font_path. pat
pattern to correct and filter font metadata. The supported parameter is
`family', `genericfamily', and `lang' at this moment.

Since

version 2.18.0

════════════════════════════════════════════════════════════════════════════════

  FcConfig

Table of Contents

[117]FcConfigCreate -- Create a configuration

[118]FcConfigReference -- Increment config reference count

[119]FcConfigDestroy -- Destroy a configuration

[120]FcConfigSetCurrent -- Set configuration as default

[121]FcConfigGetCurrent -- Return current configuration

[122]FcConfigSetFontSetFilter -- Set a predicate function to filter fontsets

[123]FcConfigAcceptFilter -- Test whether the given pattern matches filter

[124]FcConfigUptoDate -- Check timestamps on config files

[125]FcConfigHome -- return the current home directory.

[126]FcConfigEnableHome -- controls use of the home directory.

[127]FcConfigBuildFonts -- Build font database

[128]FcConfigGetConfigDirs -- Get config directories

[129]FcConfigGetFontDirs -- Get font directories

[130]FcConfigGetConfigFiles -- Get config files

[131]FcConfigGetCache -- DEPRECATED used to return per-user cache filename

[132]FcConfigGetCacheDirs -- return the list of directories searched for cache
files

[133]FcConfigGetFonts -- Get config font set

[134]FcConfigGetBlanks -- Get config blanks

[135]FcConfigGetRescanInterval -- Get config rescan interval

[136]FcConfigSetRescanInterval -- Set config rescan interval

[137]FcConfigAppFontAddFile -- Add font file to font database

[138]FcConfigAppFontAddDir -- Add fonts from directory to font database

[139]FcConfigAppFontClear -- Remove all app fonts from font database

[140]FcConfigSubstituteWithPat -- Execute substitutions

[141]FcConfigSubstitute -- Execute substitutions

[142]FcFontMatch -- Return best font

[143]FcFontSort -- Return list of matching fonts

[144]FcFontRenderPrepare -- Prepare pattern for loading font file

[145]FcFontList -- List fonts

[146]FcConfigFilename -- Find a config file

[147]FcConfigGetFilename -- Find a config file

[148]FcConfigParseAndLoad -- load a configuration file

[149]FcConfigParseAndLoadFromMemory -- load a configuration from memory

[150]FcConfigGetSysRoot -- Obtain the system root directory

[151]FcConfigSetSysRoot -- Set the system root directory

[152]FcConfigFileInfoIterInit -- Initialize the iterator

[153]FcConfigFileInfoIterNext -- Set the iterator to point to the next list

[154]FcConfigFileInfoIterGet -- Obtain the configuration file information

[155]FcConfigAcceptFont -- Test whether the given pattern matches deny list

[156]FcConfigPreferAppFont -- 

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.

                                 FcConfigCreate

Name

FcConfigCreate -- Create a configuration

Synopsis

#include <fontconfig/fontconfig.h>


FcConfig * FcConfigCreate(void);

Description

Creates an empty configuration.

                               FcConfigReference

Name

FcConfigReference -- Increment config reference count

Synopsis

#include <fontconfig/fontconfig.h>


FcConfig * FcConfigReference(FcConfig *config);

Description

Add another reference to config. Configs are freed only when the reference count
reaches zero. If config is NULL, the current configuration is used. In that case
this function will be similar to FcConfigGetCurrent() except that it increments
the reference count before returning and the user is responsible for destroying
the configuration when not needed anymore.

                                FcConfigDestroy

Name

FcConfigDestroy -- Destroy a configuration

Synopsis

#include <fontconfig/fontconfig.h>


void FcConfigDestroy(FcConfig *config);

Description

Decrements the config reference count. If all references are gone, destroys the
configuration and any data associated with it. Note that calling this function
with the return from FcConfigGetCurrent will cause a new configuration to be
created for use as current configuration.

                               FcConfigSetCurrent

Name

FcConfigSetCurrent -- Set configuration as default

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigSetCurrent(FcConfig *config);

Description

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, returning FcFalse if that call fails.

                               FcConfigGetCurrent

Name

FcConfigGetCurrent -- Return current configuration

Synopsis

#include <fontconfig/fontconfig.h>


FcConfig * FcConfigGetCurrent(void);

Description

Returns the current default configuration.

                            FcConfigSetFontSetFilter

Name

FcConfigSetFontSetFilter -- Set a predicate function to filter fontsets

Synopsis

#include <fontconfig/fontconfig.h>


FcConfig * FcConfigSetFontSetFilter(FcConfig *config, FcFilterFontSetFunc
filter_func, FcDestroyFunc destroy_data_func, void *user_data);

Description

Sets filter_func as a predicate function and filter out fontsets in config as
desired. filter_func will be called with a font pattern and user_data only when
loading caches. When config is going to be destroyed, user_data will be
destroyed through destroy_data_func if it is set.

Since

version 2.16.0

                              FcConfigAcceptFilter

Name

FcConfigAcceptFilter -- Test whether the given pattern matches filter

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigAcceptFilter(FcConfig *config, const FcPattern *font);

Description

This triggers a predicate function set by FcConfigSetFontSetFilter and return
FcTrue if font matches something they expect. otherwise FcFalse.

Since

version 2.16.0

                                FcConfigUptoDate

Name

FcConfigUptoDate -- Check timestamps on config files

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigUptoDate(FcConfig *config);

Description

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.

                                  FcConfigHome

Name

FcConfigHome -- return the current home directory.

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcConfigHome(void);

Description

Return the current user's home directory, if it is available, and if using it is
enabled, and NULL otherwise. See also FcConfigEnableHome).

                               FcConfigEnableHome

Name

FcConfigEnableHome -- controls use of the home directory.

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigEnableHome(FcBool enable);

Description

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

                               FcConfigBuildFonts

Name

FcConfigBuildFonts -- Build font database

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigBuildFonts(FcConfig *config);

Description

Builds the set of available fonts for the given configuration. Note that any
changes to the configuration after this call (through FcConfigParseAndLoad or
FcConfigParseAndLoadFromMemory) have indeterminate effects. (On the other hand,
application fonts can still be modified through FcConfigAppFontAddFile,
FcConfigAppFontAddDir and FcConfigAppFontClear). Returns FcFalse if this
operation runs out of memory. If config is NULL, the current configuration is
used.

                             FcConfigGetConfigDirs

Name

FcConfigGetConfigDirs -- Get config directories

Synopsis

#include <fontconfig/fontconfig.h>


FcStrList * FcConfigGetConfigDirs(FcConfig *config);

Description

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.

                              FcConfigGetFontDirs

Name

FcConfigGetFontDirs -- Get font directories

Synopsis

#include <fontconfig/fontconfig.h>


FcStrList * FcConfigGetFontDirs(FcConfig *config);

Description

Returns the list of font directories in config. This includes the configured
font directories along with any directories below those in the filesystem. If
config is NULL, the current configuration is used.

                             FcConfigGetConfigFiles

Name

FcConfigGetConfigFiles -- Get config files

Synopsis

#include <fontconfig/fontconfig.h>


FcStrList * FcConfigGetConfigFiles(FcConfig *config);

Description

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

                                FcConfigGetCache

Name

FcConfigGetCache -- DEPRECATED used to return per-user cache filename

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcConfigGetCache(FcConfig *config);

Description

With fontconfig no longer using per-user cache files, this function now simply
returns NULL to indicate that no per-user file exists.

                              FcConfigGetCacheDirs

Name

FcConfigGetCacheDirs -- return the list of directories searched for cache files

Synopsis

#include <fontconfig/fontconfig.h>


FcStrList * FcConfigGetCacheDirs(const FcConfig *config);

Description

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.

                                FcConfigGetFonts

Name

FcConfigGetFonts -- Get config font set

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcConfigGetFonts(FcConfig *config, FcSetName set);

Description

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.

This function isn't MT-safe. FcConfigReference must be called before using this
and then FcConfigDestroy when the return value is no longer referenced.

                               FcConfigGetBlanks

Name

FcConfigGetBlanks -- Get config blanks

Synopsis

#include <fontconfig/fontconfig.h>


FcBlanks * FcConfigGetBlanks(FcConfig *config);

Description

FcBlanks is deprecated. This function always returns NULL.

                           FcConfigGetRescanInterval

Name

FcConfigGetRescanInterval -- Get config rescan interval

Synopsis

#include <fontconfig/fontconfig.h>


int FcConfigGetRescanInterval(FcConfig *config);

Description

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.

                           FcConfigSetRescanInterval

Name

FcConfigSetRescanInterval -- Set config rescan interval

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigSetRescanInterval(FcConfig *config, int rescanInterval);

Description

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.

                             FcConfigAppFontAddFile

Name

FcConfigAppFontAddFile -- Add font file to font database

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigAppFontAddFile(FcConfig *config, const FcChar8 *file);

Description

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

                             FcConfigAppFontAddDir

Name

FcConfigAppFontAddDir -- Add fonts from directory to font database

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigAppFontAddDir(FcConfig *config, const FcChar8 *dir);

Description

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.

                              FcConfigAppFontClear

Name

FcConfigAppFontClear -- Remove all app fonts from font database

Synopsis

#include <fontconfig/fontconfig.h>


void FcConfigAppFontClear(FcConfig *config);

Description

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

                           FcConfigSubstituteWithPat

Name

FcConfigSubstituteWithPat -- Execute substitutions

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigSubstituteWithPat(FcConfig *config, FcPattern *p, FcPattern
*p_pat, FcMatchKind kind);

Description

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.

                               FcConfigSubstitute

Name

FcConfigSubstitute -- Execute substitutions

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigSubstitute(FcConfig *config, FcPattern *p, FcMatchKind kind);

Description

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.

                                  FcFontMatch

Name

FcFontMatch -- Return best font

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcFontMatch(FcConfig *config, FcPattern *p, FcResult *result);

Description

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.

                                   FcFontSort

Name

FcFontSort -- Return list of matching fonts

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcFontSort(FcConfig *config, FcPattern *p, FcBool trim, FcCharSet
**csp, FcResult *result);

Description

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.

                              FcFontRenderPrepare

Name

FcFontRenderPrepare -- Prepare pattern for loading font file

Synopsis

#include <fontconfig/fontconfig.h>


FcPattern * FcFontRenderPrepare(FcConfig *config, FcPattern *pat, FcPattern
*font);

Description

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.

                                   FcFontList

Name

FcFontList -- List fonts

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcFontList(FcConfig *config, FcPattern *p, FcObjectSet *os);

Description

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.

                                FcConfigFilename

Name

FcConfigFilename -- Find a config file

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcConfigFilename(const FcChar8 *name);

Description

This function is deprecated and is replaced by FcConfigGetFilename.

                              FcConfigGetFilename

Name

FcConfigGetFilename -- Find a config file

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcConfigGetFilename(FcConfig *config, const FcChar8 *name);

Description

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

A null or 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 configuration directory; 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.

                              FcConfigParseAndLoad

Name

FcConfigParseAndLoad -- load a configuration file

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigParseAndLoad(FcConfig *config, const FcChar8 *file, FcBool
complain);

Description

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. After all configuration
files / strings have been loaded, with FcConfigParseAndLoad and/or
FcConfigParseAndLoadFromMemory, call FcConfigBuildFonts to build the font
database.

                         FcConfigParseAndLoadFromMemory

Name

FcConfigParseAndLoadFromMemory -- load a configuration from memory

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigParseAndLoadFromMemory(FcConfig *config, const FcChar8 *buffer,
FcBool complain);

Description

Walks the configuration in 'memory' and constructs the internal representation
in 'config'. Any includes files referenced from within 'memory' will be loaded
and dparsed. 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 fsome error occurred while loading the file, either a parse error,
semantic error or allocation failure. Otherwise returns FcTrue. After all
configuration files / strings have been loaded, with FcConfigParseAndLoad and/or
FcConfigParseAndLoadFromMemory, call FcConfigBuildFonts to build the font
database.

Since

version 2.12.5

                               FcConfigGetSysRoot

Name

FcConfigGetSysRoot -- Obtain the system root directory

Synopsis

#include <fontconfig/fontconfig.h>


const FcChar8 * FcConfigGetSysRoot(const FcConfig *config);

Description

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

This function isn't MT-safe. FcConfigReference must be called before using this
and then FcConfigDestroy when the return value is no longer referenced.

Since

version 2.10.92

                               FcConfigSetSysRoot

Name

FcConfigSetSysRoot -- Set the system root directory

Synopsis

#include <fontconfig/fontconfig.h>


void FcConfigSetSysRoot(FcConfig *config, const FcChar8 *sysroot);

Description

Set 'sysroot' as the system root directory. All file paths used or created with
this 'config' (including file properties in patterns) will be considered or made
relative to this 'sysroot'. 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()).

Since

version 2.10.92

                            FcConfigFileInfoIterInit

Name

FcConfigFileInfoIterInit -- Initialize the iterator

Synopsis

#include <fontconfig/fontconfig.h>


void FcConfigFileInfoIterInit(FcConfig *config, FcConfigFileInfoIter *iter);

Description

Initialize 'iter' with the first iterator in the config file information list.

The config file information list is stored in numerical order for filenames i.e.
how fontconfig actually read them.

This function isn't MT-safe. FcConfigReference must be called before using this
and then FcConfigDestroy when the relevant values are no longer referenced.

Since

version 2.12.91

                            FcConfigFileInfoIterNext

Name

FcConfigFileInfoIterNext -- Set the iterator to point to the next list

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigFileInfoIterNext(FcConfig *config, FcConfigFileInfoIter *iter);

Description

Set 'iter' to point to the next node in the config file information list. If
there is no next node, FcFalse is returned.

This function isn't MT-safe. FcConfigReference must be called before using
FcConfigFileInfoIterInit and then FcConfigDestroy when the relevant values are
no longer referenced.

Since

version 2.12.91

                            FcConfigFileInfoIterGet

Name

FcConfigFileInfoIterGet -- Obtain the configuration file information

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigFileInfoIterGet(FcConfig *config, FcConfigFileInfoIter *iter,
FcChar8 **name, FcChar8 **description, FcBool *enabled);

Description

Obtain the filename, the description and the flag whether it is enabled or not
for 'iter' where points to current configuration file information. If the
iterator is invalid, FcFalse is returned.

This function isn't MT-safe. FcConfigReference must be called before using
FcConfigFileInfoIterInit and then FcConfigDestroy when the relevant values are
no longer referenced.

Since

version 2.12.91

                               FcConfigAcceptFont

Name

FcConfigAcceptFont -- Test whether the given pattern matches deny list

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcConfigAcceptFont(FcConfig *config, FcPattern *pat);

Description

fontconfig has the deny list which is built against <rejectfont> directive in
configuration file. This function tries to match 'pat' with them and return
FcFalse if 'pat' is rejected, otherwise FcTrue.

Since

version 2.15.1

                             FcConfigPreferAppFont

Name

FcConfigPreferAppFont -- 

Synopsis

#include <fontconfig/fontconfig.h>


void FcConfigPreferAppFont(FcConfig *config, FcBool flag);

Description

Set 'flag' to change the priority of Application fonts. default behavior is
turned off for backward compatibility.

Since

version 2.17.0

════════════════════════════════════════════════════════════════════════════════

  FcObjectType

Table of Contents

[157]FcNameRegisterObjectTypes -- Register object types

[158]FcNameUnregisterObjectTypes -- Unregister object types

[159]FcNameGetObjectType -- Lookup an object type

Provides for application-specified font name object types so that new pattern
elements can be generated from font names.

                           FcNameRegisterObjectTypes

Name

FcNameRegisterObjectTypes -- Register object types

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcNameRegisterObjectTypes(const FcObjectType *types, int ntype);

Description

Deprecated. Does nothing. Returns FcFalse.

                          FcNameUnregisterObjectTypes

Name

FcNameUnregisterObjectTypes -- Unregister object types

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcNameUnregisterObjectTypes(const FcObjectType *types, int ntype);

Description

Deprecated. Does nothing. Returns FcFalse.

                              FcNameGetObjectType

Name

FcNameGetObjectType -- Lookup an object type

Synopsis

#include <fontconfig/fontconfig.h>


const FcObjectType * FcNameGetObjectType(const char *object);

Description

Return the object type for the pattern element named object.

════════════════════════════════════════════════════════════════════════════════

  FcConstant

Table of Contents

[160]FcNameRegisterConstants -- Register symbolic constants

[161]FcNameUnregisterConstants -- Unregister symbolic constants

[162]FcNameGetConstant -- Lookup symbolic constant

[163]FcNameGetConstantFor -- Lookup symbolic constant For object

[164]FcNameConstant -- Get the value for a symbolic constant

[165]FcNameGetConstantNameFrom -- Reverse-lookup a constant name from object
name and value

Provides for application-specified symbolic constants for font names.

                            FcNameRegisterConstants

Name

FcNameRegisterConstants -- Register symbolic constants

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcNameRegisterConstants(const FcConstant *consts, int nconsts);

Description

Deprecated. Does nothing. Returns FcFalse.

                           FcNameUnregisterConstants

Name

FcNameUnregisterConstants -- Unregister symbolic constants

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcNameUnregisterConstants(const FcConstant *consts, int nconsts);

Description

Deprecated. Does nothing. Returns FcFalse.

                               FcNameGetConstant

Name

FcNameGetConstant -- Lookup symbolic constant

Synopsis

#include <fontconfig/fontconfig.h>


const FcConstant * FcNameGetConstant(FcChar8 *string);

Description

Return the FcConstant structure related to symbolic constant string.

                              FcNameGetConstantFor

Name

FcNameGetConstantFor -- Lookup symbolic constant For object

Synopsis

#include <fontconfig/fontconfig.h>


const FcConstant * FcNameGetConstantFor(FcChar8 *string, char *object);

Description

Return the FcConstant structure related to symbolic constant string for object.

                                 FcNameConstant

Name

FcNameConstant -- Get the value for a symbolic constant

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcNameConstant(FcChar8 *string, int *result);

Description

Returns whether a symbolic constant with name string is registered, placing the
value of the constant in result if present.

                           FcNameGetConstantNameFrom

Name

FcNameGetConstantNameFrom -- Reverse-lookup a constant name from object name and
value

Synopsis

#include <fontconfig/fontconfig.h>


const FcChar8 * FcNameGetConstantNameFrom(const char *object, int value);

Description

Obtain a corresponding constant name for value in object. NULL if no such
constant name is available.

Since

version 2.18.0

════════════════════════════════════════════════════════════════════════════════

  FcWeight

Table of Contents

[166]FcWeightFromOpenTypeDouble -- Convert from OpenType weight values to
fontconfig ones

[167]FcWeightToOpenTypeDouble -- Convert from fontconfig weight values to
OpenType ones

[168]FcWeightFromOpenType -- Convert from OpenType weight values to fontconfig
ones

[169]FcWeightToOpenType -- Convert from fontconfig weight values to OpenType
ones

Maps weights to and from OpenType weights.

                           FcWeightFromOpenTypeDouble

Name

FcWeightFromOpenTypeDouble -- Convert from OpenType weight values to fontconfig
ones

Synopsis

#include <fontconfig/fontconfig.h>


double FcWeightFromOpenTypeDouble(double ot_weight);

Description

FcWeightFromOpenTypeDouble returns an double value to use with FC_WEIGHT, from
an double in the 1..1000 range, resembling the numbers from OpenType
specification's OS/2 usWeight numbers, which are also similar to CSS font-weight
numbers. If input is negative, zero, or greater than 1000, returns -1. This
function linearly interpolates between various FC_WEIGHT_* constants. As such,
the returned value does not necessarily match any of the predefined constants.

Since

version 2.12.92

                            FcWeightToOpenTypeDouble

Name

FcWeightToOpenTypeDouble -- Convert from fontconfig weight values to OpenType
ones

Synopsis

#include <fontconfig/fontconfig.h>


double FcWeightToOpenTypeDouble(double ot_weight);

Description

FcWeightToOpenTypeDouble is the inverse of FcWeightFromOpenType. If the input is
less than FC_WEIGHT_THIN or greater than FC_WEIGHT_EXTRABLACK, returns -1.
Otherwise returns a number in the range 1 to 1000.

Since

version 2.12.92

                              FcWeightFromOpenType

Name

FcWeightFromOpenType -- Convert from OpenType weight values to fontconfig ones

Synopsis

#include <fontconfig/fontconfig.h>


int FcWeightFromOpenType(int ot_weight);

Description

FcWeightFromOpenType is like FcWeightFromOpenTypeDouble but with integer
arguments. Use the other function instead.

Since

version 2.11.91

                               FcWeightToOpenType

Name

FcWeightToOpenType -- Convert from fontconfig weight values to OpenType ones

Synopsis

#include <fontconfig/fontconfig.h>


int FcWeightToOpenType(int ot_weight);

Description

FcWeightToOpenType is like FcWeightToOpenTypeDouble but with integer arguments.
Use the other function instead.

Since

version 2.11.91

════════════════════════════════════════════════════════════════════════════════

  FcBlanks

Table of Contents

[170]FcBlanksCreate -- Create an FcBlanks

[171]FcBlanksDestroy -- Destroy and FcBlanks

[172]FcBlanksAdd -- Add a character to an FcBlanks

[173]FcBlanksIsMember -- Query membership in an FcBlanks

An FcBlanks object holds a list of Unicode chars which are expected to be blank
when drawn. When scanning new fonts, any glyphs which are empty and not in this
list will be assumed to be broken and not placed in the FcCharSet associated
with the font. This provides a significantly more accurate CharSet for
applications.

FcBlanks is deprecated and should not be used in newly written code. It is still
accepted by some functions for compatibility with older code but will be removed
in the future.

                                 FcBlanksCreate

Name

FcBlanksCreate -- Create an FcBlanks

Synopsis

#include <fontconfig/fontconfig.h>


FcBlanks * FcBlanksCreate(void);

Description

FcBlanks is deprecated. This function always returns NULL.

                                FcBlanksDestroy

Name

FcBlanksDestroy -- Destroy and FcBlanks

Synopsis

#include <fontconfig/fontconfig.h>


void FcBlanksDestroy(FcBlanks *b);

Description

FcBlanks is deprecated. This function does nothing.

                                  FcBlanksAdd

Name

FcBlanksAdd -- Add a character to an FcBlanks

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcBlanksAdd(FcBlanks *b, FcChar32 ucs4);

Description

FcBlanks is deprecated. This function always returns FALSE.

                                FcBlanksIsMember

Name

FcBlanksIsMember -- Query membership in an FcBlanks

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcBlanksIsMember(FcBlanks *b, FcChar32 ucs4);

Description

FcBlanks is deprecated. This function always returns FALSE.

════════════════════════════════════════════════════════════════════════════════

  FcAtomic

Table of Contents

[174]FcAtomicCreate -- create an FcAtomic object

[175]FcAtomicLock -- lock a file

[176]FcAtomicNewFile -- return new temporary file name

[177]FcAtomicOrigFile -- return original file name

[178]FcAtomicReplaceOrig -- replace original with new

[179]FcAtomicDeleteNew -- delete new file

[180]FcAtomicUnlock -- unlock a file

[181]FcAtomicDestroy -- destroy an FcAtomic object

These functions provide a safe way to update configuration files, allowing
ongoing reading of the old configuration file while locked for writing and
ensuring that a consistent and complete version of the configuration file is
always available.

                                 FcAtomicCreate

Name

FcAtomicCreate -- create an FcAtomic object

Synopsis

#include <fontconfig/fontconfig.h>


FcAtomic * FcAtomicCreate(const FcChar8 *file);

Description

Creates a data structure containing data needed to control access to file.
Writing is done to a separate file. Once that file is complete, the original
configuration file is atomically replaced so that reading process always see a
consistent and complete file without the need to lock for reading.

                                  FcAtomicLock

Name

FcAtomicLock -- lock a file

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcAtomicLock(FcAtomic *atomic);

Description

Attempts to lock the file referenced by atomic. Returns FcFalse if the file is
already locked, else returns FcTrue and leaves the file locked.

                                FcAtomicNewFile

Name

FcAtomicNewFile -- return new temporary file name

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcAtomicNewFile(FcAtomic *atomic);

Description

Returns the filename for writing a new version of the file referenced by atomic.

                                FcAtomicOrigFile

Name

FcAtomicOrigFile -- return original file name

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcAtomicOrigFile(FcAtomic *atomic);

Description

Returns the file referenced by atomic.

                              FcAtomicReplaceOrig

Name

FcAtomicReplaceOrig -- replace original with new

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcAtomicReplaceOrig(FcAtomic *atomic);

Description

Replaces the original file referenced by atomic with the new file. Returns
FcFalse if the file cannot be replaced due to permission issues in the
filesystem. Otherwise returns FcTrue.

                               FcAtomicDeleteNew

Name

FcAtomicDeleteNew -- delete new file

Synopsis

#include <fontconfig/fontconfig.h>


void FcAtomicDeleteNew(FcAtomic *atomic);

Description

Deletes the new file. Used in error recovery to back out changes.

                                 FcAtomicUnlock

Name

FcAtomicUnlock -- unlock a file

Synopsis

#include <fontconfig/fontconfig.h>


void FcAtomicUnlock(FcAtomic *atomic);

Description

Unlocks the file.

                                FcAtomicDestroy

Name

FcAtomicDestroy -- destroy an FcAtomic object

Synopsis

#include <fontconfig/fontconfig.h>


void FcAtomicDestroy(FcAtomic *atomic);

Description

Destroys atomic.

════════════════════════════════════════════════════════════════════════════════

  File and Directory routines

Table of Contents

[182]FcFileScan -- scan a font file

[183]FcFileIsDir -- check whether a file is a directory

[184]FcDirScan -- scan a font directory without caching it

[185]FcDirSave -- DEPRECATED: formerly used to save a directory cache

[186]FcDirCacheUnlink -- Remove all caches related to dir

[187]FcDirCacheValid -- check directory cache

[188]FcDirCacheLoad -- load a directory cache

[189]FcDirCacheRescan -- Re-scan a directory cache

[190]FcDirCacheRead -- read or construct a directory cache

[191]FcDirCacheLoadFile -- load a cache file

[192]FcDirCacheUnload -- unload a cache file

These routines work with font files and directories, including font directory
cache files.

                                   FcFileScan

Name

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);

Description

Scans 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 directory, it is added to dirs. Whether fonts are found depends on fontconfig
policy as well as the current configuration. Internally, fontconfig will ignore
BDF and PCF fonts which are not in Unicode (or the effectively equivalent ISO
Latin-1) encoding as those are not usable by Unicode-based applications. The
configuration can ignore fonts based on filename or contents of the font file
itself. Returns FcFalse if any of the fonts cannot be added (due to allocation
failure). Otherwise returns FcTrue.

                                  FcFileIsDir

Name

FcFileIsDir -- check whether a file is a directory

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcFileIsDir(const FcChar8 *file);

Description

Returns FcTrue if file is a directory, otherwise returns FcFalse.

                                   FcDirScan

Name

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);

Description

If 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 subdirectories found are added to dirs. Calling this function does not
create any cache files. Use FcDirCacheRead() if caching is desired.

                                   FcDirSave

Name

FcDirSave -- DEPRECATED: formerly used to save a directory cache

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcDirSave(FcFontSet *set, FcStrSet *dirs, const FcChar8 *dir);

Description

This 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 functionality is now automatically managed
by FcDirCacheLoad and FcDirCacheRead.

                                FcDirCacheUnlink

Name

FcDirCacheUnlink -- Remove all caches related to dir

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcDirCacheUnlink(const FcChar8 *dir, FcConfig *config);

Description

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.

                                FcDirCacheValid

Name

FcDirCacheValid -- check directory cache

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcDirCacheValid(const FcChar8 *dir);

Description

Returns FcTrue if dir has an associated valid cache file, else returns FcFalse

                                 FcDirCacheLoad

Name

FcDirCacheLoad -- load a directory cache

Synopsis

#include <fontconfig/fontconfig.h>


FcCache * FcDirCacheLoad(const FcChar8 *dir, FcConfig *config, FcChar8
**cache_file);

Description

Loads 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.

                                FcDirCacheRescan

Name

FcDirCacheRescan -- Re-scan a directory cache

Synopsis

#include <fontconfig/fontconfig.h>


FcCache * FcDirCacheRescan(const FcChar8 *dir, FcConfig *config);

Description

Re-scan directories only at dir and update the cache. returns NULL if failed.

Since

version 2.11.1

                                 FcDirCacheRead

Name

FcDirCacheRead -- read or construct a directory cache

Synopsis

#include <fontconfig/fontconfig.h>


FcCache * FcDirCacheRead(const FcChar8 *dir, FcBool force, FcConfig *config);

Description

This 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

Name

FcDirCacheLoadFile -- load a cache file

Synopsis

#include <fontconfig/fontconfig.h>


FcCache * FcDirCacheLoadFile(const FcChar8 *cache_file, struct stat *file_stat);

Description

This 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.

                                FcDirCacheUnload

Name

FcDirCacheUnload -- unload a cache file

Synopsis

#include <fontconfig/fontconfig.h>


void FcDirCacheUnload(FcCache *cache);

Description

This function dereferences cache. When no other references to it remain, all
memory associated with the cache will be freed.

════════════════════════════════════════════════════════════════════════════════

  FcCache routines

Table of Contents

[193]FcCacheDir -- Return directory of cache

[194]FcCacheCopySet -- Returns a copy of the fontset from cache

[195]FcCacheSubdir -- Return the i'th subdirectory.

[196]FcCacheNumSubdir -- Return the number of subdirectories in cache.

[197]FcCacheNumFont -- Returns the number of fonts in cache.

[198]FcDirCacheClean -- Clean up a cache directory

[199]FcCacheCreateTagFile -- Create CACHEDIR.TAG at cache directory.

[200]FcDirCacheCreateUUID -- Create .uuid file at a directory

[201]FcDirCacheDeleteUUID -- Delete .uuid file

These routines work with font directory caches, accessing their contents in
limited ways. It is not expected that normal applications will need to use these
functions.

                                   FcCacheDir

Name

FcCacheDir -- Return directory of cache

Synopsis

#include <fontconfig/fontconfig.h>


const FcChar8 * FcCacheDir(const FcCache *cache);

Description

This function returns the directory from which the cache was constructed.

                                 FcCacheCopySet

Name

FcCacheCopySet -- Returns a copy of the fontset from cache

Synopsis

#include <fontconfig/fontconfig.h>


FcFontSet * FcCacheCopySet(const FcCache *cache);

Description

The returned fontset contains each of the font patterns from cache. This fontset
may be modified, but the patterns from the cache are read-only.

                                 FcCacheSubdir

Name

FcCacheSubdir -- Return the i'th subdirectory.

Synopsis

#include <fontconfig/fontconfig.h>


const FcChar8 * FcCacheSubdir(const FcCache *cache, int i);

Description

The set of subdirectories stored in a cache file are indexed by this function, i
should range from 0 to n-1, where n is the return value from FcCacheNumSubdir.

                                FcCacheNumSubdir

Name

FcCacheNumSubdir -- Return the number of subdirectories in cache.

Synopsis

#include <fontconfig/fontconfig.h>


int FcCacheNumSubdir(const FcCache *cache);

Description

This returns the total number of subdirectories in the cache.

                                 FcCacheNumFont

Name

FcCacheNumFont -- Returns the number of fonts in cache.

Synopsis

#include <fontconfig/fontconfig.h>


int FcCacheNumFont(const FcCache *cache);

Description

This returns the number of fonts which would be included in the return from
FcCacheCopySet.

                                FcDirCacheClean

Name

FcDirCacheClean -- Clean up a cache directory

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcDirCacheClean(const FcChar8 *cache_dir, FcBool verbose);

Description

This tries to clean up the cache directory of cache_dir. This returns FcTrue if
the operation is successfully complete. otherwise FcFalse.

Since

version 2.9.91

                              FcCacheCreateTagFile

Name

FcCacheCreateTagFile -- Create CACHEDIR.TAG at cache directory.

Synopsis

#include <fontconfig/fontconfig.h>


void FcCacheCreateTagFile(const FcConfig *config);

Description

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

Since

version 2.9.91

                              FcDirCacheCreateUUID

Name

FcDirCacheCreateUUID -- Create .uuid file at a directory

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcDirCacheCreateUUID(FcChar8 *dir, FcBool force, FcConfig *config);

Description

This function is deprecated. it doesn't take any effects.

Since

version 2.12.92

                              FcDirCacheDeleteUUID

Name

FcDirCacheDeleteUUID -- Delete .uuid file

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcDirCacheDeleteUUID(const FcChar8 *dir, FcConfig *config);

Description

This is to delete .uuid file containing an UUID at a font directory of dir.

Since

version 2.13.1

════════════════════════════════════════════════════════════════════════════════

  FcStrSet and FcStrList

Table of Contents

[202]FcStrSetCreate -- create a string set

[203]FcStrSetMember -- check set for membership

[204]FcStrSetEqual -- check sets for equality

[205]FcStrSetAdd -- add to a string set

[206]FcStrSetAddFilename -- add a filename to a string set

[207]FcStrSetDel -- delete from a string set

[208]FcStrSetDestroy -- destroy a string set

[209]FcStrListCreate -- create a string iterator

[210]FcStrListFirst -- get first string in iteration

[211]FcStrListNext -- get next string in iteration

[212]FcStrListDone -- destroy a string iterator

A data structure for enumerating strings, used to list directories while
scanning the configuration as directories are added while scanning.

                                 FcStrSetCreate

Name

FcStrSetCreate -- create a string set

Synopsis

#include <fontconfig/fontconfig.h>


FcStrSet * FcStrSetCreate(void);

Description

Create an empty set.

                                 FcStrSetMember

Name

FcStrSetMember -- check set for membership

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcStrSetMember(FcStrSet *set, const FcChar8 *s);

Description

Returns whether s is a member of set.

                                 FcStrSetEqual

Name

FcStrSetEqual -- check sets for equality

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcStrSetEqual(FcStrSet *set_a, FcStrSet *set_b);

Description

Returns whether set_a contains precisely the same strings as set_b. Ordering of
strings within the two sets is not considered.

                                  FcStrSetAdd

Name

FcStrSetAdd -- add to a string set

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcStrSetAdd(FcStrSet *set, const FcChar8 *s);

Description

Adds a copy of s to set.

                              FcStrSetAddFilename

Name

FcStrSetAddFilename -- add a filename to a string set

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcStrSetAddFilename(FcStrSet *set, const FcChar8 *s);

Description

Adds a copy s to set, The copy is created with FcStrCopyFilename so that leading
'~' values are replaced with the value of the HOME environment variable.

                                  FcStrSetDel

Name

FcStrSetDel -- delete from a string set

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcStrSetDel(FcStrSet *set, const FcChar8 *s);

Description

Removes s from set, returning FcTrue if s was a member else FcFalse.

                                FcStrSetDestroy

Name

FcStrSetDestroy -- destroy a string set

Synopsis

#include <fontconfig/fontconfig.h>


void FcStrSetDestroy(FcStrSet *set);

Description

Destroys set.

                                FcStrListCreate

Name

FcStrListCreate -- create a string iterator

Synopsis

#include <fontconfig/fontconfig.h>


FcStrList * FcStrListCreate(FcStrSet *set);

Description

Creates an iterator to list the strings in set.

                                 FcStrListFirst

Name

FcStrListFirst -- get first string in iteration

Synopsis

#include <fontconfig/fontconfig.h>


void FcStrListFirst(FcStrList *list);

Description

Returns the first string in list.

Since

version 2.11.0

                                 FcStrListNext

Name

FcStrListNext -- get next string in iteration

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrListNext(FcStrList *list);

Description

Returns the next string in list.

                                 FcStrListDone

Name

FcStrListDone -- destroy a string iterator

Synopsis

#include <fontconfig/fontconfig.h>


void FcStrListDone(FcStrList *list);

Description

Destroys the enumerator list.

════════════════════════════════════════════════════════════════════════════════

  String utilities

Table of Contents

[213]FcUtf8ToUcs4 -- convert UTF-8 to UCS4

[214]FcUcs4ToUtf8 -- convert UCS4 to UTF-8

[215]FcUtf8Len -- count UTF-8 encoded chars

[216]FcUtf16ToUcs4 -- convert UTF-16 to UCS4

[217]FcUtf16Len -- count UTF-16 encoded chars

[218]FcIsLower -- check for lower case ASCII character

[219]FcIsUpper -- check for upper case ASCII character

[220]FcToLower -- convert upper case ASCII to lower case

[221]FcStrCopy -- duplicate a string

[222]FcStrDowncase -- create a lower case translation of a string

[223]FcStrCopyFilename -- create a complete path from a filename

[224]FcStrCmp -- compare UTF-8 strings

[225]FcStrCmpIgnoreCase -- compare UTF-8 strings ignoring case

[226]FcStrStr -- locate UTF-8 substring

[227]FcStrStrIgnoreCase -- locate UTF-8 substring ignoring case

[228]FcStrPlus -- concatenate two strings

[229]FcStrFree -- free a string

[230]FcStrBuildFilename -- Concatenate strings as a file path

[231]FcStrDirname -- directory part of filename

[232]FcStrBasename -- last component of filename

Fontconfig manipulates many UTF-8 strings represented with the FcChar8 type.
These functions are exposed to help applications deal with these UTF-8 strings
in a locale-insensitive manner.

                                  FcUtf8ToUcs4

Name

FcUtf8ToUcs4 -- convert UTF-8 to UCS4

Synopsis

#include <fontconfig/fontconfig.h>


int FcUtf8ToUcs4(FcChar8 *src, FcChar32 *dst, int len);

Description

Converts the next Unicode char from src into dst and returns the number of bytes
containing the char. src must be at least len bytes long.

                                  FcUcs4ToUtf8

Name

FcUcs4ToUtf8 -- convert UCS4 to UTF-8

Synopsis

#include <fontconfig/fontconfig.h>


int FcUcs4ToUtf8(FcChar32 src, FcChar8 dst[FC_UTF8_MAX_LEN]);

Description

Converts the Unicode char from src into dst and returns the number of bytes
needed to encode the char.

                                   FcUtf8Len

Name

FcUtf8Len -- count UTF-8 encoded chars

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcUtf8Len(FcChar8 *src, int len, int *nchar, int *wchar);

Description

Counts the number of Unicode chars in len bytes of src. Places that count in
nchar. wchar contains 1, 2 or 4 depending on the number of bytes needed to hold
the largest Unicode char counted. The return value indicates whether src is a
well-formed UTF8 string.

                                 FcUtf16ToUcs4

Name

FcUtf16ToUcs4 -- convert UTF-16 to UCS4

Synopsis

#include <fontconfig/fontconfig.h>


int FcUtf16ToUcs4(FcChar8 *src, FcEndian endian, FcChar32 *dst, int len);

Description

Converts the next Unicode char from src into dst and returns the number of bytes
containing the char. src must be at least len bytes long. Bytes of src are
combined into 16-bit units according to endian.

                                   FcUtf16Len

Name

FcUtf16Len -- count UTF-16 encoded chars

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcUtf16Len(FcChar8 *src, FcEndian endian, int len, int *nchar, int
*wchar);

Description

Counts the number of Unicode chars in len bytes of src. Bytes of src are
combined into 16-bit units according to endian. Places that count in nchar.
wchar contains 1, 2 or 4 depending on the number of bytes needed to hold the
largest Unicode char counted. The return value indicates whether string is a
well-formed UTF16 string.

                                   FcIsLower

Name

FcIsLower -- check for lower case ASCII character

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcIsLower(FcChar8 c);

Description

This macro checks whether c is an lower case ASCII letter.

                                   FcIsUpper

Name

FcIsUpper -- check for upper case ASCII character

Synopsis

#include <fontconfig/fontconfig.h>


FcBool FcIsUpper(FcChar8 c);

Description

This macro checks whether c is a upper case ASCII letter.

                                   FcToLower

Name

FcToLower -- convert upper case ASCII to lower case

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 FcToLower(FcChar8 c);

Description

This macro converts upper case ASCII c to the equivalent lower case letter.

                                   FcStrCopy

Name

FcStrCopy -- duplicate a string

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrCopy(const FcChar8 *s);

Description

Allocates memory, copies s and returns the resulting buffer. Yes, this is
strdup, but that function isn't available on every platform.

                                 FcStrDowncase

Name

FcStrDowncase -- create a lower case translation of a string

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrDowncase(const FcChar8 *s);

Description

Allocates memory, copies s, converting upper case letters to lower case and
returns the allocated buffer.

                               FcStrCopyFilename

Name

FcStrCopyFilename -- create a complete path from a filename

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrCopyFilename(const FcChar8 *s);

Description

FcStrCopyFilename constructs an absolute pathname from s. It converts any
leading '~' characters in to the value of the HOME environment variable, and any
relative paths are converted to absolute paths using the current working
directory. Sequences of '/' characters are converted to a single '/', and names
containing the current directory '.' or parent directory '..' are correctly
reconstructed. Returns NULL if '~' is the leading character and HOME is unset or
disabled (see FcConfigEnableHome).

                                    FcStrCmp

Name

FcStrCmp -- compare UTF-8 strings

Synopsis

#include <fontconfig/fontconfig.h>


int FcStrCmp(const FcChar8 *s1, const FcChar8 *s2);

Description

Returns the usual <0, 0, >0 result of comparing s1 and s2.

                               FcStrCmpIgnoreCase

Name

FcStrCmpIgnoreCase -- compare UTF-8 strings ignoring case

Synopsis

#include <fontconfig/fontconfig.h>


int FcStrCmpIgnoreCase(const FcChar8 *s1, const FcChar8 *s2);

Description

Returns the usual <0, 0, >0 result of comparing s1 and s2. This test is
case-insensitive for all proper UTF-8 encoded strings.

                                    FcStrStr

Name

FcStrStr -- locate UTF-8 substring

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrStr(const FcChar8 *s1, const FcChar8 *s2);

Description

Returns the location of s2 in s1. Returns NULL if s2 is not present in s1. This
test will operate properly with UTF8 encoded strings.

                               FcStrStrIgnoreCase

Name

FcStrStrIgnoreCase -- locate UTF-8 substring ignoring case

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrStrIgnoreCase(const FcChar8 *s1, const FcChar8 *s2);

Description

Returns the location of s2 in s1, ignoring case. Returns NULL if s2 is not
present in s1. This test is case-insensitive for all proper UTF-8 encoded
strings.

                                   FcStrPlus

Name

FcStrPlus -- concatenate two strings

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrPlus(const FcChar8 *s1, const FcChar8 *s2);

Description

This function allocates new storage and places the concatenation of s1 and s2
there, returning the new string.

                                   FcStrFree

Name

FcStrFree -- free a string

Synopsis

#include <fontconfig/fontconfig.h>


void FcStrFree(FcChar8 *s);

Description

This is just a wrapper around free(3) which helps track memory usage of strings
within the fontconfig library.

                               FcStrBuildFilename

Name

FcStrBuildFilename -- Concatenate strings as a file path

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrBuildFilename(const FcChar8 *path, ...);

Description

Creates a filename from the given elements of strings as file paths and
concatenate them with the appropriate file separator. Arguments must be
null-terminated. This returns a newly-allocated memory which should be freed
when no longer needed.

                                  FcStrDirname

Name

FcStrDirname -- directory part of filename

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrDirname(const FcChar8 *file);

Description

Returns the directory containing file. This is returned in newly allocated
storage which should be freed when no longer needed.

                                 FcStrBasename

Name

FcStrBasename -- last component of filename

Synopsis

#include <fontconfig/fontconfig.h>


FcChar8 * FcStrBasename(const FcChar8 *file);

Description

Returns the filename of file stripped of any leading directory names. This is
returned in newly allocated storage which should be freed when no longer needed.

References

   Visible links
   1. file:///tmp/html-jvl2mr#AEN16
   2. file:///tmp/html-jvl2mr#AEN19
   3. file:///tmp/html-jvl2mr#AEN31
   4. file:///tmp/html-jvl2mr#AEN103
   5. file:///tmp/html-jvl2mr#FCINITLOADCONFIG
   6. file:///tmp/html-jvl2mr#FCINITLOADCONFIGANDFONTS
   7. file:///tmp/html-jvl2mr#FCINIT
   8. file:///tmp/html-jvl2mr#FCFINI
   9. file:///tmp/html-jvl2mr#FCGETVERSION
  10. file:///tmp/html-jvl2mr#FCINITREINITIALIZE
  11. file:///tmp/html-jvl2mr#FCINITBRINGUPTODATE
  12. file:///tmp/html-jvl2mr#FCPATTERNCREATE
  13. file:///tmp/html-jvl2mr#FCPATTERNDUPLICATE
  14. file:///tmp/html-jvl2mr#FCPATTERNREFERENCE
  15. file:///tmp/html-jvl2mr#FCPATTERNDESTROY
  16. file:///tmp/html-jvl2mr#FCPATTERNOBJECTCOUNT
  17. file:///tmp/html-jvl2mr#FCPATTERNEQUAL
  18. file:///tmp/html-jvl2mr#FCPATTERNEQUALSUBSET
  19. file:///tmp/html-jvl2mr#FCPATTERNFILTER
  20. file:///tmp/html-jvl2mr#FCPATTERNHASH
  21. file:///tmp/html-jvl2mr#FCPATTERNADD
  22. file:///tmp/html-jvl2mr#FCPATTERNADDWEAK
  23. file:///tmp/html-jvl2mr#FCPATTERNADD-TYPE
  24. file:///tmp/html-jvl2mr#FCPATTERNGETWITHBINDING
  25. file:///tmp/html-jvl2mr#FCPATTERNGET
  26. file:///tmp/html-jvl2mr#FCPATTERNGET-TYPE
  27. file:///tmp/html-jvl2mr#FCPATTERNBUILD
  28. file:///tmp/html-jvl2mr#FCPATTERNDEL
  29. file:///tmp/html-jvl2mr#FCPATTERNREMOVE
  30. file:///tmp/html-jvl2mr#FCPATTERNITERSTART
  31. file:///tmp/html-jvl2mr#FCPATTERNITERNEXT
  32. file:///tmp/html-jvl2mr#FCPATTERNITEREQUAL
  33. file:///tmp/html-jvl2mr#FCPATTERNFINDITER
  34. file:///tmp/html-jvl2mr#FCPATTERNITERISVALID
  35. file:///tmp/html-jvl2mr#FCPATTERNITERGETOBJECT
  36. file:///tmp/html-jvl2mr#FCPATTERNITERVALUECOUNT
  37. file:///tmp/html-jvl2mr#FCPATTERNITERGETVALUE
  38. file:///tmp/html-jvl2mr#FCPATTERNPRINT
  39. file:///tmp/html-jvl2mr#FCDEFAULTSUBSTITUTE
  40. file:///tmp/html-jvl2mr#FCCONFIGSETDEFAULTSUBSTITUTE
  41. file:///tmp/html-jvl2mr#FCNAMEPARSE
  42. file:///tmp/html-jvl2mr#FCNAMEUNPARSE
  43. file:///tmp/html-jvl2mr#FCPATTERNFORMAT
  44. file:///tmp/html-jvl2mr#FCFONTSETCREATE
  45. file:///tmp/html-jvl2mr#FCFONTSETDESTROY
  46. file:///tmp/html-jvl2mr#FCFONTSETADD
  47. file:///tmp/html-jvl2mr#FCFONTSETLIST
  48. file:///tmp/html-jvl2mr#FCFONTSETMATCH
  49. file:///tmp/html-jvl2mr#FCFONTSETPRINT
  50. file:///tmp/html-jvl2mr#FCFONTSETSORT
  51. file:///tmp/html-jvl2mr#FCFONTSETSORTDESTROY
  52. file:///tmp/html-jvl2mr#FCOBJECTSETCREATE
  53. file:///tmp/html-jvl2mr#FCOBJECTSETADD
  54. file:///tmp/html-jvl2mr#FCOBJECTSETDESTROY
  55. file:///tmp/html-jvl2mr#FCOBJECTSETBUILD
  56. file:///tmp/html-jvl2mr#FCFREETYPECHARINDEX
  57. file:///tmp/html-jvl2mr#FCFREETYPECHARSET
  58. file:///tmp/html-jvl2mr#FCFREETYPECHARSETANDSPACING
  59. file:///tmp/html-jvl2mr#FCFREETYPEQUERY
  60. file:///tmp/html-jvl2mr#FCFREETYPEQUERYALL
  61. file:///tmp/html-jvl2mr#FCFREETYPEQUERYFACE
  62. file:///tmp/html-jvl2mr#FCFONTATIONSQUERYALL
  63. file:///tmp/html-jvl2mr#FCVALUEDESTROY
  64. file:///tmp/html-jvl2mr#FCVALUESAVE
  65. file:///tmp/html-jvl2mr#FCVALUEPRINT
  66. file:///tmp/html-jvl2mr#FCVALUEEQUAL
  67. file:///tmp/html-jvl2mr#FCCHARSETCREATE
  68. file:///tmp/html-jvl2mr#FCCHARSETDESTROY
  69. file:///tmp/html-jvl2mr#FCCHARSETADDCHAR
  70. file:///tmp/html-jvl2mr#FCCHARSETDELCHAR
  71. file:///tmp/html-jvl2mr#FCCHARSETCOPY
  72. file:///tmp/html-jvl2mr#FCCHARSETEQUAL
  73. file:///tmp/html-jvl2mr#FCCHARSETINTERSECT
  74. file:///tmp/html-jvl2mr#FCCHARSETUNION
  75. file:///tmp/html-jvl2mr#FCCHARSETSUBTRACT
  76. file:///tmp/html-jvl2mr#FCCHARSETMERGE
  77. file:///tmp/html-jvl2mr#FCCHARSETHASCHAR
  78. file:///tmp/html-jvl2mr#FCCHARSETCOUNT
  79. file:///tmp/html-jvl2mr#FCCHARSETINTERSECTCOUNT
  80. file:///tmp/html-jvl2mr#FCCHARSETSUBTRACTCOUNT
  81. file:///tmp/html-jvl2mr#FCCHARSETISSUBSET
  82. file:///tmp/html-jvl2mr#FCCHARSETFIRSTPAGE
  83. file:///tmp/html-jvl2mr#FCCHARSETNEXTPAGE
  84. file:///tmp/html-jvl2mr#FCCHARSETCOVERAGE
  85. file:///tmp/html-jvl2mr#FCCHARSETNEW
  86. file:///tmp/html-jvl2mr#FCLANGSETCREATE
  87. file:///tmp/html-jvl2mr#FCLANGSETDESTROY
  88. file:///tmp/html-jvl2mr#FCLANGSETCOPY
  89. file:///tmp/html-jvl2mr#FCLANGSETADD
  90. file:///tmp/html-jvl2mr#FCLANGSETDEL
  91. file:///tmp/html-jvl2mr#FCLANGSETUNION
  92. file:///tmp/html-jvl2mr#FCLANGSETSUBTRACT
  93. file:///tmp/html-jvl2mr#FCLANGSETCOMPARE
  94. file:///tmp/html-jvl2mr#FCLANGSETCONTAINS
  95. file:///tmp/html-jvl2mr#FCLANGSETEQUAL
  96. file:///tmp/html-jvl2mr#FCLANGSETHASH
  97. file:///tmp/html-jvl2mr#FCLANGSETHASLANG
  98. file:///tmp/html-jvl2mr#FCGETDEFAULTLANGS
  99. file:///tmp/html-jvl2mr#FCCONFIGGETDEFAULTLANGS
 100. file:///tmp/html-jvl2mr#FCLANGSETGETLANGS
 101. file:///tmp/html-jvl2mr#FCGETLANGS
 102. file:///tmp/html-jvl2mr#FCLANGNORMALIZE
 103. file:///tmp/html-jvl2mr#FCLANGGETCHARSET
 104. file:///tmp/html-jvl2mr#FCMATRIXINIT
 105. file:///tmp/html-jvl2mr#FCMATRIXCOPY
 106. file:///tmp/html-jvl2mr#FCMATRIXEQUAL
 107. file:///tmp/html-jvl2mr#FCMATRIXMULTIPLY
 108. file:///tmp/html-jvl2mr#FCMATRIXROTATE
 109. file:///tmp/html-jvl2mr#FCMATRIXSCALE
 110. file:///tmp/html-jvl2mr#FCMATRIXSHEAR
 111. file:///tmp/html-jvl2mr#FCRANGECOPY
 112. file:///tmp/html-jvl2mr#FCRANGECREATEDOUBLE
 113. file:///tmp/html-jvl2mr#FCRANGECREATEINTEGER
 114. file:///tmp/html-jvl2mr#FCRANGEDESTROY
 115. file:///tmp/html-jvl2mr#FCRANGEGETDOUBLE
 116. file:///tmp/html-jvl2mr#FCCONFIGFILEGENERATE
 117. file:///tmp/html-jvl2mr#FCCONFIGCREATE
 118. file:///tmp/html-jvl2mr#FCCONFIGREFERENCE
 119. file:///tmp/html-jvl2mr#FCCONFIGDESTROY
 120. file:///tmp/html-jvl2mr#FCCONFIGSETCURRENT
 121. file:///tmp/html-jvl2mr#FCCONFIGGETCURRENT
 122. file:///tmp/html-jvl2mr#FCCONFIGSETFONTSETFILTER
 123. file:///tmp/html-jvl2mr#FCCONFIGACCEPTFILTER
 124. file:///tmp/html-jvl2mr#FCCONFIGUPTODATE
 125. file:///tmp/html-jvl2mr#FCCONFIGHOME
 126. file:///tmp/html-jvl2mr#FCCONFIGENABLEHOME
 127. file:///tmp/html-jvl2mr#FCCONFIGBUILDFONTS
 128. file:///tmp/html-jvl2mr#FCCONFIGGETCONFIGDIRS
 129. file:///tmp/html-jvl2mr#FCCONFIGGETFONTDIRS
 130. file:///tmp/html-jvl2mr#FCCONFIGGETCONFIGFILES
 131. file:///tmp/html-jvl2mr#FCCONFIGGETCACHE
 132. file:///tmp/html-jvl2mr#FCCONFIGGETCACHEDIRS
 133. file:///tmp/html-jvl2mr#FCCONFIGGETFONTS
 134. file:///tmp/html-jvl2mr#FCCONFIGGETBLANKS
 135. file:///tmp/html-jvl2mr#FCCONFIGGETRESCANINTERVAL
 136. file:///tmp/html-jvl2mr#FCCONFIGSETRESCANINTERVAL
 137. file:///tmp/html-jvl2mr#FCCONFIGAPPFONTADDFILE
 138. file:///tmp/html-jvl2mr#FCCONFIGAPPFONTADDDIR
 139. file:///tmp/html-jvl2mr#FCCONFIGAPPFONTCLEAR
 140. file:///tmp/html-jvl2mr#FCCONFIGSUBSTITUTEWITHPAT
 141. file:///tmp/html-jvl2mr#FCCONFIGSUBSTITUTE
 142. file:///tmp/html-jvl2mr#FCFONTMATCH
 143. file:///tmp/html-jvl2mr#FCFONTSORT
 144. file:///tmp/html-jvl2mr#FCFONTRENDERPREPARE
 145. file:///tmp/html-jvl2mr#FCFONTLIST
 146. file:///tmp/html-jvl2mr#FCCONFIGFILENAME
 147. file:///tmp/html-jvl2mr#FCCONFIGGETFILENAME
 148. file:///tmp/html-jvl2mr#FCCONFIGPARSEANDLOAD
 149. file:///tmp/html-jvl2mr#FCCONFIGPARSEANDLOADFROMMEMORY
 150. file:///tmp/html-jvl2mr#FCCONFIGGETSYSROOT
 151. file:///tmp/html-jvl2mr#FCCONFIGSETSYSROOT
 152. file:///tmp/html-jvl2mr#FCCONFIGFILEINFOITERINIT
 153. file:///tmp/html-jvl2mr#FCCONFIGFILEINFOITERNEXT
 154. file:///tmp/html-jvl2mr#FCCONFIGFILEINFOITERGET
 155. file:///tmp/html-jvl2mr#FCCONFIGACCEPTFONT
 156. file:///tmp/html-jvl2mr#FCCONFIGPREFERAPPFONT
 157. file:///tmp/html-jvl2mr#FCNAMEREGISTEROBJECTTYPES
 158. file:///tmp/html-jvl2mr#FCNAMEUNREGISTEROBJECTTYPES
 159. file:///tmp/html-jvl2mr#FCNAMEGETOBJECTTYPE
 160. file:///tmp/html-jvl2mr#FCNAMEREGISTERCONSTANTS
 161. file:///tmp/html-jvl2mr#FCNAMEUNREGISTERCONSTANTS
 162. file:///tmp/html-jvl2mr#FCNAMEGETCONSTANT
 163. file:///tmp/html-jvl2mr#FCNAMEGETCONSTANTFOR
 164. file:///tmp/html-jvl2mr#FCNAMECONSTANT
 165. file:///tmp/html-jvl2mr#FCNAMEGETCONSTANTNAMEFROM
 166. file:///tmp/html-jvl2mr#FCWEIGHTFROMOPENTYPEDOUBLE
 167. file:///tmp/html-jvl2mr#FCWEIGHTTOOPENTYPEDOUBLE
 168. file:///tmp/html-jvl2mr#FCWEIGHTFROMOPENTYPE
 169. file:///tmp/html-jvl2mr#FCWEIGHTTOOPENTYPE
 170. file:///tmp/html-jvl2mr#FCBLANKSCREATE
 171. file:///tmp/html-jvl2mr#FCBLANKSDESTROY
 172. file:///tmp/html-jvl2mr#FCBLANKSADD
 173. file:///tmp/html-jvl2mr#FCBLANKSISMEMBER
 174. file:///tmp/html-jvl2mr#FCATOMICCREATE
 175. file:///tmp/html-jvl2mr#FCATOMICLOCK
 176. file:///tmp/html-jvl2mr#FCATOMICNEWFILE
 177. file:///tmp/html-jvl2mr#FCATOMICORIGFILE
 178. file:///tmp/html-jvl2mr#FCATOMICREPLACEORIG
 179. file:///tmp/html-jvl2mr#FCATOMICDELETENEW
 180. file:///tmp/html-jvl2mr#FCATOMICUNLOCK
 181. file:///tmp/html-jvl2mr#FCATOMICDESTROY
 182. file:///tmp/html-jvl2mr#FCFILESCAN
 183. file:///tmp/html-jvl2mr#FCFILEISDIR
 184. file:///tmp/html-jvl2mr#FCDIRSCAN
 185. file:///tmp/html-jvl2mr#FCDIRSAVE
 186. file:///tmp/html-jvl2mr#FCDIRCACHEUNLINK
 187. file:///tmp/html-jvl2mr#FCDIRCACHEVALID
 188. file:///tmp/html-jvl2mr#FCDIRCACHELOAD
 189. file:///tmp/html-jvl2mr#FCDIRCACHERESCAN
 190. file:///tmp/html-jvl2mr#FCDIRCACHEREAD
 191. file:///tmp/html-jvl2mr#FCDIRCACHELOADFILE
 192. file:///tmp/html-jvl2mr#FCDIRCACHEUNLOAD
 193. file:///tmp/html-jvl2mr#FCCACHEDIR
 194. file:///tmp/html-jvl2mr#FCCACHECOPYSET
 195. file:///tmp/html-jvl2mr#FCCACHESUBDIR
 196. file:///tmp/html-jvl2mr#FCCACHENUMSUBDIR
 197. file:///tmp/html-jvl2mr#FCCACHENUMFONT
 198. file:///tmp/html-jvl2mr#FCDIRCACHECLEAN
 199. file:///tmp/html-jvl2mr#FCCACHECREATETAGFILE
 200. file:///tmp/html-jvl2mr#FCDIRCACHECREATEUUID
 201. file:///tmp/html-jvl2mr#FCDIRCACHEDELETEUUID
 202. file:///tmp/html-jvl2mr#FCSTRSETCREATE
 203. file:///tmp/html-jvl2mr#FCSTRSETMEMBER
 204. file:///tmp/html-jvl2mr#FCSTRSETEQUAL
 205. file:///tmp/html-jvl2mr#FCSTRSETADD
 206. file:///tmp/html-jvl2mr#FCSTRSETADDFILENAME
 207. file:///tmp/html-jvl2mr#FCSTRSETDEL
 208. file:///tmp/html-jvl2mr#FCSTRSETDESTROY
 209. file:///tmp/html-jvl2mr#FCSTRLISTCREATE
 210. file:///tmp/html-jvl2mr#FCSTRLISTFIRST
 211. file:///tmp/html-jvl2mr#FCSTRLISTNEXT
 212. file:///tmp/html-jvl2mr#FCSTRLISTDONE
 213. file:///tmp/html-jvl2mr#FCUTF8TOUCS4
 214. file:///tmp/html-jvl2mr#FCUCS4TOUTF8
 215. file:///tmp/html-jvl2mr#FCUTF8LEN
 216. file:///tmp/html-jvl2mr#FCUTF16TOUCS4
 217. file:///tmp/html-jvl2mr#FCUTF16LEN
 218. file:///tmp/html-jvl2mr#FCISLOWER
 219. file:///tmp/html-jvl2mr#FCISUPPER
 220. file:///tmp/html-jvl2mr#FCTOLOWER
 221. file:///tmp/html-jvl2mr#FCSTRCOPY
 222. file:///tmp/html-jvl2mr#FCSTRDOWNCASE
 223. file:///tmp/html-jvl2mr#FCSTRCOPYFILENAME
 224. file:///tmp/html-jvl2mr#FCSTRCMP
 225. file:///tmp/html-jvl2mr#FCSTRCMPIGNORECASE
 226. file:///tmp/html-jvl2mr#FCSTRSTR
 227. file:///tmp/html-jvl2mr#FCSTRSTRIGNORECASE
 228. file:///tmp/html-jvl2mr#FCSTRPLUS
 229. file:///tmp/html-jvl2mr#FCSTRFREE
 230. file:///tmp/html-jvl2mr#FCSTRBUILDFILENAME
 231. file:///tmp/html-jvl2mr#FCSTRDIRNAME
 232. file:///tmp/html-jvl2mr#FCSTRBASENAME
