VirtualBox

Changeset 85745 in vbox for trunk/include/VBox/HostServices


Ignore:
Timestamp:
Aug 13, 2020 8:37:09 AM (4 years ago)
Author:
vboxsync
Message:

DnD: Renaming -- prefix all HGCM function number defines with [GUEST|HOST]_DND_FN_ to better distinguish from other defines.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/include/VBox/HostServices/DragAndDropSvc.h

    r85722 r85745  
    4949 *         + Added VBOXDNDSNDDATAHDR and VBOXDNDCBSNDDATAHDRDATA to support (simple) accounting of objects
    5050 *           being transferred, along with supplying separate meta data size (which is part of the total size being sent).
    51  *         + Added new HOST_DND_HG_SND_DATA_HDR + GUEST_DND_GH_SND_DATA_HDR commands which now allow specifying an optional
     51 *         + Added new HOST_DND_FN_HG_SND_DATA_HDR + GUEST_DND_FN_GH_SND_DATA_HDR commands which now allow specifying an optional
    5252 *           compression type and defining a checksum for the overall data transfer.
    5353 *         + Enhannced VBOXDNDGHSENDDATAMSG to support (rolling) checksums for the supplied data block.
    5454 *         + VBOXDNDHGSENDDATAMSG and VBOXDNDGHSENDDATAMSG can now contain an optional checksum for the current data block.
    5555 *         | VBOXDNDHGSENDFILEDATAMSG and VBOXDNDGHSENDFILEDATAMSG are now sharing the same HGCM mesasge.
    56  *         - Removed unused HOST_DND_GH_RECV_DIR, HOST_DND_GH_RECV_FILE_DATA and HOST_DND_GH_RECV_FILE_HDR commands.
     56 *         - Removed unused HOST_DND_FN_GH_RECV_DIR, HOST_DND_FN_GH_RECV_FILE_DATA and HOST_DND_FN_GH_RECV_FILE_HDR commands.
    5757 *
    5858 *     VBox 6.1.x and up, current:
    59  *         + Added GUEST_DND_QUERY_FEATURES + GUEST_DND_REPORT_FEATURES.
     59 *         + Added GUEST_DND_FN_QUERY_FEATURES + GUEST_DND_FN_REPORT_FEATURES.
    6060 *         - Protocol versioning support in VBOXDNDCONNECTMSG is now marked as being deprecated.
    6161 *
    6262 ** @todo:
    6363 * - Split up messages which use VBOXDNDHGACTIONMSG into own functions and remove parameters which
    64  *   are not actually needed / used by a function. Why does HOST_DND_HG_EVT_MOVE need all the format stuff, for example?
     64 *   are not actually needed / used by a function. Why does HOST_DND_FN_HG_EVT_MOVE need all the format stuff, for example?
    6565 */
    6666
    … …  
    9191{
    9292    /** The host sets a new DnD mode. */
    93     HOST_DND_SET_MODE                  = 100,
     93    HOST_DND_FN_SET_MODE                  = 100,
    9494    /** The host requests to cancel the current DnD operation on
    9595     *  the guest side. This can happen on user request on the host's
    … …  
    9999     *        not rely on an answer from the guest side in order to
    100100     *        properly cancel the operation. */
    101     HOST_DND_CANCEL                    = 204,
     101    HOST_DND_FN_CANCEL                    = 204,
    102102
    103103    /*
    … …  
    107107    /** The host enters the VM window for starting an actual
    108108     *  DnD operation. */
    109     HOST_DND_HG_EVT_ENTER              = 200,
     109    HOST_DND_FN_HG_EVT_ENTER              = 200,
    110110    /** The host's DnD cursor moves within the VM window. */
    111     HOST_DND_HG_EVT_MOVE               = 201,
     111    HOST_DND_FN_HG_EVT_MOVE               = 201,
    112112    /** The host leaves the guest VM window. */
    113     HOST_DND_HG_EVT_LEAVE              = 202,
     113    HOST_DND_FN_HG_EVT_LEAVE              = 202,
    114114    /** The host issues a "drop" event, meaning that the host is
    115115     *  ready to transfer data over to the guest. */
    116     HOST_DND_HG_EVT_DROPPED            = 203,
     116    HOST_DND_FN_HG_EVT_DROPPED            = 203,
    117117    /** The host sends the data header at the beginning of a (new)
    118118     *  data transfer. */
    119     HOST_DND_HG_SND_DATA_HDR           = 210,
     119    HOST_DND_FN_HG_SND_DATA_HDR           = 210,
    120120    /**
    121121     * The host sends the actual meta data, based on
    122      * the format(s) specified by HOST_DND_HG_EVT_ENTER.
     122     * the format(s) specified by HOST_DND_FN_HG_EVT_ENTER.
    123123     *
    124124     * Protocol v1/v2: If the guest supplied buffer too small to send
    125      *                 the actual data, the host will send a HOST_DND_HG_SND_MORE_DATA
     125     *                 the actual data, the host will send a HOST_DND_FN_HG_SND_MORE_DATA
    126126     *                 message as follow-up.
    127127     * Protocol v3+:   The incoming meta data size is specified upfront in the
    128      *                 HOST_DND_HG_SND_DATA_HDR message and must be handled accordingly.
     128     *                 HOST_DND_FN_HG_SND_DATA_HDR message and must be handled accordingly.
    129129     */
    130     HOST_DND_HG_SND_DATA               = 205,
     130    HOST_DND_FN_HG_SND_DATA               = 205,
    131131    /** The host sends more data in case the data did not entirely fit in
    132      *  the HOST_DND_HG_SND_DATA message. */
     132     *  the HOST_DND_FN_HG_SND_DATA message. */
    133133    /** @todo Deprecated function; do not use anymore. */
    134     HOST_DND_HG_SND_MORE_DATA          = 206,
     134    HOST_DND_FN_HG_SND_MORE_DATA          = 206,
    135135    /** The host sends a directory entry to the guest. */
    136     HOST_DND_HG_SND_DIR                = 207,
     136    HOST_DND_FN_HG_SND_DIR                = 207,
    137137    /** The host sends a file data chunk to the guest. */
    138     HOST_DND_HG_SND_FILE_DATA          = 208,
     138    HOST_DND_FN_HG_SND_FILE_DATA          = 208,
    139139    /** The host sends a file header to the guest.
    140140     *  Note: Only for protocol version 2 and up (>= VBox 5.0). */
    141     HOST_DND_HG_SND_FILE_HDR           = 209,
     141    HOST_DND_FN_HG_SND_FILE_HDR           = 209,
    142142
    143143    /*
    … …  
    147147    /** The host asks the guest whether a DnD operation
    148148     *  is in progress when the mouse leaves the guest window. */
    149     HOST_DND_GH_REQ_PENDING            = 600,
     149    HOST_DND_FN_GH_REQ_PENDING            = 600,
    150150    /** The host informs the guest that a DnD drop operation
    151151     *  has been started and that the host wants the data in
    152152     *  a specific MIME type. */
    153     HOST_DND_GH_EVT_DROPPED            = 601,
     153    HOST_DND_FN_GH_EVT_DROPPED            = 601,
    154154    /** Blow the type up to 32-bit. */
    155     HOST_DND_32BIT_HACK                = 0x7fffffff
     155    HOST_DND_FN_32BIT_HACK                = 0x7fffffff
    156156};
    157157
    … …  
    168168     * protocol version and flags.
    169169     * Note: New since protocol version 2. */
    170     GUEST_DND_CONNECT                  = 10,
     170    GUEST_DND_FN_CONNECT                  = 10,
    171171
    172172    /** The guest client disconnects from the HGCM service. */
    173     GUEST_DND_DISCONNECT               = 11,
     173    GUEST_DND_FN_DISCONNECT               = 11,
    174174
    175175    /** Report guest side feature flags and retrieve the host ones.
    … …  
    185185     * @since   6.1.x
    186186     */
    187     GUEST_DND_REPORT_FEATURES          = 12,
     187    GUEST_DND_FN_REPORT_FEATURES          = 12,
    188188
    189189    /** Query the host ones feature masks.
    … …  
    199199     * @since   6.1.x
    200200     */
    201     GUEST_DND_QUERY_FEATURES           = 13,
     201    GUEST_DND_FN_QUERY_FEATURES           = 13,
    202202
    203203    /**
    … …  
    205205     * on the guest side. This can be a blocking call.
    206206     */
    207     GUEST_DND_GET_NEXT_HOST_MSG        = 300,
     207    GUEST_DND_FN_GET_NEXT_HOST_MSG        = 300,
    208208
    209209    /*
    … …  
    213213    /** The guest acknowledges that a pending DnD operation from the host
    214214     *  can be dropped on the currently selected area on the guest. */
    215     GUEST_DND_HG_ACK_OP                = 400,
     215    GUEST_DND_FN_HG_ACK_OP                = 400,
    216216    /** The guest requests the actual DnD data to be sent from the host. */
    217     GUEST_DND_HG_REQ_DATA              = 401,
     217    GUEST_DND_FN_HG_REQ_DATA              = 401,
    218218    /** The guest reports back its progress back to the host. */
    219     GUEST_DND_HG_EVT_PROGRESS          = 402,
     219    GUEST_DND_FN_HG_EVT_PROGRESS          = 402,
    220220
    221221    /*
    … …  
    228228     * dragged over to the host.
    229229     */
    230     GUEST_DND_GH_ACK_PENDING           = 500,
     230    GUEST_DND_FN_GH_ACK_PENDING           = 500,
    231231    /** The guest sends the data header at the beginning of a (new)
    232232     *  data transfer. */
    233     GUEST_DND_GH_SND_DATA_HDR          = 503,
     233    GUEST_DND_FN_GH_SND_DATA_HDR          = 503,
    234234    /**
    235235     * The guest sends data of the requested format to the host. There can
    … …  
    237237     * into one.
    238238     */
    239     GUEST_DND_GH_SND_DATA              = 501,
     239    GUEST_DND_FN_GH_SND_DATA              = 501,
    240240    /** The guest reports an error back to the host. */
    241     GUEST_DND_GH_EVT_ERROR             = 502,
     241    GUEST_DND_FN_GH_EVT_ERROR             = 502,
    242242    /** The guest sends a directory entry to the host. */
    243     GUEST_DND_GH_SND_DIR               = 700,
     243    GUEST_DND_FN_GH_SND_DIR               = 700,
    244244    /** The guest sends file data to the host.
    245245     *  Note: On protocol version 1 this also contains the file name
    246246     *        and other attributes. */
    247     GUEST_DND_GH_SND_FILE_DATA         = 701,
     247    GUEST_DND_FN_GH_SND_FILE_DATA         = 701,
    248248    /** The guest sends a file header to the host, marking the
    249249     *  beginning of a (new) file transfer.
    250250     *  Note: Available since protocol version 2 (VBox 5.0). */
    251     GUEST_DND_GH_SND_FILE_HDR          = 702,
     251    GUEST_DND_FN_GH_SND_FILE_HDR          = 702,
    252252    /** Blow the type up to 32-bit. */
    253     GUEST_DND_32BIT_HACK               = 0x7fffffff
     253    GUEST_DND_FN_32BIT_HACK               = 0x7fffffff
    254254};
    255255
    256256/** @name VBOX_DND_GF_XXX - Guest features.
    257  * @sa GUEST_DND_REPORT_FEATURES
     257 * @sa GUEST_DND_FN_REPORT_FEATURES
    258258 * @{ */
    259259/** No flags set. */
    … …  
    297297 *
    298298 * Used by:
    299  * HOST_DND_HG_EVT_ENTER
    300  * HOST_DND_HG_EVT_MOVE
    301  * HOST_DND_HG_EVT_DROPPED
     299 * HOST_DND_FN_HG_EVT_ENTER
     300 * HOST_DND_FN_HG_EVT_MOVE
     301 * HOST_DND_FN_HG_EVT_DROPPED
    302302 */
    303303typedef struct HGCMMsgHGAction
    … …  
    336336 *
    337337 * Used by:
    338  * HOST_DND_HG_EVT_LEAVE
     338 * HOST_DND_FN_HG_EVT_LEAVE
    339339 */
    340340typedef struct HGCMMsgHGLeave
    … …  
    355355 *
    356356 * Used by:
    357  * HOST_DND_HG_EVT_CANCEL
     357 * HOST_DND_FN_HG_EVT_CANCEL
    358358 */
    359359typedef struct HGCMMsgHGCancel
    … …  
    374374 *
    375375 * Used by:
    376  * HOST_DND_HG_SND_DATA_HDR
    377  * GUEST_DND_GH_SND_DATA_HDR
     376 * HOST_DND_FN_HG_SND_DATA_HDR
     377 * GUEST_DND_FN_GH_SND_DATA_HDR
    378378 *
    379379 * New since protocol v3.
    … …  
    418418 *
    419419 * Used by:
    420  * HOST_DND_HG_SND_DATA
     420 * HOST_DND_FN_HG_SND_DATA
    421421 */
    422422typedef struct HGCMMsgHGSendData
    … …  
    459459 *
    460460 * Used by:
    461  * HOST_DND_HG_SND_MORE_DATA
     461 * HOST_DND_FN_HG_SND_MORE_DATA
    462462 */
    463463typedef struct HGCMMsgHGSendMoreData
    … …  
    473473 *
    474474 * Used by:
    475  * HOST_DND_HG_SND_DIR
    476  * GUEST_DND_GH_SND_DIR
     475 * HOST_DND_FN_HG_SND_DIR
     476 * GUEST_DND_FN_GH_SND_DIR
    477477 */
    478478typedef struct HGCMMsgHGSendDir
    … …  
    510510 *
    511511 * Used by:
    512  * HOST_DND_HG_SND_FILE_HDR
    513  * GUEST_DND_GH_SND_FILE_HDR
     512 * HOST_DND_FN_HG_SND_FILE_HDR
     513 * GUEST_DND_FN_GH_SND_FILE_HDR
    514514 */
    515515typedef struct HGCMMsgHGSendFileHdr
    … …  
    535535 *
    536536 * Used by:
    537  * HOST_DND_HG_SND_FILE
     537 * HOST_DND_FN_HG_SND_FILE
    538538 */
    539539typedef struct HGCMMsgHGSendFileData
    … …  
    591591 *
    592592 * Used by:
    593  * HOST_DND_GH_REQ_PENDING
     593 * HOST_DND_FN_GH_REQ_PENDING
    594594 */
    595595typedef struct HGCMMsgGHReqPending
    … …  
    619619 *
    620620 * Used by:
    621  * HOST_DND_GH_EVT_DROPPED
     621 * HOST_DND_FN_GH_EVT_DROPPED
    622622 */
    623623typedef struct HGCMMsgGHDropped
    … …  
    660660 *
    661661 * Used by:
    662  * GUEST_DND_GET_NEXT_HOST_MSG
     662 * GUEST_DND_FN_GET_NEXT_HOST_MSG
    663663 */
    664664typedef struct HGCMMsgGetNext
    … …  
    680680 *
    681681 * Used by:
    682  * GUEST_DND_CONNECT
     682 * GUEST_DND_FN_CONNECT
    683683 */
    684684typedef struct HGCMMsgConnect
    … …  
    714714 *
    715715 * Used by:
    716  * GUEST_DND_HG_ACK_OP
     716 * GUEST_DND_FN_HG_ACK_OP
    717717 */
    718718typedef struct HGCMMsgHGAck
    … …  
    739739 *
    740740 * Used by:
    741  * GUEST_DND_HG_REQ_DATA
     741 * GUEST_DND_FN_HG_REQ_DATA
    742742 */
    743743typedef struct HGCMMsgHGReqData
    … …  
    788788 *
    789789 * Used by:
    790  * GUEST_DND_GH_ACK_PENDING
     790 * GUEST_DND_FN_GH_ACK_PENDING
    791791 */
    792792typedef struct HGCMMsgGHAckPending
    … …  
    819819 *
    820820 * Used by:
    821  * GUEST_DND_GH_SND_DATA_HDR
     821 * GUEST_DND_FN_GH_SND_DATA_HDR
    822822 *
    823823 * New since protocol v3.
    … …  
    829829 *
    830830 * Used by:
    831  * GUEST_DND_GH_SND_DATA
     831 * GUEST_DND_FN_GH_SND_DATA
    832832 */
    833833typedef struct HGCMMsgGHSendData
    … …  
    865865 *
    866866 * Used by:
    867  * GUEST_DND_GH_SND_DIR
     867 * GUEST_DND_FN_GH_SND_DIR
    868868 */
    869869typedef struct HGCMMsgHGSendDir HGCMMsgGHSendDir;
    … …  
    873873 *
    874874 * Used by:
    875  * GUEST_DND_GH_SND_FILE_HDR
     875 * GUEST_DND_FN_GH_SND_FILE_HDR
    876876 *
    877877 * New since protocol v2.
    … …  
    883883 *
    884884 * Used by:
    885  * GUEST_DND_GH_SND_FILE_DATA
     885 * GUEST_DND_FN_GH_SND_FILE_DATA
    886886 */
    887887typedef struct HGCMMsgHGSendFileData HGCMMsgGHSendFileData;
    … …  
    891891 *
    892892 * Used by:
    893  * GUEST_DND_GH_EVT_ERROR
     893 * GUEST_DND_FN_GH_EVT_ERROR
    894894 */
    895895typedef struct HGCMMsgGHError
    … …  
    924924enum eDnDCallbackMagics
    925925{
    926     CB_MAGIC_DND_CONNECT                   = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_CONNECT, 0),
    927     CB_MAGIC_DND_REPORT_FEATURES           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_REPORT_FEATURES, 0),
    928     CB_MAGIC_DND_HG_GET_NEXT_HOST_MSG      = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GET_NEXT_HOST_MSG, 0),
    929     CB_MAGIC_DND_HG_ACK_OP                 = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_HG_ACK_OP, 0),
    930     CB_MAGIC_DND_HG_REQ_DATA               = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_HG_REQ_DATA, 0),
    931     CB_MAGIC_DND_HG_EVT_PROGRESS           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_HG_EVT_PROGRESS, 0),
    932     CB_MAGIC_DND_GH_ACK_PENDING            = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_ACK_PENDING, 0),
    933     CB_MAGIC_DND_GH_SND_DATA               = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_DATA, 0),
    934     CB_MAGIC_DND_GH_SND_DATA_HDR           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_DATA_HDR, 0),
    935     CB_MAGIC_DND_GH_SND_DIR                = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_DIR, 0),
    936     CB_MAGIC_DND_GH_SND_FILE_HDR           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_FILE_HDR, 0),
    937     CB_MAGIC_DND_GH_SND_FILE_DATA          = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_SND_FILE_DATA, 0),
    938     CB_MAGIC_DND_GH_EVT_ERROR              = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_GH_EVT_ERROR, 0)
     926    CB_MAGIC_DND_CONNECT                   = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_CONNECT, 0),
     927    CB_MAGIC_DND_REPORT_FEATURES           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_REPORT_FEATURES, 0),
     928    CB_MAGIC_DND_HG_GET_NEXT_HOST_MSG      = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GET_NEXT_HOST_MSG, 0),
     929    CB_MAGIC_DND_HG_ACK_OP                 = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_HG_ACK_OP, 0),
     930    CB_MAGIC_DND_HG_REQ_DATA               = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_HG_REQ_DATA, 0),
     931    CB_MAGIC_DND_HG_EVT_PROGRESS           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_HG_EVT_PROGRESS, 0),
     932    CB_MAGIC_DND_GH_ACK_PENDING            = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_ACK_PENDING, 0),
     933    CB_MAGIC_DND_GH_SND_DATA               = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_DATA, 0),
     934    CB_MAGIC_DND_GH_SND_DATA_HDR           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_DATA_HDR, 0),
     935    CB_MAGIC_DND_GH_SND_DIR                = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_DIR, 0),
     936    CB_MAGIC_DND_GH_SND_FILE_HDR           = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_FILE_HDR, 0),
     937    CB_MAGIC_DND_GH_SND_FILE_DATA          = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_SND_FILE_DATA, 0),
     938    CB_MAGIC_DND_GH_EVT_ERROR              = VBOX_DND_CB_MAGIC_MAKE(GUEST_DND_FN_GH_EVT_ERROR, 0)
    939939};
    940940
Note: See TracChangeset for help on using the changeset viewer.

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