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"
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
)
33 if (!aMsg
->ReadBytes(aIter
, &outp
, sizeof(*aResult
))) {
36 *aResult
= *reinterpret_cast<const paramType
*>(outp
);
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
);
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
));
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
);
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
);
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;
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
);
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
)
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
);
201 static_cast<mozilla::WidgetMouseEvent::reasonType
>(reason
);
203 static_cast<mozilla::WidgetMouseEvent::contextType
>(context
);
204 aResult
->exit
= static_cast<mozilla::WidgetMouseEvent::exitType
>(exit
);
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
)
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
);
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
)
264 if (!ReadParam(aMsg
, aIter
,
265 static_cast<mozilla::WidgetInputEvent
*>(aResult
)) ||
266 !ReadParam(aMsg
, aIter
, &numTouches
)) {
269 for (uint32_t i
= 0; i
< numTouches
; ++i
) {
271 mozilla::LayoutDeviceIntPoint refPoint
;
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
)) {
282 aResult
->touches
.AppendElement(
283 new mozilla::dom::Touch(
284 identifier
, mozilla::LayoutDeviceIntPoint::ToUntyped(refPoint
),
285 radius
, rotationAngle
, force
));
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
.keyCode
);
301 WriteParam(aMsg
, aParam
.charCode
);
302 WriteParam(aMsg
, aParam
.isChar
);
303 WriteParam(aMsg
, aParam
.mIsRepeat
);
304 WriteParam(aMsg
, aParam
.location
);
305 WriteParam(aMsg
, aParam
.mUniqueId
);
306 // An OS-specific native event might be attached in |mNativeKeyEvent|, but
307 // that cannot be copied across process boundaries.
310 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
312 uint32_t keyNameIndex
= 0;
313 if (ReadParam(aMsg
, aIter
,
314 static_cast<mozilla::WidgetInputEvent
*>(aResult
)) &&
315 ReadParam(aMsg
, aIter
, &keyNameIndex
) &&
316 ReadParam(aMsg
, aIter
, &aResult
->keyCode
) &&
317 ReadParam(aMsg
, aIter
, &aResult
->charCode
) &&
318 ReadParam(aMsg
, aIter
, &aResult
->isChar
) &&
319 ReadParam(aMsg
, aIter
, &aResult
->mIsRepeat
) &&
320 ReadParam(aMsg
, aIter
, &aResult
->location
) &&
321 ReadParam(aMsg
, aIter
, &aResult
->mUniqueId
))
323 aResult
->mKeyNameIndex
= static_cast<mozilla::KeyNameIndex
>(keyNameIndex
);
324 aResult
->mNativeKeyEvent
= nullptr;
332 struct ParamTraits
<mozilla::TextRangeStyle
>
334 typedef mozilla::TextRangeStyle paramType
;
336 static void Write(Message
* aMsg
, const paramType
& aParam
)
338 WriteParam(aMsg
, aParam
.mDefinedStyles
);
339 WriteParam(aMsg
, aParam
.mLineStyle
);
340 WriteParam(aMsg
, aParam
.mIsBoldLine
);
341 WriteParam(aMsg
, aParam
.mForegroundColor
);
342 WriteParam(aMsg
, aParam
.mBackgroundColor
);
343 WriteParam(aMsg
, aParam
.mUnderlineColor
);
346 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
348 return ReadParam(aMsg
, aIter
, &aResult
->mDefinedStyles
) &&
349 ReadParam(aMsg
, aIter
, &aResult
->mLineStyle
) &&
350 ReadParam(aMsg
, aIter
, &aResult
->mIsBoldLine
) &&
351 ReadParam(aMsg
, aIter
, &aResult
->mForegroundColor
) &&
352 ReadParam(aMsg
, aIter
, &aResult
->mBackgroundColor
) &&
353 ReadParam(aMsg
, aIter
, &aResult
->mUnderlineColor
);
358 struct ParamTraits
<mozilla::TextRange
>
360 typedef mozilla::TextRange paramType
;
362 static void Write(Message
* aMsg
, const paramType
& aParam
)
364 WriteParam(aMsg
, aParam
.mStartOffset
);
365 WriteParam(aMsg
, aParam
.mEndOffset
);
366 WriteParam(aMsg
, aParam
.mRangeType
);
367 WriteParam(aMsg
, aParam
.mRangeStyle
);
370 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
372 return ReadParam(aMsg
, aIter
, &aResult
->mStartOffset
) &&
373 ReadParam(aMsg
, aIter
, &aResult
->mEndOffset
) &&
374 ReadParam(aMsg
, aIter
, &aResult
->mRangeType
) &&
375 ReadParam(aMsg
, aIter
, &aResult
->mRangeStyle
);
380 struct ParamTraits
<mozilla::WidgetTextEvent
>
382 typedef mozilla::WidgetTextEvent paramType
;
384 static void Write(Message
* aMsg
, const paramType
& aParam
)
386 WriteParam(aMsg
, static_cast<mozilla::WidgetGUIEvent
>(aParam
));
387 WriteParam(aMsg
, aParam
.seqno
);
388 WriteParam(aMsg
, aParam
.theText
);
389 WriteParam(aMsg
, aParam
.isChar
);
390 WriteParam(aMsg
, aParam
.rangeCount
);
391 for (uint32_t index
= 0; index
< aParam
.rangeCount
; index
++)
392 WriteParam(aMsg
, aParam
.rangeArray
[index
]);
395 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
397 if (!ReadParam(aMsg
, aIter
,
398 static_cast<mozilla::WidgetGUIEvent
*>(aResult
)) ||
399 !ReadParam(aMsg
, aIter
, &aResult
->seqno
) ||
400 !ReadParam(aMsg
, aIter
, &aResult
->theText
) ||
401 !ReadParam(aMsg
, aIter
, &aResult
->isChar
) ||
402 !ReadParam(aMsg
, aIter
, &aResult
->rangeCount
))
405 if (!aResult
->rangeCount
) {
406 aResult
->rangeArray
= nullptr;
410 aResult
->rangeArray
= new mozilla::TextRange
[aResult
->rangeCount
];
411 if (!aResult
->rangeArray
)
414 for (uint32_t index
= 0; index
< aResult
->rangeCount
; index
++)
415 if (!ReadParam(aMsg
, aIter
, &aResult
->rangeArray
[index
])) {
422 static void Free(const paramType
& aResult
)
424 if (aResult
.rangeArray
)
425 delete [] aResult
.rangeArray
;
430 struct ParamTraits
<mozilla::WidgetCompositionEvent
>
432 typedef mozilla::WidgetCompositionEvent paramType
;
434 static void Write(Message
* aMsg
, const paramType
& aParam
)
436 WriteParam(aMsg
, static_cast<mozilla::WidgetGUIEvent
>(aParam
));
437 WriteParam(aMsg
, aParam
.seqno
);
438 WriteParam(aMsg
, aParam
.data
);
441 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
443 return ReadParam(aMsg
, aIter
,
444 static_cast<mozilla::WidgetGUIEvent
*>(aResult
)) &&
445 ReadParam(aMsg
, aIter
, &aResult
->seqno
) &&
446 ReadParam(aMsg
, aIter
, &aResult
->data
);
451 struct ParamTraits
<mozilla::WidgetQueryContentEvent
>
453 typedef mozilla::WidgetQueryContentEvent paramType
;
455 static void Write(Message
* aMsg
, const paramType
& aParam
)
457 WriteParam(aMsg
, static_cast<mozilla::WidgetGUIEvent
>(aParam
));
458 WriteParam(aMsg
, aParam
.mSucceeded
);
459 WriteParam(aMsg
, aParam
.mInput
.mOffset
);
460 WriteParam(aMsg
, aParam
.mInput
.mLength
);
461 WriteParam(aMsg
, aParam
.mReply
.mOffset
);
462 WriteParam(aMsg
, aParam
.mReply
.mString
);
463 WriteParam(aMsg
, aParam
.mReply
.mRect
);
464 WriteParam(aMsg
, aParam
.mReply
.mReversed
);
465 WriteParam(aMsg
, aParam
.mReply
.mHasSelection
);
466 WriteParam(aMsg
, aParam
.mReply
.mWidgetIsHit
);
469 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
471 aResult
->mWasAsync
= true;
472 return ReadParam(aMsg
, aIter
,
473 static_cast<mozilla::WidgetGUIEvent
*>(aResult
)) &&
474 ReadParam(aMsg
, aIter
, &aResult
->mSucceeded
) &&
475 ReadParam(aMsg
, aIter
, &aResult
->mInput
.mOffset
) &&
476 ReadParam(aMsg
, aIter
, &aResult
->mInput
.mLength
) &&
477 ReadParam(aMsg
, aIter
, &aResult
->mReply
.mOffset
) &&
478 ReadParam(aMsg
, aIter
, &aResult
->mReply
.mString
) &&
479 ReadParam(aMsg
, aIter
, &aResult
->mReply
.mRect
) &&
480 ReadParam(aMsg
, aIter
, &aResult
->mReply
.mReversed
) &&
481 ReadParam(aMsg
, aIter
, &aResult
->mReply
.mHasSelection
) &&
482 ReadParam(aMsg
, aIter
, &aResult
->mReply
.mWidgetIsHit
);
487 struct ParamTraits
<mozilla::WidgetSelectionEvent
>
489 typedef mozilla::WidgetSelectionEvent paramType
;
491 static void Write(Message
* aMsg
, const paramType
& aParam
)
493 WriteParam(aMsg
, static_cast<mozilla::WidgetGUIEvent
>(aParam
));
494 WriteParam(aMsg
, aParam
.seqno
);
495 WriteParam(aMsg
, aParam
.mOffset
);
496 WriteParam(aMsg
, aParam
.mLength
);
497 WriteParam(aMsg
, aParam
.mReversed
);
498 WriteParam(aMsg
, aParam
.mExpandToClusterBoundary
);
499 WriteParam(aMsg
, aParam
.mSucceeded
);
502 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
504 return ReadParam(aMsg
, aIter
,
505 static_cast<mozilla::WidgetGUIEvent
*>(aResult
)) &&
506 ReadParam(aMsg
, aIter
, &aResult
->seqno
) &&
507 ReadParam(aMsg
, aIter
, &aResult
->mOffset
) &&
508 ReadParam(aMsg
, aIter
, &aResult
->mLength
) &&
509 ReadParam(aMsg
, aIter
, &aResult
->mReversed
) &&
510 ReadParam(aMsg
, aIter
, &aResult
->mExpandToClusterBoundary
) &&
511 ReadParam(aMsg
, aIter
, &aResult
->mSucceeded
);
516 struct ParamTraits
<nsIMEUpdatePreference
>
518 typedef nsIMEUpdatePreference paramType
;
520 static void Write(Message
* aMsg
, const paramType
& aParam
)
522 WriteParam(aMsg
, aParam
.mWantUpdates
);
523 WriteParam(aMsg
, aParam
.mWantHints
);
526 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
528 return ReadParam(aMsg
, aIter
, &aResult
->mWantUpdates
) &&
529 ReadParam(aMsg
, aIter
, &aResult
->mWantHints
);
534 struct ParamTraits
<mozilla::WidgetPluginEvent
>
536 typedef mozilla::WidgetPluginEvent paramType
;
538 static void Write(Message
* aMsg
, const paramType
& aParam
)
540 WriteParam(aMsg
, static_cast<mozilla::WidgetGUIEvent
>(aParam
));
541 WriteParam(aMsg
, aParam
.retargetToFocusedDocument
);
544 static bool Read(const Message
* aMsg
, void** aIter
, paramType
* aResult
)
546 return ReadParam(aMsg
, aIter
,
547 static_cast<mozilla::WidgetGUIEvent
*>(aResult
)) &&
548 ReadParam(aMsg
, aIter
, &aResult
->retargetToFocusedDocument
);
554 #endif // nsGUIEventIPC_h__