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