StdIn.h

Go to the documentation of this file.

#ifndef Cpl_Io_Stdio_StdIn_h_
#define Cpl_Io_Stdio_StdIn_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/Stdio/Input_.h"
 
///
namespace Cpl {
///
namespace Io {
///
namespace Stdio {
 
 
/** This concrete class represents the C-library 'stdin' stream.
 
    NOTE: Many instances of this class may be created - even
          though there is only ONE stdin.  This is OK because
          all instance reference the systems/platform 'stdin'
 
    NOTE: stdin under Windoze is problematic with how the available() method is 
          implemented.  See the _win32/Input_.cpp file for more details.  There
          is partial work-around for the issue.  It can be enabled be defining
          the following in colony_confi.h: USE_CPL_IO_STDIO_WIN32_STDIN_CONSOLE_HACK
 */
class StdIn : public Input_
{
public:
    /// Constructor
    StdIn();
 
 
public:
    /** Overriding inherited behavior so as to NOT close the actual native
        stream. In general closing stdin/stdout/stderr is bad thing.
     */
    void close();
};
 
};      // end namespaces
};
};
#endif  // end header latch