]> git.saurik.com Git - wxWidgets.git/blobdiff - include/wx/longlong.h
minor clean up
[wxWidgets.git] / include / wx / longlong.h
index cedac4f92b6b53cb3206213eec0cade5c6df613d..621abc3e3dd2f1c8799c7637732abe2fe903a0fe 100644 (file)
@@ -3,8 +3,6 @@
 // Purpose:     declaration of wxLongLong class - best implementation of a 64
 //              bit integer for the current platform.
 // Author:      Jeffrey C. Ollie <jeff@ollie.clive.ia.us>, Vadim Zeitlin
-// Remarks:     this class is not public in wxWindows 2.0! It is intentionally
-//              not documented and is for private use only.
 // Modified by:
 // Created:     10.02.99
 // RCS-ID:      $Id$
     #pragma interface "longlong.h"
 #endif
 
+#include "wx/defs.h"
+#include "wx/wxchar.h"
+
+#include <limits.h>     // for LONG_MAX
+
+// define this to compile wxLongLongWx in "test" mode: the results of all
+// calculations will be compared with the real results taken from
+// wxLongLongNative -- this is extremely useful to find the bugs in
+// wxLongLongWx class!
+
+// #define wxLONGLONG_TEST_MODE
+
+#ifdef wxLONGLONG_TEST_MODE
+    #define wxUSE_LONGLONG_WX 1
+    #define wxUSE_LONGLONG_NATIVE 1
+#endif // wxLONGLONG_TEST_MODE
+
 // ----------------------------------------------------------------------------
 // decide upon which class we will use
 // ----------------------------------------------------------------------------
 
 // to avoid compilation problems on 64bit machines with ambiguous method calls
-// we will need this
+// we will need to define this
 #undef wxLongLongIsLong
 
 // NB: we #define and not typedef wxLongLong_t because we want to be able to
-//     use 'unsigned wxLongLong_t' as well
+//     use 'unsigned wxLongLong_t' as well and because we use "#ifdef
+//     wxLongLong_t" below
 #if defined(SIZEOF_LONG) && (SIZEOF_LONG == 8)
     #define wxLongLong_t long
     #define wxLongLongIsLong
-#elif defined(__VISUALC__)
+#elif (defined(__VISUALC__) && defined(__WIN32__)) || defined( __VMS__ )
+    #define wxLongLong_t __int64
+#elif defined(__BORLANDC__) && defined(__WIN32__) && (__BORLANDC__ >= 0x520)
     #define wxLongLong_t __int64
-#elif defined(__GNUG__)
+#elif defined(__GNUG__) || defined(__sgi)
     #define wxLongLong_t long long
 #elif defined(__MWERKS__)
     #if __option(longlong)
         #error "The 64 bit integer support in CodeWarrior has been disabled."
         #error "See the documentation on the 'longlong' pragma."
     #endif
-#else
-    #warning "Your compiler does not appear to support 64 bit integers, "\
-             "using emulation class instead."
+#elif defined(__VISAGECPP__) && __IBMCPP__ >= 400
+        #define wxLongLong_t long long
+#else // no native long long type
+    // both warning and pragma warning are not portable, but at least an
+    // unknown pragma should never be an error - except that, actually, some
+    // broken compilers don't like it, so we have to disable it in this case
+    // <sigh>
+#if !(defined(__WATCOMC__) || defined(__VISAGECPP__))
+    #pragma warning "Your compiler does not appear to support 64 bit "\
+                    "integers, using emulation class instead.\n" \
+                    "Please report your compiler version to " \
+                    "wx-dev@lists.wxwindows.org!"
+#endif
     #define wxUSE_LONGLONG_WX 1
 #endif // compiler
 
 // the user may predefine wxUSE_LONGLONG_NATIVE and/or wxUSE_LONGLONG_NATIVE
 // to disable automatic testing (useful for the test program which defines
 // both classes) but by default we only use one class
