Fix for [#27142] manipulator in particle mode does not work
[blender-staging.git] / intern / string / STR_HashedString.h
1 /*
2  * $Id$
3  * ***** BEGIN GPL LICENSE BLOCK *****
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU General Public License
7  * as published by the Free Software Foundation; either version 2
8  * of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program; if not, write to the Free Software Foundation,
17  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18  *
19  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
20  * All rights reserved.
21  *
22  * The Original Code is: all of this file.
23  *
24  * Contributor(s): none yet.
25  *
26  * ***** END GPL LICENSE BLOCK *****
27  */
28
29 /** \file string/STR_HashedString.h
30  *  \ingroup string
31  */
32
33
34 /**
35
36  * $Id$
37  * Copyright (C) 2001 NaN Technologies B.V.
38  * This file was formerly known as: GEN_StdString.cpp.
39  * @date        November, 14, 2001
40  */
41
42 #ifndef __STR_HASHSTRING
43 #define __STR_HASHSTRING
44
45 #include "STR_String.h"
46
47
48 // Hash Mix utility function, by Bob Jenkins - Mix 3 32-bit values reversibly
49 //
50 // - If gHashMix() is run forward or backward, at least 32 bits in a,b,c have at
51 //   least 1/4 probability of changing.
52 //
53 // - If gHashMix() is run forward, every bit of c will change between 1/3 and
54 //   2/3 of the time.
55 //
56 static inline void STR_gHashMix(dword& a, dword& b, dword& c)
57 {
58         a -= b; a -= c; a ^= (c>>13);
59         b -= c; b -= a; b ^= (a<<8);
60         c -= a; c -= b; c ^= (b>>13);
61         a -= b; a -= c; a ^= (c>>12);
62         b -= c; b -= a; b ^= (a<<16);
63         c -= a; c -= b; c ^= (b>>5);
64         a -= b; a -= c; a ^= (c>>3);
65         b -= c; b -= a; b ^= (a<<10);
66         c -= a; c -= b; c ^= (b>>15);
67 }
68
69 //
70 // Fast Hashable<int32> functionality
71 // http://www.concentric.net/~Ttwang/tech/inthash.htm
72 //
73 static inline dword                     STR_gHash(dword inDWord)
74 {
75         dword key = inDWord;
76         key += ~(key << 16);
77         key ^=  (key >>  5);
78         key +=  (key <<  3);
79         key ^=  (key >> 13);
80         key += ~(key <<  9);
81         key ^=  (key >> 17);
82         return key;
83 }
84
85 enum { GOLDEN_RATIO = 0x9e3779b9 }; // arbitrary value to initialize hash funtion, well not so arbitrary
86                                                                         // as this value is taken from the pigs library (Orange Games/Lost Boys)
87
88
89
90 static dword STR_gHash(const void* in, int len, dword init_val)
91 {
92         unsigned int  length = len;
93         dword a = (dword)GOLDEN_RATIO;
94         dword b = (dword)GOLDEN_RATIO;
95         dword c = init_val;                                                                                                                     // the previous hash value
96         byte  *p_in = (byte *)in;
97
98         // Do the largest part of the key
99         while (length >= 12)
100         {
101                 a += (p_in[0] + ((dword)p_in[1]<<8) + ((dword)p_in[2] <<16) + ((dword)p_in[3] <<24));
102                 b += (p_in[4] + ((dword)p_in[5]<<8) + ((dword)p_in[6] <<16) + ((dword)p_in[7] <<24));
103                 c += (p_in[8] + ((dword)p_in[9]<<8) + ((dword)p_in[10]<<16) + ((dword)p_in[11]<<24));
104                 STR_gHashMix(a, b, c);
105                 p_in += 12; length -= 12;
106         }
107
108         // Handle the last 11 bytes
109         c += len;
110         switch(length) {
111         case 11: c+=((dword)p_in[10]<<24);
112         case 10: c+=((dword)p_in[9]<<16);
113         case 9 : c+=((dword)p_in[8]<<8);                                                                                        // the first byte of c is reserved for the length
114         case 8 : b+=((dword)p_in[7]<<24);
115         case 7 : b+=((dword)p_in[6]<<16);
116         case 6 : b+=((dword)p_in[5]<<8);
117         case 5 : b+=p_in[4];
118         case 4 : a+=((dword)p_in[3]<<24);
119         case 3 : a+=((dword)p_in[2]<<16);
120         case 2 : a+=((dword)p_in[1]<<8);
121         case 1 : a+=p_in[0];
122         }
123         STR_gHashMix(a, b, c);
124
125         return c;
126 }
127
128
129
130
131 class STR_HashedString : public STR_String
132 {
133 public:
134         STR_HashedString()      : STR_String(),m_Hashed(false) {}
135         STR_HashedString(const char* str)       : STR_String(str),m_Hashed(false) {}
136         STR_HashedString(const STR_String& str) : STR_String(str),m_Hashed(false) {}
137
138         inline dword hash(dword init=0) const
139         { 
140                 if (!m_Hashed) 
141                 {
142                         const char* str = *this;
143                         int length = this->Length();
144                         m_CachedHash = STR_gHash(str,length,init);
145                         m_Hashed=true;
146                 } 
147                 return m_CachedHash;
148         }
149
150 private:
151         mutable bool m_Hashed;
152         mutable dword m_CachedHash;
153 };
154
155 #endif //__STR_HASHSTRING
156