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 "PlatformString.h"

    35 #include <wtf/HashMap.h>

    36 

    37 namespace WebKit {

    38 

    39 class WebEntities {

    40 public:

    41     // ', %, ⊅, &supl; are not defined by the HTML standards.

    42     //  - IE does not support ' as an HTML entity (but support it as an XML

    43     //    entity.)

    44     //  - Firefox supports ' as an HTML entity.

    45     //  - Both of IE and Firefox don't support %, ⊅ and &supl;.

    46     //

    47     // A web page saved by Chromium should be able to be read by other browsers

    48     // such as IE and Firefox.  Chromium should produce only the standard entity

    49     // references which other browsers can recognize.

    50     // So if standard_html_entities_ is true, we will use a numeric character

    51     // reference for ', and don't use entity references for %, ⊅

    52     // and &supl; for serialization.

    53     //

    54     // If xmlEntities is true, WebEntities will only contain standard XML

    55     // entities.

    56     explicit WebEntities(bool xmlEntities);

    57 

    58     // Check whether specified unicode has corresponding html or xml built-in

    59     // entity name. If yes, return the entity notation. If not, returns an

    60     // empty string. Parameter isHTML indicates check the code in html entity

    61     // map or in xml entity map.

    62     WebCore::String entityNameByCode(int code) const;

    63 

    64     // Returns a new string with corresponding entity names replaced.

    65     WebCore::String convertEntitiesInString(const WebCore::String&) const;

    66 private:

    67     typedef HashMap<int, WebCore::String> EntitiesMapType;

    68     // An internal object that maps the Unicode character to corresponding

    69     // entity notation.

    70     EntitiesMapType m_entitiesMap;

    71 };

    72 

    73 } // namespace WebKit

    74 

    75 #endif