fcpattern.fncs 17 KB
Newer Older
1
/*
Behdad Esfahbod's avatar
Behdad Esfahbod committed
2
 * fontconfig/doc/fcpattern.fncs
3
 *
4
 * Copyright © 2003 Keith Packard
5 6 7 8 9
 *
 * Permission to use, copy, modify, distribute, and sell this software and its
 * documentation for any purpose is hereby granted without fee, provided that
 * the above copyright notice appear in all copies and that both that
 * copyright notice and this permission notice appear in supporting
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 14 15
 * representations about the suitability of this software for any purpose.  It
 * 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 20 21 22 23
 * CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE,
 * DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER
 * TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
 * PERFORMANCE OF THIS SOFTWARE.
 */
24 25 26 27 28 29 30 31
@RET@		FcPattern *	
@FUNC@		FcPatternCreate
@TYPE1@ 	void
@PURPOSE@	Create a pattern
@DESC@
Creates a pattern with no properties; used to build patterns from scratch.
@@

32 33
@RET@		FcPattern *	
@FUNC@		FcPatternDuplicate
34
@TYPE1@		const FcPattern * 		@ARG1@		 p
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
@PURPOSE@	Copy a pattern
@DESC@
Copy a pattern, returning a new pattern that matches
<parameter>p</parameter>. Each pattern may be modified without affecting the
other.
@@

@RET@		void
@FUNC@		FcPatternReference
@TYPE1@		FcPattern * 			@ARG1@		 p
@PURPOSE@	Increment pattern reference count
@DESC@
Add another reference to <parameter>p</parameter>. Patterns are freed only
when the reference count reaches zero.
@@

51 52 53 54 55
@RET@		void
@FUNC@		FcPatternDestroy
@TYPE1@		FcPattern * 			@ARG1@		 p
@PURPOSE@	Destroy a pattern
@DESC@
56 57
Decrement the pattern reference count. If all references are gone, destroys
the pattern, in the process destroying all related values.
58 59
@@

60 61 62 63 64 65 66 67 68
@RET@		int
@FUNC@		FcPatternObjectCount
@TYPE1@		const FcPattern *		@ARG1@		p
@PURPOSE@	Returns the number of the object
@DESC@
Returns the number of the object <parameter>p</parameter> has.
@SINCE@		2.13.1
@@

69 70 71 72 73 74
@RET@		FcBool
@FUNC@		FcPatternEqual
@TYPE1@ 	const FcPattern *		@ARG1@ 		pa
@TYPE2@		const FcPattern * 		@ARG2@		pb 
@PURPOSE@	Compare patterns
@DESC@
75
Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> are exactly alike.
76 77 78 79 80 81 82 83 84
@@

@RET@		FcBool
@FUNC@		FcPatternEqualSubset
@TYPE1@		const FcPattern * 		@ARG1@ 		pa
@TYPE2@		const FcPattern *		@ARG2@ 		pb
@TYPE3@ 	const FcObjectSet * 		@ARG3@ 		os 
@PURPOSE@	Compare portions of patterns
@DESC@
85 86
Returns whether <parameter>pa</parameter> and <parameter>pb</parameter> have exactly the same values for all of the
objects in <parameter>os</parameter>.
87 88
@@

89 90 91 92 93 94 95 96 97 98 99 100
@RET@		FcPattern *
@FUNC@		FcPatternFilter
@TYPE1@		FcPattern * 			@ARG1@		 p
@TYPE2@		const FcObjectSet * 		@ARG1@		 os
@PURPOSE@	Filter the objects of pattern
@DESC@
Returns a new pattern that only has those objects from
<parameter>p</parameter> that are in <parameter>os</parameter>.
If <parameter>os</parameter> is NULL, a duplicate of
<parameter>p</parameter> is returned.
@@

101 102 103 104 105 106 107 108 109 110 111 112 113
@RET@		FcChar32
@FUNC@		FcPatternHash
@TYPE1@		const FcPattern *		@ARG1@		p
@PURPOSE@	Compute a pattern hash value
@DESC@
Returns a 32-bit number which is the same for any two patterns which are
equal.
@@

