/usr/include/dune/common/indent.hh is in libdune-common-dev 2.4.1-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 | // -*- tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
// vi: set et ts=4 sw=2 sts=2:
#ifndef DUNE_COMMON_INDENT_HH
#define DUNE_COMMON_INDENT_HH
#include <ostream>
#include <string>
namespace Dune {
/** @addtogroup Common
*
* @{
*/
/**
* @file
* @brief Utility class for handling nested indentation in output.
* @author Jö Fahlke
*/
//! Utility class for handling nested indentation in output.
/**
* An indentation object hast a string basic_indent and an indentation
* level. When it is put into a std::ostream using << it will print its
* basic_indent as many times as its indentation level. By default the
* basic_indent will be two spaces and the indentation level will be 0.
*
* An Indent object may also have a reference to a parent Indent object. If
* it has, that object it put into the stream with the << operator before
* the indentation of this object is put into the stream. This effectively
* chains Indent objects together.
*
* You can use the ++ operator to raise and the -- operator to lower the
* indentation by one level.
*
* You can use the + operator with a numeric second argument morelevel to
* create a copy of the Indent object with the indentation level increased
* morelevel times. This is mainly useful to pass indent+1 to a function,
* where indent is an indentation object.
*
* You can use the + operator with a string second argument newindent to
* create a new Indent object with this object as parent, a basic_indent of
* newindent, and an indentation level of one. This is mainly useful to
* pass indent+"> " to a function, where "> " is a possibly different
* indentation string then the one used by indent indentation object.
*
* \note The idea is for functions receive indentation objects as call by
* value parameters. This way, the indentation object of the caller
* will not be modified by the function and the function can simply
* return at anytime without having to clean up.
*/
class Indent
{
const Indent* parent;
std::string basic_indent;
unsigned level;
public:
//! setup without parent
/**
* \note Initial indentation level is 0 by default for this constructor.
*/
inline Indent(const std::string& basic_indent_ = " ", unsigned level_ = 0)
: parent(0), basic_indent(basic_indent_), level(level_)
{ }
//! setup without parent and basic_indentation of two spaces
inline Indent(unsigned level_)
: parent(0), basic_indent(" "), level(level_)
{ }
//! setup with parent
/**
* \note Initial indentation level is 1 by default for this constructor.
*/
inline Indent(const Indent* parent_,
const std::string& basic_indent_ = " ", unsigned level_ = 1)
: parent(parent_), basic_indent(basic_indent_), level(level_)
{ }
//! setup with parent
inline Indent(const Indent* parent_, unsigned level_)
: parent(parent_), basic_indent(" "), level(level_)
{ }
//! create new indentation object with this one as parent
inline Indent operator+(const std::string& newindent) const {
return Indent(this, newindent);
}
//! create a copy of this indetation object with raised level
inline Indent operator+(unsigned morelevel) const {
return Indent(parent, basic_indent, level+morelevel);
}
//! raise indentation level
inline Indent& operator++() { ++level; return *this; }
//! lower indentation level
inline Indent& operator--() { --level; return *this; }
//! write indentation to a stream
friend inline std::ostream& operator<<(std::ostream& s,
const Indent& indent);
};
//! write indentation to a stream
inline std::ostream& operator<<(std::ostream& s, const Indent& indent) {
if(indent.parent)
s << *indent.parent;
for(unsigned i = 0; i < indent.level; ++i)
s << indent.basic_indent;
return s;
}
/** }@ group Common */
} // namespace Dune
#endif // DUNE_COMMON_INDENT_HH
|