walkero
/
fontconfig
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Convert tabs to spaces 

This fixes broken layout on pdf.

Fixes https://gitlab.freedesktop.org/fontconfig/fontconfig/-/issues/343
This commit is contained in:
Akira TAGOH 2022-12-13 16:05:41 +09:00
parent ce9cbe36d8
commit 27a21ccef0
25 changed files with 1324 additions and 1324 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
doc/fcatomic.fncs
View File

@ -24,8 +24,8 @@
@RET@ FcAtomic *
@FUNC@ FcAtomicCreate
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ create an FcAtomic object
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ create an FcAtomic object
@DESC@
Creates a data structure containing data needed to control access to <parameter>file</parameter>.
Writing is done to a separate file. Once that file is complete, the original
@ -36,7 +36,7 @@ a consistent and complete file without the need to lock for reading.
@RET@ FcBool
@FUNC@ FcAtomicLock
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ lock a file
@PURPOSE@ lock a file
@DESC@
Attempts to lock the file referenced by <parameter>atomic</parameter>.
Returns FcFalse if the file is already locked, else returns FcTrue and
@ -46,7 +46,7 @@ leaves the file locked.
@RET@ FcChar8 *
@FUNC@ FcAtomicNewFile
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ return new temporary file name
@PURPOSE@ return new temporary file name
@DESC@
Returns the filename for writing a new version of the file referenced
by <parameter>atomic</parameter>.
@ -55,7 +55,7 @@ by <parameter>atomic</parameter>.
@RET@ FcChar8 *
@FUNC@ FcAtomicOrigFile
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ return original file name
@PURPOSE@ return original file name
@DESC@
Returns the file referenced by <parameter>atomic</parameter>.
@@
@ -63,7 +63,7 @@ Returns the file referenced by <parameter>atomic</parameter>.
@RET@ FcBool
@FUNC@ FcAtomicReplaceOrig
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ replace original with new
@PURPOSE@ replace original with new
@DESC@
Replaces the original file referenced by <parameter>atomic</parameter> with
the new file. Returns FcFalse if the file cannot be replaced due to
@ -73,7 +73,7 @@ permission issues in the filesystem. Otherwise returns FcTrue.
@RET@ void
@FUNC@ FcAtomicDeleteNew
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ delete new file
@PURPOSE@ delete new file
@DESC@
Deletes the new file. Used in error recovery to back out changes.
@@
@ -81,7 +81,7 @@ Deletes the new file. Used in error recovery to back out changes.
@RET@ void
@FUNC@ FcAtomicUnlock
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ unlock a file
@PURPOSE@ unlock a file
@DESC@
Unlocks the file.
@@
@ -89,7 +89,7 @@ Unlocks the file.
@RET@ void
@FUNC@ FcAtomicDestroy
@TYPE1@ FcAtomic * @ARG1@ atomic
@PURPOSE@ destroy an FcAtomic object
@PURPOSE@ destroy an FcAtomic object
@DESC@
Destroys <parameter>atomic</parameter>.
@@

36
doc/fcblanks.fncs
View File

@ -21,39 +21,39 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcBlanks *
@FUNC@ FcBlanksCreate
@TYPE1@ void
@PURPOSE@ Create an FcBlanks
@RET@ FcBlanks *
@FUNC@ FcBlanksCreate
@TYPE1@ void
@PURPOSE@ Create an FcBlanks
@DESC@
FcBlanks is deprecated.
This function always returns NULL.
@@
@RET@ void
@FUNC@ FcBlanksDestroy
@TYPE1@ FcBlanks * @ARG1@ b
@PURPOSE@ Destroy and FcBlanks
@RET@ void
@FUNC@ FcBlanksDestroy
@TYPE1@ FcBlanks * @ARG1@ b
@PURPOSE@ Destroy and FcBlanks
@DESC@
FcBlanks is deprecated.
This function does nothing.
@@
@RET@ FcBool
@FUNC@ FcBlanksAdd
@TYPE1@ FcBlanks * @ARG1@ b
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to an FcBlanks
@RET@ FcBool
@FUNC@ FcBlanksAdd
@TYPE1@ FcBlanks * @ARG1@ b
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to an FcBlanks
@DESC@
FcBlanks is deprecated.
This function always returns FALSE.
@@
@RET@ FcBool
@FUNC@ FcBlanksIsMember
@TYPE1@ FcBlanks * @ARG1@ b
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Query membership in an FcBlanks
@RET@ FcBool
@FUNC@ FcBlanksIsMember
@TYPE1@ FcBlanks * @ARG1@ b
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Query membership in an FcBlanks
@DESC@
FcBlanks is deprecated.
This function always returns FALSE.

88
doc/fccache.fncs
View File

@ -19,30 +19,30 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ const FcChar8 *
@FUNC@ FcCacheDir
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Return directory of <parameter>cache</parameter>
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Return directory of <parameter>cache</parameter>
@DESC@
This function returns the directory from which the cache was constructed.
@@
@RET@ FcFontSet *
@FUNC@ FcCacheCopySet
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Returns a copy of the fontset from <parameter>cache</parameter>
@RET@ FcFontSet *
@FUNC@ FcCacheCopySet
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Returns a copy of the fontset from <parameter>cache</parameter>
@DESC@
The returned fontset contains each of the font patterns from
<parameter>cache</parameter>. This fontset may be modified, but the patterns
from the cache are read-only.
@@
@RET@ const FcChar8 *
@FUNC@ FcCacheSubdir
@TYPE1@ const FcCache * @ARG1@ cache
@TYPE2@ int @ARG2@ i
@PURPOSE@ Return the <parameter>i</parameter>'th subdirectory.
@RET@ const FcChar8 *
@FUNC@ FcCacheSubdir
@TYPE1@ const FcCache * @ARG1@ cache
@TYPE2@ int @ARG2@ i
@PURPOSE@ Return the <parameter>i</parameter>'th subdirectory.
@DESC@
The set of subdirectories stored in a cache file are indexed by this
function, <parameter>i</parameter> should range from 0 to
@ -50,62 +50,62 @@ function, <parameter>i</parameter> should range from 0 to
value from FcCacheNumSubdir.
@@
@RET@ int
@FUNC@ FcCacheNumSubdir
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Return the number of subdirectories in <parameter>cache</parameter>.
@RET@ int
@FUNC@ FcCacheNumSubdir
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Return the number of subdirectories in <parameter>cache</parameter>.
@DESC@
This returns the total number of subdirectories in the cache.
@@
@RET@ int
@FUNC@ FcCacheNumFont
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Returns the number of fonts in <parameter>cache</parameter>.
@RET@ int
@FUNC@ FcCacheNumFont
@TYPE1@ const FcCache * @ARG1@ cache
@PURPOSE@ Returns the number of fonts in <parameter>cache</parameter>.
@DESC@
This returns the number of fonts which would be included in the return from
FcCacheCopySet.
@@
@RET@ FcBool
@FUNC@ FcDirCacheClean
@TYPE1@ const FcChar8 * @ARG1@ cache_dir
@TYPE2@ FcBool @ARG2@ verbose
@PURPOSE@ Clean up a cache directory
@RET@ FcBool
@FUNC@ FcDirCacheClean
@TYPE1@ const FcChar8 * @ARG1@ cache_dir
@TYPE2@ FcBool @ARG2@ verbose
@PURPOSE@ Clean up a cache directory
@DESC@
This tries to clean up the cache directory of <parameter>cache_dir</parameter>.
This returns FcTrue if the operation is successfully complete. otherwise FcFalse.
@SINCE@ 2.9.91
@SINCE@ 2.9.91
@@
@RET@ void
@FUNC@ FcCacheCreateTagFile
@TYPE1@ const FcConfig * @ARG1@ config
@PURPOSE@ Create CACHEDIR.TAG at cache directory.
@RET@ void
@FUNC@ FcCacheCreateTagFile
@TYPE1@ const FcConfig * @ARG1@ config
@PURPOSE@ Create CACHEDIR.TAG at cache directory.
@DESC@
This tries to create CACHEDIR.TAG file at the cache directory registered
to <parameter>config</parameter>.
@SINCE@ 2.9.91
@SINCE@ 2.9.91
@@
@RET@ FcBool
@FUNC@ FcDirCacheCreateUUID
@TYPE1@ FcChar8 * @ARG1@ dir
@TYPE2@ FcBool @ARG2@ force
@TYPE3@ FcConfig * @ARG3@ config
@PURPOSE@ Create .uuid file at a directory
@RET@ FcBool
@FUNC@ FcDirCacheCreateUUID
@TYPE1@ FcChar8 * @ARG1@ dir
@TYPE2@ FcBool @ARG2@ force
@TYPE3@ FcConfig * @ARG3@ config
@PURPOSE@ Create .uuid file at a directory
@DESC@
This function is deprecated. it doesn't take any effects.
@SINCE@ 2.12.92
@SINCE@ 2.12.92
@@
@RET@ FcBool
@FUNC@ FcDirCacheDeleteUUID
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@PURPOSE@ Delete .uuid file
@RET@ FcBool
@FUNC@ FcDirCacheDeleteUUID
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@PURPOSE@ Delete .uuid file
@DESC@
This is to delete .uuid file containing an UUID at a font directory of
<parameter>dir</parameter>.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@

212
doc/fccharset.fncs
View File

@ -21,101 +21,101 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcCharSet *
@FUNC@ FcCharSetCreate
@TYPE1@ void
@PURPOSE@ Create an empty character set
@RET@ FcCharSet *
@FUNC@ FcCharSetCreate
@TYPE1@ void
@PURPOSE@ Create an empty character set
@DESC@
<function>FcCharSetCreate</function> allocates and initializes a new empty
character set object.
@@
@RET@ void
@FUNC@ FcCharSetDestroy
@TYPE1@ FcCharSet * @ARG1@ fcs
@PURPOSE@ Destroy a character set
@RET@ void
@FUNC@ FcCharSetDestroy
@TYPE1@ FcCharSet * @ARG1@ fcs
@PURPOSE@ Destroy a character set
@DESC@
<function>FcCharSetDestroy</function> decrements the reference count
<function>FcCharSetDestroy</function> decrements the reference count
<parameter>fcs</parameter>. If the reference count becomes zero, all
memory referenced is freed.
@@
@RET@ FcBool
@FUNC@ FcCharSetAddChar
@TYPE1@ FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to a charset
@RET@ FcBool
@FUNC@ FcCharSetAddChar
@TYPE1@ FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to a charset
@DESC@
<function>FcCharSetAddChar</function> 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.
running out of memory.
@@
@RET@ FcBool
@FUNC@ FcCharSetDelChar
@TYPE1@ FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to a charset
@RET@ FcBool
@FUNC@ FcCharSetDelChar
@TYPE1@ FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Add a character to a charset
@DESC@
<function>FcCharSetDelChar</function> deletes a single Unicode char from the set,
returning FcFalse on failure, either as a result of a constant set or from
running out of memory.
@SINCE@ 2.9.0
@SINCE@ 2.9.0
@@
@RET@ FcCharSet *
@FUNC@ FcCharSetCopy
@TYPE1@ FcCharSet * @ARG1@ src
@PURPOSE@ Copy a charset
@RET@ FcCharSet *
@FUNC@ FcCharSetCopy
@TYPE1@ FcCharSet * @ARG1@ src
@PURPOSE@ Copy a charset
@DESC@
Makes a copy of <parameter>src</parameter>; note that this may not actually do anything more
than increment the reference count on <parameter>src</parameter>.
than increment the reference count on <parameter>src</parameter>.
@@
@RET@ FcBool
@FUNC@ FcCharSetEqual
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Compare two charsets
@RET@ FcBool
@FUNC@ FcCharSetEqual
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Compare two charsets
@DESC@
Returns whether <parameter>a</parameter> and <parameter>b</parameter>
contain the same set of Unicode chars.
@@
@RET@ FcCharSet *
@FUNC@ FcCharSetIntersect
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Intersect charsets
@RET@ FcCharSet *
@FUNC@ FcCharSetIntersect
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Intersect charsets
@DESC@
Returns a set including only those chars found in both
<parameter>a</parameter> and <parameter>b</parameter>.
<parameter>a</parameter> and <parameter>b</parameter>.
@@
@RET@ FcCharSet *
@FUNC@ FcCharSetUnion
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Add charsets
@RET@ FcCharSet *
@FUNC@ FcCharSetUnion
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Add charsets
@DESC@
Returns a set including only those chars found in either <parameter>a</parameter> or <parameter>b</parameter>.
Returns a set including only those chars found in either <parameter>a</parameter> or <parameter>b</parameter>.
@@
@RET@ FcCharSet *
@FUNC@ FcCharSetSubtract
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Subtract charsets
@RET@ FcCharSet *
@FUNC@ FcCharSetSubtract
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Subtract charsets
@DESC@
Returns a set including only those chars found in <parameter>a</parameter> but not <parameter>b</parameter>.
Returns a set including only those chars found in <parameter>a</parameter> but not <parameter>b</parameter>.
@@
@RET@ FcBool
@FUNC@ FcCharSetMerge
@TYPE1@ FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@TYPE3@ FcBool * @ARG3@ changed
@PURPOSE@ Merge charsets
@RET@ FcBool
@FUNC@ FcCharSetMerge
@TYPE1@ FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@TYPE3@ FcBool * @ARG3@ changed
@PURPOSE@ Merge charsets
@DESC@
Adds all chars in <parameter>b</parameter> to <parameter>a</parameter>.
In other words, this is an in-place version of FcCharSetUnion.
@ -125,56 +125,56 @@ Returns FcFalse on failure, either when <parameter>a</parameter> is a constant
set or from running out of memory.
@@
@RET@ FcBool
@FUNC@ FcCharSetHasChar
@TYPE1@ const FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Check a charset for a char
@RET@ FcBool
@FUNC@ FcCharSetHasChar
@TYPE1@ const FcCharSet * @ARG1@ fcs
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ Check a charset for a char
@DESC@
Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</parameter>.
Returns whether <parameter>fcs</parameter> contains the char <parameter>ucs4</parameter>.
@@
@RET@ FcChar32
@FUNC@ FcCharSetCount
@TYPE1@ const FcCharSet * @ARG1@ a
@PURPOSE@ Count entries in a charset
@RET@ FcChar32
@FUNC@ FcCharSetCount
@TYPE1@ const FcCharSet * @ARG1@ a
@PURPOSE@ Count entries in a charset
@DESC@
Returns the total number of Unicode chars in <parameter>a</parameter>.
Returns the total number of Unicode chars in <parameter>a</parameter>.
@@
@RET@ FcChar32
@FUNC@ FcCharSetIntersectCount
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Intersect and count charsets
@RET@ FcChar32
@FUNC@ FcCharSetIntersectCount
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Intersect and count charsets
@DESC@
Returns the number of chars that are in both <parameter>a</parameter> and <parameter>b</parameter>.
Returns the number of chars that are in both <parameter>a</parameter> and <parameter>b</parameter>.
@@
@RET@ FcChar32
@FUNC@ FcCharSetSubtractCount
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Subtract and count charsets
@RET@ FcChar32
@FUNC@ FcCharSetSubtractCount
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Subtract and count charsets
@DESC@
Returns the number of chars that are in <parameter>a</parameter> but not in <parameter>b</parameter>.
Returns the number of chars that are in <parameter>a</parameter> but not in <parameter>b</parameter>.
@@
@RET@ FcBool
@FUNC@ FcCharSetIsSubset
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Test for charset inclusion
@RET@ FcBool
@FUNC@ FcCharSetIsSubset
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ const FcCharSet * @ARG2@ b
@PURPOSE@ Test for charset inclusion
@DESC@
Returns whether <parameter>a</parameter> is a subset of <parameter>b</parameter>.
Returns whether <parameter>a</parameter> is a subset of <parameter>b</parameter>.
@@
@RET@ FcChar32
@FUNC@ FcCharSetFirstPage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map
@TYPE3@ FcChar32 * @ARG3@ next
@PURPOSE@ Start enumerating charset contents
@RET@ FcChar32
@FUNC@ FcCharSetFirstPage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map
@TYPE3@ FcChar32 * @ARG3@ next
@PURPOSE@ Start enumerating charset contents
@DESC@
Builds an array of bits in <parameter>map</parameter> marking the
first page of Unicode coverage of <parameter>a</parameter>.
@ -199,12 +199,12 @@ the 4th and 31st bits set. The code points represented by
reader ;).
@@
@RET@ FcChar32
@FUNC@ FcCharSetNextPage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map
@TYPE3@ FcChar32 * @ARG3@ next
@PURPOSE@ Continue enumerating charset contents
@RET@ FcChar32
@FUNC@ FcCharSetNextPage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32[FC_CHARSET_MAP_SIZE]% @ARG2@ map
@TYPE3@ FcChar32 * @ARG3@ next
@PURPOSE@ Continue enumerating charset contents
@DESC@
Builds an array of bits in <parameter>map</parameter> marking the
Unicode coverage of <parameter>a</parameter> for page containing
@ -217,12 +217,12 @@ code point for the page, or <constant>FC_CHARSET_DONE</constant> if
<parameter>*next</parameter>.
@@
@RET@ FcChar32
@FUNC@ FcCharSetCoverage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32 @ARG2@ page
@TYPE3@ FcChar32[8] @ARG3@ result
@PURPOSE@ DEPRECATED return coverage for a Unicode page
@RET@ FcChar32
@FUNC@ FcCharSetCoverage
@TYPE1@ const FcCharSet * @ARG1@ a
@TYPE2@ FcChar32 @ARG2@ page
@TYPE3@ FcChar32[8] @ARG3@ result
@PURPOSE@ DEPRECATED return coverage for a Unicode page
@DESC@
DEPRECATED
This function returns a bitmask in <parameter>result</parameter> which
@ -232,10 +232,10 @@ indicates which code points in
coverage.
@@
@RET@ FcCharSet *
@FUNC@ FcCharSetNew
@TYPE1@ void
@PURPOSE@ DEPRECATED alias for FcCharSetCreate
@RET@ FcCharSet *
@FUNC@ FcCharSetNew
@TYPE1@ void
@PURPOSE@ DEPRECATED alias for FcCharSetCreate
@DESC@
<function>FcCharSetNew</function> is a DEPRECATED alias for FcCharSetCreate.
@@

