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.hpp 30*6b3a42afSjmmv /// Abstractions and utilities to write formatted messages to the console. 31*6b3a42afSjmmv 32*6b3a42afSjmmv #if !defined(UTILS_CMDLINE_UI_HPP) 33*6b3a42afSjmmv #define UTILS_CMDLINE_UI_HPP 34*6b3a42afSjmmv 35*6b3a42afSjmmv #include <cstddef> 36*6b3a42afSjmmv #include <string> 37*6b3a42afSjmmv 38*6b3a42afSjmmv #include "utils/optional.hpp" 39*6b3a42afSjmmv 40*6b3a42afSjmmv namespace utils { 41*6b3a42afSjmmv 42*6b3a42afSjmmv namespace text { 43*6b3a42afSjmmv class table; 44*6b3a42afSjmmv class table_formatter; 45*6b3a42afSjmmv } // namespace text 46*6b3a42afSjmmv 47*6b3a42afSjmmv namespace cmdline { 48*6b3a42afSjmmv 49*6b3a42afSjmmv 50*6b3a42afSjmmv /// Interface to interact with the CLI. 51*6b3a42afSjmmv /// 52*6b3a42afSjmmv /// The main purpose of this class is to substitute direct usages of stdout and 53*6b3a42afSjmmv /// stderr. An instance of this class is passed to every command of a CLI, 54*6b3a42afSjmmv /// which allows unit testing and validation of the interaction with the user. 55*6b3a42afSjmmv /// 56*6b3a42afSjmmv /// This class writes directly to stdout and stderr. For testing purposes, see 57*6b3a42afSjmmv /// the utils::cmdline::ui_mock class. 58*6b3a42afSjmmv class ui { 59*6b3a42afSjmmv public: 60*6b3a42afSjmmv virtual ~ui(void); 61*6b3a42afSjmmv 62*6b3a42afSjmmv virtual void err(const std::string&, const bool = true); 63*6b3a42afSjmmv virtual void out(const std::string&, const bool = true); 64*6b3a42afSjmmv virtual optional< std::size_t > screen_width(void) const; 65*6b3a42afSjmmv 66*6b3a42afSjmmv void out_wrap(const std::string&); 67*6b3a42afSjmmv void out_tag_wrap(const std::string&, const std::string&, 68*6b3a42afSjmmv const bool = true); 69*6b3a42afSjmmv void out_table(const utils::text::table&, utils::text::table_formatter, 70*6b3a42afSjmmv const std::string&); 71*6b3a42afSjmmv }; 72*6b3a42afSjmmv 73*6b3a42afSjmmv 74*6b3a42afSjmmv void print_error(ui*, const std::string&); 75*6b3a42afSjmmv void print_info(ui*, const std::string&); 76*6b3a42afSjmmv void print_warning(ui*, const std::string&); 77*6b3a42afSjmmv 78*6b3a42afSjmmv 79*6b3a42afSjmmv } // namespace cmdline 80*6b3a42afSjmmv } // namespace utils 81*6b3a42afSjmmv 82*6b3a42afSjmmv 83*6b3a42afSjmmv #endif // !defined(UTILS_CMDLINE_UI_HPP) 84