diff options
Diffstat (limited to 'src/if_xcmdsrv.c')
| -rw-r--r-- | src/if_xcmdsrv.c | 1526 |
1 files changed, 1526 insertions, 0 deletions
diff --git a/src/if_xcmdsrv.c b/src/if_xcmdsrv.c new file mode 100644 index 0000000..73f2c9e --- /dev/null +++ b/src/if_xcmdsrv.c @@ -0,0 +1,1526 @@ +/* vi:set ts=8 sts=4 sw=4 noet: + * + * 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. + * + */ + +#include "vim.h" +#include "version.h" + +#if defined(FEAT_CLIENTSERVER) || defined(PROTO) + +# ifdef FEAT_X11 +# include <X11/Intrinsic.h> +# include <X11/Xatom.h> +# endif + +/* + * 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. + */ + + +/* + * When a result is being awaited from a sent command, one of + * the following structures is present on a list of all outstanding + * sent commands. The information in the structure is used to + * process the result when it arrives. You're probably wondering + * how there could ever be multiple outstanding sent commands. + * This could happen if Vim instances invoke each other recursively. + * It's unlikely, but possible. + */ + +typedef struct PendingCommand +{ + int serial; // Serial number expected in result. + int code; // Result Code. 0 is OK + char_u *result; // String result for command (malloc'ed). + // NULL means command still pending. + struct PendingCommand *nextPtr; + // Next in list of all outstanding commands. + // NULL means end of list. +} PendingCommand; + +static PendingCommand *pendingCommands = NULL; + // List of all commands currently + // being waited for. + +/* + * 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: + */ + +#define MAX_PROP_WORDS 100000 + +struct ServerReply +{ + Window id; + garray_T strings; +}; +static garray_T serverReply = { 0, 0, 0, 0, 0 }; +enum ServerReplyOp { SROP_Find, SROP_Add, SROP_Delete }; + +typedef int (*EndCond)(void *); + +struct x_cmdqueue +{ + char_u *propInfo; + long_u len; + struct x_cmdqueue *next; + struct x_cmdqueue *prev; +}; + +typedef struct x_cmdqueue x_queue_T; + +// dummy node, header for circular queue +static x_queue_T head = {NULL, 0, NULL, NULL}; + +/* + * Forward declarations for procedures defined later in this file: + */ + +static Window LookupName(Display *dpy, char_u *name, int delete, char_u **loose); +static int SendInit(Display *dpy); +static int DoRegisterName(Display *dpy, char_u *name); +static void DeleteAnyLingerer(Display *dpy, Window w); +static int GetRegProp(Display *dpy, char_u **regPropp, long_u *numItemsp, int domsg); +static int WaitForPend(void *p); +static int WindowValid(Display *dpy, Window w); +static void ServerWait(Display *dpy, Window w, EndCond endCond, void *endData, int localLoop, int seconds); +static int AppendPropCarefully(Display *display, Window window, Atom property, char_u *value, int length); +static int x_error_check(Display *dpy, XErrorEvent *error_event); +static int IsSerialName(char_u *name); +static void save_in_queue(char_u *buf, long_u len); +static void server_parse_message(Display *dpy, char_u *propInfo, long_u numItems); + +// Private variables for the "server" functionality +static Atom registryProperty = None; +static Atom vimProperty = None; +static int got_x_error = FALSE; + +static char_u *empty_prop = (char_u *)""; // empty GetRegProp() result + +/* + * Associate an ASCII name with Vim. Try real hard to get a unique one. + * Returns FAIL or OK. + */ + int +serverRegisterName( + Display *dpy, // display to register with + char_u *name) // the name that will be used as a base +{ + int i; + int res; + char_u *p = NULL; + + res = DoRegisterName(dpy, name); + if (res < 0) + { + i = 1; + do + { + if (res < -1 || i >= 1000) + { + msg_attr(_("Unable to register a command server name"), + HL_ATTR(HLF_W)); + return FAIL; + } + if (p == NULL) + p = alloc(STRLEN(name) + 10); + if (p == NULL) + { + res = -10; + continue; + } + sprintf((char *)p, "%s%d", name, i++); + res = DoRegisterName(dpy, p); + } + while (res < 0) + ; + vim_free(p); + } + return OK; +} + + static int +DoRegisterName(Display *dpy, char_u *name) +{ + Window w; + XErrorHandler old_handler; +#define MAX_NAME_LENGTH 100 + char_u propInfo[MAX_NAME_LENGTH + 20]; + + if (commProperty == None) + { + if (SendInit(dpy) < 0) + return -2; + } + + /* + * Make sure the name is unique, and append info about it to + * the registry property. It's important to lock the server + * here to prevent conflicting changes to the registry property. + * WARNING: Do not step through this while debugging, it will hangup the X + * server! + */ + XGrabServer(dpy); + w = LookupName(dpy, name, FALSE, NULL); + if (w != (Window)0) + { + Status status; + int dummyInt; + unsigned int dummyUns; + Window dummyWin; + + /* + * The name is currently registered. See if the commWindow + * associated with the name exists. If not, or if the commWindow + * is *our* commWindow, then just unregister the old name (this + * could happen if an application dies without cleaning up the + * registry). + */ + old_handler = XSetErrorHandler(x_error_check); + status = XGetGeometry(dpy, w, &dummyWin, &dummyInt, &dummyInt, + &dummyUns, &dummyUns, &dummyUns, &dummyUns); + (void)XSetErrorHandler(old_handler); + if (status != Success && w != commWindow) + { + XUngrabServer(dpy); + XFlush(dpy); + return -1; + } + (void)LookupName(dpy, name, /*delete=*/TRUE, NULL); + } + sprintf((char *)propInfo, "%x %.*s", (int_u)commWindow, + MAX_NAME_LENGTH, name); + old_handler = XSetErrorHandler(x_error_check); + got_x_error = FALSE; + XChangeProperty(dpy, RootWindow(dpy, 0), registryProperty, XA_STRING, 8, + PropModeAppend, propInfo, STRLEN(propInfo) + 1); + XUngrabServer(dpy); + XSync(dpy, False); + (void)XSetErrorHandler(old_handler); + + if (!got_x_error) + { +#ifdef FEAT_EVAL + set_vim_var_string(VV_SEND_SERVER, name, -1); +#endif + serverName = vim_strsave(name); +#ifdef FEAT_TITLE + need_maketitle = TRUE; +#endif + return 0; + } + return -2; +} + +#if defined(FEAT_GUI) || defined(PROTO) +/* + * Clean out new ID from registry and set it as comm win. + * Change any registered window ID. + */ + void +serverChangeRegisteredWindow( + Display *dpy, // Display to register with + Window newwin) // Re-register to this ID +{ + char_u propInfo[MAX_NAME_LENGTH + 20]; + + commWindow = newwin; + + // Always call SendInit() here, to make sure commWindow is marked as a Vim + // window. + if (SendInit(dpy) < 0) + return; + + // WARNING: Do not step through this while debugging, it will hangup the X + // server! + XGrabServer(dpy); + DeleteAnyLingerer(dpy, newwin); + if (serverName != NULL) + { + // Reinsert name if we was already registered + (void)LookupName(dpy, serverName, /*delete=*/TRUE, NULL); + sprintf((char *)propInfo, "%x %.*s", + (int_u)newwin, MAX_NAME_LENGTH, serverName); + XChangeProperty(dpy, RootWindow(dpy, 0), registryProperty, XA_STRING, 8, + PropModeAppend, (char_u *)propInfo, + STRLEN(propInfo) + 1); + } + XUngrabServer(dpy); +} +#endif + +/* + * Send to an instance of Vim via the X display. + * Returns 0 for OK, negative for an error. + */ + int +serverSendToVim( + Display *dpy, // Where to send. + char_u *name, // Where to send. + char_u *cmd, // What to send. + char_u **result, // Result of eval'ed expression + Window *server, // Actual ID of receiving app + Bool asExpr, // Interpret as keystrokes or expr ? + int timeout, // seconds to wait or zero + Bool localLoop, // Throw away everything but result + int silent) // don't complain about no server +{ + Window w; + char_u *property; + int length; + int res; + static int serial = 0; // Running count of sent commands. + // Used to give each command a + // different serial number. + PendingCommand pending; + char_u *loosename = NULL; + + if (result != NULL) + *result = NULL; + if (name == NULL || *name == NUL) + name = (char_u *)"GVIM"; // use a default name + + if (commProperty == None && dpy != NULL) + { + if (SendInit(dpy) < 0) + return -1; + } + + // Execute locally if no display or target is ourselves + if (dpy == NULL || (serverName != NULL && STRICMP(name, serverName) == 0)) + return sendToLocalVim(cmd, asExpr, result); + + /* + * 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(dpy, name, FALSE, &loosename); + // Check that the window is hot + if (w != None) + { + if (!WindowValid(dpy, w)) + { + LookupName(dpy, loosename ? loosename : name, + /*DELETE=*/TRUE, NULL); + vim_free(loosename); + continue; + } + } + break; + } + if (w == None) + { + if (!silent) + semsg(_(e_noserver), name); + return -1; + } + else if (loosename != NULL) + name = loosename; + if (server != NULL) + *server = w; + + /* + * Send the command to target interpreter by appending it to the + * comm window in the communication window. + * Length must be computed exactly! + */ + length = STRLEN(name) + STRLEN(p_enc) + STRLEN(cmd) + 14; + property = alloc(length + 30); + + sprintf((char *)property, "%c%c%c-n %s%c-E %s%c-s %s", + 0, asExpr ? 'c' : 'k', 0, name, 0, p_enc, 0, cmd); + if (name == loosename) + vim_free(loosename); + // 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(dpy, w, commProperty, property, length + 1); + vim_free(property); + if (res < 0) + { + emsg(_("E248: Failed to send command to the destination program")); + return -1; + } + + if (!asExpr) // There is no answer for this - Keys are sent async + return 0; + + /* + * Register the fact that we're waiting for a command to + * complete (this is needed by SendEventProc and by + * AppendErrorProc to pass back the command's results). + */ + pending.serial = serial; + pending.code = 0; + pending.result = NULL; + pending.nextPtr = pendingCommands; + pendingCommands = &pending; + + ServerWait(dpy, w, WaitForPend, &pending, localLoop, + timeout > 0 ? timeout : 600); + + /* + * Unregister the information about the pending command + * and return the result. + */ + if (pendingCommands == &pending) + pendingCommands = pending.nextPtr; + else + { + PendingCommand *pcPtr; + + for (pcPtr = pendingCommands; pcPtr != NULL; pcPtr = pcPtr->nextPtr) + if (pcPtr->nextPtr == &pending) + { + pcPtr->nextPtr = pending.nextPtr; + break; + } + } + if (result != NULL) + *result = pending.result; + else + vim_free(pending.result); + + return pending.code == 0 ? 0 : -1; +} + + static int +WaitForPend(void *p) +{ + PendingCommand *pending = (PendingCommand *) p; + return pending->result != NULL; +} + +/* + * Return TRUE if window "w" exists and has a "Vim" property on it. + */ + static int +WindowValid(Display *dpy, Window w) +{ + XErrorHandler old_handler; + Atom *plist; + int numProp; + int i; + + old_handler = XSetErrorHandler(x_error_check); + got_x_error = 0; + plist = XListProperties(dpy, w, &numProp); + XSync(dpy, 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; +} + +/* + * Enter a loop processing X events & polling chars until we see a result + */ + static void +ServerWait( + Display *dpy, + Window w, + EndCond endCond, + void *endData, + int localLoop, + int seconds) +{ + time_t start; + time_t now; + XEvent event; + +#define UI_MSEC_DELAY 53 +#define SEND_MSEC_POLL 500 +#ifndef HAVE_SELECT + struct pollfd fds; + + fds.fd = ConnectionNumber(dpy); + fds.events = POLLIN; +#else + fd_set fds; + struct timeval tv; + + tv.tv_sec = 0; + tv.tv_usec = SEND_MSEC_POLL * 1000; + FD_ZERO(&fds); + FD_SET(ConnectionNumber(dpy), &fds); +#endif + + time(&start); + while (TRUE) + { + while (XCheckWindowEvent(dpy, commWindow, PropertyChangeMask, &event)) + serverEventProc(dpy, &event, 1); + server_parse_messages(); + + if (endCond(endData) != 0) + break; + if (!WindowValid(dpy, w)) + break; + time(&now); + if (seconds >= 0 && (now - start) >= seconds) + break; + +#ifdef FEAT_TIMERS + check_due_timer(); +#endif + + // Just look out for the answer without calling back into Vim + if (localLoop) + { +#ifndef HAVE_SELECT + if (poll(&fds, 1, SEND_MSEC_POLL) < 0) + break; +#else + if (select(FD_SETSIZE, &fds, NULL, NULL, &tv) < 0) + break; +#endif + } + else + { + if (got_int) + break; + ui_delay((long)UI_MSEC_DELAY, TRUE); + ui_breakcheck(); + } + } +} + + +/* + * Fetch a list of all the Vim instance names currently registered for the + * display. + * + * Returns a newline separated list in allocated memory or NULL. + */ + char_u * +serverGetVimNames(Display *dpy) +{ + char_u *regProp; + char_u *entry; + char_u *p; + long_u numItems; + int_u w; + garray_T ga; + + if (registryProperty == None) + { + if (SendInit(dpy) < 0) + return NULL; + } + + /* + * Read the registry property. + */ + if (GetRegProp(dpy, ®Prop, &numItems, TRUE) == FAIL) + return NULL; + + /* + * Scan all of the names out of the property. + */ + ga_init2(&ga, 1, 100); + for (p = regProp; (long_u)(p - regProp) < numItems; p++) + { + entry = p; + while (*p != 0 && !isspace(*p)) + p++; + if (*p != 0) + { + w = None; + sscanf((char *)entry, "%x", &w); + if (WindowValid(dpy, (Window)w)) + { + ga_concat(&ga, p + 1); + ga_concat(&ga, (char_u *)"\n"); + } + while (*p != 0) + p++; + } + } + if (regProp != empty_prop) + XFree(regProp); + ga_append(&ga, NUL); + return ga.ga_data; +} + +///////////////////////////////////////////////////////////// +// Reply stuff + + static struct ServerReply * +ServerReplyFind(Window w, enum ServerReplyOp op) +{ + struct ServerReply *p; + struct ServerReply e; + int i; + + p = (struct ServerReply *) serverReply.ga_data; + for (i = 0; i < serverReply.ga_len; i++, p++) + if (p->id == w) + break; + if (i >= serverReply.ga_len) + p = NULL; + + if (p == NULL && op == SROP_Add) + { + if (serverReply.ga_growsize == 0) + ga_init2(&serverReply, sizeof(struct ServerReply), 1); + if (ga_grow(&serverReply, 1) == OK) + { + p = ((struct ServerReply *) serverReply.ga_data) + + serverReply.ga_len; + e.id = w; + ga_init2(&e.strings, 1, 100); + mch_memmove(p, &e, sizeof(e)); + serverReply.ga_len++; + } + } + else if (p != NULL && op == SROP_Delete) + { + ga_clear(&p->strings); + mch_memmove(p, p + 1, (serverReply.ga_len - i - 1) * sizeof(*p)); + serverReply.ga_len--; + } + + return p; +} + +/* + * Convert string to windowid. + * Issue an error if the id is invalid. + */ + Window +serverStrToWin(char_u *str) +{ + unsigned id = None; + + sscanf((char *)str, "0x%x", &id); + if (id == None) + semsg(_("E573: Invalid server id used: %s"), str); + + return (Window)id; +} + +/* + * Send a reply string (notification) to client with id "name". + * Return -1 if the window is invalid. + */ + int +serverSendReply(char_u *name, char_u *str) +{ + char_u *property; + int length; + int res; + Display *dpy = X_DISPLAY; + Window win = serverStrToWin(name); + + if (commProperty == None) + { + if (SendInit(dpy) < 0) + return -2; + } + if (!WindowValid(dpy, win)) + return -1; + + length = STRLEN(p_enc) + STRLEN(str) + 14; + if ((property = alloc(length + 30)) != NULL) + { + sprintf((char *)property, "%cn%c-E %s%c-n %s%c-w %x", + 0, 0, p_enc, 0, str, 0, (unsigned int)commWindow); + // Add length of what "%x" resulted in. + length += STRLEN(property + length); + res = AppendPropCarefully(dpy, win, commProperty, property, length + 1); + vim_free(property); + return res; + } + return -1; +} + + static int +WaitForReply(void *p) +{ + Window *w = (Window *) p; + + return ServerReplyFind(*w, SROP_Find) != NULL; +} + +/* + * Wait for replies from id (win) + * When "timeout" is non-zero wait up to this many seconds. + * Return 0 and the malloc'ed string when a reply is available. + * Return -1 if the window becomes invalid while waiting. + */ + int +serverReadReply( + Display *dpy, + Window win, + char_u **str, + int localLoop, + int timeout) +{ + int len; + char_u *s; + struct ServerReply *p; + + ServerWait(dpy, win, WaitForReply, &win, localLoop, + timeout > 0 ? timeout : -1); + + if ((p = ServerReplyFind(win, SROP_Find)) != NULL && p->strings.ga_len > 0) + { + *str = vim_strsave(p->strings.ga_data); + len = STRLEN(*str) + 1; + if (len < p->strings.ga_len) + { + s = (char_u *) p->strings.ga_data; + mch_memmove(s, s + len, p->strings.ga_len - len); + p->strings.ga_len -= len; + } + else + { + // Last string read. Remove from list + ga_clear(&p->strings); + ServerReplyFind(win, SROP_Delete); + } + return 0; + } + return -1; +} + +/* + * Check for replies from id (win). + * Return TRUE and a non-malloc'ed string if there is. Else return FALSE. + */ + int +serverPeekReply(Display *dpy, Window win, char_u **str) +{ + struct ServerReply *p; + + if ((p = ServerReplyFind(win, SROP_Find)) != NULL && p->strings.ga_len > 0) + { + if (str != NULL) + *str = p->strings.ga_data; + return 1; + } + if (!WindowValid(dpy, win)) + return -1; + return 0; +} + + +/* + * Initialize the communication channels for sending commands and receiving + * results. + */ + static int +SendInit(Display *dpy) +{ + XErrorHandler old_handler; + + /* + * Create the window used for communication, and set up an + * event handler for it. + */ + old_handler = XSetErrorHandler(x_error_check); + got_x_error = FALSE; + + if (commProperty == None) + commProperty = XInternAtom(dpy, "Comm", False); + if (vimProperty == None) + vimProperty = XInternAtom(dpy, "Vim", False); + if (registryProperty == None) + registryProperty = XInternAtom(dpy, "VimRegistry", False); + + if (commWindow == None) + { + commWindow = XCreateSimpleWindow(dpy, XDefaultRootWindow(dpy), + getpid(), 0, 10, 10, 0, + WhitePixel(dpy, DefaultScreen(dpy)), + WhitePixel(dpy, DefaultScreen(dpy))); + XSelectInput(dpy, commWindow, PropertyChangeMask); + // WARNING: Do not step through this while debugging, it will hangup + // the X server! + XGrabServer(dpy); + DeleteAnyLingerer(dpy, commWindow); + XUngrabServer(dpy); + } + + // Make window recognizable as a vim window + XChangeProperty(dpy, commWindow, vimProperty, XA_STRING, + 8, PropModeReplace, (char_u *)VIM_VERSION_SHORT, + (int)STRLEN(VIM_VERSION_SHORT) + 1); + + XSync(dpy, False); + (void)XSetErrorHandler(old_handler); + + return got_x_error ? -1 : 0; +} + +/* + * 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( + Display *dpy, // Display whose registry to check. + 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(dpy, ®Prop, &numItems, FALSE) == 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++; + 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++; + 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) + mch_memmove(entry, p, count); + XChangeProperty(dpy, RootWindow(dpy, 0), registryProperty, XA_STRING, + 8, PropModeReplace, regProp, + (int)(numItems - (p - entry))); + XSync(dpy, False); + } + + if (regProp != empty_prop) + XFree(regProp); + return (Window)returnValue; +} + +/* + * 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( + Display *dpy, // Display whose registry to check. + 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(dpy, ®Prop, &numItems, FALSE) == 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) + mch_memmove(entry, p, lastHalf); + numItems = (entry - regProp) + lastHalf; + p = entry; + continue; + } + } + while (*p != 0) + p++; + p++; + } + + if (entry != NULL) + { + XChangeProperty(dpy, RootWindow(dpy, 0), registryProperty, + XA_STRING, 8, PropModeReplace, regProp, + (int)(p - regProp)); + XSync(dpy, False); + } + + if (regProp != empty_prop) + XFree(regProp); +} + +/* + * 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( + Display *dpy, + char_u **regPropp, + long_u *numItemsp, + int domsg) // When TRUE give error message. +{ + int result, actualFormat; + long_u bytesAfter; + Atom actualType; + XErrorHandler old_handler; + + *regPropp = NULL; + old_handler = XSetErrorHandler(x_error_check); + got_x_error = FALSE; + + result = XGetWindowProperty(dpy, RootWindow(dpy, 0), registryProperty, 0L, + (long)MAX_PROP_WORDS, False, + XA_STRING, &actualType, + &actualFormat, numItemsp, &bytesAfter, + regPropp); + + XSync(dpy, FALSE); + (void)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(dpy, RootWindow(dpy, 0), registryProperty); + if (domsg) + emsg(_("E251: VIM instance registry property is badly formed. Deleted!")); + return FAIL; + } + return OK; +} + + +/* + * This procedure is invoked by the various X event loops throughout Vims when + * a property changes on the communication window. This procedure reads the + * property and enqueues command requests and responses. If immediate is true, + * it runs the event immediately instead of enqueuing it. Immediate can cause + * unintended behavior and should only be used for code that blocks for a + * response. + */ + void +serverEventProc( + Display *dpy, + XEvent *eventPtr, // Information about event. + int immediate) // Run event immediately. Should mostly be 0. +{ + char_u *propInfo; + int result, actualFormat; + long_u numItems, bytesAfter; + Atom actualType; + + if (eventPtr != NULL) + { + if (eventPtr->xproperty.atom != commProperty + || eventPtr->xproperty.state != PropertyNewValue) + return; + } + + /* + * Read the comm property and delete it. + */ + propInfo = NULL; + result = XGetWindowProperty(dpy, 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; + } + if (immediate) + server_parse_message(dpy, propInfo, numItems); + else + save_in_queue(propInfo, numItems); +} + +/* + * Saves x clientserver commands in a queue so that they can be called when + * vim is idle. + */ + static void +save_in_queue(char_u *propInfo, long_u len) +{ + x_queue_T *node; + + node = ALLOC_ONE(x_queue_T); + if (node == NULL) + return; // out of memory + node->propInfo = propInfo; + node->len = len; + + if (head.next == NULL) // initialize circular queue + { + head.next = &head; + head.prev = &head; + } + + // insert node at tail of queue + node->next = &head; + node->prev = head.prev; + head.prev->next = node; + head.prev = node; +} + +/* + * Parses queued clientserver messages. + */ + void +server_parse_messages(void) +{ + x_queue_T *node; + + if (!X_DISPLAY) + return; // cannot happen? + while (head.next != NULL && head.next != &head) + { + node = head.next; + head.next = node->next; + node->next->prev = node->prev; + server_parse_message(X_DISPLAY, node->propInfo, node->len); + vim_free(node); + } +} + +/* + * Returns a non-zero value if there are clientserver messages waiting + * int the queue. + */ + int +server_waiting(void) +{ + return head.next != NULL && head.next != &head; +} + +/* + * Prases a single clientserver message. A single message may contain multiple + * commands. + * "propInfo" will be freed. + */ + static void +server_parse_message( + Display *dpy, + char_u *propInfo, // A string containing 0 or more X commands + long_u numItems) // The size of propInfo in bytes. +{ + char_u *p; + int code; + char_u *tofree; + + /* + * Several commands and results could arrive in the property at + * one time; each iteration through the outer loop handles a + * single command or result. + */ + for (p = propInfo; (long_u)(p - propInfo) < numItems; ) + { + /* + * Ignore leading NULs; each command or result starts with a + * NUL so that no matter how badly formed a preceding command + * is, we'll be able to tell that a new command/result is + * starting. + */ + if (*p == 0) + { + p++; + continue; + } + + if ((*p == 'c' || *p == 'k') && (p[1] == 0)) + { + Window resWindow; + char_u *name, *script, *serial, *end; + Bool asKeys = *p == 'k'; + char_u *enc; + + /* + * This is an incoming command from some other application. + * 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; + name = NULL; + resWindow = None; + serial = (char_u *)""; + script = NULL; + enc = NULL; + while ((long_u)(p - propInfo) < numItems && *p == '-') + { + switch (p[1]) + { + case 'r': + end = skipwhite(p + 2); + resWindow = 0; + while (vim_isxdigit(*end)) + { + resWindow = 16 * resWindow + (long_u)hex2nr(*end); + ++end; + } + if (end == p + 2 || *end != ' ') + resWindow = None; + else + { + p = serial = end + 1; + clientWindow = resWindow; // Remember in global + } + break; + case 'n': + if (p[2] == ' ') + name = p + 3; + break; + case 's': + if (p[2] == ' ') + script = p + 3; + break; + case 'E': + if (p[2] == ' ') + enc = p + 3; + break; + } + while (*p != 0) + p++; + p++; + } + + if (script == NULL || name == NULL) + continue; + + if (serverName != NULL && STRICMP(name, serverName) == 0) + { + script = serverConvert(enc, script, &tofree); + if (asKeys) + server_to_input_buf(script); + else + { + char_u *res; + + res = eval_client_expr_to_string(script); + if (resWindow != None) + { + garray_T reply; + + // Initialize the result property. + ga_init2(&reply, 1, 100); + (void)ga_grow(&reply, 50 + STRLEN(p_enc)); + sprintf(reply.ga_data, "%cr%c-E %s%c-s %s%c-r ", + 0, 0, p_enc, 0, serial, 0); + reply.ga_len = 14 + STRLEN(p_enc) + STRLEN(serial); + + // Evaluate the expression and return the result. + if (res != NULL) + ga_concat(&reply, res); + else + { + ga_concat(&reply, (char_u *)_(e_invexprmsg)); + ga_append(&reply, 0); + ga_concat(&reply, (char_u *)"-c 1"); + } + ga_append(&reply, NUL); + (void)AppendPropCarefully(dpy, resWindow, commProperty, + reply.ga_data, reply.ga_len); + ga_clear(&reply); + } + vim_free(res); + } + vim_free(tofree); + } + } + else if (*p == 'r' && p[1] == 0) + { + int serial, gotSerial; + char_u *res; + PendingCommand *pcPtr; + char_u *enc; + + /* + * This is a reply to some command that we sent out. 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; + res = (char_u *)""; + code = 0; + enc = NULL; + while ((long_u)(p - propInfo) < numItems && *p == '-') + { + switch (p[1]) + { + case 'r': + if (p[2] == ' ') + res = p + 3; + break; + case 'E': + if (p[2] == ' ') + enc = p + 3; + break; + case 's': + if (sscanf((char *)p + 2, " %d", &serial) == 1) + gotSerial = 1; + break; + case 'c': + if (sscanf((char *)p + 2, " %d", &code) != 1) + code = 0; + break; + } + while (*p != 0) + p++; + p++; + } + + if (!gotSerial) + continue; + + /* + * Give the result information to anyone who's + * waiting for it. + */ + for (pcPtr = pendingCommands; pcPtr != NULL; pcPtr = pcPtr->nextPtr) + { + if (serial != pcPtr->serial || pcPtr->result != NULL) + continue; + + pcPtr->code = code; + res = serverConvert(enc, res, &tofree); + if (tofree == NULL) + res = vim_strsave(res); + pcPtr->result = res; + break; + } + } + else if (*p == 'n' && p[1] == 0) + { + Window win = 0; + unsigned int u; + int gotWindow; + char_u *str; + struct ServerReply *r; + char_u *enc; + + /* + * This is a (n)otification. Sent with serverreply_send in Vim + * script. Execute any autocommand and save it for later retrieval + */ + p += 2; + gotWindow = 0; + str = (char_u *)""; + enc = NULL; + while ((long_u)(p - propInfo) < numItems && *p == '-') + { + switch (p[1]) + { + case 'n': + if (p[2] == ' ') + str = p + 3; + break; + case 'E': + if (p[2] == ' ') + enc = p + 3; + break; + case 'w': + if (sscanf((char *)p + 2, " %x", &u) == 1) + { + win = u; + gotWindow = 1; + } + break; + } + while (*p != 0) + p++; + p++; + } + + if (!gotWindow) + continue; + str = serverConvert(enc, str, &tofree); + if ((r = ServerReplyFind(win, SROP_Add)) != NULL) + { + ga_concat(&(r->strings), str); + ga_append(&(r->strings), NUL); + } + { + char_u winstr[30]; + + sprintf((char *)winstr, "0x%x", (unsigned int)win); + apply_autocmds(EVENT_REMOTEREPLY, winstr, str, TRUE, curbuf); + } + vim_free(tofree); + } + else + { + /* + * Didn't recognize this thing. Just skip through the next + * null character and try again. + * Even if we get an 'r'(eply) we will throw it away as we + * never specify (and thus expect) one + */ + while (*p != 0) + p++; + p++; + } + } + XFree(propInfo); +} + +/* + * 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( + Display *dpy, // Display on which to operate. + 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_check); + got_x_error = FALSE; + XChangeProperty(dpy, window, property, XA_STRING, 8, + PropModeAppend, value, length); + XSync(dpy, False); + (void) XSetErrorHandler(old_handler); + return got_x_error ? -1 : 0; +} + + +/* + * Another X Error handler, just used to check for errors. + */ + static int +x_error_check(Display *dpy UNUSED, XErrorEvent *error_event UNUSED) +{ + got_x_error = TRUE; + return 0; +} + +/* + * Check if "str" looks like it had a serial number appended. + * Actually just checks if the name ends in a digit. + */ + static int +IsSerialName(char_u *str) +{ + int len = STRLEN(str); + + return (len > 1 && vim_isdigit(str[len - 1])); +} +#endif // FEAT_CLIENTSERVER |