office-gobmx/tools/qa/cppunit/test_stream.cxx
Rosh 71ec40df42 tdf#147021 - Use std::size() instead of SAL_N_ELEMENTS() macro
Change-Id: I2495fa1ad081ad75bd8e79a22bdeaa97217aa398
Reviewed-on: https://gerrit.libreoffice.org/c/core/+/177581
Reviewed-by: Ilmari Lauhakangas <ilmari.lauhakangas@libreoffice.org>
Tested-by: Jenkins
2024-11-30 09:27:12 +01:00

354 lines
12 KiB
C++

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*/
#include <sal/types.h>
#include <cppunit/TestAssert.h>
#include <cppunit/TestFixture.h>
#include <cppunit/extensions/HelperMacros.h>
#include <tools/stream.hxx>
#include <unotools/tempfile.hxx>
#include <sstream>
//Tests for eofbit/badbit/goodbit/failbit
namespace
{
class Test: public CppUnit::TestFixture
{
public:
void test_stdstream();
void test_fastostring();
void test_read_cstring();
void test_read_pstring();
void test_readline();
void test_makereadonly();
void test_write_unicode();
CPPUNIT_TEST_SUITE(Test);
CPPUNIT_TEST(test_stdstream);
CPPUNIT_TEST(test_fastostring);
CPPUNIT_TEST(test_read_cstring);
CPPUNIT_TEST(test_read_pstring);
CPPUNIT_TEST(test_readline);
CPPUNIT_TEST(test_makereadonly);
CPPUNIT_TEST(test_write_unicode);
CPPUNIT_TEST_SUITE_END();
};
void Test::test_stdstream()
{
char foo[] = "foo";
std::istringstream iss(foo, std::istringstream::in);
SvMemoryStream aMemStream(foo, std::size(foo)-1, StreamMode::READ);
char std_a(78);
iss >> std_a;
CPPUNIT_ASSERT_EQUAL('f', std_a);
char tools_a(78);
aMemStream.ReadChar( tools_a );
CPPUNIT_ASSERT_EQUAL('f', tools_a);
iss.seekg(0, std::ios_base::end);
//seeking to end doesn't set eof, reading past eof does
CPPUNIT_ASSERT(!iss.eof());
CPPUNIT_ASSERT(iss.good());
aMemStream.Seek(STREAM_SEEK_TO_END);
//seeking to end doesn't set eof, reading past eof does
CPPUNIT_ASSERT(!aMemStream.eof());
CPPUNIT_ASSERT(aMemStream.good());
std_a = 78;
iss >> std_a;
//so, now eof is set
CPPUNIT_ASSERT(iss.eof());
//a failed read doesn't change the data, it remains unchanged
CPPUNIT_ASSERT_EQUAL(static_cast<char>(78), std_a);
//nothing wrong with the stream, so not bad
CPPUNIT_ASSERT(!iss.bad());
//yet, the read didn't succeed
CPPUNIT_ASSERT(!iss.good());
CPPUNIT_ASSERT_EQUAL((std::ios::failbit|std::ios::eofbit), iss.rdstate());
tools_a = 78;
aMemStream.ReadChar( tools_a );
//so, now eof is set
CPPUNIT_ASSERT(aMemStream.eof());
//a failed read doesn't change the data, it remains unchanged
CPPUNIT_ASSERT_EQUAL(static_cast<char>(78), tools_a);
//nothing wrong with the stream, so not bad
CPPUNIT_ASSERT(!aMemStream.bad());
//yet, the read didn't succeed
CPPUNIT_ASSERT(!aMemStream.good());
//set things up so that there is only one byte available on an attempt
//to read a two-byte sal_uInt16. The byte should be consumed, but the
//operation should fail, and tools_b should remain unchanged,
sal_uInt16 tools_b = 0x1122;
aMemStream.SeekRel(-1);
CPPUNIT_ASSERT(!aMemStream.eof());
CPPUNIT_ASSERT(aMemStream.good());
aMemStream.ReadUInt16( tools_b );
CPPUNIT_ASSERT(!aMemStream.good());
CPPUNIT_ASSERT(aMemStream.eof());
CPPUNIT_ASSERT_EQUAL(static_cast<sal_uInt16>(0x1122), tools_b);
iss.clear();
iss.seekg(0);
CPPUNIT_ASSERT(iss.good());
iss >> std_a;
CPPUNIT_ASSERT_EQUAL('f', std_a);
aMemStream.Seek(0);
CPPUNIT_ASSERT(aMemStream.good());
aMemStream.ReadChar( tools_a );
CPPUNIT_ASSERT_EQUAL('f', tools_a);
//failbit is rather subtle wrt e.g seeks
char buffer[1024];
iss.clear();
iss.seekg(0);
CPPUNIT_ASSERT(iss.good());
iss.read(buffer, sizeof(buffer));
CPPUNIT_ASSERT_EQUAL(static_cast<std::streamsize>(3), iss.gcount());
CPPUNIT_ASSERT(!iss.good());
CPPUNIT_ASSERT(!iss.bad());
CPPUNIT_ASSERT(iss.eof());
aMemStream.Seek(0);
CPPUNIT_ASSERT(aMemStream.good());
std::size_t nRet = aMemStream.ReadBytes(buffer, sizeof(buffer));
CPPUNIT_ASSERT_EQUAL(static_cast<std::size_t>(3), nRet);
CPPUNIT_ASSERT(!aMemStream.good());
CPPUNIT_ASSERT(!aMemStream.bad());
CPPUNIT_ASSERT(aMemStream.eof());
}
void Test::test_fastostring()
{
char foo[] = "foobar";
SvMemoryStream aMemStream(foo, std::size(foo)-1, StreamMode::READ);
OString aOne = read_uInt8s_ToOString(aMemStream, 3);
CPPUNIT_ASSERT_EQUAL("foo"_ostr, aOne);
OString aTwo = read_uInt8s_ToOString(aMemStream, 3);
CPPUNIT_ASSERT_EQUAL("bar"_ostr, aTwo);
OString aThree = read_uInt8s_ToOString(aMemStream, 3);
CPPUNIT_ASSERT(aThree.isEmpty());
aMemStream.Seek(0);
OString aFour = read_uInt8s_ToOString(aMemStream, 100);
CPPUNIT_ASSERT_EQUAL(OString(foo), aFour);
}
void Test::test_read_cstring()
{
char foo[] = "foobar";
SvMemoryStream aMemStream(foo, std::size(foo)-1, StreamMode::READ);
OString aOne = read_zeroTerminated_uInt8s_ToOString(aMemStream);
CPPUNIT_ASSERT_EQUAL("foobar"_ostr, aOne);
CPPUNIT_ASSERT(!aMemStream.good());
CPPUNIT_ASSERT(!aMemStream.bad());
CPPUNIT_ASSERT(aMemStream.eof());
aMemStream.Seek(0);
foo[3] = 0;
OString aTwo = read_zeroTerminated_uInt8s_ToOString(aMemStream);
CPPUNIT_ASSERT_EQUAL("foo"_ostr, aTwo);
CPPUNIT_ASSERT(aMemStream.good());
}
void Test::test_read_pstring()
{
char foo[] = "\3foobar";
SvMemoryStream aMemStream(foo, std::size(foo)-1, StreamMode::READ);
OString aFoo = read_uInt8_lenPrefixed_uInt8s_ToOString(aMemStream);
CPPUNIT_ASSERT_EQUAL("foo"_ostr, aFoo);
CPPUNIT_ASSERT(aMemStream.good());
CPPUNIT_ASSERT(!aMemStream.bad());
CPPUNIT_ASSERT(!aMemStream.eof());
aMemStream.Seek(0);
foo[0] = 10;
aFoo = read_uInt8_lenPrefixed_uInt8s_ToOString(aMemStream);
CPPUNIT_ASSERT_EQUAL("foobar"_ostr, aFoo);
CPPUNIT_ASSERT(!aMemStream.good());
CPPUNIT_ASSERT(!aMemStream.bad());
CPPUNIT_ASSERT(aMemStream.eof());
aMemStream.SetEndian(SvStreamEndian::BIG);
aMemStream.Seek(0);
foo[0] = 0;
foo[1] = 3;
aFoo = read_uInt16_lenPrefixed_uInt8s_ToOString(aMemStream);
CPPUNIT_ASSERT_EQUAL("oob"_ostr, aFoo);
CPPUNIT_ASSERT(aMemStream.good());
CPPUNIT_ASSERT(!aMemStream.bad());
CPPUNIT_ASSERT(!aMemStream.eof());
}
void Test::test_readline()
{
char foo[] = "foo\nbar\n\n";
SvMemoryStream aMemStream(foo, std::size(foo)-1, StreamMode::READ);
OString aFoo;
bool bRet;
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(bRet);
CPPUNIT_ASSERT_EQUAL("foo"_ostr, aFoo);
CPPUNIT_ASSERT(aMemStream.good());
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(bRet);
CPPUNIT_ASSERT_EQUAL("bar"_ostr, aFoo);
CPPUNIT_ASSERT(aMemStream.good());
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(bRet);
CPPUNIT_ASSERT(aFoo.isEmpty());
CPPUNIT_ASSERT(aMemStream.good());
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(!bRet);
CPPUNIT_ASSERT(aFoo.isEmpty());
CPPUNIT_ASSERT(aMemStream.eof());
foo[3] = 0; //test reading embedded nulls
aMemStream.Seek(0);
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(bRet);
CPPUNIT_ASSERT_EQUAL(sal_Int32(7), aFoo.getLength());
CPPUNIT_ASSERT_EQUAL('\0', aFoo[3]);
CPPUNIT_ASSERT(aMemStream.good());
std::string sStr(foo, RTL_CONSTASCII_LENGTH(foo));
std::istringstream iss(sStr, std::istringstream::in);
std::getline(iss, sStr, '\n');
//embedded null read as expected
CPPUNIT_ASSERT_EQUAL(std::string::size_type(7), sStr.size());
CPPUNIT_ASSERT_EQUAL('\0', sStr[3]);
CPPUNIT_ASSERT(iss.good());
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(bRet);
CPPUNIT_ASSERT(aFoo.isEmpty());
CPPUNIT_ASSERT(aMemStream.good());
std::getline(iss, sStr, '\n');
CPPUNIT_ASSERT(sStr.empty());
CPPUNIT_ASSERT(iss.good());
bRet = aMemStream.ReadLine(aFoo);
CPPUNIT_ASSERT(!bRet);
CPPUNIT_ASSERT(aFoo.isEmpty());
CPPUNIT_ASSERT(aMemStream.eof());
CPPUNIT_ASSERT(!aMemStream.bad());
std::getline(iss, sStr, '\n');
CPPUNIT_ASSERT(sStr.empty());
CPPUNIT_ASSERT(iss.eof());
CPPUNIT_ASSERT(!iss.bad());
char bar[] = "foo";
SvMemoryStream aMemStreamB(bar, std::size(bar)-1, StreamMode::READ);
bRet = aMemStreamB.ReadLine(aFoo);
CPPUNIT_ASSERT(bRet);
CPPUNIT_ASSERT_EQUAL("foo"_ostr, aFoo);
CPPUNIT_ASSERT(!aMemStreamB.eof()); //<-- diff A
std::istringstream issB(bar, std::istringstream::in);
std::getline(issB, sStr, '\n');
CPPUNIT_ASSERT_EQUAL(std::string("foo"), sStr);
CPPUNIT_ASSERT(issB.eof()); //<-- diff A
}
void Test::test_makereadonly()
{
SvMemoryStream aMemStream;
CPPUNIT_ASSERT(aMemStream.IsWritable());
CPPUNIT_ASSERT_EQUAL(sal_uInt64(0), aMemStream.GetSize());
aMemStream.WriteInt64(21);
CPPUNIT_ASSERT_EQUAL(ERRCODE_NONE, aMemStream.GetError());
CPPUNIT_ASSERT_EQUAL(sal_uInt64(8), aMemStream.GetSize());
aMemStream.MakeReadOnly();
CPPUNIT_ASSERT(!aMemStream.IsWritable());
CPPUNIT_ASSERT_EQUAL(sal_uInt64(8), aMemStream.GetSize());
aMemStream.WriteInt64(42);
CPPUNIT_ASSERT_EQUAL(ERRCODE_IO_CANTWRITE, aMemStream.GetError());
CPPUNIT_ASSERT_EQUAL(sal_uInt64(8), aMemStream.GetSize());
aMemStream.ResetError();
// Check that seeking past the end doesn't resize a read-only stream.
// This apparently doesn't set an error, but at least it shouldn't
// change the size.
aMemStream.Seek(1024LL*1024*1024*3);
CPPUNIT_ASSERT_EQUAL(sal_uInt64(8), aMemStream.GetSize());
aMemStream.ResetError();
aMemStream.Seek(0);
sal_Int64 res;
aMemStream.ReadInt64(res);
CPPUNIT_ASSERT_EQUAL(ERRCODE_NONE, aMemStream.GetError());
CPPUNIT_ASSERT_EQUAL(sal_Int64(21), res);
}
void Test::test_write_unicode()
{
static constexpr OUString write(u"abc"_ustr);
utl::TempFileNamed aTempFile(u"test_write_unicode");
aTempFile.EnableKillingFile();
{
SvStream& s = *aTempFile.GetStream(StreamMode::WRITE);
s.SetEndian(SvStreamEndian::BIG);
if (!s.IsEndianSwap())
s.SetEndian(SvStreamEndian::LITTLE);
CPPUNIT_ASSERT(s.IsEndianSwap());
// StartWritingUnicodeText must switch to no endian swapping and write 0xfeff
s.StartWritingUnicodeText();
// Without the fix in place, this would fail
CPPUNIT_ASSERT(!s.IsEndianSwap());
s.WriteUnicodeOrByteText(write, RTL_TEXTENCODING_UNICODE);
aTempFile.CloseStream();
}
{
SvStream& s = *aTempFile.GetStream(StreamMode::READ);
s.SetEndian(SvStreamEndian::BIG);
if (!s.IsEndianSwap())
s.SetEndian(SvStreamEndian::LITTLE);
CPPUNIT_ASSERT(s.IsEndianSwap());
s.StartReadingUnicodeText(RTL_TEXTENCODING_DONTKNOW);
CPPUNIT_ASSERT(!s.IsEndianSwap());
CPPUNIT_ASSERT_EQUAL(sal_uInt64(2), s.Tell()); // after BOM
OUString read;
CPPUNIT_ASSERT(s.ReadUniOrByteStringLine(read, RTL_TEXTENCODING_UNICODE));
// Without the fix in place, this would fail with
// - Expected: abc
// - Actual : 愀戀挀
CPPUNIT_ASSERT_EQUAL(write, read);
aTempFile.CloseStream();
}
}
CPPUNIT_TEST_SUITE_REGISTRATION(Test);
}
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */