x11/VBoxClient/seamless-host.h

	seamless-host.h revision 6f3371e74bd63c06370fd7a958d6a0a485c1899c
/** @file
 * X11 Guest client - seamless mode, missing proper description while using the
 * potentially confusing word 'host'.
 */

/*
 * Copyright (C) 2006-2011 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 __Additions_client_seamless_host_h
# define __Additions_client_seamless_host_h

#include <iprt/thread.h>

#include <VBox/log.h>
#include <VBox/VBoxGuestLib.h>      /* for the R3 guest library functions  */

#include "seamless-x11.h"

/**
 * Interface to the host
 */
class VBoxGuestSeamlessHost : public SeamlessHostProxy
{
public:
    /** Events which can be reported by this class */
    enum meEvent
    {
        /** Empty event */
        NONE,
        /** Request to enable seamless mode */
        ENABLE,
        /** Request to disable seamless mode */
        DISABLE
    };

private:
    // We don't want a copy constructor or assignment operator
    VBoxGuestSeamlessHost(const VBoxGuestSeamlessHost&);
    VBoxGuestSeamlessHost& operator=(const VBoxGuestSeamlessHost&);

    /** Have we been initialised yet? */
    bool mIsInitialised;
    /** X11 event monitor object */
    VBoxGuestSeamlessX11 mX11Monitor;

    /** Thread to start and stop when we enter and leave seamless mode which
     *  monitors X11 windows in the guest. */
    RTTHREAD mX11MonitorRTThread;
    /** Should the X11 monitor thread be stopping? */
    volatile bool mX11ThreadStopping;
    /** Host seamless event thread. */
    RTTHREAD mThread;
    /** Is the thread running? */
    volatile bool mThreadRunning;
    /** Should the thread be stopping? */
    volatile bool mThreadStopping;

    /**
     * Waits for a seamless state change events from the host and dispatch it.  This is
     * meant to be called by the host event monitor thread exclusively.
     *
     * @returns        IRPT return code.
     */
    int nextEvent(void);

    /**
     * Interrupt an event wait and cause nextEvent() to return immediately.
     */
    void cancelEvent(void) { VbglR3InterruptEventWaits(); }

    /** Thread function to query seamless activation and deactivation events
     *  from the host. */
    static DECLCALLBACK(int) threadFunction(RTTHREAD self, void *pvUser);

    /** Helper to stop the event query thread again. */
    void stopThread();

    /** Thread function to monitor X11 window configuration changes. */
    static DECLCALLBACK(int) x11ThreadFunction(RTTHREAD self, void *pvUser);

    /** Helper to stop the X11 monitor thread again. */
    void stopX11Thread(void);

public:
    /**
     * Initialise the guest and ensure that it is capable of handling seamless mode
     * @param   pX11Monitor Object to monitor X11 guest windows.
     *
     * @returns iprt status code
     */
    int init(void)
    {
        int rc;

        LogRelFlowFunc(("\n"));
        if (mIsInitialised)
            return VERR_INTERNAL_ERROR;
        rc = mX11Monitor.init(this);
        if (RT_SUCCESS(rc))
            mIsInitialised = true;
        return rc;
    }

    /**
      * Start the service.
      * @returns iprt status value
      */
    int start(void);

    /**
     * Stops the service.
     * @param cMillies how long to wait for the thread to exit
     */
    void stop();

    /**
     * Update the set of visible rectangles in the host.
     */
    virtual void notify(RTRECT *pRects, size_t cRects);

    VBoxGuestSeamlessHost(void)
    {
        mIsInitialised = false;
        mX11MonitorRTThread = NIL_RTTHREAD;
        mX11ThreadStopping = false;
        mThread = NIL_RTTHREAD;
        mThreadRunning = false;
        mThreadStopping = false;
    }

    ~VBoxGuestSeamlessHost()
    {
        LogRelFlowFunc(("\n"));
        if (mThread)
            stop();
        LogRelFlowFunc(("returning\n"));
    }
};

#endif /* __Additions_xclient_seamless_h not defined */