Enable endianness conversions on q(u)int8

Lack of support for these types is not a real issue as endian
conversions on byte-sized types are no-ops. Still, the conversions are
useful as they facilitate writing of generic code. They can also be used
explicitly as a way to document in code an endian-specific binary
format:

     uchar *data;
     quint8 tag = qFromLittleEndian<quint8>(data++);
     quint32 size = qFromLittleEndian<quint32>(data);

This commit also adds a test for functions documented in the QtEndian
header.

Change-Id: I2f6c876ce89d2adb8c03a1c8a25921d225bf6f92
Reviewed-by: Thiago Macieira <thiago.macieira@intel.com>

diff --git a/src/corelib/global/qendian.h b/src/corelib/global/qendian.h
index 8ecff5e..e049fb6 100644 (file)
--- a/src/corelib/global/qendian.h
+++ b/src/corelib/global/qendian.h
@@ -171,6 +171,11 @@ template <> inline qint16 qFromLittleEndian<qint16>(const uchar *src)
 { return static_cast<qint16>(qFromLittleEndian<quint16>(src)); }
 #endif
 
+template <> inline quint8 qFromLittleEndian<quint8>(const uchar *src)
+{ return static_cast<quint8>(src[0]); }
+template <> inline qint8 qFromLittleEndian<qint8>(const uchar *src)
+{ return static_cast<qint8>(src[0]); }
+
 /* This function will read a big-endian (also known as network order) encoded value from \a src
  * and return the value in host-endian encoding.
  * There is no requirement that \a src must be aligned.
@@ -263,6 +268,12 @@ template <> inline qint32 qFromBigEndian<qint32>(const uchar *src)
 template <> inline qint16 qFromBigEndian<qint16>(const uchar *src)
 { return static_cast<qint16>(qFromBigEndian<quint16>(src)); }
 #endif
+
+template <> inline quint8 qFromBigEndian<quint8>(const uchar *src)
+{ return static_cast<quint8>(src[0]); }
+template <> inline qint8 qFromBigEndian<qint8>(const uchar *src)
+{ return static_cast<qint8>(src[0]); }
+
 /*
  * T qbswap(T source).
  * Changes the byte order of a value from big endian to little endian or vice versa.
@@ -367,6 +378,11 @@ template <> inline quint8 qbswap<quint8>(quint8 source)
     return source;
 }
 
+template <> inline qint8 qbswap<qint8>(qint8 source)
+{
+    return source;
+}
+
 QT_END_NAMESPACE
 
 QT_END_HEADER

diff --git a/tests/auto/corelib/global/global.pro b/tests/auto/corelib/global/global.pro
index d4293a8..5489b83 100644 (file)
--- a/tests/auto/corelib/global/global.pro
+++ b/tests/auto/corelib/global/global.pro
@@ -6,4 +6,5 @@ SUBDIRS=\
     qglobal \
     qnumeric \
     qrand \
-    qlogging
+    qlogging \
+    qtendian

diff --git a/tests/auto/corelib/global/qtendian/qtendian.pro b/tests/auto/corelib/global/qtendian/qtendian.pro
new file mode 100644 (file)
index 0000000..caad0fc
--- /dev/null
+++ b/tests/auto/corelib/global/qtendian/qtendian.pro
@@ -0,0 +1,4 @@
+CONFIG += testcase parallel_test
+TARGET = tst_qtendian
+QT = core testlib
+SOURCES = tst_qtendian.cpp

diff --git a/tests/auto/corelib/global/qtendian/tst_qtendian.cpp b/tests/auto/corelib/global/qtendian/tst_qtendian.cpp
new file mode 100644 (file)
index 0000000..002060b
--- /dev/null
+++ b/tests/auto/corelib/global/qtendian/tst_qtendian.cpp
@@ -0,0 +1,146 @@
+/****************************************************************************
+**
+** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).
+** Contact: http://www.qt-project.org/
+**
+** This file is part of the test suite of the Qt Toolkit.
+**
+** $QT_BEGIN_LICENSE:LGPL$
+** GNU Lesser General Public License Usage
+** This file may be used under the terms of the GNU Lesser General Public
+** License version 2.1 as published by the Free Software Foundation and
+** appearing in the file LICENSE.LGPL included in the packaging of this
+** file. Please review the following information to ensure the GNU Lesser
+** General Public License version 2.1 requirements will be met:
+** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
+**
+** In addition, as a special exception, Nokia gives you certain additional
+** rights. These rights are described in the Nokia Qt LGPL Exception
+** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
+**
+** GNU General Public License Usage
+** Alternatively, this file may be used under the terms of the GNU General
+** Public License version 3.0 as published by the Free Software Foundation
+** and appearing in the file LICENSE.GPL included in the packaging of this
+** file. Please review the following information to ensure the GNU General
+** Public License version 3.0 requirements will be met:
+** http://www.gnu.org/copyleft/gpl.html.
+**
+** Other Usage
+** Alternatively, this file may be used in accordance with the terms and
+** conditions contained in a signed written agreement between you and Nokia.
+**
+**
+**
+**
+**
+**
+** $QT_END_LICENSE$
+**
+****************************************************************************/
+
+
+#include <QtTest/QtTest>
+#include <QtCore/qendian.h>
+
+
+class tst_QtEndian: public QObject
+{
+    Q_OBJECT
+
+private slots:
+    void fromBigEndian();
+    void fromLittleEndian();
+
+    void toBigEndian();
+    void toLittleEndian();
+};
+
+struct TestData
+{
+    quint64 data64;
+    quint32 data32;
+    quint16 data16;
+    quint8 data8;
+
+    quint8 reserved;
+};
+
+union RawTestData
+{
+    uchar rawData[sizeof(TestData)];
+    TestData data;
+};
+
+static const TestData inNativeEndian = { 0x0123456789abcdef, 0x00c0ffee, 0xcafe, 0xcf, '\0' };
+static const RawTestData inBigEndian = { "\x01\x23\x45\x67\x89\xab\xcd\xef" "\x00\xc0\xff\xee" "\xca\xfe" "\xcf" };
+static const RawTestData inLittleEndian = { "\xef\xcd\xab\x89\x67\x45\x23\x01" "\xee\xff\xc0\x00" "\xfe\xca" "\xcf" };
+
+#define EXPAND_ENDIAN_TEST(endian)          \
+    do {                                    \
+        /* Unsigned tests */                \
+        ENDIAN_TEST(endian, quint, 64);     \
+        ENDIAN_TEST(endian, quint, 32);     \
+        ENDIAN_TEST(endian, quint, 16);     \
+        ENDIAN_TEST(endian, quint, 8);      \
+                                            \
+        /* Signed tests */                  \
+        ENDIAN_TEST(endian, qint, 64);      \
+        ENDIAN_TEST(endian, qint, 32);      \
+        ENDIAN_TEST(endian, qint, 16);      \
+        ENDIAN_TEST(endian, qint, 8);       \
+    } while (false)                         \
+    /**/
+
+#define ENDIAN_TEST(endian, type, size)                                                 \
+    do {                                                                                \
+        QCOMPARE(qFrom ## endian ## Endian(                                             \
+                    (type ## size)(in ## endian ## Endian.data.data ## size)),          \
+                (type ## size)(inNativeEndian.data ## size));                           \
+        QCOMPARE(qFrom ## endian ## Endian<type ## size>(                               \
+                    in ## endian ## Endian.rawData + offsetof(TestData, data ## size)), \
+                (type ## size)(inNativeEndian.data ## size));                           \
+    } while (false)                                                                     \
+    /**/
+
+void tst_QtEndian::fromBigEndian()
+{
+    EXPAND_ENDIAN_TEST(Big);
+}
+
+void tst_QtEndian::fromLittleEndian()
+{
+    EXPAND_ENDIAN_TEST(Little);
+}
+
+#undef ENDIAN_TEST
+
+
+#define ENDIAN_TEST(endian, type, size)                                                 \
+    do {                                                                                \
+        QCOMPARE(qTo ## endian ## Endian(                                               \
+                    (type ## size)(inNativeEndian.data ## size)),                       \
+                (type ## size)(in ## endian ## Endian.data.data ## size));              \
+                                                                                        \
+        RawTestData test;                                                               \
+        qTo ## endian ## Endian(                                                        \
+                (type ## size)(inNativeEndian.data ## size),                            \
+                test.rawData + offsetof(TestData, data ## size));                       \
+        QCOMPARE(test.data.data ## size, in ## endian ## Endian.data.data ## size );    \
+    } while (false)                                                                     \
+    /**/
+
+void tst_QtEndian::toBigEndian()
+{
+    EXPAND_ENDIAN_TEST(Big);
+}
+
+void tst_QtEndian::toLittleEndian()
+{
+    EXPAND_ENDIAN_TEST(Little);
+}
+
+#undef ENDIAN_TEST
+
+QTEST_MAIN(tst_QtEndian)
+#include "tst_qtendian.moc"