Output.h

Go to the documentation of this file.

#ifndef Cpl_Io_File_Output_h_
#define Cpl_Io_File_Output_h_
/*-----------------------------------------------------------------------------
* This file is part of the Colony.Core Project.  The Colony.Core Project is an
* open source project with a BSD type of licensing agreement.  See the license
* agreement (license.txt) in the top/ directory or on the Internet at
* http://integerfox.com/colony.core/license.txt
*
* Copyright (c) 2014-2022  John T. Taylor
*
* Redistributions of the source code must retain the above copyright notice.
*----------------------------------------------------------------------------*/
/** @file */
 
#include "Cpl/Io/File/OutputApi.h"
#include "Cpl/Io/Stdio/Output_.h"
 
 
///
namespace Cpl {
///
namespace Io {
///
namespace File {
 
 
 
/** This concrete class provides a platform independent 'standard'
    implementation of a Cpl::Io::File::Output object.
 
    NOTE: All the write operations return 'false' if an error occurred, this
          INCLUDES the end-of-file condition (which is error when dealing
          with streams). To differentiate between a true error and EOF, the
          client must call isEof().
 */
class Output : public OutputApi
{
protected:
    /// Provides the underlying write functionality
    Cpl::Io::Stdio::Output_  m_stream;
 
 
public:
    /// Constructor -->Opens the file
    Output( const char* fileName, bool forceCreate=true, bool forceEmptyFile=false );
 
    /// Constructor. 'streamfd' is a the file descriptor of a existing/opened file.
    Output( Cpl::Io::Descriptor streamfd );
 
    /// Destructor -->Will insure the file gets closed
    ~Output();
 
 
public:
    /** This method returns true if the file was successfully open and/or
        is still opened (i.e. close() has not been called). Note: it is okay
        to call other methods in the class if the file is not open - i.e.
        nothing 'bad' will happen and the method will return 'failed'
        status (when appropriate).
     */
    bool isOpened();
 
 
public:
    /// See Cpl::Io::Output
    bool write( char c );
 
    /// See Cpl::Io::Output
    bool write( const char* string );
 
    /// See Cpl::Io::Output
    bool write( const Cpl::Text::String& string );
 
    /// See Cpl::Io::Output
    bool write( Cpl::Text::String& formatBuffer, const char* format, ... );
 
    /// See Cpl::Io::Output
    bool vwrite( Cpl::Text::String& formatBuffer, const char* format, va_list ap );
 
    /// See Cpl::Io::Output
    bool write( const void* buffer, int maxBytes );
 
    /// See Cpl::Io::Output
    bool write( const void* buffer, int maxBytes, int& bytesWritten );
 
    /// See Cpl::Io::Output
    void flush();
 
    /// See Cpl::Io::IsEos (is equivalent to isEof())
    bool isEos();
 
    /// See Cpl::Io::Close
    void close();
 
 
public:
    /// See Cpl::Io::File::ObjectApi
    bool isEof();
 
    /// See Cpl::Io::File::ObjectApi
    bool length( unsigned long& len);
 
    /// See Cpl::Io::File::Object
    bool currentPos( unsigned long & curPosition );
 
    /// See Cpl::Io::File::ObjectApi
    bool setRelativePos( long deltaOffset );
 
    /// See Cpl::Io::File::Object
    bool setAbsolutePos( unsigned long newoffset );
 
    /// See Cpl::Io::File::ObjectApi
    bool setToEof();
};
 
};      // end namespaces
};
};
#endif  // end header latch