cmtkConsole.h

Go to the documentation of this file.

/*
//
//  Copyright 1997-2009 Torsten Rohlfing
//
//  Copyright 2004-2010 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: 2398 $
//
//  $LastChangedDate: 2010-10-05 14:54:37 -0700 (Tue, 05 Oct 2010) $
//
//  $LastChangedBy: torstenrohlfing $
//
*/

#ifndef __cmtkConsole_h_included_
#define __cmtkConsole_h_included_

#include <cmtkconfig.h>

#include <System/cmtkCannotBeCopied.h>

#include <iostream>
#include <string>

#ifdef CMTK_BUILD_MPI
#  include <mpi.h>
#endif

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

namespace
cmtk
{


class Console :
  private CannotBeCopied
{
public:
  Console( std::ostream& stream ) 
    : m_Stream( stream )
  { 
    this->IndentLevel = 0; 
    this->DebugLevel = 0; 
#ifdef CMTK_BUILD_MPI
    this->m_RankMPI = -1;
#endif
  }

  size_t GetLineWidth() const;

  Console& FormatText( const std::string& text, 
                       const size_t margin = 0, 
                       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 
    );

  void printf ( const char* format, ... );

  void flush() 
  { 
    LockingPtr<std::ostream> pStream( this->m_Stream, this->m_MutexLock );
    pStream->flush(); 
  }

  template<class T> 
  Console& operator << ( const T data ) 
  { 
#ifdef CMTK_BUILD_MPI
    // for now, skip the output entirely if this is not the root process.
    if ( this->m_RankMPI < 0 ) this->m_RankMPI = MPI::COMM_WORLD.Get_rank();
    if ( this->m_RankMPI ) return *this;
#endif
    LockingPtr<std::ostream> pStream( this->m_Stream, this->m_MutexLock );
    this->m_Stream << data; 
    return *this; 
  }

  void indent() { IndentLevel += 2; }

  void unindent() { IndentLevel -= 2; }

private:
  std::ostream& m_Stream;
  
  size_t IndentLevel;

  void Indent( size_t level = 0 );
  
  int DebugLevel;

  MutexLock m_MutexLock;

#ifdef CMTK_BUILD_MPI

  int m_RankMPI;
#endif
};

extern Console StdErr;

extern Console StdOut;


} // namespace cmtk

#endif // #ifndef __cmtkConsole_h_included_