NEWS tweak
[bpt/emacs.git] / src / callproc.c
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2012
3 Free Software Foundation, Inc.
4
5 This file is part of GNU Emacs.
6
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.
11
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.
16
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/>. */
19
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <sys/types.h>
25 #include <unistd.h>
26
27 #include <sys/file.h>
28 #include <fcntl.h>
29
30 #include "lisp.h"
31
32 #ifdef WINDOWSNT
33 #define NOMINMAX
34 #include <windows.h>
35 #include "w32.h"
36 #define _P_NOWAIT 1 /* from process.h */
37 #endif
38
39 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
40 #include <sys/stat.h>
41 #include <sys/param.h>
42 #endif /* MSDOS */
43
44 #include "commands.h"
45 #include "character.h"
46 #include "buffer.h"
47 #include "ccl.h"
48 #include "coding.h"
49 #include "composite.h"
50 #include <epaths.h>
51 #include "process.h"
52 #include "syssignal.h"
53 #include "systty.h"
54 #include "syswait.h"
55 #include "blockinput.h"
56 #include "frame.h"
57 #include "termhooks.h"
58
59 #ifdef MSDOS
60 #include "msdos.h"
61 #endif
62
63 #ifdef HAVE_NS
64 #include "nsterm.h"
65 #endif
66
67 /* Pattern used by call-process-region to make temp files. */
68 static Lisp_Object Vtemp_file_name_pattern;
69
70 /* True if we are about to fork off a synchronous process or if we
71 are waiting for it. */
72 bool synch_process_alive;
73
74 /* Nonzero => this is a string explaining death of synchronous subprocess. */
75 const char *synch_process_death;
76
77 /* Nonzero => this is the signal number that terminated the subprocess. */
78 int synch_process_termsig;
79
80 /* If synch_process_death is zero,
81 this is exit code of synchronous subprocess. */
82 int synch_process_retcode;
83
84 \f
85 /* Clean up when exiting Fcall_process.
86 On MSDOS, delete the temporary file on any kind of termination.
87 On Unix, kill the process and any children on termination by signal. */
88
89 /* True if this is termination due to exit. */
90 static bool call_process_exited;
91
92 static Lisp_Object
93 call_process_kill (Lisp_Object fdpid)
94 {
95 int fd;
96 pid_t pid;
97 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
98 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
99 emacs_close (fd);
100 EMACS_KILLPG (pid, SIGKILL);
101 synch_process_alive = 0;
102 return Qnil;
103 }
104
105 static Lisp_Object
106 call_process_cleanup (Lisp_Object arg)
107 {
108 Lisp_Object fdpid = Fcdr (arg);
109 int fd;
110 #if defined (MSDOS)
111 Lisp_Object file;
112 #else
113 pid_t pid;
114 #endif
115
116 Fset_buffer (Fcar (arg));
117 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
118
119 #if defined (MSDOS)
120 /* for MSDOS fdpid is really (fd . tempfile) */
121 file = Fcdr (fdpid);
122 /* FD is -1 and FILE is "" when we didn't actually create a
123 temporary file in call-process. */
124 if (fd >= 0)
125 emacs_close (fd);
126 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
127 unlink (SDATA (file));
128 #else /* not MSDOS */
129 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
130
131 if (call_process_exited)
132 {
133 emacs_close (fd);
134 return Qnil;
135 }
136
137 if (EMACS_KILLPG (pid, SIGINT) == 0)
138 {
139 ptrdiff_t count = SPECPDL_INDEX ();
140 record_unwind_protect (call_process_kill, fdpid);
141 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
142 immediate_quit = 1;
143 QUIT;
144 wait_for_termination (pid);
145 immediate_quit = 0;
146 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
147 message1 ("Waiting for process to die...done");
148 }
149 synch_process_alive = 0;
150 emacs_close (fd);
151 #endif /* not MSDOS */
152 return Qnil;
153 }
154
155 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
156 doc: /* Call PROGRAM synchronously in separate process.
157 The remaining arguments are optional.
158 The program's input comes from file INFILE (nil means `/dev/null').
159 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
160 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
161 FILE is a file name string, means that it should be written to that file
162 \(if the file already exists it is overwritten).
163 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
164 REAL-BUFFER says what to do with standard output, as above,
165 while STDERR-FILE says what to do with standard error in the child.
166 STDERR-FILE may be nil (discard standard error output),
167 t (mix it with ordinary output), or a file name string.
168
169 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
170 Remaining arguments are strings passed as command arguments to PROGRAM.
171
172 If executable PROGRAM can't be found as an executable, `call-process'
173 signals a Lisp error. `call-process' reports errors in execution of
174 the program only through its return and output.
175
176 If BUFFER is 0, `call-process' returns immediately with value nil.
177 Otherwise it waits for PROGRAM to terminate
178 and returns a numeric exit status or a signal description string.
179 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
180
181 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
182 (ptrdiff_t nargs, Lisp_Object *args)
183 {
184 Lisp_Object infile, buffer, current_dir, path, cleanup_info_tail;
185 bool display_p;
186 int fd[2];
187 int filefd;
188 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
189 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
190 char buf[CALLPROC_BUFFER_SIZE_MAX];
191 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
192 ptrdiff_t count = SPECPDL_INDEX ();
193 USE_SAFE_ALLOCA;
194
195 register const unsigned char **new_argv;
196 /* File to use for stderr in the child.
197 t means use same as standard output. */
198 Lisp_Object error_file;
199 Lisp_Object output_file = Qnil;
200 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
201 char *outf, *tempfile = NULL;
202 int outfilefd;
203 int pid;
204 #else
205 pid_t pid;
206 #endif
207 int fd_output = -1;
208 struct coding_system process_coding; /* coding-system of process output */
209 struct coding_system argument_coding; /* coding-system of arguments */
210 /* Set to the return value of Ffind_operation_coding_system. */
211 Lisp_Object coding_systems;
212 bool output_to_buffer = 1;
213
214 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
215 coding_systems = Qt;
216
217 CHECK_STRING (args[0]);
218
219 error_file = Qt;
220
221 #ifndef subprocesses
222 /* Without asynchronous processes we cannot have BUFFER == 0. */
223 if (nargs >= 3
224 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
225 error ("Operating system cannot handle asynchronous subprocesses");
226 #endif /* subprocesses */
227
228 /* Decide the coding-system for giving arguments. */
229 {
230 Lisp_Object val, *args2;
231 ptrdiff_t i;
232
233 /* If arguments are supplied, we may have to encode them. */
234 if (nargs >= 5)
235 {
236 bool must_encode = 0;
237 Lisp_Object coding_attrs;
238
239 for (i = 4; i < nargs; i++)
240 CHECK_STRING (args[i]);
241
242 for (i = 4; i < nargs; i++)
243 if (STRING_MULTIBYTE (args[i]))
244 must_encode = 1;
245
246 if (!NILP (Vcoding_system_for_write))
247 val = Vcoding_system_for_write;
248 else if (! must_encode)
249 val = Qraw_text;
250 else
251 {
252 SAFE_NALLOCA (args2, 1, nargs + 1);
253 args2[0] = Qcall_process;
254 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
255 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
256 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
257 }
258 val = complement_process_encoding_system (val);
259 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
260 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
261 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
262 {
263 /* We should not use an ASCII incompatible coding system. */
264 val = raw_text_coding_system (val);
265 setup_coding_system (val, &argument_coding);
266 }
267 }
268 }
269
270 if (nargs >= 2 && ! NILP (args[1]))
271 {
272 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
273 CHECK_STRING (infile);
274 }
275 else
276 infile = build_string (NULL_DEVICE);
277
278 if (nargs >= 3)
279 {
280 buffer = args[2];
281
282 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
283 FILE-FOR-STDERR), unless the first element is :file, in which case see
284 the next paragraph. */
285 if (CONSP (buffer)
286 && (! SYMBOLP (XCAR (buffer))
287 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
288 {
289 if (CONSP (XCDR (buffer)))
290 {
291 Lisp_Object stderr_file;
292 stderr_file = XCAR (XCDR (buffer));
293
294 if (NILP (stderr_file) || EQ (Qt, stderr_file))
295 error_file = stderr_file;
296 else
297 error_file = Fexpand_file_name (stderr_file, Qnil);
298 }
299
300 buffer = XCAR (buffer);
301 }
302
303 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
304 if (CONSP (buffer)
305 && SYMBOLP (XCAR (buffer))
306 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
307 {
308 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
309 BVAR (current_buffer, directory));
310 CHECK_STRING (output_file);
311 buffer = Qnil;
312 }
313
314 if (!(EQ (buffer, Qnil)
315 || EQ (buffer, Qt)
316 || INTEGERP (buffer)))
317 {
318 Lisp_Object spec_buffer;
319 spec_buffer = buffer;
320 buffer = Fget_buffer_create (buffer);
321 /* Mention the buffer name for a better error message. */
322 if (NILP (buffer))
323 CHECK_BUFFER (spec_buffer);
324 CHECK_BUFFER (buffer);
325 }
326 }
327 else
328 buffer = Qnil;
329
330 /* Make sure that the child will be able to chdir to the current
331 buffer's current directory, or its unhandled equivalent. We
332 can't just have the child check for an error when it does the
333 chdir, since it's in a vfork.
334
335 We have to GCPRO around this because Fexpand_file_name,
336 Funhandled_file_name_directory, and Ffile_accessible_directory_p
337 might call a file name handling function. The argument list is
338 protected by the caller, so all we really have to worry about is
339 buffer. */
340 {
341 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
342
343 current_dir = BVAR (current_buffer, directory);
344
345 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
346
347 current_dir = Funhandled_file_name_directory (current_dir);
348 if (NILP (current_dir))
349 /* If the file name handler says that current_dir is unreachable, use
350 a sensible default. */
351 current_dir = build_string ("~/");
352 current_dir = expand_and_dir_to_file (current_dir, Qnil);
353 current_dir = Ffile_name_as_directory (current_dir);
354
355 if (NILP (Ffile_accessible_directory_p (current_dir)))
356 report_file_error ("Setting current directory",
357 Fcons (BVAR (current_buffer, directory), Qnil));
358
359 if (STRING_MULTIBYTE (infile))
360 infile = ENCODE_FILE (infile);
361 if (STRING_MULTIBYTE (current_dir))
362 current_dir = ENCODE_FILE (current_dir);
363 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
364 error_file = ENCODE_FILE (error_file);
365 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
366 output_file = ENCODE_FILE (output_file);
367 UNGCPRO;
368 }
369
370 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
371
372 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
373 if (filefd < 0)
374 {
375 infile = DECODE_FILE (infile);
376 report_file_error ("Opening process input file", Fcons (infile, Qnil));
377 }
378
379 if (STRINGP (output_file))
380 {
381 #ifdef DOS_NT
382 fd_output = emacs_open (SSDATA (output_file),
383 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
384 S_IREAD | S_IWRITE);
385 #else /* not DOS_NT */
386 fd_output = creat (SSDATA (output_file), 0666);
387 #endif /* not DOS_NT */
388 if (fd_output < 0)
389 {
390 output_file = DECODE_FILE (output_file);
391 report_file_error ("Opening process output file",
392 Fcons (output_file, Qnil));
393 }
394 if (STRINGP (error_file) || NILP (error_file))
395 output_to_buffer = 0;
396 }
397
398 /* Search for program; barf if not found. */
399 {
400 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
401
402 GCPRO4 (infile, buffer, current_dir, error_file);
403 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
404 UNGCPRO;
405 }
406 if (NILP (path))
407 {
408 emacs_close (filefd);
409 report_file_error ("Searching for program", Fcons (args[0], Qnil));
410 }
411
412 /* If program file name starts with /: for quoting a magic name,
413 discard that. */
414 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
415 && SREF (path, 1) == ':')
416 path = Fsubstring (path, make_number (2), Qnil);
417
418 new_argv = SAFE_ALLOCA ((nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
419 if (nargs > 4)
420 {
421 ptrdiff_t i;
422 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
423
424 GCPRO5 (infile, buffer, current_dir, path, error_file);
425 argument_coding.dst_multibyte = 0;
426 for (i = 4; i < nargs; i++)
427 {
428 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
429 if (CODING_REQUIRE_ENCODING (&argument_coding))
430 /* We must encode this argument. */
431 args[i] = encode_coding_string (&argument_coding, args[i], 1);
432 }
433 UNGCPRO;
434 for (i = 4; i < nargs; i++)
435 new_argv[i - 3] = SDATA (args[i]);
436 new_argv[i - 3] = 0;
437 }
438 else
439 new_argv[1] = 0;
440 new_argv[0] = SDATA (path);
441
442 #ifdef MSDOS /* MW, July 1993 */
443
444 /* If we're redirecting STDOUT to a file, that file is already open
445 on fd_output. */
446 if (fd_output < 0)
447 {
448 if ((outf = egetenv ("TMPDIR")))
449 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
450 else
451 {
452 tempfile = alloca (20);
453 *tempfile = '\0';
454 }
455 dostounix_filename (tempfile);
456 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
457 strcat (tempfile, "/");
458 strcat (tempfile, "detmp.XXX");
459 mktemp (tempfile);
460 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
461 if (outfilefd < 0) {
462 emacs_close (filefd);
463 report_file_error ("Opening process output file",
464 Fcons (build_string (tempfile), Qnil));
465 }
466 }
467 else
468 outfilefd = fd_output;
469 fd[0] = filefd;
470 fd[1] = outfilefd;
471 #endif /* MSDOS */
472
473 if (INTEGERP (buffer))
474 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
475 else
476 {
477 #ifndef MSDOS
478 errno = 0;
479 if (pipe (fd) == -1)
480 {
481 emacs_close (filefd);
482 report_file_error ("Creating process pipe", Qnil);
483 }
484 #endif
485 }
486
487 {
488 /* child_setup must clobber environ in systems with true vfork.
489 Protect it from permanent change. */
490 register char **save_environ = environ;
491 register int fd1 = fd[1];
492 int fd_error = fd1;
493
494 if (fd_output >= 0)
495 fd1 = fd_output;
496
497 /* Record that we're about to create a synchronous process. */
498 synch_process_alive = 1;
499
500 /* These vars record information from process termination.
501 Clear them now before process can possibly terminate,
502 to avoid timing error if process terminates soon. */
503 synch_process_death = 0;
504 synch_process_retcode = 0;
505 synch_process_termsig = 0;
506
507 if (NILP (error_file))
508 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
509 else if (STRINGP (error_file))
510 {
511 #ifdef DOS_NT
512 fd_error = emacs_open (SSDATA (error_file),
513 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
514 S_IREAD | S_IWRITE);
515 #else /* not DOS_NT */
516 fd_error = creat (SSDATA (error_file), 0666);
517 #endif /* not DOS_NT */
518 }
519
520 if (fd_error < 0)
521 {
522 emacs_close (filefd);
523 if (fd[0] != filefd)
524 emacs_close (fd[0]);
525 if (fd1 >= 0)
526 emacs_close (fd1);
527 #ifdef MSDOS
528 unlink (tempfile);
529 #endif
530 if (NILP (error_file))
531 error_file = build_string (NULL_DEVICE);
532 else if (STRINGP (error_file))
533 error_file = DECODE_FILE (error_file);
534 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
535 }
536
537 #ifdef MSDOS /* MW, July 1993 */
538 /* Note that on MSDOS `child_setup' actually returns the child process
539 exit status, not its PID, so we assign it to `synch_process_retcode'
540 below. */
541 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
542 0, current_dir);
543
544 /* Record that the synchronous process exited and note its
545 termination status. */
546 synch_process_alive = 0;
547 synch_process_retcode = pid;
548 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
549 {
550 synchronize_system_messages_locale ();
551 synch_process_death = strerror (errno);
552 }
553
554 emacs_close (outfilefd);
555 if (fd_error != outfilefd)
556 emacs_close (fd_error);
557 fd1 = -1; /* No harm in closing that one! */
558 if (tempfile)
559 {
560 /* Since CRLF is converted to LF within `decode_coding', we
561 can always open a file with binary mode. */
562 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
563 if (fd[0] < 0)
564 {
565 unlink (tempfile);
566 emacs_close (filefd);
567 report_file_error ("Cannot re-open temporary file",
568 Fcons (build_string (tempfile), Qnil));
569 }
570 }
571 else
572 fd[0] = -1; /* We are not going to read from tempfile. */
573 #else /* not MSDOS */
574 #ifdef WINDOWSNT
575 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
576 0, current_dir);
577 #else /* not WINDOWSNT */
578
579 block_input ();
580
581 /* vfork, and prevent local vars from being clobbered by the vfork. */
582 {
583 Lisp_Object volatile buffer_volatile = buffer;
584 Lisp_Object volatile coding_systems_volatile = coding_systems;
585 Lisp_Object volatile current_dir_volatile = current_dir;
586 bool volatile display_p_volatile = display_p;
587 bool volatile output_to_buffer_volatile = output_to_buffer;
588 bool volatile sa_must_free_volatile = sa_must_free;
589 int volatile fd1_volatile = fd1;
590 int volatile fd_error_volatile = fd_error;
591 int volatile fd_output_volatile = fd_output;
592 ptrdiff_t volatile sa_count_volatile = sa_count;
593 unsigned char const **volatile new_argv_volatile = new_argv;
594
595 pid = vfork ();
596
597 buffer = buffer_volatile;
598 coding_systems = coding_systems_volatile;
599 current_dir = current_dir_volatile;
600 display_p = display_p_volatile;
601 fd1 = fd1_volatile;
602 fd_error = fd_error_volatile;
603 fd_output = fd_output_volatile;
604 output_to_buffer = output_to_buffer_volatile;
605 sa_must_free = sa_must_free_volatile;
606 sa_count = sa_count_volatile;
607 new_argv = new_argv_volatile;
608 }
609
610 if (pid == 0)
611 {
612 if (fd[0] >= 0)
613 emacs_close (fd[0]);
614
615 #ifdef HAVE_SETSID
616 setsid ();
617 #else
618 setpgid (0, 0);
619 #endif
620
621 /* Emacs ignores SIGPIPE, but the child should not. */
622 signal (SIGPIPE, SIG_DFL);
623
624 child_setup (filefd, fd1, fd_error, (char **) new_argv,
625 0, current_dir);
626 }
627
628 unblock_input ();
629
630 #endif /* not WINDOWSNT */
631
632 /* The MSDOS case did this already. */
633 if (fd_error >= 0)
634 emacs_close (fd_error);
635 #endif /* not MSDOS */
636
637 environ = save_environ;
638
639 /* Close most of our fd's, but not fd[0]
640 since we will use that to read input from. */
641 emacs_close (filefd);
642 if (fd_output >= 0)
643 emacs_close (fd_output);
644 if (fd1 >= 0 && fd1 != fd_error)
645 emacs_close (fd1);
646 }
647
648 if (pid < 0)
649 {
650 if (fd[0] >= 0)
651 emacs_close (fd[0]);
652 report_file_error ("Doing vfork", Qnil);
653 }
654
655 if (INTEGERP (buffer))
656 {
657 if (fd[0] >= 0)
658 emacs_close (fd[0]);
659 return Qnil;
660 }
661
662 /* Enable sending signal if user quits below. */
663 call_process_exited = 0;
664
665 #if defined (MSDOS)
666 /* MSDOS needs different cleanup information. */
667 cleanup_info_tail = build_string (tempfile ? tempfile : "");
668 #else
669 cleanup_info_tail = INTEGER_TO_CONS (pid);
670 #endif /* not MSDOS */
671 record_unwind_protect (call_process_cleanup,
672 Fcons (Fcurrent_buffer (),
673 Fcons (INTEGER_TO_CONS (fd[0]),
674 cleanup_info_tail)));
675
676 if (BUFFERP (buffer))
677 Fset_buffer (buffer);
678
679 if (NILP (buffer))
680 {
681 /* If BUFFER is nil, we must read process output once and then
682 discard it, so setup coding system but with nil. */
683 setup_coding_system (Qnil, &process_coding);
684 process_coding.dst_multibyte = 0;
685 }
686 else
687 {
688 Lisp_Object val, *args2;
689
690 val = Qnil;
691 if (!NILP (Vcoding_system_for_read))
692 val = Vcoding_system_for_read;
693 else
694 {
695 if (EQ (coding_systems, Qt))
696 {
697 ptrdiff_t i;
698
699 SAFE_NALLOCA (args2, 1, nargs + 1);
700 args2[0] = Qcall_process;
701 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
702 coding_systems
703 = Ffind_operation_coding_system (nargs + 1, args2);
704 }
705 if (CONSP (coding_systems))
706 val = XCAR (coding_systems);
707 else if (CONSP (Vdefault_process_coding_system))
708 val = XCAR (Vdefault_process_coding_system);
709 else
710 val = Qnil;
711 }
712 Fcheck_coding_system (val);
713 /* In unibyte mode, character code conversion should not take
714 place but EOL conversion should. So, setup raw-text or one
715 of the subsidiary according to the information just setup. */
716 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
717 && !NILP (val))
718 val = raw_text_coding_system (val);
719 setup_coding_system (val, &process_coding);
720 process_coding.dst_multibyte
721 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
722 }
723 process_coding.src_multibyte = 0;
724
725 immediate_quit = 1;
726 QUIT;
727
728 if (output_to_buffer)
729 {
730 int nread;
731 bool first = 1;
732 EMACS_INT total_read = 0;
733 int carryover = 0;
734 bool display_on_the_fly = display_p;
735 struct coding_system saved_coding;
736
737 saved_coding = process_coding;
738 while (1)
739 {
740 /* Repeatedly read until we've filled as much as possible
741 of the buffer size we have. But don't read
742 less than 1024--save that for the next bufferful. */
743 nread = carryover;
744 while (nread < bufsize - 1024)
745 {
746 int this_read = emacs_read (fd[0], buf + nread,
747 bufsize - nread);
748
749 if (this_read < 0)
750 goto give_up;
751
752 if (this_read == 0)
753 {
754 process_coding.mode |= CODING_MODE_LAST_BLOCK;
755 break;
756 }
757
758 nread += this_read;
759 total_read += this_read;
760
761 if (display_on_the_fly)
762 break;
763 }
764
765 /* Now NREAD is the total amount of data in the buffer. */
766 immediate_quit = 0;
767
768 if (!NILP (buffer))
769 {
770 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
771 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
772 insert_1_both (buf, nread, nread, 0, 1, 0);
773 else
774 { /* We have to decode the input. */
775 Lisp_Object curbuf;
776 ptrdiff_t count1 = SPECPDL_INDEX ();
777
778 XSETBUFFER (curbuf, current_buffer);
779 /* We cannot allow after-change-functions be run
780 during decoding, because that might modify the
781 buffer, while we rely on process_coding.produced to
782 faithfully reflect inserted text until we
783 TEMP_SET_PT_BOTH below. */
784 specbind (Qinhibit_modification_hooks, Qt);
785 decode_coding_c_string (&process_coding,
786 (unsigned char *) buf, nread, curbuf);
787 unbind_to (count1, Qnil);
788 if (display_on_the_fly
789 && CODING_REQUIRE_DETECTION (&saved_coding)
790 && ! CODING_REQUIRE_DETECTION (&process_coding))
791 {
792 /* We have detected some coding system. But,
793 there's a possibility that the detection was
794 done by insufficient data. So, we give up
795 displaying on the fly. */
796 if (process_coding.produced > 0)
797 del_range_2 (process_coding.dst_pos,
798 process_coding.dst_pos_byte,
799 process_coding.dst_pos
800 + process_coding.produced_char,
801 process_coding.dst_pos_byte
802 + process_coding.produced, 0);
803 display_on_the_fly = 0;
804 process_coding = saved_coding;
805 carryover = nread;
806 /* This is to make the above condition always
807 fails in the future. */
808 saved_coding.common_flags
809 &= ~CODING_REQUIRE_DETECTION_MASK;
810 continue;
811 }
812
813 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
814 PT_BYTE + process_coding.produced);
815 carryover = process_coding.carryover_bytes;
816 if (carryover > 0)
817 memcpy (buf, process_coding.carryover,
818 process_coding.carryover_bytes);
819 }
820 }
821
822 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
823 break;
824
825 /* Make the buffer bigger as we continue to read more data,
826 but not past CALLPROC_BUFFER_SIZE_MAX. */
827 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
828 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
829 bufsize = CALLPROC_BUFFER_SIZE_MAX;
830
831 if (display_p)
832 {
833 if (first)
834 prepare_menu_bars ();
835 first = 0;
836 redisplay_preserve_echo_area (1);
837 /* This variable might have been set to 0 for code
838 detection. In that case, we set it back to 1 because
839 we should have already detected a coding system. */
840 display_on_the_fly = 1;
841 }
842 immediate_quit = 1;
843 QUIT;
844 }
845 give_up: ;
846
847 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
848 /* If the caller required, let the buffer inherit the
849 coding-system used to decode the process output. */
850 if (inherit_process_coding_system)
851 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
852 make_number (total_read));
853 }
854
855 #ifndef MSDOS
856 /* Wait for it to terminate, unless it already has. */
857 if (output_to_buffer)
858 wait_for_termination (pid);
859 else
860 interruptible_wait_for_termination (pid);
861 #endif
862
863 immediate_quit = 0;
864
865 /* Don't kill any children that the subprocess may have left behind
866 when exiting. */
867 call_process_exited = 1;
868
869 SAFE_FREE ();
870 unbind_to (count, Qnil);
871
872 if (synch_process_termsig)
873 {
874 const char *signame;
875
876 synchronize_system_messages_locale ();
877 signame = strsignal (synch_process_termsig);
878
879 if (signame == 0)
880 signame = "unknown";
881
882 synch_process_death = signame;
883 }
884
885 if (synch_process_death)
886 return code_convert_string_norecord (build_string (synch_process_death),
887 Vlocale_coding_system, 0);
888 return make_number (synch_process_retcode);
889 }
890 \f
891 static Lisp_Object
892 delete_temp_file (Lisp_Object name)
893 {
894 /* Suppress jka-compr handling, etc. */
895 ptrdiff_t count = SPECPDL_INDEX ();
896 specbind (intern ("file-name-handler-alist"), Qnil);
897 internal_delete_file (name);
898 unbind_to (count, Qnil);
899 return Qnil;
900 }
901
902 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
903 3, MANY, 0,
904 doc: /* Send text from START to END to a synchronous process running PROGRAM.
905 The remaining arguments are optional.
906 Delete the text if fourth arg DELETE is non-nil.
907
908 Insert output in BUFFER before point; t means current buffer; nil for
909 BUFFER means discard it; 0 means discard and don't wait; and `(:file
910 FILE)', where FILE is a file name string, means that it should be
911 written to that file (if the file already exists it is overwritten).
912 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
913 REAL-BUFFER says what to do with standard output, as above,
914 while STDERR-FILE says what to do with standard error in the child.
915 STDERR-FILE may be nil (discard standard error output),
916 t (mix it with ordinary output), or a file name string.
917
918 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
919 Remaining args are passed to PROGRAM at startup as command args.
920
921 If BUFFER is 0, `call-process-region' returns immediately with value nil.
922 Otherwise it waits for PROGRAM to terminate
923 and returns a numeric exit status or a signal description string.
924 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
925
926 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
927 (ptrdiff_t nargs, Lisp_Object *args)
928 {
929 struct gcpro gcpro1;
930 Lisp_Object filename_string;
931 register Lisp_Object start, end;
932 ptrdiff_t count = SPECPDL_INDEX ();
933 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
934 Lisp_Object coding_systems;
935 Lisp_Object val, *args2;
936 ptrdiff_t i;
937 Lisp_Object tmpdir;
938
939 if (STRINGP (Vtemporary_file_directory))
940 tmpdir = Vtemporary_file_directory;
941 else
942 {
943 #ifndef DOS_NT
944 if (getenv ("TMPDIR"))
945 tmpdir = build_string (getenv ("TMPDIR"));
946 else
947 tmpdir = build_string ("/tmp/");
948 #else /* DOS_NT */
949 char *outf;
950 if ((outf = egetenv ("TMPDIR"))
951 || (outf = egetenv ("TMP"))
952 || (outf = egetenv ("TEMP")))
953 tmpdir = build_string (outf);
954 else
955 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
956 #endif
957 }
958
959 {
960 USE_SAFE_ALLOCA;
961 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
962 char *tempfile = SAFE_ALLOCA (SBYTES (pattern) + 1);
963 memcpy (tempfile, SDATA (pattern), SBYTES (pattern) + 1);
964 coding_systems = Qt;
965
966 #ifdef HAVE_MKSTEMP
967 {
968 int fd;
969
970 block_input ();
971 fd = mkstemp (tempfile);
972 unblock_input ();
973 if (fd == -1)
974 report_file_error ("Failed to open temporary file",
975 Fcons (build_string (tempfile), Qnil));
976 else
977 close (fd);
978 }
979 #else
980 mktemp (tempfile);
981 #endif
982
983 filename_string = build_string (tempfile);
984 GCPRO1 (filename_string);
985 SAFE_FREE ();
986 }
987
988 start = args[0];
989 end = args[1];
990 /* Decide coding-system of the contents of the temporary file. */
991 if (!NILP (Vcoding_system_for_write))
992 val = Vcoding_system_for_write;
993 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
994 val = Qraw_text;
995 else
996 {
997 USE_SAFE_ALLOCA;
998 SAFE_NALLOCA (args2, 1, nargs + 1);
999 args2[0] = Qcall_process_region;
1000 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1001 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1002 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1003 SAFE_FREE ();
1004 }
1005 val = complement_process_encoding_system (val);
1006
1007 {
1008 ptrdiff_t count1 = SPECPDL_INDEX ();
1009
1010 specbind (intern ("coding-system-for-write"), val);
1011 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1012 happen to get a ".Z" suffix. */
1013 specbind (intern ("file-name-handler-alist"), Qnil);
1014 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1015
1016 unbind_to (count1, Qnil);
1017 }
1018
1019 /* Note that Fcall_process takes care of binding
1020 coding-system-for-read. */
1021
1022 record_unwind_protect (delete_temp_file, filename_string);
1023
1024 if (nargs > 3 && !NILP (args[3]))
1025 Fdelete_region (start, end);
1026
1027 if (nargs > 3)
1028 {
1029 args += 2;
1030 nargs -= 2;
1031 }
1032 else
1033 {
1034 args[0] = args[2];
1035 nargs = 2;
1036 }
1037 args[1] = filename_string;
1038
1039 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1040 }
1041 \f
1042 #ifndef WINDOWSNT
1043 static int relocate_fd (int fd, int minfd);
1044 #endif
1045
1046 static char **
1047 add_env (char **env, char **new_env, char *string)
1048 {
1049 char **ep;
1050 bool ok = 1;
1051 if (string == NULL)
1052 return new_env;
1053
1054 /* See if this string duplicates any string already in the env.
1055 If so, don't put it in.
1056 When an env var has multiple definitions,
1057 we keep the definition that comes first in process-environment. */
1058 for (ep = env; ok && ep != new_env; ep++)
1059 {
1060 char *p = *ep, *q = string;
1061 while (ok)
1062 {
1063 if (*q != *p)
1064 break;
1065 if (*q == 0)
1066 /* The string is a lone variable name; keep it for now, we
1067 will remove it later. It is a placeholder for a
1068 variable that is not to be included in the environment. */
1069 break;
1070 if (*q == '=')
1071 ok = 0;
1072 p++, q++;
1073 }
1074 }
1075 if (ok)
1076 *new_env++ = string;
1077 return new_env;
1078 }
1079
1080 /* This is the last thing run in a newly forked inferior
1081 either synchronous or asynchronous.
1082 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1083 Initialize inferior's priority, pgrp, connected dir and environment.
1084 then exec another program based on new_argv.
1085
1086 This function may change environ for the superior process.
1087 Therefore, the superior process must save and restore the value
1088 of environ around the vfork and the call to this function.
1089
1090 If SET_PGRP, put the subprocess into a separate process group.
1091
1092 CURRENT_DIR is an elisp string giving the path of the current
1093 directory the subprocess should have. Since we can't really signal
1094 a decent error from within the child, this should be verified as an
1095 executable directory by the parent. */
1096
1097 int
1098 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1099 Lisp_Object current_dir)
1100 {
1101 char **env;
1102 char *pwd_var;
1103 #ifdef WINDOWSNT
1104 int cpid;
1105 HANDLE handles[3];
1106 #endif /* WINDOWSNT */
1107
1108 pid_t pid = getpid ();
1109
1110 /* Close Emacs's descriptors that this process should not have. */
1111 close_process_descs ();
1112
1113 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1114 we will lose if we call close_load_descs here. */
1115 #ifndef DOS_NT
1116 close_load_descs ();
1117 #endif
1118
1119 /* Note that use of alloca is always safe here. It's obvious for systems
1120 that do not have true vfork or that have true (stack) alloca.
1121 If using vfork and C_ALLOCA (when Emacs used to include
1122 src/alloca.c) it is safe because that changes the superior's
1123 static variables as if the superior had done alloca and will be
1124 cleaned up in the usual way. */
1125 {
1126 register char *temp;
1127 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1128
1129 i = SBYTES (current_dir);
1130 #ifdef MSDOS
1131 /* MSDOS must have all environment variables malloc'ed, because
1132 low-level libc functions that launch subsidiary processes rely
1133 on that. */
1134 pwd_var = xmalloc (i + 6);
1135 #else
1136 pwd_var = alloca (i + 6);
1137 #endif
1138 temp = pwd_var + 4;
1139 memcpy (pwd_var, "PWD=", 4);
1140 memcpy (temp, SDATA (current_dir), i);
1141 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1142 temp[i] = 0;
1143
1144 #ifndef DOS_NT
1145 /* We can't signal an Elisp error here; we're in a vfork. Since
1146 the callers check the current directory before forking, this
1147 should only return an error if the directory's permissions
1148 are changed between the check and this chdir, but we should
1149 at least check. */
1150 if (chdir (temp) < 0)
1151 _exit (errno);
1152 #else /* DOS_NT */
1153 /* Get past the drive letter, so that d:/ is left alone. */
1154 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1155 {
1156 temp += 2;
1157 i -= 2;
1158 }
1159 #endif /* DOS_NT */
1160
1161 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1162 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1163 temp[--i] = 0;
1164 }
1165
1166 /* Set `env' to a vector of the strings in the environment. */
1167 {
1168 register Lisp_Object tem;
1169 register char **new_env;
1170 char **p, **q;
1171 register int new_length;
1172 Lisp_Object display = Qnil;
1173
1174 new_length = 0;
1175
1176 for (tem = Vprocess_environment;
1177 CONSP (tem) && STRINGP (XCAR (tem));
1178 tem = XCDR (tem))
1179 {
1180 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1181 && (SDATA (XCAR (tem)) [7] == '\0'
1182 || SDATA (XCAR (tem)) [7] == '='))
1183 /* DISPLAY is specified in process-environment. */
1184 display = Qt;
1185 new_length++;
1186 }
1187
1188 /* If not provided yet, use the frame's DISPLAY. */
1189 if (NILP (display))
1190 {
1191 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1192 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1193 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1194 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1195 Vinitial_environment);
1196 if (STRINGP (tmp))
1197 {
1198 display = tmp;
1199 new_length++;
1200 }
1201 }
1202
1203 /* new_length + 2 to include PWD and terminating 0. */
1204 env = new_env = alloca ((new_length + 2) * sizeof *env);
1205 /* If we have a PWD envvar, pass one down,
1206 but with corrected value. */
1207 if (egetenv ("PWD"))
1208 *new_env++ = pwd_var;
1209
1210 if (STRINGP (display))
1211 {
1212 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1213 strcpy (vdata, "DISPLAY=");
1214 strcat (vdata, SSDATA (display));
1215 new_env = add_env (env, new_env, vdata);
1216 }
1217
1218 /* Overrides. */
1219 for (tem = Vprocess_environment;
1220 CONSP (tem) && STRINGP (XCAR (tem));
1221 tem = XCDR (tem))
1222 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1223
1224 *new_env = 0;
1225
1226 /* Remove variable names without values. */
1227 p = q = env;
1228 while (*p != 0)
1229 {
1230 while (*q != 0 && strchr (*q, '=') == NULL)
1231 q++;
1232 *p = *q++;
1233 if (*p != 0)
1234 p++;
1235 }
1236 }
1237
1238
1239 #ifdef WINDOWSNT
1240 prepare_standard_handles (in, out, err, handles);
1241 set_process_dir (SDATA (current_dir));
1242 /* Spawn the child. (See ntproc.c:Spawnve). */
1243 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1244 reset_standard_handles (in, out, err, handles);
1245 if (cpid == -1)
1246 /* An error occurred while trying to spawn the process. */
1247 report_file_error ("Spawning child process", Qnil);
1248 return cpid;
1249
1250 #else /* not WINDOWSNT */
1251 /* Make sure that in, out, and err are not actually already in
1252 descriptors zero, one, or two; this could happen if Emacs is
1253 started with its standard in, out, or error closed, as might
1254 happen under X. */
1255 {
1256 int oin = in, oout = out;
1257
1258 /* We have to avoid relocating the same descriptor twice! */
1259
1260 in = relocate_fd (in, 3);
1261
1262 if (out == oin)
1263 out = in;
1264 else
1265 out = relocate_fd (out, 3);
1266
1267 if (err == oin)
1268 err = in;
1269 else if (err == oout)
1270 err = out;
1271 else
1272 err = relocate_fd (err, 3);
1273 }
1274
1275 #ifndef MSDOS
1276 emacs_close (0);
1277 emacs_close (1);
1278 emacs_close (2);
1279
1280 dup2 (in, 0);
1281 dup2 (out, 1);
1282 dup2 (err, 2);
1283 emacs_close (in);
1284 if (out != in)
1285 emacs_close (out);
1286 if (err != in && err != out)
1287 emacs_close (err);
1288
1289 #if defined HAVE_SETPGID || ! (defined USG && defined SETPGRP_RELEASES_CTTY)
1290 setpgid (pid, pid);
1291 #endif
1292
1293 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1294 tcsetpgrp (0, pid);
1295
1296 /* execvp does not accept an environment arg so the only way
1297 to pass this environment is to set environ. Our caller
1298 is responsible for restoring the ambient value of environ. */
1299 environ = env;
1300 execvp (new_argv[0], new_argv);
1301
1302 emacs_write (1, "Can't exec program: ", 20);
1303 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1304 emacs_write (1, "\n", 1);
1305 _exit (1);
1306
1307 #else /* MSDOS */
1308 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1309 xfree (pwd_var);
1310 if (pid == -1)
1311 /* An error occurred while trying to run the subprocess. */
1312 report_file_error ("Spawning child process", Qnil);
1313 return pid;
1314 #endif /* MSDOS */
1315 #endif /* not WINDOWSNT */
1316 }
1317
1318 #ifndef WINDOWSNT
1319 /* Move the file descriptor FD so that its number is not less than MINFD.
1320 If the file descriptor is moved at all, the original is freed. */
1321 static int
1322 relocate_fd (int fd, int minfd)
1323 {
1324 if (fd >= minfd)
1325 return fd;
1326 else
1327 {
1328 int new;
1329 #ifdef F_DUPFD
1330 new = fcntl (fd, F_DUPFD, minfd);
1331 #else
1332 new = dup (fd);
1333 if (new != -1)
1334 /* Note that we hold the original FD open while we recurse,
1335 to guarantee we'll get a new FD if we need it. */
1336 new = relocate_fd (new, minfd);
1337 #endif
1338 if (new == -1)
1339 {
1340 const char *message_1 = "Error while setting up child: ";
1341 const char *errmessage = strerror (errno);
1342 const char *message_2 = "\n";
1343 emacs_write (2, message_1, strlen (message_1));
1344 emacs_write (2, errmessage, strlen (errmessage));
1345 emacs_write (2, message_2, strlen (message_2));
1346 _exit (1);
1347 }
1348 emacs_close (fd);
1349 return new;
1350 }
1351 }
1352 #endif /* not WINDOWSNT */
1353
1354 static bool
1355 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1356 ptrdiff_t *valuelen, Lisp_Object env)
1357 {
1358 for (; CONSP (env); env = XCDR (env))
1359 {
1360 Lisp_Object entry = XCAR (env);
1361 if (STRINGP (entry)
1362 && SBYTES (entry) >= varlen
1363 #ifdef WINDOWSNT
1364 /* NT environment variables are case insensitive. */
1365 && ! strnicmp (SDATA (entry), var, varlen)
1366 #else /* not WINDOWSNT */
1367 && ! memcmp (SDATA (entry), var, varlen)
1368 #endif /* not WINDOWSNT */
1369 )
1370 {
1371 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1372 {
1373 *value = SSDATA (entry) + (varlen + 1);
1374 *valuelen = SBYTES (entry) - (varlen + 1);
1375 return 1;
1376 }
1377 else if (SBYTES (entry) == varlen)
1378 {
1379 /* Lone variable names in Vprocess_environment mean that
1380 variable should be removed from the environment. */
1381 *value = NULL;
1382 return 1;
1383 }
1384 }
1385 }
1386 return 0;
1387 }
1388
1389 static bool
1390 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1391 ptrdiff_t *valuelen, Lisp_Object frame)
1392 {
1393 /* Try to find VAR in Vprocess_environment first. */
1394 if (getenv_internal_1 (var, varlen, value, valuelen,
1395 Vprocess_environment))
1396 return *value ? 1 : 0;
1397
1398 /* For DISPLAY try to get the values from the frame or the initial env. */
1399 if (strcmp (var, "DISPLAY") == 0)
1400 {
1401 Lisp_Object display
1402 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1403 if (STRINGP (display))
1404 {
1405 *value = SSDATA (display);
1406 *valuelen = SBYTES (display);
1407 return 1;
1408 }
1409 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1410 if (getenv_internal_1 (var, varlen, value, valuelen,
1411 Vinitial_environment))
1412 return *value ? 1 : 0;
1413 }
1414
1415 return 0;
1416 }
1417
1418 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1419 doc: /* Get the value of environment variable VARIABLE.
1420 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1421 the environment. Otherwise, value is a string.
1422
1423 This function searches `process-environment' for VARIABLE.
1424
1425 If optional parameter ENV is a list, then search this list instead of
1426 `process-environment', and return t when encountering a negative entry
1427 \(an entry for a variable with no value). */)
1428 (Lisp_Object variable, Lisp_Object env)
1429 {
1430 char *value;
1431 ptrdiff_t valuelen;
1432
1433 CHECK_STRING (variable);
1434 if (CONSP (env))
1435 {
1436 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1437 &value, &valuelen, env))
1438 return value ? make_string (value, valuelen) : Qt;
1439 else
1440 return Qnil;
1441 }
1442 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1443 &value, &valuelen, env))
1444 return make_string (value, valuelen);
1445 else
1446 return Qnil;
1447 }
1448
1449 /* A version of getenv that consults the Lisp environment lists,
1450 easily callable from C. */
1451 char *
1452 egetenv (const char *var)
1453 {
1454 char *value;
1455 ptrdiff_t valuelen;
1456
1457 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1458 return value;
1459 else
1460 return 0;
1461 }
1462
1463 \f
1464 /* This is run before init_cmdargs. */
1465
1466 void
1467 init_callproc_1 (void)
1468 {
1469 #ifdef HAVE_NS
1470 const char *etc_dir = ns_etc_directory ();
1471 const char *path_exec = ns_exec_path ();
1472 #endif
1473
1474 Vdata_directory = decode_env_path ("EMACSDATA",
1475 #ifdef HAVE_NS
1476 etc_dir ? etc_dir :
1477 #endif
1478 PATH_DATA);
1479 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1480
1481 Vdoc_directory = decode_env_path ("EMACSDOC",
1482 #ifdef HAVE_NS
1483 etc_dir ? etc_dir :
1484 #endif
1485 PATH_DOC);
1486 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1487
1488 /* Check the EMACSPATH environment variable, defaulting to the
1489 PATH_EXEC path from epaths.h. */
1490 Vexec_path = decode_env_path ("EMACSPATH",
1491 #ifdef HAVE_NS
1492 path_exec ? path_exec :
1493 #endif
1494 PATH_EXEC);
1495 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1496 /* FIXME? For ns, path_exec should go at the front? */
1497 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1498 }
1499
1500 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1501
1502 void
1503 init_callproc (void)
1504 {
1505 char *data_dir = egetenv ("EMACSDATA");
1506
1507 register char * sh;
1508 Lisp_Object tempdir;
1509 #ifdef HAVE_NS
1510 if (data_dir == 0)
1511 {
1512 const char *etc_dir = ns_etc_directory ();
1513 if (etc_dir)
1514 {
1515 data_dir = alloca (strlen (etc_dir) + 1);
1516 strcpy (data_dir, etc_dir);
1517 }
1518 }
1519 #endif
1520
1521 if (!NILP (Vinstallation_directory))
1522 {
1523 /* Add to the path the lib-src subdir of the installation dir. */
1524 Lisp_Object tem;
1525 tem = Fexpand_file_name (build_string ("lib-src"),
1526 Vinstallation_directory);
1527 #ifndef MSDOS
1528 /* MSDOS uses wrapped binaries, so don't do this. */
1529 if (NILP (Fmember (tem, Vexec_path)))
1530 {
1531 #ifdef HAVE_NS
1532 const char *path_exec = ns_exec_path ();
1533 #endif
1534 Vexec_path = decode_env_path ("EMACSPATH",
1535 #ifdef HAVE_NS
1536 path_exec ? path_exec :
1537 #endif
1538 PATH_EXEC);
1539 Vexec_path = Fcons (tem, Vexec_path);
1540 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1541 }
1542
1543 Vexec_directory = Ffile_name_as_directory (tem);
1544 #endif /* not MSDOS */
1545
1546 /* Maybe use ../etc as well as ../lib-src. */
1547 if (data_dir == 0)
1548 {
1549 tem = Fexpand_file_name (build_string ("etc"),
1550 Vinstallation_directory);
1551 Vdoc_directory = Ffile_name_as_directory (tem);
1552 }
1553 }
1554
1555 /* Look for the files that should be in etc. We don't use
1556 Vinstallation_directory, because these files are never installed
1557 near the executable, and they are never in the build
1558 directory when that's different from the source directory.
1559
1560 Instead, if these files are not in the nominal place, we try the
1561 source directory. */
1562 if (data_dir == 0)
1563 {
1564 Lisp_Object tem, tem1, srcdir;
1565
1566 srcdir = Fexpand_file_name (build_string ("../src/"),
1567 build_string (PATH_DUMPLOADSEARCH));
1568 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1569 tem1 = Ffile_exists_p (tem);
1570 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1571 {
1572 Lisp_Object newdir;
1573 newdir = Fexpand_file_name (build_string ("../etc/"),
1574 build_string (PATH_DUMPLOADSEARCH));
1575 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1576 tem1 = Ffile_exists_p (tem);
1577 if (!NILP (tem1))
1578 Vdata_directory = newdir;
1579 }
1580 }
1581
1582 #ifndef CANNOT_DUMP
1583 if (initialized)
1584 #endif
1585 {
1586 tempdir = Fdirectory_file_name (Vexec_directory);
1587 if (access (SSDATA (tempdir), 0) < 0)
1588 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1589 Vexec_directory);
1590 }
1591
1592 tempdir = Fdirectory_file_name (Vdata_directory);
1593 if (access (SSDATA (tempdir), 0) < 0)
1594 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1595 Vdata_directory);
1596
1597 sh = (char *) getenv ("SHELL");
1598 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1599
1600 #ifdef DOS_NT
1601 Vshared_game_score_directory = Qnil;
1602 #else
1603 Vshared_game_score_directory = build_string (PATH_GAME);
1604 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1605 Vshared_game_score_directory = Qnil;
1606 #endif
1607 }
1608
1609 void
1610 set_initial_environment (void)
1611 {
1612 char **envp;
1613 for (envp = environ; *envp; envp++)
1614 Vprocess_environment = Fcons (build_string (*envp),
1615 Vprocess_environment);
1616 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1617 to use `delete' and friends on process-environment. */
1618 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1619 }
1620
1621 void
1622 syms_of_callproc (void)
1623 {
1624 #ifndef DOS_NT
1625 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1626 #elif defined (WINDOWSNT)
1627 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1628 #else
1629 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1630 #endif
1631 staticpro (&Vtemp_file_name_pattern);
1632
1633 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1634 doc: /* File name to load inferior shells from.
1635 Initialized from the SHELL environment variable, or to a system-dependent
1636 default if SHELL is not set. */);
1637
1638 DEFVAR_LISP ("exec-path", Vexec_path,
1639 doc: /* List of directories to search programs to run in subprocesses.
1640 Each element is a string (directory name) or nil (try default directory). */);
1641
1642 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1643 doc: /* List of suffixes to try to find executable file names.
1644 Each element is a string. */);
1645 Vexec_suffixes = Qnil;
1646
1647 DEFVAR_LISP ("exec-directory", Vexec_directory,
1648 doc: /* Directory for executables for Emacs to invoke.
1649 More generally, this includes any architecture-dependent files
1650 that are built and installed from the Emacs distribution. */);
1651
1652 DEFVAR_LISP ("data-directory", Vdata_directory,
1653 doc: /* Directory of machine-independent files that come with GNU Emacs.
1654 These are files intended for Emacs to use while it runs. */);
1655
1656 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1657 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1658 This is usually the same as `data-directory'. */);
1659
1660 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1661 doc: /* For internal use by the build procedure only.
1662 This is the name of the directory in which the build procedure installed
1663 Emacs's info files; the default value for `Info-default-directory-list'
1664 includes this. */);
1665 Vconfigure_info_directory = build_string (PATH_INFO);
1666
1667 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1668 doc: /* Directory of score files for games which come with GNU Emacs.
1669 If this variable is nil, then Emacs is unable to use a shared directory. */);
1670 #ifdef DOS_NT
1671 Vshared_game_score_directory = Qnil;
1672 #else
1673 Vshared_game_score_directory = build_string (PATH_GAME);
1674 #endif
1675
1676 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1677 doc: /* List of environment variables inherited from the parent process.
1678 Each element should be a string of the form ENVVARNAME=VALUE.
1679 The elements must normally be decoded (using `locale-coding-system') for use. */);
1680 Vinitial_environment = Qnil;
1681
1682 DEFVAR_LISP ("process-environment", Vprocess_environment,
1683 doc: /* List of overridden environment variables for subprocesses to inherit.
1684 Each element should be a string of the form ENVVARNAME=VALUE.
1685
1686 Entries in this list take precedence to those in the frame-local
1687 environments. Therefore, let-binding `process-environment' is an easy
1688 way to temporarily change the value of an environment variable,
1689 irrespective of where it comes from. To use `process-environment' to
1690 remove an environment variable, include only its name in the list,
1691 without "=VALUE".
1692
1693 This variable is set to nil when Emacs starts.
1694
1695 If multiple entries define the same variable, the first one always
1696 takes precedence.
1697
1698 Non-ASCII characters are encoded according to the initial value of
1699 `locale-coding-system', i.e. the elements must normally be decoded for
1700 use.
1701
1702 See `setenv' and `getenv'. */);
1703 Vprocess_environment = Qnil;
1704
1705 defsubr (&Scall_process);
1706 defsubr (&Sgetenv_internal);
1707 defsubr (&Scall_process_region);
1708 }