X-Git-Url: https://git.wh0rd.org/?a=blobdiff_plain;f=doc%2Ffcpattern.fncs;h=ed59580e7ee07c0929eea3b23d95f4f1678eb7ce;hb=e690fbb20ec41ef018a32ac01118a41103c01289;hp=b049966f64d4f24d00764812054b91103fd4d3a8;hpb=af7a965f945ab5aafab13fb7b6e8d96c911b24fd;p=fontconfig.git

diff --git a/doc/fcpattern.fncs b/doc/fcpattern.fncs
index b049966..ed59580 100644
--- a/doc/fcpattern.fncs
+++ b/doc/fcpattern.fncs
@@ -1,5 +1,5 @@
 /*
- * $Id$
+ * fontconfig/doc/fcpattern.fncs
  *
  * Copyright © 2003 Keith Packard
  *
@@ -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
+<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.
+@@
+
 @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 <parameter>pa</parameter> and <parameter>pb</parameter> have exa
 objects in <parameter>os</parameter>.
 @@
 
+@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.
+@@
+
 @RET@		FcChar32
 @FUNC@		FcPatternHash
 @TYPE1@		const FcPattern *		@ARG1@		p
@@ -70,8 +102,8 @@ 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
@@ -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 <parameter>weak</parameter> instead of <pa
 @FUNC@		FcPatternAddInteger
 @TYPE1@ 	FcPattern * 			@ARG1@ 		p
 @TYPE2@		const char *			@ARG2@		object
-@TYPE3@		int				@ARG3@		i
+@TYPE3@		int%				@ARG3@		i
 
 @PROTOTYPE+@
 @RET+@		FcBool
 @FUNC+@		FcPatternAddDouble
 @TYPE1+@ 	FcPattern * 			@ARG1+@ 	p
 @TYPE2+@	const char *			@ARG2+@		object
-@TYPE3+@	double				@ARG3+@		d
+@TYPE3+@	double%				@ARG3+@		d
 
 @PROTOTYPE++@
 @RET++@		FcBool
 @FUNC++@	FcPatternAddString
 @TYPE1++@ 	FcPattern * 			@ARG1++@ 	p
 @TYPE2++@	const char *			@ARG2++@	object
-@TYPE3++@	const char *			@ARG3++@	s
+@TYPE3++@	const FcChar8 *			@ARG3++@	s
 
 @PROTOTYPE+++@
 @RET+++@	FcBool
@@ -133,7 +165,22 @@ values added to the list have binding <parameter>weak</parameter> instead of <pa
 @FUNC+++++@	FcPatternAddBool
 @TYPE1+++++@ 	FcPattern * 			@ARG1+++++@ 	p
 @TYPE2+++++@	const char *			@ARG2+++++@	object
-@TYPE3+++++@	FcBool				@ARG3+++++@	b
+@TYPE3+++++@	FcBool%				@ARG3+++++@	b
+
+@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
+
 @PURPOSE@	Add a typed value to a pattern
 @DESC@
 These are all convenience functions that insert objects of the specified
@@ -146,7 +193,7 @@ any existing list of values.
 @FUNC@		FcPatternGet
 @TYPE1@		FcPattern *			@ARG1@		p
 @TYPE2@		const char *			@ARG2@		object
-@TYPE3@		int  				@ARG3@ 		id
+@TYPE3@		int%  				@ARG3@ 		id
 @TYPE4@		FcValue *			@ARG4@		v 
 @PURPOSE@	Return a value from a pattern
 @DESC@
@@ -162,7 +209,7 @@ within the pattern directly.  Applications must not free this value.
 @FUNC@		FcPatternGetInteger
 @TYPE1@		FcPattern *			@ARG1@		p
 @TYPE2@		const char *			@ARG2@		object
-@TYPE3@		int				@ARG3@		n
+@TYPE3@		int%				@ARG3@		n
 @TYPE4@		int *				@ARG4@		i
 
 @PROTOTYPE+@
@@ -170,7 +217,7 @@ within the pattern directly.  Applications must not free this value.
 @FUNC+@ 	FcPatternGetDouble
 @TYPE1+@	FcPattern *			@ARG1+@		p
 @TYPE2+@	const char *			@ARG2+@		object
-@TYPE3+@	int				@ARG3+@		n
+@TYPE3+@	int%				@ARG3+@		n
 @TYPE4+@	double *			@ARG4+@		d 
 
 @PROTOTYPE++@
@@ -178,15 +225,15 @@ within the pattern directly.  Applications must not free this value.
 @FUNC++@	FcPatternGetString
 @TYPE1++@	FcPattern *			@ARG1++@	p
 @TYPE2++@	const char *			@ARG2++@	object
-@TYPE3++@	int				@ARG3++@	n
-@TYPE4++@	char **const			@ARG4++@	s
+@TYPE3++@	int%				@ARG3++@	n
+@TYPE4++@	FcChar8 **			@ARG4++@	s
 
 @PROTOTYPE+++@
 @RET+++@	FcResult
 @FUNC+++@	FcPatternGetMatrix 
 @TYPE1+++@ 	FcPattern * 			@ARG1+++@ 	p 
 @TYPE2+++@ 	const char * 			@ARG2+++@ 	object 
-@TYPE3+++@ 	int  				@ARG3+++@ 	n 
+@TYPE3+++@ 	int%  				@ARG3+++@ 	n 
 @TYPE4+++@ 	FcMatrix ** 			@ARG4+++@ 	s 
 
 @PROTOTYPE++++@
@@ -194,7 +241,7 @@ within the pattern directly.  Applications must not free this value.
 @FUNC++++@ 	FcPatternGetCharSet 
 @TYPE1++++@ 	FcPattern * 			@ARG1++++@ 	p 
 @TYPE2++++@ 	const char * 			@ARG2++++@ 	object 
-@TYPE3++++@ 	int  				@ARG3++++@ 	n 
+@TYPE3++++@ 	int%  				@ARG3++++@ 	n 
 @TYPE4++++@ 	FcCharSet ** 			@ARG4++++@ 	c 
 
 @PROTOTYPE+++++@
@@ -202,8 +249,25 @@ within the pattern directly.  Applications must not free this value.
 @FUNC+++++@ 	FcPatternGetBool 		
 @TYPE1+++++@ 	FcPattern * 			@ARG1+++++@ 	p
 @TYPE2+++++@ 	const char * 			@ARG2+++++@ 	object 
-@TYPE3+++++@ 	int  				@ARG3+++++@ 	n 
+@TYPE3+++++@ 	int%  				@ARG3+++++@ 	n 
 @TYPE4+++++@ 	FcBool * 			@ARG4+++++@ 	b 
+
+@PROTOTYPE++++++@
+@RET++++++@	FcBool
+@FUNC++++++@	FcPatternGetFTFace
+@TYPE1++++++@ 	FcPattern * 			@ARG1++++++@ 	p
+@TYPE2++++++@	const char *			@ARG2++++++@	object
+@TYPE3+++++@ 	int%  				@ARG3+++++@ 	n
+@TYPE3++++++@	FT_Face *			@ARG3++++++@	f
+
+@PROTOTYPE+++++++@
+@RET+++++++@	FcBool
+@FUNC+++++++@	FcPatternGetLangSet
+@TYPE1+++++++@ 	FcPattern * 			@ARG1+++++++@ 	p
+@TYPE2+++++++@	const char *			@ARG2+++++++@	object
+@TYPE3+++++@ 	int%  				@ARG3+++++@ 	n
+@TYPE3+++++++@	FcLangSet **			@ARG3+++++++@	l
+
 @PURPOSE@	Return a typed value from a pattern
 @DESC@
 These are convenience functions that call FcPatternGet and verify that the
@@ -222,7 +286,15 @@ in preference to FcPatternGet to provide compile-time typechecking.
 @RET+@		FcPattern *
 @FUNC+@		FcPatternVaBuild
 @TYPE1+@	FcPattern *			@ARG1+@		orig
-@TYPE2+@	va_list 			@ARG2+@		va
+@TYPE2+@	va_list% 			@ARG2+@		va
+
+@PROTOTYPE++@
+@RET++@		void
+@FUNC++@	FcPatternVapBuild
+@TYPE1++@	FcPattern *			@ARG1++@	result
+@TYPE2++@	FcPattern *			@ARG2++@	orig
+@TYPE3++@	va_list%			@ARG3++@	va
+
 @PURPOSE@	Create patterns from arguments
 @DESC@
 Builds a pattern using a list of objects, types and values.  Each
@@ -250,7 +322,9 @@ pattern = FcPatternBuild (0, FC_FAMILY, FcTypeString, "Times", (char *) 0);
 </programlisting>
 <para>
 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 <parameter>result</parameter>
+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 <parameter>name</parameter> from the standard text format described above into a pattern.