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. */
599 if (alternate_editor
&& alternate_editor
[0] == '\0')
601 message (true, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
605 #endif /* WINDOWSNT */
609 static _Noreturn
void
610 print_help_and_exit (void)
612 /* Spaces and tabs are significant in this message; they're chosen so the
613 message aligns properly both in a tty and in a Windows message box.
614 Please try to preserve them; otherwise the output is very hard to read
615 when using emacsclientw. */
617 "Usage: %s [OPTIONS] FILE...\n%s%s%s", progname
, "\
618 Tell the Emacs server to visit the specified files.\n\
619 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
621 The following OPTIONS are accepted:\n\
622 -V, --version Just print version info and return\n\
623 -H, --help Print this usage information message\n\
624 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
625 -c, --create-frame Create a new frame instead of trying to\n\
626 use the current Emacs frame\n\
628 -F ALIST, --frame-parameters=ALIST\n\
629 Set the parameters of a new frame\n\
630 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
631 -n, --no-wait Don't wait for the server to return\n\
632 -q, --quiet Don't display messages on success\n\
633 -d DISPLAY, --display=DISPLAY\n\
634 Visit the file in the given display\n\
636 --parent-id=ID Open in parent window ID, via XEmbed\n"
637 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
638 "-s SOCKET, --socket-name=SOCKET\n\
639 Set filename of the UNIX socket for communication\n"
641 "-f SERVER, --server-file=SERVER\n\
642 Set filename of the TCP authentication file\n\
643 -a EDITOR, --alternate-editor=EDITOR\n\
644 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"
648 #endif /* not WINDOWSNT */
650 Report bugs with M-x report-emacs-bug.\n");
654 /* Try to run a different command, or --if no alternate editor is
655 defined-- exit with an errorcode.
656 Uses argv, but gets it from the global variable main_argv. */
658 static _Noreturn
void
661 if (alternate_editor
)
665 execvp (alternate_editor
, main_argv
+ i
);
666 message (true, "%s: error executing alternate editor \"%s\"\n",
667 progname
, alternate_editor
);
673 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
676 main (int argc
, char **argv
)
680 message (true, "%s: Sorry, the Emacs server is supported only\n"
681 "on systems with Berkeley sockets.\n",
686 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
688 #define AUTH_KEY_LENGTH 64
689 #define SEND_BUFFER_SIZE 4096
691 /* Buffer to accumulate data to send in TCP connections. */
692 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
693 int sblen
= 0; /* Fill pointer for the send buffer. */
694 /* Socket used to communicate with the Emacs server process. */
695 HSOCKET emacs_socket
= 0;
697 /* On Windows, the socket library was historically separate from the
698 standard C library, so errors are handled differently. */
701 sock_err_message (const char *function_name
)
706 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
707 | FORMAT_MESSAGE_ALLOCATE_BUFFER
708 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
709 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
711 message (true, "%s: %s: %s\n", progname
, function_name
, msg
);
715 message (true, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
720 /* Let's send the data to Emacs when either
721 - the data ends in "\n", or
722 - the buffer is full (but this shouldn't happen)
723 Otherwise, we just accumulate it. */
725 send_to_emacs (HSOCKET s
, const char *data
)
732 dlen
= strlen (data
);
735 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
736 memcpy (&send_buffer
[sblen
], data
, part
);
740 if (sblen
== SEND_BUFFER_SIZE
741 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
743 int sent
= send (s
, send_buffer
, sblen
, 0);
746 message (true, "%s: failed to send %d bytes to socket: %s\n",
747 progname
, sblen
, strerror (errno
));
751 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
760 /* In STR, insert a & before each &, each space, each newline, and
761 any initial -. Change spaces to underscores, too, so that the
762 return value never contains a space.
764 Does not change the string. Outputs the result to S. */
766 quote_argument (HSOCKET s
, const char *str
)
768 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
790 if (*p
== '&' || (*p
== '-' && p
== str
))
797 send_to_emacs (s
, copy
);
803 /* The inverse of quote_argument. Removes quoting in string STR by
804 modifying the string in place. Returns STR. */
807 unquote_argument (char *str
)
838 file_name_absolute_p (const char *filename
)
840 /* Sanity check, it shouldn't happen. */
841 if (! filename
) return false;
843 /* /xxx is always an absolute path. */
844 if (filename
[0] == '/') return true;
846 /* Empty filenames (which shouldn't happen) are relative. */
847 if (filename
[0] == '\0') return false;
850 /* X:\xxx is always absolute. */
851 if (isalpha ((unsigned char) filename
[0])
852 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
855 /* Both \xxx and \\xxx\yyy are absolute. */
856 if (filename
[0] == '\\') return true;
863 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
870 /* Initialize the WinSock2 library. */
872 initialize_sockets (void)
876 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
878 message (true, "%s: error initializing WinSock2\n", progname
);
882 atexit (close_winsock
);
884 #endif /* WINDOWSNT */
887 /* Read the information needed to set up a TCP comm channel with
888 the Emacs server: host, port, and authentication string. */
891 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
892 char *authentication
)
898 if (file_name_absolute_p (config_file
))
899 config
= fopen (config_file
, "rb");
902 const char *home
= egetenv ("HOME");
906 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
908 char *z
= stpcpy (path
, home
);
909 z
= stpcpy (z
, "/.emacs.d/server/");
910 strcpy (z
, config_file
);
911 config
= fopen (path
, "rb");
915 if (!config
&& (home
= egetenv ("APPDATA")))
917 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
919 char *z
= stpcpy (path
, home
);
920 z
= stpcpy (z
, "/.emacs.d/server/");
921 strcpy (z
, config_file
);
922 config
= fopen (path
, "rb");
931 if (fgets (dotted
, sizeof dotted
, config
)
932 && (port
= strchr (dotted
, ':')))
936 message (true, "%s: invalid configuration info\n", progname
);
940 server
->sin_family
= AF_INET
;
941 server
->sin_addr
.s_addr
= inet_addr (dotted
);
942 server
->sin_port
= htons (atoi (port
));
944 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
946 message (true, "%s: cannot read authentication info\n", progname
);
956 set_tcp_socket (const char *local_server_file
)
959 struct sockaddr_in server
;
960 struct linger l_arg
= {1, 1};
961 char auth_string
[AUTH_KEY_LENGTH
+ 1];
963 if (! get_server_config (local_server_file
, &server
, auth_string
))
964 return INVALID_SOCKET
;
966 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
967 message (false, "%s: connected to remote socket at %s\n",
968 progname
, inet_ntoa (server
.sin_addr
));
970 /* Open up an AF_INET socket. */
971 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
973 sock_err_message ("socket");
974 return INVALID_SOCKET
;
977 /* Set up the socket. */
978 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
980 sock_err_message ("connect");
981 return INVALID_SOCKET
;
984 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
986 /* Send the authentication. */
987 auth_string
[AUTH_KEY_LENGTH
] = '\0';
989 send_to_emacs (s
, "-auth ");
990 send_to_emacs (s
, auth_string
);
991 send_to_emacs (s
, " ");
997 /* Returns 1 if PREFIX is a prefix of STRING. */
999 strprefix (const char *prefix
, const char *string
)
1001 return !strncmp (prefix
, string
, strlen (prefix
));
1004 /* Get tty name and type. If successful, return the type in TTY_TYPE
1005 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1006 is zero, or return 0 if NOABORT is non-zero. */
1009 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1011 const char *type
= egetenv ("TERM");
1012 const char *name
= ttyname (fileno (stdout
));
1020 message (true, "%s: could not get terminal name\n", progname
);
1031 message (true, "%s: please set the TERM variable to your terminal type\n",
1037 if (strcmp (type
, "eterm") == 0)
1043 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1044 message (true, "%s: opening a frame in an Emacs term buffer"
1045 " is not supported\n", progname
);
1056 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1058 /* Three possibilities:
1059 2 - can't be `stat'ed (sets errno)
1060 1 - isn't owned by us
1061 0 - success: none of the above */
1064 socket_status (const char *name
)
1066 struct stat statbfr
;
1068 if (stat (name
, &statbfr
) == -1)
1071 if (statbfr
.st_uid
!= geteuid ())
1078 /* A signal handler that passes the signal to the Emacs process.
1079 Useful for SIGWINCH. */
1082 pass_signal_to_emacs (int signalnum
)
1084 int old_errno
= errno
;
1087 kill (emacs_pid
, signalnum
);
1089 signal (signalnum
, pass_signal_to_emacs
);
1093 /* Signal handler for SIGCONT; notify the Emacs process that it can
1094 now resume our tty frame. */
1097 handle_sigcont (int signalnum
)
1099 int old_errno
= errno
;
1100 pid_t pgrp
= getpgrp ();
1101 pid_t tcpgrp
= tcgetpgrp (1);
1105 /* We are in the foreground. */
1106 send_to_emacs (emacs_socket
, "-resume \n");
1108 else if (0 <= tcpgrp
&& tty
)
1110 /* We are in the background; cancel the continue. */
1111 kill (-pgrp
, SIGTTIN
);
1114 signal (signalnum
, handle_sigcont
);
1118 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1119 going to sleep. Normally the suspend is initiated by Emacs via
1120 server-handle-suspend-tty, but if the server gets out of sync with
1121 reality, we may get a SIGTSTP on C-z. Handling this signal and
1122 notifying Emacs about it should get things under control again. */
1125 handle_sigtstp (int signalnum
)
1127 int old_errno
= errno
;
1131 send_to_emacs (emacs_socket
, "-suspend \n");
1133 /* Unblock this signal and call the default handler by temporarily
1134 changing the handler and resignaling. */
1135 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1136 sigdelset (&set
, signalnum
);
1137 signal (signalnum
, SIG_DFL
);
1139 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1140 signal (signalnum
, handle_sigtstp
);
1146 /* Set up signal handlers before opening a frame on the current tty. */
1151 /* Set up signal handlers. */
1152 signal (SIGWINCH
, pass_signal_to_emacs
);
1154 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1155 deciding which terminal the signal came from. C-g is now a
1156 normal input event on secondary terminals. */
1158 signal (SIGINT
, pass_signal_to_emacs
);
1159 signal (SIGQUIT
, pass_signal_to_emacs
);
1162 signal (SIGCONT
, handle_sigcont
);
1163 signal (SIGTSTP
, handle_sigtstp
);
1164 signal (SIGTTOU
, handle_sigtstp
);
1169 set_local_socket (const char *local_socket_name
)
1172 struct sockaddr_un server
;
1174 /* Open up an AF_UNIX socket in this person's home directory. */
1175 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1177 message (true, "%s: socket: %s\n", progname
, strerror (errno
));
1178 return INVALID_SOCKET
;
1181 server
.sun_family
= AF_UNIX
;
1187 const char *server_name
= local_socket_name
;
1188 const char *tmpdir
IF_LINT ( = NULL
);
1189 char *tmpdir_storage
= NULL
;
1190 char *socket_name_storage
= NULL
;
1192 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1194 /* socket_name is a file name component. */
1195 long uid
= geteuid ();
1197 tmpdir
= egetenv ("TMPDIR");
1201 #ifndef _CS_DARWIN_USER_TEMP_DIR
1202 #define _CS_DARWIN_USER_TEMP_DIR 65537
1204 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1207 tmpdir
= tmpdir_storage
= xmalloc (n
);
1208 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1214 socket_name_storage
=
1215 xmalloc (strlen (tmpdir
) + strlen (server_name
) + EXTRA_SPACE
);
1216 char *z
= stpcpy (socket_name_storage
, tmpdir
);
1217 z
+= sprintf (z
, "/emacs%ld/", uid
);
1218 strcpy (z
, server_name
);
1219 local_socket_name
= socket_name_storage
;
1222 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1223 strcpy (server
.sun_path
, local_socket_name
);
1226 message (true, "%s: socket-name %s too long\n",
1227 progname
, local_socket_name
);
1231 /* See if the socket exists, and if it's owned by us. */
1232 sock_status
= socket_status (server
.sun_path
);
1233 saved_errno
= errno
;
1234 if (sock_status
&& use_tmpdir
)
1236 /* Failing that, see if LOGNAME or USER exist and differ from
1237 our euid. If so, look for a socket based on the UID
1238 associated with the name. This is reminiscent of the logic
1239 that init_editfns uses to set the global Vuser_full_name. */
1241 const char *user_name
= egetenv ("LOGNAME");
1244 user_name
= egetenv ("USER");
1248 struct passwd
*pw
= getpwnam (user_name
);
1250 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1252 /* We're running under su, apparently. */
1253 long uid
= pw
->pw_uid
;
1254 char *user_socket_name
1255 = xmalloc (strlen (tmpdir
) + strlen (server_name
)
1257 char *z
= stpcpy (user_socket_name
, tmpdir
);
1258 z
+= sprintf (z
, "/emacs%ld/", uid
);
1259 strcpy (z
, server_name
);
1261 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1262 strcpy (server
.sun_path
, user_socket_name
);
1265 message (true, "%s: socket-name %s too long\n",
1266 progname
, user_socket_name
);
1267 exit (EXIT_FAILURE
);
1269 free (user_socket_name
);
1271 sock_status
= socket_status (server
.sun_path
);
1272 saved_errno
= errno
;
1275 errno
= saved_errno
;
1279 free (socket_name_storage
);
1280 free (tmpdir_storage
);
1282 switch (sock_status
)
1285 /* There's a socket, but it isn't owned by us. This is OK if
1287 if (0 != geteuid ())
1289 message (true, "%s: Invalid socket owner\n", progname
);
1290 return INVALID_SOCKET
;
1296 if (saved_errno
== ENOENT
)
1298 "%s: can't find socket; have you started the server?\n\
1299 To start the server in Emacs, type \"M-x server-start\".\n",
1302 message (true, "%s: can't stat %s: %s\n",
1303 progname
, server
.sun_path
, strerror (saved_errno
));
1304 return INVALID_SOCKET
;
1308 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1311 message (true, "%s: connect: %s\n", progname
, strerror (errno
));
1312 return INVALID_SOCKET
;
1317 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1320 set_socket (int no_exit_if_error
)
1323 const char *local_server_file
= server_file
;
1327 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1328 /* Explicit --socket-name argument. */
1331 s
= set_local_socket (socket_name
);
1332 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1334 message (true, "%s: error accessing socket \"%s\"\n",
1335 progname
, socket_name
);
1336 exit (EXIT_FAILURE
);
1340 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1341 if (!local_server_file
)
1342 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1344 if (local_server_file
)
1346 s
= set_tcp_socket (local_server_file
);
1347 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1350 message (true, "%s: error accessing server file \"%s\"\n",
1351 progname
, local_server_file
);
1352 exit (EXIT_FAILURE
);
1355 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1356 /* Implicit local socket. */
1357 s
= set_local_socket ("server");
1358 if (s
!= INVALID_SOCKET
)
1362 /* Implicit server file. */
1363 s
= set_tcp_socket ("server");
1364 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1367 /* No implicit or explicit socket, and no alternate editor. */
1368 message (true, "%s: No socket or alternate editor. Please use:\n\n"
1369 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1372 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1373 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1375 exit (EXIT_FAILURE
);
1379 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1380 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1383 w32_set_user_model_id (void)
1386 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
1388 /* On Windows 7 and later, we need to set the user model ID
1389 to associate emacsclient launched files with Emacs frames
1391 shell
= LoadLibrary ("shell32.dll");
1395 = (void *) GetProcAddress (shell
,
1396 "SetCurrentProcessExplicitAppUserModelID");
1397 /* If the function is defined, then we are running on Windows 7
1398 or newer, and the UI uses this to group related windows
1399 together. Since emacs, runemacs, emacsclient are related, we
1400 want them grouped even though the executables are different,
1401 so we need to set a consistent ID between them. */
1403 set_user_model (L
"GNU.Emacs");
1405 FreeLibrary (shell
);
1410 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1415 /* Reject any window not of class "Emacs". */
1416 if (! get_wc (hWnd
, class, sizeof (class))
1417 || strcmp (class, "Emacs"))
1420 /* We only need the process id, not the thread id. */
1421 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1423 /* Not the one we're looking for. */
1424 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1426 /* OK, let's raise it. */
1429 /* Stop enumeration. */
1433 /* Search for a window of class "Emacs" and owned by a process with
1434 process id = emacs_pid. If found, allow it to grab the focus. */
1437 w32_give_focus (void)
1441 /* It shouldn't happen when dealing with TCP sockets. */
1442 if (!emacs_pid
) return;
1444 user32
= GetModuleHandle ("user32.dll");
1449 /* Modern Windows restrict which processes can set the foreground window.
1450 emacsclient can allow Emacs to grab the focus by calling the function
1451 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1452 NT) lack this function, so we have to check its availability. */
1453 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1454 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1455 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1457 #endif /* HAVE_NTGUI */
1459 /* Start the emacs daemon and try to connect to it. */
1462 start_daemon_and_retry_set_socket (void)
1473 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1475 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1477 message (true, "Error: Could not start the Emacs daemon\n");
1478 exit (EXIT_FAILURE
);
1481 /* Try connecting, the daemon should have started by now. */
1482 message (true, "Emacs daemon should have started, trying to connect again\n");
1483 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1485 message (true, "Error: Cannot connect even after starting the Emacs daemon\n");
1486 exit (EXIT_FAILURE
);
1491 fprintf (stderr
, "Error: Cannot fork!\n");
1492 exit (EXIT_FAILURE
);
1496 char emacs
[] = "emacs";
1497 char daemon_option
[] = "--daemon";
1500 d_argv
[1] = daemon_option
;
1502 if (socket_name
!= NULL
)
1504 /* Pass --daemon=socket_name as argument. */
1505 const char *deq
= "--daemon=";
1506 char *daemon_arg
= xmalloc (strlen (deq
)
1507 + strlen (socket_name
) + 1);
1508 strcpy (stpcpy (daemon_arg
, deq
), socket_name
);
1509 d_argv
[1] = daemon_arg
;
1511 execvp ("emacs", d_argv
);
1512 message (true, "%s: error starting emacs daemon\n", progname
);
1514 #endif /* WINDOWSNT */
1518 main (int argc
, char **argv
)
1520 int rl
= 0, needlf
= 0;
1522 char string
[BUFSIZ
+1];
1523 int start_daemon_if_needed
;
1524 int exit_status
= EXIT_SUCCESS
;
1530 /* On Windows 7 and later, we need to explicitly associate
1531 emacsclient with emacs so the UI behaves sensibly. This
1532 association does no harm if we're not actually connecting to an
1533 Emacs using a window display. */
1534 w32_set_user_model_id ();
1535 #endif /* HAVE_NTGUI */
1537 /* Process options. */
1538 decode_options (argc
, argv
);
1540 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1542 message (true, "%s: file name or argument required\n"
1543 "Try `%s --help' for more information\n",
1544 progname
, progname
);
1545 exit (EXIT_FAILURE
);
1551 pid_t pgrp
= getpgrp ();
1552 pid_t tcpgrp
= tcgetpgrp (1);
1553 if (0 <= tcpgrp
&& tcpgrp
!= pgrp
)
1554 kill (-pgrp
, SIGTTIN
);
1556 #endif /* !WINDOWSNT */
1558 /* If alternate_editor is the empty string, start the emacs daemon
1559 in case of failure to connect. */
1560 start_daemon_if_needed
= (alternate_editor
1561 && (alternate_editor
[0] == '\0'));
1563 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1564 if (emacs_socket
== INVALID_SOCKET
)
1566 if (! start_daemon_if_needed
)
1569 start_daemon_and_retry_set_socket ();
1572 cwd
= get_current_dir_name ();
1575 message (true, "%s: %s\n", progname
,
1576 "Cannot get current working directory");
1581 if (display
&& !strcmp (display
, "w32"))
1583 #endif /* HAVE_NTGUI */
1585 /* Send over our environment and current directory. */
1589 for (i
= 0; environ
[i
]; i
++)
1591 send_to_emacs (emacs_socket
, "-env ");
1592 quote_argument (emacs_socket
, environ
[i
]);
1593 send_to_emacs (emacs_socket
, " ");
1596 send_to_emacs (emacs_socket
, "-dir ");
1597 quote_argument (emacs_socket
, cwd
);
1598 send_to_emacs (emacs_socket
, "/");
1599 send_to_emacs (emacs_socket
, " ");
1603 send_to_emacs (emacs_socket
, "-nowait ");
1606 send_to_emacs (emacs_socket
, "-current-frame ");
1610 send_to_emacs (emacs_socket
, "-display ");
1611 quote_argument (emacs_socket
, display
);
1612 send_to_emacs (emacs_socket
, " ");
1617 send_to_emacs (emacs_socket
, "-parent-id ");
1618 quote_argument (emacs_socket
, parent_id
);
1619 send_to_emacs (emacs_socket
, " ");
1622 if (frame_parameters
&& !current_frame
)
1624 send_to_emacs (emacs_socket
, "-frame-parameters ");
1625 quote_argument (emacs_socket
, frame_parameters
);
1626 send_to_emacs (emacs_socket
, " ");
1629 /* Unless we are certain we don't want to occupy the tty, send our
1630 tty information to Emacs. For example, in daemon mode Emacs may
1631 need to occupy this tty if no other frame is available. */
1632 if (!current_frame
|| !eval
)
1634 const char *tty_type
, *tty_name
;
1636 if (find_tty (&tty_type
, &tty_name
, !tty
))
1638 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1641 send_to_emacs (emacs_socket
, "-tty ");
1642 quote_argument (emacs_socket
, tty_name
);
1643 send_to_emacs (emacs_socket
, " ");
1644 quote_argument (emacs_socket
, tty_type
);
1645 send_to_emacs (emacs_socket
, " ");
1649 if (!current_frame
&& !tty
)
1650 send_to_emacs (emacs_socket
, "-window-system ");
1652 if ((argc
- optind
> 0))
1655 for (i
= optind
; i
< argc
; i
++)
1660 /* Don't prepend cwd or anything like that. */
1661 send_to_emacs (emacs_socket
, "-eval ");
1662 quote_argument (emacs_socket
, argv
[i
]);
1663 send_to_emacs (emacs_socket
, " ");
1667 if (*argv
[i
] == '+')
1669 char *p
= argv
[i
] + 1;
1670 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1673 send_to_emacs (emacs_socket
, "-position ");
1674 quote_argument (emacs_socket
, argv
[i
]);
1675 send_to_emacs (emacs_socket
, " ");
1680 else if (! file_name_absolute_p (argv
[i
])
1681 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1682 /* Windows can have a different default directory for each
1683 drive, so the cwd passed via "-dir" is not sufficient
1684 to account for that.
1685 If the user uses <drive>:<relpath>, we hence need to be
1686 careful to expand <relpath> with the default directory
1687 corresponding to <drive>. */
1689 char *filename
= (char *) xmalloc (MAX_PATH
);
1692 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1693 if (size
> 0 && size
< MAX_PATH
)
1700 send_to_emacs (emacs_socket
, "-file ");
1701 quote_argument (emacs_socket
, argv
[i
]);
1702 send_to_emacs (emacs_socket
, " ");
1707 /* Read expressions interactively. */
1708 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1710 send_to_emacs (emacs_socket
, "-eval ");
1711 quote_argument (emacs_socket
, str
);
1713 send_to_emacs (emacs_socket
, " ");
1716 send_to_emacs (emacs_socket
, "\n");
1718 /* Wait for an answer. */
1719 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1721 printf ("Waiting for Emacs...");
1725 while (fdatasync (1) != 0 && errno
== EINTR
)
1728 /* Now, wait for an answer and print any messages. */
1729 while (exit_status
== EXIT_SUCCESS
)
1735 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1737 /* If we receive a signal (e.g. SIGWINCH, which we pass
1738 through to Emacs), on some OSes we get EINTR and must retry. */
1739 while (rl
< 0 && errno
== EINTR
);
1746 /* Loop over all NL-terminated messages. */
1747 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1749 end_p
= strchr (p
, '\n');
1753 if (strprefix ("-emacs-pid ", p
))
1755 /* -emacs-pid PID: The process id of the Emacs process. */
1756 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1758 else if (strprefix ("-window-system-unsupported ", p
))
1760 /* -window-system-unsupported: Emacs was compiled without support
1761 for whatever window system we tried. Try the alternate
1762 display, or, failing that, try the terminal. */
1765 display
= alt_display
;
1776 else if (strprefix ("-print ", p
))
1778 /* -print STRING: Print STRING on the terminal. */
1779 str
= unquote_argument (p
+ strlen ("-print "));
1783 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1785 else if (strprefix ("-print-nonl ", p
))
1787 /* -print-nonl STRING: Print STRING on the terminal.
1788 Used to continue a preceding -print command. */
1789 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1791 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1793 else if (strprefix ("-error ", p
))
1795 /* -error DESCRIPTION: Signal an error on the terminal. */
1796 str
= unquote_argument (p
+ strlen ("-error "));
1799 fprintf (stderr
, "*ERROR*: %s", str
);
1800 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1801 exit_status
= EXIT_FAILURE
;
1804 else if (strprefix ("-suspend ", p
))
1806 /* -suspend: Suspend this terminal, i.e., stop the process. */
1815 /* Unknown command. */
1819 printf ("*ERROR*: Unknown message: %s\n", p
);
1827 while (fdatasync (1) != 0 && errno
== EINTR
)
1831 exit_status
= EXIT_FAILURE
;
1833 CLOSE_SOCKET (emacs_socket
);
1837 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */