X-Git-Url: http://git.hcoop.net/bpt/emacs.git/blobdiff_plain/88b46d84315d9a03b22467eccdcc620db05993bf..ba528748a14a34d2c3f619615c4cdaf4bbd89cc0:/lib-src/emacsclient.c diff --git a/lib-src/emacsclient.c b/lib-src/emacsclient.c index 3c3b27374f..3197b2a727 100644 --- a/lib-src/emacsclient.c +++ b/lib-src/emacsclient.c @@ -1,13 +1,13 @@ /* Client process that communicates with GNU Emacs acting as server. Copyright (C) 1986, 1987, 1994, 1999, 2000, 2001, 2002, 2003, 2004, - 2005, 2006 Free Software Foundation, Inc. + 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. This file is part of GNU Emacs. -GNU Emacs is free software; you can redistribute it and/or modify +GNU Emacs is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by -the Free Software Foundation; either version 2, or (at your option) -any later version. +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. GNU Emacs is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of @@ -15,24 +15,24 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License -along with GNU Emacs; see the file COPYING. If not, write to -the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, -Boston, MA 02110-1301, USA. */ +along with GNU Emacs. If not, see . */ -#define NO_SHORTNAMES - #ifdef HAVE_CONFIG_H #include #endif #ifdef WINDOWSNT +/* config.h defines these, which disables sockets altogether! */ +# undef _WINSOCKAPI_ +# undef _WINSOCK_H + # include # include +# include +# include -# define HAVE_SOCKETS -# define HAVE_INET_SOCKETS # define NO_SOCKETS_IN_FILE_SYSTEM # define HSOCKET SOCKET @@ -41,19 +41,28 @@ Boston, MA 02110-1301, USA. */ #else /* !WINDOWSNT */ +# include "syswait.h" + # ifdef HAVE_INET_SOCKETS # include # endif +# include + # define INVALID_SOCKET -1 # define HSOCKET int # define CLOSE_SOCKET close # define INITIALIZE() +# ifndef WCONTINUED +# define WCONTINUED 8 +# endif + #endif /* !WINDOWSNT */ #undef signal +#include #include #include #include "getopt.h" @@ -61,25 +70,31 @@ Boston, MA 02110-1301, USA. */ #include #endif -#ifdef VMS -# include "vms-pwd.h" -#else /* not VMS */ #ifdef WINDOWSNT # include #else /* not WINDOWSNT */ # include #endif /* not WINDOWSNT */ -#endif /* not VMS */ +#include +#include +#include + + char *getenv (), *getwd (); char *(getcwd) (); +#ifdef WINDOWSNT +char *w32_getenv (); +#define egetenv(VAR) w32_getenv(VAR) +#else +#define egetenv(VAR) getenv(VAR) +#endif + #ifndef VERSION #define VERSION "unspecified" #endif -#define SEND_STRING(data) (send_to_emacs (s, (data))) -#define SEND_QUOTED(data) (quote_file_name (s, (data))) #ifndef EXIT_SUCCESS #define EXIT_SUCCESS 0 @@ -100,19 +115,32 @@ char *(getcwd) (); #ifndef NO_RETURN #define NO_RETURN #endif + +/* Additional space when allocating buffers for filenames, etc. */ +#define EXTRA_SPACE 100 + /* Name used to invoke this program. */ char *progname; +/* The second argument to main. */ +char **main_argv; + /* Nonzero means don't wait for a response from Emacs. --no-wait. */ int nowait = 0; /* Nonzero means args are expressions to be evaluated. --eval. */ int eval = 0; +/* Nonzero means don't open a new frame. Inverse of --create-frame. */ +int current_frame = 1; + /* The display on which Emacs should work. --display. */ char *display = NULL; +/* Nonzero means open a new Emacs frame on the current terminal. */ +int tty = 0; + /* If non-NULL, the name of an editor to fallback to if the server is not running. --alternate-editor. */ const char *alternate_editor = NULL; @@ -123,6 +151,9 @@ char *socket_name = NULL; /* If non-NULL, the filename of the authentication file. */ char *server_file = NULL; +/* PID of the Emacs server process. */ +int emacs_pid = 0; + void print_help_and_exit () NO_RETURN; struct option longopts[] = @@ -131,15 +162,326 @@ struct option longopts[] = { "eval", no_argument, NULL, 'e' }, { "help", no_argument, NULL, 'H' }, { "version", no_argument, NULL, 'V' }, + { "tty", no_argument, NULL, 't' }, + { "nw", no_argument, NULL, 't' }, + { "create-frame", no_argument, NULL, 'c' }, { "alternate-editor", required_argument, NULL, 'a' }, #ifndef NO_SOCKETS_IN_FILE_SYSTEM { "socket-name", required_argument, NULL, 's' }, #endif { "server-file", required_argument, NULL, 'f' }, +#ifndef WINDOWSNT { "display", required_argument, NULL, 'd' }, +#endif { 0, 0, 0, 0 } }; + +/* Like malloc but get fatal error if memory is exhausted. */ + +long * +xmalloc (size) + unsigned int size; +{ + long *result = (long *) malloc (size); + if (result == NULL) + { + perror ("malloc"); + exit (EXIT_FAILURE); + } + return result; +} + +/* Like strdup but get a fatal error if memory is exhausted. */ + +char * +xstrdup (const char *s) +{ + char *result = strdup (s); + if (result == NULL) + { + perror ("strdup"); + exit (EXIT_FAILURE); + } + return result; +} + +/* From sysdep.c */ +#if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME) + +/* From lisp.h */ +#ifndef DIRECTORY_SEP +#define DIRECTORY_SEP '/' +#endif +#ifndef IS_DIRECTORY_SEP +#define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP) +#endif +#ifndef IS_DEVICE_SEP +#ifndef DEVICE_SEP +#define IS_DEVICE_SEP(_c_) 0 +#else +#define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP) +#endif +#endif +#ifndef IS_ANY_SEP +#define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_)) +#endif + + +/* Return the current working directory. Returns NULL on errors. + Any other returned value must be freed with free. This is used + only when get_current_dir_name is not defined on the system. */ +char* +get_current_dir_name () +{ + char *buf; + char *pwd; + struct stat dotstat, pwdstat; + /* If PWD is accurate, use it instead of calling getwd. PWD is + sometimes a nicer name, and using it may avoid a fatal error if a + parent directory is searchable but not readable. */ + if ((pwd = egetenv ("PWD")) != 0 + && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1]))) + && stat (pwd, &pwdstat) == 0 + && stat (".", &dotstat) == 0 + && dotstat.st_ino == pwdstat.st_ino + && dotstat.st_dev == pwdstat.st_dev +#ifdef MAXPATHLEN + && strlen (pwd) < MAXPATHLEN +#endif + ) + { + buf = (char *) xmalloc (strlen (pwd) + 1); + if (!buf) + return NULL; + strcpy (buf, pwd); + } +#ifdef HAVE_GETCWD + else + { + size_t buf_size = 1024; + buf = (char *) xmalloc (buf_size); + if (!buf) + return NULL; + for (;;) + { + if (getcwd (buf, buf_size) == buf) + break; + if (errno != ERANGE) + { + int tmp_errno = errno; + free (buf); + errno = tmp_errno; + return NULL; + } + buf_size *= 2; + buf = (char *) realloc (buf, buf_size); + if (!buf) + return NULL; + } + } +#else + else + { + /* We need MAXPATHLEN here. */ + buf = (char *) xmalloc (MAXPATHLEN + 1); + if (!buf) + return NULL; + if (getwd (buf) == NULL) + { + int tmp_errno = errno; + free (buf); + errno = tmp_errno; + return NULL; + } + } +#endif + return buf; +} +#endif + +#ifdef WINDOWSNT + +#define REG_ROOT "SOFTWARE\\GNU\\Emacs" + +/* Retrieve an environment variable from the Emacs subkeys of the registry. + Return NULL if the variable was not found, or it was empty. + This code is based on w32_get_resource (w32.c). */ +char * +w32_get_resource (predefined, key, type) + HKEY predefined; + char *key; + LPDWORD type; +{ + HKEY hrootkey = NULL; + char *result = NULL; + DWORD cbData; + + if (RegOpenKeyEx (predefined, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS) + { + if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS) + { + result = (char *) xmalloc (cbData); + + if ((RegQueryValueEx (hrootkey, key, NULL, type, result, &cbData) != ERROR_SUCCESS) + || (*result == 0)) + { + free (result); + result = NULL; + } + } + + RegCloseKey (hrootkey); + } + + return result; +} + +/* + getenv wrapper for Windows + + This is needed to duplicate Emacs's behavior, which is to look for enviroment + variables in the registry if they don't appear in the environment. +*/ +char * +w32_getenv (envvar) + char *envvar; +{ + char *value; + DWORD dwType; + + if (value = getenv (envvar)) + /* Found in the environment. */ + return value; + + if (! (value = w32_get_resource (HKEY_CURRENT_USER, envvar, &dwType)) && + ! (value = w32_get_resource (HKEY_LOCAL_MACHINE, envvar, &dwType))) + { + /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */ + if (strcmp (envvar, "TERM") == 0) + return xstrdup ("w32console"); + /* Found neither in the environment nor in the registry. */ + return NULL; + } + + if (dwType == REG_SZ) + /* Registry; no need to expand. */ + return value; + + if (dwType == REG_EXPAND_SZ) + { + DWORD size; + + if (size = ExpandEnvironmentStrings (value, NULL, 0)) + { + char *buffer = (char *) xmalloc (size); + if (ExpandEnvironmentStrings (value, buffer, size)) + { + /* Found and expanded. */ + free (value); + return buffer; + } + + /* Error expanding. */ + free (buffer); + } + } + + /* Not the right type, or not correctly expanded. */ + free (value); + return NULL; +} + +int +w32_window_app () +{ + static int window_app = -1; + char szTitle[MAX_PATH]; + + if (window_app < 0) + { + /* Checking for STDOUT does not work; it's a valid handle also in + nonconsole apps. Testing for the console title seems to work. */ + window_app = (GetConsoleTitleA (szTitle, MAX_PATH) == 0); + if (window_app) + InitCommonControls(); + } + + return window_app; +} + +/* + execvp wrapper for Windows. Quotes arguments with embedded spaces. + + This is necessary due to the broken implementation of exec* routines in + the Microsoft libraries: they concatenate the arguments together without + quoting special characters, and pass the result to CreateProcess, with + predictably bad results. By contrast, Posix execvp passes the arguments + directly into the argv array of the child process. +*/ +int +w32_execvp (path, argv) + char *path; + char **argv; +{ + int i; + + /* Required to allow a .BAT script as alternate editor. */ + argv[0] = (char *) alternate_editor; + + for (i = 0; argv[i]; i++) + if (strchr (argv[i], ' ')) + { + char *quoted = alloca (strlen (argv[i]) + 3); + sprintf (quoted, "\"%s\"", argv[i]); + argv[i] = quoted; + } + + return execvp (path, argv); +} + +#undef execvp +#define execvp w32_execvp + +/* Emulation of ttyname for Windows. */ +char * +ttyname (int fd) +{ + return "CONOUT$"; +} + +#endif /* WINDOWSNT */ + +/* Display a normal or error message. + On Windows, use a message box if compiled as a Windows app. */ +void +message (int is_error, char *message, ...) +{ + char msg [2048]; + va_list args; + + va_start (args, message); + vsprintf (msg, message, args); + va_end (args); + +#ifdef WINDOWSNT + if (w32_window_app ()) + { + if (is_error) + MessageBox (NULL, msg, "Emacsclient ERROR", MB_ICONERROR); + else + MessageBox (NULL, msg, "Emacsclient", MB_ICONINFORMATION); + } + else +#endif + { + FILE *f = is_error ? stderr : stdout; + + fputs (msg, f); + fflush (f); + } +} + /* Decode the options from argv and argc. The global variable `optind' will say how many arguments we used up. */ @@ -148,17 +490,17 @@ decode_options (argc, argv) int argc; char **argv; { - alternate_editor = getenv ("ALTERNATE_EDITOR"); + alternate_editor = egetenv ("ALTERNATE_EDITOR"); while (1) { - int opt = getopt_long (argc, argv, + int opt = getopt_long_only (argc, argv, #ifndef NO_SOCKETS_IN_FILE_SYSTEM - "VHnea:s:f:d:", + "VHnea:s:f:d:tc", #else - "VHnea:f:d:", + "VHnea:f:d:tc", #endif - longopts, 0); + longopts, 0); if (opt == EOF) break; @@ -184,6 +526,10 @@ decode_options (argc, argv) server_file = optarg; break; + /* We used to disallow this argument in w32, but it seems better + to allow it, for the occasional case where the user is + connecting with a w32 client to a server compiled with X11 + support. */ case 'd': display = optarg; break; @@ -197,68 +543,124 @@ decode_options (argc, argv) break; case 'V': - printf ("emacsclient %s\n", VERSION); + message (FALSE, "emacsclient %s\n", VERSION); exit (EXIT_SUCCESS); break; + case 't': + tty = 1; + current_frame = 0; + break; + + case 'c': + current_frame = 0; + break; + case 'H': print_help_and_exit (); break; default: - fprintf (stderr, "Try `%s --help' for more information\n", progname); + message (TRUE, "Try `%s --help' for more information\n", progname); exit (EXIT_FAILURE); break; } } + + /* If the -c option is used (without -t) and no --display argument + is provided, try $DISPLAY. + Without the -c option, we used to set `display' to $DISPLAY by + default, but this changed the default behavior and is sometimes + inconvenient. So we force users to use "--display $DISPLAY" if + they want Emacs to connect to their current display. */ + if (!current_frame && !tty && !display) + { + display = egetenv ("DISPLAY"); +#ifdef NS_IMPL_COCOA + /* Under Cocoa, we don't really use displays the same way as in X, + so provide a dummy. */ + if (!display || strlen (display) == 0) + display = "ns"; +#endif + } + + /* A null-string display is invalid. */ + if (display && strlen (display) == 0) + display = NULL; + + /* If no display is available, new frames are tty frames. */ + if (!current_frame && !display) + tty = 1; + + /* --no-wait implies --current-frame on ttys when there are file + arguments or expressions given. */ + if (nowait && tty && argc - optind > 0) + current_frame = 1; + +#ifdef WINDOWSNT + if (alternate_editor && alternate_editor[0] == '\0') + { + message (TRUE, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\ +an empty string"); + exit (EXIT_FAILURE); + } +#endif /* WINDOWSNT */ } + void print_help_and_exit () { - printf ( - "Usage: %s [OPTIONS] FILE...\n\ + /* Spaces and tabs are significant in this message; they're chosen so the + message aligns properly both in a tty and in a Windows message box. + Please try to preserve them; otherwise the output is very hard to read + when using emacsclientw. */ + message (FALSE, + "Usage: %s [OPTIONS] FILE...\n\ Tell the Emacs server to visit the specified files.\n\ Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\ \n\ The following OPTIONS are accepted:\n\ --V, --version Just print a version info and return\n\ --H, --help Print this usage information message\n\ --n, --no-wait Don't wait for the server to return\n\ --e, --eval Evaluate the FILE arguments as ELisp expressions\n\ --d, --display=DISPLAY Visit the file in the given display\n" +-V, --version Just print version info and return\n\ +-H, --help Print this usage information message\n\ +-nw, -t, --tty Open a new Emacs frame on the current terminal\n\ +-c, --create-frame Create a new frame instead of trying to\n\ + use the current Emacs frame\n\ +-e, --eval Evaluate the FILE arguments as ELisp expressions\n\ +-n, --no-wait Don't wait for the server to return\n\ +-d, --display=DISPLAY Visit the file in the given display\n" #ifndef NO_SOCKETS_IN_FILE_SYSTEM "-s, --socket-name=FILENAME\n\ - Set the filename of the UNIX socket for communication\n" + Set filename of the UNIX socket for communication\n" #endif "-f, --server-file=FILENAME\n\ - Set the filename of the TCP configuration file\n\ + Set filename of the TCP authentication file\n\ -a, --alternate-editor=EDITOR\n\ - Editor to fallback to if the server is not running\n\ -\n\ + Editor to fallback to if the server is not running\n" +#ifdef WINDOWSNT +" If EDITOR is the empty string, start Emacs in daemon\n\ + mode and try connecting again\n" +#endif /* WINDOWSNT */ +"\n\ Report bugs to bug-gnu-emacs@gnu.org.\n", progname); exit (EXIT_SUCCESS); } - /* Try to run a different command, or --if no alternate editor is defined-- exit with an errorcode. + Uses argv, but gets it from the global variable main_argv. */ void -fail (argc, argv) - int argc; - char **argv; +fail (void) { if (alternate_editor) { int i = optind - 1; -#ifdef WINDOWSNT - argv[i] = (char *)alternate_editor; -#endif - execvp (alternate_editor, argv + i); - fprintf (stderr, "%s: error executing alternate editor \"%s\"\n", - progname, alternate_editor); + + execvp (alternate_editor, main_argv + i); + message (TRUE, "%s: error executing alternate editor \"%s\"\n", + progname, alternate_editor); } exit (EXIT_FAILURE); } @@ -271,11 +673,12 @@ main (argc, argv) int argc; char **argv; { - fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n", + main_argv = argv; + progname = argv[0]; + message (TRUE, "%s: Sorry, the Emacs server is supported only\n" + "on systems with Berkeley sockets.\n", argv[0]); - fprintf (stderr, "on systems with Berkeley sockets.\n"); - - fail (argc, argv); + fail (); } #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */ @@ -286,8 +689,6 @@ main (argc, argv) # include # include # include -# include -# include #endif #define AUTH_KEY_LENGTH 64 @@ -299,6 +700,31 @@ extern int errno; /* Buffer to accumulate data to send in TCP connections. */ char send_buffer[SEND_BUFFER_SIZE + 1]; int sblen = 0; /* Fill pointer for the send buffer. */ +/* Socket used to communicate with the Emacs server process. */ +HSOCKET emacs_socket = 0; + +/* On Windows, the socket library was historically separate from the standard + C library, so errors are handled differently. */ +void +sock_err_message (function_name) + char *function_name; +{ +#ifdef WINDOWSNT + char* msg = NULL; + + FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM + | FORMAT_MESSAGE_ALLOCATE_BUFFER + | FORMAT_MESSAGE_ARGUMENT_ARRAY, + NULL, WSAGetLastError (), 0, (LPTSTR)&msg, 0, NULL); + + message (TRUE, "%s: %s: %s\n", progname, function_name, msg); + + LocalFree (msg); +#else + message (TRUE, "%s: %s: %s\n", progname, function_name, strerror (errno)); +#endif +} + /* Let's send the data to Emacs when either - the data ends in "\n", or @@ -339,18 +765,21 @@ send_to_emacs (s, data) } } -/* In NAME, insert a & before each &, each space, each newline, and + +/* In STR, insert a & before each &, each space, each newline, and any initial -. Change spaces to underscores, too, so that the - return value never contains a space. */ + return value never contains a space. + + Does not change the string. Outputs the result to STREAM. */ void -quote_file_name (s, name) +quote_argument (s, str) HSOCKET s; - char *name; + char *str; { - char *copy = (char *) malloc (strlen (name) * 2 + 1); + char *copy = (char *) xmalloc (strlen (str) * 2 + 1); char *p, *q; - p = name; + p = str; q = copy; while (*p) { @@ -368,18 +797,54 @@ quote_file_name (s, name) } else { - if (*p == '&' || (*p == '-' && p == name)) + if (*p == '&' || (*p == '-' && p == str)) *q++ = '&'; *q++ = *p++; } } *q++ = 0; - SEND_STRING (copy); + send_to_emacs (s, copy); free (copy); } + +/* The inverse of quote_argument. Removes quoting in string STR by + modifying the string in place. Returns STR. */ + +char * +unquote_argument (str) + char *str; +{ + char *p, *q; + + if (! str) + return str; + + p = str; + q = str; + while (*p) + { + if (*p == '&') + { + p++; + if (*p == '&') + *p = '&'; + else if (*p == '_') + *p = ' '; + else if (*p == 'n') + *p = '\n'; + else if (*p == '-') + *p = '-'; + } + *q++ = *p++; + } + *q = 0; + return str; +} + + int file_name_absolute_p (filename) const unsigned char *filename; @@ -394,9 +859,9 @@ file_name_absolute_p (filename) if (filename[0] == '\0') return FALSE; #ifdef WINDOWSNT - /* X:\xxx is always absolute; X:xxx is an error and will fail. */ - if (islower (tolower (filename[0])) - && filename[1] == ':' && filename[2] == '\\') + /* X:\xxx is always absolute. */ + if (isalpha (filename[0]) + && filename[1] == ':' && (filename[2] == '\\' || filename[2] == '/')) return TRUE; /* Both \xxx and \\xxx\yyy are absolute. */ @@ -407,7 +872,7 @@ file_name_absolute_p (filename) } #ifdef WINDOWSNT -/* Wrapper to make WSACleanup a cdecl, as required by atexit(). */ +/* Wrapper to make WSACleanup a cdecl, as required by atexit. */ void __cdecl close_winsock () { @@ -422,18 +887,19 @@ initialize_sockets () if (WSAStartup (MAKEWORD (2, 0), &wsaData)) { - fprintf (stderr, "%s: error initializing WinSock2", progname); + message (TRUE, "%s: error initializing WinSock2\n", progname); exit (EXIT_FAILURE); } atexit (close_winsock); } #endif /* WINDOWSNT */ + /* * Read the information needed to set up a TCP comm channel with * the Emacs server: host, port, pid and authentication string. -*/ + */ int get_server_config (server, authentication) struct sockaddr_in *server; @@ -448,18 +914,20 @@ get_server_config (server, authentication) config = fopen (server_file, "rb"); else { - char *home = getenv ("HOME"); + char *home = egetenv ("HOME"); if (home) { - char *path = alloca (32 + strlen (home) + strlen (server_file)); + char *path = alloca (strlen (home) + strlen (server_file) + + EXTRA_SPACE); sprintf (path, "%s/.emacs.d/server/%s", home, server_file); config = fopen (path, "rb"); } #ifdef WINDOWSNT - if (!config && (home = getenv ("APPDATA"))) + if (!config && (home = egetenv ("APPDATA"))) { - char *path = alloca (32 + strlen (home) + strlen (server_file)); + char *path = alloca (strlen (home) + strlen (server_file) + + EXTRA_SPACE); sprintf (path, "%s/.emacs.d/server/%s", home, server_file); config = fopen (path, "rb"); } @@ -478,7 +946,7 @@ get_server_config (server, authentication) } else { - fprintf (stderr, "%s: invalid configuration info", progname); + message (TRUE, "%s: invalid configuration info\n", progname); exit (EXIT_FAILURE); } @@ -488,35 +956,13 @@ get_server_config (server, authentication) if (! fread (authentication, AUTH_KEY_LENGTH, 1, config)) { - fprintf (stderr, "%s: cannot read authentication info", progname); + message (TRUE, "%s: cannot read authentication info\n", progname); exit (EXIT_FAILURE); } fclose (config); -#ifdef WINDOWSNT - /* - Modern Windows restrict which processes can set the foreground window. - So, for emacsclient to be able to force Emacs into the foreground, we - have to call AllowSetForegroundWindow(). Unfortunately, older Windows - (W95, W98 and NT) don't have this function, so we have to check first. - - We're doing this here because it has to be done before sending info - to Emacs, and otherwise we'll need a global variable just to pass around - the pid, which is also inelegant. - */ - { - HMODULE hUser32; - - if (hUser32 = LoadLibrary ("user32.dll")) - { - void (*set_fg)(DWORD); - if (set_fg = GetProcAddress (hUser32, "AllowSetForegroundWindow")) - set_fg (atoi (pid)); - FreeLibrary (hUser32); - } - } -#endif + emacs_pid = atoi (pid); return TRUE; } @@ -533,7 +979,7 @@ set_tcp_socket () return INVALID_SOCKET; if (server.sin_addr.s_addr != inet_addr ("127.0.0.1")) - fprintf (stderr, "%s: connected to remote socket at %s\n", + message (FALSE, "%s: connected to remote socket at %s\n", progname, inet_ntoa (server.sin_addr)); /* @@ -541,8 +987,7 @@ set_tcp_socket () */ if ((s = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0) { - fprintf (stderr, "%s: ", progname); - perror ("socket"); + sock_err_message ("socket"); return INVALID_SOCKET; } @@ -551,8 +996,7 @@ set_tcp_socket () */ if (connect (s, (struct sockaddr *) &server, sizeof server) < 0) { - fprintf (stderr, "%s: ", progname); - perror ("connect"); + sock_err_message ("connect"); return INVALID_SOCKET; } @@ -563,13 +1007,73 @@ set_tcp_socket () */ auth_string[AUTH_KEY_LENGTH] = '\0'; - SEND_STRING ("-auth "); - SEND_STRING (auth_string); - SEND_STRING ("\n"); + send_to_emacs (s, "-auth "); + send_to_emacs (s, auth_string); + send_to_emacs (s, " "); return s; } + +/* Returns 1 if PREFIX is a prefix of STRING. */ +static int +strprefix (char *prefix, char *string) +{ + return !strncmp (prefix, string, strlen (prefix)); +} + +/* Get tty name and type. If successful, return the type in TTY_TYPE + and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT + is zero, or return 0 if NOABORT is non-zero. */ + +int +find_tty (char **tty_type, char **tty_name, int noabort) +{ + char *type = egetenv ("TERM"); + char *name = ttyname (fileno (stdout)); + + if (!name) + { + if (noabort) + return 0; + else + { + message (TRUE, "%s: could not get terminal name\n", progname); + fail (); + } + } + + if (!type) + { + if (noabort) + return 0; + else + { + message (TRUE, "%s: please set the TERM variable to your terminal type\n", + progname); + fail (); + } + } + + if (strcmp (type, "eterm") == 0) + { + if (noabort) + return 0; + else + { + /* This causes nasty, MULTI_KBOARD-related input lockouts. */ + message (TRUE, "%s: opening a frame in an Emacs term buffer" + " is not supported\n", progname); + fail (); + } + } + + *tty_name = name; + *tty_type = type; + return 1; +} + + #if !defined (NO_SOCKETS_IN_FILE_SYSTEM) /* Three possibilities: @@ -592,6 +1096,95 @@ socket_status (socket_name) return 0; } + +/* A signal handler that passes the signal to the Emacs process. + Useful for SIGWINCH. */ + +SIGTYPE +pass_signal_to_emacs (int signalnum) +{ + int old_errno = errno; + + if (emacs_pid) + kill (emacs_pid, signalnum); + + signal (signalnum, pass_signal_to_emacs); + errno = old_errno; +} + +/* Signal handler for SIGCONT; notify the Emacs process that it can + now resume our tty frame. */ + +SIGTYPE +handle_sigcont (int signalnum) +{ + int old_errno = errno; + + if (tcgetpgrp (1) == getpgrp ()) + { + /* We are in the foreground. */ + send_to_emacs (emacs_socket, "-resume \n"); + } + else + { + /* We are in the background; cancel the continue. */ + kill (getpid (), SIGSTOP); + } + + signal (signalnum, handle_sigcont); + errno = old_errno; +} + +/* Signal handler for SIGTSTP; notify the Emacs process that we are + going to sleep. Normally the suspend is initiated by Emacs via + server-handle-suspend-tty, but if the server gets out of sync with + reality, we may get a SIGTSTP on C-z. Handling this signal and + notifying Emacs about it should get things under control again. */ + +SIGTYPE +handle_sigtstp (int signalnum) +{ + int old_errno = errno; + sigset_t set; + + if (emacs_socket) + send_to_emacs (emacs_socket, "-suspend \n"); + + /* Unblock this signal and call the default handler by temporarily + changing the handler and resignalling. */ + sigprocmask (SIG_BLOCK, NULL, &set); + sigdelset (&set, signalnum); + signal (signalnum, SIG_DFL); + kill (getpid (), signalnum); + sigprocmask (SIG_SETMASK, &set, NULL); /* Let's the above signal through. */ + signal (signalnum, handle_sigtstp); + + errno = old_errno; +} + + +/* Set up signal handlers before opening a frame on the current tty. */ + +void +init_signals (void) +{ + /* Set up signal handlers. */ + signal (SIGWINCH, pass_signal_to_emacs); + + /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of + deciding which terminal the signal came from. C-g is now a + normal input event on secondary terminals. */ +#if 0 + signal (SIGINT, pass_signal_to_emacs); + signal (SIGQUIT, pass_signal_to_emacs); +#endif + + signal (SIGCONT, handle_sigcont); + signal (SIGTSTP, handle_sigtstp); + signal (SIGTTOU, handle_sigtstp); +} + + HSOCKET set_local_socket () { @@ -604,8 +1197,7 @@ set_local_socket () if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0) { - fprintf (stderr, "%s: ", progname); - perror ("socket"); + message (TRUE, "%s: socket: %s\n", progname, strerror (errno)); return INVALID_SOCKET; } @@ -614,30 +1206,35 @@ set_local_socket () { int sock_status = 0; int default_sock = !socket_name; - int saved_errno; + int saved_errno = 0; char *server_name = "server"; + char *tmpdir; if (socket_name && !index (socket_name, '/') && !index (socket_name, '\\')) { /* socket_name is a file name component. */ - server_name = socket_name; - socket_name = NULL; - default_sock = 1; /* Try both UIDs. */ + server_name = socket_name; + socket_name = NULL; + default_sock = 1; /* Try both UIDs. */ } if (default_sock) { - socket_name = alloca (100 + strlen (server_name)); - sprintf (socket_name, "/tmp/emacs%d/%s", - (int) geteuid (), server_name); + tmpdir = egetenv ("TMPDIR"); + if (!tmpdir) + tmpdir = "/tmp"; + socket_name = alloca (strlen (tmpdir) + strlen (server_name) + + EXTRA_SPACE); + sprintf (socket_name, "%s/emacs%d/%s", + tmpdir, (int) geteuid (), server_name); } if (strlen (socket_name) < sizeof (server.sun_path)) strcpy (server.sun_path, socket_name); else { - fprintf (stderr, "%s: socket-name %s too long", - progname, socket_name); - exit (EXIT_FAILURE); + message (TRUE, "%s: socket-name %s too long\n", + progname, socket_name); + fail (); } /* See if the socket exists, and if it's owned by us. */ @@ -650,10 +1247,10 @@ set_local_socket () associated with the name. This is reminiscent of the logic that init_editfns uses to set the global Vuser_full_name. */ - char *user_name = (char *) getenv ("LOGNAME"); + char *user_name = (char *) egetenv ("LOGNAME"); if (!user_name) - user_name = (char *) getenv ("USER"); + user_name = (char *) egetenv ("USER"); if (user_name) { @@ -662,21 +1259,22 @@ set_local_socket () if (pw && (pw->pw_uid != geteuid ())) { /* We're running under su, apparently. */ - socket_name = alloca (100 + strlen (server_name)); - sprintf (socket_name, "/tmp/emacs%d/%s", - (int) pw->pw_uid, server_name); + socket_name = alloca (strlen (tmpdir) + strlen (server_name) + + EXTRA_SPACE); + sprintf (socket_name, "%s/emacs%d/%s", + tmpdir, (int) pw->pw_uid, server_name); if (strlen (socket_name) < sizeof (server.sun_path)) strcpy (server.sun_path, socket_name); else { - fprintf (stderr, "%s: socket-name %s too long", + message (TRUE, "%s: socket-name %s too long\n", progname, socket_name); exit (EXIT_FAILURE); } sock_status = socket_status (server.sun_path); - saved_errno = errno; + saved_errno = errno; } else errno = saved_errno; @@ -686,34 +1284,33 @@ set_local_socket () switch (sock_status) { case 1: - /* There's a socket, but it isn't owned by us. This is OK if - we are root. */ - if (0 != geteuid ()) - { - fprintf (stderr, "%s: Invalid socket owner\n", progname); + /* There's a socket, but it isn't owned by us. This is OK if + we are root. */ + if (0 != geteuid ()) + { + message (TRUE, "%s: Invalid socket owner\n", progname); return INVALID_SOCKET; - } - break; + } + break; case 2: - /* `stat' failed */ - if (saved_errno == ENOENT) - fprintf (stderr, - "%s: can't find socket; have you started the server?\n\ + /* `stat' failed */ + if (saved_errno == ENOENT) + message (TRUE, + "%s: can't find socket; have you started the server?\n\ To start the server in Emacs, type \"M-x server-start\".\n", progname); - else - fprintf (stderr, "%s: can't stat %s: %s\n", + else + message (TRUE, "%s: can't stat %s: %s\n", progname, server.sun_path, strerror (saved_errno)); - return INVALID_SOCKET; + return INVALID_SOCKET; } } if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2) < 0) { - fprintf (stderr, "%s: ", progname); - perror ("connect"); + message (TRUE, "%s: connect: %s\n", progname, strerror (errno)); return INVALID_SOCKET; } @@ -722,7 +1319,7 @@ To start the server in Emacs, type \"M-x server-start\".\n", #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */ HSOCKET -set_socket () +set_socket (int no_exit_if_error) { HSOCKET s; @@ -733,27 +1330,26 @@ set_socket () if (socket_name) { s = set_local_socket (); - if ((s != INVALID_SOCKET) || alternate_editor) - return s; - - fprintf (stderr, "%s: error accessing socket \"%s\"", - progname, socket_name); + if ((s != INVALID_SOCKET) || no_exit_if_error) + return s; + message (TRUE, "%s: error accessing socket \"%s\"\n", + progname, socket_name); exit (EXIT_FAILURE); } #endif /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */ if (!server_file) - server_file = getenv ("EMACS_SERVER_FILE"); + server_file = egetenv ("EMACS_SERVER_FILE"); if (server_file) { s = set_tcp_socket (); - if ((s != INVALID_SOCKET) || alternate_editor) - return s; + if ((s != INVALID_SOCKET) || no_exit_if_error) + return s; - fprintf (stderr, "%s: error accessing server file \"%s\"", - progname, server_file); + message (TRUE, "%s: error accessing server file \"%s\"\n", + progname, server_file); exit (EXIT_FAILURE); } @@ -767,11 +1363,11 @@ set_socket () /* Implicit server file. */ server_file = "server"; s = set_tcp_socket (); - if ((s != INVALID_SOCKET) || alternate_editor) + if ((s != INVALID_SOCKET) || no_exit_if_error) return s; /* No implicit or explicit socket, and no alternate editor. */ - fprintf (stderr, "%s: No socket or alternate editor. Please use:\n\n" + message (TRUE, "%s: No socket or alternate editor. Please use:\n\n" #ifndef NO_SOCKETS_IN_FILE_SYSTEM "\t--socket-name\n" #endif @@ -781,129 +1377,365 @@ set_socket () exit (EXIT_FAILURE); } +#ifdef WINDOWSNT +FARPROC set_fg; /* Pointer to AllowSetForegroundWindow. */ +FARPROC get_wc; /* Pointer to RealGetWindowClassA. */ + +BOOL CALLBACK +w32_find_emacs_process (hWnd, lParam) + HWND hWnd; + LPARAM lParam; +{ + DWORD pid; + char class[6]; + + /* Reject any window not of class "Emacs". */ + if (! get_wc (hWnd, class, sizeof (class)) + || strcmp (class, "Emacs")) + return TRUE; + + /* We only need the process id, not the thread id. */ + (void) GetWindowThreadProcessId (hWnd, &pid); + + /* Not the one we're looking for. */ + if (pid != (DWORD) emacs_pid) return TRUE; + + /* OK, let's raise it. */ + set_fg (emacs_pid); + + /* Stop enumeration. */ + return FALSE; +} + +/* + * Search for a window of class "Emacs" and owned by a process with + * process id = emacs_pid. If found, allow it to grab the focus. + */ +void +w32_give_focus () +{ + HMODULE hUser32; + + /* It shouldn't happen when dealing with TCP sockets. */ + if (!emacs_pid) return; + + if (!(hUser32 = LoadLibrary ("user32.dll"))) return; + + /* Modern Windows restrict which processes can set the foreground window. + emacsclient can allow Emacs to grab the focus by calling the function + AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and + NT) lack this function, so we have to check its availability. */ + if ((set_fg = GetProcAddress (hUser32, "AllowSetForegroundWindow")) + && (get_wc = GetProcAddress (hUser32, "RealGetWindowClassA"))) + EnumWindows (w32_find_emacs_process, (LPARAM) 0); + + FreeLibrary (hUser32); +} +#endif + +/* Start the emacs daemon and try to connect to it. */ + +void +start_daemon_and_retry_set_socket (void) +{ +#ifndef WINDOWSNT + pid_t dpid; + int status; + + dpid = fork (); + + if (dpid > 0) + { + pid_t w; + w = waitpid (dpid, &status, WUNTRACED | WCONTINUED); + + if ((w == -1) || !WIFEXITED (status) || WEXITSTATUS(status)) + { + message (TRUE, "Error: Could not start the Emacs daemon\n"); + exit (EXIT_FAILURE); + } + + /* Try connecting, the daemon should have started by now. */ + message (TRUE, "Emacs daemon should have started, trying to connect again\n"); + if ((emacs_socket = set_socket (1)) == INVALID_SOCKET) + { + message (TRUE, "Error: Cannot connect even after starting the Emacs daemon\n"); + exit (EXIT_FAILURE); + } + } + else if (dpid < 0) + { + fprintf (stderr, "Error: Cannot fork!\n"); + exit (1); + } + else + { + char *d_argv[] = {"emacs", "--daemon", 0 }; + if (socket_name != NULL) + { + /* Pass --daemon=socket_name as argument. */ + char *deq = "--daemon="; + char *daemon_arg = alloca (strlen (deq) + + strlen (socket_name) + 1); + strcpy (daemon_arg, deq); + strcat (daemon_arg, socket_name); + d_argv[1] = daemon_arg; + } + execvp ("emacs", d_argv); + message (TRUE, "%s: error starting emacs daemon\n", progname); + } +#endif /* WINDOWSNT */ +} + int main (argc, argv) int argc; char **argv; { - HSOCKET s; int i, rl, needlf = 0; - char *cwd; + char *cwd, *str; char string[BUFSIZ+1]; + int null_socket_name, null_server_file, start_daemon_if_needed; + main_argv = argv; progname = argv[0]; /* Process options. */ decode_options (argc, argv); - if ((argc - optind < 1) && !eval) + if ((argc - optind < 1) && !eval && current_frame) { - fprintf (stderr, "%s: file name or argument required\n", progname); - fprintf (stderr, "Try `%s --help' for more information\n", progname); + message (TRUE, "%s: file name or argument required\n" + "Try `%s --help' for more information\n", + progname, progname); exit (EXIT_FAILURE); } - if ((s = set_socket ()) == INVALID_SOCKET) - fail (argc, argv); + /* If alternate_editor is the empty string, start the emacs daemon + in case of failure to connect. */ + start_daemon_if_needed = (alternate_editor + && (alternate_editor[0] == '\0')); + if (start_daemon_if_needed) + { + /* set_socket changes the values for socket_name and + server_file, we need to reset them, if they were NULL before + for the second call to set_socket. */ + null_socket_name = (socket_name == NULL); + null_server_file = (server_file == NULL); + } -#ifdef HAVE_GETCWD - cwd = getcwd (string, sizeof string); -#else - cwd = getwd (string); -#endif + if ((emacs_socket = set_socket (alternate_editor + || start_daemon_if_needed)) == INVALID_SOCKET) + if (start_daemon_if_needed) + { + /* Reset socket_name and server_file if they were NULL + before the set_socket call. */ + if (null_socket_name) + socket_name = NULL; + if (null_server_file) + server_file = NULL; + + start_daemon_and_retry_set_socket (); + } + else + fail (); + + cwd = get_current_dir_name (); if (cwd == 0) { /* getwd puts message in STRING if it fails. */ -#ifdef HAVE_GETCWD - fprintf (stderr, "%s: %s (%s)\n", progname, - "Cannot get current working directory", strerror (errno)); -#else - fprintf (stderr, "%s: %s (%s)\n", progname, string, strerror (errno)); + message (TRUE, "%s: %s\n", progname, + "Cannot get current working directory"); + fail (); + } + +#ifdef WINDOWSNT + w32_give_focus (); #endif - fail (argc, argv); + + /* Send over our environment and current directory. */ + if (!current_frame) + { + extern char **environ; + int i; + for (i = 0; environ[i]; i++) + { + char *name = xstrdup (environ[i]); + char *value = strchr (name, '='); + send_to_emacs (emacs_socket, "-env "); + quote_argument (emacs_socket, environ[i]); + send_to_emacs (emacs_socket, " "); + } } + send_to_emacs (emacs_socket, "-dir "); + quote_argument (emacs_socket, cwd); + send_to_emacs (emacs_socket, "/"); + send_to_emacs (emacs_socket, " "); + retry: if (nowait) - SEND_STRING ("-nowait "); + send_to_emacs (emacs_socket, "-nowait "); - if (eval) - SEND_STRING ("-eval "); + if (current_frame) + send_to_emacs (emacs_socket, "-current-frame "); if (display) { - SEND_STRING ("-display "); - SEND_QUOTED (display); - SEND_STRING (" "); + send_to_emacs (emacs_socket, "-display "); + quote_argument (emacs_socket, display); + send_to_emacs (emacs_socket, " "); + } + + /* If using the current frame, send tty information to Emacs anyway. + In daemon mode, Emacs may need to occupy this tty if no other + frame is available. */ + if (tty || (current_frame && !eval)) + { + char *tty_type, *tty_name; + + if (find_tty (&tty_type, &tty_name, !tty)) + { +#if !defined (NO_SOCKETS_IN_FILE_SYSTEM) + init_signals (); +#endif + send_to_emacs (emacs_socket, "-tty "); + quote_argument (emacs_socket, tty_name); + send_to_emacs (emacs_socket, " "); + quote_argument (emacs_socket, tty_type); + send_to_emacs (emacs_socket, " "); + } } + if (!current_frame && !tty) + send_to_emacs (emacs_socket, "-window-system "); + if ((argc - optind > 0)) { for (i = optind; i < argc; i++) { + if (eval) - ; /* Don't prepend any cwd or anything like that. */ - else if (*argv[i] == '+') - { + { + /* Don't prepend cwd or anything like that. */ + send_to_emacs (emacs_socket, "-eval "); + quote_argument (emacs_socket, argv[i]); + send_to_emacs (emacs_socket, " "); + continue; + } + + if (*argv[i] == '+') + { char *p = argv[i] + 1; while (isdigit ((unsigned char) *p) || *p == ':') p++; - if (*p != 0) - { - SEND_QUOTED (cwd); - SEND_STRING ("/"); - } - } - else if (! file_name_absolute_p (argv[i])) - { - SEND_QUOTED (cwd); - SEND_STRING ("/"); - } - - SEND_QUOTED (argv[i]); - SEND_STRING (" "); - } + if (*p == 0) + { + send_to_emacs (emacs_socket, "-position "); + quote_argument (emacs_socket, argv[i]); + send_to_emacs (emacs_socket, " "); + continue; + } + } + + send_to_emacs (emacs_socket, "-file "); + quote_argument (emacs_socket, argv[i]); + send_to_emacs (emacs_socket, " "); + } } - else + else if (eval) { - while (fgets (string, BUFSIZ, stdin)) + /* Read expressions interactively. */ + while ((str = fgets (string, BUFSIZ, stdin))) { - SEND_QUOTED (string); + send_to_emacs (emacs_socket, "-eval "); + quote_argument (emacs_socket, str); } - SEND_STRING (" "); + send_to_emacs (emacs_socket, " "); } - SEND_STRING ("\n"); + send_to_emacs (emacs_socket, "\n"); + + /* Wait for an answer. */ + if (!eval && !tty && !nowait) + { + printf ("Waiting for Emacs..."); + needlf = 2; + } + fflush (stdout); + fsync (1); - /* Maybe wait for an answer. */ - if (!nowait) + /* Now, wait for an answer and print any messages. */ + while ((rl = recv (emacs_socket, string, BUFSIZ, 0)) > 0) { - if (!eval) + char *p; + string[rl] = '\0'; + + p = string + strlen (string) - 1; + while (p > string && *p == '\n') + *p-- = 0; + + if (strprefix ("-emacs-pid ", string)) { - printf ("Waiting for Emacs..."); - needlf = 2; + /* -emacs-pid PID: The process id of the Emacs process. */ + emacs_pid = strtol (string + strlen ("-emacs-pid"), NULL, 10); } - fflush (stdout); - - /* Now, wait for an answer and print any messages. */ - while ((rl = recv (s, string, BUFSIZ, 0)) > 0) + else if (strprefix ("-window-system-unsupported ", string)) + { + /* -window-system-unsupported: Emacs was compiled without X + support. Try again on the terminal. */ + nowait = 0; + tty = 1; + goto retry; + } + else if (strprefix ("-print ", string)) { - string[rl] = '\0'; - if (needlf == 2) + /* -print STRING: Print STRING on the terminal. */ + str = unquote_argument (string + strlen ("-print ")); + if (needlf) printf ("\n"); - printf ("%s", string); - needlf = string[0] == '\0' ? needlf : string[strlen (string) - 1] != '\n'; + printf ("%s", str); + needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n'; + } + else if (strprefix ("-error ", string)) + { + /* -error DESCRIPTION: Signal an error on the terminal. */ + str = unquote_argument (string + strlen ("-error ")); + if (needlf) + printf ("\n"); + fprintf (stderr, "*ERROR*: %s", str); + needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n'; + } +#ifdef SIGSTOP + else if (strprefix ("-suspend ", string)) + { + /* -suspend: Suspend this terminal, i.e., stop the process. */ + if (needlf) + printf ("\n"); + needlf = 0; + kill (0, SIGSTOP); + } +#endif + else + { + /* Unknown command. */ + if (needlf) + printf ("\n"); + printf ("*ERROR*: Unknown message: %s", string); + needlf = string[0] == '\0' ? needlf : string[strlen (string) - 1] != '\n'; } - - if (needlf) - printf ("\n"); - fflush (stdout); } - CLOSE_SOCKET (s); + if (needlf) + printf ("\n"); + fflush (stdout); + fsync (1); + + CLOSE_SOCKET (emacs_socket); return EXIT_SUCCESS; } #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */ + #ifndef HAVE_STRERROR char * strerror (errnum)