1 /* Client process that communicates with GNU Emacs acting as server.
3 Copyright (C) 1986-1987, 1994, 1999-2016 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 (at
10 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 (const 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 */
88 #define VERSION "unspecified"
93 #define EXIT_SUCCESS 0
97 #define EXIT_FAILURE 1
100 /* Additional space when allocating buffers for filenames, etc. */
101 #define EXTRA_SPACE 100
106 #define min(x, y) (((x) < (y)) ? (x) : (y))
109 /* Name used to invoke this program. */
110 const char *progname
;
112 /* The second argument to main. */
115 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
118 /* Nonzero means don't print messages for successful operations. --quiet. */
121 /* Nonzero means args are expressions to be evaluated. --eval. */
124 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
125 int current_frame
= 1;
127 /* The display on which Emacs should work. --display. */
128 const char *display
= NULL
;
130 /* The alternate display we should try if Emacs does not support display. */
131 const char *alt_display
= NULL
;
133 /* The parent window ID, if we are opening a frame via XEmbed. */
134 char *parent_id
= NULL
;
136 /* Nonzero means open a new Emacs frame on the current terminal. */
139 /* If non-NULL, the name of an editor to fallback to if the server
140 is not running. --alternate-editor. */
141 const char *alternate_editor
= NULL
;
143 /* If non-NULL, the filename of the UNIX socket. */
144 const char *socket_name
= NULL
;
146 /* If non-NULL, the filename of the authentication file. */
147 const char *server_file
= NULL
;
149 /* PID of the Emacs server process. */
152 /* If non-NULL, a string that should form a frame parameter alist to
153 be used for the new frame. */
154 const char *frame_parameters
= NULL
;
156 static _Noreturn
void print_help_and_exit (void);
159 struct option longopts
[] =
161 { "no-wait", no_argument
, NULL
, 'n' },
162 { "quiet", no_argument
, NULL
, 'q' },
163 { "eval", no_argument
, NULL
, 'e' },
164 { "help", no_argument
, NULL
, 'H' },
165 { "version", no_argument
, NULL
, 'V' },
166 { "tty", no_argument
, NULL
, 't' },
167 { "nw", no_argument
, NULL
, 't' },
168 { "create-frame", no_argument
, NULL
, 'c' },
169 { "alternate-editor", required_argument
, NULL
, 'a' },
170 { "frame-parameters", required_argument
, NULL
, 'F' },
171 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
172 { "socket-name", required_argument
, NULL
, 's' },
174 { "server-file", required_argument
, NULL
, 'f' },
175 { "display", required_argument
, NULL
, 'd' },
176 { "parent-id", required_argument
, NULL
, 'p' },
181 /* Like malloc but get fatal error if memory is exhausted. */
184 xmalloc (size_t size
)
186 void *result
= malloc (size
);
196 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
198 char *get_current_dir_name (void);
200 /* Return the current working directory. Returns NULL on errors.
201 Any other returned value must be freed with free. This is used
202 only when get_current_dir_name is not defined on the system. */
204 get_current_dir_name (void)
208 struct stat dotstat
, pwdstat
;
209 /* If PWD is accurate, use it instead of calling getcwd. PWD is
210 sometimes a nicer name, and using it may avoid a fatal error if a
211 parent directory is searchable but not readable. */
212 if ((pwd
= egetenv ("PWD")) != 0
213 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
214 && stat (pwd
, &pwdstat
) == 0
215 && stat (".", &dotstat
) == 0
216 && dotstat
.st_ino
== pwdstat
.st_ino
217 && dotstat
.st_dev
== pwdstat
.st_dev
219 && strlen (pwd
) < MAXPATHLEN
223 buf
= (char *) xmalloc (strlen (pwd
) + 1);
228 size_t buf_size
= 1024;
232 buf
= malloc (buf_size
);
235 if (getcwd (buf
, buf_size
) == buf
)
239 if (tmp_errno
!= ERANGE
)
258 /* Like strdup but get a fatal error if memory is exhausted. */
259 char *xstrdup (const char *);
262 xstrdup (const char *s
)
264 char *result
= strdup (s
);
273 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
275 char *w32_get_resource (HKEY
, const char *, LPDWORD
);
277 /* Retrieve an environment variable from the Emacs subkeys of the registry.
278 Return NULL if the variable was not found, or it was empty.
279 This code is based on w32_get_resource (w32.c). */
281 w32_get_resource (HKEY predefined
, const char *key
, LPDWORD type
)
283 HKEY hrootkey
= NULL
;
287 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
289 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
291 result
= (char *) xmalloc (cbData
);
293 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, (LPBYTE
)result
, &cbData
) != ERROR_SUCCESS
)
301 RegCloseKey (hrootkey
);
308 getenv wrapper for Windows
310 Value is allocated on the heap, and can be free'd.
312 This is needed to duplicate Emacs's behavior, which is to look for
313 environment variables in the registry if they don't appear in the
316 w32_getenv (const char *envvar
)
321 if ((value
= getenv (envvar
)))
322 /* Found in the environment. strdup it, because values returned
323 by getenv cannot be free'd. */
324 return xstrdup (value
);
326 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
327 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
329 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
330 if (strcmp (envvar
, "TERM") == 0)
331 return xstrdup ("w32console");
332 /* Found neither in the environment nor in the registry. */
336 if (dwType
== REG_SZ
)
337 /* Registry; no need to expand. */
340 if (dwType
== REG_EXPAND_SZ
)
344 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
346 char *buffer
= (char *) xmalloc (size
);
347 if (ExpandEnvironmentStrings (value
, buffer
, size
))
349 /* Found and expanded. */
354 /* Error expanding. */
359 /* Not the right type, or not correctly expanded. */
364 int w32_window_app (void);
367 w32_window_app (void)
369 static int window_app
= -1;
370 char szTitle
[MAX_PATH
];
374 /* Checking for STDOUT does not work; it's a valid handle also in
375 nonconsole apps. Testing for the console title seems to work. */
376 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
378 InitCommonControls ();
384 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
386 This is necessary due to the broken implementation of exec* routines in
387 the Microsoft libraries: they concatenate the arguments together without
388 quoting special characters, and pass the result to CreateProcess, with
389 predictably bad results. By contrast, POSIX execvp passes the arguments
390 directly into the argv array of the child process. */
392 int w32_execvp (const char *, char **);
395 w32_execvp (const char *path
, char **argv
)
399 /* Required to allow a .BAT script as alternate editor. */
400 argv
[0] = (char *) alternate_editor
;
402 for (i
= 0; argv
[i
]; i
++)
403 if (strchr (argv
[i
], ' '))
405 char *quoted
= alloca (strlen (argv
[i
]) + 3);
406 sprintf (quoted
, "\"%s\"", argv
[i
]);
410 return execvp (path
, argv
);
414 #define execvp w32_execvp
416 /* Emulation of ttyname for Windows. */
417 const char *ttyname (int);
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. */
606 #endif /* WINDOWSNT */
610 static _Noreturn
void
611 print_help_and_exit (void)
613 /* Spaces and tabs are significant in this message; they're chosen so the
614 message aligns properly both in a tty and in a Windows message box.
615 Please try to preserve them; otherwise the output is very hard to read
616 when using emacsclientw. */
618 "Usage: %s [OPTIONS] FILE...\n%s%s%s", progname
, "\
619 Tell the Emacs server to visit the specified files.\n\
620 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
622 The following OPTIONS are accepted:\n\
623 -V, --version Just print version info and return\n\
624 -H, --help Print this usage information message\n\
625 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
626 -c, --create-frame Create a new frame instead of trying to\n\
627 use the current Emacs frame\n\
629 -F ALIST, --frame-parameters=ALIST\n\
630 Set the parameters of a new frame\n\
631 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
632 -n, --no-wait Don't wait for the server to return\n\
633 -q, --quiet Don't display messages on success\n\
634 -d DISPLAY, --display=DISPLAY\n\
635 Visit the file in the given display\n\
637 --parent-id=ID Open in parent window ID, via XEmbed\n"
638 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
639 "-s SOCKET, --socket-name=SOCKET\n\
640 Set filename of the UNIX socket for communication\n"
642 "-f SERVER, --server-file=SERVER\n\
643 Set filename of the TCP authentication file\n\
644 -a EDITOR, --alternate-editor=EDITOR\n\
645 Editor to fallback to if the server is not running\n"
646 " If EDITOR is the empty string, start Emacs in daemon\n\
647 mode and try connecting again\n"
649 Report bugs with M-x report-emacs-bug.\n");
653 /* Try to run a different command, or --if no alternate editor is
654 defined-- exit with an errorcode.
655 Uses argv, but gets it from the global variable main_argv. */
657 static _Noreturn
void
660 if (alternate_editor
)
664 execvp (alternate_editor
, main_argv
+ i
);
665 message (true, "%s: error executing alternate editor \"%s\"\n",
666 progname
, alternate_editor
);
672 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
675 main (int argc
, char **argv
)
679 message (true, "%s: Sorry, the Emacs server is supported only\n"
680 "on systems with Berkeley sockets.\n",
685 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
687 #define AUTH_KEY_LENGTH 64
688 #define SEND_BUFFER_SIZE 4096
690 /* Buffer to accumulate data to send in TCP connections. */
691 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
692 int sblen
= 0; /* Fill pointer for the send buffer. */
693 /* Socket used to communicate with the Emacs server process. */
694 HSOCKET emacs_socket
= 0;
696 /* On Windows, the socket library was historically separate from the
697 standard C library, so errors are handled differently. */
700 sock_err_message (const char *function_name
)
705 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
706 | FORMAT_MESSAGE_ALLOCATE_BUFFER
707 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
708 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
710 message (true, "%s: %s: %s\n", progname
, function_name
, msg
);
714 message (true, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
719 /* Let's send the data to Emacs when either
720 - the data ends in "\n", or
721 - the buffer is full (but this shouldn't happen)
722 Otherwise, we just accumulate it. */
724 send_to_emacs (HSOCKET s
, const char *data
)
731 dlen
= strlen (data
);
734 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
735 memcpy (&send_buffer
[sblen
], data
, part
);
739 if (sblen
== SEND_BUFFER_SIZE
740 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
742 int sent
= send (s
, send_buffer
, sblen
, 0);
745 message (true, "%s: failed to send %d bytes to socket: %s\n",
746 progname
, sblen
, strerror (errno
));
750 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
759 /* In STR, insert a & before each &, each space, each newline, and
760 any initial -. Change spaces to underscores, too, so that the
761 return value never contains a space.
763 Does not change the string. Outputs the result to S. */
765 quote_argument (HSOCKET s
, const char *str
)
767 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
789 if (*p
== '&' || (*p
== '-' && p
== str
))
796 send_to_emacs (s
, copy
);
802 /* The inverse of quote_argument. Removes quoting in string STR by
803 modifying the string in place. Returns STR. */
806 unquote_argument (char *str
)
837 file_name_absolute_p (const char *filename
)
839 /* Sanity check, it shouldn't happen. */
840 if (! filename
) return false;
842 /* /xxx is always an absolute path. */
843 if (filename
[0] == '/') return true;
845 /* Empty filenames (which shouldn't happen) are relative. */
846 if (filename
[0] == '\0') return false;
849 /* X:\xxx is always absolute. */
850 if (isalpha ((unsigned char) filename
[0])
851 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
854 /* Both \xxx and \\xxx\yyy are absolute. */
855 if (filename
[0] == '\\') return true;
862 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
863 void __cdecl
close_winsock (void);
870 /* Initialize the WinSock2 library. */
871 void initialize_sockets (void);
873 initialize_sockets (void)
877 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
879 message (true, "%s: error initializing WinSock2\n", progname
);
883 atexit (close_winsock
);
885 #endif /* WINDOWSNT */
888 /* Read the information needed to set up a TCP comm channel with
889 the Emacs server: host, port, and authentication string. */
892 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
893 char *authentication
)
899 if (file_name_absolute_p (config_file
))
900 config
= fopen (config_file
, "rb");
903 const char *home
= egetenv ("HOME");
907 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
909 char *z
= stpcpy (path
, home
);
910 z
= stpcpy (z
, "/.emacs.d/server/");
911 strcpy (z
, config_file
);
912 config
= fopen (path
, "rb");
916 if (!config
&& (home
= egetenv ("APPDATA")))
918 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
920 char *z
= stpcpy (path
, home
);
921 z
= stpcpy (z
, "/.emacs.d/server/");
922 strcpy (z
, config_file
);
923 config
= fopen (path
, "rb");
932 if (fgets (dotted
, sizeof dotted
, config
)
933 && (port
= strchr (dotted
, ':')))
937 message (true, "%s: invalid configuration info\n", progname
);
941 server
->sin_family
= AF_INET
;
942 server
->sin_addr
.s_addr
= inet_addr (dotted
);
943 server
->sin_port
= htons (atoi (port
));
945 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
947 message (true, "%s: cannot read authentication info\n", progname
);
957 set_tcp_socket (const char *local_server_file
)
960 struct sockaddr_in server
;
961 struct linger l_arg
= {1, 1};
962 char auth_string
[AUTH_KEY_LENGTH
+ 1];
964 if (! get_server_config (local_server_file
, &server
, auth_string
))
965 return INVALID_SOCKET
;
967 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
968 message (false, "%s: connected to remote socket at %s\n",
969 progname
, inet_ntoa (server
.sin_addr
));
971 /* Open up an AF_INET socket. */
972 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
974 /* Since we have an alternate to try out, this is not an error
975 yet; popping out a modal dialog at this stage would make -a
976 option totally useless for emacsclientw -- the user will
977 still get an error message if the alternate editor fails. */
979 if(!(w32_window_app () && alternate_editor
))
981 sock_err_message ("socket");
982 return INVALID_SOCKET
;
985 /* Set up the socket. */
986 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
989 if(!(w32_window_app () && alternate_editor
))
991 sock_err_message ("connect");
992 return INVALID_SOCKET
;
995 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
997 /* Send the authentication. */
998 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1000 send_to_emacs (s
, "-auth ");
1001 send_to_emacs (s
, auth_string
);
1002 send_to_emacs (s
, " ");
1008 /* Returns 1 if PREFIX is a prefix of STRING. */
1010 strprefix (const char *prefix
, const char *string
)
1012 return !strncmp (prefix
, string
, strlen (prefix
));
1015 /* Get tty name and type. If successful, return the type in TTY_TYPE
1016 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1017 is zero, or return 0 if NOABORT is non-zero. */
1020 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1022 const char *type
= egetenv ("TERM");
1023 const char *name
= ttyname (fileno (stdout
));
1031 message (true, "%s: could not get terminal name\n", progname
);
1042 message (true, "%s: please set the TERM variable to your terminal type\n",
1048 if (strcmp (type
, "eterm") == 0)
1054 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1055 message (true, "%s: opening a frame in an Emacs term buffer"
1056 " is not supported\n", progname
);
1067 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1069 /* Three possibilities:
1070 2 - can't be `stat'ed (sets errno)
1071 1 - isn't owned by us
1072 0 - success: none of the above */
1075 socket_status (const char *name
)
1077 struct stat statbfr
;
1079 if (stat (name
, &statbfr
) == -1)
1082 if (statbfr
.st_uid
!= geteuid ())
1089 /* A signal handler that passes the signal to the Emacs process.
1090 Useful for SIGWINCH. */
1093 pass_signal_to_emacs (int signalnum
)
1095 int old_errno
= errno
;
1098 kill (emacs_pid
, signalnum
);
1100 signal (signalnum
, pass_signal_to_emacs
);
1104 /* Signal handler for SIGCONT; notify the Emacs process that it can
1105 now resume our tty frame. */
1108 handle_sigcont (int signalnum
)
1110 int old_errno
= errno
;
1111 pid_t pgrp
= getpgrp ();
1112 pid_t tcpgrp
= tcgetpgrp (1);
1116 /* We are in the foreground. */
1117 send_to_emacs (emacs_socket
, "-resume \n");
1119 else if (0 <= tcpgrp
&& tty
)
1121 /* We are in the background; cancel the continue. */
1122 kill (-pgrp
, SIGTTIN
);
1125 signal (signalnum
, handle_sigcont
);
1129 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1130 going to sleep. Normally the suspend is initiated by Emacs via
1131 server-handle-suspend-tty, but if the server gets out of sync with
1132 reality, we may get a SIGTSTP on C-z. Handling this signal and
1133 notifying Emacs about it should get things under control again. */
1136 handle_sigtstp (int signalnum
)
1138 int old_errno
= errno
;
1142 send_to_emacs (emacs_socket
, "-suspend \n");
1144 /* Unblock this signal and call the default handler by temporarily
1145 changing the handler and resignaling. */
1146 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1147 sigdelset (&set
, signalnum
);
1148 signal (signalnum
, SIG_DFL
);
1150 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1151 signal (signalnum
, handle_sigtstp
);
1157 /* Set up signal handlers before opening a frame on the current tty. */
1162 /* Set up signal handlers. */
1163 signal (SIGWINCH
, pass_signal_to_emacs
);
1165 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1166 deciding which terminal the signal came from. C-g is now a
1167 normal input event on secondary terminals. */
1169 signal (SIGINT
, pass_signal_to_emacs
);
1170 signal (SIGQUIT
, pass_signal_to_emacs
);
1173 signal (SIGCONT
, handle_sigcont
);
1174 signal (SIGTSTP
, handle_sigtstp
);
1175 signal (SIGTTOU
, handle_sigtstp
);
1180 set_local_socket (const char *local_socket_name
)
1183 struct sockaddr_un server
;
1185 /* Open up an AF_UNIX socket in this person's home directory. */
1186 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1188 message (true, "%s: socket: %s\n", progname
, strerror (errno
));
1189 return INVALID_SOCKET
;
1192 server
.sun_family
= AF_UNIX
;
1197 const char *server_name
= local_socket_name
;
1198 const char *tmpdir
= NULL
;
1199 char *tmpdir_storage
= NULL
;
1200 char *socket_name_storage
= NULL
;
1202 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1204 /* socket_name is a file name component. */
1205 long uid
= geteuid ();
1206 tmpdir
= egetenv ("TMPDIR");
1210 #ifndef _CS_DARWIN_USER_TEMP_DIR
1211 #define _CS_DARWIN_USER_TEMP_DIR 65537
1213 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1216 tmpdir
= tmpdir_storage
= xmalloc (n
);
1217 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1223 socket_name_storage
=
1224 xmalloc (strlen (tmpdir
) + strlen (server_name
) + EXTRA_SPACE
);
1225 char *z
= stpcpy (socket_name_storage
, tmpdir
);
1226 z
+= sprintf (z
, "/emacs%ld/", uid
);
1227 strcpy (z
, server_name
);
1228 local_socket_name
= socket_name_storage
;
1231 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1232 strcpy (server
.sun_path
, local_socket_name
);
1235 message (true, "%s: socket-name %s too long\n",
1236 progname
, local_socket_name
);
1240 /* See if the socket exists, and if it's owned by us. */
1241 sock_status
= socket_status (server
.sun_path
);
1242 saved_errno
= errno
;
1243 if (sock_status
&& tmpdir
)
1245 /* Failing that, see if LOGNAME or USER exist and differ from
1246 our euid. If so, look for a socket based on the UID
1247 associated with the name. This is reminiscent of the logic
1248 that init_editfns uses to set the global Vuser_full_name. */
1250 const char *user_name
= egetenv ("LOGNAME");
1253 user_name
= egetenv ("USER");
1257 struct passwd
*pw
= getpwnam (user_name
);
1259 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1261 /* We're running under su, apparently. */
1262 long uid
= pw
->pw_uid
;
1263 char *user_socket_name
1264 = xmalloc (strlen (tmpdir
) + strlen (server_name
)
1266 char *z
= stpcpy (user_socket_name
, tmpdir
);
1267 z
+= sprintf (z
, "/emacs%ld/", uid
);
1268 strcpy (z
, server_name
);
1270 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1271 strcpy (server
.sun_path
, user_socket_name
);
1274 message (true, "%s: socket-name %s too long\n",
1275 progname
, user_socket_name
);
1276 exit (EXIT_FAILURE
);
1278 free (user_socket_name
);
1280 sock_status
= socket_status (server
.sun_path
);
1281 saved_errno
= errno
;
1284 errno
= saved_errno
;
1288 free (socket_name_storage
);
1289 free (tmpdir_storage
);
1291 switch (sock_status
)
1294 /* There's a socket, but it isn't owned by us. This is OK if
1296 if (0 != geteuid ())
1298 message (true, "%s: Invalid socket owner\n", progname
);
1299 return INVALID_SOCKET
;
1305 if (saved_errno
== ENOENT
)
1307 "%s: can't find socket; have you started the server?\n\
1308 To start the server in Emacs, type \"M-x server-start\".\n",
1311 message (true, "%s: can't stat %s: %s\n",
1312 progname
, server
.sun_path
, strerror (saved_errno
));
1313 return INVALID_SOCKET
;
1317 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1320 message (true, "%s: connect: %s\n", progname
, strerror (errno
));
1321 return INVALID_SOCKET
;
1326 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1329 set_socket (int no_exit_if_error
)
1332 const char *local_server_file
= server_file
;
1336 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1337 /* Explicit --socket-name argument. */
1340 s
= set_local_socket (socket_name
);
1341 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1343 message (true, "%s: error accessing socket \"%s\"\n",
1344 progname
, socket_name
);
1345 exit (EXIT_FAILURE
);
1349 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1350 if (!local_server_file
)
1351 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1353 if (local_server_file
)
1355 s
= set_tcp_socket (local_server_file
);
1356 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1359 message (true, "%s: error accessing server file \"%s\"\n",
1360 progname
, local_server_file
);
1361 exit (EXIT_FAILURE
);
1364 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1365 /* Implicit local socket. */
1366 s
= set_local_socket ("server");
1367 if (s
!= INVALID_SOCKET
)
1371 /* Implicit server file. */
1372 s
= set_tcp_socket ("server");
1373 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1376 /* No implicit or explicit socket, and no alternate editor. */
1377 message (true, "%s: No socket or alternate editor. Please use:\n\n"
1378 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1381 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1382 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1384 exit (EXIT_FAILURE
);
1388 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1389 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1391 void w32_set_user_model_id (void);
1394 w32_set_user_model_id (void)
1397 HRESULT (WINAPI
* set_user_model
) (const wchar_t * id
);
1399 /* On Windows 7 and later, we need to set the user model ID
1400 to associate emacsclient launched files with Emacs frames
1402 shell
= LoadLibrary ("shell32.dll");
1406 = (void *) GetProcAddress (shell
,
1407 "SetCurrentProcessExplicitAppUserModelID");
1408 /* If the function is defined, then we are running on Windows 7
1409 or newer, and the UI uses this to group related windows
1410 together. Since emacs, runemacs, emacsclient are related, we
1411 want them grouped even though the executables are different,
1412 so we need to set a consistent ID between them. */
1414 set_user_model (L
"GNU.Emacs");
1416 FreeLibrary (shell
);
1420 BOOL CALLBACK
w32_find_emacs_process (HWND
, LPARAM
);
1423 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1428 /* Reject any window not of class "Emacs". */
1429 if (! get_wc (hWnd
, class, sizeof (class))
1430 || strcmp (class, "Emacs"))
1433 /* We only need the process id, not the thread id. */
1434 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1436 /* Not the one we're looking for. */
1437 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1439 /* OK, let's raise it. */
1442 /* Stop enumeration. */
1446 /* Search for a window of class "Emacs" and owned by a process with
1447 process id = emacs_pid. If found, allow it to grab the focus. */
1448 void w32_give_focus (void);
1451 w32_give_focus (void)
1455 /* It shouldn't happen when dealing with TCP sockets. */
1456 if (!emacs_pid
) return;
1458 user32
= GetModuleHandle ("user32.dll");
1463 /* Modern Windows restrict which processes can set the foreground window.
1464 emacsclient can allow Emacs to grab the focus by calling the function
1465 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1466 NT) lack this function, so we have to check its availability. */
1467 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1468 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1469 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1471 #endif /* HAVE_NTGUI */
1473 /* Start the emacs daemon and try to connect to it. */
1476 start_daemon_and_retry_set_socket (void)
1487 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1489 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1491 message (true, "Error: Could not start the Emacs daemon\n");
1492 exit (EXIT_FAILURE
);
1495 /* Try connecting, the daemon should have started by now. */
1496 message (true, "Emacs daemon should have started, trying to connect again\n");
1497 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1499 message (true, "Error: Cannot connect even after starting the Emacs daemon\n");
1500 exit (EXIT_FAILURE
);
1505 fprintf (stderr
, "Error: Cannot fork!\n");
1506 exit (EXIT_FAILURE
);
1510 char emacs
[] = "emacs";
1511 char daemon_option
[] = "--daemon";
1514 d_argv
[1] = daemon_option
;
1516 if (socket_name
!= NULL
)
1518 /* Pass --daemon=socket_name as argument. */
1519 const char *deq
= "--daemon=";
1520 char *daemon_arg
= xmalloc (strlen (deq
)
1521 + strlen (socket_name
) + 1);
1522 strcpy (stpcpy (daemon_arg
, deq
), socket_name
);
1523 d_argv
[1] = daemon_arg
;
1525 execvp ("emacs", d_argv
);
1526 message (true, "%s: error starting emacs daemon\n", progname
);
1528 #else /* WINDOWSNT */
1530 HANDLE w32_daemon_event
;
1532 PROCESS_INFORMATION pi
;
1534 ZeroMemory (&si
, sizeof si
);
1536 ZeroMemory (&pi
, sizeof pi
);
1538 /* We start Emacs in daemon mode, and then wait for it to signal us
1539 it is ready to accept client connections, by asserting an event
1540 whose name is known to the daemon (defined by nt/inc/ms-w32.h). */
1542 if (!CreateProcess (NULL
, (LPSTR
)"emacs --daemon", NULL
, NULL
, FALSE
,
1543 CREATE_NO_WINDOW
, NULL
, NULL
, &si
, &pi
))
1547 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
1548 | FORMAT_MESSAGE_ALLOCATE_BUFFER
1549 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
1550 NULL
, GetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
1551 message (true, "%s: error starting emacs daemon (%s)\n", progname
, msg
);
1552 exit (EXIT_FAILURE
);
1555 w32_daemon_event
= CreateEvent (NULL
, TRUE
, FALSE
, W32_DAEMON_EVENT
);
1556 if (w32_daemon_event
== NULL
)
1558 message (true, "Couldn't create Windows daemon event");
1559 exit (EXIT_FAILURE
);
1561 if ((wait_result
= WaitForSingleObject (w32_daemon_event
, INFINITE
))
1564 const char *msg
= NULL
;
1566 switch (wait_result
)
1568 case WAIT_ABANDONED
:
1569 msg
= "The daemon exited unexpectedly";
1572 /* Can't happen due to INFINITE. */
1575 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
1576 | FORMAT_MESSAGE_ALLOCATE_BUFFER
1577 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
1578 NULL
, GetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
1581 message (true, "Error: Could not start the Emacs daemon: %s\n", msg
);
1582 exit (EXIT_FAILURE
);
1584 CloseHandle (w32_daemon_event
);
1586 /* Try connecting, the daemon should have started by now. */
1587 /* It's just a progress message, so don't pop a dialog if this is
1589 if (!w32_window_app ())
1591 "Emacs daemon should have started, trying to connect again\n");
1592 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1595 "Error: Cannot connect even after starting the Emacs daemon\n");
1596 exit (EXIT_FAILURE
);
1598 #endif /* WINDOWSNT */
1602 main (int argc
, char **argv
)
1604 int rl
= 0, needlf
= 0;
1606 char string
[BUFSIZ
+1];
1607 int start_daemon_if_needed
;
1608 int exit_status
= EXIT_SUCCESS
;
1614 /* On Windows 7 and later, we need to explicitly associate
1615 emacsclient with emacs so the UI behaves sensibly. This
1616 association does no harm if we're not actually connecting to an
1617 Emacs using a window display. */
1618 w32_set_user_model_id ();
1619 #endif /* HAVE_NTGUI */
1621 /* Process options. */
1622 decode_options (argc
, argv
);
1624 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1626 message (true, "%s: file name or argument required\n"
1627 "Try '%s --help' for more information\n",
1628 progname
, progname
);
1629 exit (EXIT_FAILURE
);
1635 pid_t pgrp
= getpgrp ();
1636 pid_t tcpgrp
= tcgetpgrp (1);
1637 if (0 <= tcpgrp
&& tcpgrp
!= pgrp
)
1638 kill (-pgrp
, SIGTTIN
);
1640 #endif /* !WINDOWSNT */
1642 /* If alternate_editor is the empty string, start the emacs daemon
1643 in case of failure to connect. */
1644 start_daemon_if_needed
= (alternate_editor
1645 && (alternate_editor
[0] == '\0'));
1647 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1648 if (emacs_socket
== INVALID_SOCKET
)
1650 if (! start_daemon_if_needed
)
1653 start_daemon_and_retry_set_socket ();
1656 cwd
= get_current_dir_name ();
1659 message (true, "%s: %s\n", progname
,
1660 "Cannot get current working directory");
1665 if (display
&& !strcmp (display
, "w32"))
1667 #endif /* HAVE_NTGUI */
1669 /* Send over our environment and current directory. */
1673 for (i
= 0; environ
[i
]; i
++)
1675 send_to_emacs (emacs_socket
, "-env ");
1676 quote_argument (emacs_socket
, environ
[i
]);
1677 send_to_emacs (emacs_socket
, " ");
1680 send_to_emacs (emacs_socket
, "-dir ");
1681 quote_argument (emacs_socket
, cwd
);
1682 send_to_emacs (emacs_socket
, "/");
1683 send_to_emacs (emacs_socket
, " ");
1687 send_to_emacs (emacs_socket
, "-nowait ");
1690 send_to_emacs (emacs_socket
, "-current-frame ");
1694 send_to_emacs (emacs_socket
, "-display ");
1695 quote_argument (emacs_socket
, display
);
1696 send_to_emacs (emacs_socket
, " ");
1701 send_to_emacs (emacs_socket
, "-parent-id ");
1702 quote_argument (emacs_socket
, parent_id
);
1703 send_to_emacs (emacs_socket
, " ");
1706 if (frame_parameters
&& !current_frame
)
1708 send_to_emacs (emacs_socket
, "-frame-parameters ");
1709 quote_argument (emacs_socket
, frame_parameters
);
1710 send_to_emacs (emacs_socket
, " ");
1713 /* Unless we are certain we don't want to occupy the tty, send our
1714 tty information to Emacs. For example, in daemon mode Emacs may
1715 need to occupy this tty if no other frame is available. */
1716 if (!current_frame
|| !eval
)
1718 const char *tty_type
, *tty_name
;
1720 if (find_tty (&tty_type
, &tty_name
, !tty
))
1722 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1725 send_to_emacs (emacs_socket
, "-tty ");
1726 quote_argument (emacs_socket
, tty_name
);
1727 send_to_emacs (emacs_socket
, " ");
1728 quote_argument (emacs_socket
, tty_type
);
1729 send_to_emacs (emacs_socket
, " ");
1733 if (!current_frame
&& !tty
)
1734 send_to_emacs (emacs_socket
, "-window-system ");
1736 if ((argc
- optind
> 0))
1739 for (i
= optind
; i
< argc
; i
++)
1744 /* Don't prepend cwd or anything like that. */
1745 send_to_emacs (emacs_socket
, "-eval ");
1746 quote_argument (emacs_socket
, argv
[i
]);
1747 send_to_emacs (emacs_socket
, " ");
1751 if (*argv
[i
] == '+')
1753 char *p
= argv
[i
] + 1;
1754 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1757 send_to_emacs (emacs_socket
, "-position ");
1758 quote_argument (emacs_socket
, argv
[i
]);
1759 send_to_emacs (emacs_socket
, " ");
1764 else if (! file_name_absolute_p (argv
[i
])
1765 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1766 /* Windows can have a different default directory for each
1767 drive, so the cwd passed via "-dir" is not sufficient
1768 to account for that.
1769 If the user uses <drive>:<relpath>, we hence need to be
1770 careful to expand <relpath> with the default directory
1771 corresponding to <drive>. */
1773 char *filename
= (char *) xmalloc (MAX_PATH
);
1776 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1777 if (size
> 0 && size
< MAX_PATH
)
1784 send_to_emacs (emacs_socket
, "-file ");
1785 quote_argument (emacs_socket
, argv
[i
]);
1786 send_to_emacs (emacs_socket
, " ");
1791 /* Read expressions interactively. */
1792 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1794 send_to_emacs (emacs_socket
, "-eval ");
1795 quote_argument (emacs_socket
, str
);
1797 send_to_emacs (emacs_socket
, " ");
1800 send_to_emacs (emacs_socket
, "\n");
1802 /* Wait for an answer. */
1803 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1805 printf ("Waiting for Emacs...");
1809 while (fdatasync (1) != 0 && errno
== EINTR
)
1812 /* Now, wait for an answer and print any messages. */
1813 while (exit_status
== EXIT_SUCCESS
)
1819 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1821 /* If we receive a signal (e.g. SIGWINCH, which we pass
1822 through to Emacs), on some OSes we get EINTR and must retry. */
1823 while (rl
< 0 && errno
== EINTR
);
1830 /* Loop over all NL-terminated messages. */
1831 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1833 end_p
= strchr (p
, '\n');
1837 if (strprefix ("-emacs-pid ", p
))
1839 /* -emacs-pid PID: The process id of the Emacs process. */
1840 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1842 else if (strprefix ("-window-system-unsupported ", p
))
1844 /* -window-system-unsupported: Emacs was compiled without support
1845 for whatever window system we tried. Try the alternate
1846 display, or, failing that, try the terminal. */
1849 display
= alt_display
;
1860 else if (strprefix ("-print ", p
))
1862 /* -print STRING: Print STRING on the terminal. */
1863 str
= unquote_argument (p
+ strlen ("-print "));
1867 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1869 else if (strprefix ("-print-nonl ", p
))
1871 /* -print-nonl STRING: Print STRING on the terminal.
1872 Used to continue a preceding -print command. */
1873 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1875 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1877 else if (strprefix ("-error ", p
))
1879 /* -error DESCRIPTION: Signal an error on the terminal. */
1880 str
= unquote_argument (p
+ strlen ("-error "));
1883 fprintf (stderr
, "*ERROR*: %s", str
);
1884 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1885 exit_status
= EXIT_FAILURE
;
1888 else if (strprefix ("-suspend ", p
))
1890 /* -suspend: Suspend this terminal, i.e., stop the process. */
1899 /* Unknown command. */
1903 printf ("*ERROR*: Unknown message: %s\n", p
);
1911 while (fdatasync (1) != 0 && errno
== EINTR
)
1915 exit_status
= EXIT_FAILURE
;
1917 CLOSE_SOCKET (emacs_socket
);
1921 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */