xref: /netbsd-src/lib/libutil/efun.3 (revision ce2c90c7c172d95d2402a5b3d96d8f8e6d138a21)
1.\"     $NetBSD: efun.3,v 1.3 2006/10/06 15:31:20 pooka Exp $
2.\"
3.\" Copyright (c) 2006 The NetBSD Foundation, Inc.
4.\" All rights reserved.
5.\"
6.\" This code is derived from software contributed to The NetBSD Foundation
7.\" by Christos Zoulas.
8.\"
9.\" Redistribution and use in source and binary forms, with or without
10.\" modification, are permitted provided that the following conditions
11.\" are met:
12.\" 1. Redistributions of source code must retain the above copyright
13.\"    notice, this list of conditions and the following disclaimer.
14.\" 2. Redistributions in binary form must reproduce the above copyright
15.\"    notice, this list of conditions and the following disclaimer in the
16.\"    documentation and/or other materials provided with the distribution.
17.\" 3. All advertising materials mentioning features or use of this software
18.\"    must display the following acknowledgement:
19.\"        This product includes software developed by the NetBSD
20.\"        Foundation, Inc. and its contributors.
21.\" 4. Neither the name of The NetBSD Foundation nor the names of its
22.\"    contributors may be used to endorse or promote products derived
23.\"    from this software without specific prior written permission.
24.\"
25.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
26.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
27.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
28.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
29.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
30.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
31.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
32.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
33.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
34.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
35.\" POSSIBILITY OF SUCH DAMAGE.
36.\"
37.Dd October 6, 2006
38.Dt EFUN 3
39.Os
40.Sh NAME
41.Nm esetfunc ,
42.Nm easprintf ,
43.Nm efopen ,
44.Nm emalloc ,
45.Nm ecalloc ,
46.Nm erealloc ,
47.Nm estrdup ,
48.Nm estrlcat ,
49.Nm estrlcpy ,
50.Nm evasprintf
51.Nd error-checked utility functions
52.Sh LIBRARY
53.Lb libutil
54.Sh SYNOPSIS
55.In util.h
56.Ft void (*)(int, const char *, ...)
57.Fn esetfun "void (*)(int, const char *, ...)"
58.Ft int
59.Fn easprintf "char ** restrict str" "const char * restrict fmt" "..."
60.Ft FILE *
61.Fn efopen "const char *p" "const char *m"
62.Ft void *
63.Fn ecalloc "size_t n" "size_t c"
64.Ft void *
65.Fn emalloc "size_t n"
66.Ft void *
67.Fn erealloc "void *p" "size_t n"
68.Ft char *
69.Fn estrdup "const char *s"
70.Ft size_t
71.Fn estrlcat "char *dst" "const char *src" "size_t len"
72.Ft size_t
73.Fn estrlcpy "char *dst" "const char *src" "size_t len"
74.Ft int
75.Fn evasprintf "char ** restrict str" "const char * restrict fmt" "..."
76.Sh DESCRIPTION
77The
78.Nm easprintf ,
79.Nm efopen ,
80.Nm ecalloc ,
81.Nm emalloc ,
82.Nm erealloc ,
83.Nm estrdup ,
84.Nm estrlcat ,
85.Nm estrlcpy ,
86and
87.Nm evasprintf
88functions
89operate exactly as the correspoding functions that do not start with an
90.Sq e
91except that they call
92the installed error handler that can be configured with
93.Nm esetfunc .
94The default error handler is
95.Xr err 3 .
96The function
97.Nm esetfunc
98returns the previous error handler function.
99A
100.Dv NULL
101error handler will just call
102.Xr exit 3 .
103.Sh SEE ALSO
104.Xr asprintf 3 ,
105.Xr calloc 3 ,
106.Xr err 3 ,
107.Xr exit 3 ,
108.Xr fopen 3 ,
109.Xr malloc 3 ,
110.Xr realloc 3 ,
111.Xr strdup 3 ,
112.Xr strlcat 3 ,
113.Xr strlcpy 3 ,
114.Xr vasprintf 3
115