File: cmtkConsole.h

package info (click to toggle)
cmtk 3.3.1p2%2Bdfsg-4
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 10,524 kB
  • sloc: cpp: 87,098; ansic: 23,347; sh: 3,896; xml: 1,551; perl: 707; makefile: 334
file content (145 lines) | stat: -rw-r--r-- 3,896 bytes parent folder | download | duplicates (5)
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2012 SRI International
//
//  This file is part of the Computational Morphometry Toolkit.
//
//  http://www.nitrc.org/projects/cmtk/
//
//  The Computational Morphometry Toolkit is free software: you can
//  redistribute it and/or modify it under the terms of the GNU General Public
//  License as published by the Free Software Foundation, either version 3 of
//  the License, or (at your option) any later version.
//
//  The Computational Morphometry Toolkit is distributed in the hope that it
//  will be useful, but WITHOUT ANY WARRANTY; without even the implied
//  warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License along
//  with the Computational Morphometry Toolkit.  If not, see
//  <http://www.gnu.org/licenses/>.
//
//  $Revision: 5436 $
//
//  $LastChangedDate: 2018-12-10 19:01:20 -0800 (Mon, 10 Dec 2018) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkConsole_h_included_
#define __cmtkConsole_h_included_

#include <cmtkconfig.h>

#include <System/cmtkCannotBeCopied.h>

#include <iostream>
#include <string>
#include <cassert>

#include <System/cmtkMutexLock.h>
#include <System/cmtkLockingPtr.h>

namespace
cmtk
{

/** \addtogroup System */
//@{

/// Standard error output console for library.
class Console :
  /// Make class uncopyable via inheritance.
  private CannotBeCopied
{
public:
  /// Constructor.
  Console( std::ostream* stream ) 
    : m_StreamP( stream )
  { 
    this->IndentLevel = 0; 
  }

  /** Get terminal line width, if possible.
   * The line width is determined using an ioctl() call, if available. Line width can be
   * set (or overridden) by the user by setting the "CMTK_CONSOLE_LINE_WIDTH" environment
   * variable to the desired number of characters per line.
   */
  size_t GetLineWidth() const;

  /// Format text with line breaks etc.
  Console& FormatText( const std::string& text /*!< The text to format with line breaks.*/,
		       const size_t margin = 0 /*!< Left margin: this many space characters are printed at the beginning of each line.*/,
		       const size_t width = 0 /*<! Line width including margin. Default: determine based on terminal width, or default to 80 if that fails.*/,
		       const int firstLine = 0 /*!< Relative indent of first line, i.e., firstLine = -margin means no indentation of first line.*/ );

  /// Formatted output.
  void printf ( const char* format, ... );

  /// Flush output stream.
  void flush() 
  { 
    if ( this->m_StreamP )
      {
      LockingPtr<std::ostream> pStream( *this->m_StreamP, this->m_MutexLock );
      pStream->flush();
      }
  }

  /// Output stream operator.
  template<class T> 
  Console& operator << ( const T data ) 
  { 
    if ( this->m_StreamP )
      {
      LockingPtr<std::ostream> pStream( *this->m_StreamP, this->m_MutexLock );
      *pStream << data; 
      }
    return *this; 
  }

  /// Increment indentation level.
  void indent() { IndentLevel += 2; }

  /// Decrement indentation level.
  void unindent() { IndentLevel -= 2; }

  /// Implicit conversion to C++ ostream.
  operator std::ostream&()
  {
    assert( this->m_StreamP ); // will fail for StdNull!
    return *(this->m_StreamP);
  }

private:
  /// The system stream that we're attaching to.
  std::ostream* m_StreamP;
  
  /// Indentiation level.
  size_t IndentLevel;

  /// Perform indentation.
  void Indent( size_t level = 0 );
  
  /// Mutex lock for thread safety.
  MutexLock m_MutexLock;
};

/// Standard error output for the library.
extern Console StdErr;

/// Standard output for the library.
extern Console StdOut;

/// Standard output for the library.
extern Console StdNull;

//@}

} // namespace cmtk

#endif // #ifndef __cmtkConsole_h_included_