barrier/synergy/CXWindowsScreen.h

#ifndef CXWINDOWSSCREEN_H
#define CXWINDOWSSCREEN_H

#include "BasicTypes.h"
#include "ClipboardTypes.h"
#include "CClipboard.h"
#include "CMutex.h"
#include <X11/Xlib.h>
#include <map>
#include <list>

class CString;

class CXWindowsScreen {
public:
	CXWindowsScreen();
	virtual ~CXWindowsScreen();

protected:
	class CDisplayLock {
	public:
		CDisplayLock(const CXWindowsScreen*);
		~CDisplayLock();

		operator Display*() const;

	private:
		const CMutex*	m_mutex;
		Display*		m_display;
	};
	friend class CDisplayLock;

	// open the X display.  calls onOpenDisplay() after opening the display,
	// getting the screen, its size, and root window.  then it starts the
	// event thread.
	void				openDisplay();

	// destroy the window and close the display.  calls onCloseDisplay()
	// after the event thread has been shut down but before the display
	// is closed.
	void				closeDisplay();

	// get the opened screen, its size, its root window.  to get the
	// display create a CDisplayLock object passing this.  while the
	// object exists no other threads may access the display.  do not
	// save the Display* beyond the lifetime of the CDisplayLock.
	int					getScreen() const;
	void				getScreenSize(SInt32* w, SInt32* h) const;
	Window				getRoot() const;

	// create a cursor that is transparent everywhere
	Cursor				createBlankCursor() const;

	// wait for and get the next X event.  cancellable.
	bool				getEvent(XEvent*) const;

	// cause getEvent() to return false immediately and forever after
	void				doStop();

	// determine the clipboard from the X selection.  returns
	// kClipboardEnd if no such clipboard.
	ClipboardID			getClipboardID(Atom selection);

	// call when we lose the clipboard ownership (i.e. when we receive
	// a SelectionClear event).  returns true iff we've actually lost
	// a selection we care about.
	bool				lostClipboard(Atom selection, Time timestamp);

	// set the contents of the clipboard (i.e. primary selection)
	bool				setDisplayClipboard(ClipboardID,
								const IClipboard* clipboard,
								Window requestor, Time timestamp);

	// copy the clipboard contents to clipboard.  requestor must be a
	// valid window;  it will be used to receive the transfer.  timestamp
	// should be the timestamp of the provoking event and not CurrentTime.
	// if force is false then only update clipboard
	void				getDisplayClipboard(ClipboardID,
								IClipboard* clipboard,
								Window requestor, Time timestamp) const;

	// add a selection request to the request list
	void				addClipboardRequest(
								Window owner, Window requestor,
								Atom selection, Atom target,
								Atom property, Time time);

	// continue processing a selection request
	void				processClipboardRequest(Window window,
								Atom property, Time time);

	// terminate a selection request
	void				destroyClipboardRequest(Window window);

	// get the current server time
	Time				getCurrentTime(Window) const;

	// called by openDisplay() to allow subclasses to prepare the display
	virtual void		onOpenDisplay() = 0;

	// called by closeDisplay() to 
	virtual void		onCloseDisplay() = 0;

	// get the X event mask required by the subclass for the given window
	virtual long		getEventMask(Window) const = 0;

private:
	struct CPropertyNotifyInfo {
	public:
		Window			m_window;
		Atom			m_property;
	};
	struct CClipboardRequest {
	public:
		CString			m_data;
		UInt32			m_sent;
		Window			m_requestor;
		Atom			m_property;
		Atom			m_type;
		int				m_size;
	};
	typedef std::list<CClipboardRequest*> CRequestList;
	typedef std::map<Window, CRequestList*> CRequestMap;

	bool				getDisplayClipboard(Atom selection, Atom type,
								Window requestor, Time timestamp,
								Atom* outputType, CString* data) const;
	bool				getData(Window, Atom property,
								Atom* type, SInt32* datumSize,
								CString* data) const;
	IClipboard::EFormat	getFormat(Atom) const;
	static Bool			findSelectionNotify(Display*,
								XEvent* xevent, XPointer arg);
	static Bool			findPropertyNotify(Display*,
								XEvent* xevent, XPointer arg);

	bool				sendClipboardData(ClipboardID, Window requestor,
								Atom target, Atom property, Time time);
	bool				sendClipboardMultiple(ClipboardID, Window requestor,
								Atom property, Time time);
	bool				sendClipboardTargets(ClipboardID, Window requestor,
								Atom property, Time time);
	bool				sendClipboardTimestamp(ClipboardID, Window requestor,
								Atom property, Time time);
	void				sendNotify(Window requestor, Atom selection,
								Atom target, Atom property, Time time);
	bool				wasOwnedAtTime(ClipboardID, Window, Time) const;
	Time				getCurrentTimeNoLock(Window) const;

private:
	class CClipboardInfo {
	public:
		CClipboardInfo();

	public:
		// the contents of the clipboard and the time we got it
		CClipboard		m_clipboard;

		// when we lost the clipboard
		Time			m_lostClipboard;

		// the request queues
		CRequestMap		m_requests;

		// owner of clipboard when we last asked for it
		Window			m_owner;

		// true iff the previous request to m_owner got no reply
		bool			m_unresponsive;
	};

	Display*			m_display;
	int					m_screen;
	Window				m_root;
	SInt32				m_w, m_h;
	bool				m_stop;

	// atoms we'll need
	Atom				m_atomTargets;
	Atom				m_atomMultiple;
	Atom				m_atomTimestamp;
	Atom				m_atomAtom;
	Atom				m_atomAtomPair;
	Atom				m_atomInteger;
	Atom				m_atomData;
	Atom				m_atomINCR;
	Atom				m_atomString;
	Atom				m_atomText;
	Atom				m_atomCompoundText;
	Atom				m_atomClipboard[kClipboardEnd];
	Atom				m_atomSynergyTime;

	// clipboard info
	CClipboardInfo		m_clipboards[kClipboardEnd];

	// X is not thread safe
	CMutex				m_mutex;
};

#endif