>

>

>Datatypes

>

NAME="GENERATOR"

CONTENT="Modular DocBook HTML Stylesheet Version 1.79">

REL="HOME"

HREF="t1.html">

REL="PREVIOUS"

TITLE="FUNCTIONAL OVERVIEW"

HREF="x19.html">

REL="NEXT"

TITLE="FUNCTIONS"

HREF="x103.html">

>

CLASS="SECT1"

BGCOLOR="#FFFFFF"

TEXT="#000000"

LINK="#0000FF"

VLINK="#840084"

ALINK="#0000FF"

>

CLASS="NAVHEADER"

>

SUMMARY="Header navigation table"

WIDTH="100%"

BORDER="0"

CELLPADDING="0"

CELLSPACING="0"

>

>

COLSPAN="3"

ALIGN="center"

>

>

>

>

WIDTH="10%"

ALIGN="left"

VALIGN="bottom"

>

HREF="x19.html"

ACCESSKEY="P"

><<< Previous

>

>

WIDTH="80%"

ALIGN="center"

VALIGN="bottom"

>

>

WIDTH="10%"

ALIGN="right"

VALIGN="bottom"

>

HREF="x103.html"

ACCESSKEY="N"

>Next >>>

>

>

>

>

ALIGN="LEFT"

WIDTH="100%">

>

CLASS="SECT1"

>

CLASS="SECT1"

>

NAME="AEN31"

>Datatypes

>

>

>Fontconfig uses abstract data types to hide internal implementation details

for most data structures.  A few structures are exposed where appropriate.

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN34"

>FcChar8, FcChar16, FcChar32, FcBool

>

>

>These are primitive data types; the FcChar* types hold precisely the number

of bits stated (if supported by the C implementation).  FcBool holds

one of two C preprocessor symbols: FcFalse or FcTrue.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN37"

>FcMatrix

>

>

>An FcMatrix holds an affine transformation, usually used to reshape glyphs.

A small set of matrix operations are provided to manipulate these.

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

CLASS="PROGRAMLISTING"

>        typedef struct _FcMatrix {

                double xx, xy, yx, yy;

        } FcMatrix;

>

>

>

>

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN41"

>FcCharSet

>

>

>An FcCharSet is an abstract type that holds the set of encoded Unicode chars

in a font.  Operations to build and compare these sets are provided.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN44"

>FcLangSet

>

>

>An FcLangSet is an abstract type that holds the set of languages supported

by a font.  Operations to build and compare these sets are provided. These

are computed for a font based on orthographic information built into the

fontconfig library. Fontconfig has orthographies for all of the ISO 639-1

languages except for MS, NA, PA, PS, QU, RN, RW, SD, SG, SN, SU and ZA. If

you have orthographic information for any of these languages, please submit

them.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN47"

>FcLangResult

>

>

>An FcLangResult is an enumeration used to return the results of comparing

two language strings or FcLangSet objects. FcLangEqual means the

objects match language and territory. FcLangDifferentTerritory means

the objects match in language but differ in territory.

FcLangDifferentLang means the objects differ in language.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN50"

>FcType

>

>

>Tags the kind of data stored in an FcValue.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN53"

>FcValue

>

>

>An FcValue object holds a single value with one of a number of different

types.  The 'type' tag indicates which member is valid.

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

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;

                } u;

        } FcValue;

>

>

>

>

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

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 *

>

>

>

>

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN58"

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

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN61"

>FcFontSet

>

>

>    

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

CLASS="PROGRAMLISTING"

>        typedef struct _FcFontSet {

                int nfont;

                int sfont;

                FcPattern **fonts;

        } FcFontSet;

>

>

>

>

An FcFontSet contains a list of FcPatterns.  Internally fontconfig uses this

data structure to hold sets of fonts.  Externally, fontconfig returns the

results of listing fonts in this format.  'nfont' holds the number of

patterns in the 'fonts' array; 'sfont' is used to indicate the size of that

array.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN65"

>FcStrSet, FcStrList

>

>

>FcStrSet holds a list of strings that can be appended to and enumerated.

