gecko-dev/xpcom/ds/nsInt64.h

/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * 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 Original Code is mozilla.org code.
 *
 * The Initial Developer of the Original Code is
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either of the GNU General Public License Version 2 or later (the "GPL"),
 * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#ifndef nsInt64_h__
#define nsInt64_h__

#include "prlong.h"
#include "nscore.h"

/**
 * This class encapsulates full 64-bit integer functionality and
 * provides simple arithmetic and conversion operations.
 */

// If you ever decide that you need to add a non-inline method to this
// class, be sure to change the class declaration to "class NS_BASE
// nsInt64".

template<class T>
class nsTInt64
{
public: //XXX should be private
    T mValue;

public:
    /**
     * Construct a new 64-bit integer.
     */
    nsTInt64(void) : mValue(LL_ZERO) {
    }

    /**
     * Construct a new 64-bit integer from a 32-bit signed integer
     */
    nsTInt64(const PRInt32 aInt32) {
        LL_I2L(mValue, aInt32);
    }

    /**
     * Construct a new 64-bit integer from a 32-bit unsigned integer
     */
    nsTInt64(const PRUint32 aUint32) {
        LL_UI2L(mValue, aUint32);
    }

    /**
     * Construct a new 64-bit integer from a floating point value.
     */
    nsTInt64(const PRFloat64 aFloat64) {
        LL_D2L(mValue, aFloat64);
    }

    /**
     * Construct a new 64-bit integer from a native 64-bit integer
     */
    nsTInt64(const T aInt64) : mValue(aInt64) {
    }

    /**
     * Construct a new 64-bit integer from another 64-bit integer
     */
    nsTInt64(const nsTInt64& aObject) : mValue(aObject.mValue) {
    }

    // ~nsTInt64(void) -- XXX destructor unnecessary

    /**
     * Assign a 64-bit integer to another 64-bit integer
     */
    const nsTInt64& operator =(const nsTInt64& aObject) {
        mValue = aObject.mValue;
        return *this;
    }

    /**
     * Convert a 64-bit integer to a signed 32-bit value
     */
    operator PRInt32(void) const {
        PRInt32 result;
        LL_L2I(result, mValue);
        return result;
    }

    /**
     * Convert a 64-bit integer to an unsigned 32-bit value
     */
    operator PRUint32(void) const {
        PRUint32 result;
        LL_L2UI(result, mValue);
        return result;
    }

    /**
     * Convert a 64-bit integer to a floating point value
     */
    operator PRFloat64(void) const {
        PRFloat64 result;
        LL_L2D(result, mValue);
        return result;
    }

    /**
     * Convert a 64-bit integer to a native 64-bit integer.
     */
    operator T() const {
        return mValue;
    }

    /**
     * Perform unary negation on a 64-bit integer.
     */
    const nsTInt64 operator -(void) {
        nsTInt64 result;
        LL_NEG(result.mValue, mValue);
        return result;
    }

    // Arithmetic operators

