Efun source.

This commit is contained in:
christos 2006-08-26 18:11:45 +00:00
parent e72710e561
commit 6e90deb9cb
2 changed files with 261 additions and 0 deletions

111
lib/libutil/efun.3 Normal file
View File

@ -0,0 +1,111 @@
.\" $NetBSD: efun.3,v 1.1 2006/08/26 18:11:45 christos 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.
.\" 3. All advertising materials mentioning features or use of this software
.\" must display the following acknowledgement:
.\" This product includes software developed by the NetBSD
.\" Foundation, Inc. and its contributors.
.\" 4. Neither the name of The NetBSD Foundation nor the names of its
.\" contributors may be used to endorse or promote products derived
.\" from this software without specific prior written permission.
.\"
.\" 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 3, 2006
.Dt EFUN 3
.Os
.Sh NAME
.Nm esetfunc ,
.Nm easprintf ,
.Nm efopen ,
.Nm emalloc ,
.Nm ecalloc ,
.Nm erealloc ,
.Nm estrdup ,
.Nm estrlcat ,
.Nm estrlcpy ,
.Nm evasprintf
.Nd error-checked utility functions
.Sh LIBRARY
.Lb libutil
.Sh SYNOPSIS
.Ft void (*)(int, const char *, ...)
.Fn esetfun "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 c"
.Ft void *
.Fn emalloc "size_t n"
.Ft void *
.Fn erealloc "void *p" "size_t n"
.Ft char *
.Fn estrdup "const char *s"
.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 int
.Fn evasprintf "char ** restrict str" "const char * restrict fmt" "..."
.Sh DESCRIPTION
The
.Nm easprintf ,
.Nm efopen ,
.Nm ecalloc ,
.Nm emalloc ,
.Nm erealloc ,
.Nm estrdup ,
.Nm estrlcat ,
.Nm estrlcpy ,
.Nm evasprintf
operate exactly as the correspoding functions that do not start with an
.Dq e
except that they call
the installed error handler that can be configured with
.Nm esetfunc .
The default error handler is
.Xr err 3 .
The function
.Nm esetfunc
returns the previous error handler function.
A
.Dv NULL
error handler will just call
.Xr exit 3 .
.Sh SEE ALSO
.Xr exit 3 ,
.Xr asprintf 3 ,
.Xr err 3 ,
.Xr fopen 3 ,
.Xr calloc 3 ,
.Xr malloc 3 ,
.Xr realloc 3 ,
.Xr strdup 3 ,
.Xr strlcat 3 ,
.Xr strlcpy 3 ,
.Xr vasprintf 3 .

150
lib/libutil/efun.c Normal file
View File

@ -0,0 +1,150 @@
/* $NetBSD: efun.c,v 1.1 2006/08/26 18:11:45 christos 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.
* 3. All advertising materials mentioning features or use of this software
* must display the following acknowledgement:
* This product includes software developed by the NetBSD
* Foundation, Inc. and its contributors.
* 4. Neither the name of The NetBSD Foundation nor the names of its
* contributors may be used to endorse or promote products derived
* from this software without specific prior written permission.
*
* 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.
*/
#include <sys/cdefs.h>
__RCSID("$NetBSD: efun.c,v 1.1 2006/08/26 18:11:45 christos Exp $");
#include <err.h>
#include <errno.h>
#include <string.h>
#include <stdlib.h>
#include <stdio.h>
#include <stdarg.h>
#include <util.h>
static void (*efunc)(int, const char *, ...) = err;
void (*
esetfunc(void (*ef)(int, const char *, ...)))(int, const char *, ...)
{
void (*of)(int, const char *, ...) = efunc;
efunc = ef == NULL ? (void (*)(int, const char *, ...))exit : ef;
return of;
}
size_t
estrlcpy(char *dst, const char *src, size_t len)
{
size_t rv;
if ((rv = strlcpy(dst, src, len)) >= len) {
errno = ENAMETOOLONG;
(*efunc)(1,
"Cannot copy string; %zu chars needed %zu provided",
rv, len);
}
return rv;
}
size_t
estrlcat(char *dst, const char *src, size_t len)
{
size_t rv;
if ((rv = strlcat(dst, src, len)) >= len) {
errno = ENAMETOOLONG;
(*efunc)(1,
"Cannot append to string; %zu chars needed %zu provided",
rv, len);
}
return rv;
}
char *
estrdup(const char *s)
{
char *d = strdup(s);
if (d == NULL)
(*efunc)(1, "Cannot copy string");
return d;
}
void *
emalloc(size_t n)
{
void *p = malloc(n);
if (p == NULL)
(*efunc)(1, "Cannot allocate %zu bytes", n);
return p;
}
void *
ecalloc(size_t n, size_t s)
{
void *p = calloc(n, s);
if (p == NULL)
(*efunc)(1, "Cannot allocate %zu bytes", n);
return memset(p, 0, n);
}
void *
erealloc(void *p, size_t n)
{
void *q = realloc(p, n);
if (q == NULL)
(*efunc)(1, "Cannot re-allocate %zu bytes", n);
return q;
}
FILE *
efopen(const char *p, const char *m)
{
FILE *fp = fopen(p, m);
if (fp == NULL)
(*efunc)(1, "Cannot open `%s'", p);
return fp;
}
int
easprintf(char ** __restrict ret, const char * __restrict format, ...)
{
int rv;
va_list ap;
va_start(ap, format);
if ((rv = vasprintf(ret, format, ap)) == -1)
(*efunc)(1, "Cannot format string");
va_end(ap);
return rv;
}
int
evasprintf(char ** __restrict ret, const char * __restrict format, va_list ap)
{
int rv;
if ((rv = vasprintf(ret, format, ap)) == -1)
(*efunc)(1, "Cannot format string");
return rv;
}