Ticket #22: BaseFunctions_ByteOrder.diff

Source/Base/Base/OSGBaseFunctions.h

@@ -256 +256 @@
-inline
-bool osgIsBigEndian(void);
-
+// The osgHostTo??? and osg???ToHost templates are NOT implemented, there are
+// only overloads for some types available, these are:
+// UInt16, UInt32, UInt64, Real32, Real64, Real128
+
+template <class TypeT>
+TypeT osgHostToBigEndian(TypeT src);
+
+template <class TypeT>
+TypeT osgHostToLittleEndian(TypeT src);
+
+template <class TypeT>
+TypeT osgBigEndianToHost(TypeT src);
+
+template <class TypeT>
+TypeT osgLittleEndianToHost(TypeT src);
+
-// host to network
-
-inline
-osghtons 
+ osghtons
-
-inline
-osghtonl 
+ osghtonl
-
-inline
-osghtonll 
+ osghtonll
-
-inline
-osghtonf 
+ osghtonf
-
-inline
-osghtond 
+ osghtond
-
-inline
-Real128 osghtondd(Real128 src);
@@ -279 +295 @@
-// network to host
-
-inline
-
+ 
-
-inline
-
+ 
-
-inline
-
+ 
-
-inline
-
+ 
-
-inline
-
+ 
-
-inline
-
+d
-
-/*---------------------------------------------------------------------*/
-/*                   Case String Runtime Functions                     */

Source/Base/Base/OSGBaseFunctions.inl

