089d73f392e7756d60d9c5ca83e7482bf4c811ec
[WebKit-https.git] / Source / WTF / wtf / ASCIICType.h
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2011 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 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 WTF_ASCIICType_h
30 #define WTF_ASCIICType_h
31
32 #include <wtf/Assertions.h>
33 #include <wtf/text/LChar.h>
34
35 // The behavior of many of the functions in the <ctype.h> header is dependent
36 // on the current locale. But in the WebKit project, all uses of those functions
37 // are in code processing something that's not locale-specific. These equivalents
38 // for some of the <ctype.h> functions are named more explicitly, not dependent
39 // on the C library locale, and we should also optimize them as needed.
40
41 // All functions return false or leave the character unchanged if passed a character
42 // that is outside the range 0-7F. So they can be used on Unicode strings or
43 // characters if the intent is to do processing only if the character is ASCII.
44
45 namespace WTF {
46
47 const unsigned char asciiCaseFoldTable[256] = {
48     0x00, 0x01, 0x02, 0x03, 0x04, 0x05, 0x06, 0x07, 0x08, 0x09, 0x0a, 0x0b, 0x0c, 0x0d, 0x0e, 0x0f,
49     0x10, 0x11, 0x12, 0x13, 0x14, 0x15, 0x16, 0x17, 0x18, 0x19, 0x1a, 0x1b, 0x1c, 0x1d, 0x1e, 0x1f,
50     0x20, 0x21, 0x22, 0x23, 0x24, 0x25, 0x26, 0x27, 0x28, 0x29, 0x2a, 0x2b, 0x2c, 0x2d, 0x2e, 0x2f,
51     0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x3a, 0x3b, 0x3c, 0x3d, 0x3e, 0x3f,
52     0x40, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
53     0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x5b, 0x5c, 0x5d, 0x5e, 0x5f,
54     0x60, 0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f,
55     0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x7b, 0x7c, 0x7d, 0x7e, 0x7f,
56     0x80, 0x81, 0x82, 0x83, 0x84, 0x85, 0x86, 0x87, 0x88, 0x89, 0x8a, 0x8b, 0x8c, 0x8d, 0x8e, 0x8f,
57     0x90, 0x91, 0x92, 0x93, 0x94, 0x95, 0x96, 0x97, 0x98, 0x99, 0x9a, 0x9b, 0x9c, 0x9d, 0x9e, 0x9f,
58     0xa0, 0xa1, 0xa2, 0xa3, 0xa4, 0xa5, 0xa6, 0xa7, 0xa8, 0xa9, 0xaa, 0xab, 0xac, 0xad, 0xae, 0xaf,
59     0xb0, 0xb1, 0xb2, 0xb3, 0xb4, 0xb5, 0xb6, 0xb7, 0xb8, 0xb9, 0xba, 0xbb, 0xbc, 0xbd, 0xbe, 0xbf,
60     0xc0, 0xc1, 0xc2, 0xc3, 0xc4, 0xc5, 0xc6, 0xc7, 0xc8, 0xc9, 0xca, 0xcb, 0xcc, 0xcd, 0xce, 0xcf,
61     0xd0, 0xd1, 0xd2, 0xd3, 0xd4, 0xd5, 0xd6, 0xd7, 0xd8, 0xd9, 0xda, 0xdb, 0xdc, 0xdd, 0xde, 0xdf,
62     0xe0, 0xe1, 0xe2, 0xe3, 0xe4, 0xe5, 0xe6, 0xe7, 0xe8, 0xe9, 0xea, 0xeb, 0xec, 0xed, 0xee, 0xef,
63     0xf0, 0xf1, 0xf2, 0xf3, 0xf4, 0xf5, 0xf6, 0xf7, 0xf8, 0xf9, 0xfa, 0xfb, 0xfc, 0xfd, 0xfe, 0xff
64 };
65
66 template<typename CharType> inline bool isASCII(CharType c)
67 {
68     return !(c & ~0x7F);
69 }
70
71 template<typename CharType> inline bool isASCIIAlpha(CharType c)
72 {
73     return (c | 0x20) >= 'a' && (c | 0x20) <= 'z';
74 }
75
76 template<typename CharType> inline bool isASCIIDigit(CharType c)
77 {
78     return c >= '0' && c <= '9';
79 }
80
81 template<typename CharType> inline bool isASCIIAlphanumeric(CharType c)
82 {
83     return isASCIIDigit(c) || isASCIIAlpha(c);
84 }
85
86 template<typename CharType> inline bool isASCIIHexDigit(CharType c)
87 {
88     return isASCIIDigit(c) || ((c | 0x20) >= 'a' && (c | 0x20) <= 'f');
89 }
90
91 template<typename CharType> inline bool isASCIILower(CharType c)
92 {
93     return c >= 'a' && c <= 'z';
94 }
95
96 template<typename CharType> inline bool isASCIIBinaryDigit(CharType c)
97 {
98     return (c == '0') || (c == '1');
99 }
100
101 template<typename CharType> inline bool isASCIIOctalDigit(CharType c)
102 {
103     return (c >= '0') && (c <= '7');
104 }
105
106 template<typename CharType> inline bool isASCIIPrintable(CharType c)
107 {
108     return c >= ' ' && c <= '~';
109 }
110
111 /*
112  Statistics from a run of Apple's page load test for callers of isASCIISpace:
113
114  character          count
115  ---------          -----
116  non-spaces         689383
117  20  space          294720
118  0A  \n             89059
119  09  \t             28320
120  0D  \r             0
121  0C  \f             0
122  0B  \v             0
123  */
124 template<typename CharType> inline bool isASCIISpace(CharType c)
125 {
126     return c <= ' ' && (c == ' ' || (c <= 0xD && c >= 0x9));
127 }
128
129 template<typename CharType> inline bool isASCIIUpper(CharType c)
130 {
131     return c >= 'A' && c <= 'Z';
132 }
133
134 template<typename CharType> inline CharType toASCIILower(CharType c)
135 {
136     return c | ((c >= 'A' && c <= 'Z') << 5);
137 }
138
139 template<>
140 inline char toASCIILower(char c)
141 {
142     return static_cast<char>(asciiCaseFoldTable[static_cast<unsigned char>(c)]);
143 }
144
145 template<>
146 inline LChar toASCIILower(LChar c)
147 {
148     return asciiCaseFoldTable[c];
149 }
150
151 template<typename CharType> inline CharType toASCIILowerUnchecked(CharType character)
152 {
153     // This function can be used for comparing any input character
154     // to a lowercase English character. The isASCIIAlphaCaselessEqual
155     // below should be used for regular comparison of ASCII alpha
156     // characters, but switch statements in CSS tokenizer require
157     // direct use of this function.
158     return character | 0x20;
159 }
160
161 template<typename CharType> inline CharType toASCIIUpper(CharType c)
162 {
163     return c & ~((c >= 'a' && c <= 'z') << 5);
164 }
165
166 template<typename CharType> inline int toASCIIHexValue(CharType c)
167 {
168     ASSERT(isASCIIHexDigit(c));
169     return c < 'A' ? c - '0' : (c - 'A' + 10) & 0xF;
170 }
171
172 template<typename CharType> inline int toASCIIHexValue(CharType upperValue, CharType lowerValue)
173 {
174     ASSERT(isASCIIHexDigit(upperValue) && isASCIIHexDigit(lowerValue));
175     return ((toASCIIHexValue(upperValue) << 4) & 0xF0) | toASCIIHexValue(lowerValue);
176 }
177
178 inline char lowerNibbleToASCIIHexDigit(char c)
179 {
180     char nibble = c & 0xF;
181     return nibble < 10 ? '0' + nibble : 'A' + nibble - 10;
182 }
183
184 inline char upperNibbleToASCIIHexDigit(char c)
185 {
186     char nibble = (c >> 4) & 0xF;
187     return nibble < 10 ? '0' + nibble : 'A' + nibble - 10;
188 }
189
190 template<typename CharType> inline bool isASCIIAlphaCaselessEqual(CharType cssCharacter, char character)
191 {
192     // This function compares a (preferrably) constant ASCII
193     // lowercase letter to any input character.
194     ASSERT(character >= 'a' && character <= 'z');
195     return LIKELY(toASCIILowerUnchecked(cssCharacter) == character);
196 }
197
198 }
199
200 using WTF::isASCII;
201 using WTF::isASCIIAlpha;
202 using WTF::isASCIIAlphanumeric;
203 using WTF::isASCIIDigit;
204 using WTF::isASCIIHexDigit;
205 using WTF::isASCIILower;
206 using WTF::isASCIIBinaryDigit;
207 using WTF::isASCIIOctalDigit;
208 using WTF::isASCIIPrintable;
209 using WTF::isASCIISpace;
210 using WTF::isASCIIUpper;
211 using WTF::toASCIIHexValue;
212 using WTF::toASCIILower;
213 using WTF::toASCIILowerUnchecked;
214 using WTF::toASCIIUpper;
215 using WTF::lowerNibbleToASCIIHexDigit;
216 using WTF::upperNibbleToASCIIHexDigit;
217 using WTF::isASCIIAlphaCaselessEqual;
218
219 #endif