Add a new class representing the X server

This class is a Process, so it's a drop-in replacement for the current
Environment, but it provides a few methods to talk to the server being
started.

SetDisplayNumber() is called, but currently unused by the server.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Reviewed-by: Chase Douglas <chase.douglas@canonical.com>

3 files changed, 128 insertions, 0 deletions

diff --git a/include/Makefile.am b/include/Makefile.am
index 9ff5f2a..4a6ce03 100644
--- a/include/Makefile.am
+++ b/include/Makefile.am
@@ -34,6 +34,7 @@ nobase_include_HEADERS = \
 	xorg/gtest/xorg-gtest-environment.h \
 	xorg/gtest/xorg-gtest-process.h \
 	xorg/gtest/xorg-gtest-test.h \
+	xorg/gtest/xorg-gtest-xserver.h \
 	xorg/gtest/evemu/xorg-gtest-device.h \
 	xorg/gtest/xorg-gtest.h \
 	$(compat_headers)
diff --git a/include/xorg/gtest/xorg-gtest-xserver.h b/include/xorg/gtest/xorg-gtest-xserver.h
new file mode 100644
index 0000000..e717039
--- /dev/null
+++ b/include/xorg/gtest/xorg-gtest-xserver.h
@@ -0,0 +1,126 @@
+/*******************************************************************************
+ *
+ * X testing environment - Google Test helper class to communicate with the
+ * server
+ *
+ * Copyright (C) 2012 Red Hat, Inc.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice (including the next
+ * paragraph) shall be included in all copies or substantial portions of the
+ * Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ ******************************************************************************/
+
+
+#ifndef XORG_GTEST_XSERVER_H
+#define XORG_GTEST_XSERVER_H
+
+#include <gtest/gtest.h>
+#include <xorg/gtest/xorg-gtest.h>
+#include <X11/Xlib.h>
+
+namespace xorg {
+namespace testing {
+
+/**
+ * @class XServer xorg-gtest-xserver.h xorg/gtest/xorg-gtest-xserver.h
+ *
+ * Miscellaneous interfaces to communicate with the X server.
+ */
+class XServer : public xorg::testing::Process {
+  public:
+    XServer();
+
+    /**
+     * Set the display number for this server. This number must be set
+     * before the server is started to have any effect.
+     * If unset, the default display number is used.
+     *
+     * @param [in] display_number The display number the server runs on
+     */
+    void SetDisplayNumber(unsigned int display_number);
+
+    /**
+     * Get the display number from this server. If the server was not
+     * started yet, this function returns the display number the server will
+     * be started on.
+     *
+     * @return The numeric display number this server runs on
+     */
+    unsigned int GetDisplayNumber(void);
+
+    /**
+     * Get the display string that may be used for XOpenDisplay to this
+     * server. This string is effectively :display_number.
+     *
+     * @return The display string used for XOpenDisplay() to this server.
+     */
+    const std::string& GetDisplayString(void);
+
+    /**
+     * Wait for a specific device to be added to the server.
+     *
+     * @param [in] display The X display connection
+     * @param [in] name    The name of the device to wait for
+     * @param [in] timeout The timeout in milliseconds
+     *
+     * @return Whether the device was added
+     */
+    static bool WaitForDevice(::Display *display, const std::string &name, time_t timeout = 1000);
+
+    /**
+     * Wait for an event on the X connection.
+     *
+     * @param [in] display The X display connection
+     * @param [in] timeout The timeout in milliseconds
+     *
+     * @return Whether an event is available
+     */
+    static bool WaitForEvent(::Display *display, time_t timeout = 1000);
+
+    /**
+     * Wait for an event of a specific type on the X connection.
+     *
+     * All events preceding the matching event are discarded. If no event was found
+     * before the timeout expires, all events in the queue will have been discarded.
+     *
+     * @param [in] display   The X display connection
+     * @param [in] type      The X core protocol event type
+     * @param [in] extension The X extension opcode of a generic event, or -1 for
+     *                       any generic event
+     * @param [in] evtype    The X extension event type of a generic event, or -1
+     *                       for any event of the given extension
+     * @param [in] timeout   The timeout in milliseconds
+     *
+     * @return Whether an event is available
+     */
+    static bool WaitForEventOfType(::Display *display, int type, int extension, int evtype, time_t timeout = 1000);
+
+  private:
+    struct Private;
+    std::auto_ptr<Private> d_;
+
+    /* Disable copy constructor, assignment operator */
+    XServer(const XServer&);
+    XServer& operator=(const XServer&);
+
+};
+} // namespace testing
+} // namespace xorg
+
+#endif /* XORG_GTEST_XSERVER_H */
diff --git a/include/xorg/gtest/xorg-gtest.h b/include/xorg/gtest/xorg-gtest.h
index 9d57e9e..6a621bd 100644
--- a/include/xorg/gtest/xorg-gtest.h
+++ b/include/xorg/gtest/xorg-gtest.h
@@ -27,6 +27,7 @@
 
 #include "xorg-gtest-environment.h"
 #include "xorg-gtest-process.h"
+#include "xorg-gtest-xserver.h"
 #include "xorg-gtest-test.h"
 
 #ifdef HAVE_EVEMU