234
doc/fcconfig.fncs
View File

@ -23,8 +23,8 @@
*/
@RET@ FcConfig *
@FUNC@ FcConfigCreate
@TYPE1@ void
@PURPOSE@ Create a configuration
@TYPE1@ void
@PURPOSE@ Create a configuration
@DESC@
Creates an empty configuration.
@@
@ -32,7 +32,7 @@ Creates an empty configuration.
@RET@ FcConfig *
@FUNC@ FcConfigReference
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Increment config reference count
@PURPOSE@ Increment config reference count
@DESC@
Add another reference to <parameter>config</parameter>. Configs are freed only
when the reference count reaches zero.
@ -45,7 +45,7 @@ for destroying the configuration when not needed anymore.
@RET@ void
@FUNC@ FcConfigDestroy
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Destroy a configuration
@PURPOSE@ Destroy a configuration
@DESC@
Decrements the config reference count. If all references are gone, destroys
the configuration and any data associated with it.
@ -56,7 +56,7 @@ cause a new configuration to be created for use as current configuration.
@RET@ FcBool
@FUNC@ FcConfigSetCurrent
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Set configuration as default
@PURPOSE@ Set configuration as default
@DESC@
Sets the current default configuration to <parameter>config</parameter>. Implicitly calls
FcConfigBuildFonts if necessary, and FcConfigReference() to inrease the reference count
@ -65,8 +65,8 @@ in <parameter>config</parameter> since 2.12.0, returning FcFalse if that call fa
@RET@ FcConfig *
@FUNC@ FcConfigGetCurrent
@TYPE1@ void
@PURPOSE@ Return current configuration
@TYPE1@ void
@PURPOSE@ Return current configuration
@DESC@
Returns the current default configuration.
@@
@ -74,27 +74,27 @@ Returns the current default configuration.
@RET@ FcBool
@FUNC@ FcConfigUptoDate
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Check timestamps on config files
@PURPOSE@ Check timestamps on config files
@DESC@
Checks all of the files related to <parameter>config</parameter> and returns
whether any of them has been modified since the configuration was created.
If <parameter>config</parameter> is NULL, the current configuration is used.
@@
@RET@ FcChar8 *
@FUNC@ FcConfigHome
@TYPE1@ void
@PURPOSE@ return the current home directory.
@RET@ FcChar8 *
@FUNC@ FcConfigHome
@TYPE1@ void
@PURPOSE@ return the current home directory.
@DESC@
Return the current user's home directory, if it is available, and if using it
is enabled, and NULL otherwise.
See also <function>FcConfigEnableHome</function>).
@@
@RET@ FcBool
@FUNC@ FcConfigEnableHome
@TYPE1@ FcBool% @ARG1@ enable
@PURPOSE@ controls use of the home directory.
@RET@ FcBool
@FUNC@ FcConfigEnableHome
@TYPE1@ FcBool% @ARG1@ enable
@PURPOSE@ controls use of the home directory.
@DESC@
If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
files which are specified relative to the user's home directory (using the ~
@ -106,7 +106,7 @@ disabled. The previous setting of the value is returned.
@RET@ FcBool
@FUNC@ FcConfigBuildFonts
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Build font database
@PURPOSE@ Build font database
@DESC@
Builds the set of available fonts for the given configuration. Note that
any changes to the configuration after this call have indeterminate effects.
@ -117,7 +117,7 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcStrList *
@FUNC@ FcConfigGetConfigDirs
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config directories
@PURPOSE@ Get config directories
@DESC@
Returns the list of font directories specified in the configuration files
for <parameter>config</parameter>. Does not include any subdirectories.
@ -127,7 +127,7 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcStrList *
@FUNC@ FcConfigGetFontDirs
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get font directories
@PURPOSE@ Get font directories
@DESC@
Returns the list of font directories in <parameter>config</parameter>. This includes the
configured font directories along with any directories below those in the
@ -138,7 +138,7 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcStrList *
@FUNC@ FcConfigGetConfigFiles
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config files
@PURPOSE@ Get config files
@DESC@
Returns the list of known configuration files used to generate <parameter>config</parameter>.
If <parameter>config</parameter> is NULL, the current configuration is used.
@ -147,16 +147,16 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcChar8 *
@FUNC@ FcConfigGetCache
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ DEPRECATED used to return per-user cache filename
@PURPOSE@ DEPRECATED used to return per-user cache filename
@DESC@
With fontconfig no longer using per-user cache files, this function now
simply returns NULL to indicate that no per-user file exists.
@@
@RET@ FcStrList *
@FUNC@ FcConfigGetCacheDirs
@TYPE1@ const FcConfig * @ARG1@ config
@PURPOSE@ return the list of directories searched for cache files
@RET@ FcStrList *
@FUNC@ FcConfigGetCacheDirs
@TYPE1@ const FcConfig * @ARG1@ config
@PURPOSE@ return the list of directories searched for cache files
@DESC@
<function>FcConfigGetCacheDirs</function> returns a string list containing
all of the directories that fontconfig will search when attempting to load a
@ -166,9 +166,9 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcFontSet *
@FUNC@ FcConfigGetFonts
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcSetName% @ARG2@ set
@PURPOSE@ Get config font set
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcSetName% @ARG2@ set
@PURPOSE@ Get config font set
@DESC@
Returns one of the two sets of fonts from the configuration as specified
by <parameter>set</parameter>. This font set is owned by the library and must
@ -183,7 +183,7 @@ the return value is no longer referenced.
@RET@ FcBlanks *
@FUNC@ FcConfigGetBlanks
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config blanks
@PURPOSE@ Get config blanks
@DESC@
FcBlanks is deprecated.
This function always returns NULL.
@ -192,7 +192,7 @@ This function always returns NULL.
@RET@ int
@FUNC@ FcConfigGetRescanInterval
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config rescan interval
@PURPOSE@ Get config rescan interval
@DESC@
Returns the interval between automatic checks of the configuration (in
seconds) specified in <parameter>config</parameter>. The configuration is checked during
@ -203,9 +203,9 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcBool
@FUNC@ FcConfigSetRescanInterval
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ int% @ARG2@ rescanInterval
@PURPOSE@ Set config rescan interval
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ int% @ARG2@ rescanInterval
@PURPOSE@ Set config rescan interval
@DESC@
Sets the rescan interval. Returns FcFalse if the interval cannot be set (due
to allocation failure). Otherwise returns FcTrue.
@ -215,9 +215,9 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcBool
@FUNC@ FcConfigAppFontAddFile
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ file
@PURPOSE@ Add font file to font database
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ file
@PURPOSE@ Add font file to font database
@DESC@
Adds an application-specific font to the configuration. Returns FcFalse
if the fonts cannot be added (due to allocation failure or no fonts found).
@ -227,9 +227,9 @@ the current configuration is used.
@RET@ FcBool
@FUNC@ FcConfigAppFontAddDir
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ dir
@PURPOSE@ Add fonts from directory to font database
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ dir
@PURPOSE@ Add fonts from directory to font database
@DESC@
Scans the specified directory for fonts, adding each one found to the
application-specific set of fonts. Returns FcFalse
@ -241,7 +241,7 @@ the current configuration is used.
@RET@ void
@FUNC@ FcConfigAppFontClear
@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Remove all app fonts from font database
@PURPOSE@ Remove all app fonts from font database
@DESC@
Clears the set of application-specific fonts.
If <parameter>config</parameter> is NULL, the current configuration is used.
@ -249,11 +249,11 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcBool
@FUNC@ FcConfigSubstituteWithPat
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcPattern * @ARG3@ p_pat
@TYPE4@ FcMatchKind% @ARG4@ kind
@PURPOSE@ Execute substitutions
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcPattern * @ARG3@ p_pat
@TYPE4@ FcMatchKind% @ARG4@ kind
@PURPOSE@ Execute substitutions
@DESC@
Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
FcMatchPattern, then those tagged as pattern operations are applied, else
@ -265,10 +265,10 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcBool
@FUNC@ FcConfigSubstitute
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcMatchKind% @ARG3@ kind
@PURPOSE@ Execute substitutions
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcMatchKind% @ARG3@ kind
@PURPOSE@ Execute substitutions
@DESC@
Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse
if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
@ -277,10 +277,10 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcPattern *
@FUNC@ FcFontMatch
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcResult * @ARG3@ result
@PURPOSE@ Return best font
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcResult * @ARG3@ result
@PURPOSE@ Return best font
@DESC@
Finds the font in <parameter>sets</parameter> most closely matching
<parameter>pattern</parameter> and returns the result of
@ -294,12 +294,12 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcFontSet *
@FUNC@ FcFontSort
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcBool% @ARG3@ trim
@TYPE4@ FcCharSet ** @ARG4@ csp
@TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return list of matching fonts
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcBool% @ARG3@ trim
@TYPE4@ FcCharSet ** @ARG4@ csp
@TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return list of matching fonts
@DESC@
Returns the list of fonts sorted by closeness to <parameter>p</parameter>. If <parameter>trim</parameter> is FcTrue,
elements in the list which don't include Unicode coverage not provided by
@ -319,10 +319,10 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
@RET@ FcPattern *
@FUNC@ FcFontRenderPrepare
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ pat
@TYPE3@ FcPattern * @ARG3@ font
@PURPOSE@ Prepare pattern for loading font file
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ pat
@TYPE3@ FcPattern * @ARG3@ font
@PURPOSE@ Prepare pattern for loading font file
@DESC@
Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
@ -332,10 +332,10 @@ FcConfigSubstituteWithPat with <parameter>kind</parameter> FcMatchFont and then
@RET@ FcFontSet *
@FUNC@ FcFontList
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcObjectSet * @ARG3@ os
@PURPOSE@ List fonts
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcObjectSet * @ARG3@ os
@PURPOSE@ List fonts
@DESC@
Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
@ -345,17 +345,17 @@ to be up to date, and used.
@RET@ FcChar8 *
@FUNC@ FcConfigFilename
@TYPE1@ const FcChar8 * @ARG1@ name
@PURPOSE@ Find a config file
@TYPE1@ const FcChar8 * @ARG1@ name
@PURPOSE@ Find a config file
@DESC@
This function is deprecated and is replaced by <function>FcConfigGetFilename</function>.
@@
@RET@ FcChar8 *
@FUNC@ FcConfigGetFilename
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ name
@PURPOSE@ Find a config file
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ name
@PURPOSE@ Find a config file
@DESC@
Given the specified external entity name, return the associated filename.
This provides applications a way to convert various configuration file
@ -372,12 +372,12 @@ FONTCONFIG_PATH environment variable.
The result of this function is affected by the FONTCONFIG_SYSROOT environment variable or equivalent functionality.
@@
@RET@ FcBool
@FUNC@ FcConfigParseAndLoad
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ file
@TYPE3@ FcBool% @ARG3@ complain
@PURPOSE@ load a configuration file
@RET@ FcBool
@FUNC@ FcConfigParseAndLoad
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ file
@TYPE3@ FcBool% @ARG3@ complain
@PURPOSE@ load a configuration file
@DESC@
Walks the configuration in 'file' and constructs the internal representation
in 'config'. Any include files referenced from within 'file' will be loaded
@ -387,12 +387,12 @@ Returns FcFalse if some error occurred while loading the file, either a
parse error, semantic error or allocation failure. Otherwise returns FcTrue.
@@
@RET@ FcBool
@FUNC@ FcConfigParseAndLoadFromMemory
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ buffer
@TYPE3@ FcBool% @ARG3@ complain
@PURPOSE@ load a configuration from memory
@RET@ FcBool
@FUNC@ FcConfigParseAndLoadFromMemory
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ buffer
@TYPE3@ FcBool% @ARG3@ complain
@PURPOSE@ load a configuration from memory
@DESC@
Walks the configuration in 'memory' and constructs the internal representation
in 'config'. Any includes files referenced from within 'memory' will be loaded
@ -400,13 +400,13 @@ 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.
@SINCE@ 2.12.5
@SINCE@ 2.12.5
@@
@RET@ const FcChar8 *
@FUNC@ FcConfigGetSysRoot
@TYPE1@ const FcConfig * @ARG1@ config
@PURPOSE@ Obtain the system root directory
@RET@ const FcChar8 *
@FUNC@ FcConfigGetSysRoot
@TYPE1@ const FcConfig * @ARG1@ config
@PURPOSE@ Obtain the system root directory
@DESC@
Obtains the system root directory in 'config' if available. All files
(including file properties in patterns) obtained from this 'config' are
@ -415,14 +415,14 @@ relative to this system root directory.
This function isn't MT-safe. <function>FcConfigReference</function> must be called
before using this and then <function>FcConfigDestroy</function> when
the return value is no longer referenced.
@SINCE@ 2.10.92
@SINCE@ 2.10.92
@@
@RET@ void
@FUNC@ FcConfigSetSysRoot
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ sysroot
@PURPOSE@ Set the system root directory
@RET@ void
@FUNC@ FcConfigSetSysRoot
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ const FcChar8 * @ARG2@ sysroot
@PURPOSE@ Set the system root directory
@DESC@
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
@ -431,14 +431,14 @@ targets at build time. This also allows a cache to be re-targeted to a
different base directory if 'FcConfigGetSysRoot' is used to resolve file paths.
When setting this on the current config this causes changing current config
(calls FcConfigSetCurrent()).
@SINCE@ 2.10.92
@SINCE@ 2.10.92
@@
@RET@ void
@FUNC@ FcConfigFileInfoIterInit
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
@PURPOSE@ Initialize the iterator
@RET@ void
@FUNC@ FcConfigFileInfoIterInit
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
@PURPOSE@ Initialize the iterator
@DESC@
Initialize 'iter' with the first iterator in the config file information list.
</para><para>
@ -448,14 +448,14 @@ i.e. how fontconfig actually read them.
This function isn't MT-safe. <function>FcConfigReference</function> must be called
before using this and then <function>FcConfigDestroy</function> when the relevant
values are no longer referenced.
@SINCE@ 2.12.91
@SINCE@ 2.12.91
@@
@RET@ FcBool
@FUNC@ FcConfigFileInfoIterNext
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
@PURPOSE@ Set the iterator to point to the next list
@RET@ FcBool
@FUNC@ FcConfigFileInfoIterNext
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
@PURPOSE@ Set the iterator to point to the next list
@DESC@
Set 'iter' to point to the next node in the config file information list.
If there is no next node, FcFalse is returned.
@ -463,17 +463,17 @@ If there is no next node, FcFalse is returned.
This function isn't MT-safe. <function>FcConfigReference</function> must be called
before using <function>FcConfigFileInfoIterInit</function> and then
<function>FcConfigDestroy</function> when the relevant values are no longer referenced.
@SINCE@ 2.12.91
@SINCE@ 2.12.91
@@
@RET@ FcBool
@FUNC@ FcConfigFileInfoIterGet
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
@TYPE3@ FcChar8 ** @ARG3@ name
@TYPE4@ FcChar8 ** @ARG4@ description
@TYPE5@ FcBool * @ARG5@ enabled
@PURPOSE@ Obtain the configuration file information
@RET@ FcBool
@FUNC@ FcConfigFileInfoIterGet
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcConfigFileInfoIter * @ARG2@ iter
@TYPE3@ FcChar8 ** @ARG3@ name
@TYPE4@ FcChar8 ** @ARG4@ description
@TYPE5@ FcBool * @ARG5@ enabled
@PURPOSE@ Obtain the configuration file information
@DESC@
Obtain the filename, the description and the flag whether it is enabled or not
for 'iter' where points to current configuration file information.
@ -482,5 +482,5 @@ If the iterator is invalid, FcFalse is returned.
This function isn't MT-safe. <function>FcConfigReference</function> must be called
before using <function>FcConfigFileInfoIterInit</function> and then
<function>FcConfigDestroy</function> when the relevant values are no longer referenced.
@SINCE@ 2.12.91
@SINCE@ 2.12.91
@@

38
doc/fcconstant.fncs
View File

@ -21,37 +21,37 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcBool
@FUNC@ FcNameRegisterConstants
@TYPE1@ const FcConstant * @ARG1@ consts
@TYPE2@ int% @ARG2@ nconsts
@PURPOSE@ Register symbolic constants
@RET@ FcBool
@FUNC@ FcNameRegisterConstants
@TYPE1@ const FcConstant * @ARG1@ consts
@TYPE2@ int% @ARG2@ nconsts
@PURPOSE@ Register symbolic constants
@DESC@
Deprecated. Does nothing. Returns FcFalse.
@@
@RET@ FcBool
@FUNC@ FcNameUnregisterConstants
@TYPE1@ const FcConstant * @ARG1@ consts
@TYPE2@ int% @ARG2@ nconsts
@PURPOSE@ Unregister symbolic constants
@RET@ FcBool
@FUNC@ FcNameUnregisterConstants
@TYPE1@ const FcConstant * @ARG1@ consts
@TYPE2@ int% @ARG2@ nconsts
@PURPOSE@ Unregister symbolic constants
@DESC@
Deprecated. Does nothing. Returns FcFalse.
@@
@RET@ const FcConstant *
@FUNC@ FcNameGetConstant
@TYPE1@ FcChar8 * @ARG1@ string
@PURPOSE@ Lookup symbolic constant
@RET@ const FcConstant *
@FUNC@ FcNameGetConstant
@TYPE1@ FcChar8 * @ARG1@ string
@PURPOSE@ Lookup symbolic constant
@DESC@
Return the FcConstant structure related to symbolic constant <parameter>string</parameter>.
@@
@RET@ FcBool
@FUNC@ FcNameConstant
@TYPE1@ FcChar8 * @ARG1@ string
@TYPE2@ int * @ARG2@ result
@PURPOSE@ Get the value for a symbolic constant
@RET@ FcBool
@FUNC@ FcNameConstant
@TYPE1@ FcChar8 * @ARG1@ string
@TYPE2@ int * @ARG2@ result
@PURPOSE@ Get the value for a symbolic constant
@DESC@
Returns whether a symbolic constant with name <parameter>string</parameter> is registered,
placing the value of the constant in <parameter>result</parameter> if present.

