Home | History | Annotate | Line # | Download | only in libutil
 $NetBSD: efun.3,v 1.14 2015/07/26 17:37:38 kamil Exp $

Copyright (c) 2006 The NetBSD Foundation, Inc.
All rights reserved.

This code is derived from software contributed to The NetBSD Foundation
by Christos Zoulas.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
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.

THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
POSSIBILITY OF SUCH DAMAGE.

.Dd July 26, 2015 .Dt EFUN 3 .Os .Sh NAME .Nm esetfunc , .Nm easprintf , .Nm efopen , .Nm emalloc , .Nm ecalloc , .Nm erealloc , .Nm ereallocarr , .Nm estrdup , .Nm estrndup , .Nm estrlcat , .Nm estrlcpy , .Nm estrtoi , .Nm estrtou , .Nm evasprintf .Nd error-checked utility functions .Sh LIBRARY .Lb libutil .Sh SYNOPSIS n util.h .Ft void (*)(int, const char *, ...) .Fn esetfunc "void (*)(int, const char *, ...)" .Ft int .Fn easprintf "char ** restrict str" "const char * restrict fmt" "..." .Ft FILE * .Fn efopen "const char *p" "const char *m" .Ft void * .Fn ecalloc "size_t n" "size_t s" .Ft void * .Fn emalloc "size_t n" .Ft void * .Fn erealloc "void *p" "size_t n" .Ft void .Fn ereallocarr "void *p" "size_t n" "size_t s" .Ft char * .Fn estrdup "const char *s" .Ft char * .Fn estrndup "const char *s" "size_t len" .Ft size_t .Fn estrlcat "char *dst" "const char *src" "size_t len" .Ft size_t .Fn estrlcpy "char *dst" "const char *src" "size_t len" .Ft intmax_t .Fn estrtoi "const char * nptr" "int base" "intmax_t lo" "intmax_t hi" .Ft uintmax_t .Fn estrtou "const char * nptr" "int base" "uintmax_t lo" "uintmax_t hi" .Ft int .Fn evasprintf "char ** restrict str" "const char * restrict fmt" "..." .Sh DESCRIPTION The .Fn easprintf , .Fn efopen , .Fn ecalloc , .Fn emalloc , .Fn erealloc , .Fn ereallocarr , .Fn estrdup , .Fn estrndup , .Fn estrlcat , .Fn estrlcpy , .Fn estrtoi , .Fn estrtou , and .Fn evasprintf functions operate exactly as the corresponding functions that do not start with an .Sq e except that in case of an error, they call the installed error handler that can be configured with .Fn esetfunc .

p For the string handling functions, it is an error when the destination buffer is not large enough to hold the complete string. For functions that allocate memory or open a file, it is an error when they would return a null pointer. The default error handler is .Xr err 3 . The function .Fn esetfunc returns the previous error handler function. A .Dv NULL error handler will just call .Xr exit 3 . .Sh SEE ALSO .Xr asprintf 3 , .Xr calloc 3 , .Xr err 3 , .Xr exit 3 , .Xr fopen 3 , .Xr malloc 3 , .Xr realloc 3 , .Xr reallocarr 3 , .Xr strdup 3 , .Xr strlcat 3 , .Xr strlcpy 3 , .Xr strndup 3 , .Xr strtoi 3 , .Xr strtou 3 , .Xr vasprintf 3 .Sh HISTORY The .Fn estrtoi , .Fn estrtou and .Fn ereallocarr functions were added in .Nx 8 .