summaryrefslogtreecommitdiff
path: root/zen/int64.h
blob: f658e03475ecbf82749a8b40010bb0ac27ac71c2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
// **************************************************************************
// * This file is part of the FreeFileSync project. It is distributed under *
// * GNU General Public License: http://www.gnu.org/licenses/gpl.html       *
// * Copyright (C) Zenju (zenju AT gmx DOT de) - All Rights Reserved        *
// **************************************************************************

#ifndef FFS_LARGE_64_BIT_INTEGER_H_INCLUDED
#define FFS_LARGE_64_BIT_INTEGER_H_INCLUDED

#include <cassert>
#include <limits>
#include <cstdint>
#include <cstdint>
#include <ostream>
#include "assert_static.h"
#include "type_tools.h"

#ifdef ZEN_WIN
#include "win.h"
#endif


/*
zen::Int64/zen::UInt64: wrapper classes around std::int64_t/std::uint64_t

    - default initialization with 0
    - debug runtime overflow/underflow checks
    - safe and explicit semantics: no unsafe type conversions
    - safe conversion to and from Windows 64-bit integers
    - specializes std::numeric_limits
    - support stream operator<< and operator>>
*/

namespace zen
{
template <class T, class U> inline
void checkRange(U value)
{
    //caveat: std::numeric_limits<T>::min returns minimum positive(!) number for T = double, while behaving correctly for integer types... sigh
    assert(double(std::numeric_limits<T>::lowest()) <= double(value) && //new with C++11!
           double(std::numeric_limits<T>::max()   ) >= double(value));
}

class Int64
{
public:
    //safe implicit conversions
    Int64()                 : value(0) {}
    Int64(const Int64& rhs) : value(rhs.value) {}
    template <class T>
    Int64(T rhs, typename EnableIf<IsSignedInt<T>::value&&  sizeof(T) <= sizeof(std::int64_t)>::Type* = nullptr) :
        value(static_cast<std::int64_t>(rhs)) {}

    //unsafe explicit but checked conversion for all other integer types
    template <class T> explicit Int64(T rhs, typename EnableIf<!(IsSignedInt<T>::value&&  sizeof(T) <= sizeof(std::int64_t))>::Type* = nullptr) :
        value(static_cast<std::int64_t>(rhs)) { checkRange<std::int64_t>(rhs); }

    Int64& operator=(const Int64& rhs) { value = rhs.value; return *this; }

#ifdef ZEN_WIN
    Int64(DWORD low, LONG high)
    {
        assert_static(sizeof(low) + sizeof(high) == sizeof(value));

        LARGE_INTEGER cvt = {};
        cvt.LowPart  = low;
        cvt.HighPart = high;
        value = cvt.QuadPart;
    }
    LONG getHi() const
    {
        LARGE_INTEGER cvt = {};
        cvt.QuadPart = value;
        return cvt.HighPart;
    }
    DWORD getLo() const
    {
        LARGE_INTEGER cvt = {};
        cvt.QuadPart = value;
        return cvt.LowPart;
    }
#endif

    Int64& operator+=(const Int64& rhs) { checkRange<std::int64_t>(double(value) + rhs.value); value += rhs.value; return *this; }
    Int64& operator-=(const Int64& rhs) { checkRange<std::int64_t>(double(value) - rhs.value); value -= rhs.value; return *this; }
    Int64& operator*=(const Int64& rhs) { checkRange<std::int64_t>(double(value) * rhs.value); value *= rhs.value; return *this; }
    Int64& operator/=(const Int64& rhs) { assert(rhs.value != 0);                              value /= rhs.value; return *this; }
    Int64& operator%=(const Int64& rhs) { assert(rhs.value != 0);                              value %= rhs.value; return *this; }
    Int64& operator&=(const Int64& rhs) {                                                      value &= rhs.value; return *this;}
    Int64& operator|=(const Int64& rhs) {                                                      value |= rhs.value; return *this;}
    Int64& operator<<=(int rhs) { assert(rhs < 0 || (value << rhs) >> rhs == value);           value <<= rhs; return *this; }
    Int64& operator>>=(int rhs) { assert(rhs > 0 || (value >> rhs) << rhs == value);           value >>= rhs; return *this; }
    Int64  operator-() const { return -value; }

