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 policy as well as the current configuration. Internally, fontconfig will
  41 ignore BDF and PCF fonts which are not in Unicode (or the effectively
  42 equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
  43 applications. The configuration can ignore fonts based on filename or
  44 contents of the font file itself.
  45 @@
  46
  47 @RET@           FcBool
  48 @FUNC@          FcFileIsDir
  49 @TYPE1@         const FcChar8 *                 @ARG1@          file
  50 @PURPOSE@       check whether a file is a directory
  51 @DESC@
  52 Returns FcTrue if <parameter>file</parameter> is a directory, otherwise
  53 returns FcFalse.
  54 @@
  55
  56 @RET@           FcBool
  57 @FUNC@          FcDirScan
  58 @TYPE1@         FcFontSet *                     @ARG1@          set
  59 @TYPE2@         FcStrSet *                      @ARG2@          dirs
  60 @TYPE3@         FcFileCache *                   @ARG3@          cache
  61 @TYPE4@         FcBlanks *                      @ARG4@          blanks
  62 @TYPE5@         const char *                    @ARG5@          dir
  63 @TYPE6@         FcBool%                                 @ARG6@          force
  64 @PURPOSE@       scan a font directory
  65 @DESC@
  66 Scans an entire directory and adds all fonts found to
  67 <parameter>set</parameter>.  If <parameter>force</parameter> is FcTrue, then
  68 the directory and all files within it are scanned even if information is
  69 present in the per-directory cache file or <parameter>cache</parameter>.  Any
  70 subdirectories found are added to <parameter>dirs</parameter>. See the
  71 manual for <function>FcFileScan</function> for a description of how
  72 fontconfig selects which fonts to include.
  73 @@
  74
  75 @RET@           FcBool
  76 @FUNC@          FcDirSave
  77 @TYPE1@         FcFontSet *                     @ARG1@          set
  78 @TYPE2@         FcStrSet *                      @ARG2@          dirs
  79 @TYPE3@         const char *                    @ARG3@          dir
  80 @PURPOSE@       save a directory cache
  81 @DESC@
  82 Creates the per-directory cache file for <parameter>dir</parameter> and
  83 populates it with the fonts in <parameter>set</parameter> and subdirectories
  84 in <parameter>dirs</parameter>.
  85 @@
  86