1//
2// Automated Testing Framework (atf)
3//
4// Copyright (c) 2007 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_CXX_CHECK_HPP_)
31#define _ATF_CXX_CHECK_HPP_
32
33extern "C" {
34#include <atf-c/check.h>
35}
36
37#include <cstddef>
38#include <memory>
39#include <string>
40#include <vector>
41
42namespace atf {
43
44namespace process {
45class argv_array;
46} // namespace process
47
48namespace check {
49
50// ------------------------------------------------------------------------
51// The "check_result" class.
52// ------------------------------------------------------------------------
53
54//!
55//! \brief A class that contains results of executed command.
56//!
57//! The check_result class holds information about results
58//! of executing arbitrary command and manages files containing
59//! its output.
60//!
61class check_result {
62    // Non-copyable.
63    check_result(const check_result&);
64    check_result& operator=(const check_result&);
65
66    //!
67    //! \brief Internal representation of a result.
68    //!
69    atf_check_result_t m_result;
70
71    //!
72    //! \brief Constructs a results object and grabs ownership of the
73    //! parameter passed in.
74    //!
75    check_result(const atf_check_result_t* result);
76
77    friend check_result test_constructor(const char* const*);
78    friend std::auto_ptr< check_result > exec(const atf::process::argv_array&);
79
80public:
81    //!
82    //! \brief Destroys object and removes all managed files.
83    //!
84    ~check_result(void);
85
86    //!
87    //! \brief Returns whether the command exited correctly or not.
88    //!
89    bool exited(void) const;
90
91    //!
92    //! \brief Returns command's exit status.
93    //!
94    int exitcode(void) const;
95
96    //!
97    //! \brief Returns whether the command received a signal or not.
98    //!
99    bool signaled(void) const;
100
101    //!
102    //! \brief Returns the signal that terminated the command.
103    //!
104    int termsig(void) const;
105
106    //!
107    //! \brief Returns the path to file contaning command's stdout.
108    //!
109    const std::string stdout_path(void) const;
110
111    //!
112    //! \brief Returns the path to file contaning command's stderr.
113    //!
114    const std::string stderr_path(void) const;
115};
116
117// ------------------------------------------------------------------------
118// Free functions.
119// ------------------------------------------------------------------------
120
121bool build_c_o(const std::string&, const std::string&,
122               const atf::process::argv_array&);
123bool build_cpp(const std::string&, const std::string&,
124               const atf::process::argv_array&);
125bool build_cxx_o(const std::string&, const std::string&,
126                 const atf::process::argv_array&);
127std::auto_ptr< check_result > exec(const atf::process::argv_array&);
128
129// Useful for testing only.
130check_result test_constructor(void);
131
132} // namespace check
133} // namespace atf
134
135#endif // !defined(_ATF_CXX_CHECK_HPP_)
136