    inline friend bool operator==(const Int64& lhs, const Int64& rhs) { return lhs.value == rhs.value; }
    inline friend bool operator!=(const Int64& lhs, const Int64& rhs) { return lhs.value != rhs.value; }
    inline friend bool operator< (const Int64& lhs, const Int64& rhs) { return lhs.value <  rhs.value; }
    inline friend bool operator> (const Int64& lhs, const Int64& rhs) { return lhs.value >  rhs.value; }
    inline friend bool operator<=(const Int64& lhs, const Int64& rhs) { return lhs.value <= rhs.value; }
    inline friend bool operator>=(const Int64& lhs, const Int64& rhs) { return lhs.value >= rhs.value; }

    //checked conversion to arbitrary target integer type
    template <class T> inline friend T to(Int64 number) { checkRange<T>(number.value); return static_cast<T>(number.value); }

    template <class T> inline friend std::basic_istream<T>& operator>>(std::basic_istream<T>& lhs, Int64& rhs) { lhs >> rhs.value; return lhs; }
    template <class T> inline friend std::basic_ostream<T>& operator<<(std::basic_ostream<T>& lhs, const Int64& rhs) { lhs << rhs.value; return lhs; }

private:
    std::int64_t value;
};

inline Int64 operator+ (const Int64& lhs, const Int64& rhs) { return Int64(lhs) += rhs; }
inline Int64 operator- (const Int64& lhs, const Int64& rhs) { return Int64(lhs) -= rhs; }
inline Int64 operator* (const Int64& lhs, const Int64& rhs) { return Int64(lhs) *= rhs; }
inline Int64 operator/ (const Int64& lhs, const Int64& rhs) { return Int64(lhs) /= rhs; }
inline Int64 operator% (const Int64& lhs, const Int64& rhs) { return Int64(lhs) %= rhs; }
inline Int64 operator& (const Int64& lhs, const Int64& rhs) { return Int64(lhs) &= rhs; }
inline Int64 operator| (const Int64& lhs, const Int64& rhs) { return Int64(lhs) |= rhs; }
inline Int64 operator<<(const Int64& lhs, int rhs) { return Int64(lhs) <<= rhs; }
inline Int64 operator>>(const Int64& lhs, int rhs) { return Int64(lhs) >>= rhs; }


class UInt64
{
public:
    //safe implicit conversions
    UInt64()                  : value(0) {}
    UInt64(const UInt64& rhs) : value(rhs.value) {}
    template <class T>
    UInt64(T rhs, typename EnableIf<IsUnsignedInt<T>::value&&  sizeof(T) <= sizeof(std::uint64_t)>::Type* = nullptr) :
        value(static_cast<std::uint64_t>(rhs)) {}

    //unsafe explicit but checked conversion for all other integer types
    template <class T> explicit UInt64(T rhs, typename EnableIf<!(IsUnsignedInt<T>::value&&  sizeof(T) <= sizeof(std::uint64_t))>::Type* = nullptr) :
        value(static_cast<std::uint64_t>(rhs)) { checkRange<std::uint64_t>(rhs); }

    UInt64& operator=(const UInt64& rhs) { value = rhs.value; return *this; }

#ifdef ZEN_WIN
    UInt64(DWORD low, DWORD high)
    {
        assert_static(sizeof(low) + sizeof(high) == sizeof(value));

        ULARGE_INTEGER cvt = {};
        cvt.LowPart  = low;
        cvt.HighPart = high;
        value = cvt.QuadPart;
    }
    DWORD getHi() const
    {
        ULARGE_INTEGER cvt = {};
        cvt.QuadPart = value;
        return cvt.HighPart;
    }
    DWORD getLo() const
    {
        ULARGE_INTEGER cvt = {};
        cvt.QuadPart = value;
        return cvt.LowPart;
    }
#endif

    UInt64& operator+=(const UInt64& rhs) { checkRange<std::uint64_t>(double(value) + rhs.value); value += rhs.value; return *this; }
    UInt64& operator-=(const UInt64& rhs) { checkRange<std::uint64_t>(double(value) - rhs.value); value -= rhs.value; return *this; }
    UInt64& operator*=(const UInt64& rhs) { checkRange<std::uint64_t>(double(value) * rhs.value); value *= rhs.value; return *this; }
    UInt64& operator/=(const UInt64& rhs) { assert(rhs.value != 0);                                 value /= rhs.value; return *this; }
    UInt64& operator%=(const UInt64& rhs) { assert(rhs.value != 0);                                 value %= rhs.value; return *this; }
    UInt64& operator&=(const UInt64& rhs) {                                                         value &= rhs.value; return *this;}
    UInt64& operator|=(const UInt64& rhs) {                                                         value |= rhs.value; return *this;}
    UInt64& operator<<=(int rhs) { assert(rhs < 0 || (value << rhs) >> rhs == value);               value <<= rhs; return *this; }
    UInt64& operator>>=(int rhs) { assert(rhs > 0 || (value >> rhs) << rhs == value);               value >>= rhs; return *this; }

