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 (), *getwd ();
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 () 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. */
190 long *result
= (long *) malloc (size
);
199 /* Like strdup but get a fatal error if memory is exhausted. */
202 xstrdup (const char *s
)
204 char *result
= strdup (s
);
214 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
217 #ifndef DIRECTORY_SEP
218 #define DIRECTORY_SEP '/'
220 #ifndef IS_DIRECTORY_SEP
221 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
223 #ifndef IS_DEVICE_SEP
225 #define IS_DEVICE_SEP(_c_) 0
227 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
231 #define IS_ANY_SEP(_c_) (IS_DIRECTORY_SEP (_c_))
235 /* Return the current working directory. Returns NULL on errors.
236 Any other returned value must be freed with free. This is used
237 only when get_current_dir_name is not defined on the system. */
239 get_current_dir_name ()
243 struct stat dotstat
, pwdstat
;
244 /* If PWD is accurate, use it instead of calling getwd. PWD is
245 sometimes a nicer name, and using it may avoid a fatal error if a
246 parent directory is searchable but not readable. */
247 if ((pwd
= egetenv ("PWD")) != 0
248 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
249 && stat (pwd
, &pwdstat
) == 0
250 && stat (".", &dotstat
) == 0
251 && dotstat
.st_ino
== pwdstat
.st_ino
252 && dotstat
.st_dev
== pwdstat
.st_dev
254 && strlen (pwd
) < MAXPATHLEN
258 buf
= (char *) xmalloc (strlen (pwd
) + 1);
266 size_t buf_size
= 1024;
267 buf
= (char *) xmalloc (buf_size
);
272 if (getcwd (buf
, buf_size
) == buf
)
276 int tmp_errno
= errno
;
282 buf
= (char *) realloc (buf
, buf_size
);
290 /* We need MAXPATHLEN here. */
291 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
294 if (getwd (buf
) == NULL
)
296 int tmp_errno
= errno
;
309 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
311 /* Retrieve an environment variable from the Emacs subkeys of the registry.
312 Return NULL if the variable was not found, or it was empty.
313 This code is based on w32_get_resource (w32.c). */
315 w32_get_resource (predefined
, key
, type
)
320 HKEY hrootkey
= NULL
;
324 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
326 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
328 result
= (char *) xmalloc (cbData
);
330 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
338 RegCloseKey (hrootkey
);
345 getenv wrapper for Windows
347 This is needed to duplicate Emacs's behavior, which is to look for environment
348 variables in the registry if they don't appear in the environment.
357 if (value
= getenv (envvar
))
358 /* Found in the environment. */
361 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
362 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
364 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
365 if (strcmp (envvar
, "TERM") == 0)
366 return xstrdup ("w32console");
367 /* Found neither in the environment nor in the registry. */
371 if (dwType
== REG_SZ
)
372 /* Registry; no need to expand. */
375 if (dwType
== REG_EXPAND_SZ
)
379 if (size
= ExpandEnvironmentStrings (value
, NULL
, 0))
381 char *buffer
= (char *) xmalloc (size
);
382 if (ExpandEnvironmentStrings (value
, buffer
, size
))
384 /* Found and expanded. */
389 /* Error expanding. */
394 /* Not the right type, or not correctly expanded. */
400 w32_set_user_model_id ()
403 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
405 /* On Windows 7 and later, we need to set the user model ID
406 to associate emacsclient launched files with Emacs frames
408 shell
= LoadLibrary("shell32.dll");
412 = (void *) GetProcAddress (shell
,
413 "SetCurrentProcessExplicitAppUserModelID");
414 /* If the function is defined, then we are running on Windows 7
415 or newer, and the UI uses this to group related windows
416 together. Since emacs, runemacs, emacsclient are related, we
417 want them grouped even though the executables are different,
418 so we need to set a consistent ID between them. */
420 set_user_model (L
"GNU.Emacs");
429 static int window_app
= -1;
430 char szTitle
[MAX_PATH
];
434 /* Checking for STDOUT does not work; it's a valid handle also in
435 nonconsole apps. Testing for the console title seems to work. */
436 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
438 InitCommonControls();
445 execvp wrapper for Windows. Quotes arguments with embedded spaces.
447 This is necessary due to the broken implementation of exec* routines in
448 the Microsoft libraries: they concatenate the arguments together without
449 quoting special characters, and pass the result to CreateProcess, with
450 predictably bad results. By contrast, Posix execvp passes the arguments
451 directly into the argv array of the child process.
454 w32_execvp (path
, argv
)
460 /* Required to allow a .BAT script as alternate editor. */
461 argv
[0] = (char *) alternate_editor
;
463 for (i
= 0; argv
[i
]; i
++)
464 if (strchr (argv
[i
], ' '))
466 char *quoted
= alloca (strlen (argv
[i
]) + 3);
467 sprintf (quoted
, "\"%s\"", argv
[i
]);
471 return execvp (path
, argv
);
475 #define execvp w32_execvp
477 /* Emulation of ttyname for Windows. */
484 #endif /* WINDOWSNT */
486 /* Display a normal or error message.
487 On Windows, use a message box if compiled as a Windows app. */
489 message (int is_error
, char *message
, ...)
494 va_start (args
, message
);
495 vsprintf (msg
, message
, args
);
499 if (w32_window_app ())
502 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
504 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
509 FILE *f
= is_error
? stderr
: stdout
;
516 /* Decode the options from argv and argc.
517 The global variable `optind' will say how many arguments we used up. */
520 decode_options (argc
, argv
)
524 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
528 int opt
= getopt_long_only (argc
, argv
,
529 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
542 /* If getopt returns 0, then it has already processed a
543 long-named option. We should do nothing. */
547 alternate_editor
= optarg
;
550 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
552 socket_name
= optarg
;
557 server_file
= optarg
;
560 /* We used to disallow this argument in w32, but it seems better
561 to allow it, for the occasional case where the user is
562 connecting with a w32 client to a server compiled with X11
577 message (FALSE
, "emacsclient %s\n", VERSION
);
596 print_help_and_exit ();
600 message (TRUE
, "Try `%s --help' for more information\n", progname
);
606 /* If the -c option is used (without -t) and no --display argument
607 is provided, try $DISPLAY.
608 Without the -c option, we used to set `display' to $DISPLAY by
609 default, but this changed the default behavior and is sometimes
610 inconvenient. So we force users to use "--display $DISPLAY" if
611 they want Emacs to connect to their current display. */
612 if (!current_frame
&& !tty
&& !display
)
614 display
= egetenv ("DISPLAY");
616 /* Under Cocoa, we don't really use displays the same way as in X,
617 so provide a dummy. */
618 if (!display
|| strlen (display
) == 0)
623 /* A null-string display is invalid. */
624 if (display
&& strlen (display
) == 0)
627 /* If no display is available, new frames are tty frames. */
628 if (!current_frame
&& !display
)
631 /* --no-wait implies --current-frame on ttys when there are file
632 arguments or expressions given. */
633 if (nowait
&& tty
&& argc
- optind
> 0)
637 if (alternate_editor
&& alternate_editor
[0] == '\0')
639 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
643 #endif /* WINDOWSNT */
648 print_help_and_exit ()
650 /* Spaces and tabs are significant in this message; they're chosen so the
651 message aligns properly both in a tty and in a Windows message box.
652 Please try to preserve them; otherwise the output is very hard to read
653 when using emacsclientw. */
655 "Usage: %s [OPTIONS] FILE...\n\
656 Tell the Emacs server to visit the specified files.\n\
657 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
659 The following OPTIONS are accepted:\n\
660 -V, --version Just print version info and return\n\
661 -H, --help Print this usage information message\n\
662 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
663 -c, --create-frame Create a new frame instead of trying to\n\
664 use the current Emacs frame\n\
665 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
666 -n, --no-wait Don't wait for the server to return\n\
667 -d DISPLAY, --display=DISPLAY\n\
668 Visit the file in the given display\n\
669 --parent-id=ID Open in parent window ID, via XEmbed\n"
670 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
671 "-s SOCKET, --socket-name=SOCKET\n\
672 Set filename of the UNIX socket for communication\n"
674 "-f SERVER, --server-file=SERVER\n\
675 Set filename of the TCP authentication file\n\
676 -a EDITOR, --alternate-editor=EDITOR\n\
677 Editor to fallback to if the server is not running\n"
679 " If EDITOR is the empty string, start Emacs in daemon\n\
680 mode and try connecting again\n"
681 #endif /* not WINDOWSNT */
683 Report bugs with M-x report-emacs-bug.\n", progname
);
688 Try to run a different command, or --if no alternate editor is
689 defined-- exit with an errorcode.
690 Uses argv, but gets it from the global variable main_argv.
695 if (alternate_editor
)
699 execvp (alternate_editor
, main_argv
+ i
);
700 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
701 progname
, alternate_editor
);
707 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
716 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
717 "on systems with Berkeley sockets.\n",
722 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
725 # include <winsock2.h>
727 # include <sys/types.h>
728 # include <sys/socket.h>
732 #define AUTH_KEY_LENGTH 64
733 #define SEND_BUFFER_SIZE 4096
735 extern char *strerror ();
737 /* Buffer to accumulate data to send in TCP connections. */
738 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
739 int sblen
= 0; /* Fill pointer for the send buffer. */
740 /* Socket used to communicate with the Emacs server process. */
741 HSOCKET emacs_socket
= 0;
743 /* On Windows, the socket library was historically separate from the standard
744 C library, so errors are handled differently. */
746 sock_err_message (function_name
)
752 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
753 | FORMAT_MESSAGE_ALLOCATE_BUFFER
754 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
755 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
757 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
761 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
766 /* Let's send the data to Emacs when either
767 - the data ends in "\n", or
768 - the buffer is full (but this shouldn't happen)
769 Otherwise, we just accumulate it. */
771 send_to_emacs (s
, data
)
777 int dlen
= strlen (data
);
778 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
780 int part
= SEND_BUFFER_SIZE
- sblen
;
781 strncpy (&send_buffer
[sblen
], data
, part
);
783 sblen
= SEND_BUFFER_SIZE
;
787 strcpy (&send_buffer
[sblen
], data
);
794 if (sblen
== SEND_BUFFER_SIZE
795 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
797 int sent
= send (s
, send_buffer
, sblen
, 0);
799 strcpy (send_buffer
, &send_buffer
[sent
]);
806 /* In STR, insert a & before each &, each space, each newline, and
807 any initial -. Change spaces to underscores, too, so that the
808 return value never contains a space.
810 Does not change the string. Outputs the result to STREAM. */
812 quote_argument (s
, str
)
816 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
837 if (*p
== '&' || (*p
== '-' && p
== str
))
844 send_to_emacs (s
, copy
);
850 /* The inverse of quote_argument. Removes quoting in string STR by
851 modifying the string in place. Returns STR. */
854 unquote_argument (str
)
886 file_name_absolute_p (filename
)
887 const unsigned char *filename
;
889 /* Sanity check, it shouldn't happen. */
890 if (! filename
) return FALSE
;
892 /* /xxx is always an absolute path. */
893 if (filename
[0] == '/') return TRUE
;
895 /* Empty filenames (which shouldn't happen) are relative. */
896 if (filename
[0] == '\0') return FALSE
;
899 /* X:\xxx is always absolute. */
900 if (isalpha (filename
[0])
901 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
904 /* Both \xxx and \\xxx\yyy are absolute. */
905 if (filename
[0] == '\\') return TRUE
;
912 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
914 __cdecl
close_winsock ()
919 /* Initialize the WinSock2 library. */
921 initialize_sockets ()
925 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
927 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
931 atexit (close_winsock
);
933 #endif /* WINDOWSNT */
937 * Read the information needed to set up a TCP comm channel with
938 * the Emacs server: host, port, pid and authentication string.
941 get_server_config (server
, authentication
)
942 struct sockaddr_in
*server
;
943 char *authentication
;
950 if (file_name_absolute_p (server_file
))
951 config
= fopen (server_file
, "rb");
954 char *home
= egetenv ("HOME");
958 char *path
= alloca (strlen (home
) + strlen (server_file
)
960 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
961 config
= fopen (path
, "rb");
964 if (!config
&& (home
= egetenv ("APPDATA")))
966 char *path
= alloca (strlen (home
) + strlen (server_file
)
968 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
969 config
= fopen (path
, "rb");
977 if (fgets (dotted
, sizeof dotted
, config
)
978 && (port
= strchr (dotted
, ':'))
979 && (pid
= strchr (port
, ' ')))
986 message (TRUE
, "%s: invalid configuration info\n", progname
);
990 server
->sin_family
= AF_INET
;
991 server
->sin_addr
.s_addr
= inet_addr (dotted
);
992 server
->sin_port
= htons (atoi (port
));
994 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
996 message (TRUE
, "%s: cannot read authentication info\n", progname
);
1002 emacs_pid
= atoi (pid
);
1011 struct sockaddr_in server
;
1012 struct linger l_arg
= {1, 1};
1013 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1015 if (! get_server_config (&server
, auth_string
))
1016 return INVALID_SOCKET
;
1018 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1"))
1019 message (FALSE
, "%s: connected to remote socket at %s\n",
1020 progname
, inet_ntoa (server
.sin_addr
));
1023 * Open up an AF_INET socket
1025 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1027 sock_err_message ("socket");
1028 return INVALID_SOCKET
;
1034 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1036 sock_err_message ("connect");
1037 return INVALID_SOCKET
;
1040 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1043 * Send the authentication
1045 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1047 send_to_emacs (s
, "-auth ");
1048 send_to_emacs (s
, auth_string
);
1049 send_to_emacs (s
, " ");
1055 /* Returns 1 if PREFIX is a prefix of STRING. */
1057 strprefix (char *prefix
, char *string
)
1059 return !strncmp (prefix
, string
, strlen (prefix
));
1062 /* Get tty name and type. If successful, return the type in TTY_TYPE
1063 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1064 is zero, or return 0 if NOABORT is non-zero. */
1067 find_tty (char **tty_type
, char **tty_name
, int noabort
)
1069 char *type
= egetenv ("TERM");
1070 char *name
= ttyname (fileno (stdout
));
1078 message (TRUE
, "%s: could not get terminal name\n", progname
);
1089 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1095 if (strcmp (type
, "eterm") == 0)
1101 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1102 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1103 " is not supported\n", progname
);
1114 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1116 /* Three possibilities:
1117 2 - can't be `stat'ed (sets errno)
1118 1 - isn't owned by us
1119 0 - success: none of the above */
1122 socket_status (socket_name
)
1125 struct stat statbfr
;
1127 if (stat (socket_name
, &statbfr
) == -1)
1130 if (statbfr
.st_uid
!= geteuid ())
1137 /* A signal handler that passes the signal to the Emacs process.
1138 Useful for SIGWINCH. */
1141 pass_signal_to_emacs (int signalnum
)
1143 int old_errno
= errno
;
1146 kill (emacs_pid
, signalnum
);
1148 signal (signalnum
, pass_signal_to_emacs
);
1152 /* Signal handler for SIGCONT; notify the Emacs process that it can
1153 now resume our tty frame. */
1156 handle_sigcont (int signalnum
)
1158 int old_errno
= errno
;
1160 if (tcgetpgrp (1) == getpgrp ())
1162 /* We are in the foreground. */
1163 send_to_emacs (emacs_socket
, "-resume \n");
1167 /* We are in the background; cancel the continue. */
1168 kill (getpid (), SIGSTOP
);
1171 signal (signalnum
, handle_sigcont
);
1175 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1176 going to sleep. Normally the suspend is initiated by Emacs via
1177 server-handle-suspend-tty, but if the server gets out of sync with
1178 reality, we may get a SIGTSTP on C-z. Handling this signal and
1179 notifying Emacs about it should get things under control again. */
1182 handle_sigtstp (int signalnum
)
1184 int old_errno
= errno
;
1188 send_to_emacs (emacs_socket
, "-suspend \n");
1190 /* Unblock this signal and call the default handler by temporarily
1191 changing the handler and resignalling. */
1192 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1193 sigdelset (&set
, signalnum
);
1194 signal (signalnum
, SIG_DFL
);
1195 kill (getpid (), signalnum
);
1196 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1197 signal (signalnum
, handle_sigtstp
);
1203 /* Set up signal handlers before opening a frame on the current tty. */
1208 /* Set up signal handlers. */
1209 signal (SIGWINCH
, pass_signal_to_emacs
);
1211 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1212 deciding which terminal the signal came from. C-g is now a
1213 normal input event on secondary terminals. */
1215 signal (SIGINT
, pass_signal_to_emacs
);
1216 signal (SIGQUIT
, pass_signal_to_emacs
);
1219 signal (SIGCONT
, handle_sigcont
);
1220 signal (SIGTSTP
, handle_sigtstp
);
1221 signal (SIGTTOU
, handle_sigtstp
);
1229 struct sockaddr_un server
;
1232 * Open up an AF_UNIX socket in this person's home directory
1235 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1237 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1238 return INVALID_SOCKET
;
1241 server
.sun_family
= AF_UNIX
;
1244 int sock_status
= 0;
1245 int default_sock
= !socket_name
;
1246 int saved_errno
= 0;
1247 char *server_name
= "server";
1250 if (socket_name
&& !index (socket_name
, '/') && !index (socket_name
, '\\'))
1251 { /* socket_name is a file name component. */
1252 server_name
= socket_name
;
1254 default_sock
= 1; /* Try both UIDs. */
1259 tmpdir
= egetenv ("TMPDIR");
1262 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1264 sprintf (socket_name
, "%s/emacs%d/%s",
1265 tmpdir
, (int) geteuid (), server_name
);
1268 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1269 strcpy (server
.sun_path
, socket_name
);
1272 message (TRUE
, "%s: socket-name %s too long\n",
1273 progname
, socket_name
);
1277 /* See if the socket exists, and if it's owned by us. */
1278 sock_status
= socket_status (server
.sun_path
);
1279 saved_errno
= errno
;
1280 if (sock_status
&& default_sock
)
1282 /* Failing that, see if LOGNAME or USER exist and differ from
1283 our euid. If so, look for a socket based on the UID
1284 associated with the name. This is reminiscent of the logic
1285 that init_editfns uses to set the global Vuser_full_name. */
1287 char *user_name
= (char *) egetenv ("LOGNAME");
1290 user_name
= (char *) egetenv ("USER");
1294 struct passwd
*pw
= getpwnam (user_name
);
1296 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1298 /* We're running under su, apparently. */
1299 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1301 sprintf (socket_name
, "%s/emacs%d/%s",
1302 tmpdir
, (int) pw
->pw_uid
, server_name
);
1304 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1305 strcpy (server
.sun_path
, socket_name
);
1308 message (TRUE
, "%s: socket-name %s too long\n",
1309 progname
, socket_name
);
1310 exit (EXIT_FAILURE
);
1313 sock_status
= socket_status (server
.sun_path
);
1314 saved_errno
= errno
;
1317 errno
= saved_errno
;
1321 switch (sock_status
)
1324 /* There's a socket, but it isn't owned by us. This is OK if
1326 if (0 != geteuid ())
1328 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1329 return INVALID_SOCKET
;
1335 if (saved_errno
== ENOENT
)
1337 "%s: can't find socket; have you started the server?\n\
1338 To start the server in Emacs, type \"M-x server-start\".\n",
1341 message (TRUE
, "%s: can't stat %s: %s\n",
1342 progname
, server
.sun_path
, strerror (saved_errno
));
1343 return INVALID_SOCKET
;
1347 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1350 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1351 return INVALID_SOCKET
;
1356 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1359 set_socket (int no_exit_if_error
)
1365 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1366 /* Explicit --socket-name argument. */
1369 s
= set_local_socket ();
1370 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1372 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1373 progname
, socket_name
);
1374 exit (EXIT_FAILURE
);
1378 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1380 server_file
= egetenv ("EMACS_SERVER_FILE");
1384 s
= set_tcp_socket ();
1385 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1388 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1389 progname
, server_file
);
1390 exit (EXIT_FAILURE
);
1393 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1394 /* Implicit local socket. */
1395 s
= set_local_socket ();
1396 if (s
!= INVALID_SOCKET
)
1400 /* Implicit server file. */
1401 server_file
= "server";
1402 s
= set_tcp_socket ();
1403 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1406 /* No implicit or explicit socket, and no alternate editor. */
1407 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1408 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1411 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1412 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1414 exit (EXIT_FAILURE
);
1418 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1419 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1422 w32_find_emacs_process (hWnd
, lParam
)
1429 /* Reject any window not of class "Emacs". */
1430 if (! get_wc (hWnd
, class, sizeof (class))
1431 || strcmp (class, "Emacs"))
1434 /* We only need the process id, not the thread id. */
1435 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1437 /* Not the one we're looking for. */
1438 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1440 /* OK, let's raise it. */
1443 /* Stop enumeration. */
1448 * Search for a window of class "Emacs" and owned by a process with
1449 * process id = emacs_pid. If found, allow it to grab the focus.
1456 /* It shouldn't happen when dealing with TCP sockets. */
1457 if (!emacs_pid
) return;
1459 user32
= GetModuleHandle ("user32.dll");
1464 /* Modern Windows restrict which processes can set the foreground window.
1465 emacsclient can allow Emacs to grab the focus by calling the function
1466 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1467 NT) lack this function, so we have to check its availability. */
1468 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1469 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1470 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1474 /* Start the emacs daemon and try to connect to it. */
1477 start_daemon_and_retry_set_socket (void)
1488 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1490 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS(status
))
1492 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1493 exit (EXIT_FAILURE
);
1496 /* Try connecting, the daemon should have started by now. */
1497 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1498 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1500 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1501 exit (EXIT_FAILURE
);
1506 fprintf (stderr
, "Error: Cannot fork!\n");
1511 char *d_argv
[] = {"emacs", "--daemon", 0 };
1512 if (socket_name
!= NULL
)
1514 /* Pass --daemon=socket_name as argument. */
1515 char *deq
= "--daemon=";
1516 char *daemon_arg
= alloca (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 */
1533 int i
, rl
, needlf
= 0;
1535 char string
[BUFSIZ
+1];
1536 int null_socket_name
, null_server_file
, start_daemon_if_needed
;
1542 /* On Windows 7 and later, we need to explicitly associate emacsclient
1543 with emacs so the UI behaves sensibly. */
1544 w32_set_user_model_id ();
1547 /* Process options. */
1548 decode_options (argc
, argv
);
1550 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1552 message (TRUE
, "%s: file name or argument required\n"
1553 "Try `%s --help' for more information\n",
1554 progname
, progname
);
1555 exit (EXIT_FAILURE
);
1558 /* If alternate_editor is the empty string, start the emacs daemon
1559 in case of failure to connect. */
1560 start_daemon_if_needed
= (alternate_editor
1561 && (alternate_editor
[0] == '\0'));
1562 if (start_daemon_if_needed
)
1564 /* set_socket changes the values for socket_name and
1565 server_file, we need to reset them, if they were NULL before
1566 for the second call to set_socket. */
1567 null_socket_name
= (socket_name
== NULL
);
1568 null_server_file
= (server_file
== NULL
);
1571 if ((emacs_socket
= set_socket (alternate_editor
1572 || start_daemon_if_needed
)) == INVALID_SOCKET
)
1573 if (start_daemon_if_needed
)
1575 /* Reset socket_name and server_file if they were NULL
1576 before the set_socket call. */
1577 if (null_socket_name
)
1579 if (null_server_file
)
1582 start_daemon_and_retry_set_socket ();
1587 cwd
= get_current_dir_name ();
1590 /* getwd puts message in STRING if it fails. */
1591 message (TRUE
, "%s: %s\n", progname
,
1592 "Cannot get current working directory");
1600 /* Send over our environment and current directory. */
1603 extern char **environ
;
1605 for (i
= 0; environ
[i
]; i
++)
1607 char *name
= xstrdup (environ
[i
]);
1608 char *value
= strchr (name
, '=');
1609 send_to_emacs (emacs_socket
, "-env ");
1610 quote_argument (emacs_socket
, environ
[i
]);
1611 send_to_emacs (emacs_socket
, " ");
1614 send_to_emacs (emacs_socket
, "-dir ");
1615 quote_argument (emacs_socket
, cwd
);
1616 send_to_emacs (emacs_socket
, "/");
1617 send_to_emacs (emacs_socket
, " ");
1621 send_to_emacs (emacs_socket
, "-nowait ");
1624 send_to_emacs (emacs_socket
, "-current-frame ");
1628 send_to_emacs (emacs_socket
, "-display ");
1629 quote_argument (emacs_socket
, display
);
1630 send_to_emacs (emacs_socket
, " ");
1635 send_to_emacs (emacs_socket
, "-parent-id ");
1636 quote_argument (emacs_socket
, parent_id
);
1637 send_to_emacs (emacs_socket
, " ");
1640 /* If using the current frame, send tty information to Emacs anyway.
1641 In daemon mode, Emacs may need to occupy this tty if no other
1642 frame is available. */
1643 if (tty
|| (current_frame
&& !eval
))
1645 char *tty_type
, *tty_name
;
1647 if (find_tty (&tty_type
, &tty_name
, !tty
))
1649 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1652 send_to_emacs (emacs_socket
, "-tty ");
1653 quote_argument (emacs_socket
, tty_name
);
1654 send_to_emacs (emacs_socket
, " ");
1655 quote_argument (emacs_socket
, tty_type
);
1656 send_to_emacs (emacs_socket
, " ");
1660 if (!current_frame
&& !tty
)
1661 send_to_emacs (emacs_socket
, "-window-system ");
1663 if ((argc
- optind
> 0))
1665 for (i
= optind
; i
< argc
; i
++)
1670 /* Don't prepend cwd or anything like that. */
1671 send_to_emacs (emacs_socket
, "-eval ");
1672 quote_argument (emacs_socket
, argv
[i
]);
1673 send_to_emacs (emacs_socket
, " ");
1677 if (*argv
[i
] == '+')
1679 char *p
= argv
[i
] + 1;
1680 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1683 send_to_emacs (emacs_socket
, "-position ");
1684 quote_argument (emacs_socket
, argv
[i
]);
1685 send_to_emacs (emacs_socket
, " ");
1690 else if (! file_name_absolute_p (argv
[i
])
1691 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1692 /* Windows can have a different default directory for each
1693 drive, so the cwd passed via "-dir" is not sufficient
1694 to account for that.
1695 If the user uses <drive>:<relpath>, we hence need to be
1696 careful to expand <relpath> with the default directory
1697 corresponding to <drive>. */
1699 char *filename
= (char *) xmalloc (MAX_PATH
);
1702 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1703 if (size
> 0 && size
< MAX_PATH
)
1710 send_to_emacs (emacs_socket
, "-file ");
1711 quote_argument (emacs_socket
, argv
[i
]);
1712 send_to_emacs (emacs_socket
, " ");
1717 /* Read expressions interactively. */
1718 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1720 send_to_emacs (emacs_socket
, "-eval ");
1721 quote_argument (emacs_socket
, str
);
1723 send_to_emacs (emacs_socket
, " ");
1726 send_to_emacs (emacs_socket
, "\n");
1728 /* Wait for an answer. */
1729 if (!eval
&& !tty
&& !nowait
)
1731 printf ("Waiting for Emacs...");
1737 /* Now, wait for an answer and print any messages. */
1738 while ((rl
= recv (emacs_socket
, string
, BUFSIZ
, 0)) > 0)
1743 p
= string
+ strlen (string
) - 1;
1744 while (p
> string
&& *p
== '\n')
1747 if (strprefix ("-emacs-pid ", string
))
1749 /* -emacs-pid PID: The process id of the Emacs process. */
1750 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1752 else if (strprefix ("-window-system-unsupported ", string
))
1754 /* -window-system-unsupported: Emacs was compiled without X
1755 support. Try again on the terminal. */
1760 else if (strprefix ("-print ", string
))
1762 /* -print STRING: Print STRING on the terminal. */
1763 str
= unquote_argument (string
+ strlen ("-print "));
1767 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1769 else if (strprefix ("-error ", string
))
1771 /* -error DESCRIPTION: Signal an error on the terminal. */
1772 str
= unquote_argument (string
+ strlen ("-error "));
1775 fprintf (stderr
, "*ERROR*: %s", str
);
1776 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1779 else if (strprefix ("-suspend ", string
))
1781 /* -suspend: Suspend this terminal, i.e., stop the process. */
1790 /* Unknown command. */
1793 printf ("*ERROR*: Unknown message: %s", string
);
1794 needlf
= string
[0] == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1803 CLOSE_SOCKET (emacs_socket
);
1804 return EXIT_SUCCESS
;
1807 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1810 #ifndef HAVE_STRERROR
1815 extern char *sys_errlist
[];
1816 extern int sys_nerr
;
1818 if (errnum
>= 0 && errnum
< sys_nerr
)
1819 return sys_errlist
[errnum
];
1820 return (char *) "Unknown error";
1823 #endif /* ! HAVE_STRERROR */
1825 /* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
1826 (do not change this comment) */
1828 /* emacsclient.c ends here */