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

   1 /*
   2  * Automated Testing Framework (atf)
   3  *
   4  * Copyright (c) 2008, 2009 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 <atf-c/error_fwd.h>
  34 #include <atf-c/fs.h>
  35 #include <atf-c/list.h>
  36 #include <atf-c/object.h>
  37 #include <atf-c/process.h>
  38
  39 /* ---------------------------------------------------------------------
  40  * The "atf_check_result" type.
  41  * --------------------------------------------------------------------- */
  42
  43 struct atf_check_result {
  44     atf_object_t m_object;
  45
  46     atf_list_t m_argv;
  47     atf_fs_path_t m_dir;
  48     atf_fs_path_t m_stdout;
  49     atf_fs_path_t m_stderr;
  50     atf_process_status_t m_status;
  51 };
  52 typedef struct atf_check_result atf_check_result_t;
  53
  54 /* Construtors and destructors */
  55 void atf_check_result_fini(atf_check_result_t *);
  56
  57 /* Getters */
  58 const atf_list_t *atf_check_result_argv(const atf_check_result_t *);
  59 const atf_fs_path_t *atf_check_result_stdout(const atf_check_result_t *);
  60 const atf_fs_path_t *atf_check_result_stderr(const atf_check_result_t *);
  61 bool atf_check_result_exited(const atf_check_result_t *);
  62 int atf_check_result_exitcode(const atf_check_result_t *);
  63
  64 /* ---------------------------------------------------------------------
  65  * Free functions.
  66  * --------------------------------------------------------------------- */
  67
  68 atf_error_t atf_check_build_c_o(const char *, const char *,
  69                                 const char *const [],
  70                                 bool *);
  71 atf_error_t atf_check_build_cpp(const char *, const char *,
  72                                 const char *const [],
  73                                 bool *);
  74 atf_error_t atf_check_build_cxx_o(const char *, const char *,
  75                                   const char *const [],
  76                                   bool *);
  77 atf_error_t atf_check_exec_array(const char *const *, atf_check_result_t *);
  78 atf_error_t atf_check_exec_list(const atf_list_t *, atf_check_result_t *);
  79
  80 #endif /* ATF_C_CHECK_H */