72
doc/fcdircache.fncs
View File

@ -20,11 +20,11 @@
* OF THIS SOFTWARE.
*/
@RET@ FcBool
@FUNC@ FcDirCacheUnlink
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@PURPOSE@ Remove all caches related to <parameter>dir</parameter>
@RET@ FcBool
@FUNC@ FcDirCacheUnlink
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@PURPOSE@ Remove all caches related to <parameter>dir</parameter>
@DESC@
Scans the cache directories in <parameter>config</parameter>, removing any
instances of the cache file for <parameter>dir</parameter>. Returns FcFalse
@ -32,21 +32,21 @@ when some internal error occurs (out of memory, etc). Errors actually
unlinking any files are ignored.
@@
@RET@ FcBool
@FUNC@ FcDirCacheValid
@TYPE1@ const FcChar8 * @ARG1@ dir
@PURPOSE@ check directory cache
@RET@ FcBool
@FUNC@ FcDirCacheValid
@TYPE1@ const FcChar8 * @ARG1@ dir
@PURPOSE@ check directory cache
@DESC@
Returns FcTrue if <parameter>dir</parameter> has an associated valid cache
file, else returns FcFalse
@@
@RET@ FcCache *
@FUNC@ FcDirCacheLoad
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@TYPE3@ FcChar8 ** @ARG3@ cache_file
@PURPOSE@ load a directory cache
@RET@ FcCache *
@FUNC@ FcDirCacheLoad
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@TYPE3@ FcChar8 ** @ARG3@ cache_file
@PURPOSE@ load a directory cache
@DESC@
Loads the cache related to <parameter>dir</parameter>. If no cache file
exists, returns NULL. The name of the cache file is returned in
@ -54,23 +54,23 @@ exists, returns NULL. The name of the cache file is returned in
FcDirCacheRead.
@@
@RET@ FcCache *
@FUNC@ FcDirCacheRescan
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@PURPOSE@ Re-scan a directory cache
@RET@ FcCache *
@FUNC@ FcDirCacheRescan
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcConfig * @ARG2@ config
@PURPOSE@ Re-scan a directory cache
@DESC@
Re-scan directories only at <parameter>dir</parameter> and update the cache.
returns NULL if failed.
@SINCE@ 2.11.1
@SINCE@ 2.11.1
@@
@RET@ FcCache *
@FUNC@ FcDirCacheRead
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcBool% @ARG2@ force
@TYPE3@ FcConfig * @ARG3@ config
@PURPOSE@ read or construct a directory cache
@RET@ FcCache *
@FUNC@ FcDirCacheRead
@TYPE1@ const FcChar8 * @ARG1@ dir
@TYPE2@ FcBool% @ARG2@ force
@TYPE3@ FcConfig * @ARG3@ config
@PURPOSE@ read or construct a directory cache
@DESC@
This returns a cache for <parameter>dir</parameter>. If
<parameter>force</parameter> is FcFalse, then an existing, valid cache file
@ -78,21 +78,21 @@ will be used. Otherwise, a new cache will be created by scanning the
directory and that returned.
@@
@RET@ FcCache *
@FUNC@ FcDirCacheLoadFile
@TYPE1@ const FcChar8 * @ARG1@ cache_file
@TYPE2@ struct stat * @ARG2@ file_stat
@PURPOSE@ load a cache file
@RET@ FcCache *
@FUNC@ FcDirCacheLoadFile
@TYPE1@ const FcChar8 * @ARG1@ cache_file
@TYPE2@ struct stat * @ARG2@ file_stat
@PURPOSE@ load a cache file
@DESC@
This function loads a directory cache from
<parameter>cache_file</parameter>. If <parameter>file_stat</parameter> is
non-NULL, it will be filled with the results of stat(2) on the cache file.
@@
@RET@ void
@FUNC@ FcDirCacheUnload
@TYPE1@ FcCache * @ARG1@ cache
@PURPOSE@ unload a cache file
@RET@ void
@FUNC@ FcDirCacheUnload
@TYPE1@ FcCache * @ARG1@ cache
@PURPOSE@ unload a cache file
@DESC@
This function dereferences <parameter>cache</parameter>. When no other
references to it remain, all memory associated with the cache will be freed.

56
doc/fcfile.fncs
View File

@ -22,15 +22,15 @@
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcBool
@FUNC@ FcFileScan
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const FcChar8 * @ARG5@ file
@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font file
@RET@ FcBool
@FUNC@ FcFileScan
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const FcChar8 * @ARG5@ file
@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font file
@DESC@
Scans a single file and adds all fonts found to <parameter>set</parameter>.
If <parameter>force</parameter> is FcTrue, then the file is scanned even if
@ -45,24 +45,24 @@ contents of the font file itself. Returns FcFalse if any of the fonts cannot be
added (due to allocation failure). Otherwise returns FcTrue.
@@
@RET@ FcBool
@FUNC@ FcFileIsDir
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ check whether a file is a directory
@RET@ FcBool
@FUNC@ FcFileIsDir
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ check whether a file is a directory
@DESC@
Returns FcTrue if <parameter>file</parameter> is a directory, otherwise
returns FcFalse.
@@
@RET@ FcBool
@FUNC@ FcDirScan
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const FcChar8 * @ARG5@ dir
@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font directory without caching it
@RET@ FcBool
@FUNC@ FcDirScan
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
@TYPE5@ const FcChar8 * @ARG5@ dir
@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font directory without caching it
@DESC@
If <parameter>cache</parameter> is not zero or if <parameter>force</parameter>
is FcFalse, this function currently returns FcFalse. Otherwise, it scans an
@ -72,12 +72,12 @@ this function does not create any cache files. Use FcDirCacheRead() if
caching is desired.
@@
@RET@ FcBool
@FUNC@ FcDirSave
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ const FcChar8 * @ARG3@ dir
@PURPOSE@ DEPRECATED: formerly used to save a directory cache
@RET@ FcBool
@FUNC@ FcDirSave
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ const FcChar8 * @ARG3@ dir
@PURPOSE@ DEPRECATED: formerly used to save a directory cache
@DESC@
This function now does nothing aside from returning FcFalse. It used to creates the
per-directory cache file for <parameter>dir</parameter> and populates it

96
doc/fcfontset.fncs
View File

@ -21,42 +21,42 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcFontSet *
@FUNC@ FcFontSetCreate
@TYPE1@ void
@PURPOSE@ Create a font set
@RET@ FcFontSet *
@FUNC@ FcFontSetCreate
@TYPE1@ void
@PURPOSE@ Create a font set
@DESC@
Creates an empty font set.
@@
@RET@ void
@FUNC@ FcFontSetDestroy
@TYPE1@ FcFontSet * @ARG1@ s
@PURPOSE@ Destroy a font set
@RET@ void
@FUNC@ FcFontSetDestroy
@TYPE1@ FcFontSet * @ARG1@ s
@PURPOSE@ Destroy a font set
@DESC@
Destroys a font set. Note that this destroys any referenced patterns as
well.
@@
@RET@ FcBool
@FUNC@ FcFontSetAdd
@TYPE1@ FcFontSet * @ARG1@ s
@TYPE2@ FcPattern * @ARG2@ font
@PURPOSE@ Add to a font set
@RET@ FcBool
@FUNC@ FcFontSetAdd
@TYPE1@ FcFontSet * @ARG1@ s
@TYPE2@ FcPattern * @ARG2@ font
@PURPOSE@ Add to a font set
@DESC@
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.
@@
@RET@ FcFontSet *
@FUNC@ FcFontSetList
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcFontSet ** @ARG2@ sets
@TYPE3@ int @ARG3@ nsets
@TYPE4@ FcPattern * @ARG4@ pattern
@TYPE5@ FcObjectSet * @ARG5@ object_set
@PURPOSE@ List fonts from a set of font sets
@RET@ FcFontSet *
@FUNC@ FcFontSetList
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcFontSet ** @ARG2@ sets
@TYPE3@ int @ARG3@ nsets
@TYPE4@ FcPattern * @ARG4@ pattern
@TYPE5@ FcObjectSet * @ARG5@ object_set
@PURPOSE@ List fonts from a set of font sets
@DESC@
Selects fonts matching <parameter>pattern</parameter> from
<parameter>sets</parameter>, creates patterns from those
@ -66,14 +66,14 @@ If <parameter>config</parameter> is NULL, the default configuration is checked
to be up to date, and used.
@@
@RET@ FcPattern *
@FUNC@ FcFontSetMatch
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcFontSet ** @ARG2@ sets
@TYPE3@ int @ARG3@ nsets
@TYPE4@ FcPattern * @ARG4@ pattern
@TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return the best font from a set of font sets
@RET@ FcPattern *
@FUNC@ FcFontSetMatch
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcFontSet ** @ARG2@ sets
@TYPE3@ int @ARG3@ nsets
@TYPE4@ FcPattern * @ARG4@ pattern
@TYPE5@ FcResult * @ARG5@ result
@PURPOSE@ Return the best font from a set of font sets
@DESC@
Finds the font in <parameter>sets</parameter> most closely matching
<parameter>pattern</parameter> and returns the result of
@ -86,10 +86,10 @@ If <parameter>config</parameter> is NULL, the current configuration is used.
Returns NULL if an error occurs during this process.
@@
@RET@ void
@FUNC@ FcFontSetPrint
@TYPE1@ FcFontSet * @ARG1@ set
@PURPOSE@ Print a set of patterns to stdout
@RET@ void
@FUNC@ FcFontSetPrint
@TYPE1@ FcFontSet * @ARG1@ set
@PURPOSE@ Print a set of patterns to stdout
@DESC@
This function is useful for diagnosing font related issues, printing the
complete contents of every pattern in <parameter>set</parameter>. The format
@ -97,19 +97,19 @@ of the output is designed to be of help to users and developers, and may
change at any time.
@@
@RET@ FcFontSet *
@FUNC@ FcFontSetSort
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcFontSet ** @ARG2@ sets
@TYPE3@ int @ARG3@ nsets
@TYPE4@ FcPattern * @ARG4@ pattern
@TYPE5@ FcBool% @ARG5@ trim
@TYPE6@ FcCharSet ** @ARG6@ csp
@TYPE7@ FcResult * @ARG7@ result
@PURPOSE@ Add to a font set
@RET@ FcFontSet *
@FUNC@ FcFontSetSort
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcFontSet ** @ARG2@ sets
@TYPE3@ int @ARG3@ nsets
@TYPE4@ FcPattern * @ARG4@ pattern
@TYPE5@ FcBool% @ARG5@ trim
@TYPE6@ FcCharSet ** @ARG6@ csp
@TYPE7@ FcResult * @ARG7@ result
@PURPOSE@ Add to a font set
@DESC@
Returns the list of fonts from <parameter>sets</parameter>
sorted by closeness to <parameter>pattern</parameter>.
sorted by closeness to <parameter>pattern</parameter>.
If <parameter>trim</parameter> 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
@ -128,10 +128,10 @@ modify these patterns. Instead, they should be passed, along with
The FcFontSet returned by FcFontSetSort is destroyed by calling FcFontSetDestroy.
@@
@RET@ void
@FUNC@ FcFontSetSortDestroy
@TYPE1@ FcFontSet * @ARG1@ set
@PURPOSE@ DEPRECATED destroy a font set
@RET@ void
@FUNC@ FcFontSetSortDestroy
@TYPE1@ FcFontSet * @ARG1@ set
@PURPOSE@ DEPRECATED destroy a font set
@DESC@
This function is DEPRECATED. <function>FcFontSetSortDestroy</function>
destroys <parameter>set</parameter> by calling

12
doc/fcformat.fncs
View File

@ -22,11 +22,11 @@
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcChar8 *
@FUNC@ FcPatternFormat
@TYPE1@ FcPattern * @ARG1@ pat
@TYPE2@ const FcChar8 * @ARG2@ format
@PURPOSE@ Format a pattern into a string according to a format specifier
@RET@ FcChar8 *
@FUNC@ FcPatternFormat
@TYPE1@ FcPattern * @ARG1@ pat
@TYPE2@ const FcChar8 * @ARG2@ format
@PURPOSE@ Format a pattern into a string according to a format specifier
@DESC@
Converts given pattern <parameter>pat</parameter> into text described by
@ -305,5 +305,5 @@ For example, the format "%{family|downcase|delete( )}\n" will expand
to the values of the family element in <parameter>pattern</parameter>,
lower-cased and with spaces removed.
@SINCE@ 2.9.0
@SINCE@ 2.9.0
@@

84
doc/fcfreetype.fncs
View File

@ -25,11 +25,11 @@
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@ FT_UInt
@FUNC@ FcFreeTypeCharIndex
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ map Unicode to glyph id
@RET@ FT_UInt
@FUNC@ FcFreeTypeCharIndex
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcChar32% @ARG2@ ucs4
@PURPOSE@ map Unicode to glyph id
@DESC@
Maps a Unicode char to a glyph index. This function uses information from
several possible underlying encoding tables to work around broken fonts.
@ -41,11 +41,11 @@ higher level functions.
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@ FcCharSet *
@FUNC@ FcFreeTypeCharSet
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcBlanks * @ARG2@ blanks
@PURPOSE@ compute Unicode coverage
@RET@ FcCharSet *
@FUNC@ FcFreeTypeCharSet
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcBlanks * @ARG2@ blanks
@PURPOSE@ compute Unicode coverage
@DESC@
Scans a FreeType face and returns the set of encoded Unicode chars.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
@ -55,12 +55,12 @@ accepted only for compatibility with older code.
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@ FcCharSet *
@FUNC@ FcFreeTypeCharSetAndSpacing
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcBlanks * @ARG2@ blanks
@TYPE3@ int * @ARG3@ spacing
@PURPOSE@ compute Unicode coverage and spacing type
@RET@ FcCharSet *
@FUNC@ FcFreeTypeCharSetAndSpacing
@TYPE1@ FT_Face% @ARG1@ face
@TYPE2@ FcBlanks * @ARG2@ blanks
@TYPE3@ int * @ARG3@ spacing
@PURPOSE@ compute Unicode coverage and spacing type
@DESC@
Scans a FreeType face and returns the set of encoded Unicode chars.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
@ -69,19 +69,19 @@ accepted only for compatibility with older code.
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.
widths.
@@
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@ FcPattern *
@FUNC@ FcFreeTypeQuery
@TYPE1@ const FcChar8 * @ARG1@ file
@TYPE2@ int% @ARG2@ id
@TYPE3@ FcBlanks * @ARG3@ blanks
@TYPE4@ int * @ARG4@ count
@PURPOSE@ compute pattern from font file (and index)
@RET@ FcPattern *
@FUNC@ FcFreeTypeQuery
@TYPE1@ const FcChar8 * @ARG1@ file
@TYPE2@ int% @ARG2@ id
@TYPE3@ FcBlanks * @ARG3@ blanks
@TYPE4@ int * @ARG4@ count
@PURPOSE@ compute pattern from font file (and index)
@DESC@
Constructs a pattern representing the 'id'th face in 'file'. The number
of faces in 'file' is returned in 'count'.
@ -90,22 +90,22 @@ accepted only for compatibility with older code.
@@
unsigned int
FcFreeTypeQueryAll(const FcChar8 *file,
int id,
FcBlanks *blanks,
int *count,
FcFontSet *set)
FcFreeTypeQueryAll(const FcChar8 *file,
int id,
FcBlanks *blanks,
int *count,
FcFontSet *set)
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@ unsigned int
@FUNC@ FcFreeTypeQueryAll
@TYPE1@ const FcChar8 * @ARG1@ file
@TYPE2@ int% @ARG2@ id
@TYPE3@ FcBlanks * @ARG3@ blanks
@TYPE4@ int * @ARG4@ count
@TYPE5@ FcFontSet * @ARG5@ set
@PURPOSE@ compute all patterns from font file (and index)
@TYPE1@ const FcChar8 * @ARG1@ file
@TYPE2@ int% @ARG2@ id
@TYPE3@ FcBlanks * @ARG3@ blanks
@TYPE4@ int * @ARG4@ count
@TYPE5@ FcFontSet * @ARG5@ set
@PURPOSE@ compute all patterns from font file (and index)
@DESC@
Constructs patterns found in 'file'.
If id is -1, then all patterns found in 'file' are added to 'set'.
@ -114,19 +114,19 @@ The number of faces in 'file' is returned in 'count'.
The number of patterns added to 'set' is returned.
FcBlanks is deprecated, <parameter>blanks</parameter> is ignored and
accepted only for compatibility with older code.
@SINCE@ 2.12.91
@SINCE@ 2.12.91
@@
@SYNOPSIS@
#include &lt;fontconfig.h&gt;
#include &lt;fcfreetype.h&gt;
@RET@ FcPattern *
@RET@ FcPattern *
@FUNC@ FcFreeTypeQueryFace
@TYPE1@ const FT_Face% @ARG1@ face
@TYPE2@ const FcChar8 * @ARG2@ file
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcBlanks * @ARG4@ blanks
@PURPOSE@ compute pattern from FT_Face
@TYPE1@ const FT_Face% @ARG1@ face
@TYPE2@ const FcChar8 * @ARG2@ file
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcBlanks * @ARG4@ blanks
@PURPOSE@ compute pattern from FT_Face
@DESC@
Constructs a pattern representing 'face'. 'file' and 'id' are used solely as
data for pattern elements (FC_FILE, FC_INDEX and sometimes FC_FAMILY).

