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. */
490 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
492 message (int is_error
, const char *format
, ...)
497 va_start (args
, format
);
498 vsprintf (msg
, format
, args
);
502 if (w32_window_app ())
505 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
507 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
512 FILE *f
= is_error
? stderr
: stdout
;
519 /* Decode the options from argv and argc.
520 The global variable `optind' will say how many arguments we used up. */
523 decode_options (int argc
, char **argv
)
525 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
529 int opt
= getopt_long_only (argc
, argv
,
530 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
543 /* If getopt returns 0, then it has already processed a
544 long-named option. We should do nothing. */
548 alternate_editor
= optarg
;
551 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
553 socket_name
= optarg
;
558 server_file
= optarg
;
561 /* We used to disallow this argument in w32, but it seems better
562 to allow it, for the occasional case where the user is
563 connecting with a w32 client to a server compiled with X11
582 message (FALSE
, "emacsclient %s\n", VERSION
);
601 print_help_and_exit ();
605 message (TRUE
, "Try `%s --help' for more information\n", progname
);
611 /* If the -c option is used (without -t) and no --display argument
612 is provided, try $DISPLAY.
613 Without the -c option, we used to set `display' to $DISPLAY by
614 default, but this changed the default behavior and is sometimes
615 inconvenient. So we force users to use "--display $DISPLAY" if
616 they want Emacs to connect to their current display. */
617 if (!current_frame
&& !tty
&& !display
)
619 display
= egetenv ("DISPLAY");
621 /* Under Cocoa, we don't really use displays the same way as in X,
622 so provide a dummy. */
623 if (!display
|| strlen (display
) == 0)
628 /* A null-string display is invalid. */
629 if (display
&& strlen (display
) == 0)
632 /* If no display is available, new frames are tty frames. */
633 if (!current_frame
&& !display
)
636 /* --no-wait implies --current-frame on ttys when there are file
637 arguments or expressions given. */
638 if (nowait
&& tty
&& argc
- optind
> 0)
642 if (alternate_editor
&& alternate_editor
[0] == '\0')
644 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
648 #endif /* WINDOWSNT */
653 print_help_and_exit (void)
655 /* Spaces and tabs are significant in this message; they're chosen so the
656 message aligns properly both in a tty and in a Windows message box.
657 Please try to preserve them; otherwise the output is very hard to read
658 when using emacsclientw. */
660 "Usage: %s [OPTIONS] FILE...\n\
661 Tell the Emacs server to visit the specified files.\n\
662 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
664 The following OPTIONS are accepted:\n\
665 -V, --version Just print version info and return\n\
666 -H, --help Print this usage information message\n\
667 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
668 -c, --create-frame Create a new frame instead of trying to\n\
669 use the current Emacs frame\n\
670 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
671 -n, --no-wait Don't wait for the server to return\n\
672 -q, --quiet Don't display messages on success\n\
673 -d DISPLAY, --display=DISPLAY\n\
674 Visit the file in the given display\n\
675 --parent-id=ID Open in parent window ID, via XEmbed\n"
676 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
677 "-s SOCKET, --socket-name=SOCKET\n\
678 Set filename of the UNIX socket for communication\n"
680 "-f SERVER, --server-file=SERVER\n\
681 Set filename of the TCP authentication file\n\
682 -a EDITOR, --alternate-editor=EDITOR\n\
683 Editor to fallback to if the server is not running\n"
685 " If EDITOR is the empty string, start Emacs in daemon\n\
686 mode and try connecting again\n"
687 #endif /* not WINDOWSNT */
689 Report bugs with M-x report-emacs-bug.\n", progname
);
694 Try to run a different command, or --if no alternate editor is
695 defined-- exit with an errorcode.
696 Uses argv, but gets it from the global variable main_argv.
701 if (alternate_editor
)
705 execvp (alternate_editor
, main_argv
+ i
);
706 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
707 progname
, alternate_editor
);
713 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
716 main (int argc
, char **argv
)
720 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
721 "on systems with Berkeley sockets.\n",
726 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
728 #define AUTH_KEY_LENGTH 64
729 #define SEND_BUFFER_SIZE 4096
731 extern char *strerror (int);
733 /* Buffer to accumulate data to send in TCP connections. */
734 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
735 int sblen
= 0; /* Fill pointer for the send buffer. */
736 /* Socket used to communicate with the Emacs server process. */
737 HSOCKET emacs_socket
= 0;
739 /* On Windows, the socket library was historically separate from the standard
740 C library, so errors are handled differently. */
742 sock_err_message (const char *function_name
)
747 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
748 | FORMAT_MESSAGE_ALLOCATE_BUFFER
749 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
750 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
752 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
756 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
761 /* Let's send the data to Emacs when either
762 - the data ends in "\n", or
763 - the buffer is full (but this shouldn't happen)
764 Otherwise, we just accumulate it. */
766 send_to_emacs (HSOCKET s
, const char *data
)
770 size_t dlen
= strlen (data
);
771 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
773 int part
= SEND_BUFFER_SIZE
- sblen
;
774 strncpy (&send_buffer
[sblen
], data
, part
);
776 sblen
= SEND_BUFFER_SIZE
;
780 strcpy (&send_buffer
[sblen
], data
);
787 if (sblen
== SEND_BUFFER_SIZE
788 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
790 int sent
= send (s
, send_buffer
, sblen
, 0);
792 strcpy (send_buffer
, &send_buffer
[sent
]);
799 /* In STR, insert a & before each &, each space, each newline, and
800 any initial -. Change spaces to underscores, too, so that the
801 return value never contains a space.
803 Does not change the string. Outputs the result to S. */
805 quote_argument (HSOCKET s
, const char *str
)
807 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
829 if (*p
== '&' || (*p
== '-' && p
== str
))
836 send_to_emacs (s
, copy
);
842 /* The inverse of quote_argument. Removes quoting in string STR by
843 modifying the string in place. Returns STR. */
846 unquote_argument (char *str
)
877 file_name_absolute_p (const char *filename
)
879 /* Sanity check, it shouldn't happen. */
880 if (! filename
) return FALSE
;
882 /* /xxx is always an absolute path. */
883 if (filename
[0] == '/') return TRUE
;
885 /* Empty filenames (which shouldn't happen) are relative. */
886 if (filename
[0] == '\0') return FALSE
;
889 /* X:\xxx is always absolute. */
890 if (isalpha ((unsigned char) filename
[0])
891 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
894 /* Both \xxx and \\xxx\yyy are absolute. */
895 if (filename
[0] == '\\') return TRUE
;
902 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
909 /* Initialize the WinSock2 library. */
911 initialize_sockets (void)
915 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
917 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
921 atexit (close_winsock
);
923 #endif /* WINDOWSNT */
927 * Read the information needed to set up a TCP comm channel with
928 * the Emacs server: host, port, and authentication string.
931 get_server_config (struct sockaddr_in
*server
, char *authentication
)
937 if (file_name_absolute_p (server_file
))
938 config
= fopen (server_file
, "rb");
941 const char *home
= egetenv ("HOME");
945 char *path
= alloca (strlen (home
) + strlen (server_file
)
947 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
948 config
= fopen (path
, "rb");
951 if (!config
&& (home
= egetenv ("APPDATA")))
953 char *path
= alloca (strlen (home
) + strlen (server_file
)
955 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
956 config
= fopen (path
, "rb");
964 if (fgets (dotted
, sizeof dotted
, config
)
965 && (port
= strchr (dotted
, ':')))
969 message (TRUE
, "%s: invalid configuration info\n", progname
);
973 server
->sin_family
= AF_INET
;
974 server
->sin_addr
.s_addr
= inet_addr (dotted
);
975 server
->sin_port
= htons (atoi (port
));
977 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
979 message (TRUE
, "%s: cannot read authentication info\n", progname
);
989 set_tcp_socket (void)
992 struct sockaddr_in server
;
993 struct linger l_arg
= {1, 1};
994 char auth_string
[AUTH_KEY_LENGTH
+ 1];
996 if (! get_server_config (&server
, auth_string
))
997 return INVALID_SOCKET
;
999 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1000 message (FALSE
, "%s: connected to remote socket at %s\n",
1001 progname
, inet_ntoa (server
.sin_addr
));
1004 * Open up an AF_INET socket
1006 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1008 sock_err_message ("socket");
1009 return INVALID_SOCKET
;
1015 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1017 sock_err_message ("connect");
1018 return INVALID_SOCKET
;
1021 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1024 * Send the authentication
1026 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1028 send_to_emacs (s
, "-auth ");
1029 send_to_emacs (s
, auth_string
);
1030 send_to_emacs (s
, " ");
1036 /* Returns 1 if PREFIX is a prefix of STRING. */
1038 strprefix (const char *prefix
, const char *string
)
1040 return !strncmp (prefix
, string
, strlen (prefix
));
1043 /* Get tty name and type. If successful, return the type in TTY_TYPE
1044 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1045 is zero, or return 0 if NOABORT is non-zero. */
1048 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1050 const char *type
= egetenv ("TERM");
1051 const char *name
= ttyname (fileno (stdout
));
1059 message (TRUE
, "%s: could not get terminal name\n", progname
);
1070 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1076 if (strcmp (type
, "eterm") == 0)
1082 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1083 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1084 " is not supported\n", progname
);
1095 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1097 /* Three possibilities:
1098 2 - can't be `stat'ed (sets errno)
1099 1 - isn't owned by us
1100 0 - success: none of the above */
1103 socket_status (char *name
)
1105 struct stat statbfr
;
1107 if (stat (name
, &statbfr
) == -1)
1110 if (statbfr
.st_uid
!= geteuid ())
1117 /* A signal handler that passes the signal to the Emacs process.
1118 Useful for SIGWINCH. */
1121 pass_signal_to_emacs (int signalnum
)
1123 int old_errno
= errno
;
1126 kill (emacs_pid
, signalnum
);
1128 signal (signalnum
, pass_signal_to_emacs
);
1132 /* Signal handler for SIGCONT; notify the Emacs process that it can
1133 now resume our tty frame. */
1136 handle_sigcont (int signalnum
)
1138 int old_errno
= errno
;
1140 if (tcgetpgrp (1) == getpgrp ())
1142 /* We are in the foreground. */
1143 send_to_emacs (emacs_socket
, "-resume \n");
1147 /* We are in the background; cancel the continue. */
1148 kill (getpid (), SIGSTOP
);
1151 signal (signalnum
, handle_sigcont
);
1155 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1156 going to sleep. Normally the suspend is initiated by Emacs via
1157 server-handle-suspend-tty, but if the server gets out of sync with
1158 reality, we may get a SIGTSTP on C-z. Handling this signal and
1159 notifying Emacs about it should get things under control again. */
1162 handle_sigtstp (int signalnum
)
1164 int old_errno
= errno
;
1168 send_to_emacs (emacs_socket
, "-suspend \n");
1170 /* Unblock this signal and call the default handler by temporarily
1171 changing the handler and resignalling. */
1172 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1173 sigdelset (&set
, signalnum
);
1174 signal (signalnum
, SIG_DFL
);
1175 kill (getpid (), signalnum
);
1176 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1177 signal (signalnum
, handle_sigtstp
);
1183 /* Set up signal handlers before opening a frame on the current tty. */
1188 /* Set up signal handlers. */
1189 signal (SIGWINCH
, pass_signal_to_emacs
);
1191 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1192 deciding which terminal the signal came from. C-g is now a
1193 normal input event on secondary terminals. */
1195 signal (SIGINT
, pass_signal_to_emacs
);
1196 signal (SIGQUIT
, pass_signal_to_emacs
);
1199 signal (SIGCONT
, handle_sigcont
);
1200 signal (SIGTSTP
, handle_sigtstp
);
1201 signal (SIGTTOU
, handle_sigtstp
);
1206 set_local_socket (void)
1209 struct sockaddr_un server
;
1212 * Open up an AF_UNIX socket in this person's home directory
1215 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1217 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1218 return INVALID_SOCKET
;
1221 server
.sun_family
= AF_UNIX
;
1224 int sock_status
= 0;
1225 int default_sock
= !socket_name
;
1226 int saved_errno
= 0;
1227 const char *server_name
= "server";
1228 const char *tmpdir
IF_LINT ( = NULL
);
1230 if (socket_name
&& !strchr (socket_name
, '/')
1231 && !strchr (socket_name
, '\\'))
1233 /* socket_name is a file name component. */
1234 server_name
= socket_name
;
1236 default_sock
= 1; /* Try both UIDs. */
1241 tmpdir
= egetenv ("TMPDIR");
1245 #ifndef _CS_DARWIN_USER_TEMP_DIR
1246 #define _CS_DARWIN_USER_TEMP_DIR 65537
1248 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1251 tmpdir
= alloca (n
);
1252 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir
, n
);
1258 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1260 sprintf (socket_name
, "%s/emacs%d/%s",
1261 tmpdir
, (int) geteuid (), server_name
);
1264 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1265 strcpy (server
.sun_path
, socket_name
);
1268 message (TRUE
, "%s: socket-name %s too long\n",
1269 progname
, socket_name
);
1273 /* See if the socket exists, and if it's owned by us. */
1274 sock_status
= socket_status (server
.sun_path
);
1275 saved_errno
= errno
;
1276 if (sock_status
&& default_sock
)
1278 /* Failing that, see if LOGNAME or USER exist and differ from
1279 our euid. If so, look for a socket based on the UID
1280 associated with the name. This is reminiscent of the logic
1281 that init_editfns uses to set the global Vuser_full_name. */
1283 const char *user_name
= egetenv ("LOGNAME");
1286 user_name
= egetenv ("USER");
1290 struct passwd
*pw
= getpwnam (user_name
);
1292 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1294 /* We're running under su, apparently. */
1295 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1297 sprintf (socket_name
, "%s/emacs%d/%s",
1298 tmpdir
, (int) pw
->pw_uid
, server_name
);
1300 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1301 strcpy (server
.sun_path
, socket_name
);
1304 message (TRUE
, "%s: socket-name %s too long\n",
1305 progname
, socket_name
);
1306 exit (EXIT_FAILURE
);
1309 sock_status
= socket_status (server
.sun_path
);
1310 saved_errno
= errno
;
1313 errno
= saved_errno
;
1317 switch (sock_status
)
1320 /* There's a socket, but it isn't owned by us. This is OK if
1322 if (0 != geteuid ())
1324 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1325 return INVALID_SOCKET
;
1331 if (saved_errno
== ENOENT
)
1333 "%s: can't find socket; have you started the server?\n\
1334 To start the server in Emacs, type \"M-x server-start\".\n",
1337 message (TRUE
, "%s: can't stat %s: %s\n",
1338 progname
, server
.sun_path
, strerror (saved_errno
));
1339 return INVALID_SOCKET
;
1343 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1346 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1347 return INVALID_SOCKET
;
1352 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1355 set_socket (int no_exit_if_error
)
1361 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1362 /* Explicit --socket-name argument. */
1365 s
= set_local_socket ();
1366 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1368 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1369 progname
, socket_name
);
1370 exit (EXIT_FAILURE
);
1374 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1376 server_file
= egetenv ("EMACS_SERVER_FILE");
1380 s
= set_tcp_socket ();
1381 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1384 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1385 progname
, server_file
);
1386 exit (EXIT_FAILURE
);
1389 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1390 /* Implicit local socket. */
1391 s
= set_local_socket ();
1392 if (s
!= INVALID_SOCKET
)
1396 /* Implicit server file. */
1397 server_file
= "server";
1398 s
= set_tcp_socket ();
1399 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1402 /* No implicit or explicit socket, and no alternate editor. */
1403 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1404 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1407 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1408 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1410 exit (EXIT_FAILURE
);
1414 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1415 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1418 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1423 /* Reject any window not of class "Emacs". */
1424 if (! get_wc (hWnd
, class, sizeof (class))
1425 || strcmp (class, "Emacs"))
1428 /* We only need the process id, not the thread id. */
1429 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1431 /* Not the one we're looking for. */
1432 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1434 /* OK, let's raise it. */
1437 /* Stop enumeration. */
1442 * Search for a window of class "Emacs" and owned by a process with
1443 * process id = emacs_pid. If found, allow it to grab the focus.
1446 w32_give_focus (void)
1450 /* It shouldn't happen when dealing with TCP sockets. */
1451 if (!emacs_pid
) return;
1453 user32
= GetModuleHandle ("user32.dll");
1458 /* Modern Windows restrict which processes can set the foreground window.
1459 emacsclient can allow Emacs to grab the focus by calling the function
1460 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1461 NT) lack this function, so we have to check its availability. */
1462 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1463 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1464 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1468 /* Start the emacs daemon and try to connect to it. */
1471 start_daemon_and_retry_set_socket (void)
1482 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1484 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1486 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1487 exit (EXIT_FAILURE
);
1490 /* Try connecting, the daemon should have started by now. */
1491 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1492 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1494 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1495 exit (EXIT_FAILURE
);
1500 fprintf (stderr
, "Error: Cannot fork!\n");
1501 exit (EXIT_FAILURE
);
1505 char emacs
[] = "emacs";
1506 char daemon_option
[] = "--daemon";
1507 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1508 if (socket_name
!= NULL
)
1510 /* Pass --daemon=socket_name as argument. */
1511 const char *deq
= "--daemon=";
1512 char *daemon_arg
= alloca (strlen (deq
)
1513 + strlen (socket_name
) + 1);
1514 strcpy (daemon_arg
, deq
);
1515 strcat (daemon_arg
, socket_name
);
1516 d_argv
[1] = daemon_arg
;
1518 execvp ("emacs", d_argv
);
1519 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1521 #endif /* WINDOWSNT */
1525 main (int argc
, char **argv
)
1529 char string
[BUFSIZ
+1];
1530 int null_socket_name
IF_LINT ( = 0);
1531 int null_server_file
IF_LINT ( = 0);
1532 int start_daemon_if_needed
;
1533 int exit_status
= EXIT_SUCCESS
;
1539 /* On Windows 7 and later, we need to explicitly associate emacsclient
1540 with emacs so the UI behaves sensibly. */
1541 w32_set_user_model_id ();
1544 /* Process options. */
1545 decode_options (argc
, argv
);
1547 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1549 message (TRUE
, "%s: file name or argument required\n"
1550 "Try `%s --help' for more information\n",
1551 progname
, progname
);
1552 exit (EXIT_FAILURE
);
1555 /* If alternate_editor is the empty string, start the emacs daemon
1556 in case of failure to connect. */
1557 start_daemon_if_needed
= (alternate_editor
1558 && (alternate_editor
[0] == '\0'));
1559 if (start_daemon_if_needed
)
1561 /* set_socket changes the values for socket_name and
1562 server_file, we need to reset them, if they were NULL before
1563 for the second call to set_socket. */
1564 null_socket_name
= (socket_name
== NULL
);
1565 null_server_file
= (server_file
== NULL
);
1568 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1569 if (emacs_socket
== INVALID_SOCKET
)
1571 if (! start_daemon_if_needed
)
1574 /* Reset socket_name and server_file if they were NULL
1575 before the set_socket call. */
1576 if (null_socket_name
)
1578 if (null_server_file
)
1581 start_daemon_and_retry_set_socket ();
1584 cwd
= get_current_dir_name ();
1587 /* getwd puts message in STRING if it fails. */
1588 message (TRUE
, "%s: %s\n", progname
,
1589 "Cannot get current working directory");
1597 /* Send over our environment and current directory. */
1600 extern char **environ
;
1602 for (i
= 0; environ
[i
]; i
++)
1604 send_to_emacs (emacs_socket
, "-env ");
1605 quote_argument (emacs_socket
, environ
[i
]);
1606 send_to_emacs (emacs_socket
, " ");
1609 send_to_emacs (emacs_socket
, "-dir ");
1610 quote_argument (emacs_socket
, cwd
);
1611 send_to_emacs (emacs_socket
, "/");
1612 send_to_emacs (emacs_socket
, " ");
1616 send_to_emacs (emacs_socket
, "-nowait ");
1619 send_to_emacs (emacs_socket
, "-current-frame ");
1623 send_to_emacs (emacs_socket
, "-display ");
1624 quote_argument (emacs_socket
, display
);
1625 send_to_emacs (emacs_socket
, " ");
1630 send_to_emacs (emacs_socket
, "-parent-id ");
1631 quote_argument (emacs_socket
, parent_id
);
1632 send_to_emacs (emacs_socket
, " ");
1635 /* If using the current frame, send tty information to Emacs anyway.
1636 In daemon mode, Emacs may need to occupy this tty if no other
1637 frame is available. */
1638 if (tty
|| (current_frame
&& !eval
))
1640 const char *tty_type
, *tty_name
;
1642 if (find_tty (&tty_type
, &tty_name
, !tty
))
1644 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1647 send_to_emacs (emacs_socket
, "-tty ");
1648 quote_argument (emacs_socket
, tty_name
);
1649 send_to_emacs (emacs_socket
, " ");
1650 quote_argument (emacs_socket
, tty_type
);
1651 send_to_emacs (emacs_socket
, " ");
1655 if (!current_frame
&& !tty
)
1656 send_to_emacs (emacs_socket
, "-window-system ");
1658 if ((argc
- optind
> 0))
1661 for (i
= optind
; i
< argc
; i
++)
1666 /* Don't prepend cwd or anything like that. */
1667 send_to_emacs (emacs_socket
, "-eval ");
1668 quote_argument (emacs_socket
, argv
[i
]);
1669 send_to_emacs (emacs_socket
, " ");
1673 if (*argv
[i
] == '+')
1675 char *p
= argv
[i
] + 1;
1676 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1679 send_to_emacs (emacs_socket
, "-position ");
1680 quote_argument (emacs_socket
, argv
[i
]);
1681 send_to_emacs (emacs_socket
, " ");
1686 else if (! file_name_absolute_p (argv
[i
])
1687 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1688 /* Windows can have a different default directory for each
1689 drive, so the cwd passed via "-dir" is not sufficient
1690 to account for that.
1691 If the user uses <drive>:<relpath>, we hence need to be
1692 careful to expand <relpath> with the default directory
1693 corresponding to <drive>. */
1695 char *filename
= (char *) xmalloc (MAX_PATH
);
1698 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1699 if (size
> 0 && size
< MAX_PATH
)
1706 send_to_emacs (emacs_socket
, "-file ");
1707 quote_argument (emacs_socket
, argv
[i
]);
1708 send_to_emacs (emacs_socket
, " ");
1713 /* Read expressions interactively. */
1714 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1716 send_to_emacs (emacs_socket
, "-eval ");
1717 quote_argument (emacs_socket
, str
);
1719 send_to_emacs (emacs_socket
, " ");
1722 send_to_emacs (emacs_socket
, "\n");
1724 /* Wait for an answer. */
1725 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1727 printf ("Waiting for Emacs...");
1733 /* Now, wait for an answer and print any messages. */
1734 while (exit_status
== EXIT_SUCCESS
)
1740 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1742 /* If we receive a signal (e.g. SIGWINCH, which we pass
1743 through to Emacs), on some OSes we get EINTR and must retry. */
1744 while (rl
< 0 && errno
== EINTR
);
1751 p
= string
+ strlen (string
) - 1;
1752 while (p
> string
&& *p
== '\n')
1755 if (strprefix ("-emacs-pid ", string
))
1757 /* -emacs-pid PID: The process id of the Emacs process. */
1758 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1760 else if (strprefix ("-window-system-unsupported ", string
))
1762 /* -window-system-unsupported: Emacs was compiled without X
1763 support. Try again on the terminal. */
1768 else if (strprefix ("-print ", string
))
1770 /* -print STRING: Print STRING on the terminal. */
1771 str
= unquote_argument (string
+ strlen ("-print "));
1775 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1777 else if (strprefix ("-error ", string
))
1779 /* -error DESCRIPTION: Signal an error on the terminal. */
1780 str
= unquote_argument (string
+ strlen ("-error "));
1783 fprintf (stderr
, "*ERROR*: %s", str
);
1784 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1785 exit_status
= EXIT_FAILURE
;
1788 else if (strprefix ("-suspend ", string
))
1790 /* -suspend: Suspend this terminal, i.e., stop the process. */
1799 /* Unknown command. */
1802 printf ("*ERROR*: Unknown message: %s", string
);
1804 == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1814 exit_status
= EXIT_FAILURE
;
1816 CLOSE_SOCKET (emacs_socket
);
1820 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1823 #ifndef HAVE_STRERROR
1828 extern char *sys_errlist
[];
1829 extern int sys_nerr
;
1831 if (errnum
>= 0 && errnum
< sys_nerr
)
1832 return sys_errlist
[errnum
];
1833 return (char *) "Unknown error";
1836 #endif /* ! HAVE_STRERROR */
1839 /* emacsclient.c ends here */