1.\" $NetBSD: efun.3,v 1.10 2010/05/03 05:40:37 jruoho 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.\" 18.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS 19.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED 20.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 21.\" PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS 22.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 23.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 24.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 25.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 26.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 27.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 28.\" POSSIBILITY OF SUCH DAMAGE. 29.\" 30.Dd May 3, 2010 31.Dt EFUN 3 32.Os 33.Sh NAME 34.Nm esetfunc , 35.Nm easprintf , 36.Nm efopen , 37.Nm emalloc , 38.Nm ecalloc , 39.Nm erealloc , 40.Nm estrdup , 41.Nm estrndup , 42.Nm estrlcat , 43.Nm estrlcpy , 44.Nm evasprintf 45.Nd error-checked utility functions 46.Sh LIBRARY 47.Lb libutil 48.Sh SYNOPSIS 49.In util.h 50.Ft void (*)(int, const char *, ...) 51.Fn esetfunc "void (*)(int, const char *, ...)" 52.Ft int 53.Fn easprintf "char ** restrict str" "const char * restrict fmt" "..." 54.Ft FILE * 55.Fn efopen "const char *p" "const char *m" 56.Ft void * 57.Fn ecalloc "size_t n" "size_t c" 58.Ft void * 59.Fn emalloc "size_t n" 60.Ft void * 61.Fn erealloc "void *p" "size_t n" 62.Ft char * 63.Fn estrdup "const char *s" 64.Ft char * 65.Fn estrndup "const char *s" "size_t len" 66.Ft size_t 67.Fn estrlcat "char *dst" "const char *src" "size_t len" 68.Ft size_t 69.Fn estrlcpy "char *dst" "const char *src" "size_t len" 70.Ft int 71.Fn evasprintf "char ** restrict str" "const char * restrict fmt" "..." 72.Sh DESCRIPTION 73The 74.Fn easprintf , 75.Fn efopen , 76.Fn ecalloc , 77.Fn emalloc , 78.Fn erealloc , 79.Fn estrdup , 80.Fn estrndup , 81.Fn estrlcat , 82.Fn estrlcpy , 83and 84.Fn evasprintf 85functions 86operate exactly as the corresponding functions that do not start with an 87.Sq e 88except that in case of an error, they call 89the installed error handler that can be configured with 90.Fn esetfunc . 91.Pp 92For the string handling functions, it is an error when the destination 93buffer is not large enough to hold the complete string. 94For functions that allocate memory or open a file, it is an error when 95they would return a null pointer. 96The default error handler is 97.Xr err 3 . 98The function 99.Fn esetfunc 100returns the previous error handler function. 101A 102.Dv NULL 103error handler will just call 104.Xr exit 3 . 105.Sh SEE ALSO 106.Xr asprintf 3 , 107.Xr calloc 3 , 108.Xr err 3 , 109.Xr exit 3 , 110.Xr fopen 3 , 111.Xr malloc 3 , 112.Xr realloc 3 , 113.Xr strdup 3 , 114.Xr strlcat 3 , 115.Xr strlcpy 3 , 116.Xr strndup 3 , 117.Xr vasprintf 3 118