fcfile.fncs revision ca08ab68 
1/*
2 * fontconfig/doc/fcfile.fncs
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 the author(s) not be used in
11 * advertising or publicity pertaining to distribution of the software without
12 * specific, written prior permission.  The authors make 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 * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
17 * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
18 * EVENT SHALL THE AUTHOR(S) 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 FcChar8 *			@ARG5@		file	
32@TYPE6@		FcBool% 			@ARG6@		force
33@PURPOSE@	scan a font file
34@DESC@
35Scans a single file and adds all fonts found to <parameter>set</parameter>.
36If <parameter>force</parameter> is FcTrue, then the file is scanned even if
37associated 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
40policy as well as the current configuration. Internally, fontconfig will
41ignore BDF and PCF fonts which are not in Unicode (or the effectively
42equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
43applications. The configuration can ignore fonts based on filename or
44contents of the font file itself. Returns FcFalse if any of the fonts cannot be
45added (due to allocation failure). Otherwise returns FcTrue.
46@@
47
48@RET@		FcBool
49@FUNC@		FcFileIsDir
50@TYPE1@		const FcChar8 *			@ARG1@		file
51@PURPOSE@	check whether a file is a directory
52@DESC@
53Returns FcTrue if <parameter>file</parameter> is a directory, otherwise
54returns FcFalse.
55@@
56
57@RET@		FcBool 	
58@FUNC@		FcDirScan 
59@TYPE1@		FcFontSet *			@ARG1@		set	
60@TYPE2@		FcStrSet *			@ARG2@		dirs	
61@TYPE3@		FcFileCache *			@ARG3@		cache	
62@TYPE4@		FcBlanks *			@ARG4@		blanks	
63@TYPE5@		const FcChar8 *			@ARG5@		dir	
64@TYPE6@		FcBool% 			@ARG6@		force
65@PURPOSE@	scan a font directory without caching it
66@DESC@
67If <parameter>cache</parameter> is not zero or if <parameter>force</parameter>
68is FcFalse, this function currently returns FcFalse.  Otherwise, it scans an
69entire directory and adds all fonts found to <parameter>set</parameter>.
70Any subdirectories found are added to <parameter>dirs</parameter>.  Calling
71this function does not create any cache files.  Use FcDirCacheRead() if
72caching is desired.
73@@
74
75@RET@		FcBool 	
76@FUNC@		FcDirSave 
77@TYPE1@		FcFontSet *			@ARG1@		set	
78@TYPE2@		FcStrSet *			@ARG2@		dirs	
79@TYPE3@		const FcChar8 *			@ARG3@		dir	
80@PURPOSE@	DEPRECATED: formerly used to save a directory cache
81@DESC@
82This function now does nothing aside from returning FcFalse. It used to creates the
83per-directory cache file for <parameter>dir</parameter> and populates it
84with the fonts in <parameter>set</parameter> and subdirectories in
85<parameter>dirs</parameter>. All of this functionality is now automatically
86managed by FcDirCacheLoad and FcDirCacheRead.
87@@
88
89