@RET@		FcBool
@FUNC@		FcPatternAdd
@TYPE1@		FcPattern * 			@ARG1@ 		p
@TYPE2@ 	const char *			@ARG2@ 		object
114 115
@TYPE3@		FcValue%			@ARG3@		value
@TYPE4@		FcBool%				@ARG4@		append 
116 117 118
@PURPOSE@	Add a value to a pattern
@DESC@
Adds a single value to the list of values associated with the property named
119
`object<parameter>.  If `append</parameter> is FcTrue, the value is added at the end of any
Brad Hards's avatar
Brad Hards committed
120
existing list, otherwise it is inserted at the beginning.  `value' is saved
121 122 123 124 125 126 127 128
(with FcValueSave) when inserted into the pattern so that the library
retains no reference to any application-supplied data structure.
@@

@RET@		FcBool
@FUNC@		FcPatternAddWeak
@TYPE1@ 	FcPattern * 			@ARG1@ 		p
@TYPE2@ 	const char * 			@ARG2@ 		object
129 130
@TYPE3@ 	FcValue%  			@ARG3@ 		value
@TYPE4@ 	FcBool%  			@ARG4@		append 
131 132 133
@PURPOSE@	Add a value to a pattern with weak binding
@DESC@
FcPatternAddWeak is essentially the same as FcPatternAdd except that any
134
values added to the list have binding <parameter>weak</parameter> instead of <parameter>strong</parameter>.
135 136 137 138 139 140 141
@@

@TITLE@		FcPatternAdd-Type
@RET@		FcBool
@FUNC@		FcPatternAddInteger
@TYPE1@ 	FcPattern * 			@ARG1@ 		p
@TYPE2@		const char *			@ARG2@		object
142
@TYPE3@		int%				@ARG3@		i
143 144 145 146 147 148

@PROTOTYPE+@
@RET+@		FcBool
@FUNC+@		FcPatternAddDouble
@TYPE1+@ 	FcPattern * 			@ARG1+@ 	p
@TYPE2+@	const char *			@ARG2+@		object
149
@TYPE3+@	double%				@ARG3+@		d
150 151 152 153 154 155

@PROTOTYPE++@
@RET++@		FcBool
@FUNC++@	FcPatternAddString
@TYPE1++@ 	FcPattern * 			@ARG1++@ 	p
@TYPE2++@	const char *			@ARG2++@	object
156
@TYPE3++@	const FcChar8 *			@ARG3++@	s
157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176

@PROTOTYPE+++@
@RET+++@	FcBool
@FUNC+++@	FcPatternAddMatrix
@TYPE1+++@ 	FcPattern * 			@ARG1+++@ 	p
@TYPE2+++@	const char *			@ARG2+++@	object
@TYPE3+++@	const FcMatrix *		@ARG3+++@	m

@PROTOTYPE++++@
@RET++++@	FcBool
@FUNC++++@	FcPatternAddCharSet
@TYPE1++++@ 	FcPattern * 			@ARG1++++@ 	p
@TYPE2++++@	const char *			@ARG2++++@	object
@TYPE3++++@	const FcCharSet *		@ARG3++++@	c

@PROTOTYPE+++++@
@RET+++++@	FcBool
@FUNC+++++@	FcPatternAddBool
@TYPE1+++++@ 	FcPattern * 			@ARG1+++++@ 	p
@TYPE2+++++@	const char *			@ARG2+++++@	object
177
@TYPE3+++++@	FcBool%				@ARG3+++++@	b
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192

@PROTOTYPE++++++@
@RET++++++@	FcBool
@FUNC++++++@	FcPatternAddFTFace
@TYPE1++++++@ 	FcPattern * 			@ARG1++++++@ 	p
@TYPE2++++++@	const char *			@ARG2++++++@	object
@TYPE3++++++@	const FT_Face 			@ARG3++++++@	f

@PROTOTYPE+++++++@
@RET+++++++@	FcBool
@FUNC+++++++@	FcPatternAddLangSet
@TYPE1+++++++@ 	FcPattern * 			@ARG1+++++++@ 	p
@TYPE2+++++++@	const char *			@ARG2+++++++@	object
@TYPE3+++++++@	const FcLangSet *		@ARG3+++++++@	l

Akira TAGOH's avatar
Akira TAGOH committed
193 194 195 196 197 198 199
@PROTOTYPE++++++++@
@RET++++++++@	FcBool
@FUNC++++++++@	FcPatternAddRange
@TYPE1++++++++@	FcPattern *			@ARG1++++++++@	p
@TYPE2++++++++@	const char *			@ARG2++++++++@	object
@TYPE3++++++++@	const FcRange *			@ARG3++++++++@	r

200 201 202 203 204 205
@PURPOSE@	Add a typed value to a pattern
@DESC@
These are all convenience functions that insert objects of the specified
type into the pattern.  Use these in preference to FcPatternAdd as they
will provide compile-time typechecking.  These all append values to
any existing list of values.
Akira TAGOH's avatar
Akira TAGOH committed
206 207

<function>FcPatternAddRange</function> are available since 2.11.91.
208 209
@@

210 211 212 213 214 215 216 217 218 219 220 221 222 223
@RET@		FcResult
@FUNC@		FcPatternGetWithBinding
@TYPE1@		FcPattern *			@ARG1@		p
@TYPE2@		const char *			@ARG2@		object
@TYPE3@		int%  	   			@ARG3@		id
@TYPE4@		FcValue *			@ARG4@		v
@TYPE5@		FcValueBinding *		@ARG5@		b
@PURPOSE@	Return a value with binding from a pattern
@DESC@
Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
and <parameter>b</parameter> binding for that associated with the property
<parameter>object</parameter>.
The Value returned is not a copy, but rather refers to the data stored
within the pattern directly.  Applications must not free this value.
Akira TAGOH's avatar
Akira TAGOH committed
224
@SINCE@		2.12.5
225 226
@@

227 228 229 230
@RET@		FcResult
@FUNC@		FcPatternGet
@TYPE1@		FcPattern *			@ARG1@		p
@TYPE2@		const char *			@ARG2@		object
231
@TYPE3@		int%  				@ARG3@ 		id
232 233 234
@TYPE4@		FcValue *			@ARG4@		v 
@PURPOSE@	Return a value from a pattern
@DESC@
235 236
Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
associated with the property <parameter>object</parameter>.
237 238 239 240 241 242 243 244 245 246
The value returned is not a copy, but rather refers to the data stored
within the pattern directly.  Applications must not free this value.
@@

@TITLE@		FcPatternGet-Type
@PROTOTYPE@
@RET@ 		FcResult
@FUNC@		FcPatternGetInteger
@TYPE1@		FcPattern *			@ARG1@		p
@TYPE2@		const char *			@ARG2@		object
247
@TYPE3@		int%				@ARG3@		n
248 249 250 251 252 253 254
@TYPE4@		int *				@ARG4@		i

@PROTOTYPE+@
@RET+@		FcResult
@FUNC+@ 	FcPatternGetDouble
@TYPE1+@	FcPattern *			@ARG1+@		p
@TYPE2+@	const char *			@ARG2+@		object
255
@TYPE3+@	int%				@ARG3+@		n
256 257 258 259 260 261 262
@TYPE4+@	double *			@ARG4+@		d 

@PROTOTYPE++@
@RET++@ 	FcResult
@FUNC++@	FcPatternGetString
@TYPE1++@	FcPattern *			@ARG1++@	p
@TYPE2++@	const char *			@ARG2++@	object
263
@TYPE3++@	int%				@ARG3++@	n
264
@TYPE4++@	FcChar8 **			@ARG4++@	s
265 266 267 268 269 270

@PROTOTYPE+++@
@RET+++@	FcResult
@FUNC+++@	FcPatternGetMatrix 
@TYPE1+++@ 	FcPattern * 			@ARG1+++@ 	p 
@TYPE2+++@ 	const char * 			@ARG2+++@ 	object 
271
@TYPE3+++@ 	int%  				@ARG3+++@ 	n 
272 273 274 275 276 277 278
@TYPE4+++@ 	FcMatrix ** 			@ARG4+++@ 	s 

@PROTOTYPE++++@
@RET++++@ 	FcResult 
@FUNC++++@ 	FcPatternGetCharSet 
@TYPE1++++@ 	FcPattern * 			@ARG1++++@ 	p 
@TYPE2++++@ 	const char * 			@ARG2++++@ 	object 
279
@TYPE3++++@ 	int%  				@ARG3++++@ 	n 
280 281 282 283 284 285 286
@TYPE4++++@ 	FcCharSet ** 			@ARG4++++@ 	c 

@PROTOTYPE+++++@
@RET+++++@ 	FcResult 
@FUNC+++++@ 	FcPatternGetBool 		
@TYPE1+++++@ 	FcPattern * 			@ARG1+++++@ 	p
@TYPE2+++++@ 	const char * 			@ARG2+++++@ 	object 
287
@TYPE3+++++@ 	int%  				@ARG3+++++@ 	n 
288
@TYPE4+++++@ 	FcBool * 			@ARG4+++++@ 	b 
289 290

@PROTOTYPE++++++@
Behdad Esfahbod's avatar
Behdad Esfahbod committed
291
@RET++++++@	FcResult
292 293 294
@FUNC++++++@	FcPatternGetFTFace
@TYPE1++++++@ 	FcPattern * 			@ARG1++++++@ 	p
@TYPE2++++++@	const char *			@ARG2++++++@	object
Akira TAGOH's avatar
Akira TAGOH committed
295 296
@TYPE3++++++@ 	int%  				@ARG3++++++@ 	n
@TYPE4++++++@	FT_Face *			@ARG4++++++@	f
297 298

@PROTOTYPE+++++++@
Behdad Esfahbod's avatar
Behdad Esfahbod committed
299
@RET+++++++@	FcResult
300 301 302
@FUNC+++++++@	FcPatternGetLangSet
@TYPE1+++++++@ 	FcPattern * 			@ARG1+++++++@ 	p
@TYPE2+++++++@	const char *			@ARG2+++++++@	object
Akira TAGOH's avatar
Akira TAGOH committed
303 304 305 306 307 308 309 310 311 312
@TYPE3+++++++@ 	int%  				@ARG3+++++++@ 	n
@TYPE4+++++++@	FcLangSet **			@ARG4+++++++@	l

@PROTOTYPE++++++++@
@RET++++++++@	FcResult
@FUNC++++++++@	FcPatternGetRange
@TYPE1++++++++@	FcPattern *			@ARG1++++++++@	p
@TYPE2++++++++@	const char *			@ARG2++++++++@	object
@TYPE3++++++++@	int%  	   			@ARG3++++++++@	n
@TYPE4++++++++@	FcRange **			@ARG4++++++++@	r
313

314 315 316 317 318 319 320
@PURPOSE@	Return a typed value from a pattern
@DESC@
These are convenience functions that call FcPatternGet and verify that the
returned data is of the expected type. They return FcResultTypeMismatch if
this is not the case.  Note that these (like FcPatternGet) do not make a
copy of any data structure referenced by the return value.  Use these
in preference to FcPatternGet to provide compile-time typechecking.
Akira TAGOH's avatar
Akira TAGOH committed
321 322

<function>FcPatternGetRange</function> are available since 2.11.91.
323 324 325 326
@@

@RET@		FcPattern *
@FUNC@		FcPatternBuild
327
@TYPE1@		FcPattern *			@ARG1@		pattern
328 329 330 331 332
@TYPE2@ 	...

@PROTOTYPE+@
@RET+@		FcPattern *
@FUNC+@		FcPatternVaBuild
333
@TYPE1+@	FcPattern *			@ARG1+@		pattern
334
@TYPE2+@	va_list% 			@ARG2+@		va
335 336 337 338 339

@PROTOTYPE++@
@RET++@		void
@FUNC++@	FcPatternVapBuild
@TYPE1++@	FcPattern *			@ARG1++@	result
340
@TYPE2++@	FcPattern *			@ARG2++@	pattern
341 342
@TYPE3++@	va_list%			@ARG3++@	va

343 344 345 346
@PURPOSE@	Create patterns from arguments
@DESC@
Builds a pattern using a list of objects, types and values.  Each
value to be entered in the pattern is specified with three arguments:
347
</para>
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365
<orderedlist>
<listitem><para>
Object name, a string describing the property to be added.
</para></listitem><listitem><para>
Object type, one of the FcType enumerated values
</para></listitem><listitem><para>
Value, not an FcValue, but the raw type as passed to any of the
FcPatternAdd&lt;type&gt; functions.  Must match the type of the second
argument.
</para></listitem>
</orderedlist>
<para>
The argument list is terminated by a null object name, no object type nor
value need be passed for this.  The values are added to `pattern', if
`pattern' is null, a new pattern is created.  In either case, the pattern is
returned. Example
</para>
<programlisting>
366
pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);
367 368 369
</programlisting>
<para>
FcPatternVaBuild is used when the arguments are already in the form of a
370 371 372
varargs value. FcPatternVapBuild is a macro version of FcPatternVaBuild
which returns its result directly in the <parameter>result</parameter>
variable.
373 374 375 376 377 378 379 380 381 382 383 384
@@

@RET@		FcBool
@FUNC@		FcPatternDel
@TYPE1@		FcPattern *			@ARG1@		p
@TYPE2@		const char *			@ARG2@		object 
@PURPOSE@	Delete a property from a pattern
@DESC@
Deletes all values associated with the property `object', returning 
whether the property existed or not.
@@

