error.h revision 240116 
1323530Savg/*
2323530Savg * Automated Testing Framework (atf)
3323530Savg *
4323530Savg * Copyright (c) 2008 The NetBSD Foundation, Inc.
5323530Savg * All rights reserved.
6323530Savg *
7323530Savg * Redistribution and use in source and binary forms, with or without
8323530Savg * modification, are permitted provided that the following conditions
9323530Savg * are met:
10323530Savg * 1. Redistributions of source code must retain the above copyright
11323530Savg *    notice, this list of conditions and the following disclaimer.
12323530Savg * 2. Redistributions in binary form must reproduce the above copyright
13323530Savg *    notice, this list of conditions and the following disclaimer in the
14323530Savg *    documentation and/or other materials provided with the distribution.
15323530Savg *
16323530Savg * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
17323530Savg * CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18323530Savg * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19323530Savg * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20323530Savg * IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
21323530Savg * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22323530Savg * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23323530Savg * GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24323530Savg * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25323530Savg * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26323530Savg * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27323530Savg * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28323530Savg */
29323530Savg
30323530Savg#if !defined(ATF_C_ERROR_H)
31323530Savg#define ATF_C_ERROR_H
32323530Savg
33323530Savg#include <stdbool.h>
34323530Savg#include <stddef.h>
35323530Savg
36323530Savg#include <atf-c/error_fwd.h>
37323530Savg
38323530Savg/* ---------------------------------------------------------------------
39323530Savg * The "atf_error" type.
40323530Savg * --------------------------------------------------------------------- */
41323530Savg
42323530Savgstruct atf_error {
43323530Savg    bool m_free;
44323530Savg    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