vim_client-ruby 0.1.0

data/ext/vim_client/vim_client.c

@@ -0,0 +1,1039 @@
+/* vi:set ts=8 sts=4 sw=4:
+ *
+ * VimClient by Brian D. Burns
+ * Ruby extension providing a client for Vim's 'clientserver' feature.
+ *
+ * Adapted from Vim's if_xcmdsrv.c (v7-3-555)
+ */
+#include "vim_client.h"
+
+/*
+ *
+ * VIM - Vi IMproved    by Bram Moolenaar
+ * X command server by Flemming Madsen
+ *
+ * Do ":help uganda"  in Vim to read copying and usage conditions.
+ * Do ":help credits" in Vim to see a list of people who contributed.
+ * See README.txt for an overview of the Vim source code.
+ *
+ * if_xcmdsrv.c: Functions for passing commands through an X11 display.
+ *
+ */
+
+/*
+ * This file provides procedures that implement the command server
+ * functionality of Vim when in contact with an X11 server.
+ *
+ * Adapted from TCL/TK's send command  in tkSend.c of the tk 3.6 distribution.
+ * Adapted for use in Vim by Flemming Madsen. Protocol changed to that of tk 4
+ */
+
+/*
+ * Copyright (c) 1989-1993 The Regents of the University of California.
+ * All rights reserved.
+ *
+ * Permission is hereby granted, without written agreement and without
+ * license or royalty fees, to use, copy, modify, and distribute this
+ * software and its documentation for any purpose, provided that the
+ * above copyright notice and the following two paragraphs appear in
+ * all copies of this software.
+ *
+ * IN NO EVENT SHALL THE UNIVERSITY OF CALIFORNIA BE LIABLE TO ANY PARTY FOR
+ * DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING OUT
+ * OF THE USE OF THIS SOFTWARE AND ITS DOCUMENTATION, EVEN IF THE UNIVERSITY OF
+ * CALIFORNIA HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * THE UNIVERSITY OF CALIFORNIA SPECIFICALLY DISCLAIMS ANY WARRANTIES,
+ * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+ * AND FITNESS FOR A PARTICULAR PURPOSE.  THE SOFTWARE PROVIDED HEREUNDER IS
+ * ON AN "AS IS" BASIS, AND THE UNIVERSITY OF CALIFORNIA HAS NO OBLIGATION TO
+ * PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
+ */
+
+/*
+ * The information below is used for communication between processes
+ * during "send" commands.  Each process keeps a private window, never
+ * even mapped, with one property, "Comm".  When a command is sent to
+ * an interpreter, the command is appended to the comm property of the
+ * communication window associated with the interp's process.  Similarly,
+ * when a result is returned from a sent command, it is also appended
+ * to the comm property.
+ *
+ * Each command and each result takes the form of ASCII text.  For a
+ * command, the text consists of a nul character followed by several
+ * nul-terminated ASCII strings.  The first string consists of a
+ * single letter:
+ * "c" for an expression
+ * "k" for keystrokes
+ * "r" for reply
+ * "n" for notification.
+ * Subsequent strings have the form "option value" where the following options
+ * are supported:
+ *
+ * -r commWindow serial
+ *
+ *    This option means that a response should be sent to the window
+ *    whose X identifier is "commWindow" (in hex), and the response should
+ *    be identified with the serial number given by "serial" (in decimal).
+ *    If this option isn't specified then the send is asynchronous and
+ *    no response is sent.
+ *
+ * -n name
+ *    "Name" gives the name of the application for which the command is
+ *    intended.  This option must be present.
+ *
+ * -E encoding
+ *    Encoding name used for the text.  This is the 'encoding' of the
+ *    sender.  The receiver may want to do conversion to his 'encoding'.
+ *
+ * -s script
+ *    "Script" is the script to be executed.  This option must be
+ *    present.  Taken as a series of keystrokes in a "k" command where
+ *    <Key>'s are expanded
+ *
+ * The options may appear in any order.  The -n and -s options must be
+ * present, but -r may be omitted for asynchronous RPCs.  For compatibility
+ * with future releases that may add new features, there may be additional
+ * options present;  as long as they start with a "-" character, they will
+ * be ignored.
+ *
+ * A result also consists of a zero character followed by several null-
+ * terminated ASCII strings.  The first string consists of the single
+ * letter "r".  Subsequent strings have the form "option value" where
+ * the following options are supported:
+ *
+ * -s serial
+ *    Identifies the command for which this is the result.  It is the
+ *    same as the "serial" field from the -s option in the command.  This
+ *    option must be present.
+ *
+ * -r result
+ *    "Result" is the result string for the script, which may be either
+ *    a result or an error message.  If this field is omitted then it
+ *    defaults to an empty string.
+ *
+ * -c code
+ *    0: for OK. This is the default.
+ *    1: for error: Result is the last error
+ *
+ * -i errorInfo
+ * -e errorCode
+ *    Not applicable for Vim
+ *
+ * Options may appear in any order, and only the -s option must be
+ * present.  As with commands, there may be additional options besides
+ * these;  unknown options are ignored.
+ */
+
+/*
+ * Maximum size property that can be read at one time by this module:
+ * (length in 32-bit multiples of the data to be retrieved)
+ */
+#define MAX_PROP_WORDS 100000
+
+/*
+ * Structure used to process the result returned from the server.
+ */
+typedef struct {
+    int     serial;         /* Serial number expected in result. */
+    int     mode;           /* asExpr or asKeys2 */
+    int     code;           /* Result Code. 0 is OK */
+    char_u  *result;        /* String result for command (malloc'ed).
+                             * NULL means command still pending. */
+    char_u  *encoding;      /* Encoding of result (malloc'ed) */
+} PendingCommand;
+
+/*
+ * Forward declarations for procedures defined later in this file:
+ */
+static void    SendInit();
+static void    DeleteAnyLingerer __ARGS((Window w));
+static void    SendToVim __ARGS((char_u *name, char_u **cmd, int cmdMode,
+                          char_u *cmd_enc, int timeout_sec,
+                          char_u **result, int *code, char_u **server_enc));
+static Window  LookupName __ARGS((char_u *name, int delete, char_u **loose));
+static int     GetRegProp __ARGS((char_u **regPropp, long_u *numItemsp));
+static int     IsSerialName __ARGS((char_u *name));
+static int     WindowValid __ARGS((Window w));
+static int     AppendPropCarefully __ARGS((Window window, Atom property,
+                                    char_u *value, int length));
+static void    WaitForPend __ARGS((Window w, PendingCommand *pending,
+                            int timeout_sec));
+static void    EventProc __ARGS((PendingCommand *pending));
+static VALUE   send2vim __ARGS((VALUE cmd, int cmdMode));
+static VALUE   send_keys __ARGS((VALUE self, VALUE keys));
+static VALUE   send_expr __ARGS((VALUE self, VALUE expr));
+static VALUE   send_keys2 __ARGS((int argc, VALUE *argv, VALUE self));
+
+void    Init_vim_client();
+int     x_error_handler __ARGS((Display *dpy, XErrorEvent *error_event));
+int     x_ioerror_handler __ARGS((Display *dpy));
+void    sigint_handler __ARGS((int sig));
+
+static Display  *commDisplay = NULL;
+static Window   commWindow = None;
+static Atom     commProperty = None;
+static Atom     registryProperty = None;
+static Atom     vimProperty = None;
+static char_u   *empty_prop = (char_u *)""; /* empty GetRegProp() result */
+static volatile sig_atomic_t got_x_error = FALSE;
+
+static const int asExpr     = 1;    /* send cmd as an Expression */
+static const int asKeys     = 2;    /* send cmd as Keys */
+static const int asKeys2    = 3;    /* send cmd as Keys and wait for a
+                                       response (notification) */
+
+static struct sigaction sigint_action = {
+    .sa_handler = sigint_handler,
+    .sa_flags = SA_RESTART
+};
+static struct sigaction prev_sigint_action;
+static volatile sig_atomic_t got_sigint = 0;
+
+VALUE m_VimClient; /* VimClient module */
+
+/*
+ * Initialize the communication channels for sending commands and receiving
+ * results.
+ */
+    static void
+SendInit() {
+    XErrorHandler old_handler;
+
+    /*
+     * Create the window used for communication, and set up an
+     * event handler for it.
+     */
+    old_handler = XSetErrorHandler(x_error_handler);
+    got_x_error = FALSE;
+
+    commDisplay = XOpenDisplay(NULL);
+    commProperty = XInternAtom(commDisplay, "Comm", FALSE);
+    vimProperty = XInternAtom(commDisplay, "Vim", FALSE);
+    registryProperty = XInternAtom(commDisplay, "VimRegistry", FALSE);
+
+    commWindow = XCreateSimpleWindow(
+                commDisplay, XDefaultRootWindow(commDisplay),
+                getpid(), 0, 10, 10, 0,
+                WhitePixel(commDisplay, DefaultScreen(commDisplay)),
+                WhitePixel(commDisplay, DefaultScreen(commDisplay)));
+    XSelectInput(commDisplay, commWindow, PropertyChangeMask);
+    /* WARNING: Do not step through this while debugging, it will hangup
+    * the X server! */
+    XGrabServer(commDisplay);
+    DeleteAnyLingerer(commWindow);
+    XUngrabServer(commDisplay);
+
+    /* Make window recognizable as a Vim window.
+     *
+     * This is required in order to receive "notification" responses
+     * to send_keys2(). These are sent using a server2client() call
+     * on the server. That function uses serverSendReply(), which
+     * verifies that the client window has a vimProperty.
+     * Note that this is not the same as registering as a Vim server.
+     * (see DeleteAnyLingerer)
+     */
+    XChangeProperty(commDisplay, commWindow, vimProperty, XA_STRING,
+		    8, PropModeReplace, (char_u *)VIM_VERSION_SHORT,
+			(int)STRLEN(VIM_VERSION_SHORT) + 1);
+
+    XSync(commDisplay, FALSE);
+    XSetErrorHandler(old_handler);
+
+    if (got_x_error)
+        rb_raise(e_Error, "Failed to initialize");
+}
+
+/* X Error handler, defined by XSetErrorHandler().
+ * Used to temporarily replace the default handler to check for errors.
+ */
+    int
+x_error_handler(Display *dpy, XErrorEvent *error_event) {
+    got_x_error = TRUE;
+    return 0; // returned value is ignored
+}
+
+/* X IO Error handler, defined by XSetIOErrorHandler().
+ * Used during the WaitForPend loop. These are fatal IO errors.
+ */
+    int
+x_ioerror_handler(Display *dpy) {
+    rb_raise(ex_XIOError, "Fatal X11 IO Error");
+}
+
+/* Used during WaitForPend to exit the loop if a SIGINT is received.
+ * We terminate the loop, free resources, restore the previous SIGINT
+ * handler, then re-raise the SIGINT. If allowed to proceed, any call
+ * waiting for a reply will return with Qnil.
+ */
+    void
+sigint_handler(int sig) {
+    got_sigint = 1;
+}
+
+/*
+ * Delete any lingering occurrence of window id.  We promise that any
+ * occurrence is not ours since it is not yet put into the registry (by us)
+ *
+ * This is necessary in the following scenario:
+ * 1. There is an old windowid for an exit'ed vim in the registry
+ * 2. We get that id for our commWindow but only want to send, not register.
+ * 3. The window will mistakenly be regarded valid because of own commWindow
+ */
+    static void
+DeleteAnyLingerer(
+    Window      win      /* Window to remove */
+){
+    char_u      *regProp, *entry = NULL;
+    char_u      *p;
+    long_u      numItems;
+    int_u       wwin;
+
+    /*
+     * Read the registry property.
+     */
+    if (GetRegProp(&regProp, &numItems) == FAIL)
+        return;
+
+    /* Scan the property for the window id.  */
+    for (p = regProp; (long_u)(p - regProp) < numItems; ) {
+        if (*p != 0) {
+            sscanf((char *)p, "%x", &wwin);
+
+            if ((Window)wwin == win) {
+                int lastHalf;
+
+                /* Copy down the remainder to delete entry */
+                entry = p;
+                while (*p != 0)
+                    p++;
+
+                p++;
+                lastHalf = numItems - (p - regProp);
+
+                if (lastHalf > 0)
+                    memmove(entry, p, lastHalf);
+
+                numItems = (entry - regProp) + lastHalf;
+                p = entry;
+                continue;
+            }
+        }
+
+        while (*p != 0)
+            p++;
+
+        p++;
+    }
+
+    if (entry != NULL) {
+        XChangeProperty(commDisplay, RootWindow(commDisplay, 0),
+                        registryProperty, XA_STRING, 8,
+                        PropModeReplace, regProp, (int)(p - regProp));
+        XSync(commDisplay, FALSE);
+    }
+
+    if (regProp != empty_prop)
+        XFree(regProp);
+}
+
+/*
+ * Send to an instance of Vim via the X display.
+ */
+    static void
+SendToVim(
+    char_u      *name,              /* Where to send. */
+    char_u      **cmd,              /* What to send. */
+    int         cmdMode,            /* One of asExpr, asKeys, asKeys2 */
+    char_u      *cmd_enc,           /* 'encoding' of cmd string */
+    int         timeout_sec,        /* Timeout for responses */
+    char_u      **result,           /* Server reply for asExpr or asKeys2 */
+    int         *code,              /* Return code from eval'ed expression.
+                                       Applicable only for asExpr */
+    char_u      **server_enc        /* Encoding of response from server */
+){
+    Window          w;
+    char_u          *property;
+    int             length;
+    int             res;
+    char_u          *loosename = NULL;
+    static int      serial = 0;         /* Running count of sent commands.
+                                         * Used to give each command a
+                                         * different serial number. */
+
+    /*
+     * Bind the server name to a communication window.
+     *
+     * Find any survivor with a serialno attached to the name if the
+     * original registrant of the wanted name is no longer present.
+     *
+     * Delete any lingering names from dead editors.
+     */
+    while (TRUE) {
+        w = LookupName(name, FALSE, &loosename);
+        /* Check that the window is hot */
+        if (w != None) {
+            if (!WindowValid(w)) {
+                LookupName(loosename ? loosename : name,
+                    /*DELETE=*/TRUE, NULL);
+                continue;
+            }
+        }
+        break;
+    }
+
+    if (loosename != NULL) {
+        name = loosename;
+        vim_free(loosename);
+    }
+
+    if (w == None)
+        rb_raise(e_Error, "No registered Vim server found for '%s'", name);
+
+    /*
+     * Send the command to target interpreter by appending it to the
+     * comm window in the communication window.
+     * Length must be computed exactly!
+     *
+     * If the server has +multi_byte, the cmd string will be converted
+     * from cmd_enc to the encoding set on the server.
+     * The result (if asExpr or asKeys2) will be in the server's encoding.
+     * If the server does not have +multi_byte, cmd_enc will be ignored
+     * and the result will default to 'latin1' (ISO-8859-1).
+     */
+
+    length = STRLEN(name) + STRLEN(cmd_enc) + STRLEN(*cmd) + 14;
+    property = (char_u *)alloc((unsigned)length + 30);
+    sprintf((char *)property, "%c%c%c-n %s%c-E %s%c-s %s",
+        0, (cmdMode == asExpr) ? 'c' : 'k', 0, name, 0, cmd_enc, 0, *cmd);
+
+    /* Add a back reference to our comm window */
+    serial++;
+    sprintf((char *)property + length, "%c-r %x %d",
+                        0, (int_u)commWindow, serial);
+    /* Add length of what "-r %x %d" resulted in, skipping the NUL. */
+    length += STRLEN(property + length + 1) + 1;
+
+    res = AppendPropCarefully(w, commProperty, property, length + 1);
+    vim_free(property);
+
+    if (res < 0)
+        rb_raise(e_Error, "Failed to send message to Vim server");
+
+    /* There is no answer for this - Keys are sent async */
+    if (cmdMode == asKeys)
+        return;
+
+    PendingCommand  pending;
+    pending.mode = cmdMode;
+    pending.result = NULL;
+    pending.encoding = NULL;
+    /* code and serial are only applicable to asExpr */
+    pending.code = 0;
+    pending.serial = serial;
+
+    WaitForPend(w, &pending, timeout_sec);
+
+    *code = pending.code;
+    *result = pending.result;
+    *server_enc = pending.encoding;
+}
+
+/*
+ * Given a server name, see if the name exists in the registry for a
+ * particular display.
+ *
+ * If the given name is registered, return the ID of the window associated
+ * with the name.  If the name isn't registered, then return 0.
+ *
+ * Side effects:
+ *    If the registry property is improperly formed, then it is deleted.
+ *    If "delete" is non-zero, then if the named server is found it is
+ *    removed from the registry property.
+ */
+    static Window
+LookupName(
+    char_u      *name,      /* Name of a server. */
+    int         delete,     /* If non-zero, delete info about name. */
+    char_u      **loose     /* Do another search matching -999 if not found
+                               Return result here if a match is found */
+){
+    char_u    *regProp, *entry;
+    char_u    *p;
+    long_u    numItems;
+    int_u     returnValue;
+
+    /*
+     * Read the registry property.
+     */
+    if (GetRegProp(&regProp, &numItems) == FAIL)
+        return 0;
+
+    /*
+     * Scan the property for the desired name.
+     */
+    returnValue = (int_u)None;
+    entry = NULL;    /* Not needed, but eliminates compiler warning. */
+    for (p = regProp; (long_u)(p - regProp) < numItems; ) {
+        entry = p;
+
+        while (*p != 0 && !isspace(*p))
+            p++;
+
+        // case insensitive, full string comparison
+        if (*p != 0 && STRICMP(name, p + 1) == 0) {
+            sscanf((char *)entry, "%x", &returnValue);
+            break;
+        }
+
+        while (*p != 0)
+            p++;
+
+        p++;
+    }
+
+    if (loose != NULL && returnValue == (int_u)None && !IsSerialName(name)) {
+        for (p = regProp; (long_u)(p - regProp) < numItems; ) {
+            entry = p;
+
+            while (*p != 0 && !isspace(*p))
+                p++;
+
+            // case insensitive, only strlen(name) of (p + 1) compared
+            if (*p != 0 && IsSerialName(p + 1)
+                        && STRNICMP(name, p + 1, STRLEN(name)) == 0) {
+                sscanf((char *)entry, "%x", &returnValue);
+                *loose = vim_strsave(p + 1);
+                break;
+            }
+
+            while (*p != 0)
+                p++;
+
+            p++;
+        }
+    }
+
+    /*
+     * Delete the property, if that is desired (copy down the
+     * remainder of the registry property to overlay the deleted
+     * info, then rewrite the property).
+     */
+    if (delete && returnValue != (int_u)None) {
+        int count;
+
+        while (*p != 0)
+            p++;
+
+        p++;
+        count = numItems - (p - regProp);
+        if (count > 0)
+            memmove(entry, p, count);
+
+        XChangeProperty(commDisplay, RootWindow(commDisplay, 0),
+                        registryProperty, XA_STRING,
+                        8, PropModeReplace, regProp,
+                        (int)(numItems - (p - entry)));
+        XSync(commDisplay, FALSE);
+    }
+
+    if (regProp != empty_prop)
+        XFree(regProp);
+
+    return (Window)returnValue;
+}
+
+/*
+ * Read the registry property.  Delete it when it's formatted wrong.
+ * Return the property in "regPropp".  "empty_prop" is used when it doesn't
+ * exist yet.
+ * Return OK when successful.
+ */
+    static int
+GetRegProp(
+    char_u      **regPropp,
+    long_u      *numItemsp
+){
+    int             result, actualFormat;
+    long_u          bytesAfter;
+    Atom            actualType;
+    XErrorHandler   old_handler;
+
+    *regPropp = NULL;
+    old_handler = XSetErrorHandler(x_error_handler);
+    got_x_error = FALSE;
+
+    result = XGetWindowProperty(commDisplay, RootWindow(commDisplay, 0),
+                                registryProperty, 0L, (long)MAX_PROP_WORDS,
+                                FALSE, XA_STRING, &actualType, &actualFormat,
+                                numItemsp, &bytesAfter, regPropp);
+
+    XSync(commDisplay, FALSE);
+    XSetErrorHandler(old_handler);
+
+    if (got_x_error)
+        return FAIL;
+
+    if (actualType == None) {
+        /* No prop yet. Logically equal to the empty list */
+        *numItemsp = 0;
+        *regPropp = empty_prop;
+        return OK;
+    }
+
+    /* If the property is improperly formed, then delete it. */
+    if (result != Success || actualFormat != 8 || actualType != XA_STRING) {
+        if (*regPropp != NULL)
+            XFree(*regPropp);
+        XDeleteProperty(commDisplay, RootWindow(commDisplay, 0),
+                        registryProperty);
+
+        return FAIL;
+    }
+
+    return OK;
+}
+
+/*
+ * Check if "str" looks like it had a serial number appended.
+ * Actually just checks if the name ends in a digit.
+ *
+ * Handles characters > 0x100. We don't use isdigit() here, because on some
+ * systems it also considers superscript 1 to be a digit.
+ */
+    static int
+IsSerialName(char_u *str) {
+    int len = STRLEN(str);
+
+    if (len > 1) {
+        int c = str[len - 1];
+        return (c >= '0' && c <= '9');
+    }
+
+    return 0;
+}
+
+/*
+ * Return TRUE if window "w" exists and has a "Vim" property on it.
+ */
+    static int
+WindowValid(Window w) {
+    XErrorHandler   old_handler;
+    Atom            *plist;
+    int             numProp;
+    int             i;
+
+    old_handler = XSetErrorHandler(x_error_handler);
+    got_x_error = 0;
+    plist = XListProperties(commDisplay, w, &numProp);
+    XSync(commDisplay, FALSE);
+    XSetErrorHandler(old_handler);
+
+    if (plist == NULL || got_x_error)
+        return FALSE;
+
+    for (i = 0; i < numProp; i++) {
+        if (plist[i] == vimProperty) {
+            XFree(plist);
+            return TRUE;
+        }
+    }
+
+    XFree(plist);
+    return FALSE;
+}
+
+/*
+ * Append a given property to a given window, but set up an X error handler so
+ * that if the append fails this procedure can return an error code rather
+ * than having Xlib panic.
+ * Return: 0 for OK, -1 for error
+ */
+    static int
+AppendPropCarefully(
+    Window      window,         /* Window whose property is to be modified. */
+    Atom        property,       /* Name of property. */
+    char_u      *value,         /* Characters  to append to property. */
+    int         length          /* How much to append */
+){
+    XErrorHandler old_handler;
+
+    old_handler = XSetErrorHandler(x_error_handler);
+    got_x_error = FALSE;
+    XChangeProperty(commDisplay, window, property, XA_STRING, 8,
+                    PropModeAppend, value, length);
+    XSync(commDisplay, FALSE);
+    XSetErrorHandler(old_handler);
+
+    return got_x_error ? -1 : 0;
+}
+
+/*
+ * Enter a loop processing X events & polling chars until we see a result
+ */
+    static void
+WaitForPend(
+    Window          w,
+    PendingCommand  *pending,
+    int             timeout_sec
+){
+    time_t        start;
+    time_t        now;
+    time_t        lastChk = 0;
+    int           timed_out = 0;
+    XEvent        event;
+    XPropertyEvent *e = (XPropertyEvent *)&event;
+
+#define MSEC_POLL 500
+#ifdef HAVE_SYS_SELECT_H
+    fd_set          fds;
+    struct timeval  tv;
+
+    tv.tv_sec   = 0;
+    tv.tv_usec  = MSEC_POLL * 1000;
+    FD_ZERO(&fds);
+    FD_SET(ConnectionNumber(commDisplay), &fds);
+#else
+    struct pollfd   fds;
+
+    fds.fd = ConnectionNumber(commDisplay);
+    fds.events = POLLIN;
+#endif
+
+    got_sigint = 0;
+    sigaction(SIGINT, &sigint_action, &prev_sigint_action);
+
+    /* We'll raise VimClient::X11IOError if any fatal IO errors
+     * are raised by X11 while waiting for a response
+     */
+    XIOErrorHandler old_handler = XSetIOErrorHandler(x_ioerror_handler);
+
+    /* Watch for updates to our commProperty until we timeout or we're
+     * interrupted. We'll check the queue upon entering the loop, then
+     * use select/poll to check the queue as soon as our connection's fd
+     * has data (which X11/xcb will read), or at every MSEC_POLL interval.
+     */
+    time(&start);
+    while ((pending->result == NULL) && !got_sigint)
+    {
+        while (XEventsQueued(commDisplay, QueuedAfterReading) > 0) {
+            XNextEvent(commDisplay, &event);
+            if (event.type == PropertyNotify && e->window == commWindow &&
+                    e->atom == commProperty && e->state == PropertyNewValue)
+                EventProc(pending);
+        }
+
+        if (pending->result == NULL) {
+
+            time(&now);
+            if ((now - start) >= timeout_sec) {
+                timed_out = 1;
+                break;
+            }
+
+#ifdef HAVE_SYS_SELECT_H
+            select(FD_SETSIZE, &fds, NULL, NULL, &tv);
+#else
+            poll(&fds, 1, MSEC_POLL);
+#endif
+        }
+    }
+
+    XSetIOErrorHandler(old_handler);
+
+    if (got_sigint) {
+        /* When the previous handler is restored and we re-raise SIGINT,
+         * even if the signal is ignored, we will return Qnil.
+         * Also, make sure any malloc'ed memory is cleared,
+         * since it's possible EventProc could have stored a result already.
+         */
+        vim_free(pending->result);
+        vim_free(pending->encoding);
+        pending->result = NULL;
+    }
+
+    sigaction(SIGINT, &prev_sigint_action, NULL);
+
+    if (got_sigint)
+        kill(0, SIGINT);
+
+    if (timed_out)
+        rb_raise(e_TimeoutError, "Timed out waiting for response");
+}
+
+/*
+ * This procedure is invoked when our commProperty is updated.
+ * It reads the response from the server and stores the results
+ * in the PendingCommand structure.
+ */
+    static void
+EventProc(PendingCommand *pending) {
+    char_u      *propInfo;
+    char_u      *p;
+    int         result, actualFormat, code;
+    long_u      numItems, bytesAfter;
+    Atom        actualType;
+
+    /*
+     * Read the comm property and delete it.
+     * Note: There's no guarantee this won't result in a partial read.
+     */
+    propInfo = NULL;
+    result = XGetWindowProperty(commDisplay, commWindow, commProperty,
+                                0L, (long)MAX_PROP_WORDS, TRUE,
+                                XA_STRING, &actualType, &actualFormat,
+                                &numItems, &bytesAfter, &propInfo);
+
+    /* If the property doesn't exist or is improperly formed then ignore it. */
+    if (result != Success || actualType != XA_STRING || actualFormat != 8) {
+        if (propInfo != NULL)
+            XFree(propInfo);
+        return;
+    }
+
+    /*
+     * It is possible for multiple results to be stored in the commProperty.
+     * Each iteration through the outer loop handles a single result.
+     */
+    for (p = propInfo; (long_u)(p - propInfo) < numItems; ) {
+        /*
+         * Ignore leading NULs; each result starts with a NUL
+         * so that no matter how badly formed a preceding result is,
+         * we'll be able to tell that a new result is starting.
+         */
+        if (*p == 0) {
+            p++;
+            continue;
+        }
+
+        if ((*p == 'r' || *p == 'n') && p[1] == 0) {
+            int    resMode, serial, gotSerial;
+            char_u *res, *enc;
+
+            /*
+             * This is a reply to send_expr() or send_keys2().
+             * The response to send_expr() arrives as a reply ('r').
+             * The response to send_keys2() arrives as a notification ('n').
+             * Since we wait for a response to each of these requests, if a
+             * response is present for the other type, it will be discarded.
+             */
+            resMode = (*p == 'r') ? asExpr : asKeys2;
+            if (pending->mode != resMode) {
+                p++;
+                continue;
+            }
+
+            /*
+             * Iterate over all of its options. Stop when we reach the end
+             * of the property or something that doesn't look like an option.
+             */
+            p += 2;
+            gotSerial = 0;
+            code = 0;
+            res = NULL;
+            enc = NULL;
+            while ((long_u)(p - propInfo) < numItems && *p == '-') {
+                switch (p[1]) {
+                case 'r': /* Response to send_expr() */
+                    if (p[2] == ' ')
+                        res = p + 3;
+                    break;
+                case 'n': /* Response to send_keys2() */
+                    if (p[2] == ' ')
+                        res = p + 3;
+                    break;
+                case 'E': /* Encoding of 'r' or 'n' */
+                    if (p[2] == ' ')
+                        enc = p + 3;
+                    break;
+                case 's': /* send_expr() only */
+                    if (sscanf((char *)p + 2, " %d", &serial) == 1)
+                        gotSerial = 1;
+                    break;
+                case 'c': /* send_expr() only */
+                    if (sscanf((char *)p + 2, " %d", &code) != 1)
+                        code = 0;
+                    break;
+                /* case 'w': (server's commWindow)
+                 * send_keys2() only - ignored. */
+                }
+
+                while (*p != 0)
+                    p++;
+
+                p++;
+            }
+
+            /* If we're looking for a response to send_expr()
+             * but it does not match the serial number in the pending
+             * request, discard it. It could be a reply from a previous
+             * request which either timed-out or was aborted via SIGINT.
+             */
+             if (!gotSerial && resMode == asExpr)
+                 continue;
+
+            /* Responses to send_keys2() are not serialized.
+             * This means if there are old responses in the commProperty,
+             * each one found will be stored in pending, leaving us with
+             * only the latest response. So we must call vim_free() to
+             * clear any previous results.
+             *
+             * Note: Since notifications ('n') are not serialized, if an old
+             * PropertyChange and response were present (due to a previous
+             * timeout or interrupt) when we entered the loop in WaitForPend,
+             * it's possible we could read that here before the recent reply
+             * we want arrives. And since pending->result will not be NULL,
+             * the WaitForPend loop will exit.
+             */
+            if (resMode == asKeys2 ||
+                    (resMode == asExpr && serial == pending->serial)) {
+                vim_free(pending->result);
+                vim_free(pending->encoding);
+                pending->code = code; /* always 0 for asKeys2 */
+                pending->result = (res != NULL) ?
+                    vim_strsave(res) : vim_strsave((char_u *)"");
+                /* If server does not have +multi_byte,
+                 * use Vim's default 'latin1' encoding */
+                pending->encoding = (enc != NULL) ?
+                        vim_strsave(enc) : vim_strsave((char_u *)"latin1");
+            }
+        } else {
+            /*
+             * Didn't recognize this thing.  Just skip through the next
+             * null character and try again.
+             */
+            while (*p != 0)
+                p++;
+
+            p++;
+        }
+    }
+    XFree(propInfo);
+}
+
+/*
+ * Wrapper for SendToVim()
+ */
+    static VALUE
+send2vim(VALUE cmd_str, int cmdMode) {
+    char_u *name = NULL;        // name of server to send to
+    char_u *cmd = NULL;         // keys or expr to send
+    char_u *cmd_enc = NULL;     // encoding of cmd sent to server
+    char_u *res = NULL;         // response from the server
+    char_u *server_enc = NULL;  // encoding of response from server
+    int code = 0;               // response code (0 = OK, 1 = FAIL)
+    int timeout_sec = 60;       // timeout for waiting for a response
+
+    VALUE server = rb_iv_get(m_VimClient, "@server_name");
+    if (NIL_P(server))
+        rb_raise(e_Error, "server_name must be set");
+    else
+        name = StringValueCStr(server);
+
+    if (cmdMode != asKeys) {
+        /* override the default timeout if VimClient.timeout_sec is set */
+        VALUE val = rb_iv_get(m_VimClient, "@timeout_sec");
+        int t = FIXNUM_P(val) ? FIX2INT(val) : 0;
+        if (t > 0)
+            timeout_sec = t;
+    }
+
+    /* Convert the ruby string into a C string, transcoding as needed.
+     * Set the Vim encoding name of the cmd string. */
+    cmd = (char_u *)rb2vim_enc_str(cmd_str, &cmd_enc);
+
+    SendToVim(name, &cmd, cmdMode, cmd_enc, timeout_sec,
+              &res, &code, &server_enc);
+
+    if (cmdMode != asKeys && res != NULL) {
+        /* Convert the returned C string into a Ruby string,
+         * marked with the proper encoding */
+        VALUE ret = vim2rb_enc_str(&res, server_enc);
+        /* malloc'ed by vim_strsave() in EventProc() */
+        vim_free(res);
+        vim_free(server_enc);
+
+        if (code)
+            rb_raise(e_ExprError, "%s", StringValueCStr(ret));
+        else
+            return ret;
+    }
+
+    return Qnil;
+}
+
+    static VALUE
+send_keys(VALUE self, VALUE keys) {
+    return send2vim(keys, asKeys);
+}
+
+    static VALUE
+send_expr(VALUE self, VALUE expr) {
+    return send2vim(expr, asExpr);
+}
+
+    static VALUE
+send_keys2(int argc, VALUE *argv, VALUE self) {
+    VALUE keys, expr;
+    rb_scan_args(argc, argv, "11", &keys, &expr);
+
+    /* Create a callback string using the same encoding as keys.
+     * Note that concatination must be used, as opposed to printf (%)
+     * since we could be dealing with 16/32 bit encodings at this point.
+     */
+    VALUE callback, close;
+    rb_encoding *enc = rb_enc_get(keys);
+    callback = rb_str_export_to_enc(rb_str_new2(
+            ":call server2client(expand(\"<client>\"), "), enc);
+    close = rb_str_export_to_enc(rb_str_new2(")<cr>"), enc);
+
+    if (NIL_P(expr)) /* Return an empty string from the callback */
+        expr = rb_str_export_to_enc(rb_str_new2("\"\""), enc);
+    else if (enc != rb_enc_get(expr))
+        rb_raise(e_Error, "'keys' and 'expr' must use the same encoding");
+
+    /* Insert expr into the callback */
+    rb_str_append(callback, expr);
+    rb_str_append(callback, close);
+
+    /* Append the callback to the keys.
+     * rb_str_plus is used so we don't modify the user's 'keys' string */
+    keys = rb_str_plus(keys, callback);
+
+    return send2vim(keys, asKeys2);
+}
+
+/*
+ * Initialization method for ruby extension
+ */
+    void
+Init_vim_client() {
+    m_VimClient = rb_define_module("VimClient");
+
+    VALUE ex_Exception =
+        rb_define_class_under(m_VimClient, "Exception", rb_eException);
+    ex_NoMemoryError =
+        rb_define_class_under(m_VimClient, "NoMemoryError", ex_Exception);
+    ex_XIOError =
+        rb_define_class_under(m_VimClient, "XIOError", ex_Exception);
+    e_Error =
+        rb_define_class_under(m_VimClient, "Error", rb_eStandardError);
+    e_TimeoutError =
+        rb_define_class_under(m_VimClient, "TimeoutError", e_Error);
+    e_ExprError =
+        rb_define_class_under(m_VimClient, "ExprError", e_Error);
+
+    rb_define_singleton_method(m_VimClient, "send_keys", send_keys, 1);
+    rb_define_singleton_method(m_VimClient, "send_expr", send_expr, 1);
+    rb_define_singleton_method(m_VimClient, "send_keys2", send_keys2, -1);
+
+    VALUE klass = rb_funcall(m_VimClient, rb_intern("singleton_class"), 0);
+    rb_define_attr(klass, "server_name", Qtrue, Qtrue);
+    rb_define_attr(klass, "timeout_sec", Qtrue, Qtrue);
+    /* initialize instance variables (eliminates warnings) */
+    rb_iv_set(m_VimClient, "@server_name", Qnil);
+    rb_iv_set(m_VimClient, "@timeout_sec", Qnil);
+
+    /* Initialize X connection */
+    SendInit();
+}