1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986-1987, 1994, 1999-2011 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 /* config.h defines these, which disables sockets altogether! */
31 # include <commctrl.h>
33 # include <winsock2.h>
35 # define NO_SOCKETS_IN_FILE_SYSTEM
37 # define HSOCKET SOCKET
38 # define CLOSE_SOCKET closesocket
39 # define INITIALIZE() (initialize_sockets ())
41 char *w32_getenv (char *);
42 #define egetenv(VAR) w32_getenv(VAR)
44 #else /* !WINDOWSNT */
48 # ifdef HAVE_INET_SOCKETS
49 # include <netinet/in.h>
51 # include <sys/types.h>
52 # include <sys/socket.h>
54 # endif /* HAVE_SOCKETS */
56 # include <arpa/inet.h>
58 # define INVALID_SOCKET -1
60 # define CLOSE_SOCKET close
67 #define egetenv(VAR) getenv(VAR)
69 #endif /* !WINDOWSNT */
86 char *getenv (const char *), *getwd (char *);
88 char *(getcwd
) (char *, size_t);
92 #define VERSION "unspecified"
97 #define EXIT_SUCCESS 0
101 #define EXIT_FAILURE 1
112 /* Additional space when allocating buffers for filenames, etc. */
113 #define EXTRA_SPACE 100
115 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
117 # define IF_LINT(Code) Code
119 # define IF_LINT(Code) /* empty */
123 /* Name used to invoke this program. */
124 const char *progname
;
126 /* The second argument to main. */
129 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
132 /* Nonzero means don't print messages for successful operations. --quiet. */
135 /* Nonzero means args are expressions to be evaluated. --eval. */
138 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
139 int current_frame
= 1;
141 /* The display on which Emacs should work. --display. */
142 const char *display
= NULL
;
144 /* The parent window ID, if we are opening a frame via XEmbed. */
145 char *parent_id
= NULL
;
147 /* Nonzero means open a new Emacs frame on the current terminal. */
150 /* If non-NULL, the name of an editor to fallback to if the server
151 is not running. --alternate-editor. */
152 const char *alternate_editor
= NULL
;
154 /* If non-NULL, the filename of the UNIX socket. */
155 char *socket_name
= NULL
;
157 /* If non-NULL, the filename of the authentication file. */
158 const char *server_file
= NULL
;
160 /* PID of the Emacs server process. */
163 static void print_help_and_exit (void) NO_RETURN
;
164 static void fail (void) NO_RETURN
;
167 struct option longopts
[] =
169 { "no-wait", no_argument
, NULL
, 'n' },
170 { "quiet", no_argument
, NULL
, 'q' },
171 { "eval", no_argument
, NULL
, 'e' },
172 { "help", no_argument
, NULL
, 'H' },
173 { "version", no_argument
, NULL
, 'V' },
174 { "tty", no_argument
, NULL
, 't' },
175 { "nw", no_argument
, NULL
, 't' },
176 { "create-frame", no_argument
, NULL
, 'c' },
177 { "alternate-editor", required_argument
, NULL
, 'a' },
178 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
179 { "socket-name", required_argument
, NULL
, 's' },
181 { "server-file", required_argument
, NULL
, 'f' },
183 { "display", required_argument
, NULL
, 'd' },
185 { "parent-id", required_argument
, NULL
, 'p' },
190 /* Like malloc but get fatal error if memory is exhausted. */
193 xmalloc (unsigned int size
)
195 long *result
= (long *) malloc (size
);
205 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
208 #ifndef DIRECTORY_SEP
209 #define DIRECTORY_SEP '/'
211 #ifndef IS_DIRECTORY_SEP
212 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
214 #ifndef IS_DEVICE_SEP
216 #define IS_DEVICE_SEP(_c_) 0
218 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
222 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
226 /* Return the current working directory. Returns NULL on errors.
227 Any other returned value must be freed with free. This is used
228 only when get_current_dir_name is not defined on the system. */
230 get_current_dir_name (void)
234 struct stat dotstat
, pwdstat
;
235 /* If PWD is accurate, use it instead of calling getwd. PWD is
236 sometimes a nicer name, and using it may avoid a fatal error if a
237 parent directory is searchable but not readable. */
238 if ((pwd
= egetenv ("PWD")) != 0
239 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
240 && stat (pwd
, &pwdstat
) == 0
241 && stat (".", &dotstat
) == 0
242 && dotstat
.st_ino
== pwdstat
.st_ino
243 && dotstat
.st_dev
== pwdstat
.st_dev
245 && strlen (pwd
) < MAXPATHLEN
249 buf
= (char *) xmalloc (strlen (pwd
) + 1);
257 size_t buf_size
= 1024;
258 buf
= (char *) xmalloc (buf_size
);
263 if (getcwd (buf
, buf_size
) == buf
)
267 int tmp_errno
= errno
;
273 buf
= (char *) realloc (buf
, buf_size
);
281 /* We need MAXPATHLEN here. */
282 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
285 if (getwd (buf
) == NULL
)
287 int tmp_errno
= errno
;
300 /* Like strdup but get a fatal error if memory is exhausted. */
303 xstrdup (const char *s
)
305 char *result
= strdup (s
);
314 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
316 /* Retrieve an environment variable from the Emacs subkeys of the registry.
317 Return NULL if the variable was not found, or it was empty.
318 This code is based on w32_get_resource (w32.c). */
320 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
322 HKEY hrootkey
= NULL
;
326 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
328 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
330 result
= (char *) xmalloc (cbData
);
332 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
340 RegCloseKey (hrootkey
);
347 getenv wrapper for Windows
349 Value is allocated on the heap, and can be free'd.
351 This is needed to duplicate Emacs's behavior, which is to look for
352 environment variables in the registry if they don't appear in the
355 w32_getenv (char *envvar
)
360 if (value
= getenv (envvar
))
361 /* Found in the environment. strdup it, because values returned
362 by getenv cannot be free'd. */
363 return xstrdup (value
);
365 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
366 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
368 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
369 if (strcmp (envvar
, "TERM") == 0)
370 return xstrdup ("w32console");
371 /* Found neither in the environment nor in the registry. */
375 if (dwType
== REG_SZ
)
376 /* Registry; no need to expand. */
379 if (dwType
== REG_EXPAND_SZ
)
383 if (size
= ExpandEnvironmentStrings (value
, NULL
, 0))
385 char *buffer
= (char *) xmalloc (size
);
386 if (ExpandEnvironmentStrings (value
, buffer
, size
))
388 /* Found and expanded. */
393 /* Error expanding. */
398 /* Not the right type, or not correctly expanded. */
404 w32_set_user_model_id (void)
407 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
409 /* On Windows 7 and later, we need to set the user model ID
410 to associate emacsclient launched files with Emacs frames
412 shell
= LoadLibrary ("shell32.dll");
416 = (void *) GetProcAddress (shell
,
417 "SetCurrentProcessExplicitAppUserModelID");
418 /* If the function is defined, then we are running on Windows 7
419 or newer, and the UI uses this to group related windows
420 together. Since emacs, runemacs, emacsclient are related, we
421 want them grouped even though the executables are different,
422 so we need to set a consistent ID between them. */
424 set_user_model (L
"GNU.Emacs");
431 w32_window_app (void)
433 static int window_app
= -1;
434 char szTitle
[MAX_PATH
];
438 /* Checking for STDOUT does not work; it's a valid handle also in
439 nonconsole apps. Testing for the console title seems to work. */
440 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
442 InitCommonControls ();
449 execvp wrapper for Windows. Quotes arguments with embedded spaces.
451 This is necessary due to the broken implementation of exec* routines in
452 the Microsoft libraries: they concatenate the arguments together without
453 quoting special characters, and pass the result to CreateProcess, with
454 predictably bad results. By contrast, POSIX execvp passes the arguments
455 directly into the argv array of the child process.
458 w32_execvp (const char *path
, char **argv
)
462 /* Required to allow a .BAT script as alternate editor. */
463 argv
[0] = (char *) alternate_editor
;
465 for (i
= 0; argv
[i
]; i
++)
466 if (strchr (argv
[i
], ' '))
468 char *quoted
= alloca (strlen (argv
[i
]) + 3);
469 sprintf (quoted
, "\"%s\"", argv
[i
]);
473 return execvp (path
, argv
);
477 #define execvp w32_execvp
479 /* Emulation of ttyname for Windows. */
486 #endif /* WINDOWSNT */
488 /* Display a normal or error message.
489 On Windows, use a message box if compiled as a Windows app. */
491 message (int is_error
, const char *format
, ...)
496 va_start (args
, format
);
497 vsprintf (msg
, format
, args
);
501 if (w32_window_app ())
504 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
506 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
511 FILE *f
= is_error
? stderr
: stdout
;
518 /* Decode the options from argv and argc.
519 The global variable `optind' will say how many arguments we used up. */
522 decode_options (int argc
, char **argv
)
524 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
528 int opt
= getopt_long_only (argc
, argv
,
529 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
542 /* If getopt returns 0, then it has already processed a
543 long-named option. We should do nothing. */
547 alternate_editor
= optarg
;
550 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
552 socket_name
= optarg
;
557 server_file
= optarg
;
560 /* We used to disallow this argument in w32, but it seems better
561 to allow it, for the occasional case where the user is
562 connecting with a w32 client to a server compiled with X11
581 message (FALSE
, "emacsclient %s\n", VERSION
);
600 print_help_and_exit ();
604 message (TRUE
, "Try `%s --help' for more information\n", progname
);
610 /* If the -c option is used (without -t) and no --display argument
611 is provided, try $DISPLAY.
612 Without the -c option, we used to set `display' to $DISPLAY by
613 default, but this changed the default behavior and is sometimes
614 inconvenient. So we force users to use "--display $DISPLAY" if
615 they want Emacs to connect to their current display. */
616 if (!current_frame
&& !tty
&& !display
)
618 display
= egetenv ("DISPLAY");
620 /* Under Cocoa, we don't really use displays the same way as in X,
621 so provide a dummy. */
622 if (!display
|| strlen (display
) == 0)
627 /* A null-string display is invalid. */
628 if (display
&& strlen (display
) == 0)
631 /* If no display is available, new frames are tty frames. */
632 if (!current_frame
&& !display
)
635 /* --no-wait implies --current-frame on ttys when there are file
636 arguments or expressions given. */
637 if (nowait
&& tty
&& argc
- optind
> 0)
641 if (alternate_editor
&& alternate_editor
[0] == '\0')
643 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
647 #endif /* WINDOWSNT */
652 print_help_and_exit (void)
654 /* Spaces and tabs are significant in this message; they're chosen so the
655 message aligns properly both in a tty and in a Windows message box.
656 Please try to preserve them; otherwise the output is very hard to read
657 when using emacsclientw. */
659 "Usage: %s [OPTIONS] FILE...\n\
660 Tell the Emacs server to visit the specified files.\n\
661 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
663 The following OPTIONS are accepted:\n\
664 -V, --version Just print version info and return\n\
665 -H, --help Print this usage information message\n\
666 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
667 -c, --create-frame Create a new frame instead of trying to\n\
668 use the current Emacs frame\n\
669 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
670 -n, --no-wait Don't wait for the server to return\n\
671 -q, --quiet Don't display messages on success\n\
672 -d DISPLAY, --display=DISPLAY\n\
673 Visit the file in the given display\n\
674 --parent-id=ID Open in parent window ID, via XEmbed\n"
675 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
676 "-s SOCKET, --socket-name=SOCKET\n\
677 Set filename of the UNIX socket for communication\n"
679 "-f SERVER, --server-file=SERVER\n\
680 Set filename of the TCP authentication file\n\
681 -a EDITOR, --alternate-editor=EDITOR\n\
682 Editor to fallback to if the server is not running\n"
684 " If EDITOR is the empty string, start Emacs in daemon\n\
685 mode and try connecting again\n"
686 #endif /* not WINDOWSNT */
688 Report bugs with M-x report-emacs-bug.\n", progname
);
693 Try to run a different command, or --if no alternate editor is
694 defined-- exit with an errorcode.
695 Uses argv, but gets it from the global variable main_argv.
700 if (alternate_editor
)
704 execvp (alternate_editor
, main_argv
+ i
);
705 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
706 progname
, alternate_editor
);
712 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
715 main (int argc
, char **argv
)
719 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
720 "on systems with Berkeley sockets.\n",
725 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
727 #define AUTH_KEY_LENGTH 64
728 #define SEND_BUFFER_SIZE 4096
730 extern char *strerror (int);
732 /* Buffer to accumulate data to send in TCP connections. */
733 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
734 int sblen
= 0; /* Fill pointer for the send buffer. */
735 /* Socket used to communicate with the Emacs server process. */
736 HSOCKET emacs_socket
= 0;
738 /* On Windows, the socket library was historically separate from the standard
739 C library, so errors are handled differently. */
741 sock_err_message (const char *function_name
)
746 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
747 | FORMAT_MESSAGE_ALLOCATE_BUFFER
748 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
749 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
751 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
755 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
760 /* Let's send the data to Emacs when either
761 - the data ends in "\n", or
762 - the buffer is full (but this shouldn't happen)
763 Otherwise, we just accumulate it. */
765 send_to_emacs (HSOCKET s
, const char *data
)
769 size_t dlen
= strlen (data
);
770 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
772 int part
= SEND_BUFFER_SIZE
- sblen
;
773 strncpy (&send_buffer
[sblen
], data
, part
);
775 sblen
= SEND_BUFFER_SIZE
;
779 strcpy (&send_buffer
[sblen
], data
);
786 if (sblen
== SEND_BUFFER_SIZE
787 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
789 int sent
= send (s
, send_buffer
, sblen
, 0);
791 strcpy (send_buffer
, &send_buffer
[sent
]);
798 /* In STR, insert a & before each &, each space, each newline, and
799 any initial -. Change spaces to underscores, too, so that the
800 return value never contains a space.
802 Does not change the string. Outputs the result to S. */
804 quote_argument (HSOCKET s
, const char *str
)
806 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
828 if (*p
== '&' || (*p
== '-' && p
== str
))
835 send_to_emacs (s
, copy
);
841 /* The inverse of quote_argument. Removes quoting in string STR by
842 modifying the string in place. Returns STR. */
845 unquote_argument (char *str
)
876 file_name_absolute_p (const char *filename
)
878 /* Sanity check, it shouldn't happen. */
879 if (! filename
) return FALSE
;
881 /* /xxx is always an absolute path. */
882 if (filename
[0] == '/') return TRUE
;
884 /* Empty filenames (which shouldn't happen) are relative. */
885 if (filename
[0] == '\0') return FALSE
;
888 /* X:\xxx is always absolute. */
889 if (isalpha ((unsigned char) filename
[0])
890 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
893 /* Both \xxx and \\xxx\yyy are absolute. */
894 if (filename
[0] == '\\') return TRUE
;
901 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
908 /* Initialize the WinSock2 library. */
910 initialize_sockets (void)
914 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
916 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
920 atexit (close_winsock
);
922 #endif /* WINDOWSNT */
926 * Read the information needed to set up a TCP comm channel with
927 * the Emacs server: host, port, and authentication string.
930 get_server_config (struct sockaddr_in
*server
, char *authentication
)
936 if (file_name_absolute_p (server_file
))
937 config
= fopen (server_file
, "rb");
940 const char *home
= egetenv ("HOME");
944 char *path
= alloca (strlen (home
) + strlen (server_file
)
946 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
947 config
= fopen (path
, "rb");
950 if (!config
&& (home
= egetenv ("APPDATA")))
952 char *path
= alloca (strlen (home
) + strlen (server_file
)
954 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
955 config
= fopen (path
, "rb");
963 if (fgets (dotted
, sizeof dotted
, config
)
964 && (port
= strchr (dotted
, ':')))
968 message (TRUE
, "%s: invalid configuration info\n", progname
);
972 server
->sin_family
= AF_INET
;
973 server
->sin_addr
.s_addr
= inet_addr (dotted
);
974 server
->sin_port
= htons (atoi (port
));
976 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
978 message (TRUE
, "%s: cannot read authentication info\n", progname
);
988 set_tcp_socket (void)
991 struct sockaddr_in server
;
992 struct linger l_arg
= {1, 1};
993 char auth_string
[AUTH_KEY_LENGTH
+ 1];
995 if (! get_server_config (&server
, auth_string
))
996 return INVALID_SOCKET
;
998 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
999 message (FALSE
, "%s: connected to remote socket at %s\n",
1000 progname
, inet_ntoa (server
.sin_addr
));
1003 * Open up an AF_INET socket
1005 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1007 sock_err_message ("socket");
1008 return INVALID_SOCKET
;
1014 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1016 sock_err_message ("connect");
1017 return INVALID_SOCKET
;
1020 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1023 * Send the authentication
1025 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1027 send_to_emacs (s
, "-auth ");
1028 send_to_emacs (s
, auth_string
);
1029 send_to_emacs (s
, " ");
1035 /* Returns 1 if PREFIX is a prefix of STRING. */
1037 strprefix (const char *prefix
, const char *string
)
1039 return !strncmp (prefix
, string
, strlen (prefix
));
1042 /* Get tty name and type. If successful, return the type in TTY_TYPE
1043 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1044 is zero, or return 0 if NOABORT is non-zero. */
1047 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1049 const char *type
= egetenv ("TERM");
1050 const char *name
= ttyname (fileno (stdout
));
1058 message (TRUE
, "%s: could not get terminal name\n", progname
);
1069 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1075 if (strcmp (type
, "eterm") == 0)
1081 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1082 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1083 " is not supported\n", progname
);
1094 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1096 /* Three possibilities:
1097 2 - can't be `stat'ed (sets errno)
1098 1 - isn't owned by us
1099 0 - success: none of the above */
1102 socket_status (char *name
)
1104 struct stat statbfr
;
1106 if (stat (name
, &statbfr
) == -1)
1109 if (statbfr
.st_uid
!= geteuid ())
1116 /* A signal handler that passes the signal to the Emacs process.
1117 Useful for SIGWINCH. */
1120 pass_signal_to_emacs (int signalnum
)
1122 int old_errno
= errno
;
1125 kill (emacs_pid
, signalnum
);
1127 signal (signalnum
, pass_signal_to_emacs
);
1131 /* Signal handler for SIGCONT; notify the Emacs process that it can
1132 now resume our tty frame. */
1135 handle_sigcont (int signalnum
)
1137 int old_errno
= errno
;
1139 if (tcgetpgrp (1) == getpgrp ())
1141 /* We are in the foreground. */
1142 send_to_emacs (emacs_socket
, "-resume \n");
1146 /* We are in the background; cancel the continue. */
1147 kill (getpid (), SIGSTOP
);
1150 signal (signalnum
, handle_sigcont
);
1154 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1155 going to sleep. Normally the suspend is initiated by Emacs via
1156 server-handle-suspend-tty, but if the server gets out of sync with
1157 reality, we may get a SIGTSTP on C-z. Handling this signal and
1158 notifying Emacs about it should get things under control again. */
1161 handle_sigtstp (int signalnum
)
1163 int old_errno
= errno
;
1167 send_to_emacs (emacs_socket
, "-suspend \n");
1169 /* Unblock this signal and call the default handler by temporarily
1170 changing the handler and resignalling. */
1171 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1172 sigdelset (&set
, signalnum
);
1173 signal (signalnum
, SIG_DFL
);
1174 kill (getpid (), signalnum
);
1175 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1176 signal (signalnum
, handle_sigtstp
);
1182 /* Set up signal handlers before opening a frame on the current tty. */
1187 /* Set up signal handlers. */
1188 signal (SIGWINCH
, pass_signal_to_emacs
);
1190 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1191 deciding which terminal the signal came from. C-g is now a
1192 normal input event on secondary terminals. */
1194 signal (SIGINT
, pass_signal_to_emacs
);
1195 signal (SIGQUIT
, pass_signal_to_emacs
);
1198 signal (SIGCONT
, handle_sigcont
);
1199 signal (SIGTSTP
, handle_sigtstp
);
1200 signal (SIGTTOU
, handle_sigtstp
);
1205 set_local_socket (void)
1208 struct sockaddr_un server
;
1211 * Open up an AF_UNIX socket in this person's home directory
1214 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1216 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1217 return INVALID_SOCKET
;
1220 server
.sun_family
= AF_UNIX
;
1223 int sock_status
= 0;
1224 int default_sock
= !socket_name
;
1225 int saved_errno
= 0;
1226 const char *server_name
= "server";
1227 const char *tmpdir
IF_LINT ( = NULL
);
1229 if (socket_name
&& !strchr (socket_name
, '/')
1230 && !strchr (socket_name
, '\\'))
1232 /* socket_name is a file name component. */
1233 server_name
= socket_name
;
1235 default_sock
= 1; /* Try both UIDs. */
1240 tmpdir
= egetenv ("TMPDIR");
1244 #ifndef _CS_DARWIN_USER_TEMP_DIR
1245 #define _CS_DARWIN_USER_TEMP_DIR 65537
1247 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1250 tmpdir
= alloca (n
);
1251 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir
, n
);
1257 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1259 sprintf (socket_name
, "%s/emacs%d/%s",
1260 tmpdir
, (int) geteuid (), server_name
);
1263 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1264 strcpy (server
.sun_path
, socket_name
);
1267 message (TRUE
, "%s: socket-name %s too long\n",
1268 progname
, socket_name
);
1272 /* See if the socket exists, and if it's owned by us. */
1273 sock_status
= socket_status (server
.sun_path
);
1274 saved_errno
= errno
;
1275 if (sock_status
&& default_sock
)
1277 /* Failing that, see if LOGNAME or USER exist and differ from
1278 our euid. If so, look for a socket based on the UID
1279 associated with the name. This is reminiscent of the logic
1280 that init_editfns uses to set the global Vuser_full_name. */
1282 const char *user_name
= egetenv ("LOGNAME");
1285 user_name
= egetenv ("USER");
1289 struct passwd
*pw
= getpwnam (user_name
);
1291 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1293 /* We're running under su, apparently. */
1294 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1296 sprintf (socket_name
, "%s/emacs%d/%s",
1297 tmpdir
, (int) pw
->pw_uid
, server_name
);
1299 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1300 strcpy (server
.sun_path
, socket_name
);
1303 message (TRUE
, "%s: socket-name %s too long\n",
1304 progname
, socket_name
);
1305 exit (EXIT_FAILURE
);
1308 sock_status
= socket_status (server
.sun_path
);
1309 saved_errno
= errno
;
1312 errno
= saved_errno
;
1316 switch (sock_status
)
1319 /* There's a socket, but it isn't owned by us. This is OK if
1321 if (0 != geteuid ())
1323 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1324 return INVALID_SOCKET
;
1330 if (saved_errno
== ENOENT
)
1332 "%s: can't find socket; have you started the server?\n\
1333 To start the server in Emacs, type \"M-x server-start\".\n",
1336 message (TRUE
, "%s: can't stat %s: %s\n",
1337 progname
, server
.sun_path
, strerror (saved_errno
));
1338 return INVALID_SOCKET
;
1342 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1345 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1346 return INVALID_SOCKET
;
1351 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1354 set_socket (int no_exit_if_error
)
1360 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1361 /* Explicit --socket-name argument. */
1364 s
= set_local_socket ();
1365 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1367 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1368 progname
, socket_name
);
1369 exit (EXIT_FAILURE
);
1373 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1375 server_file
= egetenv ("EMACS_SERVER_FILE");
1379 s
= set_tcp_socket ();
1380 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1383 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1384 progname
, server_file
);
1385 exit (EXIT_FAILURE
);
1388 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1389 /* Implicit local socket. */
1390 s
= set_local_socket ();
1391 if (s
!= INVALID_SOCKET
)
1395 /* Implicit server file. */
1396 server_file
= "server";
1397 s
= set_tcp_socket ();
1398 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1401 /* No implicit or explicit socket, and no alternate editor. */
1402 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1403 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1406 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1407 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1409 exit (EXIT_FAILURE
);
1413 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1414 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1417 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1422 /* Reject any window not of class "Emacs". */
1423 if (! get_wc (hWnd
, class, sizeof (class))
1424 || strcmp (class, "Emacs"))
1427 /* We only need the process id, not the thread id. */
1428 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1430 /* Not the one we're looking for. */
1431 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1433 /* OK, let's raise it. */
1436 /* Stop enumeration. */
1441 * Search for a window of class "Emacs" and owned by a process with
1442 * process id = emacs_pid. If found, allow it to grab the focus.
1445 w32_give_focus (void)
1449 /* It shouldn't happen when dealing with TCP sockets. */
1450 if (!emacs_pid
) return;
1452 user32
= GetModuleHandle ("user32.dll");
1457 /* Modern Windows restrict which processes can set the foreground window.
1458 emacsclient can allow Emacs to grab the focus by calling the function
1459 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1460 NT) lack this function, so we have to check its availability. */
1461 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1462 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1463 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1467 /* Start the emacs daemon and try to connect to it. */
1470 start_daemon_and_retry_set_socket (void)
1481 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1483 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1485 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1486 exit (EXIT_FAILURE
);
1489 /* Try connecting, the daemon should have started by now. */
1490 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1491 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1493 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1494 exit (EXIT_FAILURE
);
1499 fprintf (stderr
, "Error: Cannot fork!\n");
1500 exit (EXIT_FAILURE
);
1504 char emacs
[] = "emacs";
1505 char daemon_option
[] = "--daemon";
1506 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1507 if (socket_name
!= NULL
)
1509 /* Pass --daemon=socket_name as argument. */
1510 const char *deq
= "--daemon=";
1511 char *daemon_arg
= alloca (strlen (deq
)
1512 + strlen (socket_name
) + 1);
1513 strcpy (daemon_arg
, deq
);
1514 strcat (daemon_arg
, socket_name
);
1515 d_argv
[1] = daemon_arg
;
1517 execvp ("emacs", d_argv
);
1518 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1520 #endif /* WINDOWSNT */
1524 main (int argc
, char **argv
)
1528 char string
[BUFSIZ
+1];
1529 int null_socket_name
IF_LINT ( = 0);
1530 int null_server_file
IF_LINT ( = 0);
1531 int start_daemon_if_needed
;
1532 int exit_status
= EXIT_SUCCESS
;
1538 /* On Windows 7 and later, we need to explicitly associate emacsclient
1539 with emacs so the UI behaves sensibly. */
1540 w32_set_user_model_id ();
1543 /* Process options. */
1544 decode_options (argc
, argv
);
1546 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1548 message (TRUE
, "%s: file name or argument required\n"
1549 "Try `%s --help' for more information\n",
1550 progname
, progname
);
1551 exit (EXIT_FAILURE
);
1554 /* If alternate_editor is the empty string, start the emacs daemon
1555 in case of failure to connect. */
1556 start_daemon_if_needed
= (alternate_editor
1557 && (alternate_editor
[0] == '\0'));
1558 if (start_daemon_if_needed
)
1560 /* set_socket changes the values for socket_name and
1561 server_file, we need to reset them, if they were NULL before
1562 for the second call to set_socket. */
1563 null_socket_name
= (socket_name
== NULL
);
1564 null_server_file
= (server_file
== NULL
);
1567 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1568 if (emacs_socket
== INVALID_SOCKET
)
1570 if (! start_daemon_if_needed
)
1573 /* Reset socket_name and server_file if they were NULL
1574 before the set_socket call. */
1575 if (null_socket_name
)
1577 if (null_server_file
)
1580 start_daemon_and_retry_set_socket ();
1583 cwd
= get_current_dir_name ();
1586 /* getwd puts message in STRING if it fails. */
1587 message (TRUE
, "%s: %s\n", progname
,
1588 "Cannot get current working directory");
1596 /* Send over our environment and current directory. */
1599 extern char **environ
;
1601 for (i
= 0; environ
[i
]; i
++)
1603 send_to_emacs (emacs_socket
, "-env ");
1604 quote_argument (emacs_socket
, environ
[i
]);
1605 send_to_emacs (emacs_socket
, " ");
1608 send_to_emacs (emacs_socket
, "-dir ");
1609 quote_argument (emacs_socket
, cwd
);
1610 send_to_emacs (emacs_socket
, "/");
1611 send_to_emacs (emacs_socket
, " ");
1615 send_to_emacs (emacs_socket
, "-nowait ");
1618 send_to_emacs (emacs_socket
, "-current-frame ");
1622 send_to_emacs (emacs_socket
, "-display ");
1623 quote_argument (emacs_socket
, display
);
1624 send_to_emacs (emacs_socket
, " ");
1629 send_to_emacs (emacs_socket
, "-parent-id ");
1630 quote_argument (emacs_socket
, parent_id
);
1631 send_to_emacs (emacs_socket
, " ");
1634 /* If using the current frame, send tty information to Emacs anyway.
1635 In daemon mode, Emacs may need to occupy this tty if no other
1636 frame is available. */
1637 if (tty
|| (current_frame
&& !eval
))
1639 const char *tty_type
, *tty_name
;
1641 if (find_tty (&tty_type
, &tty_name
, !tty
))
1643 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1646 send_to_emacs (emacs_socket
, "-tty ");
1647 quote_argument (emacs_socket
, tty_name
);
1648 send_to_emacs (emacs_socket
, " ");
1649 quote_argument (emacs_socket
, tty_type
);
1650 send_to_emacs (emacs_socket
, " ");
1654 if (!current_frame
&& !tty
)
1655 send_to_emacs (emacs_socket
, "-window-system ");
1657 if ((argc
- optind
> 0))
1660 for (i
= optind
; i
< argc
; i
++)
1665 /* Don't prepend cwd or anything like that. */
1666 send_to_emacs (emacs_socket
, "-eval ");
1667 quote_argument (emacs_socket
, argv
[i
]);
1668 send_to_emacs (emacs_socket
, " ");
1672 if (*argv
[i
] == '+')
1674 char *p
= argv
[i
] + 1;
1675 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1678 send_to_emacs (emacs_socket
, "-position ");
1679 quote_argument (emacs_socket
, argv
[i
]);
1680 send_to_emacs (emacs_socket
, " ");
1685 else if (! file_name_absolute_p (argv
[i
])
1686 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1687 /* Windows can have a different default directory for each
1688 drive, so the cwd passed via "-dir" is not sufficient
1689 to account for that.
1690 If the user uses <drive>:<relpath>, we hence need to be
1691 careful to expand <relpath> with the default directory
1692 corresponding to <drive>. */
1694 char *filename
= (char *) xmalloc (MAX_PATH
);
1697 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1698 if (size
> 0 && size
< MAX_PATH
)
1705 send_to_emacs (emacs_socket
, "-file ");
1706 quote_argument (emacs_socket
, argv
[i
]);
1707 send_to_emacs (emacs_socket
, " ");
1712 /* Read expressions interactively. */
1713 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1715 send_to_emacs (emacs_socket
, "-eval ");
1716 quote_argument (emacs_socket
, str
);
1718 send_to_emacs (emacs_socket
, " ");
1721 send_to_emacs (emacs_socket
, "\n");
1723 /* Wait for an answer. */
1724 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1726 printf ("Waiting for Emacs...");
1732 /* Now, wait for an answer and print any messages. */
1733 while (exit_status
== EXIT_SUCCESS
)
1739 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1741 /* If we receive a signal (e.g. SIGWINCH, which we pass
1742 through to Emacs), on some OSes we get EINTR and must retry. */
1743 while (rl
< 0 && errno
== EINTR
);
1750 p
= string
+ strlen (string
) - 1;
1751 while (p
> string
&& *p
== '\n')
1754 if (strprefix ("-emacs-pid ", string
))
1756 /* -emacs-pid PID: The process id of the Emacs process. */
1757 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1759 else if (strprefix ("-window-system-unsupported ", string
))
1761 /* -window-system-unsupported: Emacs was compiled without X
1762 support. Try again on the terminal. */
1767 else if (strprefix ("-print ", string
))
1769 /* -print STRING: Print STRING on the terminal. */
1770 str
= unquote_argument (string
+ strlen ("-print "));
1774 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1776 else if (strprefix ("-error ", string
))
1778 /* -error DESCRIPTION: Signal an error on the terminal. */
1779 str
= unquote_argument (string
+ strlen ("-error "));
1782 fprintf (stderr
, "*ERROR*: %s", str
);
1783 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1784 exit_status
= EXIT_FAILURE
;
1787 else if (strprefix ("-suspend ", string
))
1789 /* -suspend: Suspend this terminal, i.e., stop the process. */
1798 /* Unknown command. */
1801 printf ("*ERROR*: Unknown message: %s", string
);
1803 == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1813 exit_status
= EXIT_FAILURE
;
1815 CLOSE_SOCKET (emacs_socket
);
1819 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1822 #ifndef HAVE_STRERROR
1827 extern char *sys_errlist
[];
1828 extern int sys_nerr
;
1830 if (errnum
>= 0 && errnum
< sys_nerr
)
1831 return sys_errlist
[errnum
];
1832 return (char *) "Unknown error";
1835 #endif /* ! HAVE_STRERROR */
1838 /* emacsclient.c ends here */