Home | History | Annotate | Download | only in editing 
      1 /*
      2  * Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 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 COMPUTER, INC. ``AS IS'' AND ANY
     14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
     15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
     16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE COMPUTER, INC. OR
     17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
     18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
     19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
     20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
     21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
     23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     24  */
     25 
     26 #ifndef MarkupAccumulator_h
     27 #define MarkupAccumulator_h
     28 
     29 #include "core/editing/markup.h"
     30 #include "wtf/HashMap.h"
     31 #include "wtf/Vector.h"
     32 #include "wtf/text/StringBuilder.h"
     33 
     34 namespace WebCore {
     35 
     36 class Attribute;
     37 class DocumentType;
     38 class Element;
     39 class Node;
     40 class Range;
     41 
     42 typedef HashMap<AtomicString, AtomicString> Namespaces;
     43 
     44 enum EntityMask {
     45     EntityAmp = 0x0001,
     46     EntityLt = 0x0002,
     47     EntityGt = 0x0004,
     48     EntityQuot = 0x0008,
     49     EntityNbsp = 0x0010,
     50 
     51     // Non-breaking space needs to be escaped in innerHTML for compatibility reason. See http://trac.webkit.org/changeset/32879
     52     // However, we cannot do this in a XML document because it does not have the entity reference defined (See the bug 19215).
     53     EntityMaskInCDATA = 0,
     54     EntityMaskInPCDATA = EntityAmp | EntityLt | EntityGt,
     55     EntityMaskInHTMLPCDATA = EntityMaskInPCDATA | EntityNbsp,
     56     EntityMaskInAttributeValue = EntityAmp | EntityQuot | EntityLt | EntityGt,
     57     EntityMaskInHTMLAttributeValue = EntityAmp | EntityQuot | EntityNbsp,
     58 };
     59 
     60 enum SerializationType {
     61     AsOwnerDocument,
     62     ForcedXML
     63 };
     64 
     65 class MarkupAccumulator {
     66     WTF_MAKE_NONCOPYABLE(MarkupAccumulator);
     67     STACK_ALLOCATED();
     68 public:
     69     MarkupAccumulator(WillBeHeapVector<RawPtrWillBeMember<Node> >*, EAbsoluteURLs, const Range* = 0, SerializationType = AsOwnerDocument);
     70     virtual ~MarkupAccumulator();
     71 
     72     String serializeNodes(Node& targetNode, EChildrenOnly, Vector<QualifiedName>* tagNamesToSkip = 0);
     73 
     74     static void appendComment(StringBuilder&, const String&);
     75 
     76     static void appendCharactersReplacingEntities(StringBuilder&, const String&, unsigned, unsigned, EntityMask);
     77 
     78 protected:
     79     void appendString(const String&);
     80     void appendStartTag(Node&, Namespaces* = 0);
     81     virtual void appendEndTag(const Node&);
     82     static size_t totalLength(const Vector<String>&);
     83     size_t length() const { return m_markup.length(); }
     84     void concatenateMarkup(StringBuilder&);
     85     void appendAttributeValue(StringBuilder&, const String&, bool);
     86     virtual void appendCustomAttributes(StringBuilder&, const Element&, Namespaces*);
     87     bool shouldAddNamespaceElement(const Element&, Namespaces&);
     88     bool shouldAddNamespaceAttribute(const Attribute&, const Element&);
     89 
     90     void appendNamespace(StringBuilder&, const AtomicString& prefix, const AtomicString& namespaceURI, Namespaces&);
     91     EntityMask entityMaskForText(const Text&) const;
     92     virtual void appendText(StringBuilder&, Text&);
     93     void appendXMLDeclaration(StringBuilder&, const Document&);
     94     void appendDocumentType(StringBuilder&, const DocumentType&);
     95     void appendProcessingInstruction(StringBuilder&, const String& target, const String& data);
     96     virtual void appendElement(StringBuilder&, Element&, Namespaces*);
     97     void appendOpenTag(StringBuilder&, const Element&, Namespaces*);
     98     void appendCloseTag(StringBuilder&, const Element&);
     99     void appendAttribute(StringBuilder&, const Element&, const Attribute&, Namespaces*);
    100     void appendCDATASection(StringBuilder&, const String&);
    101     void appendStartMarkup(StringBuilder&, Node&, Namespaces*);
    102     bool shouldSelfClose(const Node&);
    103     bool elementCannotHaveEndTag(const Node&);
    104     void appendEndMarkup(StringBuilder&, const Node&);
    105 
    106     RawPtrWillBeMember<WillBeHeapVector<RawPtrWillBeMember<Node> > > const m_nodes;
    107     RawPtrWillBeMember<const Range> const m_range;
    108 
    109 private:
    110     String resolveURLIfNeeded(const Element&, const String&) const;
    111     void appendQuotedURLAttributeValue(StringBuilder&, const Element&, const Attribute&);
    112     void serializeNodesWithNamespaces(Node& targetNode, EChildrenOnly, const Namespaces*, Vector<QualifiedName>* tagNamesToSkip);
    113     bool serializeAsHTMLDocument(const Node&) const;
    114 
    115     StringBuilder m_markup;
    116     const EAbsoluteURLs m_resolveURLsMethod;
    117     SerializationType m_serializationType;
    118 };
    119 
    120 }
    121 
    122 #endif
    123