doc/fcfile.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
  25 @RET@           FcBool
  26 @FUNC@          FcFileScan
  27 @TYPE1@         FcFontSet *                     @ARG1@          set
  28 @TYPE2@         FcStrSet *                      @ARG2@          dirs
  29 @TYPE3@         FcFileCache *                   @ARG3@          cache
  30 @TYPE4@         FcBlanks *                      @ARG4@          blanks
  31 @TYPE5@         const char *                    @ARG5@          file
  32 @TYPE6@         FcBool%                                 @ARG6@          force
  33 @PURPOSE@       scan a font file
  34 @DESC@
  35 Scans a single file and adds all fonts found to <parameter>set</parameter>.
  36 If <parameter>force</parameter> is FcTrue, then the file is scanned even if
  37 associated information is found in <parameter>cache</parameter>.  If
  38 <parameter>file</parameter> is a directory, it is added to
  39 <parameter>dirs</parameter>. Whether fonts are found depends on fontconfig
  40 poliy as well as the current configuration.
  41 @@
  42
  43 @RET@           FcBool
  44 @FUNC@          FcDirScan
  45 @TYPE1@         FcFontSet *                     @ARG1@          set
  46 @TYPE2@         FcStrSet *                      @ARG2@          dirs
  47 @TYPE3@         FcFileCache *                   @ARG3@          cache
  48 @TYPE4@         FcBlanks *                      @ARG4@          blanks
  49 @TYPE5@         const char *                    @ARG5@          dir
  50 @TYPE6@         FcBool%                                 @ARG6@          force
  51 @PURPOSE@       scan a font directory
  52 @DESC@
  53 Scans an entire directory and adds all fonts found to
  54 <parameter>set</parameter>.  If <parameter>force</parameter> is FcTrue, then
  55 the directory and all files within it are scanned even if information is
  56 present in the per-directory cache file or <parameter>cache</parameter>.  Any
  57 subdirectories found are added to <parameter>dirs</parameter>. Whether fonts
  58 or directories are found depends on fontconfig
  59 policy as well as the current configuration.
  60 @@
  61
  62 @RET@           FcBool
  63 @FUNC@          FcDirSave
  64 @TYPE1@         FcFontSet *                     @ARG1@          set
  65 @TYPE2@         FcStrSet *                      @ARG2@          dirs
  66 @TYPE3@         const char *                    @ARG3@          dir
  67 @PURPOSE@       save a directory cache
  68 @DESC@
  69 Creates the per-directory cache file for <parameter>dir</parameter> and
  70 populates it with the fonts in <parameter>set</parameter> and subdirectories
  71 in <parameter>dirs</parameter>.
  72 @@
  73
  74 @RET@           FcBool
  75 @FUNC@          FcDirCacheValid
  76 @TYPE1@         const FcChar8 *                 @ARG1@          cache_file
  77 @PURPOSE@       check directory cache timestamp
  78 @DESC@
  79 Returns FcTrue if <parameter>cache_file</parameter> is no older than the
  80 directory containing it, else FcFalse.
  81 @@