1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986, 1987, 1994, 1999, 2000, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008, 2009, 2010 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 /* config.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 # ifdef HAVE_INET_SOCKETS
50 # include <netinet/in.h>
52 # include <sys/types.h>
53 # include <sys/socket.h>
55 # endif /* HAVE_SOCKETS */
57 # include <arpa/inet.h>
59 # define INVALID_SOCKET -1
61 # define CLOSE_SOCKET close
68 #define egetenv(VAR) getenv(VAR)
70 #endif /* !WINDOWSNT */
89 char *getenv (const char *), *getwd (char *);
91 char *(getcwd
) (char *, size_t);
95 #define VERSION "unspecified"
100 #define EXIT_SUCCESS 0
104 #define EXIT_FAILURE 1
115 /* Additional space when allocating buffers for filenames, etc. */
116 #define EXTRA_SPACE 100
119 /* Name used to invoke this program. */
120 const char *progname
;
122 /* The second argument to main. */
125 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
128 /* Nonzero means args are expressions to be evaluated. --eval. */
131 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
132 int current_frame
= 1;
134 /* The display on which Emacs should work. --display. */
135 const char *display
= NULL
;
137 /* The parent window ID, if we are opening a frame via XEmbed. */
138 char *parent_id
= NULL
;
140 /* Nonzero means open a new Emacs frame on the current terminal. */
143 /* If non-NULL, the name of an editor to fallback to if the server
144 is not running. --alternate-editor. */
145 const char *alternate_editor
= NULL
;
147 /* If non-NULL, the filename of the UNIX socket. */
148 char *socket_name
= NULL
;
150 /* If non-NULL, the filename of the authentication file. */
151 const char *server_file
= NULL
;
153 /* PID of the Emacs server process. */
156 void print_help_and_exit (void) NO_RETURN
;
157 void fail (void) NO_RETURN
;
160 struct option longopts
[] =
162 { "no-wait", no_argument
, NULL
, 'n' },
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 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
171 { "socket-name", required_argument
, NULL
, 's' },
173 { "server-file", required_argument
, NULL
, 'f' },
175 { "display", required_argument
, NULL
, 'd' },
177 { "parent-id", required_argument
, NULL
, 'p' },
182 /* Like malloc but get fatal error if memory is exhausted. */
185 xmalloc (unsigned int size
)
187 long *result
= (long *) malloc (size
);
196 /* Like strdup but get a fatal error if memory is exhausted. */
199 xstrdup (const char *s
)
201 char *result
= strdup (s
);
211 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
214 #ifndef DIRECTORY_SEP
215 #define DIRECTORY_SEP '/'
217 #ifndef IS_DIRECTORY_SEP
218 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
220 #ifndef IS_DEVICE_SEP
222 #define IS_DEVICE_SEP(_c_) 0
224 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
228 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
232 /* Return the current working directory. Returns NULL on errors.
233 Any other returned value must be freed with free. This is used
234 only when get_current_dir_name is not defined on the system. */
236 get_current_dir_name (void)
240 struct stat dotstat
, pwdstat
;
241 /* If PWD is accurate, use it instead of calling getwd. PWD is
242 sometimes a nicer name, and using it may avoid a fatal error if a
243 parent directory is searchable but not readable. */
244 if ((pwd
= egetenv ("PWD")) != 0
245 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
246 && stat (pwd
, &pwdstat
) == 0
247 && stat (".", &dotstat
) == 0
248 && dotstat
.st_ino
== pwdstat
.st_ino
249 && dotstat
.st_dev
== pwdstat
.st_dev
251 && strlen (pwd
) < MAXPATHLEN
255 buf
= (char *) xmalloc (strlen (pwd
) + 1);
263 size_t buf_size
= 1024;
264 buf
= (char *) xmalloc (buf_size
);
269 if (getcwd (buf
, buf_size
) == buf
)
273 int tmp_errno
= errno
;
279 buf
= (char *) realloc (buf
, buf_size
);
287 /* We need MAXPATHLEN here. */
288 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
291 if (getwd (buf
) == NULL
)
293 int tmp_errno
= errno
;
306 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
308 /* Retrieve an environment variable from the Emacs subkeys of the registry.
309 Return NULL if the variable was not found, or it was empty.
310 This code is based on w32_get_resource (w32.c). */
312 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
314 HKEY hrootkey
= NULL
;
318 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
320 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
322 result
= (char *) xmalloc (cbData
);
324 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
332 RegCloseKey (hrootkey
);
339 getenv wrapper for Windows
341 This is needed to duplicate Emacs's behavior, which is to look for environment
342 variables in the registry if they don't appear in the environment.
345 w32_getenv (char *envvar
)
350 if (value
= getenv (envvar
))
351 /* Found in the environment. */
354 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
355 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
357 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
358 if (strcmp (envvar
, "TERM") == 0)
359 return xstrdup ("w32console");
360 /* Found neither in the environment nor in the registry. */
364 if (dwType
== REG_SZ
)
365 /* Registry; no need to expand. */
368 if (dwType
== REG_EXPAND_SZ
)
372 if (size
= ExpandEnvironmentStrings (value
, NULL
, 0))
374 char *buffer
= (char *) xmalloc (size
);
375 if (ExpandEnvironmentStrings (value
, buffer
, size
))
377 /* Found and expanded. */
382 /* Error expanding. */
387 /* Not the right type, or not correctly expanded. */
393 w32_set_user_model_id (void)
396 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
398 /* On Windows 7 and later, we need to set the user model ID
399 to associate emacsclient launched files with Emacs frames
401 shell
= LoadLibrary ("shell32.dll");
405 = (void *) GetProcAddress (shell
,
406 "SetCurrentProcessExplicitAppUserModelID");
407 /* If the function is defined, then we are running on Windows 7
408 or newer, and the UI uses this to group related windows
409 together. Since emacs, runemacs, emacsclient are related, we
410 want them grouped even though the executables are different,
411 so we need to set a consistent ID between them. */
413 set_user_model (L
"GNU.Emacs");
420 w32_window_app (void)
422 static int window_app
= -1;
423 char szTitle
[MAX_PATH
];
427 /* Checking for STDOUT does not work; it's a valid handle also in
428 nonconsole apps. Testing for the console title seems to work. */
429 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
431 InitCommonControls ();
438 execvp wrapper for Windows. Quotes arguments with embedded spaces.
440 This is necessary due to the broken implementation of exec* routines in
441 the Microsoft libraries: they concatenate the arguments together without
442 quoting special characters, and pass the result to CreateProcess, with
443 predictably bad results. By contrast, POSIX execvp passes the arguments
444 directly into the argv array of the child process.
447 w32_execvp (const char *path
, char **argv
)
451 /* Required to allow a .BAT script as alternate editor. */
452 argv
[0] = (char *) alternate_editor
;
454 for (i
= 0; argv
[i
]; i
++)
455 if (strchr (argv
[i
], ' '))
457 char *quoted
= alloca (strlen (argv
[i
]) + 3);
458 sprintf (quoted
, "\"%s\"", argv
[i
]);
462 return execvp (path
, argv
);
466 #define execvp w32_execvp
468 /* Emulation of ttyname for Windows. */
475 #endif /* WINDOWSNT */
477 /* Display a normal or error message.
478 On Windows, use a message box if compiled as a Windows app. */
480 message (int is_error
, const char *message
, ...)
485 va_start (args
, message
);
486 vsprintf (msg
, message
, args
);
490 if (w32_window_app ())
493 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
495 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
500 FILE *f
= is_error
? stderr
: stdout
;
507 /* Decode the options from argv and argc.
508 The global variable `optind' will say how many arguments we used up. */
511 decode_options (int argc
, char **argv
)
513 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
517 int opt
= getopt_long_only (argc
, argv
,
518 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
531 /* If getopt returns 0, then it has already processed a
532 long-named option. We should do nothing. */
536 alternate_editor
= optarg
;
539 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
541 socket_name
= optarg
;
546 server_file
= optarg
;
549 /* We used to disallow this argument in w32, but it seems better
550 to allow it, for the occasional case where the user is
551 connecting with a w32 client to a server compiled with X11
566 message (FALSE
, "emacsclient %s\n", VERSION
);
585 print_help_and_exit ();
589 message (TRUE
, "Try `%s --help' for more information\n", progname
);
595 /* If the -c option is used (without -t) and no --display argument
596 is provided, try $DISPLAY.
597 Without the -c option, we used to set `display' to $DISPLAY by
598 default, but this changed the default behavior and is sometimes
599 inconvenient. So we force users to use "--display $DISPLAY" if
600 they want Emacs to connect to their current display. */
601 if (!current_frame
&& !tty
&& !display
)
603 display
= egetenv ("DISPLAY");
605 /* Under Cocoa, we don't really use displays the same way as in X,
606 so provide a dummy. */
607 if (!display
|| strlen (display
) == 0)
612 /* A null-string display is invalid. */
613 if (display
&& strlen (display
) == 0)
616 /* If no display is available, new frames are tty frames. */
617 if (!current_frame
&& !display
)
620 /* --no-wait implies --current-frame on ttys when there are file
621 arguments or expressions given. */
622 if (nowait
&& tty
&& argc
- optind
> 0)
626 if (alternate_editor
&& alternate_editor
[0] == '\0')
628 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
632 #endif /* WINDOWSNT */
637 print_help_and_exit (void)
639 /* Spaces and tabs are significant in this message; they're chosen so the
640 message aligns properly both in a tty and in a Windows message box.
641 Please try to preserve them; otherwise the output is very hard to read
642 when using emacsclientw. */
644 "Usage: %s [OPTIONS] FILE...\n\
645 Tell the Emacs server to visit the specified files.\n\
646 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
648 The following OPTIONS are accepted:\n\
649 -V, --version Just print version info and return\n\
650 -H, --help Print this usage information message\n\
651 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
652 -c, --create-frame Create a new frame instead of trying to\n\
653 use the current Emacs frame\n\
654 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
655 -n, --no-wait Don't wait for the server to return\n\
656 -d DISPLAY, --display=DISPLAY\n\
657 Visit the file in the given display\n\
658 --parent-id=ID Open in parent window ID, via XEmbed\n"
659 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
660 "-s SOCKET, --socket-name=SOCKET\n\
661 Set filename of the UNIX socket for communication\n"
663 "-f SERVER, --server-file=SERVER\n\
664 Set filename of the TCP authentication file\n\
665 -a EDITOR, --alternate-editor=EDITOR\n\
666 Editor to fallback to if the server is not running\n"
668 " If EDITOR is the empty string, start Emacs in daemon\n\
669 mode and try connecting again\n"
670 #endif /* not WINDOWSNT */
672 Report bugs with M-x report-emacs-bug.\n", progname
);
677 Try to run a different command, or --if no alternate editor is
678 defined-- exit with an errorcode.
679 Uses argv, but gets it from the global variable main_argv.
684 if (alternate_editor
)
688 execvp (alternate_editor
, main_argv
+ i
);
689 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
690 progname
, alternate_editor
);
696 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
699 main (int argc
, char **argv
)
703 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
704 "on systems with Berkeley sockets.\n",
709 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
711 #define AUTH_KEY_LENGTH 64
712 #define SEND_BUFFER_SIZE 4096
714 extern char *strerror (int);
716 /* Buffer to accumulate data to send in TCP connections. */
717 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
718 int sblen
= 0; /* Fill pointer for the send buffer. */
719 /* Socket used to communicate with the Emacs server process. */
720 HSOCKET emacs_socket
= 0;
722 /* On Windows, the socket library was historically separate from the standard
723 C library, so errors are handled differently. */
725 sock_err_message (const char *function_name
)
730 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
731 | FORMAT_MESSAGE_ALLOCATE_BUFFER
732 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
733 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
735 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
739 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
744 /* Let's send the data to Emacs when either
745 - the data ends in "\n", or
746 - the buffer is full (but this shouldn't happen)
747 Otherwise, we just accumulate it. */
749 send_to_emacs (HSOCKET s
, const char *data
)
753 size_t dlen
= strlen (data
);
754 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
756 int part
= SEND_BUFFER_SIZE
- sblen
;
757 strncpy (&send_buffer
[sblen
], data
, part
);
759 sblen
= SEND_BUFFER_SIZE
;
763 strcpy (&send_buffer
[sblen
], data
);
770 if (sblen
== SEND_BUFFER_SIZE
771 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
773 int sent
= send (s
, send_buffer
, sblen
, 0);
775 strcpy (send_buffer
, &send_buffer
[sent
]);
782 /* In STR, insert a & before each &, each space, each newline, and
783 any initial -. Change spaces to underscores, too, so that the
784 return value never contains a space.
786 Does not change the string. Outputs the result to S. */
788 quote_argument (HSOCKET s
, const char *str
)
790 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
812 if (*p
== '&' || (*p
== '-' && p
== str
))
819 send_to_emacs (s
, copy
);
825 /* The inverse of quote_argument. Removes quoting in string STR by
826 modifying the string in place. Returns STR. */
829 unquote_argument (char *str
)
860 file_name_absolute_p (const unsigned char *filename
)
862 /* Sanity check, it shouldn't happen. */
863 if (! filename
) return FALSE
;
865 /* /xxx is always an absolute path. */
866 if (filename
[0] == '/') return TRUE
;
868 /* Empty filenames (which shouldn't happen) are relative. */
869 if (filename
[0] == '\0') return FALSE
;
872 /* X:\xxx is always absolute. */
873 if (isalpha (filename
[0])
874 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
877 /* Both \xxx and \\xxx\yyy are absolute. */
878 if (filename
[0] == '\\') return TRUE
;
885 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
892 /* Initialize the WinSock2 library. */
894 initialize_sockets (void)
898 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
900 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
904 atexit (close_winsock
);
906 #endif /* WINDOWSNT */
910 * Read the information needed to set up a TCP comm channel with
911 * the Emacs server: host, port, and authentication string.
914 get_server_config (struct sockaddr_in
*server
, char *authentication
)
920 if (file_name_absolute_p (server_file
))
921 config
= fopen (server_file
, "rb");
924 char *home
= egetenv ("HOME");
928 char *path
= alloca (strlen (home
) + strlen (server_file
)
930 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
931 config
= fopen (path
, "rb");
934 if (!config
&& (home
= egetenv ("APPDATA")))
936 char *path
= alloca (strlen (home
) + strlen (server_file
)
938 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
939 config
= fopen (path
, "rb");
947 if (fgets (dotted
, sizeof dotted
, config
)
948 && (port
= strchr (dotted
, ':')))
952 message (TRUE
, "%s: invalid configuration info\n", progname
);
956 server
->sin_family
= AF_INET
;
957 server
->sin_addr
.s_addr
= inet_addr (dotted
);
958 server
->sin_port
= htons (atoi (port
));
960 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
962 message (TRUE
, "%s: cannot read authentication info\n", progname
);
972 set_tcp_socket (void)
975 struct sockaddr_in server
;
976 struct linger l_arg
= {1, 1};
977 char auth_string
[AUTH_KEY_LENGTH
+ 1];
979 if (! get_server_config (&server
, auth_string
))
980 return INVALID_SOCKET
;
982 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
983 message (FALSE
, "%s: connected to remote socket at %s\n",
984 progname
, inet_ntoa (server
.sin_addr
));
987 * Open up an AF_INET socket
989 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
991 sock_err_message ("socket");
992 return INVALID_SOCKET
;
998 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1000 sock_err_message ("connect");
1001 return INVALID_SOCKET
;
1004 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1007 * Send the authentication
1009 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1011 send_to_emacs (s
, "-auth ");
1012 send_to_emacs (s
, auth_string
);
1013 send_to_emacs (s
, " ");
1019 /* Returns 1 if PREFIX is a prefix of STRING. */
1021 strprefix (const char *prefix
, const char *string
)
1023 return !strncmp (prefix
, string
, strlen (prefix
));
1026 /* Get tty name and type. If successful, return the type in TTY_TYPE
1027 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1028 is zero, or return 0 if NOABORT is non-zero. */
1031 find_tty (char **tty_type
, char **tty_name
, int noabort
)
1033 char *type
= egetenv ("TERM");
1034 char *name
= ttyname (fileno (stdout
));
1042 message (TRUE
, "%s: could not get terminal name\n", progname
);
1053 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1059 if (strcmp (type
, "eterm") == 0)
1065 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1066 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1067 " is not supported\n", progname
);
1078 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1080 /* Three possibilities:
1081 2 - can't be `stat'ed (sets errno)
1082 1 - isn't owned by us
1083 0 - success: none of the above */
1086 socket_status (char *socket_name
)
1088 struct stat statbfr
;
1090 if (stat (socket_name
, &statbfr
) == -1)
1093 if (statbfr
.st_uid
!= geteuid ())
1100 /* A signal handler that passes the signal to the Emacs process.
1101 Useful for SIGWINCH. */
1104 pass_signal_to_emacs (int signalnum
)
1106 int old_errno
= errno
;
1109 kill (emacs_pid
, signalnum
);
1111 signal (signalnum
, pass_signal_to_emacs
);
1115 /* Signal handler for SIGCONT; notify the Emacs process that it can
1116 now resume our tty frame. */
1119 handle_sigcont (int signalnum
)
1121 int old_errno
= errno
;
1123 if (tcgetpgrp (1) == getpgrp ())
1125 /* We are in the foreground. */
1126 send_to_emacs (emacs_socket
, "-resume \n");
1130 /* We are in the background; cancel the continue. */
1131 kill (getpid (), SIGSTOP
);
1134 signal (signalnum
, handle_sigcont
);
1138 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1139 going to sleep. Normally the suspend is initiated by Emacs via
1140 server-handle-suspend-tty, but if the server gets out of sync with
1141 reality, we may get a SIGTSTP on C-z. Handling this signal and
1142 notifying Emacs about it should get things under control again. */
1145 handle_sigtstp (int signalnum
)
1147 int old_errno
= errno
;
1151 send_to_emacs (emacs_socket
, "-suspend \n");
1153 /* Unblock this signal and call the default handler by temporarily
1154 changing the handler and resignalling. */
1155 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1156 sigdelset (&set
, signalnum
);
1157 signal (signalnum
, SIG_DFL
);
1158 kill (getpid (), signalnum
);
1159 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1160 signal (signalnum
, handle_sigtstp
);
1166 /* Set up signal handlers before opening a frame on the current tty. */
1171 /* Set up signal handlers. */
1172 signal (SIGWINCH
, pass_signal_to_emacs
);
1174 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1175 deciding which terminal the signal came from. C-g is now a
1176 normal input event on secondary terminals. */
1178 signal (SIGINT
, pass_signal_to_emacs
);
1179 signal (SIGQUIT
, pass_signal_to_emacs
);
1182 signal (SIGCONT
, handle_sigcont
);
1183 signal (SIGTSTP
, handle_sigtstp
);
1184 signal (SIGTTOU
, handle_sigtstp
);
1189 set_local_socket (void)
1192 struct sockaddr_un server
;
1195 * Open up an AF_UNIX socket in this person's home directory
1198 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1200 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1201 return INVALID_SOCKET
;
1204 server
.sun_family
= AF_UNIX
;
1207 int sock_status
= 0;
1208 int default_sock
= !socket_name
;
1209 int saved_errno
= 0;
1210 const char *server_name
= "server";
1213 if (socket_name
&& !strchr (socket_name
, '/')
1214 && !strchr (socket_name
, '\\'))
1216 /* socket_name is a file name component. */
1217 server_name
= socket_name
;
1219 default_sock
= 1; /* Try both UIDs. */
1224 tmpdir
= egetenv ("TMPDIR");
1228 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1231 tmpdir
= alloca (n
);
1232 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir
, n
);
1238 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1240 sprintf (socket_name
, "%s/emacs%d/%s",
1241 tmpdir
, (int) geteuid (), server_name
);
1244 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1245 strcpy (server
.sun_path
, socket_name
);
1248 message (TRUE
, "%s: socket-name %s too long\n",
1249 progname
, socket_name
);
1253 /* See if the socket exists, and if it's owned by us. */
1254 sock_status
= socket_status (server
.sun_path
);
1255 saved_errno
= errno
;
1256 if (sock_status
&& default_sock
)
1258 /* Failing that, see if LOGNAME or USER exist and differ from
1259 our euid. If so, look for a socket based on the UID
1260 associated with the name. This is reminiscent of the logic
1261 that init_editfns uses to set the global Vuser_full_name. */
1263 char *user_name
= (char *) egetenv ("LOGNAME");
1266 user_name
= (char *) egetenv ("USER");
1270 struct passwd
*pw
= getpwnam (user_name
);
1272 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1274 /* We're running under su, apparently. */
1275 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1277 sprintf (socket_name
, "%s/emacs%d/%s",
1278 tmpdir
, (int) pw
->pw_uid
, server_name
);
1280 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1281 strcpy (server
.sun_path
, socket_name
);
1284 message (TRUE
, "%s: socket-name %s too long\n",
1285 progname
, socket_name
);
1286 exit (EXIT_FAILURE
);
1289 sock_status
= socket_status (server
.sun_path
);
1290 saved_errno
= errno
;
1293 errno
= saved_errno
;
1297 switch (sock_status
)
1300 /* There's a socket, but it isn't owned by us. This is OK if
1302 if (0 != geteuid ())
1304 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1305 return INVALID_SOCKET
;
1311 if (saved_errno
== ENOENT
)
1313 "%s: can't find socket; have you started the server?\n\
1314 To start the server in Emacs, type \"M-x server-start\".\n",
1317 message (TRUE
, "%s: can't stat %s: %s\n",
1318 progname
, server
.sun_path
, strerror (saved_errno
));
1319 return INVALID_SOCKET
;
1323 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1326 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1327 return INVALID_SOCKET
;
1332 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1335 set_socket (int no_exit_if_error
)
1341 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1342 /* Explicit --socket-name argument. */
1345 s
= set_local_socket ();
1346 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1348 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1349 progname
, socket_name
);
1350 exit (EXIT_FAILURE
);
1354 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1356 server_file
= egetenv ("EMACS_SERVER_FILE");
1360 s
= set_tcp_socket ();
1361 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1364 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1365 progname
, server_file
);
1366 exit (EXIT_FAILURE
);
1369 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1370 /* Implicit local socket. */
1371 s
= set_local_socket ();
1372 if (s
!= INVALID_SOCKET
)
1376 /* Implicit server file. */
1377 server_file
= "server";
1378 s
= set_tcp_socket ();
1379 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1382 /* No implicit or explicit socket, and no alternate editor. */
1383 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1384 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1387 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1388 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1390 exit (EXIT_FAILURE
);
1394 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1395 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1398 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1403 /* Reject any window not of class "Emacs". */
1404 if (! get_wc (hWnd
, class, sizeof (class))
1405 || strcmp (class, "Emacs"))
1408 /* We only need the process id, not the thread id. */
1409 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1411 /* Not the one we're looking for. */
1412 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1414 /* OK, let's raise it. */
1417 /* Stop enumeration. */
1422 * Search for a window of class "Emacs" and owned by a process with
1423 * process id = emacs_pid. If found, allow it to grab the focus.
1426 w32_give_focus (void)
1430 /* It shouldn't happen when dealing with TCP sockets. */
1431 if (!emacs_pid
) return;
1433 user32
= GetModuleHandle ("user32.dll");
1438 /* Modern Windows restrict which processes can set the foreground window.
1439 emacsclient can allow Emacs to grab the focus by calling the function
1440 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1441 NT) lack this function, so we have to check its availability. */
1442 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1443 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1444 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1448 /* Start the emacs daemon and try to connect to it. */
1451 start_daemon_and_retry_set_socket (void)
1462 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1464 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1466 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1467 exit (EXIT_FAILURE
);
1470 /* Try connecting, the daemon should have started by now. */
1471 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1472 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1474 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1475 exit (EXIT_FAILURE
);
1480 fprintf (stderr
, "Error: Cannot fork!\n");
1481 exit (EXIT_FAILURE
);
1485 char emacs
[] = "emacs";
1486 char daemon
[] = "--daemon";
1487 char *d_argv
[] = {emacs
, daemon
, 0 };
1488 if (socket_name
!= NULL
)
1490 /* Pass --daemon=socket_name as argument. */
1491 const char *deq
= "--daemon=";
1492 char *daemon_arg
= alloca (strlen (deq
)
1493 + strlen (socket_name
) + 1);
1494 strcpy (daemon_arg
, deq
);
1495 strcat (daemon_arg
, socket_name
);
1496 d_argv
[1] = daemon_arg
;
1498 execvp ("emacs", d_argv
);
1499 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1501 #endif /* WINDOWSNT */
1505 main (int argc
, char **argv
)
1507 int i
, rl
, needlf
= 0;
1509 char string
[BUFSIZ
+1];
1510 int null_socket_name
, null_server_file
, start_daemon_if_needed
;
1511 int exit_status
= EXIT_SUCCESS
;
1517 /* On Windows 7 and later, we need to explicitly associate emacsclient
1518 with emacs so the UI behaves sensibly. */
1519 w32_set_user_model_id ();
1522 /* Process options. */
1523 decode_options (argc
, argv
);
1525 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1527 message (TRUE
, "%s: file name or argument required\n"
1528 "Try `%s --help' for more information\n",
1529 progname
, progname
);
1530 exit (EXIT_FAILURE
);
1533 /* If alternate_editor is the empty string, start the emacs daemon
1534 in case of failure to connect. */
1535 start_daemon_if_needed
= (alternate_editor
1536 && (alternate_editor
[0] == '\0'));
1537 if (start_daemon_if_needed
)
1539 /* set_socket changes the values for socket_name and
1540 server_file, we need to reset them, if they were NULL before
1541 for the second call to set_socket. */
1542 null_socket_name
= (socket_name
== NULL
);
1543 null_server_file
= (server_file
== NULL
);
1546 if ((emacs_socket
= set_socket (alternate_editor
1547 || start_daemon_if_needed
)) == INVALID_SOCKET
)
1548 if (start_daemon_if_needed
)
1550 /* Reset socket_name and server_file if they were NULL
1551 before the set_socket call. */
1552 if (null_socket_name
)
1554 if (null_server_file
)
1557 start_daemon_and_retry_set_socket ();
1562 cwd
= get_current_dir_name ();
1565 /* getwd puts message in STRING if it fails. */
1566 message (TRUE
, "%s: %s\n", progname
,
1567 "Cannot get current working directory");
1575 /* Send over our environment and current directory. */
1578 extern char **environ
;
1580 for (i
= 0; environ
[i
]; i
++)
1582 send_to_emacs (emacs_socket
, "-env ");
1583 quote_argument (emacs_socket
, environ
[i
]);
1584 send_to_emacs (emacs_socket
, " ");
1587 send_to_emacs (emacs_socket
, "-dir ");
1588 quote_argument (emacs_socket
, cwd
);
1589 send_to_emacs (emacs_socket
, "/");
1590 send_to_emacs (emacs_socket
, " ");
1594 send_to_emacs (emacs_socket
, "-nowait ");
1597 send_to_emacs (emacs_socket
, "-current-frame ");
1601 send_to_emacs (emacs_socket
, "-display ");
1602 quote_argument (emacs_socket
, display
);
1603 send_to_emacs (emacs_socket
, " ");
1608 send_to_emacs (emacs_socket
, "-parent-id ");
1609 quote_argument (emacs_socket
, parent_id
);
1610 send_to_emacs (emacs_socket
, " ");
1613 /* If using the current frame, send tty information to Emacs anyway.
1614 In daemon mode, Emacs may need to occupy this tty if no other
1615 frame is available. */
1616 if (tty
|| (current_frame
&& !eval
))
1618 char *tty_type
, *tty_name
;
1620 if (find_tty (&tty_type
, &tty_name
, !tty
))
1622 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1625 send_to_emacs (emacs_socket
, "-tty ");
1626 quote_argument (emacs_socket
, tty_name
);
1627 send_to_emacs (emacs_socket
, " ");
1628 quote_argument (emacs_socket
, tty_type
);
1629 send_to_emacs (emacs_socket
, " ");
1633 if (!current_frame
&& !tty
)
1634 send_to_emacs (emacs_socket
, "-window-system ");
1636 if ((argc
- optind
> 0))
1638 for (i
= optind
; i
< argc
; i
++)
1643 /* Don't prepend cwd or anything like that. */
1644 send_to_emacs (emacs_socket
, "-eval ");
1645 quote_argument (emacs_socket
, argv
[i
]);
1646 send_to_emacs (emacs_socket
, " ");
1650 if (*argv
[i
] == '+')
1652 char *p
= argv
[i
] + 1;
1653 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1656 send_to_emacs (emacs_socket
, "-position ");
1657 quote_argument (emacs_socket
, argv
[i
]);
1658 send_to_emacs (emacs_socket
, " ");
1663 else if (! file_name_absolute_p (argv
[i
])
1664 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1665 /* Windows can have a different default directory for each
1666 drive, so the cwd passed via "-dir" is not sufficient
1667 to account for that.
1668 If the user uses <drive>:<relpath>, we hence need to be
1669 careful to expand <relpath> with the default directory
1670 corresponding to <drive>. */
1672 char *filename
= (char *) xmalloc (MAX_PATH
);
1675 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1676 if (size
> 0 && size
< MAX_PATH
)
1683 send_to_emacs (emacs_socket
, "-file ");
1684 quote_argument (emacs_socket
, argv
[i
]);
1685 send_to_emacs (emacs_socket
, " ");
1690 /* Read expressions interactively. */
1691 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1693 send_to_emacs (emacs_socket
, "-eval ");
1694 quote_argument (emacs_socket
, str
);
1696 send_to_emacs (emacs_socket
, " ");
1699 send_to_emacs (emacs_socket
, "\n");
1701 /* Wait for an answer. */
1702 if (!eval
&& !tty
&& !nowait
)
1704 printf ("Waiting for Emacs...");
1710 /* Now, wait for an answer and print any messages. */
1711 while (exit_status
== EXIT_SUCCESS
1712 && (rl
= recv (emacs_socket
, string
, BUFSIZ
, 0)) > 0)
1717 p
= string
+ strlen (string
) - 1;
1718 while (p
> string
&& *p
== '\n')
1721 if (strprefix ("-emacs-pid ", string
))
1723 /* -emacs-pid PID: The process id of the Emacs process. */
1724 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1726 else if (strprefix ("-window-system-unsupported ", string
))
1728 /* -window-system-unsupported: Emacs was compiled without X
1729 support. Try again on the terminal. */
1734 else if (strprefix ("-print ", string
))
1736 /* -print STRING: Print STRING on the terminal. */
1737 str
= unquote_argument (string
+ strlen ("-print "));
1741 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1743 else if (strprefix ("-error ", string
))
1745 /* -error DESCRIPTION: Signal an error on the terminal. */
1746 str
= unquote_argument (string
+ strlen ("-error "));
1749 fprintf (stderr
, "*ERROR*: %s", str
);
1750 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1751 exit_status
= EXIT_FAILURE
;
1754 else if (strprefix ("-suspend ", string
))
1756 /* -suspend: Suspend this terminal, i.e., stop the process. */
1765 /* Unknown command. */
1768 printf ("*ERROR*: Unknown message: %s", string
);
1770 == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1780 exit_status
= EXIT_FAILURE
;
1782 CLOSE_SOCKET (emacs_socket
);
1786 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1789 #ifndef HAVE_STRERROR
1794 extern char *sys_errlist
[];
1795 extern int sys_nerr
;
1797 if (errnum
>= 0 && errnum
< sys_nerr
)
1798 return sys_errlist
[errnum
];
1799 return (char *) "Unknown error";
1802 #endif /* ! HAVE_STRERROR */
1804 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1805 (do not change this comment) */
1807 /* emacsclient.c ends here */