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 #else /* !WINDOWSNT */
46 # ifdef HAVE_INET_SOCKETS
47 # include <netinet/in.h>
49 # include <sys/types.h>
50 # include <sys/socket.h>
52 # endif /* HAVE_SOCKETS */
54 # include <arpa/inet.h>
56 # define INVALID_SOCKET -1
58 # define CLOSE_SOCKET close
65 #endif /* !WINDOWSNT */
84 char *getenv (const char *), *getwd (char *);
86 char *(getcwd
) (char *, size_t);
90 char *w32_getenv (char *);
91 #define egetenv(VAR) w32_getenv(VAR)
93 #define egetenv(VAR) getenv(VAR)
97 #define VERSION "unspecified"
102 #define EXIT_SUCCESS 0
106 #define EXIT_FAILURE 1
117 /* Additional space when allocating buffers for filenames, etc. */
118 #define EXTRA_SPACE 100
121 /* Name used to invoke this program. */
124 /* The second argument to main. */
127 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
130 /* Nonzero means args are expressions to be evaluated. --eval. */
133 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
134 int current_frame
= 1;
136 /* The display on which Emacs should work. --display. */
137 char *display
= NULL
;
139 /* The parent window ID, if we are opening a frame via XEmbed. */
140 char *parent_id
= NULL
;
142 /* Nonzero means open a new Emacs frame on the current terminal. */
145 /* If non-NULL, the name of an editor to fallback to if the server
146 is not running. --alternate-editor. */
147 const char *alternate_editor
= NULL
;
149 /* If non-NULL, the filename of the UNIX socket. */
150 char *socket_name
= NULL
;
152 /* If non-NULL, the filename of the authentication file. */
153 char *server_file
= NULL
;
155 /* PID of the Emacs server process. */
158 void print_help_and_exit (void) NO_RETURN
;
159 void fail (void) NO_RETURN
;
162 struct option longopts
[] =
164 { "no-wait", no_argument
, NULL
, 'n' },
165 { "eval", no_argument
, NULL
, 'e' },
166 { "help", no_argument
, NULL
, 'H' },
167 { "version", no_argument
, NULL
, 'V' },
168 { "tty", no_argument
, NULL
, 't' },
169 { "nw", no_argument
, NULL
, 't' },
170 { "create-frame", no_argument
, NULL
, 'c' },
171 { "alternate-editor", required_argument
, NULL
, 'a' },
172 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
173 { "socket-name", required_argument
, NULL
, 's' },
175 { "server-file", required_argument
, NULL
, 'f' },
177 { "display", required_argument
, NULL
, 'd' },
179 { "parent-id", required_argument
, NULL
, 'p' },
184 /* Like malloc but get fatal error if memory is exhausted. */
187 xmalloc (unsigned int size
)
189 long *result
= (long *) malloc (size
);
198 /* Like strdup but get a fatal error if memory is exhausted. */
201 xstrdup (const char *s
)
203 char *result
= strdup (s
);
213 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
216 #ifndef DIRECTORY_SEP
217 #define DIRECTORY_SEP '/'
219 #ifndef IS_DIRECTORY_SEP
220 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
222 #ifndef IS_DEVICE_SEP
224 #define IS_DEVICE_SEP(_c_) 0
226 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
230 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
234 /* Return the current working directory. Returns NULL on errors.
235 Any other returned value must be freed with free. This is used
236 only when get_current_dir_name is not defined on the system. */
238 get_current_dir_name (void)
242 struct stat dotstat
, pwdstat
;
243 /* If PWD is accurate, use it instead of calling getwd. PWD is
244 sometimes a nicer name, and using it may avoid a fatal error if a
245 parent directory is searchable but not readable. */
246 if ((pwd
= egetenv ("PWD")) != 0
247 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
248 && stat (pwd
, &pwdstat
) == 0
249 && stat (".", &dotstat
) == 0
250 && dotstat
.st_ino
== pwdstat
.st_ino
251 && dotstat
.st_dev
== pwdstat
.st_dev
253 && strlen (pwd
) < MAXPATHLEN
257 buf
= (char *) xmalloc (strlen (pwd
) + 1);
265 size_t buf_size
= 1024;
266 buf
= (char *) xmalloc (buf_size
);
271 if (getcwd (buf
, buf_size
) == buf
)
275 int tmp_errno
= errno
;
281 buf
= (char *) realloc (buf
, buf_size
);
289 /* We need MAXPATHLEN here. */
290 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
293 if (getwd (buf
) == NULL
)
295 int tmp_errno
= errno
;
308 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
310 /* Retrieve an environment variable from the Emacs subkeys of the registry.
311 Return NULL if the variable was not found, or it was empty.
312 This code is based on w32_get_resource (w32.c). */
314 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
316 HKEY hrootkey
= NULL
;
320 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
322 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
324 result
= (char *) xmalloc (cbData
);
326 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
334 RegCloseKey (hrootkey
);
341 getenv wrapper for Windows
343 This is needed to duplicate Emacs's behavior, which is to look for environment
344 variables in the registry if they don't appear in the environment.
347 w32_getenv (char *envvar
)
352 if (value
= getenv (envvar
))
353 /* Found in the environment. */
356 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
357 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
359 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
360 if (strcmp (envvar
, "TERM") == 0)
361 return xstrdup ("w32console");
362 /* Found neither in the environment nor in the registry. */
366 if (dwType
== REG_SZ
)
367 /* Registry; no need to expand. */
370 if (dwType
== REG_EXPAND_SZ
)
374 if (size
= ExpandEnvironmentStrings (value
, NULL
, 0))
376 char *buffer
= (char *) xmalloc (size
);
377 if (ExpandEnvironmentStrings (value
, buffer
, size
))
379 /* Found and expanded. */
384 /* Error expanding. */
389 /* Not the right type, or not correctly expanded. */
395 w32_set_user_model_id (void)
398 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
400 /* On Windows 7 and later, we need to set the user model ID
401 to associate emacsclient launched files with Emacs frames
403 shell
= LoadLibrary ("shell32.dll");
407 = (void *) GetProcAddress (shell
,
408 "SetCurrentProcessExplicitAppUserModelID");
409 /* If the function is defined, then we are running on Windows 7
410 or newer, and the UI uses this to group related windows
411 together. Since emacs, runemacs, emacsclient are related, we
412 want them grouped even though the executables are different,
413 so we need to set a consistent ID between them. */
415 set_user_model (L
"GNU.Emacs");
422 w32_window_app (void)
424 static int window_app
= -1;
425 char szTitle
[MAX_PATH
];
429 /* Checking for STDOUT does not work; it's a valid handle also in
430 nonconsole apps. Testing for the console title seems to work. */
431 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
433 InitCommonControls ();
440 execvp wrapper for Windows. Quotes arguments with embedded spaces.
442 This is necessary due to the broken implementation of exec* routines in
443 the Microsoft libraries: they concatenate the arguments together without
444 quoting special characters, and pass the result to CreateProcess, with
445 predictably bad results. By contrast, POSIX execvp passes the arguments
446 directly into the argv array of the child process.
449 w32_execvp (const char *path
, char **argv
)
453 /* Required to allow a .BAT script as alternate editor. */
454 argv
[0] = (char *) alternate_editor
;
456 for (i
= 0; argv
[i
]; i
++)
457 if (strchr (argv
[i
], ' '))
459 char *quoted
= alloca (strlen (argv
[i
]) + 3);
460 sprintf (quoted
, "\"%s\"", argv
[i
]);
464 return execvp (path
, argv
);
468 #define execvp w32_execvp
470 /* Emulation of ttyname for Windows. */
477 #endif /* WINDOWSNT */
479 /* Display a normal or error message.
480 On Windows, use a message box if compiled as a Windows app. */
482 message (int is_error
, char *message
, ...)
487 va_start (args
, message
);
488 vsprintf (msg
, message
, args
);
492 if (w32_window_app ())
495 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
497 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
502 FILE *f
= is_error
? stderr
: stdout
;
509 /* Decode the options from argv and argc.
510 The global variable `optind' will say how many arguments we used up. */
513 decode_options (int argc
, char **argv
)
515 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
519 int opt
= getopt_long_only (argc
, argv
,
520 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
533 /* If getopt returns 0, then it has already processed a
534 long-named option. We should do nothing. */
538 alternate_editor
= optarg
;
541 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
543 socket_name
= optarg
;
548 server_file
= optarg
;
551 /* We used to disallow this argument in w32, but it seems better
552 to allow it, for the occasional case where the user is
553 connecting with a w32 client to a server compiled with X11
568 message (FALSE
, "emacsclient %s\n", VERSION
);
587 print_help_and_exit ();
591 message (TRUE
, "Try `%s --help' for more information\n", progname
);
597 /* If the -c option is used (without -t) and no --display argument
598 is provided, try $DISPLAY.
599 Without the -c option, we used to set `display' to $DISPLAY by
600 default, but this changed the default behavior and is sometimes
601 inconvenient. So we force users to use "--display $DISPLAY" if
602 they want Emacs to connect to their current display. */
603 if (!current_frame
&& !tty
&& !display
)
605 display
= egetenv ("DISPLAY");
607 /* Under Cocoa, we don't really use displays the same way as in X,
608 so provide a dummy. */
609 if (!display
|| strlen (display
) == 0)
614 /* A null-string display is invalid. */
615 if (display
&& strlen (display
) == 0)
618 /* If no display is available, new frames are tty frames. */
619 if (!current_frame
&& !display
)
622 /* --no-wait implies --current-frame on ttys when there are file
623 arguments or expressions given. */
624 if (nowait
&& tty
&& argc
- optind
> 0)
628 if (alternate_editor
&& alternate_editor
[0] == '\0')
630 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
634 #endif /* WINDOWSNT */
639 print_help_and_exit (void)
641 /* Spaces and tabs are significant in this message; they're chosen so the
642 message aligns properly both in a tty and in a Windows message box.
643 Please try to preserve them; otherwise the output is very hard to read
644 when using emacsclientw. */
646 "Usage: %s [OPTIONS] FILE...\n\
647 Tell the Emacs server to visit the specified files.\n\
648 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
650 The following OPTIONS are accepted:\n\
651 -V, --version Just print version info and return\n\
652 -H, --help Print this usage information message\n\
653 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
654 -c, --create-frame Create a new frame instead of trying to\n\
655 use the current Emacs frame\n\
656 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
657 -n, --no-wait Don't wait for the server to return\n\
658 -d DISPLAY, --display=DISPLAY\n\
659 Visit the file in the given display\n\
660 --parent-id=ID Open in parent window ID, via XEmbed\n"
661 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
662 "-s SOCKET, --socket-name=SOCKET\n\
663 Set filename of the UNIX socket for communication\n"
665 "-f SERVER, --server-file=SERVER\n\
666 Set filename of the TCP authentication file\n\
667 -a EDITOR, --alternate-editor=EDITOR\n\
668 Editor to fallback to if the server is not running\n"
670 " If EDITOR is the empty string, start Emacs in daemon\n\
671 mode and try connecting again\n"
672 #endif /* not WINDOWSNT */
674 Report bugs with M-x report-emacs-bug.\n", progname
);
679 Try to run a different command, or --if no alternate editor is
680 defined-- exit with an errorcode.
681 Uses argv, but gets it from the global variable main_argv.
686 if (alternate_editor
)
690 execvp (alternate_editor
, main_argv
+ i
);
691 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
692 progname
, alternate_editor
);
698 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
701 main (int argc
, char **argv
)
705 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
706 "on systems with Berkeley sockets.\n",
711 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
713 #define AUTH_KEY_LENGTH 64
714 #define SEND_BUFFER_SIZE 4096
716 extern char *strerror (int);
718 /* Buffer to accumulate data to send in TCP connections. */
719 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
720 int sblen
= 0; /* Fill pointer for the send buffer. */
721 /* Socket used to communicate with the Emacs server process. */
722 HSOCKET emacs_socket
= 0;
724 /* On Windows, the socket library was historically separate from the standard
725 C library, so errors are handled differently. */
727 sock_err_message (char *function_name
)
732 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
733 | FORMAT_MESSAGE_ALLOCATE_BUFFER
734 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
735 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
737 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
741 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
746 /* Let's send the data to Emacs when either
747 - the data ends in "\n", or
748 - the buffer is full (but this shouldn't happen)
749 Otherwise, we just accumulate it. */
751 send_to_emacs (HSOCKET s
, char *data
)
755 int dlen
= strlen (data
);
756 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
758 int part
= SEND_BUFFER_SIZE
- sblen
;
759 strncpy (&send_buffer
[sblen
], data
, part
);
761 sblen
= SEND_BUFFER_SIZE
;
765 strcpy (&send_buffer
[sblen
], data
);
772 if (sblen
== SEND_BUFFER_SIZE
773 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
775 int sent
= send (s
, send_buffer
, sblen
, 0);
777 strcpy (send_buffer
, &send_buffer
[sent
]);
784 /* In STR, insert a & before each &, each space, each newline, and
785 any initial -. Change spaces to underscores, too, so that the
786 return value never contains a space.
788 Does not change the string. Outputs the result to S. */
790 quote_argument (HSOCKET s
, char *str
)
792 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
813 if (*p
== '&' || (*p
== '-' && p
== str
))
820 send_to_emacs (s
, copy
);
826 /* The inverse of quote_argument. Removes quoting in string STR by
827 modifying the string in place. Returns STR. */
830 unquote_argument (char *str
)
861 file_name_absolute_p (const unsigned char *filename
)
863 /* Sanity check, it shouldn't happen. */
864 if (! filename
) return FALSE
;
866 /* /xxx is always an absolute path. */
867 if (filename
[0] == '/') return TRUE
;
869 /* Empty filenames (which shouldn't happen) are relative. */
870 if (filename
[0] == '\0') return FALSE
;
873 /* X:\xxx is always absolute. */
874 if (isalpha (filename
[0])
875 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
878 /* Both \xxx and \\xxx\yyy are absolute. */
879 if (filename
[0] == '\\') return TRUE
;
886 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
893 /* Initialize the WinSock2 library. */
895 initialize_sockets (void)
899 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
901 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
905 atexit (close_winsock
);
907 #endif /* WINDOWSNT */
911 * Read the information needed to set up a TCP comm channel with
912 * the Emacs server: host, port, pid and authentication string.
915 get_server_config (struct sockaddr_in
*server
, char *authentication
)
922 if (file_name_absolute_p (server_file
))
923 config
= fopen (server_file
, "rb");
926 char *home
= egetenv ("HOME");
930 char *path
= alloca (strlen (home
) + strlen (server_file
)
932 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
933 config
= fopen (path
, "rb");
936 if (!config
&& (home
= egetenv ("APPDATA")))
938 char *path
= alloca (strlen (home
) + strlen (server_file
)
940 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
941 config
= fopen (path
, "rb");
949 if (fgets (dotted
, sizeof dotted
, config
)
950 && (port
= strchr (dotted
, ':'))
951 && (pid
= strchr (port
, ' ')))
958 message (TRUE
, "%s: invalid configuration info\n", progname
);
962 server
->sin_family
= AF_INET
;
963 server
->sin_addr
.s_addr
= inet_addr (dotted
);
964 server
->sin_port
= htons (atoi (port
));
966 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
968 message (TRUE
, "%s: cannot read authentication info\n", progname
);
974 emacs_pid
= atoi (pid
);
980 set_tcp_socket (void)
983 struct sockaddr_in server
;
984 struct linger l_arg
= {1, 1};
985 char auth_string
[AUTH_KEY_LENGTH
+ 1];
987 if (! get_server_config (&server
, auth_string
))
988 return INVALID_SOCKET
;
990 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
991 message (FALSE
, "%s: connected to remote socket at %s\n",
992 progname
, inet_ntoa (server
.sin_addr
));
995 * Open up an AF_INET socket
997 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
999 sock_err_message ("socket");
1000 return INVALID_SOCKET
;
1006 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1008 sock_err_message ("connect");
1009 return INVALID_SOCKET
;
1012 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1015 * Send the authentication
1017 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1019 send_to_emacs (s
, "-auth ");
1020 send_to_emacs (s
, auth_string
);
1021 send_to_emacs (s
, " ");
1027 /* Returns 1 if PREFIX is a prefix of STRING. */
1029 strprefix (char *prefix
, char *string
)
1031 return !strncmp (prefix
, string
, strlen (prefix
));
1034 /* Get tty name and type. If successful, return the type in TTY_TYPE
1035 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1036 is zero, or return 0 if NOABORT is non-zero. */
1039 find_tty (char **tty_type
, char **tty_name
, int noabort
)
1041 char *type
= egetenv ("TERM");
1042 char *name
= ttyname (fileno (stdout
));
1050 message (TRUE
, "%s: could not get terminal name\n", progname
);
1061 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1067 if (strcmp (type
, "eterm") == 0)
1073 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1074 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1075 " is not supported\n", progname
);
1086 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1088 /* Three possibilities:
1089 2 - can't be `stat'ed (sets errno)
1090 1 - isn't owned by us
1091 0 - success: none of the above */
1094 socket_status (char *socket_name
)
1096 struct stat statbfr
;
1098 if (stat (socket_name
, &statbfr
) == -1)
1101 if (statbfr
.st_uid
!= geteuid ())
1108 /* A signal handler that passes the signal to the Emacs process.
1109 Useful for SIGWINCH. */
1112 pass_signal_to_emacs (int signalnum
)
1114 int old_errno
= errno
;
1117 kill (emacs_pid
, signalnum
);
1119 signal (signalnum
, pass_signal_to_emacs
);
1123 /* Signal handler for SIGCONT; notify the Emacs process that it can
1124 now resume our tty frame. */
1127 handle_sigcont (int signalnum
)
1129 int old_errno
= errno
;
1131 if (tcgetpgrp (1) == getpgrp ())
1133 /* We are in the foreground. */
1134 send_to_emacs (emacs_socket
, "-resume \n");
1138 /* We are in the background; cancel the continue. */
1139 kill (getpid (), SIGSTOP
);
1142 signal (signalnum
, handle_sigcont
);
1146 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1147 going to sleep. Normally the suspend is initiated by Emacs via
1148 server-handle-suspend-tty, but if the server gets out of sync with
1149 reality, we may get a SIGTSTP on C-z. Handling this signal and
1150 notifying Emacs about it should get things under control again. */
1153 handle_sigtstp (int signalnum
)
1155 int old_errno
= errno
;
1159 send_to_emacs (emacs_socket
, "-suspend \n");
1161 /* Unblock this signal and call the default handler by temporarily
1162 changing the handler and resignalling. */
1163 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1164 sigdelset (&set
, signalnum
);
1165 signal (signalnum
, SIG_DFL
);
1166 kill (getpid (), signalnum
);
1167 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1168 signal (signalnum
, handle_sigtstp
);
1174 /* Set up signal handlers before opening a frame on the current tty. */
1179 /* Set up signal handlers. */
1180 signal (SIGWINCH
, pass_signal_to_emacs
);
1182 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1183 deciding which terminal the signal came from. C-g is now a
1184 normal input event on secondary terminals. */
1186 signal (SIGINT
, pass_signal_to_emacs
);
1187 signal (SIGQUIT
, pass_signal_to_emacs
);
1190 signal (SIGCONT
, handle_sigcont
);
1191 signal (SIGTSTP
, handle_sigtstp
);
1192 signal (SIGTTOU
, handle_sigtstp
);
1197 set_local_socket (void)
1200 struct sockaddr_un server
;
1203 * Open up an AF_UNIX socket in this person's home directory
1206 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1208 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1209 return INVALID_SOCKET
;
1212 server
.sun_family
= AF_UNIX
;
1215 int sock_status
= 0;
1216 int default_sock
= !socket_name
;
1217 int saved_errno
= 0;
1218 char *server_name
= "server";
1221 if (socket_name
&& !strchr (socket_name
, '/')
1222 && !strchr (socket_name
, '\\'))
1224 /* socket_name is a file name component. */
1225 server_name
= socket_name
;
1227 default_sock
= 1; /* Try both UIDs. */
1232 tmpdir
= egetenv ("TMPDIR");
1235 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1237 sprintf (socket_name
, "%s/emacs%d/%s",
1238 tmpdir
, (int) geteuid (), server_name
);
1241 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1242 strcpy (server
.sun_path
, socket_name
);
1245 message (TRUE
, "%s: socket-name %s too long\n",
1246 progname
, socket_name
);
1250 /* See if the socket exists, and if it's owned by us. */
1251 sock_status
= socket_status (server
.sun_path
);
1252 saved_errno
= errno
;
1253 if (sock_status
&& default_sock
)
1255 /* Failing that, see if LOGNAME or USER exist and differ from
1256 our euid. If so, look for a socket based on the UID
1257 associated with the name. This is reminiscent of the logic
1258 that init_editfns uses to set the global Vuser_full_name. */
1260 char *user_name
= (char *) egetenv ("LOGNAME");
1263 user_name
= (char *) egetenv ("USER");
1267 struct passwd
*pw
= getpwnam (user_name
);
1269 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1271 /* We're running under su, apparently. */
1272 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1274 sprintf (socket_name
, "%s/emacs%d/%s",
1275 tmpdir
, (int) pw
->pw_uid
, server_name
);
1277 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1278 strcpy (server
.sun_path
, socket_name
);
1281 message (TRUE
, "%s: socket-name %s too long\n",
1282 progname
, socket_name
);
1283 exit (EXIT_FAILURE
);
1286 sock_status
= socket_status (server
.sun_path
);
1287 saved_errno
= errno
;
1290 errno
= saved_errno
;
1294 switch (sock_status
)
1297 /* There's a socket, but it isn't owned by us. This is OK if
1299 if (0 != geteuid ())
1301 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1302 return INVALID_SOCKET
;
1308 if (saved_errno
== ENOENT
)
1310 "%s: can't find socket; have you started the server?\n\
1311 To start the server in Emacs, type \"M-x server-start\".\n",
1314 message (TRUE
, "%s: can't stat %s: %s\n",
1315 progname
, server
.sun_path
, strerror (saved_errno
));
1316 return INVALID_SOCKET
;
1320 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1323 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1324 return INVALID_SOCKET
;
1329 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1332 set_socket (int no_exit_if_error
)
1338 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1339 /* Explicit --socket-name argument. */
1342 s
= set_local_socket ();
1343 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1345 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1346 progname
, socket_name
);
1347 exit (EXIT_FAILURE
);
1351 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1353 server_file
= egetenv ("EMACS_SERVER_FILE");
1357 s
= set_tcp_socket ();
1358 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1361 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1362 progname
, server_file
);
1363 exit (EXIT_FAILURE
);
1366 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1367 /* Implicit local socket. */
1368 s
= set_local_socket ();
1369 if (s
!= INVALID_SOCKET
)
1373 /* Implicit server file. */
1374 server_file
= "server";
1375 s
= set_tcp_socket ();
1376 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1379 /* No implicit or explicit socket, and no alternate editor. */
1380 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1381 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1384 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1385 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1387 exit (EXIT_FAILURE
);
1391 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1392 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1395 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1400 /* Reject any window not of class "Emacs". */
1401 if (! get_wc (hWnd
, class, sizeof (class))
1402 || strcmp (class, "Emacs"))
1405 /* We only need the process id, not the thread id. */
1406 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1408 /* Not the one we're looking for. */
1409 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1411 /* OK, let's raise it. */
1414 /* Stop enumeration. */
1419 * Search for a window of class "Emacs" and owned by a process with
1420 * process id = emacs_pid. If found, allow it to grab the focus.
1423 w32_give_focus (void)
1427 /* It shouldn't happen when dealing with TCP sockets. */
1428 if (!emacs_pid
) return;
1430 user32
= GetModuleHandle ("user32.dll");
1435 /* Modern Windows restrict which processes can set the foreground window.
1436 emacsclient can allow Emacs to grab the focus by calling the function
1437 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1438 NT) lack this function, so we have to check its availability. */
1439 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1440 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1441 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1445 /* Start the emacs daemon and try to connect to it. */
1448 start_daemon_and_retry_set_socket (void)
1459 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1461 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1463 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1464 exit (EXIT_FAILURE
);
1467 /* Try connecting, the daemon should have started by now. */
1468 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1469 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1471 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1472 exit (EXIT_FAILURE
);
1477 fprintf (stderr
, "Error: Cannot fork!\n");
1482 char *d_argv
[] = {"emacs", "--daemon", 0 };
1483 if (socket_name
!= NULL
)
1485 /* Pass --daemon=socket_name as argument. */
1486 char *deq
= "--daemon=";
1487 char *daemon_arg
= alloca (strlen (deq
)
1488 + strlen (socket_name
) + 1);
1489 strcpy (daemon_arg
, deq
);
1490 strcat (daemon_arg
, socket_name
);
1491 d_argv
[1] = daemon_arg
;
1493 execvp ("emacs", d_argv
);
1494 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1496 #endif /* WINDOWSNT */
1500 main (int argc
, char **argv
)
1502 int i
, rl
, needlf
= 0;
1504 char string
[BUFSIZ
+1];
1505 int null_socket_name
, null_server_file
, start_daemon_if_needed
;
1511 /* On Windows 7 and later, we need to explicitly associate emacsclient
1512 with emacs so the UI behaves sensibly. */
1513 w32_set_user_model_id ();
1516 /* Process options. */
1517 decode_options (argc
, argv
);
1519 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1521 message (TRUE
, "%s: file name or argument required\n"
1522 "Try `%s --help' for more information\n",
1523 progname
, progname
);
1524 exit (EXIT_FAILURE
);
1527 /* If alternate_editor is the empty string, start the emacs daemon
1528 in case of failure to connect. */
1529 start_daemon_if_needed
= (alternate_editor
1530 && (alternate_editor
[0] == '\0'));
1531 if (start_daemon_if_needed
)
1533 /* set_socket changes the values for socket_name and
1534 server_file, we need to reset them, if they were NULL before
1535 for the second call to set_socket. */
1536 null_socket_name
= (socket_name
== NULL
);
1537 null_server_file
= (server_file
== NULL
);
1540 if ((emacs_socket
= set_socket (alternate_editor
1541 || start_daemon_if_needed
)) == INVALID_SOCKET
)
1542 if (start_daemon_if_needed
)
1544 /* Reset socket_name and server_file if they were NULL
1545 before the set_socket call. */
1546 if (null_socket_name
)
1548 if (null_server_file
)
1551 start_daemon_and_retry_set_socket ();
1556 cwd
= get_current_dir_name ();
1559 /* getwd puts message in STRING if it fails. */
1560 message (TRUE
, "%s: %s\n", progname
,
1561 "Cannot get current working directory");
1569 /* Send over our environment and current directory. */
1572 extern char **environ
;
1574 for (i
= 0; environ
[i
]; i
++)
1576 char *name
= xstrdup (environ
[i
]);
1577 char *value
= strchr (name
, '=');
1578 send_to_emacs (emacs_socket
, "-env ");
1579 quote_argument (emacs_socket
, environ
[i
]);
1580 send_to_emacs (emacs_socket
, " ");
1583 send_to_emacs (emacs_socket
, "-dir ");
1584 quote_argument (emacs_socket
, cwd
);
1585 send_to_emacs (emacs_socket
, "/");
1586 send_to_emacs (emacs_socket
, " ");
1590 send_to_emacs (emacs_socket
, "-nowait ");
1593 send_to_emacs (emacs_socket
, "-current-frame ");
1597 send_to_emacs (emacs_socket
, "-display ");
1598 quote_argument (emacs_socket
, display
);
1599 send_to_emacs (emacs_socket
, " ");
1604 send_to_emacs (emacs_socket
, "-parent-id ");
1605 quote_argument (emacs_socket
, parent_id
);
1606 send_to_emacs (emacs_socket
, " ");
1609 /* If using the current frame, send tty information to Emacs anyway.
1610 In daemon mode, Emacs may need to occupy this tty if no other
1611 frame is available. */
1612 if (tty
|| (current_frame
&& !eval
))
1614 char *tty_type
, *tty_name
;
1616 if (find_tty (&tty_type
, &tty_name
, !tty
))
1618 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1621 send_to_emacs (emacs_socket
, "-tty ");
1622 quote_argument (emacs_socket
, tty_name
);
1623 send_to_emacs (emacs_socket
, " ");
1624 quote_argument (emacs_socket
, tty_type
);
1625 send_to_emacs (emacs_socket
, " ");
1629 if (!current_frame
&& !tty
)
1630 send_to_emacs (emacs_socket
, "-window-system ");
1632 if ((argc
- optind
> 0))
1634 for (i
= optind
; i
< argc
; i
++)
1639 /* Don't prepend cwd or anything like that. */
1640 send_to_emacs (emacs_socket
, "-eval ");
1641 quote_argument (emacs_socket
, argv
[i
]);
1642 send_to_emacs (emacs_socket
, " ");
1646 if (*argv
[i
] == '+')
1648 char *p
= argv
[i
] + 1;
1649 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1652 send_to_emacs (emacs_socket
, "-position ");
1653 quote_argument (emacs_socket
, argv
[i
]);
1654 send_to_emacs (emacs_socket
, " ");
1659 else if (! file_name_absolute_p (argv
[i
])
1660 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1661 /* Windows can have a different default directory for each
1662 drive, so the cwd passed via "-dir" is not sufficient
1663 to account for that.
1664 If the user uses <drive>:<relpath>, we hence need to be
1665 careful to expand <relpath> with the default directory
1666 corresponding to <drive>. */
1668 char *filename
= (char *) xmalloc (MAX_PATH
);
1671 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1672 if (size
> 0 && size
< MAX_PATH
)
1679 send_to_emacs (emacs_socket
, "-file ");
1680 quote_argument (emacs_socket
, argv
[i
]);
1681 send_to_emacs (emacs_socket
, " ");
1686 /* Read expressions interactively. */
1687 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1689 send_to_emacs (emacs_socket
, "-eval ");
1690 quote_argument (emacs_socket
, str
);
1692 send_to_emacs (emacs_socket
, " ");
1695 send_to_emacs (emacs_socket
, "\n");
1697 /* Wait for an answer. */
1698 if (!eval
&& !tty
&& !nowait
)
1700 printf ("Waiting for Emacs...");
1706 /* Now, wait for an answer and print any messages. */
1707 while ((rl
= recv (emacs_socket
, string
, BUFSIZ
, 0)) > 0)
1712 p
= string
+ strlen (string
) - 1;
1713 while (p
> string
&& *p
== '\n')
1716 if (strprefix ("-emacs-pid ", string
))
1718 /* -emacs-pid PID: The process id of the Emacs process. */
1719 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1721 else if (strprefix ("-window-system-unsupported ", string
))
1723 /* -window-system-unsupported: Emacs was compiled without X
1724 support. Try again on the terminal. */
1729 else if (strprefix ("-print ", string
))
1731 /* -print STRING: Print STRING on the terminal. */
1732 str
= unquote_argument (string
+ strlen ("-print "));
1736 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1738 else if (strprefix ("-error ", string
))
1740 /* -error DESCRIPTION: Signal an error on the terminal. */
1741 str
= unquote_argument (string
+ strlen ("-error "));
1744 fprintf (stderr
, "*ERROR*: %s", str
);
1745 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1748 else if (strprefix ("-suspend ", string
))
1750 /* -suspend: Suspend this terminal, i.e., stop the process. */
1759 /* Unknown command. */
1762 printf ("*ERROR*: Unknown message: %s", string
);
1763 needlf
= string
[0] == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1772 CLOSE_SOCKET (emacs_socket
);
1773 return EXIT_SUCCESS
;
1776 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1779 #ifndef HAVE_STRERROR
1784 extern char *sys_errlist
[];
1785 extern int sys_nerr
;
1787 if (errnum
>= 0 && errnum
< sys_nerr
)
1788 return sys_errlist
[errnum
];
1789 return (char *) "Unknown error";
1792 #endif /* ! HAVE_STRERROR */
1794 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1795 (do not change this comment) */
1797 /* emacsclient.c ends here */