blob: 31e58390055dd329bf0af3c328a1ee6c4c754ce7 [file] [log] [blame]
Alexander Afanasyevbbb31f92014-12-01 13:15:59 -08001/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
2/**
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +02003 * Copyright (c) 2013-2016 Regents of the University of California.
Alexander Afanasyevbbb31f92014-12-01 13:15:59 -08004 *
5 * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
6 *
7 * ndn-cxx library is free software: you can redistribute it and/or modify it under the
8 * terms of the GNU Lesser General Public License as published by the Free Software
9 * Foundation, either version 3 of the License, or (at your option) any later version.
10 *
11 * ndn-cxx library is distributed in the hope that it will be useful, but WITHOUT ANY
12 * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
14 *
15 * You should have received copies of the GNU General Public License and GNU Lesser
16 * General Public License along with ndn-cxx, e.g., in COPYING.md file. If not, see
17 * <http://www.gnu.org/licenses/>.
18 *
19 * See AUTHORS.md for complete list of ndn-cxx authors and contributors.
20 */
21
22#ifndef NDN_UTIL_INDENTED_STREAM_HPP
23#define NDN_UTIL_INDENTED_STREAM_HPP
24
25#include <ostream>
26#include <sstream>
27#include <string>
28
29namespace ndn {
30namespace util {
31
32/**
33 * @brief Output to stream with specified indent or prefix
34 *
35 * For example, the following code:
36 *
37 * std::cout << "Hello" << std::endl;
38 * IndentedStream os1(std::cout, " [prefix] ");
39 * os1 << "," << "\n";
40 * {
41 * IndentedStream os2(os1, " [another prefix] ");
42 * os2 << "World!" << "\n";
43 * }
44 * // either os1 needs to go out of scope or call os1.flush()
45 *
46 * Will produce the following output:
47 *
48 * Hello
49 * [prefix] ,
50 * [prefix] [another prefix] World!
51 *
52 * Based on http://stackoverflow.com/a/2212940/2150331
53 */
54class IndentedStream : public std::ostream
55{
56public:
57 IndentedStream(std::ostream& os, const std::string& indent);
58
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +020059 virtual
60 ~IndentedStream() override;
Alexander Afanasyevbbb31f92014-12-01 13:15:59 -080061
62private:
63 // Write a stream buffer that prefixes each line
64 class StreamBuf : public std::stringbuf
65 {
66 public:
67 StreamBuf(std::ostream& os, const std::string& indent);
68
69 virtual int
Davide Pesaventoaeeb3fc2016-08-14 03:40:02 +020070 sync() override;
Alexander Afanasyevbbb31f92014-12-01 13:15:59 -080071
72 private:
73 std::ostream& m_output;
74 std::string m_indent;
75 };
76
77 StreamBuf m_buffer;
78};
79
80} // namespace util
81} // namespace ndn
82
83#endif // NDN_UTIL_INDENTED_STREAM_HPP