vasilito/RedBear-OS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
bootprocess
RedBear-OS/recipes/dev/fontconfig/source/doc/fontconfig-devel.html
T
vasilito facf0c92e0 feat: track all source trees in git — full fork offline-first model 
Red Bear OS is a full fork. All sources must be available from git clone
with zero network access. Removed gitignore rules that excluded fetched
source trees under recipes/*/source/, local/recipes/kde/*/source/,
local/recipes/qt/*/source/, and vendor source trees.

Build artifacts (target/, build/, source.tar, *.o, *.so) remain excluded.

127291 files added — kernel, relibc, base, bootloader, pkgar, all KDE/Qt
frameworks, mesa, wayland, DRM drivers, and every other recipe source.
2026-05-14 10:55:53 +01:00

22882 lines
303 KiB
HTML
Raw Permalink Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Fontconfig Developers Reference, Version 2.16.0
</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"></HEAD
><BODY
CLASS="ARTICLE"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="ARTICLE"
><DIV
CLASS="TITLEPAGE"
><H1
CLASS="TITLE"
><A
NAME="INDEX"
>Fontconfig Developers Reference, Version 2.16.0</A
></H1
><DIV
CLASS="LEGALNOTICE"
><P
></P
><A
NAME="AEN12"
></A
><P
>Copyright © 2002 Keith Packard
</P
><P
>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.
</P
><P
>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.
</P
><P
></P
></DIV
><HR
WIDTH="75%"
ALIGN="CENTER"
COLOR="#000000"
SIZE="1"></DIV
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#AEN16"
>DESCRIPTION</A
></DT
><DT
><A
HREF="#AEN19"
>FUNCTIONAL OVERVIEW</A
></DT
><DT
><A
HREF="#AEN31"
>Datatypes</A
></DT
><DT
><A
HREF="#AEN103"
>FUNCTIONS</A
></DT
></DL
></DIV
><DIV
CLASS="SECT1"
><H2
CLASS="SECT1"
><A
NAME="AEN16"
>DESCRIPTION</A
></H2
><P
>Fontconfig is a library designed to provide system-wide font configuration,
customization and application access.
</P
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN19"
>FUNCTIONAL OVERVIEW</A
></H2
><P
>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.
</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN22"
>FONT CONFIGURATION</A
></H3
><P
>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.
</P
><P
>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.
</P
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN27"
>FONT PROPERTIES</A
></H3
><P
>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.
</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> 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-&#62;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
fontwarapper FC_FONT_WRAPPER String The font wrapper format
</PRE
></TD
></TR
></TABLE
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN31"
>Datatypes</A
></H2
><P
>Fontconfig uses abstract data types to hide internal implementation details
for most data structures. A few structures are exposed where appropriate.
</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN34"
>FcChar8, FcChar16, FcChar32, FcBool</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN37"
>FcMatrix</A
></H3
><P
>An FcMatrix holds an affine transformation, usually used to reshape glyphs.
A small set of matrix operations are provided to manipulate these.
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> typedef struct _FcMatrix {
double xx, xy, yx, yy;
} FcMatrix;
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN41"
>FcCharSet</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN44"
>FcLangSet</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN47"
>FcLangResult</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN50"
>FcType</A
></H3
><P
>Tags the kind of data stored in an FcValue.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN53"
>FcValue</A
></H3
><P
>An FcValue object holds a single value with one of a number of different
types. The 'type' tag indicates which member is valid.
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> 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;
</PRE
></TD
></TR
></TABLE
>
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> 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 *
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN58"
>FcPattern, FcPatternIter</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN61"
>FcFontSet</A
></H3
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> typedef struct _FcFontSet {
int nfont;
int sfont;
FcPattern **fonts;
} FcFontSet;
</PRE
></TD
></TR
></TABLE
>
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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN65"
>FcStrSet, FcStrList</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN68"
>FcObjectSet</A
></H3
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> typedef struct _FcObjectSet {
int nobject;
int sobject;
const char **objects;
} FcObjectSet;
</PRE
></TD
></TR
></TABLE
>
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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN72"
>FcObjectType</A
></H3
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> typedef struct _FcObjectType {
const char *object;
FcType type;
} FcObjectType;
</PRE
></TD
></TR
></TABLE
>
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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN76"
>FcConstant</A
></H3
><P
> <TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> typedef struct _FcConstant {
const FcChar8 *name;
const char *object;
int value;
} FcConstant;
</PRE
></TD
></TR
></TABLE
>
Provides for symbolic constants for new pattern elements. When 'name' is
seen in a font name, an 'object' element is created with value 'value'.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN80"
>FcBlanks</A
></H3
><P
>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.
</P
><P
> 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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN84"
>FcFileCache</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN87"
>FcConfig</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN90"
>FcSetName</A
></H3
><P
>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.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN93"
>FcResult</A
></H3
><P
>Used as a return type for functions manipulating FcPattern objects.
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> 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
</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN97"
>FcAtomic</A
></H3
><P
>Used for locking access to configuration files. Provides a safe way to update
configuration files.
</P
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN100"
>FcCache</A
></H3
><P
>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.
</P
></DIV
></DIV
><DIV
CLASS="SECT1"
><HR><H2
CLASS="SECT1"
><A
NAME="AEN103"
>FUNCTIONS</A
></H2
><P
>These are grouped by functionality, often using the main data type being
manipulated.
</P
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN106"
>Initialization</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCINITLOADCONFIG"
>FcInitLoadConfig</A
>&nbsp;--&nbsp;load configuration</DT
><DT
><A
HREF="#FCINITLOADCONFIGANDFONTS"
>FcInitLoadConfigAndFonts</A
>&nbsp;--&nbsp;load configuration and font data</DT
><DT
><A
HREF="#FCINIT"
>FcInit</A
>&nbsp;--&nbsp;initialize fontconfig library</DT
><DT
><A
HREF="#FCFINI"
>FcFini</A
>&nbsp;--&nbsp;finalize fontconfig library</DT
><DT
><A
HREF="#FCGETVERSION"
>FcGetVersion</A
>&nbsp;--&nbsp;library version number</DT
><DT
><A
HREF="#FCINITREINITIALIZE"
>FcInitReinitialize</A
>&nbsp;--&nbsp;re-initialize library</DT
><DT
><A
HREF="#FCINITBRINGUPTODATE"
>FcInitBringUptoDate</A
>&nbsp;--&nbsp;reload configuration files if needed</DT
></DL
></DIV
><P
>These functions provide some control over how the library is initialized.
</P
><H1
><A
NAME="FCINITLOADCONFIG"
></A
>FcInitLoadConfig</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN114"
></A
><H2
>Name</H2
>FcInitLoadConfig&nbsp;--&nbsp;load configuration</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN117"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN118"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcConfig * <TT
CLASS="FUNCTION"
>FcInitLoadConfig</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN125"
></A
><H2
>Description</H2
><P
>Loads the default configuration file and returns the resulting configuration.
Does not load any font information.
</P
></DIV
><H1
><A
NAME="FCINITLOADCONFIGANDFONTS"
></A
>FcInitLoadConfigAndFonts</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN133"
></A
><H2
>Name</H2
>FcInitLoadConfigAndFonts&nbsp;--&nbsp;load configuration and font data</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN136"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN137"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcConfig * <TT
CLASS="FUNCTION"
>FcInitLoadConfigAndFonts</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN144"
></A
><H2
>Description</H2
><P
>Loads the default configuration file and builds information about the
available fonts. Returns the resulting configuration.
</P
></DIV
><H1
><A
NAME="FCINIT"
></A
>FcInit</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN152"
></A
><H2
>Name</H2
>FcInit&nbsp;--&nbsp;initialize fontconfig library</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN155"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN156"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcInit</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN163"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCFINI"
></A
>FcFini</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN171"
></A
><H2
>Name</H2
>FcFini&nbsp;--&nbsp;finalize fontconfig library</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN174"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN175"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcFini</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN182"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCGETVERSION"
></A
>FcGetVersion</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN190"
></A
><H2
>Name</H2
>FcGetVersion&nbsp;--&nbsp;library version number</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN193"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN194"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcGetVersion</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN201"
></A
><H2
>Description</H2
><P
>Returns the version number of the library.
</P
></DIV
><H1
><A
NAME="FCINITREINITIALIZE"
></A
>FcInitReinitialize</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN209"
></A
><H2
>Name</H2
>FcInitReinitialize&nbsp;--&nbsp;re-initialize library</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN212"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN213"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcInitReinitialize</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN220"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCINITBRINGUPTODATE"
></A
>FcInitBringUptoDate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN228"
></A
><H2
>Name</H2
>FcInitBringUptoDate&nbsp;--&nbsp;reload configuration files if needed</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN231"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN232"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcInitBringUptoDate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN239"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN242"
>FcPattern</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCPATTERNCREATE"
>FcPatternCreate</A
>&nbsp;--&nbsp;Create a pattern</DT
><DT
><A
HREF="#FCPATTERNDUPLICATE"
>FcPatternDuplicate</A
>&nbsp;--&nbsp;Copy a pattern</DT
><DT
><A
HREF="#FCPATTERNREFERENCE"
>FcPatternReference</A
>&nbsp;--&nbsp;Increment pattern reference count</DT
><DT
><A
HREF="#FCPATTERNDESTROY"
>FcPatternDestroy</A
>&nbsp;--&nbsp;Destroy a pattern</DT
><DT
><A
HREF="#FCPATTERNOBJECTCOUNT"
>FcPatternObjectCount</A
>&nbsp;--&nbsp;Returns the number of the object</DT
><DT
><A
HREF="#FCPATTERNEQUAL"
>FcPatternEqual</A
>&nbsp;--&nbsp;Compare patterns</DT
><DT
><A
HREF="#FCPATTERNEQUALSUBSET"
>FcPatternEqualSubset</A
>&nbsp;--&nbsp;Compare portions of patterns</DT
><DT
><A
HREF="#FCPATTERNFILTER"
>FcPatternFilter</A
>&nbsp;--&nbsp;Filter the objects of pattern</DT
><DT
><A
HREF="#FCPATTERNHASH"
>FcPatternHash</A
>&nbsp;--&nbsp;Compute a pattern hash value</DT
><DT
><A
HREF="#FCPATTERNADD"
>FcPatternAdd</A
>&nbsp;--&nbsp;Add a value to a pattern</DT
><DT
><A
HREF="#FCPATTERNADDWEAK"
>FcPatternAddWeak</A
>&nbsp;--&nbsp;Add a value to a pattern with weak binding</DT
><DT
><A
HREF="#FCPATTERNADD-TYPE"
>FcPatternAdd-Type</A
>&nbsp;--&nbsp;Add a typed value to a pattern</DT
><DT
><A
HREF="#FCPATTERNGETWITHBINDING"
>FcPatternGetWithBinding</A
>&nbsp;--&nbsp;Return a value with binding from a pattern</DT
><DT
><A
HREF="#FCPATTERNGET"
>FcPatternGet</A
>&nbsp;--&nbsp;Return a value from a pattern</DT
><DT
><A
HREF="#FCPATTERNGET-TYPE"
>FcPatternGet-Type</A
>&nbsp;--&nbsp;Return a typed value from a pattern</DT
><DT
><A
HREF="#FCPATTERNBUILD"
>FcPatternBuild</A
>&nbsp;--&nbsp;Create patterns from arguments</DT
><DT
><A
HREF="#FCPATTERNDEL"
>FcPatternDel</A
>&nbsp;--&nbsp;Delete a property from a pattern</DT
><DT
><A
HREF="#FCPATTERNREMOVE"
>FcPatternRemove</A
>&nbsp;--&nbsp;Remove one object of the specified type from the pattern</DT
><DT
><A
HREF="#FCPATTERNITERSTART"
>FcPatternIterStart</A
>&nbsp;--&nbsp;Initialize the iterator with the first iterator in the pattern</DT
><DT
><A
HREF="#FCPATTERNITERNEXT"
>FcPatternIterNext</A
>&nbsp;--&nbsp;</DT
><DT
><A
HREF="#FCPATTERNITEREQUAL"
>FcPatternIterEqual</A
>&nbsp;--&nbsp;Compare iterators</DT
><DT
><A
HREF="#FCPATTERNFINDITER"
>FcPatternFindIter</A
>&nbsp;--&nbsp;Set the iterator to point to the object in the pattern</DT
><DT
><A
HREF="#FCPATTERNITERISVALID"
>FcPatternIterIsValid</A
>&nbsp;--&nbsp;Check whether the iterator is valid or not</DT
><DT
><A
HREF="#FCPATTERNITERGETOBJECT"
>FcPatternIterGetObject</A
>&nbsp;--&nbsp;Returns an object name which the iterator point to</DT
><DT
><A
HREF="#FCPATTERNITERVALUECOUNT"
>FcPatternIterValueCount</A
>&nbsp;--&nbsp;Returns the number of the values which the iterator point to</DT
><DT
><A
HREF="#FCPATTERNITERGETVALUE"
>FcPatternIterGetValue</A
>&nbsp;--&nbsp;Returns a value which the iterator point to</DT
><DT
><A
HREF="#FCPATTERNPRINT"
>FcPatternPrint</A
>&nbsp;--&nbsp;Print a pattern for debugging</DT
><DT
><A
HREF="#FCDEFAULTSUBSTITUTE"
>FcDefaultSubstitute</A
>&nbsp;--&nbsp;Perform default substitutions in a pattern</DT
><DT
><A
HREF="#FCNAMEPARSE"
>FcNameParse</A
>&nbsp;--&nbsp;Parse a pattern string</DT
><DT
><A
HREF="#FCNAMEUNPARSE"
>FcNameUnparse</A
>&nbsp;--&nbsp;Convert a pattern back into a string that can be parsed</DT
><DT
><A
HREF="#FCPATTERNFORMAT"
>FcPatternFormat</A
>&nbsp;--&nbsp;Format a pattern into a string according to a format specifier</DT
></DL
></DIV
><P
>An FcPattern is an opaque type that holds both patterns to match against the
available fonts, as well as the information about each font.
</P
><H1
><A
NAME="FCPATTERNCREATE"
></A
>FcPatternCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN250"
></A
><H2
>Name</H2
>FcPatternCreate&nbsp;--&nbsp;Create a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN253"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN254"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcPatternCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN261"
></A
><H2
>Description</H2
><P
>Creates a pattern with no properties; used to build patterns from scratch.
</P
></DIV
><H1
><A
NAME="FCPATTERNDUPLICATE"
></A
>FcPatternDuplicate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN269"
></A
><H2
>Name</H2
>FcPatternDuplicate&nbsp;--&nbsp;Copy a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN272"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN273"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcPatternDuplicate</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN280"
></A
><H2
>Description</H2
><P
>Copy a pattern, returning a new pattern that matches
<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>. Each pattern may be modified without affecting the
other.
</P
></DIV
><H1
><A
NAME="FCPATTERNREFERENCE"
></A
>FcPatternReference</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN289"
></A
><H2
>Name</H2
>FcPatternReference&nbsp;--&nbsp;Increment pattern reference count</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN292"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN293"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcPatternReference</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN300"
></A
><H2
>Description</H2
><P
>Add another reference to <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>. Patterns are freed only
when the reference count reaches zero.
</P
></DIV
><H1
><A
NAME="FCPATTERNDESTROY"
></A
>FcPatternDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN309"
></A
><H2
>Name</H2
>FcPatternDestroy&nbsp;--&nbsp;Destroy a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN312"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN313"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcPatternDestroy</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN320"
></A
><H2
>Description</H2
><P
>Decrement the pattern reference count. If all references are gone, destroys
the pattern, in the process destroying all related values.
</P
></DIV
><H1
><A
NAME="FCPATTERNOBJECTCOUNT"
></A
>FcPatternObjectCount</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN328"
></A
><H2
>Name</H2
>FcPatternObjectCount&nbsp;--&nbsp;Returns the number of the object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN331"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN332"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcPatternObjectCount</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN339"
></A
><H2
>Description</H2
><P
>Returns the number of the object <TT
CLASS="PARAMETER"
><I
>p</I
></TT
> has.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN343"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNEQUAL"
></A
>FcPatternEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN351"
></A
><H2
>Name</H2
>FcPatternEqual&nbsp;--&nbsp;Compare patterns</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN354"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN355"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternEqual</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>pa</I
></TT
>, const FcPattern *<TT
CLASS="PARAMETER"
><I
>pb</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN364"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>pa</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>pb</I
></TT
> are exactly alike.
</P
></DIV
><H1
><A
NAME="FCPATTERNEQUALSUBSET"
></A
>FcPatternEqualSubset</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN374"
></A
><H2
>Name</H2
>FcPatternEqualSubset&nbsp;--&nbsp;Compare portions of patterns</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN377"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN378"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternEqualSubset</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>pa</I
></TT
>, const FcPattern *<TT
CLASS="PARAMETER"
><I
>pb</I
></TT
>, const FcObjectSet *<TT
CLASS="PARAMETER"
><I
>os</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN389"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>pa</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>pb</I
></TT
> have exactly the same values for all of the
objects in <TT
CLASS="PARAMETER"
><I
>os</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCPATTERNFILTER"
></A
>FcPatternFilter</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN400"
></A
><H2
>Name</H2
>FcPatternFilter&nbsp;--&nbsp;Filter the objects of pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN403"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN404"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcPatternFilter</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const FcObjectSet *<TT
CLASS="PARAMETER"
><I
>os</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN413"
></A
><H2
>Description</H2
><P
>Returns a new pattern that only has those objects from
<TT
CLASS="PARAMETER"
><I
>p</I
></TT
> that are in <TT
CLASS="PARAMETER"
><I
>os</I
></TT
>.
If <TT
CLASS="PARAMETER"
><I
>os</I
></TT
> is NULL, a duplicate of
<TT
CLASS="PARAMETER"
><I
>p</I
></TT
> is returned.
</P
></DIV
><H1
><A
NAME="FCPATTERNHASH"
></A
>FcPatternHash</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN425"
></A
><H2
>Name</H2
>FcPatternHash&nbsp;--&nbsp;Compute a pattern hash value</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN428"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN429"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcPatternHash</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN436"
></A
><H2
>Description</H2
><P
>Returns a 32-bit number which is the same for any two patterns which are
equal.
</P
></DIV
><H1
><A
NAME="FCPATTERNADD"
></A
>FcPatternAdd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN444"
></A
><H2
>Name</H2
>FcPatternAdd&nbsp;--&nbsp;Add a value to a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN447"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN448"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAdd</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, FcValue <TT
CLASS="PARAMETER"
><I
>value</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>append</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN461"
></A
><H2
>Description</H2
><P
>Adds a single value to the list of values associated with the property named
`object<TT
CLASS="PARAMETER"
><I
>. If `append</I
></TT
> 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.
</P
></DIV
><H1
><A
NAME="FCPATTERNADDWEAK"
></A
>FcPatternAddWeak</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN470"
></A
><H2
>Name</H2
>FcPatternAddWeak&nbsp;--&nbsp;Add a value to a pattern with weak binding</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN473"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN474"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddWeak</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, FcValue <TT
CLASS="PARAMETER"
><I
>value</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>append</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN487"
></A
><H2
>Description</H2
><P
>FcPatternAddWeak is essentially the same as FcPatternAdd except that any
values added to the list have binding <TT
CLASS="PARAMETER"
><I
>weak</I
></TT
> instead of <TT
CLASS="PARAMETER"
><I
>strong</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCPATTERNADD-TYPE"
></A
>FcPatternAdd-Type</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN497"
></A
><H2
>Name</H2
>FcPatternAddInteger, FcPatternAddDouble, FcPatternAddString, FcPatternAddMatrix, FcPatternAddCharSet, FcPatternAddBool, FcPatternAddFTFace, FcPatternAddLangSet, FcPatternAddRange&nbsp;--&nbsp;Add a typed value to a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN508"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN509"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddInteger</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>i</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddDouble</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>d</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddString</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddMatrix</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, const FcMatrix *<TT
CLASS="PARAMETER"
><I
>m</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddCharSet</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>c</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddBool</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddFTFace</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, const FT_Face <TT
CLASS="PARAMETER"
><I
>f</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddLangSet</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, const FcLangSet *<TT
CLASS="PARAMETER"
><I
>l</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternAddRange</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, const FcRange *<TT
CLASS="PARAMETER"
><I
>r</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN592"
></A
><H2
>Description</H2
><P
>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.
<TT
CLASS="FUNCTION"
>FcPatternAddRange</TT
> are available since 2.11.91.
</P
></DIV
><H1
><A
NAME="FCPATTERNGETWITHBINDING"
></A
>FcPatternGetWithBinding</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN601"
></A
><H2
>Name</H2
>FcPatternGetWithBinding&nbsp;--&nbsp;Return a value with binding from a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN604"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN605"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetWithBinding</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>, FcValue *<TT
CLASS="PARAMETER"
><I
>v</I
></TT
>, FcValueBinding *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN620"
></A
><H2
>Description</H2
><P
>Returns in <TT
CLASS="PARAMETER"
><I
>v</I
></TT
> the <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>'th value
and <TT
CLASS="PARAMETER"
><I
>b</I
></TT
> binding for that associated with the property
<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>.
The Value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN627"
></A
><H2
>Since</H2
><P
>version 2.12.5</P
></DIV
><H1
><A
NAME="FCPATTERNGET"
></A
>FcPatternGet</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN635"
></A
><H2
>Name</H2
>FcPatternGet&nbsp;--&nbsp;Return a value from a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN638"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN639"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGet</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>, FcValue *<TT
CLASS="PARAMETER"
><I
>v</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN652"
></A
><H2
>Description</H2
><P
>Returns in <TT
CLASS="PARAMETER"
><I
>v</I
></TT
> the <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>'th value
associated with the property <TT
CLASS="PARAMETER"
><I
>object</I
></TT
>.
The value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value.
</P
></DIV
><H1
><A
NAME="FCPATTERNGET-TYPE"
></A
>FcPatternGet-Type</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN663"
></A
><H2
>Name</H2
>FcPatternGetInteger, FcPatternGetDouble, FcPatternGetString, FcPatternGetMatrix, FcPatternGetCharSet, FcPatternGetBool, FcPatternGetFTFace, FcPatternGetLangSet, FcPatternGetRange&nbsp;--&nbsp;Return a typed value from a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN674"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN675"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetInteger</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>i</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetDouble</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, double *<TT
CLASS="PARAMETER"
><I
>d</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetString</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FcChar8 **<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetMatrix</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FcMatrix **<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetCharSet</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FcCharSet **<TT
CLASS="PARAMETER"
><I
>c</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetBool</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FcBool *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetFTFace</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FT_Face *<TT
CLASS="PARAMETER"
><I
>f</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetLangSet</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FcLangSet **<TT
CLASS="PARAMETER"
><I
>l</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternGetRange</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>n</I
></TT
>, FcRange **<TT
CLASS="PARAMETER"
><I
>r</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN776"
></A
><H2
>Description</H2
><P
>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.
<TT
CLASS="FUNCTION"
>FcPatternGetRange</TT
> are available since 2.11.91.
</P
></DIV
><H1
><A
NAME="FCPATTERNBUILD"
></A
>FcPatternBuild</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN785"
></A
><H2
>Name</H2
>FcPatternBuild, FcPatternVaBuild, FcPatternVapBuild&nbsp;--&nbsp;Create patterns from arguments</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN790"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN791"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcPatternBuild</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>, ...<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcPatternVaBuild</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>, va_list <TT
CLASS="PARAMETER"
><I
>va</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcPatternVapBuild</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>, va_list <TT
CLASS="PARAMETER"
><I
>va</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN816"
></A
><H2
>Description</H2
><P
>Builds a pattern using a list of objects, types and values. Each
value to be entered in the pattern is specified with three arguments:</P
><P
></P
><OL
TYPE="1"
><LI
><P
>Object name, a string describing the property to be added.</P
></LI
><LI
><P
>Object type, one of the FcType enumerated values</P
></LI
><LI
><P
>Value, not an FcValue, but the raw type as passed to any of the
FcPatternAdd&#60;type&#62; functions. Must match the type of the second
argument.</P
></LI
></OL
><P
>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</P
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
>pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);</PRE
></TD
></TR
></TABLE
><P
>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 <TT
CLASS="PARAMETER"
><I
>result</I
></TT
>
variable.
</P
></DIV
><H1
><A
NAME="FCPATTERNDEL"
></A
>FcPatternDel</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN835"
></A
><H2
>Name</H2
>FcPatternDel&nbsp;--&nbsp;Delete a property from a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN838"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN839"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternDel</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN848"
></A
><H2
>Description</H2
><P
>Deletes all values associated with the property `object', returning
whether the property existed or not.
</P
></DIV
><H1
><A
NAME="FCPATTERNREMOVE"
></A
>FcPatternRemove</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN856"
></A
><H2
>Name</H2
>FcPatternRemove&nbsp;--&nbsp;Remove one object of the specified type from the pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN859"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN860"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternRemove</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN871"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCPATTERNITERSTART"
></A
>FcPatternIterStart</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN879"
></A
><H2
>Name</H2
>FcPatternIterStart&nbsp;--&nbsp;Initialize the iterator with the first iterator in the pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN882"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN883"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcPatternIterStart</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN892"
></A
><H2
>Description</H2
><P
>Initialize <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> with the first iterator in <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>.
If there are no objects in <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>
will not have any valid data.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN899"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNITERNEXT"
></A
>FcPatternIterNext</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN907"
></A
><H2
>Name</H2
>FcPatternIterNext&nbsp;--&nbsp;</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN910"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN911"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternIterNext</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN920"
></A
><H2
>Description</H2
><P
>Set <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> to point to the next object in <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>
and returns FcTrue if <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> has been changed to the next object.
returns FcFalse otherwise.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN926"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNITEREQUAL"
></A
>FcPatternIterEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN934"
></A
><H2
>Name</H2
>FcPatternIterEqual&nbsp;--&nbsp;Compare iterators</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN937"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN938"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternIterEqual</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p1</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>i1</I
></TT
>, const FcPattern *<TT
CLASS="PARAMETER"
><I
>p2</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>i2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN951"
></A
><H2
>Description</H2
><P
>Return FcTrue if both <TT
CLASS="PARAMETER"
><I
>i1</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>i2</I
></TT
>
point to same object and contains same values. return FcFalse otherwise.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN956"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNFINDITER"
></A
>FcPatternFindIter</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN964"
></A
><H2
>Name</H2
>FcPatternFindIter&nbsp;--&nbsp;Set the iterator to point to the object in the pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN967"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN968"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternFindIter</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN979"
></A
><H2
>Description</H2
><P
>Set <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> to point to <TT
CLASS="PARAMETER"
><I
>object</I
></TT
> in
<TT
CLASS="PARAMETER"
><I
>p</I
></TT
> if any and returns FcTrue. returns FcFalse otherwise.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN985"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNITERISVALID"
></A
>FcPatternIterIsValid</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN993"
></A
><H2
>Name</H2
>FcPatternIterIsValid&nbsp;--&nbsp;Check whether the iterator is valid or not</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN996"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN997"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcPatternIterIsValid</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter :<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1006"
></A
><H2
>Description</H2
><P
>Returns FcTrue if <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> point to the valid entry
in <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>. returns FcFalse otherwise.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1011"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNITERGETOBJECT"
></A
>FcPatternIterGetObject</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1019"
></A
><H2
>Name</H2
>FcPatternIterGetObject&nbsp;--&nbsp;Returns an object name which the iterator point to</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1022"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1023"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const char * <TT
CLASS="FUNCTION"
>FcPatternIterGetObject</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1032"
></A
><H2
>Description</H2
><P
>Returns an object name in <TT
CLASS="PARAMETER"
><I
>p</I
></TT
> which
<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> point to. returns NULL if
<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> isn't valid.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1038"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNITERVALUECOUNT"
></A
>FcPatternIterValueCount</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1046"
></A
><H2
>Name</H2
>FcPatternIterValueCount&nbsp;--&nbsp;Returns the number of the values which the iterator point to</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1049"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1050"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcPatternIterValueCount</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1059"
></A
><H2
>Description</H2
><P
>Returns the number of the values in the object which <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>
point to. if <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> isn't valid, returns 0.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1064"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNITERGETVALUE"
></A
>FcPatternIterGetValue</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1072"
></A
><H2
>Name</H2
>FcPatternIterGetValue&nbsp;--&nbsp;Returns a value which the iterator point to</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1075"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1076"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcResult <TT
CLASS="FUNCTION"
>FcPatternIterGetValue</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPatternIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>, FcValue *<TT
CLASS="PARAMETER"
><I
>v</I
></TT
>, FcValueBinding *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1091"
></A
><H2
>Description</H2
><P
>Returns in <TT
CLASS="PARAMETER"
><I
>v</I
></TT
> the <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>'th value
which <TT
CLASS="PARAMETER"
><I
>iter</I
></TT
> point to. also binding to <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>
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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1098"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
><H1
><A
NAME="FCPATTERNPRINT"
></A
>FcPatternPrint</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1106"
></A
><H2
>Name</H2
>FcPatternPrint&nbsp;--&nbsp;Print a pattern for debugging</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1109"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1110"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcPatternPrint</TT
></CODE
>(const FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1117"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCDEFAULTSUBSTITUTE"
></A
>FcDefaultSubstitute</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1125"
></A
><H2
>Name</H2
>FcDefaultSubstitute&nbsp;--&nbsp;Perform default substitutions in a pattern</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1128"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1129"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcDefaultSubstitute</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1136"
></A
><H2
>Description</H2
><P
>Supplies default values for underspecified font patterns:
<P
></P
><UL
><LI
><P
>Patterns without a specified style or weight are set to Medium</P
></LI
><LI
><P
>Patterns without a specified style or slant are set to Roman</P
></LI
><LI
><P
>Patterns without a specified pixel size are given one computed from any
specified point size (default 12), dpi (default 75) and scale (default 1).</P
></LI
></UL
>
</P
></DIV
><H1
><A
NAME="FCNAMEPARSE"
></A
>FcNameParse</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1151"
></A
><H2
>Name</H2
>FcNameParse&nbsp;--&nbsp;Parse a pattern string</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1154"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1155"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcNameParse</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1162"
></A
><H2
>Description</H2
><P
>Converts <TT
CLASS="PARAMETER"
><I
>name</I
></TT
> from the standard text format described above into a pattern.
</P
></DIV
><H1
><A
NAME="FCNAMEUNPARSE"
></A
>FcNameUnparse</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1171"
></A
><H2
>Name</H2
>FcNameUnparse&nbsp;--&nbsp;Convert a pattern back into a string that can be parsed</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1174"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1175"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcNameUnparse</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>pat</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1182"
></A
><H2
>Description</H2
><P
>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().
</P
></DIV
><H1
><A
NAME="FCPATTERNFORMAT"
></A
>FcPatternFormat</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1190"
></A
><H2
>Name</H2
>FcPatternFormat&nbsp;--&nbsp;Format a pattern into a string according to a format specifier</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1193"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1194"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcPatternFormat</TT
></CODE
>(FcPattern *<TT
CLASS="PARAMETER"
><I
>pat</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>format</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1203"
></A
><H2
>Description</H2
><P
>Converts given pattern <TT
CLASS="PARAMETER"
><I
>pat</I
></TT
> into text described by
the format specifier <TT
CLASS="PARAMETER"
><I
>format</I
></TT
>.
The return value refers to newly allocated memory which should be freed by the
caller using free(), or NULL if <TT
CLASS="PARAMETER"
><I
>format</I
></TT
> is invalid.&#13;</P
><P
>&#13;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.&#13;</P
><P
>&#13;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.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>simple</I
> tag
is one where the content is an identifier. When simple
tags are expanded, the named identifier will be looked up in
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> 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".&#13;</P
><P
>&#13;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]}".&#13;</P
><P
>&#13;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 <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> does not have weight set.&#13;</P
><P
>&#13;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 <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> does not have weight set.&#13;</P
><P
>&#13;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 <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> does not have weight set.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>count</I
> 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
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> has set, which may be zero.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>sub-expression</I
> 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.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>filter-out</I
> 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 <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> sans the size and pixelsize elements.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>filter-in</I
> 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
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>conditional</I
> 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 <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> has size and dpi elements but
no pixelsize element, and to "fail" otherwise.&#13;</P
><P
>&#13;An <I
CLASS="FIRSTTERM"
>enumerate</I
> 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.&#13;</P
><P
>&#13;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.&#13;</P
><P
>&#13;A <I
CLASS="FIRSTTERM"
>builtin</I
> tag
is one starting with the character "=" followed by a builtin
name. The following builtins are defined:
<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>unparse</DT
><DD
><P
>Expands to the result of calling FcNameUnparse() on the pattern.</P
></DD
><DT
>fcmatch</DT
><DD
><P
>Expands to the output of the default output format of the fc-match
command on the pattern, without the final newline.</P
></DD
><DT
>fclist</DT
><DD
><P
>Expands to the output of the default output format of the fc-list
command on the pattern, without the final newline.</P
></DD
><DT
>fccat</DT
><DD
><P
>Expands to the output of the default output format of the fc-cat
command on the pattern, without the final newline.</P
></DD
><DT
>pkgkit</DT
><DD
><P
>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.</P
></DD
></DL
></DIV
>
For example, the format "%{+family,style{%{=unparse}}}\n" will expand
to an unparsed name containing only the family and style element values
from <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>.&#13;</P
><P
>&#13;The contents of any tag can be followed by a set of zero or more
<I
CLASS="FIRSTTERM"
>converter</I
>s. A converter is specified by the
character "|" followed by the converter name and arguments. The
following converters are defined:
<P
></P
><DIV
CLASS="VARIABLELIST"
><DL
><DT
>basename</DT
><DD
><P
>Replaces text with the results of calling FcStrBasename() on it.</P
></DD
><DT
>dirname</DT
><DD
><P
>Replaces text with the results of calling FcStrDirname() on it.</P
></DD
><DT
>downcase</DT
><DD
><P
>Replaces text with the results of calling FcStrDowncase() on it.</P
></DD
><DT
>shescape</DT
><DD
><P
>Escapes text for one level of shell expansion.
(Escapes single-quotes, also encloses text in single-quotes.)</P
></DD
><DT
>cescape</DT
><DD
><P
>Escapes text such that it can be used as part of a C string literal.
(Escapes backslash and double-quotes.)</P
></DD
><DT
>xmlescape</DT
><DD
><P
>Escapes text such that it can be used in XML and HTML.
(Escapes less-than, greater-than, and ampersand.)</P
></DD
><DT
>delete(<TT
CLASS="PARAMETER"
><I
>chars</I
></TT
>)</DT
><DD
><P
>Deletes all occurrences of each of the characters in <TT
CLASS="PARAMETER"
><I
>chars</I
></TT
>
from the text.
FIXME: This converter is not UTF-8 aware yet.</P
></DD
><DT
>escape(<TT
CLASS="PARAMETER"
><I
>chars</I
></TT
>)</DT
><DD
><P
>Escapes all occurrences of each of the characters in <TT
CLASS="PARAMETER"
><I
>chars</I
></TT
>
by prepending it by the first character in <TT
CLASS="PARAMETER"
><I
>chars</I
></TT
>.
FIXME: This converter is not UTF-8 aware yet.</P
></DD
><DT
>translate(<TT
CLASS="PARAMETER"
><I
>from</I
></TT
>,<TT
CLASS="PARAMETER"
><I
>to</I
></TT
>)</DT
><DD
><P
>Translates all occurrences of each of the characters in <TT
CLASS="PARAMETER"
><I
>from</I
></TT
>
by replacing them with their corresponding character in <TT
CLASS="PARAMETER"
><I
>to</I
></TT
>.
If <TT
CLASS="PARAMETER"
><I
>to</I
></TT
> has fewer characters than
<TT
CLASS="PARAMETER"
><I
>from</I
></TT
>, it will be extended by repeating its last
character.
FIXME: This converter is not UTF-8 aware yet.</P
></DD
></DL
></DIV
>
For example, the format "%{family|downcase|delete( )}\n" will expand
to the values of the family element in <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>,
lower-cased and with spaces removed.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1313"
></A
><H2
>Since</H2
><P
>version 2.9.0</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1316"
>FcFontSet</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCFONTSETCREATE"
>FcFontSetCreate</A
>&nbsp;--&nbsp;Create a font set</DT
><DT
><A
HREF="#FCFONTSETDESTROY"
>FcFontSetDestroy</A
>&nbsp;--&nbsp;Destroy a font set</DT
><DT
><A
HREF="#FCFONTSETADD"
>FcFontSetAdd</A
>&nbsp;--&nbsp;Add to a font set</DT
><DT
><A
HREF="#FCFONTSETLIST"
>FcFontSetList</A
>&nbsp;--&nbsp;List fonts from a set of font sets</DT
><DT
><A
HREF="#FCFONTSETMATCH"
>FcFontSetMatch</A
>&nbsp;--&nbsp;Return the best font from a set of font sets</DT
><DT
><A
HREF="#FCFONTSETPRINT"
>FcFontSetPrint</A
>&nbsp;--&nbsp;Print a set of patterns to stdout</DT
><DT
><A
HREF="#FCFONTSETSORT"
>FcFontSetSort</A
>&nbsp;--&nbsp;Return list of matching fonts</DT
><DT
><A
HREF="#FCFONTSETSORTDESTROY"
>FcFontSetSortDestroy</A
>&nbsp;--&nbsp;DEPRECATED destroy a font set</DT
></DL
></DIV
><P
>An FcFontSet simply holds a list of patterns; these are used to return the
results of listing available fonts.
</P
><H1
><A
NAME="FCFONTSETCREATE"
></A
>FcFontSetCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1324"
></A
><H2
>Name</H2
>FcFontSetCreate&nbsp;--&nbsp;Create a font set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1327"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1328"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcFontSetCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1335"
></A
><H2
>Description</H2
><P
>Creates an empty font set.
</P
></DIV
><H1
><A
NAME="FCFONTSETDESTROY"
></A
>FcFontSetDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1343"
></A
><H2
>Name</H2
>FcFontSetDestroy&nbsp;--&nbsp;Destroy a font set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1346"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1347"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcFontSetDestroy</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1354"
></A
><H2
>Description</H2
><P
>Destroys a font set. Note that this destroys any referenced patterns as
well.
</P
></DIV
><H1
><A
NAME="FCFONTSETADD"
></A
>FcFontSetAdd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1362"
></A
><H2
>Name</H2
>FcFontSetAdd&nbsp;--&nbsp;Add to a font set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1365"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1366"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcFontSetAdd</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>font</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1375"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCFONTSETLIST"
></A
>FcFontSetList</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1383"
></A
><H2
>Name</H2
>FcFontSetList&nbsp;--&nbsp;List fonts from a set of font sets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1386"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1387"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcFontSetList</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcFontSet **<TT
CLASS="PARAMETER"
><I
>sets</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>nsets</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>, FcObjectSet *<TT
CLASS="PARAMETER"
><I
>object_set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1402"
></A
><H2
>Description</H2
><P
>Selects fonts matching <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> from
<TT
CLASS="PARAMETER"
><I
>sets</I
></TT
>, creates patterns from those
fonts containing only the objects in <TT
CLASS="PARAMETER"
><I
>object_set</I
></TT
> and returns
the set of unique such patterns.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the default configuration is checked
to be up to date, and used.
</P
></DIV
><H1
><A
NAME="FCFONTSETMATCH"
></A
>FcFontSetMatch</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1414"
></A
><H2
>Name</H2
>FcFontSetMatch&nbsp;--&nbsp;Return the best font from a set of font sets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1417"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1418"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcFontSetMatch</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcFontSet **<TT
CLASS="PARAMETER"
><I
>sets</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>nsets</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>, FcResult *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1433"
></A
><H2
>Description</H2
><P
>Finds the font in <TT
CLASS="PARAMETER"
><I
>sets</I
></TT
> most closely matching
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> and returns the result of
<TT
CLASS="FUNCTION"
>FcFontRenderPrepare</TT
> for that font and the provided
pattern. This function should be called only after
<TT
CLASS="FUNCTION"
>FcConfigSubstitute</TT
> and
<TT
CLASS="FUNCTION"
>FcDefaultSubstitute</TT
> have been called for
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>; otherwise the results will not be correct.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
Returns NULL if an error occurs during this process.
</P
></DIV
><H1
><A
NAME="FCFONTSETPRINT"
></A
>FcFontSetPrint</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1448"
></A
><H2
>Name</H2
>FcFontSetPrint&nbsp;--&nbsp;Print a set of patterns to stdout</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1451"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1452"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcFontSetPrint</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1459"
></A
><H2
>Description</H2
><P
>This function is useful for diagnosing font related issues, printing the
complete contents of every pattern in <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>. The format
of the output is designed to be of help to users and developers, and may
change at any time.
</P
></DIV
><H1
><A
NAME="FCFONTSETSORT"
></A
>FcFontSetSort</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1468"
></A
><H2
>Name</H2
>FcFontSetSort&nbsp;--&nbsp;Return list of matching fonts</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1471"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1472"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcFontSetSort</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcFontSet **<TT
CLASS="PARAMETER"
><I
>sets</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>nsets</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>trim</I
></TT
>, FcCharSet **<TT
CLASS="PARAMETER"
><I
>csp</I
></TT
>, FcResult *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1491"
></A
><H2
>Description</H2
><P
>Returns the list of fonts from <TT
CLASS="PARAMETER"
><I
>sets</I
></TT
>
sorted by closeness to <TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
>.
If <TT
CLASS="PARAMETER"
><I
>trim</I
></TT
> 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 <TT
CLASS="PARAMETER"
><I
>csp</I
></TT
>,
if <TT
CLASS="PARAMETER"
><I
>csp</I
></TT
> is not NULL. This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>;
otherwise the results will not be correct.
</P
><P
>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
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> to
<TT
CLASS="FUNCTION"
>FcFontRenderPrepare</TT
> which combines them into a complete pattern.
</P
><P
>The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy.
</P
></DIV
><H1
><A
NAME="FCFONTSETSORTDESTROY"
></A
>FcFontSetSortDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1509"
></A
><H2
>Name</H2
>FcFontSetSortDestroy&nbsp;--&nbsp;DEPRECATED destroy a font set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1512"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1513"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcFontSetSortDestroy</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1520"
></A
><H2
>Description</H2
><P
>This function is DEPRECATED. <TT
CLASS="FUNCTION"
>FcFontSetSortDestroy</TT
>
destroys <TT
CLASS="PARAMETER"
><I
>set</I
></TT
> by calling
<TT
CLASS="FUNCTION"
>FcFontSetDestroy</TT
>. Applications should use
<TT
CLASS="FUNCTION"
>FcFontSetDestroy</TT
> directly instead.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1527"
>FcObjectSet</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCOBJECTSETCREATE"
>FcObjectSetCreate</A
>&nbsp;--&nbsp;Create an object set</DT
><DT
><A
HREF="#FCOBJECTSETADD"
>FcObjectSetAdd</A
>&nbsp;--&nbsp;Add to an object set</DT
><DT
><A
HREF="#FCOBJECTSETDESTROY"
>FcObjectSetDestroy</A
>&nbsp;--&nbsp;Destroy an object set</DT
><DT
><A
HREF="#FCOBJECTSETBUILD"
>FcObjectSetBuild</A
>&nbsp;--&nbsp;Build object set from args</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCOBJECTSETCREATE"
></A
>FcObjectSetCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1535"
></A
><H2
>Name</H2
>FcObjectSetCreate&nbsp;--&nbsp;Create an object set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1538"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1539"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcObjectSet * <TT
CLASS="FUNCTION"
>FcObjectSetCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1546"
></A
><H2
>Description</H2
><P
>Creates an empty set.
</P
></DIV
><H1
><A
NAME="FCOBJECTSETADD"
></A
>FcObjectSetAdd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1554"
></A
><H2
>Name</H2
>FcObjectSetAdd&nbsp;--&nbsp;Add to an object set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1557"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1558"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcObjectSetAdd</TT
></CODE
>(FcObjectSet *<TT
CLASS="PARAMETER"
><I
>os</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1567"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCOBJECTSETDESTROY"
></A
>FcObjectSetDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1575"
></A
><H2
>Name</H2
>FcObjectSetDestroy&nbsp;--&nbsp;Destroy an object set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1578"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1579"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcObjectSetDestroy</TT
></CODE
>(FcObjectSet *<TT
CLASS="PARAMETER"
><I
>os</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1586"
></A
><H2
>Description</H2
><P
>Destroys an object set.
</P
></DIV
><H1
><A
NAME="FCOBJECTSETBUILD"
></A
>FcObjectSetBuild</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1594"
></A
><H2
>Name</H2
>FcObjectSetBuild, FcObjectSetVaBuild, FcObjectSetVapBuild&nbsp;--&nbsp;Build object set from args</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1599"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1600"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcObjectSet * <TT
CLASS="FUNCTION"
>FcObjectSetBuild</TT
></CODE
>(const char *<TT
CLASS="PARAMETER"
><I
>first</I
></TT
>, ...<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcObjectSet * <TT
CLASS="FUNCTION"
>FcObjectSetVaBuild</TT
></CODE
>(const char *<TT
CLASS="PARAMETER"
><I
>first</I
></TT
>, va_list <TT
CLASS="PARAMETER"
><I
>va</I
></TT
>);</CODE
></P
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcObjectSetVapBuild</TT
></CODE
>(FcObjectSet *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>, const char *<TT
CLASS="PARAMETER"
><I
>first</I
></TT
>, va_list <TT
CLASS="PARAMETER"
><I
>va</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1625"
></A
><H2
>Description</H2
><P
>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 <TT
CLASS="PARAMETER"
><I
>result</I
></TT
> variable directly.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1629"
>FreeType specific functions</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCFREETYPECHARINDEX"
>FcFreeTypeCharIndex</A
>&nbsp;--&nbsp;map Unicode to glyph id</DT
><DT
><A
HREF="#FCFREETYPECHARSET"
>FcFreeTypeCharSet</A
>&nbsp;--&nbsp;compute Unicode coverage</DT
><DT
><A
HREF="#FCFREETYPECHARSETANDSPACING"
>FcFreeTypeCharSetAndSpacing</A
>&nbsp;--&nbsp;compute Unicode coverage and spacing type</DT
><DT
><A
HREF="#FCFREETYPEQUERY"
>FcFreeTypeQuery</A
>&nbsp;--&nbsp;compute pattern from font file (and index)</DT
><DT
><A
HREF="#FCFREETYPEQUERYALL"
>FcFreeTypeQueryAll</A
>&nbsp;--&nbsp;compute all patterns from font file (and index)</DT
><DT
><A
HREF="#FCFREETYPEQUERYFACE"
>FcFreeTypeQueryFace</A
>&nbsp;--&nbsp;compute pattern from FT_Face</DT
></DL
></DIV
><P
>While the fontconfig library doesn't insist that FreeType be used as the
rasterization mechanism for fonts, it does provide some convenience
functions.
</P
><H1
><A
NAME="FCFREETYPECHARINDEX"
></A
>FcFreeTypeCharIndex</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1637"
></A
><H2
>Name</H2
>FcFreeTypeCharIndex&nbsp;--&nbsp;map Unicode to glyph id</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1640"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1641"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig.h&#62;
#include &#60;fcfreetype.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FT_UInt <TT
CLASS="FUNCTION"
>FcFreeTypeCharIndex</TT
></CODE
>(FT_Face <TT
CLASS="PARAMETER"
><I
>face</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1650"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCFREETYPECHARSET"
></A
>FcFreeTypeCharSet</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1658"
></A
><H2
>Name</H2
>FcFreeTypeCharSet&nbsp;--&nbsp;compute Unicode coverage</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1661"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1662"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig.h&#62;
#include &#60;fcfreetype.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcFreeTypeCharSet</TT
></CODE
>(FT_Face <TT
CLASS="PARAMETER"
><I
>face</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1671"
></A
><H2
>Description</H2
><P
>Scans a FreeType face and returns the set of encoded Unicode chars.
FcBlanks is deprecated, <TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
> is ignored and
accepted only for compatibility with older code.
</P
></DIV
><H1
><A
NAME="FCFREETYPECHARSETANDSPACING"
></A
>FcFreeTypeCharSetAndSpacing</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1680"
></A
><H2
>Name</H2
>FcFreeTypeCharSetAndSpacing&nbsp;--&nbsp;compute Unicode coverage and spacing type</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1683"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1684"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig.h&#62;
#include &#60;fcfreetype.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcFreeTypeCharSetAndSpacing</TT
></CODE
>(FT_Face <TT
CLASS="PARAMETER"
><I
>face</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>spacing</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1695"
></A
><H2
>Description</H2
><P
>Scans a FreeType face and returns the set of encoded Unicode chars.
FcBlanks is deprecated, <TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
> is ignored and
accepted only for compatibility with older code.
<TT
CLASS="PARAMETER"
><I
>spacing</I
></TT
> 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.
</P
></DIV
><H1
><A
NAME="FCFREETYPEQUERY"
></A
>FcFreeTypeQuery</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1705"
></A
><H2
>Name</H2
>FcFreeTypeQuery&nbsp;--&nbsp;compute pattern from font file (and index)</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1708"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1709"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig.h&#62;
#include &#60;fcfreetype.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcFreeTypeQuery</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>count</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1722"
></A
><H2
>Description</H2
><P
>Constructs a pattern representing the 'id'th face in 'file'. The number
of faces in 'file' is returned in 'count'.
FcBlanks is deprecated, <TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
> is ignored and
accepted only for compatibility with older code.
</P
></DIV
><H1
><A
NAME="FCFREETYPEQUERYALL"
></A
>FcFreeTypeQueryAll</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1731"
></A
><H2
>Name</H2
>FcFreeTypeQueryAll&nbsp;--&nbsp;compute all patterns from font file (and index)</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1734"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1735"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig.h&#62;
#include &#60;fcfreetype.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>unsigned int <TT
CLASS="FUNCTION"
>FcFreeTypeQueryAll</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>count</I
></TT
>, FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1750"
></A
><H2
>Description</H2
><P
>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, <TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
> is ignored and
accepted only for compatibility with older code.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1754"
></A
><H2
>Since</H2
><P
>version 2.12.91</P
></DIV
><H1
><A
NAME="FCFREETYPEQUERYFACE"
></A
>FcFreeTypeQueryFace</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1762"
></A
><H2
>Name</H2
>FcFreeTypeQueryFace&nbsp;--&nbsp;compute pattern from FT_Face</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1765"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1766"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig.h&#62;
#include &#60;fcfreetype.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcFreeTypeQueryFace</TT
></CODE
>(const FT_Face <TT
CLASS="PARAMETER"
><I
>face</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>id</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1779"
></A
><H2
>Description</H2
><P
>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, <TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
> is ignored and
accepted only for compatibility with older code.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1783"
>FcValue</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCVALUEDESTROY"
>FcValueDestroy</A
>&nbsp;--&nbsp;Free a value</DT
><DT
><A
HREF="#FCVALUESAVE"
>FcValueSave</A
>&nbsp;--&nbsp;Copy a value</DT
><DT
><A
HREF="#FCVALUEPRINT"
>FcValuePrint</A
>&nbsp;--&nbsp;Print a value to stdout</DT
><DT
><A
HREF="#FCVALUEEQUAL"
>FcValueEqual</A
>&nbsp;--&nbsp;Test two values for equality</DT
></DL
></DIV
><P
>FcValue is a structure containing a type tag and a union of all possible
datatypes. The tag is an enum of type
<I
CLASS="EMPHASIS"
>FcType</I
>
and is intended to provide a measure of run-time
typechecking, although that depends on careful programming.
</P
><H1
><A
NAME="FCVALUEDESTROY"
></A
>FcValueDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1792"
></A
><H2
>Name</H2
>FcValueDestroy&nbsp;--&nbsp;Free a value</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1795"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1796"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcValueDestroy</TT
></CODE
>(FcValue <TT
CLASS="PARAMETER"
><I
>v</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1803"
></A
><H2
>Description</H2
><P
>Frees any memory referenced by <TT
CLASS="PARAMETER"
><I
>v</I
></TT
>. Values of type FcTypeString,
FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
</P
></DIV
><H1
><A
NAME="FCVALUESAVE"
></A
>FcValueSave</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1812"
></A
><H2
>Name</H2
>FcValueSave&nbsp;--&nbsp;Copy a value</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1815"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1816"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcValue <TT
CLASS="FUNCTION"
>FcValueSave</TT
></CODE
>(FcValue <TT
CLASS="PARAMETER"
><I
>v</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1823"
></A
><H2
>Description</H2
><P
>Returns a copy of <TT
CLASS="PARAMETER"
><I
>v</I
></TT
> duplicating any object referenced by it so that <TT
CLASS="PARAMETER"
><I
>v</I
></TT
>
may be safely destroyed without harming the new value.
</P
></DIV
><H1
><A
NAME="FCVALUEPRINT"
></A
>FcValuePrint</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1833"
></A
><H2
>Name</H2
>FcValuePrint&nbsp;--&nbsp;Print a value to stdout</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1836"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1837"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcValuePrint</TT
></CODE
>(FcValue <TT
CLASS="PARAMETER"
><I
>v</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1844"
></A
><H2
>Description</H2
><P
>Prints a human-readable representation of <TT
CLASS="PARAMETER"
><I
>v</I
></TT
> to
stdout. The format should not be considered part of the library
specification as it may change in the future.
</P
></DIV
><H1
><A
NAME="FCVALUEEQUAL"
></A
>FcValueEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1853"
></A
><H2
>Name</H2
>FcValueEqual&nbsp;--&nbsp;Test two values for equality</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1856"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1857"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcValueEqual</TT
></CODE
>(FcValue <TT
CLASS="PARAMETER"
><I
>v_a</I
></TT
>, FcValue <TT
CLASS="PARAMETER"
><I
>v_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1866"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN1869"
>FcCharSet</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCCHARSETCREATE"
>FcCharSetCreate</A
>&nbsp;--&nbsp;Create an empty character set</DT
><DT
><A
HREF="#FCCHARSETDESTROY"
>FcCharSetDestroy</A
>&nbsp;--&nbsp;Destroy a character set</DT
><DT
><A
HREF="#FCCHARSETADDCHAR"
>FcCharSetAddChar</A
>&nbsp;--&nbsp;Add a character to a charset</DT
><DT
><A
HREF="#FCCHARSETDELCHAR"
>FcCharSetDelChar</A
>&nbsp;--&nbsp;Delete a character from a charset</DT
><DT
><A
HREF="#FCCHARSETCOPY"
>FcCharSetCopy</A
>&nbsp;--&nbsp;Copy a charset</DT
><DT
><A
HREF="#FCCHARSETEQUAL"
>FcCharSetEqual</A
>&nbsp;--&nbsp;Compare two charsets</DT
><DT
><A
HREF="#FCCHARSETINTERSECT"
>FcCharSetIntersect</A
>&nbsp;--&nbsp;Intersect charsets</DT
><DT
><A
HREF="#FCCHARSETUNION"
>FcCharSetUnion</A
>&nbsp;--&nbsp;Add charsets</DT
><DT
><A
HREF="#FCCHARSETSUBTRACT"
>FcCharSetSubtract</A
>&nbsp;--&nbsp;Subtract charsets</DT
><DT
><A
HREF="#FCCHARSETMERGE"
>FcCharSetMerge</A
>&nbsp;--&nbsp;Merge charsets</DT
><DT
><A
HREF="#FCCHARSETHASCHAR"
>FcCharSetHasChar</A
>&nbsp;--&nbsp;Check a charset for a char</DT
><DT
><A
HREF="#FCCHARSETCOUNT"
>FcCharSetCount</A
>&nbsp;--&nbsp;Count entries in a charset</DT
><DT
><A
HREF="#FCCHARSETINTERSECTCOUNT"
>FcCharSetIntersectCount</A
>&nbsp;--&nbsp;Intersect and count charsets</DT
><DT
><A
HREF="#FCCHARSETSUBTRACTCOUNT"
>FcCharSetSubtractCount</A
>&nbsp;--&nbsp;Subtract and count charsets</DT
><DT
><A
HREF="#FCCHARSETISSUBSET"
>FcCharSetIsSubset</A
>&nbsp;--&nbsp;Test for charset inclusion</DT
><DT
><A
HREF="#FCCHARSETFIRSTPAGE"
>FcCharSetFirstPage</A
>&nbsp;--&nbsp;Start enumerating charset contents</DT
><DT
><A
HREF="#FCCHARSETNEXTPAGE"
>FcCharSetNextPage</A
>&nbsp;--&nbsp;Continue enumerating charset contents</DT
><DT
><A
HREF="#FCCHARSETCOVERAGE"
>FcCharSetCoverage</A
>&nbsp;--&nbsp;DEPRECATED return coverage for a Unicode page</DT
><DT
><A
HREF="#FCCHARSETNEW"
>FcCharSetNew</A
>&nbsp;--&nbsp;DEPRECATED alias for FcCharSetCreate</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCCHARSETCREATE"
></A
>FcCharSetCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1877"
></A
><H2
>Name</H2
>FcCharSetCreate&nbsp;--&nbsp;Create an empty character set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1880"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1881"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcCharSetCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1888"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcCharSetCreate</TT
> allocates and initializes a new empty
character set object.
</P
></DIV
><H1
><A
NAME="FCCHARSETDESTROY"
></A
>FcCharSetDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1897"
></A
><H2
>Name</H2
>FcCharSetDestroy&nbsp;--&nbsp;Destroy a character set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1900"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1901"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcCharSetDestroy</TT
></CODE
>(FcCharSet *<TT
CLASS="PARAMETER"
><I
>fcs</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1908"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcCharSetDestroy</TT
> decrements the reference count
<TT
CLASS="PARAMETER"
><I
>fcs</I
></TT
>. If the reference count becomes zero, all
memory referenced is freed.
</P
></DIV
><H1
><A
NAME="FCCHARSETADDCHAR"
></A
>FcCharSetAddChar</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1918"
></A
><H2
>Name</H2
>FcCharSetAddChar&nbsp;--&nbsp;Add a character to a charset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1921"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1922"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcCharSetAddChar</TT
></CODE
>(FcCharSet *<TT
CLASS="PARAMETER"
><I
>fcs</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1931"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcCharSetAddChar</TT
> 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.
</P
></DIV
><H1
><A
NAME="FCCHARSETDELCHAR"
></A
>FcCharSetDelChar</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1940"
></A
><H2
>Name</H2
>FcCharSetDelChar&nbsp;--&nbsp;Delete a character from a charset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1943"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1944"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcCharSetDelChar</TT
></CODE
>(FcCharSet *<TT
CLASS="PARAMETER"
><I
>fcs</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1953"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcCharSetDelChar</TT
> 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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1957"
></A
><H2
>Since</H2
><P
>version 2.9.0</P
></DIV
><H1
><A
NAME="FCCHARSETCOPY"
></A
>FcCharSetCopy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1965"
></A
><H2
>Name</H2
>FcCharSetCopy&nbsp;--&nbsp;Copy a charset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1968"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1969"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcCharSetCopy</TT
></CODE
>(FcCharSet *<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1976"
></A
><H2
>Description</H2
><P
>Makes a copy of <TT
CLASS="PARAMETER"
><I
>src</I
></TT
>; note that this may not actually do anything more
than increment the reference count on <TT
CLASS="PARAMETER"
><I
>src</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETEQUAL"
></A
>FcCharSetEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN1986"
></A
><H2
>Name</H2
>FcCharSetEqual&nbsp;--&nbsp;Compare two charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN1989"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN1990"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcCharSetEqual</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN1999"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>
contain the same set of Unicode chars.
</P
></DIV
><H1
><A
NAME="FCCHARSETINTERSECT"
></A
>FcCharSetIntersect</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2009"
></A
><H2
>Name</H2
>FcCharSetIntersect&nbsp;--&nbsp;Intersect charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2012"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2013"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcCharSetIntersect</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2022"
></A
><H2
>Description</H2
><P
>Returns a set including only those chars found in both
<TT
CLASS="PARAMETER"
><I
>a</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETUNION"
></A
>FcCharSetUnion</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2032"
></A
><H2
>Name</H2
>FcCharSetUnion&nbsp;--&nbsp;Add charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2035"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2036"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcCharSetUnion</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2045"
></A
><H2
>Description</H2
><P
>Returns a set including only those chars found in either <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> or <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETSUBTRACT"
></A
>FcCharSetSubtract</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2055"
></A
><H2
>Name</H2
>FcCharSetSubtract&nbsp;--&nbsp;Subtract charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2058"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2059"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcCharSetSubtract</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2068"
></A
><H2
>Description</H2
><P
>Returns a set including only those chars found in <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> but not <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETMERGE"
></A
>FcCharSetMerge</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2078"
></A
><H2
>Name</H2
>FcCharSetMerge&nbsp;--&nbsp;Merge charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2081"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2082"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcCharSetMerge</TT
></CODE
>(FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>, FcBool *<TT
CLASS="PARAMETER"
><I
>changed</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2093"
></A
><H2
>Description</H2
><P
>Adds all chars in <TT
CLASS="PARAMETER"
><I
>b</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>.
In other words, this is an in-place version of FcCharSetUnion.
If <TT
CLASS="PARAMETER"
><I
>changed</I
></TT
> is not NULL, then it returns whether any new
chars from <TT
CLASS="PARAMETER"
><I
>b</I
></TT
> were added to <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>.
Returns FcFalse on failure, either when <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> is a constant
set or from running out of memory.
</P
></DIV
><H1
><A
NAME="FCCHARSETHASCHAR"
></A
>FcCharSetHasChar</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2107"
></A
><H2
>Name</H2
>FcCharSetHasChar&nbsp;--&nbsp;Check a charset for a char</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2110"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2111"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcCharSetHasChar</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>fcs</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2120"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>fcs</I
></TT
> contains the char <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETCOUNT"
></A
>FcCharSetCount</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2130"
></A
><H2
>Name</H2
>FcCharSetCount&nbsp;--&nbsp;Count entries in a charset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2133"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2134"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcCharSetCount</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2141"
></A
><H2
>Description</H2
><P
>Returns the total number of Unicode chars in <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETINTERSECTCOUNT"
></A
>FcCharSetIntersectCount</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2150"
></A
><H2
>Name</H2
>FcCharSetIntersectCount&nbsp;--&nbsp;Intersect and count charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2153"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2154"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcCharSetIntersectCount</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2163"
></A
><H2
>Description</H2
><P
>Returns the number of chars that are in both <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETSUBTRACTCOUNT"
></A
>FcCharSetSubtractCount</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2173"
></A
><H2
>Name</H2
>FcCharSetSubtractCount&nbsp;--&nbsp;Subtract and count charsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2176"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2177"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcCharSetSubtractCount</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2186"
></A
><H2
>Description</H2
><P
>Returns the number of chars that are in <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> but not in <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETISSUBSET"
></A
>FcCharSetIsSubset</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2196"
></A
><H2
>Name</H2
>FcCharSetIsSubset&nbsp;--&nbsp;Test for charset inclusion</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2199"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2200"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcCharSetIsSubset</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, const FcCharSet *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2209"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> is a subset of <TT
CLASS="PARAMETER"
><I
>b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETFIRSTPAGE"
></A
>FcCharSetFirstPage</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2219"
></A
><H2
>Name</H2
>FcCharSetFirstPage&nbsp;--&nbsp;Start enumerating charset contents</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2222"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2223"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcCharSetFirstPage</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, FcChar32[FC_CHARSET_MAP_SIZE] <TT
CLASS="PARAMETER"
><I
>map</I
></TT
>, FcChar32 *<TT
CLASS="PARAMETER"
><I
>next</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2234"
></A
><H2
>Description</H2
><P
>Builds an array of bits in <TT
CLASS="PARAMETER"
><I
>map</I
></TT
> marking the
first page of Unicode coverage of <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>.
<TT
CLASS="PARAMETER"
><I
>*next</I
></TT
> is set to contains the base code point
for the next page in <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>. Returns the base code
point for the page, or <CODE
CLASS="CONSTANT"
>FC_CHARSET_DONE</CODE
> if
<TT
CLASS="PARAMETER"
><I
>a</I
></TT
> contains no pages. As an example, if
<TT
CLASS="FUNCTION"
>FcCharSetFirstPage</TT
> returns
<TT
CLASS="LITERAL"
>0x300</TT
> and fills <TT
CLASS="PARAMETER"
><I
>map</I
></TT
> with
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="LITERALLAYOUT"
>0xffffffff 0xffffffff 0x01000008 0x44300002 0xffffd7f0 0xfffffffb 0xffff7fff 0xffff0003</PRE
></TD
></TR
></TABLE
>
Then the page contains code points <TT
CLASS="LITERAL"
>0x300</TT
> through
<TT
CLASS="LITERAL"
>0x33f</TT
> (the first 64 code points on the page)
because <TT
CLASS="PARAMETER"
><I
>map[0]</I
></TT
> and
<TT
CLASS="PARAMETER"
><I
>map[1]</I
></TT
> both have all their bits set. It also
contains code points <TT
CLASS="LITERAL"
>0x343</TT
> (<TT
CLASS="PARAMETER"
><I
>0x300 + 32*2
+ (4-1)</I
></TT
>) and <TT
CLASS="LITERAL"
>0x35e</TT
> (<TT
CLASS="PARAMETER"
><I
>0x300 +
32*2 + (31-1)</I
></TT
>) because <TT
CLASS="PARAMETER"
><I
>map[2]</I
></TT
> has
the 4th and 31st bits set. The code points represented by
<TT
CLASS="LITERAL"
>map[3]</TT
> and later are left as an exercise for the
reader ;).
</P
></DIV
><H1
><A
NAME="FCCHARSETNEXTPAGE"
></A
>FcCharSetNextPage</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2262"
></A
><H2
>Name</H2
>FcCharSetNextPage&nbsp;--&nbsp;Continue enumerating charset contents</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2265"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2266"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcCharSetNextPage</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, FcChar32[FC_CHARSET_MAP_SIZE] <TT
CLASS="PARAMETER"
><I
>map</I
></TT
>, FcChar32 *<TT
CLASS="PARAMETER"
><I
>next</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2277"
></A
><H2
>Description</H2
><P
>Builds an array of bits in <TT
CLASS="PARAMETER"
><I
>map</I
></TT
> marking the
Unicode coverage of <TT
CLASS="PARAMETER"
><I
>a</I
></TT
> for page containing
<TT
CLASS="PARAMETER"
><I
>*next</I
></TT
> (see the
<TT
CLASS="FUNCTION"
>FcCharSetFirstPage</TT
> description for details).
<TT
CLASS="PARAMETER"
><I
>*next</I
></TT
> is set to contains the base code point
for the next page in <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>. Returns the base of
code point for the page, or <CODE
CLASS="CONSTANT"
>FC_CHARSET_DONE</CODE
> if
<TT
CLASS="PARAMETER"
><I
>a</I
></TT
> does not contain
<TT
CLASS="PARAMETER"
><I
>*next</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCCHARSETCOVERAGE"
></A
>FcCharSetCoverage</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2294"
></A
><H2
>Name</H2
>FcCharSetCoverage&nbsp;--&nbsp;DEPRECATED return coverage for a Unicode page</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2297"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2298"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcCharSetCoverage</TT
></CODE
>(const FcCharSet *<TT
CLASS="PARAMETER"
><I
>a</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>page</I
></TT
>, FcChar32[8] <TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2309"
></A
><H2
>Description</H2
><P
>DEPRECATED
This function returns a bitmask in <TT
CLASS="PARAMETER"
><I
>result</I
></TT
> which
indicates which code points in
<TT
CLASS="PARAMETER"
><I
>page</I
></TT
> are included in <TT
CLASS="PARAMETER"
><I
>a</I
></TT
>.
<TT
CLASS="FUNCTION"
>FcCharSetCoverage</TT
> returns the next page in the charset which has any
coverage.
</P
></DIV
><H1
><A
NAME="FCCHARSETNEW"
></A
>FcCharSetNew</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2321"
></A
><H2
>Name</H2
>FcCharSetNew&nbsp;--&nbsp;DEPRECATED alias for FcCharSetCreate</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2324"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2325"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCharSet * <TT
CLASS="FUNCTION"
>FcCharSetNew</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2332"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcCharSetNew</TT
> is a DEPRECATED alias for FcCharSetCreate.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2336"
>FcLangSet</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCLANGSETCREATE"
>FcLangSetCreate</A
>&nbsp;--&nbsp;create a langset object</DT
><DT
><A
HREF="#FCLANGSETDESTROY"
>FcLangSetDestroy</A
>&nbsp;--&nbsp;destroy a langset object</DT
><DT
><A
HREF="#FCLANGSETCOPY"
>FcLangSetCopy</A
>&nbsp;--&nbsp;copy a langset object</DT
><DT
><A
HREF="#FCLANGSETADD"
>FcLangSetAdd</A
>&nbsp;--&nbsp;add a language to a langset</DT
><DT
><A
HREF="#FCLANGSETDEL"
>FcLangSetDel</A
>&nbsp;--&nbsp;delete a language from a langset</DT
><DT
><A
HREF="#FCLANGSETUNION"
>FcLangSetUnion</A
>&nbsp;--&nbsp;Add langsets</DT
><DT
><A
HREF="#FCLANGSETSUBTRACT"
>FcLangSetSubtract</A
>&nbsp;--&nbsp;Subtract langsets</DT
><DT
><A
HREF="#FCLANGSETCOMPARE"
>FcLangSetCompare</A
>&nbsp;--&nbsp;compare language sets</DT
><DT
><A
HREF="#FCLANGSETCONTAINS"
>FcLangSetContains</A
>&nbsp;--&nbsp;check langset subset relation</DT
><DT
><A
HREF="#FCLANGSETEQUAL"
>FcLangSetEqual</A
>&nbsp;--&nbsp;test for matching langsets</DT
><DT
><A
HREF="#FCLANGSETHASH"
>FcLangSetHash</A
>&nbsp;--&nbsp;return a hash value for a langset</DT
><DT
><A
HREF="#FCLANGSETHASLANG"
>FcLangSetHasLang</A
>&nbsp;--&nbsp;test langset for language support</DT
><DT
><A
HREF="#FCGETDEFAULTLANGS"
>FcGetDefaultLangs</A
>&nbsp;--&nbsp;Get the default languages list</DT
><DT
><A
HREF="#FCLANGSETGETLANGS"
>FcLangSetGetLangs</A
>&nbsp;--&nbsp;get the list of languages in the langset</DT
><DT
><A
HREF="#FCGETLANGS"
>FcGetLangs</A
>&nbsp;--&nbsp;Get list of languages</DT
><DT
><A
HREF="#FCLANGNORMALIZE"
>FcLangNormalize</A
>&nbsp;--&nbsp;Normalize the language string</DT
><DT
><A
HREF="#FCLANGGETCHARSET"
>FcLangGetCharSet</A
>&nbsp;--&nbsp;Get character map for a language</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCLANGSETCREATE"
></A
>FcLangSetCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2344"
></A
><H2
>Name</H2
>FcLangSetCreate&nbsp;--&nbsp;create a langset object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2347"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2348"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcLangSet * <TT
CLASS="FUNCTION"
>FcLangSetCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2355"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcLangSetCreate</TT
> creates a new FcLangSet object.
</P
></DIV
><H1
><A
NAME="FCLANGSETDESTROY"
></A
>FcLangSetDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2364"
></A
><H2
>Name</H2
>FcLangSetDestroy&nbsp;--&nbsp;destroy a langset object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2367"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2368"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcLangSetDestroy</TT
></CODE
>(FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2375"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcLangSetDestroy</TT
> destroys a FcLangSet object, freeing
all memory associated with it.
</P
></DIV
><H1
><A
NAME="FCLANGSETCOPY"
></A
>FcLangSetCopy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2384"
></A
><H2
>Name</H2
>FcLangSetCopy&nbsp;--&nbsp;copy a langset object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2387"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2388"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcLangSet * <TT
CLASS="FUNCTION"
>FcLangSetCopy</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2395"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcLangSetCopy</TT
> creates a new FcLangSet object and
populates it with the contents of <TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCLANGSETADD"
></A
>FcLangSetAdd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2405"
></A
><H2
>Name</H2
>FcLangSetAdd&nbsp;--&nbsp;add a language to a langset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2408"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2409"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcLangSetAdd</TT
></CODE
>(FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2418"
></A
><H2
>Description</H2
><P
><TT
CLASS="PARAMETER"
><I
>lang</I
></TT
> is added to <TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>.
<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
> 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.
</P
></DIV
><H1
><A
NAME="FCLANGSETDEL"
></A
>FcLangSetDel</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2429"
></A
><H2
>Name</H2
>FcLangSetDel&nbsp;--&nbsp;delete a language from a langset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2432"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2433"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcLangSetDel</TT
></CODE
>(FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2442"
></A
><H2
>Description</H2
><P
><TT
CLASS="PARAMETER"
><I
>lang</I
></TT
> is removed from <TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>.
<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
> 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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2448"
></A
><H2
>Since</H2
><P
>version 2.9.0</P
></DIV
><H1
><A
NAME="FCLANGSETUNION"
></A
>FcLangSetUnion</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2456"
></A
><H2
>Name</H2
>FcLangSetUnion&nbsp;--&nbsp;Add langsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2459"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2460"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcLangSet * <TT
CLASS="FUNCTION"
>FcLangSetUnion</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
>, const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2469"
></A
><H2
>Description</H2
><P
>Returns a set including only those languages found in either <TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> or <TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2474"
></A
><H2
>Since</H2
><P
>version 2.9.0</P
></DIV
><H1
><A
NAME="FCLANGSETSUBTRACT"
></A
>FcLangSetSubtract</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2482"
></A
><H2
>Name</H2
>FcLangSetSubtract&nbsp;--&nbsp;Subtract langsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2485"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2486"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcLangSet * <TT
CLASS="FUNCTION"
>FcLangSetSubtract</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
>, const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2495"
></A
><H2
>Description</H2
><P
>Returns a set including only those languages found in <TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> but not in <TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2500"
></A
><H2
>Since</H2
><P
>version 2.9.0</P
></DIV
><H1
><A
NAME="FCLANGSETCOMPARE"
></A
>FcLangSetCompare</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2508"
></A
><H2
>Name</H2
>FcLangSetCompare&nbsp;--&nbsp;compare language sets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2511"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2512"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcLangResult <TT
CLASS="FUNCTION"
>FcLangSetCompare</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
>, const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2521"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcLangSetCompare</TT
> compares language coverage for
<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>. 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.
</P
></DIV
><H1
><A
NAME="FCLANGSETCONTAINS"
></A
>FcLangSetContains</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2532"
></A
><H2
>Name</H2
>FcLangSetContains&nbsp;--&nbsp;check langset subset relation</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2535"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2536"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcLangSetContains</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
>, const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2545"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcLangSetContains</TT
> returns FcTrue if
<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> contains every language in
<TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>. <TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> will 'contain' a
language from <TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
> if <TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
>
has exactly the language, or either the language or
<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> has no territory.
</P
></DIV
><H1
><A
NAME="FCLANGSETEQUAL"
></A
>FcLangSetEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2560"
></A
><H2
>Name</H2
>FcLangSetEqual&nbsp;--&nbsp;test for matching langsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2563"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2564"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcLangSetEqual</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
>, const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2573"
></A
><H2
>Description</H2
><P
>Returns FcTrue if and only if <TT
CLASS="PARAMETER"
><I
>ls_a</I
></TT
> supports precisely
the same language and territory combinations as <TT
CLASS="PARAMETER"
><I
>ls_b</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCLANGSETHASH"
></A
>FcLangSetHash</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2583"
></A
><H2
>Name</H2
>FcLangSetHash&nbsp;--&nbsp;return a hash value for a langset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2586"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2587"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar32 <TT
CLASS="FUNCTION"
>FcLangSetHash</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2594"
></A
><H2
>Description</H2
><P
>This function returns a value which depends solely on the languages
supported by <TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>. Any language which equals
<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
> will have the same result from
<TT
CLASS="FUNCTION"
>FcLangSetHash</TT
>. However, two langsets with the same hash
value may not be equal.
</P
></DIV
><H1
><A
NAME="FCLANGSETHASLANG"
></A
>FcLangSetHasLang</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2605"
></A
><H2
>Name</H2
>FcLangSetHasLang&nbsp;--&nbsp;test langset for language support</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2608"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2609"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcLangResult <TT
CLASS="FUNCTION"
>FcLangSetHasLang</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2618"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcLangSetHasLang</TT
> checks whether
<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
> supports <TT
CLASS="PARAMETER"
><I
>lang</I
></TT
>. If
<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
> has a matching language and territory pair,
this function returns FcLangEqual. If <TT
CLASS="PARAMETER"
><I
>ls</I
></TT
> has
a matching language but differs in which territory that language is for, this
function returns FcLangDifferentTerritory. If <TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>
has no matching language, this function returns FcLangDifferentLang.
</P
></DIV
><H1
><A
NAME="FCGETDEFAULTLANGS"
></A
>FcGetDefaultLangs</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2632"
></A
><H2
>Name</H2
>FcGetDefaultLangs&nbsp;--&nbsp;Get the default languages list</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2635"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2636"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrSet * <TT
CLASS="FUNCTION"
>FcGetDefaultLangs</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2643"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2646"
></A
><H2
>Since</H2
><P
>version 2.9.91</P
></DIV
><H1
><A
NAME="FCLANGSETGETLANGS"
></A
>FcLangSetGetLangs</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2654"
></A
><H2
>Name</H2
>FcLangSetGetLangs&nbsp;--&nbsp;get the list of languages in the langset</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2657"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2658"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrSet * <TT
CLASS="FUNCTION"
>FcLangSetGetLangs</TT
></CODE
>(const FcLangSet *<TT
CLASS="PARAMETER"
><I
>ls</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2665"
></A
><H2
>Description</H2
><P
>Returns a string set of all languages in <TT
CLASS="PARAMETER"
><I
>langset</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCGETLANGS"
></A
>FcGetLangs</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2674"
></A
><H2
>Name</H2
>FcGetLangs&nbsp;--&nbsp;Get list of languages</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2677"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2678"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrSet * <TT
CLASS="FUNCTION"
>FcGetLangs</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2685"
></A
><H2
>Description</H2
><P
>Returns a string set of all known languages.
</P
></DIV
><H1
><A
NAME="FCLANGNORMALIZE"
></A
>FcLangNormalize</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2693"
></A
><H2
>Name</H2
>FcLangNormalize&nbsp;--&nbsp;Normalize the language string</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2696"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2697"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcLangNormalize</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2704"
></A
><H2
>Description</H2
><P
>Returns a string to make <TT
CLASS="PARAMETER"
><I
>lang</I
></TT
> suitable on fontconfig.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2708"
></A
><H2
>Since</H2
><P
>version 2.10.91</P
></DIV
><H1
><A
NAME="FCLANGGETCHARSET"
></A
>FcLangGetCharSet</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2716"
></A
><H2
>Name</H2
>FcLangGetCharSet&nbsp;--&nbsp;Get character map for a language</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2719"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2720"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcCharSet * <TT
CLASS="FUNCTION"
>FcLangGetCharSet</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>lang</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2727"
></A
><H2
>Description</H2
><P
>Returns the FcCharMap for a language.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2730"
>FcMatrix</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCMATRIXINIT"
>FcMatrixInit</A
>&nbsp;--&nbsp;initialize an FcMatrix structure</DT
><DT
><A
HREF="#FCMATRIXCOPY"
>FcMatrixCopy</A
>&nbsp;--&nbsp;Copy a matrix</DT
><DT
><A
HREF="#FCMATRIXEQUAL"
>FcMatrixEqual</A
>&nbsp;--&nbsp;Compare two matrices</DT
><DT
><A
HREF="#FCMATRIXMULTIPLY"
>FcMatrixMultiply</A
>&nbsp;--&nbsp;Multiply matrices</DT
><DT
><A
HREF="#FCMATRIXROTATE"
>FcMatrixRotate</A
>&nbsp;--&nbsp;Rotate a matrix</DT
><DT
><A
HREF="#FCMATRIXSCALE"
>FcMatrixScale</A
>&nbsp;--&nbsp;Scale a matrix</DT
><DT
><A
HREF="#FCMATRIXSHEAR"
>FcMatrixShear</A
>&nbsp;--&nbsp;Shear a matrix</DT
></DL
></DIV
><P
>FcMatrix structures hold an affine transformation in matrix form.
</P
><H1
><A
NAME="FCMATRIXINIT"
></A
>FcMatrixInit</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2738"
></A
><H2
>Name</H2
>FcMatrixInit&nbsp;--&nbsp;initialize an FcMatrix structure</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2741"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2742"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixInit</TT
></CODE
>(FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2749"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixInit</TT
> initializes <TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>
to the identity matrix.
</P
></DIV
><H1
><A
NAME="FCMATRIXCOPY"
></A
>FcMatrixCopy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2759"
></A
><H2
>Name</H2
>FcMatrixCopy&nbsp;--&nbsp;Copy a matrix</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2762"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2763"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixCopy</TT
></CODE
>(const FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2770"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixCopy</TT
> allocates a new FcMatrix
and copies <TT
CLASS="PARAMETER"
><I
>mat</I
></TT
> into it.
</P
></DIV
><H1
><A
NAME="FCMATRIXEQUAL"
></A
>FcMatrixEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2780"
></A
><H2
>Name</H2
>FcMatrixEqual&nbsp;--&nbsp;Compare two matrices</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2783"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2784"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixEqual</TT
></CODE
>(const FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix1</I
></TT
>, const FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2793"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixEqual</TT
> compares <TT
CLASS="PARAMETER"
><I
>matrix1</I
></TT
>
and <TT
CLASS="PARAMETER"
><I
>matrix2</I
></TT
> returning FcTrue when they are equal and
FcFalse when they are not.
</P
></DIV
><H1
><A
NAME="FCMATRIXMULTIPLY"
></A
>FcMatrixMultiply</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2804"
></A
><H2
>Name</H2
>FcMatrixMultiply&nbsp;--&nbsp;Multiply matrices</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2807"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2808"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixMultiply</TT
></CODE
>(FcMatrix *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>, const FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix1</I
></TT
>, const FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2819"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixMultiply</TT
> multiplies
<TT
CLASS="PARAMETER"
><I
>matrix1</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>matrix2</I
></TT
> storing
the result in <TT
CLASS="PARAMETER"
><I
>result</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCMATRIXROTATE"
></A
>FcMatrixRotate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2831"
></A
><H2
>Name</H2
>FcMatrixRotate&nbsp;--&nbsp;Rotate a matrix</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2834"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2835"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixRotate</TT
></CODE
>(FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>cos</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>sin</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2846"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixRotate</TT
> rotates <TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>
by the angle who's sine is <TT
CLASS="PARAMETER"
><I
>sin</I
></TT
> and cosine is
<TT
CLASS="PARAMETER"
><I
>cos</I
></TT
>. This is done by multiplying by the
matrix:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> cos -sin
sin cos</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><H1
><A
NAME="FCMATRIXSCALE"
></A
>FcMatrixScale</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2859"
></A
><H2
>Name</H2
>FcMatrixScale&nbsp;--&nbsp;Scale a matrix</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2862"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2863"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixScale</TT
></CODE
>(FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>sx</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>dy</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2874"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixScale</TT
> multiplies <TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>
x values by <TT
CLASS="PARAMETER"
><I
>sx</I
></TT
> and y values by
<TT
CLASS="PARAMETER"
><I
>dy</I
></TT
>. This is done by multiplying by
the matrix:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> sx 0
0 dy</PRE
></TD
></TR
></TABLE
>
</P
></DIV
><H1
><A
NAME="FCMATRIXSHEAR"
></A
>FcMatrixShear</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2887"
></A
><H2
>Name</H2
>FcMatrixShear&nbsp;--&nbsp;Shear a matrix</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2890"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2891"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcMatrixShear</TT
></CODE
>(FcMatrix *<TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>sh</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>sv</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2902"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcMatrixShare</TT
> shears <TT
CLASS="PARAMETER"
><I
>matrix</I
></TT
>
horizontally by <TT
CLASS="PARAMETER"
><I
>sh</I
></TT
> and vertically by
<TT
CLASS="PARAMETER"
><I
>sv</I
></TT
>. This is done by multiplying by
the matrix:
<TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="PROGRAMLISTING"
> 1 sh
sv 1</PRE
></TD
></TR
></TABLE
>
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN2910"
>FcRange</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCRANGECOPY"
>FcRangeCopy</A
>&nbsp;--&nbsp;Copy a range object</DT
><DT
><A
HREF="#FCRANGECREATEDOUBLE"
>FcRangeCreateDouble</A
>&nbsp;--&nbsp;create a range object for double</DT
><DT
><A
HREF="#FCRANGECREATEINTEGER"
>FcRangeCreateInteger</A
>&nbsp;--&nbsp;create a range object for integer</DT
><DT
><A
HREF="#FCRANGEDESTROY"
>FcRangeDestroy</A
>&nbsp;--&nbsp;destroy a range object</DT
><DT
><A
HREF="#FCRANGEGETDOUBLE"
>FcRangeGetDouble</A
>&nbsp;--&nbsp;Get the range in double</DT
></DL
></DIV
><P
>An FcRange holds two variables to indicate a range in between.
</P
><H1
><A
NAME="FCRANGECOPY"
></A
>FcRangeCopy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2918"
></A
><H2
>Name</H2
>FcRangeCopy&nbsp;--&nbsp;Copy a range object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2921"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2922"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcRange * <TT
CLASS="FUNCTION"
>FcRangeCopy</TT
></CODE
>(const FcRange *<TT
CLASS="PARAMETER"
><I
>range</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2929"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcRangeCopy</TT
> creates a new FcRange object and
populates it with the contents of <TT
CLASS="PARAMETER"
><I
>range</I
></TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2934"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
><H1
><A
NAME="FCRANGECREATEDOUBLE"
></A
>FcRangeCreateDouble</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2942"
></A
><H2
>Name</H2
>FcRangeCreateDouble&nbsp;--&nbsp;create a range object for double</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2945"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2946"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcRange * <TT
CLASS="FUNCTION"
>FcRangeCreateDouble</TT
></CODE
>(double <TT
CLASS="PARAMETER"
><I
>begin</I
></TT
>, double <TT
CLASS="PARAMETER"
><I
>end</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2955"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcRangeCreateDouble</TT
> creates a new FcRange object with
double sized value.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2959"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
><H1
><A
NAME="FCRANGECREATEINTEGER"
></A
>FcRangeCreateInteger</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2967"
></A
><H2
>Name</H2
>FcRangeCreateInteger&nbsp;--&nbsp;create a range object for integer</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2970"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2971"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcRange * <TT
CLASS="FUNCTION"
>FcRangeCreateInteger</TT
></CODE
>(int <TT
CLASS="PARAMETER"
><I
>begin</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>end</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2980"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcRangeCreateInteger</TT
> creates a new FcRange object with
integer sized value.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN2984"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
><H1
><A
NAME="FCRANGEDESTROY"
></A
>FcRangeDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN2992"
></A
><H2
>Name</H2
>FcRangeDestroy&nbsp;--&nbsp;destroy a range object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN2995"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN2996"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcRangeDestroy</TT
></CODE
>(FcRange *<TT
CLASS="PARAMETER"
><I
>range</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3003"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcRangeDestroy</TT
> destroys a FcRange object, freeing
all memory associated with it.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3007"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
><H1
><A
NAME="FCRANGEGETDOUBLE"
></A
>FcRangeGetDouble</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3015"
></A
><H2
>Name</H2
>FcRangeGetDouble&nbsp;--&nbsp;Get the range in double</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3018"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3019"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcRangeGetDouble</TT
></CODE
>(const FcRange *<TT
CLASS="PARAMETER"
><I
>range</I
></TT
>, double *<TT
CLASS="PARAMETER"
><I
>begin</I
></TT
>, double *<TT
CLASS="PARAMETER"
><I
>end</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3030"
></A
><H2
>Description</H2
><P
>Returns in <TT
CLASS="PARAMETER"
><I
>begin</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>end</I
></TT
> as the range.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3035"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN3038"
>FcConfig</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCCONFIGCREATE"
>FcConfigCreate</A
>&nbsp;--&nbsp;Create a configuration</DT
><DT
><A
HREF="#FCCONFIGREFERENCE"
>FcConfigReference</A
>&nbsp;--&nbsp;Increment config reference count</DT
><DT
><A
HREF="#FCCONFIGDESTROY"
>FcConfigDestroy</A
>&nbsp;--&nbsp;Destroy a configuration</DT
><DT
><A
HREF="#FCCONFIGSETCURRENT"
>FcConfigSetCurrent</A
>&nbsp;--&nbsp;Set configuration as default</DT
><DT
><A
HREF="#FCCONFIGGETCURRENT"
>FcConfigGetCurrent</A
>&nbsp;--&nbsp;Return current configuration</DT
><DT
><A
HREF="#FCCONFIGSETFONTSETFILTER"
>FcConfigSetFontSetFilter</A
>&nbsp;--&nbsp;Set a predicate function to filter fontsets</DT
><DT
><A
HREF="#FCCONFIGACCEPTFILTER"
>FcConfigAcceptFilter</A
>&nbsp;--&nbsp;Test whether the given pattern matches filter</DT
><DT
><A
HREF="#FCCONFIGUPTODATE"
>FcConfigUptoDate</A
>&nbsp;--&nbsp;Check timestamps on config files</DT
><DT
><A
HREF="#FCCONFIGHOME"
>FcConfigHome</A
>&nbsp;--&nbsp;return the current home directory.</DT
><DT
><A
HREF="#FCCONFIGENABLEHOME"
>FcConfigEnableHome</A
>&nbsp;--&nbsp;controls use of the home directory.</DT
><DT
><A
HREF="#FCCONFIGBUILDFONTS"
>FcConfigBuildFonts</A
>&nbsp;--&nbsp;Build font database</DT
><DT
><A
HREF="#FCCONFIGGETCONFIGDIRS"
>FcConfigGetConfigDirs</A
>&nbsp;--&nbsp;Get config directories</DT
><DT
><A
HREF="#FCCONFIGGETFONTDIRS"
>FcConfigGetFontDirs</A
>&nbsp;--&nbsp;Get font directories</DT
><DT
><A
HREF="#FCCONFIGGETCONFIGFILES"
>FcConfigGetConfigFiles</A
>&nbsp;--&nbsp;Get config files</DT
><DT
><A
HREF="#FCCONFIGGETCACHE"
>FcConfigGetCache</A
>&nbsp;--&nbsp;DEPRECATED used to return per-user cache filename</DT
><DT
><A
HREF="#FCCONFIGGETCACHEDIRS"
>FcConfigGetCacheDirs</A
>&nbsp;--&nbsp;return the list of directories searched for cache files</DT
><DT
><A
HREF="#FCCONFIGGETFONTS"
>FcConfigGetFonts</A
>&nbsp;--&nbsp;Get config font set</DT
><DT
><A
HREF="#FCCONFIGGETBLANKS"
>FcConfigGetBlanks</A
>&nbsp;--&nbsp;Get config blanks</DT
><DT
><A
HREF="#FCCONFIGGETRESCANINTERVAL"
>FcConfigGetRescanInterval</A
>&nbsp;--&nbsp;Get config rescan interval</DT
><DT
><A
HREF="#FCCONFIGSETRESCANINTERVAL"
>FcConfigSetRescanInterval</A
>&nbsp;--&nbsp;Set config rescan interval</DT
><DT
><A
HREF="#FCCONFIGAPPFONTADDFILE"
>FcConfigAppFontAddFile</A
>&nbsp;--&nbsp;Add font file to font database</DT
><DT
><A
HREF="#FCCONFIGAPPFONTADDDIR"
>FcConfigAppFontAddDir</A
>&nbsp;--&nbsp;Add fonts from directory to font database</DT
><DT
><A
HREF="#FCCONFIGAPPFONTCLEAR"
>FcConfigAppFontClear</A
>&nbsp;--&nbsp;Remove all app fonts from font database</DT
><DT
><A
HREF="#FCCONFIGSUBSTITUTEWITHPAT"
>FcConfigSubstituteWithPat</A
>&nbsp;--&nbsp;Execute substitutions</DT
><DT
><A
HREF="#FCCONFIGSUBSTITUTE"
>FcConfigSubstitute</A
>&nbsp;--&nbsp;Execute substitutions</DT
><DT
><A
HREF="#FCFONTMATCH"
>FcFontMatch</A
>&nbsp;--&nbsp;Return best font</DT
><DT
><A
HREF="#FCFONTSORT"
>FcFontSort</A
>&nbsp;--&nbsp;Return list of matching fonts</DT
><DT
><A
HREF="#FCFONTRENDERPREPARE"
>FcFontRenderPrepare</A
>&nbsp;--&nbsp;Prepare pattern for loading font file</DT
><DT
><A
HREF="#FCFONTLIST"
>FcFontList</A
>&nbsp;--&nbsp;List fonts</DT
><DT
><A
HREF="#FCCONFIGFILENAME"
>FcConfigFilename</A
>&nbsp;--&nbsp;Find a config file</DT
><DT
><A
HREF="#FCCONFIGGETFILENAME"
>FcConfigGetFilename</A
>&nbsp;--&nbsp;Find a config file</DT
><DT
><A
HREF="#FCCONFIGPARSEANDLOAD"
>FcConfigParseAndLoad</A
>&nbsp;--&nbsp;load a configuration file</DT
><DT
><A
HREF="#FCCONFIGPARSEANDLOADFROMMEMORY"
>FcConfigParseAndLoadFromMemory</A
>&nbsp;--&nbsp;load a configuration from memory</DT
><DT
><A
HREF="#FCCONFIGGETSYSROOT"
>FcConfigGetSysRoot</A
>&nbsp;--&nbsp;Obtain the system root directory</DT
><DT
><A
HREF="#FCCONFIGSETSYSROOT"
>FcConfigSetSysRoot</A
>&nbsp;--&nbsp;Set the system root directory</DT
><DT
><A
HREF="#FCCONFIGFILEINFOITERINIT"
>FcConfigFileInfoIterInit</A
>&nbsp;--&nbsp;Initialize the iterator</DT
><DT
><A
HREF="#FCCONFIGFILEINFOITERNEXT"
>FcConfigFileInfoIterNext</A
>&nbsp;--&nbsp;Set the iterator to point to the next list</DT
><DT
><A
HREF="#FCCONFIGFILEINFOITERGET"
>FcConfigFileInfoIterGet</A
>&nbsp;--&nbsp;Obtain the configuration file information</DT
><DT
><A
HREF="#FCCONFIGACCEPTFONT"
>FcConfigAcceptFont</A
>&nbsp;--&nbsp;Test whether the given pattern matches deny list</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCCONFIGCREATE"
></A
>FcConfigCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3046"
></A
><H2
>Name</H2
>FcConfigCreate&nbsp;--&nbsp;Create a configuration</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3049"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3050"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcConfig * <TT
CLASS="FUNCTION"
>FcConfigCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3057"
></A
><H2
>Description</H2
><P
>Creates an empty configuration.
</P
></DIV
><H1
><A
NAME="FCCONFIGREFERENCE"
></A
>FcConfigReference</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3065"
></A
><H2
>Name</H2
>FcConfigReference&nbsp;--&nbsp;Increment config reference count</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3068"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3069"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcConfig * <TT
CLASS="FUNCTION"
>FcConfigReference</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3076"
></A
><H2
>Description</H2
><P
>Add another reference to <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>. Configs are freed only
when the reference count reaches zero.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> 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.
</P
></DIV
><H1
><A
NAME="FCCONFIGDESTROY"
></A
>FcConfigDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3086"
></A
><H2
>Name</H2
>FcConfigDestroy&nbsp;--&nbsp;Destroy a configuration</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3089"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3090"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcConfigDestroy</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3097"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCCONFIGSETCURRENT"
></A
>FcConfigSetCurrent</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3105"
></A
><H2
>Name</H2
>FcConfigSetCurrent&nbsp;--&nbsp;Set configuration as default</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3108"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3109"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigSetCurrent</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3116"
></A
><H2
>Description</H2
><P
>Sets the current default configuration to <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>. Implicitly calls
FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count
in <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> since 2.12.0, returning FcFalse if that call fails.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETCURRENT"
></A
>FcConfigGetCurrent</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3126"
></A
><H2
>Name</H2
>FcConfigGetCurrent&nbsp;--&nbsp;Return current configuration</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3129"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3130"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcConfig * <TT
CLASS="FUNCTION"
>FcConfigGetCurrent</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3137"
></A
><H2
>Description</H2
><P
>Returns the current default configuration.
</P
></DIV
><H1
><A
NAME="FCCONFIGSETFONTSETFILTER"
></A
>FcConfigSetFontSetFilter</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3145"
></A
><H2
>Name</H2
>FcConfigSetFontSetFilter&nbsp;--&nbsp;Set a predicate function to filter fontsets</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3148"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3149"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcConfig * <TT
CLASS="FUNCTION"
>FcConfigSetFontSetFilter</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcFilterFontSetFunc <TT
CLASS="PARAMETER"
><I
>filter_func</I
></TT
>, FcDestroyFunc <TT
CLASS="PARAMETER"
><I
>destroy_data_func</I
></TT
>, void *<TT
CLASS="PARAMETER"
><I
>user_data</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3162"
></A
><H2
>Description</H2
><P
>Sets <TT
CLASS="PARAMETER"
><I
>filter_func</I
></TT
> as a predicate function and filter out
fontsets in <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> as desired.
<TT
CLASS="PARAMETER"
><I
>filter_func</I
></TT
> will be called with a font pattern and
<TT
CLASS="PARAMETER"
><I
>user_data</I
></TT
> only when loading caches.
When <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is going to be destroyed,
<TT
CLASS="PARAMETER"
><I
>user_data</I
></TT
> will be destroyed through
<TT
CLASS="PARAMETER"
><I
>destroy_data_func</I
></TT
> if it is set.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3172"
></A
><H2
>Since</H2
><P
>version 2.16.0</P
></DIV
><H1
><A
NAME="FCCONFIGACCEPTFILTER"
></A
>FcConfigAcceptFilter</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3180"
></A
><H2
>Name</H2
>FcConfigAcceptFilter&nbsp;--&nbsp;Test whether the given pattern matches filter</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3183"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3184"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigAcceptFilter</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcPattern *<TT
CLASS="PARAMETER"
><I
>font</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3193"
></A
><H2
>Description</H2
><P
>This triggers a predicate function set by <TT
CLASS="FUNCTION"
>FcConfigSetFontSetFilter</TT
>
and return FcTrue if <TT
CLASS="PARAMETER"
><I
>font</I
></TT
> matches something they expect.
otherwise FcFalse.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3198"
></A
><H2
>Since</H2
><P
>version 2.16.0</P
></DIV
><H1
><A
NAME="FCCONFIGUPTODATE"
></A
>FcConfigUptoDate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3206"
></A
><H2
>Name</H2
>FcConfigUptoDate&nbsp;--&nbsp;Check timestamps on config files</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3209"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3210"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigUptoDate</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3217"
></A
><H2
>Description</H2
><P
>Checks all of the files related to <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> and returns
whether any of them has been modified since the configuration was created.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGHOME"
></A
>FcConfigHome</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3227"
></A
><H2
>Name</H2
>FcConfigHome&nbsp;--&nbsp;return the current home directory.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3230"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3231"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcConfigHome</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3238"
></A
><H2
>Description</H2
><P
>Return the current user's home directory, if it is available, and if using it
is enabled, and NULL otherwise.
See also <TT
CLASS="FUNCTION"
>FcConfigEnableHome</TT
>).
</P
></DIV
><H1
><A
NAME="FCCONFIGENABLEHOME"
></A
>FcConfigEnableHome</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3247"
></A
><H2
>Name</H2
>FcConfigEnableHome&nbsp;--&nbsp;controls use of the home directory.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3250"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3251"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigEnableHome</TT
></CODE
>(FcBool <TT
CLASS="PARAMETER"
><I
>enable</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3258"
></A
><H2
>Description</H2
><P
>If <TT
CLASS="PARAMETER"
><I
>enable</I
></TT
> 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 <TT
CLASS="PARAMETER"
><I
>enable</I
></TT
> is
FcFalse, then all use of the home directory in these contexts will be
disabled. The previous setting of the value is returned.
</P
></DIV
><H1
><A
NAME="FCCONFIGBUILDFONTS"
></A
>FcConfigBuildFonts</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3268"
></A
><H2
>Name</H2
>FcConfigBuildFonts&nbsp;--&nbsp;Build font database</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3271"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3272"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigBuildFonts</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3279"
></A
><H2
>Description</H2
><P
>Builds the set of available fonts for the given configuration. Note that
any changes to the configuration after this call (through
<TT
CLASS="FUNCTION"
>FcConfigParseAndLoad</TT
> or
<TT
CLASS="FUNCTION"
>FcConfigParseAndLoadFromMemory</TT
>) have indeterminate
effects. (On the other hand, application fonts can still be modified
through <TT
CLASS="FUNCTION"
>FcConfigAppFontAddFile</TT
>,
<TT
CLASS="FUNCTION"
>FcConfigAppFontAddDir</TT
> and
<TT
CLASS="FUNCTION"
>FcConfigAppFontClear</TT
>). Returns FcFalse if this operation
runs out of memory. If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current
configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETCONFIGDIRS"
></A
>FcConfigGetConfigDirs</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3293"
></A
><H2
>Name</H2
>FcConfigGetConfigDirs&nbsp;--&nbsp;Get config directories</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3296"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3297"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrList * <TT
CLASS="FUNCTION"
>FcConfigGetConfigDirs</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3304"
></A
><H2
>Description</H2
><P
>Returns the list of font directories specified in the configuration files
for <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>. Does not include any subdirectories.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETFONTDIRS"
></A
>FcConfigGetFontDirs</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3314"
></A
><H2
>Name</H2
>FcConfigGetFontDirs&nbsp;--&nbsp;Get font directories</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3317"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3318"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrList * <TT
CLASS="FUNCTION"
>FcConfigGetFontDirs</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3325"
></A
><H2
>Description</H2
><P
>Returns the list of font directories in <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>. This includes the
configured font directories along with any directories below those in the
filesystem.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETCONFIGFILES"
></A
>FcConfigGetConfigFiles</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3335"
></A
><H2
>Name</H2
>FcConfigGetConfigFiles&nbsp;--&nbsp;Get config files</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3338"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3339"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrList * <TT
CLASS="FUNCTION"
>FcConfigGetConfigFiles</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3346"
></A
><H2
>Description</H2
><P
>Returns the list of known configuration files used to generate <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETCACHE"
></A
>FcConfigGetCache</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3356"
></A
><H2
>Name</H2
>FcConfigGetCache&nbsp;--&nbsp;DEPRECATED used to return per-user cache filename</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3359"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3360"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcConfigGetCache</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3367"
></A
><H2
>Description</H2
><P
>With fontconfig no longer using per-user cache files, this function now
simply returns NULL to indicate that no per-user file exists.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETCACHEDIRS"
></A
>FcConfigGetCacheDirs</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3375"
></A
><H2
>Name</H2
>FcConfigGetCacheDirs&nbsp;--&nbsp;return the list of directories searched for cache files</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3378"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3379"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrList * <TT
CLASS="FUNCTION"
>FcConfigGetCacheDirs</TT
></CODE
>(const FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3386"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcConfigGetCacheDirs</TT
> 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 <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETFONTS"
></A
>FcConfigGetFonts</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3396"
></A
><H2
>Name</H2
>FcConfigGetFonts&nbsp;--&nbsp;Get config font set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3399"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3400"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcConfigGetFonts</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcSetName <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3409"
></A
><H2
>Description</H2
><P
>Returns one of the two sets of fonts from the configuration as specified
by <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>. This font set is owned by the library and must
not be modified or freed.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
><P
>This function isn't MT-safe. <TT
CLASS="FUNCTION"
>FcConfigReference</TT
> must be called
before using this and then <TT
CLASS="FUNCTION"
>FcConfigDestroy</TT
> when
the return value is no longer referenced.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETBLANKS"
></A
>FcConfigGetBlanks</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3422"
></A
><H2
>Name</H2
>FcConfigGetBlanks&nbsp;--&nbsp;Get config blanks</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3425"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3426"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBlanks * <TT
CLASS="FUNCTION"
>FcConfigGetBlanks</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3433"
></A
><H2
>Description</H2
><P
>FcBlanks is deprecated.
This function always returns NULL.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETRESCANINTERVAL"
></A
>FcConfigGetRescanInterval</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3441"
></A
><H2
>Name</H2
>FcConfigGetRescanInterval&nbsp;--&nbsp;Get config rescan interval</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3444"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3445"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcConfigGetRescanInterval</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3452"
></A
><H2
>Description</H2
><P
>Returns the interval between automatic checks of the configuration (in
seconds) specified in <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>. 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 <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGSETRESCANINTERVAL"
></A
>FcConfigSetRescanInterval</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3462"
></A
><H2
>Name</H2
>FcConfigSetRescanInterval&nbsp;--&nbsp;Set config rescan interval</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3465"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3466"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigSetRescanInterval</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>rescanInterval</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3475"
></A
><H2
>Description</H2
><P
>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 <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGAPPFONTADDFILE"
></A
>FcConfigAppFontAddFile</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3484"
></A
><H2
>Name</H2
>FcConfigAppFontAddFile&nbsp;--&nbsp;Add font file to font database</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3487"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3488"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigAppFontAddFile</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3497"
></A
><H2
>Description</H2
><P
>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 <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL,
the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGAPPFONTADDDIR"
></A
>FcConfigAppFontAddDir</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3506"
></A
><H2
>Name</H2
>FcConfigAppFontAddDir&nbsp;--&nbsp;Add fonts from directory to font database</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3509"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3510"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigAppFontAddDir</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3519"
></A
><H2
>Description</H2
><P
>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 <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL,
the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGAPPFONTCLEAR"
></A
>FcConfigAppFontClear</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3528"
></A
><H2
>Name</H2
>FcConfigAppFontClear&nbsp;--&nbsp;Remove all app fonts from font database</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3531"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3532"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcConfigAppFontClear</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3539"
></A
><H2
>Description</H2
><P
>Clears the set of application-specific fonts.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGSUBSTITUTEWITHPAT"
></A
>FcConfigSubstituteWithPat</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3548"
></A
><H2
>Name</H2
>FcConfigSubstituteWithPat&nbsp;--&nbsp;Execute substitutions</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3551"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3552"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigSubstituteWithPat</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p_pat</I
></TT
>, FcMatchKind <TT
CLASS="PARAMETER"
><I
>kind</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3565"
></A
><H2
>Description</H2
><P
>Performs the sequence of pattern modification operations, if <TT
CLASS="PARAMETER"
><I
>kind</I
></TT
> is
FcMatchPattern, then those tagged as pattern operations are applied, else
if <TT
CLASS="PARAMETER"
><I
>kind</I
></TT
> is FcMatchFont, those tagged as font operations are applied and
p_pat is used for &#60;test&#62; elements with target=pattern. Returns FcFalse
if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCCONFIGSUBSTITUTE"
></A
>FcConfigSubstitute</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3576"
></A
><H2
>Name</H2
>FcConfigSubstitute&nbsp;--&nbsp;Execute substitutions</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3579"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3580"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigSubstitute</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcMatchKind <TT
CLASS="PARAMETER"
><I
>kind</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3591"
></A
><H2
>Description</H2
><P
>Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse
if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCFONTMATCH"
></A
>FcFontMatch</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3600"
></A
><H2
>Name</H2
>FcFontMatch&nbsp;--&nbsp;Return best font</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3603"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3604"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcFontMatch</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcResult *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3615"
></A
><H2
>Description</H2
><P
>Finds the font in <TT
CLASS="PARAMETER"
><I
>sets</I
></TT
> most closely matching
<TT
CLASS="PARAMETER"
><I
>pattern</I
></TT
> and returns the result of
<TT
CLASS="FUNCTION"
>FcFontRenderPrepare</TT
> for that font and the provided
pattern. This function should be called only after
<TT
CLASS="FUNCTION"
>FcConfigSubstitute</TT
> and
<TT
CLASS="FUNCTION"
>FcDefaultSubstitute</TT
> have been called for
<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>; otherwise the results will not be correct.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCFONTSORT"
></A
>FcFontSort</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3630"
></A
><H2
>Name</H2
>FcFontSort&nbsp;--&nbsp;Return list of matching fonts</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3633"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3634"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcFontSort</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>trim</I
></TT
>, FcCharSet **<TT
CLASS="PARAMETER"
><I
>csp</I
></TT
>, FcResult *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3649"
></A
><H2
>Description</H2
><P
>Returns the list of fonts sorted by closeness to <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>. If <TT
CLASS="PARAMETER"
><I
>trim</I
></TT
> 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 <TT
CLASS="PARAMETER"
><I
>csp</I
></TT
>, if <TT
CLASS="PARAMETER"
><I
>csp</I
></TT
> is not NULL. This function
should be called only after FcConfigSubstitute and FcDefaultSubstitute have
been called for <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>; otherwise the results will not be correct.
</P
><P
>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 <TT
CLASS="PARAMETER"
><I
>p</I
></TT
> to
<TT
CLASS="FUNCTION"
>FcFontRenderPrepare</TT
> which combines them into a complete pattern.
</P
><P
>The FcFontSet returned by FcFontSort is destroyed by calling FcFontSetDestroy.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the current configuration is used.
</P
></DIV
><H1
><A
NAME="FCFONTRENDERPREPARE"
></A
>FcFontRenderPrepare</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3667"
></A
><H2
>Name</H2
>FcFontRenderPrepare&nbsp;--&nbsp;Prepare pattern for loading font file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3670"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3671"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcPattern * <TT
CLASS="FUNCTION"
>FcFontRenderPrepare</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>pat</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>font</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3682"
></A
><H2
>Description</H2
><P
>Creates a new pattern consisting of elements of <TT
CLASS="PARAMETER"
><I
>font</I
></TT
> not appearing
in <TT
CLASS="PARAMETER"
><I
>pat</I
></TT
>, elements of <TT
CLASS="PARAMETER"
><I
>pat</I
></TT
> not appearing in <TT
CLASS="PARAMETER"
><I
>font</I
></TT
> and the best matching
value from <TT
CLASS="PARAMETER"
><I
>pat</I
></TT
> for elements appearing in both. The result is passed to
FcConfigSubstituteWithPat with <TT
CLASS="PARAMETER"
><I
>kind</I
></TT
> FcMatchFont and then returned.
</P
></DIV
><H1
><A
NAME="FCFONTLIST"
></A
>FcFontList</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3696"
></A
><H2
>Name</H2
>FcFontList&nbsp;--&nbsp;List fonts</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3699"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3700"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcFontList</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, FcObjectSet *<TT
CLASS="PARAMETER"
><I
>os</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3711"
></A
><H2
>Description</H2
><P
>Selects fonts matching <TT
CLASS="PARAMETER"
><I
>p</I
></TT
>, creates patterns from those fonts containing
only the objects in <TT
CLASS="PARAMETER"
><I
>os</I
></TT
> and returns the set of unique such patterns.
If <TT
CLASS="PARAMETER"
><I
>config</I
></TT
> is NULL, the default configuration is checked
to be up to date, and used.
</P
></DIV
><H1
><A
NAME="FCCONFIGFILENAME"
></A
>FcConfigFilename</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3722"
></A
><H2
>Name</H2
>FcConfigFilename&nbsp;--&nbsp;Find a config file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3725"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3726"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcConfigFilename</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3733"
></A
><H2
>Description</H2
><P
>This function is deprecated and is replaced by <TT
CLASS="FUNCTION"
>FcConfigGetFilename</TT
>.
</P
></DIV
><H1
><A
NAME="FCCONFIGGETFILENAME"
></A
>FcConfigGetFilename</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3742"
></A
><H2
>Name</H2
>FcConfigGetFilename&nbsp;--&nbsp;Find a config file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3745"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3746"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcConfigGetFilename</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3755"
></A
><H2
>Description</H2
><P
>Given the specified external entity name, return the associated filename.
This provides applications a way to convert various configuration file
references into filename form.
</P
><P
>A null or empty <TT
CLASS="PARAMETER"
><I
>name</I
></TT
> 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 <TT
CLASS="PARAMETER"
><I
>~</I
></TT
>, 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.
</P
><P
>The result of this function is affected by the FONTCONFIG_SYSROOT environment variable or equivalent functionality.
</P
></DIV
><H1
><A
NAME="FCCONFIGPARSEANDLOAD"
></A
>FcConfigParseAndLoad</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3767"
></A
><H2
>Name</H2
>FcConfigParseAndLoad&nbsp;--&nbsp;load a configuration file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3770"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3771"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigParseAndLoad</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>complain</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3782"
></A
><H2
>Description</H2
><P
>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
<TT
CLASS="FUNCTION"
>FcConfigParseAndLoad</TT
> and/or
<TT
CLASS="FUNCTION"
>FcConfigParseAndLoadFromMemory</TT
>, call
<TT
CLASS="FUNCTION"
>FcConfigBuildFonts</TT
> to build the font
database.
</P
></DIV
><H1
><A
NAME="FCCONFIGPARSEANDLOADFROMMEMORY"
></A
>FcConfigParseAndLoadFromMemory</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3793"
></A
><H2
>Name</H2
>FcConfigParseAndLoadFromMemory&nbsp;--&nbsp;load a configuration from memory</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3796"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3797"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigParseAndLoadFromMemory</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>buffer</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>complain</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3808"
></A
><H2
>Description</H2
><P
>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
<TT
CLASS="FUNCTION"
>FcConfigParseAndLoad</TT
> and/or
<TT
CLASS="FUNCTION"
>FcConfigParseAndLoadFromMemory</TT
>, call
<TT
CLASS="FUNCTION"
>FcConfigBuildFonts</TT
> to build the font
database.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3814"
></A
><H2
>Since</H2
><P
>version 2.12.5</P
></DIV
><H1
><A
NAME="FCCONFIGGETSYSROOT"
></A
>FcConfigGetSysRoot</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3822"
></A
><H2
>Name</H2
>FcConfigGetSysRoot&nbsp;--&nbsp;Obtain the system root directory</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3825"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3826"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcChar8 * <TT
CLASS="FUNCTION"
>FcConfigGetSysRoot</TT
></CODE
>(const FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3833"
></A
><H2
>Description</H2
><P
>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.
</P
><P
>This function isn't MT-safe. <TT
CLASS="FUNCTION"
>FcConfigReference</TT
> must be called
before using this and then <TT
CLASS="FUNCTION"
>FcConfigDestroy</TT
> when
the return value is no longer referenced.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3839"
></A
><H2
>Since</H2
><P
>version 2.10.92</P
></DIV
><H1
><A
NAME="FCCONFIGSETSYSROOT"
></A
>FcConfigSetSysRoot</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3847"
></A
><H2
>Name</H2
>FcConfigSetSysRoot&nbsp;--&nbsp;Set the system root directory</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3850"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3851"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcConfigSetSysRoot</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>sysroot</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3860"
></A
><H2
>Description</H2
><P
>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()).
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3863"
></A
><H2
>Since</H2
><P
>version 2.10.92</P
></DIV
><H1
><A
NAME="FCCONFIGFILEINFOITERINIT"
></A
>FcConfigFileInfoIterInit</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3871"
></A
><H2
>Name</H2
>FcConfigFileInfoIterInit&nbsp;--&nbsp;Initialize the iterator</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3874"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3875"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcConfigFileInfoIterInit</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcConfigFileInfoIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3884"
></A
><H2
>Description</H2
><P
>Initialize 'iter' with the first iterator in the config file information list.
</P
><P
>The config file information list is stored in numerical order for filenames
i.e. how fontconfig actually read them.
</P
><P
>This function isn't MT-safe. <TT
CLASS="FUNCTION"
>FcConfigReference</TT
> must be called
before using this and then <TT
CLASS="FUNCTION"
>FcConfigDestroy</TT
> when the relevant
values are no longer referenced.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3891"
></A
><H2
>Since</H2
><P
>version 2.12.91</P
></DIV
><H1
><A
NAME="FCCONFIGFILEINFOITERNEXT"
></A
>FcConfigFileInfoIterNext</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3899"
></A
><H2
>Name</H2
>FcConfigFileInfoIterNext&nbsp;--&nbsp;Set the iterator to point to the next list</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3902"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3903"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigFileInfoIterNext</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcConfigFileInfoIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3912"
></A
><H2
>Description</H2
><P
>Set 'iter' to point to the next node in the config file information list.
If there is no next node, FcFalse is returned.
</P
><P
>This function isn't MT-safe. <TT
CLASS="FUNCTION"
>FcConfigReference</TT
> must be called
before using <TT
CLASS="FUNCTION"
>FcConfigFileInfoIterInit</TT
> and then
<TT
CLASS="FUNCTION"
>FcConfigDestroy</TT
> when the relevant values are no longer referenced.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3919"
></A
><H2
>Since</H2
><P
>version 2.12.91</P
></DIV
><H1
><A
NAME="FCCONFIGFILEINFOITERGET"
></A
>FcConfigFileInfoIterGet</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3927"
></A
><H2
>Name</H2
>FcConfigFileInfoIterGet&nbsp;--&nbsp;Obtain the configuration file information</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3930"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3931"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigFileInfoIterGet</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcConfigFileInfoIter *<TT
CLASS="PARAMETER"
><I
>iter</I
></TT
>, FcChar8 **<TT
CLASS="PARAMETER"
><I
>name</I
></TT
>, FcChar8 **<TT
CLASS="PARAMETER"
><I
>description</I
></TT
>, FcBool *<TT
CLASS="PARAMETER"
><I
>enabled</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3946"
></A
><H2
>Description</H2
><P
>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.
</P
><P
>This function isn't MT-safe. <TT
CLASS="FUNCTION"
>FcConfigReference</TT
> must be called
before using <TT
CLASS="FUNCTION"
>FcConfigFileInfoIterInit</TT
> and then
<TT
CLASS="FUNCTION"
>FcConfigDestroy</TT
> when the relevant values are no longer referenced.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3953"
></A
><H2
>Since</H2
><P
>version 2.12.91</P
></DIV
><H1
><A
NAME="FCCONFIGACCEPTFONT"
></A
>FcConfigAcceptFont</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3961"
></A
><H2
>Name</H2
>FcConfigAcceptFont&nbsp;--&nbsp;Test whether the given pattern matches deny list</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3964"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3965"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcConfigAcceptFont</TT
></CODE
>(FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcPattern *<TT
CLASS="PARAMETER"
><I
>pat</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3974"
></A
><H2
>Description</H2
><P
>fontconfig has the deny list which is built against &#60;rejectfont&#62; directive
in configuration file. This function tries to match 'pat' with them and
return FcFalse if 'pat' is rejected, otherwise FcTrue.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN3977"
></A
><H2
>Since</H2
><P
>version 2.15.1</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN3980"
>FcObjectType</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCNAMEREGISTEROBJECTTYPES"
>FcNameRegisterObjectTypes</A
>&nbsp;--&nbsp;Register object types</DT
><DT
><A
HREF="#FCNAMEUNREGISTEROBJECTTYPES"
>FcNameUnregisterObjectTypes</A
>&nbsp;--&nbsp;Unregister object types</DT
><DT
><A
HREF="#FCNAMEGETOBJECTTYPE"
>FcNameGetObjectType</A
>&nbsp;--&nbsp;Lookup an object type</DT
></DL
></DIV
><P
>Provides for application-specified font name object types so that new
pattern elements can be generated from font names.
</P
><H1
><A
NAME="FCNAMEREGISTEROBJECTTYPES"
></A
>FcNameRegisterObjectTypes</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN3988"
></A
><H2
>Name</H2
>FcNameRegisterObjectTypes&nbsp;--&nbsp;Register object types</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN3991"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN3992"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcNameRegisterObjectTypes</TT
></CODE
>(const FcObjectType *<TT
CLASS="PARAMETER"
><I
>types</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>ntype</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4001"
></A
><H2
>Description</H2
><P
>Deprecated. Does nothing. Returns FcFalse.
</P
></DIV
><H1
><A
NAME="FCNAMEUNREGISTEROBJECTTYPES"
></A
>FcNameUnregisterObjectTypes</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4009"
></A
><H2
>Name</H2
>FcNameUnregisterObjectTypes&nbsp;--&nbsp;Unregister object types</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4012"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4013"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcNameUnregisterObjectTypes</TT
></CODE
>(const FcObjectType *<TT
CLASS="PARAMETER"
><I
>types</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>ntype</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4022"
></A
><H2
>Description</H2
><P
>Deprecated. Does nothing. Returns FcFalse.
</P
></DIV
><H1
><A
NAME="FCNAMEGETOBJECTTYPE"
></A
>FcNameGetObjectType</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4030"
></A
><H2
>Name</H2
>FcNameGetObjectType&nbsp;--&nbsp;Lookup an object type</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4033"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4034"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcObjectType * <TT
CLASS="FUNCTION"
>FcNameGetObjectType</TT
></CODE
>(const char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4041"
></A
><H2
>Description</H2
><P
>Return the object type for the pattern element named <TT
CLASS="PARAMETER"
><I
>object</I
></TT
>.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4045"
>FcConstant</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCNAMEREGISTERCONSTANTS"
>FcNameRegisterConstants</A
>&nbsp;--&nbsp;Register symbolic constants</DT
><DT
><A
HREF="#FCNAMEUNREGISTERCONSTANTS"
>FcNameUnregisterConstants</A
>&nbsp;--&nbsp;Unregister symbolic constants</DT
><DT
><A
HREF="#FCNAMEGETCONSTANT"
>FcNameGetConstant</A
>&nbsp;--&nbsp;Lookup symbolic constant</DT
><DT
><A
HREF="#FCNAMEGETCONSTANTFOR"
>FcNameGetConstantFor</A
>&nbsp;--&nbsp;Lookup symbolic constant For object</DT
><DT
><A
HREF="#FCNAMECONSTANT"
>FcNameConstant</A
>&nbsp;--&nbsp;Get the value for a symbolic constant</DT
></DL
></DIV
><P
>Provides for application-specified symbolic constants for font names.
</P
><H1
><A
NAME="FCNAMEREGISTERCONSTANTS"
></A
>FcNameRegisterConstants</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4053"
></A
><H2
>Name</H2
>FcNameRegisterConstants&nbsp;--&nbsp;Register symbolic constants</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4056"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4057"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcNameRegisterConstants</TT
></CODE
>(const FcConstant *<TT
CLASS="PARAMETER"
><I
>consts</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>nconsts</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4066"
></A
><H2
>Description</H2
><P
>Deprecated. Does nothing. Returns FcFalse.
</P
></DIV
><H1
><A
NAME="FCNAMEUNREGISTERCONSTANTS"
></A
>FcNameUnregisterConstants</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4074"
></A
><H2
>Name</H2
>FcNameUnregisterConstants&nbsp;--&nbsp;Unregister symbolic constants</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4077"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4078"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcNameUnregisterConstants</TT
></CODE
>(const FcConstant *<TT
CLASS="PARAMETER"
><I
>consts</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>nconsts</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4087"
></A
><H2
>Description</H2
><P
>Deprecated. Does nothing. Returns FcFalse.
</P
></DIV
><H1
><A
NAME="FCNAMEGETCONSTANT"
></A
>FcNameGetConstant</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4095"
></A
><H2
>Name</H2
>FcNameGetConstant&nbsp;--&nbsp;Lookup symbolic constant</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4098"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4099"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcConstant * <TT
CLASS="FUNCTION"
>FcNameGetConstant</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>string</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4106"
></A
><H2
>Description</H2
><P
>Return the FcConstant structure related to symbolic constant <TT
CLASS="PARAMETER"
><I
>string</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCNAMEGETCONSTANTFOR"
></A
>FcNameGetConstantFor</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4115"
></A
><H2
>Name</H2
>FcNameGetConstantFor&nbsp;--&nbsp;Lookup symbolic constant For object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4118"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4119"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcConstant * <TT
CLASS="FUNCTION"
>FcNameGetConstantFor</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>string</I
></TT
>, char *<TT
CLASS="PARAMETER"
><I
>object</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4128"
></A
><H2
>Description</H2
><P
>Return the FcConstant structure related to symbolic constant <TT
CLASS="PARAMETER"
><I
>string</I
></TT
>
for <TT
CLASS="PARAMETER"
><I
>object</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCNAMECONSTANT"
></A
>FcNameConstant</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4138"
></A
><H2
>Name</H2
>FcNameConstant&nbsp;--&nbsp;Get the value for a symbolic constant</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4141"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4142"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcNameConstant</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>string</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>result</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4151"
></A
><H2
>Description</H2
><P
>Returns whether a symbolic constant with name <TT
CLASS="PARAMETER"
><I
>string</I
></TT
> is registered,
placing the value of the constant in <TT
CLASS="PARAMETER"
><I
>result</I
></TT
> if present.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4156"
>FcWeight</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCWEIGHTFROMOPENTYPEDOUBLE"
>FcWeightFromOpenTypeDouble</A
>&nbsp;--&nbsp;Convert from OpenType weight values to fontconfig ones</DT
><DT
><A
HREF="#FCWEIGHTTOOPENTYPEDOUBLE"
>FcWeightToOpenTypeDouble</A
>&nbsp;--&nbsp;Convert from fontconfig weight values to OpenType ones</DT
><DT
><A
HREF="#FCWEIGHTFROMOPENTYPE"
>FcWeightFromOpenType</A
>&nbsp;--&nbsp;Convert from OpenType weight values to fontconfig ones</DT
><DT
><A
HREF="#FCWEIGHTTOOPENTYPE"
>FcWeightToOpenType</A
>&nbsp;--&nbsp;Convert from fontconfig weight values to OpenType ones</DT
></DL
></DIV
><P
>Maps weights to and from OpenType weights.
</P
><H1
><A
NAME="FCWEIGHTFROMOPENTYPEDOUBLE"
></A
>FcWeightFromOpenTypeDouble</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4164"
></A
><H2
>Name</H2
>FcWeightFromOpenTypeDouble&nbsp;--&nbsp;Convert from OpenType weight values to fontconfig ones</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4167"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4168"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>double <TT
CLASS="FUNCTION"
>FcWeightFromOpenTypeDouble</TT
></CODE
>(double <TT
CLASS="PARAMETER"
><I
>ot_weight</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4175"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcWeightFromOpenTypeDouble</TT
> 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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4179"
></A
><H2
>Since</H2
><P
>version 2.12.92</P
></DIV
><H1
><A
NAME="FCWEIGHTTOOPENTYPEDOUBLE"
></A
>FcWeightToOpenTypeDouble</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4187"
></A
><H2
>Name</H2
>FcWeightToOpenTypeDouble&nbsp;--&nbsp;Convert from fontconfig weight values to OpenType ones</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4190"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4191"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>double <TT
CLASS="FUNCTION"
>FcWeightToOpenTypeDouble</TT
></CODE
>(double <TT
CLASS="PARAMETER"
><I
>ot_weight</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4198"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcWeightToOpenTypeDouble</TT
> is the inverse of
<TT
CLASS="FUNCTION"
>FcWeightFromOpenType</TT
>. 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.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4203"
></A
><H2
>Since</H2
><P
>version 2.12.92</P
></DIV
><H1
><A
NAME="FCWEIGHTFROMOPENTYPE"
></A
>FcWeightFromOpenType</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4211"
></A
><H2
>Name</H2
>FcWeightFromOpenType&nbsp;--&nbsp;Convert from OpenType weight values to fontconfig ones</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4214"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4215"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcWeightFromOpenType</TT
></CODE
>(int <TT
CLASS="PARAMETER"
><I
>ot_weight</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4222"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcWeightFromOpenType</TT
> is like
<TT
CLASS="FUNCTION"
>FcWeightFromOpenTypeDouble</TT
> but with integer arguments.
Use the other function instead.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4227"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
><H1
><A
NAME="FCWEIGHTTOOPENTYPE"
></A
>FcWeightToOpenType</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4235"
></A
><H2
>Name</H2
>FcWeightToOpenType&nbsp;--&nbsp;Convert from fontconfig weight values to OpenType ones</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4238"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4239"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcWeightToOpenType</TT
></CODE
>(int <TT
CLASS="PARAMETER"
><I
>ot_weight</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4246"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcWeightToOpenType</TT
> is like
<TT
CLASS="FUNCTION"
>FcWeightToOpenTypeDouble</TT
> but with integer arguments.
Use the other function instead.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4251"
></A
><H2
>Since</H2
><P
>version 2.11.91</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4254"
>FcBlanks</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCBLANKSCREATE"
>FcBlanksCreate</A
>&nbsp;--&nbsp;Create an FcBlanks</DT
><DT
><A
HREF="#FCBLANKSDESTROY"
>FcBlanksDestroy</A
>&nbsp;--&nbsp;Destroy and FcBlanks</DT
><DT
><A
HREF="#FCBLANKSADD"
>FcBlanksAdd</A
>&nbsp;--&nbsp;Add a character to an FcBlanks</DT
><DT
><A
HREF="#FCBLANKSISMEMBER"
>FcBlanksIsMember</A
>&nbsp;--&nbsp;Query membership in an FcBlanks</DT
></DL
></DIV
><P
>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.
</P
><P
> 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.
</P
><H1
><A
NAME="FCBLANKSCREATE"
></A
>FcBlanksCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4263"
></A
><H2
>Name</H2
>FcBlanksCreate&nbsp;--&nbsp;Create an FcBlanks</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4266"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4267"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBlanks * <TT
CLASS="FUNCTION"
>FcBlanksCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4274"
></A
><H2
>Description</H2
><P
>FcBlanks is deprecated.
This function always returns NULL.
</P
></DIV
><H1
><A
NAME="FCBLANKSDESTROY"
></A
>FcBlanksDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4282"
></A
><H2
>Name</H2
>FcBlanksDestroy&nbsp;--&nbsp;Destroy and FcBlanks</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4285"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4286"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcBlanksDestroy</TT
></CODE
>(FcBlanks *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4293"
></A
><H2
>Description</H2
><P
>FcBlanks is deprecated.
This function does nothing.
</P
></DIV
><H1
><A
NAME="FCBLANKSADD"
></A
>FcBlanksAdd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4301"
></A
><H2
>Name</H2
>FcBlanksAdd&nbsp;--&nbsp;Add a character to an FcBlanks</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4304"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4305"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcBlanksAdd</TT
></CODE
>(FcBlanks *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4314"
></A
><H2
>Description</H2
><P
>FcBlanks is deprecated.
This function always returns FALSE.
</P
></DIV
><H1
><A
NAME="FCBLANKSISMEMBER"
></A
>FcBlanksIsMember</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4322"
></A
><H2
>Name</H2
>FcBlanksIsMember&nbsp;--&nbsp;Query membership in an FcBlanks</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4325"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4326"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcBlanksIsMember</TT
></CODE
>(FcBlanks *<TT
CLASS="PARAMETER"
><I
>b</I
></TT
>, FcChar32 <TT
CLASS="PARAMETER"
><I
>ucs4</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4335"
></A
><H2
>Description</H2
><P
>FcBlanks is deprecated.
This function always returns FALSE.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4338"
>FcAtomic</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCATOMICCREATE"
>FcAtomicCreate</A
>&nbsp;--&nbsp;create an FcAtomic object</DT
><DT
><A
HREF="#FCATOMICLOCK"
>FcAtomicLock</A
>&nbsp;--&nbsp;lock a file</DT
><DT
><A
HREF="#FCATOMICNEWFILE"
>FcAtomicNewFile</A
>&nbsp;--&nbsp;return new temporary file name</DT
><DT
><A
HREF="#FCATOMICORIGFILE"
>FcAtomicOrigFile</A
>&nbsp;--&nbsp;return original file name</DT
><DT
><A
HREF="#FCATOMICREPLACEORIG"
>FcAtomicReplaceOrig</A
>&nbsp;--&nbsp;replace original with new</DT
><DT
><A
HREF="#FCATOMICDELETENEW"
>FcAtomicDeleteNew</A
>&nbsp;--&nbsp;delete new file</DT
><DT
><A
HREF="#FCATOMICUNLOCK"
>FcAtomicUnlock</A
>&nbsp;--&nbsp;unlock a file</DT
><DT
><A
HREF="#FCATOMICDESTROY"
>FcAtomicDestroy</A
>&nbsp;--&nbsp;destroy an FcAtomic object</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCATOMICCREATE"
></A
>FcAtomicCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4346"
></A
><H2
>Name</H2
>FcAtomicCreate&nbsp;--&nbsp;create an FcAtomic object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4349"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4350"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcAtomic * <TT
CLASS="FUNCTION"
>FcAtomicCreate</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4357"
></A
><H2
>Description</H2
><P
>Creates a data structure containing data needed to control access to <TT
CLASS="PARAMETER"
><I
>file</I
></TT
>.
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.
</P
></DIV
><H1
><A
NAME="FCATOMICLOCK"
></A
>FcAtomicLock</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4366"
></A
><H2
>Name</H2
>FcAtomicLock&nbsp;--&nbsp;lock a file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4369"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4370"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcAtomicLock</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4377"
></A
><H2
>Description</H2
><P
>Attempts to lock the file referenced by <TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>.
Returns FcFalse if the file is already locked, else returns FcTrue and
leaves the file locked.
</P
></DIV
><H1
><A
NAME="FCATOMICNEWFILE"
></A
>FcAtomicNewFile</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4386"
></A
><H2
>Name</H2
>FcAtomicNewFile&nbsp;--&nbsp;return new temporary file name</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4389"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4390"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcAtomicNewFile</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4397"
></A
><H2
>Description</H2
><P
>Returns the filename for writing a new version of the file referenced
by <TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCATOMICORIGFILE"
></A
>FcAtomicOrigFile</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4406"
></A
><H2
>Name</H2
>FcAtomicOrigFile&nbsp;--&nbsp;return original file name</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4409"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4410"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcAtomicOrigFile</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4417"
></A
><H2
>Description</H2
><P
>Returns the file referenced by <TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCATOMICREPLACEORIG"
></A
>FcAtomicReplaceOrig</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4426"
></A
><H2
>Name</H2
>FcAtomicReplaceOrig&nbsp;--&nbsp;replace original with new</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4429"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4430"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcAtomicReplaceOrig</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4437"
></A
><H2
>Description</H2
><P
>Replaces the original file referenced by <TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
> with
the new file. Returns FcFalse if the file cannot be replaced due to
permission issues in the filesystem. Otherwise returns FcTrue.
</P
></DIV
><H1
><A
NAME="FCATOMICDELETENEW"
></A
>FcAtomicDeleteNew</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4446"
></A
><H2
>Name</H2
>FcAtomicDeleteNew&nbsp;--&nbsp;delete new file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4449"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4450"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcAtomicDeleteNew</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4457"
></A
><H2
>Description</H2
><P
>Deletes the new file. Used in error recovery to back out changes.
</P
></DIV
><H1
><A
NAME="FCATOMICUNLOCK"
></A
>FcAtomicUnlock</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4465"
></A
><H2
>Name</H2
>FcAtomicUnlock&nbsp;--&nbsp;unlock a file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4468"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4469"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcAtomicUnlock</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4476"
></A
><H2
>Description</H2
><P
>Unlocks the file.
</P
></DIV
><H1
><A
NAME="FCATOMICDESTROY"
></A
>FcAtomicDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4484"
></A
><H2
>Name</H2
>FcAtomicDestroy&nbsp;--&nbsp;destroy an FcAtomic object</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4487"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4488"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcAtomicDestroy</TT
></CODE
>(FcAtomic *<TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4495"
></A
><H2
>Description</H2
><P
>Destroys <TT
CLASS="PARAMETER"
><I
>atomic</I
></TT
>.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4499"
>File and Directory routines</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCFILESCAN"
>FcFileScan</A
>&nbsp;--&nbsp;scan a font file</DT
><DT
><A
HREF="#FCFILEISDIR"
>FcFileIsDir</A
>&nbsp;--&nbsp;check whether a file is a directory</DT
><DT
><A
HREF="#FCDIRSCAN"
>FcDirScan</A
>&nbsp;--&nbsp;scan a font directory without caching it</DT
><DT
><A
HREF="#FCDIRSAVE"
>FcDirSave</A
>&nbsp;--&nbsp;DEPRECATED: formerly used to save a directory cache</DT
><DT
><A
HREF="#FCDIRCACHEUNLINK"
>FcDirCacheUnlink</A
>&nbsp;--&nbsp;Remove all caches related to <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
></DT
><DT
><A
HREF="#FCDIRCACHEVALID"
>FcDirCacheValid</A
>&nbsp;--&nbsp;check directory cache</DT
><DT
><A
HREF="#FCDIRCACHELOAD"
>FcDirCacheLoad</A
>&nbsp;--&nbsp;load a directory cache</DT
><DT
><A
HREF="#FCDIRCACHERESCAN"
>FcDirCacheRescan</A
>&nbsp;--&nbsp;Re-scan a directory cache</DT
><DT
><A
HREF="#FCDIRCACHEREAD"
>FcDirCacheRead</A
>&nbsp;--&nbsp;read or construct a directory cache</DT
><DT
><A
HREF="#FCDIRCACHELOADFILE"
>FcDirCacheLoadFile</A
>&nbsp;--&nbsp;load a cache file</DT
><DT
><A
HREF="#FCDIRCACHEUNLOAD"
>FcDirCacheUnload</A
>&nbsp;--&nbsp;unload a cache file</DT
></DL
></DIV
><P
>These routines work with font files and directories, including font
directory cache files.
</P
><H1
><A
NAME="FCFILESCAN"
></A
>FcFileScan</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4507"
></A
><H2
>Name</H2
>FcFileScan&nbsp;--&nbsp;scan a font file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4510"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4511"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcFileScan</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, FcStrSet *<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>, FcFileCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>force</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4528"
></A
><H2
>Description</H2
><P
>Scans a single file and adds all fonts found to <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
If <TT
CLASS="PARAMETER"
><I
>force</I
></TT
> is FcTrue, then the file is scanned even if
associated information is found in <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>. If
<TT
CLASS="PARAMETER"
><I
>file</I
></TT
> is a directory, it is added to
<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>. 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.
</P
></DIV
><H1
><A
NAME="FCFILEISDIR"
></A
>FcFileIsDir</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4541"
></A
><H2
>Name</H2
>FcFileIsDir&nbsp;--&nbsp;check whether a file is a directory</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4544"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4545"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcFileIsDir</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4552"
></A
><H2
>Description</H2
><P
>Returns FcTrue if <TT
CLASS="PARAMETER"
><I
>file</I
></TT
> is a directory, otherwise
returns FcFalse.
</P
></DIV
><H1
><A
NAME="FCDIRSCAN"
></A
>FcDirScan</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4561"
></A
><H2
>Name</H2
>FcDirScan&nbsp;--&nbsp;scan a font directory without caching it</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4564"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4565"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirScan</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, FcStrSet *<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>, FcFileCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>, FcBlanks *<TT
CLASS="PARAMETER"
><I
>blanks</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>force</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4582"
></A
><H2
>Description</H2
><P
>If <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
> is not zero or if <TT
CLASS="PARAMETER"
><I
>force</I
></TT
>
is FcFalse, this function currently returns FcFalse. Otherwise, it scans an
entire directory and adds all fonts found to <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
Any subdirectories found are added to <TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>. Calling
this function does not create any cache files. Use FcDirCacheRead() if
caching is desired.
</P
></DIV
><H1
><A
NAME="FCDIRSAVE"
></A
>FcDirSave</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4594"
></A
><H2
>Name</H2
>FcDirSave&nbsp;--&nbsp;DEPRECATED: formerly used to save a directory cache</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4597"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4598"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirSave</TT
></CODE
>(FcFontSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, FcStrSet *<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4609"
></A
><H2
>Description</H2
><P
>This function now does nothing aside from returning FcFalse. It used to creates the
per-directory cache file for <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
> and populates it
with the fonts in <TT
CLASS="PARAMETER"
><I
>set</I
></TT
> and subdirectories in
<TT
CLASS="PARAMETER"
><I
>dirs</I
></TT
>. All of this functionality is now automatically
managed by FcDirCacheLoad and FcDirCacheRead.
</P
></DIV
><H1
><A
NAME="FCDIRCACHEUNLINK"
></A
>FcDirCacheUnlink</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4620"
></A
><H2
>Name</H2
>FcDirCacheUnlink&nbsp;--&nbsp;Remove all caches related to <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4624"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4625"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirCacheUnlink</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4634"
></A
><H2
>Description</H2
><P
>Scans the cache directories in <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, removing any
instances of the cache file for <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>. Returns FcFalse
when some internal error occurs (out of memory, etc). Errors actually
unlinking any files are ignored.
</P
></DIV
><H1
><A
NAME="FCDIRCACHEVALID"
></A
>FcDirCacheValid</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4644"
></A
><H2
>Name</H2
>FcDirCacheValid&nbsp;--&nbsp;check directory cache</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4647"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4648"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirCacheValid</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4655"
></A
><H2
>Description</H2
><P
>Returns FcTrue if <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
> has an associated valid cache
file, else returns FcFalse
</P
></DIV
><H1
><A
NAME="FCDIRCACHELOAD"
></A
>FcDirCacheLoad</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4664"
></A
><H2
>Name</H2
>FcDirCacheLoad&nbsp;--&nbsp;load a directory cache</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4667"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4668"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCache * <TT
CLASS="FUNCTION"
>FcDirCacheLoad</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>, FcChar8 **<TT
CLASS="PARAMETER"
><I
>cache_file</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4679"
></A
><H2
>Description</H2
><P
>Loads the cache related to <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>. If no cache file
exists, returns NULL. The name of the cache file is returned in
<TT
CLASS="PARAMETER"
><I
>cache_file</I
></TT
>, unless that is NULL. See also
FcDirCacheRead.
</P
></DIV
><H1
><A
NAME="FCDIRCACHERESCAN"
></A
>FcDirCacheRescan</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4689"
></A
><H2
>Name</H2
>FcDirCacheRescan&nbsp;--&nbsp;Re-scan a directory cache</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4692"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4693"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCache * <TT
CLASS="FUNCTION"
>FcDirCacheRescan</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4702"
></A
><H2
>Description</H2
><P
>Re-scan directories only at <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
> and update the cache.
returns NULL if failed.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4706"
></A
><H2
>Since</H2
><P
>version 2.11.1</P
></DIV
><H1
><A
NAME="FCDIRCACHEREAD"
></A
>FcDirCacheRead</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4714"
></A
><H2
>Name</H2
>FcDirCacheRead&nbsp;--&nbsp;read or construct a directory cache</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4717"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4718"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCache * <TT
CLASS="FUNCTION"
>FcDirCacheRead</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>force</I
></TT
>, FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4729"
></A
><H2
>Description</H2
><P
>This returns a cache for <TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>. If
<TT
CLASS="PARAMETER"
><I
>force</I
></TT
> 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.
</P
></DIV
><H1
><A
NAME="FCDIRCACHELOADFILE"
></A
>FcDirCacheLoadFile</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4739"
></A
><H2
>Name</H2
>FcDirCacheLoadFile&nbsp;--&nbsp;load a cache file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4742"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4743"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcCache * <TT
CLASS="FUNCTION"
>FcDirCacheLoadFile</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>cache_file</I
></TT
>, struct stat *<TT
CLASS="PARAMETER"
><I
>file_stat</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4752"
></A
><H2
>Description</H2
><P
>This function loads a directory cache from
<TT
CLASS="PARAMETER"
><I
>cache_file</I
></TT
>. If <TT
CLASS="PARAMETER"
><I
>file_stat</I
></TT
> is
non-NULL, it will be filled with the results of stat(2) on the cache file.
</P
></DIV
><H1
><A
NAME="FCDIRCACHEUNLOAD"
></A
>FcDirCacheUnload</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4762"
></A
><H2
>Name</H2
>FcDirCacheUnload&nbsp;--&nbsp;unload a cache file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4765"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4766"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcDirCacheUnload</TT
></CODE
>(FcCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4773"
></A
><H2
>Description</H2
><P
>This function dereferences <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>. When no other
references to it remain, all memory associated with the cache will be freed.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4777"
>FcCache routines</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCCACHEDIR"
>FcCacheDir</A
>&nbsp;--&nbsp;Return directory of <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
></DT
><DT
><A
HREF="#FCCACHECOPYSET"
>FcCacheCopySet</A
>&nbsp;--&nbsp;Returns a copy of the fontset from <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
></DT
><DT
><A
HREF="#FCCACHESUBDIR"
>FcCacheSubdir</A
>&nbsp;--&nbsp;Return the <TT
CLASS="PARAMETER"
><I
>i</I
></TT
>'th subdirectory.</DT
><DT
><A
HREF="#FCCACHENUMSUBDIR"
>FcCacheNumSubdir</A
>&nbsp;--&nbsp;Return the number of subdirectories in <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>.</DT
><DT
><A
HREF="#FCCACHENUMFONT"
>FcCacheNumFont</A
>&nbsp;--&nbsp;Returns the number of fonts in <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>.</DT
><DT
><A
HREF="#FCDIRCACHECLEAN"
>FcDirCacheClean</A
>&nbsp;--&nbsp;Clean up a cache directory</DT
><DT
><A
HREF="#FCCACHECREATETAGFILE"
>FcCacheCreateTagFile</A
>&nbsp;--&nbsp;Create CACHEDIR.TAG at cache directory.</DT
><DT
><A
HREF="#FCDIRCACHECREATEUUID"
>FcDirCacheCreateUUID</A
>&nbsp;--&nbsp;Create .uuid file at a directory</DT
><DT
><A
HREF="#FCDIRCACHEDELETEUUID"
>FcDirCacheDeleteUUID</A
>&nbsp;--&nbsp;Delete .uuid file</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCCACHEDIR"
></A
>FcCacheDir</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4785"
></A
><H2
>Name</H2
>FcCacheDir&nbsp;--&nbsp;Return directory of <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4789"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4790"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcChar8 * <TT
CLASS="FUNCTION"
>FcCacheDir</TT
></CODE
>(const FcCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4797"
></A
><H2
>Description</H2
><P
>This function returns the directory from which the cache was constructed.
</P
></DIV
><H1
><A
NAME="FCCACHECOPYSET"
></A
>FcCacheCopySet</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4805"
></A
><H2
>Name</H2
>FcCacheCopySet&nbsp;--&nbsp;Returns a copy of the fontset from <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
></DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4809"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4810"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcFontSet * <TT
CLASS="FUNCTION"
>FcCacheCopySet</TT
></CODE
>(const FcCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4817"
></A
><H2
>Description</H2
><P
>The returned fontset contains each of the font patterns from
<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>. This fontset may be modified, but the patterns
from the cache are read-only.
</P
></DIV
><H1
><A
NAME="FCCACHESUBDIR"
></A
>FcCacheSubdir</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4826"
></A
><H2
>Name</H2
>FcCacheSubdir&nbsp;--&nbsp;Return the <TT
CLASS="PARAMETER"
><I
>i</I
></TT
>'th subdirectory.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4830"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4831"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>const FcChar8 * <TT
CLASS="FUNCTION"
>FcCacheSubdir</TT
></CODE
>(const FcCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>i</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4840"
></A
><H2
>Description</H2
><P
>The set of subdirectories stored in a cache file are indexed by this
function, <TT
CLASS="PARAMETER"
><I
>i</I
></TT
> should range from 0 to
<TT
CLASS="PARAMETER"
><I
>n</I
></TT
>-1, where <TT
CLASS="PARAMETER"
><I
>n</I
></TT
> is the return
value from FcCacheNumSubdir.
</P
></DIV
><H1
><A
NAME="FCCACHENUMSUBDIR"
></A
>FcCacheNumSubdir</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4851"
></A
><H2
>Name</H2
>FcCacheNumSubdir&nbsp;--&nbsp;Return the number of subdirectories in <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4855"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4856"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcCacheNumSubdir</TT
></CODE
>(const FcCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4863"
></A
><H2
>Description</H2
><P
>This returns the total number of subdirectories in the cache.
</P
></DIV
><H1
><A
NAME="FCCACHENUMFONT"
></A
>FcCacheNumFont</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4871"
></A
><H2
>Name</H2
>FcCacheNumFont&nbsp;--&nbsp;Returns the number of fonts in <TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4875"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4876"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcCacheNumFont</TT
></CODE
>(const FcCache *<TT
CLASS="PARAMETER"
><I
>cache</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4883"
></A
><H2
>Description</H2
><P
>This returns the number of fonts which would be included in the return from
FcCacheCopySet.
</P
></DIV
><H1
><A
NAME="FCDIRCACHECLEAN"
></A
>FcDirCacheClean</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4891"
></A
><H2
>Name</H2
>FcDirCacheClean&nbsp;--&nbsp;Clean up a cache directory</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4894"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4895"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirCacheClean</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>cache_dir</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>verbose</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4904"
></A
><H2
>Description</H2
><P
>This tries to clean up the cache directory of <TT
CLASS="PARAMETER"
><I
>cache_dir</I
></TT
>.
This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4908"
></A
><H2
>Since</H2
><P
>version 2.9.91</P
></DIV
><H1
><A
NAME="FCCACHECREATETAGFILE"
></A
>FcCacheCreateTagFile</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4916"
></A
><H2
>Name</H2
>FcCacheCreateTagFile&nbsp;--&nbsp;Create CACHEDIR.TAG at cache directory.</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4919"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4920"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcCacheCreateTagFile</TT
></CODE
>(const FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4927"
></A
><H2
>Description</H2
><P
>This tries to create CACHEDIR.TAG file at the cache directory registered
to <TT
CLASS="PARAMETER"
><I
>config</I
></TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4931"
></A
><H2
>Since</H2
><P
>version 2.9.91</P
></DIV
><H1
><A
NAME="FCDIRCACHECREATEUUID"
></A
>FcDirCacheCreateUUID</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4939"
></A
><H2
>Name</H2
>FcDirCacheCreateUUID&nbsp;--&nbsp;Create .uuid file at a directory</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4942"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4943"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirCacheCreateUUID</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcBool <TT
CLASS="PARAMETER"
><I
>force</I
></TT
>, FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4954"
></A
><H2
>Description</H2
><P
>This function is deprecated. it doesn't take any effects.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4957"
></A
><H2
>Since</H2
><P
>version 2.12.92</P
></DIV
><H1
><A
NAME="FCDIRCACHEDELETEUUID"
></A
>FcDirCacheDeleteUUID</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4965"
></A
><H2
>Name</H2
>FcDirCacheDeleteUUID&nbsp;--&nbsp;Delete .uuid file</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4968"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4969"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcDirCacheDeleteUUID</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>, FcConfig *<TT
CLASS="PARAMETER"
><I
>config</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4978"
></A
><H2
>Description</H2
><P
>This is to delete .uuid file containing an UUID at a font directory of
<TT
CLASS="PARAMETER"
><I
>dir</I
></TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN4982"
></A
><H2
>Since</H2
><P
>version 2.13.1</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN4985"
>FcStrSet and FcStrList</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCSTRSETCREATE"
>FcStrSetCreate</A
>&nbsp;--&nbsp;create a string set</DT
><DT
><A
HREF="#FCSTRSETMEMBER"
>FcStrSetMember</A
>&nbsp;--&nbsp;check set for membership</DT
><DT
><A
HREF="#FCSTRSETEQUAL"
>FcStrSetEqual</A
>&nbsp;--&nbsp;check sets for equality</DT
><DT
><A
HREF="#FCSTRSETADD"
>FcStrSetAdd</A
>&nbsp;--&nbsp;add to a string set</DT
><DT
><A
HREF="#FCSTRSETADDFILENAME"
>FcStrSetAddFilename</A
>&nbsp;--&nbsp;add a filename to a string set</DT
><DT
><A
HREF="#FCSTRSETDEL"
>FcStrSetDel</A
>&nbsp;--&nbsp;delete from a string set</DT
><DT
><A
HREF="#FCSTRSETDESTROY"
>FcStrSetDestroy</A
>&nbsp;--&nbsp;destroy a string set</DT
><DT
><A
HREF="#FCSTRLISTCREATE"
>FcStrListCreate</A
>&nbsp;--&nbsp;create a string iterator</DT
><DT
><A
HREF="#FCSTRLISTFIRST"
>FcStrListFirst</A
>&nbsp;--&nbsp;get first string in iteration</DT
><DT
><A
HREF="#FCSTRLISTNEXT"
>FcStrListNext</A
>&nbsp;--&nbsp;get next string in iteration</DT
><DT
><A
HREF="#FCSTRLISTDONE"
>FcStrListDone</A
>&nbsp;--&nbsp;destroy a string iterator</DT
></DL
></DIV
><P
>A data structure for enumerating strings, used to list directories while
scanning the configuration as directories are added while scanning.
</P
><H1
><A
NAME="FCSTRSETCREATE"
></A
>FcStrSetCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN4993"
></A
><H2
>Name</H2
>FcStrSetCreate&nbsp;--&nbsp;create a string set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN4996"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN4997"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrSet * <TT
CLASS="FUNCTION"
>FcStrSetCreate</TT
></CODE
>(void<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5004"
></A
><H2
>Description</H2
><P
>Create an empty set.
</P
></DIV
><H1
><A
NAME="FCSTRSETMEMBER"
></A
>FcStrSetMember</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5012"
></A
><H2
>Name</H2
>FcStrSetMember&nbsp;--&nbsp;check set for membership</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5015"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5016"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcStrSetMember</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5025"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>s</I
></TT
> is a member of
<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCSTRSETEQUAL"
></A
>FcStrSetEqual</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5035"
></A
><H2
>Name</H2
>FcStrSetEqual&nbsp;--&nbsp;check sets for equality</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5038"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5039"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcStrSetEqual</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set_a</I
></TT
>, FcStrSet *<TT
CLASS="PARAMETER"
><I
>set_b</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5048"
></A
><H2
>Description</H2
><P
>Returns whether <TT
CLASS="PARAMETER"
><I
>set_a</I
></TT
> contains precisely the same
strings as <TT
CLASS="PARAMETER"
><I
>set_b</I
></TT
>. Ordering of strings within the two
sets is not considered.
</P
></DIV
><H1
><A
NAME="FCSTRSETADD"
></A
>FcStrSetAdd</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5058"
></A
><H2
>Name</H2
>FcStrSetAdd&nbsp;--&nbsp;add to a string set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5061"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5062"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcStrSetAdd</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5071"
></A
><H2
>Description</H2
><P
>Adds a copy of <TT
CLASS="PARAMETER"
><I
>s</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCSTRSETADDFILENAME"
></A
>FcStrSetAddFilename</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5081"
></A
><H2
>Name</H2
>FcStrSetAddFilename&nbsp;--&nbsp;add a filename to a string set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5084"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5085"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcStrSetAddFilename</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5094"
></A
><H2
>Description</H2
><P
>Adds a copy <TT
CLASS="PARAMETER"
><I
>s</I
></TT
> to <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, The copy
is created with FcStrCopyFilename so that leading '~' values are replaced
with the value of the HOME environment variable.
</P
></DIV
><H1
><A
NAME="FCSTRSETDEL"
></A
>FcStrSetDel</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5104"
></A
><H2
>Name</H2
>FcStrSetDel&nbsp;--&nbsp;delete from a string set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5107"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5108"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcStrSetDel</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5117"
></A
><H2
>Description</H2
><P
>Removes <TT
CLASS="PARAMETER"
><I
>s</I
></TT
> from <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>, returning
FcTrue if <TT
CLASS="PARAMETER"
><I
>s</I
></TT
> was a member else FcFalse.
</P
></DIV
><H1
><A
NAME="FCSTRSETDESTROY"
></A
>FcStrSetDestroy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5128"
></A
><H2
>Name</H2
>FcStrSetDestroy&nbsp;--&nbsp;destroy a string set</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5131"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5132"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcStrSetDestroy</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5139"
></A
><H2
>Description</H2
><P
>Destroys <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCSTRLISTCREATE"
></A
>FcStrListCreate</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5148"
></A
><H2
>Name</H2
>FcStrListCreate&nbsp;--&nbsp;create a string iterator</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5151"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5152"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcStrList * <TT
CLASS="FUNCTION"
>FcStrListCreate</TT
></CODE
>(FcStrSet *<TT
CLASS="PARAMETER"
><I
>set</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5159"
></A
><H2
>Description</H2
><P
>Creates an iterator to list the strings in <TT
CLASS="PARAMETER"
><I
>set</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCSTRLISTFIRST"
></A
>FcStrListFirst</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5168"
></A
><H2
>Name</H2
>FcStrListFirst&nbsp;--&nbsp;get first string in iteration</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5171"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5172"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcStrListFirst</TT
></CODE
>(FcStrList *<TT
CLASS="PARAMETER"
><I
>list</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5179"
></A
><H2
>Description</H2
><P
>Returns the first string in <TT
CLASS="PARAMETER"
><I
>list</I
></TT
>.
</P
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5183"
></A
><H2
>Since</H2
><P
>version 2.11.0</P
></DIV
><H1
><A
NAME="FCSTRLISTNEXT"
></A
>FcStrListNext</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5191"
></A
><H2
>Name</H2
>FcStrListNext&nbsp;--&nbsp;get next string in iteration</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5194"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5195"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrListNext</TT
></CODE
>(FcStrList *<TT
CLASS="PARAMETER"
><I
>list</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5202"
></A
><H2
>Description</H2
><P
>Returns the next string in <TT
CLASS="PARAMETER"
><I
>list</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCSTRLISTDONE"
></A
>FcStrListDone</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5211"
></A
><H2
>Name</H2
>FcStrListDone&nbsp;--&nbsp;destroy a string iterator</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5214"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5215"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcStrListDone</TT
></CODE
>(FcStrList *<TT
CLASS="PARAMETER"
><I
>list</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5222"
></A
><H2
>Description</H2
><P
>Destroys the enumerator <TT
CLASS="PARAMETER"
><I
>list</I
></TT
>.
</P
></DIV
></DIV
><DIV
CLASS="SECT2"
><HR><H3
CLASS="SECT2"
><A
NAME="AEN5226"
>String utilities</A
></H3
><DIV
CLASS="TOC"
><DL
><DT
><B
>Table of Contents</B
></DT
><DT
><A
HREF="#FCUTF8TOUCS4"
>FcUtf8ToUcs4</A
>&nbsp;--&nbsp;convert UTF-8 to UCS4</DT
><DT
><A
HREF="#FCUCS4TOUTF8"
>FcUcs4ToUtf8</A
>&nbsp;--&nbsp;convert UCS4 to UTF-8</DT
><DT
><A
HREF="#FCUTF8LEN"
>FcUtf8Len</A
>&nbsp;--&nbsp;count UTF-8 encoded chars</DT
><DT
><A
HREF="#FCUTF16TOUCS4"
>FcUtf16ToUcs4</A
>&nbsp;--&nbsp;convert UTF-16 to UCS4</DT
><DT
><A
HREF="#FCUTF16LEN"
>FcUtf16Len</A
>&nbsp;--&nbsp;count UTF-16 encoded chars</DT
><DT
><A
HREF="#FCISLOWER"
>FcIsLower</A
>&nbsp;--&nbsp;check for lower case ASCII character</DT
><DT
><A
HREF="#FCISUPPER"
>FcIsUpper</A
>&nbsp;--&nbsp;check for upper case ASCII character</DT
><DT
><A
HREF="#FCTOLOWER"
>FcToLower</A
>&nbsp;--&nbsp;convert upper case ASCII to lower case</DT
><DT
><A
HREF="#FCSTRCOPY"
>FcStrCopy</A
>&nbsp;--&nbsp;duplicate a string</DT
><DT
><A
HREF="#FCSTRDOWNCASE"
>FcStrDowncase</A
>&nbsp;--&nbsp;create a lower case translation of a string</DT
><DT
><A
HREF="#FCSTRCOPYFILENAME"
>FcStrCopyFilename</A
>&nbsp;--&nbsp;create a complete path from a filename</DT
><DT
><A
HREF="#FCSTRCMP"
>FcStrCmp</A
>&nbsp;--&nbsp;compare UTF-8 strings</DT
><DT
><A
HREF="#FCSTRCMPIGNORECASE"
>FcStrCmpIgnoreCase</A
>&nbsp;--&nbsp;compare UTF-8 strings ignoring case</DT
><DT
><A
HREF="#FCSTRSTR"
>FcStrStr</A
>&nbsp;--&nbsp;locate UTF-8 substring</DT
><DT
><A
HREF="#FCSTRSTRIGNORECASE"
>FcStrStrIgnoreCase</A
>&nbsp;--&nbsp;locate UTF-8 substring ignoring case</DT
><DT
><A
HREF="#FCSTRPLUS"
>FcStrPlus</A
>&nbsp;--&nbsp;concatenate two strings</DT
><DT
><A
HREF="#FCSTRFREE"
>FcStrFree</A
>&nbsp;--&nbsp;free a string</DT
><DT
><A
HREF="#FCSTRBUILDFILENAME"
>FcStrBuildFilename</A
>&nbsp;--&nbsp;Concatenate strings as a file path</DT
><DT
><A
HREF="#FCSTRDIRNAME"
>FcStrDirname</A
>&nbsp;--&nbsp;directory part of filename</DT
><DT
><A
HREF="#FCSTRBASENAME"
>FcStrBasename</A
>&nbsp;--&nbsp;last component of filename</DT
></DL
></DIV
><P
>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.
</P
><H1
><A
NAME="FCUTF8TOUCS4"
></A
>FcUtf8ToUcs4</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5234"
></A
><H2
>Name</H2
>FcUtf8ToUcs4&nbsp;--&nbsp;convert UTF-8 to UCS4</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5237"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5238"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcUtf8ToUcs4</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>, FcChar32 *<TT
CLASS="PARAMETER"
><I
>dst</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>len</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5249"
></A
><H2
>Description</H2
><P
>Converts the next Unicode char from <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> into
<TT
CLASS="PARAMETER"
><I
>dst</I
></TT
> and returns the number of bytes containing the
char. <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> must be at least
<TT
CLASS="PARAMETER"
><I
>len</I
></TT
> bytes long.
</P
></DIV
><H1
><A
NAME="FCUCS4TOUTF8"
></A
>FcUcs4ToUtf8</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5261"
></A
><H2
>Name</H2
>FcUcs4ToUtf8&nbsp;--&nbsp;convert UCS4 to UTF-8</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5264"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5265"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcUcs4ToUtf8</TT
></CODE
>(FcChar32 <TT
CLASS="PARAMETER"
><I
>src</I
></TT
>, FcChar8 <TT
CLASS="PARAMETER"
><I
>dst[FC_UTF8_MAX_LEN]</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5274"
></A
><H2
>Description</H2
><P
>Converts the Unicode char from <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> into
<TT
CLASS="PARAMETER"
><I
>dst</I
></TT
> and returns the number of bytes needed to encode
the char.
</P
></DIV
><H1
><A
NAME="FCUTF8LEN"
></A
>FcUtf8Len</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5284"
></A
><H2
>Name</H2
>FcUtf8Len&nbsp;--&nbsp;count UTF-8 encoded chars</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5287"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5288"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcUtf8Len</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>len</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>nchar</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>wchar</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5301"
></A
><H2
>Description</H2
><P
>Counts the number of Unicode chars in <TT
CLASS="PARAMETER"
><I
>len</I
></TT
> bytes of
<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>. Places that count in
<TT
CLASS="PARAMETER"
><I
>nchar</I
></TT
>. <TT
CLASS="PARAMETER"
><I
>wchar</I
></TT
> contains 1, 2 or
4 depending on the number of bytes needed to hold the largest Unicode char
counted. The return value indicates whether <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> is a
well-formed UTF8 string.
</P
></DIV
><H1
><A
NAME="FCUTF16TOUCS4"
></A
>FcUtf16ToUcs4</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5314"
></A
><H2
>Name</H2
>FcUtf16ToUcs4&nbsp;--&nbsp;convert UTF-16 to UCS4</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5317"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5318"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcUtf16ToUcs4</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>, FcEndian <TT
CLASS="PARAMETER"
><I
>endian</I
></TT
>, FcChar32 *<TT
CLASS="PARAMETER"
><I
>dst</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>len</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5331"
></A
><H2
>Description</H2
><P
>Converts the next Unicode char from <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> into
<TT
CLASS="PARAMETER"
><I
>dst</I
></TT
> and returns the number of bytes containing the
char. <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> must be at least <TT
CLASS="PARAMETER"
><I
>len</I
></TT
>
bytes long. Bytes of <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> are combined into 16-bit
units according to <TT
CLASS="PARAMETER"
><I
>endian</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCUTF16LEN"
></A
>FcUtf16Len</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5345"
></A
><H2
>Name</H2
>FcUtf16Len&nbsp;--&nbsp;count UTF-16 encoded chars</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5348"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5349"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcUtf16Len</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>, FcEndian <TT
CLASS="PARAMETER"
><I
>endian</I
></TT
>, int <TT
CLASS="PARAMETER"
><I
>len</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>nchar</I
></TT
>, int *<TT
CLASS="PARAMETER"
><I
>wchar</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5364"
></A
><H2
>Description</H2
><P
>Counts the number of Unicode chars in <TT
CLASS="PARAMETER"
><I
>len</I
></TT
> bytes of
<TT
CLASS="PARAMETER"
><I
>src</I
></TT
>. Bytes of <TT
CLASS="PARAMETER"
><I
>src</I
></TT
> are
combined into 16-bit units according to <TT
CLASS="PARAMETER"
><I
>endian</I
></TT
>.
Places that count in <TT
CLASS="PARAMETER"
><I
>nchar</I
></TT
>.
<TT
CLASS="PARAMETER"
><I
>wchar</I
></TT
> contains 1, 2 or 4 depending on the number of
bytes needed to hold the largest Unicode char counted. The return value
indicates whether <TT
CLASS="PARAMETER"
><I
>string</I
></TT
> is a well-formed UTF16
string.
</P
></DIV
><H1
><A
NAME="FCISLOWER"
></A
>FcIsLower</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5379"
></A
><H2
>Name</H2
>FcIsLower&nbsp;--&nbsp;check for lower case ASCII character</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5382"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5383"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcIsLower</TT
></CODE
>(FcChar8 <TT
CLASS="PARAMETER"
><I
>c</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5390"
></A
><H2
>Description</H2
><P
>This macro checks whether <TT
CLASS="PARAMETER"
><I
>c</I
></TT
> is an lower case ASCII
letter.
</P
></DIV
><H1
><A
NAME="FCISUPPER"
></A
>FcIsUpper</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5399"
></A
><H2
>Name</H2
>FcIsUpper&nbsp;--&nbsp;check for upper case ASCII character</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5402"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5403"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcBool <TT
CLASS="FUNCTION"
>FcIsUpper</TT
></CODE
>(FcChar8 <TT
CLASS="PARAMETER"
><I
>c</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5410"
></A
><H2
>Description</H2
><P
>This macro checks whether <TT
CLASS="PARAMETER"
><I
>c</I
></TT
> is a upper case ASCII
letter.
</P
></DIV
><H1
><A
NAME="FCTOLOWER"
></A
>FcToLower</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5419"
></A
><H2
>Name</H2
>FcToLower&nbsp;--&nbsp;convert upper case ASCII to lower case</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5422"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5423"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 <TT
CLASS="FUNCTION"
>FcToLower</TT
></CODE
>(FcChar8 <TT
CLASS="PARAMETER"
><I
>c</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5430"
></A
><H2
>Description</H2
><P
>This macro converts upper case ASCII <TT
CLASS="PARAMETER"
><I
>c</I
></TT
> to the
equivalent lower case letter.
</P
></DIV
><H1
><A
NAME="FCSTRCOPY"
></A
>FcStrCopy</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5439"
></A
><H2
>Name</H2
>FcStrCopy&nbsp;--&nbsp;duplicate a string</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5442"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5443"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrCopy</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5450"
></A
><H2
>Description</H2
><P
>Allocates memory, copies <TT
CLASS="PARAMETER"
><I
>s</I
></TT
> and returns the resulting
buffer. Yes, this is <TT
CLASS="FUNCTION"
>strdup</TT
>, but that function isn't
available on every platform.
</P
></DIV
><H1
><A
NAME="FCSTRDOWNCASE"
></A
>FcStrDowncase</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5460"
></A
><H2
>Name</H2
>FcStrDowncase&nbsp;--&nbsp;create a lower case translation of a string</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5463"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5464"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrDowncase</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5471"
></A
><H2
>Description</H2
><P
>Allocates memory, copies <TT
CLASS="PARAMETER"
><I
>s</I
></TT
>, converting upper case
letters to lower case and returns the allocated buffer.
</P
></DIV
><H1
><A
NAME="FCSTRCOPYFILENAME"
></A
>FcStrCopyFilename</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5480"
></A
><H2
>Name</H2
>FcStrCopyFilename&nbsp;--&nbsp;create a complete path from a filename</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5483"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5484"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrCopyFilename</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5491"
></A
><H2
>Description</H2
><P
><TT
CLASS="FUNCTION"
>FcStrCopyFilename</TT
> constructs an absolute pathname from
<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>. 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 <TT
CLASS="FUNCTION"
>FcConfigEnableHome</TT
>).
</P
></DIV
><H1
><A
NAME="FCSTRCMP"
></A
>FcStrCmp</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5502"
></A
><H2
>Name</H2
>FcStrCmp&nbsp;--&nbsp;compare UTF-8 strings</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5505"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5506"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcStrCmp</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5515"
></A
><H2
>Description</H2
><P
>Returns the usual &#60;0, 0, &#62;0 result of comparing
<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>.
</P
></DIV
><H1
><A
NAME="FCSTRCMPIGNORECASE"
></A
>FcStrCmpIgnoreCase</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5525"
></A
><H2
>Name</H2
>FcStrCmpIgnoreCase&nbsp;--&nbsp;compare UTF-8 strings ignoring case</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5528"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5529"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>int <TT
CLASS="FUNCTION"
>FcStrCmpIgnoreCase</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5538"
></A
><H2
>Description</H2
><P
>Returns the usual &#60;0, 0, &#62;0 result of comparing
<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>. This test is
case-insensitive for all proper UTF-8 encoded strings.
</P
></DIV
><H1
><A
NAME="FCSTRSTR"
></A
>FcStrStr</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5548"
></A
><H2
>Name</H2
>FcStrStr&nbsp;--&nbsp;locate UTF-8 substring</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5551"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5552"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrStr</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5561"
></A
><H2
>Description</H2
><P
>Returns the location of <TT
CLASS="PARAMETER"
><I
>s2</I
></TT
> in
<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>. Returns NULL if <TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>
is not present in <TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>. This test will operate properly
with UTF8 encoded strings.
</P
></DIV
><H1
><A
NAME="FCSTRSTRIGNORECASE"
></A
>FcStrStrIgnoreCase</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5573"
></A
><H2
>Name</H2
>FcStrStrIgnoreCase&nbsp;--&nbsp;locate UTF-8 substring ignoring case</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5576"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5577"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrStrIgnoreCase</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5586"
></A
><H2
>Description</H2
><P
>Returns the location of <TT
CLASS="PARAMETER"
><I
>s2</I
></TT
> in
<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>, ignoring case. Returns NULL if
<TT
CLASS="PARAMETER"
><I
>s2</I
></TT
> is not present in <TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>.
This test is case-insensitive for all proper UTF-8 encoded strings.
</P
></DIV
><H1
><A
NAME="FCSTRPLUS"
></A
>FcStrPlus</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5598"
></A
><H2
>Name</H2
>FcStrPlus&nbsp;--&nbsp;concatenate two strings</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5601"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5602"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrPlus</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
>, const FcChar8 *<TT
CLASS="PARAMETER"
><I
>s2</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5611"
></A
><H2
>Description</H2
><P
>This function allocates new storage and places the concatenation of
<TT
CLASS="PARAMETER"
><I
>s1</I
></TT
> and <TT
CLASS="PARAMETER"
><I
>s2</I
></TT
> there, returning the
new string.
</P
></DIV
><H1
><A
NAME="FCSTRFREE"
></A
>FcStrFree</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5621"
></A
><H2
>Name</H2
>FcStrFree&nbsp;--&nbsp;free a string</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5624"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5625"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>void <TT
CLASS="FUNCTION"
>FcStrFree</TT
></CODE
>(FcChar8 *<TT
CLASS="PARAMETER"
><I
>s</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5632"
></A
><H2
>Description</H2
><P
>This is just a wrapper around free(3) which helps track memory usage of
strings within the fontconfig library.
</P
></DIV
><H1
><A
NAME="FCSTRBUILDFILENAME"
></A
>FcStrBuildFilename</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5640"
></A
><H2
>Name</H2
>FcStrBuildFilename&nbsp;--&nbsp;Concatenate strings as a file path</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5643"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5644"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrBuildFilename</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>path</I
></TT
>, ...<TT
CLASS="PARAMETER"
><I
></I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5653"
></A
><H2
>Description</H2
><P
>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.
</P
></DIV
><H1
><A
NAME="FCSTRDIRNAME"
></A
>FcStrDirname</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5661"
></A
><H2
>Name</H2
>FcStrDirname&nbsp;--&nbsp;directory part of filename</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5664"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5665"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrDirname</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5672"
></A
><H2
>Description</H2
><P
>Returns the directory containing <TT
CLASS="PARAMETER"
><I
>file</I
></TT
>. This
is returned in newly allocated storage which should be freed when no longer
needed.
</P
></DIV
><H1
><A
NAME="FCSTRBASENAME"
></A
>FcStrBasename</H1
><DIV
CLASS="REFNAMEDIV"
><A
NAME="AEN5681"
></A
><H2
>Name</H2
>FcStrBasename&nbsp;--&nbsp;last component of filename</DIV
><DIV
CLASS="REFSYNOPSISDIV"
><A
NAME="AEN5684"
></A
><H2
>Synopsis</H2
><DIV
CLASS="FUNCSYNOPSIS"
><P
></P
><A
NAME="AEN5685"
></A
><TABLE
BORDER="0"
BGCOLOR="#E0E0E0"
WIDTH="100%"
><TR
><TD
><PRE
CLASS="FUNCSYNOPSISINFO"
>#include &#60;fontconfig/fontconfig.h&#62;
</PRE
></TD
></TR
></TABLE
><P
><CODE
><CODE
CLASS="FUNCDEF"
>FcChar8 * <TT
CLASS="FUNCTION"
>FcStrBasename</TT
></CODE
>(const FcChar8 *<TT
CLASS="PARAMETER"
><I
>file</I
></TT
>);</CODE
></P
><P
></P
></DIV
></DIV
><DIV
CLASS="REFSECT1"
><A
NAME="AEN5692"
></A
><H2
>Description</H2
><P
>Returns the filename of <TT
CLASS="PARAMETER"
><I
>file</I
></TT
> stripped of any leading
directory names. This is returned in newly allocated storage which should
be freed when no longer needed.
</P
></DIV
></DIV
></DIV
></DIV
></BODY
></HTML
>
Reference in New Issue View Git Blame Copy Permalink