src/third_party/WebKit/Source/core/loader/DocumentWriter.h

   1 /*
   2  * Copyright (C) 2010. Adam Barth. 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 Adam Barth. ("Adam Barth") 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 DocumentWriter_h
  30 #define DocumentWriter_h
  31
  32 #include "core/loader/TextResourceDecoderBuilder.h"
  33 #include "platform/heap/Handle.h"
  34 #include "wtf/RefCounted.h"
  35 #include "wtf/text/WTFString.h"
  36
  37 namespace blink {
  38
  39 class Document;
  40 class DocumentParser;
  41
  42 class DocumentWriter : public RefCountedWillBeGarbageCollectedFinalized<DocumentWriter> {
  43     WTF_MAKE_NONCOPYABLE(DocumentWriter);
  44 public:
  45     static PassRefPtrWillBeRawPtr<DocumentWriter> create(Document*, const AtomicString& mimeType = emptyAtom, const AtomicString& encoding = emptyAtom);
  46
  47     ~DocumentWriter();
  48     void trace(Visitor*);
  49
  50     void end();
  51
  52     void forceSynchronousParse();
  53     void addData(const char* bytes, size_t length);
  54
  55     const AtomicString& mimeType() const { return m_decoderBuilder.mimeType(); }
  56     const AtomicString& encoding() const { return m_decoderBuilder.encoding(); }
  57
  58     // Exposed for DocumentLoader::replaceDocumentWhileExecutingJavaScriptURL.
  59     void appendReplacingData(const String&);
  60
  61     void setUserChosenEncoding(const String& charset);
  62
  63     void setDocumentWasLoadedAsPartOfNavigation();
  64
  65 private:
  66     DocumentWriter(Document*, const AtomicString& mimeType, const AtomicString& encoding);
  67
  68     RawPtrWillBeMember<Document> m_document;
  69     TextResourceDecoderBuilder m_decoderBuilder;
  70
  71     RefPtrWillBeMember<DocumentParser> m_parser;
  72     bool m_forcedSynchronousParse;
  73 };
  74
  75 } // namespace blink
  76
  77 #endif // DocumentWriter_h