Bug 959171 - Fix how to bind EGLImage in GrallocTextureHostOGL. r=nical
[gecko.git] / widget / nsGUIEventIPC.h
blob22d326110454f94882e7ed128e8dae6ae6403e95
1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 /* This Source Code Form is subject to the terms of the Mozilla Public
3 * License, v. 2.0. If a copy of the MPL was not distributed with this
4 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
6 #ifndef nsGUIEventIPC_h__
7 #define nsGUIEventIPC_h__
9 #include "ipc/IPCMessageUtils.h"
10 #include "mozilla/GfxMessageUtils.h"
11 #include "mozilla/dom/Touch.h"
12 #include "mozilla/MiscEvents.h"
13 #include "mozilla/MouseEvents.h"
14 #include "mozilla/TextEvents.h"
15 #include "mozilla/TouchEvents.h"
17 namespace IPC
20 template<>
21 struct ParamTraits<mozilla::BaseEventFlags>
23 typedef mozilla::BaseEventFlags paramType;
25 static void Write(Message* aMsg, const paramType& aParam)
27 aMsg->WriteBytes(&aParam, sizeof(aParam));
30 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
32 const char* outp;
33 if (!aMsg->ReadBytes(aIter, &outp, sizeof(*aResult))) {
34 return false;
36 *aResult = *reinterpret_cast<const paramType*>(outp);
37 return true;
41 template<>
42 struct ParamTraits<mozilla::WidgetEvent>
44 typedef mozilla::WidgetEvent paramType;
46 static void Write(Message* aMsg, const paramType& aParam)
48 WriteParam(aMsg, (uint8_t) aParam.eventStructType);
49 WriteParam(aMsg, aParam.message);
50 WriteParam(aMsg, aParam.refPoint);
51 WriteParam(aMsg, aParam.time);
52 WriteParam(aMsg, aParam.mFlags);
55 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
57 uint8_t eventStructType = 0;
58 bool ret = ReadParam(aMsg, aIter, &eventStructType) &&
59 ReadParam(aMsg, aIter, &aResult->message) &&
60 ReadParam(aMsg, aIter, &aResult->refPoint) &&
61 ReadParam(aMsg, aIter, &aResult->time) &&
62 ReadParam(aMsg, aIter, &aResult->mFlags);
63 aResult->eventStructType = static_cast<nsEventStructType>(eventStructType);
64 return ret;
68 template<>
69 struct ParamTraits<mozilla::WidgetGUIEvent>
71 typedef mozilla::WidgetGUIEvent paramType;
73 static void Write(Message* aMsg, const paramType& aParam)
75 WriteParam(aMsg, static_cast<mozilla::WidgetEvent>(aParam));
78 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
80 return ReadParam(aMsg, aIter, static_cast<mozilla::WidgetEvent*>(aResult));
84 template<>
85 struct ParamTraits<mozilla::WidgetInputEvent>
87 typedef mozilla::WidgetInputEvent paramType;
89 static void Write(Message* aMsg, const paramType& aParam)
91 WriteParam(aMsg, static_cast<mozilla::WidgetGUIEvent>(aParam));
92 WriteParam(aMsg, aParam.modifiers);
95 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
97 return ReadParam(aMsg, aIter,
98 static_cast<mozilla::WidgetGUIEvent*>(aResult)) &&
99 ReadParam(aMsg, aIter, &aResult->modifiers);
103 template<>
104 struct ParamTraits<mozilla::WidgetMouseEventBase>
106 typedef mozilla::WidgetMouseEventBase paramType;
108 static void Write(Message* aMsg, const paramType& aParam)
110 WriteParam(aMsg, static_cast<mozilla::WidgetInputEvent>(aParam));
111 WriteParam(aMsg, aParam.button);
112 WriteParam(aMsg, aParam.buttons);
113 WriteParam(aMsg, aParam.pressure);
114 WriteParam(aMsg, aParam.inputSource);
117 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
119 return ReadParam(aMsg, aIter,
120 static_cast<mozilla::WidgetInputEvent*>(aResult)) &&
121 ReadParam(aMsg, aIter, &aResult->button) &&
122 ReadParam(aMsg, aIter, &aResult->buttons) &&
123 ReadParam(aMsg, aIter, &aResult->pressure) &&
124 ReadParam(aMsg, aIter, &aResult->inputSource);
128 template<>
129 struct ParamTraits<mozilla::WidgetWheelEvent>
131 typedef mozilla::WidgetWheelEvent paramType;
133 static void Write(Message* aMsg, const paramType& aParam)
135 WriteParam(aMsg, static_cast<mozilla::WidgetMouseEventBase>(aParam));
136 WriteParam(aMsg, aParam.deltaX);
137 WriteParam(aMsg, aParam.deltaY);
138 WriteParam(aMsg, aParam.deltaZ);
139 WriteParam(aMsg, aParam.deltaMode);
140 WriteParam(aMsg, aParam.customizedByUserPrefs);
141 WriteParam(aMsg, aParam.isMomentum);
142 WriteParam(aMsg, aParam.isPixelOnlyDevice);
143 WriteParam(aMsg, aParam.lineOrPageDeltaX);
144 WriteParam(aMsg, aParam.lineOrPageDeltaY);
145 WriteParam(aMsg, static_cast<int32_t>(aParam.scrollType));
146 WriteParam(aMsg, aParam.overflowDeltaX);
147 WriteParam(aMsg, aParam.overflowDeltaY);
150 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
152 int32_t scrollType = 0;
153 bool rv =
154 ReadParam(aMsg, aIter,
155 static_cast<mozilla::WidgetMouseEventBase*>(aResult)) &&
156 ReadParam(aMsg, aIter, &aResult->deltaX) &&
157 ReadParam(aMsg, aIter, &aResult->deltaY) &&
158 ReadParam(aMsg, aIter, &aResult->deltaZ) &&
159 ReadParam(aMsg, aIter, &aResult->deltaMode) &&
160 ReadParam(aMsg, aIter, &aResult->customizedByUserPrefs) &&
161 ReadParam(aMsg, aIter, &aResult->isMomentum) &&
162 ReadParam(aMsg, aIter, &aResult->isPixelOnlyDevice) &&
163 ReadParam(aMsg, aIter, &aResult->lineOrPageDeltaX) &&
164 ReadParam(aMsg, aIter, &aResult->lineOrPageDeltaY) &&
165 ReadParam(aMsg, aIter, &scrollType) &&
166 ReadParam(aMsg, aIter, &aResult->overflowDeltaX) &&
167 ReadParam(aMsg, aIter, &aResult->overflowDeltaY);
168 aResult->scrollType =
169 static_cast<mozilla::WidgetWheelEvent::ScrollType>(scrollType);
170 return rv;
174 template<>
175 struct ParamTraits<mozilla::WidgetMouseEvent>
177 typedef mozilla::WidgetMouseEvent paramType;
179 static void Write(Message* aMsg, const paramType& aParam)
181 WriteParam(aMsg, static_cast<mozilla::WidgetMouseEventBase>(aParam));
182 WriteParam(aMsg, aParam.ignoreRootScrollFrame);
183 WriteParam(aMsg, (uint8_t) aParam.reason);
184 WriteParam(aMsg, (uint8_t) aParam.context);
185 WriteParam(aMsg, (uint8_t) aParam.exit);
186 WriteParam(aMsg, aParam.clickCount);
189 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
191 bool rv;
192 uint8_t reason = 0, context = 0, exit = 0;
193 rv = ReadParam(aMsg, aIter,
194 static_cast<mozilla::WidgetMouseEventBase*>(aResult)) &&
195 ReadParam(aMsg, aIter, &aResult->ignoreRootScrollFrame) &&
196 ReadParam(aMsg, aIter, &reason) &&
197 ReadParam(aMsg, aIter, &context) &&
198 ReadParam(aMsg, aIter, &exit) &&
199 ReadParam(aMsg, aIter, &aResult->clickCount);
200 aResult->reason =
201 static_cast<mozilla::WidgetMouseEvent::reasonType>(reason);
202 aResult->context =
203 static_cast<mozilla::WidgetMouseEvent::contextType>(context);
204 aResult->exit = static_cast<mozilla::WidgetMouseEvent::exitType>(exit);
205 return rv;
209 template<>
210 struct ParamTraits<mozilla::WidgetPointerEvent>
212 typedef mozilla::WidgetPointerEvent paramType;
214 static void Write(Message* aMsg, const paramType& aParam)
216 WriteParam(aMsg, static_cast<mozilla::WidgetMouseEvent>(aParam));
217 WriteParam(aMsg, aParam.pointerId);
218 WriteParam(aMsg, aParam.width);
219 WriteParam(aMsg, aParam.height);
220 WriteParam(aMsg, aParam.tiltX);
221 WriteParam(aMsg, aParam.tiltY);
222 WriteParam(aMsg, aParam.isPrimary);
225 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
227 bool rv =
228 ReadParam(aMsg, aIter, static_cast<mozilla::WidgetMouseEvent*>(aResult)) &&
229 ReadParam(aMsg, aIter, &aResult->pointerId) &&
230 ReadParam(aMsg, aIter, &aResult->width) &&
231 ReadParam(aMsg, aIter, &aResult->height) &&
232 ReadParam(aMsg, aIter, &aResult->tiltX) &&
233 ReadParam(aMsg, aIter, &aResult->tiltY) &&
234 ReadParam(aMsg, aIter, &aResult->isPrimary);
235 return rv;
239 template<>
240 struct ParamTraits<mozilla::WidgetTouchEvent>
242 typedef mozilla::WidgetTouchEvent paramType;
244 static void Write(Message* aMsg, const paramType& aParam)
246 WriteParam(aMsg, static_cast<const mozilla::WidgetInputEvent&>(aParam));
247 // Sigh, Touch bites us again! We want to be able to do
248 // WriteParam(aMsg, aParam.touches);
249 const nsTArray< nsRefPtr<mozilla::dom::Touch> >& touches = aParam.touches;
250 WriteParam(aMsg, touches.Length());
251 for (uint32_t i = 0; i < touches.Length(); ++i) {
252 mozilla::dom::Touch* touch = touches[i];
253 WriteParam(aMsg, touch->mIdentifier);
254 WriteParam(aMsg, touch->mRefPoint);
255 WriteParam(aMsg, touch->mRadius);
256 WriteParam(aMsg, touch->mRotationAngle);
257 WriteParam(aMsg, touch->mForce);
261 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
263 uint32_t numTouches;
264 if (!ReadParam(aMsg, aIter,
265 static_cast<mozilla::WidgetInputEvent*>(aResult)) ||
266 !ReadParam(aMsg, aIter, &numTouches)) {
267 return false;
269 for (uint32_t i = 0; i < numTouches; ++i) {
270 int32_t identifier;
271 mozilla::LayoutDeviceIntPoint refPoint;
272 nsIntPoint radius;
273 float rotationAngle;
274 float force;
275 if (!ReadParam(aMsg, aIter, &identifier) ||
276 !ReadParam(aMsg, aIter, &refPoint) ||
277 !ReadParam(aMsg, aIter, &radius) ||
278 !ReadParam(aMsg, aIter, &rotationAngle) ||
279 !ReadParam(aMsg, aIter, &force)) {
280 return false;
282 aResult->touches.AppendElement(
283 new mozilla::dom::Touch(
284 identifier, mozilla::LayoutDeviceIntPoint::ToUntyped(refPoint),
285 radius, rotationAngle, force));
287 return true;
291 template<>
292 struct ParamTraits<mozilla::WidgetKeyboardEvent>
294 typedef mozilla::WidgetKeyboardEvent paramType;
296 static void Write(Message* aMsg, const paramType& aParam)
298 WriteParam(aMsg, static_cast<mozilla::WidgetInputEvent>(aParam));
299 WriteParam(aMsg, static_cast<uint32_t>(aParam.mKeyNameIndex));
300 WriteParam(aMsg, aParam.mKeyValue);
301 WriteParam(aMsg, aParam.keyCode);
302 WriteParam(aMsg, aParam.charCode);
303 WriteParam(aMsg, aParam.isChar);
304 WriteParam(aMsg, aParam.mIsRepeat);
305 WriteParam(aMsg, aParam.location);
306 WriteParam(aMsg, aParam.mUniqueId);
307 // An OS-specific native event might be attached in |mNativeKeyEvent|, but
308 // that cannot be copied across process boundaries.
311 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
313 uint32_t keyNameIndex = 0;
314 if (ReadParam(aMsg, aIter,
315 static_cast<mozilla::WidgetInputEvent*>(aResult)) &&
316 ReadParam(aMsg, aIter, &keyNameIndex) &&
317 ReadParam(aMsg, aIter, &aResult->mKeyValue) &&
318 ReadParam(aMsg, aIter, &aResult->keyCode) &&
319 ReadParam(aMsg, aIter, &aResult->charCode) &&
320 ReadParam(aMsg, aIter, &aResult->isChar) &&
321 ReadParam(aMsg, aIter, &aResult->mIsRepeat) &&
322 ReadParam(aMsg, aIter, &aResult->location) &&
323 ReadParam(aMsg, aIter, &aResult->mUniqueId))
325 aResult->mKeyNameIndex = static_cast<mozilla::KeyNameIndex>(keyNameIndex);
326 aResult->mNativeKeyEvent = nullptr;
327 return true;
329 return false;
333 template<>
334 struct ParamTraits<mozilla::TextRangeStyle>
336 typedef mozilla::TextRangeStyle paramType;
338 static void Write(Message* aMsg, const paramType& aParam)
340 WriteParam(aMsg, aParam.mDefinedStyles);
341 WriteParam(aMsg, aParam.mLineStyle);
342 WriteParam(aMsg, aParam.mIsBoldLine);
343 WriteParam(aMsg, aParam.mForegroundColor);
344 WriteParam(aMsg, aParam.mBackgroundColor);
345 WriteParam(aMsg, aParam.mUnderlineColor);
348 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
350 return ReadParam(aMsg, aIter, &aResult->mDefinedStyles) &&
351 ReadParam(aMsg, aIter, &aResult->mLineStyle) &&
352 ReadParam(aMsg, aIter, &aResult->mIsBoldLine) &&
353 ReadParam(aMsg, aIter, &aResult->mForegroundColor) &&
354 ReadParam(aMsg, aIter, &aResult->mBackgroundColor) &&
355 ReadParam(aMsg, aIter, &aResult->mUnderlineColor);
359 template<>
360 struct ParamTraits<mozilla::TextRange>
362 typedef mozilla::TextRange paramType;
364 static void Write(Message* aMsg, const paramType& aParam)
366 WriteParam(aMsg, aParam.mStartOffset);
367 WriteParam(aMsg, aParam.mEndOffset);
368 WriteParam(aMsg, aParam.mRangeType);
369 WriteParam(aMsg, aParam.mRangeStyle);
372 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
374 return ReadParam(aMsg, aIter, &aResult->mStartOffset) &&
375 ReadParam(aMsg, aIter, &aResult->mEndOffset) &&
376 ReadParam(aMsg, aIter, &aResult->mRangeType) &&
377 ReadParam(aMsg, aIter, &aResult->mRangeStyle);
381 template<>
382 struct ParamTraits<mozilla::WidgetTextEvent>
384 typedef mozilla::WidgetTextEvent paramType;
386 static void Write(Message* aMsg, const paramType& aParam)
388 WriteParam(aMsg, static_cast<mozilla::WidgetGUIEvent>(aParam));
389 WriteParam(aMsg, aParam.mSeqno);
390 WriteParam(aMsg, aParam.theText);
391 WriteParam(aMsg, aParam.isChar);
392 WriteParam(aMsg, aParam.rangeCount);
393 for (uint32_t index = 0; index < aParam.rangeCount; index++)
394 WriteParam(aMsg, aParam.rangeArray[index]);
397 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
399 if (!ReadParam(aMsg, aIter,
400 static_cast<mozilla::WidgetGUIEvent*>(aResult)) ||
401 !ReadParam(aMsg, aIter, &aResult->mSeqno) ||
402 !ReadParam(aMsg, aIter, &aResult->theText) ||
403 !ReadParam(aMsg, aIter, &aResult->isChar) ||
404 !ReadParam(aMsg, aIter, &aResult->rangeCount))
405 return false;
407 if (!aResult->rangeCount) {
408 aResult->rangeArray = nullptr;
409 return true;
412 aResult->rangeArray = new mozilla::TextRange[aResult->rangeCount];
413 if (!aResult->rangeArray)
414 return false;
416 for (uint32_t index = 0; index < aResult->rangeCount; index++)
417 if (!ReadParam(aMsg, aIter, &aResult->rangeArray[index])) {
418 Free(*aResult);
419 return false;
421 return true;
424 static void Free(const paramType& aResult)
426 if (aResult.rangeArray)
427 delete [] aResult.rangeArray;
431 template<>
432 struct ParamTraits<mozilla::WidgetCompositionEvent>
434 typedef mozilla::WidgetCompositionEvent paramType;
436 static void Write(Message* aMsg, const paramType& aParam)
438 WriteParam(aMsg, static_cast<mozilla::WidgetGUIEvent>(aParam));
439 WriteParam(aMsg, aParam.mSeqno);
440 WriteParam(aMsg, aParam.data);
443 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
445 return ReadParam(aMsg, aIter,
446 static_cast<mozilla::WidgetGUIEvent*>(aResult)) &&
447 ReadParam(aMsg, aIter, &aResult->mSeqno) &&
448 ReadParam(aMsg, aIter, &aResult->data);
452 template<>
453 struct ParamTraits<mozilla::WidgetQueryContentEvent>
455 typedef mozilla::WidgetQueryContentEvent paramType;
457 static void Write(Message* aMsg, const paramType& aParam)
459 WriteParam(aMsg, static_cast<mozilla::WidgetGUIEvent>(aParam));
460 WriteParam(aMsg, aParam.mSucceeded);
461 WriteParam(aMsg, aParam.mInput.mOffset);
462 WriteParam(aMsg, aParam.mInput.mLength);
463 WriteParam(aMsg, aParam.mReply.mOffset);
464 WriteParam(aMsg, aParam.mReply.mString);
465 WriteParam(aMsg, aParam.mReply.mRect);
466 WriteParam(aMsg, aParam.mReply.mReversed);
467 WriteParam(aMsg, aParam.mReply.mHasSelection);
468 WriteParam(aMsg, aParam.mReply.mWidgetIsHit);
471 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
473 aResult->mWasAsync = true;
474 return ReadParam(aMsg, aIter,
475 static_cast<mozilla::WidgetGUIEvent*>(aResult)) &&
476 ReadParam(aMsg, aIter, &aResult->mSucceeded) &&
477 ReadParam(aMsg, aIter, &aResult->mInput.mOffset) &&
478 ReadParam(aMsg, aIter, &aResult->mInput.mLength) &&
479 ReadParam(aMsg, aIter, &aResult->mReply.mOffset) &&
480 ReadParam(aMsg, aIter, &aResult->mReply.mString) &&
481 ReadParam(aMsg, aIter, &aResult->mReply.mRect) &&
482 ReadParam(aMsg, aIter, &aResult->mReply.mReversed) &&
483 ReadParam(aMsg, aIter, &aResult->mReply.mHasSelection) &&
484 ReadParam(aMsg, aIter, &aResult->mReply.mWidgetIsHit);
488 template<>
489 struct ParamTraits<mozilla::WidgetSelectionEvent>
491 typedef mozilla::WidgetSelectionEvent paramType;
493 static void Write(Message* aMsg, const paramType& aParam)
495 WriteParam(aMsg, static_cast<mozilla::WidgetGUIEvent>(aParam));
496 WriteParam(aMsg, aParam.mSeqno);
497 WriteParam(aMsg, aParam.mOffset);
498 WriteParam(aMsg, aParam.mLength);
499 WriteParam(aMsg, aParam.mReversed);
500 WriteParam(aMsg, aParam.mExpandToClusterBoundary);
501 WriteParam(aMsg, aParam.mSucceeded);
504 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
506 return ReadParam(aMsg, aIter,
507 static_cast<mozilla::WidgetGUIEvent*>(aResult)) &&
508 ReadParam(aMsg, aIter, &aResult->mSeqno) &&
509 ReadParam(aMsg, aIter, &aResult->mOffset) &&
510 ReadParam(aMsg, aIter, &aResult->mLength) &&
511 ReadParam(aMsg, aIter, &aResult->mReversed) &&
512 ReadParam(aMsg, aIter, &aResult->mExpandToClusterBoundary) &&
513 ReadParam(aMsg, aIter, &aResult->mSucceeded);
517 template<>
518 struct ParamTraits<nsIMEUpdatePreference>
520 typedef nsIMEUpdatePreference paramType;
522 static void Write(Message* aMsg, const paramType& aParam)
524 WriteParam(aMsg, aParam.mWantUpdates);
525 WriteParam(aMsg, aParam.mWantHints);
528 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
530 return ReadParam(aMsg, aIter, &aResult->mWantUpdates) &&
531 ReadParam(aMsg, aIter, &aResult->mWantHints);
535 template<>
536 struct ParamTraits<mozilla::WidgetPluginEvent>
538 typedef mozilla::WidgetPluginEvent paramType;
540 static void Write(Message* aMsg, const paramType& aParam)
542 WriteParam(aMsg, static_cast<mozilla::WidgetGUIEvent>(aParam));
543 WriteParam(aMsg, aParam.retargetToFocusedDocument);
546 static bool Read(const Message* aMsg, void** aIter, paramType* aResult)
548 return ReadParam(aMsg, aIter,
549 static_cast<mozilla::WidgetGUIEvent*>(aResult)) &&
550 ReadParam(aMsg, aIter, &aResult->retargetToFocusedDocument);
554 } // namespace IPC
556 #endif // nsGUIEventIPC_h__