blob: 4feb09de0121ba7923f720cef4a5e543ed60488d (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
/* $Id: VBoxClient.h $ */
/** @file
*
* VirtualBox additions user session daemon.
*/
/*
* Copyright (C) 2006-2019 Oracle Corporation
*
* This file is part of VirtualBox Open Source Edition (OSE), as
* available from http://www.virtualbox.org. This file is free software;
* you can redistribute it and/or modify it under the terms of the GNU
* General Public License (GPL) as published by the Free Software
* Foundation, in version 2 as it comes in the "COPYING" file of the
* VirtualBox OSE distribution. VirtualBox OSE is distributed in the
* hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
*/
#ifndef GA_INCLUDED_SRC_x11_VBoxClient_VBoxClient_h
#define GA_INCLUDED_SRC_x11_VBoxClient_VBoxClient_h
#ifndef RT_WITHOUT_PRAGMA_ONCE
# pragma once
#endif
#include <VBox/log.h>
#include <iprt/cpp/utils.h>
#include <iprt/string.h>
/** Exit with a fatal error. */
#define VBClFatalError(format) \
do { \
char *pszMessage = RTStrAPrintf2 format; \
LogRel(format); \
vbclFatalError(pszMessage); \
} while(0)
/** Exit with a fatal error. */
extern DECLNORETURN(void) vbclFatalError(char *pszMessage);
/** Call clean-up for the current service and exit. */
extern void VBClCleanUp(bool fExit = true);
/** A simple interface describing a service. VBoxClient will run exactly one
* service per invocation. */
struct VBCLSERVICE
{
/** Get the services default path to pidfile, relative to $HOME */
/** @todo Should this also have a component relative to the X server number?
*/
const char *(*getPidFilePath)(void);
/** Special initialisation, if needed. @a pause and @a resume are
* guaranteed not to be called until after this returns. */
int (*init)(struct VBCLSERVICE **ppInterface);
/** Run the service main loop */
int (*run)(struct VBCLSERVICE **ppInterface, bool fDaemonised);
/** Clean up any global resources before we shut down hard. The last calls
* to @a pause and @a resume are guaranteed to finish before this is called.
*/
void (*cleanup)(struct VBCLSERVICE **ppInterface);
};
/** Default handler for various struct VBCLSERVICE member functions. */
DECLINLINE(int) VBClServiceDefaultHandler(struct VBCLSERVICE **pSelf)
{
RT_NOREF1(pSelf);
return VINF_SUCCESS;
}
/** Default handler for the struct VBCLSERVICE clean-up member function.
* Usually used because the service is cleaned up automatically when the user
* process/X11 exits. */
DECLINLINE(void) VBClServiceDefaultCleanup(struct VBCLSERVICE **ppInterface)
{
NOREF(ppInterface);
}
extern struct VBCLSERVICE **VBClGetClipboardService();
extern struct VBCLSERVICE **VBClGetSeamlessService();
extern struct VBCLSERVICE **VBClGetDisplayService();
extern struct VBCLSERVICE **VBClGetHostVersionService();
#ifdef VBOX_WITH_DRAG_AND_DROP
extern struct VBCLSERVICE **VBClGetDragAndDropService();
#endif /* VBOX_WITH_DRAG_AND_DROP */
extern struct VBCLSERVICE **VBClCheck3DService();
extern struct VBCLSERVICE **VBClDisplaySVGAService();
extern struct VBCLSERVICE **VBClDisplaySVGAX11Service();
#endif /* !GA_INCLUDED_SRC_x11_VBoxClient_VBoxClient_h */
|