Its unique characteristic is that the enumeration works even while strings

are appended during enumeration.  FcStrList is used during enumeration to

safely and correctly walk the list of strings even while that list is edited

in the middle of enumeration.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN68"

>FcObjectSet

>

>

>      

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

CLASS="PROGRAMLISTING"

>        typedef struct _FcObjectSet {

                int nobject;

                int sobject;

                const char **objects;

        } FcObjectSet;

>

>

>

>

holds a set of names and is used to specify which fields from fonts are

placed in the the list of returned patterns when listing fonts.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN72"

>FcObjectType

>

>

>      

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

CLASS="PROGRAMLISTING"

>        typedef struct _FcObjectType {

                const char *object;

                FcType type;

        } FcObjectType;

>

>

>

>

marks the type of a pattern element generated when parsing font names.

Applications can add new object types so that font names may contain the new

elements.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN76"

>FcConstant

>

>

>      

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

CLASS="PROGRAMLISTING"

>        typedef struct _FcConstant {

            const FcChar8 *name;

            const char *object;

            int value;

        } FcConstant;

>

>

>

>

Provides for symbolic constants for new pattern elements.  When 'name' is

seen in a font name, an 'object' element is created with value 'value'.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN80"

>FcBlanks

>

>

>holds a list of Unicode chars which are expected to be blank; unexpectedly

blank chars are assumed to be invalid and are elided from the charset

associated with the font.

>

>        FcBlanks is deprecated and should not be used in newly written code.

        It is still accepted by some functions for compatibility with

        older code but will be removed in the future.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN84"

>FcFileCache

>

>

>holds the per-user cache information for use while loading the font

database. This is built automatically for the current configuration when

that is loaded.  Applications must always pass '0' when one is requested.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN87"

>FcConfig

>

>

>holds a complete configuration of the library; there is one default

configuration, other can be constructed from XML data structures.  All

public entry points that need global data can take an optional FcConfig*

argument; passing 0 uses the default configuration.  FcConfig objects hold two

sets of fonts, the first contains those specified by the configuration, the

second set holds those added by the application at run-time.  Interfaces

that need to reference a particular set use one of the FcSetName enumerated

values.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN90"

>FcSetName

>

>

>Specifies one of the two sets of fonts available in a configuration;

FcSetSystem for those fonts specified in the configuration and

FcSetApplication which holds fonts provided by the application.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN93"

>FcResult

>

>

>Used as a return type for functions manipulating FcPattern objects.

BORDER="0"

BGCOLOR="#E0E0E0"

WIDTH="100%"

>

>

>

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

>

>

>

>

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN97"

>FcAtomic

>

>

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

configuration files.

>

>

CLASS="SECT2"

>

CLASS="SECT2"

>

NAME="AEN100"

>FcCache

>

>

>Holds information about the fonts contained in a single directory. Normal

applications need not worry about this as caches for font access are

automatically managed by the library. Applications dealing with cache

management may want to use some of these objects in their work, however the

included 'fc-cache' program generally suffices for all of that.

>

>

>

CLASS="NAVFOOTER"

>

ALIGN="LEFT"

WIDTH="100%">

SUMMARY="Footer navigation table"

WIDTH="100%"

BORDER="0"

CELLPADDING="0"

CELLSPACING="0"

>

>

WIDTH="33%"

ALIGN="left"

VALIGN="top"

>

HREF="x19.html"

ACCESSKEY="P"

><<< Previous

>

>

WIDTH="34%"

ALIGN="center"

VALIGN="top"

>

HREF="t1.html"

ACCESSKEY="H"

>Home

>

>

WIDTH="33%"

ALIGN="right"

VALIGN="top"

>

HREF="x103.html"

ACCESSKEY="N"

>Next >>>

>

>

>

>

WIDTH="33%"

ALIGN="left"

VALIGN="top"

>FUNCTIONAL OVERVIEW

>

WIDTH="34%"

ALIGN="center"

VALIGN="top"

> 

>

WIDTH="33%"

ALIGN="right"

VALIGN="top"

>FUNCTIONS

>

>

>

>

>

>