385 386 387 388
@RET@		FcBool
@FUNC@		FcPatternRemove
@TYPE1@		FcPattern *			@ARG1@		p
@TYPE2@		const char *			@ARG2@		object 
389
@TYPE3@		int%				@ARG3@		id
390 391 392 393 394
@PURPOSE@	Remove one object of the specified type from the pattern
@DESC@
Removes the value associated with the property `object' at position `id', returning 
whether the property existed and had a value at that position or not.
@@
395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495

@RET@		void
@FUNC@		FcPatternIterStart
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter *			@ARG2@		iter
@PURPOSE@	Initialize the iterator with the first iterator in the pattern
@DESC@
Initialize <parameter>iter</parameter> with the first iterator in <parameter>p</parameter>.
If there are no objects in <parameter>p</parameter>, <parameter>iter</parameter>
will not have any valid data.
@SINCE@		2.13.1
@@

@RET@		FcBool
@FUNC@		FcPatternIterNext
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter *			@ARG2@		iter
@PURPUSE@	Set the iterator to point to the next object in the pattern
@DESC@
Set <parameter>iter</parameter> to point to the next object in <parameter>p</parameter>
and returns FcTrue if <parameter>iter</parameter> has been changed to the next object.
returns FcFalse otherwise.
@SINCE@		2.13.1
@@

