contrib/atf/atf-c/check.h

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