56
doc/fcinit.fncs
View File

@ -21,28 +21,28 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcConfig *
@FUNC@ FcInitLoadConfig
@TYPE1@ void
@PURPOSE@ load configuration
@RET@ FcConfig *
@FUNC@ FcInitLoadConfig
@TYPE1@ void
@PURPOSE@ load configuration
@DESC@
Loads the default configuration file and returns the resulting configuration.
Does not load any font information.
@@
@RET@ FcConfig *
@FUNC@ FcInitLoadConfigAndFonts
@TYPE1@ void
@PURPOSE@ load configuration and font data
@RET@ FcConfig *
@FUNC@ FcInitLoadConfigAndFonts
@TYPE1@ void
@PURPOSE@ load configuration and font data
@DESC@
Loads the default configuration file and builds information about the
available fonts. Returns the resulting configuration.
@@
@RET@ FcBool
@FUNC@ FcInit
@TYPE1@ void
@PURPOSE@ initialize fontconfig library
@RET@ FcBool
@FUNC@ FcInit
@TYPE1@ void
@PURPOSE@ initialize fontconfig library
@DESC@
Loads the default configuration file and the fonts referenced therein and
sets the default configuration to that result. Returns whether this
@ -50,10 +50,10 @@ process succeeded or not. If the default configuration has already
been loaded, this routine does nothing and returns FcTrue.
@@
@RET@ void
@FUNC@ FcFini
@TYPE1@ void
@PURPOSE@ finalize fontconfig library
@RET@ void
@FUNC@ FcFini
@TYPE1@ void
@PURPOSE@ finalize fontconfig library
@DESC@
Frees all data structures allocated by previous calls to fontconfig
functions. Fontconfig returns to an uninitialized state, requiring a
@ -61,18 +61,18 @@ new call to one of the FcInit functions before any other fontconfig
function may be called.
@@
@RET@ int
@FUNC@ FcGetVersion
@TYPE1@ void
@PURPOSE@ library version number
@RET@ int
@FUNC@ FcGetVersion
@TYPE1@ void
@PURPOSE@ library version number
@DESC@
Returns the version number of the library.
@@
@RET@ FcBool
@FUNC@ FcInitReinitialize
@TYPE1@ void
@PURPOSE@ re-initialize library
@RET@ FcBool
@FUNC@ FcInitReinitialize
@TYPE1@ void
@PURPOSE@ re-initialize library
@DESC@
Forces the default configuration file to be reloaded and resets the default
configuration. Returns FcFalse if the configuration cannot be reloaded (due
@ -80,10 +80,10 @@ to configuration file errors, allocation failures or other issues) and leaves th
existing configuration unchanged. Otherwise returns FcTrue.
@@
@RET@ FcBool
@FUNC@ FcInitBringUptoDate
@TYPE1@ void
@PURPOSE@ reload configuration files if needed
@RET@ FcBool
@FUNC@ FcInitBringUptoDate
@TYPE1@ void
@PURPOSE@ reload configuration files if needed
@DESC@
Checks the rescan interval in the default configuration, checking the
configuration if the interval has passed and reloading the configuration if

166
doc/fclangset.fncs
View File

@ -20,37 +20,37 @@
* OF THIS SOFTWARE.
*/
@RET@ FcLangSet *
@FUNC@ FcLangSetCreate
@TYPE1@ void
@PURPOSE@ create a langset object
@RET@ FcLangSet *
@FUNC@ FcLangSetCreate
@TYPE1@ void
@PURPOSE@ create a langset object
@DESC@
<function>FcLangSetCreate</function> creates a new FcLangSet object.
@@
@RET@ void
@FUNC@ FcLangSetDestroy
@TYPE1@ FcLangSet * @ARG1@ ls
@PURPOSE@ destroy a langset object
@RET@ void
@FUNC@ FcLangSetDestroy
@TYPE1@ FcLangSet * @ARG1@ ls
@PURPOSE@ destroy a langset object
@DESC@
<function>FcLangSetDestroy</function> destroys a FcLangSet object, freeing
all memory associated with it.
@@
@RET@ FcLangSet *
@FUNC@ FcLangSetCopy
@TYPE1@ const FcLangSet * @ARG1@ ls
@PURPOSE@ copy a langset object
@RET@ FcLangSet *
@FUNC@ FcLangSetCopy
@TYPE1@ const FcLangSet * @ARG1@ ls
@PURPOSE@ copy a langset object
@DESC@
<function>FcLangSetCopy</function> creates a new FcLangSet object and
populates it with the contents of <parameter>ls</parameter>.
@@
@RET@ FcBool
@FUNC@ FcLangSetAdd
@TYPE1@ FcLangSet * @ARG1@ ls
@TYPE2@ const FcChar8 * @ARG2@ lang
@PURPOSE@ add a language to a langset
@RET@ FcBool
@FUNC@ FcLangSetAdd
@TYPE1@ FcLangSet * @ARG1@ ls
@TYPE2@ const FcChar8 * @ARG2@ lang
@PURPOSE@ add a language to a langset
@DESC@
<parameter>lang</parameter> is added to <parameter>ls</parameter>.
<parameter>lang</parameter> should be of the form Ll-Tt where Ll is a
@ -58,44 +58,44 @@ two or three letter language from ISO 639 and Tt is a territory from ISO
3166.
@@
@RET@ FcBool
@FUNC@ FcLangSetDel
@TYPE1@ FcLangSet * @ARG1@ ls
@TYPE2@ const FcChar8 * @ARG2@ lang
@PURPOSE@ delete a language from a langset
@RET@ FcBool
@FUNC@ FcLangSetDel
@TYPE1@ FcLangSet * @ARG1@ ls
@TYPE2@ const FcChar8 * @ARG2@ lang
@PURPOSE@ delete a language from a langset
@DESC@
<parameter>lang</parameter> is removed from <parameter>ls</parameter>.
<parameter>lang</parameter> should be of the form Ll-Tt where Ll is a
two or three letter language from ISO 639 and Tt is a territory from ISO
3166.
@SINCE@ 2.9.0
@SINCE@ 2.9.0
@@
@RET@ FcLangSet *
@FUNC@ FcLangSetUnion
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ Add langsets
@RET@ FcLangSet *
@FUNC@ FcLangSetUnion
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ Add langsets
@DESC@
Returns a set including only those languages found in either <parameter>ls_a</parameter> or <parameter>ls_b</parameter>.
@SINCE@ 2.9.0
@SINCE@ 2.9.0
@@
@RET@ FcLangSet *
@FUNC@ FcLangSetSubtract
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ Subtract langsets
@RET@ FcLangSet *
@FUNC@ FcLangSetSubtract
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ Subtract langsets
@DESC@
Returns a set including only those languages found in <parameter>ls_a</parameter> but not in <parameter>ls_b</parameter>.
@SINCE@ 2.9.0
@SINCE@ 2.9.0
@@
@RET@ FcLangResult
@FUNC@ FcLangSetCompare
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ compare language sets
@RET@ FcLangResult
@FUNC@ FcLangSetCompare
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ compare language sets
@DESC@
<function>FcLangSetCompare</function> compares language coverage for
<parameter>ls_a</parameter> and <parameter>ls_b</parameter>. If they share
@ -105,11 +105,11 @@ function returns FcLangDifferentTerritory. If they share no languages in
common, this function returns FcLangDifferentLang.
@@
@RET@ FcBool
@FUNC@ FcLangSetContains
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ check langset subset relation
@RET@ FcBool
@FUNC@ FcLangSetContains
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ check langset subset relation
@DESC@
<function>FcLangSetContains</function> returns FcTrue if
<parameter>ls_a</parameter> contains every language in
@ -119,20 +119,20 @@ has exactly the language, or either the language or
<parameter>ls_a</parameter> has no territory.
@@
@RET@ FcBool
@FUNC@ FcLangSetEqual
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ test for matching langsets
@RET@ FcBool
@FUNC@ FcLangSetEqual
@TYPE1@ const FcLangSet * @ARG1@ ls_a
@TYPE2@ const FcLangSet * @ARG2@ ls_b
@PURPOSE@ test for matching langsets
@DESC@
Returns FcTrue if and only if <parameter>ls_a</parameter> supports precisely
the same language and territory combinations as <parameter>ls_b</parameter>.
@@
@RET@ FcChar32
@FUNC@ FcLangSetHash
@TYPE1@ const FcLangSet * @ARG1@ ls
@PURPOSE@ return a hash value for a langset
@RET@ FcChar32
@FUNC@ FcLangSetHash
@TYPE1@ const FcLangSet * @ARG1@ ls
@PURPOSE@ return a hash value for a langset
@DESC@
This function returns a value which depends solely on the languages
supported by <parameter>ls</parameter>. Any language which equals
@ -141,61 +141,61 @@ supported by <parameter>ls</parameter>. Any language which equals
value may not be equal.
@@
@RET@ FcLangResult
@FUNC@ FcLangSetHasLang
@TYPE1@ const FcLangSet * @ARG1@ ls
@TYPE2@ const FcChar8 * @ARG2@ lang
@PURPOSE@ test langset for language support
@RET@ FcLangResult
@FUNC@ FcLangSetHasLang
@TYPE1@ const FcLangSet * @ARG1@ ls
@TYPE2@ const FcChar8 * @ARG2@ lang
@PURPOSE@ test langset for language support
@DESC@
<function>FcLangSetHasLang</function> checks whether
<parameter>ls</parameter> supports <parameter>lang</parameter>. If
<parameter>ls</parameter> supports <parameter>lang</parameter>. If
<parameter>ls</parameter> has a matching language and territory pair,
this function returns FcLangEqual. If <parameter>ls</parameter> has
a matching language but differs in which territory that language is for, this
function returns FcLangDifferentTerritory. If <parameter>ls</parameter>
function returns FcLangDifferentTerritory. If <parameter>ls</parameter>
has no matching language, this function returns FcLangDifferentLang.
@@
@RET@ FcStrSet *
@FUNC@ FcGetDefaultLangs
@TYPE1@ void
@PURPOSE@ Get the default languages list
@RET@ FcStrSet *
@FUNC@ FcGetDefaultLangs
@TYPE1@ void
@PURPOSE@ Get the default languages list
@DESC@
Returns a string set of the default languages according to the environment variables on the system.
This function looks for them in order of FC_LANG, LC_ALL, LC_CTYPE and LANG then.
If there are no valid values in those environment variables, "en" will be set as fallback.
@SINCE@ 2.9.91
@SINCE@ 2.9.91
@@
@RET@ FcStrSet *
@FUNC@ FcLangSetGetLangs
@TYPE1@ const FcLangSet * @ARG1@ ls
@PURPOSE@ get the list of languages in the langset
@RET@ FcStrSet *
@FUNC@ FcLangSetGetLangs
@TYPE1@ const FcLangSet * @ARG1@ ls
@PURPOSE@ get the list of languages in the langset
@DESC@
Returns a string set of all languages in <parameter>langset</parameter>.
@@
@RET@ FcStrSet *
@FUNC@ FcGetLangs
@TYPE1@ void
@PURPOSE@ Get list of languages
@RET@ FcStrSet *
@FUNC@ FcGetLangs
@TYPE1@ void
@PURPOSE@ Get list of languages
@DESC@
Returns a string set of all known languages.
@@
@RET@ FcChar8 *
@FUNC@ FcLangNormalize
@TYPE1@ const FcChar8 * @ARG1@ lang
@PURPOSE@ Normalize the language string
@RET@ FcChar8 *
@FUNC@ FcLangNormalize
@TYPE1@ const FcChar8 * @ARG1@ lang
@PURPOSE@ Normalize the language string
@DESC@
Returns a string to make <parameter>lang</parameter> suitable on fontconfig.
@SINCE@ 2.10.91
@SINCE@ 2.10.91
@@
@RET@ const FcCharSet *
@FUNC@ FcLangGetCharSet
@TYPE1@ const FcChar8 * @ARG1@ lang
@PURPOSE@ Get character map for a language
@RET@ const FcCharSet *
@FUNC@ FcLangGetCharSet
@TYPE1@ const FcChar8 * @ARG1@ lang
@PURPOSE@ Get character map for a language
@DESC@
Returns the FcCharMap for a language.
@@

94
doc/fcmatrix.fncs
View File

@ -22,59 +22,59 @@
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ void
@FUNC@ FcMatrixInit
@PURPOSE@ initialize an FcMatrix structure
@TYPE1@ FcMatrix *
@ARG1@ matrix
@RET@ void
@FUNC@ FcMatrixInit
@PURPOSE@ initialize an FcMatrix structure
@TYPE1@ FcMatrix *
@ARG1@ matrix
@DESC@
<function>FcMatrixInit</function> initializes <parameter>matrix</parameter>
to the identity matrix.
@@
@FUNC@ FcMatrixCopy
@PURPOSE@ Copy a matrix
@TYPE1@ const FcMatrix *
@ARG1@ matrix
@FUNC@ FcMatrixCopy
@PURPOSE@ Copy a matrix
@TYPE1@ const FcMatrix *
@ARG1@ matrix
@DESC@
<function>FcMatrixCopy</function> allocates a new FcMatrix
and copies <parameter>mat</parameter> into it.
@@
@FUNC@ FcMatrixEqual
@PURPOSE@ Compare two matrices
@TYPE1@ const FcMatrix *
@ARG1@ matrix1
@TYPE2@ const FcMatrix *
@ARG2@ matrix2
@FUNC@ FcMatrixEqual
@PURPOSE@ Compare two matrices
@TYPE1@ const FcMatrix *
@ARG1@ matrix1
@TYPE2@ const FcMatrix *
@ARG2@ matrix2
@DESC@
<function>FcMatrixEqual</function> compares <parameter>matrix1</parameter>
and <parameter>matrix2</parameter> returning FcTrue when they are equal and
FcFalse when they are not.
@@
@FUNC@ FcMatrixMultiply
@PURPOSE@ Multiply matrices
@TYPE1@ FcMatrix *
@ARG1@ result
@TYPE2@ const FcMatrix *
@ARG2@ matrix1
@TYPE3@ const FcMatrix *
@ARG3@ matrix2
@FUNC@ FcMatrixMultiply
@PURPOSE@ Multiply matrices
@TYPE1@ FcMatrix *
@ARG1@ result
@TYPE2@ const FcMatrix *
@ARG2@ matrix1
@TYPE3@ const FcMatrix *
@ARG3@ matrix2
@DESC@
<function>FcMatrixMultiply</function> multiplies
<parameter>matrix1</parameter> and <parameter>matrix2</parameter> storing
the result in <parameter>result</parameter>.
@@
@FUNC@ FcMatrixRotate
@PURPOSE@ Rotate a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double%
@ARG2@ cos
@TYPE3@ double%
@ARG3@ sin
@FUNC@ FcMatrixRotate
@PURPOSE@ Rotate a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double%
@ARG2@ cos
@TYPE3@ double%
@ARG3@ sin
@DESC@
<function>FcMatrixRotate</function> rotates <parameter>matrix</parameter>
by the angle who's sine is <parameter>sin</parameter> and cosine is
@ -86,14 +86,14 @@ matrix:
</programlisting>
@@
@FUNC@ FcMatrixScale
@PURPOSE@ Scale a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double%
@ARG2@ sx
@TYPE3@ double%
@ARG3@ dy
@FUNC@ FcMatrixScale
@PURPOSE@ Scale a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double%
@ARG2@ sx
@TYPE3@ double%
@ARG3@ dy
@DESC@
<function>FcMatrixScale</function> multiplies <parameter>matrix</parameter>
x values by <parameter>sx</parameter> and y values by
@ -105,14 +105,14 @@ the matrix:
</programlisting>
@@
@FUNC@ FcMatrixShear
@PURPOSE@ Shear a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double%
@ARG2@ sh
@TYPE3@ double%
@ARG3@ sv
@FUNC@ FcMatrixShear
@PURPOSE@ Shear a matrix
@TYPE1@ FcMatrix *
@ARG1@ matrix
@TYPE2@ double%
@ARG2@ sh
@TYPE3@ double%
@ARG3@ sv
@DESC@
<function>FcMatrixShare</function> shears <parameter>matrix</parameter>
horizontally by <parameter>sh</parameter> and vertically by

54
doc/fcobjectset.fncs
View File

@ -21,51 +21,51 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcObjectSet *
@FUNC@ FcObjectSetCreate
@TYPE1@ void
@PURPOSE@ Create an object set
@RET@ FcObjectSet *
@FUNC@ FcObjectSetCreate
@TYPE1@ void
@PURPOSE@ Create an object set
@DESC@
Creates an empty set.
@@
@RET@ FcBool
@FUNC@ FcObjectSetAdd
@TYPE1@ FcObjectSet * @ARG1@ os
@TYPE2@ const char * @ARG2@ object
@PURPOSE@ Add to an object set
@RET@ FcBool
@FUNC@ FcObjectSetAdd
@TYPE1@ FcObjectSet * @ARG1@ os
@TYPE2@ const char * @ARG2@ object
@PURPOSE@ Add to an object set
@DESC@
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.
@@
@RET@ void
@FUNC@ FcObjectSetDestroy
@TYPE1@ FcObjectSet * @ARG1@ os
@PURPOSE@ Destroy an object set
@RET@ void
@FUNC@ FcObjectSetDestroy
@TYPE1@ FcObjectSet * @ARG1@ os
@PURPOSE@ Destroy an object set
@DESC@
Destroys an object set.
@@
@RET@ FcObjectSet *
@FUNC@ FcObjectSetBuild
@TYPE1@ const char * @ARG1@ first
@TYPE2@ ...
@RET@ FcObjectSet *
@FUNC@ FcObjectSetBuild
@TYPE1@ const char * @ARG1@ first
@TYPE2@ ...
@PROTOTYPE+@
@RET+@ FcObjectSet *
@FUNC+@ FcObjectSetVaBuild
@TYPE1+@ const char * @ARG1+@ first
@TYPE2+@ va_list% @ARG2+@ va
@RET+@ FcObjectSet *
@FUNC+@ FcObjectSetVaBuild
@TYPE1+@ const char * @ARG1+@ first
@TYPE2+@ va_list% @ARG2+@ va
@PROTOTYPE++@
@RET++@ void
@FUNC++@ FcObjectSetVapBuild
@TYPE1++@ FcObjectSet * @ARG1++@ result
@TYPE2++@ const char * @ARG2++@ first
@TYPE3++@ va_list% @ARG3++@ va
@RET++@ void
@FUNC++@ FcObjectSetVapBuild
@TYPE1++@ FcObjectSet * @ARG1++@ result
@TYPE2++@ const char * @ARG2++@ first
@TYPE3++@ va_list% @ARG3++@ va
@PURPOSE@ Build object set from args
@PURPOSE@ Build object set from args
@DESC@
These build an object set from a null-terminated list of property names.
FcObjectSetVapBuild is a macro version of FcObjectSetVaBuild which returns

