error.h revision 240116
1/* 2 * Automated Testing Framework (atf) 3 * 4 * Copyright (c) 2008 The NetBSD Foundation, Inc. 5 * All rights reserved. 6 * 7 * Redistribution and use in source and binary forms, with or without 8 * modification, are permitted provided that the following conditions 9 * are met: 10 * 1. Redistributions of source code must retain the above copyright 11 * notice, this list of conditions and the following disclaimer. 12 * 2. Redistributions in binary form must reproduce the above copyright 13 * notice, this list of conditions and the following disclaimer in the 14 * documentation and/or other materials provided with the distribution. 15 * 16 * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND 17 * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, 18 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 20 * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY 21 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE 23 * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 24 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER 25 * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR 26 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30#if !defined(ATF_C_ERROR_H) 31#define ATF_C_ERROR_H 32 33#include <stdbool.h> 34#include <stddef.h> 35 36#include <atf-c/error_fwd.h> 37 38/* --------------------------------------------------------------------- 39 * The "atf_error" type. 40 * --------------------------------------------------------------------- */ 41 42struct atf_error { 43 bool m_free; 44 const char *m_type; 45 void *m_data; 46 47 void (*m_format)(struct atf_error *, char *, size_t); 48}; 49 50atf_error_t atf_error_new(const char *, void *, size_t, 51 void (*)(const atf_error_t, char *, size_t)); 52void atf_error_free(atf_error_t); 53 54atf_error_t atf_no_error(void); 55bool atf_is_error(const atf_error_t); 56 57bool atf_error_is(const atf_error_t, const char *); 58const void *atf_error_data(const atf_error_t); 59void atf_error_format(const atf_error_t, char *, size_t); 60 61/* --------------------------------------------------------------------- 62 * Common error types. 63 * --------------------------------------------------------------------- */ 64 65atf_error_t atf_libc_error(int, const char *, ...); 66int atf_libc_error_code(const atf_error_t); 67const char *atf_libc_error_msg(const atf_error_t); 68 69atf_error_t atf_no_memory_error(void); 70 71#endif /* ATF_C_ERROR_H */ 72