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