1 /* Client process that communicates with GNU Emacs acting as server.
3 Copyright (C) 1986-1987, 1994, 1999-2015 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
68 #define egetenv(VAR) getenv(VAR)
70 #endif /* !WINDOWSNT */
86 #define VERSION "unspecified"
91 #define EXIT_SUCCESS 0
95 #define EXIT_FAILURE 1
98 /* Additional space when allocating buffers for filenames, etc. */
99 #define EXTRA_SPACE 100
104 #define min(x, y) (((x) < (y)) ? (x) : (y))
107 /* Name used to invoke this program. */
108 const char *progname
;
110 /* The second argument to main. */
113 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
116 /* Nonzero means don't print messages for successful operations. --quiet. */
119 /* Nonzero means args are expressions to be evaluated. --eval. */
122 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
123 int current_frame
= 1;
125 /* The display on which Emacs should work. --display. */
126 const char *display
= NULL
;
128 /* The alternate display we should try if Emacs does not support display. */
129 const char *alt_display
= NULL
;
131 /* The parent window ID, if we are opening a frame via XEmbed. */
132 char *parent_id
= NULL
;
134 /* Nonzero means open a new Emacs frame on the current terminal. */
137 /* If non-NULL, the name of an editor to fallback to if the server
138 is not running. --alternate-editor. */
139 const char *alternate_editor
= NULL
;
141 /* If non-NULL, the filename of the UNIX socket. */
142 const char *socket_name
= NULL
;
144 /* If non-NULL, the filename of the authentication file. */
145 const char *server_file
= NULL
;
147 /* PID of the Emacs server process. */
150 /* If non-NULL, a string that should form a frame parameter alist to
151 be used for the new frame. */
152 const char *frame_parameters
= NULL
;
154 static _Noreturn
void print_help_and_exit (void);
157 struct option longopts
[] =
159 { "no-wait", no_argument
, NULL
, 'n' },
160 { "quiet", no_argument
, NULL
, 'q' },
161 { "eval", no_argument
, NULL
, 'e' },
162 { "help", no_argument
, NULL
, 'H' },
163 { "version", no_argument
, NULL
, 'V' },
164 { "tty", no_argument
, NULL
, 't' },
165 { "nw", no_argument
, NULL
, 't' },
166 { "create-frame", no_argument
, NULL
, 'c' },
167 { "alternate-editor", required_argument
, NULL
, 'a' },
168 { "frame-parameters", required_argument
, NULL
, 'F' },
169 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
170 { "socket-name", required_argument
, NULL
, 's' },
172 { "server-file", required_argument
, NULL
, 'f' },
173 { "display", required_argument
, NULL
, 'd' },
174 { "parent-id", required_argument
, NULL
, 'p' },
179 /* Like malloc but get fatal error if memory is exhausted. */
182 xmalloc (size_t size
)
184 void *result
= malloc (size
);
194 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
196 char *get_current_dir_name (void);
198 /* Return the current working directory. Returns NULL on errors.
199 Any other returned value must be freed with free. This is used
200 only when get_current_dir_name is not defined on the system. */
202 get_current_dir_name (void)
206 struct stat dotstat
, pwdstat
;
207 /* If PWD is accurate, use it instead of calling getcwd. PWD is
208 sometimes a nicer name, and using it may avoid a fatal error if a
209 parent directory is searchable but not readable. */
210 if ((pwd
= egetenv ("PWD")) != 0
211 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
212 && stat (pwd
, &pwdstat
) == 0
213 && stat (".", &dotstat
) == 0
214 && dotstat
.st_ino
== pwdstat
.st_ino
215 && dotstat
.st_dev
== pwdstat
.st_dev
217 && strlen (pwd
) < MAXPATHLEN
221 buf
= (char *) xmalloc (strlen (pwd
) + 1);
226 size_t buf_size
= 1024;
230 buf
= malloc (buf_size
);
233 if (getcwd (buf
, buf_size
) == buf
)
237 if (tmp_errno
!= ERANGE
)
256 /* Like strdup but get a fatal error if memory is exhausted. */
259 xstrdup (const char *s
)
261 char *result
= strdup (s
);
270 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
272 /* Retrieve an environment variable from the Emacs subkeys of the registry.
273 Return NULL if the variable was not found, or it was empty.
274 This code is based on w32_get_resource (w32.c). */
276 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
278 HKEY hrootkey
= NULL
;
282 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
284 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
286 result
= (char *) xmalloc (cbData
);
288 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
296 RegCloseKey (hrootkey
);
303 getenv wrapper for Windows
305 Value is allocated on the heap, and can be free'd.
307 This is needed to duplicate Emacs's behavior, which is to look for
308 environment variables in the registry if they don't appear in the
311 w32_getenv (char *envvar
)
316 if ((value
= getenv (envvar
)))
317 /* Found in the environment. strdup it, because values returned
318 by getenv cannot be free'd. */
319 return xstrdup (value
);
321 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
322 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
324 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
325 if (strcmp (envvar
, "TERM") == 0)
326 return xstrdup ("w32console");
327 /* Found neither in the environment nor in the registry. */
331 if (dwType
== REG_SZ
)
332 /* Registry; no need to expand. */
335 if (dwType
== REG_EXPAND_SZ
)
339 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
341 char *buffer
= (char *) xmalloc (size
);
342 if (ExpandEnvironmentStrings (value
, buffer
, size
))
344 /* Found and expanded. */
349 /* Error expanding. */
354 /* Not the right type, or not correctly expanded. */
361 w32_window_app (void)
363 static int window_app
= -1;
364 char szTitle
[MAX_PATH
];
368 /* Checking for STDOUT does not work; it's a valid handle also in
369 nonconsole apps. Testing for the console title seems to work. */
370 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
372 InitCommonControls ();
378 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
380 This is necessary due to the broken implementation of exec* routines in
381 the Microsoft libraries: they concatenate the arguments together without
382 quoting special characters, and pass the result to CreateProcess, with
383 predictably bad results. By contrast, POSIX execvp passes the arguments
384 directly into the argv array of the child process. */
387 w32_execvp (const char *path
, char **argv
)
390 extern int execvp (const char*, char **);
392 /* Required to allow a .BAT script as alternate editor. */
393 argv
[0] = (char *) alternate_editor
;
395 for (i
= 0; argv
[i
]; i
++)
396 if (strchr (argv
[i
], ' '))
398 char *quoted
= alloca (strlen (argv
[i
]) + 3);
399 sprintf (quoted
, "\"%s\"", argv
[i
]);
403 return execvp (path
, argv
);
407 #define execvp w32_execvp
409 /* Emulation of ttyname for Windows. */
416 #endif /* WINDOWSNT */
418 /* Display a normal or error message.
419 On Windows, use a message box if compiled as a Windows app. */
420 static void message (bool, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
422 message (bool is_error
, const char *format
, ...)
426 va_start (args
, format
);
429 if (w32_window_app ())
432 vsnprintf (msg
, sizeof msg
, format
, args
);
433 msg
[sizeof msg
- 1] = '\0';
436 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
438 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
443 FILE *f
= is_error
? stderr
: stdout
;
445 vfprintf (f
, format
, args
);
452 /* Decode the options from argv and argc.
453 The global variable `optind' will say how many arguments we used up. */
456 decode_options (int argc
, char **argv
)
458 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
462 int opt
= getopt_long_only (argc
, argv
,
463 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
476 /* If getopt returns 0, then it has already processed a
477 long-named option. We should do nothing. */
481 alternate_editor
= optarg
;
484 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
486 socket_name
= optarg
;
491 server_file
= optarg
;
494 /* We used to disallow this argument in w32, but it seems better
495 to allow it, for the occasional case where the user is
496 connecting with a w32 client to a server compiled with X11
515 message (false, "emacsclient %s\n", VERSION
);
534 print_help_and_exit ();
538 frame_parameters
= optarg
;
542 message (true, "Try `%s --help' for more information\n", progname
);
548 /* If the -c option is used (without -t) and no --display argument
549 is provided, try $DISPLAY.
550 Without the -c option, we used to set `display' to $DISPLAY by
551 default, but this changed the default behavior and is sometimes
552 inconvenient. So we force users to use "--display $DISPLAY" if
553 they want Emacs to connect to their current display.
555 Some window systems have a notion of default display not
556 reflected in the DISPLAY variable. If the user didn't give us an
557 explicit display, try this platform-specific after trying the
558 display in DISPLAY (if any). */
559 if (!current_frame
&& !tty
&& !display
)
561 /* Set these here so we use a default_display only when the user
562 didn't give us an explicit display. */
563 #if defined (NS_IMPL_COCOA)
565 #elif defined (HAVE_NTGUI)
569 display
= egetenv ("DISPLAY");
574 display
= alt_display
;
578 /* A null-string display is invalid. */
579 if (display
&& strlen (display
) == 0)
582 /* If no display is available, new frames are tty frames. */
583 if (!current_frame
&& !display
)
587 /* Emacs on Windows does not support graphical and text terminal
588 frames in the same instance. So, treat the -t and -c options as
589 equivalent, and open a new frame on the server's terminal.
590 Ideally, we would only set tty = 1 when the serve is running in a
591 console, but alas we don't know that. As a workaround, always
592 ask for a tty frame, and let server.el figure it out. */
598 #endif /* WINDOWSNT */
602 static _Noreturn
void
603 print_help_and_exit (void)
605 /* Spaces and tabs are significant in this message; they're chosen so the
606 message aligns properly both in a tty and in a Windows message box.
607 Please try to preserve them; otherwise the output is very hard to read
608 when using emacsclientw. */
610 "Usage: %s [OPTIONS] FILE...\n%s%s%s", progname
, "\
611 Tell the Emacs server to visit the specified files.\n\
612 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
614 The following OPTIONS are accepted:\n\
615 -V, --version Just print version info and return\n\
616 -H, --help Print this usage information message\n\
617 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
618 -c, --create-frame Create a new frame instead of trying to\n\
619 use the current Emacs frame\n\
621 -F ALIST, --frame-parameters=ALIST\n\
622 Set the parameters of a new frame\n\
623 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
624 -n, --no-wait Don't wait for the server to return\n\
625 -q, --quiet Don't display messages on success\n\
626 -d DISPLAY, --display=DISPLAY\n\
627 Visit the file in the given display\n\
629 --parent-id=ID Open in parent window ID, via XEmbed\n"
630 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
631 "-s SOCKET, --socket-name=SOCKET\n\
632 Set filename of the UNIX socket for communication\n"
634 "-f SERVER, --server-file=SERVER\n\
635 Set filename of the TCP authentication file\n\
636 -a EDITOR, --alternate-editor=EDITOR\n\
637 Editor to fallback to if the server is not running\n"
638 " If EDITOR is the empty string, start Emacs in daemon\n\
639 mode and try connecting again\n"
641 Report bugs with M-x report-emacs-bug.\n");
645 /* Try to run a different command, or --if no alternate editor is
646 defined-- exit with an errorcode.
647 Uses argv, but gets it from the global variable main_argv. */
649 static _Noreturn
void
652 if (alternate_editor
)
656 execvp (alternate_editor
, main_argv
+ i
);
657 message (true, "%s: error executing alternate editor \"%s\"\n",
658 progname
, alternate_editor
);
664 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
667 main (int argc
, char **argv
)
671 message (true, "%s: Sorry, the Emacs server is supported only\n"
672 "on systems with Berkeley sockets.\n",
677 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
679 #define AUTH_KEY_LENGTH 64
680 #define SEND_BUFFER_SIZE 4096
682 /* Buffer to accumulate data to send in TCP connections. */
683 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
684 int sblen
= 0; /* Fill pointer for the send buffer. */
685 /* Socket used to communicate with the Emacs server process. */
686 HSOCKET emacs_socket
= 0;
688 /* On Windows, the socket library was historically separate from the
689 standard C library, so errors are handled differently. */
692 sock_err_message (const char *function_name
)
697 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
698 | FORMAT_MESSAGE_ALLOCATE_BUFFER
699 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
700 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
702 message (true, "%s: %s: %s\n", progname
, function_name
, msg
);
706 message (true, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
711 /* Let's send the data to Emacs when either
712 - the data ends in "\n", or
713 - the buffer is full (but this shouldn't happen)
714 Otherwise, we just accumulate it. */
716 send_to_emacs (HSOCKET s
, const char *data
)
723 dlen
= strlen (data
);
726 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
727 memcpy (&send_buffer
[sblen
], data
, part
);
731 if (sblen
== SEND_BUFFER_SIZE
732 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
734 int sent
= send (s
, send_buffer
, sblen
, 0);
737 message (true, "%s: failed to send %d bytes to socket: %s\n",
738 progname
, sblen
, strerror (errno
));
742 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
751 /* In STR, insert a & before each &, each space, each newline, and
752 any initial -. Change spaces to underscores, too, so that the
753 return value never contains a space.
755 Does not change the string. Outputs the result to S. */
757 quote_argument (HSOCKET s
, const char *str
)
759 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
781 if (*p
== '&' || (*p
== '-' && p
== str
))
788 send_to_emacs (s
, copy
);
794 /* The inverse of quote_argument. Removes quoting in string STR by
795 modifying the string in place. Returns STR. */
798 unquote_argument (char *str
)
829 file_name_absolute_p (const char *filename
)
831 /* Sanity check, it shouldn't happen. */
832 if (! filename
) return false;
834 /* /xxx is always an absolute path. */
835 if (filename
[0] == '/') return true;
837 /* Empty filenames (which shouldn't happen) are relative. */
838 if (filename
[0] == '\0') return false;
841 /* X:\xxx is always absolute. */
842 if (isalpha ((unsigned char) filename
[0])
843 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
846 /* Both \xxx and \\xxx\yyy are absolute. */
847 if (filename
[0] == '\\') return true;
854 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
861 /* Initialize the WinSock2 library. */
863 initialize_sockets (void)
867 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
869 message (true, "%s: error initializing WinSock2\n", progname
);
873 atexit (close_winsock
);
875 #endif /* WINDOWSNT */
878 /* Read the information needed to set up a TCP comm channel with
879 the Emacs server: host, port, and authentication string. */
882 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
883 char *authentication
)
889 if (file_name_absolute_p (config_file
))
890 config
= fopen (config_file
, "rb");
893 const char *home
= egetenv ("HOME");
897 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
899 char *z
= stpcpy (path
, home
);
900 z
= stpcpy (z
, "/.emacs.d/server/");
901 strcpy (z
, config_file
);
902 config
= fopen (path
, "rb");
906 if (!config
&& (home
= egetenv ("APPDATA")))
908 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
910 char *z
= stpcpy (path
, home
);
911 z
= stpcpy (z
, "/.emacs.d/server/");
912 strcpy (z
, config_file
);
913 config
= fopen (path
, "rb");
922 if (fgets (dotted
, sizeof dotted
, config
)
923 && (port
= strchr (dotted
, ':')))
927 message (true, "%s: invalid configuration info\n", progname
);
931 server
->sin_family
= AF_INET
;
932 server
->sin_addr
.s_addr
= inet_addr (dotted
);
933 server
->sin_port
= htons (atoi (port
));
935 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
937 message (true, "%s: cannot read authentication info\n", progname
);
947 set_tcp_socket (const char *local_server_file
)
950 struct sockaddr_in server
;
951 struct linger l_arg
= {1, 1};
952 char auth_string
[AUTH_KEY_LENGTH
+ 1];
954 if (! get_server_config (local_server_file
, &server
, auth_string
))
955 return INVALID_SOCKET
;
957 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
958 message (false, "%s: connected to remote socket at %s\n",
959 progname
, inet_ntoa (server
.sin_addr
));
961 /* Open up an AF_INET socket. */
962 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
964 sock_err_message ("socket");
965 return INVALID_SOCKET
;
968 /* Set up the socket. */
969 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
971 sock_err_message ("connect");
972 return INVALID_SOCKET
;
975 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
977 /* Send the authentication. */
978 auth_string
[AUTH_KEY_LENGTH
] = '\0';
980 send_to_emacs (s
, "-auth ");
981 send_to_emacs (s
, auth_string
);
982 send_to_emacs (s
, " ");
988 /* Returns 1 if PREFIX is a prefix of STRING. */
990 strprefix (const char *prefix
, const char *string
)
992 return !strncmp (prefix
, string
, strlen (prefix
));
995 /* Get tty name and type. If successful, return the type in TTY_TYPE
996 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
997 is zero, or return 0 if NOABORT is non-zero. */
1000 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1002 const char *type
= egetenv ("TERM");
1003 const char *name
= ttyname (fileno (stdout
));
1011 message (true, "%s: could not get terminal name\n", progname
);
1022 message (true, "%s: please set the TERM variable to your terminal type\n",
1028 if (strcmp (type
, "eterm") == 0)
1034 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1035 message (true, "%s: opening a frame in an Emacs term buffer"
1036 " is not supported\n", progname
);
1047 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1049 /* Three possibilities:
1050 2 - can't be `stat'ed (sets errno)
1051 1 - isn't owned by us
1052 0 - success: none of the above */
1055 socket_status (const char *name
)
1057 struct stat statbfr
;
1059 if (stat (name
, &statbfr
) == -1)
1062 if (statbfr
.st_uid
!= geteuid ())
1069 /* A signal handler that passes the signal to the Emacs process.
1070 Useful for SIGWINCH. */
1073 pass_signal_to_emacs (int signalnum
)
1075 int old_errno
= errno
;
1078 kill (emacs_pid
, signalnum
);
1080 signal (signalnum
, pass_signal_to_emacs
);
1084 /* Signal handler for SIGCONT; notify the Emacs process that it can
1085 now resume our tty frame. */
1088 handle_sigcont (int signalnum
)
1090 int old_errno
= errno
;
1091 pid_t pgrp
= getpgrp ();
1092 pid_t tcpgrp
= tcgetpgrp (1);
1096 /* We are in the foreground. */
1097 send_to_emacs (emacs_socket
, "-resume \n");
1099 else if (0 <= tcpgrp
&& tty
)
1101 /* We are in the background; cancel the continue. */
1102 kill (-pgrp
, SIGTTIN
);
1105 signal (signalnum
, handle_sigcont
);
1109 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1110 going to sleep. Normally the suspend is initiated by Emacs via
1111 server-handle-suspend-tty, but if the server gets out of sync with
1112 reality, we may get a SIGTSTP on C-z. Handling this signal and
1113 notifying Emacs about it should get things under control again. */
1116 handle_sigtstp (int signalnum
)
1118 int old_errno
= errno
;
1122 send_to_emacs (emacs_socket
, "-suspend \n");
1124 /* Unblock this signal and call the default handler by temporarily
1125 changing the handler and resignaling. */
1126 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1127 sigdelset (&set
, signalnum
);
1128 signal (signalnum
, SIG_DFL
);
1130 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1131 signal (signalnum
, handle_sigtstp
);
1137 /* Set up signal handlers before opening a frame on the current tty. */
1142 /* Set up signal handlers. */
1143 signal (SIGWINCH
, pass_signal_to_emacs
);
1145 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1146 deciding which terminal the signal came from. C-g is now a
1147 normal input event on secondary terminals. */
1149 signal (SIGINT
, pass_signal_to_emacs
);
1150 signal (SIGQUIT
, pass_signal_to_emacs
);
1153 signal (SIGCONT
, handle_sigcont
);
1154 signal (SIGTSTP
, handle_sigtstp
);
1155 signal (SIGTTOU
, handle_sigtstp
);
1160 set_local_socket (const char *local_socket_name
)
1163 struct sockaddr_un server
;
1165 /* Open up an AF_UNIX socket in this person's home directory. */
1166 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1168 message (true, "%s: socket: %s\n", progname
, strerror (errno
));
1169 return INVALID_SOCKET
;
1172 server
.sun_family
= AF_UNIX
;
1178 const char *server_name
= local_socket_name
;
1179 const char *tmpdir
IF_LINT ( = NULL
);
1180 char *tmpdir_storage
= NULL
;
1181 char *socket_name_storage
= NULL
;
1183 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1185 /* socket_name is a file name component. */
1186 long uid
= geteuid ();
1188 tmpdir
= egetenv ("TMPDIR");
1192 #ifndef _CS_DARWIN_USER_TEMP_DIR
1193 #define _CS_DARWIN_USER_TEMP_DIR 65537
1195 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1198 tmpdir
= tmpdir_storage
= xmalloc (n
);
1199 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1205 socket_name_storage
=
1206 xmalloc (strlen (tmpdir
) + strlen (server_name
) + EXTRA_SPACE
);
1207 char *z
= stpcpy (socket_name_storage
, tmpdir
);
1208 z
+= sprintf (z
, "/emacs%ld/", uid
);
1209 strcpy (z
, server_name
);
1210 local_socket_name
= socket_name_storage
;
1213 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1214 strcpy (server
.sun_path
, local_socket_name
);
1217 message (true, "%s: socket-name %s too long\n",
1218 progname
, local_socket_name
);
1222 /* See if the socket exists, and if it's owned by us. */
1223 sock_status
= socket_status (server
.sun_path
);
1224 saved_errno
= errno
;
1225 if (sock_status
&& use_tmpdir
)
1227 /* Failing that, see if LOGNAME or USER exist and differ from
1228 our euid. If so, look for a socket based on the UID
1229 associated with the name. This is reminiscent of the logic
1230 that init_editfns uses to set the global Vuser_full_name. */
1232 const char *user_name
= egetenv ("LOGNAME");
1235 user_name
= egetenv ("USER");
1239 struct passwd
*pw
= getpwnam (user_name
);
1241 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1243 /* We're running under su, apparently. */
1244 long uid
= pw
->pw_uid
;
1245 char *user_socket_name
1246 = xmalloc (strlen (tmpdir
) + strlen (server_name
)
1248 char *z
= stpcpy (user_socket_name
, tmpdir
);
1249 z
+= sprintf (z
, "/emacs%ld/", uid
);
1250 strcpy (z
, server_name
);
1252 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1253 strcpy (server
.sun_path
, user_socket_name
);
1256 message (true, "%s: socket-name %s too long\n",
1257 progname
, user_socket_name
);
1258 exit (EXIT_FAILURE
);
1260 free (user_socket_name
);
1262 sock_status
= socket_status (server
.sun_path
);
1263 saved_errno
= errno
;
1266 errno
= saved_errno
;
1270 free (socket_name_storage
);
1271 free (tmpdir_storage
);
1273 switch (sock_status
)
1276 /* There's a socket, but it isn't owned by us. This is OK if
1278 if (0 != geteuid ())
1280 message (true, "%s: Invalid socket owner\n", progname
);
1281 return INVALID_SOCKET
;
1287 if (saved_errno
== ENOENT
)
1289 "%s: can't find socket; have you started the server?\n\
1290 To start the server in Emacs, type \"M-x server-start\".\n",
1293 message (true, "%s: can't stat %s: %s\n",
1294 progname
, server
.sun_path
, strerror (saved_errno
));
1295 return INVALID_SOCKET
;
1299 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1302 message (true, "%s: connect: %s\n", progname
, strerror (errno
));
1303 return INVALID_SOCKET
;
1308 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1311 set_socket (int no_exit_if_error
)
1314 const char *local_server_file
= server_file
;
1318 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1319 /* Explicit --socket-name argument. */
1322 s
= set_local_socket (socket_name
);
1323 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1325 message (true, "%s: error accessing socket \"%s\"\n",
1326 progname
, socket_name
);
1327 exit (EXIT_FAILURE
);
1331 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1332 if (!local_server_file
)
1333 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1335 if (local_server_file
)
1337 s
= set_tcp_socket (local_server_file
);
1338 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1341 message (true, "%s: error accessing server file \"%s\"\n",
1342 progname
, local_server_file
);
1343 exit (EXIT_FAILURE
);
1346 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1347 /* Implicit local socket. */
1348 s
= set_local_socket ("server");
1349 if (s
!= INVALID_SOCKET
)
1353 /* Implicit server file. */
1354 s
= set_tcp_socket ("server");
1355 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1358 /* No implicit or explicit socket, and no alternate editor. */
1359 message (true, "%s: No socket or alternate editor. Please use:\n\n"
1360 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1363 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1364 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1366 exit (EXIT_FAILURE
);
1370 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1371 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1374 w32_set_user_model_id (void)
1377 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
1379 /* On Windows 7 and later, we need to set the user model ID
1380 to associate emacsclient launched files with Emacs frames
1382 shell
= LoadLibrary ("shell32.dll");
1386 = (void *) GetProcAddress (shell
,
1387 "SetCurrentProcessExplicitAppUserModelID");
1388 /* If the function is defined, then we are running on Windows 7
1389 or newer, and the UI uses this to group related windows
1390 together. Since emacs, runemacs, emacsclient are related, we
1391 want them grouped even though the executables are different,
1392 so we need to set a consistent ID between them. */
1394 set_user_model (L
"GNU.Emacs");
1396 FreeLibrary (shell
);
1401 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1406 /* Reject any window not of class "Emacs". */
1407 if (! get_wc (hWnd
, class, sizeof (class))
1408 || strcmp (class, "Emacs"))
1411 /* We only need the process id, not the thread id. */
1412 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1414 /* Not the one we're looking for. */
1415 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1417 /* OK, let's raise it. */
1420 /* Stop enumeration. */
1424 /* Search for a window of class "Emacs" and owned by a process with
1425 process id = emacs_pid. If found, allow it to grab the focus. */
1428 w32_give_focus (void)
1432 /* It shouldn't happen when dealing with TCP sockets. */
1433 if (!emacs_pid
) return;
1435 user32
= GetModuleHandle ("user32.dll");
1440 /* Modern Windows restrict which processes can set the foreground window.
1441 emacsclient can allow Emacs to grab the focus by calling the function
1442 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1443 NT) lack this function, so we have to check its availability. */
1444 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1445 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1446 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1448 #endif /* HAVE_NTGUI */
1450 /* Start the emacs daemon and try to connect to it. */
1453 start_daemon_and_retry_set_socket (void)
1464 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1466 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1468 message (true, "Error: Could not start the Emacs daemon\n");
1469 exit (EXIT_FAILURE
);
1472 /* Try connecting, the daemon should have started by now. */
1473 message (true, "Emacs daemon should have started, trying to connect again\n");
1474 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1476 message (true, "Error: Cannot connect even after starting the Emacs daemon\n");
1477 exit (EXIT_FAILURE
);
1482 fprintf (stderr
, "Error: Cannot fork!\n");
1483 exit (EXIT_FAILURE
);
1487 char emacs
[] = "emacs";
1488 char daemon_option
[] = "--daemon";
1491 d_argv
[1] = daemon_option
;
1493 if (socket_name
!= NULL
)
1495 /* Pass --daemon=socket_name as argument. */
1496 const char *deq
= "--daemon=";
1497 char *daemon_arg
= xmalloc (strlen (deq
)
1498 + strlen (socket_name
) + 1);
1499 strcpy (stpcpy (daemon_arg
, deq
), socket_name
);
1500 d_argv
[1] = daemon_arg
;
1502 execvp ("emacs", d_argv
);
1503 message (true, "%s: error starting emacs daemon\n", progname
);
1505 #else /* WINDOWSNT */
1507 HANDLE w32_daemon_event
;
1509 PROCESS_INFORMATION pi
;
1511 ZeroMemory (&si
, sizeof si
);
1513 ZeroMemory (&pi
, sizeof pi
);
1515 /* We start Emacs in daemon mode, and then wait for it to signal us
1516 it is ready to accept client connections, by asserting an event
1517 whose name is known to the daemon (defined by nt/inc/ms-w32.h). */
1519 if (!CreateProcess (NULL
, "emacs --daemon", NULL
, NULL
, FALSE
,
1520 CREATE_NO_WINDOW
, NULL
, NULL
, &si
, &pi
))
1524 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
1525 | FORMAT_MESSAGE_ALLOCATE_BUFFER
1526 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
1527 NULL
, GetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
1528 message (true, "%s: error starting emacs daemon (%s)\n", progname
, msg
);
1529 exit (EXIT_FAILURE
);
1532 w32_daemon_event
= CreateEvent (NULL
, TRUE
, FALSE
, W32_DAEMON_EVENT
);
1533 if (w32_daemon_event
== NULL
)
1535 message (true, "Couldn't create Windows daemon event");
1536 exit (EXIT_FAILURE
);
1538 if ((wait_result
= WaitForSingleObject (w32_daemon_event
, INFINITE
))
1543 switch (wait_result
)
1545 case WAIT_ABANDONED
:
1546 msg
= "The daemon exited unexpectedly";
1549 /* Can't happen due to INFINITE. */
1552 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
1553 | FORMAT_MESSAGE_ALLOCATE_BUFFER
1554 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
1555 NULL
, GetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
1558 message (true, "Error: Could not start the Emacs daemon: %s\n", msg
);
1559 exit (EXIT_FAILURE
);
1561 CloseHandle (w32_daemon_event
);
1563 /* Try connecting, the daemon should have started by now. */
1564 /* It's just a progress message, so don't pop a dialog if this is
1566 if (!w32_window_app ())
1568 "Emacs daemon should have started, trying to connect again\n");
1569 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1572 "Error: Cannot connect even after starting the Emacs daemon\n");
1573 exit (EXIT_FAILURE
);
1575 #endif /* WINDOWSNT */
1579 main (int argc
, char **argv
)
1581 int rl
= 0, needlf
= 0;
1583 char string
[BUFSIZ
+1];
1584 int start_daemon_if_needed
;
1585 int exit_status
= EXIT_SUCCESS
;
1591 /* On Windows 7 and later, we need to explicitly associate
1592 emacsclient with emacs so the UI behaves sensibly. This
1593 association does no harm if we're not actually connecting to an
1594 Emacs using a window display. */
1595 w32_set_user_model_id ();
1596 #endif /* HAVE_NTGUI */
1598 /* Process options. */
1599 decode_options (argc
, argv
);
1601 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1603 message (true, "%s: file name or argument required\n"
1604 "Try `%s --help' for more information\n",
1605 progname
, progname
);
1606 exit (EXIT_FAILURE
);
1612 pid_t pgrp
= getpgrp ();
1613 pid_t tcpgrp
= tcgetpgrp (1);
1614 if (0 <= tcpgrp
&& tcpgrp
!= pgrp
)
1615 kill (-pgrp
, SIGTTIN
);
1617 #endif /* !WINDOWSNT */
1619 /* If alternate_editor is the empty string, start the emacs daemon
1620 in case of failure to connect. */
1621 start_daemon_if_needed
= (alternate_editor
1622 && (alternate_editor
[0] == '\0'));
1624 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1625 if (emacs_socket
== INVALID_SOCKET
)
1627 if (! start_daemon_if_needed
)
1630 start_daemon_and_retry_set_socket ();
1633 cwd
= get_current_dir_name ();
1636 message (true, "%s: %s\n", progname
,
1637 "Cannot get current working directory");
1642 if (display
&& !strcmp (display
, "w32"))
1644 #endif /* HAVE_NTGUI */
1646 /* Send over our environment and current directory. */
1650 for (i
= 0; environ
[i
]; i
++)
1652 send_to_emacs (emacs_socket
, "-env ");
1653 quote_argument (emacs_socket
, environ
[i
]);
1654 send_to_emacs (emacs_socket
, " ");
1657 send_to_emacs (emacs_socket
, "-dir ");
1658 quote_argument (emacs_socket
, cwd
);
1659 send_to_emacs (emacs_socket
, "/");
1660 send_to_emacs (emacs_socket
, " ");
1664 send_to_emacs (emacs_socket
, "-nowait ");
1667 send_to_emacs (emacs_socket
, "-current-frame ");
1671 send_to_emacs (emacs_socket
, "-display ");
1672 quote_argument (emacs_socket
, display
);
1673 send_to_emacs (emacs_socket
, " ");
1678 send_to_emacs (emacs_socket
, "-parent-id ");
1679 quote_argument (emacs_socket
, parent_id
);
1680 send_to_emacs (emacs_socket
, " ");
1683 if (frame_parameters
&& !current_frame
)
1685 send_to_emacs (emacs_socket
, "-frame-parameters ");
1686 quote_argument (emacs_socket
, frame_parameters
);
1687 send_to_emacs (emacs_socket
, " ");
1690 /* Unless we are certain we don't want to occupy the tty, send our
1691 tty information to Emacs. For example, in daemon mode Emacs may
1692 need to occupy this tty if no other frame is available. */
1693 if (!current_frame
|| !eval
)
1695 const char *tty_type
, *tty_name
;
1697 if (find_tty (&tty_type
, &tty_name
, !tty
))
1699 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1702 send_to_emacs (emacs_socket
, "-tty ");
1703 quote_argument (emacs_socket
, tty_name
);
1704 send_to_emacs (emacs_socket
, " ");
1705 quote_argument (emacs_socket
, tty_type
);
1706 send_to_emacs (emacs_socket
, " ");
1710 if (!current_frame
&& !tty
)
1711 send_to_emacs (emacs_socket
, "-window-system ");
1713 if ((argc
- optind
> 0))
1716 for (i
= optind
; i
< argc
; i
++)
1721 /* Don't prepend cwd or anything like that. */
1722 send_to_emacs (emacs_socket
, "-eval ");
1723 quote_argument (emacs_socket
, argv
[i
]);
1724 send_to_emacs (emacs_socket
, " ");
1728 if (*argv
[i
] == '+')
1730 char *p
= argv
[i
] + 1;
1731 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1734 send_to_emacs (emacs_socket
, "-position ");
1735 quote_argument (emacs_socket
, argv
[i
]);
1736 send_to_emacs (emacs_socket
, " ");
1741 else if (! file_name_absolute_p (argv
[i
])
1742 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1743 /* Windows can have a different default directory for each
1744 drive, so the cwd passed via "-dir" is not sufficient
1745 to account for that.
1746 If the user uses <drive>:<relpath>, we hence need to be
1747 careful to expand <relpath> with the default directory
1748 corresponding to <drive>. */
1750 char *filename
= (char *) xmalloc (MAX_PATH
);
1753 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1754 if (size
> 0 && size
< MAX_PATH
)
1761 send_to_emacs (emacs_socket
, "-file ");
1762 quote_argument (emacs_socket
, argv
[i
]);
1763 send_to_emacs (emacs_socket
, " ");
1768 /* Read expressions interactively. */
1769 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1771 send_to_emacs (emacs_socket
, "-eval ");
1772 quote_argument (emacs_socket
, str
);
1774 send_to_emacs (emacs_socket
, " ");
1777 send_to_emacs (emacs_socket
, "\n");
1779 /* Wait for an answer. */
1780 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1782 printf ("Waiting for Emacs...");
1786 while (fdatasync (1) != 0 && errno
== EINTR
)
1789 /* Now, wait for an answer and print any messages. */
1790 while (exit_status
== EXIT_SUCCESS
)
1796 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1798 /* If we receive a signal (e.g. SIGWINCH, which we pass
1799 through to Emacs), on some OSes we get EINTR and must retry. */
1800 while (rl
< 0 && errno
== EINTR
);
1807 /* Loop over all NL-terminated messages. */
1808 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1810 end_p
= strchr (p
, '\n');
1814 if (strprefix ("-emacs-pid ", p
))
1816 /* -emacs-pid PID: The process id of the Emacs process. */
1817 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1819 else if (strprefix ("-window-system-unsupported ", p
))
1821 /* -window-system-unsupported: Emacs was compiled without support
1822 for whatever window system we tried. Try the alternate
1823 display, or, failing that, try the terminal. */
1826 display
= alt_display
;
1837 else if (strprefix ("-print ", p
))
1839 /* -print STRING: Print STRING on the terminal. */
1840 str
= unquote_argument (p
+ strlen ("-print "));
1844 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1846 else if (strprefix ("-print-nonl ", p
))
1848 /* -print-nonl STRING: Print STRING on the terminal.
1849 Used to continue a preceding -print command. */
1850 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1852 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1854 else if (strprefix ("-error ", p
))
1856 /* -error DESCRIPTION: Signal an error on the terminal. */
1857 str
= unquote_argument (p
+ strlen ("-error "));
1860 fprintf (stderr
, "*ERROR*: %s", str
);
1861 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1862 exit_status
= EXIT_FAILURE
;
1865 else if (strprefix ("-suspend ", p
))
1867 /* -suspend: Suspend this terminal, i.e., stop the process. */
1876 /* Unknown command. */
1880 printf ("*ERROR*: Unknown message: %s\n", p
);
1888 while (fdatasync (1) != 0 && errno
== EINTR
)
1892 exit_status
= EXIT_FAILURE
;
1894 CLOSE_SOCKET (emacs_socket
);
1898 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */