1 /* Client process that communicates with GNU Emacs acting as server.
2 Copyright (C) 1986-1987, 1994, 1999-2012 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
24 /* config.h defines these, which disables sockets altogether! */
31 # include <commctrl.h>
33 # include <winsock2.h>
35 # define NO_SOCKETS_IN_FILE_SYSTEM
37 # define HSOCKET SOCKET
38 # define CLOSE_SOCKET closesocket
39 # define INITIALIZE() (initialize_sockets ())
41 char *w32_getenv (char *);
42 #define egetenv(VAR) w32_getenv(VAR)
44 #else /* !WINDOWSNT */
48 # ifdef HAVE_INET_SOCKETS
49 # include <netinet/in.h>
51 # include <sys/types.h>
52 # include <sys/socket.h>
54 # endif /* HAVE_SOCKETS */
56 # include <arpa/inet.h>
58 # define INVALID_SOCKET -1
60 # define CLOSE_SOCKET close
67 #define egetenv(VAR) getenv(VAR)
69 #endif /* !WINDOWSNT */
86 char *getenv (const char *), *getwd (char *);
88 char *(getcwd
) (char *, size_t);
92 #define VERSION "unspecified"
97 #define EXIT_SUCCESS 0
101 #define EXIT_FAILURE 1
112 /* Additional space when allocating buffers for filenames, etc. */
113 #define EXTRA_SPACE 100
115 /* Use this to suppress gcc's `...may be used before initialized' warnings. */
117 # define IF_LINT(Code) Code
119 # define IF_LINT(Code) /* empty */
123 /* Name used to invoke this program. */
124 const char *progname
;
126 /* The second argument to main. */
129 /* Nonzero means don't wait for a response from Emacs. --no-wait. */
132 /* Nonzero means don't print messages for successful operations. --quiet. */
135 /* Nonzero means args are expressions to be evaluated. --eval. */
138 /* Nonzero means don't open a new frame. Inverse of --create-frame. */
139 int current_frame
= 1;
141 /* The display on which Emacs should work. --display. */
142 const char *display
= NULL
;
144 /* The parent window ID, if we are opening a frame via XEmbed. */
145 char *parent_id
= NULL
;
147 /* Nonzero means open a new Emacs frame on the current terminal. */
150 /* If non-NULL, the name of an editor to fallback to if the server
151 is not running. --alternate-editor. */
152 const char *alternate_editor
= NULL
;
154 /* If non-NULL, the filename of the UNIX socket. */
155 const char *socket_name
= NULL
;
157 /* If non-NULL, the filename of the authentication file. */
158 const char *server_file
= NULL
;
160 /* PID of the Emacs server process. */
163 /* If non-NULL, a string that should form a frame parameter alist to
164 be used for the new frame */
165 const char *frame_parameters
= NULL
;
167 static void print_help_and_exit (void) NO_RETURN
;
168 static void fail (void) NO_RETURN
;
171 struct option longopts
[] =
173 { "no-wait", no_argument
, NULL
, 'n' },
174 { "quiet", no_argument
, NULL
, 'q' },
175 { "eval", no_argument
, NULL
, 'e' },
176 { "help", no_argument
, NULL
, 'H' },
177 { "version", no_argument
, NULL
, 'V' },
178 { "tty", no_argument
, NULL
, 't' },
179 { "nw", no_argument
, NULL
, 't' },
180 { "create-frame", no_argument
, NULL
, 'c' },
181 { "alternate-editor", required_argument
, NULL
, 'a' },
182 { "frame-parameters", required_argument
, NULL
, 'F' },
183 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
184 { "socket-name", required_argument
, NULL
, 's' },
186 { "server-file", required_argument
, NULL
, 'f' },
188 { "display", required_argument
, NULL
, 'd' },
190 { "parent-id", required_argument
, NULL
, 'p' },
195 /* Like malloc but get fatal error if memory is exhausted. */
198 xmalloc (size_t size
)
200 void *result
= malloc (size
);
210 #if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
213 #ifndef DIRECTORY_SEP
214 #define DIRECTORY_SEP '/'
216 #ifndef IS_DIRECTORY_SEP
217 #define IS_DIRECTORY_SEP(_c_) ((_c_) == DIRECTORY_SEP)
219 #ifndef IS_DEVICE_SEP
221 #define IS_DEVICE_SEP(_c_) 0
223 #define IS_DEVICE_SEP(_c_) ((_c_) == DEVICE_SEP)
227 char *get_current_dir_name (void);
229 /* Return the current working directory. Returns NULL on errors.
230 Any other returned value must be freed with free. This is used
231 only when get_current_dir_name is not defined on the system. */
233 get_current_dir_name (void)
237 struct stat dotstat
, pwdstat
;
238 /* If PWD is accurate, use it instead of calling getwd. PWD is
239 sometimes a nicer name, and using it may avoid a fatal error if a
240 parent directory is searchable but not readable. */
241 if ((pwd
= egetenv ("PWD")) != 0
242 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
243 && stat (pwd
, &pwdstat
) == 0
244 && stat (".", &dotstat
) == 0
245 && dotstat
.st_ino
== pwdstat
.st_ino
246 && dotstat
.st_dev
== pwdstat
.st_dev
248 && strlen (pwd
) < MAXPATHLEN
252 buf
= (char *) xmalloc (strlen (pwd
) + 1);
258 size_t buf_size
= 1024;
262 buf
= malloc (buf_size
);
265 if (getcwd (buf
, buf_size
) == buf
)
269 if (tmp_errno
!= ERANGE
)
285 /* We need MAXPATHLEN here. */
286 buf
= (char *) xmalloc (MAXPATHLEN
+ 1);
287 if (getwd (buf
) == NULL
)
289 int tmp_errno
= errno
;
302 /* Like strdup but get a fatal error if memory is exhausted. */
305 xstrdup (const char *s
)
307 char *result
= strdup (s
);
316 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
318 /* Retrieve an environment variable from the Emacs subkeys of the registry.
319 Return NULL if the variable was not found, or it was empty.
320 This code is based on w32_get_resource (w32.c). */
322 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
324 HKEY hrootkey
= NULL
;
328 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
330 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
332 result
= (char *) xmalloc (cbData
);
334 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
342 RegCloseKey (hrootkey
);
349 getenv wrapper for Windows
351 Value is allocated on the heap, and can be free'd.
353 This is needed to duplicate Emacs's behavior, which is to look for
354 environment variables in the registry if they don't appear in the
357 w32_getenv (char *envvar
)
362 if ((value
= getenv (envvar
)))
363 /* Found in the environment. strdup it, because values returned
364 by getenv cannot be free'd. */
365 return xstrdup (value
);
367 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
368 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
370 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
371 if (strcmp (envvar
, "TERM") == 0)
372 return xstrdup ("w32console");
373 /* Found neither in the environment nor in the registry. */
377 if (dwType
== REG_SZ
)
378 /* Registry; no need to expand. */
381 if (dwType
== REG_EXPAND_SZ
)
385 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
387 char *buffer
= (char *) xmalloc (size
);
388 if (ExpandEnvironmentStrings (value
, buffer
, size
))
390 /* Found and expanded. */
395 /* Error expanding. */
400 /* Not the right type, or not correctly expanded. */
406 w32_set_user_model_id (void)
409 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
411 /* On Windows 7 and later, we need to set the user model ID
412 to associate emacsclient launched files with Emacs frames
414 shell
= LoadLibrary ("shell32.dll");
418 = (void *) GetProcAddress (shell
,
419 "SetCurrentProcessExplicitAppUserModelID");
420 /* If the function is defined, then we are running on Windows 7
421 or newer, and the UI uses this to group related windows
422 together. Since emacs, runemacs, emacsclient are related, we
423 want them grouped even though the executables are different,
424 so we need to set a consistent ID between them. */
426 set_user_model (L
"GNU.Emacs");
433 w32_window_app (void)
435 static int window_app
= -1;
436 char szTitle
[MAX_PATH
];
440 /* Checking for STDOUT does not work; it's a valid handle also in
441 nonconsole apps. Testing for the console title seems to work. */
442 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
444 InitCommonControls ();
451 execvp wrapper for Windows. Quotes arguments with embedded spaces.
453 This is necessary due to the broken implementation of exec* routines in
454 the Microsoft libraries: they concatenate the arguments together without
455 quoting special characters, and pass the result to CreateProcess, with
456 predictably bad results. By contrast, POSIX execvp passes the arguments
457 directly into the argv array of the child process.
460 w32_execvp (const char *path
, char **argv
)
464 /* Required to allow a .BAT script as alternate editor. */
465 argv
[0] = (char *) alternate_editor
;
467 for (i
= 0; argv
[i
]; i
++)
468 if (strchr (argv
[i
], ' '))
470 char *quoted
= alloca (strlen (argv
[i
]) + 3);
471 sprintf (quoted
, "\"%s\"", argv
[i
]);
475 return execvp (path
, argv
);
479 #define execvp w32_execvp
481 /* Emulation of ttyname for Windows. */
488 #endif /* WINDOWSNT */
490 /* Display a normal or error message.
491 On Windows, use a message box if compiled as a Windows app. */
492 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
494 message (int is_error
, const char *format
, ...)
498 va_start (args
, format
);
501 if (w32_window_app ())
504 vsnprintf (msg
, sizeof msg
, format
, args
);
505 msg
[sizeof msg
- 1] = '\0';
508 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
510 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
515 FILE *f
= is_error
? stderr
: stdout
;
517 vfprintf (f
, format
, args
);
524 /* Decode the options from argv and argc.
525 The global variable `optind' will say how many arguments we used up. */
528 decode_options (int argc
, char **argv
)
530 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
534 int opt
= getopt_long_only (argc
, argv
,
535 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
548 /* If getopt returns 0, then it has already processed a
549 long-named option. We should do nothing. */
553 alternate_editor
= optarg
;
556 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
558 socket_name
= optarg
;
563 server_file
= optarg
;
566 /* We used to disallow this argument in w32, but it seems better
567 to allow it, for the occasional case where the user is
568 connecting with a w32 client to a server compiled with X11
587 message (FALSE
, "emacsclient %s\n", VERSION
);
606 print_help_and_exit ();
610 frame_parameters
= optarg
;
614 message (TRUE
, "Try `%s --help' for more information\n", progname
);
620 /* If the -c option is used (without -t) and no --display argument
621 is provided, try $DISPLAY.
622 Without the -c option, we used to set `display' to $DISPLAY by
623 default, but this changed the default behavior and is sometimes
624 inconvenient. So we force users to use "--display $DISPLAY" if
625 they want Emacs to connect to their current display. */
626 if (!current_frame
&& !tty
&& !display
)
628 display
= egetenv ("DISPLAY");
630 /* Under Cocoa, we don't really use displays the same way as in X,
631 so provide a dummy. */
632 if (!display
|| strlen (display
) == 0)
637 /* A null-string display is invalid. */
638 if (display
&& strlen (display
) == 0)
641 /* If no display is available, new frames are tty frames. */
642 if (!current_frame
&& !display
)
646 /* Emacs on Windows does not support graphical and text terminal
647 frames in the same instance. So, treat the -t and -c options as
648 equivalent, and open a new frame on the server's terminal.
649 Ideally, we would only set tty = 1 when the serve is running in a
650 console, but alas we don't know that. As a workaround, always
651 ask for a tty frame, and let server.el figure it out. */
658 if (alternate_editor
&& alternate_editor
[0] == '\0')
660 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
664 #endif /* WINDOWSNT */
669 print_help_and_exit (void)
671 /* Spaces and tabs are significant in this message; they're chosen so the
672 message aligns properly both in a tty and in a Windows message box.
673 Please try to preserve them; otherwise the output is very hard to read
674 when using emacsclientw. */
676 "Usage: %s [OPTIONS] FILE...\n\
677 Tell the Emacs server to visit the specified files.\n\
678 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
680 The following OPTIONS are accepted:\n\
681 -V, --version Just print version info and return\n\
682 -H, --help Print this usage information message\n\
683 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
684 -c, --create-frame Create a new frame instead of trying to\n\
685 use the current Emacs frame\n\
686 -F ALIST, --frame-parameters=ALIST\n\
687 Set the parameters of a new frame\n\
688 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
689 -n, --no-wait Don't wait for the server to return\n\
690 -q, --quiet Don't display messages on success\n\
691 -d DISPLAY, --display=DISPLAY\n\
692 Visit the file in the given display\n\
693 --parent-id=ID Open in parent window ID, via XEmbed\n"
694 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
695 "-s SOCKET, --socket-name=SOCKET\n\
696 Set filename of the UNIX socket for communication\n"
698 "-f SERVER, --server-file=SERVER\n\
699 Set filename of the TCP authentication file\n\
700 -a EDITOR, --alternate-editor=EDITOR\n\
701 Editor to fallback to if the server is not running\n"
703 " If EDITOR is the empty string, start Emacs in daemon\n\
704 mode and try connecting again\n"
705 #endif /* not WINDOWSNT */
707 Report bugs with M-x report-emacs-bug.\n", progname
);
712 Try to run a different command, or --if no alternate editor is
713 defined-- exit with an errorcode.
714 Uses argv, but gets it from the global variable main_argv.
719 if (alternate_editor
)
723 execvp (alternate_editor
, main_argv
+ i
);
724 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
725 progname
, alternate_editor
);
731 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
734 main (int argc
, char **argv
)
738 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
739 "on systems with Berkeley sockets.\n",
744 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
746 #define AUTH_KEY_LENGTH 64
747 #define SEND_BUFFER_SIZE 4096
749 extern char *strerror (int);
751 /* Buffer to accumulate data to send in TCP connections. */
752 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
753 int sblen
= 0; /* Fill pointer for the send buffer. */
754 /* Socket used to communicate with the Emacs server process. */
755 HSOCKET emacs_socket
= 0;
757 /* On Windows, the socket library was historically separate from the standard
758 C library, so errors are handled differently. */
760 sock_err_message (const char *function_name
)
765 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
766 | FORMAT_MESSAGE_ALLOCATE_BUFFER
767 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
768 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
770 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
774 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
779 /* Let's send the data to Emacs when either
780 - the data ends in "\n", or
781 - the buffer is full (but this shouldn't happen)
782 Otherwise, we just accumulate it. */
784 send_to_emacs (HSOCKET s
, const char *data
)
788 size_t dlen
= strlen (data
);
789 if (dlen
+ sblen
>= SEND_BUFFER_SIZE
)
791 int part
= SEND_BUFFER_SIZE
- sblen
;
792 strncpy (&send_buffer
[sblen
], data
, part
);
794 sblen
= SEND_BUFFER_SIZE
;
798 strcpy (&send_buffer
[sblen
], data
);
805 if (sblen
== SEND_BUFFER_SIZE
806 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
808 int sent
= send (s
, send_buffer
, sblen
, 0);
810 strcpy (send_buffer
, &send_buffer
[sent
]);
817 /* In STR, insert a & before each &, each space, each newline, and
818 any initial -. Change spaces to underscores, too, so that the
819 return value never contains a space.
821 Does not change the string. Outputs the result to S. */
823 quote_argument (HSOCKET s
, const char *str
)
825 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
847 if (*p
== '&' || (*p
== '-' && p
== str
))
854 send_to_emacs (s
, copy
);
860 /* The inverse of quote_argument. Removes quoting in string STR by
861 modifying the string in place. Returns STR. */
864 unquote_argument (char *str
)
895 file_name_absolute_p (const char *filename
)
897 /* Sanity check, it shouldn't happen. */
898 if (! filename
) return FALSE
;
900 /* /xxx is always an absolute path. */
901 if (filename
[0] == '/') return TRUE
;
903 /* Empty filenames (which shouldn't happen) are relative. */
904 if (filename
[0] == '\0') return FALSE
;
907 /* X:\xxx is always absolute. */
908 if (isalpha ((unsigned char) filename
[0])
909 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
912 /* Both \xxx and \\xxx\yyy are absolute. */
913 if (filename
[0] == '\\') return TRUE
;
920 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
927 /* Initialize the WinSock2 library. */
929 initialize_sockets (void)
933 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
935 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
939 atexit (close_winsock
);
941 #endif /* WINDOWSNT */
945 * Read the information needed to set up a TCP comm channel with
946 * the Emacs server: host, port, and authentication string.
949 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
950 char *authentication
)
956 if (file_name_absolute_p (config_file
))
957 config
= fopen (config_file
, "rb");
960 const char *home
= egetenv ("HOME");
964 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
967 strcat (path
, "/.emacs.d/server/");
968 strcat (path
, config_file
);
969 config
= fopen (path
, "rb");
973 if (!config
&& (home
= egetenv ("APPDATA")))
975 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
978 strcat (path
, "/.emacs.d/server/");
979 strcat (path
, config_file
);
980 config
= fopen (path
, "rb");
989 if (fgets (dotted
, sizeof dotted
, config
)
990 && (port
= strchr (dotted
, ':')))
994 message (TRUE
, "%s: invalid configuration info\n", progname
);
998 server
->sin_family
= AF_INET
;
999 server
->sin_addr
.s_addr
= inet_addr (dotted
);
1000 server
->sin_port
= htons (atoi (port
));
1002 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
1004 message (TRUE
, "%s: cannot read authentication info\n", progname
);
1005 exit (EXIT_FAILURE
);
1014 set_tcp_socket (const char *local_server_file
)
1017 struct sockaddr_in server
;
1018 struct linger l_arg
= {1, 1};
1019 char auth_string
[AUTH_KEY_LENGTH
+ 1];
1021 if (! get_server_config (local_server_file
, &server
, auth_string
))
1022 return INVALID_SOCKET
;
1024 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
1025 message (FALSE
, "%s: connected to remote socket at %s\n",
1026 progname
, inet_ntoa (server
.sin_addr
));
1029 * Open up an AF_INET socket
1031 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
1033 sock_err_message ("socket");
1034 return INVALID_SOCKET
;
1040 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
1042 sock_err_message ("connect");
1043 return INVALID_SOCKET
;
1046 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1049 * Send the authentication
1051 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1053 send_to_emacs (s
, "-auth ");
1054 send_to_emacs (s
, auth_string
);
1055 send_to_emacs (s
, " ");
1061 /* Returns 1 if PREFIX is a prefix of STRING. */
1063 strprefix (const char *prefix
, const char *string
)
1065 return !strncmp (prefix
, string
, strlen (prefix
));
1068 /* Get tty name and type. If successful, return the type in TTY_TYPE
1069 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1070 is zero, or return 0 if NOABORT is non-zero. */
1073 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1075 const char *type
= egetenv ("TERM");
1076 const char *name
= ttyname (fileno (stdout
));
1084 message (TRUE
, "%s: could not get terminal name\n", progname
);
1095 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1101 if (strcmp (type
, "eterm") == 0)
1107 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1108 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1109 " is not supported\n", progname
);
1120 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1122 /* Three possibilities:
1123 2 - can't be `stat'ed (sets errno)
1124 1 - isn't owned by us
1125 0 - success: none of the above */
1128 socket_status (const char *name
)
1130 struct stat statbfr
;
1132 if (stat (name
, &statbfr
) == -1)
1135 if (statbfr
.st_uid
!= geteuid ())
1142 /* A signal handler that passes the signal to the Emacs process.
1143 Useful for SIGWINCH. */
1146 pass_signal_to_emacs (int signalnum
)
1148 int old_errno
= errno
;
1151 kill (emacs_pid
, signalnum
);
1153 signal (signalnum
, pass_signal_to_emacs
);
1157 /* Signal handler for SIGCONT; notify the Emacs process that it can
1158 now resume our tty frame. */
1161 handle_sigcont (int signalnum
)
1163 int old_errno
= errno
;
1165 if (tcgetpgrp (1) == getpgrp ())
1167 /* We are in the foreground. */
1168 send_to_emacs (emacs_socket
, "-resume \n");
1172 /* We are in the background; cancel the continue. */
1173 kill (getpid (), SIGSTOP
);
1176 signal (signalnum
, handle_sigcont
);
1180 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1181 going to sleep. Normally the suspend is initiated by Emacs via
1182 server-handle-suspend-tty, but if the server gets out of sync with
1183 reality, we may get a SIGTSTP on C-z. Handling this signal and
1184 notifying Emacs about it should get things under control again. */
1187 handle_sigtstp (int signalnum
)
1189 int old_errno
= errno
;
1193 send_to_emacs (emacs_socket
, "-suspend \n");
1195 /* Unblock this signal and call the default handler by temporarily
1196 changing the handler and resignaling. */
1197 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1198 sigdelset (&set
, signalnum
);
1199 signal (signalnum
, SIG_DFL
);
1200 kill (getpid (), signalnum
);
1201 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1202 signal (signalnum
, handle_sigtstp
);
1208 /* Set up signal handlers before opening a frame on the current tty. */
1213 /* Set up signal handlers. */
1214 signal (SIGWINCH
, pass_signal_to_emacs
);
1216 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1217 deciding which terminal the signal came from. C-g is now a
1218 normal input event on secondary terminals. */
1220 signal (SIGINT
, pass_signal_to_emacs
);
1221 signal (SIGQUIT
, pass_signal_to_emacs
);
1224 signal (SIGCONT
, handle_sigcont
);
1225 signal (SIGTSTP
, handle_sigtstp
);
1226 signal (SIGTTOU
, handle_sigtstp
);
1231 set_local_socket (const char *local_socket_name
)
1234 struct sockaddr_un server
;
1237 * Open up an AF_UNIX socket in this person's home directory
1240 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1242 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1243 return INVALID_SOCKET
;
1246 server
.sun_family
= AF_UNIX
;
1252 const char *server_name
= local_socket_name
;
1253 const char *tmpdir
IF_LINT ( = NULL
);
1254 char *tmpdir_storage
= NULL
;
1255 char *socket_name_storage
= NULL
;
1257 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1259 /* socket_name is a file name component. */
1260 long uid
= geteuid ();
1261 ptrdiff_t tmpdirlen
;
1263 tmpdir
= egetenv ("TMPDIR");
1267 #ifndef _CS_DARWIN_USER_TEMP_DIR
1268 #define _CS_DARWIN_USER_TEMP_DIR 65537
1270 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1273 tmpdir
= tmpdir_storage
= xmalloc (n
);
1274 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir
, n
);
1280 tmpdirlen
= strlen (tmpdir
);
1281 socket_name_storage
=
1282 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1283 strcpy (socket_name_storage
, tmpdir
);
1284 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1285 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1286 local_socket_name
= socket_name_storage
;
1289 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1290 strcpy (server
.sun_path
, local_socket_name
);
1293 message (TRUE
, "%s: socket-name %s too long\n",
1294 progname
, local_socket_name
);
1298 /* See if the socket exists, and if it's owned by us. */
1299 sock_status
= socket_status (server
.sun_path
);
1300 saved_errno
= errno
;
1301 if (sock_status
&& use_tmpdir
)
1303 /* Failing that, see if LOGNAME or USER exist and differ from
1304 our euid. If so, look for a socket based on the UID
1305 associated with the name. This is reminiscent of the logic
1306 that init_editfns uses to set the global Vuser_full_name. */
1308 const char *user_name
= egetenv ("LOGNAME");
1311 user_name
= egetenv ("USER");
1315 struct passwd
*pw
= getpwnam (user_name
);
1317 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1319 /* We're running under su, apparently. */
1320 long uid
= pw
->pw_uid
;
1321 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1322 char *user_socket_name
1323 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1324 strcpy (user_socket_name
, tmpdir
);
1325 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1326 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1328 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1329 strcpy (server
.sun_path
, user_socket_name
);
1332 message (TRUE
, "%s: socket-name %s too long\n",
1333 progname
, user_socket_name
);
1334 exit (EXIT_FAILURE
);
1336 free (user_socket_name
);
1338 sock_status
= socket_status (server
.sun_path
);
1339 saved_errno
= errno
;
1342 errno
= saved_errno
;
1346 free (socket_name_storage
);
1347 free (tmpdir_storage
);
1349 switch (sock_status
)
1352 /* There's a socket, but it isn't owned by us. This is OK if
1354 if (0 != geteuid ())
1356 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1357 return INVALID_SOCKET
;
1363 if (saved_errno
== ENOENT
)
1365 "%s: can't find socket; have you started the server?\n\
1366 To start the server in Emacs, type \"M-x server-start\".\n",
1369 message (TRUE
, "%s: can't stat %s: %s\n",
1370 progname
, server
.sun_path
, strerror (saved_errno
));
1371 return INVALID_SOCKET
;
1375 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1378 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1379 return INVALID_SOCKET
;
1384 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1387 set_socket (int no_exit_if_error
)
1390 const char *local_server_file
= server_file
;
1394 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1395 /* Explicit --socket-name argument. */
1398 s
= set_local_socket (socket_name
);
1399 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1401 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1402 progname
, socket_name
);
1403 exit (EXIT_FAILURE
);
1407 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1408 if (!local_server_file
)
1409 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1411 if (local_server_file
)
1413 s
= set_tcp_socket (local_server_file
);
1414 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1417 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1418 progname
, local_server_file
);
1419 exit (EXIT_FAILURE
);
1422 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1423 /* Implicit local socket. */
1424 s
= set_local_socket ("server");
1425 if (s
!= INVALID_SOCKET
)
1429 /* Implicit server file. */
1430 s
= set_tcp_socket ("server");
1431 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1434 /* No implicit or explicit socket, and no alternate editor. */
1435 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1436 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1439 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1440 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1442 exit (EXIT_FAILURE
);
1446 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1447 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1450 w32_find_emacs_process (HWND hWnd
, LPARAM lParam
)
1455 /* Reject any window not of class "Emacs". */
1456 if (! get_wc (hWnd
, class, sizeof (class))
1457 || strcmp (class, "Emacs"))
1460 /* We only need the process id, not the thread id. */
1461 (void) GetWindowThreadProcessId (hWnd
, &pid
);
1463 /* Not the one we're looking for. */
1464 if (pid
!= (DWORD
) emacs_pid
) return TRUE
;
1466 /* OK, let's raise it. */
1469 /* Stop enumeration. */
1474 * Search for a window of class "Emacs" and owned by a process with
1475 * process id = emacs_pid. If found, allow it to grab the focus.
1478 w32_give_focus (void)
1482 /* It shouldn't happen when dealing with TCP sockets. */
1483 if (!emacs_pid
) return;
1485 user32
= GetModuleHandle ("user32.dll");
1490 /* Modern Windows restrict which processes can set the foreground window.
1491 emacsclient can allow Emacs to grab the focus by calling the function
1492 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1493 NT) lack this function, so we have to check its availability. */
1494 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1495 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1496 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1500 /* Start the emacs daemon and try to connect to it. */
1503 start_daemon_and_retry_set_socket (void)
1514 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1516 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1518 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1519 exit (EXIT_FAILURE
);
1522 /* Try connecting, the daemon should have started by now. */
1523 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1524 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1526 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1527 exit (EXIT_FAILURE
);
1532 fprintf (stderr
, "Error: Cannot fork!\n");
1533 exit (EXIT_FAILURE
);
1537 char emacs
[] = "emacs";
1538 char daemon_option
[] = "--daemon";
1539 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1540 if (socket_name
!= NULL
)
1542 /* Pass --daemon=socket_name as argument. */
1543 const char *deq
= "--daemon=";
1544 char *daemon_arg
= xmalloc (strlen (deq
)
1545 + strlen (socket_name
) + 1);
1546 strcpy (daemon_arg
, deq
);
1547 strcat (daemon_arg
, socket_name
);
1548 d_argv
[1] = daemon_arg
;
1550 execvp ("emacs", d_argv
);
1551 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1553 #endif /* WINDOWSNT */
1557 main (int argc
, char **argv
)
1559 int rl
= 0, needlf
= 0;
1561 char string
[BUFSIZ
+1];
1562 int start_daemon_if_needed
;
1563 int exit_status
= EXIT_SUCCESS
;
1569 /* On Windows 7 and later, we need to explicitly associate emacsclient
1570 with emacs so the UI behaves sensibly. */
1571 w32_set_user_model_id ();
1574 /* Process options. */
1575 decode_options (argc
, argv
);
1577 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1579 message (TRUE
, "%s: file name or argument required\n"
1580 "Try `%s --help' for more information\n",
1581 progname
, progname
);
1582 exit (EXIT_FAILURE
);
1585 /* If alternate_editor is the empty string, start the emacs daemon
1586 in case of failure to connect. */
1587 start_daemon_if_needed
= (alternate_editor
1588 && (alternate_editor
[0] == '\0'));
1590 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1591 if (emacs_socket
== INVALID_SOCKET
)
1593 if (! start_daemon_if_needed
)
1596 start_daemon_and_retry_set_socket ();
1599 cwd
= get_current_dir_name ();
1602 /* getwd puts message in STRING if it fails. */
1603 message (TRUE
, "%s: %s\n", progname
,
1604 "Cannot get current working directory");
1612 /* Send over our environment and current directory. */
1616 /* This is defined in stdlib.h on MS-Windows. It's defined in
1617 unistd.h on some POSIX hosts, but not all (Bug#10155). */
1618 extern char **environ
;
1621 for (i
= 0; environ
[i
]; i
++)
1623 send_to_emacs (emacs_socket
, "-env ");
1624 quote_argument (emacs_socket
, environ
[i
]);
1625 send_to_emacs (emacs_socket
, " ");
1628 send_to_emacs (emacs_socket
, "-dir ");
1629 quote_argument (emacs_socket
, cwd
);
1630 send_to_emacs (emacs_socket
, "/");
1631 send_to_emacs (emacs_socket
, " ");
1635 send_to_emacs (emacs_socket
, "-nowait ");
1638 send_to_emacs (emacs_socket
, "-current-frame ");
1642 send_to_emacs (emacs_socket
, "-display ");
1643 quote_argument (emacs_socket
, display
);
1644 send_to_emacs (emacs_socket
, " ");
1649 send_to_emacs (emacs_socket
, "-parent-id ");
1650 quote_argument (emacs_socket
, parent_id
);
1651 send_to_emacs (emacs_socket
, " ");
1654 if (frame_parameters
&& !current_frame
)
1656 send_to_emacs (emacs_socket
, "-frame-parameters ");
1657 quote_argument (emacs_socket
, frame_parameters
);
1658 send_to_emacs (emacs_socket
, " ");
1661 /* If using the current frame, send tty information to Emacs anyway.
1662 In daemon mode, Emacs may need to occupy this tty if no other
1663 frame is available. */
1664 if (tty
|| (current_frame
&& !eval
))
1666 const char *tty_type
, *tty_name
;
1668 if (find_tty (&tty_type
, &tty_name
, !tty
))
1670 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1673 send_to_emacs (emacs_socket
, "-tty ");
1674 quote_argument (emacs_socket
, tty_name
);
1675 send_to_emacs (emacs_socket
, " ");
1676 quote_argument (emacs_socket
, tty_type
);
1677 send_to_emacs (emacs_socket
, " ");
1681 if (!current_frame
&& !tty
)
1682 send_to_emacs (emacs_socket
, "-window-system ");
1684 if ((argc
- optind
> 0))
1687 for (i
= optind
; i
< argc
; i
++)
1692 /* Don't prepend cwd or anything like that. */
1693 send_to_emacs (emacs_socket
, "-eval ");
1694 quote_argument (emacs_socket
, argv
[i
]);
1695 send_to_emacs (emacs_socket
, " ");
1699 if (*argv
[i
] == '+')
1701 char *p
= argv
[i
] + 1;
1702 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1705 send_to_emacs (emacs_socket
, "-position ");
1706 quote_argument (emacs_socket
, argv
[i
]);
1707 send_to_emacs (emacs_socket
, " ");
1712 else if (! file_name_absolute_p (argv
[i
])
1713 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1714 /* Windows can have a different default directory for each
1715 drive, so the cwd passed via "-dir" is not sufficient
1716 to account for that.
1717 If the user uses <drive>:<relpath>, we hence need to be
1718 careful to expand <relpath> with the default directory
1719 corresponding to <drive>. */
1721 char *filename
= (char *) xmalloc (MAX_PATH
);
1724 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1725 if (size
> 0 && size
< MAX_PATH
)
1732 send_to_emacs (emacs_socket
, "-file ");
1733 quote_argument (emacs_socket
, argv
[i
]);
1734 send_to_emacs (emacs_socket
, " ");
1739 /* Read expressions interactively. */
1740 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1742 send_to_emacs (emacs_socket
, "-eval ");
1743 quote_argument (emacs_socket
, str
);
1745 send_to_emacs (emacs_socket
, " ");
1748 send_to_emacs (emacs_socket
, "\n");
1750 /* Wait for an answer. */
1751 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1753 printf ("Waiting for Emacs...");
1759 /* Now, wait for an answer and print any messages. */
1760 while (exit_status
== EXIT_SUCCESS
)
1766 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1768 /* If we receive a signal (e.g. SIGWINCH, which we pass
1769 through to Emacs), on some OSes we get EINTR and must retry. */
1770 while (rl
< 0 && errno
== EINTR
);
1777 /* Loop over all NL-terminated messages. */
1778 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1780 end_p
= strchr (p
, '\n');
1784 if (strprefix ("-emacs-pid ", p
))
1786 /* -emacs-pid PID: The process id of the Emacs process. */
1787 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1789 else if (strprefix ("-window-system-unsupported ", p
))
1791 /* -window-system-unsupported: Emacs was compiled without X
1792 support. Try again on the terminal. */
1797 else if (strprefix ("-print ", p
))
1799 /* -print STRING: Print STRING on the terminal. */
1800 str
= unquote_argument (p
+ strlen ("-print "));
1804 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1806 else if (strprefix ("-print-nonl ", p
))
1808 /* -print-nonl STRING: Print STRING on the terminal.
1809 Used to continue a preceding -print command. */
1810 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1812 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1814 else if (strprefix ("-error ", p
))
1816 /* -error DESCRIPTION: Signal an error on the terminal. */
1817 str
= unquote_argument (p
+ strlen ("-error "));
1820 fprintf (stderr
, "*ERROR*: %s", str
);
1821 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1822 exit_status
= EXIT_FAILURE
;
1825 else if (strprefix ("-suspend ", p
))
1827 /* -suspend: Suspend this terminal, i.e., stop the process. */
1836 /* Unknown command. */
1840 printf ("*ERROR*: Unknown message: %s\n", p
);
1851 exit_status
= EXIT_FAILURE
;
1853 CLOSE_SOCKET (emacs_socket
);
1857 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
1860 #ifndef HAVE_STRERROR
1865 extern char *sys_errlist
[];
1866 extern int sys_nerr
;
1868 if (errnum
>= 0 && errnum
< sys_nerr
)
1869 return sys_errlist
[errnum
];
1870 return (char *) "Unknown error";
1873 #endif /* ! HAVE_STRERROR */
1876 /* emacsclient.c ends here */