1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986-1987, 1994, 1999-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 /* ms-w32.h defines these, which disables sockets altogether! */
31 # include <commctrl.h>
33 # include <winsock2.h>
35 # define NO_SOCKETS_IN_FILE_SYSTEM
37 # define HSOCKET SOCKET
38 # define CLOSE_SOCKET closesocket
39 # define INITIALIZE() (initialize_sockets ())
41 char *w32_getenv (char *);
42 #define egetenv(VAR) w32_getenv(VAR)
44 #else /* !WINDOWSNT */
48 # ifdef HAVE_INET_SOCKETS
49 # include <netinet/in.h>
51 # include <sys/types.h>
52 # include <sys/socket.h>
54 # endif /* HAVE_SOCKETS */
56 # include <arpa/inet.h>
58 # define INVALID_SOCKET -1
60 # define CLOSE_SOCKET close
67 #define egetenv(VAR) getenv(VAR)
69 #endif /* !WINDOWSNT */
86 char *getenv (const char *), *getwd (char *);
88 char *(getcwd
) (char *, size_t);
92 #define VERSION "unspecified"
97 #define EXIT_SUCCESS 0
101 #define EXIT_FAILURE 1
112 /* Additional space when allocating buffers for filenames, etc. */
113 #define EXTRA_SPACE 100
115 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
117 # define IF_LINT(Code) Code
119 # define IF_LINT(Code) /* empty */
125 #define min(x, y) (((x) < (y)) ? (x) : (y))
128 /* Name used to invoke this program. */
129 const char *progname
;
131 /* The second argument to main. */
134 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
137 /* Nonzero means don't print messages for successful operations. --quiet. */
140 /* Nonzero means args are expressions to be evaluated. --eval. */
143 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
144 int current_frame
= 1;
146 /* The display on which Emacs should work. --display. */
147 const char *display
= NULL
;
149 /* The parent window ID, if we are opening a frame via XEmbed. */
150 char *parent_id
= NULL
;
152 /* Nonzero means open a new Emacs frame on the current terminal. */
155 /* If non-NULL, the name of an editor to fallback to if the server
156 is not running. --alternate-editor. */
157 const char *alternate_editor
= NULL
;
159 /* If non-NULL, the filename of the UNIX socket. */
160 const char *socket_name
= NULL
;
162 /* If non-NULL, the filename of the authentication file. */
163 const char *server_file
= NULL
;
165 /* PID of the Emacs server process. */
168 /* If non-NULL, a string that should form a frame parameter alist to
169 be used for the new frame */
170 const char *frame_parameters
= NULL
;
172 static _Noreturn
void print_help_and_exit (void);
175 struct option longopts
[] =
177 { "no-wait", no_argument
, NULL
, 'n' },
178 { "quiet", no_argument
, NULL
, 'q' },
179 { "eval", no_argument
, NULL
, 'e' },
180 { "help", no_argument
, NULL
, 'H' },
181 { "version", no_argument
, NULL
, 'V' },
182 { "tty", no_argument
, NULL
, 't' },
183 { "nw", no_argument
, NULL
, 't' },
184 { "create-frame", no_argument
, NULL
, 'c' },
185 { "alternate-editor", required_argument
, NULL
, 'a' },
186 { "frame-parameters", required_argument
, NULL
, 'F' },
187 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
188 { "socket-name", required_argument
, NULL
, 's' },
190 { "server-file", required_argument
, NULL
, 'f' },
192 { "display", required_argument
, NULL
, 'd' },
194 { "parent-id", required_argument
, NULL
, 'p' },
199 /* Like malloc but get fatal error if memory is exhausted. */
202 xmalloc (size_t size
)
204 void *result
= malloc (size
);
214 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
217 #ifndef DIRECTORY_SEP
218 #define DIRECTORY_SEP '/'
220 #ifndef IS_DIRECTORY_SEP
221 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
223 #ifndef IS_DEVICE_SEP
225 #define IS_DEVICE_SEP(_c_) 0
227 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
231 char *get_current_dir_name (void);
233 /* Return the current working directory. Returns NULL on errors.
234 Any other returned value must be freed with free. This is used
235 only when get_current_dir_name is not defined on the system. */
237 get_current_dir_name (void)
241 struct stat dotstat
, pwdstat
;
242 /* If PWD is accurate, use it instead of calling getwd. PWD is
243 sometimes a nicer name, and using it may avoid a fatal error if a
244 parent directory is searchable but not readable. */
245 if ((pwd
= egetenv ("PWD")) != 0
246 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
247 && stat (pwd
, &pwdstat
) == 0
248 && stat (".", &dotstat
) == 0
249 && dotstat
.st_ino
== pwdstat
.st_ino
250 && dotstat
.st_dev
== pwdstat
.st_dev
252 && strlen (pwd
) < MAXPATHLEN
256 buf
= (char *) xmalloc (strlen (pwd
) + 1);
262 size_t buf_size
= 1024;
266 buf
= malloc (buf_size
);
269 if (getcwd (buf
, buf_size
) == buf
)
273 if (tmp_errno
!= ERANGE
)
289 /* We need MAXPATHLEN here. */
290 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
291 if (getwd (buf
) == NULL
)
293 int tmp_errno
= errno
;
306 /* Like strdup but get a fatal error if memory is exhausted. */
309 xstrdup (const char *s
)
311 char *result
= strdup (s
);
320 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
322 /* Retrieve an environment variable from the Emacs subkeys of the registry.
323 Return NULL if the variable was not found, or it was empty.
324 This code is based on w32_get_resource (w32.c). */
326 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
328 HKEY hrootkey
= NULL
;
332 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
334 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
336 result
= (char *) xmalloc (cbData
);
338 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
346 RegCloseKey (hrootkey
);
353 getenv wrapper for Windows
355 Value is allocated on the heap, and can be free'd.
357 This is needed to duplicate Emacs's behavior, which is to look for
358 environment variables in the registry if they don't appear in the
361 w32_getenv (char *envvar
)
366 if ((value
= getenv (envvar
)))
367 /* Found in the environment. strdup it, because values returned
368 by getenv cannot be free'd. */
369 return xstrdup (value
);
371 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
372 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
374 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
375 if (strcmp (envvar
, "TERM") == 0)
376 return xstrdup ("w32console");
377 /* Found neither in the environment nor in the registry. */
381 if (dwType
== REG_SZ
)
382 /* Registry; no need to expand. */
385 if (dwType
== REG_EXPAND_SZ
)
389 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
391 char *buffer
= (char *) xmalloc (size
);
392 if (ExpandEnvironmentStrings (value
, buffer
, size
))
394 /* Found and expanded. */
399 /* Error expanding. */
404 /* Not the right type, or not correctly expanded. */
410 w32_set_user_model_id (void)
413 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
415 /* On Windows 7 and later, we need to set the user model ID
416 to associate emacsclient launched files with Emacs frames
418 shell
= LoadLibrary ("shell32.dll");
422 = (void *) GetProcAddress (shell
,
423 "SetCurrentProcessExplicitAppUserModelID");
424 /* If the function is defined, then we are running on Windows 7
425 or newer, and the UI uses this to group related windows
426 together. Since emacs, runemacs, emacsclient are related, we
427 want them grouped even though the executables are different,
428 so we need to set a consistent ID between them. */
430 set_user_model (L
"GNU.Emacs");
437 w32_window_app (void)
439 static int window_app
= -1;
440 char szTitle
[MAX_PATH
];
444 /* Checking for STDOUT does not work; it's a valid handle also in
445 nonconsole apps. Testing for the console title seems to work. */
446 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
448 InitCommonControls ();
454 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
456 This is necessary due to the broken implementation of exec* routines in
457 the Microsoft libraries: they concatenate the arguments together without
458 quoting special characters, and pass the result to CreateProcess, with
459 predictably bad results. By contrast, POSIX execvp passes the arguments
460 directly into the argv array of the child process. */
463 w32_execvp (const char *path
, char **argv
)
466 extern int execvp (const char*, char **);
468 /* Required to allow a .BAT script as alternate editor. */
469 argv
[0] = (char *) alternate_editor
;
471 for (i
= 0; argv
[i
]; i
++)
472 if (strchr (argv
[i
], ' '))
474 char *quoted
= alloca (strlen (argv
[i
]) + 3);
475 sprintf (quoted
, "\"%s\"", argv
[i
]);
479 return execvp (path
, argv
);
483 #define execvp w32_execvp
485 /* Emulation of ttyname for Windows. */
492 #endif /* WINDOWSNT */
494 /* Display a normal or error message.
495 On Windows, use a message box if compiled as a Windows app. */
496 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
498 message (int is_error
, const char *format
, ...)
502 va_start (args
, format
);
505 if (w32_window_app ())
508 vsnprintf (msg
, sizeof msg
, format
, args
);
509 msg
[sizeof msg
- 1] = '\0';
512 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
514 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
519 FILE *f
= is_error
? stderr
: stdout
;
521 vfprintf (f
, format
, args
);
528 /* Decode the options from argv and argc.
529 The global variable `optind' will say how many arguments we used up. */
532 decode_options (int argc
, char **argv
)
534 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
538 int opt
= getopt_long_only (argc
, argv
,
539 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
552 /* If getopt returns 0, then it has already processed a
553 long-named option. We should do nothing. */
557 alternate_editor
= optarg
;
560 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
562 socket_name
= optarg
;
567 server_file
= optarg
;
570 /* We used to disallow this argument in w32, but it seems better
571 to allow it, for the occasional case where the user is
572 connecting with a w32 client to a server compiled with X11
591 message (FALSE
, "emacsclient %s\n", VERSION
);
610 print_help_and_exit ();
614 frame_parameters
= optarg
;
618 message (TRUE
, "Try `%s --help' for more information\n", progname
);
624 /* If the -c option is used (without -t) and no --display argument
625 is provided, try $DISPLAY.
626 Without the -c option, we used to set `display' to $DISPLAY by
627 default, but this changed the default behavior and is sometimes
628 inconvenient. So we force users to use "--display $DISPLAY" if
629 they want Emacs to connect to their current display. */
630 if (!current_frame
&& !tty
&& !display
)
632 display
= egetenv ("DISPLAY");
634 /* Under Cocoa, we don't really use displays the same way as in X,
635 so provide a dummy. */
636 if (!display
|| strlen (display
) == 0)
641 /* A null-string display is invalid. */
642 if (display
&& strlen (display
) == 0)
645 /* If no display is available, new frames are tty frames. */
646 if (!current_frame
&& !display
)
650 /* Emacs on Windows does not support graphical and text terminal
651 frames in the same instance. So, treat the -t and -c options as
652 equivalent, and open a new frame on the server's terminal.
653 Ideally, we would only set tty = 1 when the serve is running in a
654 console, but alas we don't know that. As a workaround, always
655 ask for a tty frame, and let server.el figure it out. */
662 if (alternate_editor
&& alternate_editor
[0] == '\0')
664 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
668 #endif /* WINDOWSNT */
672 static _Noreturn
void
673 print_help_and_exit (void)
675 /* Spaces and tabs are significant in this message; they're chosen so the
676 message aligns properly both in a tty and in a Windows message box.
677 Please try to preserve them; otherwise the output is very hard to read
678 when using emacsclientw. */
680 "Usage: %s [OPTIONS] FILE...\n\
681 Tell the Emacs server to visit the specified files.\n\
682 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
684 The following OPTIONS are accepted:\n\
685 -V, --version Just print version info and return\n\
686 -H, --help Print this usage information message\n\
687 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
688 -c, --create-frame Create a new frame instead of trying to\n\
689 use the current Emacs frame\n\
690 -F ALIST, --frame-parameters=ALIST\n\
691 Set the parameters of a new frame\n\
692 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
693 -n, --no-wait Don't wait for the server to return\n\
694 -q, --quiet Don't display messages on success\n\
695 -d DISPLAY, --display=DISPLAY\n\
696 Visit the file in the given display\n\
697 --parent-id=ID Open in parent window ID, via XEmbed\n"
698 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
699 "-s SOCKET, --socket-name=SOCKET\n\
700 Set filename of the UNIX socket for communication\n"
702 "-f SERVER, --server-file=SERVER\n\
703 Set filename of the TCP authentication file\n\
704 -a EDITOR, --alternate-editor=EDITOR\n\
705 Editor to fallback to if the server is not running\n"
707 " If EDITOR is the empty string, start Emacs in daemon\n\
708 mode and try connecting again\n"
709 #endif /* not WINDOWSNT */
711 Report bugs with M-x report-emacs-bug.\n", progname
);
715 /* Try to run a different command, or --if no alternate editor is
716 defined-- exit with an errorcode.
717 Uses argv, but gets it from the global variable main_argv. */
719 static _Noreturn
void
722 if (alternate_editor
)
726 execvp (alternate_editor
, main_argv
+ i
);
727 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
728 progname
, alternate_editor
);
734 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
737 main (int argc
, char **argv
)
741 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
742 "on systems with Berkeley sockets.\n",
747 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
749 #define AUTH_KEY_LENGTH 64
750 #define SEND_BUFFER_SIZE 4096
752 /* Buffer to accumulate data to send in TCP connections. */
753 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
754 int sblen
= 0; /* Fill pointer for the send buffer. */
755 /* Socket used to communicate with the Emacs server process. */
756 HSOCKET emacs_socket
= 0;
758 /* On Windows, the socket library was historically separate from the
759 standard C library, so errors are handled differently. */
762 sock_err_message (const char *function_name
)
767 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
768 | FORMAT_MESSAGE_ALLOCATE_BUFFER
769 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
770 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
772 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
776 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
781 /* Let's send the data to Emacs when either
782 - the data ends in "\n", or
783 - the buffer is full (but this shouldn't happen)
784 Otherwise, we just accumulate it. */
786 send_to_emacs (HSOCKET s
, const char *data
)
793 dlen
= strlen (data
);
796 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
797 memcpy (&send_buffer
[sblen
], data
, part
);
801 if (sblen
== SEND_BUFFER_SIZE
802 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
804 int sent
= send (s
, send_buffer
, sblen
, 0);
807 message (TRUE
, "%s: failed to send %d bytes to socket: %s\n",
808 progname
, sblen
, strerror (errno
));
812 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
821 /* In STR, insert a & before each &, each space, each newline, and
822 any initial -. Change spaces to underscores, too, so that the
823 return value never contains a space.
825 Does not change the string. Outputs the result to S. */
827 quote_argument (HSOCKET s
, const char *str
)
829 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
851 if (*p
== '&' || (*p
== '-' && p
== str
))
858 send_to_emacs (s
, copy
);
864 /* The inverse of quote_argument. Removes quoting in string STR by
865 modifying the string in place. Returns STR. */
868 unquote_argument (char *str
)
899 file_name_absolute_p (const char *filename
)
901 /* Sanity check, it shouldn't happen. */
902 if (! filename
) return FALSE
;
904 /* /xxx is always an absolute path. */
905 if (filename
[0] == '/') return TRUE
;
907 /* Empty filenames (which shouldn't happen) are relative. */
908 if (filename
[0] == '\0') return FALSE
;
911 /* X:\xxx is always absolute. */
912 if (isalpha ((unsigned char) filename
[0])
913 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
916 /* Both \xxx and \\xxx\yyy are absolute. */
917 if (filename
[0] == '\\') return TRUE
;
924 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
931 /* Initialize the WinSock2 library. */
933 initialize_sockets (void)
937 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
939 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
943 atexit (close_winsock
);
945 #endif /* WINDOWSNT */
948 /* Read the information needed to set up a TCP comm channel with
949 the Emacs server: host, port, and authentication string. */
952 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
953 char *authentication
)
959 if (file_name_absolute_p (config_file
))
960 config
= fopen (config_file
, "rb");
963 const char *home
= egetenv ("HOME");
967 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
970 strcat (path
, "/.emacs.d/server/");
971 strcat (path
, config_file
);
972 config
= fopen (path
, "rb");
976 if (!config
&& (home
= egetenv ("APPDATA")))
978 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
981 strcat (path
, "/.emacs.d/server/");
982 strcat (path
, config_file
);
983 config
= fopen (path
, "rb");
992 if (fgets (dotted
, sizeof dotted
, config
)
993 && (port
= strchr (dotted
, ':')))
997 message (TRUE
, "%s: invalid configuration info\n", progname
);
1001 server
->sin_family
= AF_INET
;
1002 server
->sin_addr
.s_addr
= inet_addr (dotted
);
1003 server
->sin_port
= htons (atoi (port
));
1005 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
1007 message (TRUE
, "%s: cannot read authentication info\n", progname
);
1008 exit (EXIT_FAILURE
);
1017 set_tcp_socket (const char *local_server_file
)
1020 struct sockaddr_in server
;
1021 struct linger l_arg
= {1, 1};
1022 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1024 if (! get_server_config (local_server_file
, &server
, auth_string
))
1025 return INVALID_SOCKET
;
1027 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1028 message (FALSE
, "%s: connected to remote socket at %s\n",
1029 progname
, inet_ntoa (server
.sin_addr
));
1031 /* Open up an AF_INET socket. */
1032 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1034 sock_err_message ("socket");
1035 return INVALID_SOCKET
;
1038 /* Set up the socket. */
1039 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1041 sock_err_message ("connect");
1042 return INVALID_SOCKET
;
1045 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1047 /* Send the authentication. */
1048 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1050 send_to_emacs (s
, "-auth ");
1051 send_to_emacs (s
, auth_string
);
1052 send_to_emacs (s
, " ");
1058 /* Returns 1 if PREFIX is a prefix of STRING. */
1060 strprefix (const char *prefix
, const char *string
)
1062 return !strncmp (prefix
, string
, strlen (prefix
));
1065 /* Get tty name and type. If successful, return the type in TTY_TYPE
1066 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1067 is zero, or return 0 if NOABORT is non-zero. */
1070 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1072 const char *type
= egetenv ("TERM");
1073 const char *name
= ttyname (fileno (stdout
));
1081 message (TRUE
, "%s: could not get terminal name\n", progname
);
1092 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1098 if (strcmp (type
, "eterm") == 0)
1104 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1105 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1106 " is not supported\n", progname
);
1117 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1119 /* Three possibilities:
1120 2 - can't be `stat'ed (sets errno)
1121 1 - isn't owned by us
1122 0 - success: none of the above */
1125 socket_status (const char *name
)
1127 struct stat statbfr
;
1129 if (stat (name
, &statbfr
) == -1)
1132 if (statbfr
.st_uid
!= geteuid ())
1139 /* A signal handler that passes the signal to the Emacs process.
1140 Useful for SIGWINCH. */
1143 pass_signal_to_emacs (int signalnum
)
1145 int old_errno
= errno
;
1148 kill (emacs_pid
, signalnum
);
1150 signal (signalnum
, pass_signal_to_emacs
);
1154 /* Signal handler for SIGCONT; notify the Emacs process that it can
1155 now resume our tty frame. */
1158 handle_sigcont (int signalnum
)
1160 int old_errno
= errno
;
1162 if (tcgetpgrp (1) == getpgrp ())
1164 /* We are in the foreground. */
1165 send_to_emacs (emacs_socket
, "-resume \n");
1169 /* We are in the background; cancel the continue. */
1170 kill (getpid (), SIGSTOP
);
1173 signal (signalnum
, handle_sigcont
);
1177 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1178 going to sleep. Normally the suspend is initiated by Emacs via
1179 server-handle-suspend-tty, but if the server gets out of sync with
1180 reality, we may get a SIGTSTP on C-z. Handling this signal and
1181 notifying Emacs about it should get things under control again. */
1184 handle_sigtstp (int signalnum
)
1186 int old_errno
= errno
;
1190 send_to_emacs (emacs_socket
, "-suspend \n");
1192 /* Unblock this signal and call the default handler by temporarily
1193 changing the handler and resignaling. */
1194 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1195 sigdelset (&set
, signalnum
);
1196 signal (signalnum
, SIG_DFL
);
1197 kill (getpid (), signalnum
);
1198 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1199 signal (signalnum
, handle_sigtstp
);
1205 /* Set up signal handlers before opening a frame on the current tty. */
1210 /* Set up signal handlers. */
1211 signal (SIGWINCH
, pass_signal_to_emacs
);
1213 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1214 deciding which terminal the signal came from. C-g is now a
1215 normal input event on secondary terminals. */
1217 signal (SIGINT
, pass_signal_to_emacs
);
1218 signal (SIGQUIT
, pass_signal_to_emacs
);
1221 signal (SIGCONT
, handle_sigcont
);
1222 signal (SIGTSTP
, handle_sigtstp
);
1223 signal (SIGTTOU
, handle_sigtstp
);
1228 set_local_socket (const char *local_socket_name
)
1231 struct sockaddr_un server
;
1233 /* Open up an AF_UNIX socket in this person's home directory. */
1234 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1236 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1237 return INVALID_SOCKET
;
1240 server
.sun_family
= AF_UNIX
;
1246 const char *server_name
= local_socket_name
;
1247 const char *tmpdir
IF_LINT ( = NULL
);
1248 char *tmpdir_storage
= NULL
;
1249 char *socket_name_storage
= NULL
;
1251 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1253 /* socket_name is a file name component. */
1254 long uid
= geteuid ();
1255 ptrdiff_t tmpdirlen
;
1257 tmpdir
= egetenv ("TMPDIR");
1261 #ifndef _CS_DARWIN_USER_TEMP_DIR
1262 #define _CS_DARWIN_USER_TEMP_DIR 65537
1264 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1267 tmpdir
= tmpdir_storage
= xmalloc (n
);
1268 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1274 tmpdirlen
= strlen (tmpdir
);
1275 socket_name_storage
=
1276 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1277 strcpy (socket_name_storage
, tmpdir
);
1278 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1279 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1280 local_socket_name
= socket_name_storage
;
1283 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1284 strcpy (server
.sun_path
, local_socket_name
);
1287 message (TRUE
, "%s: socket-name %s too long\n",
1288 progname
, local_socket_name
);
1292 /* See if the socket exists, and if it's owned by us. */
1293 sock_status
= socket_status (server
.sun_path
);
1294 saved_errno
= errno
;
1295 if (sock_status
&& use_tmpdir
)
1297 /* Failing that, see if LOGNAME or USER exist and differ from
1298 our euid. If so, look for a socket based on the UID
1299 associated with the name. This is reminiscent of the logic
1300 that init_editfns uses to set the global Vuser_full_name. */
1302 const char *user_name
= egetenv ("LOGNAME");
1305 user_name
= egetenv ("USER");
1309 struct passwd
*pw
= getpwnam (user_name
);
1311 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1313 /* We're running under su, apparently. */
1314 long uid
= pw
->pw_uid
;
1315 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1316 char *user_socket_name
1317 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1318 strcpy (user_socket_name
, tmpdir
);
1319 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1320 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1322 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1323 strcpy (server
.sun_path
, user_socket_name
);
1326 message (TRUE
, "%s: socket-name %s too long\n",
1327 progname
, user_socket_name
);
1328 exit (EXIT_FAILURE
);
1330 free (user_socket_name
);
1332 sock_status
= socket_status (server
.sun_path
);
1333 saved_errno
= errno
;
1336 errno
= saved_errno
;
1340 free (socket_name_storage
);
1341 free (tmpdir_storage
);
1343 switch (sock_status
)
1346 /* There's a socket, but it isn't owned by us. This is OK if
1348 if (0 != geteuid ())
1350 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1351 return INVALID_SOCKET
;
1357 if (saved_errno
== ENOENT
)
1359 "%s: can't find socket; have you started the server?\n\
1360 To start the server in Emacs, type \"M-x server-start\".\n",
1363 message (TRUE
, "%s: can't stat %s: %s\n",
1364 progname
, server
.sun_path
, strerror (saved_errno
));
1365 return INVALID_SOCKET
;
1369 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1372 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1373 return INVALID_SOCKET
;
1378 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1381 set_socket (int no_exit_if_error
)
1384 const char *local_server_file
= server_file
;
1388 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1389 /* Explicit --socket-name argument. */
1392 s
= set_local_socket (socket_name
);
1393 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1395 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1396 progname
, socket_name
);
1397 exit (EXIT_FAILURE
);
1401 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1402 if (!local_server_file
)
1403 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1405 if (local_server_file
)
1407 s
= set_tcp_socket (local_server_file
);
1408 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1411 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1412 progname
, local_server_file
);
1413 exit (EXIT_FAILURE
);
1416 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1417 /* Implicit local socket. */
1418 s
= set_local_socket ("server");
1419 if (s
!= INVALID_SOCKET
)
1423 /* Implicit server file. */
1424 s
= set_tcp_socket ("server");
1425 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1428 /* No implicit or explicit socket, and no alternate editor. */
1429 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1430 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1433 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1434 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1436 exit (EXIT_FAILURE
);
1440 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1441 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1444 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1449 /* Reject any window not of class "Emacs". */
1450 if (! get_wc (hWnd
, class, sizeof (class))
1451 || strcmp (class, "Emacs"))
1454 /* We only need the process id, not the thread id. */
1455 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1457 /* Not the one we're looking for. */
1458 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1460 /* OK, let's raise it. */
1463 /* Stop enumeration. */
1467 /* Search for a window of class "Emacs" and owned by a process with
1468 process id = emacs_pid. If found, allow it to grab the focus. */
1471 w32_give_focus (void)
1475 /* It shouldn't happen when dealing with TCP sockets. */
1476 if (!emacs_pid
) return;
1478 user32
= GetModuleHandle ("user32.dll");
1483 /* Modern Windows restrict which processes can set the foreground window.
1484 emacsclient can allow Emacs to grab the focus by calling the function
1485 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1486 NT) lack this function, so we have to check its availability. */
1487 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1488 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1489 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1493 /* Start the emacs daemon and try to connect to it. */
1496 start_daemon_and_retry_set_socket (void)
1507 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1509 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1511 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1512 exit (EXIT_FAILURE
);
1515 /* Try connecting, the daemon should have started by now. */
1516 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1517 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1519 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1520 exit (EXIT_FAILURE
);
1525 fprintf (stderr
, "Error: Cannot fork!\n");
1526 exit (EXIT_FAILURE
);
1530 char emacs
[] = "emacs";
1531 char daemon_option
[] = "--daemon";
1532 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1533 if (socket_name
!= NULL
)
1535 /* Pass --daemon=socket_name as argument. */
1536 const char *deq
= "--daemon=";
1537 char *daemon_arg
= xmalloc (strlen (deq
)
1538 + strlen (socket_name
) + 1);
1539 strcpy (daemon_arg
, deq
);
1540 strcat (daemon_arg
, socket_name
);
1541 d_argv
[1] = daemon_arg
;
1543 execvp ("emacs", d_argv
);
1544 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1546 #endif /* WINDOWSNT */
1550 main (int argc
, char **argv
)
1552 int rl
= 0, needlf
= 0;
1554 char string
[BUFSIZ
+1];
1555 int start_daemon_if_needed
;
1556 int exit_status
= EXIT_SUCCESS
;
1562 /* On Windows 7 and later, we need to explicitly associate emacsclient
1563 with emacs so the UI behaves sensibly. */
1564 w32_set_user_model_id ();
1567 /* Process options. */
1568 decode_options (argc
, argv
);
1570 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1572 message (TRUE
, "%s: file name or argument required\n"
1573 "Try `%s --help' for more information\n",
1574 progname
, progname
);
1575 exit (EXIT_FAILURE
);
1578 /* If alternate_editor is the empty string, start the emacs daemon
1579 in case of failure to connect. */
1580 start_daemon_if_needed
= (alternate_editor
1581 && (alternate_editor
[0] == '\0'));
1583 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1584 if (emacs_socket
== INVALID_SOCKET
)
1586 if (! start_daemon_if_needed
)
1589 start_daemon_and_retry_set_socket ();
1592 cwd
= get_current_dir_name ();
1595 /* getwd puts message in STRING if it fails. */
1596 message (TRUE
, "%s: %s\n", progname
,
1597 "Cannot get current working directory");
1605 /* Send over our environment and current directory. */
1609 /* This is defined in stdlib.h on MS-Windows. It's defined in
1610 unistd.h on some POSIX hosts, but not all (Bug#10155). */
1611 extern char **environ
;
1614 for (i
= 0; environ
[i
]; i
++)
1616 send_to_emacs (emacs_socket
, "-env ");
1617 quote_argument (emacs_socket
, environ
[i
]);
1618 send_to_emacs (emacs_socket
, " ");
1621 send_to_emacs (emacs_socket
, "-dir ");
1622 quote_argument (emacs_socket
, cwd
);
1623 send_to_emacs (emacs_socket
, "/");
1624 send_to_emacs (emacs_socket
, " ");
1628 send_to_emacs (emacs_socket
, "-nowait ");
1631 send_to_emacs (emacs_socket
, "-current-frame ");
1635 send_to_emacs (emacs_socket
, "-display ");
1636 quote_argument (emacs_socket
, display
);
1637 send_to_emacs (emacs_socket
, " ");
1642 send_to_emacs (emacs_socket
, "-parent-id ");
1643 quote_argument (emacs_socket
, parent_id
);
1644 send_to_emacs (emacs_socket
, " ");
1647 if (frame_parameters
&& !current_frame
)
1649 send_to_emacs (emacs_socket
, "-frame-parameters ");
1650 quote_argument (emacs_socket
, frame_parameters
);
1651 send_to_emacs (emacs_socket
, " ");
1654 /* Unless we are certain we don't want to occupy the tty, send our
1655 tty information to Emacs. For example, in daemon mode Emacs may
1656 need to occupy this tty if no other frame is available. */
1657 if (!current_frame
|| !eval
)
1659 const char *tty_type
, *tty_name
;
1661 if (find_tty (&tty_type
, &tty_name
, !tty
))
1663 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1666 send_to_emacs (emacs_socket
, "-tty ");
1667 quote_argument (emacs_socket
, tty_name
);
1668 send_to_emacs (emacs_socket
, " ");
1669 quote_argument (emacs_socket
, tty_type
);
1670 send_to_emacs (emacs_socket
, " ");
1674 if (!current_frame
&& !tty
)
1675 send_to_emacs (emacs_socket
, "-window-system ");
1677 if ((argc
- optind
> 0))
1680 for (i
= optind
; i
< argc
; i
++)
1685 /* Don't prepend cwd or anything like that. */
1686 send_to_emacs (emacs_socket
, "-eval ");
1687 quote_argument (emacs_socket
, argv
[i
]);
1688 send_to_emacs (emacs_socket
, " ");
1692 if (*argv
[i
] == '+')
1694 char *p
= argv
[i
] + 1;
1695 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1698 send_to_emacs (emacs_socket
, "-position ");
1699 quote_argument (emacs_socket
, argv
[i
]);
1700 send_to_emacs (emacs_socket
, " ");
1705 else if (! file_name_absolute_p (argv
[i
])
1706 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1707 /* Windows can have a different default directory for each
1708 drive, so the cwd passed via "-dir" is not sufficient
1709 to account for that.
1710 If the user uses <drive>:<relpath>, we hence need to be
1711 careful to expand <relpath> with the default directory
1712 corresponding to <drive>. */
1714 char *filename
= (char *) xmalloc (MAX_PATH
);
1717 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1718 if (size
> 0 && size
< MAX_PATH
)
1725 send_to_emacs (emacs_socket
, "-file ");
1726 quote_argument (emacs_socket
, argv
[i
]);
1727 send_to_emacs (emacs_socket
, " ");
1732 /* Read expressions interactively. */
1733 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1735 send_to_emacs (emacs_socket
, "-eval ");
1736 quote_argument (emacs_socket
, str
);
1738 send_to_emacs (emacs_socket
, " ");
1741 send_to_emacs (emacs_socket
, "\n");
1743 /* Wait for an answer. */
1744 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1746 printf ("Waiting for Emacs...");
1752 /* Now, wait for an answer and print any messages. */
1753 while (exit_status
== EXIT_SUCCESS
)
1759 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1761 /* If we receive a signal (e.g. SIGWINCH, which we pass
1762 through to Emacs), on some OSes we get EINTR and must retry. */
1763 while (rl
< 0 && errno
== EINTR
);
1770 /* Loop over all NL-terminated messages. */
1771 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1773 end_p
= strchr (p
, '\n');
1777 if (strprefix ("-emacs-pid ", p
))
1779 /* -emacs-pid PID: The process id of the Emacs process. */
1780 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1782 else if (strprefix ("-window-system-unsupported ", p
))
1784 /* -window-system-unsupported: Emacs was compiled without X
1785 support. Try again on the terminal. */
1790 else if (strprefix ("-print ", p
))
1792 /* -print STRING: Print STRING on the terminal. */
1793 str
= unquote_argument (p
+ strlen ("-print "));
1797 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1799 else if (strprefix ("-print-nonl ", p
))
1801 /* -print-nonl STRING: Print STRING on the terminal.
1802 Used to continue a preceding -print command. */
1803 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1805 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1807 else if (strprefix ("-error ", p
))
1809 /* -error DESCRIPTION: Signal an error on the terminal. */
1810 str
= unquote_argument (p
+ strlen ("-error "));
1813 fprintf (stderr
, "*ERROR*: %s", str
);
1814 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1815 exit_status
= EXIT_FAILURE
;
1818 else if (strprefix ("-suspend ", p
))
1820 /* -suspend: Suspend this terminal, i.e., stop the process. */
1829 /* Unknown command. */
1833 printf ("*ERROR*: Unknown message: %s\n", p
);
1844 exit_status
= EXIT_FAILURE
;
1846 CLOSE_SOCKET (emacs_socket
);
1850 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */