[wxWidgets.git] / tests / streams / bstream.h

///////////////////////////////////////////////////////////////////////////////
// Name:        tests/streams/bstream.h
// Purpose:     Template class for testing base stream functions.
// Author:      Hans Van Leemputten
// RCS-ID:      $Id$
// Copyright:   (c) 2004 Hans Van Leemputten
// Licence:     wxWidgets licence
///////////////////////////////////////////////////////////////////////////////

#ifndef _WX_TESTBSTREAM_H__
#define _WX_TESTBSTREAM_H__

#include "wx/cppunit.h"

///////////////////////////////////////////////////////////////////////////////
// Some macros preventing us from typing too much ;-)
//

#define STREAM_TEST_NAME "Streams"
#define COMPOSE_TEST_NAME(Name) \
    STREAM_TEST_NAME "." #Name
#define STREAM_REGISTER_SUB_SUITE(Name) \
    extern CppUnit::Test* Get##Name##Suite(); \
    suite->addTest(Get##Name##Suite())
#define STREAM_IMPLEMENT_SUB_REGISTRATION_ROUTINE(Name) \
    CppUnit::Test* Get##Name##Suite() { return Name::suite(); }
#define STREAM_TEST_SUBSUITE_NAMED_REGISTRATION(Name) \
    CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( Name, COMPOSE_TEST_NAME(Name) ); \
    STREAM_IMPLEMENT_SUB_REGISTRATION_ROUTINE( Name )

///////////////////////////////////////////////////////////////////////////////
// Template class that implements a test for all base stream functions.
//

template <class TStreamIn, class TStreamOut> class BaseStreamTestCase : public CppUnit::TestCase
{
protected:
    typedef BaseStreamTestCase<TStreamIn, TStreamOut> StreamTestCase;

    class CleanupHelper
    {
    public:
        CleanupHelper(StreamTestCase *value)
            :m_pCleanup(value)
        {}
        ~CleanupHelper()
        {
            m_pCleanup->DeleteInStream();
            m_pCleanup->DeleteOutStream();
        }
    private:
        StreamTestCase   *m_pCleanup;
    };
    friend class CleanupHelper;

public:
    BaseStreamTestCase()
        :m_bSimpleTellITest(false),
         m_bSimpleTellOTest(false),
         m_bSeekInvalidBeyondEnd(true),
         m_bEofAtLastRead(true),
         m_pCurrentIn(NULL),
         m_pCurrentOut(NULL)
    { /* Nothing extra */ }
    virtual ~BaseStreamTestCase()
    {
        // Prevent mem leaks!
        delete m_pCurrentIn;
        delete m_pCurrentOut;
    }

protected:
    /*
     * Input stream tests.
     */

    // Just try to perform a GetSize() on the input stream.
    void Input_GetSize()
    {
        CleanupHelper cleanup(this);
        const TStreamIn &stream_in = CreateInStream();
        CPPUNIT_ASSERT(!stream_in.Eof());

        // Size should be greater then zero.
        // Note: streams not supporting this should register this test
        //       with CPPUNIT_TEST_FAIL instead of CPPUNIT_TEST.
        CPPUNIT_ASSERT(stream_in.GetSize() != 0);
    }

    // Just try to perform a GetC() on the input stream.
    void Input_GetC()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();
        CPPUNIT_ASSERT(!stream_in.Eof());

        // If no exception occurs the test is successful.
        (void)stream_in.GetC();
    }

    // Just try to perform a Read() on the input stream.
    void Input_Read()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();
        CPPUNIT_ASSERT(!stream_in.Eof());

        // Note: the input stream should at least be of min size +10!

        char buf[10];
        (void)stream_in.Read(buf, 10);

        CPPUNIT_ASSERT(!stream_in.Eof());
        CPPUNIT_ASSERT(stream_in.IsOk());

        // Test the stream version aswell.
        TStreamOut &stream_out = CreateOutStream();
        (void)stream_in.Read(stream_out);

        // The output stream should have read the input stream till the end.
        CPPUNIT_ASSERT(stream_in.Eof());
    }

    // Test and see what happens to the EOF when we
    // read after EOF was encountered.
    void Input_Eof()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();
        CPPUNIT_ASSERT(!stream_in.Eof());
        // Double check to see if Eof it self doesn't changes the Eof status.
        CPPUNIT_ASSERT(!stream_in.Eof());

        // Travel to the end of the stream.
        while(!stream_in.Eof())
        {
            CPPUNIT_ASSERT_MESSAGE( "unexpected non-EOF stream error",
                                    stream_in.IsOk() );

            // Read, we move one byte along.
            (void)stream_in.GetC();
#if 0
            // EOF behaviour is different in streams, disabled (for now?)

            if (m_bEofAtLastRead)
                // EOF should only occure after the last successful get.
                CPPUNIT_ASSERT_MESSAGE("Eof is detected too late.", !(stream_in.LastRead() != 1 && stream_in.Eof()));
            else
                // EOF should only occure after a failed get.
                CPPUNIT_ASSERT_MESSAGE("Eof is detected too soon.", !(stream_in.LastRead() == 1 && stream_in.Eof()));
#endif
        }

        // Check EOF stream state.
        CPPUNIT_ASSERT_MESSAGE("EOF is not EOF?", stream_in.Eof());

        // Ok we found the end, lets see if we can go past it.
        for (size_t i = 0; i < 100; i++)
            (void)stream_in.GetC();

        // Check for EOF correctness.
        CPPUNIT_ASSERT_MESSAGE("EOF is wrong when we read past EOF!", stream_in.Eof());
        CPPUNIT_ASSERT_MESSAGE("Last error is not EOF while stream_in.Eof() is true", stream_in.GetLastError() == wxSTREAM_EOF);
    }

    // Just try to perform a LastRead() on the input stream.
    void Input_LastRead()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();
        CPPUNIT_ASSERT(!stream_in.Eof());

        char buf[5];
        (void)stream_in.Read(buf, 5);
        CPPUNIT_ASSERT_EQUAL(5, stream_in.LastRead());
        (void)stream_in.GetC();
        CPPUNIT_ASSERT_EQUAL(1, stream_in.LastRead());
    }

    void Input_CanRead()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();

        CPPUNIT_ASSERT( stream_in.CanRead() );

        // read the entire contents
        (void)stream_in.Read(CreateOutStream());

        CPPUNIT_ASSERT( !stream_in.CanRead() );
    }

    // Just try to perform a SeekI() on the input stream.
    void Input_SeekI()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();

        CPPUNIT_ASSERT( stream_in.IsSeekable() );
        CPPUNIT_ASSERT(!stream_in.Eof());

        // Try to Seek in the stream...
        // Note: streams not supporting this should register this test
        //       with CPPUNIT_TEST_FAIL instead of CPPUNIT_TEST.
        CPPUNIT_ASSERT_EQUAL(2, stream_in.SeekI(2, wxFromStart));
        CPPUNIT_ASSERT_EQUAL(4, stream_in.SeekI(2, wxFromCurrent));
        // Not sure the following line is correct, so test it differently.
        //CPPUNIT_ASSERT_EQUAL(stream_in.GetSize()-2, stream_in.SeekI(-2, wxFromEnd));
        CPPUNIT_ASSERT(stream_in.SeekI(-2, wxFromEnd) != wxInvalidOffset);
        // Go beyond the stream size.
        CPPUNIT_ASSERT((stream_in.SeekI(10, wxFromCurrent) == wxInvalidOffset) == m_bSeekInvalidBeyondEnd);
    }

    // Just try to perform a TellI() on the input stream.
    void Input_TellI()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();

        // this test shouldn't be used at all if the stream isn't seekable
        CPPUNIT_ASSERT( stream_in.IsSeekable() );

        CPPUNIT_ASSERT(!stream_in.Eof());

        // Try to Get the location in the stream...
        CPPUNIT_ASSERT_EQUAL(0, stream_in.TellI());
        (void)stream_in.GetC();
        CPPUNIT_ASSERT_EQUAL(1, stream_in.TellI());
        if (!m_bSimpleTellITest)
        {
            wxFileOffset pos = stream_in.SeekI(5, wxFromStart);
            CPPUNIT_ASSERT_EQUAL(pos, stream_in.TellI());
            (void)stream_in.GetC();
            CPPUNIT_ASSERT_EQUAL(6, stream_in.TellI());
            pos = stream_in.SeekI(2, wxFromCurrent);
            CPPUNIT_ASSERT_EQUAL(pos, stream_in.TellI());
            pos = stream_in.SeekI(5, wxFromStart);
            CPPUNIT_ASSERT_EQUAL(pos, stream_in.TellI());
        }
    }

    // Just try to perform a Peek() on the input stream.
    void Input_Peek()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();

        // Test the full stream
        while (stream_in.IsOk())
        {
            char peekChar = stream_in.Peek();
            char getChar = stream_in.GetC();
            if (stream_in.LastRead() == 1)
                CPPUNIT_ASSERT_EQUAL(getChar, peekChar);
        }
    }

    // Just try to perform a Ungetch() on the input stream.
    void Input_Ungetch()
    {
        CleanupHelper cleanup(this);
        TStreamIn &stream_in = CreateInStream();
        CPPUNIT_ASSERT(!stream_in.Eof());

        const char *ungetstr = "test";
        size_t ungetsize = stream_in.Ungetch(ungetstr, strlen(ungetstr) + 1);
        if (ungetsize != 0)
        {
            CPPUNIT_ASSERT_EQUAL(strlen(ungetstr) + 1, ungetsize);
            char buf[10];
            (void)stream_in.Read(buf, ungetsize);
            CPPUNIT_ASSERT(strcmp(buf, ungetstr) == 0);
        }

        if (stream_in.Ungetch('a'))
        {
            CPPUNIT_ASSERT_EQUAL(int('a'), stream_in.GetC());
        }
    }

    /*
     * Output stream tests.
     */

    // Just try to perform a PutC() on the output stream.
    void Output_PutC()
    {
        CleanupHelper cleanup(this);
        TStreamOut &stream_out = CreateOutStream();

        const char *buf = "Some text";
        const wxFileOffset len = strlen(buf);
        for ( int i = 0; i < len; i++ )
            stream_out.PutC(buf[i]);

        if ( stream_out.IsSeekable() )
            CPPUNIT_ASSERT_EQUAL(len, stream_out.TellO());
    }

    // Just try to perform a Write() on the output stream.
    void Output_Write()
    {
        CleanupHelper cleanup(this);
        TStreamOut &stream_out = CreateOutStream();

        // Do the buffer version.
        const char *buf = "Some text";
        const wxFileOffset len = strlen(buf);
        (void)stream_out.Write(buf, len);
        if ( stream_out.IsSeekable() )
            CPPUNIT_ASSERT_EQUAL( len, stream_out.TellO() );

        // Do the Stream version.
        TStreamIn &stream_in = CreateInStream();
        (void)stream_out.Write(stream_in);

        if ( stream_out.IsSeekable() )
            CPPUNIT_ASSERT(stream_out.TellO() > len);
    }

    // Just try to perform a LastWrite() on the output stream.
    void Output_LastWrite()
    {
        CleanupHelper cleanup(this);
        TStreamOut &stream_out = CreateOutStream();

        const char *buf = "12345";
        (void)stream_out.Write(buf, 5);
        CPPUNIT_ASSERT_EQUAL(5, stream_out.LastWrite());
        (void)stream_out.PutC('1');
        CPPUNIT_ASSERT_EQUAL(1, stream_out.LastWrite());
    }

    // Just try to perform a SeekO() on the output stream.
    void Output_SeekO()
    {
        CleanupHelper cleanup(this);
        TStreamOut &stream_out = CreateOutStream();

        CPPUNIT_ASSERT( stream_out.IsSeekable() );

        // First put some data in the stream, so it is not empty.
        const char *buf = "1234567890";
        (void)stream_out.Write(buf, 10);

        // Try to Seek in the stream...
        // Note: streams not supporting this should register this test
        //       with CPPUNIT_TEST_FAIL instead of CPPUNIT_TEST.
        CPPUNIT_ASSERT_EQUAL(2, stream_out.SeekO(2, wxFromStart));
        CPPUNIT_ASSERT_EQUAL(4, stream_out.SeekO(2, wxFromCurrent));
        // Not sure the following line is correct, so test it differently.
        //CPPUNIT_ASSERT_EQUAL(stream_in.GetSize()-2, stream_out.SeekO(-2, wxFromEnd));
        CPPUNIT_ASSERT(stream_out.SeekO(-2, wxFromEnd) != wxInvalidOffset);
        // Go beyond the stream size.
        CPPUNIT_ASSERT((stream_out.SeekO(10, wxFromCurrent) == wxInvalidOffset) == m_bSeekInvalidBeyondEnd);
    }

    // Just try to perform a TellO() on the output stream.
    void Output_TellO()
    {
        CleanupHelper cleanup(this);
        TStreamOut &stream_out = CreateOutStream();

        // If this test is used, the stream must be seekable
        CPPUNIT_ASSERT( stream_out.IsSeekable() );

        // Try to Get the location in the stream...
        CPPUNIT_ASSERT_EQUAL(0, stream_out.TellO());
        (void)stream_out.PutC('1');
        CPPUNIT_ASSERT_EQUAL(1, stream_out.TellO());
        if (!m_bSimpleTellOTest)
        {
            // First put some extra data in the stream, so it's not empty.
            const char *buf = "1234567890";
            (void)stream_out.Write(buf, 10);

            wxFileOffset pos = stream_out.SeekO(5, wxFromStart);
            CPPUNIT_ASSERT_EQUAL(pos, stream_out.TellO());
            (void)stream_out.PutC('1');
            CPPUNIT_ASSERT_EQUAL(6, stream_out.TellO());
            pos = stream_out.SeekO(2, wxFromCurrent);
            CPPUNIT_ASSERT_EQUAL(pos, stream_out.TellO());
            pos = stream_out.SeekO(5, wxFromStart);
            CPPUNIT_ASSERT_EQUAL(pos, stream_out.TellO());
        }
    }