@@ -1575 +1575 @@
-    return (BYTE_ORDER) == (BIG_ENDIAN);
-}
-
+/*! Convert a UInt16 from host byte order to big endian byte order.
+
+    \param[in] src Input value in host byte order.
+    \return The input converted to big endian byte order.
+
+    \note An actual conversion only happens on little endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+UInt16 osgHostToBigEndian(UInt16 src)
+{
-#if BYTE_ORDER == LITTLE_ENDIAN
+    return (src >> 8) | (src << 8);
+#else
+    return src;
+#endif
+}
-
-
+
-
-/*! Convert a UInt16 from host byte order to network byte order.
-
-    \param[in] src Input value in host byte order.
-network
+little endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-htons
+HostToLittleEndian
-{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    return src;
+#else
-    return (src >> 8) | (src << 8);
+#endif
-}
-
-32 from host byte order to network
+16 from big endian byte order to host
-
-host
-network
+big endian
+host
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-32 osghtonl(UInt32
+16 osgBigEndianToHost(UInt16
-{
-
-
-
-
+
+
+
+
+
-}
-
-64 from host byte order to network
+16 from little endian byte order to host
-
+    \param[in] src Input value in little endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline 
+UInt16 osgLittleEndianToHost(UInt16 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    return src;
+#else
+    return (src >> 8) | (src << 8);
+#endif
+}
+
+/*! Convert a UInt32 from host byte order to big endian byte order.
+
-    \param[in] src Input value in host byte order.
-network
+big endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-64 osghtonll(UInt64
+32 osgHostToBigEndian(UInt32
-{
-
-
-
-
-
-
-
-
-
+
+
+
+
+
-#else
-
-
-
-
-
-
-
-
+
-#endif
-}
-
-Real32 from host byte order to network
+UInt32 from host byte order to little endian
-
-    \param[in] src Input value in host byte order.
-network
+little endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-
+
-{
-
+
+
+
+
+
+
+
+
+
-
-
-
+
-
+    \param[in] src Input value in big endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on little endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+UInt32 osgBigEndianToHost(UInt32 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    return ((src & 0x000000ff) << 24) |
+           ((src & 0x0000ff00) << 8 ) |
+           ((src & 0x00ff0000) >> 8 ) |
+           ((src & 0xff000000) >> 24);
+#else
-    return src;
+#endif
-}
-
-Real64 from host byte order to network
+UInt32 from little endian byte order to host
-
+    \param[in] src Input value in little endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline 
+UInt32 osgLittleEndianToHost(UInt32 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    return src;
+#else
+    return ((src & 0x000000ff) << 24) |
+           ((src & 0x0000ff00) << 8 ) |
+           ((src & 0x00ff0000) >> 8 ) |
+           ((src & 0xff000000) >> 24);
+#endif
+}
+
+// define some macros for long long int literals (these are undef'ed below)
+// XXX should these go into OSGBaseTypes.h ?? (cneumann)
+#ifdef OSG_LONGLONG_HAS_LL
+
+#define OSG_UINT64_LITERAL(value)   \
+value##ULL
+
+#define OSG_INT64_LITERAL(value)    \
+value##LL
+
+#else
+
+#define OSG_UINT64_LITERAL(value)   \
+value##U
+
+#define OSG_INT64_LITERAL(value)    \
+value
+
+#endif
+
+/*! Convert a UInt64 from host byte order to big endian byte order.
+
-    \param[in] src Input value in host byte order.
-network
+big endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-
+
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
+
-
+    \param[in] src Input value in host byte order.
+    \return The input converted to little endian byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+UInt64 osgHostToLittleEndian(UInt64 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
-    return src;
+#else
+    return ((src & OSG_UINT64_LITERAL(0x00000000000000ff)) << 56) |
+           ((src & OSG_UINT64_LITERAL(0x000000000000ff00)) << 40) |
+           ((src & OSG_UINT64_LITERAL(0x0000000000ff0000)) << 24) |
+           ((src & OSG_UINT64_LITERAL(0x00000000ff000000)) << 8 ) |
+           ((src & OSG_UINT64_LITERAL(0x000000ff00000000)) >> 8 ) |
+           ((src & OSG_UINT64_LITERAL(0x0000ff0000000000)) >> 24) |
+           ((src & OSG_UINT64_LITERAL(0x00ff000000000000)) >> 40) |
+           ((src & OSG_UINT64_LITERAL(0xff00000000000000)) >> 56);
+#endif
-}
-
-Real128 from host byte order to network
+UInt64 from big endian byte order to host
-
-host
-network
+big endian
+host
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-
+
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
-
-
-
-
-
-
-
-
+
-
+    \param[in] src Input value in little endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline 
+UInt64 osgLittleEndianToHost(UInt64 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
-    return src;
+#else
+    return ((src & OSG_UINT64_LITERAL(0x00000000000000ff)) << 56) |
+           ((src & OSG_UINT64_LITERAL(0x000000000000ff00)) << 40) |
+           ((src & OSG_UINT64_LITERAL(0x0000000000ff0000)) << 24) |
+           ((src & OSG_UINT64_LITERAL(0x00000000ff000000)) << 8 ) |
+           ((src & OSG_UINT64_LITERAL(0x000000ff00000000)) >> 8 ) |
+           ((src & OSG_UINT64_LITERAL(0x0000ff0000000000)) >> 24) |
+           ((src & OSG_UINT64_LITERAL(0x00ff000000000000)) >> 40) |
+           ((src & OSG_UINT64_LITERAL(0xff00000000000000)) >> 56);
+#endif
-}
-
-
+
+
+
-
-UInt16 from network byte order to host
+Real32 from host byte order to big endian
-
-    \param[in] src Input value in host byte order.
-network
+big endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-
+
-{
-
+
+
+
+
+
+
+
+
+
+
-}
-
-UInt32 from network byte order to host
+Real32 from host byte order to little endian
-
-    \param[in] src Input value in host byte order.
-network
+little endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-
+
-{
-
-
-
-
+
+
+
+
+
+
+
+
+
+
-}
-
-UInt64 from network
+Real32 from big endian
-
-host
-network
+big endian
+host
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-
+
-{
-
-
-
-
-
-
-
-
-
+
+
+
+
+
+
+
-#else
-
-
-
-
-
-
-
-
+
-#endif
-}
-
-network
+little endian
-
-host
-network
+little endian
+host
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-
-ntohf
+
+LittleEndianToHost
-{
-
-
+
+
+
+
+
-    std::swap(p[0], p[3]);
-    std::swap(p[1], p[2]);
+    
+    return src;
+#endif
+}
-
+/*! Convert a Real64 from host byte order to big endian byte order.
+
+    \param[in] src Input value in host byte order.
+    \return The input converted to big endian byte order.
+
+    \note An actual conversion only happens on little endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+Real64 osgHostToBigEndian(Real64 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    UInt8 *p = reinterpret_cast<UInt8*>(&src);
+    
+    std::swap(p[0], p[7]);
+    std::swap(p[1], p[6]);
+    std::swap(p[2], p[5]);
+    std::swap(p[3], p[4]);
+    
-    return src;
+#else
+    return src;
+#endif
-}
-
-network byte order to host
+host byte order to little endian
-
-    \param[in] src Input value in host byte order.
-network
+little endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-ntohd
+HostToLittleEndian
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+/*! Convert a Real64 from big endian byte order to host byte order.
+
+    \param[in] src Input value in big endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on little endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+Real64 osgBigEndianToHost(Real64 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    UInt8 *p = reinterpret_cast<UInt8*>(&src);
+    
-    std::swap(p[0], p[7]);
-    std::swap(p[1], p[6]);
-    std::swap(p[2], p[5]);
-    std::swap(p[3], p[4]);
+    
+    return src;
+#else
+    return src;
+#endif
+}
-
+/*! Convert a Real64 from little endian byte order to host byte order.
+
+    \param[in] src Input value in little endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline 
+Real64 osgLittleEndianToHost(Real64 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
-    return src;
+#else
+    UInt8 *p = reinterpret_cast<UInt8*>(&src);
+    
+    std::swap(p[0], p[7]);
+    std::swap(p[1], p[6]);
+    std::swap(p[2], p[5]);
+    std::swap(p[3], p[4]);
+    
+    return src;
+#endif
-}
-
-network byte order to host
+host byte order to big endian
-
-    \param[in] src Input value in host byte order.
-network
+big endian
-
-
-
+
-
-    \ingroup GrpBaseBaseMiscFn
- */
-inline
-ntohdd
+HostToBigEndian
-{
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-
+/*! Convert a Real128 from host byte order to little endian byte order.
+
+    \param[in] src Input value in host byte order.
+    \return The input converted to little endian byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+Real128 osgHostToLittleEndian(Real128 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    return src;
+#else
+    UInt8 *p = reinterpret_cast<UInt8*>(&src);
+    
-    std::swap(p[0], p[15]);
-    std::swap(p[1], p[14]);
-    std::swap(p[2], p[13]);
@@ -1857 +2122 @@
-    std::swap(p[5], p[10]);
-    std::swap(p[6], p[9]);
-    std::swap(p[7], p[8]);
+    
+    return src;
+#endif
+}
-
+/*! Convert a Real128 from big endian byte order to host byte order.
+
+    \param[in] src Input value in big endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on little endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline
+Real128 osgBigEndianToHost(Real128 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    UInt8 *p = reinterpret_cast<UInt8*>(&src);
+    
+    std::swap(p[0], p[15]);
+    std::swap(p[1], p[14]);
+    std::swap(p[2], p[13]);
+    std::swap(p[3], p[12]);
+    std::swap(p[4], p[11]);
+    std::swap(p[5], p[10]);
+    std::swap(p[6], p[9]);
+    std::swap(p[7], p[8]);
+    
-    return src;
+#else
+    return src;
+#endif
-}
-
+/*! Convert a Real128 from little endian byte order to host byte order.
+
+    \param[in] src Input value in little endian byte order.
+    \return The input converted to host byte order.
+
+    \note An actual conversion only happens on big endian architectures.
+
+    \ingroup GrpBaseBaseMiscFn
+ */
+inline 
+Real128 osgLittleEndianToHost(Real128 src)
+{
+#if BYTE_ORDER == LITTLE_ENDIAN
+    return src;
-#else
+    UInt8 *p = reinterpret_cast<UInt8*>(&src);
+    
+    std::swap(p[0], p[15]);
+    std::swap(p[1], p[14]);
+    std::swap(p[2], p[13]);
+    std::swap(p[3], p[12]);
+    std::swap(p[4], p[11]);
+    std::swap(p[5], p[10]);
+    std::swap(p[6], p[9]);
+    std::swap(p[7], p[8]);
+    
+    return src;
+#endif
+}
-
-// host to network
-// perhaps we should use macros here ...
-
-/*! Convert a UInt16 from host byte order to network byte order.
-
-    \param[in] src Input value in host byte order.
@@ -1879 +2200 @@
-inline
-UInt16 osghtons(UInt16 src)
-{
-src
+osgHostToBigEndian(src)
-}
-
-/*! Convert a UInt32 from host byte order to network byte order.
@@ -1895 +2216 @@
-inline
-UInt32 osghtonl(UInt32 src)
-{
-src
+osgHostToBigEndian(src)
-}
-
-/*! Convert a UInt64 from host byte order to network byte order.
@@ -1911 +2232 @@
-inline
-UInt64 osghtonll(UInt64 src)
-{
-src
+osgHostToBigEndian(src)
-}
-
-/*! Convert a Real32 from host byte order to network byte order.
@@ -1927 +2248 @@
-inline
-Real32 osghtonf(Real32 src)
-{
-src
+osgHostToBigEndian(src)
-}
-
-/*! Convert a Real64 from host byte order to network byte order.
@@ -1943 +2264 @@
-inline
-Real64 osghtond(Real64 src)
-{
-src
+osgHostToBigEndian(src)
-}
-
-/*! Convert a Real128 from host byte order to network byte order.
@@ -1959 +2280 @@
-inline
-Real128 osghtondd(Real128 src)
-{
-src
+osgHostToBigEndian(src)
-}
-
-// network to host
-
-/*! Convert a UInt16 from network byte order to host byte order.
-
-    \param[in] src Input value in host byte order.
@@ -1977 +2296 @@
-inline
-UInt16 osgntohs(UInt16 src)
-{
-src
+osgBigEndianToHost(src)
-}
-
-/*! Convert a UInt32 from network byte order to host byte order.
@@ -1993 +2312 @@
-inline
-UInt32 osgntohl(UInt32 src)
-{
-src
+osgBigEndianToHost(src)
-}
-
-/*! Convert a UInt64 from network byte order to host byte order.
@@ -2009 +2328 @@
-inline
-UInt64 osgntohll(UInt64 src)
-{
-src
+osgBigEndianToHost(src)
-}
-
-/*! Convert a Real32 from network byte order to host byte order.
@@ -2025 +2344 @@
-inline
-Real32 osgntohf(Real32 src)
-{
-src
+osgBigEndianToHost(src)
-}
-
-/*! Convert a Real64 from network byte order to host byte order.
@@ -2041 +2360 @@
-inline
-Real64 osgntohd(Real64 src)
-{
-src
+osgBigEndianToHost(src)
-}
-
-/*! Convert a Real128 from network byte order to host byte order.
@@ -2057 +2376 @@
-inline
-Real128 osgntohdd(Real128 src)
-{
-src
+osgBigEndianToHost(src)
-}
-
-#endif
-
-/*! \}                                                                 */
-/*---------------------------------------------------------------------*/
-/*! \name C strings                                                    */