<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
-<!ENTITY fcmatrix SYSTEM "fcmatrix.sgml">
+<!ENTITY fcatomic SYSTEM "fcatomic.sgml">
+<!ENTITY fcblanks SYSTEM "fcblanks.sgml">
<!ENTITY fccharset SYSTEM "fccharset.sgml">
-<!ENTITY fcvalue SYSTEM "fcvalue.sgml">
-<!ENTITY fcpattern SYSTEM "fcpattern.sgml">
+<!ENTITY fcconfig SYSTEM "fcconfig.sgml">
+<!ENTITY fcconstant SYSTEM "fcconstant.sgml">
+<!ENTITY fcfile SYSTEM "fcfile.sgml">
<!ENTITY fcfontset SYSTEM "fcfontset.sgml">
+<!ENTITY fcfreetype SYSTEM "fcfreetype.sgml">
+<!ENTITY fcinit SYSTEM "fcinit.sgml">
+<!ENTITY fcmatrix SYSTEM "fcmatrix.sgml">
<!ENTITY fcobjectset SYSTEM "fcobjectset.sgml">
<!ENTITY fcobjecttype SYSTEM "fcobjecttype.sgml">
-<!ENTITY fcconstant SYSTEM "fcconstant.sgml">
-<!ENTITY fcblanks SYSTEM "fcblanks.sgml">
-<!ENTITY fcconfig SYSTEM "fcconfig.sgml">
+<!ENTITY fcpattern SYSTEM "fcpattern.sgml">
+<!ENTITY fcstring SYSTEM "fcstring.sgml">
+<!ENTITY fcstrset SYSTEM "fcstrset.sgml">
+<!ENTITY fcvalue SYSTEM "fcvalue.sgml">
+<!ENTITY version SYSTEM "version.sgml">
]>
<!--
$Id$
- Copyright © 2002 Keith Packard
+ Copyright © 2003 Keith Packard
Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
PERFORMANCE OF THIS SOFTWARE.
-->
<article>
- <title>Fontconfig Developers Reference</title>
+ <title>Fontconfig Developers Reference, Version &version; </title>
<artheader>
<author>
<firstname>Keith</firstname>
</author>
<authorinitials>KRP</authorinitials>
<productname>Fontconfig</productname>
- <productnumber>2.1.91</productnumber>
+ <productnumber>&version;</productnumber>
<LegalNotice>
<simpara>
-Copyright © 2002 Keith Packard
+Copyright © 2002 Keith Packard
</simpara><simpara>
Permission to use, copy, modify, distribute, and sell this software and its
documentation for any purpose is hereby granted without fee, provided that
</simpara>
</LegalNotice>
</artheader>
-<!--
-<refsynopsisdiv>
- <synopsis>
- #include <fontconfig/fontconfig.h>
- #include <fontconfig/fcfreetype.h>
- </synopsis>
-</refsynopsisdiv>
--->
<sect1><title>DESCRIPTION</title>
<para>
Fontconfig is a library designed to provide system-wide font configuration,
<programlisting>
Property Definitions
- Property CPP Symbol Type Description
+ Property CPP Symbol Type Description
----------------------------------------------------
- family FC_FAMILY String Font family name
+ family FC_FAMILY String Font family names
+ familylang FC_FAMILYLANG String Language cooresponding to
+ each family name
style FC_STYLE String Font style. Overrides weight
and slant
+ stylelang FC_STYLELANG String Language cooresponding to
+ each style name
+ fullname FC_FULLNAME String Font face full name where
+ different from family and
+ family + style
+ fullnamelang FC_FULLNAMELANG String Language cooresponding to
+ each fullname
slant FC_SLANT Int Italic, oblique or roman
weight FC_WEIGHT Int Light, medium, demibold,
bold or black
size FC_SIZE Double Point size
+ width FC_WIDTH Int Condensed, normal or expanded
aspect FC_ASPECT Double Stretches glyphs horizontally
before hinting
pixelsize FC_PIXEL_SIZE Double Pixel size
- spacing FC_SPACING Int Proportional, monospace or
- charcell
+ 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
hinting FC_HINTING Bool Whether the rasterizer should
use hinting
+ hintstyle FC_HINT_STYLE Int Automatic hinting style
verticallayout FC_VERTICAL_LAYOUT Bool Use vertical layout
autohint FC_AUTOHINT Bool Use autohinter instead of
normal hinter
spacing
charset FC_CHARSET CharSet Unicode chars encoded by
the font
- lang FC_LANG String List of RFC-3066-style
+ 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
+ embolden FC_EMBOLDEN Bool Rasterizer should
+ synthetically embolden the font
</programlisting>
</sect2>
</sect1>
-<sect1><title>DATATYPES</title>
+<sect1><title>Datatypes</title>
<para>
Fontconfig uses abstract datatypes to hide internal implementation details
for most data structures. A few structures are exposed where appropriate.
</para>
- <variablelist>
- <varlistentry>
- <term>FcChar8<term>
- <term>FcChar16<term>
- <term>FcChar32<term>
- <term>FcBool</term>
- <listitem>
+ <sect2><title>FcChar8, FcChar16, FcChar32, FcBool</title>
<para>
These are primitive datatypes; the FcChar* types hold precisely the number
of bits stated (if supported by the C implementation). FcBool holds
one of two CPP symbols: FcFalse or FcTrue.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcMatrix</term><listitem>
+ </sect2>
+ <sect2><title>FcMatrix</title>
<para>
An FcMatrix holds an affine transformation, usually used to reshape glyphs.
A small set of matrix operations are provided to manipulate these.
} FcMatrix;
</programlisting>
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcCharSet</term><listitem>
+ </sect2>
+ <sect2><title>FcCharSet</title>
<para>
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.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcType</term><listitem>
+ </sect2>
+ <sect2><title>FcLangSet</title>
+ <para>
+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.
+ </para>
+ </sect2>
+ <sect2><title>FcLangResult</title>
+ <para>
+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.
+ </para>
+ </sect2>
+ <sect2><title>FcType</title>
<para>
Tags the kind of data stored in an FcValue.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcValue</term><listitem>
+ </sect2>
+ <sect2><title>FcValue</title>
<para>
An FcValue object holds a single value with one of a number of different
types. The 'type' tag indicates which member is valid.
double d;
const FcMatrix *m;
const FcCharSet *c;
+ void *f;
+ const FcLangSet *l;
} u;
} FcValue;
</programlisting>
FcTypeBool b b
FcTypeMatrix m FcMatrix *
FcTypeCharSet c FcCharSet *
+ FcTypeFTFace f void * (FT_Face)
+ FcTypeLangSet l FcLangSet *
</programlisting>
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcPattern</term><listitem>
+ </sect2>
+ <sect2><title>FcPattern</title>
<para>
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
one or more values; conventionally all of the same type, although the
interface doesn't demand that.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcFontSet</term><listitem>
+ </sect2>
+ <sect2><title>FcFontSet</title>
<para>
<programlisting>
typedef struct _FcFontSet {
patterns in the 'fonts' array; 'sfont' is used to indicate the size of that
array.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcStrSet</term><term>FcStrList</term><listitem>
+ </sect2>
+ <sect2><title>FcStrSet, FcStrList</title>
<para>
FcStrSet holds a list of strings that can be appended to and enumerated.
Its unique characteristic is that the enumeration works even while strings
safely and correctly walk the list of strings even while that list is edited
in the middle of enumeration.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcObjectSet</term><listitem>
+ </sect2>
+ <sect2><title>FcObjectSet</title>
<para>
<programlisting>
typedef struct _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.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcObjectType</term><listitem>
+ </sect2>
+ <sect2><title>FcObjectType</title>
<para>
<programlisting>
typedef struct _FcObjectType {
Applications can add new object types so that font names may contain the new
elements.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcConstant</term><listitem>
+ </sect2>
+ <sect2><title>FcConstant</title>
<para>
<programlisting>
typedef struct _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'.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcBlanks</term><listitem>
+ </sect2>
+ <sect2><title>FcBlanks</title>
<para>
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.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcFileCache</term><listitem>
+ </sect2>
+ <sect2><title>FcFileCache</title>
<para>
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.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcConfig</term><listitem>
+ </sect2>
+ <sect2><title>FcConfig</title>
<para>
holds a complete configuration of the library; there is one default
configuration, other can be constructed from XML data structures. All
that need to reference a particulat set use one of the FcSetName enumerated
values.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcSetName</term><listitem>
+ </sect2>
+ <sect2><title>FcSetName</title>
<para>
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.
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcResult</term><listitem>
+ </sect2>
+ <sect2><title>FcResult</title>
<para>
Used as a return type for functions manipulating FcPattern objects.
<programlisting>
FcResultTypeMismatch Object exists, but the type doesn't match
FcResultNoId Object exists, but has fewer values
than specified
+ FcResultOutOfMemory Malloc failed
</programlisting>
</para>
- </listitem></varlistentry>
- <varlistentry><term>FcAtomic</term><listitem>
+ </sect2>
+ <sect2><title>FcAtomic</title>
<para>
Used for locking access to config files. Provides a safe way to update
configuration files.
</para>
- </listitem></varlistentry>
- </variablelist>
+ </sect2>
</sect1>
<sect1><title>FUNCTIONS</title>
<para>
-Functions are grouped by the main datatype involved
+These are grouped by functionality, often using the main datatype being
+manipulated.
</para>
- <sect2><title>FcMatrix</title>
- <para>
-FcMatrix structures hold an affine transformation in matrix form.
- </para>
- &fcmatrix;
- </sect2>
- <sect2><title>FcCharSet</title>
- <para>
-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.
- </para>
- &fccharset;
- </sect2>
- <sect2><title>FcValue</title>
+ <sect2><title>Initialization</title>
<para>
-FcValue is a structure containing a type tag and a union of all possible
-datatypes. The tag is an enum of type
-<emphasis>FcType</emphasis>
-and is intended to provide a measure of run-time
-typechecking, although that depends on careful programming.
+These functions provide some control over how the library is initialized.
</para>
- &fcvalue;
+ &fcinit;
</sect2>
<sect2><title>FcPattern</title>
<para>
</para>
&fcobjectset;
</sect2>
+ <sect2><title>FreeType specific functions</title>
+ <para>
+While the fontconfig library doesn't insist that FreeType be used as the
+rasterization mechanism for fonts, it does provide some convenience
+functions.
+ </para>
+ &fcfreetype;
+ </sect2>
+ <sect2><title>FcValue</title>
+ <para>
+FcValue is a structure containing a type tag and a union of all possible
+datatypes. The tag is an enum of type
+<emphasis>FcType</emphasis>
+and is intended to provide a measure of run-time
+typechecking, although that depends on careful programming.
+ </para>
+ &fcvalue;
+ </sect2>
+ <sect2><title>FcCharSet</title>
+ <para>
+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.
+ </para>
+ &fccharset;
+ </sect2>
+ <sect2><title>FcMatrix</title>
+ <para>
+FcMatrix structures hold an affine transformation in matrix form.
+ </para>
+ &fcmatrix;
+ </sect2>
+ <sect2><title>FcConfig</title>
+ <para>
+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.
+ </para>
+ &fcconfig;
+ </sect2>
<sect2><title>FcObjectType</title>
<para>
Provides for applcation-specified font name object types so that new
</para>
&fcblanks;
</sect2>
- <sect2><title>FcConfig</title>
- <para>
-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.
- </para>
- &fcconfig;
- </sect2>
- <sect2><title>Initialization</title>
- <para>
-These functions provide some control over how the library is initialized.
- </para>
- <variablelist>
- <varlistentry><term>
-FcConfig *FcInitLoadConfig (void);
- </term><listitem><para>
-Loads the default configuration file and returns the resulting configuration.
-Does not load any font information.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcConfig *FcInitLoadConfigAndFonts (void);
- </term><listitem><para>
-Loads the default configuration file and builds information about the
-available fonts. Returns the resulting configuration.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcInit (void);
- </term><listitem><para>
-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.
- </para></listitem></varlistentry>
- <varlistentry><term>
-int FcGetVersion (void);
- </term><listitem><para>
-Returns the version number of the library.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcInitReinitialize (void);
- </term><listitem><para>
-Forces the default configuration file to be reloaded and resets the default
-configuration.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcInitBringUptoDate (void);
- </term><listitem><para>
-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.
- </para></listitem></varlistentry>
- </variablelist></sect2>
<sect2><title>FcAtomic</title>
<para>
These functions provide a safe way to update config files, allowing ongoing
reading of the old config file while locked for writing and ensuring that a
consistent and complete version of the config file is always available.
</para>
- <variablelist>
- <varlistentry><term>
-FcAtomic * FcAtomicCreate (const FcChar8 *file);
- </term><listitem><para>
-Creates a data structure containing data needed to control access to 'file'.
-Writing is done to a separate file. Once that file is complete, the original
-configuration file is atomically replaced so that reading process always see
-a consistent and complete file without the need to lock for reading.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcAtomicLock (FcAtomic *atomic);
- </term><listitem><para>
-Attempts to lock the file referenced by 'atomic'. Returns FcFalse if the
-file is locked by another process, else returns FcTrue and leaves the file
-locked.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcAtomicNewFile (FcAtomic *atomic);
- </term><listitem><para>
-Returns the filename for writing a new version of the file referenced
-by 'atomic'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcAtomicOrigFile (FcAtomic *atomic);
- </term><listitem><para>
-Returns the file refernced by 'atomic'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcAtomicReplaceOrig (FcAtomic *atomic);
- </term><listitem><para>
-Replaces the original file referenced by 'atomic' with the new file.
- </para></listitem></varlistentry>
- <varlistentry><term>
-void FcAtomicDeleteNew (FcAtomic *atomic);
- </term><listitem><para>
-Deletes the new file.
- </para></listitem></varlistentry>
- <varlistentry><term>
-void FcAtomicUnlock (FcAtomic *atomic);
- </term><listitem><para>
-Unlocks the file.
- </para></listitem></varlistentry>
- <varlistentry><term>
-void FcAtomicDestroy (FcAtomic *atomic);
- </term><listitem><para>
-Destroys 'atomic'.
- </para></listitem></varlistentry>
- </variablelist></sect2>
- <sect2><title>FreeType specific functions</title>
+ &fcatomic;
+ </sect2>
+ <sect2><title>File and Directory routines</title>
<para>
- <programlisting>
-#include <fontconfig/fcfreetype.h>
- </programlisting>
-While the fontconfig library doesn't insist that FreeType be used as the
-rasterization mechanism for fonts, it does provide some convenience
-functions.
+These routines work with font files and directories, including font
+directory cache files.
</para>
- <variablelist>
- <varlistentry><term>
-FT_UInt FcFreeTypeCharIndex (FT_Face face, FcChar32 ucs4);
- </term><listitem><para>
-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.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcCharSet *FcFreeTypeCharSet (FT_Face face, FcBlanks *blanks) Scans a
- </term><listitem><para>
-FreeType face and returns the set of encoded Unicode chars. This scans
-several encoding tables to build as complete a list as possible.
-If 'blanks' is not 0, the glyphs in the font are examined and any blank glyphs
-not in 'blanks' are not placed in the returned FcCharSet.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcPattern *FcFreeTypeQuery (const char *file, int id, FcBlanks *blanks, int *count);
- </term><listitem><para>
-Constructs a pattern representing the 'id'th font in 'file'. The number
-of fonts in 'file' is returned in 'count'.
- </para></listitem></varlistentry>
- </variablelist></sect2>
- <sect2><title>XML specific functions</title>
- <variablelist>
- <varlistentry><term>
-FcBool FcConfigParseAndLoad (FcConfig *config, const FcChar8 *file, FcBool complain);
- </term><listitem><para>
-Walks the configuration in 'file' and constructs the internal representation
-in 'config'. Any include files referenced from within 'file' will be loaded
-with FcConfigLoad and also parsed. If 'complain' is FcFalse, no warning
-will be displayed if 'file' does not exist.
- </para></listitem></varlistentry>
- </variablelist></sect2>
- <sect2><title>File and Directory routines</title>
- <variablelist>
- <varlistentry><term>
-FcBool FcFileScan (FcFontSet *set, FcStrSet *dirs, FcFileCache *cache, FcBlanks *blanks, const char *file, FcBool force);
- </term><listitem><para>
-Scans a single file and adds all fonts found to 'set'. If 'force' is FcTrue,
-then the file is scanned even if associated information is found in 'cache'.
-If 'file' is a directory, it is added to 'dirs'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcDirScan (FcFontSet *set, FcStrSet *dirs, FcFileCache *cache, FcBlanks *blanks, const char *dir, FcBool force);
- </term><listitem><para>
-Scans an entire directory and adds all fonts found to 'set'. If 'force' is
-FcTrue, then the directory and all files within it are scanned even if
-information is present in the per-directory cache file or 'cache'. Any
-subdirectories found are added to 'dirs'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcDirSave (FcFontSet *set, FcStrSet *dirs, const char *dir);
- </term><listitem><para>
-Creates the per-directory cache file for 'dir' and populates it with the
-fonts in 'set' and subdirectories in 'dirs'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcDirCacheValid (const FcChar8 *cache_file);
- </term><listitem><para>
-Returns FcTrue if 'cache_file' is no older than the directory containing it,
-else FcFalse.
- </para></listitem></varlistentry>
- </variablelist></sect2>
+ &fcfile;
+ </sect2>
<sect2><title>FcStrSet and FcStrList</title>
<para>
A data structure for enumerating strings, used to list directories while
scanning the configuration as directories are added while scanning.
</para>
- <variablelist>
- <varlistentry><term>
-FcStrSet *FcStrSetCreate (void);
- </term><listitem><para>
-Create an empty set.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcStrSetMember (FcStrSet *set, const FcChar8 *s);
- </term><listitem><para>
-Returns whether 's' is a member of 'set'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcStrSetAdd (FcStrSet *set, const FcChar8 *s);
- </term><listitem><para>
-Adds a copy of 's' to 'set'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcStrSetAddFilename (FcStrSet *set, const FcChar8 *s);
- </term><listitem><para>
-Adds a copy 's' to 'set', The copy is created with FcStrCopyFilename
-so that leading '~' values are replaced with the value of the HOME
-environment variable.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcStrSetDel (FcStrSet *set, const FcChar8 *s);
- </term><listitem><para>
-Removes 's' from 'set', returning FcTrue if 's' was a member else FcFalse.
- </para></listitem></varlistentry>
- <varlistentry><term>
-void FcStrSetDestroy (FcStrSet *set);
- </term><listitem><para>
-Destroys 'set'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcStrList *FcStrListCreate (FcStrSet *set);
- </term><listitem><para>
-Creates an enumerator to list the strings in 'set'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcStrListNext (FcStrList *list);
- </term><listitem><para>
-Returns the next string in 'set'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-void FcStrListDone (FcStrList *list);
- </term><listitem><para>
-Destroys the enumerator 'list'.
- </para></listitem></varlistentry>
- </variablelist></sect2>
+ &fcstrset;
+ </sect2>
<sect2><title>String utilities</title>
- <variablelist>
- <varlistentry><term>
-int FcUtf8ToUcs4 (FcChar8 *src, FcChar32 *dst, int len);
- </term><listitem>
- <para>
-Converts the next Unicode char from 'src' into 'dst' and returns the number
-of bytes containing the char. 'src' nust be at least 'len' bytes long.
- </para></listitem></varlistentry>
- <varlistentry><term>
-int FcUcs4ToUtf8 (FcChar32 src, FcChar8 dst[FC_UTF8_MAX_LEN]);
- </term><listitem><para>
-Converts the Unicode char from 'src' into 'dst' and returns the
-number of bytes needed to encode the char.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcUtf8Len (FcChar8 *src, int len, int *nchar, int *wchar);
- </term><listitem><para>
-Counts the number of Unicode chars in 'len' bytes of 'src'. Places that
-count in 'nchar'. 'wchar' contains 1, 2 or 4 depending on the number of
-bytes needed to hold the largest unicode char counted. The return value
-indicates whether 'src' is a well-formed UTF8 string.
- </para></listitem></varlistentry>
- <varlistentry><term>
-int FcUtf16ToUcs4 (FcChar8 *src, FcEndian endian, FcChar32 *dst, int len);
- </term><listitem><para>
-Converts the next Unicode char from 'src' into 'dst' and returns the
-number of bytes containing the char. 'src' must be at least 'len' bytes
-long. Bytes of 'src' are combined into 16-bit units according to 'endian'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcBool FcUtf16Len (FcChar8 *src, FcEndian endian, int len, int *nchar, int *wchar);
- </term><listitem><para>
-Counts the number of Unicode chars in 'len' bytes of 'src'. Bytes of 'src'
-are combined into 16-bit units according to 'endian'. Places that
-count in 'nchar'. 'wchar' contains 1, 2 or 4 depending on the number of
-bytes needed to hold the largest unicode char counted. The return value
-indicates whether 'string' is a well-formed UTF16 string.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcStrCopy (const FcChar8 *s);
- </term><listitem><para>
-Allocates memory, copies 's' and returns the resulting buffer. Yes, this
-is 'strdup', but that function isn't available on every platform.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcStrCopyFilename (const FcChar8 *s);
- </term><listitem><para>
-Just like FcStrCopy except that it converts any leading '~' characters
-in 's' to the value of the HOME environment variable.
- </para></listitem></varlistentry>
- <varlistentry><term>
-int FcStrCmpIgnoreCase (const char *s1, const char *s2);
- </term><listitem><para>
-Returns the usual <0, 0, >0 result of comparing 's1' and 's2'. This test
-is case-insensitive in the ASCII range and will operate properly with UTF8
-encoded strings, although it does not check for well formed strings.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcStrDirname (const FcChar8 *file);
- </term><listitem><para>
-Returns the directory containing 'file'.
- </para></listitem></varlistentry>
- <varlistentry><term>
-FcChar8 *FcStrBasename (const FcChar8 *file);
- </term><listitem><para>
-Returns the filename of 'file' stripped of any leading directory names.
- </para></listitem></varlistentry>
- </variablelist></sect2>
+ <para>
+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.
+ </para>
+ &fcstring;
+ </sect2>
</sect1>
</article>
git.wh0rd.org / fontconfig.git / blobdiff