protected:
    // Some tests can be configured... here you can find the config settings
    bool m_bSimpleTellITest;    // if true, no SeekI will be used by the TellI test.
                                // Default false.
    bool m_bSimpleTellOTest;    // if true, no SeekO will be used by the TellI test.
                                // Default false.
    bool m_bSeekInvalidBeyondEnd; // if true a SeekI|O beyond the end of the stream should return wxInvalidOffset
                                  // Default true.
    bool m_bEofAtLastRead;      // Does EOF occure at the moment the last byte is read or when read past the last byte.
                                // Default true.
protected:
    TStreamIn &CreateInStream()
    {
        if (m_pCurrentIn)
        {
            wxFAIL_MSG(_T("Error in test case, the previouse input stream needs to be delete first!"));
        }

        m_pCurrentIn = DoCreateInStream();
        wxASSERT(m_pCurrentIn != NULL);
        return *m_pCurrentIn;
    }
    TStreamOut &CreateOutStream()
    {
        if (m_pCurrentOut)
        {
            wxFAIL_MSG(_T("Error in test case, the previouse output stream needs to be delete first!"));
        }

        m_pCurrentOut = DoCreateOutStream();
        wxASSERT(m_pCurrentOut != NULL);
        return *m_pCurrentOut;
    }

    void DeleteInStream()
    {
        if (m_pCurrentIn == NULL)
            return;
        delete m_pCurrentIn;
        m_pCurrentIn = NULL;
        // Incase something extra needs to be done.
        DoDeleteInStream();
    }
    void DeleteOutStream()
    {
        if (m_pCurrentOut == NULL)
            return;

        CPPUNIT_ASSERT(m_pCurrentOut->Close());

        delete m_pCurrentOut;
        m_pCurrentOut = NULL;
        // Incase something extra needs to be done.
        DoDeleteOutStream();
    }