-#ifndef wxLongLong_t
-    #undef wxUSE_LONGLONG_NATIVE
-    #define wxUSE_LONGLONG_NATIVE 0
+#if (defined(wxUSE_LONGLONG_WX) && wxUSE_LONGLONG_WX) || !defined(wxLongLong_t)
+    // don't use both classes unless wxUSE_LONGLONG_NATIVE was explicitly set:
+    // this is useful in test programs and only there
+    #ifndef wxUSE_LONGLONG_NATIVE
+        #define wxUSE_LONGLONG_NATIVE 0
+    #endif
+
     class WXDLLEXPORT wxLongLongWx;
+#if defined(__VISUALC__) && !defined(__WIN32__)
+    #define wxLongLong wxLongLongWx
+#else
     typedef wxLongLongWx wxLongLong;
+#endif
+
 #else
     // if nothing is defined, use native implementation by default, of course
     #ifndef wxUSE_LONGLONG_NATIVE
@@ -98,7 +135,7 @@ public:
         m_ll |= (wxLongLong_t) lo;
     }
 
-    // default copy ctor is ok in both cases
+    // default copy ctor is ok
 
     // no dtor
 
@@ -107,22 +144,40 @@ public:
     wxLongLongNative& operator=(wxLongLong_t ll)
         { m_ll = ll; return *this; }
 
+        // from double: this one has an explicit name because otherwise we
+        // would have ambiguity with "ll = int" and also because we don't want
+        // to have implicit conversions between doubles and wxLongLongs
+    wxLongLongNative& Assign(double d)
+        { m_ll = (wxLongLong_t)d; return *this; }
+
     // assignment operators from wxLongLongNative is ok
 
     // accessors
         // get high part
     long GetHi() const
-        { return (long)((m_ll & 0xFFFFFFFF00000000l) >> 32); }
+        { return (long)(m_ll >> 32); }
         // get low part
     unsigned long GetLo() const
-        { return (unsigned long) (m_ll & 0x00000000FFFFFFFFl); }
+        { return (unsigned long)m_ll; }
 
         // get absolute value
+    wxLongLongNative Abs() const { return wxLongLongNative(*this).Abs(); }
     wxLongLongNative& Abs() { if ( m_ll < 0 ) m_ll = -m_ll; return *this; }
 
         // convert to native long long
     wxLongLong_t GetValue() const { return m_ll; }
 
+        // convert to long with range checking in the debug mode (only!)
+    long ToLong() const
+    {
+        wxASSERT_MSG( (m_ll >= LONG_MIN) && (m_ll <= LONG_MAX),
+                      _T("wxLongLong to long conversion loss of precision") );
+
+        return (long)m_ll;
+    }
+
+    // don't provide implicit conversion to wxLongLong_t or we will have an
+    // ambiguity for all arithmetic operations
     //operator wxLongLong_t() const { return m_ll; }
 
     // operations
@@ -200,8 +255,12 @@ public:
     // multiplication/division
     wxLongLongNative operator*(const wxLongLongNative& ll) const
         { return wxLongLongNative(m_ll * ll.m_ll); }
+    wxLongLongNative operator*(long l) const
+        { return wxLongLongNative(m_ll * l); }
     wxLongLongNative& operator*=(const wxLongLongNative& ll)
         { m_ll *= ll.m_ll; return *this; }
+    wxLongLongNative& operator*=(long l)
+        { m_ll *= l; return *this; }
 
     wxLongLongNative operator/(const wxLongLongNative& ll) const
         { return wxLongLongNative(m_ll / ll.m_ll); }
@@ -209,6 +268,8 @@ public:
         { return wxLongLongNative(m_ll / l); }
     wxLongLongNative& operator/=(const wxLongLongNative& ll)
         { m_ll /= ll.m_ll; return *this; }
