1// Copyright 2011 Google Inc. 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 cli/cmd_report.hpp 30/// Provides the cmd_report class. 31 32#if !defined(CLI_CMD_REPORT_HPP) 33#define CLI_CMD_REPORT_HPP 34 35#include <fstream> 36#include <memory> 37 38#include "cli/common.hpp" 39#include "utils/cmdline/options.hpp" 40#include "utils/cmdline/ui.hpp" 41#include "utils/fs/path.hpp" 42#include "utils/noncopyable.hpp" 43 44namespace cli { 45 46 47/// Wrapper class to send messages through the UI or to a file. 48/// 49/// The cmdline::ui object provides methods to write messages to stdout and 50/// stderr. We are interested in using these methods when dumping a report to 51/// any of these channels, because this provides us proper logging among other 52/// goodies during testing. However, these are unsuitable to write the output 53/// to an arbitrary file, which is a necessity for reports. 54/// 55/// Therefore, this class provides a mechanism to write stdout and stderr 56/// messages through the cmdline::ui object if the user so wishes, but otherwise 57/// prints messages to the user selected file. 58class file_writer : utils::noncopyable { 59 /// The UI object to write stdout and stderr messages through. 60 utils::cmdline::ui* const _ui; 61 62 /// The path to the output file. 63 const utils::fs::path _output_path; 64 65 /// The output file, if not stdout nor stderr. 66 std::unique_ptr< std::ofstream > _output_file; 67 68 /// Constant that represents the path to stdout. 69 static const utils::fs::path _stdout_path; 70 71 /// Constant that represents the path to stderr. 72 static const utils::fs::path _stderr_path; 73 74public: 75 file_writer(utils::cmdline::ui* const, const utils::fs::path&); 76 ~file_writer(void); 77 78 void operator()(const std::string&); 79}; 80 81 82/// Implementation of the "report" subcommand. 83class cmd_report : public cli_command 84{ 85public: 86 cmd_report(void); 87 88 int run(utils::cmdline::ui*, const utils::cmdline::parsed_cmdline&, 89 const utils::config::tree&); 90}; 91 92 93} // namespace cli 94 95 96#endif // !defined(CLI_CMD_REPORT_HPP) 97