Libc-1439.100.3.tar.gz

[apple/libc.git] / stdlib / FreeBSD / atexit.3

diff --git a/stdlib/FreeBSD/atexit.3 b/stdlib/FreeBSD/atexit.3
index 72a9977257559ca66e0d7dc5c0395829535c520c..9d60aa81fe5b79b260e4af2da11f1e20536621b8 100644 (file)
--- a/stdlib/FreeBSD/atexit.3
+++ b/stdlib/FreeBSD/atexit.3
@@ -13,11 +13,7 @@
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.
 .\" 2. Redistributions in binary form must reproduce the above copyright
 .\"    notice, this list of conditions and the following disclaimer in the
 .\"    documentation and/or other materials provided with the distribution.

-.\" 3. All advertising materials mentioning features or use of this software
-.\"    must display the following acknowledgement:
-.\"    This product includes software developed by the University of
-.\"    California, Berkeley and its contributors.
-.\" 4. Neither the name of the University nor the names of its contributors
+.\" 3. Neither the name of the University nor the names of its contributors

 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\"
 .\"    may be used to endorse or promote products derived from this software
 .\"    without specific prior written permission.
 .\"


@@ -34,7 +30,7 @@
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)atexit.3   8.1 (Berkeley) 6/4/93
 .\" SUCH DAMAGE.
 .\"
 .\"     @(#)atexit.3   8.1 (Berkeley) 6/4/93

-.\" $FreeBSD: src/lib/libc/stdlib/atexit.3,v 1.10 2002/12/18 13:33:03 ru Exp $
+.\" $FreeBSD$

 .\"
 .Dd September 6, 2002
 .Dt ATEXIT 3
 .\"
 .Dd September 6, 2002
 .Dt ATEXIT 3


@@ -42,12 +38,14 @@
 .Sh NAME
 .Nm atexit
 .Nd register a function to be called on exit
 .Sh NAME
 .Nm atexit
 .Nd register a function to be called on exit

-.Sh LIBRARY
-.Lb libc

 .Sh SYNOPSIS
 .In stdlib.h
 .Ft int
 .Fn atexit "void (*function)(void)"
 .Sh SYNOPSIS
 .In stdlib.h
 .Ft int
 .Fn atexit "void (*function)(void)"

+#ifdef UNIFDEF_BLOCKS
+.Ft int
+.Fn atexit_b "void (^function)(void)"
+#endif

 .Sh DESCRIPTION
 The
 .Fn atexit
 .Sh DESCRIPTION
 The
 .Fn atexit


@@ -61,6 +59,33 @@ or via return from the program's
 Functions so registered are called in reverse order;
 no arguments are passed.
 .Pp
 Functions so registered are called in reverse order;
 no arguments are passed.
 .Pp

+If the provided
+.Fa function
+is located in a library that has been dynamically loaded (e.g. by
+.Fn dlopen ) Ns ,
+it will be called when the library is unloaded (due to a call
+to
+.Fn dlclose )
+or at program exit.
+#ifdef UNIFDEF_BLOCKS
+.Pp
+The
+.Fn atexit_b
+function is like
+.Fn atexit
+except the callback is a block pointer instead of a function pointer.
+.Bd -ragged -offset indent
+Note: The
+.Fn Block_copy
+function (defined in
+.In Blocks.h )
+is used by
+.Fn atexit_b
+to make a copy of the block, especially for the case when a stack-based
+block might go out of scope when the subroutine returns.
+.Ed
+#endif
+.Pp

 These functions must not call
 .Fn exit ;
 if it should be necessary to terminate the process while in such a
 These functions must not call
 .Fn exit ;
 if it should be necessary to terminate the process while in such a


@@ -75,7 +100,10 @@ At least 32 functions can always be registered,
 and more are allowed as long as sufficient memory can be allocated.
 .\" XXX {ATEXIT_MAX} is not implemented yet
 .Sh RETURN VALUES
 and more are allowed as long as sufficient memory can be allocated.
 .\" XXX {ATEXIT_MAX} is not implemented yet
 .Sh RETURN VALUES

-.Rv -std atexit
+#ifdef UNIFDEF_BLOCKS
+.ds ATEXIT_B atexit_b
+#endif
+.Rv -std atexit \*[ATEXIT_B]

 .Sh ERRORS
 .Bl -tag -width Er
 .It Bq Er ENOMEM
 .Sh ERRORS
 .Bl -tag -width Er
 .It Bq Er ENOMEM