28
doc/fcobjecttype.fncs
View File

@ -21,28 +21,28 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcBool
@FUNC@ FcNameRegisterObjectTypes
@TYPE1@ const FcObjectType * @ARG1@ types
@TYPE2@ int% @ARG2@ ntype
@PURPOSE@ Register object types
@RET@ FcBool
@FUNC@ FcNameRegisterObjectTypes
@TYPE1@ const FcObjectType * @ARG1@ types
@TYPE2@ int% @ARG2@ ntype
@PURPOSE@ Register object types
@DESC@
Deprecated. Does nothing. Returns FcFalse.
@@
@RET@ FcBool
@FUNC@ FcNameUnregisterObjectTypes
@TYPE1@ const FcObjectType * @ARG1@ types
@TYPE2@ int% @ARG2@ ntype
@PURPOSE@ Unregister object types
@RET@ FcBool
@FUNC@ FcNameUnregisterObjectTypes
@TYPE1@ const FcObjectType * @ARG1@ types
@TYPE2@ int% @ARG2@ ntype
@PURPOSE@ Unregister object types
@DESC@
Deprecated. Does nothing. Returns FcFalse.
@@
@RET@ const FcObjectType *
@FUNC@ FcNameGetObjectType
@TYPE1@ const char * @ARG1@ object
@PURPOSE@ Lookup an object type
@RET@ const FcObjectType *
@FUNC@ FcNameGetObjectType
@TYPE1@ const char * @ARG1@ object
@PURPOSE@ Lookup an object type
@DESC@
Return the object type for the pattern element named <parameter>object</parameter>.
@@

542
doc/fcpattern.fncs
View File

@ -21,76 +21,76 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcPattern *
@FUNC@ FcPatternCreate
@TYPE1@ void
@PURPOSE@ Create a pattern
@RET@ FcPattern *
@FUNC@ FcPatternCreate
@TYPE1@ void
@PURPOSE@ Create a pattern
@DESC@
Creates a pattern with no properties; used to build patterns from scratch.
@@
@RET@ FcPattern *
@FUNC@ FcPatternDuplicate
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Copy a pattern
@RET@ FcPattern *
@FUNC@ FcPatternDuplicate
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Copy a pattern
@DESC@
Copy a pattern, returning a new pattern that matches
<parameter>p</parameter>. Each pattern may be modified without affecting the
other.
@@
@RET@ void
@FUNC@ FcPatternReference
@TYPE1@ FcPattern * @ARG1@ p
@PURPOSE@ Increment pattern reference count
@RET@ void
@FUNC@ FcPatternReference
@TYPE1@ FcPattern * @ARG1@ p
@PURPOSE@ Increment pattern reference count
@DESC@
Add another reference to <parameter>p</parameter>. Patterns are freed only
when the reference count reaches zero.
@@
@RET@ void
@FUNC@ FcPatternDestroy
@TYPE1@ FcPattern * @ARG1@ p
@PURPOSE@ Destroy a pattern
@RET@ void
@FUNC@ FcPatternDestroy
@TYPE1@ FcPattern * @ARG1@ p
@PURPOSE@ Destroy a pattern
@DESC@
Decrement the pattern reference count. If all references are gone, destroys
the pattern, in the process destroying all related values.
@@
@RET@ int
@FUNC@ FcPatternObjectCount
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Returns the number of the object
@RET@ int
@FUNC@ FcPatternObjectCount
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Returns the number of the object
@DESC@
Returns the number of the object <parameter>p</parameter> has.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ FcBool
@FUNC@ FcPatternEqual
@TYPE1@ const FcPattern * @ARG1@ pa
@TYPE2@ const FcPattern * @ARG2@ pb
@PURPOSE@ Compare patterns
@RET@ FcBool
@FUNC@ FcPatternEqual
@TYPE1@ const FcPattern * @ARG1@ pa
@TYPE2@ const FcPattern * @ARG2@ pb
@PURPOSE@ Compare patterns
@DESC@
Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
@@
@RET@ FcBool
@FUNC@ FcPatternEqualSubset
@TYPE1@ const FcPattern * @ARG1@ pa
@TYPE2@ const FcPattern * @ARG2@ pb
@TYPE3@ const FcObjectSet * @ARG3@ os
@PURPOSE@ Compare portions of patterns
@RET@ FcBool
@FUNC@ FcPatternEqualSubset
@TYPE1@ const FcPattern * @ARG1@ pa
@TYPE2@ const FcPattern * @ARG2@ pb
@TYPE3@ const FcObjectSet * @ARG3@ os
@PURPOSE@ Compare portions of patterns
@DESC@
Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
objects in <parameter>os</parameter>.
@@
@RET@ FcPattern *
@FUNC@ FcPatternFilter
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const FcObjectSet * @ARG2@ os
@PURPOSE@ Filter the objects of pattern
@RET@ FcPattern *
@FUNC@ FcPatternFilter
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const FcObjectSet * @ARG2@ os
@PURPOSE@ Filter the objects of pattern
@DESC@
Returns a new pattern that only has those objects from
<parameter>p</parameter> that are in <parameter>os</parameter>.
@ -98,22 +98,22 @@ If <parameter>os</parameter> is NULL, a duplicate of
<parameter>p</parameter> is returned.
@@
@RET@ FcChar32
@FUNC@ FcPatternHash
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Compute a pattern hash value
@RET@ FcChar32
@FUNC@ FcPatternHash
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Compute a pattern hash value
@DESC@
Returns a 32-bit number which is the same for any two patterns which are
equal.
@@
@RET@ FcBool
@FUNC@ FcPatternAdd
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ FcValue% @ARG3@ value
@TYPE4@ FcBool% @ARG4@ append
@PURPOSE@ Add a value to a pattern
@RET@ FcBool
@FUNC@ FcPatternAdd
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ FcValue% @ARG3@ value
@TYPE4@ FcBool% @ARG4@ append
@PURPOSE@ Add a value to a pattern
@DESC@
Adds a single value to the list of values associated with the property named
`object<parameter>. If `append</parameter> is FcTrue, the value is added at the end of any
@ -122,82 +122,82 @@ existing list, otherwise it is inserted at the beginning. `value' is saved
retains no reference to any application-supplied data structure.
@@
@RET@ FcBool
@FUNC@ FcPatternAddWeak
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ FcValue% @ARG3@ value
@TYPE4@ FcBool% @ARG4@ append
@PURPOSE@ Add a value to a pattern with weak binding
@RET@ FcBool
@FUNC@ FcPatternAddWeak
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ FcValue% @ARG3@ value
@TYPE4@ FcBool% @ARG4@ append
@PURPOSE@ Add a value to a pattern with weak binding
@DESC@
FcPatternAddWeak is essentially the same as FcPatternAdd except that any
values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
@@
@TITLE@ FcPatternAdd-Type
@RET@ FcBool
@FUNC@ FcPatternAddInteger
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ i
@TITLE@ FcPatternAdd-Type
@RET@ FcBool
@FUNC@ FcPatternAddInteger
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ i
@PROTOTYPE+@
@RET+@ FcBool
@FUNC+@ FcPatternAddDouble
@TYPE1+@ FcPattern * @ARG1+@ p
@TYPE2+@ const char * @ARG2+@ object
@TYPE3+@ double% @ARG3+@ d
@RET+@ FcBool
@FUNC+@ FcPatternAddDouble
@TYPE1+@ FcPattern * @ARG1+@ p
@TYPE2+@ const char * @ARG2+@ object
@TYPE3+@ double% @ARG3+@ d
@PROTOTYPE++@
@RET++@ FcBool
@FUNC++@ FcPatternAddString
@TYPE1++@ FcPattern * @ARG1++@ p
@TYPE2++@ const char * @ARG2++@ object
@TYPE3++@ const FcChar8 * @ARG3++@ s
@RET++@ FcBool
@FUNC++@ FcPatternAddString
@TYPE1++@ FcPattern * @ARG1++@ p
@TYPE2++@ const char * @ARG2++@ object
@TYPE3++@ const FcChar8 * @ARG3++@ s
@PROTOTYPE+++@
@RET+++@ FcBool
@FUNC+++@ FcPatternAddMatrix
@TYPE1+++@ FcPattern * @ARG1+++@ p
@TYPE2+++@ const char * @ARG2+++@ object
@TYPE3+++@ const FcMatrix * @ARG3+++@ m
@RET+++@ FcBool
@FUNC+++@ FcPatternAddMatrix
@TYPE1+++@ FcPattern * @ARG1+++@ p
@TYPE2+++@ const char * @ARG2+++@ object
@TYPE3+++@ const FcMatrix * @ARG3+++@ m
@PROTOTYPE++++@
@RET++++@ FcBool
@FUNC++++@ FcPatternAddCharSet
@TYPE1++++@ FcPattern * @ARG1++++@ p
@TYPE2++++@ const char * @ARG2++++@ object
@TYPE3++++@ const FcCharSet * @ARG3++++@ c
@RET++++@ FcBool
@FUNC++++@ FcPatternAddCharSet
@TYPE1++++@ FcPattern * @ARG1++++@ p
@TYPE2++++@ const char * @ARG2++++@ object
@TYPE3++++@ const FcCharSet * @ARG3++++@ c
@PROTOTYPE+++++@
@RET+++++@ FcBool
@FUNC+++++@ FcPatternAddBool
@TYPE1+++++@ FcPattern * @ARG1+++++@ p
@TYPE2+++++@ const char * @ARG2+++++@ object
@TYPE3+++++@ FcBool% @ARG3+++++@ b
@RET+++++@ FcBool
@FUNC+++++@ FcPatternAddBool
@TYPE1+++++@ FcPattern * @ARG1+++++@ p
@TYPE2+++++@ const char * @ARG2+++++@ object
@TYPE3+++++@ FcBool% @ARG3+++++@ b
@PROTOTYPE++++++@
@RET++++++@ FcBool
@FUNC++++++@ FcPatternAddFTFace
@TYPE1++++++@ FcPattern * @ARG1++++++@ p
@TYPE2++++++@ const char * @ARG2++++++@ object
@TYPE3++++++@ const FT_Face @ARG3++++++@ f
@RET++++++@ FcBool
@FUNC++++++@ FcPatternAddFTFace
@TYPE1++++++@ FcPattern * @ARG1++++++@ p
@TYPE2++++++@ const char * @ARG2++++++@ object
@TYPE3++++++@ const FT_Face @ARG3++++++@ f
@PROTOTYPE+++++++@
@RET+++++++@ FcBool
@FUNC+++++++@ FcPatternAddLangSet
@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p
@TYPE2+++++++@ const char * @ARG2+++++++@ object
@TYPE3+++++++@ const FcLangSet * @ARG3+++++++@ l
@RET+++++++@ FcBool
@FUNC+++++++@ FcPatternAddLangSet
@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p
@TYPE2+++++++@ const char * @ARG2+++++++@ object
@TYPE3+++++++@ const FcLangSet * @ARG3+++++++@ l
@PROTOTYPE++++++++@
@RET++++++++@ FcBool
@FUNC++++++++@ FcPatternAddRange
@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p
@TYPE2++++++++@ const char * @ARG2++++++++@ object
@TYPE3++++++++@ const FcRange * @ARG3++++++++@ r
@RET++++++++@ FcBool
@FUNC++++++++@ FcPatternAddRange
@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p
@TYPE2++++++++@ const char * @ARG2++++++++@ object
@TYPE3++++++++@ const FcRange * @ARG3++++++++@ r
@PURPOSE@ Add a typed value to a pattern
@PURPOSE@ Add a typed value to a pattern
@DESC@
These are all convenience functions that insert objects of the specified
type into the pattern. Use these in preference to FcPatternAdd as they
@ -207,30 +207,30 @@ any existing list of values.
<function>FcPatternAddRange</function> are available since 2.11.91.
@@
@RET@ FcResult
@FUNC@ FcPatternGetWithBinding
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@TYPE5@ FcValueBinding * @ARG5@ b
@PURPOSE@ Return a value with binding from a pattern
@RET@ FcResult
@FUNC@ FcPatternGetWithBinding
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@TYPE5@ FcValueBinding * @ARG5@ b
@PURPOSE@ Return a value with binding from a pattern
@DESC@
Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
and <parameter>b</parameter> binding for that associated with the property
<parameter>object</parameter>.
The Value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value.
@SINCE@ 2.12.5
@SINCE@ 2.12.5
@@
@RET@ FcResult
@FUNC@ FcPatternGet
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@PURPOSE@ Return a value from a pattern
@RET@ FcResult
@FUNC@ FcPatternGet
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@PURPOSE@ Return a value from a pattern
@DESC@
Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
associated with the property <parameter>object</parameter>.
@ -238,80 +238,80 @@ The value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value.
@@
@TITLE@ FcPatternGet-Type
@TITLE@ FcPatternGet-Type
@PROTOTYPE@
@RET@ FcResult
@FUNC@ FcPatternGetInteger
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ n
@TYPE4@ int * @ARG4@ i
@RET@ FcResult
@FUNC@ FcPatternGetInteger
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ n
@TYPE4@ int * @ARG4@ i
@PROTOTYPE+@
@RET+@ FcResult
@FUNC+@ FcPatternGetDouble
@TYPE1+@ FcPattern * @ARG1+@ p
@TYPE2+@ const char * @ARG2+@ object
@TYPE3+@ int% @ARG3+@ n
@TYPE4+@ double * @ARG4+@ d
@RET+@ FcResult
@FUNC+@ FcPatternGetDouble
@TYPE1+@ FcPattern * @ARG1+@ p
@TYPE2+@ const char * @ARG2+@ object
@TYPE3+@ int% @ARG3+@ n
@TYPE4+@ double * @ARG4+@ d
@PROTOTYPE++@
@RET++@ FcResult
@FUNC++@ FcPatternGetString
@TYPE1++@ FcPattern * @ARG1++@ p
@TYPE2++@ const char * @ARG2++@ object
@TYPE3++@ int% @ARG3++@ n
@TYPE4++@ FcChar8 ** @ARG4++@ s
@RET++@ FcResult
@FUNC++@ FcPatternGetString
@TYPE1++@ FcPattern * @ARG1++@ p
@TYPE2++@ const char * @ARG2++@ object
@TYPE3++@ int% @ARG3++@ n
@TYPE4++@ FcChar8 ** @ARG4++@ s
@PROTOTYPE+++@
@RET+++@ FcResult
@FUNC+++@ FcPatternGetMatrix
@TYPE1+++@ FcPattern * @ARG1+++@ p
@TYPE2+++@ const char * @ARG2+++@ object
@TYPE3+++@ int% @ARG3+++@ n
@TYPE4+++@ FcMatrix ** @ARG4+++@ s
@RET+++@ FcResult
@FUNC+++@ FcPatternGetMatrix
@TYPE1+++@ FcPattern * @ARG1+++@ p
@TYPE2+++@ const char * @ARG2+++@ object
@TYPE3+++@ int% @ARG3+++@ n
@TYPE4+++@ FcMatrix ** @ARG4+++@ s
@PROTOTYPE++++@
@RET++++@ FcResult
@FUNC++++@ FcPatternGetCharSet
@TYPE1++++@ FcPattern * @ARG1++++@ p
@TYPE2++++@ const char * @ARG2++++@ object
@TYPE3++++@ int% @ARG3++++@ n
@TYPE4++++@ FcCharSet ** @ARG4++++@ c
@RET++++@ FcResult
@FUNC++++@ FcPatternGetCharSet
@TYPE1++++@ FcPattern * @ARG1++++@ p
@TYPE2++++@ const char * @ARG2++++@ object
@TYPE3++++@ int% @ARG3++++@ n
@TYPE4++++@ FcCharSet ** @ARG4++++@ c
@PROTOTYPE+++++@
@RET+++++@ FcResult
@FUNC+++++@ FcPatternGetBool
@TYPE1+++++@ FcPattern * @ARG1+++++@ p
@TYPE2+++++@ const char * @ARG2+++++@ object
@TYPE3+++++@ int% @ARG3+++++@ n
@TYPE4+++++@ FcBool * @ARG4+++++@ b
@RET+++++@ FcResult
@FUNC+++++@ FcPatternGetBool
@TYPE1+++++@ FcPattern * @ARG1+++++@ p
@TYPE2+++++@ const char * @ARG2+++++@ object
@TYPE3+++++@ int% @ARG3+++++@ n
@TYPE4+++++@ FcBool * @ARG4+++++@ b
@PROTOTYPE++++++@
@RET++++++@ FcResult
@FUNC++++++@ FcPatternGetFTFace
@TYPE1++++++@ FcPattern * @ARG1++++++@ p
@TYPE2++++++@ const char * @ARG2++++++@ object
@TYPE3++++++@ int% @ARG3++++++@ n
@TYPE4++++++@ FT_Face * @ARG4++++++@ f
@RET++++++@ FcResult
@FUNC++++++@ FcPatternGetFTFace
@TYPE1++++++@ FcPattern * @ARG1++++++@ p
@TYPE2++++++@ const char * @ARG2++++++@ object
@TYPE3++++++@ int% @ARG3++++++@ n
@TYPE4++++++@ FT_Face * @ARG4++++++@ f
@PROTOTYPE+++++++@
@RET+++++++@ FcResult
@FUNC+++++++@ FcPatternGetLangSet
@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p
@TYPE2+++++++@ const char * @ARG2+++++++@ object
@TYPE3+++++++@ int% @ARG3+++++++@ n
@TYPE4+++++++@ FcLangSet ** @ARG4+++++++@ l
@RET+++++++@ FcResult
@FUNC+++++++@ FcPatternGetLangSet
@TYPE1+++++++@ FcPattern * @ARG1+++++++@ p
@TYPE2+++++++@ const char * @ARG2+++++++@ object
@TYPE3+++++++@ int% @ARG3+++++++@ n
@TYPE4+++++++@ FcLangSet ** @ARG4+++++++@ l
@PROTOTYPE++++++++@
@RET++++++++@ FcResult
@FUNC++++++++@ FcPatternGetRange
@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p
@TYPE2++++++++@ const char * @ARG2++++++++@ object
@TYPE3++++++++@ int% @ARG3++++++++@ n
@TYPE4++++++++@ FcRange ** @ARG4++++++++@ r
@RET++++++++@ FcResult
@FUNC++++++++@ FcPatternGetRange
@TYPE1++++++++@ FcPattern * @ARG1++++++++@ p
@TYPE2++++++++@ const char * @ARG2++++++++@ object
@TYPE3++++++++@ int% @ARG3++++++++@ n
@TYPE4++++++++@ FcRange ** @ARG4++++++++@ r
@PURPOSE@ Return a typed value from a pattern
@PURPOSE@ Return a typed value from a pattern
@DESC@
These are convenience functions that call FcPatternGet and verify that the
returned data is of the expected type. They return FcResultTypeMismatch if
@ -322,25 +322,25 @@ in preference to FcPatternGet to provide compile-time typechecking.
<function>FcPatternGetRange</function> are available since 2.11.91.
@@
@RET@ FcPattern *
@FUNC@ FcPatternBuild
@TYPE1@ FcPattern * @ARG1@ pattern
@TYPE2@ ...
@RET@ FcPattern *
@FUNC@ FcPatternBuild
@TYPE1@ FcPattern * @ARG1@ pattern
@TYPE2@ ...
@PROTOTYPE+@
@RET+@ FcPattern *
@FUNC+@ FcPatternVaBuild
@TYPE1+@ FcPattern * @ARG1+@ pattern
@TYPE2+@ va_list% @ARG2+@ va
@RET+@ FcPattern *
@FUNC+@ FcPatternVaBuild
@TYPE1+@ FcPattern * @ARG1+@ pattern
@TYPE2+@ va_list% @ARG2+@ va
@PROTOTYPE++@
@RET++@ void
@FUNC++@ FcPatternVapBuild
@TYPE1++@ FcPattern * @ARG1++@ result
@TYPE2++@ FcPattern * @ARG2++@ pattern
@TYPE3++@ va_list% @ARG3++@ va
@RET++@ void
@FUNC++@ FcPatternVapBuild
@TYPE1++@ FcPattern * @ARG1++@ result
@TYPE2++@ FcPattern * @ARG2++@ pattern
@TYPE3++@ va_list% @ARG3++@ va
@PURPOSE@ Create patterns from arguments
@PURPOSE@ Create patterns from arguments
@DESC@
Builds a pattern using a list of objects, types and values. Each
value to be entered in the pattern is specified with three arguments:
@ -372,141 +372,141 @@ which returns its result directly in the <parameter>result</parameter>
variable.
@@
@RET@ FcBool
@FUNC@ FcPatternDel
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@PURPOSE@ Delete a property from a pattern
@RET@ FcBool
@FUNC@ FcPatternDel
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@PURPOSE@ Delete a property from a pattern
@DESC@
Deletes all values associated with the property `object', returning
Deletes all values associated with the property `object', returning
whether the property existed or not.
@@
@RET@ FcBool
@FUNC@ FcPatternRemove
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ id
@PURPOSE@ Remove one object of the specified type from the pattern
@RET@ FcBool
@FUNC@ FcPatternRemove
@TYPE1@ FcPattern * @ARG1@ p
@TYPE2@ const char * @ARG2@ object
@TYPE3@ int% @ARG3@ id
@PURPOSE@ Remove one object of the specified type from the pattern
@DESC@
Removes the value associated with the property `object' at position `id', returning
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.
@@
@RET@ void
@FUNC@ FcPatternIterStart
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPOSE@ Initialize the iterator with the first iterator in the pattern
@RET@ void
@FUNC@ FcPatternIterStart
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPOSE@ Initialize the iterator with the first iterator in the pattern
@DESC@
Initialize <parameter>iter</parameter> with the first iterator in <parameter>p</parameter>.
If there are no objects in <parameter>p</parameter>, <parameter>iter</parameter>
will not have any valid data.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ FcBool
@FUNC@ FcPatternIterNext
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPUSE@ Set the iterator to point to the next object in the pattern
@RET@ FcBool
@FUNC@ FcPatternIterNext
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPUSE@ Set the iterator to point to the next object in the pattern
@DESC@
Set <parameter>iter</parameter> to point to the next object in <parameter>p</parameter>
and returns FcTrue if <parameter>iter</parameter> has been changed to the next object.
returns FcFalse otherwise.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ FcBool
@FUNC@ FcPatternIterEqual
@TYPE1@ const FcPattern * @ARG1@ p1
@TYPE2@ FcPatternIter * @ARG2@ i1
@TYPE3@ const FcPattern * @ARG3@ p2
@TYPE4@ FcPatternIter * @ARG4@ i2
@PURPOSE@ Compare iterators
@RET@ FcBool
@FUNC@ FcPatternIterEqual
@TYPE1@ const FcPattern * @ARG1@ p1
@TYPE2@ FcPatternIter * @ARG2@ i1
@TYPE3@ const FcPattern * @ARG3@ p2
@TYPE4@ FcPatternIter * @ARG4@ i2
@PURPOSE@ Compare iterators
@DESC@
Return FcTrue if both <parameter>i1</parameter> and <parameter>i2</parameter>
point to same object and contains same values. return FcFalse otherwise.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ FcBool
@FUNC@ FcPatternFindIter
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@TYPE3@ const char * @ARG3@ object
@PURPOSE@ Set the iterator to point to the object in the pattern
@RET@ FcBool
@FUNC@ FcPatternFindIter
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@TYPE3@ const char * @ARG3@ object
@PURPOSE@ Set the iterator to point to the object in the pattern
@DESC@
Set <parameter>iter</parameter> to point to <parameter>object</parameter> in
<parameter>p</parameter> if any and returns FcTrue. returns FcFalse otherwise.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ FcBool
@FUNC@ FcPatternIterIsValid
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter : @ARG2@ iter
@PURPOSE@ Check whether the iterator is valid or not
@RET@ FcBool
@FUNC@ FcPatternIterIsValid
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter : @ARG2@ iter
@PURPOSE@ Check whether the iterator is valid or not
@DESC@
Returns FcTrue if <parameter>iter</parameter> point to the valid entry
in <parameter>p</parameter>. returns FcFalse otherwise.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ const char *
@FUNC@ FcPatternIterGetObject
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPOSE@ Returns an object name which the iterator point to
@RET@ const char *
@FUNC@ FcPatternIterGetObject
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPOSE@ Returns an object name which the iterator point to
@DESC@
Returns an object name in <parameter>p</parameter> which
<parameter>iter</parameter> point to. returns NULL if
<parameter>iter</parameter> isn't valid.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ int
@FUNC@ FcPatternIterValueCount
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPOSE@ Returns the number of the values which the iterator point to
@RET@ int
@FUNC@ FcPatternIterValueCount
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@PURPOSE@ Returns the number of the values which the iterator point to
@DESC@
Returns the number of the values in the object which <parameter>iter</parameter>
point to. if <parameter>iter</parameter> isn't valid, returns 0.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ FcResult
@FUNC@ FcPatternIterGetValue
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@TYPE3@ int @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@TYPE5@ FcValueBinding * @ARG5@ b
@PURPOSE@ Returns a value which the iterator point to
@RET@ FcResult
@FUNC@ FcPatternIterGetValue
@TYPE1@ const FcPattern * @ARG1@ p
@TYPE2@ FcPatternIter * @ARG2@ iter
@TYPE3@ int @ARG3@ id
@TYPE4@ FcValue * @ARG4@ v
@TYPE5@ FcValueBinding * @ARG5@ b
@PURPOSE@ Returns a value which the iterator point to
@DESC@
Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
which <parameter>iter</parameter> point to. also binding to <parameter>b</parameter>
if given.
The value returned is not a copy, but rather refers to the data stored
within the pattern directly. Applications must not free this value.
@SINCE@ 2.13.1
@SINCE@ 2.13.1
@@
@RET@ void
@FUNC@ FcPatternPrint
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Print a pattern for debugging
@RET@ void
@FUNC@ FcPatternPrint
@TYPE1@ const FcPattern * @ARG1@ p
@PURPOSE@ Print a pattern for debugging
@DESC@
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.
@@
@RET@ void
@FUNC@ FcDefaultSubstitute
@TYPE1@ FcPattern * @ARG1@ pattern
@PURPOSE@ Perform default substitutions in a pattern
@RET@ void
@FUNC@ FcDefaultSubstitute
@TYPE1@ FcPattern * @ARG1@ pattern
@PURPOSE@ Perform default substitutions in a pattern
@DESC@
Supplies default values for underspecified font patterns:
<itemizedlist>
@ -523,18 +523,18 @@ specified point size (default 12), dpi (default 75) and scale (default 1).
</itemizedlist>
@@
@RET@ FcPattern *
@FUNC@ FcNameParse
@TYPE1@ const FcChar8 * @ARG1@ name
@PURPOSE@ Parse a pattern string
@RET@ FcPattern *
@FUNC@ FcNameParse
@TYPE1@ const FcChar8 * @ARG1@ name
@PURPOSE@ Parse a pattern string
@DESC@
Converts <parameter>name</parameter> from the standard text format described above into a pattern.
@@
@RET@ FcChar8 *
@FUNC@ FcNameUnparse
@TYPE1@ FcPattern * @ARG1@ pat
@PURPOSE@ Convert a pattern back into a string that can be parsed
@RET@ FcChar8 *
@FUNC@ FcNameUnparse
@TYPE1@ FcPattern * @ARG1@ pat
@PURPOSE@ Convert a pattern back into a string that can be parsed
@DESC@
Converts the given pattern into the standard text format described above.
The return value is not static, but instead refers to newly allocated memory

