0030550: Coding - Integer overflow in Standard_CString HashCodes
[occt.git] / src / Standard / Standard_Address.hxx
1 // Copyright (c) 1998-1999 Matra Datavision
2 // Copyright (c) 1999-2014 OPEN CASCADE SAS
3 //
4 // This file is part of Open CASCADE Technology software library.
5 //
6 // This library is free software; you can redistribute it and/or modify it under
7 // the terms of the GNU Lesser General Public License version 2.1 as published
8 // by the Free Software Foundation, with special exception defined in the file
9 // OCCT_LGPL_EXCEPTION.txt. Consult the file LICENSE_LGPL_21.txt included in OCCT
10 // distribution for complete text of the license and disclaimer of any warranty.
11 //
12 // Alternatively, this file may be used under the terms of Open CASCADE
13 // commercial license or contractual agreement.
14
15 #ifndef _Standard_Address_HeaderFile
16 #define _Standard_Address_HeaderFile
17
18 #include <Standard_Integer.hxx>
19
20 //! Returns a hash code of the given memory pointer
21 //! @param thePointer the memory pointer which hash code it to be computed
22 //! @param theUpperBound the upper bound of the range a resulting hash code must be within
23 //! @return a value of a computed hash code, in range [1, UpperBound]
24 inline Standard_Integer HashCode (const void* const thePointer, const Standard_Integer theUpperBound)
25 {
26   union
27   {
28     const void*      L;
29     Standard_Integer I[2];
30   } U;
31
32   U.I[0] = 0;
33   U.I[1] = 0;
34   U.L    = thePointer;
35
36   return HashCode (U.I[0] ^ U.I[1], theUpperBound);
37 }
38
39 //============================================================================
40 // IsEqual : Returns Standard_True if two CString have the same value
41 //============================================================================
42
43 inline Standard_Boolean IsEqual(const Standard_Address One
44                                ,const Standard_Address Two)
45 { return One == Two; }
46
47 #endif