X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=doc%2Ffcpattern.fncs;h=1df1c4f6184bfd9051b433cfb2e0f3d7e3751f42;hb=082caefb6d5462c97f280b7037e3740b4865a244;hp=b049966f64d4f24d00764812054b91103fd4d3a8;hpb=af7a965f945ab5aafab13fb7b6e8d96c911b24fd;p=fontconfig.git diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs index b049966..1df1c4f 100644 --- a/doc/fcpattern.fncs +++ b/doc/fcpattern.fncs @@ -1,5 +1,5 @@ /* - * $Id$ + * fontconfig/doc/fcpattern.fncs * * Copyright © 2003 Keith Packard * @@ -7,15 +7,15 @@ * 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 - * documentation, and that the name of Keith Packard not be used in + * documentation, and that the name of the author(s) not be used in * advertising or publicity pertaining to distribution of the software without - * specific, written prior permission. Keith Packard makes no + * specific, written prior permission. The authors make no * representations about the suitability of this software for any purpose. It * is provided "as is" without express or implied warranty. * - * KEITH PACKARD DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, + * THE AUTHOR(S) DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, * INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO - * EVENT SHALL KEITH PACKARD BE LIABLE FOR ANY SPECIAL, INDIRECT OR + * EVENT SHALL THE AUTHOR(S) BE LIABLE FOR ANY SPECIAL, INDIRECT OR * 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 @@ -29,12 +29,32 @@ Creates a pattern with no properties; used to build patterns from scratch. @@ +@RET@ FcPattern * +@FUNC@ FcPatternDuplicate +@TYPE1@ const FcPattern * @ARG1@ p +@PURPOSE@ Copy a pattern +@DESC@ +Copy a pattern, returning a new pattern that matches +p. 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 p. Patterns are freed only +when the reference count reaches zero. +@@ + @RET@ void @FUNC@ FcPatternDestroy @TYPE1@ FcPattern * @ARG1@ p @PURPOSE@ Destroy a pattern @DESC@ -Destroys a pattern, in the process destroying all related values. +Decrement the pattern reference count. If all references are gone, destroys +the pattern, in the process destroying all related values. @@ @RET@ FcBool @@ -57,6 +77,18 @@ Returns whether pa and pb have exa objects in os. @@ +@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 +p that are in os. +If os is NULL, a duplicate of +p is returned. +@@ + @RET@ FcChar32 @FUNC@ FcPatternHash @TYPE1@ const FcPattern * @ARG1@ p @@ -70,13 +102,13 @@ equal. @FUNC@ FcPatternAdd @TYPE1@ FcPattern * @ARG1@ p @TYPE2@ const char * @ARG2@ object -@TYPE3@ FcValue @ARG3@ value -@TYPE4@ FcBool @ARG4@ append +@TYPE3@ FcValue% @ARG3@ value +@TYPE4@ FcBool% @ARG4@ append @PURPOSE@ Add a value to a pattern @DESC@ Adds a single value to the list of values associated with the property named `object. If `append is FcTrue, the value is added at the end of any -existing list, otherwise it is inserted at the begining. `value' is saved +existing list, otherwise it is inserted at the beginning. `value' is saved (with FcValueSave) when inserted into the pattern so that the library retains no reference to any application-supplied data structure. @@ @@ -85,8 +117,8 @@ retains no reference to any application-supplied data structure. @FUNC@ FcPatternAddWeak @TYPE1@ FcPattern * @ARG1@ p @TYPE2@ const char * @ARG2@ object -@TYPE3@ FcValue @ARG3@ value -@TYPE4@ FcBool @ARG4@ append +@TYPE3@ FcValue% @ARG3@ value +@TYPE4@ FcBool% @ARG4@ append @PURPOSE@ Add a value to a pattern with weak binding @DESC@ FcPatternAddWeak is essentially the same as FcPatternAdd except that any @@ -98,21 +130,21 @@ values added to the list have binding weak instead of weak instead of FcPatternVaBuild is used when the arguments are already in the form of a -varargs value. +varargs value. FcPatternVapBuild is a macro version of FcPatternVaBuild +which returns its result directly in the result +variable. @@ @RET@ FcBool @@ -267,7 +341,7 @@ whether the property existed or not. @FUNC@ FcPatternRemove @TYPE1@ FcPattern * @ARG1@ p @TYPE2@ const char * @ARG2@ object -@TYPE3@ int @ARG3@ id +@TYPE3@ int% @ARG3@ id @PURPOSE@ Remove one object of the specified type from the pattern @DESC@ Removes the value associated with the property `object' at position `id', returning @@ -306,7 +380,7 @@ specified point size (default 12), dpi (default 75) and scale (default 1). @RET@ FcPattern * @FUNC@ FcNameParse -@TYPE1@ const char * @ARG1@ name +@TYPE1@ const FcChar8 * @ARG1@ name @PURPOSE@ Parse a pattern string @DESC@ Converts name from the standard text format described above into a pattern. @@ -319,5 +393,5 @@ Converts name from the standard text format described abo @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 -which should be freed by the caller. +which should be freed by the caller using free(). @@