58
doc/fcrange.fncs
View File

@ -21,55 +21,55 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ FcRange *
@FUNC@ FcRangeCopy
@TYPE1@ const FcRange * @ARG1@ range
@PURPOSE@ Copy a range object
@RET@ FcRange *
@FUNC@ FcRangeCopy
@TYPE1@ const FcRange * @ARG1@ range
@PURPOSE@ Copy a range object
@DESC@
<function>FcRangeCopy</function> creates a new FcRange object and
populates it with the contents of <parameter>range</parameter>.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@
@RET@ FcRange *
@FUNC@ FcRangeCreateDouble
@TYPE1@ double @ARG1@ begin
@TYPE2@ double @ARG2@ end
@PURPOSE@ create a range object for double
@RET@ FcRange *
@FUNC@ FcRangeCreateDouble
@TYPE1@ double @ARG1@ begin
@TYPE2@ double @ARG2@ end
@PURPOSE@ create a range object for double
@DESC@
<function>FcRangeCreateDouble</function> creates a new FcRange object with
double sized value.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@
@RET@ FcRange *
@FUNC@ FcRangeCreateInteger
@TYPE1@ int @ARG1@ begin
@TYPE2@ int @ARG2@ end
@PURPOSE@ create a range object for integer
@RET@ FcRange *
@FUNC@ FcRangeCreateInteger
@TYPE1@ int @ARG1@ begin
@TYPE2@ int @ARG2@ end
@PURPOSE@ create a range object for integer
@DESC@
<function>FcRangeCreateInteger</function> creates a new FcRange object with
integer sized value.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@
@RET@ void
@FUNC@ FcRangeDestroy
@TYPE1@ FcRange * @ARG1@ range
@PURPOSE@ destroy a range object
@RET@ void
@FUNC@ FcRangeDestroy
@TYPE1@ FcRange * @ARG1@ range
@PURPOSE@ destroy a range object
@DESC@
<function>FcRangeDestroy</function> destroys a FcRange object, freeing
all memory associated with it.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@
@RET@ FcBool
@FUNC@ FcRangeGetDouble
@TYPE1@ const FcRange * @ARG1@ range
@TYPE2@ double * @ARG2@ begin
@TYPE3@ double * @ARG3@ end
@PURPOSE@ Get the range in double
@RET@ FcBool
@FUNC@ FcRangeGetDouble
@TYPE1@ const FcRange * @ARG1@ range
@TYPE2@ double * @ARG2@ begin
@TYPE3@ double * @ARG3@ end
@PURPOSE@ Get the range in double
@DESC@
Returns in <parameter>begin</parameter> and <parameter>end</parameter> as the range.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@

202
doc/fcstring.fncs
View File