@RET@		FcBool
@FUNC@		FcPatternIterEqual
@TYPE1@		const FcPattern *		@ARG1@		p1
@TYPE2@		FcPatternIter *			@ARG2@		i1
@TYPE3@		const FcPattern *		@ARG3@		p2
@TYPE4@		FcPatternIter *			@ARG4@		i2
@PURPOSE@	Compare iterators
@DESC@
Return FcTrue if both <parameter>i1</parameter> and <parameter>i2</parameter>
point to same object and contains same values. return FcFalse otherwise.
@SINCE@		2.13.1
@@

@RET@		FcBool
@FUNC@		FcPatternFindIter
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter *			@ARG2@		iter
@TYPE3@		const char *  			@ARG3@		object
@PURPOSE@	Set the iterator to point to the object in the pattern
@DESC@
Set <parameter>iter</parameter> to point to <parameter>object</parameter> in
<parameter>p</parameter> if any and returns FcTrue. returns FcFalse otherwise.
@SINCE@		2.13.1
@@

@RET@		FcBool
@FUNC@		FcPatternIterIsValid
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter :			@ARG2@		iter
@PURPOSE@	Check whether the iterator is valid or not
@DESC@
Returns FcTrue if <parameter>iter</parameter> point to the valid entry
in <parameter>p</parameter>. returns FcFalse otherwise.
@SINCE@		2.13.1
@@

