DGtal::TraceWriterTerm Class Reference

Implements trace prefix for color terminals. More...

#include <DGtal/base/TraceWriterTerm.h>

Inheritance diagram for DGtal::TraceWriterTerm:

Public Member Functions
	TraceWriterTerm (std::ostream &aoutputStream=std::cerr)
	~TraceWriterTerm ()
void	selfDisplay (std::ostream &out) const
bool	isValid () const
std::string	prefixWarning ()
std::string	prefixInfo ()
std::string	prefixError ()
std::string	prefixEmphase ()
std::string	postfixReset ()
Public Member Functions inherited from DGtal::TraceWriter
void	selfDisplay (std::ostream &out) const
bool	isValid () const
virtual std::string	prefixWarning ()=0
virtual std::string	prefixInfo ()=0
virtual std::string	prefixError ()=0
virtual std::string	prefixEmphase ()=0
virtual std::string	postfixReset ()=0
std::ostream &	outputStream ()

Private Member Functions
	TraceWriterTerm (const TraceWriterTerm &other)
TraceWriterTerm &	operator= (const TraceWriterTerm &other)

Additional Inherited Members
Protected Member Functions inherited from DGtal::TraceWriter
	TraceWriter (std::ostream &aoutputStream)
Protected Attributes inherited from DGtal::TraceWriter
std::ostream &	myOutputStream
	Reference to the output stream. More...

Detailed Description

Implements trace prefix for color terminals.

Description of class 'TraceWriterTerm'

Aim:

Todo:

Detect if the terminal has color capabilities

See also

testTrace.cpp

Definition at line 63 of file TraceWriterTerm.h.

Constructor & Destructor Documentation

TraceWriterTerm() [1/2]

DGtal::TraceWriterTerm::TraceWriterTerm ( std::ostream &  aoutputStream = std::cerr )

inline

Constructor.

Parameters

aoutputStream

the current output Stream

Definition at line 72 of file TraceWriterTerm.h.

: TraceWriter(aoutputStream) {};

~TraceWriterTerm()

DGtal::TraceWriterTerm::~TraceWriterTerm ( )

inline

Destructor.

Definition at line 78 of file TraceWriterTerm.h.

{};

TraceWriterTerm() [2/2]

DGtal::TraceWriterTerm::TraceWriterTerm ( const TraceWriterTerm &  other )

private

Copy constructor.

Parameters

other

the object to clone. Forbidden by default.

Member Function Documentation

isValid()

bool DGtal::TraceWriterTerm::isValid

(

)

const

Checks the validity/consistency of the object.

Returns

'true' if the object is valid, 'false' otherwise.

operator=()

TraceWriterTerm & DGtal::TraceWriterTerm::operator= ( const TraceWriterTerm &  other )

private

Assignment.

Parameters

other

the object to copy.

Returns

a reference on 'this'. Forbidden by default.

postfixReset()

std::string DGtal::TraceWriterTerm::postfixReset ( )

inlinevirtual

Create a Reset postfix

Returns

the postfix

Implements DGtal::TraceWriter.

Definition at line 153 of file TraceWriterTerm.h.

    {
#if ( !defined(DGTAL_NO_ESCAPED_CHAR_IN_TRACE) && (defined(UNIX)||defined(unix)||defined(linux)) )
      return "\033[0m";
#else
      return "";
#endif
    }

prefixEmphase()

std::string DGtal::TraceWriterTerm::prefixEmphase ( )

inlinevirtual

Create an Emphase Prefix

Returns

the prefix

Implements DGtal::TraceWriter.

Definition at line 140 of file TraceWriterTerm.h.

    {
#if ( !defined(DGTAL_NO_ESCAPED_CHAR_IN_TRACE) && (defined(UNIX)||defined(unix)||defined(linux)) )
      return "\033[0m\033[1m";
#else
      return "";
#endif
    }

prefixError()

std::string DGtal::TraceWriterTerm::prefixError ( )

inlinevirtual

Create an Error Prefix

Returns

the prefix

Implements DGtal::TraceWriter.

Definition at line 127 of file TraceWriterTerm.h.

    {
#if ( !defined(DGTAL_NO_ESCAPED_CHAR_IN_TRACE) && (defined(UNIX)||defined(unix)||defined(linux)) )
      return "\033[0m\033[31m[ERR]";
#else
      return "";
#endif
    }

prefixInfo()

std::string DGtal::TraceWriterTerm::prefixInfo ( )

inlinevirtual

Create an Info Prefix

Returns

the prefix

Implements DGtal::TraceWriter.

Definition at line 114 of file TraceWriterTerm.h.

    {
#if ( !defined(DGTAL_NO_ESCAPED_CHAR_IN_TRACE) && (defined(UNIX)||defined(unix)||defined(linux)) )
      return "\033[0m";
#else
      return "";
#endif
    }

prefixWarning()

std::string DGtal::TraceWriterTerm::prefixWarning ( )

inlinevirtual

Create a Wrarning Prefix

Returns

the prefix

Implements DGtal::TraceWriter.

Definition at line 101 of file TraceWriterTerm.h.

    {
#if ( !defined(DGTAL_NO_ESCAPED_CHAR_IN_TRACE) && (defined(UNIX)||defined(unix)||defined(linux)) )
      return "\033[0m\033[35m";
#else
      return "";
#endif
    }

selfDisplay()

void DGtal::TraceWriterTerm::selfDisplay

(

std::ostream &

out

)

const

Writes/Displays the object on an output stream.

Parameters

out	the output stream where the object is written.

---

The documentation for this class was generated from the following file:

• TraceWriterTerm.h