+    wxLongLongNative& operator/=(long l)
+        { m_ll /= l; return *this; }
 
     wxLongLongNative operator%(const wxLongLongNative& ll) const
         { return wxLongLongNative(m_ll % ll.m_ll); }
@@ -245,8 +306,10 @@ public:
         // conversion to byte array: returns a pointer to static buffer!
     void *asArray() const;
 
+#if wxUSE_STD_IOSTREAM
         // input/output
-    friend ostream& operator<<(ostream&, const wxLongLongNative&);
+    friend wxSTD ostream& operator<<(wxSTD ostream&, const wxLongLongNative&);
+#endif
 
 private:
     wxLongLong_t  m_ll;
@@ -261,13 +324,32 @@ class WXDLLEXPORT wxLongLongWx
 public:
     // ctors
         // default ctor initializes to 0
-    wxLongLongWx() { m_lo = m_hi = 0; }
+    wxLongLongWx()
+    {
+        m_lo = m_hi = 0;
+
+#ifdef wxLONGLONG_TEST_MODE
+        m_ll = 0;
+
+        Check();
+#endif // wxLONGLONG_TEST_MODE
+    }
         // from long
-    wxLongLongWx(long l)
-        { m_lo = l; m_hi = (l < 0 ? -1l : 0l); }
+    wxLongLongWx(long l) { *this = l; }
         // from 2 longs
     wxLongLongWx(long hi, unsigned long lo)
-        { m_hi = hi; m_lo = lo; }
+    {
+        m_hi = hi;
+        m_lo = lo;
+
+#ifdef wxLONGLONG_TEST_MODE
+        m_ll = hi;
+        m_ll <<= 32;
+        m_ll |= lo;
+
+        Check();
+#endif // wxLONGLONG_TEST_MODE
+    }
 
     // default copy ctor is ok in both cases
 
@@ -276,7 +358,20 @@ public:
     // assignment operators
         // from long
     wxLongLongWx& operator=(long l)
-        { m_lo = l; m_hi = (l < 0 ? -1l : 0l); return *this; }
+    {
+        m_lo = l;
+        m_hi = (l < 0 ? -1l : 0l);
+
+#ifdef wxLONGLONG_TEST_MODE
+        m_ll = l;
+
+        Check();
+#endif // wxLONGLONG_TEST_MODE
+
+        return *this;
+    }
+        // from double
+    wxLongLongWx& Assign(double d);
         // can't have assignment operator from 2 longs
 
     // accessors
@@ -285,6 +380,32 @@ public:
         // get low part
     unsigned long GetLo() const { return m_lo; }
 
+        // get absolute value
+    wxLongLongWx Abs() const { return wxLongLongWx(*this).Abs(); }
+    wxLongLongWx& Abs()
+    {
+        if ( m_hi < 0 )
+            m_hi = -m_hi;
+
+#ifdef wxLONGLONG_TEST_MODE
+        if ( m_ll < 0 )
+            m_ll = -m_ll;
+
+        Check();
+#endif // wxLONGLONG_TEST_MODE
+
+        return *this;
+    }
+
+        // convert to long with range checking in the debug mode (only!)
+    long ToLong() const
+    {
+        wxASSERT_MSG( (m_hi == 0l) || (m_hi == -1l),
+                      _T("wxLongLong to long conversion loss of precision") );
+
+        return (long)m_lo;
+    }
+
     // operations
         // addition
     wxLongLongWx operator+(const wxLongLongWx& ll) const;
@@ -296,10 +417,11 @@ public:
     wxLongLongWx& operator++();
 
         // post increment operator
-    wxLongLongWx& operator++(int);
+    wxLongLongWx& operator++(int) { return ++(*this); }
 
         // negation operator
     wxLongLongWx operator-() const;
+    wxLongLongWx& Negate();
 
         // subraction
     wxLongLongWx operator-(const wxLongLongWx& ll) const;
@@ -309,7 +431,7 @@ public:
     wxLongLongWx& operator--();
 
         // post decrement operator