@RET@		const char *
@FUNC@		FcPatternIterGetObject
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter *			@ARG2@		iter
@PURPOSE@	Returns an object name which the iterator point to
@DESC@
Returns an object name in <parameter>p</parameter> which
<parameter>iter</parameter> point to. returns NULL if
<parameter>iter</parameter> isn't valid.
@SINCE@		2.13.1
@@

@RET@		int
@FUNC@		FcPatternIterValueCount
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter *			@ARG2@		iter
@PURPOSE@	Returns the number of the values which the iterator point to
@DESC@
Returns the number of the values in the object which <parameter>iter</parameter>
point to. if <parameter>iter</parameter> isn't valid, returns 0.
@SINCE@		2.13.1
@@

@RET@		FcResult
@FUNC@		FcPatternIterGetValue
@TYPE1@		const FcPattern *		@ARG1@		p
@TYPE2@		FcPatternIter *			@ARG2@		iter
@TYPE3@		int	      			@ARG3@		id
@TYPE4@		FcValue *			@ARG4@		v
@TYPE5@		FcValueBinding *		@ARG5@		b
@PURPOSE@	Returns a value which the iterator point to
@DESC@
Returns in <parameter>v</parameter> the <parameter>id</parameter>'th value
which <parameter>iter</parameter> point to. also binding to <parameter>b</parameter>
if given.
The value returned is not a copy, but rather refers to the data stored
within the pattern directly.  Applications must not free this value.
@SINCE@		2.13.1
@@