    inline friend bool operator==(const UInt64& lhs, const UInt64& rhs) { return lhs.value == rhs.value; }
    inline friend bool operator!=(const UInt64& lhs, const UInt64& rhs) { return lhs.value != rhs.value; }
    inline friend bool operator< (const UInt64& lhs, const UInt64& rhs) { return lhs.value <  rhs.value; }
    inline friend bool operator> (const UInt64& lhs, const UInt64& rhs) { return lhs.value >  rhs.value; }
    inline friend bool operator<=(const UInt64& lhs, const UInt64& rhs) { return lhs.value <= rhs.value; }
    inline friend bool operator>=(const UInt64& lhs, const UInt64& rhs) { return lhs.value >= rhs.value; }

    //checked conversion to arbitrary target integer type
    template <class T> friend T to(UInt64 number);

    template <class T> inline friend std::basic_istream<T>& operator>>(std::basic_istream<T>& lhs, UInt64& rhs) { lhs >> rhs.value; return lhs; }
    template <class T> inline friend std::basic_ostream<T>& operator<<(std::basic_ostream<T>& lhs, const UInt64& rhs) { lhs << rhs.value; return lhs; }

private:
    std::uint64_t value;
};

template <class T> inline T to(UInt64 number) { checkRange<T>(number.value); return static_cast<T>(number.value); } //Clang 3.2 doesn't properly handle inline-friends defined in class definition

inline UInt64 operator+ (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) += rhs; }
inline UInt64 operator- (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) -= rhs; }
inline UInt64 operator* (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) *= rhs; }
inline UInt64 operator/ (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) /= rhs; }
inline UInt64 operator% (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) %= rhs; }
inline UInt64 operator& (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) &= rhs; }
inline UInt64 operator| (const UInt64& lhs, const UInt64& rhs) { return UInt64(lhs) |= rhs; }
inline UInt64 operator<<(const UInt64& lhs, int rhs) { return UInt64(lhs) <<= rhs; }
inline UInt64 operator>>(const UInt64& lhs, int rhs) { return UInt64(lhs) >>= rhs; }

template <> inline UInt64 to(Int64 number) { checkRange<std::uint64_t>(number.value); return UInt64(number.value); }
template <> inline Int64 to(UInt64 number) { checkRange<std:: int64_t>(number.value); return  Int64(number.value); }


#ifdef ZEN_WIN
//convert FILETIME (number of 100-nanosecond intervals since January 1, 1601 UTC)
//       to time_t (number of seconds since Jan. 1st 1970 UTC)
//
//FAT32 time is preserved exactly: FAT32 -> toTimeT -> tofiletime -> FAT32
inline
Int64 toTimeT(const FILETIME& ft)
{
    return to<Int64>(UInt64(ft.dwLowDateTime, ft.dwHighDateTime) / 10000000U) - Int64(3054539008UL, 2);
    //timeshift between ansi C time and FILETIME in seconds == 11644473600s
}

inline
FILETIME toFileTime(const Int64& utcTime)
{
    const UInt64 fileTimeLong = to<UInt64>(utcTime + Int64(3054539008UL, 2)) * 10000000U;
    const FILETIME output = { fileTimeLong.getLo(), fileTimeLong.getHi() };
    return output;
}
#endif
}

//specialize numeric limits
namespace std
{
assert_static(std::numeric_limits<std:: int64_t>::is_specialized);
assert_static(std::numeric_limits<std::uint64_t>::is_specialized);

template <> class numeric_limits<zen::Int64>  : public numeric_limits<std::int64_t>
{
public:
    static zen::Int64 min() throw() { return numeric_limits<std::int64_t>::min(); }
    static zen::Int64 max() throw() { return numeric_limits<std::int64_t>::max(); }
};

template <> class numeric_limits<zen::UInt64> : public numeric_limits<std::uint64_t>
{
public:
    static zen::UInt64 min() throw() { return numeric_limits<std::uint64_t>::min(); }
    static zen::UInt64 max() throw() { return numeric_limits<std::uint64_t>::max(); }
};
}

/*
//specialize zen type trait
namespace zen -> we cannot mix signed/unsigned in general arithmetic operations -> we'll use the ostream-approach
{
template <> struct IsUnsignedInt<UInt64> : StaticBool<true> {};
template <> struct IsSignedInt  <Int64>  : StaticBool<true> {};
}
*/
#endif //FFS_LARGE_64_BIT_INTEGER_H_INCLUDED
bgstack15