external/bsd/atf/dist/atf-c/tcr.h

   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_TCR_H)
  31 #define ATF_C_TCR_H
  32
  33 #include <stdarg.h>
  34 #include <stdbool.h>
  35
  36 #include <atf-c/dynstr.h>
  37 #include <atf-c/error_fwd.h>
  38 #include <atf-c/object.h>
  39
  40 /* ---------------------------------------------------------------------
  41  * The "atf_tcr" type.
  42  * --------------------------------------------------------------------- */
  43
  44 typedef int atf_tcr_state_t;
  45
  46 struct atf_tcr {
  47     atf_object_t m_object;
  48
  49     atf_tcr_state_t m_state;
  50     atf_dynstr_t m_reason;
  51 };
  52 typedef struct atf_tcr atf_tcr_t;
  53
  54 /* Constants. */
  55 extern const atf_tcr_state_t atf_tcr_passed_state;
  56 extern const atf_tcr_state_t atf_tcr_failed_state;
  57 extern const atf_tcr_state_t atf_tcr_skipped_state;
  58
  59 /* Constructors/destructors. */
  60 atf_error_t atf_tcr_init(atf_tcr_t *, int);
  61 atf_error_t atf_tcr_init_reason_ap(atf_tcr_t *, atf_tcr_state_t,
  62                                    const char *, va_list);
  63 atf_error_t atf_tcr_init_reason_fmt(atf_tcr_t *, atf_tcr_state_t,
  64                                     const char *, ...);
  65 void atf_tcr_fini(atf_tcr_t *);
  66
  67 /* Getters. */
  68 atf_tcr_state_t atf_tcr_get_state(const atf_tcr_t *);
  69 const atf_dynstr_t *atf_tcr_get_reason(const atf_tcr_t *);
  70 bool atf_tcr_has_reason(const atf_tcr_t *);
  71
  72 /* Operators. */
  73 bool atf_equal_tcr_tcr(const atf_tcr_t *, const atf_tcr_t *);
  74
  75 /* Serialization. */
  76 atf_error_t atf_tcr_serialize(const atf_tcr_t *, const int);
  77 atf_error_t atf_tcr_deserialize(atf_tcr_t *, const int);
  78
  79 #endif /* ATF_C_TCR_H */