contrib/atf/atf-c/check.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_CHECK_H)
  31 #define ATF_C_CHECK_H
  32
  33 #include <stdbool.h>
  34
  35 #include <atf-c/error_fwd.h>
  36
  37 /* ---------------------------------------------------------------------
  38  * The "atf_check_result" type.
  39  * --------------------------------------------------------------------- */
  40
  41 struct atf_check_result_impl;
  42 struct atf_check_result {
  43     struct atf_check_result_impl *pimpl;
  44 };
  45 typedef struct atf_check_result atf_check_result_t;
  46
  47 /* Construtors and destructors */
  48 void atf_check_result_fini(atf_check_result_t *);
  49
  50 /* Getters */
  51 const char *atf_check_result_stdout(const atf_check_result_t *);
  52 const char *atf_check_result_stderr(const atf_check_result_t *);
  53 bool atf_check_result_exited(const atf_check_result_t *);
  54 int atf_check_result_exitcode(const atf_check_result_t *);
  55 bool atf_check_result_signaled(const atf_check_result_t *);
  56 int atf_check_result_termsig(const atf_check_result_t *);
  57
  58 /* ---------------------------------------------------------------------
  59  * Free functions.
  60  * --------------------------------------------------------------------- */
  61
  62 atf_error_t atf_check_build_c_o(const char *, const char *,
  63                                 const char *const [],
  64                                 bool *);
  65 atf_error_t atf_check_build_cpp(const char *, const char *,
  66                                 const char *const [],
  67                                 bool *);
  68 atf_error_t atf_check_build_cxx_o(const char *, const char *,
  69                                   const char *const [],
  70                                   bool *);
  71 atf_error_t atf_check_exec_array(const char *const *, atf_check_result_t *);
  72
  73 #endif /* ATF_C_CHECK_H */