1 /* Client process that communicates with GNU Emacs acting as server.
3 Copyright (C) 1986-1987, 1994, 1999-2013 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 # endif /* HAVE_NTGUI */
53 # ifdef HAVE_INET_SOCKETS
54 # include <netinet/in.h>
56 # include <sys/types.h>
57 # include <sys/socket.h>
59 # endif /* HAVE_SOCKETS */
61 # include <arpa/inet.h>
63 # define INVALID_SOCKET -1
65 # define CLOSE_SOCKET close
72 #define egetenv(VAR) getenv(VAR)
74 #endif /* !WINDOWSNT */
91 char *getenv (const char *);
94 #define VERSION "unspecified"
99 #define EXIT_SUCCESS 0
103 #define EXIT_FAILURE 1
106 /* Additional space when allocating buffers for filenames, etc. */
107 #define EXTRA_SPACE 100
112 #define min(x, y) (((x) < (y)) ? (x) : (y))
115 /* Name used to invoke this program. */
116 const char *progname
;
118 /* The second argument to main. */
121 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
124 /* Nonzero means don't print messages for successful operations. --quiet. */
127 /* Nonzero means args are expressions to be evaluated. --eval. */
130 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
131 int current_frame
= 1;
133 /* The display on which Emacs should work. --display. */
134 const char *display
= NULL
;
136 /* The alternate display we should try if Emacs does not support display. */
137 const char *alt_display
= NULL
;
139 /* The parent window ID, if we are opening a frame via XEmbed. */
140 char *parent_id
= NULL
;
142 /* Nonzero means open a new Emacs frame on the current terminal. */
145 /* If non-NULL, the name of an editor to fallback to if the server
146 is not running. --alternate-editor. */
147 const char *alternate_editor
= NULL
;
149 /* If non-NULL, the filename of the UNIX socket. */
150 const char *socket_name
= NULL
;
152 /* If non-NULL, the filename of the authentication file. */
153 const char *server_file
= NULL
;
155 /* PID of the Emacs server process. */
158 /* If non-NULL, a string that should form a frame parameter alist to
159 be used for the new frame */
160 const char *frame_parameters
= NULL
;
162 static _Noreturn
void print_help_and_exit (void);
165 struct option longopts
[] =
167 { "no-wait", no_argument
, NULL
, 'n' },
168 { "quiet", no_argument
, NULL
, 'q' },
169 { "eval", no_argument
, NULL
, 'e' },
170 { "help", no_argument
, NULL
, 'H' },
171 { "version", no_argument
, NULL
, 'V' },
172 { "tty", no_argument
, NULL
, 't' },
173 { "nw", no_argument
, NULL
, 't' },
174 { "create-frame", no_argument
, NULL
, 'c' },
175 { "alternate-editor", required_argument
, NULL
, 'a' },
176 { "frame-parameters", required_argument
, NULL
, 'F' },
177 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
178 { "socket-name", required_argument
, NULL
, 's' },
180 { "server-file", required_argument
, NULL
, 'f' },
181 { "display", required_argument
, NULL
, 'd' },
182 { "parent-id", required_argument
, NULL
, 'p' },
187 /* Like malloc but get fatal error if memory is exhausted. */
190 xmalloc (size_t size
)
192 void *result
= malloc (size
);
202 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
204 char *get_current_dir_name (void);
206 /* Return the current working directory. Returns NULL on errors.
207 Any other returned value must be freed with free. This is used
208 only when get_current_dir_name is not defined on the system. */
210 get_current_dir_name (void)
214 struct stat dotstat
, pwdstat
;
215 /* If PWD is accurate, use it instead of calling getcwd. PWD is
216 sometimes a nicer name, and using it may avoid a fatal error if a
217 parent directory is searchable but not readable. */
218 if ((pwd
= egetenv ("PWD")) != 0
219 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
220 && stat (pwd
, &pwdstat
) == 0
221 && stat (".", &dotstat
) == 0
222 && dotstat
.st_ino
== pwdstat
.st_ino
223 && dotstat
.st_dev
== pwdstat
.st_dev
225 && strlen (pwd
) < MAXPATHLEN
229 buf
= (char *) xmalloc (strlen (pwd
) + 1);
234 size_t buf_size
= 1024;
238 buf
= malloc (buf_size
);
241 if (getcwd (buf
, buf_size
) == buf
)
245 if (tmp_errno
!= ERANGE
)
264 /* Like strdup but get a fatal error if memory is exhausted. */
267 xstrdup (const char *s
)
269 char *result
= strdup (s
);
278 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
280 /* Retrieve an environment variable from the Emacs subkeys of the registry.
281 Return NULL if the variable was not found, or it was empty.
282 This code is based on w32_get_resource (w32.c). */
284 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
286 HKEY hrootkey
= NULL
;
290 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
292 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
294 result
= (char *) xmalloc (cbData
);
296 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
304 RegCloseKey (hrootkey
);
311 getenv wrapper for Windows
313 Value is allocated on the heap, and can be free'd.
315 This is needed to duplicate Emacs's behavior, which is to look for
316 environment variables in the registry if they don't appear in the
319 w32_getenv (char *envvar
)
324 if ((value
= getenv (envvar
)))
325 /* Found in the environment. strdup it, because values returned
326 by getenv cannot be free'd. */
327 return xstrdup (value
);
329 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
330 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
332 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
333 if (strcmp (envvar
, "TERM") == 0)
334 return xstrdup ("w32console");
335 /* Found neither in the environment nor in the registry. */
339 if (dwType
== REG_SZ
)
340 /* Registry; no need to expand. */
343 if (dwType
== REG_EXPAND_SZ
)
347 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
349 char *buffer
= (char *) xmalloc (size
);
350 if (ExpandEnvironmentStrings (value
, buffer
, size
))
352 /* Found and expanded. */
357 /* Error expanding. */
362 /* Not the right type, or not correctly expanded. */
369 w32_window_app (void)
371 static int window_app
= -1;
372 char szTitle
[MAX_PATH
];
376 /* Checking for STDOUT does not work; it's a valid handle also in
377 nonconsole apps. Testing for the console title seems to work. */
378 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
380 InitCommonControls ();
386 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
388 This is necessary due to the broken implementation of exec* routines in
389 the Microsoft libraries: they concatenate the arguments together without
390 quoting special characters, and pass the result to CreateProcess, with
391 predictably bad results. By contrast, POSIX execvp passes the arguments
392 directly into the argv array of the child process. */
395 w32_execvp (const char *path
, char **argv
)
398 extern int execvp (const char*, char **);
400 /* Required to allow a .BAT script as alternate editor. */
401 argv
[0] = (char *) alternate_editor
;
403 for (i
= 0; argv
[i
]; i
++)
404 if (strchr (argv
[i
], ' '))
406 char *quoted
= alloca (strlen (argv
[i
]) + 3);
407 sprintf (quoted
, "\"%s\"", argv
[i
]);
411 return execvp (path
, argv
);
415 #define execvp w32_execvp
417 /* Emulation of ttyname for Windows. */
424 #endif /* WINDOWSNT */
426 /* Display a normal or error message.
427 On Windows, use a message box if compiled as a Windows app. */
428 static void message (bool, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
430 message (bool is_error
, const char *format
, ...)
434 va_start (args
, format
);
437 if (w32_window_app ())
440 vsnprintf (msg
, sizeof msg
, format
, args
);
441 msg
[sizeof msg
- 1] = '\0';
444 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
446 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
451 FILE *f
= is_error
? stderr
: stdout
;
453 vfprintf (f
, format
, args
);
460 /* Decode the options from argv and argc.
461 The global variable `optind' will say how many arguments we used up. */
464 decode_options (int argc
, char **argv
)
466 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
470 int opt
= getopt_long_only (argc
, argv
,
471 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
484 /* If getopt returns 0, then it has already processed a
485 long-named option. We should do nothing. */
489 alternate_editor
= optarg
;
492 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
494 socket_name
= optarg
;
499 server_file
= optarg
;
502 /* We used to disallow this argument in w32, but it seems better
503 to allow it, for the occasional case where the user is
504 connecting with a w32 client to a server compiled with X11
523 message (false, "emacsclient %s\n", VERSION
);
542 print_help_and_exit ();
546 frame_parameters
= optarg
;
550 message (true, "Try `%s --help' for more information\n", progname
);
556 /* If the -c option is used (without -t) and no --display argument
557 is provided, try $DISPLAY.
558 Without the -c option, we used to set `display' to $DISPLAY by
559 default, but this changed the default behavior and is sometimes
560 inconvenient. So we force users to use "--display $DISPLAY" if
561 they want Emacs to connect to their current display.
563 Some window systems have a notion of default display not
564 reflected in the DISPLAY variable. If the user didn't give us an
565 explicit display, try this platform-specific after trying the
566 display in DISPLAY (if any). */
567 if (!current_frame
&& !tty
&& !display
)
569 /* Set these here so we use a default_display only when the user
570 didn't give us an explicit display. */
571 #if defined (NS_IMPL_COCOA)
573 #elif defined (HAVE_NTGUI)
577 display
= egetenv ("DISPLAY");
582 display
= alt_display
;
586 /* A null-string display is invalid. */
587 if (display
&& strlen (display
) == 0)
590 /* If no display is available, new frames are tty frames. */
591 if (!current_frame
&& !display
)
595 /* Emacs on Windows does not support graphical and text terminal
596 frames in the same instance. So, treat the -t and -c options as
597 equivalent, and open a new frame on the server's terminal.
598 Ideally, we would only set tty = 1 when the serve is running in a
599 console, but alas we don't know that. As a workaround, always
600 ask for a tty frame, and let server.el figure it out. */
607 if (alternate_editor
&& alternate_editor
[0] == '\0')
609 message (true, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
613 #endif /* WINDOWSNT */
617 static _Noreturn
void
618 print_help_and_exit (void)
620 /* Spaces and tabs are significant in this message; they're chosen so the
621 message aligns properly both in a tty and in a Windows message box.
622 Please try to preserve them; otherwise the output is very hard to read
623 when using emacsclientw. */
625 "Usage: %s [OPTIONS] FILE...\n%s%s%s", progname
, "\
626 Tell the Emacs server to visit the specified files.\n\
627 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
629 The following OPTIONS are accepted:\n\
630 -V, --version Just print version info and return\n\
631 -H, --help Print this usage information message\n\
632 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
633 -c, --create-frame Create a new frame instead of trying to\n\
634 use the current Emacs frame\n\
636 -F ALIST, --frame-parameters=ALIST\n\
637 Set the parameters of a new frame\n\
638 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
639 -n, --no-wait Don't wait for the server to return\n\
640 -q, --quiet Don't display messages on success\n\
641 -d DISPLAY, --display=DISPLAY\n\
642 Visit the file in the given display\n\
644 --parent-id=ID Open in parent window ID, via XEmbed\n"
645 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
646 "-s SOCKET, --socket-name=SOCKET\n\
647 Set filename of the UNIX socket for communication\n"
649 "-f SERVER, --server-file=SERVER\n\
650 Set filename of the TCP authentication file\n\
651 -a EDITOR, --alternate-editor=EDITOR\n\
652 Editor to fallback to if the server is not running\n"
654 " If EDITOR is the empty string, start Emacs in daemon\n\
655 mode and try connecting again\n"
656 #endif /* not WINDOWSNT */
658 Report bugs with M-x report-emacs-bug.\n");
662 /* Try to run a different command, or --if no alternate editor is
663 defined-- exit with an errorcode.
664 Uses argv, but gets it from the global variable main_argv. */
666 static _Noreturn
void
669 if (alternate_editor
)
673 execvp (alternate_editor
, main_argv
+ i
);
674 message (true, "%s: error executing alternate editor \"%s\"\n",
675 progname
, alternate_editor
);
681 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
684 main (int argc
, char **argv
)
688 message (true, "%s: Sorry, the Emacs server is supported only\n"
689 "on systems with Berkeley sockets.\n",
694 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
696 #define AUTH_KEY_LENGTH 64
697 #define SEND_BUFFER_SIZE 4096
699 /* Buffer to accumulate data to send in TCP connections. */
700 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
701 int sblen
= 0; /* Fill pointer for the send buffer. */
702 /* Socket used to communicate with the Emacs server process. */
703 HSOCKET emacs_socket
= 0;
705 /* On Windows, the socket library was historically separate from the
706 standard C library, so errors are handled differently. */
709 sock_err_message (const char *function_name
)
714 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
715 | FORMAT_MESSAGE_ALLOCATE_BUFFER
716 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
717 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
719 message (true, "%s: %s: %s\n", progname
, function_name
, msg
);
723 message (true, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
728 /* Let's send the data to Emacs when either
729 - the data ends in "\n", or
730 - the buffer is full (but this shouldn't happen)
731 Otherwise, we just accumulate it. */
733 send_to_emacs (HSOCKET s
, const char *data
)
740 dlen
= strlen (data
);
743 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
744 memcpy (&send_buffer
[sblen
], data
, part
);
748 if (sblen
== SEND_BUFFER_SIZE
749 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
751 int sent
= send (s
, send_buffer
, sblen
, 0);
754 message (true, "%s: failed to send %d bytes to socket: %s\n",
755 progname
, sblen
, strerror (errno
));
759 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
768 /* In STR, insert a & before each &, each space, each newline, and
769 any initial -. Change spaces to underscores, too, so that the
770 return value never contains a space.
772 Does not change the string. Outputs the result to S. */
774 quote_argument (HSOCKET s
, const char *str
)
776 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
798 if (*p
== '&' || (*p
== '-' && p
== str
))
805 send_to_emacs (s
, copy
);
811 /* The inverse of quote_argument. Removes quoting in string STR by
812 modifying the string in place. Returns STR. */
815 unquote_argument (char *str
)
846 file_name_absolute_p (const char *filename
)
848 /* Sanity check, it shouldn't happen. */
849 if (! filename
) return false;
851 /* /xxx is always an absolute path. */
852 if (filename
[0] == '/') return true;
854 /* Empty filenames (which shouldn't happen) are relative. */
855 if (filename
[0] == '\0') return false;
858 /* X:\xxx is always absolute. */
859 if (isalpha ((unsigned char) filename
[0])
860 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
863 /* Both \xxx and \\xxx\yyy are absolute. */
864 if (filename
[0] == '\\') return true;
871 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
878 /* Initialize the WinSock2 library. */
880 initialize_sockets (void)
884 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
886 message (true, "%s: error initializing WinSock2\n", progname
);
890 atexit (close_winsock
);
892 #endif /* WINDOWSNT */
895 /* Read the information needed to set up a TCP comm channel with
896 the Emacs server: host, port, and authentication string. */
899 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
900 char *authentication
)
906 if (file_name_absolute_p (config_file
))
907 config
= fopen (config_file
, "rb");
910 const char *home
= egetenv ("HOME");
914 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
917 strcat (path
, "/.emacs.d/server/");
918 strcat (path
, config_file
);
919 config
= fopen (path
, "rb");
923 if (!config
&& (home
= egetenv ("APPDATA")))
925 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
928 strcat (path
, "/.emacs.d/server/");
929 strcat (path
, config_file
);
930 config
= fopen (path
, "rb");
939 if (fgets (dotted
, sizeof dotted
, config
)
940 && (port
= strchr (dotted
, ':')))
944 message (true, "%s: invalid configuration info\n", progname
);
948 server
->sin_family
= AF_INET
;
949 server
->sin_addr
.s_addr
= inet_addr (dotted
);
950 server
->sin_port
= htons (atoi (port
));
952 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
954 message (true, "%s: cannot read authentication info\n", progname
);
964 set_tcp_socket (const char *local_server_file
)
967 struct sockaddr_in server
;
968 struct linger l_arg
= {1, 1};
969 char auth_string
[AUTH_KEY_LENGTH
+ 1];
971 if (! get_server_config (local_server_file
, &server
, auth_string
))
972 return INVALID_SOCKET
;
974 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
975 message (false, "%s: connected to remote socket at %s\n",
976 progname
, inet_ntoa (server
.sin_addr
));
978 /* Open up an AF_INET socket. */
979 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
981 sock_err_message ("socket");
982 return INVALID_SOCKET
;
985 /* Set up the socket. */
986 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
988 sock_err_message ("connect");
989 return INVALID_SOCKET
;
992 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
994 /* Send the authentication. */
995 auth_string
[AUTH_KEY_LENGTH
] = '\0';
997 send_to_emacs (s
, "-auth ");
998 send_to_emacs (s
, auth_string
);
999 send_to_emacs (s
, " ");
1005 /* Returns 1 if PREFIX is a prefix of STRING. */
1007 strprefix (const char *prefix
, const char *string
)
1009 return !strncmp (prefix
, string
, strlen (prefix
));
1012 /* Get tty name and type. If successful, return the type in TTY_TYPE
1013 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1014 is zero, or return 0 if NOABORT is non-zero. */
1017 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1019 const char *type
= egetenv ("TERM");
1020 const char *name
= ttyname (fileno (stdout
));
1028 message (true, "%s: could not get terminal name\n", progname
);
1039 message (true, "%s: please set the TERM variable to your terminal type\n",
1045 if (strcmp (type
, "eterm") == 0)
1051 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1052 message (true, "%s: opening a frame in an Emacs term buffer"
1053 " is not supported\n", progname
);
1064 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1066 /* Three possibilities:
1067 2 - can't be `stat'ed (sets errno)
1068 1 - isn't owned by us
1069 0 - success: none of the above */
1072 socket_status (const char *name
)
1074 struct stat statbfr
;
1076 if (stat (name
, &statbfr
) == -1)
1079 if (statbfr
.st_uid
!= geteuid ())
1086 /* A signal handler that passes the signal to the Emacs process.
1087 Useful for SIGWINCH. */
1090 pass_signal_to_emacs (int signalnum
)
1092 int old_errno
= errno
;
1095 kill (emacs_pid
, signalnum
);
1097 signal (signalnum
, pass_signal_to_emacs
);
1101 /* Signal handler for SIGCONT; notify the Emacs process that it can
1102 now resume our tty frame. */
1105 handle_sigcont (int signalnum
)
1107 int old_errno
= errno
;
1109 if (tcgetpgrp (1) == getpgrp ())
1111 /* We are in the foreground. */
1112 send_to_emacs (emacs_socket
, "-resume \n");
1116 /* We are in the background; cancel the continue. */
1120 signal (signalnum
, handle_sigcont
);
1124 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1125 going to sleep. Normally the suspend is initiated by Emacs via
1126 server-handle-suspend-tty, but if the server gets out of sync with
1127 reality, we may get a SIGTSTP on C-z. Handling this signal and
1128 notifying Emacs about it should get things under control again. */
1131 handle_sigtstp (int signalnum
)
1133 int old_errno
= errno
;
1137 send_to_emacs (emacs_socket
, "-suspend \n");
1139 /* Unblock this signal and call the default handler by temporarily
1140 changing the handler and resignaling. */
1141 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1142 sigdelset (&set
, signalnum
);
1143 signal (signalnum
, SIG_DFL
);
1145 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1146 signal (signalnum
, handle_sigtstp
);
1152 /* Set up signal handlers before opening a frame on the current tty. */
1157 /* Set up signal handlers. */
1158 signal (SIGWINCH
, pass_signal_to_emacs
);
1160 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1161 deciding which terminal the signal came from. C-g is now a
1162 normal input event on secondary terminals. */
1164 signal (SIGINT
, pass_signal_to_emacs
);
1165 signal (SIGQUIT
, pass_signal_to_emacs
);
1168 signal (SIGCONT
, handle_sigcont
);
1169 signal (SIGTSTP
, handle_sigtstp
);
1170 signal (SIGTTOU
, handle_sigtstp
);
1175 set_local_socket (const char *local_socket_name
)
1178 struct sockaddr_un server
;
1180 /* Open up an AF_UNIX socket in this person's home directory. */
1181 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1183 message (true, "%s: socket: %s\n", progname
, strerror (errno
));
1184 return INVALID_SOCKET
;
1187 server
.sun_family
= AF_UNIX
;
1193 const char *server_name
= local_socket_name
;
1194 const char *tmpdir
IF_LINT ( = NULL
);
1195 char *tmpdir_storage
= NULL
;
1196 char *socket_name_storage
= NULL
;
1198 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1200 /* socket_name is a file name component. */
1201 long uid
= geteuid ();
1202 ptrdiff_t tmpdirlen
;
1204 tmpdir
= egetenv ("TMPDIR");
1208 #ifndef _CS_DARWIN_USER_TEMP_DIR
1209 #define _CS_DARWIN_USER_TEMP_DIR 65537
1211 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1214 tmpdir
= tmpdir_storage
= xmalloc (n
);
1215 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1221 tmpdirlen
= strlen (tmpdir
);
1222 socket_name_storage
=
1223 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1224 strcpy (socket_name_storage
, tmpdir
);
1225 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1226 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1227 local_socket_name
= socket_name_storage
;
1230 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1231 strcpy (server
.sun_path
, local_socket_name
);
1234 message (true, "%s: socket-name %s too long\n",
1235 progname
, local_socket_name
);
1239 /* See if the socket exists, and if it's owned by us. */
1240 sock_status
= socket_status (server
.sun_path
);
1241 saved_errno
= errno
;
1242 if (sock_status
&& use_tmpdir
)
1244 /* Failing that, see if LOGNAME or USER exist and differ from
1245 our euid. If so, look for a socket based on the UID
1246 associated with the name. This is reminiscent of the logic
1247 that init_editfns uses to set the global Vuser_full_name. */
1249 const char *user_name
= egetenv ("LOGNAME");
1252 user_name
= egetenv ("USER");
1256 struct passwd
*pw
= getpwnam (user_name
);
1258 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1260 /* We're running under su, apparently. */
1261 long uid
= pw
->pw_uid
;
1262 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1263 char *user_socket_name
1264 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1265 strcpy (user_socket_name
, tmpdir
);
1266 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1267 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1269 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1270 strcpy (server
.sun_path
, user_socket_name
);
1273 message (true, "%s: socket-name %s too long\n",
1274 progname
, user_socket_name
);
1275 exit (EXIT_FAILURE
);
1277 free (user_socket_name
);
1279 sock_status
= socket_status (server
.sun_path
);
1280 saved_errno
= errno
;
1283 errno
= saved_errno
;
1287 free (socket_name_storage
);
1288 free (tmpdir_storage
);
1290 switch (sock_status
)
1293 /* There's a socket, but it isn't owned by us. This is OK if
1295 if (0 != geteuid ())
1297 message (true, "%s: Invalid socket owner\n", progname
);
1298 return INVALID_SOCKET
;
1304 if (saved_errno
== ENOENT
)
1306 "%s: can't find socket; have you started the server?\n\
1307 To start the server in Emacs, type \"M-x server-start\".\n",
1310 message (true, "%s: can't stat %s: %s\n",
1311 progname
, server
.sun_path
, strerror (saved_errno
));
1312 return INVALID_SOCKET
;
1316 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1319 message (true, "%s: connect: %s\n", progname
, strerror (errno
));
1320 return INVALID_SOCKET
;
1325 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1328 set_socket (int no_exit_if_error
)
1331 const char *local_server_file
= server_file
;
1335 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1336 /* Explicit --socket-name argument. */
1339 s
= set_local_socket (socket_name
);
1340 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1342 message (true, "%s: error accessing socket \"%s\"\n",
1343 progname
, socket_name
);
1344 exit (EXIT_FAILURE
);
1348 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1349 if (!local_server_file
)
1350 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1352 if (local_server_file
)
1354 s
= set_tcp_socket (local_server_file
);
1355 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1358 message (true, "%s: error accessing server file \"%s\"\n",
1359 progname
, local_server_file
);
1360 exit (EXIT_FAILURE
);
1363 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1364 /* Implicit local socket. */
1365 s
= set_local_socket ("server");
1366 if (s
!= INVALID_SOCKET
)
1370 /* Implicit server file. */
1371 s
= set_tcp_socket ("server");
1372 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1375 /* No implicit or explicit socket, and no alternate editor. */
1376 message (true, "%s: No socket or alternate editor. Please use:\n\n"
1377 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1380 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1381 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1383 exit (EXIT_FAILURE
);
1387 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1388 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1391 w32_set_user_model_id (void)
1394 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
1396 /* On Windows 7 and later, we need to set the user model ID
1397 to associate emacsclient launched files with Emacs frames
1399 shell
= LoadLibrary ("shell32.dll");
1403 = (void *) GetProcAddress (shell
,
1404 "SetCurrentProcessExplicitAppUserModelID");
1405 /* If the function is defined, then we are running on Windows 7
1406 or newer, and the UI uses this to group related windows
1407 together. Since emacs, runemacs, emacsclient are related, we
1408 want them grouped even though the executables are different,
1409 so we need to set a consistent ID between them. */
1411 set_user_model (L
"GNU.Emacs");
1413 FreeLibrary (shell
);
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. */
1441 /* Search for a window of class "Emacs" and owned by a process with
1442 process id = emacs_pid. If found, allow it to grab the focus. */
1445 w32_give_focus (void)
1449 /* It shouldn't happen when dealing with TCP sockets. */
1450 if (!emacs_pid
) return;
1452 user32
= GetModuleHandle ("user32.dll");
1457 /* Modern Windows restrict which processes can set the foreground window.
1458 emacsclient can allow Emacs to grab the focus by calling the function
1459 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1460 NT) lack this function, so we have to check its availability. */
1461 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1462 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1463 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1465 #endif /* HAVE_NTGUI */
1467 /* Start the emacs daemon and try to connect to it. */
1470 start_daemon_and_retry_set_socket (void)
1481 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1483 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1485 message (true, "Error: Could not start the Emacs daemon\n");
1486 exit (EXIT_FAILURE
);
1489 /* Try connecting, the daemon should have started by now. */
1490 message (true, "Emacs daemon should have started, trying to connect again\n");
1491 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1493 message (true, "Error: Cannot connect even after starting the Emacs daemon\n");
1494 exit (EXIT_FAILURE
);
1499 fprintf (stderr
, "Error: Cannot fork!\n");
1500 exit (EXIT_FAILURE
);
1504 char emacs
[] = "emacs";
1505 char daemon_option
[] = "--daemon";
1508 d_argv
[1] = daemon_option
;
1510 if (socket_name
!= NULL
)
1512 /* Pass --daemon=socket_name as argument. */
1513 const char *deq
= "--daemon=";
1514 char *daemon_arg
= xmalloc (strlen (deq
)
1515 + strlen (socket_name
) + 1);
1516 strcpy (daemon_arg
, deq
);
1517 strcat (daemon_arg
, socket_name
);
1518 d_argv
[1] = daemon_arg
;
1520 execvp ("emacs", d_argv
);
1521 message (true, "%s: error starting emacs daemon\n", progname
);
1523 #endif /* WINDOWSNT */
1527 main (int argc
, char **argv
)
1529 int rl
= 0, needlf
= 0;
1531 char string
[BUFSIZ
+1];
1532 int start_daemon_if_needed
;
1533 int exit_status
= EXIT_SUCCESS
;
1539 /* On Windows 7 and later, we need to explicitly associate
1540 emacsclient with emacs so the UI behaves sensibly. This
1541 association does no harm if we're not actually connecting to an
1542 Emacs using a window display. */
1543 w32_set_user_model_id ();
1544 #endif /* HAVE_NTGUI */
1546 /* Process options. */
1547 decode_options (argc
, argv
);
1549 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1551 message (true, "%s: file name or argument required\n"
1552 "Try `%s --help' for more information\n",
1553 progname
, progname
);
1554 exit (EXIT_FAILURE
);
1557 /* If alternate_editor is the empty string, start the emacs daemon
1558 in case of failure to connect. */
1559 start_daemon_if_needed
= (alternate_editor
1560 && (alternate_editor
[0] == '\0'));
1562 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1563 if (emacs_socket
== INVALID_SOCKET
)
1565 if (! start_daemon_if_needed
)
1568 start_daemon_and_retry_set_socket ();
1571 cwd
= get_current_dir_name ();
1574 message (true, "%s: %s\n", progname
,
1575 "Cannot get current working directory");
1580 if (display
&& !strcmp (display
, "w32"))
1582 #endif /* HAVE_NTGUI */
1584 /* Send over our environment and current directory. */
1588 for (i
= 0; environ
[i
]; i
++)
1590 send_to_emacs (emacs_socket
, "-env ");
1591 quote_argument (emacs_socket
, environ
[i
]);
1592 send_to_emacs (emacs_socket
, " ");
1595 send_to_emacs (emacs_socket
, "-dir ");
1596 quote_argument (emacs_socket
, cwd
);
1597 send_to_emacs (emacs_socket
, "/");
1598 send_to_emacs (emacs_socket
, " ");
1602 send_to_emacs (emacs_socket
, "-nowait ");
1605 send_to_emacs (emacs_socket
, "-current-frame ");
1609 send_to_emacs (emacs_socket
, "-display ");
1610 quote_argument (emacs_socket
, display
);
1611 send_to_emacs (emacs_socket
, " ");
1616 send_to_emacs (emacs_socket
, "-parent-id ");
1617 quote_argument (emacs_socket
, parent_id
);
1618 send_to_emacs (emacs_socket
, " ");
1621 if (frame_parameters
&& !current_frame
)
1623 send_to_emacs (emacs_socket
, "-frame-parameters ");
1624 quote_argument (emacs_socket
, frame_parameters
);
1625 send_to_emacs (emacs_socket
, " ");
1628 /* Unless we are certain we don't want to occupy the tty, send our
1629 tty information to Emacs. For example, in daemon mode Emacs may
1630 need to occupy this tty if no other frame is available. */
1631 if (!current_frame
|| !eval
)
1633 const char *tty_type
, *tty_name
;
1635 if (find_tty (&tty_type
, &tty_name
, !tty
))
1637 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1640 send_to_emacs (emacs_socket
, "-tty ");
1641 quote_argument (emacs_socket
, tty_name
);
1642 send_to_emacs (emacs_socket
, " ");
1643 quote_argument (emacs_socket
, tty_type
);
1644 send_to_emacs (emacs_socket
, " ");
1648 if (!current_frame
&& !tty
)
1649 send_to_emacs (emacs_socket
, "-window-system ");
1651 if ((argc
- optind
> 0))
1654 for (i
= optind
; i
< argc
; i
++)
1659 /* Don't prepend cwd or anything like that. */
1660 send_to_emacs (emacs_socket
, "-eval ");
1661 quote_argument (emacs_socket
, argv
[i
]);
1662 send_to_emacs (emacs_socket
, " ");
1666 if (*argv
[i
] == '+')
1668 char *p
= argv
[i
] + 1;
1669 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1672 send_to_emacs (emacs_socket
, "-position ");
1673 quote_argument (emacs_socket
, argv
[i
]);
1674 send_to_emacs (emacs_socket
, " ");
1679 else if (! file_name_absolute_p (argv
[i
])
1680 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1681 /* Windows can have a different default directory for each
1682 drive, so the cwd passed via "-dir" is not sufficient
1683 to account for that.
1684 If the user uses <drive>:<relpath>, we hence need to be
1685 careful to expand <relpath> with the default directory
1686 corresponding to <drive>. */
1688 char *filename
= (char *) xmalloc (MAX_PATH
);
1691 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1692 if (size
> 0 && size
< MAX_PATH
)
1699 send_to_emacs (emacs_socket
, "-file ");
1700 quote_argument (emacs_socket
, argv
[i
]);
1701 send_to_emacs (emacs_socket
, " ");
1706 /* Read expressions interactively. */
1707 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1709 send_to_emacs (emacs_socket
, "-eval ");
1710 quote_argument (emacs_socket
, str
);
1712 send_to_emacs (emacs_socket
, " ");
1715 send_to_emacs (emacs_socket
, "\n");
1717 /* Wait for an answer. */
1718 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1720 printf ("Waiting for Emacs...");
1724 while (fdatasync (1) != 0 && errno
== EINTR
)
1727 /* Now, wait for an answer and print any messages. */
1728 while (exit_status
== EXIT_SUCCESS
)
1734 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1736 /* If we receive a signal (e.g. SIGWINCH, which we pass
1737 through to Emacs), on some OSes we get EINTR and must retry. */
1738 while (rl
< 0 && errno
== EINTR
);
1745 /* Loop over all NL-terminated messages. */
1746 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1748 end_p
= strchr (p
, '\n');
1752 if (strprefix ("-emacs-pid ", p
))
1754 /* -emacs-pid PID: The process id of the Emacs process. */
1755 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1757 else if (strprefix ("-window-system-unsupported ", p
))
1759 /* -window-system-unsupported: Emacs was compiled without support
1760 for whatever window system we tried. Try the alternate
1761 display, or, failing that, try the terminal. */
1764 display
= alt_display
;
1775 else if (strprefix ("-print ", p
))
1777 /* -print STRING: Print STRING on the terminal. */
1778 str
= unquote_argument (p
+ strlen ("-print "));
1782 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1784 else if (strprefix ("-print-nonl ", p
))
1786 /* -print-nonl STRING: Print STRING on the terminal.
1787 Used to continue a preceding -print command. */
1788 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1790 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1792 else if (strprefix ("-error ", p
))
1794 /* -error DESCRIPTION: Signal an error on the terminal. */
1795 str
= unquote_argument (p
+ strlen ("-error "));
1798 fprintf (stderr
, "*ERROR*: %s", str
);
1799 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1800 exit_status
= EXIT_FAILURE
;
1803 else if (strprefix ("-suspend ", p
))
1805 /* -suspend: Suspend this terminal, i.e., stop the process. */
1814 /* Unknown command. */
1818 printf ("*ERROR*: Unknown message: %s\n", p
);
1826 while (fdatasync (1) != 0 && errno
== EINTR
)
1830 exit_status
= EXIT_FAILURE
;
1832 CLOSE_SOCKET (emacs_socket
);
1836 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */