Merge branch 'upstream' into tizen
[platform/upstream/fontconfig.git] / doc / fcstring.sgml
1 <!--
2    fontconfig/doc/func.sgml
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     <refentry id="FcUtf8ToUcs4">
25         <refmeta>
26             <refentrytitle>FcUtf8ToUcs4</refentrytitle>
27             <manvolnum>3</manvolnum>
28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
29         </refmeta>
30         <refnamediv>
31             <refname>FcUtf8ToUcs4</refname>
32             <refpurpose>convert UTF-8 to UCS4</refpurpose>
33         </refnamediv>
34         <refsynopsisdiv>
35         <funcsynopsis>
36         <funcsynopsisinfo>
37 #include &lt;fontconfig/fontconfig.h&gt;
38         </funcsynopsisinfo>
39         <funcprototype>
40             <funcdef>int <function>FcUtf8ToUcs4</function></funcdef>
41                 <paramdef>FcChar8 *<parameter>src</parameter></paramdef>
42                 <paramdef>FcChar32 *<parameter>dst</parameter></paramdef>
43                 <paramdef>int <parameter>len</parameter></paramdef>
44         </funcprototype>
45         </funcsynopsis>
46         </refsynopsisdiv>
47         <refsect1><title>Description</title>
48             <para>
49 Converts the next Unicode char from <parameter>src</parameter> into
50 <parameter>dst</parameter> and returns the number of bytes containing the
51 char.  <parameter>src</parameter> must be at least
52 <parameter>len</parameter> bytes long.
53             </para>
54         </refsect1>
55     </refentry>
56 <!--
57    fontconfig/doc/func.sgml
58   
59    Copyright © 2003 Keith Packard
60   
61    Permission to use, copy, modify, distribute, and sell this software and its
62    documentation for any purpose is hereby granted without fee, provided that
63    the above copyright notice appear in all copies and that both that
64    copyright notice and this permission notice appear in supporting
65    documentation, and that the name of the author(s) not be used in
66    advertising or publicity pertaining to distribution of the software without
67    specific, written prior permission.  The authors make no
68    representations about the suitability of this software for any purpose.  It
69    is provided "as is" without express or implied warranty.
70   
71    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
72    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
73    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
74    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
75    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
76    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
77    PERFORMANCE OF THIS SOFTWARE.
78  -->
79     <refentry id="FcUcs4ToUtf8">
80         <refmeta>
81             <refentrytitle>FcUcs4ToUtf8</refentrytitle>
82             <manvolnum>3</manvolnum>
83             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
84         </refmeta>
85         <refnamediv>
86             <refname>FcUcs4ToUtf8</refname>
87             <refpurpose>convert UCS4 to UTF-8</refpurpose>
88         </refnamediv>
89         <refsynopsisdiv>
90         <funcsynopsis>
91         <funcsynopsisinfo>
92 #include &lt;fontconfig/fontconfig.h&gt;
93         </funcsynopsisinfo>
94         <funcprototype>
95             <funcdef>int <function>FcUcs4ToUtf8</function></funcdef>
96                 <paramdef>FcChar32 <parameter>src</parameter></paramdef>
97                 <paramdef>FcChar8 <parameter>dst[FC_UTF8_MAX_LEN]</parameter></paramdef>
98         </funcprototype>
99         </funcsynopsis>
100         </refsynopsisdiv>
101         <refsect1><title>Description</title>
102             <para>
103 Converts the Unicode char from <parameter>src</parameter> into
104 <parameter>dst</parameter> and returns the number of bytes needed to encode
105 the char.
106             </para>
107         </refsect1>
108     </refentry>
109 <!--
110    fontconfig/doc/func.sgml
111   
112    Copyright © 2003 Keith Packard
113   
114    Permission to use, copy, modify, distribute, and sell this software and its
115    documentation for any purpose is hereby granted without fee, provided that
116    the above copyright notice appear in all copies and that both that
117    copyright notice and this permission notice appear in supporting
118    documentation, and that the name of the author(s) not be used in
119    advertising or publicity pertaining to distribution of the software without
120    specific, written prior permission.  The authors make no
121    representations about the suitability of this software for any purpose.  It
122    is provided "as is" without express or implied warranty.
123   
124    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
125    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
126    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
127    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
128    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
129    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
130    PERFORMANCE OF THIS SOFTWARE.
131  -->
132     <refentry id="FcUtf8Len">
133         <refmeta>
134             <refentrytitle>FcUtf8Len</refentrytitle>
135             <manvolnum>3</manvolnum>
136             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
137         </refmeta>
138         <refnamediv>
139             <refname>FcUtf8Len</refname>
140             <refpurpose>count UTF-8 encoded chars</refpurpose>
141         </refnamediv>
142         <refsynopsisdiv>
143         <funcsynopsis>
144         <funcsynopsisinfo>
145 #include &lt;fontconfig/fontconfig.h&gt;
146         </funcsynopsisinfo>
147         <funcprototype>
148             <funcdef>FcBool <function>FcUtf8Len</function></funcdef>
149                 <paramdef>FcChar8 *<parameter>src</parameter></paramdef>
150                 <paramdef>int <parameter>len</parameter></paramdef>
151                 <paramdef>int *<parameter>nchar</parameter></paramdef>
152                 <paramdef>int *<parameter>wchar</parameter></paramdef>
153         </funcprototype>
154         </funcsynopsis>
155         </refsynopsisdiv>
156         <refsect1><title>Description</title>
157             <para>
158 Counts the number of Unicode chars in <parameter>len</parameter> bytes of
159 <parameter>src</parameter>.  Places that count in
160 <parameter>nchar</parameter>.  <parameter>wchar</parameter> contains 1, 2 or
161 4 depending on the number of bytes needed to hold the largest Unicode char
162 counted.  The return value indicates whether <parameter>src</parameter> is a
163 well-formed UTF8 string.
164             </para>
165         </refsect1>
166     </refentry>
167 <!--
168    fontconfig/doc/func.sgml
169   
170    Copyright © 2003 Keith Packard
171   
172    Permission to use, copy, modify, distribute, and sell this software and its
173    documentation for any purpose is hereby granted without fee, provided that
174    the above copyright notice appear in all copies and that both that
175    copyright notice and this permission notice appear in supporting
176    documentation, and that the name of the author(s) not be used in
177    advertising or publicity pertaining to distribution of the software without
178    specific, written prior permission.  The authors make no
179    representations about the suitability of this software for any purpose.  It
180    is provided "as is" without express or implied warranty.
181   
182    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
183    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
184    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
185    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
186    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
187    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
188    PERFORMANCE OF THIS SOFTWARE.
189  -->
190     <refentry id="FcUtf16ToUcs4">
191         <refmeta>
192             <refentrytitle>FcUtf16ToUcs4</refentrytitle>
193             <manvolnum>3</manvolnum>
194             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
195         </refmeta>
196         <refnamediv>
197             <refname>FcUtf16ToUcs4</refname>
198             <refpurpose>convert UTF-16 to UCS4</refpurpose>
199         </refnamediv>
200         <refsynopsisdiv>
201         <funcsynopsis>
202         <funcsynopsisinfo>
203 #include &lt;fontconfig/fontconfig.h&gt;
204         </funcsynopsisinfo>
205         <funcprototype>
206             <funcdef>int <function>FcUtf16ToUcs4</function></funcdef>
207                 <paramdef>FcChar8 *<parameter>src</parameter></paramdef>
208                 <paramdef>FcEndian <parameter>endian</parameter></paramdef>
209                 <paramdef>FcChar32 *<parameter>dst</parameter></paramdef>
210                 <paramdef>int <parameter>len</parameter></paramdef>
211         </funcprototype>
212         </funcsynopsis>
213         </refsynopsisdiv>
214         <refsect1><title>Description</title>
215             <para>
216 Converts the next Unicode char from <parameter>src</parameter> into
217 <parameter>dst</parameter> and returns the number of bytes containing the
218 char. <parameter>src</parameter> must be at least <parameter>len</parameter>
219 bytes long.  Bytes of <parameter>src</parameter> are combined into 16-bit
220 units according to <parameter>endian</parameter>.
221             </para>
222         </refsect1>
223     </refentry>
224 <!--
225    fontconfig/doc/func.sgml
226   
227    Copyright © 2003 Keith Packard
228   
229    Permission to use, copy, modify, distribute, and sell this software and its
230    documentation for any purpose is hereby granted without fee, provided that
231    the above copyright notice appear in all copies and that both that
232    copyright notice and this permission notice appear in supporting
233    documentation, and that the name of the author(s) not be used in
234    advertising or publicity pertaining to distribution of the software without
235    specific, written prior permission.  The authors make no
236    representations about the suitability of this software for any purpose.  It
237    is provided "as is" without express or implied warranty.
238   
239    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
240    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
241    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
242    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
243    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
244    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
245    PERFORMANCE OF THIS SOFTWARE.
246  -->
247     <refentry id="FcUtf16Len">
248         <refmeta>
249             <refentrytitle>FcUtf16Len</refentrytitle>
250             <manvolnum>3</manvolnum>
251             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
252         </refmeta>
253         <refnamediv>
254             <refname>FcUtf16Len</refname>
255             <refpurpose>count UTF-16 encoded chars</refpurpose>
256         </refnamediv>
257         <refsynopsisdiv>
258         <funcsynopsis>
259         <funcsynopsisinfo>
260 #include &lt;fontconfig/fontconfig.h&gt;
261         </funcsynopsisinfo>
262         <funcprototype>
263             <funcdef>FcBool <function>FcUtf16Len</function></funcdef>
264                 <paramdef>FcChar8 *<parameter>src</parameter></paramdef>
265                 <paramdef>FcEndian <parameter>endian</parameter></paramdef>
266                 <paramdef>int <parameter>len</parameter></paramdef>
267                 <paramdef>int *<parameter>nchar</parameter></paramdef>
268                 <paramdef>int *<parameter>wchar</parameter></paramdef>
269         </funcprototype>
270         </funcsynopsis>
271         </refsynopsisdiv>
272         <refsect1><title>Description</title>
273             <para>
274 Counts the number of Unicode chars in <parameter>len</parameter> bytes of
275 <parameter>src</parameter>.  Bytes of <parameter>src</parameter> are
276 combined into 16-bit units according to <parameter>endian</parameter>.
277 Places that count in <parameter>nchar</parameter>.
278 <parameter>wchar</parameter> contains 1, 2 or 4 depending on the number of
279 bytes needed to hold the largest Unicode char counted.  The return value
280 indicates whether <parameter>string</parameter> is a well-formed UTF16
281 string.
282             </para>
283         </refsect1>
284     </refentry>
285 <!--
286    fontconfig/doc/func.sgml
287   
288    Copyright © 2003 Keith Packard
289   
290    Permission to use, copy, modify, distribute, and sell this software and its
291    documentation for any purpose is hereby granted without fee, provided that
292    the above copyright notice appear in all copies and that both that
293    copyright notice and this permission notice appear in supporting
294    documentation, and that the name of the author(s) not be used in
295    advertising or publicity pertaining to distribution of the software without
296    specific, written prior permission.  The authors make no
297    representations about the suitability of this software for any purpose.  It
298    is provided "as is" without express or implied warranty.
299   
300    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
301    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
302    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
303    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
304    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
305    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
306    PERFORMANCE OF THIS SOFTWARE.
307  -->
308     <refentry id="FcIsLower">
309         <refmeta>
310             <refentrytitle>FcIsLower</refentrytitle>
311             <manvolnum>3</manvolnum>
312             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
313         </refmeta>
314         <refnamediv>
315             <refname>FcIsLower</refname>
316             <refpurpose>check for lower case ASCII character</refpurpose>
317         </refnamediv>
318         <refsynopsisdiv>
319         <funcsynopsis>
320         <funcsynopsisinfo>
321 #include &lt;fontconfig/fontconfig.h&gt;
322         </funcsynopsisinfo>
323         <funcprototype>
324             <funcdef>FcBool <function>FcIsLower</function></funcdef>
325                 <paramdef>FcChar8<parameter>c</parameter></paramdef>
326         </funcprototype>
327         </funcsynopsis>
328         </refsynopsisdiv>
329         <refsect1><title>Description</title>
330             <para>
331 This macro checks whether <parameter>c</parameter> is an lower case ASCII
332 letter.
333             </para>
334         </refsect1>
335     </refentry>
336 <!--
337    fontconfig/doc/func.sgml
338   
339    Copyright © 2003 Keith Packard
340   
341    Permission to use, copy, modify, distribute, and sell this software and its
342    documentation for any purpose is hereby granted without fee, provided that
343    the above copyright notice appear in all copies and that both that
344    copyright notice and this permission notice appear in supporting
345    documentation, and that the name of the author(s) not be used in
346    advertising or publicity pertaining to distribution of the software without
347    specific, written prior permission.  The authors make no
348    representations about the suitability of this software for any purpose.  It
349    is provided "as is" without express or implied warranty.
350   
351    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
352    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
353    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
354    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
355    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
356    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
357    PERFORMANCE OF THIS SOFTWARE.
358  -->
359     <refentry id="FcIsUpper">
360         <refmeta>
361             <refentrytitle>FcIsUpper</refentrytitle>
362             <manvolnum>3</manvolnum>
363             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
364         </refmeta>
365         <refnamediv>
366             <refname>FcIsUpper</refname>
367             <refpurpose>check for upper case ASCII character</refpurpose>
368         </refnamediv>
369         <refsynopsisdiv>
370         <funcsynopsis>
371         <funcsynopsisinfo>
372 #include &lt;fontconfig/fontconfig.h&gt;
373         </funcsynopsisinfo>
374         <funcprototype>
375             <funcdef>FcBool <function>FcIsUpper</function></funcdef>
376                 <paramdef>FcChar8<parameter>c</parameter></paramdef>
377         </funcprototype>
378         </funcsynopsis>
379         </refsynopsisdiv>
380         <refsect1><title>Description</title>
381             <para>
382 This macro checks whether <parameter>c</parameter> is a upper case ASCII
383 letter.
384             </para>
385         </refsect1>
386     </refentry>
387 <!--
388    fontconfig/doc/func.sgml
389   
390    Copyright © 2003 Keith Packard
391   
392    Permission to use, copy, modify, distribute, and sell this software and its
393    documentation for any purpose is hereby granted without fee, provided that
394    the above copyright notice appear in all copies and that both that
395    copyright notice and this permission notice appear in supporting
396    documentation, and that the name of the author(s) not be used in
397    advertising or publicity pertaining to distribution of the software without
398    specific, written prior permission.  The authors make no
399    representations about the suitability of this software for any purpose.  It
400    is provided "as is" without express or implied warranty.
401   
402    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
403    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
404    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
405    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
406    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
407    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
408    PERFORMANCE OF THIS SOFTWARE.
409  -->
410     <refentry id="FcToLower">
411         <refmeta>
412             <refentrytitle>FcToLower</refentrytitle>
413             <manvolnum>3</manvolnum>
414             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
415         </refmeta>
416         <refnamediv>
417             <refname>FcToLower</refname>
418             <refpurpose>convert upper case ASCII to lower case</refpurpose>
419         </refnamediv>
420         <refsynopsisdiv>
421         <funcsynopsis>
422         <funcsynopsisinfo>
423 #include &lt;fontconfig/fontconfig.h&gt;
424         </funcsynopsisinfo>
425         <funcprototype>
426             <funcdef>FcChar8 <function>FcToLower</function></funcdef>
427                 <paramdef>FcChar8<parameter>c</parameter></paramdef>
428         </funcprototype>
429         </funcsynopsis>
430         </refsynopsisdiv>
431         <refsect1><title>Description</title>
432             <para>
433 This macro converts upper case ASCII <parameter>c</parameter> to the
434 equivalent lower case letter.
435             </para>
436         </refsect1>
437     </refentry>
438 <!--
439    fontconfig/doc/func.sgml
440   
441    Copyright © 2003 Keith Packard
442   
443    Permission to use, copy, modify, distribute, and sell this software and its
444    documentation for any purpose is hereby granted without fee, provided that
445    the above copyright notice appear in all copies and that both that
446    copyright notice and this permission notice appear in supporting
447    documentation, and that the name of the author(s) not be used in
448    advertising or publicity pertaining to distribution of the software without
449    specific, written prior permission.  The authors make no
450    representations about the suitability of this software for any purpose.  It
451    is provided "as is" without express or implied warranty.
452   
453    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
454    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
455    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
456    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
457    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
458    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
459    PERFORMANCE OF THIS SOFTWARE.
460  -->
461     <refentry id="FcStrCopy">
462         <refmeta>
463             <refentrytitle>FcStrCopy</refentrytitle>
464             <manvolnum>3</manvolnum>
465             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
466         </refmeta>
467         <refnamediv>
468             <refname>FcStrCopy</refname>
469             <refpurpose>duplicate a string</refpurpose>
470         </refnamediv>
471         <refsynopsisdiv>
472         <funcsynopsis>
473         <funcsynopsisinfo>
474 #include &lt;fontconfig/fontconfig.h&gt;
475         </funcsynopsisinfo>
476         <funcprototype>
477             <funcdef>FcChar8 * <function>FcStrCopy</function></funcdef>
478                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
479         </funcprototype>
480         </funcsynopsis>
481         </refsynopsisdiv>
482         <refsect1><title>Description</title>
483             <para>
484 Allocates memory, copies <parameter>s</parameter> and returns the resulting
485 buffer.  Yes, this is <function>strdup</function>, but that function isn't
486 available on every platform.
487             </para>
488         </refsect1>
489     </refentry>
490 <!--
491    fontconfig/doc/func.sgml
492   
493    Copyright © 2003 Keith Packard
494   
495    Permission to use, copy, modify, distribute, and sell this software and its
496    documentation for any purpose is hereby granted without fee, provided that
497    the above copyright notice appear in all copies and that both that
498    copyright notice and this permission notice appear in supporting
499    documentation, and that the name of the author(s) not be used in
500    advertising or publicity pertaining to distribution of the software without
501    specific, written prior permission.  The authors make no
502    representations about the suitability of this software for any purpose.  It
503    is provided "as is" without express or implied warranty.
504   
505    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
506    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
507    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
508    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
509    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
510    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
511    PERFORMANCE OF THIS SOFTWARE.
512  -->
513     <refentry id="FcStrDowncase">
514         <refmeta>
515             <refentrytitle>FcStrDowncase</refentrytitle>
516             <manvolnum>3</manvolnum>
517             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
518         </refmeta>
519         <refnamediv>
520             <refname>FcStrDowncase</refname>
521             <refpurpose>create a lower case translation of a string</refpurpose>
522         </refnamediv>
523         <refsynopsisdiv>
524         <funcsynopsis>
525         <funcsynopsisinfo>
526 #include &lt;fontconfig/fontconfig.h&gt;
527         </funcsynopsisinfo>
528         <funcprototype>
529             <funcdef>FcChar8 * <function>FcStrDowncase</function></funcdef>
530                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
531         </funcprototype>
532         </funcsynopsis>
533         </refsynopsisdiv>
534         <refsect1><title>Description</title>
535             <para>
536 Allocates memory, copies <parameter>s</parameter>, converting upper case
537 letters to lower case and returns the allocated buffer.
538             </para>
539         </refsect1>
540     </refentry>
541 <!--
542    fontconfig/doc/func.sgml
543   
544    Copyright © 2003 Keith Packard
545   
546    Permission to use, copy, modify, distribute, and sell this software and its
547    documentation for any purpose is hereby granted without fee, provided that
548    the above copyright notice appear in all copies and that both that
549    copyright notice and this permission notice appear in supporting
550    documentation, and that the name of the author(s) not be used in
551    advertising or publicity pertaining to distribution of the software without
552    specific, written prior permission.  The authors make no
553    representations about the suitability of this software for any purpose.  It
554    is provided "as is" without express or implied warranty.
555   
556    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
557    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
558    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
559    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
560    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
561    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
562    PERFORMANCE OF THIS SOFTWARE.
563  -->
564     <refentry id="FcStrCopyFilename">
565         <refmeta>
566             <refentrytitle>FcStrCopyFilename</refentrytitle>
567             <manvolnum>3</manvolnum>
568             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
569         </refmeta>
570         <refnamediv>
571             <refname>FcStrCopyFilename</refname>
572             <refpurpose>create a complete path from a filename</refpurpose>
573         </refnamediv>
574         <refsynopsisdiv>
575         <funcsynopsis>
576         <funcsynopsisinfo>
577 #include &lt;fontconfig/fontconfig.h&gt;
578         </funcsynopsisinfo>
579         <funcprototype>
580             <funcdef>FcChar8 * <function>FcStrCopyFilename</function></funcdef>
581                 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
582         </funcprototype>
583         </funcsynopsis>
584         </refsynopsisdiv>
585         <refsect1><title>Description</title>
586             <para>
587 <function>FcStrCopyFilename</function> constructs an absolute pathname from
588 <parameter>s</parameter>. It converts any leading '~' characters in
589 to the value of the HOME environment variable, and any relative paths are
590 converted to absolute paths using the current working directory. Sequences
591 of '/' characters are converted to a single '/', and names containing the
592 current directory '.' or parent directory '..' are correctly reconstructed.
593 Returns NULL if '~' is the leading character and HOME is unset or disabled
594 (see <function>FcConfigEnableHome</function>).
595             </para>
596         </refsect1>
597     </refentry>
598 <!--
599    fontconfig/doc/func.sgml
600   
601    Copyright © 2003 Keith Packard
602   
603    Permission to use, copy, modify, distribute, and sell this software and its
604    documentation for any purpose is hereby granted without fee, provided that
605    the above copyright notice appear in all copies and that both that
606    copyright notice and this permission notice appear in supporting
607    documentation, and that the name of the author(s) not be used in
608    advertising or publicity pertaining to distribution of the software without
609    specific, written prior permission.  The authors make no
610    representations about the suitability of this software for any purpose.  It
611    is provided "as is" without express or implied warranty.
612   
613    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
614    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
615    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
616    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
617    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
618    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
619    PERFORMANCE OF THIS SOFTWARE.
620  -->
621     <refentry id="FcStrCmp">
622         <refmeta>
623             <refentrytitle>FcStrCmp</refentrytitle>
624             <manvolnum>3</manvolnum>
625             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
626         </refmeta>
627         <refnamediv>
628             <refname>FcStrCmp</refname>
629             <refpurpose>compare UTF-8 strings</refpurpose>
630         </refnamediv>
631         <refsynopsisdiv>
632         <funcsynopsis>
633         <funcsynopsisinfo>
634 #include &lt;fontconfig/fontconfig.h&gt;
635         </funcsynopsisinfo>
636         <funcprototype>
637             <funcdef>int <function>FcStrCmp</function></funcdef>
638                 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
639                 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
640         </funcprototype>
641         </funcsynopsis>
642         </refsynopsisdiv>
643         <refsect1><title>Description</title>
644             <para>
645 Returns the usual &lt;0, 0, &gt;0 result of comparing
646 <parameter>s1</parameter> and <parameter>s2</parameter>.
647             </para>
648         </refsect1>
649     </refentry>
650 <!--
651    fontconfig/doc/func.sgml
652   
653    Copyright © 2003 Keith Packard
654   
655    Permission to use, copy, modify, distribute, and sell this software and its
656    documentation for any purpose is hereby granted without fee, provided that
657    the above copyright notice appear in all copies and that both that
658    copyright notice and this permission notice appear in supporting
659    documentation, and that the name of the author(s) not be used in
660    advertising or publicity pertaining to distribution of the software without
661    specific, written prior permission.  The authors make no
662    representations about the suitability of this software for any purpose.  It
663    is provided "as is" without express or implied warranty.
664   
665    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
666    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
667    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
668    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
669    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
670    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
671    PERFORMANCE OF THIS SOFTWARE.
672  -->
673     <refentry id="FcStrCmpIgnoreCase">
674         <refmeta>
675             <refentrytitle>FcStrCmpIgnoreCase</refentrytitle>
676             <manvolnum>3</manvolnum>
677             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
678         </refmeta>
679         <refnamediv>
680             <refname>FcStrCmpIgnoreCase</refname>
681             <refpurpose>compare UTF-8 strings ignoring case</refpurpose>
682         </refnamediv>
683         <refsynopsisdiv>
684         <funcsynopsis>
685         <funcsynopsisinfo>
686 #include &lt;fontconfig/fontconfig.h&gt;
687         </funcsynopsisinfo>
688         <funcprototype>
689             <funcdef>int <function>FcStrCmpIgnoreCase</function></funcdef>
690                 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
691                 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
692         </funcprototype>
693         </funcsynopsis>
694         </refsynopsisdiv>
695         <refsect1><title>Description</title>
696             <para>
697 Returns the usual &lt;0, 0, &gt;0 result of comparing
698 <parameter>s1</parameter> and <parameter>s2</parameter>. This test is
699 case-insensitive for all proper UTF-8 encoded strings.
700             </para>
701         </refsect1>
702     </refentry>
703 <!--
704    fontconfig/doc/func.sgml
705   
706    Copyright © 2003 Keith Packard
707   
708    Permission to use, copy, modify, distribute, and sell this software and its
709    documentation for any purpose is hereby granted without fee, provided that
710    the above copyright notice appear in all copies and that both that
711    copyright notice and this permission notice appear in supporting
712    documentation, and that the name of the author(s) not be used in
713    advertising or publicity pertaining to distribution of the software without
714    specific, written prior permission.  The authors make no
715    representations about the suitability of this software for any purpose.  It
716    is provided "as is" without express or implied warranty.
717   
718    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
719    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
720    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
721    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
722    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
723    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
724    PERFORMANCE OF THIS SOFTWARE.
725  -->
726     <refentry id="FcStrStr">
727         <refmeta>
728             <refentrytitle>FcStrStr</refentrytitle>
729             <manvolnum>3</manvolnum>
730             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
731         </refmeta>
732         <refnamediv>
733             <refname>FcStrStr</refname>
734             <refpurpose>locate UTF-8 substring</refpurpose>
735         </refnamediv>
736         <refsynopsisdiv>
737         <funcsynopsis>
738         <funcsynopsisinfo>
739 #include &lt;fontconfig/fontconfig.h&gt;
740         </funcsynopsisinfo>
741         <funcprototype>
742             <funcdef>FcChar8 * <function>FcStrStr</function></funcdef>
743                 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
744                 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
745         </funcprototype>
746         </funcsynopsis>
747         </refsynopsisdiv>
748         <refsect1><title>Description</title>
749             <para>
750 Returns the location of <parameter>s2</parameter> in
751 <parameter>s1</parameter>.  Returns NULL if <parameter>s2</parameter>
752 is not present in <parameter>s1</parameter>. This test will operate properly
753 with UTF8 encoded strings.
754             </para>
755         </refsect1>
756     </refentry>
757 <!--
758    fontconfig/doc/func.sgml
759   
760    Copyright © 2003 Keith Packard
761   
762    Permission to use, copy, modify, distribute, and sell this software and its
763    documentation for any purpose is hereby granted without fee, provided that
764    the above copyright notice appear in all copies and that both that
765    copyright notice and this permission notice appear in supporting
766    documentation, and that the name of the author(s) not be used in
767    advertising or publicity pertaining to distribution of the software without
768    specific, written prior permission.  The authors make no
769    representations about the suitability of this software for any purpose.  It
770    is provided "as is" without express or implied warranty.
771   
772    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
773    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
774    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
775    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
776    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
777    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
778    PERFORMANCE OF THIS SOFTWARE.
779  -->
780     <refentry id="FcStrStrIgnoreCase">
781         <refmeta>
782             <refentrytitle>FcStrStrIgnoreCase</refentrytitle>
783             <manvolnum>3</manvolnum>
784             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
785         </refmeta>
786         <refnamediv>
787             <refname>FcStrStrIgnoreCase</refname>
788             <refpurpose>locate UTF-8 substring ignoring ASCII case</refpurpose>
789         </refnamediv>
790         <refsynopsisdiv>
791         <funcsynopsis>
792         <funcsynopsisinfo>
793 #include &lt;fontconfig/fontconfig.h&gt;
794         </funcsynopsisinfo>
795         <funcprototype>
796             <funcdef>FcChar8 * <function>FcStrStrIgnoreCase</function></funcdef>
797                 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
798                 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
799         </funcprototype>
800         </funcsynopsis>
801         </refsynopsisdiv>
802         <refsect1><title>Description</title>
803             <para>
804 Returns the location of <parameter>s2</parameter> in 
805 <parameter>s1</parameter>, ignoring case.  Returns NULL if
806 <parameter>s2</parameter> is not present in <parameter>s1</parameter>.
807 This test is case-insensitive for all proper UTF-8 encoded strings.
808             </para>
809         </refsect1>
810     </refentry>
811 <!--
812    fontconfig/doc/func.sgml
813   
814    Copyright © 2003 Keith Packard
815   
816    Permission to use, copy, modify, distribute, and sell this software and its
817    documentation for any purpose is hereby granted without fee, provided that
818    the above copyright notice appear in all copies and that both that
819    copyright notice and this permission notice appear in supporting
820    documentation, and that the name of the author(s) not be used in
821    advertising or publicity pertaining to distribution of the software without
822    specific, written prior permission.  The authors make no
823    representations about the suitability of this software for any purpose.  It
824    is provided "as is" without express or implied warranty.
825   
826    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
827    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
828    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
829    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
830    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
831    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
832    PERFORMANCE OF THIS SOFTWARE.
833  -->
834     <refentry id="FcStrPlus">
835         <refmeta>
836             <refentrytitle>FcStrPlus</refentrytitle>
837             <manvolnum>3</manvolnum>
838             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
839         </refmeta>
840         <refnamediv>
841             <refname>FcStrPlus</refname>
842             <refpurpose>concatenate two strings</refpurpose>
843         </refnamediv>
844         <refsynopsisdiv>
845         <funcsynopsis>
846         <funcsynopsisinfo>
847 #include &lt;fontconfig/fontconfig.h&gt;
848         </funcsynopsisinfo>
849         <funcprototype>
850             <funcdef>FcChar8 * <function>FcStrPlus</function></funcdef>
851                 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
852                 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
853         </funcprototype>
854         </funcsynopsis>
855         </refsynopsisdiv>
856         <refsect1><title>Description</title>
857             <para>
858 This function allocates new storage and places the concatenation of
859 <parameter>s1</parameter> and <parameter>s2</parameter> there, returning the
860 new string.
861             </para>
862         </refsect1>
863     </refentry>
864 <!--
865    fontconfig/doc/func.sgml
866   
867    Copyright © 2003 Keith Packard
868   
869    Permission to use, copy, modify, distribute, and sell this software and its
870    documentation for any purpose is hereby granted without fee, provided that
871    the above copyright notice appear in all copies and that both that
872    copyright notice and this permission notice appear in supporting
873    documentation, and that the name of the author(s) not be used in
874    advertising or publicity pertaining to distribution of the software without
875    specific, written prior permission.  The authors make no
876    representations about the suitability of this software for any purpose.  It
877    is provided "as is" without express or implied warranty.
878   
879    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
880    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
881    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
882    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
883    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
884    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
885    PERFORMANCE OF THIS SOFTWARE.
886  -->
887     <refentry id="FcStrFree">
888         <refmeta>
889             <refentrytitle>FcStrFree</refentrytitle>
890             <manvolnum>3</manvolnum>
891             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
892         </refmeta>
893         <refnamediv>
894             <refname>FcStrFree</refname>
895             <refpurpose>free a string</refpurpose>
896         </refnamediv>
897         <refsynopsisdiv>
898         <funcsynopsis>
899         <funcsynopsisinfo>
900 #include &lt;fontconfig/fontconfig.h&gt;
901         </funcsynopsisinfo>
902         <funcprototype>
903             <funcdef>void <function>FcStrFree</function></funcdef>
904                 <paramdef>FcChar8 *<parameter>s</parameter></paramdef>
905         </funcprototype>
906         </funcsynopsis>
907         </refsynopsisdiv>
908         <refsect1><title>Description</title>
909             <para>
910 This is just a wrapper around free(3) which helps track memory usage of
911 strings within the fontconfig library.
912             </para>
913         </refsect1>
914     </refentry>
915 <!--
916    fontconfig/doc/func.sgml
917   
918    Copyright © 2003 Keith Packard
919   
920    Permission to use, copy, modify, distribute, and sell this software and its
921    documentation for any purpose is hereby granted without fee, provided that
922    the above copyright notice appear in all copies and that both that
923    copyright notice and this permission notice appear in supporting
924    documentation, and that the name of the author(s) not be used in
925    advertising or publicity pertaining to distribution of the software without
926    specific, written prior permission.  The authors make no
927    representations about the suitability of this software for any purpose.  It
928    is provided "as is" without express or implied warranty.
929   
930    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
931    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
932    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
933    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
934    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
935    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
936    PERFORMANCE OF THIS SOFTWARE.
937  -->
938     <refentry id="FcStrDirname">
939         <refmeta>
940             <refentrytitle>FcStrDirname</refentrytitle>
941             <manvolnum>3</manvolnum>
942             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
943         </refmeta>
944         <refnamediv>
945             <refname>FcStrDirname</refname>
946             <refpurpose>directory part of filename</refpurpose>
947         </refnamediv>
948         <refsynopsisdiv>
949         <funcsynopsis>
950         <funcsynopsisinfo>
951 #include &lt;fontconfig/fontconfig.h&gt;
952         </funcsynopsisinfo>
953         <funcprototype>
954             <funcdef>FcChar8 * <function>FcStrDirname</function></funcdef>
955                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
956         </funcprototype>
957         </funcsynopsis>
958         </refsynopsisdiv>
959         <refsect1><title>Description</title>
960             <para>
961 Returns the directory containing <parameter>file</parameter>.  This
962 is returned in newly allocated storage which should be freed when no longer
963 needed.
964             </para>
965         </refsect1>
966     </refentry>
967 <!--
968    fontconfig/doc/func.sgml
969   
970    Copyright © 2003 Keith Packard
971   
972    Permission to use, copy, modify, distribute, and sell this software and its
973    documentation for any purpose is hereby granted without fee, provided that
974    the above copyright notice appear in all copies and that both that
975    copyright notice and this permission notice appear in supporting
976    documentation, and that the name of the author(s) not be used in
977    advertising or publicity pertaining to distribution of the software without
978    specific, written prior permission.  The authors make no
979    representations about the suitability of this software for any purpose.  It
980    is provided "as is" without express or implied warranty.
981   
982    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
983    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
984    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
985    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
986    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
987    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
988    PERFORMANCE OF THIS SOFTWARE.
989  -->
990     <refentry id="FcStrBasename">
991         <refmeta>
992             <refentrytitle>FcStrBasename</refentrytitle>
993             <manvolnum>3</manvolnum>
994             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
995         </refmeta>
996         <refnamediv>
997             <refname>FcStrBasename</refname>
998             <refpurpose>last component of filename</refpurpose>
999         </refnamediv>
1000         <refsynopsisdiv>
1001         <funcsynopsis>
1002         <funcsynopsisinfo>
1003 #include &lt;fontconfig/fontconfig.h&gt;
1004         </funcsynopsisinfo>
1005         <funcprototype>
1006             <funcdef>FcChar8 * <function>FcStrBasename</function></funcdef>
1007                 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
1008         </funcprototype>
1009         </funcsynopsis>
1010         </refsynopsisdiv>
1011         <refsect1><title>Description</title>
1012             <para>
1013 Returns the filename of <parameter>file</parameter> stripped of any leading
1014 directory names.  This is returned in newly allocated storage which should
1015 be freed when no longer needed.
1016             </para>
1017         </refsect1>
1018     </refentry>