//==============================================================================
// incharfilter.hpp
//	Generic input character filter stream.
//
// Notice
//	Copyright ©2010 by David R. Tribble, all rights reserved.
//	Permission is granted to any person or entity except those designated
//	by the United States Department of State as a terrorist, or terrorist
//	government or agency, to use and distribute this source code provided
//	that the original copyright notice remains present and unaltered.
//==============================================================================

#ifndef drt_lib_incharfilter_hpp
#define drt_lib_incharfilter_hpp	101


// Identification

#ifndef NO_H_IDENT
static char	drt_lib_incharfilter_hpp_REV[] =
    "@(#)drt/src/lib/incharfilter.hpp $Revision: 1.1 $$Date: 2010/05/08 16:44:37 $";
#endif


// Includes

#ifndef sys_stdio_h
 #include <stdio.h>
 #define sys_stdio_h
#endif

#ifndef drt_lib_charstream_hpp
 #include "charstream.hpp"
#endif
#ifndef drt_lib_incharstream_hpp
 #include "incharstream.hpp"
#endif


//------------------------------------------------------------------------------
// class InCharFilter
//	Controls the reading of data for an input text file from another
//	underlying input character stream.
//
//	Handles the following file encodings:
//	    8-bit (ASCII or ISO 8859-1)
//	    7-bit, with none(space)/mark/even/odd parity modes
//	    UTF-8
//	    UTF-16 (big-endian)
//	    UTF-16 reversed (little-endian)
//	    UTF-32 (big-endian)
//	    UTF-32 reversed (little-endian)
//	    24-bit (big-endian)			(non-standard)
//	    24-bit reversed (little-endian)	(non-standard)
//
//	Handles the following newline sequences:
//	    CR		(0D)
//	    LF		(0A)
//	    CR LF	(0D 0A)
//	    NEL		(85)
//	    Any
//	    None
//------------------------------------------------------------------------------

#define InCharFilter_VS	100			// Class version

class InCharFilter:
    public InCharStream
{
#if CharStream_VS/100 != 1
 #error class CharStream has changed
#endif
#if InCharStream_VS/100 != 1
 #error class InCharStream has changed
#endif

// ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~ ~
// Functions

public:
    virtual /**/	~InCharFilter();	// Destructor
    /**/		InCharFilter();		// Constructor
    /**/		InCharFilter(InCharStream *in);
						// Constructor

    bool		open(InCharStream *in);	// Open an input stream
    InCharStream *	getStream() const;	// Get input stream

    virtual bool	close();		// Close the stream

    virtual int		read();			// Read a Unicode char
    virtual int		read(int buf[], int len);
						// Read Unicode chars

private:
    /**/		InCharFilter(const InCharFilter &o);
    const InCharFilter & operator =(const InCharFilter &o);

protected:
    InCharStream *	m_in;			// Input stream
};


#endif // drt_lib_incharfilter_hpp

// End incharfilter.hpp