fcvalue.fncs 2.28 KB
Newer Older
1
/*
Behdad Esfahbod's avatar
Behdad Esfahbod committed
2
 * fontconfig/doc/fcvalue.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
@RET@		void
@FUNC@		FcValueDestroy
26
@TYPE1@		FcValue%		@ARG1@		v
27 28
@PURPOSE@	Free a value
@DESC@
29
Frees any memory referenced by <parameter>v</parameter>.  Values of type FcTypeString,
30 31 32 33 34
FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
@@

@RET@		FcValue 
@FUNC@		FcValueSave
35
@TYPE1@		FcValue% 		@ARG1@		v
36 37
@PURPOSE@	Copy a value
@DESC@
38
Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
39 40
may be safely destroyed without harming the new value.
@@
41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61

@RET@		void
@FUNC@		FcValuePrint
@TYPE1@		FcValue%		@ARG1@		v
@PURPOSE@	Print a value to stdout
@DESC@
Prints a human-readable representation of <parameter>v</parameter> to
stdout. The format should not be considered part of the library
specification as it may change in the future.
@@

@RET@		FcBool
@FUNC@		FcValueEqual
@TYPE1@		FcValue%		@ARG1@		v_a
@TYPE2@		FcValue%		@ARG2@		v_b
@PURPOSE@	Test two values for equality
@DESC@
Compares two values. Integers and Doubles are compared as numbers; otherwise
the two values have to be the same type to be considered equal. Strings are
compared ignoring case.
@@