1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986-1987, 1994, 1999-2011 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 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 (unsigned int size
)
200 long *result
= (long *) 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);
260 size_t buf_size
= 1024;
261 buf
= (char *) xmalloc (buf_size
);
266 if (getcwd (buf
, buf_size
) == buf
)
270 int tmp_errno
= errno
;
276 buf
= (char *) realloc (buf
, buf_size
);
284 /* We need MAXPATHLEN here. */
285 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
288 if (getwd (buf
) == NULL
)
290 int tmp_errno
= errno
;
303 /* Like strdup but get a fatal error if memory is exhausted. */
306 xstrdup (const char *s
)
308 char *result
= strdup (s
);
317 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
319 /* Retrieve an environment variable from the Emacs subkeys of the registry.
320 Return NULL if the variable was not found, or it was empty.
321 This code is based on w32_get_resource (w32.c). */
323 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
325 HKEY hrootkey
= NULL
;
329 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
331 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
333 result
= (char *) xmalloc (cbData
);
335 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
343 RegCloseKey (hrootkey
);
350 getenv wrapper for Windows
352 Value is allocated on the heap, and can be free'd.
354 This is needed to duplicate Emacs's behavior, which is to look for
355 environment variables in the registry if they don't appear in the
358 w32_getenv (char *envvar
)
363 if (value
= getenv (envvar
))
364 /* Found in the environment. strdup it, because values returned
365 by getenv cannot be free'd. */
366 return xstrdup (value
);
368 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
369 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
371 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
372 if (strcmp (envvar
, "TERM") == 0)
373 return xstrdup ("w32console");
374 /* Found neither in the environment nor in the registry. */
378 if (dwType
== REG_SZ
)
379 /* Registry; no need to expand. */
382 if (dwType
== REG_EXPAND_SZ
)
386 if (size
= ExpandEnvironmentStrings (value
, NULL
, 0))
388 char *buffer
= (char *) xmalloc (size
);
389 if (ExpandEnvironmentStrings (value
, buffer
, size
))
391 /* Found and expanded. */
396 /* Error expanding. */
401 /* Not the right type, or not correctly expanded. */
407 w32_set_user_model_id (void)
410 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
412 /* On Windows 7 and later, we need to set the user model ID
413 to associate emacsclient launched files with Emacs frames
415 shell
= LoadLibrary ("shell32.dll");
419 = (void *) GetProcAddress (shell
,
420 "SetCurrentProcessExplicitAppUserModelID");
421 /* If the function is defined, then we are running on Windows 7
422 or newer, and the UI uses this to group related windows
423 together. Since emacs, runemacs, emacsclient are related, we
424 want them grouped even though the executables are different,
425 so we need to set a consistent ID between them. */
427 set_user_model (L
"GNU.Emacs");
434 w32_window_app (void)
436 static int window_app
= -1;
437 char szTitle
[MAX_PATH
];
441 /* Checking for STDOUT does not work; it's a valid handle also in
442 nonconsole apps. Testing for the console title seems to work. */
443 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
445 InitCommonControls ();
452 execvp wrapper for Windows. Quotes arguments with embedded spaces.
454 This is necessary due to the broken implementation of exec* routines in
455 the Microsoft libraries: they concatenate the arguments together without
456 quoting special characters, and pass the result to CreateProcess, with
457 predictably bad results. By contrast, POSIX execvp passes the arguments
458 directly into the argv array of the child process.
461 w32_execvp (const char *path
, char **argv
)
465 /* Required to allow a .BAT script as alternate editor. */
466 argv
[0] = (char *) alternate_editor
;
468 for (i
= 0; argv
[i
]; i
++)
469 if (strchr (argv
[i
], ' '))
471 char *quoted
= alloca (strlen (argv
[i
]) + 3);
472 sprintf (quoted
, "\"%s\"", argv
[i
]);
476 return execvp (path
, argv
);
480 #define execvp w32_execvp
482 /* Emulation of ttyname for Windows. */
489 #endif /* WINDOWSNT */
491 /* Display a normal or error message.
492 On Windows, use a message box if compiled as a Windows app. */
493 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
495 message (int is_error
, const char *format
, ...)
500 va_start (args
, format
);
501 vsprintf (msg
, format
, args
);
505 if (w32_window_app ())
508 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
510 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
515 FILE *f
= is_error
? stderr
: stdout
;
522 /* Decode the options from argv and argc.
523 The global variable `optind' will say how many arguments we used up. */
526 decode_options (int argc
, char **argv
)
528 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
532 int opt
= getopt_long_only (argc
, argv
,
533 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
546 /* If getopt returns 0, then it has already processed a
547 long-named option. We should do nothing. */
551 alternate_editor
= optarg
;
554 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
556 socket_name
= optarg
;
561 server_file
= optarg
;
564 /* We used to disallow this argument in w32, but it seems better
565 to allow it, for the occasional case where the user is
566 connecting with a w32 client to a server compiled with X11
585 message (FALSE
, "emacsclient %s\n", VERSION
);
604 print_help_and_exit ();
608 frame_parameters
= optarg
;
612 message (TRUE
, "Try `%s --help' for more information\n", progname
);
618 /* If the -c option is used (without -t) and no --display argument
619 is provided, try $DISPLAY.
620 Without the -c option, we used to set `display' to $DISPLAY by
621 default, but this changed the default behavior and is sometimes
622 inconvenient. So we force users to use "--display $DISPLAY" if
623 they want Emacs to connect to their current display. */
624 if (!current_frame
&& !tty
&& !display
)
626 display
= egetenv ("DISPLAY");
628 /* Under Cocoa, we don't really use displays the same way as in X,
629 so provide a dummy. */
630 if (!display
|| strlen (display
) == 0)
635 /* A null-string display is invalid. */
636 if (display
&& strlen (display
) == 0)
639 /* If no display is available, new frames are tty frames. */
640 if (!current_frame
&& !display
)
643 /* --no-wait implies --current-frame on ttys when there are file
644 arguments or expressions given. */
645 if (nowait
&& tty
&& argc
- optind
> 0)
649 if (alternate_editor
&& alternate_editor
[0] == '\0')
651 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
656 /* TTY frames not supported on Windows. Continue using GUI rather than
657 forcing the user to change their command-line. This is required since
658 tty is set above if certain options are given and $DISPLAY is not set,
659 which is not obvious to users. */
663 #endif /* WINDOWSNT */
668 print_help_and_exit (void)
670 /* Spaces and tabs are significant in this message; they're chosen so the
671 message aligns properly both in a tty and in a Windows message box.
672 Please try to preserve them; otherwise the output is very hard to read
673 when using emacsclientw. */
675 "Usage: %s [OPTIONS] FILE...\n\
676 Tell the Emacs server to visit the specified files.\n\
677 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
679 The following OPTIONS are accepted:\n\
680 -V, --version Just print version info and return\n\
681 -H, --help Print this usage information message\n\
682 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
683 -c, --create-frame Create a new frame instead of trying to\n\
684 use the current Emacs frame\n\
685 -F ALIST, --frame-parameters=ALIST\n\
686 Set the parameters of a new frame\n\
687 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
688 -n, --no-wait Don't wait for the server to return\n\
689 -q, --quiet Don't display messages on success\n\
690 -d DISPLAY, --display=DISPLAY\n\
691 Visit the file in the given display\n\
692 --parent-id=ID Open in parent window ID, via XEmbed\n"
693 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
694 "-s SOCKET, --socket-name=SOCKET\n\
695 Set filename of the UNIX socket for communication\n"
697 "-f SERVER, --server-file=SERVER\n\
698 Set filename of the TCP authentication file\n\
699 -a EDITOR, --alternate-editor=EDITOR\n\
700 Editor to fallback to if the server is not running\n"
702 " If EDITOR is the empty string, start Emacs in daemon\n\
703 mode and try connecting again\n"
704 #endif /* not WINDOWSNT */
706 Report bugs with M-x report-emacs-bug.\n", progname
);
711 Try to run a different command, or --if no alternate editor is
712 defined-- exit with an errorcode.
713 Uses argv, but gets it from the global variable main_argv.
718 if (alternate_editor
)
722 execvp (alternate_editor
, main_argv
+ i
);
723 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
724 progname
, alternate_editor
);
730 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
733 main (int argc
, char **argv
)
737 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
738 "on systems with Berkeley sockets.\n",
743 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
745 #define AUTH_KEY_LENGTH 64
746 #define SEND_BUFFER_SIZE 4096
748 extern char *strerror (int);
750 /* Buffer to accumulate data to send in TCP connections. */
751 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
752 int sblen
= 0; /* Fill pointer for the send buffer. */
753 /* Socket used to communicate with the Emacs server process. */
754 HSOCKET emacs_socket
= 0;
756 /* On Windows, the socket library was historically separate from the standard
757 C library, so errors are handled differently. */
759 sock_err_message (const char *function_name
)
764 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
765 | FORMAT_MESSAGE_ALLOCATE_BUFFER
766 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
767 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
769 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
773 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
778 /* Let's send the data to Emacs when either
779 - the data ends in "\n", or
780 - the buffer is full (but this shouldn't happen)
781 Otherwise, we just accumulate it. */
783 send_to_emacs (HSOCKET s
, const char *data
)
787 size_t dlen
= strlen (data
);
788 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
790 int part
= SEND_BUFFER_SIZE
- sblen
;
791 strncpy (&send_buffer
[sblen
], data
, part
);
793 sblen
= SEND_BUFFER_SIZE
;
797 strcpy (&send_buffer
[sblen
], data
);
804 if (sblen
== SEND_BUFFER_SIZE
805 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
807 int sent
= send (s
, send_buffer
, sblen
, 0);
809 strcpy (send_buffer
, &send_buffer
[sent
]);
816 /* In STR, insert a & before each &, each space, each newline, and
817 any initial -. Change spaces to underscores, too, so that the
818 return value never contains a space.
820 Does not change the string. Outputs the result to S. */
822 quote_argument (HSOCKET s
, const char *str
)
824 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
846 if (*p
== '&' || (*p
== '-' && p
== str
))
853 send_to_emacs (s
, copy
);
859 /* The inverse of quote_argument. Removes quoting in string STR by
860 modifying the string in place. Returns STR. */
863 unquote_argument (char *str
)
894 file_name_absolute_p (const char *filename
)
896 /* Sanity check, it shouldn't happen. */
897 if (! filename
) return FALSE
;
899 /* /xxx is always an absolute path. */
900 if (filename
[0] == '/') return TRUE
;
902 /* Empty filenames (which shouldn't happen) are relative. */
903 if (filename
[0] == '\0') return FALSE
;
906 /* X:\xxx is always absolute. */
907 if (isalpha ((unsigned char) filename
[0])
908 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
911 /* Both \xxx and \\xxx\yyy are absolute. */
912 if (filename
[0] == '\\') return TRUE
;
919 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
926 /* Initialize the WinSock2 library. */
928 initialize_sockets (void)
932 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
934 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
938 atexit (close_winsock
);
940 #endif /* WINDOWSNT */
944 * Read the information needed to set up a TCP comm channel with
945 * the Emacs server: host, port, and authentication string.
948 get_server_config (struct sockaddr_in
*server
, char *authentication
)
954 if (file_name_absolute_p (server_file
))
955 config
= fopen (server_file
, "rb");
958 const char *home
= egetenv ("HOME");
962 char *path
= alloca (strlen (home
) + strlen (server_file
)
964 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
965 config
= fopen (path
, "rb");
968 if (!config
&& (home
= egetenv ("APPDATA")))
970 char *path
= alloca (strlen (home
) + strlen (server_file
)
972 sprintf (path
, "%s/.emacs.d/server/%s", home
, server_file
);
973 config
= fopen (path
, "rb");
981 if (fgets (dotted
, sizeof dotted
, config
)
982 && (port
= strchr (dotted
, ':')))
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
);
1006 set_tcp_socket (void)
1009 struct sockaddr_in server
;
1010 struct linger l_arg
= {1, 1};
1011 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1013 if (! get_server_config (&server
, auth_string
))
1014 return INVALID_SOCKET
;
1016 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1017 message (FALSE
, "%s: connected to remote socket at %s\n",
1018 progname
, inet_ntoa (server
.sin_addr
));
1021 * Open up an AF_INET socket
1023 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1025 sock_err_message ("socket");
1026 return INVALID_SOCKET
;
1032 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1034 sock_err_message ("connect");
1035 return INVALID_SOCKET
;
1038 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1041 * Send the authentication
1043 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1045 send_to_emacs (s
, "-auth ");
1046 send_to_emacs (s
, auth_string
);
1047 send_to_emacs (s
, " ");
1053 /* Returns 1 if PREFIX is a prefix of STRING. */
1055 strprefix (const char *prefix
, const char *string
)
1057 return !strncmp (prefix
, string
, strlen (prefix
));
1060 /* Get tty name and type. If successful, return the type in TTY_TYPE
1061 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1062 is zero, or return 0 if NOABORT is non-zero. */
1065 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1067 const char *type
= egetenv ("TERM");
1068 const char *name
= ttyname (fileno (stdout
));
1076 message (TRUE
, "%s: could not get terminal name\n", progname
);
1087 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1093 if (strcmp (type
, "eterm") == 0)
1099 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1100 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1101 " is not supported\n", progname
);
1112 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1114 /* Three possibilities:
1115 2 - can't be `stat'ed (sets errno)
1116 1 - isn't owned by us
1117 0 - success: none of the above */
1120 socket_status (const char *name
)
1122 struct stat statbfr
;
1124 if (stat (name
, &statbfr
) == -1)
1127 if (statbfr
.st_uid
!= geteuid ())
1134 /* A signal handler that passes the signal to the Emacs process.
1135 Useful for SIGWINCH. */
1138 pass_signal_to_emacs (int signalnum
)
1140 int old_errno
= errno
;
1143 kill (emacs_pid
, signalnum
);
1145 signal (signalnum
, pass_signal_to_emacs
);
1149 /* Signal handler for SIGCONT; notify the Emacs process that it can
1150 now resume our tty frame. */
1153 handle_sigcont (int signalnum
)
1155 int old_errno
= errno
;
1157 if (tcgetpgrp (1) == getpgrp ())
1159 /* We are in the foreground. */
1160 send_to_emacs (emacs_socket
, "-resume \n");
1164 /* We are in the background; cancel the continue. */
1165 kill (getpid (), SIGSTOP
);
1168 signal (signalnum
, handle_sigcont
);
1172 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1173 going to sleep. Normally the suspend is initiated by Emacs via
1174 server-handle-suspend-tty, but if the server gets out of sync with
1175 reality, we may get a SIGTSTP on C-z. Handling this signal and
1176 notifying Emacs about it should get things under control again. */
1179 handle_sigtstp (int signalnum
)
1181 int old_errno
= errno
;
1185 send_to_emacs (emacs_socket
, "-suspend \n");
1187 /* Unblock this signal and call the default handler by temporarily
1188 changing the handler and resignalling. */
1189 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1190 sigdelset (&set
, signalnum
);
1191 signal (signalnum
, SIG_DFL
);
1192 kill (getpid (), signalnum
);
1193 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1194 signal (signalnum
, handle_sigtstp
);
1200 /* Set up signal handlers before opening a frame on the current tty. */
1205 /* Set up signal handlers. */
1206 signal (SIGWINCH
, pass_signal_to_emacs
);
1208 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1209 deciding which terminal the signal came from. C-g is now a
1210 normal input event on secondary terminals. */
1212 signal (SIGINT
, pass_signal_to_emacs
);
1213 signal (SIGQUIT
, pass_signal_to_emacs
);
1216 signal (SIGCONT
, handle_sigcont
);
1217 signal (SIGTSTP
, handle_sigtstp
);
1218 signal (SIGTTOU
, handle_sigtstp
);
1223 set_local_socket (void)
1226 struct sockaddr_un server
;
1229 * Open up an AF_UNIX socket in this person's home directory
1232 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1234 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1235 return INVALID_SOCKET
;
1238 server
.sun_family
= AF_UNIX
;
1241 int sock_status
= 0;
1242 int default_sock
= !socket_name
;
1243 int saved_errno
= 0;
1244 const char *server_name
= "server";
1245 const char *tmpdir
IF_LINT ( = NULL
);
1247 if (socket_name
&& !strchr (socket_name
, '/')
1248 && !strchr (socket_name
, '\\'))
1250 /* socket_name is a file name component. */
1251 server_name
= socket_name
;
1253 default_sock
= 1; /* Try both UIDs. */
1258 tmpdir
= egetenv ("TMPDIR");
1262 #ifndef _CS_DARWIN_USER_TEMP_DIR
1263 #define _CS_DARWIN_USER_TEMP_DIR 65537
1265 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1268 tmpdir
= alloca (n
);
1269 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir
, n
);
1275 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1277 sprintf (socket_name
, "%s/emacs%d/%s",
1278 tmpdir
, (int) geteuid (), server_name
);
1281 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1282 strcpy (server
.sun_path
, socket_name
);
1285 message (TRUE
, "%s: socket-name %s too long\n",
1286 progname
, socket_name
);
1290 /* See if the socket exists, and if it's owned by us. */
1291 sock_status
= socket_status (server
.sun_path
);
1292 saved_errno
= errno
;
1293 if (sock_status
&& default_sock
)
1295 /* Failing that, see if LOGNAME or USER exist and differ from
1296 our euid. If so, look for a socket based on the UID
1297 associated with the name. This is reminiscent of the logic
1298 that init_editfns uses to set the global Vuser_full_name. */
1300 const char *user_name
= egetenv ("LOGNAME");
1303 user_name
= egetenv ("USER");
1307 struct passwd
*pw
= getpwnam (user_name
);
1309 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1311 /* We're running under su, apparently. */
1312 socket_name
= alloca (strlen (tmpdir
) + strlen (server_name
)
1314 sprintf (socket_name
, "%s/emacs%d/%s",
1315 tmpdir
, (int) pw
->pw_uid
, server_name
);
1317 if (strlen (socket_name
) < sizeof (server
.sun_path
))
1318 strcpy (server
.sun_path
, socket_name
);
1321 message (TRUE
, "%s: socket-name %s too long\n",
1322 progname
, socket_name
);
1323 exit (EXIT_FAILURE
);
1326 sock_status
= socket_status (server
.sun_path
);
1327 saved_errno
= errno
;
1330 errno
= saved_errno
;
1334 switch (sock_status
)
1337 /* There's a socket, but it isn't owned by us. This is OK if
1339 if (0 != geteuid ())
1341 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1342 return INVALID_SOCKET
;
1348 if (saved_errno
== ENOENT
)
1350 "%s: can't find socket; have you started the server?\n\
1351 To start the server in Emacs, type \"M-x server-start\".\n",
1354 message (TRUE
, "%s: can't stat %s: %s\n",
1355 progname
, server
.sun_path
, strerror (saved_errno
));
1356 return INVALID_SOCKET
;
1360 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1363 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1364 return INVALID_SOCKET
;
1369 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1372 set_socket (int no_exit_if_error
)
1378 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1379 /* Explicit --socket-name argument. */
1382 s
= set_local_socket ();
1383 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1385 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1386 progname
, socket_name
);
1387 exit (EXIT_FAILURE
);
1391 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1393 server_file
= egetenv ("EMACS_SERVER_FILE");
1397 s
= set_tcp_socket ();
1398 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1401 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1402 progname
, server_file
);
1403 exit (EXIT_FAILURE
);
1406 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1407 /* Implicit local socket. */
1408 s
= set_local_socket ();
1409 if (s
!= INVALID_SOCKET
)
1413 /* Implicit server file. */
1414 server_file
= "server";
1415 s
= set_tcp_socket ();
1416 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1419 /* No implicit or explicit socket, and no alternate editor. */
1420 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1421 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1424 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1425 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1427 exit (EXIT_FAILURE
);
1431 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1432 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1435 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1440 /* Reject any window not of class "Emacs". */
1441 if (! get_wc (hWnd
, class, sizeof (class))
1442 || strcmp (class, "Emacs"))
1445 /* We only need the process id, not the thread id. */
1446 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1448 /* Not the one we're looking for. */
1449 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1451 /* OK, let's raise it. */
1454 /* Stop enumeration. */
1459 * Search for a window of class "Emacs" and owned by a process with
1460 * process id = emacs_pid. If found, allow it to grab the focus.
1463 w32_give_focus (void)
1467 /* It shouldn't happen when dealing with TCP sockets. */
1468 if (!emacs_pid
) return;
1470 user32
= GetModuleHandle ("user32.dll");
1475 /* Modern Windows restrict which processes can set the foreground window.
1476 emacsclient can allow Emacs to grab the focus by calling the function
1477 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1478 NT) lack this function, so we have to check its availability. */
1479 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1480 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1481 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1485 /* Start the emacs daemon and try to connect to it. */
1488 start_daemon_and_retry_set_socket (void)
1499 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1501 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1503 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1504 exit (EXIT_FAILURE
);
1507 /* Try connecting, the daemon should have started by now. */
1508 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1509 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1511 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1512 exit (EXIT_FAILURE
);
1517 fprintf (stderr
, "Error: Cannot fork!\n");
1518 exit (EXIT_FAILURE
);
1522 char emacs
[] = "emacs";
1523 char daemon_option
[] = "--daemon";
1524 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1525 if (socket_name
!= NULL
)
1527 /* Pass --daemon=socket_name as argument. */
1528 const char *deq
= "--daemon=";
1529 char *daemon_arg
= alloca (strlen (deq
)
1530 + strlen (socket_name
) + 1);
1531 strcpy (daemon_arg
, deq
);
1532 strcat (daemon_arg
, socket_name
);
1533 d_argv
[1] = daemon_arg
;
1535 execvp ("emacs", d_argv
);
1536 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1538 #endif /* WINDOWSNT */
1542 main (int argc
, char **argv
)
1544 int rl
= 0, needlf
= 0;
1546 char string
[BUFSIZ
+1];
1547 int null_socket_name
IF_LINT ( = 0);
1548 int null_server_file
IF_LINT ( = 0);
1549 int start_daemon_if_needed
;
1550 int exit_status
= EXIT_SUCCESS
;
1556 /* On Windows 7 and later, we need to explicitly associate emacsclient
1557 with emacs so the UI behaves sensibly. */
1558 w32_set_user_model_id ();
1561 /* Process options. */
1562 decode_options (argc
, argv
);
1564 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1566 message (TRUE
, "%s: file name or argument required\n"
1567 "Try `%s --help' for more information\n",
1568 progname
, progname
);
1569 exit (EXIT_FAILURE
);
1572 /* If alternate_editor is the empty string, start the emacs daemon
1573 in case of failure to connect. */
1574 start_daemon_if_needed
= (alternate_editor
1575 && (alternate_editor
[0] == '\0'));
1576 if (start_daemon_if_needed
)
1578 /* set_socket changes the values for socket_name and
1579 server_file, we need to reset them, if they were NULL before
1580 for the second call to set_socket. */
1581 null_socket_name
= (socket_name
== NULL
);
1582 null_server_file
= (server_file
== NULL
);
1585 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1586 if (emacs_socket
== INVALID_SOCKET
)
1588 if (! start_daemon_if_needed
)
1591 /* Reset socket_name and server_file if they were NULL
1592 before the set_socket call. */
1593 if (null_socket_name
)
1595 if (null_server_file
)
1598 start_daemon_and_retry_set_socket ();
1601 cwd
= get_current_dir_name ();
1604 /* getwd puts message in STRING if it fails. */
1605 message (TRUE
, "%s: %s\n", progname
,
1606 "Cannot get current working directory");
1614 /* Send over our environment and current directory. */
1617 extern char **environ
;
1619 for (i
= 0; environ
[i
]; i
++)
1621 send_to_emacs (emacs_socket
, "-env ");
1622 quote_argument (emacs_socket
, environ
[i
]);
1623 send_to_emacs (emacs_socket
, " ");
1626 send_to_emacs (emacs_socket
, "-dir ");
1627 quote_argument (emacs_socket
, cwd
);
1628 send_to_emacs (emacs_socket
, "/");
1629 send_to_emacs (emacs_socket
, " ");
1633 send_to_emacs (emacs_socket
, "-nowait ");
1636 send_to_emacs (emacs_socket
, "-current-frame ");
1640 send_to_emacs (emacs_socket
, "-display ");
1641 quote_argument (emacs_socket
, display
);
1642 send_to_emacs (emacs_socket
, " ");
1647 send_to_emacs (emacs_socket
, "-parent-id ");
1648 quote_argument (emacs_socket
, parent_id
);
1649 send_to_emacs (emacs_socket
, " ");
1652 if (frame_parameters
&& !current_frame
)
1654 send_to_emacs (emacs_socket
, "-frame-parameters ");
1655 quote_argument (emacs_socket
, frame_parameters
);
1656 send_to_emacs (emacs_socket
, " ");
1659 /* If using the current frame, send tty information to Emacs anyway.
1660 In daemon mode, Emacs may need to occupy this tty if no other
1661 frame is available. */
1662 if (tty
|| (current_frame
&& !eval
))
1664 const char *tty_type
, *tty_name
;
1666 if (find_tty (&tty_type
, &tty_name
, !tty
))
1668 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1671 send_to_emacs (emacs_socket
, "-tty ");
1672 quote_argument (emacs_socket
, tty_name
);
1673 send_to_emacs (emacs_socket
, " ");
1674 quote_argument (emacs_socket
, tty_type
);
1675 send_to_emacs (emacs_socket
, " ");
1679 if (!current_frame
&& !tty
)
1680 send_to_emacs (emacs_socket
, "-window-system ");
1682 if ((argc
- optind
> 0))
1685 for (i
= optind
; i
< argc
; i
++)
1690 /* Don't prepend cwd or anything like that. */
1691 send_to_emacs (emacs_socket
, "-eval ");
1692 quote_argument (emacs_socket
, argv
[i
]);
1693 send_to_emacs (emacs_socket
, " ");
1697 if (*argv
[i
] == '+')
1699 char *p
= argv
[i
] + 1;
1700 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1703 send_to_emacs (emacs_socket
, "-position ");
1704 quote_argument (emacs_socket
, argv
[i
]);
1705 send_to_emacs (emacs_socket
, " ");
1710 else if (! file_name_absolute_p (argv
[i
])
1711 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1712 /* Windows can have a different default directory for each
1713 drive, so the cwd passed via "-dir" is not sufficient
1714 to account for that.
1715 If the user uses <drive>:<relpath>, we hence need to be
1716 careful to expand <relpath> with the default directory
1717 corresponding to <drive>. */
1719 char *filename
= (char *) xmalloc (MAX_PATH
);
1722 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1723 if (size
> 0 && size
< MAX_PATH
)
1730 send_to_emacs (emacs_socket
, "-file ");
1731 quote_argument (emacs_socket
, argv
[i
]);
1732 send_to_emacs (emacs_socket
, " ");
1737 /* Read expressions interactively. */
1738 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1740 send_to_emacs (emacs_socket
, "-eval ");
1741 quote_argument (emacs_socket
, str
);
1743 send_to_emacs (emacs_socket
, " ");
1746 send_to_emacs (emacs_socket
, "\n");
1748 /* Wait for an answer. */
1749 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1751 printf ("Waiting for Emacs...");
1757 /* Now, wait for an answer and print any messages. */
1758 while (exit_status
== EXIT_SUCCESS
)
1764 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1766 /* If we receive a signal (e.g. SIGWINCH, which we pass
1767 through to Emacs), on some OSes we get EINTR and must retry. */
1768 while (rl
< 0 && errno
== EINTR
);
1775 p
= string
+ strlen (string
) - 1;
1776 while (p
> string
&& *p
== '\n')
1779 if (strprefix ("-emacs-pid ", string
))
1781 /* -emacs-pid PID: The process id of the Emacs process. */
1782 emacs_pid
= strtol (string
+ strlen ("-emacs-pid"), NULL
, 10);
1784 else if (strprefix ("-window-system-unsupported ", string
))
1786 /* -window-system-unsupported: Emacs was compiled without X
1787 support. Try again on the terminal. */
1792 else if (strprefix ("-print ", string
))
1794 /* -print STRING: Print STRING on the terminal. */
1795 str
= unquote_argument (string
+ strlen ("-print "));
1799 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1801 else if (strprefix ("-error ", string
))
1803 /* -error DESCRIPTION: Signal an error on the terminal. */
1804 str
= unquote_argument (string
+ strlen ("-error "));
1807 fprintf (stderr
, "*ERROR*: %s", str
);
1808 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1809 exit_status
= EXIT_FAILURE
;
1812 else if (strprefix ("-suspend ", string
))
1814 /* -suspend: Suspend this terminal, i.e., stop the process. */
1823 /* Unknown command. */
1826 printf ("*ERROR*: Unknown message: %s", string
);
1828 == '\0' ? needlf
: string
[strlen (string
) - 1] != '\n';
1838 exit_status
= EXIT_FAILURE
;
1840 CLOSE_SOCKET (emacs_socket
);
1844 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1847 #ifndef HAVE_STRERROR
1852 extern char *sys_errlist
[];
1853 extern int sys_nerr
;
1855 if (errnum
>= 0 && errnum
< sys_nerr
)
1856 return sys_errlist
[errnum
];
1857 return (char *) "Unknown error";
1860 #endif /* ! HAVE_STRERROR */
1863 /* emacsclient.c ends here */