(cperl-fill-paragraph): Call fill-paragraph
[bpt/emacs.git] / lib-src / emacsclient.c
CommitLineData
efb859b4 1/* Client process that communicates with GNU Emacs acting as server.
5c9659d3 2 Copyright (C) 1986, 1987, 1994, 1999, 2000, 2001, 2003, 2004
de073ce3 3 Free Software Foundation, Inc.
46cec291
RS
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
92af894f 9the Free Software Foundation; either version 2, or (at your option)
46cec291
RS
10any later version.
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
18along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
46cec291
RS
21
22
23#define NO_SHORTNAMES
e69233c2
PJ
24
25#ifdef HAVE_CONFIG_H
2f8fe2f4 26#include <config.h>
e69233c2
PJ
27#endif
28
4e23f2ba 29#undef signal
46cec291 30
e69233c2 31#include <ctype.h>
8f9aaa0a
RS
32#include <stdio.h>
33#include <getopt.h>
79f13bba
DL
34#ifdef HAVE_UNISTD_H
35#include <unistd.h>
36#endif
8f9aaa0a 37
9f637eea
GM
38#ifdef VMS
39# include "vms-pwd.h"
40#else
41# include <pwd.h>
42#endif /* not VMS */
43
8f9aaa0a
RS
44char *getenv (), *getwd ();
45char *getcwd ();
8f9aaa0a
RS
46
47/* This is defined with -D from the compilation command,
48 which extracts it from ../lisp/version.el. */
49
50#ifndef VERSION
51#define VERSION "unspecified"
52#endif
53\f
54/* Name used to invoke this program. */
55char *progname;
56
749ae770 57/* Nonzero means don't wait for a response from Emacs. --no-wait. */
8f9aaa0a
RS
58int nowait = 0;
59
30be2360
SM
60/* Nonzero means args are expressions to be evaluated. --eval. */
61int eval = 0;
62
63/* The display on which Emacs should work. --display. */
64char *display = NULL;
65
66/* If non-NULL, the name of an editor to fallback to if the server
67 is not running. --alternate-editor. */
68const char * alternate_editor = NULL;
69
3db926be 70/* If non-NULL, the filename of the UNIX socket. */
254107e4
RS
71char *socket_name = NULL;
72
7f3bff3e
AS
73void print_help_and_exit ();
74
8f9aaa0a
RS
75struct option longopts[] =
76{
749ae770 77 { "no-wait", no_argument, NULL, 'n' },
30be2360 78 { "eval", no_argument, NULL, 'e' },
8f9aaa0a
RS
79 { "help", no_argument, NULL, 'H' },
80 { "version", no_argument, NULL, 'V' },
3cf8c6aa 81 { "alternate-editor", required_argument, NULL, 'a' },
254107e4 82 { "socket-name", required_argument, NULL, 's' },
30be2360
SM
83 { "display", required_argument, NULL, 'd' },
84 { 0, 0, 0, 0 }
8f9aaa0a
RS
85};
86
87/* Decode the options from argv and argc.
5212210c 88 The global variable `optind' will say how many arguments we used up. */
8f9aaa0a 89
5212210c 90void
8f9aaa0a
RS
91decode_options (argc, argv)
92 int argc;
93 char **argv;
94{
95 while (1)
96 {
97 int opt = getopt_long (argc, argv,
254107e4 98 "VHnea:s:d:", longopts, 0);
8f9aaa0a
RS
99
100 if (opt == EOF)
101 break;
102
97e3214d 103 alternate_editor = getenv ("ALTERNATE_EDITOR");
e69233c2 104
8f9aaa0a
RS
105 switch (opt)
106 {
107 case 0:
108 /* If getopt returns 0, then it has already processed a
109 long-named option. We should do nothing. */
110 break;
e69233c2 111
97e3214d
GM
112 case 'a':
113 alternate_editor = optarg;
114 break;
e69233c2 115
254107e4
RS
116 case 's':
117 socket_name = optarg;
118 break;
119
30be2360
SM
120 case 'd':
121 display = optarg;
122 break;
123
8f9aaa0a
RS
124 case 'n':
125 nowait = 1;
126 break;
127
30be2360
SM
128 case 'e':
129 eval = 1;
130 break;
131
8f9aaa0a 132 case 'V':
20c396e8
JB
133 printf ("emacsclient %s\n", VERSION);
134 exit (0);
8f9aaa0a 135 break;
46cec291 136
8f9aaa0a 137 case 'H':
8f9aaa0a 138 print_help_and_exit ();
20c396e8
JB
139 break;
140
141 default:
142 fprintf (stderr, "Try `%s --help' for more information\n", progname);
143 exit (1);
144 break;
8f9aaa0a
RS
145 }
146 }
8f9aaa0a
RS
147}
148
7f3bff3e 149void
8f9aaa0a
RS
150print_help_and_exit ()
151{
20c396e8
JB
152 printf (
153 "Usage: %s [OPTIONS] FILE...\n\
30be2360
SM
154Tell the Emacs server to visit the specified files.\n\
155Every FILE can be either just a FILENAME or [+LINE[:COLUMN]] FILENAME.\n\
20c396e8 156\n\
30be2360
SM
157The following OPTIONS are accepted:\n\
158-V, --version Just print a version info and return\n\
159-H, --help Print this usage information message\n\
160-n, --no-wait Don't wait for the server to return\n\
161-e, --eval Evaluate the FILE arguments as ELisp expressions\n\
162-d, --display=DISPLAY Visit the file in the given display\n\
254107e4
RS
163-s, --socket-name=FILENAME\n\
164 Set the filename of the UNIX socket for communication\n\
30be2360
SM
165-a, --alternate-editor=EDITOR\n\
166 Editor to fallback to if the server is not running\n\
20c396e8 167\n\
30be2360 168Report bugs to bug-gnu-emacs@gnu.org.\n", progname);
20c396e8 169 exit (0);
8f9aaa0a 170}
5212210c 171
a4cf2096
RS
172/* In NAME, insert a & before each &, each space, each newline, and
173 any initial -. Change spaces to underscores, too, so that the
5212210c
RS
174 return value never contains a space. */
175
87209357
EZ
176void
177quote_file_name (name, stream)
5212210c 178 char *name;
87209357 179 FILE *stream;
5212210c
RS
180{
181 char *copy = (char *) malloc (strlen (name) * 2 + 1);
182 char *p, *q;
183
184 p = name;
185 q = copy;
186 while (*p)
187 {
188 if (*p == ' ')
189 {
f1db6a73 190 *q++ = '&';
5212210c
RS
191 *q++ = '_';
192 p++;
193 }
3cf8c6aa
SM
194 else if (*p == '\n')
195 {
196 *q++ = '&';
197 *q++ = 'n';
198 p++;
199 }
5212210c
RS
200 else
201 {
f1db6a73
RS
202 if (*p == '&' || (*p == '-' && p == name))
203 *q++ = '&';
5212210c
RS
204 *q++ = *p++;
205 }
206 }
f1db6a73 207 *q++ = 0;
5212210c 208
87209357
EZ
209 fprintf (stream, copy);
210
211 free (copy);
5212210c 212}
0c76956f 213
0c76956f
RS
214/* Like malloc but get fatal error if memory is exhausted. */
215
5497dfdb 216long *
0c76956f
RS
217xmalloc (size)
218 unsigned int size;
219{
5f32a712 220 long *result = (long *) malloc (size);
0c76956f
RS
221 if (result == NULL)
222 {
223 perror ("malloc");
224 exit (1);
225 }
226 return result;
227}
8f9aaa0a 228\f
97e3214d
GM
229/*
230 Try to run a different command, or --if no alternate editor is
231 defined-- exit with an errorcode.
232*/
de073ce3 233void
97e3214d
GM
234fail (argc, argv)
235 int argc;
236 char **argv;
237{
238 if (alternate_editor)
239 {
3cf8c6aa 240 int i = optind - 1;
97e3214d 241 execvp (alternate_editor, argv + i);
23431241 242 return;
97e3214d
GM
243 }
244 else
245 {
246 exit (1);
247 }
248}
249
250
97e3214d 251\f
30be2360 252#if !defined (HAVE_SOCKETS) || defined (NO_SOCKETS_IN_FILE_SYSTEM)
46cec291 253
de073ce3 254int
46cec291
RS
255main (argc, argv)
256 int argc;
257 char **argv;
258{
259 fprintf (stderr, "%s: Sorry, the Emacs server is supported only\n",
260 argv[0]);
30be2360 261 fprintf (stderr, "on systems with Berkeley sockets.\n");
97e3214d
GM
262
263 fail (argc, argv);
46cec291
RS
264}
265
30be2360 266#else /* HAVE_SOCKETS */
46cec291
RS
267
268#include <sys/types.h>
269#include <sys/socket.h>
270#include <sys/un.h>
efb859b4 271#include <sys/stat.h>
46cec291
RS
272#include <errno.h>
273
92af894f 274extern char *strerror ();
46cec291
RS
275extern int errno;
276
9f637eea
GM
277/* Three possibilities:
278 2 - can't be `stat'ed (sets errno)
279 1 - isn't owned by us
280 0 - success: none of the above */
281
282static int
283socket_status (socket_name)
284 char *socket_name;
285{
286 struct stat statbfr;
287
288 if (stat (socket_name, &statbfr) == -1)
289 return 2;
290
291 if (statbfr.st_uid != geteuid ())
292 return 1;
293
294 return 0;
295}
296
340ff9de 297int
46cec291
RS
298main (argc, argv)
299 int argc;
300 char **argv;
301{
3cf8c6aa 302 int s, i, needlf = 0;
23a7488d 303 FILE *out, *in;
46cec291 304 struct sockaddr_un server;
571512de 305 char *cwd, *str;
46cec291 306 char string[BUFSIZ];
8f9aaa0a
RS
307
308 progname = argv[0];
46cec291 309
8f9aaa0a 310 /* Process options. */
5212210c 311 decode_options (argc, argv);
46cec291 312
87209357 313 if ((argc - optind < 1) && !eval)
20c396e8
JB
314 {
315 fprintf (stderr, "%s: file name or argument required\n", progname);
316 fprintf (stderr, "Try `%s --help' for more information\n", progname);
317 exit (1);
318 }
46cec291 319
e69233c2 320 /*
46cec291
RS
321 * Open up an AF_UNIX socket in this person's home directory
322 */
323
324 if ((s = socket (AF_UNIX, SOCK_STREAM, 0)) < 0)
325 {
326 fprintf (stderr, "%s: ", argv[0]);
327 perror ("socket");
97e3214d 328 fail (argc, argv);
46cec291 329 }
e69233c2 330
46cec291 331 server.sun_family = AF_UNIX;
c5fee545 332
c5fee545 333 {
9f637eea 334 int sock_status = 0;
5c9659d3 335 int default_sock = !socket_name;
152b6e83 336 int saved_errno;
0734b0d0
SM
337 char *server_name = "server";
338
339 if (socket_name && !index (socket_name, '/') && !index (socket_name, '\\'))
340 { /* socket_name is a file name component. */
341 server_name = socket_name;
342 socket_name = NULL;
343 default_sock = 1; /* Try both UIDs. */
344 }
efb859b4 345
5c9659d3 346 if (default_sock)
254107e4 347 {
0734b0d0
SM
348 socket_name = alloca (100 + strlen (server_name));
349 sprintf (socket_name, "/tmp/emacs%d/%s",
350 (int) geteuid (), server_name);
254107e4
RS
351 }
352
353 if (strlen (socket_name) < sizeof (server.sun_path))
354 strcpy (server.sun_path, socket_name);
355 else
5c9659d3
SM
356 {
357 fprintf (stderr, "%s: socket-name %s too long",
358 argv[0], socket_name);
359 exit (1);
360 }
efb859b4 361
9f637eea
GM
362 /* See if the socket exists, and if it's owned by us. */
363 sock_status = socket_status (server.sun_path);
152b6e83 364 saved_errno = errno;
5c9659d3 365 if (sock_status && default_sock)
efb859b4 366 {
9f637eea
GM
367 /* Failing that, see if LOGNAME or USER exist and differ from
368 our euid. If so, look for a socket based on the UID
369 associated with the name. This is reminiscent of the logic
370 that init_editfns uses to set the global Vuser_full_name. */
e69233c2 371
9f637eea 372 char *user_name = (char *) getenv ("LOGNAME");
293f9f2a 373
9f637eea
GM
374 if (!user_name)
375 user_name = (char *) getenv ("USER");
e69233c2 376
9f637eea
GM
377 if (user_name)
378 {
379 struct passwd *pw = getpwnam (user_name);
293f9f2a 380
9f637eea
GM
381 if (pw && (pw->pw_uid != geteuid ()))
382 {
383 /* We're running under su, apparently. */
0734b0d0
SM
384 socket_name = alloca (100 + strlen (server_name));
385 sprintf (socket_name, "/tmp/emacs%d/%s",
386 (int) pw->pw_uid, server_name);
5c9659d3
SM
387
388 if (strlen (socket_name) < sizeof (server.sun_path))
389 strcpy (server.sun_path, socket_name);
390 else
391 {
392 fprintf (stderr, "%s: socket-name %s too long",
393 argv[0], socket_name);
394 exit (1);
395 }
396
9f637eea 397 sock_status = socket_status (server.sun_path);
152b6e83 398 saved_errno = errno;
9f637eea 399 }
293f9f2a
RS
400 else
401 errno = saved_errno;
9f637eea 402 }
efb859b4 403 }
e69233c2 404
9f637eea
GM
405 switch (sock_status)
406 {
407 case 1:
408 /* There's a socket, but it isn't owned by us. This is OK if
409 we are root. */
410 if (0 != geteuid ())
411 {
412 fprintf (stderr, "%s: Invalid socket owner\n", argv[0]);
413 fail (argc, argv);
414 }
415 break;
e69233c2 416
9f637eea
GM
417 case 2:
418 /* `stat' failed */
152b6e83 419 if (saved_errno == ENOENT)
9f637eea 420 fprintf (stderr,
45adde32
SE
421 "%s: can't find socket; have you started the server?\n\
422To start the server in Emacs, type \"M-x server-start\".\n",
9f637eea
GM
423 argv[0]);
424 else
425 fprintf (stderr, "%s: can't stat %s: %s\n",
152b6e83 426 argv[0], server.sun_path, strerror (saved_errno));
9f637eea
GM
427 fail (argc, argv);
428 break;
429 }
efb859b4 430 }
46cec291 431
4e23f2ba
JB
432 if (connect (s, (struct sockaddr *) &server, strlen (server.sun_path) + 2)
433 < 0)
46cec291
RS
434 {
435 fprintf (stderr, "%s: ", argv[0]);
436 perror ("connect");
97e3214d 437 fail (argc, argv);
46cec291 438 }
23a7488d
RS
439
440 /* We use the stream OUT to send our command to the server. */
46cec291
RS
441 if ((out = fdopen (s, "r+")) == NULL)
442 {
443 fprintf (stderr, "%s: ", argv[0]);
444 perror ("fdopen");
97e3214d 445 fail (argc, argv);
46cec291
RS
446 }
447
23a7488d
RS
448 /* We use the stream IN to read the response.
449 We used to use just one stream for both output and input
450 on the socket, but reversing direction works nonportably:
451 on some systems, the output appears as the first input;
452 on other systems it does not. */
453 if ((in = fdopen (s, "r+")) == NULL)
454 {
455 fprintf (stderr, "%s: ", argv[0]);
456 perror ("fdopen");
97e3214d 457 fail (argc, argv);
23a7488d
RS
458 }
459
38732dba 460#ifdef HAVE_GETCWD
ee6a193c 461 cwd = getcwd (string, sizeof string);
38732dba
RS
462#else
463 cwd = getwd (string);
ee6a193c 464#endif
46cec291
RS
465 if (cwd == 0)
466 {
467 /* getwd puts message in STRING if it fails. */
bb5618fe 468
38732dba 469#ifdef HAVE_GETCWD
bb5618fe
JB
470 fprintf (stderr, "%s: %s (%s)\n", argv[0],
471 "Cannot get current working directory", strerror (errno));
38732dba 472#else
bb5618fe 473 fprintf (stderr, "%s: %s (%s)\n", argv[0], string, strerror (errno));
bd252662 474#endif
97e3214d 475 fail (argc, argv);
46cec291
RS
476 }
477
5212210c
RS
478 if (nowait)
479 fprintf (out, "-nowait ");
292d74a3 480
30be2360
SM
481 if (eval)
482 fprintf (out, "-eval ");
483
484 if (display)
87209357
EZ
485 {
486 fprintf (out, "-display ");
487 quote_file_name (display, out);
488 fprintf (out, " ");
489 }
30be2360 490
87209357 491 if ((argc - optind > 0))
5212210c 492 {
87209357 493 for (i = optind; i < argc; i++)
46cec291 494 {
87209357
EZ
495 if (eval)
496 ; /* Don't prepend any cwd or anything like that. */
497 else if (*argv[i] == '+')
498 {
499 char *p = argv[i] + 1;
500 while (isdigit ((unsigned char) *p) || *p == ':') p++;
501 if (*p != 0)
502 {
503 quote_file_name (cwd, out);
504 fprintf (out, "/");
505 }
506 }
507 else if (*argv[i] != '/')
508 {
509 quote_file_name (cwd, out);
510 fprintf (out, "/");
511 }
512
513 quote_file_name (argv[i], out);
514 fprintf (out, " ");
46cec291 515 }
46cec291 516 }
87209357
EZ
517 else
518 {
519 while ((str = fgets (string, BUFSIZ, stdin)))
520 {
521 quote_file_name (str, out);
522 }
523 fprintf (out, " ");
524 }
525
46cec291
RS
526 fprintf (out, "\n");
527 fflush (out);
528
292d74a3
RS
529 /* Maybe wait for an answer. */
530 if (nowait)
531 return 0;
532
30be2360
SM
533 if (!eval)
534 {
535 printf ("Waiting for Emacs...");
536 needlf = 2;
537 }
46cec291
RS
538 fflush (stdout);
539
3cf8c6aa 540 /* Now, wait for an answer and print any messages. */
e69233c2 541 while ((str = fgets (string, BUFSIZ, in)))
3cf8c6aa
SM
542 {
543 if (needlf == 2)
544 printf ("\n");
545 printf ("%s", str);
546 needlf = str[0] == '\0' ? needlf : str[strlen (str) - 1] != '\n';
547 }
548
549 if (needlf)
550 printf ("\n");
551 fflush (stdout);
23a7488d 552
340ff9de 553 return 0;
46cec291
RS
554}
555
30be2360 556#endif /* HAVE_SOCKETS */
27711600
RM
557\f
558#ifndef HAVE_STRERROR
559char *
560strerror (errnum)
561 int errnum;
562{
563 extern char *sys_errlist[];
564 extern int sys_nerr;
565
566 if (errnum >= 0 && errnum < sys_nerr)
567 return sys_errlist[errnum];
568 return (char *) "Unknown error";
569}
570
571#endif /* ! HAVE_STRERROR */
ab5796a9
MB
572
573/* arch-tag: f39bb9c4-73eb-477e-896d-50832e2ca9a7
574 (do not change this comment) */