@ -23,12 +23,12 @@
*/
<variablelist>
@RET@ int
@FUNC@ FcUtf8ToUcs4
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcChar32 * @ARG2@ dst
@TYPE3@ int% @ARG3@ len
@PURPOSE@ convert UTF-8 to UCS4
@RET@ int
@FUNC@ FcUtf8ToUcs4
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcChar32 * @ARG2@ dst
@TYPE3@ int% @ARG3@ len
@PURPOSE@ convert UTF-8 to UCS4
@DESC@
Converts the next Unicode char from <parameter>src</parameter> into
<parameter>dst</parameter> and returns the number of bytes containing the
@ -36,24 +36,24 @@ char. <parameter>src</parameter> must be at least
<parameter>len</parameter> bytes long.
@@
@RET@ int
@FUNC@ FcUcs4ToUtf8
@TYPE1@ FcChar32% @ARG1@ src
@TYPE2@ FcChar8% @ARG2@ dst[FC_UTF8_MAX_LEN]
@PURPOSE@ convert UCS4 to UTF-8
@RET@ int
@FUNC@ FcUcs4ToUtf8
@TYPE1@ FcChar32% @ARG1@ src
@TYPE2@ FcChar8% @ARG2@ dst[FC_UTF8_MAX_LEN]
@PURPOSE@ convert UCS4 to UTF-8
@DESC@
Converts the Unicode char from <parameter>src</parameter> into
<parameter>dst</parameter> and returns the number of bytes needed to encode
the char.
@@
@RET@ FcBool
@FUNC@ FcUtf8Len
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ int% @ARG2@ len
@TYPE3@ int * @ARG3@ nchar
@TYPE4@ int * @ARG4@ wchar
@PURPOSE@ count UTF-8 encoded chars
@RET@ FcBool
@FUNC@ FcUtf8Len
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ int% @ARG2@ len
@TYPE3@ int * @ARG3@ nchar
@TYPE4@ int * @ARG4@ wchar
@PURPOSE@ count UTF-8 encoded chars
@DESC@
Counts the number of Unicode chars in <parameter>len</parameter> bytes of
<parameter>src</parameter>. Places that count in
@ -63,13 +63,13 @@ counted. The return value indicates whether <parameter>src</parameter> is a
well-formed UTF8 string.
@@
@RET@ int
@FUNC@ FcUtf16ToUcs4
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcEndian% @ARG2@ endian
@TYPE3@ FcChar32 * @ARG3@ dst
@TYPE4@ int% @ARG4@ len
@PURPOSE@ convert UTF-16 to UCS4
@RET@ int
@FUNC@ FcUtf16ToUcs4
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcEndian% @ARG2@ endian
@TYPE3@ FcChar32 * @ARG3@ dst
@TYPE4@ int% @ARG4@ len
@PURPOSE@ convert UTF-16 to UCS4
@DESC@
Converts the next Unicode char from <parameter>src</parameter> into
<parameter>dst</parameter> and returns the number of bytes containing the
@ -78,14 +78,14 @@ bytes long. Bytes of <parameter>src</parameter> are combined into 16-bit
units according to <parameter>endian</parameter>.
@@
@RET@ FcBool
@FUNC@ FcUtf16Len
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcEndian% @ARG2@ endian
@TYPE3@ int% @ARG3@ len
@TYPE4@ int * @ARG4@ nchar
@TYPE5@ int * @ARG5@ wchar
@PURPOSE@ count UTF-16 encoded chars
@RET@ FcBool
@FUNC@ FcUtf16Len
@TYPE1@ FcChar8 * @ARG1@ src
@TYPE2@ FcEndian% @ARG2@ endian
@TYPE3@ int% @ARG3@ len
@TYPE4@ int * @ARG4@ nchar
@TYPE5@ int * @ARG5@ wchar
@PURPOSE@ count UTF-16 encoded chars
@DESC@
Counts the number of Unicode chars in <parameter>len</parameter> bytes of
<parameter>src</parameter>. Bytes of <parameter>src</parameter> are
@ -97,56 +97,56 @@ indicates whether <parameter>string</parameter> is a well-formed UTF16
string.
@@
@RET@ FcBool
@FUNC@ FcIsLower
@TYPE1@ FcChar8 @ARG1@ c
@PURPOSE@ check for lower case ASCII character
@RET@ FcBool
@FUNC@ FcIsLower
@TYPE1@ FcChar8 @ARG1@ c
@PURPOSE@ check for lower case ASCII character
@DESC@
This macro checks whether <parameter>c</parameter> is an lower case ASCII
letter.
@@
@RET@ FcBool
@FUNC@ FcIsUpper
@TYPE1@ FcChar8 @ARG1@ c
@PURPOSE@ check for upper case ASCII character
@RET@ FcBool
@FUNC@ FcIsUpper
@TYPE1@ FcChar8 @ARG1@ c
@PURPOSE@ check for upper case ASCII character
@DESC@
This macro checks whether <parameter>c</parameter> is a upper case ASCII
letter.
@@
@RET@ FcChar8
@FUNC@ FcToLower
@TYPE1@ FcChar8 @ARG1@ c
@PURPOSE@ convert upper case ASCII to lower case
@RET@ FcChar8
@FUNC@ FcToLower
@TYPE1@ FcChar8 @ARG1@ c
@PURPOSE@ convert upper case ASCII to lower case
@DESC@
This macro converts upper case ASCII <parameter>c</parameter> to the
equivalent lower case letter.
@@
@RET@ FcChar8 *
@FUNC@ FcStrCopy
@TYPE1@ const FcChar8 * @ARG1@ s
@PURPOSE@ duplicate a string
@RET@ FcChar8 *
@FUNC@ FcStrCopy
@TYPE1@ const FcChar8 * @ARG1@ s
@PURPOSE@ duplicate a string
@DESC@
Allocates memory, copies <parameter>s</parameter> and returns the resulting
buffer. Yes, this is <function>strdup</function>, but that function isn't
available on every platform.
@@
@RET@ FcChar8 *
@FUNC@ FcStrDowncase
@TYPE1@ const FcChar8 * @ARG1@ s
@PURPOSE@ create a lower case translation of a string
@RET@ FcChar8 *
@FUNC@ FcStrDowncase
@TYPE1@ const FcChar8 * @ARG1@ s
@PURPOSE@ create a lower case translation of a string
@DESC@
Allocates memory, copies <parameter>s</parameter>, converting upper case
letters to lower case and returns the allocated buffer.
@@
@RET@ FcChar8 *
@FUNC@ FcStrCopyFilename
@TYPE1@ const FcChar8 * @ARG1@ s
@PURPOSE@ create a complete path from a filename
@RET@ FcChar8 *
@FUNC@ FcStrCopyFilename
@TYPE1@ const FcChar8 * @ARG1@ s
@PURPOSE@ create a complete path from a filename
@DESC@
<function>FcStrCopyFilename</function> constructs an absolute pathname from
<parameter>s</parameter>. It converts any leading '~' characters in
@ -158,32 +158,32 @@ Returns NULL if '~' is the leading character and HOME is unset or disabled
(see <function>FcConfigEnableHome</function>).
@@
@RET@ int
@FUNC@ FcStrCmp
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ compare UTF-8 strings
@RET@ int
@FUNC@ FcStrCmp
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ compare UTF-8 strings
@DESC@
Returns the usual &lt;0, 0, &gt;0 result of comparing
<parameter>s1</parameter> and <parameter>s2</parameter>.
<parameter>s1</parameter> and <parameter>s2</parameter>.
@@
@RET@ int
@FUNC@ FcStrCmpIgnoreCase
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ compare UTF-8 strings ignoring case
@RET@ int
@FUNC@ FcStrCmpIgnoreCase
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ compare UTF-8 strings ignoring case
@DESC@
Returns the usual &lt;0, 0, &gt;0 result of comparing
<parameter>s1</parameter> and <parameter>s2</parameter>. This test is
case-insensitive for all proper UTF-8 encoded strings.
@@
@RET@ FcChar8 *
@FUNC@ FcStrStr
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ locate UTF-8 substring
@RET@ FcChar8 *
@FUNC@ FcStrStr
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ locate UTF-8 substring
@DESC@
Returns the location of <parameter>s2</parameter> in
<parameter>s1</parameter>. Returns NULL if <parameter>s2</parameter>
@ -191,43 +191,43 @@ is not present in <parameter>s1</parameter>. This test will operate properly
with UTF8 encoded strings.
@@
@RET@ FcChar8 *
@FUNC@ FcStrStrIgnoreCase
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ locate UTF-8 substring ignoring case
@RET@ FcChar8 *
@FUNC@ FcStrStrIgnoreCase
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ locate UTF-8 substring ignoring case
@DESC@
Returns the location of <parameter>s2</parameter> in
Returns the location of <parameter>s2</parameter> in
<parameter>s1</parameter>, ignoring case. Returns NULL if
<parameter>s2</parameter> is not present in <parameter>s1</parameter>.
This test is case-insensitive for all proper UTF-8 encoded strings.
@@
@RET@ FcChar8 *
@FUNC@ FcStrPlus
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ concatenate two strings
@RET@ FcChar8 *
@FUNC@ FcStrPlus
@TYPE1@ const FcChar8 * @ARG1@ s1
@TYPE2@ const FcChar8 * @ARG2@ s2
@PURPOSE@ concatenate two strings
@DESC@
This function allocates new storage and places the concatenation of
<parameter>s1</parameter> and <parameter>s2</parameter> there, returning the
new string.
@@
@RET@ void
@FUNC@ FcStrFree
@TYPE1@ FcChar8 * @ARG1@ s
@PURPOSE@ free a string
@RET@ void
@FUNC@ FcStrFree
@TYPE1@ FcChar8 * @ARG1@ s
@PURPOSE@ free a string
@DESC@
This is just a wrapper around free(3) which helps track memory usage of
strings within the fontconfig library.
@@
@RET@ FcChar8 *
@FUNC@ FcStrBuildFilename
@TYPE1@ const FcChar8 * @ARG1@ path
@TYPE2@ ...
@PURPOSE@ Concatenate strings as a file path
@RET@ FcChar8 *
@FUNC@ FcStrBuildFilename
@TYPE1@ const FcChar8 * @ARG1@ path
@TYPE2@ ...
@PURPOSE@ Concatenate strings as a file path
@DESC@
Creates a filename from the given elements of strings as file paths
and concatenate them with the appropriate file separator.
@ -235,20 +235,20 @@ Arguments must be null-terminated.
This returns a newly-allocated memory which should be freed when no longer needed.
@@
@RET@ FcChar8 *
@FUNC@ FcStrDirname
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ directory part of filename
@RET@ FcChar8 *
@FUNC@ FcStrDirname
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ directory part of filename
@DESC@
Returns the directory containing <parameter>file</parameter>. This
is returned in newly allocated storage which should be freed when no longer
needed.
@@
@RET@ FcChar8 *
@FUNC@ FcStrBasename
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ last component of filename
@RET@ FcChar8 *
@FUNC@ FcStrBasename
@TYPE1@ const FcChar8 * @ARG1@ file
@PURPOSE@ last component of filename
@DESC@
Returns the filename of <parameter>file</parameter> stripped of any leading
directory names. This is returned in newly allocated storage which should

100
doc/fcstrset.fncs
View File

@ -23,102 +23,102 @@
*/
<variablelist>
@RET@ FcStrSet *
@FUNC@ FcStrSetCreate
@TYPE1@ void
@PURPOSE@ create a string set
@RET@ FcStrSet *
@FUNC@ FcStrSetCreate
@TYPE1@ void
@PURPOSE@ create a string set
@DESC@
Create an empty set.
@@
@RET@ FcBool
@FUNC@ FcStrSetMember
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ check set for membership
@RET@ FcBool
@FUNC@ FcStrSetMember
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ check set for membership
@DESC@
Returns whether <parameter>s</parameter> is a member of
<parameter>set</parameter>.
@@
@RET@ FcBool
@FUNC@ FcStrSetEqual
@TYPE1@ FcStrSet * @ARG1@ set_a
@TYPE2@ FcStrSet * @ARG2@ set_b
@PURPOSE@ check sets for equality
@RET@ FcBool
@FUNC@ FcStrSetEqual
@TYPE1@ FcStrSet * @ARG1@ set_a
@TYPE2@ FcStrSet * @ARG2@ set_b
@PURPOSE@ check sets for equality
@DESC@
Returns whether <parameter>set_a</parameter> contains precisely the same
strings as <parameter>set_b</parameter>. Ordering of strings within the two
sets is not considered.
@@
@RET@ FcBool
@FUNC@ FcStrSetAdd
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ add to a string set
@RET@ FcBool
@FUNC@ FcStrSetAdd
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ add to a string set
@DESC@
Adds a copy of <parameter>s</parameter> to <parameter>set</parameter>.
@@
@RET@ FcBool
@FUNC@ FcStrSetAddFilename
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ add a filename to a string set
@RET@ FcBool
@FUNC@ FcStrSetAddFilename
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ add a filename to a string set
@DESC@
Adds a copy <parameter>s</parameter> to <parameter>set</parameter>, The copy
is created with FcStrCopyFilename so that leading '~' values are replaced
with the value of the HOME environment variable.
@@
@RET@ FcBool
@FUNC@ FcStrSetDel
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ delete from a string set
@RET@ FcBool
@FUNC@ FcStrSetDel
@TYPE1@ FcStrSet * @ARG1@ set
@TYPE2@ const FcChar8 * @ARG2@ s
@PURPOSE@ delete from a string set
@DESC@
Removes <parameter>s</parameter> from <parameter>set</parameter>, returning
FcTrue if <parameter>s</parameter> was a member else FcFalse.
@@
@RET@ void
@FUNC@ FcStrSetDestroy
@TYPE1@ FcStrSet * @ARG1@ set
@PURPOSE@ destroy a string set
@RET@ void
@FUNC@ FcStrSetDestroy
@TYPE1@ FcStrSet * @ARG1@ set
@PURPOSE@ destroy a string set
@DESC@
Destroys <parameter>set</parameter>.
@@
@RET@ FcStrList *
@FUNC@ FcStrListCreate
@TYPE1@ FcStrSet * @ARG1@ set
@PURPOSE@ create a string iterator
@RET@ FcStrList *
@FUNC@ FcStrListCreate
@TYPE1@ FcStrSet * @ARG1@ set
@PURPOSE@ create a string iterator
@DESC@
Creates an iterator to list the strings in <parameter>set</parameter>.
@@
@RET@ void
@FUNC@ FcStrListFirst
@TYPE1@ FcStrList * @ARG1@ list
@PURPOSE@ get first string in iteration
@RET@ void
@FUNC@ FcStrListFirst
@TYPE1@ FcStrList * @ARG1@ list
@PURPOSE@ get first string in iteration
@DESC@
Returns the first string in <parameter>list</parameter>.
@SINCE@ 2.11.0
@SINCE@ 2.11.0
@@
@RET@ FcChar8 *
@FUNC@ FcStrListNext
@TYPE1@ FcStrList * @ARG1@ list
@PURPOSE@ get next string in iteration
@RET@ FcChar8 *
@FUNC@ FcStrListNext
@TYPE1@ FcStrList * @ARG1@ list
@PURPOSE@ get next string in iteration
@DESC@
Returns the next string in <parameter>list</parameter>.
@@
@RET@ void
@FUNC@ FcStrListDone
@TYPE1@ FcStrList * @ARG1@ list
@PURPOSE@ destroy a string iterator
@RET@ void
@FUNC@ FcStrListDone
@TYPE1@ FcStrList * @ARG1@ list
@PURPOSE@ destroy a string iterator
@DESC@
Destroys the enumerator <parameter>list</parameter>.
@@

34
doc/fcvalue.fncs
View File

@ -21,39 +21,39 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ void
@FUNC@ FcValueDestroy
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Free a value
@RET@ void
@FUNC@ FcValueDestroy
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Free a value
@DESC@
Frees any memory referenced by <parameter>v</parameter>. Values of type FcTypeString,
FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
@@
@RET@ FcValue
@FUNC@ FcValueSave
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Copy a value
@RET@ FcValue
@FUNC@ FcValueSave
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Copy a value
@DESC@
Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
may be safely destroyed without harming the new value.
@@
@RET@ void
@FUNC@ FcValuePrint
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Print a value to stdout
@RET@ void
@FUNC@ FcValuePrint
@TYPE1@ FcValue% @ARG1@ v
@PURPOSE@ Print a value to stdout
@DESC@
Prints a human-readable representation of <parameter>v</parameter> to
stdout. The format should not be considered part of the library
specification as it may change in the future.
@@
@RET@ FcBool
@FUNC@ FcValueEqual
@TYPE1@ FcValue% @ARG1@ v_a
@TYPE2@ FcValue% @ARG2@ v_b
@PURPOSE@ Test two values for equality
@RET@ FcBool
@FUNC@ FcValueEqual
@TYPE1@ FcValue% @ARG1@ v_a
@TYPE2@ FcValue% @ARG2@ v_b
@PURPOSE@ Test two values for equality
@DESC@
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

40
doc/fcweight.fncs
View File

@ -19,10 +19,10 @@
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
@RET@ double
@FUNC@ FcWeightFromOpenTypeDouble
@TYPE1@ double @ARG1@ ot_weight
@PURPOSE@ Convert from OpenType weight values to fontconfig ones
@RET@ double
@FUNC@ FcWeightFromOpenTypeDouble
@TYPE1@ double @ARG1@ ot_weight
@PURPOSE@ Convert from OpenType weight values to fontconfig ones
@DESC@
<function>FcWeightFromOpenTypeDouble</function> returns an double value
to use with FC_WEIGHT, from an double in the 1..1000 range, resembling
@ -31,39 +31,39 @@ are also similar to CSS font-weight numbers. If input is negative,
zero, or greater than 1000, returns -1. This function linearly interpolates
between various FC_WEIGHT_* constants. As such, the returned value does not
necessarily match any of the predefined constants.
@SINCE@ 2.12.92
@SINCE@ 2.12.92
@@
@RET@ double
@FUNC@ FcWeightToOpenTypeDouble
@TYPE1@ double @ARG1@ ot_weight
@PURPOSE@ Convert from fontconfig weight values to OpenType ones
@RET@ double
@FUNC@ FcWeightToOpenTypeDouble
@TYPE1@ double @ARG1@ ot_weight
@PURPOSE@ Convert from fontconfig weight values to OpenType ones
@DESC@
<function>FcWeightToOpenTypeDouble</function> is the inverse of
<function>FcWeightFromOpenType</function>. If the input is less than
FC_WEIGHT_THIN or greater than FC_WEIGHT_EXTRABLACK, returns -1. Otherwise
returns a number in the range 1 to 1000.
@SINCE@ 2.12.92
@SINCE@ 2.12.92
@@
@RET@ int
@FUNC@ FcWeightFromOpenType
@TYPE1@ int @ARG1@ ot_weight
@PURPOSE@ Convert from OpenType weight values to fontconfig ones
@RET@ int
@FUNC@ FcWeightFromOpenType
@TYPE1@ int @ARG1@ ot_weight
@PURPOSE@ Convert from OpenType weight values to fontconfig ones
@DESC@
<function>FcWeightFromOpenType</function> is like
<function>FcWeightFromOpenTypeDouble</function> but with integer arguments.
Use the other function instead.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@
@RET@ int
@FUNC@ FcWeightToOpenType
@TYPE1@ int @ARG1@ ot_weight
@PURPOSE@ Convert from fontconfig weight values to OpenType ones
@RET@ int
@FUNC@ FcWeightToOpenType
@TYPE1@ int @ARG1@ ot_weight
@PURPOSE@ Convert from fontconfig weight values to OpenType ones
@DESC@
<function>FcWeightToOpenType</function> is like
<function>FcWeightToOpenTypeDouble</function> but with integer arguments.
Use the other function instead.
@SINCE@ 2.11.91
@SINCE@ 2.11.91
@@

60
doc/fontconfig-devel.sgml
View File

@ -25,9 +25,9 @@
]>
<!--
fontconfig/doc/local-fontconfig-devel.sgml
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
the above copyright notice appear in all copies and that both that
@ -37,7 +37,7 @@
specific, written prior permission. The authors make no
representations about the suitability of this software for any purpose. It
is provided "as is" without express or implied warranty.
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
@ -47,22 +47,22 @@
PERFORMANCE OF THIS SOFTWARE.
-->
<article>
<title>Fontconfig Developers Reference, Version &version; </title>
<artheader>
<author>
<firstname>Keith</firstname>
<surname>Packard</surname>
<affiliation><orgname>
HP Cambridge Research Lab
</orgname></affiliation>
</author>
<authorinitials>KRP</authorinitials>
<productname>Fontconfig</productname>
<productnumber>&version;</productnumber>
<LegalNotice>
<simpara>
<title>Fontconfig Developers Reference, Version &version; </title>
<artheader>
<author>
<firstname>Keith</firstname>
<surname>Packard</surname>
<affiliation><orgname>
HP Cambridge Research Lab
</orgname></affiliation>
</author>
<authorinitials>KRP</authorinitials>
<productname>Fontconfig</productname>
<productnumber>&version;</productnumber>
<LegalNotice>
<simpara>
Copyright © 2002 Keith Packard
</simpara><simpara>
</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
the above copyright notice appear in all copies and that both that
@ -72,7 +72,7 @@ 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.
</simpara><simpara>
</simpara><simpara>
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
@ -80,9 +80,9 @@ 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.
</simpara>
</LegalNotice>
</artheader>
</simpara>
</LegalNotice>
</artheader>
<sect1><title>DESCRIPTION</title>
<para>
Fontconfig is a library designed to provide system-wide font configuration,
@ -103,7 +103,7 @@ 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.
list of application-provided font files.
</para><para>
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
@ -284,9 +284,9 @@ types. The 'type' tag indicates which member is valid.
double d;
const FcMatrix *m;
const FcCharSet *c;
void *f;
const FcLangSet *l;
const FcRange *r;
void *f;
const FcLangSet *l;
const FcRange *r;
} u;
} FcValue;
</programlisting>
@ -302,9 +302,9 @@ types. The 'type' tag indicates which member is valid.
FcTypeBool b b
FcTypeMatrix m FcMatrix *
FcTypeCharSet c FcCharSet *
FcTypeFTFace f void * (FT_Face)
FcTypeLangSet l FcLangSet *
FcTypeRange r FcRange *
FcTypeFTFace f void * (FT_Face)
FcTypeLangSet l FcLangSet *
FcTypeRange r FcRange *
</programlisting>
</para>
</sect2>
@ -497,7 +497,7 @@ functions.
<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
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.

