187 lines
6.9 KiB
C
187 lines
6.9 KiB
C
/** @file
|
|
* Shared Clipboard - Common X11 code.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (C) 2006-2023 Oracle and/or its affiliates.
|
|
*
|
|
* This file is part of VirtualBox base platform packages, as
|
|
* available from https://www.virtualbox.org.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation, in version 3 of the
|
|
* License.
|
|
*
|
|
* This program is distributed in the hope that it will be useful, but
|
|
* WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, see <https://www.gnu.org/licenses>.
|
|
*
|
|
* The contents of this file may alternatively be used under the terms
|
|
* of the Common Development and Distribution License Version 1.0
|
|
* (CDDL), a copy of it is provided in the "COPYING.CDDL" file included
|
|
* in the VirtualBox distribution, in which case the provisions of the
|
|
* CDDL are applicable instead of those of the GPL.
|
|
*
|
|
* You may elect to license modified versions of this file under the
|
|
* terms and conditions of either the GPL or the CDDL or both.
|
|
*
|
|
* SPDX-License-Identifier: GPL-3.0-only OR CDDL-1.0
|
|
*/
|
|
|
|
#ifndef VBOX_INCLUDED_GuestHost_SharedClipboard_x11_h
|
|
#define VBOX_INCLUDED_GuestHost_SharedClipboard_x11_h
|
|
#ifndef RT_WITHOUT_PRAGMA_ONCE
|
|
# pragma once
|
|
#endif
|
|
|
|
#include <X11/Intrinsic.h>
|
|
|
|
#include <iprt/thread.h>
|
|
|
|
#include <VBox/GuestHost/SharedClipboard.h>
|
|
#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
|
|
# include <VBox/GuestHost/SharedClipboard-transfers.h>
|
|
#endif
|
|
|
|
/**
|
|
* The maximum number of simultaneous connections to shared clipboard service.
|
|
* This constant limits amount of GUEST -> HOST connections to shared clipboard host service
|
|
* for X11 host only. Once amount of connections reaches this number, all the
|
|
* further attempts to CONNECT will be dropped on an early stage. Possibility to connect
|
|
* is available again after one of existing connections is closed by DISCONNECT call.
|
|
*/
|
|
#define VBOX_SHARED_CLIPBOARD_X11_CONNECTIONS_MAX (20)
|
|
|
|
/** Enables the Xt busy / update handling. */
|
|
#define VBOX_WITH_SHARED_CLIPBOARD_XT_BUSY 1
|
|
|
|
/**
|
|
* Enumeration for all clipboard formats which we support on X11.
|
|
*/
|
|
typedef enum _SHCLX11FMT
|
|
{
|
|
SHCLX11FMT_INVALID = 0,
|
|
SHCLX11FMT_TARGETS,
|
|
SHCLX11FMT_TEXT, /* Treat this as UTF-8, but it may really be ascii */
|
|
SHCLX11FMT_UTF8,
|
|
SHCLX11FMT_BMP,
|
|
SHCLX11FMT_HTML
|
|
#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
|
|
, SHCLX11FMT_URI_LIST
|
|
#endif
|
|
} SHCLX11FMT;
|
|
|
|
/**
|
|
* The table maps X11 names to data formats
|
|
* and to the corresponding VBox clipboard formats.
|
|
*/
|
|
typedef struct SHCLX11FMTTABLE
|
|
{
|
|
/** The X11 atom name of the format (several names can match one format). */
|
|
const char *pcszAtom;
|
|
/** The format corresponding to the name. */
|
|
SHCLX11FMT enmFmtX11;
|
|
/** The corresponding VBox clipboard format. */
|
|
SHCLFORMAT uFmtVBox;
|
|
} SHCLX11FMTTABLE;
|
|
|
|
#define NIL_CLIPX11FORMAT 0
|
|
|
|
/** Defines an index of the X11 clipboad format table. */
|
|
typedef unsigned SHCLX11FMTIDX;
|
|
|
|
/**
|
|
* Structure for maintaining a Shared Clipboard context on X11 platforms.
|
|
*/
|
|
typedef struct _SHCLX11CTX
|
|
{
|
|
/** Opaque data structure describing the front-end. */
|
|
PSHCLCONTEXT pFrontend;
|
|
/** Our callback table to use. */
|
|
SHCLCALLBACKS Callbacks;
|
|
/** Is an X server actually available? */
|
|
bool fHaveX11;
|
|
/** The X Toolkit application context structure. */
|
|
XtAppContext pAppContext;
|
|
/** We have a separate thread to wait for window and clipboard events. */
|
|
RTTHREAD Thread;
|
|
/** Flag indicating that the thread is in a started state. */
|
|
bool fThreadStarted;
|
|
/** The X Toolkit widget which we use as our clipboard client. It is never made visible. */
|
|
Widget pWidget;
|
|
/** Should we try to grab the clipboard on startup? */
|
|
bool fGrabClipboardOnStart;
|
|
/** The best text format X11 has to offer, as an index into the formats table. */
|
|
SHCLX11FMTIDX idxFmtText;
|
|
/** The best bitmap format X11 has to offer, as an index into the formats table. */
|
|
SHCLX11FMTIDX idxFmtBmp;
|
|
/** The best HTML format X11 has to offer, as an index into the formats table. */
|
|
SHCLX11FMTIDX idxFmtHTML;
|
|
#ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS
|
|
/** The best HTML format X11 has to offer, as an index into the formats table. */
|
|
SHCLX11FMTIDX idxFmtURI;
|
|
# ifdef VBOX_WITH_SHARED_CLIPBOARD_TRANSFERS_HTTP
|
|
/** HTTP transfer context data. */
|
|
SHCLHTTPCONTEXT HttpCtx;
|
|
# endif
|
|
#endif
|
|
/** What kind of formats does VBox have to offer? */
|
|
SHCLFORMATS vboxFormats;
|
|
/** Cache of the last unicode data that we received. */
|
|
void *pvUnicodeCache;
|
|
/** Size of the unicode data in the cache. */
|
|
uint32_t cbUnicodeCache;
|
|
/** When we wish the clipboard to exit, we have to wake up the event
|
|
* loop. We do this by writing into a pipe. This end of the pipe is
|
|
* the end that another thread can write to. */
|
|
int wakeupPipeWrite;
|
|
/** The reader end of the pipe. */
|
|
int wakeupPipeRead;
|
|
/** A pointer to the XFixesSelectSelectionInput function. */
|
|
void (*fixesSelectInput)(Display *, Window, Atom, unsigned long);
|
|
/** The first XFixes event number. */
|
|
int fixesEventBase;
|
|
#ifdef VBOX_WITH_SHARED_CLIPBOARD_XT_BUSY
|
|
/** XtGetSelectionValue on some versions of libXt isn't re-entrant
|
|
* so block overlapping requests on this flag. */
|
|
bool fXtBusy;
|
|
/** If a request is blocked on the previous flag, set this flag to request
|
|
* an update later - the first callback should check and clear this flag
|
|
* before processing the callback event. */
|
|
bool fXtNeedsUpdate;
|
|
#endif
|
|
} SHCLX11CTX, *PSHCLX11CTX;
|
|
|
|
/**
|
|
* Structure for keeping a X11 read data request.
|
|
*/
|
|
typedef struct _SHCLX11READDATAREQ
|
|
{
|
|
/** Actual read request to handle. */
|
|
CLIPREADCBREQ *pReq;
|
|
/** Result code of the operation on completion. */
|
|
int rcCompletion;
|
|
} SHCLX11READDATAREQ;
|
|
/** Pointer to a send data request. */
|
|
typedef SHCLX11READDATAREQ *PSHCLX11READDATAREQ;
|
|
|
|
/** @name Shared Clipboard APIs for X11.
|
|
* @{
|
|
*/
|
|
int ShClX11Init(PSHCLX11CTX pCtx, PSHCLCALLBACKS pCallbacks, PSHCLCONTEXT pParent, bool fHeadless);
|
|
void ShClX11Destroy(PSHCLX11CTX pCtx);
|
|
int ShClX11ThreadStart(PSHCLX11CTX pCtx, bool grab);
|
|
int ShClX11ThreadStartEx(PSHCLX11CTX pCtx, const char *pszName, bool fGrab);
|
|
int ShClX11ThreadStop(PSHCLX11CTX pCtx);
|
|
int ShClX11ReportFormatsToX11(PSHCLX11CTX pCtx, SHCLFORMATS vboxFormats);
|
|
int ShClX11ReadDataFromX11(PSHCLX11CTX pCtx, SHCLFORMATS vboxFormat, CLIPREADCBREQ *pReq);
|
|
void ShClX11SetCallbacks(PSHCLX11CTX pCtx, PSHCLCALLBACKS pCallbacks);
|
|
/** @} */
|
|
|
|
#endif /* !VBOX_INCLUDED_GuestHost_SharedClipboard_x11_h */
|
|
|