Imported Upstream version 2.11.93
[platform/upstream/fontconfig.git] / doc / fclangset.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="FcLangSetCreate">
25         <refmeta>
26             <refentrytitle>FcLangSetCreate</refentrytitle>
27             <manvolnum>3</manvolnum>
28             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
29         </refmeta>
30         <refnamediv>
31             <refname>FcLangSetCreate</refname>
32             <refpurpose>create a langset object</refpurpose>
33         </refnamediv>
34         <refsynopsisdiv>
35         <funcsynopsis>
36         <funcsynopsisinfo>
37 #include &lt;fontconfig/fontconfig.h&gt;
38         </funcsynopsisinfo>
39         <funcprototype>
40             <funcdef>FcLangSet * <function>FcLangSetCreate</function></funcdef>
41                 <paramdef>void<parameter></parameter></paramdef>
42         </funcprototype>
43         </funcsynopsis>
44         </refsynopsisdiv>
45         <refsect1><title>Description</title>
46             <para>
47 <function>FcLangSetCreate</function> creates a new FcLangSet object.
48             </para>
49         </refsect1>
50     </refentry>
51 <!--
52    fontconfig/doc/func.sgml
53   
54    Copyright © 2003 Keith Packard
55   
56    Permission to use, copy, modify, distribute, and sell this software and its
57    documentation for any purpose is hereby granted without fee, provided that
58    the above copyright notice appear in all copies and that both that
59    copyright notice and this permission notice appear in supporting
60    documentation, and that the name of the author(s) not be used in
61    advertising or publicity pertaining to distribution of the software without
62    specific, written prior permission.  The authors make no
63    representations about the suitability of this software for any purpose.  It
64    is provided "as is" without express or implied warranty.
65   
66    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
67    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
68    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
69    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
70    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
71    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
72    PERFORMANCE OF THIS SOFTWARE.
73  -->
74     <refentry id="FcLangSetDestroy">
75         <refmeta>
76             <refentrytitle>FcLangSetDestroy</refentrytitle>
77             <manvolnum>3</manvolnum>
78             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
79         </refmeta>
80         <refnamediv>
81             <refname>FcLangSetDestroy</refname>
82             <refpurpose>destroy a langset object</refpurpose>
83         </refnamediv>
84         <refsynopsisdiv>
85         <funcsynopsis>
86         <funcsynopsisinfo>
87 #include &lt;fontconfig/fontconfig.h&gt;
88         </funcsynopsisinfo>
89         <funcprototype>
90             <funcdef>void <function>FcLangSetDestroy</function></funcdef>
91                 <paramdef>FcLangSet *<parameter>ls</parameter></paramdef>
92         </funcprototype>
93         </funcsynopsis>
94         </refsynopsisdiv>
95         <refsect1><title>Description</title>
96             <para>
97 <function>FcLangSetDestroy</function> destroys a FcLangSet object, freeing
98 all memory associated with it.
99             </para>
100         </refsect1>
101     </refentry>
102 <!--
103    fontconfig/doc/func.sgml
104   
105    Copyright © 2003 Keith Packard
106   
107    Permission to use, copy, modify, distribute, and sell this software and its
108    documentation for any purpose is hereby granted without fee, provided that
109    the above copyright notice appear in all copies and that both that
110    copyright notice and this permission notice appear in supporting
111    documentation, and that the name of the author(s) not be used in
112    advertising or publicity pertaining to distribution of the software without
113    specific, written prior permission.  The authors make no
114    representations about the suitability of this software for any purpose.  It
115    is provided "as is" without express or implied warranty.
116   
117    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
118    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
119    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
120    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
121    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
122    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
123    PERFORMANCE OF THIS SOFTWARE.
124  -->
125     <refentry id="FcLangSetCopy">
126         <refmeta>
127             <refentrytitle>FcLangSetCopy</refentrytitle>
128             <manvolnum>3</manvolnum>
129             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
130         </refmeta>
131         <refnamediv>
132             <refname>FcLangSetCopy</refname>
133             <refpurpose>copy a langset object</refpurpose>
134         </refnamediv>
135         <refsynopsisdiv>
136         <funcsynopsis>
137         <funcsynopsisinfo>
138 #include &lt;fontconfig/fontconfig.h&gt;
139         </funcsynopsisinfo>
140         <funcprototype>
141             <funcdef>FcLangSet * <function>FcLangSetCopy</function></funcdef>
142                 <paramdef>const FcLangSet *<parameter>ls</parameter></paramdef>
143         </funcprototype>
144         </funcsynopsis>
145         </refsynopsisdiv>
146         <refsect1><title>Description</title>
147             <para>
148 <function>FcLangSetCopy</function> creates a new FcLangSet object and
149 populates it with the contents of <parameter>ls</parameter>.
150             </para>
151         </refsect1>
152     </refentry>
153 <!--
154    fontconfig/doc/func.sgml
155   
156    Copyright © 2003 Keith Packard
157   
158    Permission to use, copy, modify, distribute, and sell this software and its
159    documentation for any purpose is hereby granted without fee, provided that
160    the above copyright notice appear in all copies and that both that
161    copyright notice and this permission notice appear in supporting
162    documentation, and that the name of the author(s) not be used in
163    advertising or publicity pertaining to distribution of the software without
164    specific, written prior permission.  The authors make no
165    representations about the suitability of this software for any purpose.  It
166    is provided "as is" without express or implied warranty.
167   
168    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
169    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
170    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
171    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
172    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
173    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
174    PERFORMANCE OF THIS SOFTWARE.
175  -->
176     <refentry id="FcLangSetAdd">
177         <refmeta>
178             <refentrytitle>FcLangSetAdd</refentrytitle>
179             <manvolnum>3</manvolnum>
180             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
181         </refmeta>
182         <refnamediv>
183             <refname>FcLangSetAdd</refname>
184             <refpurpose>add a language to a langset</refpurpose>
185         </refnamediv>
186         <refsynopsisdiv>
187         <funcsynopsis>
188         <funcsynopsisinfo>
189 #include &lt;fontconfig/fontconfig.h&gt;
190         </funcsynopsisinfo>
191         <funcprototype>
192             <funcdef>FcBool <function>FcLangSetAdd</function></funcdef>
193                 <paramdef>FcLangSet *<parameter>ls</parameter></paramdef>
194                 <paramdef>const FcChar8 *<parameter>lang</parameter></paramdef>
195         </funcprototype>
196         </funcsynopsis>
197         </refsynopsisdiv>
198         <refsect1><title>Description</title>
199             <para>
200 <parameter>lang</parameter> is added to <parameter>ls</parameter>.
201 <parameter>lang</parameter> should be of the form Ll-Tt where Ll is a
202 two or three letter language from ISO 639 and Tt is a territory from ISO
203 3166.
204             </para>
205         </refsect1>
206     </refentry>
207 <!--
208    fontconfig/doc/func.sgml
209   
210    Copyright © 2003 Keith Packard
211   
212    Permission to use, copy, modify, distribute, and sell this software and its
213    documentation for any purpose is hereby granted without fee, provided that
214    the above copyright notice appear in all copies and that both that
215    copyright notice and this permission notice appear in supporting
216    documentation, and that the name of the author(s) not be used in
217    advertising or publicity pertaining to distribution of the software without
218    specific, written prior permission.  The authors make no
219    representations about the suitability of this software for any purpose.  It
220    is provided "as is" without express or implied warranty.
221   
222    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
223    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
224    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
225    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
226    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
227    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
228    PERFORMANCE OF THIS SOFTWARE.
229  -->
230     <refentry id="FcLangSetDel">
231         <refmeta>
232             <refentrytitle>FcLangSetDel</refentrytitle>
233             <manvolnum>3</manvolnum>
234             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
235         </refmeta>
236         <refnamediv>
237             <refname>FcLangSetDel</refname>
238             <refpurpose>delete a language from a langset</refpurpose>
239         </refnamediv>
240         <refsynopsisdiv>
241         <funcsynopsis>
242         <funcsynopsisinfo>
243 #include &lt;fontconfig/fontconfig.h&gt;
244         </funcsynopsisinfo>
245         <funcprototype>
246             <funcdef>FcBool <function>FcLangSetDel</function></funcdef>
247                 <paramdef>FcLangSet *<parameter>ls</parameter></paramdef>
248                 <paramdef>const FcChar8 *<parameter>lang</parameter></paramdef>
249         </funcprototype>
250         </funcsynopsis>
251         </refsynopsisdiv>
252         <refsect1><title>Description</title>
253             <para>
254 <parameter>lang</parameter> is removed from <parameter>ls</parameter>.
255 <parameter>lang</parameter> should be of the form Ll-Tt where Ll is a
256 two or three letter language from ISO 639 and Tt is a territory from ISO
257 3166.
258             </para>
259         </refsect1>
260         <refsect1><title>Since</title>
261             <para>version 2.9.0</para>
262         </refsect1>
263     </refentry>
264 <!--
265    fontconfig/doc/func.sgml
266   
267    Copyright © 2003 Keith Packard
268   
269    Permission to use, copy, modify, distribute, and sell this software and its
270    documentation for any purpose is hereby granted without fee, provided that
271    the above copyright notice appear in all copies and that both that
272    copyright notice and this permission notice appear in supporting
273    documentation, and that the name of the author(s) not be used in
274    advertising or publicity pertaining to distribution of the software without
275    specific, written prior permission.  The authors make no
276    representations about the suitability of this software for any purpose.  It
277    is provided "as is" without express or implied warranty.
278   
279    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
280    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
281    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
282    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
283    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
284    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
285    PERFORMANCE OF THIS SOFTWARE.
286  -->
287     <refentry id="FcLangSetUnion">
288         <refmeta>
289             <refentrytitle>FcLangSetUnion</refentrytitle>
290             <manvolnum>3</manvolnum>
291             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
292         </refmeta>
293         <refnamediv>
294             <refname>FcLangSetUnion</refname>
295             <refpurpose>Add langsets</refpurpose>
296         </refnamediv>
297         <refsynopsisdiv>
298         <funcsynopsis>
299         <funcsynopsisinfo>
300 #include &lt;fontconfig/fontconfig.h&gt;
301         </funcsynopsisinfo>
302         <funcprototype>
303             <funcdef>FcLangSet * <function>FcLangSetUnion</function></funcdef>
304                 <paramdef>const FcLangSet *<parameter>ls_a</parameter></paramdef>
305                 <paramdef>const FcLangSet *<parameter>ls_b</parameter></paramdef>
306         </funcprototype>
307         </funcsynopsis>
308         </refsynopsisdiv>
309         <refsect1><title>Description</title>
310             <para>
311 Returns a set including only those languages found in either <parameter>ls_a</parameter> or <parameter>ls_b</parameter>.
312             </para>
313         </refsect1>
314         <refsect1><title>Since</title>
315             <para>version 2.9.0</para>
316         </refsect1>
317     </refentry>
318 <!--
319    fontconfig/doc/func.sgml
320   
321    Copyright © 2003 Keith Packard
322   
323    Permission to use, copy, modify, distribute, and sell this software and its
324    documentation for any purpose is hereby granted without fee, provided that
325    the above copyright notice appear in all copies and that both that
326    copyright notice and this permission notice appear in supporting
327    documentation, and that the name of the author(s) not be used in
328    advertising or publicity pertaining to distribution of the software without
329    specific, written prior permission.  The authors make no
330    representations about the suitability of this software for any purpose.  It
331    is provided "as is" without express or implied warranty.
332   
333    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
334    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
335    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
336    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
337    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
338    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
339    PERFORMANCE OF THIS SOFTWARE.
340  -->
341     <refentry id="FcLangSetSubtract">
342         <refmeta>
343             <refentrytitle>FcLangSetSubtract</refentrytitle>
344             <manvolnum>3</manvolnum>
345             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
346         </refmeta>
347         <refnamediv>
348             <refname>FcLangSetSubtract</refname>
349             <refpurpose>Subtract langsets</refpurpose>
350         </refnamediv>
351         <refsynopsisdiv>
352         <funcsynopsis>
353         <funcsynopsisinfo>
354 #include &lt;fontconfig/fontconfig.h&gt;
355         </funcsynopsisinfo>
356         <funcprototype>
357             <funcdef>FcLangSet * <function>FcLangSetSubtract</function></funcdef>
358                 <paramdef>const FcLangSet *<parameter>ls_a</parameter></paramdef>
359                 <paramdef>const FcLangSet *<parameter>ls_b</parameter></paramdef>
360         </funcprototype>
361         </funcsynopsis>
362         </refsynopsisdiv>
363         <refsect1><title>Description</title>
364             <para>
365 Returns a set including only those languages found in <parameter>ls_a</parameter> but not in <parameter>ls_b</parameter>.
366             </para>
367         </refsect1>
368         <refsect1><title>Since</title>
369             <para>version 2.9.0</para>
370         </refsect1>
371     </refentry>
372 <!--
373    fontconfig/doc/func.sgml
374   
375    Copyright © 2003 Keith Packard
376   
377    Permission to use, copy, modify, distribute, and sell this software and its
378    documentation for any purpose is hereby granted without fee, provided that
379    the above copyright notice appear in all copies and that both that
380    copyright notice and this permission notice appear in supporting
381    documentation, and that the name of the author(s) not be used in
382    advertising or publicity pertaining to distribution of the software without
383    specific, written prior permission.  The authors make no
384    representations about the suitability of this software for any purpose.  It
385    is provided "as is" without express or implied warranty.
386   
387    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
388    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
389    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
390    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
391    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
392    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
393    PERFORMANCE OF THIS SOFTWARE.
394  -->
395     <refentry id="FcLangSetCompare">
396         <refmeta>
397             <refentrytitle>FcLangSetCompare</refentrytitle>
398             <manvolnum>3</manvolnum>
399             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
400         </refmeta>
401         <refnamediv>
402             <refname>FcLangSetCompare</refname>
403             <refpurpose>compare language sets</refpurpose>
404         </refnamediv>
405         <refsynopsisdiv>
406         <funcsynopsis>
407         <funcsynopsisinfo>
408 #include &lt;fontconfig/fontconfig.h&gt;
409         </funcsynopsisinfo>
410         <funcprototype>
411             <funcdef>FcLangResult <function>FcLangSetCompare</function></funcdef>
412                 <paramdef>const FcLangSet *<parameter>ls_a</parameter></paramdef>
413                 <paramdef>const FcLangSet *<parameter>ls_b</parameter></paramdef>
414         </funcprototype>
415         </funcsynopsis>
416         </refsynopsisdiv>
417         <refsect1><title>Description</title>
418             <para>
419 <function>FcLangSetCompare</function> compares language coverage for
420 <parameter>ls_a</parameter> and <parameter>ls_b</parameter>. If they share
421 any language and territory pair, this function returns FcLangEqual. If they
422 share a language but differ in which territory that language is for, this
423 function returns FcLangDifferentTerritory. If they share no languages in
424 common, this function returns FcLangDifferentLang.
425             </para>
426         </refsect1>
427     </refentry>
428 <!--
429    fontconfig/doc/func.sgml
430   
431    Copyright © 2003 Keith Packard
432   
433    Permission to use, copy, modify, distribute, and sell this software and its
434    documentation for any purpose is hereby granted without fee, provided that
435    the above copyright notice appear in all copies and that both that
436    copyright notice and this permission notice appear in supporting
437    documentation, and that the name of the author(s) not be used in
438    advertising or publicity pertaining to distribution of the software without
439    specific, written prior permission.  The authors make no
440    representations about the suitability of this software for any purpose.  It
441    is provided "as is" without express or implied warranty.
442   
443    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
444    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
445    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
446    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
447    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
448    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
449    PERFORMANCE OF THIS SOFTWARE.
450  -->
451     <refentry id="FcLangSetContains">
452         <refmeta>
453             <refentrytitle>FcLangSetContains</refentrytitle>
454             <manvolnum>3</manvolnum>
455             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
456         </refmeta>
457         <refnamediv>
458             <refname>FcLangSetContains</refname>
459             <refpurpose>check langset subset relation</refpurpose>
460         </refnamediv>
461         <refsynopsisdiv>
462         <funcsynopsis>
463         <funcsynopsisinfo>
464 #include &lt;fontconfig/fontconfig.h&gt;
465         </funcsynopsisinfo>
466         <funcprototype>
467             <funcdef>FcBool <function>FcLangSetContains</function></funcdef>
468                 <paramdef>const FcLangSet *<parameter>ls_a</parameter></paramdef>
469                 <paramdef>const FcLangSet *<parameter>ls_b</parameter></paramdef>
470         </funcprototype>
471         </funcsynopsis>
472         </refsynopsisdiv>
473         <refsect1><title>Description</title>
474             <para>
475 <function>FcLangSetContains</function> returns FcTrue if
476 <parameter>ls_a</parameter> contains every language in
477 <parameter>ls_b</parameter>. <parameter>ls_a</parameter> will 'contain' a
478 language from <parameter>ls_b</parameter> if <parameter>ls_a</parameter>
479 has exactly the language, or either the language or
480 <parameter>ls_a</parameter> has no territory.
481             </para>
482         </refsect1>
483     </refentry>
484 <!--
485    fontconfig/doc/func.sgml
486   
487    Copyright © 2003 Keith Packard
488   
489    Permission to use, copy, modify, distribute, and sell this software and its
490    documentation for any purpose is hereby granted without fee, provided that
491    the above copyright notice appear in all copies and that both that
492    copyright notice and this permission notice appear in supporting
493    documentation, and that the name of the author(s) not be used in
494    advertising or publicity pertaining to distribution of the software without
495    specific, written prior permission.  The authors make no
496    representations about the suitability of this software for any purpose.  It
497    is provided "as is" without express or implied warranty.
498   
499    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
500    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
501    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
502    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
503    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
504    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
505    PERFORMANCE OF THIS SOFTWARE.
506  -->
507     <refentry id="FcLangSetEqual">
508         <refmeta>
509             <refentrytitle>FcLangSetEqual</refentrytitle>
510             <manvolnum>3</manvolnum>
511             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
512         </refmeta>
513         <refnamediv>
514             <refname>FcLangSetEqual</refname>
515             <refpurpose>test for matching langsets</refpurpose>
516         </refnamediv>
517         <refsynopsisdiv>
518         <funcsynopsis>
519         <funcsynopsisinfo>
520 #include &lt;fontconfig/fontconfig.h&gt;
521         </funcsynopsisinfo>
522         <funcprototype>
523             <funcdef>FcBool <function>FcLangSetEqual</function></funcdef>
524                 <paramdef>const FcLangSet *<parameter>ls_a</parameter></paramdef>
525                 <paramdef>const FcLangSet *<parameter>ls_b</parameter></paramdef>
526         </funcprototype>
527         </funcsynopsis>
528         </refsynopsisdiv>
529         <refsect1><title>Description</title>
530             <para>
531 Returns FcTrue if and only if <parameter>ls_a</parameter> supports precisely
532 the same language and territory combinations as <parameter>ls_b</parameter>.
533             </para>
534         </refsect1>
535     </refentry>
536 <!--
537    fontconfig/doc/func.sgml
538   
539    Copyright © 2003 Keith Packard
540   
541    Permission to use, copy, modify, distribute, and sell this software and its
542    documentation for any purpose is hereby granted without fee, provided that
543    the above copyright notice appear in all copies and that both that
544    copyright notice and this permission notice appear in supporting
545    documentation, and that the name of the author(s) not be used in
546    advertising or publicity pertaining to distribution of the software without
547    specific, written prior permission.  The authors make no
548    representations about the suitability of this software for any purpose.  It
549    is provided "as is" without express or implied warranty.
550   
551    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
552    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
553    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
554    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
555    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
556    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
557    PERFORMANCE OF THIS SOFTWARE.
558  -->
559     <refentry id="FcLangSetHash">
560         <refmeta>
561             <refentrytitle>FcLangSetHash</refentrytitle>
562             <manvolnum>3</manvolnum>
563             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
564         </refmeta>
565         <refnamediv>
566             <refname>FcLangSetHash</refname>
567             <refpurpose>return a hash value for a langset</refpurpose>
568         </refnamediv>
569         <refsynopsisdiv>
570         <funcsynopsis>
571         <funcsynopsisinfo>
572 #include &lt;fontconfig/fontconfig.h&gt;
573         </funcsynopsisinfo>
574         <funcprototype>
575             <funcdef>FcChar32 <function>FcLangSetHash</function></funcdef>
576                 <paramdef>const FcLangSet *<parameter>ls</parameter></paramdef>
577         </funcprototype>
578         </funcsynopsis>
579         </refsynopsisdiv>
580         <refsect1><title>Description</title>
581             <para>
582 This function returns a value which depends solely on the languages
583 supported by <parameter>ls</parameter>. Any language which equals
584 <parameter>ls</parameter> will have the same result from
585 <function>FcLangSetHash</function>. However, two langsets with the same hash
586 value may not be equal.
587             </para>
588         </refsect1>
589     </refentry>
590 <!--
591    fontconfig/doc/func.sgml
592   
593    Copyright © 2003 Keith Packard
594   
595    Permission to use, copy, modify, distribute, and sell this software and its
596    documentation for any purpose is hereby granted without fee, provided that
597    the above copyright notice appear in all copies and that both that
598    copyright notice and this permission notice appear in supporting
599    documentation, and that the name of the author(s) not be used in
600    advertising or publicity pertaining to distribution of the software without
601    specific, written prior permission.  The authors make no
602    representations about the suitability of this software for any purpose.  It
603    is provided "as is" without express or implied warranty.
604   
605    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
606    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
607    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
608    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
609    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
610    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
611    PERFORMANCE OF THIS SOFTWARE.
612  -->
613     <refentry id="FcLangSetHasLang">
614         <refmeta>
615             <refentrytitle>FcLangSetHasLang</refentrytitle>
616             <manvolnum>3</manvolnum>
617             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
618         </refmeta>
619         <refnamediv>
620             <refname>FcLangSetHasLang</refname>
621             <refpurpose>test langset for language support</refpurpose>
622         </refnamediv>
623         <refsynopsisdiv>
624         <funcsynopsis>
625         <funcsynopsisinfo>
626 #include &lt;fontconfig/fontconfig.h&gt;
627         </funcsynopsisinfo>
628         <funcprototype>
629             <funcdef>FcLangResult <function>FcLangSetHasLang</function></funcdef>
630                 <paramdef>const FcLangSet *<parameter>ls</parameter></paramdef>
631                 <paramdef>const FcChar8 *<parameter>lang</parameter></paramdef>
632         </funcprototype>
633         </funcsynopsis>
634         </refsynopsisdiv>
635         <refsect1><title>Description</title>
636             <para>
637 <function>FcLangSetHasLang</function> checks whether
638 <parameter>ls</parameter> supports <parameter>lang</parameter>. If 
639 <parameter>ls</parameter> has a matching language and territory pair,
640 this function returns FcLangEqual. If <parameter>ls</parameter> has
641 a matching language but differs in which territory that language is for, this
642 function returns FcLangDifferentTerritory. If <parameter>ls</parameter> 
643 has no matching language, this function returns FcLangDifferentLang.
644             </para>
645         </refsect1>
646     </refentry>
647 <!--
648    fontconfig/doc/func.sgml
649   
650    Copyright © 2003 Keith Packard
651   
652    Permission to use, copy, modify, distribute, and sell this software and its
653    documentation for any purpose is hereby granted without fee, provided that
654    the above copyright notice appear in all copies and that both that
655    copyright notice and this permission notice appear in supporting
656    documentation, and that the name of the author(s) not be used in
657    advertising or publicity pertaining to distribution of the software without
658    specific, written prior permission.  The authors make no
659    representations about the suitability of this software for any purpose.  It
660    is provided "as is" without express or implied warranty.
661   
662    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
663    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
664    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
665    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
666    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
667    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
668    PERFORMANCE OF THIS SOFTWARE.
669  -->
670     <refentry id="FcGetDefaultLangs">
671         <refmeta>
672             <refentrytitle>FcGetDefaultLangs</refentrytitle>
673             <manvolnum>3</manvolnum>
674             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
675         </refmeta>
676         <refnamediv>
677             <refname>FcGetDefaultLangs</refname>
678             <refpurpose>Get the default languages list</refpurpose>
679         </refnamediv>
680         <refsynopsisdiv>
681         <funcsynopsis>
682         <funcsynopsisinfo>
683 #include &lt;fontconfig/fontconfig.h&gt;
684         </funcsynopsisinfo>
685         <funcprototype>
686             <funcdef>FcStrSet * <function>FcGetDefaultLangs</function></funcdef>
687                 <paramdef>void<parameter></parameter></paramdef>
688         </funcprototype>
689         </funcsynopsis>
690         </refsynopsisdiv>
691         <refsect1><title>Description</title>
692             <para>
693 Returns a string set of the default languages according to the environment variables on the system.
694 This function looks for them in order of FC_LANG, LC_ALL, LC_CTYPE and LANG then.
695 If there are no valid values in those environment variables, "en" will be set as fallback.
696             </para>
697         </refsect1>
698         <refsect1><title>Since</title>
699             <para>version 2.9.91</para>
700         </refsect1>
701     </refentry>
702 <!--
703    fontconfig/doc/func.sgml
704   
705    Copyright © 2003 Keith Packard
706   
707    Permission to use, copy, modify, distribute, and sell this software and its
708    documentation for any purpose is hereby granted without fee, provided that
709    the above copyright notice appear in all copies and that both that
710    copyright notice and this permission notice appear in supporting
711    documentation, and that the name of the author(s) not be used in
712    advertising or publicity pertaining to distribution of the software without
713    specific, written prior permission.  The authors make no
714    representations about the suitability of this software for any purpose.  It
715    is provided "as is" without express or implied warranty.
716   
717    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
718    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
719    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
720    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
721    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
722    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
723    PERFORMANCE OF THIS SOFTWARE.
724  -->
725     <refentry id="FcLangSetGetLangs">
726         <refmeta>
727             <refentrytitle>FcLangSetGetLangs</refentrytitle>
728             <manvolnum>3</manvolnum>
729             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
730         </refmeta>
731         <refnamediv>
732             <refname>FcLangSetGetLangs</refname>
733             <refpurpose>get the list of languages in the langset</refpurpose>
734         </refnamediv>
735         <refsynopsisdiv>
736         <funcsynopsis>
737         <funcsynopsisinfo>
738 #include &lt;fontconfig/fontconfig.h&gt;
739         </funcsynopsisinfo>
740         <funcprototype>
741             <funcdef>FcStrSet * <function>FcLangSetGetLangs</function></funcdef>
742                 <paramdef>const FcLangSet *<parameter>ls</parameter></paramdef>
743         </funcprototype>
744         </funcsynopsis>
745         </refsynopsisdiv>
746         <refsect1><title>Description</title>
747             <para>
748 Returns a string set of all languages in <parameter>langset</parameter>.
749             </para>
750         </refsect1>
751     </refentry>
752 <!--
753    fontconfig/doc/func.sgml
754   
755    Copyright © 2003 Keith Packard
756   
757    Permission to use, copy, modify, distribute, and sell this software and its
758    documentation for any purpose is hereby granted without fee, provided that
759    the above copyright notice appear in all copies and that both that
760    copyright notice and this permission notice appear in supporting
761    documentation, and that the name of the author(s) not be used in
762    advertising or publicity pertaining to distribution of the software without
763    specific, written prior permission.  The authors make no
764    representations about the suitability of this software for any purpose.  It
765    is provided "as is" without express or implied warranty.
766   
767    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
768    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
769    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
770    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
771    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
772    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
773    PERFORMANCE OF THIS SOFTWARE.
774  -->
775     <refentry id="FcGetLangs">
776         <refmeta>
777             <refentrytitle>FcGetLangs</refentrytitle>
778             <manvolnum>3</manvolnum>
779             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
780         </refmeta>
781         <refnamediv>
782             <refname>FcGetLangs</refname>
783             <refpurpose>Get list of languages</refpurpose>
784         </refnamediv>
785         <refsynopsisdiv>
786         <funcsynopsis>
787         <funcsynopsisinfo>
788 #include &lt;fontconfig/fontconfig.h&gt;
789         </funcsynopsisinfo>
790         <funcprototype>
791             <funcdef>FcStrSet * <function>FcGetLangs</function></funcdef>
792                 <paramdef>void<parameter></parameter></paramdef>
793         </funcprototype>
794         </funcsynopsis>
795         </refsynopsisdiv>
796         <refsect1><title>Description</title>
797             <para>
798 Returns a string set of all known languages.
799             </para>
800         </refsect1>
801     </refentry>
802 <!--
803    fontconfig/doc/func.sgml
804   
805    Copyright © 2003 Keith Packard
806   
807    Permission to use, copy, modify, distribute, and sell this software and its
808    documentation for any purpose is hereby granted without fee, provided that
809    the above copyright notice appear in all copies and that both that
810    copyright notice and this permission notice appear in supporting
811    documentation, and that the name of the author(s) not be used in
812    advertising or publicity pertaining to distribution of the software without
813    specific, written prior permission.  The authors make no
814    representations about the suitability of this software for any purpose.  It
815    is provided "as is" without express or implied warranty.
816   
817    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
818    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
819    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
820    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
821    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
822    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
823    PERFORMANCE OF THIS SOFTWARE.
824  -->
825     <refentry id="FcLangNormalize">
826         <refmeta>
827             <refentrytitle>FcLangNormalize</refentrytitle>
828             <manvolnum>3</manvolnum>
829             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
830         </refmeta>
831         <refnamediv>
832             <refname>FcLangNormalize</refname>
833             <refpurpose>Normalize the language string</refpurpose>
834         </refnamediv>
835         <refsynopsisdiv>
836         <funcsynopsis>
837         <funcsynopsisinfo>
838 #include &lt;fontconfig/fontconfig.h&gt;
839         </funcsynopsisinfo>
840         <funcprototype>
841             <funcdef>FcChar8 * <function>FcLangNormalize</function></funcdef>
842                 <paramdef>const FcChar8 *<parameter>lang</parameter></paramdef>
843         </funcprototype>
844         </funcsynopsis>
845         </refsynopsisdiv>
846         <refsect1><title>Description</title>
847             <para>
848 Returns a string to make <parameter>lang</parameter> suitable on fontconfig.
849             </para>
850         </refsect1>
851         <refsect1><title>Since</title>
852             <para>version 2.10.91</para>
853         </refsect1>
854     </refentry>
855 <!--
856    fontconfig/doc/func.sgml
857   
858    Copyright © 2003 Keith Packard
859   
860    Permission to use, copy, modify, distribute, and sell this software and its
861    documentation for any purpose is hereby granted without fee, provided that
862    the above copyright notice appear in all copies and that both that
863    copyright notice and this permission notice appear in supporting
864    documentation, and that the name of the author(s) not be used in
865    advertising or publicity pertaining to distribution of the software without
866    specific, written prior permission.  The authors make no
867    representations about the suitability of this software for any purpose.  It
868    is provided "as is" without express or implied warranty.
869   
870    THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE,
871    INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO
872    EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR
873    CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
874    DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
875    TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
876    PERFORMANCE OF THIS SOFTWARE.
877  -->
878     <refentry id="FcLangGetCharSet">
879         <refmeta>
880             <refentrytitle>FcLangGetCharSet</refentrytitle>
881             <manvolnum>3</manvolnum>
882             <refmiscinfo class="software">Fontconfig &version;</refmiscinfo>
883         </refmeta>
884         <refnamediv>
885             <refname>FcLangGetCharSet</refname>
886             <refpurpose>Get character map for a language</refpurpose>
887         </refnamediv>
888         <refsynopsisdiv>
889         <funcsynopsis>
890         <funcsynopsisinfo>
891 #include &lt;fontconfig/fontconfig.h&gt;
892         </funcsynopsisinfo>
893         <funcprototype>
894             <funcdef>const FcCharSet * <function>FcLangGetCharSet</function></funcdef>
895                 <paramdef>const FcChar8 *<parameter>lang</parameter></paramdef>
896         </funcprototype>
897         </funcsynopsis>
898         </refsynopsisdiv>
899         <refsect1><title>Description</title>
900             <para>
901 Returns the FcCharMap for a language.
902             </para>
903         </refsect1>
904     </refentry>