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/>. */
27 /* config.h defines these, which disables sockets altogether! */
34 # include <commctrl.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>
50 # include <arpa/inet.h>
52 # define INVALID_SOCKET -1
54 # define CLOSE_SOCKET close
61 #endif /* !WINDOWSNT */
75 #else /* not WINDOWSNT */
77 #endif /* not WINDOWSNT */
84 char *getenv (const char *), *getwd (char *);
89 #define egetenv(VAR) w32_getenv(VAR)
91 #define egetenv(VAR) getenv(VAR)
95 #define VERSION "unspecified"
100 #define EXIT_SUCCESS 0
104 #define EXIT_FAILURE 1
119 /* Additional space when allocating buffers for filenames, etc. */
120 #define EXTRA_SPACE 100
123 /* Name used to invoke this program. */
126 /* The second argument to main. */
129 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
132 /* Nonzero means args are expressions to be evaluated. --eval. */
135 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
136 int current_frame
= 1;
138 /* The display on which Emacs should work. --display. */
139 char *display
= NULL
;
141 /* The parent window ID, if we are opening a frame via XEmbed. */
142 char *parent_id
= NULL
;
144 /* Nonzero means open a new Emacs frame on the current terminal. */
147 /* If non-NULL, the name of an editor to fallback to if the server
148 is not running. --alternate-editor. */
149 const char *alternate_editor
= NULL
;
151 /* If non-NULL, the filename of the UNIX socket. */
152 char *socket_name
= NULL
;
154 /* If non-NULL, the filename of the authentication file. */
155 char *server_file
= NULL
;
157 /* PID of the Emacs server process. */
160 void print_help_and_exit (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 ()
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 (predefined
, key
, type
)
319 HKEY hrootkey
= NULL
;
323 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
325 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
327 result
= (char *) xmalloc (cbData
);
329 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
337 RegCloseKey (hrootkey
);
344 getenv wrapper for Windows
346 This is needed to duplicate Emacs's behavior, which is to look for environment
347 variables in the registry if they don't appear in the environment.
356 if (value
= getenv (envvar
))
357 /* Found in the environment. */
360 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
361 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
363 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
364 if (strcmp (envvar
, "TERM") == 0)
365 return xstrdup ("w32console");
366 /* Found neither in the environment nor in the registry. */
370 if (dwType
== REG_SZ
)
371 /* Registry; no need to expand. */
374 if (dwType
== REG_EXPAND_SZ
)
378 if (size
= ExpandEnvironmentStrings (value
, NULL
, 0))
380 char *buffer
= (char *) xmalloc (size
);
381 if (ExpandEnvironmentStrings (value
, buffer
, size
))
383 /* Found and expanded. */
388 /* Error expanding. */
393 /* Not the right type, or not correctly expanded. */
399 w32_set_user_model_id ()
402 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
404 /* On Windows 7 and later, we need to set the user model ID
405 to associate emacsclient launched files with Emacs frames
407 shell
= LoadLibrary("shell32.dll");
411 = (void *) GetProcAddress (shell
,
412 "SetCurrentProcessExplicitAppUserModelID");
413 /* If the function is defined, then we are running on Windows 7
414 or newer, and the UI uses this to group related windows
415 together. Since emacs, runemacs, emacsclient are related, we
416 want them grouped even though the executables are different,
417 so we need to set a consistent ID between them. */
419 set_user_model (L
"GNU.Emacs");
428 static int window_app
= -1;
429 char szTitle
[MAX_PATH
];
433 /* Checking for STDOUT does not work; it's a valid handle also in
434 nonconsole apps. Testing for the console title seems to work. */
435 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
437 InitCommonControls();
444 execvp wrapper for Windows. Quotes arguments with embedded spaces.
446 This is necessary due to the broken implementation of exec* routines in
447 the Microsoft libraries: they concatenate the arguments together without
448 quoting special characters, and pass the result to CreateProcess, with
449 predictably bad results. By contrast, Posix execvp passes the arguments
450 directly into the argv array of the child process.
453 w32_execvp (path
, argv
)
459 /* Required to allow a .BAT script as alternate editor. */
460 argv
[0] = (char *) alternate_editor
;
462 for (i
= 0; argv
[i
]; i
++)
463 if (strchr (argv
[i
], ' '))
465 char *quoted
= alloca (strlen (argv
[i
]) + 3);
466 sprintf (quoted
, "\"%s\"", argv
[i
]);
470 return execvp (path
, argv
);
474 #define execvp w32_execvp
476 /* Emulation of ttyname for Windows. */
483 #endif /* WINDOWSNT */
485 /* Display a normal or error message.
486 On Windows, use a message box if compiled as a Windows app. */
488 message (int is_error
, char *message
, ...)
493 va_start (args
, message
);
494 vsprintf (msg
, message
, args
);
498 if (w32_window_app ())
501 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
503 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
508 FILE *f
= is_error
? stderr
: stdout
;
515 /* Decode the options from argv and argc.
516 The global variable `optind' will say how many arguments we used up. */
519 decode_options (int argc
, char **argv
)
521 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
525 int opt
= getopt_long_only (argc
, argv
,
526 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
539 /* If getopt returns 0, then it has already processed a
540 long-named option. We should do nothing. */
544 alternate_editor
= optarg
;
547 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
549 socket_name
= optarg
;
554 server_file
= optarg
;
557 /* We used to disallow this argument in w32, but it seems better
558 to allow it, for the occasional case where the user is
559 connecting with a w32 client to a server compiled with X11
574 message (FALSE
, "emacsclient %s\n", VERSION
);
593 print_help_and_exit ();
597 message (TRUE
, "Try `%s --help' for more information\n", progname
);
603 /* If the -c option is used (without -t) and no --display argument
604 is provided, try $DISPLAY.
605 Without the -c option, we used to set `display' to $DISPLAY by
606 default, but this changed the default behavior and is sometimes
607 inconvenient. So we force users to use "--display $DISPLAY" if
608 they want Emacs to connect to their current display. */
609 if (!current_frame
&& !tty
&& !display
)
611 display
= egetenv ("DISPLAY");
613 /* Under Cocoa, we don't really use displays the same way as in X,
614 so provide a dummy. */
615 if (!display
|| strlen (display
) == 0)
620 /* A null-string display is invalid. */
621 if (display
&& strlen (display
) == 0)
624 /* If no display is available, new frames are tty frames. */
625 if (!current_frame
&& !display
)
628 /* --no-wait implies --current-frame on ttys when there are file
629 arguments or expressions given. */
630 if (nowait
&& tty
&& argc
- optind
> 0)
634 if (alternate_editor
&& alternate_editor
[0] == '\0')
636 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
640 #endif /* WINDOWSNT */
645 print_help_and_exit (void)
647 /* Spaces and tabs are significant in this message; they're chosen so the
648 message aligns properly both in a tty and in a Windows message box.
649 Please try to preserve them; otherwise the output is very hard to read
650 when using emacsclientw. */
652 "Usage: %s [OPTIONS] FILE...\n\
653 Tell the Emacs server to visit the specified files.\n\
654 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
656 The following OPTIONS are accepted:\n\
657 -V, --version Just print version info and return\n\
658 -H, --help Print this usage information message\n\
659 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
660 -c, --create-frame Create a new frame instead of trying to\n\
661 use the current Emacs frame\n\
662 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
663 -n, --no-wait Don't wait for the server to return\n\
664 -d DISPLAY, --display=DISPLAY\n\
665 Visit the file in the given display\n\
666 --parent-id=ID Open in parent window ID, via XEmbed\n"
667 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
668 "-s SOCKET, --socket-name=SOCKET\n\
669 Set filename of the UNIX socket for communication\n"
671 "-f SERVER, --server-file=SERVER\n\
672 Set filename of the TCP authentication file\n\
673 -a EDITOR, --alternate-editor=EDITOR\n\
674 Editor to fallback to if the server is not running\n"
676 " If EDITOR is the empty string, start Emacs in daemon\n\
677 mode and try connecting again\n"
678 #endif /* not WINDOWSNT */
680 Report bugs with M-x report-emacs-bug.\n", progname
);
685 Try to run a different command, or --if no alternate editor is
686 defined-- exit with an errorcode.
687 Uses argv, but gets it from the global variable main_argv.
692 if (alternate_editor
)
696 execvp (alternate_editor
, main_argv
+ i
);
697 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
698 progname
, alternate_editor
);
704 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
713 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
714 "on systems with Berkeley sockets.\n",
719 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
722 # include <winsock2.h>
724 # include <sys/types.h>
725 # include <sys/socket.h>
729 #define AUTH_KEY_LENGTH 64
730 #define SEND_BUFFER_SIZE 4096
732 extern char *strerror (int);
734 /* Buffer to accumulate data to send in TCP connections. */
735 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
736 int sblen
= 0; /* Fill pointer for the send buffer. */
737 /* Socket used to communicate with the Emacs server process. */
738 HSOCKET emacs_socket
= 0;
740 /* On Windows, the socket library was historically separate from the standard
741 C library, so errors are handled differently. */
743 sock_err_message (char *function_name
)
748 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
749 | FORMAT_MESSAGE_ALLOCATE_BUFFER
750 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
751 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
753 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
757 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
762 /* Let's send the data to Emacs when either
763 - the data ends in "\n", or
764 - the buffer is full (but this shouldn't happen)
765 Otherwise, we just accumulate it. */
767 send_to_emacs (HSOCKET s
, char *data
)
771 int dlen
= strlen (data
);
772 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
774 int part
= SEND_BUFFER_SIZE
- sblen
;
775 strncpy (&send_buffer
[sblen
], data
, part
);
777 sblen
= SEND_BUFFER_SIZE
;
781 strcpy (&send_buffer
[sblen
], data
);
788 if (sblen
== SEND_BUFFER_SIZE
789 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
791 int sent
= send (s
, send_buffer
, sblen
, 0);
793 strcpy (send_buffer
, &send_buffer
[sent
]);
800 /* In STR, insert a & before each &, each space, each newline, and
801 any initial -. Change spaces to underscores, too, so that the
802 return value never contains a space.
804 Does not change the string. Outputs the result to S. */
806 quote_argument (HSOCKET s
, char *str
)
808 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
829 if (*p
== '&' || (*p
== '-' && p
== str
))
836 send_to_emacs (s
, copy
);
842 /* The inverse of quote_argument. Removes quoting in string STR by
843 modifying the string in place. Returns STR. */
846 unquote_argument (char *str
)
877 file_name_absolute_p (const unsigned char *filename
)
879 /* Sanity check, it shouldn't happen. */
880 if (! filename
) return FALSE
;
882 /* /xxx is always an absolute path. */
883 if (filename
[0] == '/') return TRUE
;
885 /* Empty filenames (which shouldn't happen) are relative. */
886 if (filename
[0] == '\0') return FALSE
;
889 /* X:\xxx is always absolute. */
890 if (isalpha (filename
[0])
891 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
894 /* Both \xxx and \\xxx\yyy are absolute. */
895 if (filename
[0] == '\\') return TRUE
;
902 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
904 __cdecl
close_winsock ()
909 /* Initialize the WinSock2 library. */
911 initialize_sockets ()
915 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
917 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
921 atexit (close_winsock
);
923 #endif /* WINDOWSNT */
927 * Read the information needed to set up a TCP comm channel with
928 * the Emacs server: host, port, pid and authentication string.
931 get_server_config (struct sockaddr_in
*server
, char *authentication
)
938 if (file_name_absolute_p (server_file
))
939 config
= fopen (server_file
, "rb");
942 char *home
= egetenv ("HOME");
946 char *path
= alloca (strlen (home
) + strlen (server_file
)
948 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
949 config
= fopen (path
, "rb");
952 if (!config
&& (home
= egetenv ("APPDATA")))
954 char *path
= alloca (strlen (home
) + strlen (server_file
)
956 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
957 config
= fopen (path
, "rb");
965 if (fgets (dotted
, sizeof dotted
, config
)
966 && (port
= strchr (dotted
, ':'))
967 && (pid
= strchr (port
, ' ')))
974 message (TRUE
, "%s: invalid configuration info\n", progname
);
978 server
->sin_family
= AF_INET
;
979 server
->sin_addr
.s_addr
= inet_addr (dotted
);
980 server
->sin_port
= htons (atoi (port
));
982 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
984 message (TRUE
, "%s: cannot read authentication info\n", progname
);
990 emacs_pid
= atoi (pid
);
996 set_tcp_socket (void)
999 struct sockaddr_in server
;
1000 struct linger l_arg
= {1, 1};
1001 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1003 if (! get_server_config (&server
, auth_string
))
1004 return INVALID_SOCKET
;
1006 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
1007 message (FALSE
, "%s: connected to remote socket at %s\n",
1008 progname
, inet_ntoa (server
.sin_addr
));
1011 * Open up an AF_INET socket
1013 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1015 sock_err_message ("socket");
1016 return INVALID_SOCKET
;
1022 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1024 sock_err_message ("connect");
1025 return INVALID_SOCKET
;
1028 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1031 * Send the authentication
1033 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1035 send_to_emacs (s
, "-auth ");
1036 send_to_emacs (s
, auth_string
);
1037 send_to_emacs (s
, " ");
1043 /* Returns 1 if PREFIX is a prefix of STRING. */
1045 strprefix (char *prefix
, char *string
)
1047 return !strncmp (prefix
, string
, strlen (prefix
));
1050 /* Get tty name and type. If successful, return the type in TTY_TYPE
1051 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1052 is zero, or return 0 if NOABORT is non-zero. */
1055 find_tty (char **tty_type
, char **tty_name
, int noabort
)
1057 char *type
= egetenv ("TERM");
1058 char *name
= ttyname (fileno (stdout
));
1066 message (TRUE
, "%s: could not get terminal name\n", progname
);
1077 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1083 if (strcmp (type
, "eterm") == 0)
1089 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1090 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1091 " is not supported\n", progname
);
1102 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1104 /* Three possibilities:
1105 2 - can't be `stat'ed (sets errno)
1106 1 - isn't owned by us
1107 0 - success: none of the above */
1110 socket_status (char *socket_name
)
1112 struct stat statbfr
;
1114 if (stat (socket_name
, &statbfr
) == -1)
1117 if (statbfr
.st_uid
!= geteuid ())
1124 /* A signal handler that passes the signal to the Emacs process.
1125 Useful for SIGWINCH. */
1128 pass_signal_to_emacs (int signalnum
)
1130 int old_errno
= errno
;
1133 kill (emacs_pid
, signalnum
);
1135 signal (signalnum
, pass_signal_to_emacs
);
1139 /* Signal handler for SIGCONT; notify the Emacs process that it can
1140 now resume our tty frame. */
1143 handle_sigcont (int signalnum
)
1145 int old_errno
= errno
;
1147 if (tcgetpgrp (1) == getpgrp ())
1149 /* We are in the foreground. */
1150 send_to_emacs (emacs_socket
, "-resume \n");
1154 /* We are in the background; cancel the continue. */
1155 kill (getpid (), SIGSTOP
);
1158 signal (signalnum
, handle_sigcont
);
1162 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1163 going to sleep. Normally the suspend is initiated by Emacs via
1164 server-handle-suspend-tty, but if the server gets out of sync with
1165 reality, we may get a SIGTSTP on C-z. Handling this signal and
1166 notifying Emacs about it should get things under control again. */
1169 handle_sigtstp (int signalnum
)
1171 int old_errno
= errno
;
1175 send_to_emacs (emacs_socket
, "-suspend \n");
1177 /* Unblock this signal and call the default handler by temporarily
1178 changing the handler and resignalling. */
1179 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1180 sigdelset (&set
, signalnum
);
1181 signal (signalnum
, SIG_DFL
);
1182 kill (getpid (), signalnum
);
1183 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1184 signal (signalnum
, handle_sigtstp
);
1190 /* Set up signal handlers before opening a frame on the current tty. */
1195 /* Set up signal handlers. */
1196 signal (SIGWINCH
, pass_signal_to_emacs
);
1198 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1199 deciding which terminal the signal came from. C-g is now a
1200 normal input event on secondary terminals. */
1202 signal (SIGINT
, pass_signal_to_emacs
);
1203 signal (SIGQUIT
, pass_signal_to_emacs
);
1206 signal (SIGCONT
, handle_sigcont
);
1207 signal (SIGTSTP
, handle_sigtstp
);
1208 signal (SIGTTOU
, handle_sigtstp
);
1213 set_local_socket (void)
1216 struct sockaddr_un server
;
1219 * Open up an AF_UNIX socket in this person's home directory
1222 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1224 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1225 return INVALID_SOCKET
;
1228 server
.sun_family
= AF_UNIX
;
1231 int sock_status
= 0;
1232 int default_sock
= !socket_name
;
1233 int saved_errno
= 0;
1234 char *server_name
= "server";
1237 if (socket_name
&& !strchr (socket_name
, '/')
1238 && !strchr (socket_name
, '\\'))
1240 /* socket_name is a file name component. */
1241 server_name
= socket_name
;
1243 default_sock
= 1; /* Try both UIDs. */
1248 tmpdir
= egetenv ("TMPDIR");
1251 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1253 sprintf (socket_name
, "%s/emacs%d/%s",
1254 tmpdir
, (int) geteuid (), server_name
);
1257 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1258 strcpy (server
.sun_path
, socket_name
);
1261 message (TRUE
, "%s: socket-name %s too long\n",
1262 progname
, socket_name
);
1266 /* See if the socket exists, and if it's owned by us. */
1267 sock_status
= socket_status (server
.sun_path
);
1268 saved_errno
= errno
;
1269 if (sock_status
&& default_sock
)
1271 /* Failing that, see if LOGNAME or USER exist and differ from
1272 our euid. If so, look for a socket based on the UID
1273 associated with the name. This is reminiscent of the logic
1274 that init_editfns uses to set the global Vuser_full_name. */
1276 char *user_name
= (char *) egetenv ("LOGNAME");
1279 user_name
= (char *) egetenv ("USER");
1283 struct passwd
*pw
= getpwnam (user_name
);
1285 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1287 /* We're running under su, apparently. */
1288 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1290 sprintf (socket_name
, "%s/emacs%d/%s",
1291 tmpdir
, (int) pw
->pw_uid
, server_name
);
1293 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1294 strcpy (server
.sun_path
, socket_name
);
1297 message (TRUE
, "%s: socket-name %s too long\n",
1298 progname
, socket_name
);
1299 exit (EXIT_FAILURE
);
1302 sock_status
= socket_status (server
.sun_path
);
1303 saved_errno
= errno
;
1306 errno
= saved_errno
;
1310 switch (sock_status
)
1313 /* There's a socket, but it isn't owned by us. This is OK if
1315 if (0 != geteuid ())
1317 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1318 return INVALID_SOCKET
;
1324 if (saved_errno
== ENOENT
)
1326 "%s: can't find socket; have you started the server?\n\
1327 To start the server in Emacs, type \"M-x server-start\".\n",
1330 message (TRUE
, "%s: can't stat %s: %s\n",
1331 progname
, server
.sun_path
, strerror (saved_errno
));
1332 return INVALID_SOCKET
;
1336 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1339 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1340 return INVALID_SOCKET
;
1345 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1348 set_socket (int no_exit_if_error
)
1354 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1355 /* Explicit --socket-name argument. */
1358 s
= set_local_socket ();
1359 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1361 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1362 progname
, socket_name
);
1363 exit (EXIT_FAILURE
);
1367 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1369 server_file
= egetenv ("EMACS_SERVER_FILE");
1373 s
= set_tcp_socket ();
1374 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1377 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1378 progname
, server_file
);
1379 exit (EXIT_FAILURE
);
1382 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1383 /* Implicit local socket. */
1384 s
= set_local_socket ();
1385 if (s
!= INVALID_SOCKET
)
1389 /* Implicit server file. */
1390 server_file
= "server";
1391 s
= set_tcp_socket ();
1392 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1395 /* No implicit or explicit socket, and no alternate editor. */
1396 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1397 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1400 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1401 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1403 exit (EXIT_FAILURE
);
1407 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1408 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1411 w32_find_emacs_process (hWnd
, lParam
)
1418 /* Reject any window not of class "Emacs". */
1419 if (! get_wc (hWnd
, class, sizeof (class))
1420 || strcmp (class, "Emacs"))
1423 /* We only need the process id, not the thread id. */
1424 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1426 /* Not the one we're looking for. */
1427 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1429 /* OK, let's raise it. */
1432 /* Stop enumeration. */
1437 * Search for a window of class "Emacs" and owned by a process with
1438 * process id = emacs_pid. If found, allow it to grab the focus.
1445 /* It shouldn't happen when dealing with TCP sockets. */
1446 if (!emacs_pid
) return;
1448 user32
= GetModuleHandle ("user32.dll");
1453 /* Modern Windows restrict which processes can set the foreground window.
1454 emacsclient can allow Emacs to grab the focus by calling the function
1455 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1456 NT) lack this function, so we have to check its availability. */
1457 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1458 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1459 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1463 /* Start the emacs daemon and try to connect to it. */
1466 start_daemon_and_retry_set_socket (void)
1477 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1479 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS(status
))
1481 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1482 exit (EXIT_FAILURE
);
1485 /* Try connecting, the daemon should have started by now. */
1486 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1487 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1489 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1490 exit (EXIT_FAILURE
);
1495 fprintf (stderr
, "Error: Cannot fork!\n");
1500 char *d_argv
[] = {"emacs", "--daemon", 0 };
1501 if (socket_name
!= NULL
)
1503 /* Pass --daemon=socket_name as argument. */
1504 char *deq
= "--daemon=";
1505 char *daemon_arg
= alloca (strlen (deq
)
1506 + strlen (socket_name
) + 1);
1507 strcpy (daemon_arg
, deq
);
1508 strcat (daemon_arg
, socket_name
);
1509 d_argv
[1] = daemon_arg
;
1511 execvp ("emacs", d_argv
);
1512 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1514 #endif /* WINDOWSNT */
1518 main (int argc
, char **argv
)
1520 int i
, rl
, needlf
= 0;
1522 char string
[BUFSIZ
+1];
1523 int null_socket_name
, null_server_file
, start_daemon_if_needed
;
1529 /* On Windows 7 and later, we need to explicitly associate emacsclient
1530 with emacs so the UI behaves sensibly. */
1531 w32_set_user_model_id ();
1534 /* Process options. */
1535 decode_options (argc
, argv
);
1537 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1539 message (TRUE
, "%s: file name or argument required\n"
1540 "Try `%s --help' for more information\n",
1541 progname
, progname
);
1542 exit (EXIT_FAILURE
);
1545 /* If alternate_editor is the empty string, start the emacs daemon
1546 in case of failure to connect. */
1547 start_daemon_if_needed
= (alternate_editor
1548 && (alternate_editor
[0] == '\0'));
1549 if (start_daemon_if_needed
)
1551 /* set_socket changes the values for socket_name and
1552 server_file, we need to reset them, if they were NULL before
1553 for the second call to set_socket. */
1554 null_socket_name
= (socket_name
== NULL
);
1555 null_server_file
= (server_file
== NULL
);
1558 if ((emacs_socket
= set_socket (alternate_editor
1559 || start_daemon_if_needed
)) == INVALID_SOCKET
)
1560 if (start_daemon_if_needed
)
1562 /* Reset socket_name and server_file if they were NULL
1563 before the set_socket call. */
1564 if (null_socket_name
)
1566 if (null_server_file
)
1569 start_daemon_and_retry_set_socket ();
1574 cwd
= get_current_dir_name ();
1577 /* getwd puts message in STRING if it fails. */
1578 message (TRUE
, "%s: %s\n", progname
,
1579 "Cannot get current working directory");
1587 /* Send over our environment and current directory. */
1590 extern char **environ
;
1592 for (i
= 0; environ
[i
]; i
++)
1594 char *name
= xstrdup (environ
[i
]);
1595 char *value
= strchr (name
, '=');
1596 send_to_emacs (emacs_socket
, "-env ");
1597 quote_argument (emacs_socket
, environ
[i
]);
1598 send_to_emacs (emacs_socket
, " ");
1601 send_to_emacs (emacs_socket
, "-dir ");
1602 quote_argument (emacs_socket
, cwd
);
1603 send_to_emacs (emacs_socket
, "/");
1604 send_to_emacs (emacs_socket
, " ");
1608 send_to_emacs (emacs_socket
, "-nowait ");
1611 send_to_emacs (emacs_socket
, "-current-frame ");
1615 send_to_emacs (emacs_socket
, "-display ");
1616 quote_argument (emacs_socket
, display
);
1617 send_to_emacs (emacs_socket
, " ");
1622 send_to_emacs (emacs_socket
, "-parent-id ");
1623 quote_argument (emacs_socket
, parent_id
);
1624 send_to_emacs (emacs_socket
, " ");
1627 /* If using the current frame, send tty information to Emacs anyway.
1628 In daemon mode, Emacs may need to occupy this tty if no other
1629 frame is available. */
1630 if (tty
|| (current_frame
&& !eval
))
1632 char *tty_type
, *tty_name
;
1634 if (find_tty (&tty_type
, &tty_name
, !tty
))
1636 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1639 send_to_emacs (emacs_socket
, "-tty ");
1640 quote_argument (emacs_socket
, tty_name
);
1641 send_to_emacs (emacs_socket
, " ");
1642 quote_argument (emacs_socket
, tty_type
);
1643 send_to_emacs (emacs_socket
, " ");
1647 if (!current_frame
&& !tty
)
1648 send_to_emacs (emacs_socket
, "-window-system ");
1650 if ((argc
- optind
> 0))
1652 for (i
= optind
; i
< argc
; i
++)
1657 /* Don't prepend cwd or anything like that. */
1658 send_to_emacs (emacs_socket
, "-eval ");
1659 quote_argument (emacs_socket
, argv
[i
]);
1660 send_to_emacs (emacs_socket
, " ");
1664 if (*argv
[i
] == '+')
1666 char *p
= argv
[i
] + 1;
1667 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1670 send_to_emacs (emacs_socket
, "-position ");
1671 quote_argument (emacs_socket
, argv
[i
]);
1672 send_to_emacs (emacs_socket
, " ");
1677 else if (! file_name_absolute_p (argv
[i
])
1678 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1679 /* Windows can have a different default directory for each
1680 drive, so the cwd passed via "-dir" is not sufficient
1681 to account for that.
1682 If the user uses <drive>:<relpath>, we hence need to be
1683 careful to expand <relpath> with the default directory
1684 corresponding to <drive>. */
1686 char *filename
= (char *) xmalloc (MAX_PATH
);
1689 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1690 if (size
> 0 && size
< MAX_PATH
)
1697 send_to_emacs (emacs_socket
, "-file ");
1698 quote_argument (emacs_socket
, argv
[i
]);
1699 send_to_emacs (emacs_socket
, " ");
1704 /* Read expressions interactively. */
1705 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1707 send_to_emacs (emacs_socket
, "-eval ");
1708 quote_argument (emacs_socket
, str
);
1710 send_to_emacs (emacs_socket
, " ");
1713 send_to_emacs (emacs_socket
, "\n");
1715 /* Wait for an answer. */
1716 if (!eval
&& !tty
&& !nowait
)
1718 printf ("Waiting for Emacs...");
1724 /* Now, wait for an answer and print any messages. */
1725 while ((rl
= recv (emacs_socket
, string
, BUFSIZ
, 0)) > 0)
1730 p
= string
+ strlen (string
) - 1;
1731 while (p
> string
&& *p
== '\n')
1734 if (strprefix ("-emacs-pid ", string
))
1736 /* -emacs-pid PID: The process id of the Emacs process. */
1737 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1739 else if (strprefix ("-window-system-unsupported ", string
))
1741 /* -window-system-unsupported: Emacs was compiled without X
1742 support. Try again on the terminal. */
1747 else if (strprefix ("-print ", string
))
1749 /* -print STRING: Print STRING on the terminal. */
1750 str
= unquote_argument (string
+ strlen ("-print "));
1754 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1756 else if (strprefix ("-error ", string
))
1758 /* -error DESCRIPTION: Signal an error on the terminal. */
1759 str
= unquote_argument (string
+ strlen ("-error "));
1762 fprintf (stderr
, "*ERROR*: %s", str
);
1763 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1766 else if (strprefix ("-suspend ", string
))
1768 /* -suspend: Suspend this terminal, i.e., stop the process. */
1777 /* Unknown command. */
1780 printf ("*ERROR*: Unknown message: %s", string
);
1781 needlf
= string
[0] == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1790 CLOSE_SOCKET (emacs_socket
);
1791 return EXIT_SUCCESS
;
1794 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1797 #ifndef HAVE_STRERROR
1802 extern char *sys_errlist
[];
1803 extern int sys_nerr
;
1805 if (errnum
>= 0 && errnum
< sys_nerr
)
1806 return sys_errlist
[errnum
];
1807 return (char *) "Unknown error";
1810 #endif /* ! HAVE_STRERROR */
1812 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1813 (do not change this comment) */
1815 /* emacsclient.c ends here */