JavaScriptCore:
[WebKit-https.git] / JavaScriptCore / kjs / SymbolTable.h
1 /*
2  * Copyright (C) 2007, 2008 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer.
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution.
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission.
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #ifndef SymbolTable_h
30 #define SymbolTable_h
31
32 #include "JSObject.h"
33 #include "ustring.h"
34 #include <wtf/AlwaysInline.h>
35
36 namespace KJS {
37
38     static ALWAYS_INLINE int missingSymbolMarker() { return std::numeric_limits<int>::max(); }
39
40     // The bit twiddling in this class assumes that every register index is a
41     // reasonably small negative number, and therefore has its high two bits set.
42
43     struct SymbolTableEntry {
44         SymbolTableEntry()
45             : rawValue(0)
46         {
47         }
48         
49         SymbolTableEntry(int index)
50         {
51             ASSERT(index & 0x80000000);
52             ASSERT(index & 0x40000000);
53
54             rawValue = index & ~0x80000000 & ~0x40000000;
55         }
56         
57         SymbolTableEntry(int index, unsigned attributes)
58         {
59             ASSERT(index & 0x80000000);
60             ASSERT(index & 0x40000000);
61
62             rawValue = index;
63             
64             if (!(attributes & ReadOnly))
65                 rawValue &= ~0x80000000;
66             
67             if (!(attributes & DontEnum))
68                 rawValue &= ~0x40000000;
69         }
70
71         bool isNull() const
72         {
73             return !rawValue;
74         }
75
76         int getIndex() const
77         {
78             ASSERT(!isNull());
79             return rawValue | 0x80000000 | 0x40000000;
80         }
81
82         unsigned getAttributes() const
83         {
84             unsigned attributes = 0;
85             
86             if (rawValue & 0x80000000)
87                 attributes |= ReadOnly;
88             
89             if (rawValue & 0x40000000)
90                 attributes |= DontEnum;
91             
92             return attributes;
93         }
94
95         void setAttributes(unsigned attributes)
96         {
97             rawValue = getIndex();
98             
99             if (!(attributes & ReadOnly))
100                 rawValue &= ~0x80000000;
101             
102             if (!(attributes & DontEnum))
103                 rawValue &= ~0x40000000;
104         }
105
106         bool isReadOnly() const
107         {
108             return rawValue & 0x80000000;
109         }
110
111         int rawValue;
112     };
113
114     struct SymbolTableIndexHashTraits {
115         typedef SymbolTableEntry TraitType;
116         static SymbolTableEntry emptyValue() { return SymbolTableEntry(); }
117         static const bool emptyValueIsZero = false;
118         static const bool needsDestruction = false;
119     };
120
121     typedef HashMap<RefPtr<UString::Rep>, SymbolTableEntry, IdentifierRepHash, HashTraits<RefPtr<UString::Rep> >, SymbolTableIndexHashTraits> SymbolTable;
122
123 } // namespace KJS
124
125 #endif // SymbolTable_h