doc/fcvalue.fncs

   1 /*
   2  * fontconfig/doc/fcvalue.fncs
   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 @RET@           void
  25 @FUNC@          FcValueDestroy
  26 @TYPE1@         FcValue%                @ARG1@          v
  27 @PURPOSE@       Free a value
  28 @DESC@
  29 Frees any memory referenced by <parameter>v</parameter>.  Values of type FcTypeString,
  30 FcTypeMatrix and FcTypeCharSet reference memory, the other types do not.
  31 @@
  32
  33 @RET@           FcValue
  34 @FUNC@          FcValueSave
  35 @TYPE1@         FcValue%                @ARG1@          v
  36 @PURPOSE@       Copy a value
  37 @DESC@
  38 Returns a copy of <parameter>v</parameter> duplicating any object referenced by it so that <parameter>v</parameter>
  39 may be safely destroyed without harming the new value.
  40 @@
  41
  42 @RET@           void
  43 @FUNC@          FcValuePrint
  44 @TYPE1@         FcValue%                @ARG1@          v
  45 @PURPOSE@       Print a value to stdout
  46 @DESC@
  47 Prints a human-readable representation of <parameter>v</parameter> to
  48 stdout. The format should not be considered part of the library
  49 specification as it may change in the future.
  50 @@
  51
  52 @RET@           FcBool
  53 @FUNC@          FcValueEqual
  54 @TYPE1@         FcValue%                @ARG1@          v_a
  55 @TYPE2@         FcValue%                @ARG2@          v_b
  56 @PURPOSE@       Test two values for equality
  57 @DESC@
  58 Compares two values. Integers and Doubles are compared as numbers; otherwise
  59 the two values have to be the same type to be considered equal. Strings are
  60 compared ignoring case.
  61 @@