1*b0d29bc4SBrooks Davis // Copyright 2010 The Kyua Authors. 2*b0d29bc4SBrooks Davis // All rights reserved. 3*b0d29bc4SBrooks Davis // 4*b0d29bc4SBrooks Davis // Redistribution and use in source and binary forms, with or without 5*b0d29bc4SBrooks Davis // modification, are permitted provided that the following conditions are 6*b0d29bc4SBrooks Davis // met: 7*b0d29bc4SBrooks Davis // 8*b0d29bc4SBrooks Davis // * Redistributions of source code must retain the above copyright 9*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer. 10*b0d29bc4SBrooks Davis // * Redistributions in binary form must reproduce the above copyright 11*b0d29bc4SBrooks Davis // notice, this list of conditions and the following disclaimer in the 12*b0d29bc4SBrooks Davis // documentation and/or other materials provided with the distribution. 13*b0d29bc4SBrooks Davis // * Neither the name of Google Inc. nor the names of its contributors 14*b0d29bc4SBrooks Davis // may be used to endorse or promote products derived from this software 15*b0d29bc4SBrooks Davis // without specific prior written permission. 16*b0d29bc4SBrooks Davis // 17*b0d29bc4SBrooks Davis // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18*b0d29bc4SBrooks Davis // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19*b0d29bc4SBrooks Davis // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20*b0d29bc4SBrooks Davis // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21*b0d29bc4SBrooks Davis // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22*b0d29bc4SBrooks Davis // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23*b0d29bc4SBrooks Davis // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24*b0d29bc4SBrooks Davis // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25*b0d29bc4SBrooks Davis // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26*b0d29bc4SBrooks Davis // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27*b0d29bc4SBrooks Davis // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28*b0d29bc4SBrooks Davis 29*b0d29bc4SBrooks Davis /// \file utils/cmdline/ui.hpp 30*b0d29bc4SBrooks Davis /// Abstractions and utilities to write formatted messages to the console. 31*b0d29bc4SBrooks Davis 32*b0d29bc4SBrooks Davis #if !defined(UTILS_CMDLINE_UI_HPP) 33*b0d29bc4SBrooks Davis #define UTILS_CMDLINE_UI_HPP 34*b0d29bc4SBrooks Davis 35*b0d29bc4SBrooks Davis #include "utils/cmdline/ui_fwd.hpp" 36*b0d29bc4SBrooks Davis 37*b0d29bc4SBrooks Davis #include <cstddef> 38*b0d29bc4SBrooks Davis #include <string> 39*b0d29bc4SBrooks Davis 40*b0d29bc4SBrooks Davis #include "utils/optional_fwd.hpp" 41*b0d29bc4SBrooks Davis #include "utils/text/table_fwd.hpp" 42*b0d29bc4SBrooks Davis 43*b0d29bc4SBrooks Davis namespace utils { 44*b0d29bc4SBrooks Davis namespace cmdline { 45*b0d29bc4SBrooks Davis 46*b0d29bc4SBrooks Davis 47*b0d29bc4SBrooks Davis /// Interface to interact with the CLI. 48*b0d29bc4SBrooks Davis /// 49*b0d29bc4SBrooks Davis /// The main purpose of this class is to substitute direct usages of stdout and 50*b0d29bc4SBrooks Davis /// stderr. An instance of this class is passed to every command of a CLI, 51*b0d29bc4SBrooks Davis /// which allows unit testing and validation of the interaction with the user. 52*b0d29bc4SBrooks Davis /// 53*b0d29bc4SBrooks Davis /// This class writes directly to stdout and stderr. For testing purposes, see 54*b0d29bc4SBrooks Davis /// the utils::cmdline::ui_mock class. 55*b0d29bc4SBrooks Davis class ui { 56*b0d29bc4SBrooks Davis public: 57*b0d29bc4SBrooks Davis virtual ~ui(void); 58*b0d29bc4SBrooks Davis 59*b0d29bc4SBrooks Davis virtual void err(const std::string&, const bool = true); 60*b0d29bc4SBrooks Davis virtual void out(const std::string&, const bool = true); 61*b0d29bc4SBrooks Davis virtual optional< std::size_t > screen_width(void) const; 62*b0d29bc4SBrooks Davis 63*b0d29bc4SBrooks Davis void out_wrap(const std::string&); 64*b0d29bc4SBrooks Davis void out_tag_wrap(const std::string&, const std::string&, 65*b0d29bc4SBrooks Davis const bool = true); 66*b0d29bc4SBrooks Davis void out_table(const utils::text::table&, utils::text::table_formatter, 67*b0d29bc4SBrooks Davis const std::string&); 68*b0d29bc4SBrooks Davis }; 69*b0d29bc4SBrooks Davis 70*b0d29bc4SBrooks Davis 71*b0d29bc4SBrooks Davis void print_error(ui*, const std::string&); 72*b0d29bc4SBrooks Davis void print_info(ui*, const std::string&); 73*b0d29bc4SBrooks Davis void print_warning(ui*, const std::string&); 74*b0d29bc4SBrooks Davis 75*b0d29bc4SBrooks Davis 76*b0d29bc4SBrooks Davis } // namespace cmdline 77*b0d29bc4SBrooks Davis } // namespace utils 78*b0d29bc4SBrooks Davis 79*b0d29bc4SBrooks Davis #endif // !defined(UTILS_CMDLINE_UI_HPP) 80