1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986-1987, 1994, 1999-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 /* config.h defines these, which disables sockets altogether! */
31 # include <commctrl.h>
33 # include <winsock2.h>
35 # define NO_SOCKETS_IN_FILE_SYSTEM
37 # define HSOCKET SOCKET
38 # define CLOSE_SOCKET closesocket
39 # define INITIALIZE() (initialize_sockets ())
41 char *w32_getenv (char *);
42 #define egetenv(VAR) w32_getenv(VAR)
44 #else /* !WINDOWSNT */
48 # ifdef HAVE_INET_SOCKETS
49 # include <netinet/in.h>
51 # include <sys/types.h>
52 # include <sys/socket.h>
54 # endif /* HAVE_SOCKETS */
56 # include <arpa/inet.h>
58 # define INVALID_SOCKET -1
60 # define CLOSE_SOCKET close
67 #define egetenv(VAR) getenv(VAR)
69 #endif /* !WINDOWSNT */
86 char *getenv (const char *), *getwd (char *);
88 char *(getcwd
) (char *, size_t);
92 #define VERSION "unspecified"
97 #define EXIT_SUCCESS 0
101 #define EXIT_FAILURE 1
112 /* Additional space when allocating buffers for filenames, etc. */
113 #define EXTRA_SPACE 100
115 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
117 # define IF_LINT(Code) Code
119 # define IF_LINT(Code) /* empty */
123 /* Name used to invoke this program. */
124 const char *progname
;
126 /* The second argument to main. */
129 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
132 /* Nonzero means don't print messages for successful operations. --quiet. */
135 /* Nonzero means args are expressions to be evaluated. --eval. */
138 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
139 int current_frame
= 1;
141 /* The display on which Emacs should work. --display. */
142 const char *display
= NULL
;
144 /* The parent window ID, if we are opening a frame via XEmbed. */
145 char *parent_id
= NULL
;
147 /* Nonzero means open a new Emacs frame on the current terminal. */
150 /* If non-NULL, the name of an editor to fallback to if the server
151 is not running. --alternate-editor. */
152 const char *alternate_editor
= NULL
;
154 /* If non-NULL, the filename of the UNIX socket. */
155 const char *socket_name
= NULL
;
157 /* If non-NULL, the filename of the authentication file. */
158 const char *server_file
= NULL
;
160 /* PID of the Emacs server process. */
163 /* If non-NULL, a string that should form a frame parameter alist to
164 be used for the new frame */
165 const char *frame_parameters
= NULL
;
167 static void print_help_and_exit (void) NO_RETURN
;
168 static void fail (void) NO_RETURN
;
171 struct option longopts
[] =
173 { "no-wait", no_argument
, NULL
, 'n' },
174 { "quiet", no_argument
, NULL
, 'q' },
175 { "eval", no_argument
, NULL
, 'e' },
176 { "help", no_argument
, NULL
, 'H' },
177 { "version", no_argument
, NULL
, 'V' },
178 { "tty", no_argument
, NULL
, 't' },
179 { "nw", no_argument
, NULL
, 't' },
180 { "create-frame", no_argument
, NULL
, 'c' },
181 { "alternate-editor", required_argument
, NULL
, 'a' },
182 { "frame-parameters", required_argument
, NULL
, 'F' },
183 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
184 { "socket-name", required_argument
, NULL
, 's' },
186 { "server-file", required_argument
, NULL
, 'f' },
188 { "display", required_argument
, NULL
, 'd' },
190 { "parent-id", required_argument
, NULL
, 'p' },
195 /* Like malloc but get fatal error if memory is exhausted. */
198 xmalloc (size_t size
)
200 void *result
= malloc (size
);
210 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
213 #ifndef DIRECTORY_SEP
214 #define DIRECTORY_SEP '/'
216 #ifndef IS_DIRECTORY_SEP
217 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
219 #ifndef IS_DEVICE_SEP
221 #define IS_DEVICE_SEP(_c_) 0
223 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
227 char *get_current_dir_name (void);
229 /* Return the current working directory. Returns NULL on errors.
230 Any other returned value must be freed with free. This is used
231 only when get_current_dir_name is not defined on the system. */
233 get_current_dir_name (void)
237 struct stat dotstat
, pwdstat
;
238 /* If PWD is accurate, use it instead of calling getwd. PWD is
239 sometimes a nicer name, and using it may avoid a fatal error if a
240 parent directory is searchable but not readable. */
241 if ((pwd
= egetenv ("PWD")) != 0
242 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
243 && stat (pwd
, &pwdstat
) == 0
244 && stat (".", &dotstat
) == 0
245 && dotstat
.st_ino
== pwdstat
.st_ino
246 && dotstat
.st_dev
== pwdstat
.st_dev
248 && strlen (pwd
) < MAXPATHLEN
252 buf
= (char *) xmalloc (strlen (pwd
) + 1);
258 size_t buf_size
= 1024;
262 buf
= malloc (buf_size
);
265 if (getcwd (buf
, buf_size
) == buf
)
269 if (tmp_errno
!= ERANGE
)
285 /* We need MAXPATHLEN here. */
286 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
287 if (getwd (buf
) == NULL
)
289 int tmp_errno
= errno
;
302 /* Like strdup but get a fatal error if memory is exhausted. */
305 xstrdup (const char *s
)
307 char *result
= strdup (s
);
316 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
318 /* Retrieve an environment variable from the Emacs subkeys of the registry.
319 Return NULL if the variable was not found, or it was empty.
320 This code is based on w32_get_resource (w32.c). */
322 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
324 HKEY hrootkey
= NULL
;
328 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
330 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
332 result
= (char *) xmalloc (cbData
);
334 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
342 RegCloseKey (hrootkey
);
349 getenv wrapper for Windows
351 Value is allocated on the heap, and can be free'd.
353 This is needed to duplicate Emacs's behavior, which is to look for
354 environment variables in the registry if they don't appear in the
357 w32_getenv (char *envvar
)
362 if ((value
= getenv (envvar
)))
363 /* Found in the environment. strdup it, because values returned
364 by getenv cannot be free'd. */
365 return xstrdup (value
);
367 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
368 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
370 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
371 if (strcmp (envvar
, "TERM") == 0)
372 return xstrdup ("w32console");
373 /* Found neither in the environment nor in the registry. */
377 if (dwType
== REG_SZ
)
378 /* Registry; no need to expand. */
381 if (dwType
== REG_EXPAND_SZ
)
385 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
387 char *buffer
= (char *) xmalloc (size
);
388 if (ExpandEnvironmentStrings (value
, buffer
, size
))
390 /* Found and expanded. */
395 /* Error expanding. */
400 /* Not the right type, or not correctly expanded. */
406 w32_set_user_model_id (void)
409 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
411 /* On Windows 7 and later, we need to set the user model ID
412 to associate emacsclient launched files with Emacs frames
414 shell
= LoadLibrary ("shell32.dll");
418 = (void *) GetProcAddress (shell
,
419 "SetCurrentProcessExplicitAppUserModelID");
420 /* If the function is defined, then we are running on Windows 7
421 or newer, and the UI uses this to group related windows
422 together. Since emacs, runemacs, emacsclient are related, we
423 want them grouped even though the executables are different,
424 so we need to set a consistent ID between them. */
426 set_user_model (L
"GNU.Emacs");
433 w32_window_app (void)
435 static int window_app
= -1;
436 char szTitle
[MAX_PATH
];
440 /* Checking for STDOUT does not work; it's a valid handle also in
441 nonconsole apps. Testing for the console title seems to work. */
442 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
444 InitCommonControls ();
451 execvp wrapper for Windows. Quotes arguments with embedded spaces.
453 This is necessary due to the broken implementation of exec* routines in
454 the Microsoft libraries: they concatenate the arguments together without
455 quoting special characters, and pass the result to CreateProcess, with
456 predictably bad results. By contrast, POSIX execvp passes the arguments
457 directly into the argv array of the child process.
460 w32_execvp (const char *path
, char **argv
)
464 /* Required to allow a .BAT script as alternate editor. */
465 argv
[0] = (char *) alternate_editor
;
467 for (i
= 0; argv
[i
]; i
++)
468 if (strchr (argv
[i
], ' '))
470 char *quoted
= alloca (strlen (argv
[i
]) + 3);
471 sprintf (quoted
, "\"%s\"", argv
[i
]);
475 return execvp (path
, argv
);
479 #define execvp w32_execvp
481 /* Emulation of ttyname for Windows. */
488 #endif /* WINDOWSNT */
490 /* Display a normal or error message.
491 On Windows, use a message box if compiled as a Windows app. */
492 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
494 message (int is_error
, const char *format
, ...)
498 va_start (args
, format
);
501 if (w32_window_app ())
504 vsnprintf (msg
, sizeof msg
, format
, args
);
505 msg
[sizeof msg
- 1] = '\0';
508 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
510 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
515 FILE *f
= is_error
? stderr
: stdout
;
517 vfprintf (f
, format
, args
);
524 /* Decode the options from argv and argc.
525 The global variable `optind' will say how many arguments we used up. */
528 decode_options (int argc
, char **argv
)
530 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
534 int opt
= getopt_long_only (argc
, argv
,
535 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
548 /* If getopt returns 0, then it has already processed a
549 long-named option. We should do nothing. */
553 alternate_editor
= optarg
;
556 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
558 socket_name
= optarg
;
563 server_file
= optarg
;
566 /* We used to disallow this argument in w32, but it seems better
567 to allow it, for the occasional case where the user is
568 connecting with a w32 client to a server compiled with X11
587 message (FALSE
, "emacsclient %s\n", VERSION
);
606 print_help_and_exit ();
610 frame_parameters
= optarg
;
614 message (TRUE
, "Try `%s --help' for more information\n", progname
);
620 /* If the -c option is used (without -t) and no --display argument
621 is provided, try $DISPLAY.
622 Without the -c option, we used to set `display' to $DISPLAY by
623 default, but this changed the default behavior and is sometimes
624 inconvenient. So we force users to use "--display $DISPLAY" if
625 they want Emacs to connect to their current display. */
626 if (!current_frame
&& !tty
&& !display
)
628 display
= egetenv ("DISPLAY");
630 /* Under Cocoa, we don't really use displays the same way as in X,
631 so provide a dummy. */
632 if (!display
|| strlen (display
) == 0)
637 /* A null-string display is invalid. */
638 if (display
&& strlen (display
) == 0)
642 /* Emacs on Windows does not support GUI and console frames in the same
643 instance. So, it makes sense to treat the -t and -c options as
644 equivalent, and open a new frame regardless of whether the running
645 instance is GUI or console. Ideally, we would only set tty = 1 when
646 the instance is running in a console, but alas we don't know that.
647 The simplest workaround is to always ask for a tty frame, and let
648 server.el check whether it makes sense. */
649 if (tty
|| !current_frame
)
651 display
= (const char *) ttyname
;
657 /* If no display is available, new frames are tty frames. */
658 if (!current_frame
&& !display
)
661 /* --no-wait implies --current-frame on ttys when there are file
662 arguments or expressions given. */
663 if (nowait
&& tty
&& argc
- optind
> 0)
667 if (alternate_editor
&& alternate_editor
[0] == '\0')
669 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
673 #endif /* WINDOWSNT */
678 print_help_and_exit (void)
680 /* Spaces and tabs are significant in this message; they're chosen so the
681 message aligns properly both in a tty and in a Windows message box.
682 Please try to preserve them; otherwise the output is very hard to read
683 when using emacsclientw. */
685 "Usage: %s [OPTIONS] FILE...\n\
686 Tell the Emacs server to visit the specified files.\n\
687 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
689 The following OPTIONS are accepted:\n\
690 -V, --version Just print version info and return\n\
691 -H, --help Print this usage information message\n\
692 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
693 -c, --create-frame Create a new frame instead of trying to\n\
694 use the current Emacs frame\n\
695 -F ALIST, --frame-parameters=ALIST\n\
696 Set the parameters of a new frame\n\
697 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
698 -n, --no-wait Don't wait for the server to return\n\
699 -q, --quiet Don't display messages on success\n\
700 -d DISPLAY, --display=DISPLAY\n\
701 Visit the file in the given display\n\
702 --parent-id=ID Open in parent window ID, via XEmbed\n"
703 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
704 "-s SOCKET, --socket-name=SOCKET\n\
705 Set filename of the UNIX socket for communication\n"
707 "-f SERVER, --server-file=SERVER\n\
708 Set filename of the TCP authentication file\n\
709 -a EDITOR, --alternate-editor=EDITOR\n\
710 Editor to fallback to if the server is not running\n"
712 " If EDITOR is the empty string, start Emacs in daemon\n\
713 mode and try connecting again\n"
714 #endif /* not WINDOWSNT */
716 Report bugs with M-x report-emacs-bug.\n", progname
);
721 Try to run a different command, or --if no alternate editor is
722 defined-- exit with an errorcode.
723 Uses argv, but gets it from the global variable main_argv.
728 if (alternate_editor
)
732 execvp (alternate_editor
, main_argv
+ i
);
733 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
734 progname
, alternate_editor
);
740 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
743 main (int argc
, char **argv
)
747 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
748 "on systems with Berkeley sockets.\n",
753 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
755 #define AUTH_KEY_LENGTH 64
756 #define SEND_BUFFER_SIZE 4096
758 extern char *strerror (int);
760 /* Buffer to accumulate data to send in TCP connections. */
761 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
762 int sblen
= 0; /* Fill pointer for the send buffer. */
763 /* Socket used to communicate with the Emacs server process. */
764 HSOCKET emacs_socket
= 0;
766 /* On Windows, the socket library was historically separate from the standard
767 C library, so errors are handled differently. */
769 sock_err_message (const char *function_name
)
774 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
775 | FORMAT_MESSAGE_ALLOCATE_BUFFER
776 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
777 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
779 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
783 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
788 /* Let's send the data to Emacs when either
789 - the data ends in "\n", or
790 - the buffer is full (but this shouldn't happen)
791 Otherwise, we just accumulate it. */
793 send_to_emacs (HSOCKET s
, const char *data
)
797 size_t dlen
= strlen (data
);
798 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
800 int part
= SEND_BUFFER_SIZE
- sblen
;
801 strncpy (&send_buffer
[sblen
], data
, part
);
803 sblen
= SEND_BUFFER_SIZE
;
807 strcpy (&send_buffer
[sblen
], data
);
814 if (sblen
== SEND_BUFFER_SIZE
815 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
817 int sent
= send (s
, send_buffer
, sblen
, 0);
819 strcpy (send_buffer
, &send_buffer
[sent
]);
826 /* In STR, insert a & before each &, each space, each newline, and
827 any initial -. Change spaces to underscores, too, so that the
828 return value never contains a space.
830 Does not change the string. Outputs the result to S. */
832 quote_argument (HSOCKET s
, const char *str
)
834 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
856 if (*p
== '&' || (*p
== '-' && p
== str
))
863 send_to_emacs (s
, copy
);
869 /* The inverse of quote_argument. Removes quoting in string STR by
870 modifying the string in place. Returns STR. */
873 unquote_argument (char *str
)
904 file_name_absolute_p (const char *filename
)
906 /* Sanity check, it shouldn't happen. */
907 if (! filename
) return FALSE
;
909 /* /xxx is always an absolute path. */
910 if (filename
[0] == '/') return TRUE
;
912 /* Empty filenames (which shouldn't happen) are relative. */
913 if (filename
[0] == '\0') return FALSE
;
916 /* X:\xxx is always absolute. */
917 if (isalpha ((unsigned char) filename
[0])
918 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
921 /* Both \xxx and \\xxx\yyy are absolute. */
922 if (filename
[0] == '\\') return TRUE
;
929 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
936 /* Initialize the WinSock2 library. */
938 initialize_sockets (void)
942 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
944 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
948 atexit (close_winsock
);
950 #endif /* WINDOWSNT */
954 * Read the information needed to set up a TCP comm channel with
955 * the Emacs server: host, port, and authentication string.
958 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
959 char *authentication
)
965 if (file_name_absolute_p (config_file
))
966 config
= fopen (config_file
, "rb");
969 const char *home
= egetenv ("HOME");
973 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
976 strcat (path
, "/.emacs.d/server/");
977 strcat (path
, config_file
);
978 config
= fopen (path
, "rb");
982 if (!config
&& (home
= egetenv ("APPDATA")))
984 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
987 strcat (path
, "/.emacs.d/server/");
988 strcat (path
, config_file
);
989 config
= fopen (path
, "rb");
998 if (fgets (dotted
, sizeof dotted
, config
)
999 && (port
= strchr (dotted
, ':')))
1003 message (TRUE
, "%s: invalid configuration info\n", progname
);
1004 exit (EXIT_FAILURE
);
1007 server
->sin_family
= AF_INET
;
1008 server
->sin_addr
.s_addr
= inet_addr (dotted
);
1009 server
->sin_port
= htons (atoi (port
));
1011 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
1013 message (TRUE
, "%s: cannot read authentication info\n", progname
);
1014 exit (EXIT_FAILURE
);
1023 set_tcp_socket (const char *local_server_file
)
1026 struct sockaddr_in server
;
1027 struct linger l_arg
= {1, 1};
1028 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1030 if (! get_server_config (local_server_file
, &server
, auth_string
))
1031 return INVALID_SOCKET
;
1033 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1034 message (FALSE
, "%s: connected to remote socket at %s\n",
1035 progname
, inet_ntoa (server
.sin_addr
));
1038 * Open up an AF_INET socket
1040 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1042 sock_err_message ("socket");
1043 return INVALID_SOCKET
;
1049 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1051 sock_err_message ("connect");
1052 return INVALID_SOCKET
;
1055 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1058 * Send the authentication
1060 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1062 send_to_emacs (s
, "-auth ");
1063 send_to_emacs (s
, auth_string
);
1064 send_to_emacs (s
, " ");
1070 /* Returns 1 if PREFIX is a prefix of STRING. */
1072 strprefix (const char *prefix
, const char *string
)
1074 return !strncmp (prefix
, string
, strlen (prefix
));
1077 /* Get tty name and type. If successful, return the type in TTY_TYPE
1078 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1079 is zero, or return 0 if NOABORT is non-zero. */
1082 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1084 const char *type
= egetenv ("TERM");
1085 const char *name
= ttyname (fileno (stdout
));
1093 message (TRUE
, "%s: could not get terminal name\n", progname
);
1104 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1110 if (strcmp (type
, "eterm") == 0)
1116 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1117 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1118 " is not supported\n", progname
);
1129 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1131 /* Three possibilities:
1132 2 - can't be `stat'ed (sets errno)
1133 1 - isn't owned by us
1134 0 - success: none of the above */
1137 socket_status (const char *name
)
1139 struct stat statbfr
;
1141 if (stat (name
, &statbfr
) == -1)
1144 if (statbfr
.st_uid
!= geteuid ())
1151 /* A signal handler that passes the signal to the Emacs process.
1152 Useful for SIGWINCH. */
1155 pass_signal_to_emacs (int signalnum
)
1157 int old_errno
= errno
;
1160 kill (emacs_pid
, signalnum
);
1162 signal (signalnum
, pass_signal_to_emacs
);
1166 /* Signal handler for SIGCONT; notify the Emacs process that it can
1167 now resume our tty frame. */
1170 handle_sigcont (int signalnum
)
1172 int old_errno
= errno
;
1174 if (tcgetpgrp (1) == getpgrp ())
1176 /* We are in the foreground. */
1177 send_to_emacs (emacs_socket
, "-resume \n");
1181 /* We are in the background; cancel the continue. */
1182 kill (getpid (), SIGSTOP
);
1185 signal (signalnum
, handle_sigcont
);
1189 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1190 going to sleep. Normally the suspend is initiated by Emacs via
1191 server-handle-suspend-tty, but if the server gets out of sync with
1192 reality, we may get a SIGTSTP on C-z. Handling this signal and
1193 notifying Emacs about it should get things under control again. */
1196 handle_sigtstp (int signalnum
)
1198 int old_errno
= errno
;
1202 send_to_emacs (emacs_socket
, "-suspend \n");
1204 /* Unblock this signal and call the default handler by temporarily
1205 changing the handler and resignaling. */
1206 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1207 sigdelset (&set
, signalnum
);
1208 signal (signalnum
, SIG_DFL
);
1209 kill (getpid (), signalnum
);
1210 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1211 signal (signalnum
, handle_sigtstp
);
1217 /* Set up signal handlers before opening a frame on the current tty. */
1222 /* Set up signal handlers. */
1223 signal (SIGWINCH
, pass_signal_to_emacs
);
1225 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1226 deciding which terminal the signal came from. C-g is now a
1227 normal input event on secondary terminals. */
1229 signal (SIGINT
, pass_signal_to_emacs
);
1230 signal (SIGQUIT
, pass_signal_to_emacs
);
1233 signal (SIGCONT
, handle_sigcont
);
1234 signal (SIGTSTP
, handle_sigtstp
);
1235 signal (SIGTTOU
, handle_sigtstp
);
1240 set_local_socket (const char *local_socket_name
)
1243 struct sockaddr_un server
;
1246 * Open up an AF_UNIX socket in this person's home directory
1249 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1251 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1252 return INVALID_SOCKET
;
1255 server
.sun_family
= AF_UNIX
;
1261 const char *server_name
= local_socket_name
;
1262 const char *tmpdir
IF_LINT ( = NULL
);
1263 char *tmpdir_storage
= NULL
;
1264 char *socket_name_storage
= NULL
;
1266 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1268 /* socket_name is a file name component. */
1269 long uid
= geteuid ();
1270 ptrdiff_t tmpdirlen
;
1272 tmpdir
= egetenv ("TMPDIR");
1276 #ifndef _CS_DARWIN_USER_TEMP_DIR
1277 #define _CS_DARWIN_USER_TEMP_DIR 65537
1279 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1282 tmpdir
= tmpdir_storage
= xmalloc (n
);
1283 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir
, n
);
1289 tmpdirlen
= strlen (tmpdir
);
1290 socket_name_storage
=
1291 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1292 strcpy (socket_name_storage
, tmpdir
);
1293 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1294 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1295 local_socket_name
= socket_name_storage
;
1298 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1299 strcpy (server
.sun_path
, local_socket_name
);
1302 message (TRUE
, "%s: socket-name %s too long\n",
1303 progname
, local_socket_name
);
1307 /* See if the socket exists, and if it's owned by us. */
1308 sock_status
= socket_status (server
.sun_path
);
1309 saved_errno
= errno
;
1310 if (sock_status
&& use_tmpdir
)
1312 /* Failing that, see if LOGNAME or USER exist and differ from
1313 our euid. If so, look for a socket based on the UID
1314 associated with the name. This is reminiscent of the logic
1315 that init_editfns uses to set the global Vuser_full_name. */
1317 const char *user_name
= egetenv ("LOGNAME");
1320 user_name
= egetenv ("USER");
1324 struct passwd
*pw
= getpwnam (user_name
);
1326 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1328 /* We're running under su, apparently. */
1329 long uid
= pw
->pw_uid
;
1330 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1331 char *user_socket_name
1332 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1333 strcpy (user_socket_name
, tmpdir
);
1334 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1335 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1337 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1338 strcpy (server
.sun_path
, user_socket_name
);
1341 message (TRUE
, "%s: socket-name %s too long\n",
1342 progname
, user_socket_name
);
1343 exit (EXIT_FAILURE
);
1345 free (user_socket_name
);
1347 sock_status
= socket_status (server
.sun_path
);
1348 saved_errno
= errno
;
1351 errno
= saved_errno
;
1355 free (socket_name_storage
);
1356 free (tmpdir_storage
);
1358 switch (sock_status
)
1361 /* There's a socket, but it isn't owned by us. This is OK if
1363 if (0 != geteuid ())
1365 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1366 return INVALID_SOCKET
;
1372 if (saved_errno
== ENOENT
)
1374 "%s: can't find socket; have you started the server?\n\
1375 To start the server in Emacs, type \"M-x server-start\".\n",
1378 message (TRUE
, "%s: can't stat %s: %s\n",
1379 progname
, server
.sun_path
, strerror (saved_errno
));
1380 return INVALID_SOCKET
;
1384 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1387 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1388 return INVALID_SOCKET
;
1393 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1396 set_socket (int no_exit_if_error
)
1399 const char *local_server_file
= server_file
;
1403 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1404 /* Explicit --socket-name argument. */
1407 s
= set_local_socket (socket_name
);
1408 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1410 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1411 progname
, socket_name
);
1412 exit (EXIT_FAILURE
);
1416 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1417 if (!local_server_file
)
1418 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1420 if (local_server_file
)
1422 s
= set_tcp_socket (local_server_file
);
1423 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1426 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1427 progname
, local_server_file
);
1428 exit (EXIT_FAILURE
);
1431 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1432 /* Implicit local socket. */
1433 s
= set_local_socket ("server");
1434 if (s
!= INVALID_SOCKET
)
1438 /* Implicit server file. */
1439 s
= set_tcp_socket ("server");
1440 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1443 /* No implicit or explicit socket, and no alternate editor. */
1444 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1445 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1448 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1449 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1451 exit (EXIT_FAILURE
);
1455 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1456 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1459 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1464 /* Reject any window not of class "Emacs". */
1465 if (! get_wc (hWnd
, class, sizeof (class))
1466 || strcmp (class, "Emacs"))
1469 /* We only need the process id, not the thread id. */
1470 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1472 /* Not the one we're looking for. */
1473 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1475 /* OK, let's raise it. */
1478 /* Stop enumeration. */
1483 * Search for a window of class "Emacs" and owned by a process with
1484 * process id = emacs_pid. If found, allow it to grab the focus.
1487 w32_give_focus (void)
1491 /* It shouldn't happen when dealing with TCP sockets. */
1492 if (!emacs_pid
) return;
1494 user32
= GetModuleHandle ("user32.dll");
1499 /* Modern Windows restrict which processes can set the foreground window.
1500 emacsclient can allow Emacs to grab the focus by calling the function
1501 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1502 NT) lack this function, so we have to check its availability. */
1503 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1504 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1505 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1509 /* Start the emacs daemon and try to connect to it. */
1512 start_daemon_and_retry_set_socket (void)
1523 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1525 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1527 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1528 exit (EXIT_FAILURE
);
1531 /* Try connecting, the daemon should have started by now. */
1532 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1533 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1535 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1536 exit (EXIT_FAILURE
);
1541 fprintf (stderr
, "Error: Cannot fork!\n");
1542 exit (EXIT_FAILURE
);
1546 char emacs
[] = "emacs";
1547 char daemon_option
[] = "--daemon";
1548 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1549 if (socket_name
!= NULL
)
1551 /* Pass --daemon=socket_name as argument. */
1552 const char *deq
= "--daemon=";
1553 char *daemon_arg
= xmalloc (strlen (deq
)
1554 + strlen (socket_name
) + 1);
1555 strcpy (daemon_arg
, deq
);
1556 strcat (daemon_arg
, socket_name
);
1557 d_argv
[1] = daemon_arg
;
1559 execvp ("emacs", d_argv
);
1560 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1562 #endif /* WINDOWSNT */
1566 main (int argc
, char **argv
)
1568 int rl
= 0, needlf
= 0;
1570 char string
[BUFSIZ
+1];
1571 int start_daemon_if_needed
;
1572 int exit_status
= EXIT_SUCCESS
;
1578 /* On Windows 7 and later, we need to explicitly associate emacsclient
1579 with emacs so the UI behaves sensibly. */
1580 w32_set_user_model_id ();
1583 /* Process options. */
1584 decode_options (argc
, argv
);
1586 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1588 message (TRUE
, "%s: file name or argument required\n"
1589 "Try `%s --help' for more information\n",
1590 progname
, progname
);
1591 exit (EXIT_FAILURE
);
1594 /* If alternate_editor is the empty string, start the emacs daemon
1595 in case of failure to connect. */
1596 start_daemon_if_needed
= (alternate_editor
1597 && (alternate_editor
[0] == '\0'));
1599 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1600 if (emacs_socket
== INVALID_SOCKET
)
1602 if (! start_daemon_if_needed
)
1605 start_daemon_and_retry_set_socket ();
1608 cwd
= get_current_dir_name ();
1611 /* getwd puts message in STRING if it fails. */
1612 message (TRUE
, "%s: %s\n", progname
,
1613 "Cannot get current working directory");
1621 /* Send over our environment and current directory. */
1625 /* This is defined in stdlib.h on MS-Windows. It's defined in
1626 unistd.h on some POSIX hosts, but not all (Bug#10155). */
1627 extern char **environ
;
1630 for (i
= 0; environ
[i
]; i
++)
1632 send_to_emacs (emacs_socket
, "-env ");
1633 quote_argument (emacs_socket
, environ
[i
]);
1634 send_to_emacs (emacs_socket
, " ");
1637 send_to_emacs (emacs_socket
, "-dir ");
1638 quote_argument (emacs_socket
, cwd
);
1639 send_to_emacs (emacs_socket
, "/");
1640 send_to_emacs (emacs_socket
, " ");
1644 send_to_emacs (emacs_socket
, "-nowait ");
1647 send_to_emacs (emacs_socket
, "-current-frame ");
1651 send_to_emacs (emacs_socket
, "-display ");
1652 quote_argument (emacs_socket
, display
);
1653 send_to_emacs (emacs_socket
, " ");
1658 send_to_emacs (emacs_socket
, "-parent-id ");
1659 quote_argument (emacs_socket
, parent_id
);
1660 send_to_emacs (emacs_socket
, " ");
1663 if (frame_parameters
&& !current_frame
)
1665 send_to_emacs (emacs_socket
, "-frame-parameters ");
1666 quote_argument (emacs_socket
, frame_parameters
);
1667 send_to_emacs (emacs_socket
, " ");
1670 /* If using the current frame, send tty information to Emacs anyway.
1671 In daemon mode, Emacs may need to occupy this tty if no other
1672 frame is available. */
1673 if (tty
|| (current_frame
&& !eval
))
1675 const char *tty_type
, *tty_name
;
1677 if (find_tty (&tty_type
, &tty_name
, !tty
))
1679 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1682 send_to_emacs (emacs_socket
, "-tty ");
1683 quote_argument (emacs_socket
, tty_name
);
1684 send_to_emacs (emacs_socket
, " ");
1685 quote_argument (emacs_socket
, tty_type
);
1686 send_to_emacs (emacs_socket
, " ");
1690 if (!current_frame
&& !tty
)
1691 send_to_emacs (emacs_socket
, "-window-system ");
1693 if ((argc
- optind
> 0))
1696 for (i
= optind
; i
< argc
; i
++)
1701 /* Don't prepend cwd or anything like that. */
1702 send_to_emacs (emacs_socket
, "-eval ");
1703 quote_argument (emacs_socket
, argv
[i
]);
1704 send_to_emacs (emacs_socket
, " ");
1708 if (*argv
[i
] == '+')
1710 char *p
= argv
[i
] + 1;
1711 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1714 send_to_emacs (emacs_socket
, "-position ");
1715 quote_argument (emacs_socket
, argv
[i
]);
1716 send_to_emacs (emacs_socket
, " ");
1721 else if (! file_name_absolute_p (argv
[i
])
1722 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1723 /* Windows can have a different default directory for each
1724 drive, so the cwd passed via "-dir" is not sufficient
1725 to account for that.
1726 If the user uses <drive>:<relpath>, we hence need to be
1727 careful to expand <relpath> with the default directory
1728 corresponding to <drive>. */
1730 char *filename
= (char *) xmalloc (MAX_PATH
);
1733 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1734 if (size
> 0 && size
< MAX_PATH
)
1741 send_to_emacs (emacs_socket
, "-file ");
1742 quote_argument (emacs_socket
, argv
[i
]);
1743 send_to_emacs (emacs_socket
, " ");
1748 /* Read expressions interactively. */
1749 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1751 send_to_emacs (emacs_socket
, "-eval ");
1752 quote_argument (emacs_socket
, str
);
1754 send_to_emacs (emacs_socket
, " ");
1757 send_to_emacs (emacs_socket
, "\n");
1759 /* Wait for an answer. */
1760 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1762 printf ("Waiting for Emacs...");
1768 /* Now, wait for an answer and print any messages. */
1769 while (exit_status
== EXIT_SUCCESS
)
1775 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1777 /* If we receive a signal (e.g. SIGWINCH, which we pass
1778 through to Emacs), on some OSes we get EINTR and must retry. */
1779 while (rl
< 0 && errno
== EINTR
);
1786 /* Loop over all NL-terminated messages. */
1787 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1789 end_p
= strchr (p
, '\n');
1793 if (strprefix ("-emacs-pid ", p
))
1795 /* -emacs-pid PID: The process id of the Emacs process. */
1796 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1798 else if (strprefix ("-window-system-unsupported ", p
))
1800 /* -window-system-unsupported: Emacs was compiled without X
1801 support. Try again on the terminal. */
1806 else if (strprefix ("-print ", p
))
1808 /* -print STRING: Print STRING on the terminal. */
1809 str
= unquote_argument (p
+ strlen ("-print "));
1813 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1815 else if (strprefix ("-error ", p
))
1817 /* -error DESCRIPTION: Signal an error on the terminal. */
1818 str
= unquote_argument (p
+ strlen ("-error "));
1821 fprintf (stderr
, "*ERROR*: %s", str
);
1822 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1823 exit_status
= EXIT_FAILURE
;
1826 else if (strprefix ("-suspend ", p
))
1828 /* -suspend: Suspend this terminal, i.e., stop the process. */
1837 /* Unknown command. */
1841 printf ("*ERROR*: Unknown message: %s\n", p
);
1852 exit_status
= EXIT_FAILURE
;
1854 CLOSE_SOCKET (emacs_socket
);
1858 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1861 #ifndef HAVE_STRERROR
1866 extern char *sys_errlist
[];
1867 extern int sys_nerr
;
1869 if (errnum
>= 0 && errnum
< sys_nerr
)
1870 return sys_errlist
[errnum
];
1871 return (char *) "Unknown error";
1874 #endif /* ! HAVE_STRERROR */
1877 /* emacsclient.c ends here */