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/html/imports/HTMLImport.h"
  35 #include "platform/heap/Handle.h"
  36 #include "platform/weborigin/KURL.h"
  37 #include "wtf/WeakPtr.h"
  38
  39 namespace blink {
  40
  41 class CustomElementMicrotaskImportStep;
  42 class HTMLImportLoader;
  43 class HTMLImportChildClient;
  44 class HTMLLinkElement;
  45
  46 //
  47 // An import tree node subclas to encapsulate imported document
  48 // lifecycle. This class is owned by HTMLImportsController. The actual loading
  49 // is done by HTMLImportLoader, which can be shared among multiple
  50 // HTMLImportChild of same link URL.
  51 //
  52 class HTMLImportChild final : public HTMLImport {
  53 public:
  54     HTMLImportChild(const KURL&, HTMLImportLoader*, SyncMode);
  55     virtual ~HTMLImportChild();
  56
  57     HTMLLinkElement* link() const;
  58     const KURL& url() const { return m_url; }
  59
  60     void ownerInserted();
  61     void didShareLoader();
  62     void didStartLoading();
  63 #if !ENABLE(OILPAN)
  64     void importDestroyed();
  65     WeakPtr<HTMLImportChild> weakPtr() { return m_weakFactory.createWeakPtr(); }
  66 #endif
  67
  68     // HTMLImport
  69     virtual Document* document() const override;
  70     virtual bool isDone() const override;
  71     virtual HTMLImportLoader* loader() const override;
  72     virtual void stateWillChange() override;
  73     virtual void stateDidChange() override;
  74     virtual void trace(Visitor*) override;
  75
  76 #if !defined(NDEBUG)
  77     virtual void showThis() override;
  78 #endif
  79
  80     void setClient(HTMLImportChildClient*);
  81 #if !ENABLE(OILPAN)
  82     void clearClient();
  83 #endif
  84
  85     void didFinishLoading();
  86     void didFinishUpgradingCustomElements();
  87     void normalize();
  88
  89 private:
  90     void didFinish();
  91     void shareLoader();
  92     void createCustomElementMicrotaskStepIfNeeded();
  93     void invalidateCustomElementMicrotaskStep();
  94
  95     KURL m_url;
  96     WeakPtrWillBeWeakMember<CustomElementMicrotaskImportStep> m_customElementMicrotaskStep;
  97 #if !ENABLE(OILPAN)
  98     WeakPtrFactory<HTMLImportChild> m_weakFactory;
  99 #endif
 100     RawPtrWillBeMember<HTMLImportLoader> m_loader;
 101     RawPtrWillBeMember<HTMLImportChildClient> m_client;
 102 };
 103
 104 inline HTMLImportChild* toHTMLImportChild(HTMLImport* import)
 105 {
 106     ASSERT(!import || !import->isRoot());
 107     return static_cast<HTMLImportChild*>(import);
 108 }
 109
 110 } // namespace blink
 111
 112 #endif // HTMLImportChild_h