1 /* Client process that communicates with GNU Emacs acting as server.
3 Copyright (C) 1986-1987, 1994, 1999-2012 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 /* ms-w32.h defines these, which disables sockets altogether! */
32 # include <commctrl.h>
34 # include <winsock2.h>
36 # define NO_SOCKETS_IN_FILE_SYSTEM
38 # define HSOCKET SOCKET
39 # define CLOSE_SOCKET closesocket
40 # define INITIALIZE() (initialize_sockets ())
42 char *w32_getenv (char *);
43 #define egetenv(VAR) w32_getenv(VAR)
45 #else /* !WINDOWSNT */
49 # ifdef HAVE_INET_SOCKETS
50 # include <netinet/in.h>
52 # include <sys/types.h>
53 # include <sys/socket.h>
55 # endif /* HAVE_SOCKETS */
57 # include <arpa/inet.h>
59 # define INVALID_SOCKET -1
61 # define CLOSE_SOCKET close
68 #define egetenv(VAR) getenv(VAR)
70 #endif /* !WINDOWSNT */
87 char *getenv (const char *), *getwd (char *);
89 char *(getcwd
) (char *, size_t);
93 #define VERSION "unspecified"
98 #define EXIT_SUCCESS 0
102 #define EXIT_FAILURE 1
113 /* Additional space when allocating buffers for filenames, etc. */
114 #define EXTRA_SPACE 100
119 #define min(x, y) (((x) < (y)) ? (x) : (y))
122 /* Name used to invoke this program. */
123 const char *progname
;
125 /* The second argument to main. */
128 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
131 /* Nonzero means don't print messages for successful operations. --quiet. */
134 /* Nonzero means args are expressions to be evaluated. --eval. */
137 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
138 int current_frame
= 1;
140 /* The display on which Emacs should work. --display. */
141 const char *display
= NULL
;
143 /* The parent window ID, if we are opening a frame via XEmbed. */
144 char *parent_id
= NULL
;
146 /* Nonzero means open a new Emacs frame on the current terminal. */
149 /* If non-NULL, the name of an editor to fallback to if the server
150 is not running. --alternate-editor. */
151 const char *alternate_editor
= NULL
;
153 /* If non-NULL, the filename of the UNIX socket. */
154 const char *socket_name
= NULL
;
156 /* If non-NULL, the filename of the authentication file. */
157 const char *server_file
= NULL
;
159 /* PID of the Emacs server process. */
162 /* If non-NULL, a string that should form a frame parameter alist to
163 be used for the new frame */
164 const char *frame_parameters
= NULL
;
166 static _Noreturn
void print_help_and_exit (void);
169 struct option longopts
[] =
171 { "no-wait", no_argument
, NULL
, 'n' },
172 { "quiet", no_argument
, NULL
, 'q' },
173 { "eval", no_argument
, NULL
, 'e' },
174 { "help", no_argument
, NULL
, 'H' },
175 { "version", no_argument
, NULL
, 'V' },
176 { "tty", no_argument
, NULL
, 't' },
177 { "nw", no_argument
, NULL
, 't' },
178 { "create-frame", no_argument
, NULL
, 'c' },
179 { "alternate-editor", required_argument
, NULL
, 'a' },
180 { "frame-parameters", required_argument
, NULL
, 'F' },
181 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
182 { "socket-name", required_argument
, NULL
, 's' },
184 { "server-file", required_argument
, NULL
, 'f' },
186 { "display", required_argument
, NULL
, 'd' },
188 { "parent-id", required_argument
, NULL
, 'p' },
193 /* Like malloc but get fatal error if memory is exhausted. */
196 xmalloc (size_t size
)
198 void *result
= malloc (size
);
208 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
210 char *get_current_dir_name (void);
212 /* Return the current working directory. Returns NULL on errors.
213 Any other returned value must be freed with free. This is used
214 only when get_current_dir_name is not defined on the system. */
216 get_current_dir_name (void)
220 struct stat dotstat
, pwdstat
;
221 /* If PWD is accurate, use it instead of calling getwd. PWD is
222 sometimes a nicer name, and using it may avoid a fatal error if a
223 parent directory is searchable but not readable. */
224 if ((pwd
= egetenv ("PWD")) != 0
225 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
226 && stat (pwd
, &pwdstat
) == 0
227 && stat (".", &dotstat
) == 0
228 && dotstat
.st_ino
== pwdstat
.st_ino
229 && dotstat
.st_dev
== pwdstat
.st_dev
231 && strlen (pwd
) < MAXPATHLEN
235 buf
= (char *) xmalloc (strlen (pwd
) + 1);
241 size_t buf_size
= 1024;
245 buf
= malloc (buf_size
);
248 if (getcwd (buf
, buf_size
) == buf
)
252 if (tmp_errno
!= ERANGE
)
268 /* We need MAXPATHLEN here. */
269 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
270 if (getwd (buf
) == NULL
)
272 int tmp_errno
= errno
;
285 /* Like strdup but get a fatal error if memory is exhausted. */
288 xstrdup (const char *s
)
290 char *result
= strdup (s
);
299 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
301 /* Retrieve an environment variable from the Emacs subkeys of the registry.
302 Return NULL if the variable was not found, or it was empty.
303 This code is based on w32_get_resource (w32.c). */
305 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
307 HKEY hrootkey
= NULL
;
311 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
313 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
315 result
= (char *) xmalloc (cbData
);
317 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
325 RegCloseKey (hrootkey
);
332 getenv wrapper for Windows
334 Value is allocated on the heap, and can be free'd.
336 This is needed to duplicate Emacs's behavior, which is to look for
337 environment variables in the registry if they don't appear in the
340 w32_getenv (char *envvar
)
345 if ((value
= getenv (envvar
)))
346 /* Found in the environment. strdup it, because values returned
347 by getenv cannot be free'd. */
348 return xstrdup (value
);
350 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
351 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
353 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
354 if (strcmp (envvar
, "TERM") == 0)
355 return xstrdup ("w32console");
356 /* Found neither in the environment nor in the registry. */
360 if (dwType
== REG_SZ
)
361 /* Registry; no need to expand. */
364 if (dwType
== REG_EXPAND_SZ
)
368 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
370 char *buffer
= (char *) xmalloc (size
);
371 if (ExpandEnvironmentStrings (value
, buffer
, size
))
373 /* Found and expanded. */
378 /* Error expanding. */
383 /* Not the right type, or not correctly expanded. */
389 w32_set_user_model_id (void)
392 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
394 /* On Windows 7 and later, we need to set the user model ID
395 to associate emacsclient launched files with Emacs frames
397 shell
= LoadLibrary ("shell32.dll");
401 = (void *) GetProcAddress (shell
,
402 "SetCurrentProcessExplicitAppUserModelID");
403 /* If the function is defined, then we are running on Windows 7
404 or newer, and the UI uses this to group related windows
405 together. Since emacs, runemacs, emacsclient are related, we
406 want them grouped even though the executables are different,
407 so we need to set a consistent ID between them. */
409 set_user_model (L
"GNU.Emacs");
416 w32_window_app (void)
418 static int window_app
= -1;
419 char szTitle
[MAX_PATH
];
423 /* Checking for STDOUT does not work; it's a valid handle also in
424 nonconsole apps. Testing for the console title seems to work. */
425 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
427 InitCommonControls ();
433 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
435 This is necessary due to the broken implementation of exec* routines in
436 the Microsoft libraries: they concatenate the arguments together without
437 quoting special characters, and pass the result to CreateProcess, with
438 predictably bad results. By contrast, POSIX execvp passes the arguments
439 directly into the argv array of the child process. */
442 w32_execvp (const char *path
, char **argv
)
445 extern int execvp (const char*, char **);
447 /* Required to allow a .BAT script as alternate editor. */
448 argv
[0] = (char *) alternate_editor
;
450 for (i
= 0; argv
[i
]; i
++)
451 if (strchr (argv
[i
], ' '))
453 char *quoted
= alloca (strlen (argv
[i
]) + 3);
454 sprintf (quoted
, "\"%s\"", argv
[i
]);
458 return execvp (path
, argv
);
462 #define execvp w32_execvp
464 /* Emulation of ttyname for Windows. */
471 #endif /* WINDOWSNT */
473 /* Display a normal or error message.
474 On Windows, use a message box if compiled as a Windows app. */
475 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
477 message (int is_error
, const char *format
, ...)
481 va_start (args
, format
);
484 if (w32_window_app ())
487 vsnprintf (msg
, sizeof msg
, format
, args
);
488 msg
[sizeof msg
- 1] = '\0';
491 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
493 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
498 FILE *f
= is_error
? stderr
: stdout
;
500 vfprintf (f
, format
, args
);
507 /* Decode the options from argv and argc.
508 The global variable `optind' will say how many arguments we used up. */
511 decode_options (int argc
, char **argv
)
513 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
517 int opt
= getopt_long_only (argc
, argv
,
518 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
531 /* If getopt returns 0, then it has already processed a
532 long-named option. We should do nothing. */
536 alternate_editor
= optarg
;
539 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
541 socket_name
= optarg
;
546 server_file
= optarg
;
549 /* We used to disallow this argument in w32, but it seems better
550 to allow it, for the occasional case where the user is
551 connecting with a w32 client to a server compiled with X11
570 message (FALSE
, "emacsclient %s\n", VERSION
);
589 print_help_and_exit ();
593 frame_parameters
= optarg
;
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
)
629 /* Emacs on Windows does not support graphical and text terminal
630 frames in the same instance. So, treat the -t and -c options as
631 equivalent, and open a new frame on the server's terminal.
632 Ideally, we would only set tty = 1 when the serve is running in a
633 console, but alas we don't know that. As a workaround, always
634 ask for a tty frame, and let server.el figure it out. */
641 if (alternate_editor
&& alternate_editor
[0] == '\0')
643 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
647 #endif /* WINDOWSNT */
651 static _Noreturn
void
652 print_help_and_exit (void)
654 /* Spaces and tabs are significant in this message; they're chosen so the
655 message aligns properly both in a tty and in a Windows message box.
656 Please try to preserve them; otherwise the output is very hard to read
657 when using emacsclientw. */
659 "Usage: %s [OPTIONS] FILE...\n\
660 Tell the Emacs server to visit the specified files.\n\
661 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
663 The following OPTIONS are accepted:\n\
664 -V, --version Just print version info and return\n\
665 -H, --help Print this usage information message\n\
666 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
667 -c, --create-frame Create a new frame instead of trying to\n\
668 use the current Emacs frame\n\
669 -F ALIST, --frame-parameters=ALIST\n\
670 Set the parameters of a new frame\n\
671 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
672 -n, --no-wait Don't wait for the server to return\n\
673 -q, --quiet Don't display messages on success\n\
674 -d DISPLAY, --display=DISPLAY\n\
675 Visit the file in the given display\n\
676 --parent-id=ID Open in parent window ID, via XEmbed\n"
677 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
678 "-s SOCKET, --socket-name=SOCKET\n\
679 Set filename of the UNIX socket for communication\n"
681 "-f SERVER, --server-file=SERVER\n\
682 Set filename of the TCP authentication file\n\
683 -a EDITOR, --alternate-editor=EDITOR\n\
684 Editor to fallback to if the server is not running\n"
686 " If EDITOR is the empty string, start Emacs in daemon\n\
687 mode and try connecting again\n"
688 #endif /* not WINDOWSNT */
690 Report bugs with M-x report-emacs-bug.\n", progname
);
694 /* Try to run a different command, or --if no alternate editor is
695 defined-- exit with an errorcode.
696 Uses argv, but gets it from the global variable main_argv. */
698 static _Noreturn
void
701 if (alternate_editor
)
705 execvp (alternate_editor
, main_argv
+ i
);
706 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
707 progname
, alternate_editor
);
713 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
716 main (int argc
, char **argv
)
720 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
721 "on systems with Berkeley sockets.\n",
726 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
728 #define AUTH_KEY_LENGTH 64
729 #define SEND_BUFFER_SIZE 4096
731 /* Buffer to accumulate data to send in TCP connections. */
732 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
733 int sblen
= 0; /* Fill pointer for the send buffer. */
734 /* Socket used to communicate with the Emacs server process. */
735 HSOCKET emacs_socket
= 0;
737 /* On Windows, the socket library was historically separate from the
738 standard C library, so errors are handled differently. */
741 sock_err_message (const char *function_name
)
746 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
747 | FORMAT_MESSAGE_ALLOCATE_BUFFER
748 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
749 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
751 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
755 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
760 /* Let's send the data to Emacs when either
761 - the data ends in "\n", or
762 - the buffer is full (but this shouldn't happen)
763 Otherwise, we just accumulate it. */
765 send_to_emacs (HSOCKET s
, const char *data
)
772 dlen
= strlen (data
);
775 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
776 memcpy (&send_buffer
[sblen
], data
, part
);
780 if (sblen
== SEND_BUFFER_SIZE
781 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
783 int sent
= send (s
, send_buffer
, sblen
, 0);
786 message (TRUE
, "%s: failed to send %d bytes to socket: %s\n",
787 progname
, sblen
, strerror (errno
));
791 memmove (send_buffer
, &send_buffer
[sent
], sblen
- 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
, const char *str
)
808 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
830 if (*p
== '&' || (*p
== '-' && p
== str
))
837 send_to_emacs (s
, copy
);
843 /* The inverse of quote_argument. Removes quoting in string STR by
844 modifying the string in place. Returns STR. */
847 unquote_argument (char *str
)
878 file_name_absolute_p (const char *filename
)
880 /* Sanity check, it shouldn't happen. */
881 if (! filename
) return FALSE
;
883 /* /xxx is always an absolute path. */
884 if (filename
[0] == '/') return TRUE
;
886 /* Empty filenames (which shouldn't happen) are relative. */
887 if (filename
[0] == '\0') return FALSE
;
890 /* X:\xxx is always absolute. */
891 if (isalpha ((unsigned char) filename
[0])
892 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
895 /* Both \xxx and \\xxx\yyy are absolute. */
896 if (filename
[0] == '\\') return TRUE
;
903 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
910 /* Initialize the WinSock2 library. */
912 initialize_sockets (void)
916 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
918 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
922 atexit (close_winsock
);
924 #endif /* WINDOWSNT */
927 /* Read the information needed to set up a TCP comm channel with
928 the Emacs server: host, port, and authentication string. */
931 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
932 char *authentication
)
938 if (file_name_absolute_p (config_file
))
939 config
= fopen (config_file
, "rb");
942 const char *home
= egetenv ("HOME");
946 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
949 strcat (path
, "/.emacs.d/server/");
950 strcat (path
, config_file
);
951 config
= fopen (path
, "rb");
955 if (!config
&& (home
= egetenv ("APPDATA")))
957 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
960 strcat (path
, "/.emacs.d/server/");
961 strcat (path
, config_file
);
962 config
= fopen (path
, "rb");
971 if (fgets (dotted
, sizeof dotted
, config
)
972 && (port
= strchr (dotted
, ':')))
976 message (TRUE
, "%s: invalid configuration info\n", progname
);
980 server
->sin_family
= AF_INET
;
981 server
->sin_addr
.s_addr
= inet_addr (dotted
);
982 server
->sin_port
= htons (atoi (port
));
984 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
986 message (TRUE
, "%s: cannot read authentication info\n", progname
);
996 set_tcp_socket (const char *local_server_file
)
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 (local_server_file
, &server
, auth_string
))
1004 return INVALID_SOCKET
;
1006 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1007 message (FALSE
, "%s: connected to remote socket at %s\n",
1008 progname
, inet_ntoa (server
.sin_addr
));
1010 /* Open up an AF_INET socket. */
1011 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1013 sock_err_message ("socket");
1014 return INVALID_SOCKET
;
1017 /* Set up the socket. */
1018 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1020 sock_err_message ("connect");
1021 return INVALID_SOCKET
;
1024 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1026 /* Send the authentication. */
1027 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1029 send_to_emacs (s
, "-auth ");
1030 send_to_emacs (s
, auth_string
);
1031 send_to_emacs (s
, " ");
1037 /* Returns 1 if PREFIX is a prefix of STRING. */
1039 strprefix (const char *prefix
, const char *string
)
1041 return !strncmp (prefix
, string
, strlen (prefix
));
1044 /* Get tty name and type. If successful, return the type in TTY_TYPE
1045 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1046 is zero, or return 0 if NOABORT is non-zero. */
1049 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1051 const char *type
= egetenv ("TERM");
1052 const char *name
= ttyname (fileno (stdout
));
1060 message (TRUE
, "%s: could not get terminal name\n", progname
);
1071 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1077 if (strcmp (type
, "eterm") == 0)
1083 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1084 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1085 " is not supported\n", progname
);
1096 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1098 /* Three possibilities:
1099 2 - can't be `stat'ed (sets errno)
1100 1 - isn't owned by us
1101 0 - success: none of the above */
1104 socket_status (const char *name
)
1106 struct stat statbfr
;
1108 if (stat (name
, &statbfr
) == -1)
1111 if (statbfr
.st_uid
!= geteuid ())
1118 /* A signal handler that passes the signal to the Emacs process.
1119 Useful for SIGWINCH. */
1122 pass_signal_to_emacs (int signalnum
)
1124 int old_errno
= errno
;
1127 kill (emacs_pid
, signalnum
);
1129 signal (signalnum
, pass_signal_to_emacs
);
1133 /* Signal handler for SIGCONT; notify the Emacs process that it can
1134 now resume our tty frame. */
1137 handle_sigcont (int signalnum
)
1139 int old_errno
= errno
;
1141 if (tcgetpgrp (1) == getpgrp ())
1143 /* We are in the foreground. */
1144 send_to_emacs (emacs_socket
, "-resume \n");
1148 /* We are in the background; cancel the continue. */
1149 kill (getpid (), SIGSTOP
);
1152 signal (signalnum
, handle_sigcont
);
1156 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1157 going to sleep. Normally the suspend is initiated by Emacs via
1158 server-handle-suspend-tty, but if the server gets out of sync with
1159 reality, we may get a SIGTSTP on C-z. Handling this signal and
1160 notifying Emacs about it should get things under control again. */
1163 handle_sigtstp (int signalnum
)
1165 int old_errno
= errno
;
1169 send_to_emacs (emacs_socket
, "-suspend \n");
1171 /* Unblock this signal and call the default handler by temporarily
1172 changing the handler and resignaling. */
1173 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1174 sigdelset (&set
, signalnum
);
1175 signal (signalnum
, SIG_DFL
);
1176 kill (getpid (), signalnum
);
1177 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1178 signal (signalnum
, handle_sigtstp
);
1184 /* Set up signal handlers before opening a frame on the current tty. */
1189 /* Set up signal handlers. */
1190 signal (SIGWINCH
, pass_signal_to_emacs
);
1192 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1193 deciding which terminal the signal came from. C-g is now a
1194 normal input event on secondary terminals. */
1196 signal (SIGINT
, pass_signal_to_emacs
);
1197 signal (SIGQUIT
, pass_signal_to_emacs
);
1200 signal (SIGCONT
, handle_sigcont
);
1201 signal (SIGTSTP
, handle_sigtstp
);
1202 signal (SIGTTOU
, handle_sigtstp
);
1207 set_local_socket (const char *local_socket_name
)
1210 struct sockaddr_un server
;
1212 /* Open up an AF_UNIX socket in this person's home directory. */
1213 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1215 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1216 return INVALID_SOCKET
;
1219 server
.sun_family
= AF_UNIX
;
1225 const char *server_name
= local_socket_name
;
1226 const char *tmpdir
IF_LINT ( = NULL
);
1227 char *tmpdir_storage
= NULL
;
1228 char *socket_name_storage
= NULL
;
1230 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1232 /* socket_name is a file name component. */
1233 long uid
= geteuid ();
1234 ptrdiff_t tmpdirlen
;
1236 tmpdir
= egetenv ("TMPDIR");
1240 #ifndef _CS_DARWIN_USER_TEMP_DIR
1241 #define _CS_DARWIN_USER_TEMP_DIR 65537
1243 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1246 tmpdir
= tmpdir_storage
= xmalloc (n
);
1247 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1253 tmpdirlen
= strlen (tmpdir
);
1254 socket_name_storage
=
1255 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1256 strcpy (socket_name_storage
, tmpdir
);
1257 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1258 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1259 local_socket_name
= socket_name_storage
;
1262 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1263 strcpy (server
.sun_path
, local_socket_name
);
1266 message (TRUE
, "%s: socket-name %s too long\n",
1267 progname
, local_socket_name
);
1271 /* See if the socket exists, and if it's owned by us. */
1272 sock_status
= socket_status (server
.sun_path
);
1273 saved_errno
= errno
;
1274 if (sock_status
&& use_tmpdir
)
1276 /* Failing that, see if LOGNAME or USER exist and differ from
1277 our euid. If so, look for a socket based on the UID
1278 associated with the name. This is reminiscent of the logic
1279 that init_editfns uses to set the global Vuser_full_name. */
1281 const char *user_name
= egetenv ("LOGNAME");
1284 user_name
= egetenv ("USER");
1288 struct passwd
*pw
= getpwnam (user_name
);
1290 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1292 /* We're running under su, apparently. */
1293 long uid
= pw
->pw_uid
;
1294 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1295 char *user_socket_name
1296 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1297 strcpy (user_socket_name
, tmpdir
);
1298 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1299 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1301 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1302 strcpy (server
.sun_path
, user_socket_name
);
1305 message (TRUE
, "%s: socket-name %s too long\n",
1306 progname
, user_socket_name
);
1307 exit (EXIT_FAILURE
);
1309 free (user_socket_name
);
1311 sock_status
= socket_status (server
.sun_path
);
1312 saved_errno
= errno
;
1315 errno
= saved_errno
;
1319 free (socket_name_storage
);
1320 free (tmpdir_storage
);
1322 switch (sock_status
)
1325 /* There's a socket, but it isn't owned by us. This is OK if
1327 if (0 != geteuid ())
1329 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1330 return INVALID_SOCKET
;
1336 if (saved_errno
== ENOENT
)
1338 "%s: can't find socket; have you started the server?\n\
1339 To start the server in Emacs, type \"M-x server-start\".\n",
1342 message (TRUE
, "%s: can't stat %s: %s\n",
1343 progname
, server
.sun_path
, strerror (saved_errno
));
1344 return INVALID_SOCKET
;
1348 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1351 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1352 return INVALID_SOCKET
;
1357 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1360 set_socket (int no_exit_if_error
)
1363 const char *local_server_file
= server_file
;
1367 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1368 /* Explicit --socket-name argument. */
1371 s
= set_local_socket (socket_name
);
1372 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1374 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1375 progname
, socket_name
);
1376 exit (EXIT_FAILURE
);
1380 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1381 if (!local_server_file
)
1382 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1384 if (local_server_file
)
1386 s
= set_tcp_socket (local_server_file
);
1387 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1390 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1391 progname
, local_server_file
);
1392 exit (EXIT_FAILURE
);
1395 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1396 /* Implicit local socket. */
1397 s
= set_local_socket ("server");
1398 if (s
!= INVALID_SOCKET
)
1402 /* Implicit server file. */
1403 s
= set_tcp_socket ("server");
1404 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1407 /* No implicit or explicit socket, and no alternate editor. */
1408 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1409 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1412 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1413 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1415 exit (EXIT_FAILURE
);
1419 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1420 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1423 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1428 /* Reject any window not of class "Emacs". */
1429 if (! get_wc (hWnd
, class, sizeof (class))
1430 || strcmp (class, "Emacs"))
1433 /* We only need the process id, not the thread id. */
1434 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1436 /* Not the one we're looking for. */
1437 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1439 /* OK, let's raise it. */
1442 /* Stop enumeration. */
1446 /* Search for a window of class "Emacs" and owned by a process with
1447 process id = emacs_pid. If found, allow it to grab the focus. */
1450 w32_give_focus (void)
1454 /* It shouldn't happen when dealing with TCP sockets. */
1455 if (!emacs_pid
) return;
1457 user32
= GetModuleHandle ("user32.dll");
1462 /* Modern Windows restrict which processes can set the foreground window.
1463 emacsclient can allow Emacs to grab the focus by calling the function
1464 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1465 NT) lack this function, so we have to check its availability. */
1466 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1467 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1468 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1472 /* Start the emacs daemon and try to connect to it. */
1475 start_daemon_and_retry_set_socket (void)
1486 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1488 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1490 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1491 exit (EXIT_FAILURE
);
1494 /* Try connecting, the daemon should have started by now. */
1495 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1496 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1498 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1499 exit (EXIT_FAILURE
);
1504 fprintf (stderr
, "Error: Cannot fork!\n");
1505 exit (EXIT_FAILURE
);
1509 char emacs
[] = "emacs";
1510 char daemon_option
[] = "--daemon";
1511 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1512 if (socket_name
!= NULL
)
1514 /* Pass --daemon=socket_name as argument. */
1515 const char *deq
= "--daemon=";
1516 char *daemon_arg
= xmalloc (strlen (deq
)
1517 + strlen (socket_name
) + 1);
1518 strcpy (daemon_arg
, deq
);
1519 strcat (daemon_arg
, socket_name
);
1520 d_argv
[1] = daemon_arg
;
1522 execvp ("emacs", d_argv
);
1523 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1525 #endif /* WINDOWSNT */
1529 main (int argc
, char **argv
)
1531 int rl
= 0, needlf
= 0;
1533 char string
[BUFSIZ
+1];
1534 int start_daemon_if_needed
;
1535 int exit_status
= EXIT_SUCCESS
;
1541 /* On Windows 7 and later, we need to explicitly associate emacsclient
1542 with emacs so the UI behaves sensibly. */
1543 w32_set_user_model_id ();
1546 /* Process options. */
1547 decode_options (argc
, argv
);
1549 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1551 message (TRUE
, "%s: file name or argument required\n"
1552 "Try `%s --help' for more information\n",
1553 progname
, progname
);
1554 exit (EXIT_FAILURE
);
1557 /* If alternate_editor is the empty string, start the emacs daemon
1558 in case of failure to connect. */
1559 start_daemon_if_needed
= (alternate_editor
1560 && (alternate_editor
[0] == '\0'));
1562 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1563 if (emacs_socket
== INVALID_SOCKET
)
1565 if (! start_daemon_if_needed
)
1568 start_daemon_and_retry_set_socket ();
1571 cwd
= get_current_dir_name ();
1574 /* getwd puts message in STRING if it fails. */
1575 message (TRUE
, "%s: %s\n", progname
,
1576 "Cannot get current working directory");
1584 /* Send over our environment and current directory. */
1588 for (i
= 0; environ
[i
]; i
++)
1590 send_to_emacs (emacs_socket
, "-env ");
1591 quote_argument (emacs_socket
, environ
[i
]);
1592 send_to_emacs (emacs_socket
, " ");
1595 send_to_emacs (emacs_socket
, "-dir ");
1596 quote_argument (emacs_socket
, cwd
);
1597 send_to_emacs (emacs_socket
, "/");
1598 send_to_emacs (emacs_socket
, " ");
1602 send_to_emacs (emacs_socket
, "-nowait ");
1605 send_to_emacs (emacs_socket
, "-current-frame ");
1609 send_to_emacs (emacs_socket
, "-display ");
1610 quote_argument (emacs_socket
, display
);
1611 send_to_emacs (emacs_socket
, " ");
1616 send_to_emacs (emacs_socket
, "-parent-id ");
1617 quote_argument (emacs_socket
, parent_id
);
1618 send_to_emacs (emacs_socket
, " ");
1621 if (frame_parameters
&& !current_frame
)
1623 send_to_emacs (emacs_socket
, "-frame-parameters ");
1624 quote_argument (emacs_socket
, frame_parameters
);
1625 send_to_emacs (emacs_socket
, " ");
1628 /* Unless we are certain we don't want to occupy the tty, send our
1629 tty information to Emacs. For example, in daemon mode Emacs may
1630 need to occupy this tty if no other frame is available. */
1631 if (!current_frame
|| !eval
)
1633 const char *tty_type
, *tty_name
;
1635 if (find_tty (&tty_type
, &tty_name
, !tty
))
1637 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1640 send_to_emacs (emacs_socket
, "-tty ");
1641 quote_argument (emacs_socket
, tty_name
);
1642 send_to_emacs (emacs_socket
, " ");
1643 quote_argument (emacs_socket
, tty_type
);
1644 send_to_emacs (emacs_socket
, " ");
1648 if (!current_frame
&& !tty
)
1649 send_to_emacs (emacs_socket
, "-window-system ");
1651 if ((argc
- optind
> 0))
1654 for (i
= optind
; i
< argc
; i
++)
1659 /* Don't prepend cwd or anything like that. */
1660 send_to_emacs (emacs_socket
, "-eval ");
1661 quote_argument (emacs_socket
, argv
[i
]);
1662 send_to_emacs (emacs_socket
, " ");
1666 if (*argv
[i
] == '+')
1668 char *p
= argv
[i
] + 1;
1669 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1672 send_to_emacs (emacs_socket
, "-position ");
1673 quote_argument (emacs_socket
, argv
[i
]);
1674 send_to_emacs (emacs_socket
, " ");
1679 else if (! file_name_absolute_p (argv
[i
])
1680 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1681 /* Windows can have a different default directory for each
1682 drive, so the cwd passed via "-dir" is not sufficient
1683 to account for that.
1684 If the user uses <drive>:<relpath>, we hence need to be
1685 careful to expand <relpath> with the default directory
1686 corresponding to <drive>. */
1688 char *filename
= (char *) xmalloc (MAX_PATH
);
1691 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1692 if (size
> 0 && size
< MAX_PATH
)
1699 send_to_emacs (emacs_socket
, "-file ");
1700 quote_argument (emacs_socket
, argv
[i
]);
1701 send_to_emacs (emacs_socket
, " ");
1706 /* Read expressions interactively. */
1707 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1709 send_to_emacs (emacs_socket
, "-eval ");
1710 quote_argument (emacs_socket
, str
);
1712 send_to_emacs (emacs_socket
, " ");
1715 send_to_emacs (emacs_socket
, "\n");
1717 /* Wait for an answer. */
1718 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1720 printf ("Waiting for Emacs...");
1726 /* Now, wait for an answer and print any messages. */
1727 while (exit_status
== EXIT_SUCCESS
)
1733 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1735 /* If we receive a signal (e.g. SIGWINCH, which we pass
1736 through to Emacs), on some OSes we get EINTR and must retry. */
1737 while (rl
< 0 && errno
== EINTR
);
1744 /* Loop over all NL-terminated messages. */
1745 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1747 end_p
= strchr (p
, '\n');
1751 if (strprefix ("-emacs-pid ", p
))
1753 /* -emacs-pid PID: The process id of the Emacs process. */
1754 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1756 else if (strprefix ("-window-system-unsupported ", p
))
1758 /* -window-system-unsupported: Emacs was compiled without X
1759 support. Try again on the terminal. */
1764 else if (strprefix ("-print ", p
))
1766 /* -print STRING: Print STRING on the terminal. */
1767 str
= unquote_argument (p
+ strlen ("-print "));
1771 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1773 else if (strprefix ("-print-nonl ", p
))
1775 /* -print-nonl STRING: Print STRING on the terminal.
1776 Used to continue a preceding -print command. */
1777 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1779 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1781 else if (strprefix ("-error ", p
))
1783 /* -error DESCRIPTION: Signal an error on the terminal. */
1784 str
= unquote_argument (p
+ strlen ("-error "));
1787 fprintf (stderr
, "*ERROR*: %s", str
);
1788 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1789 exit_status
= EXIT_FAILURE
;
1792 else if (strprefix ("-suspend ", p
))
1794 /* -suspend: Suspend this terminal, i.e., stop the process. */
1803 /* Unknown command. */
1807 printf ("*ERROR*: Unknown message: %s\n", p
);
1818 exit_status
= EXIT_FAILURE
;
1820 CLOSE_SOCKET (emacs_socket
);
1824 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */