add a good(), eof(), bad() and a test case to demonstrate

3 files changed, 129 insertions, 0 deletions

diff --git a/tools/CppunitTest_tools_test.mk b/tools/CppunitTest_tools_test.mk
index 52d0b7019055..2d1e02e9abdb 100755
--- a/tools/CppunitTest_tools_test.mk
+++ b/tools/CppunitTest_tools_test.mk
@@ -32,6 +32,7 @@ $(eval $(call gb_CppunitTest_CppunitTest,tools_test))
 $(eval $(call gb_CppunitTest_add_exception_objects,tools_test, \
     tools/qa/cppunit/test_reversemap \
     tools/qa/cppunit/test_pathutils \
+    tools/qa/cppunit/test_streamstate \
 ))
 
 $(eval $(call gb_CppunitTest_add_api,tools_test, \
diff --git a/tools/inc/tools/stream.hxx b/tools/inc/tools/stream.hxx
index dc097b8c563f..707b830d78c9 100644
--- a/tools/inc/tools/stream.hxx
+++ b/tools/inc/tools/stream.hxx
@@ -525,6 +525,20 @@ public:
     void            SetVersion( long n ) { nVersion = n; }
 
     friend SvStream& operator<<( SvStream& rStr, SvStrPtr f ); // fuer Manips
+
+    //end of input seen
+    bool eof() const { return bIsEof; }
+
+    // stream is broken
+    bool bad() const { return GetError() != 0; }
+
+    //next operation might succeed. If the state is good() the previous i/o
+    //operation succeeded. If the state is good(), the next input operation
+    //might succeed; otherwise, it will fail. Applying an input operation to a
+    //stream that is not in the good() state is a null operation as far as the
+    //variable being read into is concerned. If we try to read into a variable
+    //v and the operation fails, the value of v should be unchanged,
+    bool good() const { return !(eof() || bad()); }
 };
 
 inline SvStream& operator<<( SvStream& rStr, SvStrPtr f )
diff --git a/tools/qa/cppunit/test_streamstate.cxx b/tools/qa/cppunit/test_streamstate.cxx
new file mode 100644
index 000000000000..1040dc660a06
--- /dev/null
+++ b/tools/qa/cppunit/test_streamstate.cxx
@@ -0,0 +1,114 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * Version: MPL 1.1 / GPLv3+ / LGPLv3+
+ *
+ * The contents of this file are subject to the Mozilla Public License Version
+ * 1.1 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ * http://www.mozilla.org/MPL/
+ *
+ * Software distributed under the License is distributed on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+ * for the specific language governing rights and limitations under the
+ * License.
+ *
+ * The Initial Developer of the Original Code is
+ *        Caolán McNamara <caolanm@redhat.com> (Red Hat, Inc.)
+ * Portions created by the Initial Developer are Copyright (C) 2011 the
+ * Initial Developer. All Rights Reserved.
+ *
+ * Contributor(s): Caolán McNamara <caolanm@redhat.com>
+ *
+ * Alternatively, the contents of this file may be used under the terms of
+ * either the GNU General Public License Version 3 or later (the "GPLv3+"), or
+ * the GNU Lesser General Public License Version 3 or later (the "LGPLv3+"),
+ * in which case the provisions of the GPLv3+ or the LGPLv3+ are applicable
+ * instead of those above.
+ */
+
+#include "precompiled_tools.hxx"
+#include <sal/cppunit.h>
+
+#include <tools/stream.hxx>
+#include <sstream>
+
+//Tests for eofbit/badbit/goodbit/failbit
+
+namespace
+{
+
+    class Test: public CppUnit::TestFixture
+    {
+    public:
+        void test_stdstream();
+
+        CPPUNIT_TEST_SUITE(Test);
+        CPPUNIT_TEST(test_stdstream);
+        CPPUNIT_TEST_SUITE_END();
+    };
+
+    void Test::test_stdstream()
+    {
+        char foo[] = "foo";
+        std::istringstream iss(foo, std::istringstream::in);
+        SvMemoryStream aMemStream(RTL_CONSTASCII_STRINGPARAM(foo), STREAM_READ);
+
+        char std_a(78);
+        iss >> std_a;
+        CPPUNIT_ASSERT(std_a == 'f');
+
+        char tools_a(78);
+        aMemStream >> tools_a;
+        CPPUNIT_ASSERT(std_a == 'f');
+
+        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.IsEof());
+        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(std_a == 78);
+        //nothing wrong with the stream, so not bad
+        CPPUNIT_ASSERT(!iss.bad());
+        //yet, the read didn't succeed
+        CPPUNIT_ASSERT(!iss.good());
+        CPPUNIT_ASSERT(iss.rdstate() == (std::ios::failbit|std::ios::eofbit));
+
+        tools_a = 78;
+        aMemStream >> tools_a;
+        //so, now eof is set
+        CPPUNIT_ASSERT(aMemStream.IsEof());
+        //a failed read doesn't change the data, it remains unchanged
+        CPPUNIT_ASSERT(tools_a == 78);
+        //nothing wrong with the stream, so not bad
+        CPPUNIT_ASSERT(!aMemStream.GetError());
+        //yet, the read didn't succeed
+        CPPUNIT_ASSERT(!aMemStream.good());
+
+        iss.clear();
+        iss.seekg(0);
+        CPPUNIT_ASSERT(iss.good());
+        iss >> std_a;
+        CPPUNIT_ASSERT(std_a == 'f');
+
+        aMemStream.Seek(0);
+        CPPUNIT_ASSERT(aMemStream.good());
+        aMemStream >> tools_a;
+        CPPUNIT_ASSERT(tools_a == 'f');
+
+        //failbit is rather subtle wrt e.g seeks
+    }
+
+    CPPUNIT_TEST_SUITE_REGISTRATION(Test);
+}
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */