1 /* Client process that communicates with GNU Emacs acting as server.
3 Copyright (C) 1986-1987, 1994, 1999-2013 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software: you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation, either version 3 of the License, or
10 (at your option) any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
25 /* ms-w32.h defines these, which disables sockets altogether! */
32 # include <commctrl.h>
34 # include <winsock2.h>
36 # define NO_SOCKETS_IN_FILE_SYSTEM
38 # define HSOCKET SOCKET
39 # define CLOSE_SOCKET closesocket
40 # define INITIALIZE() (initialize_sockets ())
42 char *w32_getenv (char *);
43 #define egetenv(VAR) w32_getenv(VAR)
45 #else /* !WINDOWSNT */
49 # endif /* HAVE_NTGUI */
53 # ifdef HAVE_INET_SOCKETS
54 # include <netinet/in.h>
56 # include <sys/types.h>
57 # include <sys/socket.h>
59 # endif /* HAVE_SOCKETS */
61 # include <arpa/inet.h>
63 # define INVALID_SOCKET -1
65 # define CLOSE_SOCKET close
72 #define egetenv(VAR) getenv(VAR)
74 #endif /* !WINDOWSNT */
91 char *getenv (const char *);
94 #define VERSION "unspecified"
99 #define EXIT_SUCCESS 0
103 #define EXIT_FAILURE 1
114 /* Additional space when allocating buffers for filenames, etc. */
115 #define EXTRA_SPACE 100
120 #define min(x, y) (((x) < (y)) ? (x) : (y))
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 alternate display we should try if Emacs does not support display. */
145 const char *alt_display
= NULL
;
147 /* The parent window ID, if we are opening a frame via XEmbed. */
148 char *parent_id
= NULL
;
150 /* Nonzero means open a new Emacs frame on the current terminal. */
153 /* If non-NULL, the name of an editor to fallback to if the server
154 is not running. --alternate-editor. */
155 const char *alternate_editor
= NULL
;
157 /* If non-NULL, the filename of the UNIX socket. */
158 const char *socket_name
= NULL
;
160 /* If non-NULL, the filename of the authentication file. */
161 const char *server_file
= NULL
;
163 /* PID of the Emacs server process. */
166 /* If non-NULL, a string that should form a frame parameter alist to
167 be used for the new frame */
168 const char *frame_parameters
= NULL
;
170 static _Noreturn
void print_help_and_exit (void);
173 struct option longopts
[] =
175 { "no-wait", no_argument
, NULL
, 'n' },
176 { "quiet", no_argument
, NULL
, 'q' },
177 { "eval", no_argument
, NULL
, 'e' },
178 { "help", no_argument
, NULL
, 'H' },
179 { "version", no_argument
, NULL
, 'V' },
180 { "tty", no_argument
, NULL
, 't' },
181 { "nw", no_argument
, NULL
, 't' },
182 { "create-frame", no_argument
, NULL
, 'c' },
183 { "alternate-editor", required_argument
, NULL
, 'a' },
184 { "frame-parameters", required_argument
, NULL
, 'F' },
185 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
186 { "socket-name", required_argument
, NULL
, 's' },
188 { "server-file", required_argument
, NULL
, 'f' },
189 { "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)
212 char *get_current_dir_name (void);
214 /* Return the current working directory. Returns NULL on errors.
215 Any other returned value must be freed with free. This is used
216 only when get_current_dir_name is not defined on the system. */
218 get_current_dir_name (void)
222 struct stat dotstat
, pwdstat
;
223 /* If PWD is accurate, use it instead of calling getcwd. PWD is
224 sometimes a nicer name, and using it may avoid a fatal error if a
225 parent directory is searchable but not readable. */
226 if ((pwd
= egetenv ("PWD")) != 0
227 && (IS_DIRECTORY_SEP (*pwd
) || (*pwd
&& IS_DEVICE_SEP (pwd
[1])))
228 && stat (pwd
, &pwdstat
) == 0
229 && stat (".", &dotstat
) == 0
230 && dotstat
.st_ino
== pwdstat
.st_ino
231 && dotstat
.st_dev
== pwdstat
.st_dev
233 && strlen (pwd
) < MAXPATHLEN
237 buf
= (char *) xmalloc (strlen (pwd
) + 1);
242 size_t buf_size
= 1024;
246 buf
= malloc (buf_size
);
249 if (getcwd (buf
, buf_size
) == buf
)
253 if (tmp_errno
!= ERANGE
)
272 /* Like strdup but get a fatal error if memory is exhausted. */
275 xstrdup (const char *s
)
277 char *result
= strdup (s
);
286 #define REG_ROOT "SOFTWARE\\GNU\\Emacs"
288 /* Retrieve an environment variable from the Emacs subkeys of the registry.
289 Return NULL if the variable was not found, or it was empty.
290 This code is based on w32_get_resource (w32.c). */
292 w32_get_resource (HKEY predefined
, char *key
, LPDWORD type
)
294 HKEY hrootkey
= NULL
;
298 if (RegOpenKeyEx (predefined
, REG_ROOT
, 0, KEY_READ
, &hrootkey
) == ERROR_SUCCESS
)
300 if (RegQueryValueEx (hrootkey
, key
, NULL
, NULL
, NULL
, &cbData
) == ERROR_SUCCESS
)
302 result
= (char *) xmalloc (cbData
);
304 if ((RegQueryValueEx (hrootkey
, key
, NULL
, type
, result
, &cbData
) != ERROR_SUCCESS
)
312 RegCloseKey (hrootkey
);
319 getenv wrapper for Windows
321 Value is allocated on the heap, and can be free'd.
323 This is needed to duplicate Emacs's behavior, which is to look for
324 environment variables in the registry if they don't appear in the
327 w32_getenv (char *envvar
)
332 if ((value
= getenv (envvar
)))
333 /* Found in the environment. strdup it, because values returned
334 by getenv cannot be free'd. */
335 return xstrdup (value
);
337 if (! (value
= w32_get_resource (HKEY_CURRENT_USER
, envvar
, &dwType
)) &&
338 ! (value
= w32_get_resource (HKEY_LOCAL_MACHINE
, envvar
, &dwType
)))
340 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
341 if (strcmp (envvar
, "TERM") == 0)
342 return xstrdup ("w32console");
343 /* Found neither in the environment nor in the registry. */
347 if (dwType
== REG_SZ
)
348 /* Registry; no need to expand. */
351 if (dwType
== REG_EXPAND_SZ
)
355 if ((size
= ExpandEnvironmentStrings (value
, NULL
, 0)))
357 char *buffer
= (char *) xmalloc (size
);
358 if (ExpandEnvironmentStrings (value
, buffer
, size
))
360 /* Found and expanded. */
365 /* Error expanding. */
370 /* Not the right type, or not correctly expanded. */
377 w32_window_app (void)
379 static int window_app
= -1;
380 char szTitle
[MAX_PATH
];
384 /* Checking for STDOUT does not work; it's a valid handle also in
385 nonconsole apps. Testing for the console title seems to work. */
386 window_app
= (GetConsoleTitleA (szTitle
, MAX_PATH
) == 0);
388 InitCommonControls ();
394 /* execvp wrapper for Windows. Quotes arguments with embedded spaces.
396 This is necessary due to the broken implementation of exec* routines in
397 the Microsoft libraries: they concatenate the arguments together without
398 quoting special characters, and pass the result to CreateProcess, with
399 predictably bad results. By contrast, POSIX execvp passes the arguments
400 directly into the argv array of the child process. */
403 w32_execvp (const char *path
, char **argv
)
406 extern int execvp (const char*, char **);
408 /* Required to allow a .BAT script as alternate editor. */
409 argv
[0] = (char *) alternate_editor
;
411 for (i
= 0; argv
[i
]; i
++)
412 if (strchr (argv
[i
], ' '))
414 char *quoted
= alloca (strlen (argv
[i
]) + 3);
415 sprintf (quoted
, "\"%s\"", argv
[i
]);
419 return execvp (path
, argv
);
423 #define execvp w32_execvp
425 /* Emulation of ttyname for Windows. */
432 #endif /* WINDOWSNT */
434 /* Display a normal or error message.
435 On Windows, use a message box if compiled as a Windows app. */
436 static void message (int, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
438 message (int is_error
, const char *format
, ...)
442 va_start (args
, format
);
445 if (w32_window_app ())
448 vsnprintf (msg
, sizeof msg
, format
, args
);
449 msg
[sizeof msg
- 1] = '\0';
452 MessageBox (NULL
, msg
, "Emacsclient ERROR", MB_ICONERROR
);
454 MessageBox (NULL
, msg
, "Emacsclient", MB_ICONINFORMATION
);
459 FILE *f
= is_error
? stderr
: stdout
;
461 vfprintf (f
, format
, args
);
468 /* Decode the options from argv and argc.
469 The global variable `optind' will say how many arguments we used up. */
472 decode_options (int argc
, char **argv
)
474 alternate_editor
= egetenv ("ALTERNATE_EDITOR");
478 int opt
= getopt_long_only (argc
, argv
,
479 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
492 /* If getopt returns 0, then it has already processed a
493 long-named option. We should do nothing. */
497 alternate_editor
= optarg
;
500 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
502 socket_name
= optarg
;
507 server_file
= optarg
;
510 /* We used to disallow this argument in w32, but it seems better
511 to allow it, for the occasional case where the user is
512 connecting with a w32 client to a server compiled with X11
531 message (FALSE
, "emacsclient %s\n", VERSION
);
550 print_help_and_exit ();
554 frame_parameters
= optarg
;
558 message (TRUE
, "Try `%s --help' for more information\n", progname
);
564 /* If the -c option is used (without -t) and no --display argument
565 is provided, try $DISPLAY.
566 Without the -c option, we used to set `display' to $DISPLAY by
567 default, but this changed the default behavior and is sometimes
568 inconvenient. So we force users to use "--display $DISPLAY" if
569 they want Emacs to connect to their current display.
571 Some window systems have a notion of default display not
572 reflected in the DISPLAY variable. If the user didn't give us an
573 explicit display, try this platform-specific after trying the
574 display in DISPLAY (if any). */
575 if (!current_frame
&& !tty
&& !display
)
577 /* Set these here so we use a default_display only when the user
578 didn't give us an explicit display. */
579 #if defined (NS_IMPL_COCOA)
581 #elif defined (HAVE_NTGUI)
585 display
= egetenv ("DISPLAY");
590 display
= alt_display
;
594 /* A null-string display is invalid. */
595 if (display
&& strlen (display
) == 0)
598 /* If no display is available, new frames are tty frames. */
599 if (!current_frame
&& !display
)
603 /* Emacs on Windows does not support graphical and text terminal
604 frames in the same instance. So, treat the -t and -c options as
605 equivalent, and open a new frame on the server's terminal.
606 Ideally, we would only set tty = 1 when the serve is running in a
607 console, but alas we don't know that. As a workaround, always
608 ask for a tty frame, and let server.el figure it out. */
615 if (alternate_editor
&& alternate_editor
[0] == '\0')
617 message (TRUE
, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
621 #endif /* WINDOWSNT */
625 static _Noreturn
void
626 print_help_and_exit (void)
628 /* Spaces and tabs are significant in this message; they're chosen so the
629 message aligns properly both in a tty and in a Windows message box.
630 Please try to preserve them; otherwise the output is very hard to read
631 when using emacsclientw. */
633 "Usage: %s [OPTIONS] FILE...\n\
634 Tell the Emacs server to visit the specified files.\n\
635 Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
637 The following OPTIONS are accepted:\n\
638 -V, --version Just print version info and return\n\
639 -H, --help Print this usage information message\n\
640 -nw, -t, --tty Open a new Emacs frame on the current terminal\n\
641 -c, --create-frame Create a new frame instead of trying to\n\
642 use the current Emacs frame\n\
643 -F ALIST, --frame-parameters=ALIST\n\
644 Set the parameters of a new frame\n\
645 -e, --eval Evaluate the FILE arguments as ELisp expressions\n\
646 -n, --no-wait Don't wait for the server to return\n\
647 -q, --quiet Don't display messages on success\n\
648 -d DISPLAY, --display=DISPLAY\n\
649 Visit the file in the given display\n\
650 --parent-id=ID Open in parent window ID, via XEmbed\n"
651 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
652 "-s SOCKET, --socket-name=SOCKET\n\
653 Set filename of the UNIX socket for communication\n"
655 "-f SERVER, --server-file=SERVER\n\
656 Set filename of the TCP authentication file\n\
657 -a EDITOR, --alternate-editor=EDITOR\n\
658 Editor to fallback to if the server is not running\n"
660 " If EDITOR is the empty string, start Emacs in daemon\n\
661 mode and try connecting again\n"
662 #endif /* not WINDOWSNT */
664 Report bugs with M-x report-emacs-bug.\n", progname
);
668 /* Try to run a different command, or --if no alternate editor is
669 defined-- exit with an errorcode.
670 Uses argv, but gets it from the global variable main_argv. */
672 static _Noreturn
void
675 if (alternate_editor
)
679 execvp (alternate_editor
, main_argv
+ i
);
680 message (TRUE
, "%s: error executing alternate editor \"%s\"\n",
681 progname
, alternate_editor
);
687 #if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
690 main (int argc
, char **argv
)
694 message (TRUE
, "%s: Sorry, the Emacs server is supported only\n"
695 "on systems with Berkeley sockets.\n",
700 #else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
702 #define AUTH_KEY_LENGTH 64
703 #define SEND_BUFFER_SIZE 4096
705 /* Buffer to accumulate data to send in TCP connections. */
706 char send_buffer
[SEND_BUFFER_SIZE
+ 1];
707 int sblen
= 0; /* Fill pointer for the send buffer. */
708 /* Socket used to communicate with the Emacs server process. */
709 HSOCKET emacs_socket
= 0;
711 /* On Windows, the socket library was historically separate from the
712 standard C library, so errors are handled differently. */
715 sock_err_message (const char *function_name
)
720 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
721 | FORMAT_MESSAGE_ALLOCATE_BUFFER
722 | FORMAT_MESSAGE_ARGUMENT_ARRAY
,
723 NULL
, WSAGetLastError (), 0, (LPTSTR
)&msg
, 0, NULL
);
725 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, msg
);
729 message (TRUE
, "%s: %s: %s\n", progname
, function_name
, strerror (errno
));
734 /* Let's send the data to Emacs when either
735 - the data ends in "\n", or
736 - the buffer is full (but this shouldn't happen)
737 Otherwise, we just accumulate it. */
739 send_to_emacs (HSOCKET s
, const char *data
)
746 dlen
= strlen (data
);
749 size_t part
= min (dlen
, SEND_BUFFER_SIZE
- sblen
);
750 memcpy (&send_buffer
[sblen
], data
, part
);
754 if (sblen
== SEND_BUFFER_SIZE
755 || (sblen
> 0 && send_buffer
[sblen
-1] == '\n'))
757 int sent
= send (s
, send_buffer
, sblen
, 0);
760 message (TRUE
, "%s: failed to send %d bytes to socket: %s\n",
761 progname
, sblen
, strerror (errno
));
765 memmove (send_buffer
, &send_buffer
[sent
], sblen
- sent
);
774 /* In STR, insert a & before each &, each space, each newline, and
775 any initial -. Change spaces to underscores, too, so that the
776 return value never contains a space.
778 Does not change the string. Outputs the result to S. */
780 quote_argument (HSOCKET s
, const char *str
)
782 char *copy
= (char *) xmalloc (strlen (str
) * 2 + 1);
804 if (*p
== '&' || (*p
== '-' && p
== str
))
811 send_to_emacs (s
, copy
);
817 /* The inverse of quote_argument. Removes quoting in string STR by
818 modifying the string in place. Returns STR. */
821 unquote_argument (char *str
)
852 file_name_absolute_p (const char *filename
)
854 /* Sanity check, it shouldn't happen. */
855 if (! filename
) return FALSE
;
857 /* /xxx is always an absolute path. */
858 if (filename
[0] == '/') return TRUE
;
860 /* Empty filenames (which shouldn't happen) are relative. */
861 if (filename
[0] == '\0') return FALSE
;
864 /* X:\xxx is always absolute. */
865 if (isalpha ((unsigned char) filename
[0])
866 && filename
[1] == ':' && (filename
[2] == '\\' || filename
[2] == '/'))
869 /* Both \xxx and \\xxx\yyy are absolute. */
870 if (filename
[0] == '\\') return TRUE
;
877 /* Wrapper to make WSACleanup a cdecl, as required by atexit. */
884 /* Initialize the WinSock2 library. */
886 initialize_sockets (void)
890 if (WSAStartup (MAKEWORD (2, 0), &wsaData
))
892 message (TRUE
, "%s: error initializing WinSock2\n", progname
);
896 atexit (close_winsock
);
898 #endif /* WINDOWSNT */
901 /* Read the information needed to set up a TCP comm channel with
902 the Emacs server: host, port, and authentication string. */
905 get_server_config (const char *config_file
, struct sockaddr_in
*server
,
906 char *authentication
)
912 if (file_name_absolute_p (config_file
))
913 config
= fopen (config_file
, "rb");
916 const char *home
= egetenv ("HOME");
920 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
923 strcat (path
, "/.emacs.d/server/");
924 strcat (path
, config_file
);
925 config
= fopen (path
, "rb");
929 if (!config
&& (home
= egetenv ("APPDATA")))
931 char *path
= xmalloc (strlen (home
) + strlen (config_file
)
934 strcat (path
, "/.emacs.d/server/");
935 strcat (path
, config_file
);
936 config
= fopen (path
, "rb");
945 if (fgets (dotted
, sizeof dotted
, config
)
946 && (port
= strchr (dotted
, ':')))
950 message (TRUE
, "%s: invalid configuration info\n", progname
);
954 server
->sin_family
= AF_INET
;
955 server
->sin_addr
.s_addr
= inet_addr (dotted
);
956 server
->sin_port
= htons (atoi (port
));
958 if (! fread (authentication
, AUTH_KEY_LENGTH
, 1, config
))
960 message (TRUE
, "%s: cannot read authentication info\n", progname
);
970 set_tcp_socket (const char *local_server_file
)
973 struct sockaddr_in server
;
974 struct linger l_arg
= {1, 1};
975 char auth_string
[AUTH_KEY_LENGTH
+ 1];
977 if (! get_server_config (local_server_file
, &server
, auth_string
))
978 return INVALID_SOCKET
;
980 if (server
.sin_addr
.s_addr
!= inet_addr ("127.0.0.1") && !quiet
)
981 message (FALSE
, "%s: connected to remote socket at %s\n",
982 progname
, inet_ntoa (server
.sin_addr
));
984 /* Open up an AF_INET socket. */
985 if ((s
= socket (AF_INET
, SOCK_STREAM
, IPPROTO_TCP
)) < 0)
987 sock_err_message ("socket");
988 return INVALID_SOCKET
;
991 /* Set up the socket. */
992 if (connect (s
, (struct sockaddr
*) &server
, sizeof server
) < 0)
994 sock_err_message ("connect");
995 return INVALID_SOCKET
;
998 setsockopt (s
, SOL_SOCKET
, SO_LINGER
, (char *) &l_arg
, sizeof l_arg
);
1000 /* Send the authentication. */
1001 auth_string
[AUTH_KEY_LENGTH
] = '\0';
1003 send_to_emacs (s
, "-auth ");
1004 send_to_emacs (s
, auth_string
);
1005 send_to_emacs (s
, " ");
1011 /* Returns 1 if PREFIX is a prefix of STRING. */
1013 strprefix (const char *prefix
, const char *string
)
1015 return !strncmp (prefix
, string
, strlen (prefix
));
1018 /* Get tty name and type. If successful, return the type in TTY_TYPE
1019 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1020 is zero, or return 0 if NOABORT is non-zero. */
1023 find_tty (const char **tty_type
, const char **tty_name
, int noabort
)
1025 const char *type
= egetenv ("TERM");
1026 const char *name
= ttyname (fileno (stdout
));
1034 message (TRUE
, "%s: could not get terminal name\n", progname
);
1045 message (TRUE
, "%s: please set the TERM variable to your terminal type\n",
1051 if (strcmp (type
, "eterm") == 0)
1057 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
1058 message (TRUE
, "%s: opening a frame in an Emacs term buffer"
1059 " is not supported\n", progname
);
1070 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1072 /* Three possibilities:
1073 2 - can't be `stat'ed (sets errno)
1074 1 - isn't owned by us
1075 0 - success: none of the above */
1078 socket_status (const char *name
)
1080 struct stat statbfr
;
1082 if (stat (name
, &statbfr
) == -1)
1085 if (statbfr
.st_uid
!= geteuid ())
1092 /* A signal handler that passes the signal to the Emacs process.
1093 Useful for SIGWINCH. */
1096 pass_signal_to_emacs (int signalnum
)
1098 int old_errno
= errno
;
1101 kill (emacs_pid
, signalnum
);
1103 signal (signalnum
, pass_signal_to_emacs
);
1107 /* Signal handler for SIGCONT; notify the Emacs process that it can
1108 now resume our tty frame. */
1111 handle_sigcont (int signalnum
)
1113 int old_errno
= errno
;
1115 if (tcgetpgrp (1) == getpgrp ())
1117 /* We are in the foreground. */
1118 send_to_emacs (emacs_socket
, "-resume \n");
1122 /* We are in the background; cancel the continue. */
1126 signal (signalnum
, handle_sigcont
);
1130 /* Signal handler for SIGTSTP; notify the Emacs process that we are
1131 going to sleep. Normally the suspend is initiated by Emacs via
1132 server-handle-suspend-tty, but if the server gets out of sync with
1133 reality, we may get a SIGTSTP on C-z. Handling this signal and
1134 notifying Emacs about it should get things under control again. */
1137 handle_sigtstp (int signalnum
)
1139 int old_errno
= errno
;
1143 send_to_emacs (emacs_socket
, "-suspend \n");
1145 /* Unblock this signal and call the default handler by temporarily
1146 changing the handler and resignaling. */
1147 sigprocmask (SIG_BLOCK
, NULL
, &set
);
1148 sigdelset (&set
, signalnum
);
1149 signal (signalnum
, SIG_DFL
);
1151 sigprocmask (SIG_SETMASK
, &set
, NULL
); /* Let's the above signal through. */
1152 signal (signalnum
, handle_sigtstp
);
1158 /* Set up signal handlers before opening a frame on the current tty. */
1163 /* Set up signal handlers. */
1164 signal (SIGWINCH
, pass_signal_to_emacs
);
1166 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1167 deciding which terminal the signal came from. C-g is now a
1168 normal input event on secondary terminals. */
1170 signal (SIGINT
, pass_signal_to_emacs
);
1171 signal (SIGQUIT
, pass_signal_to_emacs
);
1174 signal (SIGCONT
, handle_sigcont
);
1175 signal (SIGTSTP
, handle_sigtstp
);
1176 signal (SIGTTOU
, handle_sigtstp
);
1181 set_local_socket (const char *local_socket_name
)
1184 struct sockaddr_un server
;
1186 /* Open up an AF_UNIX socket in this person's home directory. */
1187 if ((s
= socket (AF_UNIX
, SOCK_STREAM
, 0)) < 0)
1189 message (TRUE
, "%s: socket: %s\n", progname
, strerror (errno
));
1190 return INVALID_SOCKET
;
1193 server
.sun_family
= AF_UNIX
;
1199 const char *server_name
= local_socket_name
;
1200 const char *tmpdir
IF_LINT ( = NULL
);
1201 char *tmpdir_storage
= NULL
;
1202 char *socket_name_storage
= NULL
;
1204 if (!strchr (local_socket_name
, '/') && !strchr (local_socket_name
, '\\'))
1206 /* socket_name is a file name component. */
1207 long uid
= geteuid ();
1208 ptrdiff_t tmpdirlen
;
1210 tmpdir
= egetenv ("TMPDIR");
1214 #ifndef _CS_DARWIN_USER_TEMP_DIR
1215 #define _CS_DARWIN_USER_TEMP_DIR 65537
1217 size_t n
= confstr (_CS_DARWIN_USER_TEMP_DIR
, NULL
, (size_t) 0);
1220 tmpdir
= tmpdir_storage
= xmalloc (n
);
1221 confstr (_CS_DARWIN_USER_TEMP_DIR
, tmpdir_storage
, n
);
1227 tmpdirlen
= strlen (tmpdir
);
1228 socket_name_storage
=
1229 xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1230 strcpy (socket_name_storage
, tmpdir
);
1231 sprintf (socket_name_storage
+ tmpdirlen
, "/emacs%ld/", uid
);
1232 strcat (socket_name_storage
+ tmpdirlen
, server_name
);
1233 local_socket_name
= socket_name_storage
;
1236 if (strlen (local_socket_name
) < sizeof (server
.sun_path
))
1237 strcpy (server
.sun_path
, local_socket_name
);
1240 message (TRUE
, "%s: socket-name %s too long\n",
1241 progname
, local_socket_name
);
1245 /* See if the socket exists, and if it's owned by us. */
1246 sock_status
= socket_status (server
.sun_path
);
1247 saved_errno
= errno
;
1248 if (sock_status
&& use_tmpdir
)
1250 /* Failing that, see if LOGNAME or USER exist and differ from
1251 our euid. If so, look for a socket based on the UID
1252 associated with the name. This is reminiscent of the logic
1253 that init_editfns uses to set the global Vuser_full_name. */
1255 const char *user_name
= egetenv ("LOGNAME");
1258 user_name
= egetenv ("USER");
1262 struct passwd
*pw
= getpwnam (user_name
);
1264 if (pw
&& (pw
->pw_uid
!= geteuid ()))
1266 /* We're running under su, apparently. */
1267 long uid
= pw
->pw_uid
;
1268 ptrdiff_t tmpdirlen
= strlen (tmpdir
);
1269 char *user_socket_name
1270 = xmalloc (tmpdirlen
+ strlen (server_name
) + EXTRA_SPACE
);
1271 strcpy (user_socket_name
, tmpdir
);
1272 sprintf (user_socket_name
+ tmpdirlen
, "/emacs%ld/", uid
);
1273 strcat (user_socket_name
+ tmpdirlen
, server_name
);
1275 if (strlen (user_socket_name
) < sizeof (server
.sun_path
))
1276 strcpy (server
.sun_path
, user_socket_name
);
1279 message (TRUE
, "%s: socket-name %s too long\n",
1280 progname
, user_socket_name
);
1281 exit (EXIT_FAILURE
);
1283 free (user_socket_name
);
1285 sock_status
= socket_status (server
.sun_path
);
1286 saved_errno
= errno
;
1289 errno
= saved_errno
;
1293 free (socket_name_storage
);
1294 free (tmpdir_storage
);
1296 switch (sock_status
)
1299 /* There's a socket, but it isn't owned by us. This is OK if
1301 if (0 != geteuid ())
1303 message (TRUE
, "%s: Invalid socket owner\n", progname
);
1304 return INVALID_SOCKET
;
1310 if (saved_errno
== ENOENT
)
1312 "%s: can't find socket; have you started the server?\n\
1313 To start the server in Emacs, type \"M-x server-start\".\n",
1316 message (TRUE
, "%s: can't stat %s: %s\n",
1317 progname
, server
.sun_path
, strerror (saved_errno
));
1318 return INVALID_SOCKET
;
1322 if (connect (s
, (struct sockaddr
*) &server
, strlen (server
.sun_path
) + 2)
1325 message (TRUE
, "%s: connect: %s\n", progname
, strerror (errno
));
1326 return INVALID_SOCKET
;
1331 #endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1334 set_socket (int no_exit_if_error
)
1337 const char *local_server_file
= server_file
;
1341 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1342 /* Explicit --socket-name argument. */
1345 s
= set_local_socket (socket_name
);
1346 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1348 message (TRUE
, "%s: error accessing socket \"%s\"\n",
1349 progname
, socket_name
);
1350 exit (EXIT_FAILURE
);
1354 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
1355 if (!local_server_file
)
1356 local_server_file
= egetenv ("EMACS_SERVER_FILE");
1358 if (local_server_file
)
1360 s
= set_tcp_socket (local_server_file
);
1361 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1364 message (TRUE
, "%s: error accessing server file \"%s\"\n",
1365 progname
, local_server_file
);
1366 exit (EXIT_FAILURE
);
1369 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1370 /* Implicit local socket. */
1371 s
= set_local_socket ("server");
1372 if (s
!= INVALID_SOCKET
)
1376 /* Implicit server file. */
1377 s
= set_tcp_socket ("server");
1378 if ((s
!= INVALID_SOCKET
) || no_exit_if_error
)
1381 /* No implicit or explicit socket, and no alternate editor. */
1382 message (TRUE
, "%s: No socket or alternate editor. Please use:\n\n"
1383 #ifndef NO_SOCKETS_IN_FILE_SYSTEM
1386 "\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1387 \t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1389 exit (EXIT_FAILURE
);
1393 FARPROC set_fg
; /* Pointer to AllowSetForegroundWindow. */
1394 FARPROC get_wc
; /* Pointer to RealGetWindowClassA. */
1397 w32_set_user_model_id (void)
1400 HRESULT (WINAPI
* set_user_model
) (wchar_t * id
);
1402 /* On Windows 7 and later, we need to set the user model ID
1403 to associate emacsclient launched files with Emacs frames
1405 shell
= LoadLibrary ("shell32.dll");
1409 = (void *) GetProcAddress (shell
,
1410 "SetCurrentProcessExplicitAppUserModelID");
1411 /* If the function is defined, then we are running on Windows 7
1412 or newer, and the UI uses this to group related windows
1413 together. Since emacs, runemacs, emacsclient are related, we
1414 want them grouped even though the executables are different,
1415 so we need to set a consistent ID between them. */
1417 set_user_model (L
"GNU.Emacs");
1419 FreeLibrary (shell
);
1424 w32_find_emacs_process (HWND hWnd
, LPARAM 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. */
1447 /* Search for a window of class "Emacs" and owned by a process with
1448 process id = emacs_pid. If found, allow it to grab the focus. */
1451 w32_give_focus (void)
1455 /* It shouldn't happen when dealing with TCP sockets. */
1456 if (!emacs_pid
) return;
1458 user32
= GetModuleHandle ("user32.dll");
1463 /* Modern Windows restrict which processes can set the foreground window.
1464 emacsclient can allow Emacs to grab the focus by calling the function
1465 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1466 NT) lack this function, so we have to check its availability. */
1467 if ((set_fg
= GetProcAddress (user32
, "AllowSetForegroundWindow"))
1468 && (get_wc
= GetProcAddress (user32
, "RealGetWindowClassA")))
1469 EnumWindows (w32_find_emacs_process
, (LPARAM
) 0);
1471 #endif /* HAVE_NTGUI */
1473 /* Start the emacs daemon and try to connect to it. */
1476 start_daemon_and_retry_set_socket (void)
1487 w
= waitpid (dpid
, &status
, WUNTRACED
| WCONTINUED
);
1489 if ((w
== -1) || !WIFEXITED (status
) || WEXITSTATUS (status
))
1491 message (TRUE
, "Error: Could not start the Emacs daemon\n");
1492 exit (EXIT_FAILURE
);
1495 /* Try connecting, the daemon should have started by now. */
1496 message (TRUE
, "Emacs daemon should have started, trying to connect again\n");
1497 if ((emacs_socket
= set_socket (1)) == INVALID_SOCKET
)
1499 message (TRUE
, "Error: Cannot connect even after starting the Emacs daemon\n");
1500 exit (EXIT_FAILURE
);
1505 fprintf (stderr
, "Error: Cannot fork!\n");
1506 exit (EXIT_FAILURE
);
1510 char emacs
[] = "emacs";
1511 char daemon_option
[] = "--daemon";
1512 char *d_argv
[] = {emacs
, daemon_option
, 0 };
1513 if (socket_name
!= NULL
)
1515 /* Pass --daemon=socket_name as argument. */
1516 const char *deq
= "--daemon=";
1517 char *daemon_arg
= xmalloc (strlen (deq
)
1518 + strlen (socket_name
) + 1);
1519 strcpy (daemon_arg
, deq
);
1520 strcat (daemon_arg
, socket_name
);
1521 d_argv
[1] = daemon_arg
;
1523 execvp ("emacs", d_argv
);
1524 message (TRUE
, "%s: error starting emacs daemon\n", progname
);
1526 #endif /* WINDOWSNT */
1530 main (int argc
, char **argv
)
1532 int rl
= 0, needlf
= 0;
1534 char string
[BUFSIZ
+1];
1535 int start_daemon_if_needed
;
1536 int exit_status
= EXIT_SUCCESS
;
1542 /* On Windows 7 and later, we need to explicitly associate
1543 emacsclient with emacs so the UI behaves sensibly. This
1544 association does no harm if we're not actually connecting to an
1545 Emacs using a window display. */
1546 w32_set_user_model_id ();
1547 #endif /* HAVE_NTGUI */
1549 /* Process options. */
1550 decode_options (argc
, argv
);
1552 if ((argc
- optind
< 1) && !eval
&& current_frame
)
1554 message (TRUE
, "%s: file name or argument required\n"
1555 "Try `%s --help' for more information\n",
1556 progname
, progname
);
1557 exit (EXIT_FAILURE
);
1560 /* If alternate_editor is the empty string, start the emacs daemon
1561 in case of failure to connect. */
1562 start_daemon_if_needed
= (alternate_editor
1563 && (alternate_editor
[0] == '\0'));
1565 emacs_socket
= set_socket (alternate_editor
|| start_daemon_if_needed
);
1566 if (emacs_socket
== INVALID_SOCKET
)
1568 if (! start_daemon_if_needed
)
1571 start_daemon_and_retry_set_socket ();
1574 cwd
= get_current_dir_name ();
1577 message (TRUE
, "%s: %s\n", progname
,
1578 "Cannot get current working directory");
1583 if (display
&& !strcmp (display
, "w32"))
1585 #endif /* HAVE_NTGUI */
1587 /* Send over our environment and current directory. */
1591 for (i
= 0; environ
[i
]; i
++)
1593 send_to_emacs (emacs_socket
, "-env ");
1594 quote_argument (emacs_socket
, environ
[i
]);
1595 send_to_emacs (emacs_socket
, " ");
1598 send_to_emacs (emacs_socket
, "-dir ");
1599 quote_argument (emacs_socket
, cwd
);
1600 send_to_emacs (emacs_socket
, "/");
1601 send_to_emacs (emacs_socket
, " ");
1605 send_to_emacs (emacs_socket
, "-nowait ");
1608 send_to_emacs (emacs_socket
, "-current-frame ");
1612 send_to_emacs (emacs_socket
, "-display ");
1613 quote_argument (emacs_socket
, display
);
1614 send_to_emacs (emacs_socket
, " ");
1619 send_to_emacs (emacs_socket
, "-parent-id ");
1620 quote_argument (emacs_socket
, parent_id
);
1621 send_to_emacs (emacs_socket
, " ");
1624 if (frame_parameters
&& !current_frame
)
1626 send_to_emacs (emacs_socket
, "-frame-parameters ");
1627 quote_argument (emacs_socket
, frame_parameters
);
1628 send_to_emacs (emacs_socket
, " ");
1631 /* Unless we are certain we don't want to occupy the tty, send our
1632 tty information to Emacs. For example, in daemon mode Emacs may
1633 need to occupy this tty if no other frame is available. */
1634 if (!current_frame
|| !eval
)
1636 const char *tty_type
, *tty_name
;
1638 if (find_tty (&tty_type
, &tty_name
, !tty
))
1640 #if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
1643 send_to_emacs (emacs_socket
, "-tty ");
1644 quote_argument (emacs_socket
, tty_name
);
1645 send_to_emacs (emacs_socket
, " ");
1646 quote_argument (emacs_socket
, tty_type
);
1647 send_to_emacs (emacs_socket
, " ");
1651 if (!current_frame
&& !tty
)
1652 send_to_emacs (emacs_socket
, "-window-system ");
1654 if ((argc
- optind
> 0))
1657 for (i
= optind
; i
< argc
; i
++)
1662 /* Don't prepend cwd or anything like that. */
1663 send_to_emacs (emacs_socket
, "-eval ");
1664 quote_argument (emacs_socket
, argv
[i
]);
1665 send_to_emacs (emacs_socket
, " ");
1669 if (*argv
[i
] == '+')
1671 char *p
= argv
[i
] + 1;
1672 while (isdigit ((unsigned char) *p
) || *p
== ':') p
++;
1675 send_to_emacs (emacs_socket
, "-position ");
1676 quote_argument (emacs_socket
, argv
[i
]);
1677 send_to_emacs (emacs_socket
, " ");
1682 else if (! file_name_absolute_p (argv
[i
])
1683 && (isalpha (argv
[i
][0]) && argv
[i
][1] == ':'))
1684 /* Windows can have a different default directory for each
1685 drive, so the cwd passed via "-dir" is not sufficient
1686 to account for that.
1687 If the user uses <drive>:<relpath>, we hence need to be
1688 careful to expand <relpath> with the default directory
1689 corresponding to <drive>. */
1691 char *filename
= (char *) xmalloc (MAX_PATH
);
1694 size
= GetFullPathName (argv
[i
], MAX_PATH
, filename
, NULL
);
1695 if (size
> 0 && size
< MAX_PATH
)
1702 send_to_emacs (emacs_socket
, "-file ");
1703 quote_argument (emacs_socket
, argv
[i
]);
1704 send_to_emacs (emacs_socket
, " ");
1709 /* Read expressions interactively. */
1710 while ((str
= fgets (string
, BUFSIZ
, stdin
)))
1712 send_to_emacs (emacs_socket
, "-eval ");
1713 quote_argument (emacs_socket
, str
);
1715 send_to_emacs (emacs_socket
, " ");
1718 send_to_emacs (emacs_socket
, "\n");
1720 /* Wait for an answer. */
1721 if (!eval
&& !tty
&& !nowait
&& !quiet
)
1723 printf ("Waiting for Emacs...");
1727 while (fdatasync (1) != 0 && errno
== EINTR
)
1730 /* Now, wait for an answer and print any messages. */
1731 while (exit_status
== EXIT_SUCCESS
)
1737 rl
= recv (emacs_socket
, string
, BUFSIZ
, 0);
1739 /* If we receive a signal (e.g. SIGWINCH, which we pass
1740 through to Emacs), on some OSes we get EINTR and must retry. */
1741 while (rl
< 0 && errno
== EINTR
);
1748 /* Loop over all NL-terminated messages. */
1749 for (end_p
= p
= string
; end_p
!= NULL
&& *end_p
!= '\0'; p
= end_p
)
1751 end_p
= strchr (p
, '\n');
1755 if (strprefix ("-emacs-pid ", p
))
1757 /* -emacs-pid PID: The process id of the Emacs process. */
1758 emacs_pid
= strtol (p
+ strlen ("-emacs-pid"), NULL
, 10);
1760 else if (strprefix ("-window-system-unsupported ", p
))
1762 /* -window-system-unsupported: Emacs was compiled without support
1763 for whatever window system we tried. Try the alternate
1764 display, or, failing that, try the terminal. */
1767 display
= alt_display
;
1778 else if (strprefix ("-print ", p
))
1780 /* -print STRING: Print STRING on the terminal. */
1781 str
= unquote_argument (p
+ strlen ("-print "));
1785 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1787 else if (strprefix ("-print-nonl ", p
))
1789 /* -print-nonl STRING: Print STRING on the terminal.
1790 Used to continue a preceding -print command. */
1791 str
= unquote_argument (p
+ strlen ("-print-nonl "));
1793 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1795 else if (strprefix ("-error ", p
))
1797 /* -error DESCRIPTION: Signal an error on the terminal. */
1798 str
= unquote_argument (p
+ strlen ("-error "));
1801 fprintf (stderr
, "*ERROR*: %s", str
);
1802 needlf
= str
[0] == '\0' ? needlf
: str
[strlen (str
) - 1] != '\n';
1803 exit_status
= EXIT_FAILURE
;
1806 else if (strprefix ("-suspend ", p
))
1808 /* -suspend: Suspend this terminal, i.e., stop the process. */
1817 /* Unknown command. */
1821 printf ("*ERROR*: Unknown message: %s\n", p
);
1829 while (fdatasync (1) != 0 && errno
== EINTR
)
1833 exit_status
= EXIT_FAILURE
;
1835 CLOSE_SOCKET (emacs_socket
);
1839 #endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */