doc/fcconfig.fncs

   1 /*
   2  * $Id$
   3  *
   4  * Copyright © 2003 Keith Packard
   5  *
   6  * Permission to use, copy, modify, distribute, and sell this software and its
   7  * documentation for any purpose is hereby granted without fee, provided that
   8  * the above copyright notice appear in all copies and that both that
   9  * copyright notice and this permission notice appear in supporting
  10  * documentation, and that the name of Keith Packard not be used in
  11  * advertising or publicity pertaining to distribution of the software without
  12  * specific, written prior permission.  Keith Packard makes no
  13  * representations about the suitability of this software for any purpose.  It
  14  * is provided "as is" without express or implied warranty.
  15  *
  16  * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
  17  * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
  18  * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
  19  * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
  20  * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
  21  * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
  22  * PERFORMANCE OF THIS SOFTWARE.
  23  */
  24 @RET@           FcConfig *
  25 @FUNC@          FcConfigCreate
  26 @TYPE1@         void
  27 @PURPOSE@       Create a configuration
  28 @DESC@
  29 Creates an empty configuration.
  30 @@
  31
  32 @RET@           void
  33 @FUNC@          FcConfigDestroy
  34 @TYPE1@         FcConfig *                      @ARG1@          config
  35 @PURPOSE@       Destroy a configuration
  36 @DESC@
  37 Destroys a configuration and any data associated with it.  Note that calling
  38 this function with the return from FcConfigGetCurrent will place the library
  39 in an indeterminate state.
  40 @@
  41
  42 @RET@           FcBool
  43 @FUNC@          FcConfigSetCurrent
  44 @TYPE1@         FcConfig *                      @ARG1@          config
  45 @PURPOSE@       Set configuration as default
  46 @DESC@
  47 Sets the current default configuration to <parameter>config</parameter>.  Implicitly calls
  48 FcConfigBuildFonts if necessary, returning FcFalse if that call fails.
  49 @@
  50
  51 @RET@           FcConfig *
  52 @FUNC@          FcConfigGetCurrent
  53 @TYPE1@         void
  54 @PURPOSE@       Return current configuration
  55 @DESC@
  56 Returns the current default configuration.
  57 @@
  58
  59 @RET@           FcBool
  60 @FUNC@          FcConfigUptoDate
  61 @TYPE1@         FcConfig *                      @ARG1@          config
  62 @PURPOSE@       Check timestamps on config files
  63 @DESC@
  64 Checks all of the files related to <parameter>config</parameter> and returns
  65 whether any of them has been modified since the configuration was created.
  66 @@
  67
  68 @RET@           FcBool
  69 @FUNC@          FcConfigHome
  70 @TYPE1@         void
  71 @PURPOSE@       return the current home directory.
  72 @DESC@
  73 Return the current user's home directory, if it is available, and if using it
  74 is enabled. See also <function>FcConfigEnableHome</function>).
  75 @@
  76
  77 @RET@           FcBol
  78 @FUNC@          FcConfigEnableHome
  79 @TYPE1@         FcBool%                         @ARG1@          enable
  80 @PURPOSE@       controls use of the home directory.
  81 @DESC@
  82 If <parameter>enable</parameter> is FcTrue, then Fontconfig will use various
  83 files which are specified relative to the user's home directory (using the ~
  84 notation in the configuration). When <parameter>enable</parameter> is
  85 FcFalse, then all use of the home directory in these contexts will be
  86 disabled. The previous setting of the value is returned.
  87 @@
  88
  89 @RET@           FcBool
  90 @FUNC@          FcConfigBuildFonts
  91 @TYPE1@         FcConfig *                      @ARG1@          config
  92 @PURPOSE@       Build font database
  93 @DESC@
  94 Builds the set of available fonts for the given configuration.  Note that
  95 any changes to the configuration after this call have indeterminate effects.
  96 Returns FcFalse if this operation runs out of memory.
  97 @@
  98
  99 @RET@           FcStrList *
 100 @FUNC@          FcConfigGetConfigDirs
 101 @TYPE1@         FcConfig *                      @ARG1@          config
 102 @PURPOSE@       Get config directories
 103 @DESC@
 104 Returns the list of font directories specified in the configuration files
 105 for <parameter>config</parameter>.  Does not include any subdirectories.
 106 @@
 107
 108 @RET@           FcStrList *
 109 @FUNC@          FcConfigGetFontDirs
 110 @TYPE1@         FcConfig *                      @ARG1@          config
 111 @PURPOSE@       Get font directories
 112 @DESC@
 113 Returns the list of font directories in <parameter>config</parameter>. This includes the
 114 configured font directories along with any directories below those in the
 115 filesystem.
 116 @@
 117
 118 @RET@           FcStrList *
 119 @FUNC@          FcConfigGetConfigFiles
 120 @TYPE1@         FcConfig *                      @ARG1@          config
 121 @PURPOSE@       Get config files
 122 @DESC@
 123 Returns the list of known configuration files used to generate <parameter>config</parameter>.
 124 @@
 125
 126 @RET@           FcChar8 *
 127 @FUNC@          FcConfigGetCache
 128 @TYPE1@         FcConfig *                      @ARG1@          config
 129 @PURPOSE@       DEPRECATED used to return per-user cache filename
 130 @DESC@
 131 With fontconfig no longer using per-user cache files, this function now
 132 simply returns NULL to indicate that no per-user file exists.
 133 @@
 134
 135 @RET@           FcStrList *
 136 @FUNC@          FcConfigGetCacheDirs
 137 @TYPE1@         FcConfig *                      @ARG1@          config
 138 @PURPOSE@       return the list of directories searched for cache files
 139 @DESC@
 140 <function>FcConfigGetCacheDirs</function> returns a string list containing
 141 all of the directories that fontconfig will search when attempting to load a
 142 cache file for a font directory.
 143 @@
 144
 145 @RET@           FcFontSet *
 146 @FUNC@          FcConfigGetFonts
 147 @TYPE1@         FcConfig *                      @ARG1@          config
 148 @TYPE2@         FcSetName%                      @ARG2@          set
 149 @PURPOSE@       Get config font set
 150 @DESC@
 151 Returns one of the two sets of fonts from the configuration as specified
 152 by <parameter>set</parameter>. This font set is owned by the library and must
 153 not be freed.
 154 @@
 155
 156 @RET@           FcBlanks *
 157 @FUNC@          FcConfigGetBlanks
 158 @TYPE1@         FcConfig *                      @ARG1@          config
 159 @PURPOSE@       Get config blanks
 160 @DESC@
 161 Returns the FcBlanks object associated with the given configuration, if no
 162 blanks were present in the configuration, this function will return 0.
 163 @@
 164
 165 @RET@           int
 166 @FUNC@          FcConfigGetRescanInterval
 167 @TYPE1@         FcConfig *                      @ARG1@          config
 168 @PURPOSE@       Get config rescan interval
 169 @DESC@
 170 Returns the interval between automatic checks of the configuration (in
 171 seconds) specified in <parameter>config</parameter>.  The configuration is checked during
 172 a call to FcFontList when this interval has passed since the last check.
 173 An interval setting of zero disables automatic checks.
 174 @@
 175
 176 @RET@           FcBool
 177 @FUNC@          FcConfigSetRescanInterval
 178 @TYPE1@         FcConfig *                      @ARG1@          config
 179 @TYPE2@         int%                            @ARG2@          rescanInterval
 180 @PURPOSE@       Set config rescan interval
 181 @DESC@
 182 Sets the rescan interval. Returns FcFalse if the interval cannot be set (due
 183 to allocation failure). Otherwise returns FcTrue.
 184 An interval setting of zero disables automatic checks.
 185 @@
 186
 187 @RET@           FcBool
 188 @FUNC@          FcConfigAppFontAddFile
 189 @TYPE1@         FcConfig *                      @ARG1@          config
 190 @TYPE2@         const FcChar8 *                 @ARG2@          file
 191 @PURPOSE@       Add font file to font database
 192 @DESC@
 193 Adds an application-specific font to the configuration. Returns FcFalse
 194 if the fonts cannot be added (due to allocation failure). Otherwise returns FcTrue.
 195 @@
 196
 197 @RET@           FcBool
 198 @FUNC@          FcConfigAppFontAddDir
 199 @TYPE1@         FcConfig *                      @ARG1@          config
 200 @TYPE2@         const FcChar8 *                 @ARG2@          dir
 201 @PURPOSE@       Add fonts from directory to font database
 202 @DESC@
 203 Scans the specified directory for fonts, adding each one found to the
 204 application-specific set of fonts. Returns FcFalse
 205 if the fonts cannot be added (due to allocation failure). Otherwise returns FcTrue.
 206 @@
 207
 208 @RET@           void
 209 @FUNC@          FcConfigAppFontClear
 210 @TYPE1@         FcConfig *                      @ARG1@          config
 211 @PURPOSE@       Remove all app fonts from font database
 212 @DESC@
 213 Clears the set of application-specific fonts.
 214 @@
 215
 216 @RET@           FcBool
 217 @FUNC@          FcConfigSubstituteWithPat
 218 @TYPE1@         FcConfig *                      @ARG1@          config
 219 @TYPE2@         FcPattern *                     @ARG2@          p
 220 @TYPE3@         FcPattern *                     @ARG3@          p_pat
 221 @TYPE4@         FcMatchKind%                     @ARG4@          kind
 222 @PURPOSE@       Execute substitutions
 223 @DESC@
 224 Performs the sequence of pattern modification operations, if <parameter>kind</parameter> is
 225 FcMatchPattern, then those tagged as pattern operations are applied, else
 226 if <parameter>kind</parameter> is FcMatchFont, those tagged as font operations are applied and
 227 p_pat is used for &lt;test&gt; elements with target=pattern. Returns FcFalse
 228 if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
 229 @@
 230
 231 @RET@           FcBool
 232 @FUNC@          FcConfigSubstitute
 233 @TYPE1@         FcConfig *                      @ARG1@          config
 234 @TYPE2@         FcPattern *                     @ARG2@          p
 235 @TYPE3@         FcMatchKind%                    @ARG3@          kind
 236 @PURPOSE@       Execute substitutions
 237 @DESC@
 238 Calls FcConfigSubstituteWithPat setting p_pat to NULL. Returns FcFalse
 239 if the substitution cannot be performed (due to allocation failure). Otherwise returns FcTrue.
 240 @@
 241
 242 @RET@           FcPattern *
 243 @FUNC@          FcFontMatch
 244 @TYPE1@         FcConfig *                      @ARG1@          config
 245 @TYPE2@         FcPattern *                     @ARG2@          p
 246 @TYPE3@         FcResult *                      @ARG3@          result
 247 @PURPOSE@       Return best font
 248 @DESC@
 249 Finds the font in <parameter>sets</parameter> most closely matching
 250 <parameter>pattern</parameter> and returns the result of
 251 <function>FcFontRenderPrepare</function> for that font and the provided
 252 pattern. This function should be called only after
 253 <function>FcConfigSubstitute</function> and
 254 <function>FcDefaultSubstitute</function> have been called for
 255 <parameter>p</parameter>; otherwise the results will not be correct.
 256 @@
 257
 258 @RET@           FcFontSet *
 259 @FUNC@          FcFontSort
 260 @TYPE1@         FcConfig *                      @ARG1@          config
 261 @TYPE2@         FcPattern *                     @ARG2@          p
 262 @TYPE3@         FcBool%                         @ARG3@          trim
 263 @TYPE4@         FcCharSet **                    @ARG4@          csp
 264 @TYPE5@         FcResult *                      @ARG5@          result
 265 @PURPOSE@       Return list of matching fonts
 266 @DESC@
 267 Returns the list of fonts sorted by closeness to <parameter>p</parameter>.  If <parameter>trim</parameter> is FcTrue,
 268 elements in the list which don't include Unicode coverage not provided by
 269 earlier elements in the list are elided.  The union of Unicode coverage of
 270 all of the fonts is returned in <parameter>csp</parameter>, if <parameter>csp</parameter> is not NULL.  This function
 271 should be called only after FcConfigSubstitute and FcDefaultSubstitute have
 272 been called for <parameter>p</parameter>; otherwise the results will not be correct.
 273     </para><para>
 274 The returned FcFontSet references FcPattern structures which may be shared
 275 by the return value from multiple FcFontSort calls, applications must not
 276 modify these patterns.  Instead, they should be passed, along with <parameter>p</parameter> to
 277 <function>FcFontRenderPrepare</function> which combines them into a complete pattern.
 278     </para><para>
 279 The FcFontSet returned by FcFontSort is destroyed by caling FcFontSetDestroy.
 280 @@
 281
 282 @RET@           FcPattern *
 283 @FUNC@          FcFontRenderPrepare
 284 @TYPE1@         FcConfig *                      @ARG1@          config
 285 @TYPE2@         FcPattern *                     @ARG2@          pat
 286 @TYPE3@         FcPattern *                     @ARG3@          font
 287 @PURPOSE@       Prepare pattern for loading font file
 288 @DESC@
 289 Creates a new pattern consisting of elements of <parameter>font</parameter> not appearing
 290 in <parameter>pat</parameter>, elements of <parameter>pat</parameter> not appearing in <parameter>font</parameter> and the best matching
 291 value from <parameter>pat</parameter> for elements appearing in both.  The result is passed to
 292 FcConfigSubstituteWithPat with <parameter>kind</parameter> FcMatchFont and then returned.
 293 @@
 294
 295 @RET@           FcFontSet *
 296 @FUNC@          FcFontList
 297 @TYPE1@         FcConfig *                      @ARG1@          config
 298 @TYPE2@         FcPattern *                     @ARG2@          p
 299 @TYPE3@         FcObjectSet *                   @ARG3@          os
 300 @PURPOSE@       List fonts
 301 @DESC@
 302 Selects fonts matching <parameter>p</parameter>, creates patterns from those fonts containing
 303 only the objects in <parameter>os</parameter> and returns the set of unique such patterns.
 304 @@
 305
 306 @RET@           FcChar8 *
 307 @FUNC@          FcConfigFilename
 308 @TYPE1@         const FcChar8 *                 @ARG1@          name
 309 @PURPOSE@       Find a config file
 310 @DESC@
 311 Given the specified external entity name, return the associated filename.
 312 This provides applications a way to convert various configuration file
 313 references into filename form.
 314     </para><para>
 315 A null or empty <parameter>name</parameter> indicates that the default configuration file should
 316 be used; which file this references can be overridden with the
 317 FC_CONFIG_FILE environment variable.  Next, if the name starts with <parameter>~</parameter>, it
 318 refers to a file in the current users home directory.  Otherwise if the name
 319 doesn't start with '/', it refers to a file in the default configuration
 320 directory; the built-in default directory can be overridden with the
 321 FC_CONFIG_DIR environment variable.
 322 @@
 323
 324 @RET@           FcBool
 325 @FUNC@          FcConfigParseAndLoad
 326 @TYPE1@         FcConfig *                      @ARG1@          config
 327 @TYPE2@         const FcChar8 *                 @ARG2@          file
 328 @TYPE3@         FcBool%                         @ARG3@          complain
 329 @PURPOSE@       load a configuration file
 330 @DESC@
 331 Walks the configuration in 'file' and constructs the internal representation
 332 in 'config'.  Any include files referenced from within 'file' will be loaded
 333 and parsed.  If 'complain' is FcFalse, no warning will be displayed if
 334 'file' does not exist. Error and warning messages will be output to stderr.
 335 Returns FcFalse if some error occurred while loading the file, either a
 336 parse error, semantic error or allocation failure. Otherwise returns FcTrue.
 337 @@