mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-04-04 18:06:22 +03:00
2b2be3fb82
0030551: Foundation Classes - Integer overflow in NCollection_CellFilter HashCode Signed integers are not used in hash code functions now to prevent undefined behavior on left shift operations with signed integers. A possibility of negative values of hash codes is eliminated. INT_MAX → IntegerLast() in hash code functions. All found hash code functions behaves uniformly now: they return a value in the range [1, theUpperBound]. Relevant comments are added to such functions.
89 lines
3.4 KiB
C++
89 lines
3.4 KiB
C++
// Created by: Eugene Maltchikov
|
|
// Copyright (c) 1999-2014 OPEN CASCADE SAS
|
|
//
|
|
// This file is part of Open CASCADE Technology software library.
|
|
//
|
|
// This library is free software; you can redistribute it and/or modify it under
|
|
// the terms of the GNU Lesser General Public License version 2.1 as published
|
|
// by the Free Software Foundation, with special exception defined in the file
|
|
// OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
|
|
// distribution for complete text of the license and disclaimer of any warranty.
|
|
//
|
|
// Alternatively, this file may be used under the terms of Open CASCADE
|
|
// commercial license or contractual agreement.
|
|
|
|
#ifndef NCollection_DefaultHasher_HeaderFile
|
|
#define NCollection_DefaultHasher_HeaderFile
|
|
|
|
#include <Standard_Integer.hxx>
|
|
#include <Standard_Boolean.hxx>
|
|
|
|
//=======================================================================
|
|
//function : HashCode_Proxy
|
|
//purpose : Function is required to call the global function HashCode.
|
|
//=======================================================================
|
|
|
|
//! Returns hash code for the given key, in the range [1, theUpperBound]
|
|
//! @tparam TheKeyType the type of the given key
|
|
//! @param theKey the key which hash code is to be computed
|
|
//! @param theUpperBound the upper bound of the range a computing hash code must be within
|
|
//! @return a computed hash code, in the range [1, theUpperBound]
|
|
template <class TheKeyType>
|
|
inline Standard_Integer HashCode_Proxy (const TheKeyType& theKey, const Standard_Integer theUpperBound)
|
|
{
|
|
return HashCode (theKey, theUpperBound);
|
|
}
|
|
|
|
//=======================================================================
|
|
//function : IsEqual
|
|
//purpose : Default implementation of IsEqual via operator ==
|
|
//=======================================================================
|
|
|
|
template <class TheKeyType>
|
|
inline Standard_Boolean IsEqual (const TheKeyType& theKey1,
|
|
const TheKeyType& theKey2)
|
|
{
|
|
return theKey1 == theKey2;
|
|
}
|
|
|
|
//=======================================================================
|
|
//function : IsEqual_Proxy
|
|
//purpose : Function is required to call the global function IsEqual.
|
|
//=======================================================================
|
|
|
|
template <class TheKeyType>
|
|
inline Standard_Boolean IsEqual_Proxy (const TheKeyType& theKey1,
|
|
const TheKeyType& theKey2)
|
|
{
|
|
return IsEqual (theKey1, theKey2);
|
|
}
|
|
|
|
|
|
/**
|
|
* Purpose: The DefaultHasher is a Hasher that is used by
|
|
* default in NCollection maps.
|
|
* To compute the hash code of the key is used the
|
|
* global function HashCode.
|
|
* To compare two keys is used the global function
|
|
* IsEqual.
|
|
*/
|
|
template <class TheKeyType> class NCollection_DefaultHasher {
|
|
public:
|
|
//! Returns hash code for the given key, in the range [1, theUpperBound]
|
|
//! @param theKey the key which hash code is to be computed
|
|
//! @param theUpperBound the upper bound of the range a computing hash code must be within
|
|
//! @return a computed hash code, in the range [1, theUpperBound]
|
|
static Standard_Integer HashCode (const TheKeyType& theKey, const Standard_Integer theUpperBound)
|
|
{
|
|
return HashCode_Proxy (theKey, theUpperBound);
|
|
}
|
|
|
|
//
|
|
static Standard_Boolean IsEqual(const TheKeyType& theKey1,
|
|
const TheKeyType& theKey2) {
|
|
return IsEqual_Proxy(theKey1, theKey2);
|
|
}
|
|
};
|
|
|
|
#endif
|