X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=doc%2Ffcfile.fncs;h=5f5f32a8a27baffaa46f7832aaaea58b0dde741f;hb=00047ca256ef9a351039a0e900b8b784dc30e4c3;hp=2aa46e183ce5fb6eb24c7eb6716e9d9e650365ee;hpb=61895ed16c0c06e4d6b2abeb8ff292d53b4ea499;p=platform%2Fupstream%2Ffontconfig.git
diff --git a/doc/fcfile.fncs b/doc/fcfile.fncs
index 2aa46e1..5f5f32a 100644
--- a/doc/fcfile.fncs
+++ b/doc/fcfile.fncs
@@ -1,5 +1,5 @@
/*
- * $Id$
+ * fontconfig/doc/fcfile.fncs
*
* Copyright © 2003 Keith Packard
*
@@ -7,15 +7,15 @@
* documentation for any purpose is hereby granted without fee, provided that
* the above copyright notice appear in all copies and that both that
* copyright notice and this permission notice appear in supporting
- * documentation, and that the name of Keith Packard not be used in
+ * documentation, and that the name of the author(s) not be used in
* advertising or publicity pertaining to distribution of the software without
- * specific, written prior permission. Keith Packard makes no
+ * specific, written prior permission. The authors make no
* representations about the suitability of this software for any purpose. It
* is provided "as is" without express or implied warranty.
*
- * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
+ * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
* INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
- * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR
+ * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
* CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
* DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
* TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
@@ -28,15 +28,30 @@
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
-@TYPE5@ const char * @ARG5@ file
-@TYPE6@ FcBool% @ARG6@ force
+@TYPE5@ const FcChar8 * @ARG5@ file
+@TYPE6@ FcBool% @ARG6@ force
@PURPOSE@ scan a font file
@DESC@
Scans a single file and adds all fonts found to set.
If force is FcTrue, then the file is scanned even if
associated information is found in cache. If
file is a directory, it is added to
-dirs.
+dirs. Whether fonts are found depends on fontconfig
+policy as well as the current configuration. Internally, fontconfig will
+ignore BDF and PCF fonts which are not in Unicode (or the effectively
+equivalent ISO Latin-1) encoding as those are not usable by Unicode-based
+applications. The configuration can ignore fonts based on filename or
+contents of the font file itself. Returns FcFalse if any of the fonts cannot be
+added (due to allocation failure). Otherwise returns FcTrue.
+@@
+
+@RET@ FcBool
+@FUNC@ FcFileIsDir
+@TYPE1@ const FcChar8 * @ARG1@ file
+@PURPOSE@ check whether a file is a directory
+@DESC@
+Returns FcTrue if file is a directory, otherwise
+returns FcFalse.
@@
@RET@ FcBool
@@ -45,34 +60,29 @@ associated information is found in cache. If
@TYPE2@ FcStrSet * @ARG2@ dirs
@TYPE3@ FcFileCache * @ARG3@ cache
@TYPE4@ FcBlanks * @ARG4@ blanks
-@TYPE5@ const char * @ARG5@ dir
-@TYPE6@ FcBool% @ARG6@ force
-@PURPOSE@ scan a font directory
+@TYPE5@ const FcChar8 * @ARG5@ dir
+@TYPE6@ FcBool% @ARG6@ force
+@PURPOSE@ scan a font directory without caching it
@DESC@
-Scans an entire directory and adds all fonts found to
-set. If force is FcTrue, then
-the directory and all files within it are scanned even if information is
-present in the per-directory cache file or cache. Any
-subdirectories found are added to dirs.
+If cache is not zero or if force
+is FcFalse, this function currently returns FcFalse. Otherwise, it scans an
+entire directory and adds all fonts found to set.
+Any subdirectories found are added to dirs. Calling
+this function does not create any cache files. Use FcDirCacheRead() if
+caching is desired.
@@
@RET@ FcBool
@FUNC@ FcDirSave
@TYPE1@ FcFontSet * @ARG1@ set
@TYPE2@ FcStrSet * @ARG2@ dirs
-@TYPE3@ const char * @ARG3@ dir
-@PURPOSE@ save a directory cache
+@TYPE3@ const FcChar8 * @ARG3@ dir
+@PURPOSE@ DEPRECATED: formerly used to save a directory cache
@DESC@
-Creates the per-directory cache file for dir and
-populates it with the fonts in set and subdirectories
-in dirs.
+This function now does nothing aside from returning FcFalse. It used to creates the
+per-directory cache file for dir and populates it
+with the fonts in set and subdirectories in
+dirs. All of this functionality is now automatically
+managed by FcDirCacheLoad and FcDirCacheRead.
@@
-@RET@ FcBool
-@FUNC@ FcDirCacheValid
-@TYPE1@ const FcChar8 * @ARG1@ cache_file
-@PURPOSE@ check directory cache timestamp
-@DESC@
-Returns FcTrue if cache_file is no older than the
-directory containing it, else FcFalse.
-@@