This class defines an output stream for replacing the standard 'cout'. More...

#include <textfile.h>

Classes
struct	mute
	Local mute of the stream. More...

Public Member Functions
	outputstream (std::ostream &_out=std::cout, bool _show=true, bool _flush=false)
	The default constructor. More...

	~outputstream ()
	The destructor. More...

void	logfile (const char *filename)
	Turns on logging to a file. More...

void	logfile (const outputstream &other)
	Turns on logging to the same file as some other stream. More...

std::ofstream *	getlogstream (void)
	Returns a pointer to the stream which is working as a log file. More...

void	keepforever (void)
	Makes this stream keep the allocated file open for ever, and not close it even in the destructor. More...

int	precision () const
	Returns the precision of the main output stream. More...

Public Attributes
bool	show
	If this variable is set to true then everything that is written to this stream is also written to 'cout'. More...

bool	log
	If this variable is set to true then everything that is written to this stream is also written to the log file. More...

bool	flush
	If this variable is set to true then both the output stream 'cout' and the log file are flushed after every write operation. More...

std::ostream &	out
	A reference to the main output stream bound with this stream. More...

Protected Attributes
std::ofstream *	logstream
	A pointer to the log file stream. More...

bool	copied
	This variable is set to true if this log file pointer was copied from another output stream, and therefore it should not be deleted by this stream. More...

Detailed Description

This class defines an output stream for replacing the standard 'cout'.

It has the additional features of flushing the output after every operation, suppressing the output, or logging the output to a file.

Definition at line 63 of file textfile.h.

Constructor & Destructor Documentation

◆ outputstream()

chomp::homology::outputstream::outputstream	(	std::ostream &	_out = `std::cout`,
		bool	_show = `true`,
		bool	_flush = `false`
	)

inline

The default constructor.

Definition at line 140 of file textfile.h.

                    : out (_out)
{
        show = _show;
        flush = _flush;
        log = false;
        logstream = NULL;
        copied = false;
        return;
} /* outputstream::outputstream */

References copied, flush, log, logstream, and show.

◆ ~outputstream()

chomp::homology::outputstream::~outputstream ( )

inline

The destructor.

Definition at line 201 of file textfile.h.

{
        if (!copied && logstream)
                delete logstream;
        return;
} /* outputstream::~outputstream */

References copied, and logstream.

Member Function Documentation

◆ getlogstream()

std::ofstream * chomp::homology::outputstream::getlogstream ( void )

inline

Returns a pointer to the stream which is working as a log file.

Returns 0 if no such stream is bound with this output stream.

Definition at line 208 of file textfile.h.

{
        return logstream;
} /* outputstream::getlogstream */

References logstream.

◆ keepforever()

void chomp::homology::outputstream::keepforever ( void )

inline

Makes this stream keep the allocated file open for ever, and not close it even in the destructor.

It is assumed then that the file will be closed automatically by the operating system.

Definition at line 213 of file textfile.h.

{
        copied = true;
        return;
} /* outputstream::getlogstream */

References copied.

◆ logfile() [1/2]

void chomp::homology::outputstream::logfile ( const char * filename )

inline

Turns on logging to a file.

If the file exists, its contents is ereased.

Definition at line 151 of file textfile.h.

{
        // delete the previous log stream
        if (logstream && !copied)
                delete logstream;
 
        // make a note that this output stream is the master copy
        copied = false;
 
        // create a file stream to log the output to;
        // note: if "keepforever" is applied to the output stream
        // then this data structure is not released and produces
        // a small memory leak; however, the file is automatically
        // closed by the system; this may be necessary to avoid
        // a crash of the program if any other output streams
        // still want to write to a copy of this stream
        // upon program's shutdown
        logstream = new std::ofstream (filename);
 
        // warn if the log file could not be created
        if (!logstream || !*logstream)
        {
                out << "WARNING: Can't create '" << filename <<
                        "'. Logging to a file has been turned off." <<
                        std::endl;
                if (logstream)
                        delete logstream;
                logstream = NULL;
        }
 
        // otherwise set a flag indicating that logging to a file is on
        else
                log = true;
 
        return;
} /* outputstream::logfile */

References copied, log, logstream, and out.

◆ logfile() [2/2]

void chomp::homology::outputstream::logfile ( const outputstream & other )

inline

Turns on logging to the same file as some other stream.

Definition at line 188 of file textfile.h.

{
        if (!copied && logstream)
                delete logstream;
        logstream = other. logstream;
        if (logstream)
        {
                copied = true;
                log = true;
        }
        return;
} /* outputstream::logfile */

References copied, log, and logstream.

◆ precision()

int chomp::homology::outputstream::precision ( ) const

inline

Returns the precision of the main output stream.

Definition at line 219 of file textfile.h.

{
        return out. precision ();
} /* outputstream::precision */

References out, and precision().

Referenced by precision().

Member Data Documentation

◆ copied

bool chomp::homology::outputstream::copied

protected

This variable is set to true if this log file pointer was copied from another output stream, and therefore it should not be deleted by this stream.

Definition at line 134 of file textfile.h.

Referenced by keepforever(), logfile(), outputstream(), and ~outputstream().

◆ flush

bool chomp::homology::outputstream::flush

If this variable is set to true then both the output stream 'cout' and the log file are flushed after every write operation.

Note that this may slow down the output significantly if the log file is located on a network drive.

Definition at line 94 of file textfile.h.

Referenced by outputstream().

◆ log

bool chomp::homology::outputstream::log

If this variable is set to true then everything that is written to this stream is also written to the log file.

Definition at line 88 of file textfile.h.

Referenced by logfile(), and outputstream().

◆ logstream

std::ofstream* chomp::homology::outputstream::logstream

protected

A pointer to the log file stream.

Definition at line 129 of file textfile.h.

Referenced by getlogstream(), logfile(), outputstream(), and ~outputstream().

◆ out

std::ostream& chomp::homology::outputstream::out

A reference to the main output stream bound with this stream.

Definition at line 101 of file textfile.h.

Referenced by logfile(), and precision().

◆ show

bool chomp::homology::outputstream::show

If this variable is set to true then everything that is written to this stream is also written to 'cout'.

If this variable is set to false then the screen output is suppressed, while logging can still be turned on.

Definition at line 84 of file textfile.h.

Referenced by outputstream().

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

chomp/system/textfile.h

Classes

Public Member Functions

Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ outputstream()

◆ ~outputstream()

Member Function Documentation

◆ getlogstream()

◆ keepforever()

◆ logfile() [1/2]

◆ logfile() [2/2]

◆ precision()

Member Data Documentation

◆ copied

◆ flush

◆ log

◆ logstream

◆ out

◆ show