Make some things that return never-null pointers return references instead.
[WebKit-https.git] / Source / WebCore / loader / appcache / DOMApplicationCache.h
1 /*
2  * Copyright (C) 2008, 2009 Apple 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 DOMApplicationCache_h
27 #define DOMApplicationCache_h
28
29 #include "ApplicationCacheHost.h"
30 #include "DOMWindowProperty.h"
31 #include "EventNames.h"
32 #include "EventTarget.h"
33 #include "ScriptWrappable.h"
34 #include <wtf/Forward.h>
35 #include <wtf/HashMap.h>
36 #include <wtf/PassRefPtr.h>
37 #include <wtf/RefCounted.h>
38 #include <wtf/Vector.h>
39 #include <wtf/text/AtomicStringHash.h>
40
41 namespace WebCore {
42
43 class Frame;
44 class KURL;
45
46 class DOMApplicationCache : public ScriptWrappable, public RefCounted<DOMApplicationCache>, public EventTarget, public DOMWindowProperty {
47 public:
48     static PassRefPtr<DOMApplicationCache> create(Frame* frame) { return adoptRef(new DOMApplicationCache(frame)); }
49     ~DOMApplicationCache() { ASSERT(!m_frame); }
50
51     virtual void disconnectFrameForPageCache() OVERRIDE;
52     virtual void reconnectFrameFromPageCache(Frame*) OVERRIDE;
53     virtual void willDestroyGlobalObjectInFrame() OVERRIDE;
54
55     unsigned short status() const;
56     void update(ExceptionCode&);
57     void swapCache(ExceptionCode&);
58     void abort();
59
60     // EventTarget impl
61
62     using RefCounted<DOMApplicationCache>::ref;
63     using RefCounted<DOMApplicationCache>::deref;
64
65     // Explicitly named attribute event listener helpers
66
67     DEFINE_ATTRIBUTE_EVENT_LISTENER(checking);
68     DEFINE_ATTRIBUTE_EVENT_LISTENER(error);
69     DEFINE_ATTRIBUTE_EVENT_LISTENER(noupdate);
70     DEFINE_ATTRIBUTE_EVENT_LISTENER(downloading);
71     DEFINE_ATTRIBUTE_EVENT_LISTENER(progress);
72     DEFINE_ATTRIBUTE_EVENT_LISTENER(updateready);
73     DEFINE_ATTRIBUTE_EVENT_LISTENER(cached);
74     DEFINE_ATTRIBUTE_EVENT_LISTENER(obsolete);
75
76     virtual const AtomicString& interfaceName() const;
77     virtual ScriptExecutionContext* scriptExecutionContext() const;
78
79     static const AtomicString& toEventType(ApplicationCacheHost::EventID id);
80
81 private:
82     explicit DOMApplicationCache(Frame*);
83
84     virtual void refEventTarget() { ref(); }
85     virtual void derefEventTarget() { deref(); }
86     virtual EventTargetData* eventTargetData() OVERRIDE;
87     virtual EventTargetData& ensureEventTargetData() OVERRIDE;
88
89     ApplicationCacheHost* applicationCacheHost() const;
90
91     EventTargetData m_eventTargetData;
92 };
93
94 } // namespace WebCore
95
96 #endif // DOMApplicationCache_h