Home | History | Annotate | Download | only in imports 
      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 "platform/heap/Handle.h"
     37 #include "wtf/OwnPtr.h"
     38 #include "wtf/PassOwnPtr.h"
     39 #include "wtf/Vector.h"
     40 
     41 namespace WebCore {
     42 
     43 class CustomElementSyncMicrotaskQueue;
     44 class Document;
     45 class DocumentWriter;
     46 class HTMLImportChild;
     47 class HTMLImportsController;
     48 
     49 
     50 //
     51 // Owning imported Document lifetime. It also implements ResourceClient through ResourceOwner
     52 // to feed fetched bytes to the DocumentWriter of the imported document.
     53 // HTMLImportLoader is owned by HTMLImportsController.
     54 //
     55 //
     56 class HTMLImportLoader FINAL : public NoBaseWillBeGarbageCollectedFinalized<HTMLImportLoader>, public ResourceOwner<RawResource> {
     57 public:
     58     enum State {
     59         StateLoading,
     60         StateWritten,
     61         StateParsed,
     62         StateLoaded,
     63         StateError
     64     };
     65 
     66     static PassOwnPtrWillBeRawPtr<HTMLImportLoader> create(HTMLImportsController* controller)
     67     {
     68         return adoptPtrWillBeNoop(new HTMLImportLoader(controller));
     69     }
     70 
     71     virtual ~HTMLImportLoader();
     72 
     73     Document* document() const { return m_document.get(); }
     74     void addImport(HTMLImportChild*);
     75 #if !ENABLE(OILPAN)
     76     void removeImport(HTMLImportChild*);
     77 #endif
     78     void moveToFirst(HTMLImportChild*);
     79     HTMLImportChild* firstImport() const { return m_imports[0]; }
     80     bool isFirstImport(const HTMLImportChild* child) const { return m_imports.size() ? firstImport() == child : false; }
     81 
     82     bool isDone() const { return m_state == StateLoaded || m_state == StateError; }
     83     bool hasError() const { return m_state == StateError; }
     84     bool shouldBlockScriptExecution() const;
     85 
     86 #if !ENABLE(OILPAN)
     87     void importDestroyed();
     88 #endif
     89     void startLoading(const ResourcePtr<RawResource>&);
     90 
     91     // Tells the loader that the parser is done with this import.
     92     // Called by Document::finishedParsing, after DOMContentLoaded was dispatched.
     93     void didFinishParsing();
     94     // Tells the loader that all of the import's stylesheets finished
     95     // loading.
     96     // Called by Document::didRemoveAllPendingStylesheet.
     97     void didRemoveAllPendingStylesheet();
     98 
     99     PassRefPtrWillBeRawPtr<CustomElementSyncMicrotaskQueue> microtaskQueue() const;
    100 
    101     virtual void trace(Visitor*);
    102 
    103 private:
    104     HTMLImportLoader(HTMLImportsController*);
    105 
    106     // RawResourceClient
    107     virtual void responseReceived(Resource*, const ResourceResponse&) OVERRIDE;
    108     virtual void dataReceived(Resource*, const char* data, int length) OVERRIDE;
    109     virtual void notifyFinished(Resource*) OVERRIDE;
    110 
    111     State startWritingAndParsing(const ResourceResponse&);
    112     State finishWriting();
    113     State finishParsing();
    114     State finishLoading();
    115 
    116     void setState(State);
    117     void didFinishLoading();
    118     bool hasPendingResources() const;
    119 #if !ENABLE(OILPAN)
    120     void clear();
    121 #endif
    122 
    123     RawPtrWillBeMember<HTMLImportsController> m_controller;
    124     WillBeHeapVector<RawPtrWillBeMember<HTMLImportChild> > m_imports;
    125     State m_state;
    126     RefPtrWillBeMember<Document> m_document;
    127     RefPtrWillBeMember<DocumentWriter> m_writer;
    128     RefPtrWillBeMember<CustomElementSyncMicrotaskQueue> m_microtaskQueue;
    129 };
    130 
    131 } // namespace WebCore
    132 
    133 #endif // HTMLImportLoader_h
    134