196
doc/fontconfig-user.sgml
View File

@ -4,7 +4,7 @@
]>
<!--
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
the above copyright notice appear in all copies and that both that
@ -14,7 +14,7 @@
specific, written prior permission. The authors make no
representations about the suitability of this software for any purpose. It
is provided "as is" without express or implied warranty.
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
@ -29,8 +29,8 @@
<manvolnum>5</manvolnum>
</refmeta>
<refnamediv>
<refname>fonts.conf</refname>
<refpurpose>Font configuration files</refpurpose>
<refname>fonts.conf</refname>
<refpurpose>Font configuration files</refpurpose>
</refnamediv>
<refsynopsisdiv>
<synopsis>
@ -63,7 +63,7 @@ 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.
list of application-provided font files.
</para><para>
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
@ -151,7 +151,7 @@ Fontconfig performs matching by measuring the distance from a provided
pattern to all of the available fonts in the system. The closest matching
font is selected. This ensures that a font will always be returned, but
doesn't ensure that it is anything like the requested pattern.
</para><para>
</para><para>
Font matching starts with an application constructed pattern. The desired
attributes of the resulting font are collected together in a pattern. Each
property of the pattern can contain one or more values; these are listed in
@ -211,7 +211,7 @@ list of family names, second a list of point sizes and finally a list of
additional properties:
</para>
<programlisting>
&lt;families&gt;-&lt;point sizes&gt;:&lt;name1&gt;=&lt;values1&gt;:&lt;name2&gt;=&lt;values2&gt;...
&lt;families&gt;-&lt;point sizes&gt;:&lt;name1&gt;=&lt;values1&gt;:&lt;name2&gt;=&lt;values2&gt;...
</programlisting>
<para>
Values in a list are separated with commas. The name needn't include either
@ -301,11 +301,11 @@ The fontconfig document type definition resides in the external entity
directory (&confdir;). Each configuration file should contain the
following structure:
<programlisting>
&lt;?xml version="1.0"?&gt;
&lt;!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd"&gt;
&lt;fontconfig&gt;
...
&lt;/fontconfig&gt;
&lt;?xml version="1.0"?&gt;
&lt;!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd"&gt;
&lt;fontconfig&gt;
...
&lt;/fontconfig&gt;
</programlisting>
</para>
<refsect2><title><literal>&lt;fontconfig&gt;</literal></title><para>
@ -427,7 +427,7 @@ build the fontconfig database.
</para></refsect2>
<refsect2><title><literal>&lt;test qual="any" name="property" target="default" compare="eq"&gt;</literal></title><para>
This element contains a single value which is compared with the target
('pattern', 'font', 'scan' or 'default') property "property" (substitute any of the property names seen
('pattern', 'font', 'scan' or 'default') property "property" (substitute any of the property names seen
above). 'compare' can be one of "eq", "not_eq", "less", "less_eq", "more", "more_eq", "contains" or
"not_contains". 'qual' may either be the default, "any", in which case the match
succeeds if any value associated with the property matches the test value, or
@ -595,102 +595,102 @@ This is an example of a system-wide configuration file
&lt;!DOCTYPE fontconfig SYSTEM "urn:fontconfig:fonts.dtd"&gt;
&lt;!-- &confdir;/fonts.conf file to configure system font access --&gt;
&lt;fontconfig&gt;
&lt;!--
Find fonts in these directories
&lt;!--
Find fonts in these directories
--&gt;
&lt;dir&gt;/usr/share/fonts&lt;/dir&gt;
&lt;dir&gt;/usr/X11R6/lib/X11/fonts&lt;/dir&gt;
&lt;!--
Accept deprecated 'mono' alias, replacing it with 'monospace'
Accept deprecated 'mono' alias, replacing it with 'monospace'
--&gt;
&lt;match target="pattern"&gt;
&lt;test qual="any" name="family"&gt;&lt;string&gt;mono&lt;/string&gt;&lt;/test&gt;
&lt;edit name="family" mode="assign"&gt;&lt;string&gt;monospace&lt;/string&gt;&lt;/edit&gt;
&lt;test qual="any" name="family"&gt;&lt;string&gt;mono&lt;/string&gt;&lt;/test&gt;
&lt;edit name="family" mode="assign"&gt;&lt;string&gt;monospace&lt;/string&gt;&lt;/edit&gt;
&lt;/match&gt;
&lt;!--
Names not including any well known alias are given 'sans-serif'
Names not including any well known alias are given 'sans-serif'
--&gt;
&lt;match target="pattern"&gt;
&lt;test qual="all" name="family" compare="not_eq"&gt;&lt;string&gt;sans-serif&lt;/string&gt;&lt;/test&gt;
&lt;test qual="all" name="family" compare="not_eq"&gt;&lt;string&gt;serif&lt;/string&gt;&lt;/test&gt;
&lt;test qual="all" name="family" compare="not_eq"&gt;&lt;string&gt;monospace&lt;/string&gt;&lt;/test&gt;
&lt;edit name="family" mode="append_last"&gt;&lt;string&gt;sans-serif&lt;/string&gt;&lt;/edit&gt;
&lt;test qual="all" name="family" compare="not_eq"&gt;&lt;string&gt;sans-serif&lt;/string&gt;&lt;/test&gt;
&lt;test qual="all" name="family" compare="not_eq"&gt;&lt;string&gt;serif&lt;/string&gt;&lt;/test&gt;
&lt;test qual="all" name="family" compare="not_eq"&gt;&lt;string&gt;monospace&lt;/string&gt;&lt;/test&gt;
&lt;edit name="family" mode="append_last"&gt;&lt;string&gt;sans-serif&lt;/string&gt;&lt;/edit&gt;
&lt;/match&gt;
&lt;!--
Load per-user customization file, but don't complain
if it doesn't exist
Load per-user customization file, but don't complain
if it doesn't exist
--&gt;
&lt;include ignore_missing="yes" prefix="xdg"&gt;fontconfig/fonts.conf&lt;/include&gt;
&lt;!--
Load local customization files, but don't complain
if there aren't any
Load local customization files, but don't complain
if there aren't any
--&gt;
&lt;include ignore_missing="yes"&gt;conf.d&lt;/include&gt;
&lt;include ignore_missing="yes"&gt;local.conf&lt;/include&gt;
&lt;!--
Alias well known font names to available TrueType fonts.
These substitute TrueType faces for similar Type1
faces to improve screen appearance.
Alias well known font names to available TrueType fonts.
These substitute TrueType faces for similar Type1
faces to improve screen appearance.
--&gt;
&lt;alias&gt;
&lt;family&gt;Times&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Times New Roman&lt;/family&gt;&lt;/prefer&gt;
&lt;default&gt;&lt;family&gt;serif&lt;/family&gt;&lt;/default&gt;
&lt;family&gt;Times&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Times New Roman&lt;/family&gt;&lt;/prefer&gt;
&lt;default&gt;&lt;family&gt;serif&lt;/family&gt;&lt;/default&gt;
&lt;/alias&gt;
&lt;alias&gt;
&lt;family&gt;Helvetica&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Arial&lt;/family&gt;&lt;/prefer&gt;
&lt;default&gt;&lt;family&gt;sans&lt;/family&gt;&lt;/default&gt;
&lt;family&gt;Helvetica&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Arial&lt;/family&gt;&lt;/prefer&gt;
&lt;default&gt;&lt;family&gt;sans&lt;/family&gt;&lt;/default&gt;
&lt;/alias&gt;
&lt;alias&gt;
&lt;family&gt;Courier&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Courier New&lt;/family&gt;&lt;/prefer&gt;
&lt;default&gt;&lt;family&gt;monospace&lt;/family&gt;&lt;/default&gt;
&lt;family&gt;Courier&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Courier New&lt;/family&gt;&lt;/prefer&gt;
&lt;default&gt;&lt;family&gt;monospace&lt;/family&gt;&lt;/default&gt;
&lt;/alias&gt;
&lt;!--
Provide required aliases for standard names
Do these after the users configuration file so that
any aliases there are used preferentially
Provide required aliases for standard names
Do these after the users configuration file so that
any aliases there are used preferentially
--&gt;
&lt;alias&gt;
&lt;family&gt;serif&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Times New Roman&lt;/family&gt;&lt;/prefer&gt;
&lt;family&gt;serif&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Times New Roman&lt;/family&gt;&lt;/prefer&gt;
&lt;/alias&gt;
&lt;alias&gt;
&lt;family&gt;sans&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Arial&lt;/family&gt;&lt;/prefer&gt;
&lt;family&gt;sans&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Arial&lt;/family&gt;&lt;/prefer&gt;
&lt;/alias&gt;
&lt;alias&gt;
&lt;family&gt;monospace&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Andale Mono&lt;/family&gt;&lt;/prefer&gt;
&lt;family&gt;monospace&lt;/family&gt;
&lt;prefer&gt;&lt;family&gt;Andale Mono&lt;/family&gt;&lt;/prefer&gt;
&lt;/alias&gt;
&lt;--
The example of the requirements of OR operator;
If the 'family' contains 'Courier New' OR 'Courier'
add 'monospace' as the alternative
The example of the requirements of OR operator;
If the 'family' contains 'Courier New' OR 'Courier'
add 'monospace' as the alternative
--&gt;
&lt;match target="pattern"&gt;
&lt;test name="family" compare="eq"&gt;
&lt;string&gt;Courier New&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;monospace&lt;/string&gt;
&lt;/edit&gt;
&lt;test name="family" compare="eq"&gt;
&lt;string&gt;Courier New&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;monospace&lt;/string&gt;
&lt;/edit&gt;
&lt;/match&gt;
&lt;match target="pattern"&gt;
&lt;test name="family" compare="eq"&gt;
&lt;string&gt;Courier&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;monospace&lt;/string&gt;
&lt;/edit&gt;
&lt;test name="family" compare="eq"&gt;
&lt;string&gt;Courier&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;monospace&lt;/string&gt;
&lt;/edit&gt;
&lt;/match&gt;
&lt;/fontconfig&gt;
@ -708,52 +708,52 @@ $XDG_CONFIG_HOME/fontconfig/fonts.conf
&lt;fontconfig&gt;
&lt;!--
Private font directory
Private font directory
--&gt;
&lt;dir prefix="xdg"&gt;fonts&lt;/dir&gt;
&lt;!--
use rgb sub-pixel ordering to improve glyph appearance on
LCD screens. Changes affecting rendering, but not matching
should always use target="font".
use rgb sub-pixel ordering to improve glyph appearance on
LCD screens. Changes affecting rendering, but not matching
should always use target="font".
--&gt;
&lt;match target="font"&gt;
&lt;edit name="rgba" mode="assign"&gt;&lt;const&gt;rgb&lt;/const&gt;&lt;/edit&gt;
&lt;edit name="rgba" mode="assign"&gt;&lt;const&gt;rgb&lt;/const&gt;&lt;/edit&gt;
&lt;/match&gt;
&lt;!--
use WenQuanYi Zen Hei font when serif is requested for Chinese
use WenQuanYi Zen Hei font when serif is requested for Chinese
--&gt;
&lt;match&gt;
&lt;!--
If you don't want to use WenQuanYi Zen Hei font for zh-tw etc,
you can use zh-cn instead of zh.
Please note, even if you set zh-cn, it still matches zh.
if you don't like it, you can use compare="eq"
instead of compare="contains".
--&gt;
&lt;test name="lang" compare="contains"&gt;
&lt;string&gt;zh&lt;/string&gt;
&lt;/test&gt;
&lt;test name="family"&gt;
&lt;string&gt;serif&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;WenQuanYi Zen Hei&lt;/string&gt;
&lt;/edit&gt;
&lt;!--
If you don't want to use WenQuanYi Zen Hei font for zh-tw etc,
you can use zh-cn instead of zh.
Please note, even if you set zh-cn, it still matches zh.
if you don't like it, you can use compare="eq"
instead of compare="contains".
--&gt;
&lt;test name="lang" compare="contains"&gt;
&lt;string&gt;zh&lt;/string&gt;
&lt;/test&gt;
&lt;test name="family"&gt;
&lt;string&gt;serif&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;WenQuanYi Zen Hei&lt;/string&gt;
&lt;/edit&gt;
&lt;/match&gt;
&lt;!--
use VL Gothic font when sans-serif is requested for Japanese
use VL Gothic font when sans-serif is requested for Japanese
--&gt;
&lt;match&gt;
&lt;test name="lang" compare="contains"&gt;
&lt;string&gt;ja&lt;/string&gt;
&lt;/test&gt;
&lt;test name="family"&gt;
&lt;string&gt;sans-serif&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;VL Gothic&lt;/string&gt;
&lt;/edit&gt;
&lt;test name="lang" compare="contains"&gt;
&lt;string&gt;ja&lt;/string&gt;
&lt;/test&gt;
&lt;test name="family"&gt;
&lt;string&gt;sans-serif&lt;/string&gt;
&lt;/test&gt;
&lt;edit name="family" mode="prepend"&gt;
&lt;string&gt;VL Gothic&lt;/string&gt;
&lt;/edit&gt;
&lt;/match&gt;
&lt;/fontconfig&gt;
</programlisting>
@ -773,7 +773,7 @@ is the conventional name for a directory of additional configuration files
managed by external applications or the local administrator. The
filenames starting with decimal digits are sorted in lexicographic order
and used as additional configuration files. All of these files are in XML
format. The master fonts.conf file references this directory in an
format. The master fonts.conf file references this directory in an
&lt;include&gt; directive.
</para>
<para>
@ -837,8 +837,8 @@ fc-cat(1), fc-cache(1), fc-list(1), fc-match(1), fc-query(1), <ulink url="https:
</para>
</refsect1>
<refsect1><title>Version</title>
<para>
<para>
Fontconfig version &version;
</para>
</para>
</refsect1>
</refentry>

72
doc/func.sgml
View File

@ -1,8 +1,8 @@
<!--
fontconfig/doc/func.sgml
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
the above copyright notice appear in all copies and that both that
@ -12,7 +12,7 @@
specific, written prior permission. The authors make no
representations about the suitability of this software for any purpose. It
is provided "as is" without express or implied warranty.
THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
@ -26,66 +26,66 @@
@:@
<refentry id="@FUNC@">
@;@
<refmeta>
<refmeta>
@?TITLE@
<refentrytitle>@TITLE@</refentrytitle>
<refentrytitle>@TITLE@</refentrytitle>
@:@
<refentrytitle>@FUNC@</refentrytitle>
<refentrytitle>@FUNC@</refentrytitle>
@;@
<manvolnum>3</manvolnum>
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
</refmeta>
<refnamediv>
<manvolnum>3</manvolnum>
<refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
</refmeta>
<refnamediv>
@{PROTOTYPE@
<refname>@FUNC@</refname>
<refname>@FUNC@</refname>
@}PROTOTYPE@
<refpurpose>@PURPOSE@</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
<refpurpose>@PURPOSE@</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis>
<funcsynopsisinfo>
@?SYNOPSIS@
@SYNOPSIS@
@:@
#include &lt;fontconfig/fontconfig.h&gt;
@;@
</funcsynopsisinfo>
</funcsynopsisinfo>
@{PROTOTYPE@
<funcprototype>
<funcdef>@?RET@@RET@@:@void@;@ <function>@FUNC@</function></funcdef>
<funcprototype>
<funcdef>@?RET@@RET@@:@void@;@ <function>@FUNC@</function></funcdef>
@?TYPE1@
<paramdef>@TYPE1@<parameter>@ARG1@</parameter></paramdef>
<paramdef>@TYPE1@<parameter>@ARG1@</parameter></paramdef>
@;@
@?TYPE2@
<paramdef>@TYPE2@<parameter>@ARG2@</parameter></paramdef>
<paramdef>@TYPE2@<parameter>@ARG2@</parameter></paramdef>
@;@
@?TYPE3@
<paramdef>@TYPE3@<parameter>@ARG3@</parameter></paramdef>
<paramdef>@TYPE3@<parameter>@ARG3@</parameter></paramdef>
@;@
@?TYPE4@
<paramdef>@TYPE4@<parameter>@ARG4@</parameter></paramdef>
<paramdef>@TYPE4@<parameter>@ARG4@</parameter></paramdef>
@;@
@?TYPE5@
<paramdef>@TYPE5@<parameter>@ARG5@</parameter></paramdef>
<paramdef>@TYPE5@<parameter>@ARG5@</parameter></paramdef>
@;@
@?TYPE6@
<paramdef>@TYPE6@<parameter>@ARG6@</parameter></paramdef>
<paramdef>@TYPE6@<parameter>@ARG6@</parameter></paramdef>
@;@
@?TYPE7@
<paramdef>@TYPE7@<parameter>@ARG7@</parameter></paramdef>
<paramdef>@TYPE7@<parameter>@ARG7@</parameter></paramdef>
@;@
</funcprototype>
</funcprototype>
@}PROTOTYPE@
</funcsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>
</funcsynopsis>
</refsynopsisdiv>
<refsect1><title>Description</title>
<para>
@DESC@
</para>
</refsect1>
</para>
</refsect1>
@?SINCE@
<refsect1><title>Since</title>
<para>version @SINCE@</para>
</refsect1>
<refsect1><title>Since</title>
<para>version @SINCE@</para>
</refsect1>
@;@
</refentry>