2 fontconfig/doc/func.sgml
4 Copyright © 2003 Keith Packard
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.
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.
24 <refentry id="FcUtf8ToUcs4">
26 <refentrytitle>FcUtf8ToUcs4</refentrytitle>
27 <manvolnum>3</manvolnum>
28 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
31 <refname>FcUtf8ToUcs4</refname>
32 <refpurpose>convert UTF-8 to UCS4</refpurpose>
37 #include <fontconfig/fontconfig.h>
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>
47 <refsect1><title>Description</title>
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.
57 fontconfig/doc/func.sgml
59 Copyright © 2003 Keith Packard
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.
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.
79 <refentry id="FcUcs4ToUtf8">
81 <refentrytitle>FcUcs4ToUtf8</refentrytitle>
82 <manvolnum>3</manvolnum>
83 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
86 <refname>FcUcs4ToUtf8</refname>
87 <refpurpose>convert UCS4 to UTF-8</refpurpose>
92 #include <fontconfig/fontconfig.h>
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>
101 <refsect1><title>Description</title>
103 Converts the Unicode char from <parameter>src</parameter> into
104 <parameter>dst</parameter> and returns the number of bytes needed to encode
110 fontconfig/doc/func.sgml
112 Copyright © 2003 Keith Packard
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.
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.
132 <refentry id="FcUtf8Len">
134 <refentrytitle>FcUtf8Len</refentrytitle>
135 <manvolnum>3</manvolnum>
136 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
139 <refname>FcUtf8Len</refname>
140 <refpurpose>count UTF-8 encoded chars</refpurpose>
145 #include <fontconfig/fontconfig.h>
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>
156 <refsect1><title>Description</title>
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.
168 fontconfig/doc/func.sgml
170 Copyright © 2003 Keith Packard
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.
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.
190 <refentry id="FcUtf16ToUcs4">
192 <refentrytitle>FcUtf16ToUcs4</refentrytitle>
193 <manvolnum>3</manvolnum>
194 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
197 <refname>FcUtf16ToUcs4</refname>
198 <refpurpose>convert UTF-16 to UCS4</refpurpose>
203 #include <fontconfig/fontconfig.h>
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>
214 <refsect1><title>Description</title>
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>.
225 fontconfig/doc/func.sgml
227 Copyright © 2003 Keith Packard
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.
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.
247 <refentry id="FcUtf16Len">
249 <refentrytitle>FcUtf16Len</refentrytitle>
250 <manvolnum>3</manvolnum>
251 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
254 <refname>FcUtf16Len</refname>
255 <refpurpose>count UTF-16 encoded chars</refpurpose>
260 #include <fontconfig/fontconfig.h>
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>
272 <refsect1><title>Description</title>
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
286 fontconfig/doc/func.sgml
288 Copyright © 2003 Keith Packard
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.
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.
308 <refentry id="FcIsLower">
310 <refentrytitle>FcIsLower</refentrytitle>
311 <manvolnum>3</manvolnum>
312 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
315 <refname>FcIsLower</refname>
316 <refpurpose>check for lower case ASCII character</refpurpose>
321 #include <fontconfig/fontconfig.h>
324 <funcdef>FcBool <function>FcIsLower</function></funcdef>
325 <paramdef>FcChar8<parameter>c</parameter></paramdef>
329 <refsect1><title>Description</title>
331 This macro checks whether <parameter>c</parameter> is an lower case ASCII
337 fontconfig/doc/func.sgml
339 Copyright © 2003 Keith Packard
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.
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.
359 <refentry id="FcIsUpper">
361 <refentrytitle>FcIsUpper</refentrytitle>
362 <manvolnum>3</manvolnum>
363 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
366 <refname>FcIsUpper</refname>
367 <refpurpose>check for upper case ASCII character</refpurpose>
372 #include <fontconfig/fontconfig.h>
375 <funcdef>FcBool <function>FcIsUpper</function></funcdef>
376 <paramdef>FcChar8<parameter>c</parameter></paramdef>
380 <refsect1><title>Description</title>
382 This macro checks whether <parameter>c</parameter> is a upper case ASCII
388 fontconfig/doc/func.sgml
390 Copyright © 2003 Keith Packard
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.
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.
410 <refentry id="FcToLower">
412 <refentrytitle>FcToLower</refentrytitle>
413 <manvolnum>3</manvolnum>
414 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
417 <refname>FcToLower</refname>
418 <refpurpose>convert upper case ASCII to lower case</refpurpose>
423 #include <fontconfig/fontconfig.h>
426 <funcdef>FcChar8 <function>FcToLower</function></funcdef>
427 <paramdef>FcChar8<parameter>c</parameter></paramdef>
431 <refsect1><title>Description</title>
433 This macro converts upper case ASCII <parameter>c</parameter> to the
434 equivalent lower case letter.
439 fontconfig/doc/func.sgml
441 Copyright © 2003 Keith Packard
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.
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.
461 <refentry id="FcStrCopy">
463 <refentrytitle>FcStrCopy</refentrytitle>
464 <manvolnum>3</manvolnum>
465 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
468 <refname>FcStrCopy</refname>
469 <refpurpose>duplicate a string</refpurpose>
474 #include <fontconfig/fontconfig.h>
477 <funcdef>FcChar8 * <function>FcStrCopy</function></funcdef>
478 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
482 <refsect1><title>Description</title>
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.
491 fontconfig/doc/func.sgml
493 Copyright © 2003 Keith Packard
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.
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.
513 <refentry id="FcStrDowncase">
515 <refentrytitle>FcStrDowncase</refentrytitle>
516 <manvolnum>3</manvolnum>
517 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
520 <refname>FcStrDowncase</refname>
521 <refpurpose>create a lower case translation of a string</refpurpose>
526 #include <fontconfig/fontconfig.h>
529 <funcdef>FcChar8 * <function>FcStrDowncase</function></funcdef>
530 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
534 <refsect1><title>Description</title>
536 Allocates memory, copies <parameter>s</parameter>, converting upper case
537 letters to lower case and returns the allocated buffer.
542 fontconfig/doc/func.sgml
544 Copyright © 2003 Keith Packard
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.
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.
564 <refentry id="FcStrCopyFilename">
566 <refentrytitle>FcStrCopyFilename</refentrytitle>
567 <manvolnum>3</manvolnum>
568 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
571 <refname>FcStrCopyFilename</refname>
572 <refpurpose>create a complete path from a filename</refpurpose>
577 #include <fontconfig/fontconfig.h>
580 <funcdef>FcChar8 * <function>FcStrCopyFilename</function></funcdef>
581 <paramdef>const FcChar8 *<parameter>s</parameter></paramdef>
585 <refsect1><title>Description</title>
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>).
599 fontconfig/doc/func.sgml
601 Copyright © 2003 Keith Packard
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.
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.
621 <refentry id="FcStrCmp">
623 <refentrytitle>FcStrCmp</refentrytitle>
624 <manvolnum>3</manvolnum>
625 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
628 <refname>FcStrCmp</refname>
629 <refpurpose>compare UTF-8 strings</refpurpose>
634 #include <fontconfig/fontconfig.h>
637 <funcdef>int <function>FcStrCmp</function></funcdef>
638 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
639 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
643 <refsect1><title>Description</title>
645 Returns the usual <0, 0, >0 result of comparing
646 <parameter>s1</parameter> and <parameter>s2</parameter>.
651 fontconfig/doc/func.sgml
653 Copyright © 2003 Keith Packard
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.
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.
673 <refentry id="FcStrCmpIgnoreCase">
675 <refentrytitle>FcStrCmpIgnoreCase</refentrytitle>
676 <manvolnum>3</manvolnum>
677 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
680 <refname>FcStrCmpIgnoreCase</refname>
681 <refpurpose>compare UTF-8 strings ignoring case</refpurpose>
686 #include <fontconfig/fontconfig.h>
689 <funcdef>int <function>FcStrCmpIgnoreCase</function></funcdef>
690 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
691 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
695 <refsect1><title>Description</title>
697 Returns the usual <0, 0, >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.
704 fontconfig/doc/func.sgml
706 Copyright © 2003 Keith Packard
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.
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.
726 <refentry id="FcStrStr">
728 <refentrytitle>FcStrStr</refentrytitle>
729 <manvolnum>3</manvolnum>
730 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
733 <refname>FcStrStr</refname>
734 <refpurpose>locate UTF-8 substring</refpurpose>
739 #include <fontconfig/fontconfig.h>
742 <funcdef>FcChar8 * <function>FcStrStr</function></funcdef>
743 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
744 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
748 <refsect1><title>Description</title>
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.
758 fontconfig/doc/func.sgml
760 Copyright © 2003 Keith Packard
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.
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.
780 <refentry id="FcStrStrIgnoreCase">
782 <refentrytitle>FcStrStrIgnoreCase</refentrytitle>
783 <manvolnum>3</manvolnum>
784 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
787 <refname>FcStrStrIgnoreCase</refname>
788 <refpurpose>locate UTF-8 substring ignoring ASCII case</refpurpose>
793 #include <fontconfig/fontconfig.h>
796 <funcdef>FcChar8 * <function>FcStrStrIgnoreCase</function></funcdef>
797 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
798 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
802 <refsect1><title>Description</title>
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.
812 fontconfig/doc/func.sgml
814 Copyright © 2003 Keith Packard
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.
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.
834 <refentry id="FcStrPlus">
836 <refentrytitle>FcStrPlus</refentrytitle>
837 <manvolnum>3</manvolnum>
838 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
841 <refname>FcStrPlus</refname>
842 <refpurpose>concatenate two strings</refpurpose>
847 #include <fontconfig/fontconfig.h>
850 <funcdef>FcChar8 * <function>FcStrPlus</function></funcdef>
851 <paramdef>const FcChar8 *<parameter>s1</parameter></paramdef>
852 <paramdef>const FcChar8 *<parameter>s2</parameter></paramdef>
856 <refsect1><title>Description</title>
858 This function allocates new storage and places the concatenation of
859 <parameter>s1</parameter> and <parameter>s2</parameter> there, returning the
865 fontconfig/doc/func.sgml
867 Copyright © 2003 Keith Packard
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.
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.
887 <refentry id="FcStrFree">
889 <refentrytitle>FcStrFree</refentrytitle>
890 <manvolnum>3</manvolnum>
891 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
894 <refname>FcStrFree</refname>
895 <refpurpose>free a string</refpurpose>
900 #include <fontconfig/fontconfig.h>
903 <funcdef>void <function>FcStrFree</function></funcdef>
904 <paramdef>FcChar8 *<parameter>s</parameter></paramdef>
908 <refsect1><title>Description</title>
910 This is just a wrapper around free(3) which helps track memory usage of
911 strings within the fontconfig library.
916 fontconfig/doc/func.sgml
918 Copyright © 2003 Keith Packard
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.
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.
938 <refentry id="FcStrDirname">
940 <refentrytitle>FcStrDirname</refentrytitle>
941 <manvolnum>3</manvolnum>
942 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
945 <refname>FcStrDirname</refname>
946 <refpurpose>directory part of filename</refpurpose>
951 #include <fontconfig/fontconfig.h>
954 <funcdef>FcChar8 * <function>FcStrDirname</function></funcdef>
955 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
959 <refsect1><title>Description</title>
961 Returns the directory containing <parameter>file</parameter>. This
962 is returned in newly allocated storage which should be freed when no longer
968 fontconfig/doc/func.sgml
970 Copyright © 2003 Keith Packard
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.
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.
990 <refentry id="FcStrBasename">
992 <refentrytitle>FcStrBasename</refentrytitle>
993 <manvolnum>3</manvolnum>
994 <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
997 <refname>FcStrBasename</refname>
998 <refpurpose>last component of filename</refpurpose>
1003 #include <fontconfig/fontconfig.h>
1006 <funcdef>FcChar8 * <function>FcStrBasename</function></funcdef>
1007 <paramdef>const FcChar8 *<parameter>file</parameter></paramdef>
1011 <refsect1><title>Description</title>
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.