1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986-1987, 1994, 1999-2012 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 /* ms-w32.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 */
125 #define min(x, y) (((x) < (y)) ? (x) : (y))
128 /* Name used to invoke this program. */
129 const char *progname
;
131 /* The second argument to main. */
134 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
137 /* Nonzero means don't print messages for successful operations. --quiet. */
140 /* Nonzero means args are expressions to be evaluated. --eval. */
143 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
144 int current_frame
= 1;
146 /* The display on which Emacs should work. --display. */
147 const char *display
= NULL
;
149 /* The parent window ID, if we are opening a frame via XEmbed. */
150 char *parent_id
= NULL
;
152 /* Nonzero means open a new Emacs frame on the current terminal. */
155 /* If non-NULL, the name of an editor to fallback to if the server
156 is not running. --alternate-editor. */
157 const char *alternate_editor
= NULL
;
159 /* If non-NULL, the filename of the UNIX socket. */
160 const char *socket_name
= NULL
;
162 /* If non-NULL, the filename of the authentication file. */
163 const char *server_file
= NULL
;
165 /* PID of the Emacs server process. */
168 /* If non-NULL, a string that should form a frame parameter alist to
169 be used for the new frame */
170 const char *frame_parameters
= NULL
;
172 static _Noreturn
void print_help_and_exit (void);
175 struct option longopts
[] =
177 { "no-wait", no_argument
, NULL
, 'n' },
178 { "quiet", no_argument
, NULL
, 'q' },
179 { "eval", no_argument
, NULL
, 'e' },
180 { "help", no_argument
, NULL
, 'H' },
181 { "version", no_argument
, NULL
, 'V' },
182 { "tty", no_argument
, NULL
, 't' },
183 { "nw", no_argument
, NULL
, 't' },
184 { "create-frame", no_argument
, NULL
, 'c' },
185 { "alternate-editor", required_argument
, NULL
, 'a' },
186 { "frame-parameters", required_argument
, NULL
, 'F' },
187 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
188 { "socket-name", required_argument
, NULL
, 's' },
190 { "server-file", required_argument
, NULL
, 'f' },
192 { "display", required_argument
, NULL
, 'd' },
194 { "parent-id", required_argument
, NULL
, 'p' },
199 /* Like malloc but get fatal error if memory is exhausted. */
202 xmalloc (size_t size
)
204 void *result
= malloc (size
);
214 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
217 #ifndef DIRECTORY_SEP
218 #define DIRECTORY_SEP '/'
220 #ifndef IS_DIRECTORY_SEP
221 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
223 #ifndef IS_DEVICE_SEP
225 #define IS_DEVICE_SEP(_c_) 0
227 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
231 char *get_current_dir_name (void);
233 /* Return the current working directory. Returns NULL on errors.
234 Any other returned value must be freed with free. This is used
235 only when get_current_dir_name is not defined on the system. */
237 get_current_dir_name (void)
241 struct stat dotstat
, pwdstat
;
242 /* If PWD is accurate, use it instead of calling getwd. PWD is
243 sometimes a nicer name, and using it may avoid a fatal error if a
244 parent directory is searchable but not readable. */
245 if ((pwd
= egetenv ("PWD")) != 0
246 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
247 && stat (pwd
, &pwdstat
) == 0
248 && stat (".", &dotstat
) == 0
249 && dotstat
.st_ino
== pwdstat
.st_ino
250 && dotstat
.st_dev
== pwdstat
.st_dev
252 && strlen (pwd
) < MAXPATHLEN
256 buf
= (char *) xmalloc (strlen (pwd
) + 1);
262 size_t buf_size
= 1024;
266 buf
= malloc (buf_size
);
269 if (getcwd (buf
, buf_size
) == buf
)
273 if (tmp_errno
!= ERANGE
)
289 /* We need MAXPATHLEN here. */
290 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
291 if (getwd (buf
) == NULL
)
293 int tmp_errno
= errno
;
306 /* Like strdup but get a fatal error if memory is exhausted. */
309 xstrdup (const char *s
)
311 char *result
= strdup (s
);
320 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
322 /* Retrieve an environment variable from the Emacs subkeys of the registry.
323 Return NULL if the variable was not found, or it was empty.
324 This code is based on w32_get_resource (w32.c). */
326 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
328 HKEY hrootkey
= NULL
;
332 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
334 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
336 result
= (char *) xmalloc (cbData
);
338 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
346 RegCloseKey (hrootkey
);
353 getenv wrapper for Windows
355 Value is allocated on the heap, and can be free'd.
357 This is needed to duplicate Emacs's behavior, which is to look for
358 environment variables in the registry if they don't appear in the
361 w32_getenv (char *envvar
)
366 if ((value
= getenv (envvar
)))
367 /* Found in the environment. strdup it, because values returned
368 by getenv cannot be free'd. */
369 return xstrdup (value
);
371 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
372 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
374 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
375 if (strcmp (envvar
, "TERM") == 0)
376 return xstrdup ("w32console");
377 /* Found neither in the environment nor in the registry. */
381 if (dwType
== REG_SZ
)
382 /* Registry; no need to expand. */
385 if (dwType
== REG_EXPAND_SZ
)
389 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
391 char *buffer
= (char *) xmalloc (size
);
392 if (ExpandEnvironmentStrings (value
, buffer
, size
))
394 /* Found and expanded. */
399 /* Error expanding. */
404 /* Not the right type, or not correctly expanded. */
410 w32_set_user_model_id (void)
413 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
415 /* On Windows 7 and later, we need to set the user model ID
416 to associate emacsclient launched files with Emacs frames
418 shell
= LoadLibrary ("shell32.dll");
422 = (void *) GetProcAddress (shell
,
423 "SetCurrentProcessExplicitAppUserModelID");
424 /* If the function is defined, then we are running on Windows 7
425 or newer, and the UI uses this to group related windows
426 together. Since emacs, runemacs, emacsclient are related, we
427 want them grouped even though the executables are different,
428 so we need to set a consistent ID between them. */
430 set_user_model (L
"GNU.Emacs");
437 w32_window_app (void)
439 static int window_app
= -1;
440 char szTitle
[MAX_PATH
];
444 /* Checking for STDOUT does not work; it's a valid handle also in
445 nonconsole apps. Testing for the console title seems to work. */
446 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
448 InitCommonControls ();
454 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
456 This is necessary due to the broken implementation of exec* routines in
457 the Microsoft libraries: they concatenate the arguments together without
458 quoting special characters, and pass the result to CreateProcess, with
459 predictably bad results. By contrast, POSIX execvp passes the arguments
460 directly into the argv array of the child process. */
463 w32_execvp (const char *path
, char **argv
)
466 extern int execvp (const char*, char **);
468 /* Required to allow a .BAT script as alternate editor. */
469 argv
[0] = (char *) alternate_editor
;
471 for (i
= 0; argv
[i
]; i
++)
472 if (strchr (argv
[i
], ' '))
474 char *quoted
= alloca (strlen (argv
[i
]) + 3);
475 sprintf (quoted
, "\"%s\"", argv
[i
]);
479 return execvp (path
, argv
);
483 #define execvp w32_execvp
485 /* Emulation of ttyname for Windows. */
492 #endif /* WINDOWSNT */
494 /* Display a normal or error message.
495 On Windows, use a message box if compiled as a Windows app. */
496 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
498 message (int is_error
, const char *format
, ...)
502 va_start (args
, format
);
505 if (w32_window_app ())
508 vsnprintf (msg
, sizeof msg
, format
, args
);
509 msg
[sizeof msg
- 1] = '\0';
512 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
514 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
519 FILE *f
= is_error
? stderr
: stdout
;
521 vfprintf (f
, format
, args
);
528 /* Decode the options from argv and argc.
529 The global variable `optind' will say how many arguments we used up. */
532 decode_options (int argc
, char **argv
)
534 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
538 int opt
= getopt_long_only (argc
, argv
,
539 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
552 /* If getopt returns 0, then it has already processed a
553 long-named option. We should do nothing. */
557 alternate_editor
= optarg
;
560 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
562 socket_name
= optarg
;
567 server_file
= optarg
;
570 /* We used to disallow this argument in w32, but it seems better
571 to allow it, for the occasional case where the user is
572 connecting with a w32 client to a server compiled with X11
591 message (FALSE
, "emacsclient %s\n", VERSION
);
610 print_help_and_exit ();
614 frame_parameters
= optarg
;
618 message (TRUE
, "Try `%s --help' for more information\n", progname
);
624 /* If the -c option is used (without -t) and no --display argument
625 is provided, try $DISPLAY.
626 Without the -c option, we used to set `display' to $DISPLAY by
627 default, but this changed the default behavior and is sometimes
628 inconvenient. So we force users to use "--display $DISPLAY" if
629 they want Emacs to connect to their current display. */
630 if (!current_frame
&& !tty
&& !display
)
632 display
= egetenv ("DISPLAY");
634 /* Under Cocoa, we don't really use displays the same way as in X,
635 so provide a dummy. */
636 if (!display
|| strlen (display
) == 0)
641 /* A null-string display is invalid. */
642 if (display
&& strlen (display
) == 0)
645 /* If no display is available, new frames are tty frames. */
646 if (!current_frame
&& !display
)
650 /* Emacs on Windows does not support graphical and text terminal
651 frames in the same instance. So, treat the -t and -c options as
652 equivalent, and open a new frame on the server's terminal.
653 Ideally, we would only set tty = 1 when the serve is running in a
654 console, but alas we don't know that. As a workaround, always
655 ask for a tty frame, and let server.el figure it out. */
662 if (alternate_editor
&& alternate_editor
[0] == '\0')
664 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
668 #endif /* WINDOWSNT */
672 static _Noreturn
void
673 print_help_and_exit (void)
675 /* Spaces and tabs are significant in this message; they're chosen so the
676 message aligns properly both in a tty and in a Windows message box.
677 Please try to preserve them; otherwise the output is very hard to read
678 when using emacsclientw. */
680 "Usage: %s [OPTIONS] FILE...\n\
681 Tell the Emacs server to visit the specified files.\n\
682 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
684 The following OPTIONS are accepted:\n\
685 -V, --version Just print version info and return\n\
686 -H, --help Print this usage information message\n\
687 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
688 -c, --create-frame Create a new frame instead of trying to\n\
689 use the current Emacs frame\n\
690 -F ALIST, --frame-parameters=ALIST\n\
691 Set the parameters of a new frame\n\
692 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
693 -n, --no-wait Don't wait for the server to return\n\
694 -q, --quiet Don't display messages on success\n\
695 -d DISPLAY, --display=DISPLAY\n\
696 Visit the file in the given display\n\
697 --parent-id=ID Open in parent window ID, via XEmbed\n"
698 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
699 "-s SOCKET, --socket-name=SOCKET\n\
700 Set filename of the UNIX socket for communication\n"
702 "-f SERVER, --server-file=SERVER\n\
703 Set filename of the TCP authentication file\n\
704 -a EDITOR, --alternate-editor=EDITOR\n\
705 Editor to fallback to if the server is not running\n"
707 " If EDITOR is the empty string, start Emacs in daemon\n\
708 mode and try connecting again\n"
709 #endif /* not WINDOWSNT */
711 Report bugs with M-x report-emacs-bug.\n", progname
);
715 /* Try to run a different command, or --if no alternate editor is
716 defined-- exit with an errorcode.
717 Uses argv, but gets it from the global variable main_argv. */
719 static _Noreturn
void
722 if (alternate_editor
)
726 execvp (alternate_editor
, main_argv
+ i
);
727 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
728 progname
, alternate_editor
);
734 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
737 main (int argc
, char **argv
)
741 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
742 "on systems with Berkeley sockets.\n",
747 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
749 #define AUTH_KEY_LENGTH 64
750 #define SEND_BUFFER_SIZE 4096
752 extern char *strerror (int);
754 /* Buffer to accumulate data to send in TCP connections. */
755 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
756 int sblen
= 0; /* Fill pointer for the send buffer. */
757 /* Socket used to communicate with the Emacs server process. */
758 HSOCKET emacs_socket
= 0;
760 /* On Windows, the socket library was historically separate from the
761 standard C library, so errors are handled differently. */
764 sock_err_message (const char *function_name
)
769 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
770 | FORMAT_MESSAGE_ALLOCATE_BUFFER
771 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
772 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
774 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
778 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
783 /* Let's send the data to Emacs when either
784 - the data ends in "\n", or
785 - the buffer is full (but this shouldn't happen)
786 Otherwise, we just accumulate it. */
788 send_to_emacs (HSOCKET s
, const char *data
)
795 dlen
= strlen (data
);
798 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
799 memcpy (&send_buffer
[sblen
], data
, part
);
803 if (sblen
== SEND_BUFFER_SIZE
804 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
806 int sent
= send (s
, send_buffer
, sblen
, 0);
809 message (TRUE
, "%s: failed to send %d bytes to socket: %s\n",
810 progname
, sblen
, strerror (errno
));
814 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
823 /* In STR, insert a & before each &, each space, each newline, and
824 any initial -. Change spaces to underscores, too, so that the
825 return value never contains a space.
827 Does not change the string. Outputs the result to S. */
829 quote_argument (HSOCKET s
, const char *str
)
831 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
853 if (*p
== '&' || (*p
== '-' && p
== str
))
860 send_to_emacs (s
, copy
);
866 /* The inverse of quote_argument. Removes quoting in string STR by
867 modifying the string in place. Returns STR. */
870 unquote_argument (char *str
)
901 file_name_absolute_p (const char *filename
)
903 /* Sanity check, it shouldn't happen. */
904 if (! filename
) return FALSE
;
906 /* /xxx is always an absolute path. */
907 if (filename
[0] == '/') return TRUE
;
909 /* Empty filenames (which shouldn't happen) are relative. */
910 if (filename
[0] == '\0') return FALSE
;
913 /* X:\xxx is always absolute. */
914 if (isalpha ((unsigned char) filename
[0])
915 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
918 /* Both \xxx and \\xxx\yyy are absolute. */
919 if (filename
[0] == '\\') return TRUE
;
926 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
933 /* Initialize the WinSock2 library. */
935 initialize_sockets (void)
939 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
941 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
945 atexit (close_winsock
);
947 #endif /* WINDOWSNT */
950 /* Read the information needed to set up a TCP comm channel with
951 the Emacs server: host, port, and authentication string. */
954 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
955 char *authentication
)
961 if (file_name_absolute_p (config_file
))
962 config
= fopen (config_file
, "rb");
965 const char *home
= egetenv ("HOME");
969 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
972 strcat (path
, "/.emacs.d/server/");
973 strcat (path
, config_file
);
974 config
= fopen (path
, "rb");
978 if (!config
&& (home
= egetenv ("APPDATA")))
980 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
983 strcat (path
, "/.emacs.d/server/");
984 strcat (path
, config_file
);
985 config
= fopen (path
, "rb");
994 if (fgets (dotted
, sizeof dotted
, config
)
995 && (port
= strchr (dotted
, ':')))
999 message (TRUE
, "%s: invalid configuration info\n", progname
);
1000 exit (EXIT_FAILURE
);
1003 server
->sin_family
= AF_INET
;
1004 server
->sin_addr
.s_addr
= inet_addr (dotted
);
1005 server
->sin_port
= htons (atoi (port
));
1007 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
1009 message (TRUE
, "%s: cannot read authentication info\n", progname
);
1010 exit (EXIT_FAILURE
);
1019 set_tcp_socket (const char *local_server_file
)
1022 struct sockaddr_in server
;
1023 struct linger l_arg
= {1, 1};
1024 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1026 if (! get_server_config (local_server_file
, &server
, auth_string
))
1027 return INVALID_SOCKET
;
1029 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1030 message (FALSE
, "%s: connected to remote socket at %s\n",
1031 progname
, inet_ntoa (server
.sin_addr
));
1033 /* Open up an AF_INET socket. */
1034 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1036 sock_err_message ("socket");
1037 return INVALID_SOCKET
;
1040 /* Set up the socket. */
1041 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1043 sock_err_message ("connect");
1044 return INVALID_SOCKET
;
1047 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1049 /* Send the authentication. */
1050 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1052 send_to_emacs (s
, "-auth ");
1053 send_to_emacs (s
, auth_string
);
1054 send_to_emacs (s
, " ");
1060 /* Returns 1 if PREFIX is a prefix of STRING. */
1062 strprefix (const char *prefix
, const char *string
)
1064 return !strncmp (prefix
, string
, strlen (prefix
));
1067 /* Get tty name and type. If successful, return the type in TTY_TYPE
1068 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1069 is zero, or return 0 if NOABORT is non-zero. */
1072 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1074 const char *type
= egetenv ("TERM");
1075 const char *name
= ttyname (fileno (stdout
));
1083 message (TRUE
, "%s: could not get terminal name\n", progname
);
1094 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1100 if (strcmp (type
, "eterm") == 0)
1106 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1107 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1108 " is not supported\n", progname
);
1119 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1121 /* Three possibilities:
1122 2 - can't be `stat'ed (sets errno)
1123 1 - isn't owned by us
1124 0 - success: none of the above */
1127 socket_status (const char *name
)
1129 struct stat statbfr
;
1131 if (stat (name
, &statbfr
) == -1)
1134 if (statbfr
.st_uid
!= geteuid ())
1141 /* A signal handler that passes the signal to the Emacs process.
1142 Useful for SIGWINCH. */
1145 pass_signal_to_emacs (int signalnum
)
1147 int old_errno
= errno
;
1150 kill (emacs_pid
, signalnum
);
1152 signal (signalnum
, pass_signal_to_emacs
);
1156 /* Signal handler for SIGCONT; notify the Emacs process that it can
1157 now resume our tty frame. */
1160 handle_sigcont (int signalnum
)
1162 int old_errno
= errno
;
1164 if (tcgetpgrp (1) == getpgrp ())
1166 /* We are in the foreground. */
1167 send_to_emacs (emacs_socket
, "-resume \n");
1171 /* We are in the background; cancel the continue. */
1172 kill (getpid (), SIGSTOP
);
1175 signal (signalnum
, handle_sigcont
);
1179 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1180 going to sleep. Normally the suspend is initiated by Emacs via
1181 server-handle-suspend-tty, but if the server gets out of sync with
1182 reality, we may get a SIGTSTP on C-z. Handling this signal and
1183 notifying Emacs about it should get things under control again. */
1186 handle_sigtstp (int signalnum
)
1188 int old_errno
= errno
;
1192 send_to_emacs (emacs_socket
, "-suspend \n");
1194 /* Unblock this signal and call the default handler by temporarily
1195 changing the handler and resignaling. */
1196 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1197 sigdelset (&set
, signalnum
);
1198 signal (signalnum
, SIG_DFL
);
1199 kill (getpid (), signalnum
);
1200 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1201 signal (signalnum
, handle_sigtstp
);
1207 /* Set up signal handlers before opening a frame on the current tty. */
1212 /* Set up signal handlers. */
1213 signal (SIGWINCH
, pass_signal_to_emacs
);
1215 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1216 deciding which terminal the signal came from. C-g is now a
1217 normal input event on secondary terminals. */
1219 signal (SIGINT
, pass_signal_to_emacs
);
1220 signal (SIGQUIT
, pass_signal_to_emacs
);
1223 signal (SIGCONT
, handle_sigcont
);
1224 signal (SIGTSTP
, handle_sigtstp
);
1225 signal (SIGTTOU
, handle_sigtstp
);
1230 set_local_socket (const char *local_socket_name
)
1233 struct sockaddr_un server
;
1235 /* Open up an AF_UNIX socket in this person's home directory. */
1236 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1238 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1239 return INVALID_SOCKET
;
1242 server
.sun_family
= AF_UNIX
;
1248 const char *server_name
= local_socket_name
;
1249 const char *tmpdir
IF_LINT ( = NULL
);
1250 char *tmpdir_storage
= NULL
;
1251 char *socket_name_storage
= NULL
;
1253 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1255 /* socket_name is a file name component. */
1256 long uid
= geteuid ();
1257 ptrdiff_t tmpdirlen
;
1259 tmpdir
= egetenv ("TMPDIR");
1263 #ifndef _CS_DARWIN_USER_TEMP_DIR
1264 #define _CS_DARWIN_USER_TEMP_DIR 65537
1266 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1269 tmpdir
= tmpdir_storage
= xmalloc (n
);
1270 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1276 tmpdirlen
= strlen (tmpdir
);
1277 socket_name_storage
=
1278 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1279 strcpy (socket_name_storage
, tmpdir
);
1280 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1281 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1282 local_socket_name
= socket_name_storage
;
1285 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1286 strcpy (server
.sun_path
, local_socket_name
);
1289 message (TRUE
, "%s: socket-name %s too long\n",
1290 progname
, local_socket_name
);
1294 /* See if the socket exists, and if it's owned by us. */
1295 sock_status
= socket_status (server
.sun_path
);
1296 saved_errno
= errno
;
1297 if (sock_status
&& use_tmpdir
)
1299 /* Failing that, see if LOGNAME or USER exist and differ from
1300 our euid. If so, look for a socket based on the UID
1301 associated with the name. This is reminiscent of the logic
1302 that init_editfns uses to set the global Vuser_full_name. */
1304 const char *user_name
= egetenv ("LOGNAME");
1307 user_name
= egetenv ("USER");
1311 struct passwd
*pw
= getpwnam (user_name
);
1313 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1315 /* We're running under su, apparently. */
1316 long uid
= pw
->pw_uid
;
1317 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1318 char *user_socket_name
1319 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1320 strcpy (user_socket_name
, tmpdir
);
1321 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1322 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1324 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1325 strcpy (server
.sun_path
, user_socket_name
);
1328 message (TRUE
, "%s: socket-name %s too long\n",
1329 progname
, user_socket_name
);
1330 exit (EXIT_FAILURE
);
1332 free (user_socket_name
);
1334 sock_status
= socket_status (server
.sun_path
);
1335 saved_errno
= errno
;
1338 errno
= saved_errno
;
1342 free (socket_name_storage
);
1343 free (tmpdir_storage
);
1345 switch (sock_status
)
1348 /* There's a socket, but it isn't owned by us. This is OK if
1350 if (0 != geteuid ())
1352 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1353 return INVALID_SOCKET
;
1359 if (saved_errno
== ENOENT
)
1361 "%s: can't find socket; have you started the server?\n\
1362 To start the server in Emacs, type \"M-x server-start\".\n",
1365 message (TRUE
, "%s: can't stat %s: %s\n",
1366 progname
, server
.sun_path
, strerror (saved_errno
));
1367 return INVALID_SOCKET
;
1371 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1374 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1375 return INVALID_SOCKET
;
1380 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1383 set_socket (int no_exit_if_error
)
1386 const char *local_server_file
= server_file
;
1390 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1391 /* Explicit --socket-name argument. */
1394 s
= set_local_socket (socket_name
);
1395 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1397 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1398 progname
, socket_name
);
1399 exit (EXIT_FAILURE
);
1403 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1404 if (!local_server_file
)
1405 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1407 if (local_server_file
)
1409 s
= set_tcp_socket (local_server_file
);
1410 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1413 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1414 progname
, local_server_file
);
1415 exit (EXIT_FAILURE
);
1418 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1419 /* Implicit local socket. */
1420 s
= set_local_socket ("server");
1421 if (s
!= INVALID_SOCKET
)
1425 /* Implicit server file. */
1426 s
= set_tcp_socket ("server");
1427 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1430 /* No implicit or explicit socket, and no alternate editor. */
1431 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1432 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1435 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1436 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1438 exit (EXIT_FAILURE
);
1442 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1443 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1446 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1451 /* Reject any window not of class "Emacs". */
1452 if (! get_wc (hWnd
, class, sizeof (class))
1453 || strcmp (class, "Emacs"))
1456 /* We only need the process id, not the thread id. */
1457 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1459 /* Not the one we're looking for. */
1460 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1462 /* OK, let's raise it. */
1465 /* Stop enumeration. */
1469 /* Search for a window of class "Emacs" and owned by a process with
1470 process id = emacs_pid. If found, allow it to grab the focus. */
1473 w32_give_focus (void)
1477 /* It shouldn't happen when dealing with TCP sockets. */
1478 if (!emacs_pid
) return;
1480 user32
= GetModuleHandle ("user32.dll");
1485 /* Modern Windows restrict which processes can set the foreground window.
1486 emacsclient can allow Emacs to grab the focus by calling the function
1487 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1488 NT) lack this function, so we have to check its availability. */
1489 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1490 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1491 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1495 /* Start the emacs daemon and try to connect to it. */
1498 start_daemon_and_retry_set_socket (void)
1509 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1511 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1513 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1514 exit (EXIT_FAILURE
);
1517 /* Try connecting, the daemon should have started by now. */
1518 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1519 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1521 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1522 exit (EXIT_FAILURE
);
1527 fprintf (stderr
, "Error: Cannot fork!\n");
1528 exit (EXIT_FAILURE
);
1532 char emacs
[] = "emacs";
1533 char daemon_option
[] = "--daemon";
1534 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1535 if (socket_name
!= NULL
)
1537 /* Pass --daemon=socket_name as argument. */
1538 const char *deq
= "--daemon=";
1539 char *daemon_arg
= xmalloc (strlen (deq
)
1540 + strlen (socket_name
) + 1);
1541 strcpy (daemon_arg
, deq
);
1542 strcat (daemon_arg
, socket_name
);
1543 d_argv
[1] = daemon_arg
;
1545 execvp ("emacs", d_argv
);
1546 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1548 #endif /* WINDOWSNT */
1552 main (int argc
, char **argv
)
1554 int rl
= 0, needlf
= 0;
1556 char string
[BUFSIZ
+1];
1557 int start_daemon_if_needed
;
1558 int exit_status
= EXIT_SUCCESS
;
1564 /* On Windows 7 and later, we need to explicitly associate emacsclient
1565 with emacs so the UI behaves sensibly. */
1566 w32_set_user_model_id ();
1569 /* Process options. */
1570 decode_options (argc
, argv
);
1572 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1574 message (TRUE
, "%s: file name or argument required\n"
1575 "Try `%s --help' for more information\n",
1576 progname
, progname
);
1577 exit (EXIT_FAILURE
);
1580 /* If alternate_editor is the empty string, start the emacs daemon
1581 in case of failure to connect. */
1582 start_daemon_if_needed
= (alternate_editor
1583 && (alternate_editor
[0] == '\0'));
1585 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1586 if (emacs_socket
== INVALID_SOCKET
)
1588 if (! start_daemon_if_needed
)
1591 start_daemon_and_retry_set_socket ();
1594 cwd
= get_current_dir_name ();
1597 /* getwd puts message in STRING if it fails. */
1598 message (TRUE
, "%s: %s\n", progname
,
1599 "Cannot get current working directory");
1607 /* Send over our environment and current directory. */
1611 /* This is defined in stdlib.h on MS-Windows. It's defined in
1612 unistd.h on some POSIX hosts, but not all (Bug#10155). */
1613 extern char **environ
;
1616 for (i
= 0; environ
[i
]; i
++)
1618 send_to_emacs (emacs_socket
, "-env ");
1619 quote_argument (emacs_socket
, environ
[i
]);
1620 send_to_emacs (emacs_socket
, " ");
1623 send_to_emacs (emacs_socket
, "-dir ");
1624 quote_argument (emacs_socket
, cwd
);
1625 send_to_emacs (emacs_socket
, "/");
1626 send_to_emacs (emacs_socket
, " ");
1630 send_to_emacs (emacs_socket
, "-nowait ");
1633 send_to_emacs (emacs_socket
, "-current-frame ");
1637 send_to_emacs (emacs_socket
, "-display ");
1638 quote_argument (emacs_socket
, display
);
1639 send_to_emacs (emacs_socket
, " ");
1644 send_to_emacs (emacs_socket
, "-parent-id ");
1645 quote_argument (emacs_socket
, parent_id
);
1646 send_to_emacs (emacs_socket
, " ");
1649 if (frame_parameters
&& !current_frame
)
1651 send_to_emacs (emacs_socket
, "-frame-parameters ");
1652 quote_argument (emacs_socket
, frame_parameters
);
1653 send_to_emacs (emacs_socket
, " ");
1656 /* Unless we are certain we don't want to occupy the tty, send our
1657 tty information to Emacs. For example, in daemon mode Emacs may
1658 need to occupy this tty if no other frame is available. */
1659 if (!current_frame
|| !eval
)
1661 const char *tty_type
, *tty_name
;
1663 if (find_tty (&tty_type
, &tty_name
, !tty
))
1665 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1668 send_to_emacs (emacs_socket
, "-tty ");
1669 quote_argument (emacs_socket
, tty_name
);
1670 send_to_emacs (emacs_socket
, " ");
1671 quote_argument (emacs_socket
, tty_type
);
1672 send_to_emacs (emacs_socket
, " ");
1676 if (!current_frame
&& !tty
)
1677 send_to_emacs (emacs_socket
, "-window-system ");
1679 if ((argc
- optind
> 0))
1682 for (i
= optind
; i
< argc
; i
++)
1687 /* Don't prepend cwd or anything like that. */
1688 send_to_emacs (emacs_socket
, "-eval ");
1689 quote_argument (emacs_socket
, argv
[i
]);
1690 send_to_emacs (emacs_socket
, " ");
1694 if (*argv
[i
] == '+')
1696 char *p
= argv
[i
] + 1;
1697 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1700 send_to_emacs (emacs_socket
, "-position ");
1701 quote_argument (emacs_socket
, argv
[i
]);
1702 send_to_emacs (emacs_socket
, " ");
1707 else if (! file_name_absolute_p (argv
[i
])
1708 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1709 /* Windows can have a different default directory for each
1710 drive, so the cwd passed via "-dir" is not sufficient
1711 to account for that.
1712 If the user uses <drive>:<relpath>, we hence need to be
1713 careful to expand <relpath> with the default directory
1714 corresponding to <drive>. */
1716 char *filename
= (char *) xmalloc (MAX_PATH
);
1719 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1720 if (size
> 0 && size
< MAX_PATH
)
1727 send_to_emacs (emacs_socket
, "-file ");
1728 quote_argument (emacs_socket
, argv
[i
]);
1729 send_to_emacs (emacs_socket
, " ");
1734 /* Read expressions interactively. */
1735 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1737 send_to_emacs (emacs_socket
, "-eval ");
1738 quote_argument (emacs_socket
, str
);
1740 send_to_emacs (emacs_socket
, " ");
1743 send_to_emacs (emacs_socket
, "\n");
1745 /* Wait for an answer. */
1746 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1748 printf ("Waiting for Emacs...");
1754 /* Now, wait for an answer and print any messages. */
1755 while (exit_status
== EXIT_SUCCESS
)
1761 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1763 /* If we receive a signal (e.g. SIGWINCH, which we pass
1764 through to Emacs), on some OSes we get EINTR and must retry. */
1765 while (rl
< 0 && errno
== EINTR
);
1772 /* Loop over all NL-terminated messages. */
1773 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1775 end_p
= strchr (p
, '\n');
1779 if (strprefix ("-emacs-pid ", p
))
1781 /* -emacs-pid PID: The process id of the Emacs process. */
1782 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1784 else if (strprefix ("-window-system-unsupported ", p
))
1786 /* -window-system-unsupported: Emacs was compiled without X
1787 support. Try again on the terminal. */
1792 else if (strprefix ("-print ", p
))
1794 /* -print STRING: Print STRING on the terminal. */
1795 str
= unquote_argument (p
+ strlen ("-print "));
1799 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1801 else if (strprefix ("-print-nonl ", p
))
1803 /* -print-nonl STRING: Print STRING on the terminal.
1804 Used to continue a preceding -print command. */
1805 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1807 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1809 else if (strprefix ("-error ", p
))
1811 /* -error DESCRIPTION: Signal an error on the terminal. */
1812 str
= unquote_argument (p
+ strlen ("-error "));
1815 fprintf (stderr
, "*ERROR*: %s", str
);
1816 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1817 exit_status
= EXIT_FAILURE
;
1820 else if (strprefix ("-suspend ", p
))
1822 /* -suspend: Suspend this terminal, i.e., stop the process. */
1831 /* Unknown command. */
1835 printf ("*ERROR*: Unknown message: %s\n", p
);
1846 exit_status
= EXIT_FAILURE
;
1848 CLOSE_SOCKET (emacs_socket
);
1852 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1855 #ifndef HAVE_STRERROR
1860 extern char *sys_errlist
[];
1861 extern int sys_nerr
;
1863 if (errnum
>= 0 && errnum
< sys_nerr
)
1864 return sys_errlist
[errnum
];
1865 return (char *) "Unknown error";
1868 #endif /* ! HAVE_STRERROR */
1871 /* emacsclient.c ends here */