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

/*
 * Copyright (C) 2013 Google Inc. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are
 * met:
 *
 *     * Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 * copyright notice, this list of conditions and the following disclaimer
 * in the documentation and/or other materials provided with the
 * distribution.
 *     * Neither the name of Google Inc. nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#ifndef HTMLImportLoader_h
#define HTMLImportLoader_h

#include "core/dom/DocumentParserClient.h"
#include "core/fetch/RawResource.h"
#include "core/fetch/ResourceOwner.h"
#include "platform/heap/Handle.h"
#include "wtf/Vector.h"
#include <memory>

namespace blink {

class V0CustomElementSyncMicrotaskQueue;
class Document;
class DocumentWriter;
class HTMLImportChild;
class HTMLImportsController;

// Owning imported Document lifetime. It also implements ResourceClient through
// ResourceOwner to feed fetched bytes to the DocumentWriter of the imported
// document.  HTMLImportLoader is owned by HTMLImportsController.
class HTMLImportLoader final
    : public GarbageCollectedFinalized<HTMLImportLoader>,
      public ResourceOwner<RawResource>,
      public DocumentParserClient {
  USING_GARBAGE_COLLECTED_MIXIN(HTMLImportLoader);

 public:
  enum State {
    StateLoading,
    StateWritten,
    StateParsed,
    StateLoaded,
    StateError
  };

  static HTMLImportLoader* create(HTMLImportsController* controller) {
    return new HTMLImportLoader(controller);
  }

  ~HTMLImportLoader() override;
  void dispose();

  Document* document() const { return m_document.get(); }
  void addImport(HTMLImportChild*);
  void removeImport(HTMLImportChild*);

  void moveToFirst(HTMLImportChild*);
  HTMLImportChild* firstImport() const { return m_imports[0]; }
  bool isFirstImport(const HTMLImportChild* child) const {
    return m_imports.size() ? firstImport() == child : false;
  }

  bool isDone() const {
    return m_state == StateLoaded || m_state == StateError;
  }
  bool hasError() const { return m_state == StateError; }
  bool shouldBlockScriptExecution() const;

  void startLoading(RawResource*);

  // Tells the loader that all of the import's stylesheets finished
  // loading.
  // Called by Document::didRemoveAllPendingStylesheet.
  void didRemoveAllPendingStylesheet();

  V0CustomElementSyncMicrotaskQueue* microtaskQueue() const;

  DECLARE_VIRTUAL_TRACE();

 private:
  HTMLImportLoader(HTMLImportsController*);

  // RawResourceClient
  void responseReceived(Resource*,
                        const ResourceResponse&,
                        std::unique_ptr<WebDataConsumerHandle>) override;
  void dataReceived(Resource*, const char* data, size_t length) override;
  void notifyFinished(Resource*) override;
  String debugName() const override { return "HTMLImportLoader"; }

  // DocumentParserClient

  // Called after document parse is complete after DOMContentLoaded was
  // dispatched.
  void notifyParserStopped() override;

  State startWritingAndParsing(const ResourceResponse&);
  State finishWriting();
  State finishParsing();
  State finishLoading();

  void setState(State);
  void didFinishLoading();
  bool hasPendingResources() const;

  Member<HTMLImportsController> m_controller;
  HeapVector<Member<HTMLImportChild>> m_imports;
  State m_state;
  Member<Document> m_document;
  Member<DocumentWriter> m_writer;
  Member<V0CustomElementSyncMicrotaskQueue> m_microtaskQueue;
};

}  // namespace blink

#endif  // HTMLImportLoader_h