Fix autorevert-tests on MS-Windows
[emacs.git] / src / callproc.c
blob84324c48dcfbb6f4cb46319c58a6cc4bf8a3d6c4
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2017 Free Software Foundation,
4 Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or (at
11 your option) any later version.
13 GNU Emacs is distributed in the hope that it will be useful,
14 but WITHOUT ANY WARRANTY; without even the implied warranty of
15 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 GNU General Public License for more details.
18 You should have received a copy of the GNU General Public License
19 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
22 #include <config.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <sys/types.h>
27 #include <unistd.h>
29 #include <sys/file.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 #ifdef WINDOWSNT
35 #include <sys/socket.h> /* for fcntl */
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
46 #include "commands.h"
47 #include "buffer.h"
48 #include "coding.h"
49 #include <epaths.h>
50 #include "process.h"
51 #include "syssignal.h"
52 #include "syswait.h"
53 #include "blockinput.h"
54 #include "frame.h"
56 #ifdef MSDOS
57 #include "msdos.h"
58 #endif
60 #ifdef HAVE_NS
61 #include "nsterm.h"
62 #endif
64 /* Pattern used by call-process-region to make temp files. */
65 static Lisp_Object Vtemp_file_name_pattern;
67 /* The next two variables are used while record-unwind-protect is in place
68 during call-process for a subprocess for which record_deleted_pid has
69 not yet been called. At other times, synch_process_pid is zero and
70 synch_process_tempfile's contents are irrelevant. Doing this via static
71 C variables is more convenient than putting them into the arguments
72 of record-unwind-protect, as they need to be updated at randomish
73 times in the code, and Lisp cannot always store these values as
74 Emacs integers. It's safe to use static variables here, as the
75 code is never invoked reentrantly. */
77 /* If nonzero, a process-ID that has not been reaped. */
78 static pid_t synch_process_pid;
80 /* If a string, the name of a temp file that has not been removed. */
81 #ifdef MSDOS
82 static Lisp_Object synch_process_tempfile;
83 #else
84 # define synch_process_tempfile make_number (0)
85 #endif
87 /* Indexes of file descriptors that need closing on call_process_kill. */
88 enum
90 /* The subsidiary process's stdout and stderr. stdin is handled
91 separately, in either Fcall_process_region or create_temp_file. */
92 CALLPROC_STDOUT, CALLPROC_STDERR,
94 /* How to read from a pipe (or substitute) from the subsidiary process. */
95 CALLPROC_PIPEREAD,
97 /* A bound on the number of file descriptors. */
98 CALLPROC_FDS
101 static Lisp_Object call_process (ptrdiff_t, Lisp_Object *, int, ptrdiff_t);
103 /* Return the current buffer's working directory, or the home
104 directory if it's unreachable, as a string suitable for a system call.
105 Signal an error if the result would not be an accessible directory. */
107 Lisp_Object
108 encode_current_directory (void)
110 Lisp_Object dir;
112 dir = BVAR (current_buffer, directory);
114 dir = Funhandled_file_name_directory (dir);
116 /* If the file name handler says that dir is unreachable, use
117 a sensible default. */
118 if (NILP (dir))
119 dir = build_string ("~");
121 dir = expand_and_dir_to_file (dir, Qnil);
123 if (NILP (Ffile_accessible_directory_p (dir)))
124 report_file_error ("Setting current directory",
125 BVAR (current_buffer, directory));
127 /* Remove "/:" from DIR and encode it. */
128 dir = ENCODE_FILE (remove_slash_colon (dir));
130 if (! file_accessible_directory_p (dir))
131 report_file_error ("Setting current directory",
132 BVAR (current_buffer, directory));
134 return dir;
137 /* If P is reapable, record it as a deleted process and kill it.
138 Do this in a critical section. Unless PID is wedged it will be
139 reaped on receipt of the first SIGCHLD after the critical section. */
141 void
142 record_kill_process (struct Lisp_Process *p, Lisp_Object tempfile)
144 #ifndef MSDOS
145 sigset_t oldset;
146 block_child_signal (&oldset);
148 if (p->alive)
150 record_deleted_pid (p->pid, tempfile);
151 p->alive = 0;
152 kill (- p->pid, SIGKILL);
155 unblock_child_signal (&oldset);
156 #endif /* !MSDOS */
159 /* Clean up files, file descriptors and processes created by Fcall_process. */
161 static void
162 delete_temp_file (Lisp_Object name)
164 unlink (SSDATA (name));
167 static void
168 call_process_kill (void *ptr)
170 int *callproc_fd = ptr;
171 int i;
172 for (i = 0; i < CALLPROC_FDS; i++)
173 if (0 <= callproc_fd[i])
174 emacs_close (callproc_fd[i]);
176 if (synch_process_pid)
178 struct Lisp_Process proc;
179 proc.alive = 1;
180 proc.pid = synch_process_pid;
181 record_kill_process (&proc, synch_process_tempfile);
182 synch_process_pid = 0;
184 else if (STRINGP (synch_process_tempfile))
185 delete_temp_file (synch_process_tempfile);
188 /* Clean up when exiting Fcall_process: restore the buffer, and
189 kill the subsidiary process group if the process still exists. */
191 static void
192 call_process_cleanup (Lisp_Object buffer)
194 Fset_buffer (buffer);
196 #ifndef MSDOS
197 if (synch_process_pid)
199 kill (-synch_process_pid, SIGINT);
200 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
202 /* This will quit on C-g. */
203 wait_for_termination (synch_process_pid, 0, 1);
205 synch_process_pid = 0;
206 message1 ("Waiting for process to die...done");
208 #endif /* !MSDOS */
211 #ifdef DOS_NT
212 static mode_t const default_output_mode = S_IREAD | S_IWRITE;
213 #else
214 static mode_t const default_output_mode = 0666;
215 #endif
217 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
218 doc: /* Call PROGRAM synchronously in separate process.
219 The remaining arguments are optional.
220 The program's input comes from file INFILE (nil means `/dev/null').
221 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
222 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
223 FILE is a file name string, means that it should be written to that file
224 (if the file already exists it is overwritten).
225 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
226 REAL-BUFFER says what to do with standard output, as above,
227 while STDERR-FILE says what to do with standard error in the child.
228 STDERR-FILE may be nil (discard standard error output),
229 t (mix it with ordinary output), or a file name string.
231 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
232 Remaining arguments are strings passed as command arguments to PROGRAM.
234 If executable PROGRAM can't be found as an executable, `call-process'
235 signals a Lisp error. `call-process' reports errors in execution of
236 the program only through its return and output.
238 If DESTINATION is 0, `call-process' returns immediately with value nil.
239 Otherwise it waits for PROGRAM to terminate
240 and returns a numeric exit status or a signal description string.
241 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
243 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
244 (ptrdiff_t nargs, Lisp_Object *args)
246 Lisp_Object infile, encoded_infile;
247 int filefd;
248 ptrdiff_t count = SPECPDL_INDEX ();
250 if (nargs >= 2 && ! NILP (args[1]))
252 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
253 CHECK_STRING (infile);
255 else
256 infile = build_string (NULL_DEVICE);
258 encoded_infile = ENCODE_FILE (infile);
260 filefd = emacs_open (SSDATA (encoded_infile), O_RDONLY, 0);
261 if (filefd < 0)
262 report_file_error ("Opening process input file", infile);
263 record_unwind_protect_int (close_file_unwind, filefd);
264 return unbind_to (count, call_process (nargs, args, filefd, -1));
267 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
269 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
270 unwinder that is intended to remove the input temporary file; in
271 this case NARGS must be at least 2 and ARGS[1] is the file's name.
273 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
275 static Lisp_Object
276 call_process (ptrdiff_t nargs, Lisp_Object *args, int filefd,
277 ptrdiff_t tempfile_index)
279 Lisp_Object buffer, current_dir, path;
280 bool display_p;
281 int fd0;
282 int callproc_fd[CALLPROC_FDS];
283 int status;
284 ptrdiff_t i;
285 ptrdiff_t count = SPECPDL_INDEX ();
286 USE_SAFE_ALLOCA;
288 char **new_argv;
289 /* File to use for stderr in the child.
290 t means use same as standard output. */
291 Lisp_Object error_file;
292 Lisp_Object output_file = Qnil;
293 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
294 char *tempfile = NULL;
295 #else
296 sigset_t oldset;
297 pid_t pid;
298 #endif
299 int child_errno;
300 int fd_output, fd_error;
301 struct coding_system process_coding; /* coding-system of process output */
302 struct coding_system argument_coding; /* coding-system of arguments */
303 /* Set to the return value of Ffind_operation_coding_system. */
304 Lisp_Object coding_systems;
305 bool discard_output;
307 if (synch_process_pid)
308 error ("call-process invoked recursively");
310 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
311 coding_systems = Qt;
313 CHECK_STRING (args[0]);
315 error_file = Qt;
317 #ifndef subprocesses
318 /* Without asynchronous processes we cannot have BUFFER == 0. */
319 if (nargs >= 3
320 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
321 error ("Operating system cannot handle asynchronous subprocesses");
322 #endif /* subprocesses */
324 /* Decide the coding-system for giving arguments. */
326 Lisp_Object val, *args2;
328 /* If arguments are supplied, we may have to encode them. */
329 if (nargs >= 5)
331 bool must_encode = 0;
332 Lisp_Object coding_attrs;
334 for (i = 4; i < nargs; i++)
335 CHECK_STRING (args[i]);
337 for (i = 4; i < nargs; i++)
338 if (STRING_MULTIBYTE (args[i]))
339 must_encode = 1;
341 if (!NILP (Vcoding_system_for_write))
342 val = Vcoding_system_for_write;
343 else if (! must_encode)
344 val = Qraw_text;
345 else
347 SAFE_NALLOCA (args2, 1, nargs + 1);
348 args2[0] = Qcall_process;
349 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
350 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
351 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
353 val = complement_process_encoding_system (val);
354 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
355 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
356 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
358 /* We should not use an ASCII incompatible coding system. */
359 val = raw_text_coding_system (val);
360 setup_coding_system (val, &argument_coding);
365 if (nargs < 3)
366 buffer = Qnil;
367 else
369 buffer = args[2];
371 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
372 FILE-FOR-STDERR), unless the first element is :file, in which case see
373 the next paragraph. */
374 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
376 if (CONSP (XCDR (buffer)))
378 Lisp_Object stderr_file;
379 stderr_file = XCAR (XCDR (buffer));
381 if (NILP (stderr_file) || EQ (Qt, stderr_file))
382 error_file = stderr_file;
383 else
384 error_file = Fexpand_file_name (stderr_file, Qnil);
387 buffer = XCAR (buffer);
390 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
391 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
393 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
394 BVAR (current_buffer, directory));
395 CHECK_STRING (output_file);
396 buffer = Qnil;
399 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
401 Lisp_Object spec_buffer;
402 spec_buffer = buffer;
403 buffer = Fget_buffer_create (buffer);
404 /* Mention the buffer name for a better error message. */
405 if (NILP (buffer))
406 CHECK_BUFFER (spec_buffer);
407 CHECK_BUFFER (buffer);
411 /* Make sure that the child will be able to chdir to the current
412 buffer's current directory, or its unhandled equivalent. We
413 can't just have the child check for an error when it does the
414 chdir, since it's in a vfork. */
415 current_dir = encode_current_directory ();
417 if (STRINGP (error_file))
418 error_file = ENCODE_FILE (error_file);
419 if (STRINGP (output_file))
420 output_file = ENCODE_FILE (output_file);
422 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
424 for (i = 0; i < CALLPROC_FDS; i++)
425 callproc_fd[i] = -1;
426 #ifdef MSDOS
427 synch_process_tempfile = make_number (0);
428 #endif
429 record_unwind_protect_ptr (call_process_kill, callproc_fd);
431 /* Search for program; barf if not found. */
433 int ok;
435 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
436 make_number (X_OK), false);
437 if (ok < 0)
438 report_file_error ("Searching for program", args[0]);
441 /* Remove "/:" from PATH. */
442 path = remove_slash_colon (path);
444 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
446 if (nargs > 4)
448 ptrdiff_t i;
450 argument_coding.dst_multibyte = 0;
451 for (i = 4; i < nargs; i++)
453 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
454 if (CODING_REQUIRE_ENCODING (&argument_coding))
455 /* We must encode this argument. */
456 args[i] = encode_coding_string (&argument_coding, args[i], 1);
458 for (i = 4; i < nargs; i++)
459 new_argv[i - 3] = SSDATA (args[i]);
460 new_argv[i - 3] = 0;
462 else
463 new_argv[1] = 0;
464 path = ENCODE_FILE (path);
465 new_argv[0] = SSDATA (path);
467 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
469 #ifdef MSDOS
470 if (! discard_output && ! STRINGP (output_file))
472 char const *tmpdir = egetenv ("TMPDIR");
473 char const *outf = tmpdir ? tmpdir : "";
474 tempfile = alloca (strlen (outf) + 20);
475 strcpy (tempfile, outf);
476 dostounix_filename (tempfile);
477 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
478 strcat (tempfile, "/");
479 strcat (tempfile, "emXXXXXX");
480 mktemp (tempfile);
481 if (!*tempfile)
482 report_file_error ("Opening process output file", Qnil);
483 output_file = build_string (tempfile);
484 synch_process_tempfile = output_file;
486 #endif
488 if (discard_output)
490 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
491 if (fd_output < 0)
492 report_file_error ("Opening null device", Qnil);
494 else if (STRINGP (output_file))
496 fd_output = emacs_open (SSDATA (output_file),
497 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
498 default_output_mode);
499 if (fd_output < 0)
501 int open_errno = errno;
502 output_file = DECODE_FILE (output_file);
503 report_file_errno ("Opening process output file",
504 output_file, open_errno);
507 else
509 int fd[2];
510 if (emacs_pipe (fd) != 0)
511 report_file_error ("Creating process pipe", Qnil);
512 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
513 fd_output = fd[1];
515 callproc_fd[CALLPROC_STDOUT] = fd_output;
517 fd_error = fd_output;
519 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
521 fd_error = emacs_open ((STRINGP (error_file)
522 ? SSDATA (error_file)
523 : NULL_DEVICE),
524 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
525 default_output_mode);
526 if (fd_error < 0)
528 int open_errno = errno;
529 report_file_errno ("Cannot redirect stderr",
530 (STRINGP (error_file)
531 ? DECODE_FILE (error_file)
532 : build_string (NULL_DEVICE)),
533 open_errno);
535 callproc_fd[CALLPROC_STDERR] = fd_error;
538 #ifdef MSDOS /* MW, July 1993 */
539 status = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
541 if (status < 0)
543 child_errno = errno;
544 unbind_to (count, Qnil);
545 synchronize_system_messages_locale ();
546 return
547 code_convert_string_norecord (build_string (strerror (child_errno)),
548 Vlocale_coding_system, 0);
551 for (i = 0; i < CALLPROC_FDS; i++)
552 if (0 <= callproc_fd[i])
554 emacs_close (callproc_fd[i]);
555 callproc_fd[i] = -1;
557 emacs_close (filefd);
558 clear_unwind_protect (count - 1);
560 if (tempfile)
562 /* Since CRLF is converted to LF within `decode_coding', we
563 can always open a file with binary mode. */
564 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile, O_RDONLY, 0);
565 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
567 int open_errno = errno;
568 report_file_errno ("Cannot re-open temporary file",
569 build_string (tempfile), open_errno);
573 #endif /* MSDOS */
575 /* Do the unwind-protect now, even though the pid is not known, so
576 that no storage allocation is done in the critical section.
577 The actual PID will be filled in during the critical section. */
578 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
580 #ifndef MSDOS
582 block_input ();
583 block_child_signal (&oldset);
585 #ifdef WINDOWSNT
586 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
587 #else /* not WINDOWSNT */
589 /* vfork, and prevent local vars from being clobbered by the vfork. */
591 Lisp_Object volatile buffer_volatile = buffer;
592 Lisp_Object volatile coding_systems_volatile = coding_systems;
593 Lisp_Object volatile current_dir_volatile = current_dir;
594 bool volatile display_p_volatile = display_p;
595 bool volatile sa_must_free_volatile = sa_must_free;
596 int volatile fd_error_volatile = fd_error;
597 int volatile filefd_volatile = filefd;
598 ptrdiff_t volatile count_volatile = count;
599 ptrdiff_t volatile sa_avail_volatile = sa_avail;
600 ptrdiff_t volatile sa_count_volatile = sa_count;
601 char **volatile new_argv_volatile = new_argv;
602 int volatile callproc_fd_volatile[CALLPROC_FDS];
603 for (i = 0; i < CALLPROC_FDS; i++)
604 callproc_fd_volatile[i] = callproc_fd[i];
606 pid = vfork ();
608 buffer = buffer_volatile;
609 coding_systems = coding_systems_volatile;
610 current_dir = current_dir_volatile;
611 display_p = display_p_volatile;
612 sa_must_free = sa_must_free_volatile;
613 fd_error = fd_error_volatile;
614 filefd = filefd_volatile;
615 count = count_volatile;
616 sa_avail = sa_avail_volatile;
617 sa_count = sa_count_volatile;
618 new_argv = new_argv_volatile;
620 for (i = 0; i < CALLPROC_FDS; i++)
621 callproc_fd[i] = callproc_fd_volatile[i];
622 fd_output = callproc_fd[CALLPROC_STDOUT];
625 if (pid == 0)
627 unblock_child_signal (&oldset);
629 setsid ();
631 /* Emacs ignores SIGPIPE, but the child should not. */
632 signal (SIGPIPE, SIG_DFL);
633 /* Likewise for SIGPROF. */
634 #ifdef SIGPROF
635 signal (SIGPROF, SIG_DFL);
636 #endif
638 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
641 #endif /* not WINDOWSNT */
643 child_errno = errno;
645 if (pid > 0)
647 synch_process_pid = pid;
649 if (INTEGERP (buffer))
651 if (tempfile_index < 0)
652 record_deleted_pid (pid, Qnil);
653 else
655 eassert (1 < nargs);
656 record_deleted_pid (pid, args[1]);
657 clear_unwind_protect (tempfile_index);
659 synch_process_pid = 0;
663 unblock_child_signal (&oldset);
664 unblock_input ();
666 if (pid < 0)
667 report_file_errno ("Doing vfork", Qnil, child_errno);
669 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
670 since we will use that to read input from. */
671 for (i = 0; i < CALLPROC_FDS; i++)
672 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
674 emacs_close (callproc_fd[i]);
675 callproc_fd[i] = -1;
677 emacs_close (filefd);
678 clear_unwind_protect (count - 1);
680 #endif /* not MSDOS */
682 if (INTEGERP (buffer))
683 return unbind_to (count, Qnil);
685 if (BUFFERP (buffer))
686 Fset_buffer (buffer);
688 fd0 = callproc_fd[CALLPROC_PIPEREAD];
690 if (0 <= fd0)
692 Lisp_Object val, *args2;
694 val = Qnil;
695 if (!NILP (Vcoding_system_for_read))
696 val = Vcoding_system_for_read;
697 else
699 if (EQ (coding_systems, Qt))
701 ptrdiff_t i;
703 SAFE_NALLOCA (args2, 1, nargs + 1);
704 args2[0] = Qcall_process;
705 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
706 coding_systems
707 = Ffind_operation_coding_system (nargs + 1, args2);
709 if (CONSP (coding_systems))
710 val = XCAR (coding_systems);
711 else if (CONSP (Vdefault_process_coding_system))
712 val = XCAR (Vdefault_process_coding_system);
713 else
714 val = Qnil;
716 Fcheck_coding_system (val);
717 /* In unibyte mode, character code conversion should not take
718 place but EOL conversion should. So, setup raw-text or one
719 of the subsidiary according to the information just setup. */
720 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
721 && !NILP (val))
722 val = raw_text_coding_system (val);
723 setup_coding_system (val, &process_coding);
724 process_coding.dst_multibyte
725 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
726 process_coding.src_multibyte = 0;
729 if (0 <= fd0)
731 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
732 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
733 char buf[CALLPROC_BUFFER_SIZE_MAX];
734 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
735 int nread;
736 EMACS_INT total_read = 0;
737 int carryover = 0;
738 bool display_on_the_fly = display_p;
739 struct coding_system saved_coding = process_coding;
741 while (1)
743 /* Repeatedly read until we've filled as much as possible
744 of the buffer size we have. But don't read
745 less than 1024--save that for the next bufferful. */
746 nread = carryover;
747 while (nread < bufsize - 1024)
749 int this_read = emacs_read_quit (fd0, buf + nread,
750 bufsize - nread);
752 if (this_read < 0)
753 goto give_up;
755 if (this_read == 0)
757 process_coding.mode |= CODING_MODE_LAST_BLOCK;
758 break;
761 nread += this_read;
762 total_read += this_read;
764 if (display_on_the_fly)
765 break;
768 /* Now NREAD is the total amount of data in the buffer. */
770 if (!nread)
772 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
773 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
774 insert_1_both (buf, nread, nread, 0, 1, 0);
775 else
776 { /* We have to decode the input. */
777 Lisp_Object curbuf;
778 ptrdiff_t count1 = SPECPDL_INDEX ();
780 XSETBUFFER (curbuf, current_buffer);
781 /* FIXME: Call signal_after_change! */
782 prepare_to_modify_buffer (PT, PT, NULL);
783 /* We cannot allow after-change-functions be run
784 during decoding, because that might modify the
785 buffer, while we rely on process_coding.produced to
786 faithfully reflect inserted text until we
787 TEMP_SET_PT_BOTH below. */
788 specbind (Qinhibit_modification_hooks, Qt);
789 decode_coding_c_string (&process_coding,
790 (unsigned char *) buf, nread, curbuf);
791 unbind_to (count1, Qnil);
792 if (display_on_the_fly
793 && CODING_REQUIRE_DETECTION (&saved_coding)
794 && ! CODING_REQUIRE_DETECTION (&process_coding))
796 /* We have detected some coding system, but the
797 detection may have been via insufficient data.
798 So give up displaying on the fly. */
799 if (process_coding.produced > 0)
800 del_range_2 (process_coding.dst_pos,
801 process_coding.dst_pos_byte,
802 (process_coding.dst_pos
803 + process_coding.produced_char),
804 (process_coding.dst_pos_byte
805 + process_coding.produced),
807 display_on_the_fly = false;
808 process_coding = saved_coding;
809 carryover = nread;
810 /* Make the above condition always fail in the future. */
811 saved_coding.common_flags
812 &= ~CODING_REQUIRE_DETECTION_MASK;
813 continue;
816 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
817 PT_BYTE + process_coding.produced);
818 carryover = process_coding.carryover_bytes;
819 if (carryover > 0)
820 memcpy (buf, process_coding.carryover,
821 process_coding.carryover_bytes);
824 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
825 break;
827 /* Make the buffer bigger as we continue to read more data,
828 but not past CALLPROC_BUFFER_SIZE_MAX. */
829 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
830 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
831 bufsize = CALLPROC_BUFFER_SIZE_MAX;
833 if (display_p)
835 redisplay_preserve_echo_area (1);
836 /* This variable might have been set to 0 for code
837 detection. In that case, set it back to 1 because
838 we should have already detected a coding system. */
839 display_on_the_fly = true;
842 give_up: ;
844 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
845 /* If the caller required, let the buffer inherit the
846 coding-system used to decode the process output. */
847 if (inherit_process_coding_system)
848 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
849 make_number (total_read));
852 #ifndef MSDOS
853 /* Wait for it to terminate, unless it already has. */
854 wait_for_termination (pid, &status, fd0 < 0);
855 #endif
857 /* Don't kill any children that the subprocess may have left behind
858 when exiting. */
859 synch_process_pid = 0;
861 SAFE_FREE ();
862 unbind_to (count, Qnil);
864 if (WIFSIGNALED (status))
866 const char *signame;
868 synchronize_system_messages_locale ();
869 signame = strsignal (WTERMSIG (status));
871 if (signame == 0)
872 signame = "unknown";
874 return code_convert_string_norecord (build_string (signame),
875 Vlocale_coding_system, 0);
878 eassert (WIFEXITED (status));
879 return make_number (WEXITSTATUS (status));
882 /* Create a temporary file suitable for storing the input data of
883 call-process-region. NARGS and ARGS are the same as for
884 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
885 naming the file, and return a file descriptor for reading.
886 Unwind-protect the file, so that the file descriptor will be closed
887 and the file removed when the caller unwinds the specpdl stack. */
889 static int
890 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
891 Lisp_Object *filename_string_ptr)
893 int fd;
894 Lisp_Object filename_string;
895 Lisp_Object val, start, end;
896 Lisp_Object tmpdir;
898 if (STRINGP (Vtemporary_file_directory))
899 tmpdir = Vtemporary_file_directory;
900 else
902 char *outf;
903 #ifndef DOS_NT
904 outf = getenv ("TMPDIR");
905 tmpdir = build_string (outf ? outf : "/tmp/");
906 #else /* DOS_NT */
907 if ((outf = egetenv ("TMPDIR"))
908 || (outf = egetenv ("TMP"))
909 || (outf = egetenv ("TEMP")))
910 tmpdir = build_string (outf);
911 else
912 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
913 #endif
917 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
918 char *tempfile;
919 ptrdiff_t count;
921 #ifdef WINDOWSNT
922 /* Cannot use the result of Fexpand_file_name, because it
923 downcases the XXXXXX part of the pattern, and mktemp then
924 doesn't recognize it. */
925 if (!NILP (Vw32_downcase_file_names))
927 Lisp_Object dirname = Ffile_name_directory (pattern);
929 if (NILP (dirname))
930 pattern = Vtemp_file_name_pattern;
931 else
932 pattern = concat2 (dirname, Vtemp_file_name_pattern);
934 #endif
936 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
937 tempfile = SSDATA (filename_string);
939 count = SPECPDL_INDEX ();
940 record_unwind_protect_nothing ();
941 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
942 if (fd < 0)
943 report_file_error ("Failed to open temporary file using pattern",
944 pattern);
945 set_unwind_protect (count, delete_temp_file, filename_string);
946 record_unwind_protect_int (close_file_unwind, fd);
949 start = args[0];
950 end = args[1];
951 /* Decide coding-system of the contents of the temporary file. */
952 if (!NILP (Vcoding_system_for_write))
953 val = Vcoding_system_for_write;
954 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
955 val = Qraw_text;
956 else
958 Lisp_Object coding_systems;
959 Lisp_Object *args2;
960 USE_SAFE_ALLOCA;
961 SAFE_NALLOCA (args2, 1, nargs + 1);
962 args2[0] = Qcall_process_region;
963 memcpy (args2 + 1, args, nargs * sizeof *args);
964 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
965 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
966 SAFE_FREE ();
968 val = complement_process_encoding_system (val);
971 ptrdiff_t count1 = SPECPDL_INDEX ();
973 specbind (intern ("coding-system-for-write"), val);
974 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
975 happen to get a ".Z" suffix. */
976 specbind (Qfile_name_handler_alist, Qnil);
977 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
979 unbind_to (count1, Qnil);
982 if (lseek (fd, 0, SEEK_SET) < 0)
983 report_file_error ("Setting file position", filename_string);
985 /* Note that Fcall_process takes care of binding
986 coding-system-for-read. */
988 *filename_string_ptr = filename_string;
989 return fd;
992 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
993 3, MANY, 0,
994 doc: /* Send text from START to END to a synchronous process running PROGRAM.
996 START and END are normally buffer positions specifying the part of the
997 buffer to send to the process.
998 If START is nil, that means to use the entire buffer contents; END is
999 ignored.
1000 If START is a string, then send that string to the process
1001 instead of any buffer contents; END is ignored.
1002 The remaining arguments are optional.
1003 Delete the text if fourth arg DELETE is non-nil.
1005 Insert output in BUFFER before point; t means current buffer; nil for
1006 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1007 FILE)', where FILE is a file name string, means that it should be
1008 written to that file (if the file already exists it is overwritten).
1009 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1010 REAL-BUFFER says what to do with standard output, as above,
1011 while STDERR-FILE says what to do with standard error in the child.
1012 STDERR-FILE may be nil (discard standard error output),
1013 t (mix it with ordinary output), or a file name string.
1015 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1016 Remaining args are passed to PROGRAM at startup as command args.
1018 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1019 Otherwise it waits for PROGRAM to terminate
1020 and returns a numeric exit status or a signal description string.
1021 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1023 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1024 (ptrdiff_t nargs, Lisp_Object *args)
1026 Lisp_Object infile, val;
1027 ptrdiff_t count = SPECPDL_INDEX ();
1028 Lisp_Object start = args[0];
1029 Lisp_Object end = args[1];
1030 bool empty_input;
1031 int fd;
1033 if (STRINGP (start))
1034 empty_input = SCHARS (start) == 0;
1035 else if (NILP (start))
1036 empty_input = BEG == Z;
1037 else
1039 validate_region (&args[0], &args[1]);
1040 start = args[0];
1041 end = args[1];
1042 empty_input = XINT (start) == XINT (end);
1045 if (!empty_input)
1046 fd = create_temp_file (nargs, args, &infile);
1047 else
1049 infile = Qnil;
1050 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1051 if (fd < 0)
1052 report_file_error ("Opening null device", Qnil);
1053 record_unwind_protect_int (close_file_unwind, fd);
1056 if (nargs > 3 && !NILP (args[3]))
1057 Fdelete_region (start, end);
1059 if (nargs > 3)
1061 args += 2;
1062 nargs -= 2;
1064 else
1066 args[0] = args[2];
1067 nargs = 2;
1069 args[1] = infile;
1071 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1072 return unbind_to (count, val);
1075 static char **
1076 add_env (char **env, char **new_env, char *string)
1078 char **ep;
1079 bool ok = 1;
1080 if (string == NULL)
1081 return new_env;
1083 /* See if this string duplicates any string already in the env.
1084 If so, don't put it in.
1085 When an env var has multiple definitions,
1086 we keep the definition that comes first in process-environment. */
1087 for (ep = env; ok && ep != new_env; ep++)
1089 char *p = *ep, *q = string;
1090 while (ok)
1092 if (*p && *q != *p)
1093 break;
1094 if (*q == 0)
1095 /* The string is a lone variable name; keep it for now, we
1096 will remove it later. It is a placeholder for a
1097 variable that is not to be included in the environment. */
1098 break;
1099 if (*q == '=')
1100 ok = 0;
1101 p++, q++;
1104 if (ok)
1105 *new_env++ = string;
1106 return new_env;
1109 #ifndef DOS_NT
1111 /* 'exec' failed inside a child running NAME, with error number ERR.
1112 Possibly a vforked child needed to allocate a large vector on the
1113 stack; such a child cannot fall back on malloc because that might
1114 mess up the allocator's data structures in the parent.
1115 Report the error and exit the child. */
1117 static _Noreturn void
1118 exec_failed (char const *name, int err)
1120 /* Avoid deadlock if the child's perror writes to a full pipe; the
1121 pipe's reader is the parent, but with vfork the parent can't
1122 run until the child exits. Truncate the diagnostic instead. */
1123 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1125 errno = err;
1126 emacs_perror (name);
1127 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1130 #else
1132 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1133 fork and exec, and handle alloca exhaustion in a different way. */
1135 static void
1136 exec_failed (char const *name, int err)
1140 #endif
1142 /* This is the last thing run in a newly forked inferior
1143 either synchronous or asynchronous.
1144 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1145 Initialize inferior's priority, pgrp, connected dir and environment.
1146 then exec another program based on new_argv.
1148 If SET_PGRP, put the subprocess into a separate process group.
1150 CURRENT_DIR is an elisp string giving the path of the current
1151 directory the subprocess should have. Since we can't really signal
1152 a decent error from within the child, this should be verified as an
1153 executable directory by the parent.
1155 On GNUish hosts, either exec or return an error number.
1156 On MS-Windows, either return a pid or signal an error.
1157 On MS-DOS, either return an exit status or signal an error. */
1159 CHILD_SETUP_TYPE
1160 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1161 Lisp_Object current_dir)
1163 char **env;
1164 char *pwd_var;
1165 #ifdef WINDOWSNT
1166 int cpid;
1167 HANDLE handles[3];
1168 #else
1169 pid_t pid = getpid ();
1170 #endif /* WINDOWSNT */
1172 /* Note that use of alloca is always safe here. It's obvious for systems
1173 that do not have true vfork or that have true (stack) alloca.
1174 If using vfork and C_ALLOCA (when Emacs used to include
1175 src/alloca.c) it is safe because that changes the superior's
1176 static variables as if the superior had done alloca and will be
1177 cleaned up in the usual way. */
1179 char *temp;
1180 ptrdiff_t i;
1182 i = SBYTES (current_dir);
1183 #ifdef MSDOS
1184 /* MSDOS must have all environment variables malloc'ed, because
1185 low-level libc functions that launch subsidiary processes rely
1186 on that. */
1187 pwd_var = xmalloc (i + 5);
1188 #else
1189 if (MAX_ALLOCA - 5 < i)
1190 exec_failed (new_argv[0], ENOMEM);
1191 pwd_var = alloca (i + 5);
1192 #endif
1193 temp = pwd_var + 4;
1194 memcpy (pwd_var, "PWD=", 4);
1195 lispstpcpy (temp, current_dir);
1197 #ifndef DOS_NT
1198 /* We can't signal an Elisp error here; we're in a vfork. Since
1199 the callers check the current directory before forking, this
1200 should only return an error if the directory's permissions
1201 are changed between the check and this chdir, but we should
1202 at least check. */
1203 if (chdir (temp) < 0)
1204 _exit (EXIT_CANCELED);
1205 #else /* DOS_NT */
1206 /* Get past the drive letter, so that d:/ is left alone. */
1207 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1209 temp += 2;
1210 i -= 2;
1212 #endif /* DOS_NT */
1214 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1215 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1216 temp[--i] = 0;
1219 /* Set `env' to a vector of the strings in the environment. */
1221 register Lisp_Object tem;
1222 register char **new_env;
1223 char **p, **q;
1224 register int new_length;
1225 Lisp_Object display = Qnil;
1227 new_length = 0;
1229 for (tem = Vprocess_environment;
1230 CONSP (tem) && STRINGP (XCAR (tem));
1231 tem = XCDR (tem))
1233 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1234 && (SDATA (XCAR (tem)) [7] == '\0'
1235 || SDATA (XCAR (tem)) [7] == '='))
1236 /* DISPLAY is specified in process-environment. */
1237 display = Qt;
1238 new_length++;
1241 /* If not provided yet, use the frame's DISPLAY. */
1242 if (NILP (display))
1244 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1245 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1246 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1247 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1248 Vinitial_environment);
1249 if (STRINGP (tmp))
1251 display = tmp;
1252 new_length++;
1256 /* new_length + 2 to include PWD and terminating 0. */
1257 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1258 exec_failed (new_argv[0], ENOMEM);
1259 env = new_env = alloca ((new_length + 2) * sizeof *env);
1260 /* If we have a PWD envvar, pass one down,
1261 but with corrected value. */
1262 if (egetenv ("PWD"))
1263 *new_env++ = pwd_var;
1265 if (STRINGP (display))
1267 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1268 exec_failed (new_argv[0], ENOMEM);
1269 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1270 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1271 new_env = add_env (env, new_env, vdata);
1274 /* Overrides. */
1275 for (tem = Vprocess_environment;
1276 CONSP (tem) && STRINGP (XCAR (tem));
1277 tem = XCDR (tem))
1278 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1280 *new_env = 0;
1282 /* Remove variable names without values. */
1283 p = q = env;
1284 while (*p != 0)
1286 while (*q != 0 && strchr (*q, '=') == NULL)
1287 q++;
1288 *p = *q++;
1289 if (*p != 0)
1290 p++;
1295 #ifdef WINDOWSNT
1296 prepare_standard_handles (in, out, err, handles);
1297 set_process_dir (SSDATA (current_dir));
1298 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1299 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1300 reset_standard_handles (in, out, err, handles);
1301 if (cpid == -1)
1302 /* An error occurred while trying to spawn the process. */
1303 report_file_error ("Spawning child process", Qnil);
1304 return cpid;
1306 #else /* not WINDOWSNT */
1308 #ifndef MSDOS
1310 restore_nofile_limit ();
1312 /* Redirect file descriptors and clear the close-on-exec flag on the
1313 redirected ones. IN, OUT, and ERR are close-on-exec so they
1314 need not be closed explicitly. */
1315 dup2 (in, STDIN_FILENO);
1316 dup2 (out, STDOUT_FILENO);
1317 dup2 (err, STDERR_FILENO);
1319 setpgid (0, 0);
1320 tcsetpgrp (0, pid);
1322 int errnum = emacs_exec_file (new_argv[0], new_argv, env);
1323 exec_failed (new_argv[0], errnum);
1325 #else /* MSDOS */
1326 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1327 xfree (pwd_var);
1328 if (pid == -1)
1329 /* An error occurred while trying to run the subprocess. */
1330 report_file_error ("Spawning child process", Qnil);
1331 return pid;
1332 #endif /* MSDOS */
1333 #endif /* not WINDOWSNT */
1336 static bool
1337 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1338 ptrdiff_t *valuelen, Lisp_Object env)
1340 for (; CONSP (env); env = XCDR (env))
1342 Lisp_Object entry = XCAR (env);
1343 if (STRINGP (entry)
1344 && SBYTES (entry) >= varlen
1345 #ifdef WINDOWSNT
1346 /* NT environment variables are case insensitive. */
1347 && ! strnicmp (SSDATA (entry), var, varlen)
1348 #else /* not WINDOWSNT */
1349 && ! memcmp (SDATA (entry), var, varlen)
1350 #endif /* not WINDOWSNT */
1353 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1355 *value = SSDATA (entry) + (varlen + 1);
1356 *valuelen = SBYTES (entry) - (varlen + 1);
1357 return 1;
1359 else if (SBYTES (entry) == varlen)
1361 /* Lone variable names in Vprocess_environment mean that
1362 variable should be removed from the environment. */
1363 *value = NULL;
1364 return 1;
1368 return 0;
1371 static bool
1372 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1373 ptrdiff_t *valuelen, Lisp_Object frame)
1375 /* Try to find VAR in Vprocess_environment first. */
1376 if (getenv_internal_1 (var, varlen, value, valuelen,
1377 Vprocess_environment))
1378 return *value ? 1 : 0;
1380 /* On Windows we make some modifications to Emacs' environment
1381 without recording them in Vprocess_environment. */
1382 #ifdef WINDOWSNT
1384 char* tmpval = getenv (var);
1385 if (tmpval)
1387 *value = tmpval;
1388 *valuelen = strlen (tmpval);
1389 return 1;
1392 #endif
1394 /* For DISPLAY try to get the values from the frame or the initial env. */
1395 if (strcmp (var, "DISPLAY") == 0)
1397 Lisp_Object display
1398 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1399 if (STRINGP (display))
1401 *value = SSDATA (display);
1402 *valuelen = SBYTES (display);
1403 return 1;
1405 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1406 if (getenv_internal_1 (var, varlen, value, valuelen,
1407 Vinitial_environment))
1408 return *value ? 1 : 0;
1411 return 0;
1414 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1415 doc: /* Get the value of environment variable VARIABLE.
1416 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1417 the environment. Otherwise, value is a string.
1419 This function searches `process-environment' for VARIABLE.
1421 If optional parameter ENV is a list, then search this list instead of
1422 `process-environment', and return t when encountering a negative entry
1423 \(an entry for a variable with no value). */)
1424 (Lisp_Object variable, Lisp_Object env)
1426 char *value;
1427 ptrdiff_t valuelen;
1429 CHECK_STRING (variable);
1430 if (CONSP (env))
1432 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1433 &value, &valuelen, env))
1434 return value ? make_string (value, valuelen) : Qt;
1435 else
1436 return Qnil;
1438 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1439 &value, &valuelen, env))
1440 return make_string (value, valuelen);
1441 else
1442 return Qnil;
1445 /* A version of getenv that consults the Lisp environment lists,
1446 easily callable from C. This is usually called from egetenv. */
1447 char *
1448 egetenv_internal (const char *var, ptrdiff_t len)
1450 char *value;
1451 ptrdiff_t valuelen;
1453 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1454 return value;
1455 else
1456 return 0;
1460 /* This is run before init_cmdargs. */
1462 void
1463 init_callproc_1 (void)
1465 #ifdef HAVE_NS
1466 const char *etc_dir = ns_etc_directory ();
1467 const char *path_exec = ns_exec_path ();
1468 #endif
1470 Vdata_directory = decode_env_path ("EMACSDATA",
1471 #ifdef HAVE_NS
1472 etc_dir ? etc_dir :
1473 #endif
1474 PATH_DATA, 0);
1475 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1477 Vdoc_directory = decode_env_path ("EMACSDOC",
1478 #ifdef HAVE_NS
1479 etc_dir ? etc_dir :
1480 #endif
1481 PATH_DOC, 0);
1482 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1484 /* Check the EMACSPATH environment variable, defaulting to the
1485 PATH_EXEC path from epaths.h. */
1486 Vexec_path = decode_env_path ("EMACSPATH",
1487 #ifdef HAVE_NS
1488 path_exec ? path_exec :
1489 #endif
1490 PATH_EXEC, 0);
1491 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1492 /* FIXME? For ns, path_exec should go at the front? */
1493 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1496 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1498 void
1499 init_callproc (void)
1501 bool data_dir = egetenv ("EMACSDATA") != 0;
1503 char *sh;
1504 Lisp_Object tempdir;
1505 #ifdef HAVE_NS
1506 if (data_dir == 0)
1507 data_dir = ns_etc_directory () != 0;
1508 #endif
1510 if (!NILP (Vinstallation_directory))
1512 /* Add to the path the lib-src subdir of the installation dir. */
1513 Lisp_Object tem;
1514 tem = Fexpand_file_name (build_string ("lib-src"),
1515 Vinstallation_directory);
1516 #ifndef MSDOS
1517 /* MSDOS uses wrapped binaries, so don't do this. */
1518 if (NILP (Fmember (tem, Vexec_path)))
1520 #ifdef HAVE_NS
1521 const char *path_exec = ns_exec_path ();
1522 #endif
1523 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1524 Vexec_path = decode_env_path ("EMACSPATH",
1525 #ifdef HAVE_NS
1526 path_exec ? path_exec :
1527 #endif
1528 SSDATA (tem), 0);
1529 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1532 Vexec_directory = Ffile_name_as_directory (tem);
1533 #endif /* not MSDOS */
1535 /* Maybe use ../etc as well as ../lib-src. */
1536 if (data_dir == 0)
1538 tem = Fexpand_file_name (build_string ("etc"),
1539 Vinstallation_directory);
1540 Vdoc_directory = Ffile_name_as_directory (tem);
1544 /* Look for the files that should be in etc. We don't use
1545 Vinstallation_directory, because these files are never installed
1546 near the executable, and they are never in the build
1547 directory when that's different from the source directory.
1549 Instead, if these files are not in the nominal place, we try the
1550 source directory. */
1551 if (data_dir == 0)
1553 Lisp_Object tem, tem1, srcdir;
1554 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1556 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1558 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1559 tem1 = Ffile_exists_p (tem);
1560 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1562 Lisp_Object newdir;
1563 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1564 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1565 tem1 = Ffile_exists_p (tem);
1566 if (!NILP (tem1))
1567 Vdata_directory = newdir;
1571 #ifndef CANNOT_DUMP
1572 if (initialized)
1573 #endif
1575 tempdir = Fdirectory_file_name (Vexec_directory);
1576 if (! file_accessible_directory_p (tempdir))
1577 dir_warning ("arch-dependent data dir", Vexec_directory);
1580 tempdir = Fdirectory_file_name (Vdata_directory);
1581 if (! file_accessible_directory_p (tempdir))
1582 dir_warning ("arch-independent data dir", Vdata_directory);
1584 sh = getenv ("SHELL");
1585 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1587 #ifdef DOS_NT
1588 Vshared_game_score_directory = Qnil;
1589 #else
1590 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1591 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1592 Vshared_game_score_directory = Qnil;
1593 #endif
1596 void
1597 set_initial_environment (void)
1599 char **envp;
1600 for (envp = environ; *envp; envp++)
1601 Vprocess_environment = Fcons (build_string (*envp),
1602 Vprocess_environment);
1603 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1604 to use `delete' and friends on process-environment. */
1605 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1608 void
1609 syms_of_callproc (void)
1611 #ifndef DOS_NT
1612 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1613 #else /* DOS_NT */
1614 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1615 #endif
1616 staticpro (&Vtemp_file_name_pattern);
1618 #ifdef MSDOS
1619 synch_process_tempfile = make_number (0);
1620 staticpro (&synch_process_tempfile);
1621 #endif
1623 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1624 doc: /* File name to load inferior shells from.
1625 Initialized from the SHELL environment variable, or to a system-dependent
1626 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1628 DEFVAR_LISP ("exec-path", Vexec_path,
1629 doc: /* List of directories to search programs to run in subprocesses.
1630 Each element is a string (directory name) or nil (try default directory).
1632 By default the last element of this list is `exec-directory'. The
1633 last element is not always used, for example in shell completion
1634 \(`shell-dynamic-complete-command'). */);
1636 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1637 doc: /* List of suffixes to try to find executable file names.
1638 Each element is a string. */);
1639 Vexec_suffixes = Qnil;
1641 DEFVAR_LISP ("exec-directory", Vexec_directory,
1642 doc: /* Directory for executables for Emacs to invoke.
1643 More generally, this includes any architecture-dependent files
1644 that are built and installed from the Emacs distribution. */);
1646 DEFVAR_LISP ("data-directory", Vdata_directory,
1647 doc: /* Directory of machine-independent files that come with GNU Emacs.
1648 These are files intended for Emacs to use while it runs. */);
1650 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1651 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1652 This is usually the same as `data-directory'. */);
1654 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1655 doc: /* For internal use by the build procedure only.
1656 This is the name of the directory in which the build procedure installed
1657 Emacs's info files; the default value for `Info-default-directory-list'
1658 includes this. */);
1659 Vconfigure_info_directory = build_string (PATH_INFO);
1661 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1662 doc: /* Directory of score files for games which come with GNU Emacs.
1663 If this variable is nil, then Emacs is unable to use a shared directory. */);
1664 #ifdef DOS_NT
1665 Vshared_game_score_directory = Qnil;
1666 #else
1667 Vshared_game_score_directory = build_string (PATH_GAME);
1668 #endif
1670 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1671 doc: /* List of environment variables inherited from the parent process.
1672 Each element should be a string of the form ENVVARNAME=VALUE.
1673 The elements must normally be decoded (using `locale-coding-system') for use. */);
1674 Vinitial_environment = Qnil;
1676 DEFVAR_LISP ("process-environment", Vprocess_environment,
1677 doc: /* List of overridden environment variables for subprocesses to inherit.
1678 Each element should be a string of the form ENVVARNAME=VALUE.
1680 Entries in this list take precedence to those in the frame-local
1681 environments. Therefore, let-binding `process-environment' is an easy
1682 way to temporarily change the value of an environment variable,
1683 irrespective of where it comes from. To use `process-environment' to
1684 remove an environment variable, include only its name in the list,
1685 without "=VALUE".
1687 This variable is set to nil when Emacs starts.
1689 If multiple entries define the same variable, the first one always
1690 takes precedence.
1692 Non-ASCII characters are encoded according to the initial value of
1693 `locale-coding-system', i.e. the elements must normally be decoded for
1694 use.
1696 See `setenv' and `getenv'. */);
1697 Vprocess_environment = Qnil;
1699 defsubr (&Scall_process);
1700 defsubr (&Sgetenv_internal);
1701 defsubr (&Scall_process_region);