WinCairo build fails to link.
[WebKit-https.git] / Source / WebKit / chromium / src / WebEntities.h
1 /*
2  * Copyright (C) 2009 Google 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 are
6  * met:
7  *
8  *     * Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *     * Redistributions in binary form must reproduce the above
11  * copyright notice, this list of conditions and the following disclaimer
12  * in the documentation and/or other materials provided with the
13  * distribution.
14  *     * Neither the name of Google Inc. nor the names of its
15  * contributors may be used to endorse or promote products derived from
16  * this software without specific prior written permission.
17  *
18  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
21  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
22  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
23  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
24  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
25  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
26  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
28  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29  */
30
31 #ifndef WebEntities_h
32 #define WebEntities_h
33
34 #include <wtf/HashMap.h>
35 #include <wtf/text/WTFString.h>
36
37 namespace WebKit {
38
39 // FIXME: This class is wrong and needs to be removed.
40 class WebEntities {
41 public:
42     // &apos;, &percnt;, &nsup;, &supl; are not defined by the HTML standards.
43     //  - IE does not support &apos; as an HTML entity (but support it as an XML
44     //    entity.)
45     //  - Firefox supports &apos; as an HTML entity.
46     //  - Both of IE and Firefox don't support &percnt;, &nsup; and &supl;.
47     //
48     // A web page saved by Chromium should be able to be read by other browsers
49     // such as IE and Firefox.  Chromium should produce only the standard entity
50     // references which other browsers can recognize.
51     // So if standard_html_entities_ is true, we will use a numeric character
52     // reference for &apos;, and don't use entity references for &percnt;, &nsup;
53     // and &supl; for serialization.
54     //
55     // If xmlEntities is true, WebEntities will only contain standard XML
56     // entities.
57     explicit WebEntities(bool xmlEntities);
58
59     // Check whether specified unicode has corresponding html or xml built-in
60     // entity name. If yes, return the entity notation. If not, returns an
61     // empty string. Parameter isHTML indicates check the code in html entity
62     // map or in xml entity map.
63     WTF::String entityNameByCode(int code) const;
64
65     // Returns a new string with corresponding entity names replaced.
66     WTF::String convertEntitiesInString(const WTF::String&) const;
67 private:
68     typedef HashMap<int, WTF::String> EntitiesMapType;
69     // An internal object that maps the Unicode character to corresponding
70     // entity notation.
71     EntitiesMapType m_entitiesMap;
72 };
73
74 } // namespace WebKit
75
76 #endif