1 /* Client process that communicates with GNU Emacs acting as server.
3 Copyright (C) 1986-1987, 1994, 1999-2012 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 /* ms-w32.h defines these, which disables sockets altogether! */
32 # include <commctrl.h>
34 # include <winsock2.h>
36 # define NO_SOCKETS_IN_FILE_SYSTEM
38 # define HSOCKET SOCKET
39 # define CLOSE_SOCKET closesocket
40 # define INITIALIZE() (initialize_sockets ())
42 char *w32_getenv (char *);
43 #define egetenv(VAR) w32_getenv(VAR)
45 #else /* !WINDOWSNT */
49 # ifdef HAVE_INET_SOCKETS
50 # include <netinet/in.h>
52 # include <sys/types.h>
53 # include <sys/socket.h>
55 # endif /* HAVE_SOCKETS */
57 # include <arpa/inet.h>
59 # define INVALID_SOCKET -1
61 # define CLOSE_SOCKET close
68 #define egetenv(VAR) getenv(VAR)
70 #endif /* !WINDOWSNT */
87 char *getenv (const char *), *getwd (char *);
89 char *(getcwd
) (char *, size_t);
93 #define VERSION "unspecified"
98 #define EXIT_SUCCESS 0
102 #define EXIT_FAILURE 1
113 /* Additional space when allocating buffers for filenames, etc. */
114 #define EXTRA_SPACE 100
116 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
118 # define IF_LINT(Code) Code
120 # define IF_LINT(Code) /* empty */
126 #define min(x, y) (((x) < (y)) ? (x) : (y))
129 /* Name used to invoke this program. */
130 const char *progname
;
132 /* The second argument to main. */
135 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
138 /* Nonzero means don't print messages for successful operations. --quiet. */
141 /* Nonzero means args are expressions to be evaluated. --eval. */
144 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
145 int current_frame
= 1;
147 /* The display on which Emacs should work. --display. */
148 const char *display
= NULL
;
150 /* The parent window ID, if we are opening a frame via XEmbed. */
151 char *parent_id
= NULL
;
153 /* Nonzero means open a new Emacs frame on the current terminal. */
156 /* If non-NULL, the name of an editor to fallback to if the server
157 is not running. --alternate-editor. */
158 const char *alternate_editor
= NULL
;
160 /* If non-NULL, the filename of the UNIX socket. */
161 const char *socket_name
= NULL
;
163 /* If non-NULL, the filename of the authentication file. */
164 const char *server_file
= NULL
;
166 /* PID of the Emacs server process. */
169 /* If non-NULL, a string that should form a frame parameter alist to
170 be used for the new frame */
171 const char *frame_parameters
= NULL
;
173 static _Noreturn
void print_help_and_exit (void);
176 struct option longopts
[] =
178 { "no-wait", no_argument
, NULL
, 'n' },
179 { "quiet", no_argument
, NULL
, 'q' },
180 { "eval", no_argument
, NULL
, 'e' },
181 { "help", no_argument
, NULL
, 'H' },
182 { "version", no_argument
, NULL
, 'V' },
183 { "tty", no_argument
, NULL
, 't' },
184 { "nw", no_argument
, NULL
, 't' },
185 { "create-frame", no_argument
, NULL
, 'c' },
186 { "alternate-editor", required_argument
, NULL
, 'a' },
187 { "frame-parameters", required_argument
, NULL
, 'F' },
188 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
189 { "socket-name", required_argument
, NULL
, 's' },
191 { "server-file", required_argument
, NULL
, 'f' },
193 { "display", required_argument
, NULL
, 'd' },
195 { "parent-id", required_argument
, NULL
, 'p' },
200 /* Like malloc but get fatal error if memory is exhausted. */
203 xmalloc (size_t size
)
205 void *result
= malloc (size
);
215 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
217 char *get_current_dir_name (void);
219 /* Return the current working directory. Returns NULL on errors.
220 Any other returned value must be freed with free. This is used
221 only when get_current_dir_name is not defined on the system. */
223 get_current_dir_name (void)
227 struct stat dotstat
, pwdstat
;
228 /* If PWD is accurate, use it instead of calling getwd. PWD is
229 sometimes a nicer name, and using it may avoid a fatal error if a
230 parent directory is searchable but not readable. */
231 if ((pwd
= egetenv ("PWD")) != 0
232 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
233 && stat (pwd
, &pwdstat
) == 0
234 && stat (".", &dotstat
) == 0
235 && dotstat
.st_ino
== pwdstat
.st_ino
236 && dotstat
.st_dev
== pwdstat
.st_dev
238 && strlen (pwd
) < MAXPATHLEN
242 buf
= (char *) xmalloc (strlen (pwd
) + 1);
248 size_t buf_size
= 1024;
252 buf
= malloc (buf_size
);
255 if (getcwd (buf
, buf_size
) == buf
)
259 if (tmp_errno
!= ERANGE
)
275 /* We need MAXPATHLEN here. */
276 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
277 if (getwd (buf
) == NULL
)
279 int tmp_errno
= errno
;
292 /* Like strdup but get a fatal error if memory is exhausted. */
295 xstrdup (const char *s
)
297 char *result
= strdup (s
);
306 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
308 /* Retrieve an environment variable from the Emacs subkeys of the registry.
309 Return NULL if the variable was not found, or it was empty.
310 This code is based on w32_get_resource (w32.c). */
312 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
314 HKEY hrootkey
= NULL
;
318 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
320 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
322 result
= (char *) xmalloc (cbData
);
324 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
332 RegCloseKey (hrootkey
);
339 getenv wrapper for Windows
341 Value is allocated on the heap, and can be free'd.
343 This is needed to duplicate Emacs's behavior, which is to look for
344 environment variables in the registry if they don't appear in the
347 w32_getenv (char *envvar
)
352 if ((value
= getenv (envvar
)))
353 /* Found in the environment. strdup it, because values returned
354 by getenv cannot be free'd. */
355 return xstrdup (value
);
357 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
358 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
360 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
361 if (strcmp (envvar
, "TERM") == 0)
362 return xstrdup ("w32console");
363 /* Found neither in the environment nor in the registry. */
367 if (dwType
== REG_SZ
)
368 /* Registry; no need to expand. */
371 if (dwType
== REG_EXPAND_SZ
)
375 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
377 char *buffer
= (char *) xmalloc (size
);
378 if (ExpandEnvironmentStrings (value
, buffer
, size
))
380 /* Found and expanded. */
385 /* Error expanding. */
390 /* Not the right type, or not correctly expanded. */
396 w32_set_user_model_id (void)
399 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
401 /* On Windows 7 and later, we need to set the user model ID
402 to associate emacsclient launched files with Emacs frames
404 shell
= LoadLibrary ("shell32.dll");
408 = (void *) GetProcAddress (shell
,
409 "SetCurrentProcessExplicitAppUserModelID");
410 /* If the function is defined, then we are running on Windows 7
411 or newer, and the UI uses this to group related windows
412 together. Since emacs, runemacs, emacsclient are related, we
413 want them grouped even though the executables are different,
414 so we need to set a consistent ID between them. */
416 set_user_model (L
"GNU.Emacs");
423 w32_window_app (void)
425 static int window_app
= -1;
426 char szTitle
[MAX_PATH
];
430 /* Checking for STDOUT does not work; it's a valid handle also in
431 nonconsole apps. Testing for the console title seems to work. */
432 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
434 InitCommonControls ();
440 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
442 This is necessary due to the broken implementation of exec* routines in
443 the Microsoft libraries: they concatenate the arguments together without
444 quoting special characters, and pass the result to CreateProcess, with
445 predictably bad results. By contrast, POSIX execvp passes the arguments
446 directly into the argv array of the child process. */
449 w32_execvp (const char *path
, char **argv
)
452 extern int execvp (const char*, char **);
454 /* Required to allow a .BAT script as alternate editor. */
455 argv
[0] = (char *) alternate_editor
;
457 for (i
= 0; argv
[i
]; i
++)
458 if (strchr (argv
[i
], ' '))
460 char *quoted
= alloca (strlen (argv
[i
]) + 3);
461 sprintf (quoted
, "\"%s\"", argv
[i
]);
465 return execvp (path
, argv
);
469 #define execvp w32_execvp
471 /* Emulation of ttyname for Windows. */
478 #endif /* WINDOWSNT */
480 /* Display a normal or error message.
481 On Windows, use a message box if compiled as a Windows app. */
482 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
484 message (int is_error
, const char *format
, ...)
488 va_start (args
, format
);
491 if (w32_window_app ())
494 vsnprintf (msg
, sizeof msg
, format
, args
);
495 msg
[sizeof msg
- 1] = '\0';
498 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
500 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
505 FILE *f
= is_error
? stderr
: stdout
;
507 vfprintf (f
, format
, args
);
514 /* Decode the options from argv and argc.
515 The global variable `optind' will say how many arguments we used up. */
518 decode_options (int argc
, char **argv
)
520 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
524 int opt
= getopt_long_only (argc
, argv
,
525 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
538 /* If getopt returns 0, then it has already processed a
539 long-named option. We should do nothing. */
543 alternate_editor
= optarg
;
546 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
548 socket_name
= optarg
;
553 server_file
= optarg
;
556 /* We used to disallow this argument in w32, but it seems better
557 to allow it, for the occasional case where the user is
558 connecting with a w32 client to a server compiled with X11
577 message (FALSE
, "emacsclient %s\n", VERSION
);
596 print_help_and_exit ();
600 frame_parameters
= optarg
;
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
)
636 /* Emacs on Windows does not support graphical and text terminal
637 frames in the same instance. So, treat the -t and -c options as
638 equivalent, and open a new frame on the server's terminal.
639 Ideally, we would only set tty = 1 when the serve is running in a
640 console, but alas we don't know that. As a workaround, always
641 ask for a tty frame, and let server.el figure it out. */
648 if (alternate_editor
&& alternate_editor
[0] == '\0')
650 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
654 #endif /* WINDOWSNT */
658 static _Noreturn
void
659 print_help_and_exit (void)
661 /* Spaces and tabs are significant in this message; they're chosen so the
662 message aligns properly both in a tty and in a Windows message box.
663 Please try to preserve them; otherwise the output is very hard to read
664 when using emacsclientw. */
666 "Usage: %s [OPTIONS] FILE...\n\
667 Tell the Emacs server to visit the specified files.\n\
668 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
670 The following OPTIONS are accepted:\n\
671 -V, --version Just print version info and return\n\
672 -H, --help Print this usage information message\n\
673 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
674 -c, --create-frame Create a new frame instead of trying to\n\
675 use the current Emacs frame\n\
676 -F ALIST, --frame-parameters=ALIST\n\
677 Set the parameters of a new frame\n\
678 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
679 -n, --no-wait Don't wait for the server to return\n\
680 -q, --quiet Don't display messages on success\n\
681 -d DISPLAY, --display=DISPLAY\n\
682 Visit the file in the given display\n\
683 --parent-id=ID Open in parent window ID, via XEmbed\n"
684 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
685 "-s SOCKET, --socket-name=SOCKET\n\
686 Set filename of the UNIX socket for communication\n"
688 "-f SERVER, --server-file=SERVER\n\
689 Set filename of the TCP authentication file\n\
690 -a EDITOR, --alternate-editor=EDITOR\n\
691 Editor to fallback to if the server is not running\n"
693 " If EDITOR is the empty string, start Emacs in daemon\n\
694 mode and try connecting again\n"
695 #endif /* not WINDOWSNT */
697 Report bugs with M-x report-emacs-bug.\n", progname
);
701 /* Try to run a different command, or --if no alternate editor is
702 defined-- exit with an errorcode.
703 Uses argv, but gets it from the global variable main_argv. */
705 static _Noreturn
void
708 if (alternate_editor
)
712 execvp (alternate_editor
, main_argv
+ i
);
713 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
714 progname
, alternate_editor
);
720 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
723 main (int argc
, char **argv
)
727 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
728 "on systems with Berkeley sockets.\n",
733 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
735 #define AUTH_KEY_LENGTH 64
736 #define SEND_BUFFER_SIZE 4096
738 /* Buffer to accumulate data to send in TCP connections. */
739 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
740 int sblen
= 0; /* Fill pointer for the send buffer. */
741 /* Socket used to communicate with the Emacs server process. */
742 HSOCKET emacs_socket
= 0;
744 /* On Windows, the socket library was historically separate from the
745 standard C library, so errors are handled differently. */
748 sock_err_message (const char *function_name
)
753 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
754 | FORMAT_MESSAGE_ALLOCATE_BUFFER
755 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
756 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
758 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
762 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
767 /* Let's send the data to Emacs when either
768 - the data ends in "\n", or
769 - the buffer is full (but this shouldn't happen)
770 Otherwise, we just accumulate it. */
772 send_to_emacs (HSOCKET s
, const char *data
)
779 dlen
= strlen (data
);
782 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
783 memcpy (&send_buffer
[sblen
], data
, part
);
787 if (sblen
== SEND_BUFFER_SIZE
788 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
790 int sent
= send (s
, send_buffer
, sblen
, 0);
793 message (TRUE
, "%s: failed to send %d bytes to socket: %s\n",
794 progname
, sblen
, strerror (errno
));
798 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
807 /* In STR, insert a & before each &, each space, each newline, and
808 any initial -. Change spaces to underscores, too, so that the
809 return value never contains a space.
811 Does not change the string. Outputs the result to S. */
813 quote_argument (HSOCKET s
, const char *str
)
815 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
837 if (*p
== '&' || (*p
== '-' && p
== str
))
844 send_to_emacs (s
, copy
);
850 /* The inverse of quote_argument. Removes quoting in string STR by
851 modifying the string in place. Returns STR. */
854 unquote_argument (char *str
)
885 file_name_absolute_p (const char *filename
)
887 /* Sanity check, it shouldn't happen. */
888 if (! filename
) return FALSE
;
890 /* /xxx is always an absolute path. */
891 if (filename
[0] == '/') return TRUE
;
893 /* Empty filenames (which shouldn't happen) are relative. */
894 if (filename
[0] == '\0') return FALSE
;
897 /* X:\xxx is always absolute. */
898 if (isalpha ((unsigned char) filename
[0])
899 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
902 /* Both \xxx and \\xxx\yyy are absolute. */
903 if (filename
[0] == '\\') return TRUE
;
910 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
917 /* Initialize the WinSock2 library. */
919 initialize_sockets (void)
923 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
925 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
929 atexit (close_winsock
);
931 #endif /* WINDOWSNT */
934 /* Read the information needed to set up a TCP comm channel with
935 the Emacs server: host, port, and authentication string. */
938 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
939 char *authentication
)
945 if (file_name_absolute_p (config_file
))
946 config
= fopen (config_file
, "rb");
949 const char *home
= egetenv ("HOME");
953 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
956 strcat (path
, "/.emacs.d/server/");
957 strcat (path
, config_file
);
958 config
= fopen (path
, "rb");
962 if (!config
&& (home
= egetenv ("APPDATA")))
964 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
967 strcat (path
, "/.emacs.d/server/");
968 strcat (path
, config_file
);
969 config
= fopen (path
, "rb");
978 if (fgets (dotted
, sizeof dotted
, config
)
979 && (port
= strchr (dotted
, ':')))
983 message (TRUE
, "%s: invalid configuration info\n", progname
);
987 server
->sin_family
= AF_INET
;
988 server
->sin_addr
.s_addr
= inet_addr (dotted
);
989 server
->sin_port
= htons (atoi (port
));
991 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
993 message (TRUE
, "%s: cannot read authentication info\n", progname
);
1003 set_tcp_socket (const char *local_server_file
)
1006 struct sockaddr_in server
;
1007 struct linger l_arg
= {1, 1};
1008 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1010 if (! get_server_config (local_server_file
, &server
, auth_string
))
1011 return INVALID_SOCKET
;
1013 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1014 message (FALSE
, "%s: connected to remote socket at %s\n",
1015 progname
, inet_ntoa (server
.sin_addr
));
1017 /* Open up an AF_INET socket. */
1018 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1020 sock_err_message ("socket");
1021 return INVALID_SOCKET
;
1024 /* Set up the socket. */
1025 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1027 sock_err_message ("connect");
1028 return INVALID_SOCKET
;
1031 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1033 /* Send the authentication. */
1034 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1036 send_to_emacs (s
, "-auth ");
1037 send_to_emacs (s
, auth_string
);
1038 send_to_emacs (s
, " ");
1044 /* Returns 1 if PREFIX is a prefix of STRING. */
1046 strprefix (const char *prefix
, const char *string
)
1048 return !strncmp (prefix
, string
, strlen (prefix
));
1051 /* Get tty name and type. If successful, return the type in TTY_TYPE
1052 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1053 is zero, or return 0 if NOABORT is non-zero. */
1056 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1058 const char *type
= egetenv ("TERM");
1059 const char *name
= ttyname (fileno (stdout
));
1067 message (TRUE
, "%s: could not get terminal name\n", progname
);
1078 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1084 if (strcmp (type
, "eterm") == 0)
1090 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1091 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1092 " is not supported\n", progname
);
1103 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1105 /* Three possibilities:
1106 2 - can't be `stat'ed (sets errno)
1107 1 - isn't owned by us
1108 0 - success: none of the above */
1111 socket_status (const char *name
)
1113 struct stat statbfr
;
1115 if (stat (name
, &statbfr
) == -1)
1118 if (statbfr
.st_uid
!= geteuid ())
1125 /* A signal handler that passes the signal to the Emacs process.
1126 Useful for SIGWINCH. */
1129 pass_signal_to_emacs (int signalnum
)
1131 int old_errno
= errno
;
1134 kill (emacs_pid
, signalnum
);
1136 signal (signalnum
, pass_signal_to_emacs
);
1140 /* Signal handler for SIGCONT; notify the Emacs process that it can
1141 now resume our tty frame. */
1144 handle_sigcont (int signalnum
)
1146 int old_errno
= errno
;
1148 if (tcgetpgrp (1) == getpgrp ())
1150 /* We are in the foreground. */
1151 send_to_emacs (emacs_socket
, "-resume \n");
1155 /* We are in the background; cancel the continue. */
1156 kill (getpid (), SIGSTOP
);
1159 signal (signalnum
, handle_sigcont
);
1163 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1164 going to sleep. Normally the suspend is initiated by Emacs via
1165 server-handle-suspend-tty, but if the server gets out of sync with
1166 reality, we may get a SIGTSTP on C-z. Handling this signal and
1167 notifying Emacs about it should get things under control again. */
1170 handle_sigtstp (int signalnum
)
1172 int old_errno
= errno
;
1176 send_to_emacs (emacs_socket
, "-suspend \n");
1178 /* Unblock this signal and call the default handler by temporarily
1179 changing the handler and resignaling. */
1180 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1181 sigdelset (&set
, signalnum
);
1182 signal (signalnum
, SIG_DFL
);
1183 kill (getpid (), signalnum
);
1184 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1185 signal (signalnum
, handle_sigtstp
);
1191 /* Set up signal handlers before opening a frame on the current tty. */
1196 /* Set up signal handlers. */
1197 signal (SIGWINCH
, pass_signal_to_emacs
);
1199 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1200 deciding which terminal the signal came from. C-g is now a
1201 normal input event on secondary terminals. */
1203 signal (SIGINT
, pass_signal_to_emacs
);
1204 signal (SIGQUIT
, pass_signal_to_emacs
);
1207 signal (SIGCONT
, handle_sigcont
);
1208 signal (SIGTSTP
, handle_sigtstp
);
1209 signal (SIGTTOU
, handle_sigtstp
);
1214 set_local_socket (const char *local_socket_name
)
1217 struct sockaddr_un server
;
1219 /* Open up an AF_UNIX socket in this person's home directory. */
1220 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1222 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1223 return INVALID_SOCKET
;
1226 server
.sun_family
= AF_UNIX
;
1232 const char *server_name
= local_socket_name
;
1233 const char *tmpdir
IF_LINT ( = NULL
);
1234 char *tmpdir_storage
= NULL
;
1235 char *socket_name_storage
= NULL
;
1237 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1239 /* socket_name is a file name component. */
1240 long uid
= geteuid ();
1241 ptrdiff_t tmpdirlen
;
1243 tmpdir
= egetenv ("TMPDIR");
1247 #ifndef _CS_DARWIN_USER_TEMP_DIR
1248 #define _CS_DARWIN_USER_TEMP_DIR 65537
1250 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1253 tmpdir
= tmpdir_storage
= xmalloc (n
);
1254 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1260 tmpdirlen
= strlen (tmpdir
);
1261 socket_name_storage
=
1262 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1263 strcpy (socket_name_storage
, tmpdir
);
1264 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1265 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1266 local_socket_name
= socket_name_storage
;
1269 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1270 strcpy (server
.sun_path
, local_socket_name
);
1273 message (TRUE
, "%s: socket-name %s too long\n",
1274 progname
, local_socket_name
);
1278 /* See if the socket exists, and if it's owned by us. */
1279 sock_status
= socket_status (server
.sun_path
);
1280 saved_errno
= errno
;
1281 if (sock_status
&& use_tmpdir
)
1283 /* Failing that, see if LOGNAME or USER exist and differ from
1284 our euid. If so, look for a socket based on the UID
1285 associated with the name. This is reminiscent of the logic
1286 that init_editfns uses to set the global Vuser_full_name. */
1288 const char *user_name
= egetenv ("LOGNAME");
1291 user_name
= egetenv ("USER");
1295 struct passwd
*pw
= getpwnam (user_name
);
1297 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1299 /* We're running under su, apparently. */
1300 long uid
= pw
->pw_uid
;
1301 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1302 char *user_socket_name
1303 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1304 strcpy (user_socket_name
, tmpdir
);
1305 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1306 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1308 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1309 strcpy (server
.sun_path
, user_socket_name
);
1312 message (TRUE
, "%s: socket-name %s too long\n",
1313 progname
, user_socket_name
);
1314 exit (EXIT_FAILURE
);
1316 free (user_socket_name
);
1318 sock_status
= socket_status (server
.sun_path
);
1319 saved_errno
= errno
;
1322 errno
= saved_errno
;
1326 free (socket_name_storage
);
1327 free (tmpdir_storage
);
1329 switch (sock_status
)
1332 /* There's a socket, but it isn't owned by us. This is OK if
1334 if (0 != geteuid ())
1336 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1337 return INVALID_SOCKET
;
1343 if (saved_errno
== ENOENT
)
1345 "%s: can't find socket; have you started the server?\n\
1346 To start the server in Emacs, type \"M-x server-start\".\n",
1349 message (TRUE
, "%s: can't stat %s: %s\n",
1350 progname
, server
.sun_path
, strerror (saved_errno
));
1351 return INVALID_SOCKET
;
1355 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1358 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1359 return INVALID_SOCKET
;
1364 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1367 set_socket (int no_exit_if_error
)
1370 const char *local_server_file
= server_file
;
1374 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1375 /* Explicit --socket-name argument. */
1378 s
= set_local_socket (socket_name
);
1379 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1381 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1382 progname
, socket_name
);
1383 exit (EXIT_FAILURE
);
1387 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1388 if (!local_server_file
)
1389 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1391 if (local_server_file
)
1393 s
= set_tcp_socket (local_server_file
);
1394 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1397 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1398 progname
, local_server_file
);
1399 exit (EXIT_FAILURE
);
1402 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1403 /* Implicit local socket. */
1404 s
= set_local_socket ("server");
1405 if (s
!= INVALID_SOCKET
)
1409 /* Implicit server file. */
1410 s
= set_tcp_socket ("server");
1411 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1414 /* No implicit or explicit socket, and no alternate editor. */
1415 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1416 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1419 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1420 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1422 exit (EXIT_FAILURE
);
1426 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1427 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1430 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1435 /* Reject any window not of class "Emacs". */
1436 if (! get_wc (hWnd
, class, sizeof (class))
1437 || strcmp (class, "Emacs"))
1440 /* We only need the process id, not the thread id. */
1441 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1443 /* Not the one we're looking for. */
1444 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1446 /* OK, let's raise it. */
1449 /* Stop enumeration. */
1453 /* Search for a window of class "Emacs" and owned by a process with
1454 process id = emacs_pid. If found, allow it to grab the focus. */
1457 w32_give_focus (void)
1461 /* It shouldn't happen when dealing with TCP sockets. */
1462 if (!emacs_pid
) return;
1464 user32
= GetModuleHandle ("user32.dll");
1469 /* Modern Windows restrict which processes can set the foreground window.
1470 emacsclient can allow Emacs to grab the focus by calling the function
1471 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1472 NT) lack this function, so we have to check its availability. */
1473 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1474 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1475 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1479 /* Start the emacs daemon and try to connect to it. */
1482 start_daemon_and_retry_set_socket (void)
1493 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1495 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1497 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1498 exit (EXIT_FAILURE
);
1501 /* Try connecting, the daemon should have started by now. */
1502 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1503 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1505 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1506 exit (EXIT_FAILURE
);
1511 fprintf (stderr
, "Error: Cannot fork!\n");
1512 exit (EXIT_FAILURE
);
1516 char emacs
[] = "emacs";
1517 char daemon_option
[] = "--daemon";
1518 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1519 if (socket_name
!= NULL
)
1521 /* Pass --daemon=socket_name as argument. */
1522 const char *deq
= "--daemon=";
1523 char *daemon_arg
= xmalloc (strlen (deq
)
1524 + strlen (socket_name
) + 1);
1525 strcpy (daemon_arg
, deq
);
1526 strcat (daemon_arg
, socket_name
);
1527 d_argv
[1] = daemon_arg
;
1529 execvp ("emacs", d_argv
);
1530 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1532 #endif /* WINDOWSNT */
1536 main (int argc
, char **argv
)
1538 int rl
= 0, needlf
= 0;
1540 char string
[BUFSIZ
+1];
1541 int start_daemon_if_needed
;
1542 int exit_status
= EXIT_SUCCESS
;
1548 /* On Windows 7 and later, we need to explicitly associate emacsclient
1549 with emacs so the UI behaves sensibly. */
1550 w32_set_user_model_id ();
1553 /* Process options. */
1554 decode_options (argc
, argv
);
1556 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1558 message (TRUE
, "%s: file name or argument required\n"
1559 "Try `%s --help' for more information\n",
1560 progname
, progname
);
1561 exit (EXIT_FAILURE
);
1564 /* If alternate_editor is the empty string, start the emacs daemon
1565 in case of failure to connect. */
1566 start_daemon_if_needed
= (alternate_editor
1567 && (alternate_editor
[0] == '\0'));
1569 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1570 if (emacs_socket
== INVALID_SOCKET
)
1572 if (! start_daemon_if_needed
)
1575 start_daemon_and_retry_set_socket ();
1578 cwd
= get_current_dir_name ();
1581 /* getwd puts message in STRING if it fails. */
1582 message (TRUE
, "%s: %s\n", progname
,
1583 "Cannot get current working directory");
1591 /* Send over our environment and current directory. */
1595 /* This is defined in stdlib.h on MS-Windows. It's defined in
1596 unistd.h on some POSIX hosts, but not all (Bug#10155). */
1597 extern char **environ
;
1600 for (i
= 0; environ
[i
]; i
++)
1602 send_to_emacs (emacs_socket
, "-env ");
1603 quote_argument (emacs_socket
, environ
[i
]);
1604 send_to_emacs (emacs_socket
, " ");
1607 send_to_emacs (emacs_socket
, "-dir ");
1608 quote_argument (emacs_socket
, cwd
);
1609 send_to_emacs (emacs_socket
, "/");
1610 send_to_emacs (emacs_socket
, " ");
1614 send_to_emacs (emacs_socket
, "-nowait ");
1617 send_to_emacs (emacs_socket
, "-current-frame ");
1621 send_to_emacs (emacs_socket
, "-display ");
1622 quote_argument (emacs_socket
, display
);
1623 send_to_emacs (emacs_socket
, " ");
1628 send_to_emacs (emacs_socket
, "-parent-id ");
1629 quote_argument (emacs_socket
, parent_id
);
1630 send_to_emacs (emacs_socket
, " ");
1633 if (frame_parameters
&& !current_frame
)
1635 send_to_emacs (emacs_socket
, "-frame-parameters ");
1636 quote_argument (emacs_socket
, frame_parameters
);
1637 send_to_emacs (emacs_socket
, " ");
1640 /* Unless we are certain we don't want to occupy the tty, send our
1641 tty information to Emacs. For example, in daemon mode Emacs may
1642 need to occupy this tty if no other frame is available. */
1643 if (!current_frame
|| !eval
)
1645 const char *tty_type
, *tty_name
;
1647 if (find_tty (&tty_type
, &tty_name
, !tty
))
1649 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1652 send_to_emacs (emacs_socket
, "-tty ");
1653 quote_argument (emacs_socket
, tty_name
);
1654 send_to_emacs (emacs_socket
, " ");
1655 quote_argument (emacs_socket
, tty_type
);
1656 send_to_emacs (emacs_socket
, " ");
1660 if (!current_frame
&& !tty
)
1661 send_to_emacs (emacs_socket
, "-window-system ");
1663 if ((argc
- optind
> 0))
1666 for (i
= optind
; i
< argc
; i
++)
1671 /* Don't prepend cwd or anything like that. */
1672 send_to_emacs (emacs_socket
, "-eval ");
1673 quote_argument (emacs_socket
, argv
[i
]);
1674 send_to_emacs (emacs_socket
, " ");
1678 if (*argv
[i
] == '+')
1680 char *p
= argv
[i
] + 1;
1681 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1684 send_to_emacs (emacs_socket
, "-position ");
1685 quote_argument (emacs_socket
, argv
[i
]);
1686 send_to_emacs (emacs_socket
, " ");
1691 else if (! file_name_absolute_p (argv
[i
])
1692 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1693 /* Windows can have a different default directory for each
1694 drive, so the cwd passed via "-dir" is not sufficient
1695 to account for that.
1696 If the user uses <drive>:<relpath>, we hence need to be
1697 careful to expand <relpath> with the default directory
1698 corresponding to <drive>. */
1700 char *filename
= (char *) xmalloc (MAX_PATH
);
1703 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1704 if (size
> 0 && size
< MAX_PATH
)
1711 send_to_emacs (emacs_socket
, "-file ");
1712 quote_argument (emacs_socket
, argv
[i
]);
1713 send_to_emacs (emacs_socket
, " ");
1718 /* Read expressions interactively. */
1719 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1721 send_to_emacs (emacs_socket
, "-eval ");
1722 quote_argument (emacs_socket
, str
);
1724 send_to_emacs (emacs_socket
, " ");
1727 send_to_emacs (emacs_socket
, "\n");
1729 /* Wait for an answer. */
1730 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1732 printf ("Waiting for Emacs...");
1738 /* Now, wait for an answer and print any messages. */
1739 while (exit_status
== EXIT_SUCCESS
)
1745 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1747 /* If we receive a signal (e.g. SIGWINCH, which we pass
1748 through to Emacs), on some OSes we get EINTR and must retry. */
1749 while (rl
< 0 && errno
== EINTR
);
1756 /* Loop over all NL-terminated messages. */
1757 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1759 end_p
= strchr (p
, '\n');
1763 if (strprefix ("-emacs-pid ", p
))
1765 /* -emacs-pid PID: The process id of the Emacs process. */
1766 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1768 else if (strprefix ("-window-system-unsupported ", p
))
1770 /* -window-system-unsupported: Emacs was compiled without X
1771 support. Try again on the terminal. */
1776 else if (strprefix ("-print ", p
))
1778 /* -print STRING: Print STRING on the terminal. */
1779 str
= unquote_argument (p
+ strlen ("-print "));
1783 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1785 else if (strprefix ("-print-nonl ", p
))
1787 /* -print-nonl STRING: Print STRING on the terminal.
1788 Used to continue a preceding -print command. */
1789 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1791 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1793 else if (strprefix ("-error ", p
))
1795 /* -error DESCRIPTION: Signal an error on the terminal. */
1796 str
= unquote_argument (p
+ strlen ("-error "));
1799 fprintf (stderr
, "*ERROR*: %s", str
);
1800 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1801 exit_status
= EXIT_FAILURE
;
1804 else if (strprefix ("-suspend ", p
))
1806 /* -suspend: Suspend this terminal, i.e., stop the process. */
1815 /* Unknown command. */
1819 printf ("*ERROR*: Unknown message: %s\n", p
);
1830 exit_status
= EXIT_FAILURE
;
1832 CLOSE_SOCKET (emacs_socket
);
1836 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */