Async loading of image resources
[WebKit-https.git] / Source / WebCore / loader / ImageLoader.h
1 /*
2  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
3  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
4  * Copyright (C) 2004, 2009 Apple Inc. All rights reserved.
5  *
6  * This library is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU Library General Public
8  * License as published by the Free Software Foundation; either
9  * version 2 of the License, or (at your option) any later version.
10  *
11  * This library is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14  * Library General Public License for more details.
15  *
16  * You should have received a copy of the GNU Library General Public License
17  * along with this library; see the file COPYING.LIB.  If not, write to
18  * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19  * Boston, MA 02110-1301, USA.
20  *
21  */
22
23 #ifndef ImageLoader_h
24 #define ImageLoader_h
25
26 #include "CachedImageClient.h"
27 #include "CachedResourceHandle.h"
28 #include "CachedResourceLoader.h"
29 #include "MicroTask.h"
30 #include "Timer.h"
31 #include <wtf/RefCounted.h>
32 #include <wtf/WeakPtr.h>
33 #include <wtf/text/AtomicString.h>
34
35 namespace WebCore {
36
37 class Document;
38 class Element;
39 class ImageLoader;
40 class RenderImageResource;
41 class URL;
42 class Task;
43
44 template<typename T> class EventSender;
45 typedef EventSender<ImageLoader> ImageEventSender;
46
47 class ImageLoader : public CachedImageClient {
48     WTF_MAKE_FAST_ALLOCATED;
49 public:
50     virtual ~ImageLoader();
51
52     // This function should be called when the element is attached to a document; starts
53     // loading if a load hasn't already been started.
54     void updateFromElement();
55
56     // This function should be called whenever the 'src' attribute is set, even if its value
57     // doesn't change; starts new load unconditionally (matches Firefox and Opera behavior).
58     void updateFromElementIgnoringPreviousError();
59
60     void elementDidMoveToNewDocument(Document* oldDocument);
61
62     Element& element() { return m_element; }
63     const Element& element() const { return m_element; }
64
65     bool imageComplete() const { return m_imageComplete && !m_hasPendingTask; }
66
67     CachedImage* image() const { return m_image.get(); }
68     void clearImage(); // Cancels pending beforeload and load events, and doesn't dispatch new ones.
69
70     void setLoadManually(bool loadManually) { m_loadManually = loadManually; }
71
72     bool hasPendingBeforeLoadEvent() const { return m_hasPendingBeforeLoadEvent; }
73     bool hasPendingActivity() const { return m_hasPendingLoadEvent || m_hasPendingErrorEvent || m_hasPendingTask; }
74
75     void dispatchPendingEvent(ImageEventSender*);
76
77     static void dispatchPendingBeforeLoadEvents();
78     static void dispatchPendingLoadEvents();
79     static void dispatchPendingErrorEvents();
80
81     bool hasPendingTask() const { return m_hasPendingTask; }
82
83 protected:
84     explicit ImageLoader(Element&);
85     virtual void notifyFinished(CachedResource*) override;
86
87 private:
88     class ImageLoaderTask;
89
90     // Called from the task or from updateFromElement to initiate the load.
91     void doUpdateFromElement(CachedResourceLoader::ShouldBypassMainWorldContentSecurityPolicy);
92     virtual void dispatchLoadEvent() = 0;
93     virtual String sourceURI(const AtomicString&) const = 0;
94
95     void updatedHasPendingEvent();
96
97     void dispatchPendingBeforeLoadEvent();
98     void dispatchPendingLoadEvent();
99     void dispatchPendingErrorEvent();
100
101     RenderImageResource* renderImageResource();
102     void updateRenderer();
103
104     void clearImageWithoutConsideringPendingLoadEvent();
105     void clearFailedLoadURL();
106
107     void timerFired();
108
109     // Determine whether to initiate a synchronous load or to schedule a microtask.
110     bool shouldLoadImmediately(const AtomicString& attribtue) const;
111     WeakPtr<ImageLoader> createWeakPtr() { return m_weakFactory.createWeakPtr(); }
112
113     Element& m_element;
114     CachedResourceHandle<CachedImage> m_image;
115     Timer m_derefElementTimer;
116     WeakPtrFactory<ImageLoader> m_weakFactory;
117     AtomicString m_failedLoadURL;
118     bool m_hasPendingBeforeLoadEvent : 1;
119     bool m_hasPendingLoadEvent : 1;
120     bool m_hasPendingErrorEvent : 1;
121     bool m_imageComplete : 1;
122     bool m_loadManually : 1;
123     bool m_elementIsProtected : 1;
124     bool m_hasPendingTask : 1;
125 };
126
127 }
128
129 #endif