third_party/WebKit/Source/core/dom/PendingScript.h

   1 /*
   2  * Copyright (C) 2010 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
   6  * are met:
   7  * 1. Redistributions of source code must retain the above copyright
   8  *    notice, this list of conditions and the following disclaimer.
   9  * 2. Redistributions in binary form must reproduce the above copyright
  10  *    notice, this list of conditions and the following disclaimer in the
  11  *    documentation and/or other materials provided with the distribution.
  12  *
  13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. ``AS IS'' AND ANY
  14  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  16  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL APPLE INC. OR
  17  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
  18  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
  19  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
  20  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
  21  * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  22  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  23  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  24  */
  25
  26 #ifndef PendingScript_h
  27 #define PendingScript_h
  28
  29 #include "core/CoreExport.h"
  30 #include "core/fetch/ResourceOwner.h"
  31 #include "core/fetch/ScriptResource.h"
  32 #include "platform/heap/Handle.h"
  33 #include "wtf/PassRefPtr.h"
  34 #include "wtf/RefPtr.h"
  35 #include "wtf/text/TextPosition.h"
  36
  37 namespace blink {
  38
  39 class Element;
  40 class ScriptSourceCode;
  41 class ScriptStreamer;
  42
  43 // A container for an external script which may be loaded and executed.
  44 //
  45 // A ResourcePtr alone does not prevent the underlying Resource
  46 // from purging its data buffer. This class holds a dummy client open for its
  47 // lifetime in order to guarantee that the data buffer will not be purged.
  48 class CORE_EXPORT PendingScript final : public ResourceOwner<ScriptResource> {
  49     ALLOW_ONLY_INLINE_ALLOCATION();
  50 public:
  51     enum Type {
  52         ParsingBlocking,
  53         Deferred,
  54         Async
  55     };
  56
  57     PendingScript();
  58     PendingScript(Element*, ScriptResource*);
  59     PendingScript(const PendingScript&);
  60     ~PendingScript();
  61
  62     PendingScript& operator=(const PendingScript&);
  63
  64     TextPosition startingPosition() const { return m_startingPosition; }
  65     void setStartingPosition(const TextPosition& position) { m_startingPosition = position; }
  66
  67     void watchForLoad(ScriptResourceClient*);
  68     void stopWatchingForLoad(ScriptResourceClient*);
  69
  70     Element* element() const { return m_element.get(); }
  71     void setElement(Element*);
  72     PassRefPtrWillBeRawPtr<Element> releaseElementAndClear();
  73
  74     void setScriptResource(ScriptResource*);
  75
  76     virtual void notifyFinished(Resource*);
  77     virtual void notifyAppendData(ScriptResource*);
  78
  79     DECLARE_TRACE();
  80
  81     ScriptSourceCode getSource(const KURL& documentURL, bool& errorOccurred) const;
  82
  83     void setStreamer(PassRefPtrWillBeRawPtr<ScriptStreamer>);
  84
  85     bool isReady() const;
  86
  87 private:
  88     bool m_watchingForLoad;
  89     RefPtrWillBeMember<Element> m_element;
  90     TextPosition m_startingPosition; // Only used for inline script tags.
  91
  92     RefPtrWillBeMember<ScriptStreamer> m_streamer;
  93 };
  94
  95 } // namespace blink
  96
  97 #endif // PendingScript_h