declare smobs in alloc.c
[bpt/emacs.git] / lib-src / emacsclient.c
CommitLineData
efb859b4 1/* Client process that communicates with GNU Emacs acting as server.
9374581a 2
ba318903 3Copyright (C) 1986-1987, 1994, 1999-2014 Free Software Foundation, Inc.
46cec291
RS
4
5This file is part of GNU Emacs.
6
294981c7 7GNU Emacs is free software: you can redistribute it and/or modify
46cec291 8it under the terms of the GNU General Public License as published by
294981c7
GM
9the Free Software Foundation, either version 3 of the License, or
10(at your option) any later version.
46cec291
RS
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
294981c7 18along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
46cec291
RS
19
20
2f8fe2f4 21#include <config.h>
e69233c2 22
aa0b6932 23#ifdef WINDOWSNT
aa0b6932 24
79432772 25/* ms-w32.h defines these, which disables sockets altogether! */
bc28de71
JB
26# undef _WINSOCKAPI_
27# undef _WINSOCK_H
28
411b80a5
JB
29# include <malloc.h>
30# include <stdlib.h>
42073bfb 31# include <windows.h>
dbf60b07 32# include <commctrl.h>
0613f5d5
DN
33# include <io.h>
34# include <winsock2.h>
411b80a5 35
411b80a5
JB
36# define NO_SOCKETS_IN_FILE_SYSTEM
37
aa0b6932
JB
38# define HSOCKET SOCKET
39# define CLOSE_SOCKET closesocket
aa0b6932 40# define INITIALIZE() (initialize_sockets ())
411b80a5 41
728a982d
DN
42char *w32_getenv (char *);
43#define egetenv(VAR) w32_getenv(VAR)
44
411b80a5
JB
45#else /* !WINDOWSNT */
46
5e0944c6
DC
47# ifdef HAVE_NTGUI
48# include <windows.h>
49# endif /* HAVE_NTGUI */
50
67c1df01 51# include "syswait.h"
ed4a3730 52
1e7823d0
JB
53# ifdef HAVE_INET_SOCKETS
54# include <netinet/in.h>
0613f5d5
DN
55# ifdef HAVE_SOCKETS
56# include <sys/types.h>
57# include <sys/socket.h>
58# include <sys/un.h>
59# endif /* HAVE_SOCKETS */
1e7823d0 60# endif
18d2ad29 61# include <arpa/inet.h>
448d4085 62
e35fc962 63# define INVALID_SOCKET -1
aa0b6932
JB
64# define HSOCKET int
65# define CLOSE_SOCKET close
aa0b6932 66# define INITIALIZE()
411b80a5 67
728a982d
DN
68#define egetenv(VAR) getenv(VAR)
69
411b80a5 70#endif /* !WINDOWSNT */
aa0b6932 71
4e23f2ba 72#undef signal
46cec291 73
42073bfb 74#include <stdarg.h>
e69233c2 75#include <ctype.h>
8f9aaa0a 76#include <stdio.h>
613f7bda 77#include <getopt.h>
4004364e 78#include <unistd.h>
8f9aaa0a 79
0613f5d5 80#include <pwd.h>
dc4a4a14 81#include <sys/stat.h>
9628b887 82#include <signal.h>
4d553a13 83#include <errno.h>
9628b887 84
8f9aaa0a
RS
85#ifndef VERSION
86#define VERSION "unspecified"
87#endif
88\f
aa0b6932
JB
89
90#ifndef EXIT_SUCCESS
91#define EXIT_SUCCESS 0
92#endif
93
94#ifndef EXIT_FAILURE
95#define EXIT_FAILURE 1
96#endif
97
bc558f3e
JB
98/* Additional space when allocating buffers for filenames, etc. */
99#define EXTRA_SPACE 100
100
069a7756
JB
101#ifdef min
102#undef min
103#endif
1e6f32f8
JM
104#define min(x, y) (((x) < (y)) ? (x) : (y))
105
aa0b6932 106\f
8f9aaa0a 107/* Name used to invoke this program. */
728a982d 108const char *progname;
8f9aaa0a 109
0a125897
KL
110/* The second argument to main. */
111char **main_argv;
112
749ae770 113/* Nonzero means don't wait for a response from Emacs. --no-wait. */
8f9aaa0a
RS
114int nowait = 0;
115
0b973fc5
DW
116/* Nonzero means don't print messages for successful operations. --quiet. */
117int quiet = 0;
118
30be2360
SM
119/* Nonzero means args are expressions to be evaluated. --eval. */
120int eval = 0;
121
31fa6595
SM
122/* Nonzero means don't open a new frame. Inverse of --create-frame. */
123int current_frame = 1;
92071250 124
30be2360 125/* The display on which Emacs should work. --display. */
988e88ab 126const char *display = NULL;
30be2360 127
6b59694e
DC
128/* The alternate display we should try if Emacs does not support display. */
129const char *alt_display = NULL;
130
0191e222
CY
131/* The parent window ID, if we are opening a frame via XEmbed. */
132char *parent_id = NULL;
133
9628b887 134/* Nonzero means open a new Emacs frame on the current terminal. */
77134727 135int tty = 0;
9628b887 136
30be2360
SM
137/* If non-NULL, the name of an editor to fallback to if the server
138 is not running. --alternate-editor. */
b03d27bd 139const char *alternate_editor = NULL;
30be2360 140
3db926be 141/* If non-NULL, the filename of the UNIX socket. */
6b0c8984 142const char *socket_name = NULL;
254107e4 143
aa0b6932 144/* If non-NULL, the filename of the authentication file. */
988e88ab 145const char *server_file = NULL;
aa0b6932 146
c66648e0
JB
147/* PID of the Emacs server process. */
148int emacs_pid = 0;
149
18a4ce5e
AR
150/* If non-NULL, a string that should form a frame parameter alist to
151 be used for the new frame */
152const char *frame_parameters = NULL;
153
845ca893 154static _Noreturn void print_help_and_exit (void);
68441b90 155
7f3bff3e 156
8f9aaa0a
RS
157struct option longopts[] =
158{
749ae770 159 { "no-wait", no_argument, NULL, 'n' },
0b973fc5 160 { "quiet", no_argument, NULL, 'q' },
30be2360 161 { "eval", no_argument, NULL, 'e' },
8f9aaa0a
RS
162 { "help", no_argument, NULL, 'H' },
163 { "version", no_argument, NULL, 'V' },
b28c910d 164 { "tty", no_argument, NULL, 't' },
dc1cd5f7 165 { "nw", no_argument, NULL, 't' },
31fa6595 166 { "create-frame", no_argument, NULL, 'c' },
3cf8c6aa 167 { "alternate-editor", required_argument, NULL, 'a' },
18a4ce5e 168 { "frame-parameters", required_argument, NULL, 'F' },
b03d27bd 169#ifndef NO_SOCKETS_IN_FILE_SYSTEM
254107e4 170 { "socket-name", required_argument, NULL, 's' },
b03d27bd 171#endif
aa0b6932 172 { "server-file", required_argument, NULL, 'f' },
30be2360 173 { "display", required_argument, NULL, 'd' },
0191e222 174 { "parent-id", required_argument, NULL, 'p' },
30be2360 175 { 0, 0, 0, 0 }
8f9aaa0a
RS
176};
177
974b73e8
KL
178\f
179/* Like malloc but get fatal error if memory is exhausted. */
180
17107bb6
PE
181static void *
182xmalloc (size_t size)
974b73e8 183{
17107bb6 184 void *result = malloc (size);
974b73e8
KL
185 if (result == NULL)
186 {
187 perror ("malloc");
188 exit (EXIT_FAILURE);
189 }
190 return result;
191}
192
974b73e8
KL
193/* From sysdep.c */
194#if !defined (HAVE_GET_CURRENT_DIR_NAME) || defined (BROKEN_GET_CURRENT_DIR_NAME)
195
c5443aa5 196char *get_current_dir_name (void);
cb06b8dc 197
974b73e8 198/* Return the current working directory. Returns NULL on errors.
5ab73228 199 Any other returned value must be freed with free. This is used
974b73e8
KL
200 only when get_current_dir_name is not defined on the system. */
201char*
7c3320d8 202get_current_dir_name (void)
974b73e8
KL
203{
204 char *buf;
b9170155 205 const char *pwd;
974b73e8 206 struct stat dotstat, pwdstat;
9239d970 207 /* If PWD is accurate, use it instead of calling getcwd. PWD is
974b73e8
KL
208 sometimes a nicer name, and using it may avoid a fatal error if a
209 parent directory is searchable but not readable. */
7ce8671d 210 if ((pwd = egetenv ("PWD")) != 0
974b73e8
KL
211 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
212 && stat (pwd, &pwdstat) == 0
213 && stat (".", &dotstat) == 0
214 && dotstat.st_ino == pwdstat.st_ino
215 && dotstat.st_dev == pwdstat.st_dev
216#ifdef MAXPATHLEN
217 && strlen (pwd) < MAXPATHLEN
218#endif
219 )
220 {
221 buf = (char *) xmalloc (strlen (pwd) + 1);
974b73e8
KL
222 strcpy (buf, pwd);
223 }
974b73e8
KL
224 else
225 {
226 size_t buf_size = 1024;
974b73e8
KL
227 for (;;)
228 {
17107bb6
PE
229 int tmp_errno;
230 buf = malloc (buf_size);
231 if (! buf)
232 break;
974b73e8
KL
233 if (getcwd (buf, buf_size) == buf)
234 break;
17107bb6
PE
235 tmp_errno = errno;
236 free (buf);
237 if (tmp_errno != ERANGE)
974b73e8 238 {
974b73e8
KL
239 errno = tmp_errno;
240 return NULL;
241 }
242 buf_size *= 2;
17107bb6
PE
243 if (! buf_size)
244 {
245 errno = ENOMEM;
246 return NULL;
247 }
974b73e8
KL
248 }
249 }
974b73e8
KL
250 return buf;
251}
252#endif
253
42073bfb 254#ifdef WINDOWSNT
7ce8671d 255
a54af40e
EZ
256/* Like strdup but get a fatal error if memory is exhausted. */
257
258char *
259xstrdup (const char *s)
260{
261 char *result = strdup (s);
262 if (result == NULL)
263 {
264 perror ("strdup");
265 exit (EXIT_FAILURE);
266 }
267 return result;
268}
269
7ce8671d
JB
270#define REG_ROOT "SOFTWARE\\GNU\\Emacs"
271
272/* Retrieve an environment variable from the Emacs subkeys of the registry.
273 Return NULL if the variable was not found, or it was empty.
274 This code is based on w32_get_resource (w32.c). */
275char *
7c3320d8 276w32_get_resource (HKEY predefined, char *key, LPDWORD type)
7ce8671d
JB
277{
278 HKEY hrootkey = NULL;
279 char *result = NULL;
280 DWORD cbData;
281
282 if (RegOpenKeyEx (predefined, REG_ROOT, 0, KEY_READ, &hrootkey) == ERROR_SUCCESS)
283 {
284 if (RegQueryValueEx (hrootkey, key, NULL, NULL, NULL, &cbData) == ERROR_SUCCESS)
285 {
286 result = (char *) xmalloc (cbData);
287
bc558f3e
JB
288 if ((RegQueryValueEx (hrootkey, key, NULL, type, result, &cbData) != ERROR_SUCCESS)
289 || (*result == 0))
7ce8671d
JB
290 {
291 free (result);
292 result = NULL;
293 }
294 }
295
296 RegCloseKey (hrootkey);
297 }
298
299 return result;
300}
301
302/*
303 getenv wrapper for Windows
304
a54af40e
EZ
305 Value is allocated on the heap, and can be free'd.
306
307 This is needed to duplicate Emacs's behavior, which is to look for
308 environment variables in the registry if they don't appear in the
309 environment. */
7ce8671d 310char *
7c3320d8 311w32_getenv (char *envvar)
7ce8671d
JB
312{
313 char *value;
314 DWORD dwType;
315
657d08d3 316 if ((value = getenv (envvar)))
a54af40e
EZ
317 /* Found in the environment. strdup it, because values returned
318 by getenv cannot be free'd. */
319 return xstrdup (value);
7ce8671d
JB
320
321 if (! (value = w32_get_resource (HKEY_CURRENT_USER, envvar, &dwType)) &&
322 ! (value = w32_get_resource (HKEY_LOCAL_MACHINE, envvar, &dwType)))
d41784ee
EZ
323 {
324 /* "w32console" is what Emacs on Windows uses for tty-type under -nw. */
325 if (strcmp (envvar, "TERM") == 0)
a54af40e 326 return xstrdup ("w32console");
d41784ee
EZ
327 /* Found neither in the environment nor in the registry. */
328 return NULL;
329 }
7ce8671d
JB
330
331 if (dwType == REG_SZ)
332 /* Registry; no need to expand. */
333 return value;
334
335 if (dwType == REG_EXPAND_SZ)
336 {
337 DWORD size;
338
657d08d3 339 if ((size = ExpandEnvironmentStrings (value, NULL, 0)))
7ce8671d
JB
340 {
341 char *buffer = (char *) xmalloc (size);
342 if (ExpandEnvironmentStrings (value, buffer, size))
343 {
344 /* Found and expanded. */
345 free (value);
346 return buffer;
347 }
348
349 /* Error expanding. */
350 free (buffer);
351 }
352 }
353
354 /* Not the right type, or not correctly expanded. */
355 free (value);
356 return NULL;
357}
358
ff90fbde 359
42073bfb 360int
7c3320d8 361w32_window_app (void)
42073bfb
JB
362{
363 static int window_app = -1;
364 char szTitle[MAX_PATH];
365
366 if (window_app < 0)
dbf60b07
JR
367 {
368 /* Checking for STDOUT does not work; it's a valid handle also in
369 nonconsole apps. Testing for the console title seems to work. */
370 window_app = (GetConsoleTitleA (szTitle, MAX_PATH) == 0);
371 if (window_app)
361358ea 372 InitCommonControls ();
dbf60b07 373 }
42073bfb
JB
374
375 return window_app;
376}
105faa84 377
79432772 378/* execvp wrapper for Windows. Quotes arguments with embedded spaces.
105faa84
DN
379
380 This is necessary due to the broken implementation of exec* routines in
381 the Microsoft libraries: they concatenate the arguments together without
382 quoting special characters, and pass the result to CreateProcess, with
7c3320d8 383 predictably bad results. By contrast, POSIX execvp passes the arguments
79432772
JB
384 directly into the argv array of the child process. */
385
105faa84 386int
7c3320d8 387w32_execvp (const char *path, char **argv)
105faa84
DN
388{
389 int i;
ad0a19b7 390 extern int execvp (const char*, char **);
105faa84
DN
391
392 /* Required to allow a .BAT script as alternate editor. */
393 argv[0] = (char *) alternate_editor;
394
395 for (i = 0; argv[i]; i++)
396 if (strchr (argv[i], ' '))
397 {
398 char *quoted = alloca (strlen (argv[i]) + 3);
399 sprintf (quoted, "\"%s\"", argv[i]);
400 argv[i] = quoted;
401 }
402
403 return execvp (path, argv);
404}
405
406#undef execvp
407#define execvp w32_execvp
408
d41784ee
EZ
409/* Emulation of ttyname for Windows. */
410char *
411ttyname (int fd)
412{
413 return "CONOUT$";
414}
415
105faa84 416#endif /* WINDOWSNT */
42073bfb 417
f387c1ee
JB
418/* Display a normal or error message.
419 On Windows, use a message box if compiled as a Windows app. */
96c06863 420static void message (bool, const char *, ...) ATTRIBUTE_FORMAT_PRINTF (2, 3);
b23b5a5b 421static void
96c06863 422message (bool is_error, const char *format, ...)
42073bfb 423{
42073bfb
JB
424 va_list args;
425
b0bbc07d 426 va_start (args, format);
42073bfb
JB
427
428#ifdef WINDOWSNT
429 if (w32_window_app ())
430 {
17107bb6
PE
431 char msg[2048];
432 vsnprintf (msg, sizeof msg, format, args);
433 msg[sizeof msg - 1] = '\0';
434
42073bfb
JB
435 if (is_error)
436 MessageBox (NULL, msg, "Emacsclient ERROR", MB_ICONERROR);
437 else
438 MessageBox (NULL, msg, "Emacsclient", MB_ICONINFORMATION);
439 }
440 else
441#endif
9219db75
JB
442 {
443 FILE *f = is_error ? stderr : stdout;
444
17107bb6 445 vfprintf (f, format, args);
9219db75
JB
446 fflush (f);
447 }
17107bb6
PE
448
449 va_end (args);
42073bfb
JB
450}
451
8f9aaa0a 452/* Decode the options from argv and argc.
5212210c 453 The global variable `optind' will say how many arguments we used up. */
8f9aaa0a 454
b23b5a5b 455static void
873fbd0b 456decode_options (int argc, char **argv)
8f9aaa0a 457{
7ce8671d 458 alternate_editor = egetenv ("ALTERNATE_EDITOR");
0ea5797a 459
8f9aaa0a
RS
460 while (1)
461 {
dc1cd5f7 462 int opt = getopt_long_only (argc, argv,
b03d27bd 463#ifndef NO_SOCKETS_IN_FILE_SYSTEM
3794a2d3 464 "VHneqa:s:f:d:F:tc",
b03d27bd 465#else
3794a2d3 466 "VHneqa:f:d:F:tc",
b03d27bd 467#endif
974b73e8 468 longopts, 0);
8f9aaa0a
RS
469
470 if (opt == EOF)
471 break;
472
473 switch (opt)
474 {
475 case 0:
476 /* If getopt returns 0, then it has already processed a
477 long-named option. We should do nothing. */
478 break;
e69233c2 479
97e3214d
GM
480 case 'a':
481 alternate_editor = optarg;
482 break;
e69233c2 483
b03d27bd 484#ifndef NO_SOCKETS_IN_FILE_SYSTEM
254107e4
RS
485 case 's':
486 socket_name = optarg;
487 break;
b03d27bd 488#endif
254107e4 489
aa0b6932
JB
490 case 'f':
491 server_file = optarg;
492 break;
254107e4 493
0ea5797a
SM
494 /* We used to disallow this argument in w32, but it seems better
495 to allow it, for the occasional case where the user is
496 connecting with a w32 client to a server compiled with X11
497 support. */
30be2360
SM
498 case 'd':
499 display = optarg;
500 break;
501
8f9aaa0a
RS
502 case 'n':
503 nowait = 1;
504 break;
505
30be2360
SM
506 case 'e':
507 eval = 1;
508 break;
509
0b973fc5
DW
510 case 'q':
511 quiet = 1;
512 break;
513
8f9aaa0a 514 case 'V':
96c06863 515 message (false, "emacsclient %s\n", VERSION);
65396510 516 exit (EXIT_SUCCESS);
8f9aaa0a 517 break;
46cec291 518
819b8f00 519 case 't':
77134727 520 tty = 1;
c1b8e896 521 current_frame = 0;
77134727
KL
522 break;
523
e5299d8d 524 case 'c':
31fa6595 525 current_frame = 0;
9628b887 526 break;
0b0d3e0b 527
0191e222
CY
528 case 'p':
529 parent_id = optarg;
530 current_frame = 0;
531 break;
532
8f9aaa0a 533 case 'H':
8f9aaa0a 534 print_help_and_exit ();
20c396e8
JB
535 break;
536
18a4ce5e
AR
537 case 'F':
538 frame_parameters = optarg;
539 break;
540
20c396e8 541 default:
96c06863 542 message (true, "Try `%s --help' for more information\n", progname);
65396510 543 exit (EXIT_FAILURE);
20c396e8 544 break;
8f9aaa0a
RS
545 }
546 }
9628b887 547
273b9028
CY
548 /* If the -c option is used (without -t) and no --display argument
549 is provided, try $DISPLAY.
550 Without the -c option, we used to set `display' to $DISPLAY by
551 default, but this changed the default behavior and is sometimes
552 inconvenient. So we force users to use "--display $DISPLAY" if
6b59694e
DC
553 they want Emacs to connect to their current display.
554
555 Some window systems have a notion of default display not
556 reflected in the DISPLAY variable. If the user didn't give us an
557 explicit display, try this platform-specific after trying the
558 display in DISPLAY (if any). */
09317bf4 559 if (!current_frame && !tty && !display)
e7534fc4 560 {
6b59694e
DC
561 /* Set these here so we use a default_display only when the user
562 didn't give us an explicit display. */
563#if defined (NS_IMPL_COCOA)
564 alt_display = "ns";
565#elif defined (HAVE_NTGUI)
efc3dd3c 566 alt_display = "w32";
e7534fc4 567#endif
6b59694e
DC
568
569 display = egetenv ("DISPLAY");
570 }
571
572 if (!display)
573 {
574 display = alt_display;
575 alt_display = NULL;
e7534fc4 576 }
9997dc15 577
273b9028 578 /* A null-string display is invalid. */
0ea5797a
SM
579 if (display && strlen (display) == 0)
580 display = NULL;
581
273b9028
CY
582 /* If no display is available, new frames are tty frames. */
583 if (!current_frame && !display)
92071250 584 tty = 1;
c0f342ab 585
802bdb3c 586#ifdef WINDOWSNT
9a864fa2
CY
587 /* Emacs on Windows does not support graphical and text terminal
588 frames in the same instance. So, treat the -t and -c options as
589 equivalent, and open a new frame on the server's terminal.
590 Ideally, we would only set tty = 1 when the serve is running in a
591 console, but alas we don't know that. As a workaround, always
592 ask for a tty frame, and let server.el figure it out. */
593 if (!current_frame)
594 {
595 display = NULL;
596 tty = 1;
597 }
598
69157c99 599 if (alternate_editor && alternate_editor[0] == '\0')
802bdb3c 600 {
96c06863 601 message (true, "--alternate-editor argument or ALTERNATE_EDITOR variable cannot be\n\
802bdb3c
DN
602an empty string");
603 exit (EXIT_FAILURE);
604 }
605#endif /* WINDOWSNT */
8f9aaa0a
RS
606}
607
974b73e8 608\f
845ca893 609static _Noreturn void
873fbd0b 610print_help_and_exit (void)
8f9aaa0a 611{
c0f342ab
JB
612 /* Spaces and tabs are significant in this message; they're chosen so the
613 message aligns properly both in a tty and in a Windows message box.
614 Please try to preserve them; otherwise the output is very hard to read
615 when using emacsclientw. */
96c06863 616 message (false,
29abe551 617 "Usage: %s [OPTIONS] FILE...\n%s%s%s", progname, "\
30be2360
SM
618Tell the Emacs server to visit the specified files.\n\
619Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
20c396e8 620\n\
30be2360 621The following OPTIONS are accepted:\n\
c0f342ab
JB
622-V, --version Just print version info and return\n\
623-H, --help Print this usage information message\n\
dc1cd5f7 624-nw, -t, --tty Open a new Emacs frame on the current terminal\n\
c4b858e3 625-c, --create-frame Create a new frame instead of trying to\n\
9dfda22f 626 use the current Emacs frame\n\
29abe551 627", "\
a150502a 628-F ALIST, --frame-parameters=ALIST\n\
5f9388d0 629 Set the parameters of a new frame\n\
c0f342ab 630-e, --eval Evaluate the FILE arguments as ELisp expressions\n\
d07529f3 631-n, --no-wait Don't wait for the server to return\n\
0b973fc5 632-q, --quiet Don't display messages on success\n\
24d5010d 633-d DISPLAY, --display=DISPLAY\n\
0191e222 634 Visit the file in the given display\n\
29abe551 635", "\
0191e222 636--parent-id=ID Open in parent window ID, via XEmbed\n"
aa0b6932 637#ifndef NO_SOCKETS_IN_FILE_SYSTEM
24d5010d 638"-s SOCKET, --socket-name=SOCKET\n\
9dfda22f 639 Set filename of the UNIX socket for communication\n"
aa0b6932 640#endif
24d5010d 641"-f SERVER, --server-file=SERVER\n\
9dfda22f 642 Set filename of the TCP authentication file\n\
24d5010d 643-a EDITOR, --alternate-editor=EDITOR\n\
9dfda22f 644 Editor to fallback to if the server is not running\n"
6133a1a9 645#ifndef WINDOWSNT
c3f995a2
JB
646" If EDITOR is the empty string, start Emacs in daemon\n\
647 mode and try connecting again\n"
6133a1a9 648#endif /* not WINDOWSNT */
c3f995a2 649"\n\
29abe551 650Report bugs with M-x report-emacs-bug.\n");
65396510 651 exit (EXIT_SUCCESS);
8f9aaa0a 652}
5212210c 653
79432772
JB
654/* Try to run a different command, or --if no alternate editor is
655 defined-- exit with an errorcode.
656 Uses argv, but gets it from the global variable main_argv. */
657
845ca893 658static _Noreturn void
974b73e8 659fail (void)
9002956f 660{
aa0b6932 661 if (alternate_editor)
9002956f 662 {
aa0b6932 663 int i = optind - 1;
4472aef4 664
974b73e8 665 execvp (alternate_editor, main_argv + i);
96c06863 666 message (true, "%s: error executing alternate editor \"%s\"\n",
974b73e8 667 progname, alternate_editor);
9002956f 668 }
aa0b6932 669 exit (EXIT_FAILURE);
9002956f
KL
670}
671
aa0b6932 672\f
1e7823d0 673#if !defined (HAVE_SOCKETS) || !defined (HAVE_INET_SOCKETS)
9002956f 674
aa0b6932 675int
0613f5d5 676main (int argc, char **argv)
9002956f 677{
974b73e8
KL
678 main_argv = argv;
679 progname = argv[0];
96c06863 680 message (true, "%s: Sorry, the Emacs server is supported only\n"
c0f342ab 681 "on systems with Berkeley sockets.\n",
aa0b6932 682 argv[0]);
974b73e8 683 fail ();
9002956f
KL
684}
685
1e7823d0 686#else /* HAVE_SOCKETS && HAVE_INET_SOCKETS */
2828d5f9 687
aa0b6932
JB
688#define AUTH_KEY_LENGTH 64
689#define SEND_BUFFER_SIZE 4096
690
aa0b6932
JB
691/* Buffer to accumulate data to send in TCP connections. */
692char send_buffer[SEND_BUFFER_SIZE + 1];
693int sblen = 0; /* Fill pointer for the send buffer. */
4b7b77f6
JR
694/* Socket used to communicate with the Emacs server process. */
695HSOCKET emacs_socket = 0;
aa0b6932 696
79432772
JB
697/* On Windows, the socket library was historically separate from the
698 standard C library, so errors are handled differently. */
699
b23b5a5b 700static void
988e88ab 701sock_err_message (const char *function_name)
d22b00e5
JR
702{
703#ifdef WINDOWSNT
704 char* msg = NULL;
705
706 FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM
707 | FORMAT_MESSAGE_ALLOCATE_BUFFER
708 | FORMAT_MESSAGE_ARGUMENT_ARRAY,
709 NULL, WSAGetLastError (), 0, (LPTSTR)&msg, 0, NULL);
710
96c06863 711 message (true, "%s: %s: %s\n", progname, function_name, msg);
d22b00e5
JR
712
713 LocalFree (msg);
714#else
96c06863 715 message (true, "%s: %s: %s\n", progname, function_name, strerror (errno));
d22b00e5
JR
716#endif
717}
718
719
aa0b6932
JB
720/* Let's send the data to Emacs when either
721 - the data ends in "\n", or
722 - the buffer is full (but this shouldn't happen)
723 Otherwise, we just accumulate it. */
b23b5a5b 724static void
988e88ab 725send_to_emacs (HSOCKET s, const char *data)
aa0b6932 726{
1e6f32f8
JM
727 size_t dlen;
728
729 if (!data)
730 return;
731
732 dlen = strlen (data);
733 while (*data)
2828d5f9 734 {
1e6f32f8
JM
735 size_t part = min (dlen, SEND_BUFFER_SIZE - sblen);
736 memcpy (&send_buffer[sblen], data, part);
737 data += part;
738 sblen += part;
aa0b6932
JB
739
740 if (sblen == SEND_BUFFER_SIZE
741 || (sblen > 0 && send_buffer[sblen-1] == '\n'))
742 {
743 int sent = send (s, send_buffer, sblen, 0);
1e6f32f8
JM
744 if (sent < 0)
745 {
96c06863 746 message (true, "%s: failed to send %d bytes to socket: %s\n",
1e6f32f8
JM
747 progname, sblen, strerror (errno));
748 fail ();
749 }
aa0b6932 750 if (sent != sblen)
1e6f32f8 751 memmove (send_buffer, &send_buffer[sent], sblen - sent);
aa0b6932
JB
752 sblen -= sent;
753 }
1e6f32f8
JM
754
755 dlen -= part;
2828d5f9 756 }
2828d5f9 757}
2828d5f9
KL
758
759\f
0b0d3e0b 760/* In STR, insert a & before each &, each space, each newline, and
a4cf2096 761 any initial -. Change spaces to underscores, too, so that the
0b0d3e0b
KL
762 return value never contains a space.
763
3a35a84c 764 Does not change the string. Outputs the result to S. */
b23b5a5b 765static void
988e88ab 766quote_argument (HSOCKET s, const char *str)
5212210c 767{
9002956f 768 char *copy = (char *) xmalloc (strlen (str) * 2 + 1);
988e88ab
J
769 const char *p;
770 char *q;
5212210c 771
0b0d3e0b 772 p = str;
5212210c
RS
773 q = copy;
774 while (*p)
775 {
776 if (*p == ' ')
777 {
f1db6a73 778 *q++ = '&';
5212210c
RS
779 *q++ = '_';
780 p++;
781 }
3cf8c6aa
SM
782 else if (*p == '\n')
783 {
784 *q++ = '&';
785 *q++ = 'n';
786 p++;
787 }
5212210c
RS
788 else
789 {
0b0d3e0b 790 if (*p == '&' || (*p == '-' && p == str))
f1db6a73 791 *q++ = '&';
5212210c
RS
792 *q++ = *p++;
793 }
794 }
f1db6a73 795 *q++ = 0;
5212210c 796
486ba65f 797 send_to_emacs (s, copy);
87209357
EZ
798
799 free (copy);
5212210c 800}
0c76956f 801
0b0d3e0b
KL
802
803/* The inverse of quote_argument. Removes quoting in string STR by
79432772 804 modifying the string in place. Returns STR. */
0b0d3e0b 805
b23b5a5b 806static char *
873fbd0b 807unquote_argument (char *str)
0b0d3e0b
KL
808{
809 char *p, *q;
810
811 if (! str)
812 return str;
813
814 p = str;
815 q = str;
816 while (*p)
817 {
818 if (*p == '&')
819 {
820 p++;
821 if (*p == '&')
822 *p = '&';
823 else if (*p == '_')
824 *p = ' ';
825 else if (*p == 'n')
826 *p = '\n';
827 else if (*p == '-')
828 *p = '-';
829 }
830 *q++ = *p++;
831 }
832 *q = 0;
833 return str;
834}
835
8f9aaa0a 836\f
b23b5a5b 837static int
03fc768b 838file_name_absolute_p (const char *filename)
b03d27bd
JB
839{
840 /* Sanity check, it shouldn't happen. */
96c06863 841 if (! filename) return false;
b03d27bd
JB
842
843 /* /xxx is always an absolute path. */
96c06863 844 if (filename[0] == '/') return true;
b03d27bd
JB
845
846 /* Empty filenames (which shouldn't happen) are relative. */
96c06863 847 if (filename[0] == '\0') return false;
b03d27bd
JB
848
849#ifdef WINDOWSNT
71b8f735 850 /* X:\xxx is always absolute. */
03fc768b 851 if (isalpha ((unsigned char) filename[0])
cb0297bb 852 && filename[1] == ':' && (filename[2] == '\\' || filename[2] == '/'))
96c06863 853 return true;
b03d27bd
JB
854
855 /* Both \xxx and \\xxx\yyy are absolute. */
96c06863 856 if (filename[0] == '\\') return true;
b03d27bd
JB
857#endif
858
96c06863 859 return false;
b03d27bd
JB
860}
861
aa0b6932 862#ifdef WINDOWSNT
f0384499 863/* Wrapper to make WSACleanup a cdecl, as required by atexit. */
7c3320d8
JB
864void __cdecl
865close_winsock (void)
aa0b6932
JB
866{
867 WSACleanup ();
868}
0c76956f 869
b03d27bd
JB
870/* Initialize the WinSock2 library. */
871void
7c3320d8 872initialize_sockets (void)
0c76956f 873{
aa0b6932
JB
874 WSADATA wsaData;
875
aa0b6932
JB
876 if (WSAStartup (MAKEWORD (2, 0), &wsaData))
877 {
96c06863 878 message (true, "%s: error initializing WinSock2\n", progname);
aa0b6932
JB
879 exit (EXIT_FAILURE);
880 }
881
882 atexit (close_winsock);
0c76956f 883}
e35fc962 884#endif /* WINDOWSNT */
974b73e8 885
8f9aaa0a 886\f
79432772
JB
887/* Read the information needed to set up a TCP comm channel with
888 the Emacs server: host, port, and authentication string. */
889
b23b5a5b 890static int
6b0c8984
AS
891get_server_config (const char *config_file, struct sockaddr_in *server,
892 char *authentication)
97e3214d 893{
aa0b6932
JB
894 char dotted[32];
895 char *port;
b03d27bd 896 FILE *config = NULL;
aa0b6932 897
6b0c8984
AS
898 if (file_name_absolute_p (config_file))
899 config = fopen (config_file, "rb");
b03d27bd 900 else
97e3214d 901 {
b9170155 902 const char *home = egetenv ("HOME");
88b46d84 903
aa0b6932
JB
904 if (home)
905 {
6b0c8984 906 char *path = xmalloc (strlen (home) + strlen (config_file)
17107bb6
PE
907 + EXTRA_SPACE);
908 strcpy (path, home);
909 strcat (path, "/.emacs.d/server/");
6b0c8984 910 strcat (path, config_file);
aa0b6932 911 config = fopen (path, "rb");
17107bb6 912 free (path);
aa0b6932 913 }
88b46d84 914#ifdef WINDOWSNT
7ce8671d 915 if (!config && (home = egetenv ("APPDATA")))
88b46d84 916 {
6b0c8984 917 char *path = xmalloc (strlen (home) + strlen (config_file)
17107bb6
PE
918 + EXTRA_SPACE);
919 strcpy (path, home);
920 strcat (path, "/.emacs.d/server/");
6b0c8984 921 strcat (path, config_file);
88b46d84 922 config = fopen (path, "rb");
17107bb6 923 free (path);
88b46d84
JB
924 }
925#endif
aa0b6932
JB
926 }
927
928 if (! config)
96c06863 929 return false;
aa0b6932
JB
930
931 if (fgets (dotted, sizeof dotted, config)
968ef9b4
JB
932 && (port = strchr (dotted, ':')))
933 *port++ = '\0';
97e3214d
GM
934 else
935 {
96c06863 936 message (true, "%s: invalid configuration info\n", progname);
65396510 937 exit (EXIT_FAILURE);
97e3214d 938 }
97e3214d 939
aa0b6932
JB
940 server->sin_family = AF_INET;
941 server->sin_addr.s_addr = inet_addr (dotted);
942 server->sin_port = htons (atoi (port));
97e3214d 943
aa0b6932
JB
944 if (! fread (authentication, AUTH_KEY_LENGTH, 1, config))
945 {
96c06863 946 message (true, "%s: cannot read authentication info\n", progname);
aa0b6932
JB
947 exit (EXIT_FAILURE);
948 }
46cec291 949
aa0b6932 950 fclose (config);
97e3214d 951
96c06863 952 return true;
97e3214d
GM
953}
954
b23b5a5b 955static HSOCKET
6b0c8984 956set_tcp_socket (const char *local_server_file)
aa0b6932
JB
957{
958 HSOCKET s;
959 struct sockaddr_in server;
aa0b6932
JB
960 struct linger l_arg = {1, 1};
961 char auth_string[AUTH_KEY_LENGTH + 1];
9628b887 962
6b0c8984 963 if (! get_server_config (local_server_file, &server, auth_string))
aa0b6932
JB
964 return INVALID_SOCKET;
965
0b973fc5 966 if (server.sin_addr.s_addr != inet_addr ("127.0.0.1") && !quiet)
96c06863 967 message (false, "%s: connected to remote socket at %s\n",
b03d27bd
JB
968 progname, inet_ntoa (server.sin_addr));
969
79432772 970 /* Open up an AF_INET socket. */
aa0b6932
JB
971 if ((s = socket (AF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0)
972 {
d22b00e5 973 sock_err_message ("socket");
aa0b6932
JB
974 return INVALID_SOCKET;
975 }
976
79432772 977 /* Set up the socket. */
aa0b6932
JB
978 if (connect (s, (struct sockaddr *) &server, sizeof server) < 0)
979 {
d22b00e5 980 sock_err_message ("connect");
aa0b6932
JB
981 return INVALID_SOCKET;
982 }
983
aa0b6932
JB
984 setsockopt (s, SOL_SOCKET, SO_LINGER, (char *) &l_arg, sizeof l_arg);
985
79432772 986 /* Send the authentication. */
aa0b6932
JB
987 auth_string[AUTH_KEY_LENGTH] = '\0';
988
486ba65f
JR
989 send_to_emacs (s, "-auth ");
990 send_to_emacs (s, auth_string);
5ab73228 991 send_to_emacs (s, " ");
aa0b6932
JB
992
993 return s;
994}
995
b2ff54a0
JR
996
997/* Returns 1 if PREFIX is a prefix of STRING. */
998static int
988e88ab 999strprefix (const char *prefix, const char *string)
b2ff54a0 1000{
cb06b8dc 1001 return !strncmp (prefix, string, strlen (prefix));
b2ff54a0
JR
1002}
1003
a336ee5b
CY
1004/* Get tty name and type. If successful, return the type in TTY_TYPE
1005 and the name in TTY_NAME, and return 1. Otherwise, fail if NOABORT
1006 is zero, or return 0 if NOABORT is non-zero. */
1007
b23b5a5b 1008static int
b9170155 1009find_tty (const char **tty_type, const char **tty_name, int noabort)
a336ee5b 1010{
b9170155
PE
1011 const char *type = egetenv ("TERM");
1012 const char *name = ttyname (fileno (stdout));
a336ee5b
CY
1013
1014 if (!name)
1015 {
1016 if (noabort)
1017 return 0;
1018 else
1019 {
96c06863 1020 message (true, "%s: could not get terminal name\n", progname);
a336ee5b
CY
1021 fail ();
1022 }
1023 }
1024
1025 if (!type)
1026 {
1027 if (noabort)
1028 return 0;
1029 else
1030 {
96c06863 1031 message (true, "%s: please set the TERM variable to your terminal type\n",
a336ee5b
CY
1032 progname);
1033 fail ();
1034 }
1035 }
1036
1037 if (strcmp (type, "eterm") == 0)
1038 {
1039 if (noabort)
1040 return 0;
1041 else
1042 {
1043 /* This causes nasty, MULTI_KBOARD-related input lockouts. */
96c06863 1044 message (true, "%s: opening a frame in an Emacs term buffer"
a336ee5b
CY
1045 " is not supported\n", progname);
1046 fail ();
1047 }
1048 }
1049
1050 *tty_name = name;
1051 *tty_type = type;
1052 return 1;
1053}
1054
b2ff54a0 1055
aa0b6932 1056#if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
46cec291 1057
9f637eea
GM
1058/* Three possibilities:
1059 2 - can't be `stat'ed (sets errno)
1060 1 - isn't owned by us
1061 0 - success: none of the above */
1062
1063static int
fe91f5a0 1064socket_status (const char *name)
9f637eea
GM
1065{
1066 struct stat statbfr;
1067
b0bbc07d 1068 if (stat (name, &statbfr) == -1)
9f637eea
GM
1069 return 2;
1070
1071 if (statbfr.st_uid != geteuid ())
1072 return 1;
0b0d3e0b 1073
9f637eea
GM
1074 return 0;
1075}
1076
974b73e8 1077\f
da8e1115
KL
1078/* A signal handler that passes the signal to the Emacs process.
1079 Useful for SIGWINCH. */
1080
9af30bdf 1081static void
428a555e 1082pass_signal_to_emacs (int signalnum)
9628b887
KL
1083{
1084 int old_errno = errno;
1085
9f729af5 1086 if (emacs_pid)
428a555e 1087 kill (emacs_pid, signalnum);
9f729af5 1088
428a555e 1089 signal (signalnum, pass_signal_to_emacs);
9f729af5
KL
1090 errno = old_errno;
1091}
1092
0b0d3e0b
KL
1093/* Signal handler for SIGCONT; notify the Emacs process that it can
1094 now resume our tty frame. */
1095
9af30bdf 1096static void
0b0d3e0b
KL
1097handle_sigcont (int signalnum)
1098{
1099 int old_errno = errno;
d050de75
PE
1100 pid_t pgrp = getpgrp ();
1101 pid_t tcpgrp = tcgetpgrp (1);
0b0d3e0b 1102
d050de75 1103 if (tcpgrp == pgrp)
0b0d3e0b 1104 {
591debed 1105 /* We are in the foreground. */
486ba65f 1106 send_to_emacs (emacs_socket, "-resume \n");
0b0d3e0b 1107 }
d050de75 1108 else if (0 <= tcpgrp && tty)
0b0d3e0b 1109 {
591debed 1110 /* We are in the background; cancel the continue. */
d050de75 1111 kill (-pgrp, SIGTTIN);
0b0d3e0b 1112 }
c6c53c3e
KL
1113
1114 signal (signalnum, handle_sigcont);
0b0d3e0b
KL
1115 errno = old_errno;
1116}
1117
1118/* Signal handler for SIGTSTP; notify the Emacs process that we are
1119 going to sleep. Normally the suspend is initiated by Emacs via
1120 server-handle-suspend-tty, but if the server gets out of sync with
1121 reality, we may get a SIGTSTP on C-z. Handling this signal and
79432772 1122 notifying Emacs about it should get things under control again. */
0b0d3e0b 1123
9af30bdf 1124static void
0b0d3e0b
KL
1125handle_sigtstp (int signalnum)
1126{
1127 int old_errno = errno;
1128 sigset_t set;
c0f342ab 1129
90843190 1130 if (emacs_socket)
486ba65f 1131 send_to_emacs (emacs_socket, "-suspend \n");
0b0d3e0b 1132
5ab73228 1133 /* Unblock this signal and call the default handler by temporarily
8350f087 1134 changing the handler and resignaling. */
0b0d3e0b
KL
1135 sigprocmask (SIG_BLOCK, NULL, &set);
1136 sigdelset (&set, signalnum);
1137 signal (signalnum, SIG_DFL);
a7db35b3 1138 raise (signalnum);
0b0d3e0b
KL
1139 sigprocmask (SIG_SETMASK, &set, NULL); /* Let's the above signal through. */
1140 signal (signalnum, handle_sigtstp);
1141
1142 errno = old_errno;
1143}
273b9028
CY
1144
1145
da8e1115 1146/* Set up signal handlers before opening a frame on the current tty. */
0b0d3e0b 1147
b23b5a5b 1148static void
4d553a13 1149init_signals (void)
9628b887
KL
1150{
1151 /* Set up signal handlers. */
428a555e 1152 signal (SIGWINCH, pass_signal_to_emacs);
4ca927b4
KL
1153
1154 /* Don't pass SIGINT and SIGQUIT to Emacs, because it has no way of
1155 deciding which terminal the signal came from. C-g is now a
1156 normal input event on secondary terminals. */
1157#if 0
428a555e
KL
1158 signal (SIGINT, pass_signal_to_emacs);
1159 signal (SIGQUIT, pass_signal_to_emacs);
4ca927b4 1160#endif
0b0d3e0b
KL
1161
1162 signal (SIGCONT, handle_sigcont);
1163 signal (SIGTSTP, handle_sigtstp);
1164 signal (SIGTTOU, handle_sigtstp);
9628b887
KL
1165}
1166
46cec291 1167
b23b5a5b 1168static HSOCKET
6b0c8984 1169set_local_socket (const char *local_socket_name)
46cec291 1170{
aa0b6932 1171 HSOCKET s;
46cec291 1172 struct sockaddr_un server;
46cec291 1173
79432772 1174 /* Open up an AF_UNIX socket in this person's home directory. */
46cec291
RS
1175 if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
1176 {
96c06863 1177 message (true, "%s: socket: %s\n", progname, strerror (errno));
aa0b6932 1178 return INVALID_SOCKET;
46cec291 1179 }
e69233c2 1180
46cec291 1181 server.sun_family = AF_UNIX;
c5fee545 1182
c5fee545 1183 {
6b0c8984
AS
1184 int sock_status;
1185 int use_tmpdir = 0;
1186 int saved_errno;
1187 const char *server_name = local_socket_name;
4be3dfc5 1188 const char *tmpdir IF_LINT ( = NULL);
17107bb6
PE
1189 char *tmpdir_storage = NULL;
1190 char *socket_name_storage = NULL;
0b0d3e0b 1191
6b0c8984 1192 if (!strchr (local_socket_name, '/') && !strchr (local_socket_name, '\\'))
8966b757
AS
1193 {
1194 /* socket_name is a file name component. */
17107bb6
PE
1195 long uid = geteuid ();
1196 ptrdiff_t tmpdirlen;
6b0c8984 1197 use_tmpdir = 1;
f77b11a0
JB
1198 tmpdir = egetenv ("TMPDIR");
1199 if (!tmpdir)
b336bfcd
GM
1200 {
1201#ifdef DARWIN_OS
e6068ab3
YM
1202#ifndef _CS_DARWIN_USER_TEMP_DIR
1203#define _CS_DARWIN_USER_TEMP_DIR 65537
1204#endif
b336bfcd
GM
1205 size_t n = confstr (_CS_DARWIN_USER_TEMP_DIR, NULL, (size_t) 0);
1206 if (n > 0)
1207 {
17107bb6 1208 tmpdir = tmpdir_storage = xmalloc (n);
dd1ff7c0 1209 confstr (_CS_DARWIN_USER_TEMP_DIR, tmpdir_storage, n);
b336bfcd
GM
1210 }
1211 else
1212#endif
1213 tmpdir = "/tmp";
1214 }
17107bb6 1215 tmpdirlen = strlen (tmpdir);
6b0c8984 1216 socket_name_storage =
17107bb6 1217 xmalloc (tmpdirlen + strlen (server_name) + EXTRA_SPACE);
6b0c8984
AS
1218 strcpy (socket_name_storage, tmpdir);
1219 sprintf (socket_name_storage + tmpdirlen, "/emacs%ld/", uid);
1220 strcat (socket_name_storage + tmpdirlen, server_name);
1221 local_socket_name = socket_name_storage;
254107e4
RS
1222 }
1223
6b0c8984
AS
1224 if (strlen (local_socket_name) < sizeof (server.sun_path))
1225 strcpy (server.sun_path, local_socket_name);
254107e4 1226 else
819b8f00 1227 {
96c06863 1228 message (true, "%s: socket-name %s too long\n",
6b0c8984 1229 progname, local_socket_name);
819b8f00
KL
1230 fail ();
1231 }
efb859b4 1232
9f637eea
GM
1233 /* See if the socket exists, and if it's owned by us. */
1234 sock_status = socket_status (server.sun_path);
152b6e83 1235 saved_errno = errno;
6b0c8984 1236 if (sock_status && use_tmpdir)
efb859b4 1237 {
9f637eea
GM
1238 /* Failing that, see if LOGNAME or USER exist and differ from
1239 our euid. If so, look for a socket based on the UID
1240 associated with the name. This is reminiscent of the logic
1241 that init_editfns uses to set the global Vuser_full_name. */
e69233c2 1242
b9170155 1243 const char *user_name = egetenv ("LOGNAME");
293f9f2a 1244
9f637eea 1245 if (!user_name)
b9170155 1246 user_name = egetenv ("USER");
e69233c2 1247
9f637eea
GM
1248 if (user_name)
1249 {
1250 struct passwd *pw = getpwnam (user_name);
293f9f2a 1251
9f637eea
GM
1252 if (pw && (pw->pw_uid != geteuid ()))
1253 {
1254 /* We're running under su, apparently. */
17107bb6
PE
1255 long uid = pw->pw_uid;
1256 ptrdiff_t tmpdirlen = strlen (tmpdir);
6b0c8984
AS
1257 char *user_socket_name
1258 = xmalloc (tmpdirlen + strlen (server_name) + EXTRA_SPACE);
1259 strcpy (user_socket_name, tmpdir);
1260 sprintf (user_socket_name + tmpdirlen, "/emacs%ld/", uid);
1261 strcat (user_socket_name + tmpdirlen, server_name);
1262
1263 if (strlen (user_socket_name) < sizeof (server.sun_path))
1264 strcpy (server.sun_path, user_socket_name);
5c9659d3
SM
1265 else
1266 {
96c06863 1267 message (true, "%s: socket-name %s too long\n",
6b0c8984 1268 progname, user_socket_name);
65396510 1269 exit (EXIT_FAILURE);
5c9659d3 1270 }
6b0c8984 1271 free (user_socket_name);
5c9659d3 1272
9f637eea 1273 sock_status = socket_status (server.sun_path);
b80bf66e 1274 saved_errno = errno;
9f637eea 1275 }
293f9f2a
RS
1276 else
1277 errno = saved_errno;
9f637eea 1278 }
efb859b4 1279 }
e69233c2 1280
17107bb6
PE
1281 free (socket_name_storage);
1282 free (tmpdir_storage);
1283
aa0b6932
JB
1284 switch (sock_status)
1285 {
1286 case 1:
974b73e8
KL
1287 /* There's a socket, but it isn't owned by us. This is OK if
1288 we are root. */
1289 if (0 != geteuid ())
1290 {
96c06863 1291 message (true, "%s: Invalid socket owner\n", progname);
aa0b6932 1292 return INVALID_SOCKET;
974b73e8
KL
1293 }
1294 break;
aa0b6932
JB
1295
1296 case 2:
974b73e8
KL
1297 /* `stat' failed */
1298 if (saved_errno == ENOENT)
96c06863 1299 message (true,
974b73e8 1300 "%s: can't find socket; have you started the server?\n\
45adde32 1301To start the server in Emacs, type \"M-x server-start\".\n",
aa0b6932 1302 progname);
974b73e8 1303 else
96c06863 1304 message (true, "%s: can't stat %s: %s\n",
aa0b6932 1305 progname, server.sun_path, strerror (saved_errno));
974b73e8 1306 return INVALID_SOCKET;
aa0b6932 1307 }
efb859b4 1308 }
46cec291 1309
4e23f2ba
JB
1310 if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2)
1311 < 0)
46cec291 1312 {
96c06863 1313 message (true, "%s: connect: %s\n", progname, strerror (errno));
aa0b6932 1314 return INVALID_SOCKET;
46cec291 1315 }
23a7488d 1316
aa0b6932
JB
1317 return s;
1318}
1319#endif /* ! NO_SOCKETS_IN_FILE_SYSTEM */
1320
b23b5a5b 1321static HSOCKET
636b507b 1322set_socket (int no_exit_if_error)
aa0b6932 1323{
b03d27bd 1324 HSOCKET s;
6b0c8984 1325 const char *local_server_file = server_file;
c0f342ab 1326
b03d27bd 1327 INITIALIZE ();
c0f342ab 1328
aa0b6932 1329#ifndef NO_SOCKETS_IN_FILE_SYSTEM
b03d27bd
JB
1330 /* Explicit --socket-name argument. */
1331 if (socket_name)
46cec291 1332 {
6b0c8984 1333 s = set_local_socket (socket_name);
636b507b 1334 if ((s != INVALID_SOCKET) || no_exit_if_error)
974b73e8 1335 return s;
96c06863 1336 message (true, "%s: error accessing socket \"%s\"\n",
974b73e8 1337 progname, socket_name);
b03d27bd 1338 exit (EXIT_FAILURE);
46cec291 1339 }
b03d27bd
JB
1340#endif
1341
1342 /* Explicit --server-file arg or EMACS_SERVER_FILE variable. */
6b0c8984
AS
1343 if (!local_server_file)
1344 local_server_file = egetenv ("EMACS_SERVER_FILE");
46cec291 1345
6b0c8984 1346 if (local_server_file)
23a7488d 1347 {
6b0c8984 1348 s = set_tcp_socket (local_server_file);
636b507b 1349 if ((s != INVALID_SOCKET) || no_exit_if_error)
974b73e8 1350 return s;
c0f342ab 1351
96c06863 1352 message (true, "%s: error accessing server file \"%s\"\n",
6b0c8984 1353 progname, local_server_file);
b03d27bd 1354 exit (EXIT_FAILURE);
23a7488d 1355 }
c0f342ab 1356
b03d27bd
JB
1357#ifndef NO_SOCKETS_IN_FILE_SYSTEM
1358 /* Implicit local socket. */
6b0c8984 1359 s = set_local_socket ("server");
b03d27bd
JB
1360 if (s != INVALID_SOCKET)
1361 return s;
1362#endif
23a7488d 1363
b03d27bd 1364 /* Implicit server file. */
6b0c8984 1365 s = set_tcp_socket ("server");
636b507b 1366 if ((s != INVALID_SOCKET) || no_exit_if_error)
b03d27bd
JB
1367 return s;
1368
1369 /* No implicit or explicit socket, and no alternate editor. */
96c06863 1370 message (true, "%s: No socket or alternate editor. Please use:\n\n"
b03d27bd
JB
1371#ifndef NO_SOCKETS_IN_FILE_SYSTEM
1372"\t--socket-name\n"
ee6a193c 1373#endif
b03d27bd
JB
1374"\t--server-file (or environment variable EMACS_SERVER_FILE)\n\
1375\t--alternate-editor (or environment variable ALTERNATE_EDITOR)\n",
1376 progname);
1377 exit (EXIT_FAILURE);
aa0b6932 1378}
46cec291 1379
5e0944c6 1380#ifdef HAVE_NTGUI
0e0dced5
JB
1381FARPROC set_fg; /* Pointer to AllowSetForegroundWindow. */
1382FARPROC get_wc; /* Pointer to RealGetWindowClassA. */
1383
5e0944c6
DC
1384void
1385w32_set_user_model_id (void)
1386{
1387 HMODULE shell;
1388 HRESULT (WINAPI * set_user_model) (wchar_t * id);
1389
1390 /* On Windows 7 and later, we need to set the user model ID
1391 to associate emacsclient launched files with Emacs frames
1392 in the UI. */
1393 shell = LoadLibrary ("shell32.dll");
1394 if (shell)
1395 {
1396 set_user_model
1397 = (void *) GetProcAddress (shell,
1398 "SetCurrentProcessExplicitAppUserModelID");
1399 /* If the function is defined, then we are running on Windows 7
1400 or newer, and the UI uses this to group related windows
1401 together. Since emacs, runemacs, emacsclient are related, we
1402 want them grouped even though the executables are different,
1403 so we need to set a consistent ID between them. */
1404 if (set_user_model)
1405 set_user_model (L"GNU.Emacs");
1406
1407 FreeLibrary (shell);
1408 }
1409}
1410
0e0dced5 1411BOOL CALLBACK
7c3320d8 1412w32_find_emacs_process (HWND hWnd, LPARAM lParam)
0e0dced5
JB
1413{
1414 DWORD pid;
1415 char class[6];
1416
1417 /* Reject any window not of class "Emacs". */
1418 if (! get_wc (hWnd, class, sizeof (class))
1419 || strcmp (class, "Emacs"))
1420 return TRUE;
1421
1422 /* We only need the process id, not the thread id. */
1423 (void) GetWindowThreadProcessId (hWnd, &pid);
1424
1425 /* Not the one we're looking for. */
1426 if (pid != (DWORD) emacs_pid) return TRUE;
1427
1428 /* OK, let's raise it. */
1429 set_fg (emacs_pid);
1430
1431 /* Stop enumeration. */
1432 return FALSE;
1433}
1434
79432772
JB
1435/* Search for a window of class "Emacs" and owned by a process with
1436 process id = emacs_pid. If found, allow it to grab the focus. */
1437
0e0dced5 1438void
7c3320d8 1439w32_give_focus (void)
0e0dced5 1440{
ff90fbde 1441 HANDLE user32;
0e0dced5 1442
71b8f735 1443 /* It shouldn't happen when dealing with TCP sockets. */
0e0dced5
JB
1444 if (!emacs_pid) return;
1445
ff90fbde
JR
1446 user32 = GetModuleHandle ("user32.dll");
1447
1448 if (!user32)
1449 return;
0e0dced5
JB
1450
1451 /* Modern Windows restrict which processes can set the foreground window.
1452 emacsclient can allow Emacs to grab the focus by calling the function
1453 AllowSetForegroundWindow. Unfortunately, older Windows (W95, W98 and
1454 NT) lack this function, so we have to check its availability. */
ff90fbde
JR
1455 if ((set_fg = GetProcAddress (user32, "AllowSetForegroundWindow"))
1456 && (get_wc = GetProcAddress (user32, "RealGetWindowClassA")))
0e0dced5 1457 EnumWindows (w32_find_emacs_process, (LPARAM) 0);
0e0dced5 1458}
5e0944c6 1459#endif /* HAVE_NTGUI */
0e0dced5 1460
636b507b
DN
1461/* Start the emacs daemon and try to connect to it. */
1462
b23b5a5b 1463static void
636b507b
DN
1464start_daemon_and_retry_set_socket (void)
1465{
802bdb3c 1466#ifndef WINDOWSNT
636b507b
DN
1467 pid_t dpid;
1468 int status;
636b507b
DN
1469
1470 dpid = fork ();
1471
1472 if (dpid > 0)
1473 {
fd95644b
DN
1474 pid_t w;
1475 w = waitpid (dpid, &status, WUNTRACED | WCONTINUED);
636b507b 1476
361358ea 1477 if ((w == -1) || !WIFEXITED (status) || WEXITSTATUS (status))
fd95644b 1478 {
96c06863 1479 message (true, "Error: Could not start the Emacs daemon\n");
fd95644b
DN
1480 exit (EXIT_FAILURE);
1481 }
1482
1483 /* Try connecting, the daemon should have started by now. */
96c06863 1484 message (true, "Emacs daemon should have started, trying to connect again\n");
636b507b 1485 if ((emacs_socket = set_socket (1)) == INVALID_SOCKET)
fd95644b 1486 {
96c06863 1487 message (true, "Error: Cannot connect even after starting the Emacs daemon\n");
fd95644b
DN
1488 exit (EXIT_FAILURE);
1489 }
636b507b
DN
1490 }
1491 else if (dpid < 0)
1492 {
fd95644b 1493 fprintf (stderr, "Error: Cannot fork!\n");
6ab88e02 1494 exit (EXIT_FAILURE);
636b507b
DN
1495 }
1496 else
1497 {
988e88ab 1498 char emacs[] = "emacs";
b0bbc07d 1499 char daemon_option[] = "--daemon";
29abe551
PE
1500 char *d_argv[3];
1501 d_argv[0] = emacs;
1502 d_argv[1] = daemon_option;
1503 d_argv[2] = 0;
636b507b
DN
1504 if (socket_name != NULL)
1505 {
1506 /* Pass --daemon=socket_name as argument. */
988e88ab 1507 const char *deq = "--daemon=";
17107bb6
PE
1508 char *daemon_arg = xmalloc (strlen (deq)
1509 + strlen (socket_name) + 1);
636b507b
DN
1510 strcpy (daemon_arg, deq);
1511 strcat (daemon_arg, socket_name);
1512 d_argv[1] = daemon_arg;
1513 }
1514 execvp ("emacs", d_argv);
96c06863 1515 message (true, "%s: error starting emacs daemon\n", progname);
636b507b 1516 }
802bdb3c 1517#endif /* WINDOWSNT */
636b507b
DN
1518}
1519
aa0b6932 1520int
873fbd0b 1521main (int argc, char **argv)
aa0b6932 1522{
c5443aa5 1523 int rl = 0, needlf = 0;
974b73e8 1524 char *cwd, *str;
aa0b6932 1525 char string[BUFSIZ+1];
4be3dfc5 1526 int start_daemon_if_needed;
3ecb8d93 1527 int exit_status = EXIT_SUCCESS;
aa0b6932 1528
974b73e8 1529 main_argv = argv;
aa0b6932
JB
1530 progname = argv[0];
1531
5e0944c6 1532#ifdef HAVE_NTGUI
6b59694e
DC
1533 /* On Windows 7 and later, we need to explicitly associate
1534 emacsclient with emacs so the UI behaves sensibly. This
1535 association does no harm if we're not actually connecting to an
1536 Emacs using a window display. */
ff90fbde 1537 w32_set_user_model_id ();
5e0944c6 1538#endif /* HAVE_NTGUI */
ff90fbde 1539
aa0b6932
JB
1540 /* Process options. */
1541 decode_options (argc, argv);
1542
273b9028 1543 if ((argc - optind < 1) && !eval && current_frame)
23a7488d 1544 {
96c06863 1545 message (true, "%s: file name or argument required\n"
974b73e8
KL
1546 "Try `%s --help' for more information\n",
1547 progname, progname);
aa0b6932 1548 exit (EXIT_FAILURE);
23a7488d
RS
1549 }
1550
f11352e6 1551#ifndef WINDOWSNT
d050de75
PE
1552 if (tty)
1553 {
1554 pid_t pgrp = getpgrp ();
1555 pid_t tcpgrp = tcgetpgrp (1);
1556 if (0 <= tcpgrp && tcpgrp != pgrp)
1557 kill (-pgrp, SIGTTIN);
1558 }
f11352e6 1559#endif /* !WINDOWSNT */
d050de75 1560
636b507b
DN
1561 /* If alternate_editor is the empty string, start the emacs daemon
1562 in case of failure to connect. */
1563 start_daemon_if_needed = (alternate_editor
1564 && (alternate_editor[0] == '\0'));
aa0b6932 1565
7e6bb4c9
PE
1566 emacs_socket = set_socket (alternate_editor || start_daemon_if_needed);
1567 if (emacs_socket == INVALID_SOCKET)
1568 {
1569 if (! start_daemon_if_needed)
1570 fail ();
1571
7e6bb4c9
PE
1572 start_daemon_and_retry_set_socket ();
1573 }
974b73e8
KL
1574
1575 cwd = get_current_dir_name ();
46cec291
RS
1576 if (cwd == 0)
1577 {
96c06863 1578 message (true, "%s: %s\n", progname,
974b73e8 1579 "Cannot get current working directory");
819b8f00 1580 fail ();
46cec291
RS
1581 }
1582
5e0944c6 1583#ifdef HAVE_NTGUI
efc3dd3c 1584 if (display && !strcmp (display, "w32"))
0e0dced5 1585 w32_give_focus ();
5e0944c6 1586#endif /* HAVE_NTGUI */
c66648e0 1587
273b9028 1588 /* Send over our environment and current directory. */
59e085e0
KL
1589 if (!current_frame)
1590 {
59e085e0
KL
1591 int i;
1592 for (i = 0; environ[i]; i++)
1593 {
486ba65f
JR
1594 send_to_emacs (emacs_socket, "-env ");
1595 quote_argument (emacs_socket, environ[i]);
1596 send_to_emacs (emacs_socket, " ");
59e085e0 1597 }
2828d5f9 1598 }
ba528748
SM
1599 send_to_emacs (emacs_socket, "-dir ");
1600 quote_argument (emacs_socket, cwd);
1601 send_to_emacs (emacs_socket, "/");
1602 send_to_emacs (emacs_socket, " ");
2828d5f9 1603
6afdd335 1604 retry:
5212210c 1605 if (nowait)
486ba65f 1606 send_to_emacs (emacs_socket, "-nowait ");
292d74a3 1607
92071250 1608 if (current_frame)
486ba65f 1609 send_to_emacs (emacs_socket, "-current-frame ");
c0f342ab 1610
30be2360 1611 if (display)
87209357 1612 {
486ba65f
JR
1613 send_to_emacs (emacs_socket, "-display ");
1614 quote_argument (emacs_socket, display);
1615 send_to_emacs (emacs_socket, " ");
87209357 1616 }
30be2360 1617
0191e222
CY
1618 if (parent_id)
1619 {
1620 send_to_emacs (emacs_socket, "-parent-id ");
1621 quote_argument (emacs_socket, parent_id);
1622 send_to_emacs (emacs_socket, " ");
1623 }
1624
18a4ce5e
AR
1625 if (frame_parameters && !current_frame)
1626 {
1627 send_to_emacs (emacs_socket, "-frame-parameters ");
1628 quote_argument (emacs_socket, frame_parameters);
1629 send_to_emacs (emacs_socket, " ");
1630 }
1631
2d0e8e61
CY
1632 /* Unless we are certain we don't want to occupy the tty, send our
1633 tty information to Emacs. For example, in daemon mode Emacs may
1634 need to occupy this tty if no other frame is available. */
1635 if (!current_frame || !eval)
9628b887 1636 {
b9170155 1637 const char *tty_type, *tty_name;
0b0d3e0b 1638
273b9028
CY
1639 if (find_tty (&tty_type, &tty_name, !tty))
1640 {
b2ff54a0 1641#if !defined (NO_SOCKETS_IN_FILE_SYSTEM)
273b9028 1642 init_signals ();
b2ff54a0 1643#endif
273b9028
CY
1644 send_to_emacs (emacs_socket, "-tty ");
1645 quote_argument (emacs_socket, tty_name);
1646 send_to_emacs (emacs_socket, " ");
1647 quote_argument (emacs_socket, tty_type);
1648 send_to_emacs (emacs_socket, " ");
1649 }
9628b887 1650 }
77134727 1651
273b9028 1652 if (!current_frame && !tty)
486ba65f 1653 send_to_emacs (emacs_socket, "-window-system ");
0b0d3e0b 1654
87209357 1655 if ((argc - optind > 0))
5212210c 1656 {
b0bbc07d 1657 int i;
87209357 1658 for (i = optind; i < argc; i++)
46cec291 1659 {
0b0d3e0b 1660
87209357 1661 if (eval)
0b0d3e0b 1662 {
974b73e8 1663 /* Don't prepend cwd or anything like that. */
486ba65f
JR
1664 send_to_emacs (emacs_socket, "-eval ");
1665 quote_argument (emacs_socket, argv[i]);
1666 send_to_emacs (emacs_socket, " ");
0b0d3e0b
KL
1667 continue;
1668 }
1669
1670 if (*argv[i] == '+')
1671 {
87209357
EZ
1672 char *p = argv[i] + 1;
1673 while (isdigit ((unsigned char) *p) || *p == ':') p++;
0b0d3e0b
KL
1674 if (*p == 0)
1675 {
486ba65f
JR
1676 send_to_emacs (emacs_socket, "-position ");
1677 quote_argument (emacs_socket, argv[i]);
1678 send_to_emacs (emacs_socket, " ");
0b0d3e0b
KL
1679 continue;
1680 }
0b0d3e0b 1681 }
6cde1b21
JB
1682#ifdef WINDOWSNT
1683 else if (! file_name_absolute_p (argv[i])
1684 && (isalpha (argv[i][0]) && argv[i][1] == ':'))
1685 /* Windows can have a different default directory for each
1686 drive, so the cwd passed via "-dir" is not sufficient
1687 to account for that.
1688 If the user uses <drive>:<relpath>, we hence need to be
1689 careful to expand <relpath> with the default directory
1690 corresponding to <drive>. */
1691 {
1692 char *filename = (char *) xmalloc (MAX_PATH);
1693 DWORD size;
1694
1695 size = GetFullPathName (argv[i], MAX_PATH, filename, NULL);
1696 if (size > 0 && size < MAX_PATH)
1697 argv[i] = filename;
1698 else
1699 free (filename);
1700 }
1701#endif
0b0d3e0b 1702
486ba65f 1703 send_to_emacs (emacs_socket, "-file ");
486ba65f
JR
1704 quote_argument (emacs_socket, argv[i]);
1705 send_to_emacs (emacs_socket, " ");
0b0d3e0b 1706 }
46cec291 1707 }
273b9028 1708 else if (eval)
87209357 1709 {
273b9028
CY
1710 /* Read expressions interactively. */
1711 while ((str = fgets (string, BUFSIZ, stdin)))
1712 {
1713 send_to_emacs (emacs_socket, "-eval ");
1714 quote_argument (emacs_socket, str);
1715 }
1716 send_to_emacs (emacs_socket, " ");
87209357 1717 }
0b0d3e0b 1718
486ba65f 1719 send_to_emacs (emacs_socket, "\n");
46cec291 1720
fc2040c0 1721 /* Wait for an answer. */
0b973fc5 1722 if (!eval && !tty && !nowait && !quiet)
30be2360
SM
1723 {
1724 printf ("Waiting for Emacs...");
1725 needlf = 2;
1726 }
46cec291 1727 fflush (stdout);
47d7532e
PE
1728 while (fdatasync (1) != 0 && errno == EINTR)
1729 continue;
46cec291 1730
3cf8c6aa 1731 /* Now, wait for an answer and print any messages. */
b166dcd8 1732 while (exit_status == EXIT_SUCCESS)
3cf8c6aa 1733 {
2b84f674 1734 char *p, *end_p;
b166dcd8
KC
1735 do
1736 {
1737 errno = 0;
1738 rl = recv (emacs_socket, string, BUFSIZ, 0);
1739 }
1740 /* If we receive a signal (e.g. SIGWINCH, which we pass
1741 through to Emacs), on some OSes we get EINTR and must retry. */
1742 while (rl < 0 && errno == EINTR);
1743
1744 if (rl <= 0)
1745 break;
b23b5a5b 1746
974b73e8
KL
1747 string[rl] = '\0';
1748
2b84f674
AS
1749 /* Loop over all NL-terminated messages. */
1750 for (end_p = p = string; end_p != NULL && *end_p != '\0'; p = end_p)
1751 {
1752 end_p = strchr (p, '\n');
1753 if (end_p != NULL)
1754 *end_p++ = '\0';
0b0d3e0b 1755
6b59694e
DC
1756 if (strprefix ("-emacs-pid ", p))
1757 {
1758 /* -emacs-pid PID: The process id of the Emacs process. */
1759 emacs_pid = strtol (p + strlen ("-emacs-pid"), NULL, 10);
1760 }
1761 else if (strprefix ("-window-system-unsupported ", p))
1762 {
1763 /* -window-system-unsupported: Emacs was compiled without support
1764 for whatever window system we tried. Try the alternate
1765 display, or, failing that, try the terminal. */
1766 if (alt_display)
1767 {
1768 display = alt_display;
1769 alt_display = NULL;
1770 }
1771 else
1772 {
1773 nowait = 0;
1774 tty = 1;
1775 }
1776
1777 goto retry;
1778 }
1779 else if (strprefix ("-print ", p))
1780 {
1781 /* -print STRING: Print STRING on the terminal. */
1782 str = unquote_argument (p + strlen ("-print "));
1783 if (needlf)
1784 printf ("\n");
1785 printf ("%s", str);
1786 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
1787 }
1788 else if (strprefix ("-print-nonl ", p))
1789 {
1790 /* -print-nonl STRING: Print STRING on the terminal.
1791 Used to continue a preceding -print command. */
1792 str = unquote_argument (p + strlen ("-print-nonl "));
1793 printf ("%s", str);
1794 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
1795 }
1796 else if (strprefix ("-error ", p))
1797 {
1798 /* -error DESCRIPTION: Signal an error on the terminal. */
1799 str = unquote_argument (p + strlen ("-error "));
1800 if (needlf)
1801 printf ("\n");
1802 fprintf (stderr, "*ERROR*: %s", str);
1803 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
1804 exit_status = EXIT_FAILURE;
1805 }
c801ad51 1806#ifdef SIGSTOP
2b84f674
AS
1807 else if (strprefix ("-suspend ", p))
1808 {
1809 /* -suspend: Suspend this terminal, i.e., stop the process. */
1810 if (needlf)
1811 printf ("\n");
1812 needlf = 0;
1813 kill (0, SIGSTOP);
1814 }
b2ff54a0 1815#endif
2b84f674
AS
1816 else
1817 {
1818 /* Unknown command. */
1819 if (needlf)
1820 printf ("\n");
1821 needlf = 0;
1822 printf ("*ERROR*: Unknown message: %s\n", p);
1823 }
1824 }
3cf8c6aa
SM
1825 }
1826
1827 if (needlf)
1828 printf ("\n");
1829 fflush (stdout);
47d7532e
PE
1830 while (fdatasync (1) != 0 && errno == EINTR)
1831 continue;
23a7488d 1832
3ecb8d93
WS
1833 if (rl < 0)
1834 exit_status = EXIT_FAILURE;
1835
4b7b77f6 1836 CLOSE_SOCKET (emacs_socket);
3ecb8d93 1837 return exit_status;
46cec291
RS
1838}
1839
1e7823d0 1840#endif /* HAVE_SOCKETS && HAVE_INET_SOCKETS */