1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License
6 : * Version 1.1 (the "License"); you may not use this file except in
7 : * compliance with the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is
18 : * Mozilla Corporation
19 : * Portions created by the Initial Developer are Copyright (C) 2009
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : * Olli Pettay <Olli.Pettay@helsinki.fi>
24 : *
25 : * Alternatively, the contents of this file may be used under the terms of
26 : * either the GNU General Public License Version 2 or later (the "GPL"), or
27 : * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
28 : * in which case the provisions of the GPL or the LGPL are applicable instead
29 : * of those above. If you wish to allow use of your version of this file only
30 : * under the terms of either the GPL or the LGPL, and not to allow others to
31 : * use your version of this file under the terms of the MPL, indicate your
32 : * decision by deleting the provisions above and replace them with the notice
33 : * and other provisions required by the GPL or the LGPL. If you do not delete
34 : * the provisions above, a recipient may use your version of this file under
35 : * the terms of any one of the MPL, the GPL or the LGPL.
36 : *
37 : * ***** END LICENSE BLOCK ***** */
38 :
39 : #ifndef nsDOMEventTargetHelper_h_
40 : #define nsDOMEventTargetHelper_h_
41 :
42 : #include "nsCOMPtr.h"
43 : #include "nsAutoPtr.h"
44 : #include "nsIDOMEventTarget.h"
45 : #include "nsIDOMEventListener.h"
46 : #include "nsCycleCollectionParticipant.h"
47 : #include "nsPIDOMWindow.h"
48 : #include "nsIScriptGlobalObject.h"
49 : #include "nsEventListenerManager.h"
50 : #include "nsIScriptContext.h"
51 : #include "nsWrapperCache.h"
52 :
53 : class nsDOMEventListenerWrapper : public nsIDOMEventListener
54 3507 : {
55 : public:
56 3507 : nsDOMEventListenerWrapper(nsIDOMEventListener* aListener)
57 3507 : : mListener(aListener) {}
58 :
59 353 : NS_DECL_CYCLE_COLLECTING_ISUPPORTS
60 38227 : NS_DECL_CYCLE_COLLECTION_CLASS(nsDOMEventListenerWrapper)
61 :
62 : NS_DECL_NSIDOMEVENTLISTENER
63 :
64 0 : nsIDOMEventListener* GetInner() { return mListener; }
65 : void Disconnect() { mListener = nsnull; }
66 : protected:
67 : nsCOMPtr<nsIDOMEventListener> mListener;
68 : };
69 :
70 : class nsDOMEventTargetHelper : public nsIDOMEventTarget,
71 : public nsWrapperCache
72 : {
73 : public:
74 0 : nsDOMEventTargetHelper() : mOwner(nsnull), mHasOrHasHadOwner(false) {}
75 : virtual ~nsDOMEventTargetHelper();
76 0 : NS_DECL_CYCLE_COLLECTING_ISUPPORTS
77 517069 : NS_DECL_CYCLE_COLLECTION_SCRIPT_HOLDER_CLASS(nsDOMEventTargetHelper)
78 :
79 : NS_DECL_NSIDOMEVENTTARGET
80 :
81 1238 : void GetParentObject(nsIScriptGlobalObject **aParentObject)
82 : {
83 1238 : if (mOwner) {
84 0 : CallQueryInterface(mOwner, aParentObject);
85 : }
86 : else {
87 1238 : *aParentObject = nsnull;
88 : }
89 1238 : }
90 :
91 7287 : static nsDOMEventTargetHelper* FromSupports(nsISupports* aSupports)
92 : {
93 : nsIDOMEventTarget* target =
94 7287 : static_cast<nsIDOMEventTarget*>(aSupports);
95 : #ifdef DEBUG
96 : {
97 : nsCOMPtr<nsIDOMEventTarget> target_qi =
98 14574 : do_QueryInterface(aSupports);
99 :
100 : // If this assertion fires the QI implementation for the object in
101 : // question doesn't use the nsIDOMEventTarget pointer as the
102 : // nsISupports pointer. That must be fixed, or we'll crash...
103 7287 : NS_ASSERTION(target_qi == target, "Uh, fix QI!");
104 : }
105 : #endif
106 :
107 7287 : return static_cast<nsDOMEventTargetHelper*>(target);
108 : }
109 :
110 : void Init(JSContext* aCx = nsnull);
111 :
112 : bool HasListenersFor(const nsAString& aType)
113 : {
114 : return mListenerManager && mListenerManager->HasListenersFor(aType);
115 : }
116 : nsresult RemoveAddEventListener(const nsAString& aType,
117 : nsRefPtr<nsDOMEventListenerWrapper>& aCurrent,
118 : nsIDOMEventListener* aNew);
119 :
120 : nsresult GetInnerEventListener(nsRefPtr<nsDOMEventListenerWrapper>& aWrapper,
121 : nsIDOMEventListener** aListener);
122 :
123 0 : nsresult CheckInnerWindowCorrectness()
124 : {
125 0 : NS_ENSURE_STATE(!mHasOrHasHadOwner || mOwner);
126 0 : if (mOwner) {
127 0 : NS_ASSERTION(mOwner->IsInnerWindow(), "Should have inner window here!\n");
128 0 : nsPIDOMWindow* outer = mOwner->GetOuterWindow();
129 0 : if (!outer || outer->GetCurrentInnerWindow() != mOwner) {
130 0 : return NS_ERROR_FAILURE;
131 : }
132 : }
133 0 : return NS_OK;
134 : }
135 :
136 : void BindToOwner(nsPIDOMWindow* aOwner);
137 : void BindToOwner(nsDOMEventTargetHelper* aOther);
138 : virtual void DisconnectFromOwner();
139 0 : nsPIDOMWindow* GetOwner() { return mOwner; }
140 0 : bool HasOrHasHadOwner() { return mHasOrHasHadOwner; }
141 : protected:
142 : nsRefPtr<nsEventListenerManager> mListenerManager;
143 : private:
144 : // These may be null (native callers or xpcshell).
145 : nsPIDOMWindow* mOwner; // Inner window.
146 : bool mHasOrHasHadOwner;
147 : };
148 :
149 : #define NS_DECL_EVENT_HANDLER(_event) \
150 : protected: \
151 : nsRefPtr<nsDOMEventListenerWrapper> mOn##_event##Listener; \
152 : public:
153 :
154 : #define NS_DECL_AND_IMPL_EVENT_HANDLER(_event) \
155 : protected: \
156 : nsRefPtr<nsDOMEventListenerWrapper> mOn##_event##Listener; \
157 : public: \
158 : NS_IMETHOD GetOn##_event(nsIDOMEventListener** a##_event) \
159 : { \
160 : return GetInnerEventListener(mOn##_event##Listener, a##_event); \
161 : } \
162 : NS_IMETHOD SetOn##_event(nsIDOMEventListener* a##_event) \
163 : { \
164 : return RemoveAddEventListener(NS_LITERAL_STRING(#_event), \
165 : mOn##_event##Listener, a##_event); \
166 : }
167 :
168 : #define NS_IMPL_EVENT_HANDLER(_class, _event) \
169 : NS_IMETHODIMP \
170 : _class::GetOn##_event(nsIDOMEventListener** a##_event) \
171 : { \
172 : return GetInnerEventListener(mOn##_event##Listener, a##_event); \
173 : } \
174 : NS_IMETHODIMP \
175 : _class::SetOn##_event(nsIDOMEventListener* a##_event) \
176 : { \
177 : return RemoveAddEventListener(NS_LITERAL_STRING(#_event), \
178 : mOn##_event##Listener, a##_event); \
179 : }
180 :
181 : #define NS_IMPL_FORWARD_EVENT_HANDLER(_class, _event, _baseclass) \
182 : NS_IMETHODIMP \
183 : _class::GetOn##_event(nsIDOMEventListener** a##_event) \
184 : { \
185 : return _baseclass::GetOn##_event(a##_event); \
186 : } \
187 : NS_IMETHODIMP \
188 : _class::SetOn##_event(nsIDOMEventListener* a##_event) \
189 : { \
190 : return _baseclass::SetOn##_event(a##_event); \
191 : }
192 :
193 : #define NS_CYCLE_COLLECTION_TRAVERSE_EVENT_HANDLER(_event) \
194 : NS_IMPL_CYCLE_COLLECTION_TRAVERSE_NSCOMPTR(mOn##_event##Listener)
195 :
196 : #define NS_CYCLE_COLLECTION_UNLINK_EVENT_HANDLER(_event) \
197 : NS_IMPL_CYCLE_COLLECTION_UNLINK_NSCOMPTR(mOn##_event##Listener)
198 :
199 : #define NS_DISCONNECT_EVENT_HANDLER(_event) \
200 : if (mOn##_event##Listener) { mOn##_event##Listener->Disconnect(); }
201 :
202 : #define NS_UNMARK_LISTENER_WRAPPER(_event) \
203 : if (tmp->mOn##_event##Listener) { \
204 : nsCOMPtr<nsIXPConnectWrappedJS> wjs = \
205 : do_QueryInterface(tmp->mOn##_event##Listener->GetInner()); \
206 : xpc_UnmarkGrayObject(wjs); \
207 : }
208 :
209 : #endif // nsDOMEventTargetHelper_h_
|