VirtualBox

source: vbox/trunk/include/VBox/HostServices/DragAndDropSvc.h@ 69107

Last change on this file since 69107 was 69107, checked in by vboxsync, 7 years ago

include/VBox/: (C) year
  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 38.4 KB
Line 
1/** @file
2 * Drag and Drop service - Common header for host service and guest clients.
3 */
4
5/*
6 * Copyright (C) 2011-2017 Oracle Corporation
7 *
8 * This file is part of VirtualBox Open Source Edition (OSE), as
9 * available from http://www.virtualbox.org. This file is free software;
10 * you can redistribute it and/or modify it under the terms of the GNU
11 * General Public License (GPL) as published by the Free Software
12 * Foundation, in version 2 as it comes in the "COPYING" file of the
13 * VirtualBox OSE distribution. VirtualBox OSE is distributed in the
14 * hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
15 *
16 * The contents of this file may alternatively be used under the terms
17 * of the Common Development and Distribution License Version 1.0
18 * (CDDL) only, as it comes in the "COPYING.CDDL" file of the
19 * VirtualBox OSE distribution, in which case the provisions of the
20 * CDDL are applicable instead of those of the GPL.
21 *
22 * You may elect to license modified versions of this file under the
23 * terms and conditions of either the GPL or the CDDL or both.
24 */
25
26/**
27 * Protocol handling and notes:
28 * All client/server components should be backwards compatible.
29 *
30 ******************************************************************************
31 *
32 * Protocol changelog:
33 *
34 * Protocol v1 (VBox < 5.0, deprecated):
35 * | Initial implementation which only implemented host to guest transfers.
36 * | For file transfers all file information such as the file name and file size were
37 * transferred with every file data chunk being sent.
38 *
39 * Protocol v2 (VBox 5.0 - VBox 5.0.8, deprecated):
40 * + Added support for guest to host transfers.
41 * + Added protocol version support through VBOXDNDCONNECTMSG. The host takes the installed
42 * Guest Additions version as indicator which protocol to use for communicating with the guest.
43 * The guest itself uses VBOXDNDCONNECTMSG to report its supported protocol version to the DnD service.
44 *
45 * Protocol v3 (VBox 5.0.10 and up, current):
46 * + Added VBOXDNDDISCONNECTMSG for being able to track client disconnects on host side (Main).
47 * + Added context IDs for every HGCM message. Not used yet and must be 0.
48 * + Added VBOXDNDSNDDATAHDR and VBOXDNDCBSNDDATAHDRDATA to support (simple) accounting of objects
49 * being transferred, along with supplying separate meta data size (which is part of the total size being sent).
50 * + Added new HOST_DND_HG_SND_DATA_HDR + GUEST_DND_GH_SND_DATA_HDR commands which now allow specifying an optional
51 * compression type and defining a checksum for the overall data transfer.
52 * + Enhannced VBOXDNDGHSENDDATAMSG to support (rolling) checksums for the supplied data block.
53 * + VBOXDNDHGSENDDATAMSG and VBOXDNDGHSENDDATAMSG can now contain an optional checksum for the current data block.
54 * | VBOXDNDHGSENDFILEDATAMSG and VBOXDNDGHSENDFILEDATAMSG are now sharing the same HGCM mesasge.
55 * - Removed unused HOST_DND_GH_RECV_DIR, HOST_DND_GH_RECV_FILE_DATA and HOST_DND_GH_RECV_FILE_HDR commands.
56 */
57
58#ifndef ___VBox_HostService_DragAndDropSvc_h
59#define ___VBox_HostService_DragAndDropSvc_h
60
61#include <VBox/hgcmsvc.h>
62#include <VBox/VMMDevCoreTypes.h>
63#include <VBox/VBoxGuestCoreTypes.h>
64
65/*
66 * The mode of operations.
67 */
68#define VBOX_DRAG_AND_DROP_MODE_OFF 0
69#define VBOX_DRAG_AND_DROP_MODE_HOST_TO_GUEST 1
70#define VBOX_DRAG_AND_DROP_MODE_GUEST_TO_HOST 2
71#define VBOX_DRAG_AND_DROP_MODE_BIDIRECTIONAL 3
72
73#define DND_IGNORE_ACTION UINT32_C(0)
74#define DND_COPY_ACTION RT_BIT_32(0)
75#define DND_MOVE_ACTION RT_BIT_32(1)
76#define DND_LINK_ACTION RT_BIT_32(2)
77
78#define hasDnDCopyAction(a) ((a) & DND_COPY_ACTION)
79#define hasDnDMoveAction(a) ((a) & DND_MOVE_ACTION)
80#define hasDnDLinkAction(a) ((a) & DND_LINK_ACTION)
81
82#define isDnDIgnoreAction(a) ((a) == DND_IGNORE_ACTION)
83#define isDnDCopyAction(a) ((a) == DND_COPY_ACTION)
84#define isDnDMoveAction(a) ((a) == DND_MOVE_ACTION)
85#define isDnDLinkAction(a) ((a) == DND_LINK_ACTION)
86
87/** @def VBOX_DND_FORMATS_DEFAULT
88 * Default drag'n drop formats.
89 * Note: If you add new entries here, make sure you test those
90 * with all supported guest OSes!
91 */
92#define VBOX_DND_FORMATS_DEFAULT \
93 "text/uri-list", \
94 /* Text. */ \
95 "text/html", \
96 "text/plain;charset=utf-8", \
97 "text/plain;charset=utf-16", \
98 "text/plain", \
99 "text/richtext", \
100 "UTF8_STRING", \
101 "TEXT", \
102 "STRING", \
103 /* OpenOffice formats. */ \
104 /* See: https://wiki.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Common_Application_Features#OpenOffice.org_Clipboard_Data_Formats */ \
105 "application/x-openoffice-embed-source-xml;windows_formatname=\"Star Embed Source (XML)\"", \
106 "application/x-openoffice;windows_formatname=\"Bitmap\""
107
108namespace DragAndDropSvc {
109
110/******************************************************************************
111* Typedefs, constants and inlines *
112******************************************************************************/
113
114/**
115 * The service functions which are callable by host.
116 * Note: When adding new functions to this table, make sure that the actual ID
117 * does *not* overlap with the eGuestFn enumeration below!
118 */
119enum eHostFn
120{
121 /** The host just has set a new DnD mode. */
122 HOST_DND_SET_MODE = 100,
123
124 /*
125 * Host -> Guest messages
126 */
127
128 /** The host entered the VM window for starting an actual
129 * DnD operation. */
130 HOST_DND_HG_EVT_ENTER = 200,
131 /** The host's DnD cursor moved within the VM window. */
132 HOST_DND_HG_EVT_MOVE = 201,
133 /** The host left the guest VM window. */
134 HOST_DND_HG_EVT_LEAVE = 202,
135 /** The host issued a "drop" event, meaning that the host is
136 * ready to transfer data over to the guest. */
137 HOST_DND_HG_EVT_DROPPED = 203,
138 /** The host requested to cancel the current DnD operation on
139 * the guest side. This can happen on user request on the host's
140 * UI side or due to some host error which has happened.
141 *
142 * Note: This is a fire-and-forget message, as the host should
143 * not rely on an answer from the guest side in order to
144 * properly cancel the operation. */
145 HOST_DND_HG_EVT_CANCEL = 204,
146 /** Sends the data header at the beginning of a (new)
147 * data transfer. */
148 HOST_DND_HG_SND_DATA_HDR = 210,
149 /**
150 * Sends the actual meta data, based on
151 * the format(s) specified by HOST_DND_HG_EVT_ENTER.
152 *
153 * Protocol v1/v2: If the guest supplied buffer too small to send
154 * the actual data, the host will send a HOST_DND_HG_SND_MORE_DATA
155 * message as follow-up.
156 * Protocol v3+: The incoming meta data size is specified upfront in the
157 * HOST_DND_HG_SND_DATA_HDR message and must be handled accordingly.
158 */
159 HOST_DND_HG_SND_DATA = 205,
160 /** Sent when the actual buffer for HOST_DND_HG_SND_DATA was too small. */
161 /** @todo Deprecated function; do not use anymore. */
162 HOST_DND_HG_SND_MORE_DATA = 206,
163 /** Directory entry to be sent to the guest. */
164 HOST_DND_HG_SND_DIR = 207,
165 /** File data chunk to send to the guest. */
166 HOST_DND_HG_SND_FILE_DATA = 208,
167 /** File header to send to the guest.
168 * Note: Only for protocol version 2 and up (>= VBox 5.0). */
169 HOST_DND_HG_SND_FILE_HDR = 209,
170
171 /*
172 * Guest -> Host messages
173 */
174
175 /** The host asks the guest whether a DnD operation
176 * is in progress when the mouse leaves the guest window. */
177 HOST_DND_GH_REQ_PENDING = 600,
178 /** The host informs the guest that a DnD drop operation
179 * has been started and that the host wants the data in
180 * a specific MIME type. */
181 HOST_DND_GH_EVT_DROPPED = 601,
182 /** Blow the type up to 32-bit. */
183 HOST_DND_32BIT_HACK = 0x7fffffff
184};
185
186/**
187 * The service functions which are called by guest.
188 * Note: When adding new functions to this table, make sure that the actual ID
189 * does *not* overlap with the eHostFn enumeration above!
190 */
191enum eGuestFn
192{
193 /* Guest sends a connection request to the HGCM service,
194 * along with some additional information like supported
195 * protocol version and flags.
196 * Note: New since protocol version 2. */
197 GUEST_DND_CONNECT = 10,
198
199 /* Sent when a guest client disconnected from the HGCM service. */
200 GUEST_DND_DISCONNECT = 11,
201
202 /**
203 * Guest waits for a new message the host wants to process
204 * on the guest side. This can be a blocking call.
205 */
206 GUEST_DND_GET_NEXT_HOST_MSG = 300,
207
208 /*
209 * Host -> Guest operation messages.
210 */
211
212 /** The guest acknowledges that the pending DnD data from
213 * the host can be dropped on the currently selected source
214 * on the guest. */
215 GUEST_DND_HG_ACK_OP = 400,
216 /** The guest requests the actual DnD data to be sent
217 * from the host. */
218 GUEST_DND_HG_REQ_DATA = 401,
219 /** Reports back the guest's progress on a host -> guest operation. */
220 GUEST_DND_HG_EVT_PROGRESS = 402,
221
222 /*
223 * Guest -> Host operation messages.
224 */
225
226 /**
227 * The guests acknowledges that it currently has a drag'n drop
228 * operation in progress on the guest, which eventually could be
229 * dragged over to the host.
230 */
231 GUEST_DND_GH_ACK_PENDING = 500,
232 /** Sends the data header at the beginning of a (new)
233 * data transfer. */
234 GUEST_DND_GH_SND_DATA_HDR = 503,
235 /**
236 * Sends data of the requested format to the host. There can
237 * be more than one message if the actual data does not fit
238 * into one.
239 */
240 GUEST_DND_GH_SND_DATA = 501,
241 /** Reports an error back to the host. */
242 GUEST_DND_GH_EVT_ERROR = 502,
243 /** Guest sends a directory entry to the host. */
244 GUEST_DND_GH_SND_DIR = 700,
245 /** Guest sends file data to the host. */
246 /* Note: On protocol version 1 this also contains the file name
247 * and other attributes. */
248 GUEST_DND_GH_SND_FILE_DATA = 701,
249 /** Guest sends a file header to the host, marking the
250 * beginning of a (new) file transfer.
251 * Note: Available since protocol version 2 (VBox 5.0). */
252 GUEST_DND_GH_SND_FILE_HDR = 702,
253 /** Blow the type up to 32-bit. */
254 GUEST_DND_32BIT_HACK = 0x7fffffff
255};
256
257/**
258 * DnD operation progress states.
259 */
260typedef enum DNDPROGRESS
261{
262 DND_PROGRESS_UNKNOWN = 0,
263 DND_PROGRESS_RUNNING = 1,
264 DND_PROGRESS_COMPLETE,
265 DND_PROGRESS_CANCELLED,
266 DND_PROGRESS_ERROR,
267 /** Blow the type up to 32-bit. */
268 DND_PROGRESS_32BIT_HACK = 0x7fffffff
269} DNDPROGRESS, *PDNDPROGRESS;
270
271#pragma pack (1)
272
273/*
274 * Host events
275 */
276
277/**
278 * Action message for telling the guest about the currently ongoing
279 * drag and drop action when entering the guest's area, moving around in it
280 * and dropping content into it from the host.
281 *
282 * Used by:
283 * HOST_DND_HG_EVT_ENTER
284 * HOST_DND_HG_EVT_MOVE
285 * HOST_DND_HG_EVT_DROPPED
286 */
287typedef struct VBOXDNDHGACTIONMSG
288{
289 VBGLIOCHGCMCALL hdr;
290
291 union
292 {
293 struct
294 {
295 HGCMFunctionParameter uScreenId; /* OUT uint32_t */
296 HGCMFunctionParameter uX; /* OUT uint32_t */
297 HGCMFunctionParameter uY; /* OUT uint32_t */
298 HGCMFunctionParameter uDefAction; /* OUT uint32_t */
299 HGCMFunctionParameter uAllActions; /* OUT uint32_t */
300 HGCMFunctionParameter pvFormats; /* OUT ptr */
301 HGCMFunctionParameter cbFormats; /* OUT uint32_t */
302 } v1;
303 struct
304 {
305 /** Context ID. */
306 HGCMFunctionParameter uContext;
307 HGCMFunctionParameter uScreenId; /* OUT uint32_t */
308 HGCMFunctionParameter uX; /* OUT uint32_t */
309 HGCMFunctionParameter uY; /* OUT uint32_t */
310 HGCMFunctionParameter uDefAction; /* OUT uint32_t */
311 HGCMFunctionParameter uAllActions; /* OUT uint32_t */
312 HGCMFunctionParameter pvFormats; /* OUT ptr */
313 HGCMFunctionParameter cbFormats; /* OUT uint32_t */
314 } v3;
315 } u;
316} VBOXDNDHGACTIONMSG;
317
318/**
319 * Tells the guest that the host has left its drag and drop area on the guest.
320 *
321 * Used by:
322 * HOST_DND_HG_EVT_LEAVE
323 */
324typedef struct VBOXDNDHGLEAVEMSG
325{
326 VBGLIOCHGCMCALL hdr;
327 union
328 {
329 struct
330 {
331 /** Context ID. */
332 HGCMFunctionParameter uContext;
333 } v3;
334 } u;
335} VBOXDNDHGLEAVEMSG;
336
337/**
338 * Tells the guest that the host wants to cancel the current drag and drop operation.
339 *
340 * Used by:
341 * HOST_DND_HG_EVT_CANCEL
342 */
343typedef struct VBOXDNDHGCANCELMSG
344{
345 VBGLIOCHGCMCALL hdr;
346 union
347 {
348 struct
349 {
350 /** Context ID. */
351 HGCMFunctionParameter uContext;
352 } v3;
353 } u;
354} VBOXDNDHGCANCELMSG;
355
356/**
357 * Sends the header of an incoming (meta) data block.
358 *
359 * Used by:
360 * HOST_DND_HG_SND_DATA_HDR
361 * GUEST_DND_GH_SND_DATA_HDR
362 *
363 * New since protocol v3.
364 */
365typedef struct VBOXDNDHGSENDDATAHDRMSG
366{
367 VBGLIOCHGCMCALL hdr;
368
369 /** Context ID. Unused at the moment. */
370 HGCMFunctionParameter uContext; /* OUT uint32_t */
371 /** Data transfer flags. Not yet used and must be 0. */
372 HGCMFunctionParameter uFlags; /* OUT uint32_t */
373 /** Screen ID where the data originates from. */
374 HGCMFunctionParameter uScreenId; /* OUT uint32_t */
375 /** Total size (in bytes) to transfer. */
376 HGCMFunctionParameter cbTotal; /* OUT uint64_t */
377 /**
378 * Total meta data size (in bytes) to transfer.
379 * This size also is part of cbTotal already, so:
380 *
381 * cbTotal = cbMeta + additional size for files etc.
382 */
383 HGCMFunctionParameter cbMeta; /* OUT uint64_t */
384 /** Meta data format. */
385 HGCMFunctionParameter pvMetaFmt; /* OUT ptr */
386 /** Size (in bytes) of meta data format. */
387 HGCMFunctionParameter cbMetaFmt; /* OUT uint32_t */
388 /* Number of objects (files/directories) to transfer. */
389 HGCMFunctionParameter cObjects; /* OUT uint64_t */
390 /** Compression type. */
391 HGCMFunctionParameter enmCompression; /* OUT uint32_t */
392 /** Checksum type. */
393 HGCMFunctionParameter enmChecksumType; /* OUT uint32_t */
394 /** Checksum buffer for the entire data to be transferred. */
395 HGCMFunctionParameter pvChecksum; /* OUT ptr */
396 /** Size (in bytes) of checksum. */
397 HGCMFunctionParameter cbChecksum; /* OUT uint32_t */
398} VBOXDNDHGSENDDATAHDRMSG;
399
400/**
401 * Sends a (meta) data block to the guest.
402 *
403 * Used by:
404 * HOST_DND_HG_SND_DATA
405 */
406typedef struct VBOXDNDHGSENDDATAMSG
407{
408 VBGLIOCHGCMCALL hdr;
409
410 union
411 {
412 struct
413 {
414 HGCMFunctionParameter uScreenId; /* OUT uint32_t */
415 HGCMFunctionParameter pvFormat; /* OUT ptr */
416 HGCMFunctionParameter cbFormat; /* OUT uint32_t */
417 HGCMFunctionParameter pvData; /* OUT ptr */
418 HGCMFunctionParameter cbData; /* OUT uint32_t */
419 } v1;
420 /* No changes in v2. */
421 struct
422 {
423 /** Context ID. Unused at the moment. */
424 HGCMFunctionParameter uContext; /* OUT uint32_t */
425 /** Data block to send. */
426 HGCMFunctionParameter pvData; /* OUT ptr */
427 /** Size (in bytes) of data block to send. */
428 HGCMFunctionParameter cbData; /* OUT uint32_t */
429 /** Checksum of data block, based on the checksum
430 * type in the data header. Optional. */
431 HGCMFunctionParameter pvChecksum; /* OUT ptr */
432 /** Size (in bytes) of checksum to send. */
433 HGCMFunctionParameter cbChecksum; /* OUT uint32_t */
434 } v3;
435 } u;
436} VBOXDNDHGSENDDATAMSG;
437
438/**
439 * Sends more (meta) data in case the data didn't fit
440 * into the current XXX_DND_HG_SND_DATA message.
441 *
442 ** @todo Deprecated since protocol v3. Don't use! Will be removed.
443 *
444 * Used by:
445 * HOST_DND_HG_SND_MORE_DATA
446 */
447typedef struct VBOXDNDHGSENDMOREDATAMSG
448{
449 VBGLIOCHGCMCALL hdr;
450
451 HGCMFunctionParameter pvData; /* OUT ptr */
452 HGCMFunctionParameter cbData; /* OUT uint32_t */
453} VBOXDNDHGSENDMOREDATAMSG;
454
455/**
456 * Directory entry event.
457 *
458 * Used by:
459 * HOST_DND_HG_SND_DIR
460 * GUEST_DND_GH_SND_DIR
461 */
462typedef struct VBOXDNDHGSENDDIRMSG
463{
464 VBGLIOCHGCMCALL hdr;
465
466 union
467 {
468 struct
469 {
470 /** Directory name. */
471 HGCMFunctionParameter pvName; /* OUT ptr */
472 /** Size (in bytes) of directory name. */
473 HGCMFunctionParameter cbName; /* OUT uint32_t */
474 /** Directory mode. */
475 HGCMFunctionParameter fMode; /* OUT uint32_t */
476 } v1;
477 struct
478 {
479 /** Context ID. Unused at the moment. */
480 HGCMFunctionParameter uContext; /* OUT uint32_t */
481 /** Directory name. */
482 HGCMFunctionParameter pvName; /* OUT ptr */
483 /** Size (in bytes) of directory name. */
484 HGCMFunctionParameter cbName; /* OUT uint32_t */
485 /** Directory mode. */
486 HGCMFunctionParameter fMode; /* OUT uint32_t */
487 } v3;
488 } u;
489} VBOXDNDHGSENDDIRMSG;
490
491/**
492 * File header message, marking the start of transferring a new file.
493 * Note: Only for protocol version 2 and up.
494 *
495 * Used by:
496 * HOST_DND_HG_SND_FILE_HDR
497 * GUEST_DND_GH_SND_FILE_HDR
498 */
499typedef struct VBOXDNDHGSENDFILEHDRMSG
500{
501 VBGLIOCHGCMCALL hdr;
502
503 /** Context ID. Unused at the moment. */
504 HGCMFunctionParameter uContext; /* OUT uint32_t */
505 /** File path. */
506 HGCMFunctionParameter pvName; /* OUT ptr */
507 /** Size (in bytes) of file path. */
508 HGCMFunctionParameter cbName; /* OUT uint32_t */
509 /** Optional flags; unused at the moment. */
510 HGCMFunctionParameter uFlags; /* OUT uint32_t */
511 /** File creation mode. */
512 HGCMFunctionParameter fMode; /* OUT uint32_t */
513 /** Total size (in bytes). */
514 HGCMFunctionParameter cbTotal; /* OUT uint64_t */
515} VBOXDNDHGSENDFILEHDRMSG;
516
517/**
518 * HG: File data (chunk) event.
519 *
520 * Used by:
521 * HOST_DND_HG_SND_FILE
522 */
523typedef struct VBOXDNDHGSENDFILEDATAMSG
524{
525 VBGLIOCHGCMCALL hdr;
526
527 union
528 {
529 /* Note: Protocol v1 sends the file name + file mode
530 * every time a file data chunk is being sent. */
531 struct
532 {
533 /** File name. */
534 HGCMFunctionParameter pvName; /* OUT ptr */
535 /** Size (in bytes) of file name. */
536 HGCMFunctionParameter cbName; /* OUT uint32_t */
537 /** Current data chunk. */
538 HGCMFunctionParameter pvData; /* OUT ptr */
539 /** Size (in bytes) of current data chunk. */
540 HGCMFunctionParameter cbData; /* OUT uint32_t */
541 /** File mode. */
542 HGCMFunctionParameter fMode; /* OUT uint32_t */
543 } v1;
544 struct
545 {
546 /** Note: pvName is now part of the VBOXDNDHGSENDFILEHDRMSG message. */
547 /** Note: cbName is now part of the VBOXDNDHGSENDFILEHDRMSG message. */
548 /** Context ID. Unused at the moment. */
549 HGCMFunctionParameter uContext; /* OUT uint32_t */
550 /** Current data chunk. */
551 HGCMFunctionParameter pvData; /* OUT ptr */
552 /** Size (in bytes) of current data chunk. */
553 HGCMFunctionParameter cbData; /* OUT uint32_t */
554 /** Note: fMode is now part of the VBOXDNDHGSENDFILEHDRMSG message. */
555 } v2;
556 struct
557 {
558 /** Context ID. Unused at the moment. */
559 HGCMFunctionParameter uContext; /* OUT uint32_t */
560 /** Current data chunk. */
561 HGCMFunctionParameter pvData; /* OUT ptr */
562 /** Size (in bytes) of current data chunk. */
563 HGCMFunctionParameter cbData; /* OUT uint32_t */
564 /** Checksum of data block, based on the checksum
565 * type in the data header. Optional. */
566 HGCMFunctionParameter pvChecksum; /* OUT ptr */
567 /** Size (in bytes) of curren data chunk checksum. */
568 HGCMFunctionParameter cbChecksum; /* OUT uint32_t */
569 } v3;
570 } u;
571} VBOXDNDHGSENDFILEDATAMSG;
572
573/**
574 * Asks the guest if a guest->host DnD operation is in progress.
575 *
576 * Used by:
577 * HOST_DND_GH_REQ_PENDING
578 */
579typedef struct VBOXDNDGHREQPENDINGMSG
580{
581 VBGLIOCHGCMCALL hdr;
582
583 union
584 {
585 struct
586 {
587 /** Screen ID. */
588 HGCMFunctionParameter uScreenId; /* OUT uint32_t */
589 } v1;
590 struct
591 {
592 /** Context ID. Unused at the moment. */
593 HGCMFunctionParameter uContext; /* OUT uint32_t */
594 /** Screen ID. */
595 HGCMFunctionParameter uScreenId; /* OUT uint32_t */
596 } v3;
597 } u;
598} VBOXDNDGHREQPENDINGMSG;
599
600/**
601 * Tells the guest that the host has dropped the ongoing guest->host
602 * DnD operation on a valid target on the host.
603 *
604 * Used by:
605 * HOST_DND_GH_EVT_DROPPED
606 */
607typedef struct VBOXDNDGHDROPPEDMSG
608{
609 VBGLIOCHGCMCALL hdr;
610
611 union
612 {
613 struct
614 {
615 /** Requested format for sending the data. */
616 HGCMFunctionParameter pvFormat; /* OUT ptr */
617 /** Size (in bytes) of requested format. */
618 HGCMFunctionParameter cbFormat; /* OUT uint32_t */
619 /** Drop action peformed on the host. */
620 HGCMFunctionParameter uAction; /* OUT uint32_t */
621 } v1;
622 struct
623 {
624 /** Context ID. Unused at the moment. */
625 HGCMFunctionParameter uContext; /* OUT uint32_t */
626 /** Requested format for sending the data. */
627 HGCMFunctionParameter pvFormat; /* OUT ptr */
628 /** Size (in bytes) of requested format. */
629 HGCMFunctionParameter cbFormat; /* OUT uint32_t */
630 /** Drop action peformed on the host. */
631 HGCMFunctionParameter uAction; /* OUT uint32_t */
632 } v3;
633 } u;
634} VBOXDNDGHDROPPEDMSG;
635
636/*
637 * Guest events
638 */
639
640/**
641 * Asks the host for the next command to process, along
642 * with the needed amount of parameters and an optional blocking
643 * flag.
644 *
645 * Used by:
646 * GUEST_DND_GET_NEXT_HOST_MSG
647 */
648typedef struct VBOXDNDNEXTMSGMSG
649{
650 VBGLIOCHGCMCALL hdr;
651
652 /** Message ID. */
653 HGCMFunctionParameter uMsg; /* OUT uint32_t */
654 /** Number of parameters the message needs. */
655 HGCMFunctionParameter cParms; /* OUT uint32_t */
656 /** Whether or not to block (wait) for a
657 * new message to arrive. */
658 HGCMFunctionParameter fBlock; /* OUT uint32_t */
659} VBOXDNDNEXTMSGMSG;
660
661/**
662 * Guest connection request. Used to tell the DnD protocol
663 * version to the (host) service.
664 *
665 * Used by:
666 * GUEST_DND_CONNECT
667 */
668typedef struct VBOXDNDCONNECTMSG
669{
670 VBGLIOCHGCMCALL hdr;
671
672 union
673 {
674 struct
675 {
676 /** Protocol version to use. */
677 HGCMFunctionParameter uProtocol; /* OUT uint32_t */
678 /** Connection flags. Optional. */
679 HGCMFunctionParameter uFlags; /* OUT uint32_t */
680 } v2;
681 struct
682 {
683 /** Context ID. Unused at the moment. */
684 HGCMFunctionParameter uContext; /* OUT uint32_t */
685 /** Protocol version to use. */
686 HGCMFunctionParameter uProtocol; /* OUT uint32_t */
687 /** Connection flags. Optional. */
688 HGCMFunctionParameter uFlags; /* OUT uint32_t */
689 } v3;
690 } u;
691} VBOXDNDCONNECTMSG;
692
693/**
694 * Acknowledges a host operation along with the allowed
695 * action(s) on the guest.
696 *
697 * Used by:
698 * GUEST_DND_HG_ACK_OP
699 */
700typedef struct VBOXDNDHGACKOPMSG
701{
702 VBGLIOCHGCMCALL hdr;
703
704 union
705 {
706 struct
707 {
708 HGCMFunctionParameter uAction; /* OUT uint32_t */
709 } v1;
710 struct
711 {
712 /** Context ID. Unused at the moment. */
713 HGCMFunctionParameter uContext; /* OUT uint32_t */
714 HGCMFunctionParameter uAction; /* OUT uint32_t */
715 } v3;
716 } u;
717} VBOXDNDHGACKOPMSG;
718
719/**
720 * HG request for data event.
721 *
722 * Used by:
723 * GUEST_DND_HG_REQ_DATA
724 */
725typedef struct VBOXDNDHGREQDATAMSG
726{
727 VBGLIOCHGCMCALL hdr;
728
729 union
730 {
731 struct
732 {
733 HGCMFunctionParameter pvFormat; /* OUT ptr */
734 } v1;
735 struct
736 {
737 /** Context ID. Unused at the moment. */
738 HGCMFunctionParameter uContext; /* OUT uint32_t */
739 HGCMFunctionParameter pvFormat; /* OUT ptr */
740 HGCMFunctionParameter cbFormat; /* OUT uint32_t */
741 } v3;
742 } u;
743} VBOXDNDHGREQDATAMSG;
744
745typedef struct VBOXDNDHGEVTPROGRESSMSG
746{
747 VBGLIOCHGCMCALL hdr;
748
749 union
750 {
751 struct
752 {
753 HGCMFunctionParameter uStatus; /* OUT uint32_t */
754 HGCMFunctionParameter uPercent; /* OUT uint32_t */
755 HGCMFunctionParameter rc; /* OUT uint32_t */
756 } v1;
757 struct
758 {
759 /** Context ID. Unused at the moment. */
760 HGCMFunctionParameter uContext; /* OUT uint32_t */
761 HGCMFunctionParameter uStatus; /* OUT uint32_t */
762 HGCMFunctionParameter uPercent; /* OUT uint32_t */
763 HGCMFunctionParameter rc; /* OUT uint32_t */
764 } v3;
765 } u;
766} VBOXDNDHGEVTPROGRESSMSG;
767
768/**
769 * Acknowledges a pending drag and drop event
770 * to the host.
771 *
772 * Used by:
773 * GUEST_DND_GH_ACK_PENDING
774 */
775typedef struct VBOXDNDGHACKPENDINGMSG
776{
777 VBGLIOCHGCMCALL hdr;
778
779 union
780 {
781 struct
782 {
783 HGCMFunctionParameter uDefAction; /* OUT uint32_t */
784 HGCMFunctionParameter uAllActions; /* OUT uint32_t */
785 HGCMFunctionParameter pvFormats; /* OUT ptr */
786 } v1;
787 struct
788 {
789 /** Context ID. Unused at the moment. */
790 HGCMFunctionParameter uContext; /* OUT uint32_t */
791 HGCMFunctionParameter uDefAction; /* OUT uint32_t */
792 HGCMFunctionParameter uAllActions; /* OUT uint32_t */
793 HGCMFunctionParameter pvFormats; /* OUT ptr */
794 HGCMFunctionParameter cbFormats; /* OUT uint32_t */
795 } v3;
796 } u;
797} VBOXDNDGHACKPENDINGMSG;
798
799/**
800 * Sends the header of an incoming data block
801 * to the host.
802 *
803 * Used by:
804 * GUEST_DND_GH_SND_DATA_HDR
805 *
806 * New since protocol v3.
807 */
808typedef struct VBOXDNDHGSENDDATAHDRMSG VBOXDNDGHSENDDATAHDRMSG;
809
810/**
811 * Sends a (meta) data block to the host.
812 *
813 * Used by:
814 * GUEST_DND_GH_SND_DATA
815 */
816typedef struct VBOXDNDGHSENDDATAMSG
817{
818 VBGLIOCHGCMCALL hdr;
819
820 union
821 {
822 struct
823 {
824 HGCMFunctionParameter pvData; /* OUT ptr */
825 /** Total bytes to send. This can be more than
826 * the data block specified in pvData above, e.g.
827 * when sending over file objects afterwards. */
828 HGCMFunctionParameter cbTotalBytes; /* OUT uint32_t */
829 } v1;
830 struct
831 {
832 /** Context ID. Unused at the moment. */
833 HGCMFunctionParameter uContext; /* OUT uint32_t */
834 /** Data block to send. */
835 HGCMFunctionParameter pvData; /* OUT ptr */
836 /** Size (in bytes) of data block to send. */
837 HGCMFunctionParameter cbData; /* OUT uint32_t */
838 /** (Rolling) Checksum, based on checksum type in data header. */
839 HGCMFunctionParameter pvChecksum; /* OUT ptr */
840 /** Size (in bytes) of checksum. */
841 HGCMFunctionParameter cbChecksum; /* OUT uint32_t */
842 } v3;
843 } u;
844} VBOXDNDGHSENDDATAMSG;
845
846/**
847 * Sends a directory entry to the host.
848 *
849 * Used by:
850 * GUEST_DND_GH_SND_DIR
851 */
852typedef struct VBOXDNDHGSENDDIRMSG VBOXDNDGHSENDDIRMSG;
853
854/**
855 * Sends a file header to the host.
856 *
857 * Used by:
858 * GUEST_DND_GH_SND_FILE_HDR
859 *
860 * New since protocol v2.
861 */
862typedef struct VBOXDNDHGSENDFILEHDRMSG VBOXDNDGHSENDFILEHDRMSG;
863
864/**
865 * Sends file data to the host.
866 *
867 * Used by:
868 * GUEST_DND_GH_SND_FILE_DATA
869 */
870typedef struct VBOXDNDHGSENDFILEDATAMSG VBOXDNDGHSENDFILEDATAMSG;
871
872/**
873 * Sends a guest error event to the host.
874 *
875 * Used by:
876 * GUEST_DND_GH_EVT_ERROR
877 */
878typedef struct VBOXDNDGHEVTERRORMSG
879{
880 VBGLIOCHGCMCALL hdr;
881
882 union
883 {
884 struct
885 {
886 HGCMFunctionParameter rc; /* OUT uint32_t */
887 } v1;
888 struct
889 {
890 /** Context ID. Unused at the moment. */
891 HGCMFunctionParameter uContext; /* OUT uint32_t */
892 HGCMFunctionParameter rc; /* OUT uint32_t */
893 } v3;
894 } u;
895} VBOXDNDGHEVTERRORMSG;
896
897#pragma pack()
898
899/** Builds a callback magic out of the function ID and the version
900 * of the callback data. */
901#define VBOX_DND_CB_MAGIC_MAKE(uFn, uVer) \
902 RT_MAKE_U32(uVer, uFn)
903
904/*
905 * Callback magics.
906 */
907enum eDnDCallbackMagics
908{
909 CB_MAGIC_DND_CONNECT = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_CONNECT, 0),
910 CB_MAGIC_DND_HG_GET_NEXT_HOST_MSG = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GET_NEXT_HOST_MSG, 0),
911 CB_MAGIC_DND_HG_ACK_OP = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_HG_ACK_OP, 0),
912 CB_MAGIC_DND_HG_REQ_DATA = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_HG_REQ_DATA, 0),
913 CB_MAGIC_DND_HG_EVT_PROGRESS = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_HG_EVT_PROGRESS, 0),
914 CB_MAGIC_DND_GH_ACK_PENDING = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_ACK_PENDING, 0),
915 CB_MAGIC_DND_GH_SND_DATA = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_DATA, 0),
916 CB_MAGIC_DND_GH_SND_DATA_HDR = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_DATA_HDR, 0),
917 CB_MAGIC_DND_GH_SND_DIR = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_DIR, 0),
918 CB_MAGIC_DND_GH_SND_FILE_HDR = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_FILE_HDR, 0),
919 CB_MAGIC_DND_GH_SND_FILE_DATA = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_FILE_DATA, 0),
920 CB_MAGIC_DND_GH_EVT_ERROR = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_EVT_ERROR, 0)
921};
922
923typedef struct VBOXDNDCBHEADERDATA
924{
925 /** Magic number to identify the structure. */
926 uint32_t uMagic;
927 /** Context ID to identify callback data. */
928 uint32_t uContextID;
929} VBOXDNDCBHEADERDATA, *PVBOXDNDCBHEADERDATA;
930
931typedef struct VBOXDNDCBCONNECTMSGDATA
932{
933 /** Callback data header. */
934 VBOXDNDCBHEADERDATA hdr;
935 uint32_t uProtocol;
936 uint32_t uFlags;
937} VBOXDNDCBCONNECTMSGDATA, *PVBOXDNDCBCONNECTMSGDATA;
938
939typedef struct VBOXDNDCBDISCONNECTMSGDATA
940{
941 /** Callback data header. */
942 VBOXDNDCBHEADERDATA hdr;
943} VBOXDNDCBDISCONNECTMSGDATA, *PVBOXDNDCBDISCONNECTMSGDATA;
944
945typedef struct VBOXDNDCBHGGETNEXTHOSTMSG
946{
947 /** Callback data header. */
948 VBOXDNDCBHEADERDATA hdr;
949 uint32_t uMsg;
950 uint32_t cParms;
951} VBOXDNDCBHGGETNEXTHOSTMSG, *PVBOXDNDCBHGGETNEXTHOSTMSG;
952
953typedef struct VBOXDNDCBHGGETNEXTHOSTMSGDATA
954{
955 /** Callback data header. */
956 VBOXDNDCBHEADERDATA hdr;
957 uint32_t uMsg;
958 uint32_t cParms;
959 PVBOXHGCMSVCPARM paParms;
960} VBOXDNDCBHGGETNEXTHOSTMSGDATA, *PVBOXDNDCBHGGETNEXTHOSTMSGDATA;
961
962typedef struct VBOXDNDCBHGACKOPDATA
963{
964 /** Callback data header. */
965 VBOXDNDCBHEADERDATA hdr;
966 uint32_t uAction;
967} VBOXDNDCBHGACKOPDATA, *PVBOXDNDCBHGACKOPDATA;
968
969typedef struct VBOXDNDCBHGREQDATADATA
970{
971 /** Callback data header. */
972 VBOXDNDCBHEADERDATA hdr;
973 char *pszFormat;
974 uint32_t cbFormat;
975} VBOXDNDCBHGREQDATADATA, *PVBOXDNDCBHGREQDATADATA;
976
977typedef struct VBOXDNDCBHGEVTPROGRESSDATA
978{
979 /** Callback data header. */
980 VBOXDNDCBHEADERDATA hdr;
981 uint32_t uPercentage;
982 uint32_t uStatus;
983 uint32_t rc;
984} VBOXDNDCBHGEVTPROGRESSDATA, *PVBOXDNDCBHGEVTPROGRESSDATA;
985
986typedef struct VBOXDNDCBGHACKPENDINGDATA
987{
988 /** Callback data header. */
989 VBOXDNDCBHEADERDATA hdr;
990 uint32_t uDefAction;
991 uint32_t uAllActions;
992 char *pszFormat;
993 uint32_t cbFormat;
994} VBOXDNDCBGHACKPENDINGDATA, *PVBOXDNDCBGHACKPENDINGDATA;
995
996/**
997 * Data header.
998 * New since protocol v3.
999 */
1000typedef struct VBOXDNDDATAHDR
1001{
1002 /** Data transfer flags. Not yet used and must be 0. */
1003 uint32_t uFlags;
1004 /** Screen ID where the data originates from. */
1005 uint32_t uScreenId;
1006 /** Total size (in bytes) to transfer. */
1007 uint64_t cbTotal;
1008 /** Meta data size (in bytes) to transfer.
1009 * This size also is part of cbTotal already. */
1010 uint32_t cbMeta;
1011 /** Meta format buffer. */
1012 void *pvMetaFmt;
1013 /** Size (in bytes) of meta format buffer. */
1014 uint32_t cbMetaFmt;
1015 /** Number of objects (files/directories) to transfer. */
1016 uint64_t cObjects;
1017 /** Compression type. Currently unused, so specify 0.
1018 **@todo Add IPRT compression type enumeration as soon as it's available. */
1019 uint32_t enmCompression;
1020 /** Checksum type. Currently unused, so specify RTDIGESTTYPE_INVALID. */
1021 RTDIGESTTYPE enmChecksumType;
1022 /** The actual checksum buffer for the entire data to be transferred,
1023 * based on enmChksumType. If RTDIGESTTYPE_INVALID is specified,
1024 * no checksum is being used and pvChecksum will be NULL. */
1025 void *pvChecksum;
1026 /** Size (in bytes) of checksum. */
1027 uint32_t cbChecksum;
1028} VBOXDNDDATAHDR, *PVBOXDNDSNDDATAHDR;
1029
1030/* New since protocol v3. */
1031typedef struct VBOXDNDCBSNDDATAHDRDATA
1032{
1033 /** Callback data header. */
1034 VBOXDNDCBHEADERDATA hdr;
1035 /** Actual header data. */
1036 VBOXDNDDATAHDR data;
1037} VBOXDNDCBSNDDATAHDRDATA, *PVBOXDNDCBSNDDATAHDRDATA;
1038
1039typedef struct VBOXDNDSNDDATA
1040{
1041 union
1042 {
1043 struct
1044 {
1045 /** Data block buffer. */
1046 void *pvData;
1047 /** Size (in bytes) of data block. */
1048 uint32_t cbData;
1049 /** Total metadata size (in bytes). This is transmitted
1050 * with every message because the size can change. */
1051 uint32_t cbTotalSize;
1052 } v1;
1053 /* Protocol v2: No changes. */
1054 struct
1055 {
1056 /** Data block buffer. */
1057 void *pvData;
1058 /** Size (in bytes) of data block. */
1059 uint32_t cbData;
1060 /** (Rolling) Checksum. Not yet implemented. */
1061 void *pvChecksum;
1062 /** Size (in bytes) of checksum. Not yet implemented. */
1063 uint32_t cbChecksum;
1064 } v3;
1065 } u;
1066} VBOXDNDSNDDATA, *PVBOXDNDSNDDATA;
1067
1068typedef struct VBOXDNDCBSNDDATADATA
1069{
1070 /** Callback data header. */
1071 VBOXDNDCBHEADERDATA hdr;
1072 /** Actual data. */
1073 VBOXDNDSNDDATA data;
1074} VBOXDNDCBSNDDATADATA, *PVBOXDNDCBSNDDATADATA;
1075
1076typedef struct VBOXDNDCBSNDDIRDATA
1077{
1078 /** Callback data header. */
1079 VBOXDNDCBHEADERDATA hdr;
1080 /** Directory path. */
1081 char *pszPath;
1082 /** Size (in bytes) of path. */
1083 uint32_t cbPath;
1084 /** Directory creation mode. */
1085 uint32_t fMode;
1086} VBOXDNDCBSNDDIRDATA, *PVBOXDNDCBSNDDIRDATA;
1087
1088/* Note: Only for protocol version 2 and up (>= VBox 5.0). */
1089typedef struct VBOXDNDCBSNDFILEHDRDATA
1090{
1091 /** Callback data header. */
1092 VBOXDNDCBHEADERDATA hdr;
1093 /** File path (name). */
1094 char *pszFilePath;
1095 /** Size (in bytes) of file path. */
1096 uint32_t cbFilePath;
1097 /** Total size (in bytes) of this file. */
1098 uint64_t cbSize;
1099 /** File (creation) mode. */
1100 uint32_t fMode;
1101 /** Additional flags. Not used at the moment. */
1102 uint32_t fFlags;
1103} VBOXDNDCBSNDFILEHDRDATA, *PVBOXDNDCBSNDFILEHDRDATA;
1104
1105typedef struct VBOXDNDCBSNDFILEDATADATA
1106{
1107 /** Callback data header. */
1108 VBOXDNDCBHEADERDATA hdr;
1109 /** Current file data chunk. */
1110 void *pvData;
1111 /** Size (in bytes) of current data chunk. */
1112 uint32_t cbData;
1113 union
1114 {
1115 struct
1116 {
1117 /** File path (name). */
1118 char *pszFilePath;
1119 /** Size (in bytes) of file path. */
1120 uint32_t cbFilePath;
1121 /** File (creation) mode. */
1122 uint32_t fMode;
1123 } v1;
1124 /* Protocol v2 + v3: Have the file attributes (name, size, mode, ...)
1125 in the VBOXDNDCBSNDFILEHDRDATA structure. */
1126 struct
1127 {
1128 /** Checksum for current file data chunk. */
1129 void *pvChecksum;
1130 /** Size (in bytes) of current data chunk. */
1131 uint32_t cbChecksum;
1132 } v3;
1133 } u;
1134} VBOXDNDCBSNDFILEDATADATA, *PVBOXDNDCBSNDFILEDATADATA;
1135
1136typedef struct VBOXDNDCBEVTERRORDATA
1137{
1138 /** Callback data header. */
1139 VBOXDNDCBHEADERDATA hdr;
1140 int32_t rc;
1141} VBOXDNDCBEVTERRORDATA, *PVBOXDNDCBEVTERRORDATA;
1142
1143} /* namespace DragAndDropSvc */
1144
1145#endif /* !___VBox_HostService_DragAndDropSvc_h */
1146
Note: See TracBrowser for help on using the repository browser.

© 2024 Oracle Support Privacy / Do Not Sell My Info Terms of Use Trademark Policy Automated Access Etiquette