src/third_party/WebKit/Source/core/html/imports/HTMLImportLoader.h

   1 /*
   2  * Copyright (C) 2013 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 HTMLImportLoader_h
  32 #define HTMLImportLoader_h
  33
  34 #include "core/fetch/RawResource.h"
  35 #include "core/fetch/ResourceOwner.h"
  36 #include "wtf/OwnPtr.h"
  37 #include "wtf/PassOwnPtr.h"
  38 #include "wtf/Vector.h"
  39
  40 namespace WebCore {
  41
  42 class CustomElementMicrotaskQueue;
  43 class Document;
  44 class DocumentWriter;
  45 class HTMLImportChild;
  46 class HTMLImportsController;
  47
  48
  49 //
  50 // Owning imported Document lifetime. It also implements ResourceClient through ResourceOwner
  51 // to feed fetched bytes to the DocumentWriter of the imported document.
  52 // HTMLImportLoader is owned by and shared between HTMLImportChild.
  53 //
  54 //
  55 class HTMLImportLoader FINAL : public RefCounted<HTMLImportLoader>, public ResourceOwner<RawResource> {
  56 public:
  57     enum State {
  58         StateLoading,
  59         StateWritten,
  60         StateParsed,
  61         StateLoaded,
  62         StateError
  63     };
  64
  65     static PassRefPtr<HTMLImportLoader> create(HTMLImportsController* controller)
  66     {
  67         return adoptRef(new HTMLImportLoader(controller));
  68     }
  69
  70     virtual ~HTMLImportLoader();
  71
  72     Document* document() const { return m_importedDocument.get(); }
  73     Document* importedDocument() const;
  74     void addImport(HTMLImportChild*);
  75     void removeImport(HTMLImportChild*);
  76     void moveToFirst(HTMLImportChild*);
  77     HTMLImportChild* firstImport() const { return m_imports[0]; }
  78     bool isFirstImport(HTMLImportChild* child) const { return m_imports.size() ? firstImport() == child : false; }
  79
  80     bool isDone() const { return m_state == StateLoaded || m_state == StateError; }
  81     bool hasError() const { return m_state == StateError; }
  82     bool shouldBlockScriptExecution() const;
  83
  84     void importDestroyed();
  85     void startLoading(const ResourcePtr<RawResource>&);
  86     void didFinishParsing();
  87     void didRemoveAllPendingStylesheet();
  88
  89     PassRefPtr<CustomElementMicrotaskQueue> microtaskQueue() const;
  90
  91 private:
  92     HTMLImportLoader(HTMLImportsController*);
  93
  94     // RawResourceClient
  95     virtual void responseReceived(Resource*, const ResourceResponse&) OVERRIDE;
  96     virtual void dataReceived(Resource*, const char* data, int length) OVERRIDE;
  97     virtual void notifyFinished(Resource*) OVERRIDE;
  98
  99     State startWritingAndParsing(const ResourceResponse&);
 100     State finishWriting();
 101     State finishParsing();
 102     State finishLoading();
 103
 104     void setState(State);
 105     void didFinishLoading();
 106     bool hasPendingResources() const;
 107     void clear();
 108
 109     HTMLImportsController* m_controller;
 110     Vector<HTMLImportChild*> m_imports;
 111     State m_state;
 112     RefPtr<Document> m_importedDocument;
 113     RefPtr<DocumentWriter> m_writer;
 114     RefPtr<CustomElementMicrotaskQueue> m_microtaskQueue;
 115 };
 116
 117 } // namespace WebCore
 118
 119 #endif // HTMLImportLoader_h