Home | History | Annotate | Line # | Download | only in atf-c 
      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/defs.h>
     37 #include <atf-c/error_fwd.h>
     38 
     39 /* ---------------------------------------------------------------------
     40  * The "atf_error" type.
     41  * --------------------------------------------------------------------- */
     42 
     43 struct atf_error {
     44     bool m_free;
     45     const char *m_type;
     46     void *m_data;
     47 
     48     void (*m_format)(struct atf_error *, char *, size_t);
     49 };
     50 
     51 atf_error_t atf_error_new(const char *, void *, size_t,
     52                           void (*)(const atf_error_t, char *, size_t));
     53 void atf_error_free(atf_error_t);
     54 
     55 atf_error_t atf_no_error(void);
     56 bool atf_is_error(const atf_error_t);
     57 
     58 bool atf_error_is(const atf_error_t, const char *);
     59 const void *atf_error_data(const atf_error_t);
     60 void atf_error_format(const atf_error_t, char *, size_t);
     61 
     62 /* ---------------------------------------------------------------------
     63  * Common error types.
     64  * --------------------------------------------------------------------- */
     65 
     66 atf_error_t atf_libc_error(int, const char *, ...)
     67     ATF_DEFS_ATTRIBUTE_FORMAT_PRINTF(2, 3);
     68 int atf_libc_error_code(const atf_error_t);
     69 const char *atf_libc_error_msg(const atf_error_t);
     70 
     71 atf_error_t atf_no_memory_error(void);
     72 
     73 #endif /* ATF_C_ERROR_H */
     74