    /**
     * Increment a 64-bit integer by a 64-bit integer amount.
     */
    nsTInt64& operator +=(const nsTInt64& aObject) {
        LL_ADD(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Decrement a 64-bit integer by a 64-bit integer amount.
     */
    nsTInt64& operator -=(const nsTInt64& aObject) {
        LL_SUB(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Multiply a 64-bit integer by a 64-bit integer amount.
     */
    nsTInt64& operator *=(const nsTInt64& aObject) {
        LL_MUL(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Divide a 64-bit integer by a 64-bit integer amount.
     */
    nsTInt64& operator /=(const nsTInt64& aObject) {
        LL_DIV(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Compute the modulus of a 64-bit integer to a 64-bit value.
     */
    nsTInt64& operator %=(const nsTInt64& aObject) {
        LL_MOD(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Shift a 64-bit integer left.
     */
    nsTInt64& operator <<=(int aCount) {
        LL_SHL(mValue, mValue, aCount);
        return *this;
    }

    /**
     * Shift a 64-bit signed integer right.
     */
    nsTInt64& operator >>=(int aCount) {
        LL_SHR(mValue, mValue, aCount);
        return *this;
    }

    // Comparison operators
    /**
     * Add two 64-bit integers.
     */
    inline const nsTInt64
    operator +(const nsTInt64& aObject2) const {
        return nsTInt64(*this) += aObject2;
    }

    /**
     * Subtract one 64-bit integer from another.
     */
    inline const nsTInt64
    operator -(const nsTInt64& aObject2) const {
        return nsTInt64(*this) -= aObject2;
    }

    /**
     * Multiply two 64-bit integers
     */
    inline const nsTInt64
    operator *(const nsTInt64& aObject2) const {
        return nsTInt64(*this) *= aObject2;
    }

    /**
     * Divide one 64-bit integer by another
     */
    inline const nsTInt64
    operator /(const nsTInt64& aObject2) const {
        return nsTInt64(*this) /= aObject2;
    }

    /**
     * Compute the modulus of two 64-bit integers
     */
    inline const nsTInt64
    operator %(const nsTInt64& aObject2) const {
        return nsTInt64(*this) %= aObject2;
    }

    /**
     * Shift left a 64-bit integer
     */
    inline const nsTInt64
    operator <<(int aCount) const {
        return nsTInt64(*this) <<= aCount;
    }

    /**
     * Shift right a signed 64-bit integer
     */
    inline const nsTInt64
    operator >>(int aCount) const {
        return nsTInt64(*this) >>= aCount;
    }

    /**
     * Determine if two 64-bit integers are equal
     */
    inline PRBool
    operator ==(const nsTInt64& aObject2) const {
        return LL_EQ(mValue, aObject2.mValue);
    }

    inline PRBool
    operator ==(T aValue) const {
        return LL_EQ(mValue, aValue);
    }

    /**
     * Determine if two 64-bit integers are not equal
     */
    inline PRBool
    operator !=(const nsTInt64& aObject2) const {
        return LL_NE(mValue, aObject2.mValue);
    }

    inline PRBool
    operator !=(T aValue) const {
        return LL_NE(mValue, aValue);
    }

    /**
     * Perform a bitwise AND of two 64-bit integers
     */
    inline const nsTInt64
    operator &(const nsTInt64& aObject2) const {
        return nsTInt64(*this) &= aObject2;
    }

    /**
     * Perform a bitwise OR of two 64-bit integers
     */
    inline const nsTInt64
    operator |(const nsTInt64& aObject2) const {
        return nsTInt64(*this) |= aObject2;
    }

    /**
     * Perform a bitwise XOR of two 64-bit integers
     */
    inline const nsTInt64
    operator ^(const nsTInt64& aObject2) const {
        return nsTInt64(*this) ^= aObject2;
    }

    // Bitwise operators

    /**
     * Compute the bitwise NOT of a 64-bit integer
     */
    const nsTInt64 operator ~(void) const {
        nsTInt64 result;
        LL_NOT(result.mValue, mValue);
        return result;
    }

    /**
     * Compute the bitwise AND with another 64-bit integer
     */
    nsTInt64& operator &=(const nsTInt64& aObject) {
        LL_AND(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Compute the bitwise OR with another 64-bit integer
     */
    nsTInt64& operator |=(const nsTInt64& aObject) {
        LL_OR(mValue, mValue, aObject.mValue);
        return *this;
    }

    /**
     * Compute the bitwise XOR with another 64-bit integer
     */
    nsTInt64& operator ^=(const nsTInt64& aObject) {
        LL_XOR(mValue, mValue, aObject.mValue);
        return *this;
    }


    /**
     * Allow doing if (!some_nsInt64)
     */
    PRBool operator!() const {
        return LL_IS_ZERO(mValue);
    }
    
};

typedef nsTInt64<PRInt64> nsInt64;
typedef nsTInt64<PRUint64> nsUint64;

/**
 * Determine if one 64-bit integer is strictly greater than another, using signed values
 */
inline PRBool
operator >(const nsInt64& aObject1, const nsInt64& aObject2) {
    return LL_CMP(aObject1.mValue, >, aObject2.mValue);
}

inline PRBool
operator >(const nsUint64& aObject1, const nsUint64& aObject2) {
    return LL_UCMP(aObject1.mValue, >, aObject2.mValue);
}

/**
 * Determine if one 64-bit integer is greater than or equal to another, using signed values
 */
inline PRBool
operator >=(const nsInt64& aObject1, const nsInt64& aObject2) {
    return ! LL_CMP(aObject1.mValue, <, aObject2.mValue);
}

inline PRBool
operator >=(const nsUint64& aObject1, const nsUint64& aObject2) {
    return ! LL_UCMP(aObject1.mValue, <, aObject2.mValue);
}

/**
 * Determine if one 64-bit integer is strictly less than another, using signed values
 */
inline PRBool 
operator <(const nsInt64& aObject1, const nsInt64& aObject2) {
    return LL_CMP(aObject1.mValue, <, aObject2.mValue);
}

inline PRBool 
operator <(const nsUint64& aObject1, const nsUint64& aObject2) {
    return LL_UCMP(aObject1.mValue, <, aObject2.mValue);
}

/**
 * Determine if one 64-bit integers is less than or equal to another, using signed values
 */
inline PRBool
operator <=(const nsInt64& aObject1, const nsInt64& aObject2) {
    return ! LL_CMP(aObject1.mValue, >, aObject2.mValue);
}

inline PRBool
operator <=(const nsUint64& aObject1, const nsUint64& aObject2) {
    return ! LL_UCMP(aObject1.mValue, >, aObject2.mValue);
}

#endif // nsInt64_h__