-    wxLongLongWx& operator--(int);
+    wxLongLongWx& operator--(int) { return --(*this); }
 
     // shifts
         // left shift
@@ -330,33 +452,79 @@ public:
     wxLongLongWx operator~() const;
 
     // comparison
-    bool operator==(const wxLongLongWx& ll) const;
-    bool operator!=(const wxLongLongWx& ll) const;
+    bool operator==(const wxLongLongWx& ll) const
+        { return m_lo == ll.m_lo && m_hi == ll.m_hi; }
+    bool operator!=(const wxLongLongWx& ll) const
+        { return !(*this == ll); }
     bool operator<(const wxLongLongWx& ll) const;
     bool operator>(const wxLongLongWx& ll) const;
-    bool operator<=(const wxLongLongWx& ll) const;
-    bool operator>=(const wxLongLongWx& ll) const;
+    bool operator<=(const wxLongLongWx& ll) const
+        { return *this < ll || *this == ll; }
+    bool operator>=(const wxLongLongWx& ll) const
+        { return *this > ll || *this == ll; }
+
+    bool operator<(long l) const { return *this < wxLongLongWx(l); }
+    bool operator>(long l) const { return *this > wxLongLongWx(l); }
+    bool operator==(long l) const
+    {
+        return l >= 0 ? (m_hi == 0 && m_lo == (unsigned long)l)
+                      : (m_hi == -1 && m_lo == (unsigned long)l);
+    }
+
+    bool operator<=(long l) const { return *this < l || *this == l; }
+    bool operator>=(long l) const { return *this > l || *this == l; }
 
     // multiplication
     wxLongLongWx operator*(const wxLongLongWx& ll) const;
     wxLongLongWx& operator*=(const wxLongLongWx& ll);
-    void *asArray(void) const;
 
     // division
+    wxLongLongWx operator/(const wxLongLongWx& ll) const;
+    wxLongLongWx& operator/=(const wxLongLongWx& ll);
+
+    wxLongLongWx operator%(const wxLongLongWx& ll) const;
+
     void Divide(const wxLongLongWx& divisor,
                 wxLongLongWx& quotient,
                 wxLongLongWx& remainder) const;
 
     // input/output
-    friend ostream& operator<<(ostream&, const wxLongLongWx&);
+#if wxUSE_STD_IOSTREAM
+    friend wxSTD ostream& operator<<(wxSTD ostream&, const wxLongLongWx&);
+#endif // wxUSE_STD_IOSTREAM
+
+    void *asArray() const;
 
 private:
     // long is at least 32 bits, so represent our 64bit number as 2 longs
 
     long m_hi;                // signed bit is in the high part
     unsigned long m_lo;
+
+#ifdef wxLONGLONG_TEST_MODE
+    void Check()
+    {
+        wxASSERT( (m_ll >> 32) == m_hi && (unsigned long)m_ll == m_lo );
+    }
+
+    wxLongLong_t m_ll;
+#endif // wxLONGLONG_TEST_MODE
 };
 
 #endif // wxUSE_LONGLONG_WX
 
+// ----------------------------------------------------------------------------
+// binary operators
+// ----------------------------------------------------------------------------
+
+inline bool operator<(long l, const wxLongLong& ll) { return ll > l; }
+inline bool operator>(long l, const wxLongLong& ll) { return ll > l; }
+inline bool operator<=(long l, const wxLongLong& ll) { return ll > l; }
+inline bool operator>=(long l, const wxLongLong& ll) { return ll > l; }
+inline bool operator==(long l, const wxLongLong& ll) { return ll > l; }
+inline bool operator!=(long l, const wxLongLong& ll) { return ll > l; }
+
+inline wxLongLong operator+(long l, const wxLongLong& ll) { return ll + l; }
+inline wxLongLong operator-(long l, const wxLongLong& ll) { return ll - l; }
+
 #endif // _WX_LONGLONG_H