src/third_party/WebKit/Source/core/html/imports/HTMLImportChild.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 HTMLImportChild_h
  32 #define HTMLImportChild_h
  33
  34 #include "core/fetch/RawResource.h"
  35 #include "core/fetch/ResourceOwner.h"
  36 #include "core/html/imports/HTMLImport.h"
  37 #include "platform/heap/Handle.h"
  38 #include "platform/weborigin/KURL.h"
  39 #include "wtf/Vector.h"
  40 #include "wtf/WeakPtr.h"
  41
  42 namespace WebCore {
  43
  44 class CustomElementMicrotaskImportStep;
  45 class HTMLImportLoader;
  46 class HTMLImportChildClient;
  47 class HTMLLinkElement;
  48
  49 //
  50 // An import tree node subclas to encapsulate imported document
  51 // lifecycle. This class is owned by LinkStyle. The actual loading
  52 // is done by HTMLImportLoader, which can be shared among multiple
  53 // HTMLImportChild of same link URL.
  54 //
  55 // HTMLImportChild implements ResourceClient through ResourceOwner
  56 // so that it can speculatively request linked resources while it is unblocked.
  57 //
  58 class HTMLImportChild FINAL : public HTMLImport, public ResourceOwner<RawResource> {
  59 public:
  60     HTMLImportChild(Document&, const KURL&, SyncMode);
  61     virtual ~HTMLImportChild();
  62
  63     HTMLLinkElement* link() const;
  64     Document* importedDocument() const;
  65     const KURL& url() const { return m_url; }
  66
  67     void wasAlreadyLoaded();
  68     void startLoading(const ResourcePtr<RawResource>&);
  69     void importDestroyed();
  70     WeakPtr<HTMLImportChild> weakPtr() { return m_weakFactory.createWeakPtr(); }
  71
  72     // HTMLImport
  73     virtual bool isChild() const OVERRIDE { return true; }
  74     virtual Document* document() const OVERRIDE;
  75     virtual bool isDone() const OVERRIDE;
  76     virtual HTMLImportLoader* loader() const OVERRIDE { return m_loader; }
  77     virtual void stateWillChange() OVERRIDE;
  78     virtual void stateDidChange() OVERRIDE;
  79
  80 #if !defined(NDEBUG)
  81     virtual void showThis() OVERRIDE;
  82 #endif
  83
  84     void setClient(HTMLImportChildClient*);
  85     void clearClient();
  86     bool loaderHasError() const;
  87
  88     void didFinishLoading();
  89     void didFinishUpgradingCustomElements();
  90     bool isLoaded() const;
  91     void normalize();
  92
  93 private:
  94     // RawResourceOwner doing nothing.
  95     // HTMLImportChild owns the resource so that the contents of prefetched Resource doesn't go away.
  96     virtual void responseReceived(Resource*, const ResourceResponse&) OVERRIDE { }
  97     virtual void dataReceived(Resource*, const char*, int) OVERRIDE { }
  98     virtual void notifyFinished(Resource*) OVERRIDE { }
  99
 100     void didFinish();
 101     void createLoader();
 102     void shareLoader(HTMLImportChild*);
 103     void ensureLoader();
 104
 105 #if ENABLE(OILPAN)
 106     Persistent<Document> m_master;
 107 #else
 108     Document& m_master;
 109 #endif
 110     KURL m_url;
 111     WeakPtrFactory<HTMLImportChild> m_weakFactory;
 112     WeakPtr<CustomElementMicrotaskImportStep> m_customElementMicrotaskStep;
 113     HTMLImportLoader* m_loader;
 114     HTMLImportChildClient* m_client;
 115 };
 116
 117 inline HTMLImportChild* toHTMLImportChild(HTMLImport* import)
 118 {
 119     ASSERT(!import || import->isChild());
 120     return static_cast<HTMLImportChild*>(import);
 121 }
 122
 123 } // namespace WebCore
 124
 125 #endif // HTMLImportChild_h