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