496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
@RET@		void
@FUNC@		FcPatternPrint
@TYPE1@		const FcPattern *		@ARG1@		p 
@PURPOSE@	Print a pattern for debugging
@DESC@
Prints an easily readable version of the pattern to stdout.  There is
no provision for reparsing data in this format, it's just for diagnostics
and debugging.
@@

@RET@		void 	
@FUNC@		FcDefaultSubstitute
@TYPE1@		FcPattern *			@ARG1@		pattern 
@PURPOSE@	Perform default substitutions in a pattern
@DESC@
Supplies default values for underspecified font patterns:
<itemizedlist>
<listitem><para>
Patterns without a specified style or weight are set to Medium
</para></listitem>
<listitem><para>
Patterns without a specified style or slant are set to Roman
</para></listitem>
<listitem><para>
Patterns without a specified pixel size are given one computed from any
specified point size (default 12), dpi (default 75) and scale (default 1).
</para></listitem>
</itemizedlist>
@@

@RET@		FcPattern *
@FUNC@		FcNameParse
528
@TYPE1@		const FcChar8 *			@ARG1@		name 
529 530
@PURPOSE@	Parse a pattern string
@DESC@
531
Converts <parameter>name</parameter> from the standard text format described above into a pattern.
532 533 534 535 536 537 538 539 540
@@

@RET@		FcChar8 *
@FUNC@		FcNameUnparse
@TYPE1@		FcPattern *			@ARG1@		pat 
@PURPOSE@	Convert a pattern back into a string that can be parsed
@DESC@
Converts the given pattern into the standard text format described above.
The return value is not static, but instead refers to newly allocated memory
541
which should be freed by the caller using free().
542
@@