1/*
2 * Copyright (C) 2010 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 * 1.  Redistributions of source code must retain the above copyright
8 *     notice, this list of conditions and the following disclaimer.
9 * 2.  Redistributions in binary form must reproduce the above copyright
10 *     notice, this list of conditions and the following disclaimer in the
11 *     documentation and/or other materials provided with the distribution.
12 *
13 * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS'' AND ANY
14 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16 * DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS BE LIABLE FOR ANY
17 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
19 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
20 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
21 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
22 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
23 */
24
25#ifndef HTMLParserIdioms_h
26#define HTMLParserIdioms_h
27
28#include "core/dom/QualifiedName.h"
29#include "platform/Decimal.h"
30#include "wtf/Forward.h"
31#include "wtf/text/WTFString.h"
32
33namespace WTF {
34class TextEncoding;
35}
36
37namespace blink {
38
39// Strip leading and trailing whitespace as defined by the HTML specification.
40String stripLeadingAndTrailingHTMLSpaces(const String&);
41template<size_t inlineCapacity>
42String stripLeadingAndTrailingHTMLSpaces(const Vector<UChar, inlineCapacity>& vector)
43{
44    return stripLeadingAndTrailingHTMLSpaces(StringImpl::create8BitIfPossible(vector));
45}
46
47// An implementation of the HTML specification's algorithm to convert a number to a string for number and range types.
48String serializeForNumberType(const Decimal&);
49String serializeForNumberType(double);
50
51// Convert the specified string to a decimal/double. If the conversion fails, the return value is fallback value or NaN if not specified.
52// Leading or trailing illegal characters cause failure, as does passing an empty string.
53// The double* parameter may be 0 to check if the string can be parsed without getting the result.
54Decimal parseToDecimalForNumberType(const String&, const Decimal& fallbackValue = Decimal::nan());
55double parseToDoubleForNumberType(const String&, double fallbackValue = std::numeric_limits<double>::quiet_NaN());
56
57// http://www.whatwg.org/specs/web-apps/current-work/#rules-for-parsing-integers
58bool parseHTMLInteger(const String&, int&);
59
60// http://www.whatwg.org/specs/web-apps/current-work/#rules-for-parsing-non-negative-integers
61bool parseHTMLNonNegativeInteger(const String&, unsigned&);
62
63typedef Vector<pair<String, String> > HTMLAttributeList;
64// The returned encoding might not be valid.
65WTF::TextEncoding encodingFromMetaAttributes(const HTMLAttributeList&);
66
67// Space characters as defined by the HTML specification.
68template<typename CharType>
69inline bool isHTMLSpace(CharType character)
70{
71    // Histogram from Apple's page load test combined with some ad hoc browsing some other test suites.
72    //
73    //     82%: 216330 non-space characters, all > U+0020
74    //     11%:  30017 plain space characters, U+0020
75    //      5%:  12099 newline characters, U+000A
76    //      2%:   5346 tab characters, U+0009
77    //
78    // No other characters seen. No U+000C or U+000D, and no other control characters.
79    // Accordingly, we check for non-spaces first, then space, then newline, then tab, then the other characters.
80
81    return character <= ' ' && (character == ' ' || character == '\n' || character == '\t' || character == '\r' || character == '\f');
82}
83
84template<typename CharType>
85inline bool isComma(CharType character)
86{
87    return character == ',';
88}
89
90template<typename CharType>
91inline bool isHTMLSpaceOrComma(CharType character)
92{
93    return isComma(character) || isHTMLSpace(character);
94}
95
96inline bool isHTMLLineBreak(UChar character)
97{
98    return character <= '\r' && (character == '\n' || character == '\r');
99}
100
101template<typename CharType>
102inline bool isNotHTMLSpace(CharType character)
103{
104    return !isHTMLSpace<CharType>(character);
105}
106
107bool threadSafeMatch(const QualifiedName&, const QualifiedName&);
108bool threadSafeMatch(const String&, const QualifiedName&);
109
110enum CharacterWidth {
111    Likely8Bit,
112    Force8Bit,
113    Force16Bit
114};
115
116String attemptStaticStringCreation(const LChar*, size_t);
117
118String attemptStaticStringCreation(const UChar*, size_t, CharacterWidth);
119
120template<size_t inlineCapacity>
121inline static String attemptStaticStringCreation(const Vector<UChar, inlineCapacity>& vector, CharacterWidth width)
122{
123    return attemptStaticStringCreation(vector.data(), vector.size(), width);
124}
125
126inline static String attemptStaticStringCreation(const String str)
127{
128    if (!str.is8Bit())
129        return attemptStaticStringCreation(str.characters16(), str.length(), Force16Bit);
130    return attemptStaticStringCreation(str.characters8(), str.length());
131}
132
133
134}
135#endif
136