xref: /netbsd-src/external/bsd/kyua-cli/dist/utils/cmdline/ui_mock.hpp (revision 6b3a42af15b5e090c339512c790dd68f3d11a9d8)
1*6b3a42afSjmmv // Copyright 2010 Google Inc.
2*6b3a42afSjmmv // All rights reserved.
3*6b3a42afSjmmv //
4*6b3a42afSjmmv // Redistribution and use in source and binary forms, with or without
5*6b3a42afSjmmv // modification, are permitted provided that the following conditions are
6*6b3a42afSjmmv // met:
7*6b3a42afSjmmv //
8*6b3a42afSjmmv // * Redistributions of source code must retain the above copyright
9*6b3a42afSjmmv //   notice, this list of conditions and the following disclaimer.
10*6b3a42afSjmmv // * Redistributions in binary form must reproduce the above copyright
11*6b3a42afSjmmv //   notice, this list of conditions and the following disclaimer in the
12*6b3a42afSjmmv //   documentation and/or other materials provided with the distribution.
13*6b3a42afSjmmv // * Neither the name of Google Inc. nor the names of its contributors
14*6b3a42afSjmmv //   may be used to endorse or promote products derived from this software
15*6b3a42afSjmmv //   without specific prior written permission.
16*6b3a42afSjmmv //
17*6b3a42afSjmmv // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18*6b3a42afSjmmv // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19*6b3a42afSjmmv // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20*6b3a42afSjmmv // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21*6b3a42afSjmmv // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22*6b3a42afSjmmv // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23*6b3a42afSjmmv // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24*6b3a42afSjmmv // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25*6b3a42afSjmmv // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26*6b3a42afSjmmv // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27*6b3a42afSjmmv // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28*6b3a42afSjmmv 
29*6b3a42afSjmmv /// \file utils/cmdline/ui_mock.hpp
30*6b3a42afSjmmv /// Provides the utils::cmdline::ui_mock class.
31*6b3a42afSjmmv ///
32*6b3a42afSjmmv /// This file is only supposed to be included from test program, never from
33*6b3a42afSjmmv /// production code.
34*6b3a42afSjmmv 
35*6b3a42afSjmmv #if !defined(UTILS_CMDLINE_UI_MOCK_HPP)
36*6b3a42afSjmmv #define UTILS_CMDLINE_UI_MOCK_HPP
37*6b3a42afSjmmv 
38*6b3a42afSjmmv #include <cstddef>
39*6b3a42afSjmmv #include <string>
40*6b3a42afSjmmv #include <vector>
41*6b3a42afSjmmv 
42*6b3a42afSjmmv #include "utils/cmdline/ui.hpp"
43*6b3a42afSjmmv 
44*6b3a42afSjmmv namespace utils {
45*6b3a42afSjmmv namespace cmdline {
46*6b3a42afSjmmv 
47*6b3a42afSjmmv 
48*6b3a42afSjmmv /// Testable interface to interact with the CLI.
49*6b3a42afSjmmv ///
50*6b3a42afSjmmv /// This class records all writes to stdout and stderr to allow further
51*6b3a42afSjmmv /// inspection for testing purposes.
52*6b3a42afSjmmv class ui_mock : public ui {
53*6b3a42afSjmmv     /// Fake width of the screen; if 0, represents none.
54*6b3a42afSjmmv     std::size_t _screen_width;
55*6b3a42afSjmmv 
56*6b3a42afSjmmv     /// Messages sent to stderr.
57*6b3a42afSjmmv     std::vector< std::string > _err_log;
58*6b3a42afSjmmv 
59*6b3a42afSjmmv     /// Messages sent to stdout.
60*6b3a42afSjmmv     std::vector< std::string > _out_log;
61*6b3a42afSjmmv 
62*6b3a42afSjmmv public:
63*6b3a42afSjmmv     ui_mock(const std::size_t = 0);
64*6b3a42afSjmmv 
65*6b3a42afSjmmv     void err(const std::string&, const bool = true);
66*6b3a42afSjmmv     void out(const std::string&, const bool = true);
67*6b3a42afSjmmv     optional< std::size_t > screen_width(void) const;
68*6b3a42afSjmmv 
69*6b3a42afSjmmv     const std::vector< std::string >& err_log(void) const;
70*6b3a42afSjmmv     const std::vector< std::string >& out_log(void) const;
71*6b3a42afSjmmv };
72*6b3a42afSjmmv 
73*6b3a42afSjmmv 
74*6b3a42afSjmmv }  // namespace cmdline
75*6b3a42afSjmmv }  // namespace utils
76*6b3a42afSjmmv 
77*6b3a42afSjmmv 
78*6b3a42afSjmmv #endif  // !defined(UTILS_CMDLINE_UI_MOCK_HPP)
79