X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;ds=sidebyside;f=doc%2Ffcconfig.fncs;h=e29c392c8f17f336697d42e7e74b2232e08ab5dd;hb=9b74b78fe87f75f7026bfb23ab43ef347e109ca6;hp=d6119f2ffd1024466822c78559af034a79bf9cde;hpb=2df0c66230fb86a784414b5db803d32d1a083b3a;p=fontconfig.git diff --git a/doc/fcconfig.fncs b/doc/fcconfig.fncs index d6119f2..e29c392 100644 --- a/doc/fcconfig.fncs +++ b/doc/fcconfig.fncs @@ -1,7 +1,7 @@ /* * $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 @@ -21,7 +21,7 @@ * 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 @@ -29,9 +29,9 @@ 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 @@ -39,16 +39,16 @@ this function with the return from FcConfigGetCurrent will place the library 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 config. Implicitly calls FcConfigBuildFonts if necessary, returning FcFalse if that call fails. @@ -@RET@ FcConfig * +@RET@ FcConfig * @FUNC@ FcConfigGetCurrent @TYPE1@ void @PURPOSE@ Return current configuration @@ -56,18 +56,18 @@ FcConfigBuildFonts if necessary, returning FcFalse if that call fails. 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 config 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 @@ -75,18 +75,18 @@ any changes to the configuration after this call have indeterminate effects. 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 config. 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 config. This includes the @@ -94,45 +94,45 @@ configured font directories along with any directories below those in 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 config. 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 set. @@ -@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 @@ -140,71 +140,71 @@ seconds) specified in config. The configuration is check 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 kind is -FcMatchPattern, then those tagged as pattern operations are applied, else +FcMatchPattern, then those tagged as pattern operations are applied, else if kind 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 config most close matching p. This function @@ -212,13 +212,13 @@ should be called only after FcConfigSubstitute and FcDefaultSubstitute have been called for p; 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 p. If trim is FcTrue, @@ -236,11 +236,11 @@ FcFontRenderPrepare which combines them into a complete pattern. 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 font not appearing @@ -249,25 +249,25 @@ value from pat for elements appearing in both. The resul FcConfigSubstitute with kind 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 p, creates patterns from those fonts containing only the objects in os 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. A null or empty name indicates that the default configuration file should be used; which file this references can be overridden with the @@ -277,3 +277,16 @@ doesn't start with '/', it refers to a file in the default configuration 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. +@@