protected:
    // Items that need to be implemented by a derived class!
    virtual TStreamIn  *DoCreateInStream() = 0;
    virtual TStreamOut *DoCreateOutStream() = 0;
    virtual void DoDeleteInStream()  { /* Depends on the base class */ }
    virtual void DoDeleteOutStream() { /* Depends on the base class */ }

private:
    TStreamIn  *m_pCurrentIn;
    TStreamOut *m_pCurrentOut;
};

#endif
Commit	Line	Data
e3f810a2 VS	1	///////////////////////////////////////////////////////////////////////////////
	2	// Name: tests/streams/bstream.h
	3	// Purpose: Template class for testing base stream functions.
	4	// Author: Hans Van Leemputten
	5	// RCS-ID: $Id$
	6	// Copyright: (c) 2004 Hans Van Leemputten
	7	// Licence: wxWidgets licence
	8	///////////////////////////////////////////////////////////////////////////////
	9
	10	#ifndef _WX_TESTBSTREAM_H__
	11	#define _WX_TESTBSTREAM_H__
	12
	13	#include "wx/cppunit.h"
e3f810a2 VS	14
e3f810a2 VS	15	///////////////////////////////////////////////////////////////////////////////
08776b09	16	// Some macros preventing us from typing too much ;-)
e3f810a2 VS	17	//
	18
	19	#define STREAM_TEST_NAME "Streams"
