/*
* $Id$
*
- * Copyright © 2003 Keith Packard
+ * Copyright © 2003 Keith Packard
*
* Permission to use, copy, modify, distribute, and sell this software and its
* documentation for any purpose is hereby granted without fee, provided that
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
* PERFORMANCE OF THIS SOFTWARE.
*/
-@RET@ FcConfig *
+@RET@ FcConfig *
@FUNC@ FcConfigCreate
@TYPE1@ void
@PURPOSE@ Create a configuration
Creates an empty configuration.
@@
-@RET@ void
-@FUNC@ FcConfigDestroy
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ void
+@FUNC@ FcConfigDestroy
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Destroy a configuration
@DESC@
Destroys a configuration and any data associated with it. Note that calling
in an indeterminate state.
@@
-@RET@ FcBool
-@FUNC@ FcConfigSetCurrent
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcBool
+@FUNC@ FcConfigSetCurrent
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Set configuration as default
@DESC@
Sets the current default configuration to <parameter>config</parameter>. Implicitly calls
FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
@@
-@RET@ FcConfig *
+@RET@ FcConfig *
@FUNC@ FcConfigGetCurrent
@TYPE1@ void
@PURPOSE@ Return current configuration
Returns the current default configuration.
@@
-@RET@ FcBool
-@FUNC@ FcConfigUptoDate
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcBool
+@FUNC@ FcConfigUptoDate
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Check timestamps on config files
@DESC@
Checks all of the files related to <parameter>config</parameter> and returns whether the
in-memory version is in sync with the disk version.
@@
-@RET@ FcBool
-@FUNC@ FcConfigBuildFonts
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcBool
+@FUNC@ FcConfigBuildFonts
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Build font database
@DESC@
Builds the set of available fonts for the given configuration. Note that
Returns FcFalse if this operation runs out of memory.
@@
-@RET@ FcStrList *
-@FUNC@ FcConfigGetConfigDirs
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcStrList *
+@FUNC@ FcConfigGetConfigDirs
+@TYPE1@ FcConfig * @ARG1@ config
@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.
@@
-@RET@ FcStrList *
-@FUNC@ FcConfigGetFontDirs
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcStrList *
+@FUNC@ FcConfigGetFontDirs
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get font directories
@DESC@
Returns the list of font directories in <parameter>config</parameter>. This includes the
filesystem.
@@
-@RET@ FcStrList *
-@FUNC@ FcConfigGetConfigFiles
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcStrList *
+@FUNC@ FcConfigGetConfigFiles
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config files
@DESC@
Returns the list of known configuration files used to generate <parameter>config</parameter>.
Note that this will not include any configuration done with FcConfigParse.
@@
-@RET@ char *
-@FUNC@ FcConfigGetCache
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ char *
+@FUNC@ FcConfigGetCache
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get cache filename
@DESC@
Returns the name of the file used to store per-user font information.
@@
-@RET@ FcFontSet *
-@FUNC@ FcConfigGetFonts
+@RET@ FcFontSet *
+@FUNC@ FcConfigGetFonts
@TYPE1@ FcConfig * @ARG1@ config
-@TYPE2@ FcSetName @ARG2@ set
+@TYPE2@ FcSetName% @ARG2@ set
@PURPOSE@ Get config font set
@DESC@
-Returns one of the two sets of fonts from the configuration as specified
+Returns one of the two sets of fonts from the configuration as specified
by <parameter>set</parameter>.
@@
-@RET@ FcBlanks *
-@FUNC@ FcConfigGetBlanks
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ FcBlanks *
+@FUNC@ FcConfigGetBlanks
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config blanks
@DESC@
Returns the FcBlanks object associated with the given configuration, if no
blanks were present in the configuration, this function will return 0.
@@
-@RET@ int
-@FUNC@ FcConfigGetRescanInverval
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ int
+@FUNC@ FcConfigGetRescanInverval
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Get config rescan interval
@DESC@
Returns the interval between automatic checks of the configuration (in
a call to FcFontList when this interval has passed since the last check.
@@
-@RET@ FcBool
-@FUNC@ FcConfigSetRescanInverval
+@RET@ FcBool
+@FUNC@ FcConfigSetRescanInverval
@TYPE1@ FcConfig * @ARG1@ config
-@TYPE2@ int @ARG2@ rescanInterval
+@TYPE2@ int% @ARG2@ rescanInterval
@PURPOSE@ Set config rescan interval
@DESC@
Sets the rescan interval; returns FcFalse if an error occurred.
@@
-@RET@ FcBool
-@FUNC@ FcConfigAppFontAddFile
+@RET@ FcBool
+@FUNC@ FcConfigAppFontAddFile
@TYPE1@ FcConfig * @ARG1@ config
-@TYPE2@ const char * @ARG2@ file
+@TYPE2@ const char * @ARG2@ file
@PURPOSE@ Add font file to font database
@DESC@
Adds an application-specific font to the configuration.
@@
-@RET@ FcBool
-@FUNC@ FcConfigAppFontAddDir
+@RET@ FcBool
+@FUNC@ FcConfigAppFontAddDir
@TYPE1@ FcConfig * @ARG1@ config
-@TYPE2@ const char * @ARG1@ dir
+@TYPE2@ const char * @ARG1@ 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.
@@
-@RET@ void
-@FUNC@ FcConfigAppFontClear
-@TYPE1@ FcConfig * @ARG1@ config
+@RET@ void
+@FUNC@ FcConfigAppFontClear
+@TYPE1@ FcConfig * @ARG1@ config
@PURPOSE@ Remove all app fonts from font database
@DESC@
Clears the set of application-specific fonts.
@@
-@RET@ FcBool
-@FUNC@ FcConfigSubstituteWithPat
+@RET@ FcBool
+@FUNC@ FcConfigSubstituteWithPat
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
@TYPE3@ FcPattern * @ARG3@ p_pat
-@TYPE4@ FcMatchKind @ARG4@ kind
+@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
+FcMatchPattern, then those tagged as pattern operations are applied, else
if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
p_pat is used for <test> elements with target=pattern.
@@
-@RET@ FcBool
-@FUNC@ FcConfigSubstitute
+@RET@ FcBool
+@FUNC@ FcConfigSubstitute
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
-@TYPE3@ FcMatchKind @ARG3@ kind
+@TYPE3@ FcMatchKind% @ARG3@ kind
@PURPOSE@ Execute substitutions
@DESC@
Calls FcConfigSubstituteWithPat setting p_pat to NULL.
@@
-@RET@ FcPattern *
-@FUNC@ FcFontMatch
+@RET@ FcPattern *
+@FUNC@ FcFontMatch
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
-@TYPE3@ FcResult * @ARG3@ result
+@TYPE3@ FcResult * @ARG3@ result
@PURPOSE@ Return best font
@DESC@
Returns the font in <parameter>config</parameter> most close matching <parameter>p</parameter>. This function
been called for <parameter>p</parameter>; otherwise the results will not be correct.
@@
-@RET@ FcFontSet *
-@FUNC@ FcFontSort
+@RET@ FcFontSet *
+@FUNC@ FcFontSort
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
-@TYPE3@ FcBool @ARG3@ trim
+@TYPE3@ FcBool% @ARG3@ trim
@TYPE4@ FcCharSet ** @ARG4@ csp
-@TYPE5@ FcResult * @ARG5@ result
+@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,
The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
@@
-@RET@ FcPattern *
-@FUNC@ FcFontRenderPrepare
+@RET@ FcPattern *
+@FUNC@ FcFontRenderPrepare
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ pat
-@TYPE3@ FcPattern * @ARG3@ font
+@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
FcConfigSubstitute with <parameter>kind</parameter> FcMatchFont and then returned.
@@
-@RET@ FcFontSet *
-@FUNC@ FcFontList
+@RET@ FcFontSet *
+@FUNC@ FcFontList
@TYPE1@ FcConfig * @ARG1@ config
@TYPE2@ FcPattern * @ARG2@ p
-@TYPE3@ FcObjectSet * @ARG3@ os
+@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.
@@
-@RET@ char *
-@FUNC@ FcConfigFilename
-@TYPE1@ const char * @ARG1@ name
+@RET@ char *
+@FUNC@ FcConfigFilename
+@TYPE1@ const char * @ARG1@ 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
-references into filename form.
+references into filename form.
</para><para>
A null or empty <parameter>name</parameter> indicates that the default configuration file should
be used; which file this references can be overridden with the
directory; the built-in default directory can be overridden with the
FC_CONFIG_DIR environment variable.
@@
+
+@RET@ FcBool
+@FUNC@ FcConfigParseAndLoad
+@TYPE1@ FcConfig * @ARG1@ config
+@TYPE2@ const FcChar8 * @ARG2@ file
+@TYPE2@ 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
+with FcConfigLoad and also parsed. If 'complain' is FcFalse, no warning
+will be displayed if 'file' does not exist.
+@@
git.wh0rd.org / fontconfig.git / blobdiff