08776b09 VS	20	#define COMPOSE_TEST_NAME(Name) \
08776b09 VS	21	STREAM_TEST_NAME "." #Name
e3f810a2	22	#define STREAM_REGISTER_SUB_SUITE(Name) \
3e5f6c1c	23	extern CppUnit::Test* Get##Name##Suite(); \
e3f810a2 VS	24	suite->addTest(Get##Name##Suite())
e3f810a2 VS	25	#define STREAM_IMPLEMENT_SUB_REGISTRATION_ROUTINE(Name) \
3e5f6c1c	26	CppUnit::Test* Get##Name##Suite() { return Name::suite(); }
e3f810a2	27	#define STREAM_TEST_SUBSUITE_NAMED_REGISTRATION(Name) \
08776b09	28	CPPUNIT_TEST_SUITE_NAMED_REGISTRATION( Name, COMPOSE_TEST_NAME(Name) ); \
e3f810a2 VS	29	STREAM_IMPLEMENT_SUB_REGISTRATION_ROUTINE( Name )
e3f810a2 VS	30
e3f810a2 VS	31	///////////////////////////////////////////////////////////////////////////////
	32	// Template class that implements a test for all base stream functions.
	33	//
	34
3e5f6c1c	35	template <class TStreamIn, class TStreamOut> class BaseStreamTestCase : public CppUnit::TestCase
e3f810a2 VS	36	{
	37	protected:
	38	typedef BaseStreamTestCase<TStreamIn, TStreamOut> StreamTestCase;
	39
	40	class CleanupHelper
	41	{
	42	public:
	43	CleanupHelper(StreamTestCase *value)
	44	:m_pCleanup(value)
	45	{}
	46	~CleanupHelper()
2d76b6d8	47	{
e3f810a2 VS	48	m_pCleanup->DeleteInStream();
	49	m_pCleanup->DeleteOutStream();
	50	}
	51	private:
	52	StreamTestCase *m_pCleanup;
	53	};
	54	friend class CleanupHelper;
	55
	56	public:
	57	BaseStreamTestCase()
	58	:m_bSimpleTellITest(false),
	59	m_bSimpleTellOTest(false),
08776b09	60	m_bSeekInvalidBeyondEnd(true),
7735998c	61	m_bEofAtLastRead(true),
e3f810a2 VS	62	m_pCurrentIn(NULL),
	63	m_pCurrentOut(NULL)
	64	{ /* Nothing extra */ }
	65	virtual ~BaseStreamTestCase()
	66	{
	67	// Prevent mem leaks!
	68	delete m_pCurrentIn;
	69	delete m_pCurrentOut;
2d76b6d8	70	}
e3f810a2 VS	71
	72	protected:
	73	/*
	74	* Input stream tests.
	75	*/
	76
	77	// Just try to perform a GetSize() on the input stream.
	78	void Input_GetSize()
	79	{
	80	CleanupHelper cleanup(this);
	81	const TStreamIn &stream_in = CreateInStream();
	82	CPPUNIT_ASSERT(!stream_in.Eof());
	83
	84	// Size should be greater then zero.
	85	// Note: streams not supporting this should register this test
	86	// with CPPUNIT_TEST_FAIL instead of CPPUNIT_TEST.
	87	CPPUNIT_ASSERT(stream_in.GetSize() != 0);
	88	}
	89
	90	// Just try to perform a GetC() on the input stream.
	91	void Input_GetC()
	92	{
	93	CleanupHelper cleanup(this);
	94	TStreamIn &stream_in = CreateInStream();
	95	CPPUNIT_ASSERT(!stream_in.Eof());
	96
	97	// If no exception occurs the test is successful.
	98	(void)stream_in.GetC();
	99	}
	100
	101	// Just try to perform a Read() on the input stream.
	102	void Input_Read()
	103	{
	104	CleanupHelper cleanup(this);
	105	TStreamIn &stream_in = CreateInStream();
	106	CPPUNIT_ASSERT(!stream_in.Eof());
	107
	108	// Note: the input stream should at least be of min size +10!
	109
2d76b6d8	110	char buf[10];
e3f810a2 VS	111	(void)stream_in.Read(buf, 10);
	112
	113	CPPUNIT_ASSERT(!stream_in.Eof());
	114	CPPUNIT_ASSERT(stream_in.IsOk());
	115
	116	// Test the stream version aswell.
	117	TStreamOut &stream_out = CreateOutStream();
	118	(void)stream_in.Read(stream_out);
	119
	120	// The output stream should have read the input stream till the end.
	121	CPPUNIT_ASSERT(stream_in.Eof());
	122	}
	123
2d76b6d8	124	// Test and see what happens to the EOF when we
e3f810a2 VS	125	// read after EOF was encountered.
	126	void Input_Eof()
	127	{
	128	CleanupHelper cleanup(this);
	129	TStreamIn &stream_in = CreateInStream();
	130	CPPUNIT_ASSERT(!stream_in.Eof());
	131	// Double check to see if Eof it self doesn't changes the Eof status.
	132	CPPUNIT_ASSERT(!stream_in.Eof());
	133
	134	// Travel to the end of the stream.
	135	while(!stream_in.Eof())
	136	{
bf451723 VZ	137	CPPUNIT_ASSERT_MESSAGE( "unexpected non-EOF stream error",
	138	stream_in.IsOk() );
	139
e3f810a2 VS	140	// Read, we move one byte along.
e3f810a2 VS	141	(void)stream_in.GetC();
7735998c VS	142	#if 0
	143	// EOF behaviour is different in streams, disabled (for now?)
	144
	145	if (m_bEofAtLastRead)
	146	// EOF should only occure after the last successful get.
	147	CPPUNIT_ASSERT_MESSAGE("Eof is detected too late.", !(stream_in.LastRead() != 1 && stream_in.Eof()));
	148	else
	149	// EOF should only occure after a failed get.
	150	CPPUNIT_ASSERT_MESSAGE("Eof is detected too soon.", !(stream_in.LastRead() == 1 && stream_in.Eof()));
	151	#endif
e3f810a2 VS	152	}
e3f810a2 VS	153
7735998c	154	// Check EOF stream state.
2d76b6d8	155	CPPUNIT_ASSERT_MESSAGE("EOF is not EOF?", stream_in.Eof());
7735998c	156
e3f810a2 VS	157	// Ok we found the end, lets see if we can go past it.
	158	for (size_t i = 0; i < 100; i++)
	159	(void)stream_in.GetC();
	160
	161	// Check for EOF correctness.
	162	CPPUNIT_ASSERT_MESSAGE("EOF is wrong when we read past EOF!", stream_in.Eof());
7735998c	163	CPPUNIT_ASSERT_MESSAGE("Last error is not EOF while stream_in.Eof() is true", stream_in.GetLastError() == wxSTREAM_EOF);
e3f810a2 VS	164	}
	165
	166	// Just try to perform a LastRead() on the input stream.
	167	void Input_LastRead()
	168	{
	169	CleanupHelper cleanup(this);
	170	TStreamIn &stream_in = CreateInStream();
	171	CPPUNIT_ASSERT(!stream_in.Eof());
	172
	173	char buf[5];
	174	(void)stream_in.Read(buf, 5);
91bde3ec	175	CPPUNIT_ASSERT_EQUAL(5, stream_in.LastRead());
e3f810a2	176	(void)stream_in.GetC();
91bde3ec	177	CPPUNIT_ASSERT_EQUAL(1, stream_in.LastRead());
e3f810a2 VS	178	}
e3f810a2 VS	179
2d76b6d8 VZ	180	void Input_CanRead()
	181	{
	182	CleanupHelper cleanup(this);
	183	TStreamIn &stream_in = CreateInStream();
	184
	185	CPPUNIT_ASSERT( stream_in.CanRead() );
	186
	187	// read the entire contents
	188	(void)stream_in.Read(CreateOutStream());
	189
	190	CPPUNIT_ASSERT( !stream_in.CanRead() );
	191	}
	192
e3f810a2 VS	193	// Just try to perform a SeekI() on the input stream.
	194	void Input_SeekI()
	195	{
	196	CleanupHelper cleanup(this);
	197	TStreamIn &stream_in = CreateInStream();
8bd966d3 VZ	198
8bd966d3 VZ	199	CPPUNIT_ASSERT( stream_in.IsSeekable() );
e3f810a2 VS	200	CPPUNIT_ASSERT(!stream_in.Eof());
	201
	202	// Try to Seek in the stream...
	203	// Note: streams not supporting this should register this test
	204	// with CPPUNIT_TEST_FAIL instead of CPPUNIT_TEST.
a54b285e VZ	205	CPPUNIT_ASSERT_EQUAL(2, stream_in.SeekI(2, wxFromStart));
a54b285e VZ	206	CPPUNIT_ASSERT_EQUAL(4, stream_in.SeekI(2, wxFromCurrent));
e3f810a2	207	// Not sure the following line is correct, so test it differently.
91bde3ec	208	//CPPUNIT_ASSERT_EQUAL(stream_in.GetSize()-2, stream_in.SeekI(-2, wxFromEnd));
e3f810a2 VS	209	CPPUNIT_ASSERT(stream_in.SeekI(-2, wxFromEnd) != wxInvalidOffset);
e3f810a2 VS	210	// Go beyond the stream size.
08776b09	211	CPPUNIT_ASSERT((stream_in.SeekI(10, wxFromCurrent) == wxInvalidOffset) == m_bSeekInvalidBeyondEnd);
e3f810a2 VS	212	}
	213
	214	// Just try to perform a TellI() on the input stream.
	215	void Input_TellI()
	216	{
	217	CleanupHelper cleanup(this);
	218	TStreamIn &stream_in = CreateInStream();
8bd966d3 VZ	219
	220	// this test shouldn't be used at all if the stream isn't seekable
	221	CPPUNIT_ASSERT( stream_in.IsSeekable() );
	222
e3f810a2 VS	223	CPPUNIT_ASSERT(!stream_in.Eof());
	224
	225	// Try to Get the location in the stream...
91bde3ec	226	CPPUNIT_ASSERT_EQUAL(0, stream_in.TellI());
e3f810a2	227	(void)stream_in.GetC();
91bde3ec	228	CPPUNIT_ASSERT_EQUAL(1, stream_in.TellI());
e3f810a2 VS	229	if (!m_bSimpleTellITest)
e3f810a2 VS	230	{
30984dea	231	wxFileOffset pos = stream_in.SeekI(5, wxFromStart);
91bde3ec	232	CPPUNIT_ASSERT_EQUAL(pos, stream_in.TellI());
e3f810a2	233	(void)stream_in.GetC();
91bde3ec	234	CPPUNIT_ASSERT_EQUAL(6, stream_in.TellI());
e3f810a2	235	pos = stream_in.SeekI(2, wxFromCurrent);
91bde3ec	236	CPPUNIT_ASSERT_EQUAL(pos, stream_in.TellI());
e3f810a2	237	pos = stream_in.SeekI(5, wxFromStart);
91bde3ec	238	CPPUNIT_ASSERT_EQUAL(pos, stream_in.TellI());
e3f810a2 VS	239	}
e3f810a2 VS	240	}
2d76b6d8	241
e3f810a2 VS	242	// Just try to perform a Peek() on the input stream.
	243	void Input_Peek()
	244	{
	245	CleanupHelper cleanup(this);
	246	TStreamIn &stream_in = CreateInStream();
	247
	248	// Test the full stream
08776b09	249	while (stream_in.IsOk())
e3f810a2	250	{
e3f810a2 VS	251	char peekChar = stream_in.Peek();
e3f810a2 VS	252	char getChar = stream_in.GetC();
08776b09	253	if (stream_in.LastRead() == 1)
91bde3ec	254	CPPUNIT_ASSERT_EQUAL(getChar, peekChar);
e3f810a2 VS	255	}
	256	}
	257
	258	// Just try to perform a Ungetch() on the input stream.
	259	void Input_Ungetch()
	260	{
	261	CleanupHelper cleanup(this);
	262	TStreamIn &stream_in = CreateInStream();
	263	CPPUNIT_ASSERT(!stream_in.Eof());
2d76b6d8	264
e3f810a2 VS	265	const char *ungetstr = "test";
	266	size_t ungetsize = stream_in.Ungetch(ungetstr, strlen(ungetstr) + 1);
	267	if (ungetsize != 0)
	268	{
91bde3ec	269	CPPUNIT_ASSERT_EQUAL(strlen(ungetstr) + 1, ungetsize);
e3f810a2 VS	270	char buf[10];
	271	(void)stream_in.Read(buf, ungetsize);
	272	CPPUNIT_ASSERT(strcmp(buf, ungetstr) == 0);
	273	}
	274
	275	if (stream_in.Ungetch('a'))
	276	{
a54b285e	277	CPPUNIT_ASSERT_EQUAL(int('a'), stream_in.GetC());
e3f810a2 VS	278	}
	279	}
	280
	281	/*
	282	* Output stream tests.
	283	*/
	284
	285	// Just try to perform a PutC() on the output stream.
	286	void Output_PutC()
	287	{
	288	CleanupHelper cleanup(this);
	289	TStreamOut &stream_out = CreateOutStream();
	290
8bd966d3 VZ	291	const char *buf = "Some text";
	292	const wxFileOffset len = strlen(buf);
	293	for ( int i = 0; i < len; i++ )
e3f810a2 VS	294	stream_out.PutC(buf[i]);
e3f810a2 VS	295
8bd966d3 VZ	296	if ( stream_out.IsSeekable() )
8bd966d3 VZ	297	CPPUNIT_ASSERT_EQUAL(len, stream_out.TellO());
e3f810a2 VS	298	}
	299
	300	// Just try to perform a Write() on the output stream.
	301	void Output_Write()
	302	{
	303	CleanupHelper cleanup(this);
	304	TStreamOut &stream_out = CreateOutStream();
	305
	306	// Do the buffer version.
8bd966d3 VZ	307	const char *buf = "Some text";
8bd966d3 VZ	308	const wxFileOffset len = strlen(buf);
e3f810a2	309	(void)stream_out.Write(buf, len);
8bd966d3 VZ	310	if ( stream_out.IsSeekable() )
8bd966d3 VZ	311	CPPUNIT_ASSERT_EQUAL( len, stream_out.TellO() );
e3f810a2 VS	312
	313	// Do the Stream version.
	314	TStreamIn &stream_in = CreateInStream();
	315	(void)stream_out.Write(stream_in);
8bd966d3 VZ	316
	317	if ( stream_out.IsSeekable() )
	318	CPPUNIT_ASSERT(stream_out.TellO() > len);
e3f810a2 VS	319	}
	320
	321	// Just try to perform a LastWrite() on the output stream.
	322	void Output_LastWrite()
	323	{
	324	CleanupHelper cleanup(this);
	325	TStreamOut &stream_out = CreateOutStream();
	326
8bd966d3	327	const char *buf = "12345";
e3f810a2	328	(void)stream_out.Write(buf, 5);
91bde3ec	329	CPPUNIT_ASSERT_EQUAL(5, stream_out.LastWrite());
e3f810a2	330	(void)stream_out.PutC('1');
91bde3ec	331	CPPUNIT_ASSERT_EQUAL(1, stream_out.LastWrite());
e3f810a2 VS	332	}
	333
	334	// Just try to perform a SeekO() on the output stream.
	335	void Output_SeekO()
	336	{
	337	CleanupHelper cleanup(this);
	338	TStreamOut &stream_out = CreateOutStream();
2d76b6d8	339
8bd966d3 VZ	340	CPPUNIT_ASSERT( stream_out.IsSeekable() );
8bd966d3 VZ	341
e3f810a2	342	// First put some data in the stream, so it is not empty.
8bd966d3	343	const char *buf = "1234567890";
e3f810a2 VS	344	(void)stream_out.Write(buf, 10);
	345
	346	// Try to Seek in the stream...
	347	// Note: streams not supporting this should register this test
	348	// with CPPUNIT_TEST_FAIL instead of CPPUNIT_TEST.
91bde3ec VZ	349	CPPUNIT_ASSERT_EQUAL(2, stream_out.SeekO(2, wxFromStart));
91bde3ec VZ	350	CPPUNIT_ASSERT_EQUAL(4, stream_out.SeekO(2, wxFromCurrent));
e3f810a2	351	// Not sure the following line is correct, so test it differently.
91bde3ec	352	//CPPUNIT_ASSERT_EQUAL(stream_in.GetSize()-2, stream_out.SeekO(-2, wxFromEnd));
e3f810a2 VS	353	CPPUNIT_ASSERT(stream_out.SeekO(-2, wxFromEnd) != wxInvalidOffset);
e3f810a2 VS	354	// Go beyond the stream size.
08776b09	355	CPPUNIT_ASSERT((stream_out.SeekO(10, wxFromCurrent) == wxInvalidOffset) == m_bSeekInvalidBeyondEnd);
e3f810a2 VS	356	}
	357
	358	// Just try to perform a TellO() on the output stream.
	359	void Output_TellO()
	360	{
	361	CleanupHelper cleanup(this);
	362	TStreamOut &stream_out = CreateOutStream();
	363
8bd966d3 VZ	364	// If this test is used, the stream must be seekable
	365	CPPUNIT_ASSERT( stream_out.IsSeekable() );
	366
e3f810a2	367	// Try to Get the location in the stream...
91bde3ec	368	CPPUNIT_ASSERT_EQUAL(0, stream_out.TellO());
e3f810a2	369	(void)stream_out.PutC('1');
91bde3ec	370	CPPUNIT_ASSERT_EQUAL(1, stream_out.TellO());
e3f810a2 VS	371	if (!m_bSimpleTellOTest)
	372	{
	373	// First put some extra data in the stream, so it's not empty.
8bd966d3	374	const char *buf = "1234567890";
e3f810a2	375	(void)stream_out.Write(buf, 10);
2d76b6d8	376
9540df9c	377	wxFileOffset pos = stream_out.SeekO(5, wxFromStart);
91bde3ec	378	CPPUNIT_ASSERT_EQUAL(pos, stream_out.TellO());
e3f810a2	379	(void)stream_out.PutC('1');
91bde3ec	380	CPPUNIT_ASSERT_EQUAL(6, stream_out.TellO());
e3f810a2	381	pos = stream_out.SeekO(2, wxFromCurrent);
91bde3ec	382	CPPUNIT_ASSERT_EQUAL(pos, stream_out.TellO());
e3f810a2	383	pos = stream_out.SeekO(5, wxFromStart);
91bde3ec	384	CPPUNIT_ASSERT_EQUAL(pos, stream_out.TellO());
e3f810a2 VS	385	}
	386	}
	387
	388	protected:
	389	// Some tests can be configured... here you can find the config settings
2d76b6d8	390	bool m_bSimpleTellITest; // if true, no SeekI will be used by the TellI test.
e3f810a2	391	// Default false.
2d76b6d8	392	bool m_bSimpleTellOTest; // if true, no SeekO will be used by the TellI test.
e3f810a2	393	// Default false.
08776b09 VS	394	bool m_bSeekInvalidBeyondEnd; // if true a SeekI\|O beyond the end of the stream should return wxInvalidOffset
08776b09 VS	395	// Default true.
7735998c VS	396	bool m_bEofAtLastRead; // Does EOF occure at the moment the last byte is read or when read past the last byte.
7735998c VS	397	// Default true.
e3f810a2 VS	398	protected:
e3f810a2 VS	399	TStreamIn &CreateInStream()
2d76b6d8	400	{
e3f810a2 VS	401	if (m_pCurrentIn)
	402	{
	403	wxFAIL_MSG(_T("Error in test case, the previouse input stream needs to be delete first!"));
	404	}
	405
	406	m_pCurrentIn = DoCreateInStream();
	407	wxASSERT(m_pCurrentIn != NULL);
	408	return *m_pCurrentIn;
	409	}
	410	TStreamOut &CreateOutStream()
2d76b6d8	411	{
e3f810a2 VS	412	if (m_pCurrentOut)
	413	{
	414	wxFAIL_MSG(_T("Error in test case, the previouse output stream needs to be delete first!"));
	415	}
	416
	417	m_pCurrentOut = DoCreateOutStream();
	418	wxASSERT(m_pCurrentOut != NULL);
	419	return *m_pCurrentOut;
	420	}
2d76b6d8	421
e3f810a2 VS	422	void DeleteInStream()
	423	{
	424	if (m_pCurrentIn == NULL)
	425	return;
	426	delete m_pCurrentIn;
	427	m_pCurrentIn = NULL;
	428	// Incase something extra needs to be done.
	429	DoDeleteInStream();
	430	}
	431	void DeleteOutStream()
2d76b6d8	432	{
e3f810a2 VS	433	if (m_pCurrentOut == NULL)
e3f810a2 VS	434	return;
2d76b6d8	435
8f0ff178	436	CPPUNIT_ASSERT(m_pCurrentOut->Close());
2d76b6d8	437
e3f810a2 VS	438	delete m_pCurrentOut;
	439	m_pCurrentOut = NULL;
	440	// Incase something extra needs to be done.
	441	DoDeleteOutStream();
	442	}
	443
	444	protected:
	445	// Items that need to be implemented by a derived class!
	446	virtual TStreamIn *DoCreateInStream() = 0;
	447	virtual TStreamOut *DoCreateOutStream() = 0;
	448	virtual void DoDeleteInStream() { /* Depends on the base class */ }
	449	virtual void DoDeleteOutStream() { /* Depends on the base class */ }
	450
	451	private:
	452	TStreamIn *m_pCurrentIn;
	453	TStreamOut *m_pCurrentOut;
	454	};
	455
	456	#endif
	457
	458