; Instrument tramp.el
[emacs.git] / src / callproc.c
blob3a40626de48b49e7a5e8ed88d8190de7703078d7
1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2016 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 <sys/types.h>
26 #include <unistd.h>
28 #include <sys/file.h>
29 #include <fcntl.h>
31 #include "lisp.h"
33 #ifdef WINDOWSNT
34 #define NOMINMAX
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)");
201 immediate_quit = 1;
202 QUIT;
203 wait_for_termination (synch_process_pid, 0, 1);
204 synch_process_pid = 0;
205 immediate_quit = 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 int pid;
296 #else
297 sigset_t oldset;
298 pid_t pid;
299 #endif
300 int child_errno;
301 int fd_output, fd_error;
302 struct coding_system process_coding; /* coding-system of process output */
303 struct coding_system argument_coding; /* coding-system of arguments */
304 /* Set to the return value of Ffind_operation_coding_system. */
305 Lisp_Object coding_systems;
306 bool discard_output;
308 if (synch_process_pid)
309 error ("call-process invoked recursively");
311 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
312 coding_systems = Qt;
314 CHECK_STRING (args[0]);
316 error_file = Qt;
318 #ifndef subprocesses
319 /* Without asynchronous processes we cannot have BUFFER == 0. */
320 if (nargs >= 3
321 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
322 error ("Operating system cannot handle asynchronous subprocesses");
323 #endif /* subprocesses */
325 /* Decide the coding-system for giving arguments. */
327 Lisp_Object val, *args2;
329 /* If arguments are supplied, we may have to encode them. */
330 if (nargs >= 5)
332 bool must_encode = 0;
333 Lisp_Object coding_attrs;
335 for (i = 4; i < nargs; i++)
336 CHECK_STRING (args[i]);
338 for (i = 4; i < nargs; i++)
339 if (STRING_MULTIBYTE (args[i]))
340 must_encode = 1;
342 if (!NILP (Vcoding_system_for_write))
343 val = Vcoding_system_for_write;
344 else if (! must_encode)
345 val = Qraw_text;
346 else
348 SAFE_NALLOCA (args2, 1, nargs + 1);
349 args2[0] = Qcall_process;
350 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
351 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
352 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
354 val = complement_process_encoding_system (val);
355 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
356 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
357 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
359 /* We should not use an ASCII incompatible coding system. */
360 val = raw_text_coding_system (val);
361 setup_coding_system (val, &argument_coding);
366 if (nargs < 3)
367 buffer = Qnil;
368 else
370 buffer = args[2];
372 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
373 FILE-FOR-STDERR), unless the first element is :file, in which case see
374 the next paragraph. */
375 if (CONSP (buffer) && !EQ (XCAR (buffer), QCfile))
377 if (CONSP (XCDR (buffer)))
379 Lisp_Object stderr_file;
380 stderr_file = XCAR (XCDR (buffer));
382 if (NILP (stderr_file) || EQ (Qt, stderr_file))
383 error_file = stderr_file;
384 else
385 error_file = Fexpand_file_name (stderr_file, Qnil);
388 buffer = XCAR (buffer);
391 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
392 if (CONSP (buffer) && EQ (XCAR (buffer), QCfile))
394 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
395 BVAR (current_buffer, directory));
396 CHECK_STRING (output_file);
397 buffer = Qnil;
400 if (! (NILP (buffer) || EQ (buffer, Qt) || INTEGERP (buffer)))
402 Lisp_Object spec_buffer;
403 spec_buffer = buffer;
404 buffer = Fget_buffer_create (buffer);
405 /* Mention the buffer name for a better error message. */
406 if (NILP (buffer))
407 CHECK_BUFFER (spec_buffer);
408 CHECK_BUFFER (buffer);
412 /* Make sure that the child will be able to chdir to the current
413 buffer's current directory, or its unhandled equivalent. We
414 can't just have the child check for an error when it does the
415 chdir, since it's in a vfork. */
416 current_dir = encode_current_directory ();
418 if (STRINGP (error_file))
419 error_file = ENCODE_FILE (error_file);
420 if (STRINGP (output_file))
421 output_file = ENCODE_FILE (output_file);
423 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
425 for (i = 0; i < CALLPROC_FDS; i++)
426 callproc_fd[i] = -1;
427 #ifdef MSDOS
428 synch_process_tempfile = make_number (0);
429 #endif
430 record_unwind_protect_ptr (call_process_kill, callproc_fd);
432 /* Search for program; barf if not found. */
434 int ok;
436 ok = openp (Vexec_path, args[0], Vexec_suffixes, &path,
437 make_number (X_OK), false);
438 if (ok < 0)
439 report_file_error ("Searching for program", args[0]);
442 /* Remove "/:" from PATH. */
443 path = remove_slash_colon (path);
445 SAFE_NALLOCA (new_argv, 1, nargs < 4 ? 2 : nargs - 2);
447 if (nargs > 4)
449 ptrdiff_t i;
451 argument_coding.dst_multibyte = 0;
452 for (i = 4; i < nargs; i++)
454 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
455 if (CODING_REQUIRE_ENCODING (&argument_coding))
456 /* We must encode this argument. */
457 args[i] = encode_coding_string (&argument_coding, args[i], 1);
459 for (i = 4; i < nargs; i++)
460 new_argv[i - 3] = SSDATA (args[i]);
461 new_argv[i - 3] = 0;
463 else
464 new_argv[1] = 0;
465 path = ENCODE_FILE (path);
466 new_argv[0] = SSDATA (path);
468 discard_output = INTEGERP (buffer) || (NILP (buffer) && NILP (output_file));
470 #ifdef MSDOS
471 if (! discard_output && ! STRINGP (output_file))
473 char const *tmpdir = egetenv ("TMPDIR");
474 char const *outf = tmpdir ? tmpdir : "";
475 tempfile = alloca (strlen (outf) + 20);
476 strcpy (tempfile, outf);
477 dostounix_filename (tempfile);
478 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
479 strcat (tempfile, "/");
480 strcat (tempfile, "emXXXXXX");
481 mktemp (tempfile);
482 if (!*tempfile)
483 report_file_error ("Opening process output file", Qnil);
484 output_file = build_string (tempfile);
485 synch_process_tempfile = output_file;
487 #endif
489 if (discard_output)
491 fd_output = emacs_open (NULL_DEVICE, O_WRONLY, 0);
492 if (fd_output < 0)
493 report_file_error ("Opening null device", Qnil);
495 else if (STRINGP (output_file))
497 fd_output = emacs_open (SSDATA (output_file),
498 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
499 default_output_mode);
500 if (fd_output < 0)
502 int open_errno = errno;
503 output_file = DECODE_FILE (output_file);
504 report_file_errno ("Opening process output file",
505 output_file, open_errno);
508 else
510 int fd[2];
511 if (emacs_pipe (fd) != 0)
512 report_file_error ("Creating process pipe", Qnil);
513 callproc_fd[CALLPROC_PIPEREAD] = fd[0];
514 fd_output = fd[1];
516 callproc_fd[CALLPROC_STDOUT] = fd_output;
518 fd_error = fd_output;
520 if (STRINGP (error_file) || (NILP (error_file) && !discard_output))
522 fd_error = emacs_open ((STRINGP (error_file)
523 ? SSDATA (error_file)
524 : NULL_DEVICE),
525 O_WRONLY | O_CREAT | O_TRUNC | O_TEXT,
526 default_output_mode);
527 if (fd_error < 0)
529 int open_errno = errno;
530 report_file_errno ("Cannot redirect stderr",
531 (STRINGP (error_file)
532 ? DECODE_FILE (error_file)
533 : build_string (NULL_DEVICE)),
534 open_errno);
536 callproc_fd[CALLPROC_STDERR] = fd_error;
539 #ifdef MSDOS /* MW, July 1993 */
540 /* Note that on MSDOS `child_setup' actually returns the child process
541 exit status, not its PID, so assign it to status below. */
542 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
544 if (pid < 0)
546 child_errno = errno;
547 unbind_to (count, Qnil);
548 synchronize_system_messages_locale ();
549 return
550 code_convert_string_norecord (build_string (strerror (child_errno)),
551 Vlocale_coding_system, 0);
553 status = pid;
555 for (i = 0; i < CALLPROC_FDS; i++)
556 if (0 <= callproc_fd[i])
558 emacs_close (callproc_fd[i]);
559 callproc_fd[i] = -1;
561 emacs_close (filefd);
562 clear_unwind_protect (count - 1);
564 if (tempfile)
566 /* Since CRLF is converted to LF within `decode_coding', we
567 can always open a file with binary mode. */
568 callproc_fd[CALLPROC_PIPEREAD] = emacs_open (tempfile, O_RDONLY, 0);
569 if (callproc_fd[CALLPROC_PIPEREAD] < 0)
571 int open_errno = errno;
572 report_file_errno ("Cannot re-open temporary file",
573 build_string (tempfile), open_errno);
577 #endif /* MSDOS */
579 /* Do the unwind-protect now, even though the pid is not known, so
580 that no storage allocation is done in the critical section.
581 The actual PID will be filled in during the critical section. */
582 record_unwind_protect (call_process_cleanup, Fcurrent_buffer ());
584 #ifndef MSDOS
586 block_input ();
587 block_child_signal (&oldset);
589 #ifdef WINDOWSNT
590 pid = child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
591 #else /* not WINDOWSNT */
593 /* vfork, and prevent local vars from being clobbered by the vfork. */
595 Lisp_Object volatile buffer_volatile = buffer;
596 Lisp_Object volatile coding_systems_volatile = coding_systems;
597 Lisp_Object volatile current_dir_volatile = current_dir;
598 bool volatile display_p_volatile = display_p;
599 bool volatile sa_must_free_volatile = sa_must_free;
600 int volatile fd_error_volatile = fd_error;
601 int volatile filefd_volatile = filefd;
602 ptrdiff_t volatile count_volatile = count;
603 ptrdiff_t volatile sa_avail_volatile = sa_avail;
604 ptrdiff_t volatile sa_count_volatile = sa_count;
605 char **volatile new_argv_volatile = new_argv;
606 int volatile callproc_fd_volatile[CALLPROC_FDS];
607 for (i = 0; i < CALLPROC_FDS; i++)
608 callproc_fd_volatile[i] = callproc_fd[i];
610 pid = vfork ();
612 buffer = buffer_volatile;
613 coding_systems = coding_systems_volatile;
614 current_dir = current_dir_volatile;
615 display_p = display_p_volatile;
616 sa_must_free = sa_must_free_volatile;
617 fd_error = fd_error_volatile;
618 filefd = filefd_volatile;
619 count = count_volatile;
620 sa_avail = sa_avail_volatile;
621 sa_count = sa_count_volatile;
622 new_argv = new_argv_volatile;
624 for (i = 0; i < CALLPROC_FDS; i++)
625 callproc_fd[i] = callproc_fd_volatile[i];
626 fd_output = callproc_fd[CALLPROC_STDOUT];
629 if (pid == 0)
631 unblock_child_signal (&oldset);
633 setsid ();
635 /* Emacs ignores SIGPIPE, but the child should not. */
636 signal (SIGPIPE, SIG_DFL);
637 /* Likewise for SIGPROF. */
638 #ifdef SIGPROF
639 signal (SIGPROF, SIG_DFL);
640 #endif
642 child_setup (filefd, fd_output, fd_error, new_argv, 0, current_dir);
645 #endif /* not WINDOWSNT */
647 child_errno = errno;
649 if (pid > 0)
651 synch_process_pid = pid;
653 if (INTEGERP (buffer))
655 if (tempfile_index < 0)
656 record_deleted_pid (pid, Qnil);
657 else
659 eassert (1 < nargs);
660 record_deleted_pid (pid, args[1]);
661 clear_unwind_protect (tempfile_index);
663 synch_process_pid = 0;
667 unblock_child_signal (&oldset);
668 unblock_input ();
670 if (pid < 0)
671 report_file_errno ("Doing vfork", Qnil, child_errno);
673 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
674 since we will use that to read input from. */
675 for (i = 0; i < CALLPROC_FDS; i++)
676 if (i != CALLPROC_PIPEREAD && 0 <= callproc_fd[i])
678 emacs_close (callproc_fd[i]);
679 callproc_fd[i] = -1;
681 emacs_close (filefd);
682 clear_unwind_protect (count - 1);
684 #endif /* not MSDOS */
686 if (INTEGERP (buffer))
687 return unbind_to (count, Qnil);
689 if (BUFFERP (buffer))
690 Fset_buffer (buffer);
692 fd0 = callproc_fd[CALLPROC_PIPEREAD];
694 if (0 <= fd0)
696 Lisp_Object val, *args2;
698 val = Qnil;
699 if (!NILP (Vcoding_system_for_read))
700 val = Vcoding_system_for_read;
701 else
703 if (EQ (coding_systems, Qt))
705 ptrdiff_t i;
707 SAFE_NALLOCA (args2, 1, nargs + 1);
708 args2[0] = Qcall_process;
709 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
710 coding_systems
711 = Ffind_operation_coding_system (nargs + 1, args2);
713 if (CONSP (coding_systems))
714 val = XCAR (coding_systems);
715 else if (CONSP (Vdefault_process_coding_system))
716 val = XCAR (Vdefault_process_coding_system);
717 else
718 val = Qnil;
720 Fcheck_coding_system (val);
721 /* In unibyte mode, character code conversion should not take
722 place but EOL conversion should. So, setup raw-text or one
723 of the subsidiary according to the information just setup. */
724 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
725 && !NILP (val))
726 val = raw_text_coding_system (val);
727 setup_coding_system (val, &process_coding);
728 process_coding.dst_multibyte
729 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
730 process_coding.src_multibyte = 0;
733 immediate_quit = 1;
734 QUIT;
736 if (0 <= fd0)
738 enum { CALLPROC_BUFFER_SIZE_MIN = 16 * 1024 };
739 enum { CALLPROC_BUFFER_SIZE_MAX = 4 * CALLPROC_BUFFER_SIZE_MIN };
740 char buf[CALLPROC_BUFFER_SIZE_MAX];
741 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
742 int nread;
743 EMACS_INT total_read = 0;
744 int carryover = 0;
745 bool display_on_the_fly = display_p;
746 struct coding_system saved_coding = process_coding;
748 while (1)
750 /* Repeatedly read until we've filled as much as possible
751 of the buffer size we have. But don't read
752 less than 1024--save that for the next bufferful. */
753 nread = carryover;
754 while (nread < bufsize - 1024)
756 int this_read = emacs_read (fd0, buf + nread,
757 bufsize - nread);
759 if (this_read < 0)
760 goto give_up;
762 if (this_read == 0)
764 process_coding.mode |= CODING_MODE_LAST_BLOCK;
765 break;
768 nread += this_read;
769 total_read += this_read;
771 if (display_on_the_fly)
772 break;
775 /* Now NREAD is the total amount of data in the buffer. */
776 immediate_quit = 0;
778 if (!nread)
780 else if (NILP (BVAR (current_buffer, enable_multibyte_characters))
781 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
782 insert_1_both (buf, nread, nread, 0, 1, 0);
783 else
784 { /* We have to decode the input. */
785 Lisp_Object curbuf;
786 ptrdiff_t count1 = SPECPDL_INDEX ();
788 XSETBUFFER (curbuf, current_buffer);
789 /* FIXME: Call signal_after_change! */
790 prepare_to_modify_buffer (PT, PT, NULL);
791 /* We cannot allow after-change-functions be run
792 during decoding, because that might modify the
793 buffer, while we rely on process_coding.produced to
794 faithfully reflect inserted text until we
795 TEMP_SET_PT_BOTH below. */
796 specbind (Qinhibit_modification_hooks, Qt);
797 decode_coding_c_string (&process_coding,
798 (unsigned char *) buf, nread, curbuf);
799 unbind_to (count1, Qnil);
800 if (display_on_the_fly
801 && CODING_REQUIRE_DETECTION (&saved_coding)
802 && ! CODING_REQUIRE_DETECTION (&process_coding))
804 /* We have detected some coding system, but the
805 detection may have been via insufficient data.
806 So give up displaying on the fly. */
807 if (process_coding.produced > 0)
808 del_range_2 (process_coding.dst_pos,
809 process_coding.dst_pos_byte,
810 (process_coding.dst_pos
811 + process_coding.produced_char),
812 (process_coding.dst_pos_byte
813 + process_coding.produced),
815 display_on_the_fly = false;
816 process_coding = saved_coding;
817 carryover = nread;
818 /* Make the above condition always fail in the future. */
819 saved_coding.common_flags
820 &= ~CODING_REQUIRE_DETECTION_MASK;
821 continue;
824 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
825 PT_BYTE + process_coding.produced);
826 carryover = process_coding.carryover_bytes;
827 if (carryover > 0)
828 memcpy (buf, process_coding.carryover,
829 process_coding.carryover_bytes);
832 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
833 break;
835 /* Make the buffer bigger as we continue to read more data,
836 but not past CALLPROC_BUFFER_SIZE_MAX. */
837 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
838 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
839 bufsize = CALLPROC_BUFFER_SIZE_MAX;
841 if (display_p)
843 redisplay_preserve_echo_area (1);
844 /* This variable might have been set to 0 for code
845 detection. In that case, set it back to 1 because
846 we should have already detected a coding system. */
847 display_on_the_fly = true;
849 immediate_quit = true;
850 QUIT;
852 give_up: ;
854 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
855 /* If the caller required, let the buffer inherit the
856 coding-system used to decode the process output. */
857 if (inherit_process_coding_system)
858 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
859 make_number (total_read));
862 #ifndef MSDOS
863 /* Wait for it to terminate, unless it already has. */
864 wait_for_termination (pid, &status, fd0 < 0);
865 #endif
867 immediate_quit = 0;
869 /* Don't kill any children that the subprocess may have left behind
870 when exiting. */
871 synch_process_pid = 0;
873 SAFE_FREE ();
874 unbind_to (count, Qnil);
876 if (WIFSIGNALED (status))
878 const char *signame;
880 synchronize_system_messages_locale ();
881 signame = strsignal (WTERMSIG (status));
883 if (signame == 0)
884 signame = "unknown";
886 return code_convert_string_norecord (build_string (signame),
887 Vlocale_coding_system, 0);
890 eassert (WIFEXITED (status));
891 return make_number (WEXITSTATUS (status));
894 /* Create a temporary file suitable for storing the input data of
895 call-process-region. NARGS and ARGS are the same as for
896 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
897 naming the file, and return a file descriptor for reading.
898 Unwind-protect the file, so that the file descriptor will be closed
899 and the file removed when the caller unwinds the specpdl stack. */
901 static int
902 create_temp_file (ptrdiff_t nargs, Lisp_Object *args,
903 Lisp_Object *filename_string_ptr)
905 int fd;
906 Lisp_Object filename_string;
907 Lisp_Object val, start, end;
908 Lisp_Object tmpdir;
910 if (STRINGP (Vtemporary_file_directory))
911 tmpdir = Vtemporary_file_directory;
912 else
914 char *outf;
915 #ifndef DOS_NT
916 outf = getenv ("TMPDIR");
917 tmpdir = build_string (outf ? outf : "/tmp/");
918 #else /* DOS_NT */
919 if ((outf = egetenv ("TMPDIR"))
920 || (outf = egetenv ("TMP"))
921 || (outf = egetenv ("TEMP")))
922 tmpdir = build_string (outf);
923 else
924 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
925 #endif
929 Lisp_Object pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
930 char *tempfile;
931 ptrdiff_t count;
933 #ifdef WINDOWSNT
934 /* Cannot use the result of Fexpand_file_name, because it
935 downcases the XXXXXX part of the pattern, and mktemp then
936 doesn't recognize it. */
937 if (!NILP (Vw32_downcase_file_names))
939 Lisp_Object dirname = Ffile_name_directory (pattern);
941 if (NILP (dirname))
942 pattern = Vtemp_file_name_pattern;
943 else
944 pattern = concat2 (dirname, Vtemp_file_name_pattern);
946 #endif
948 filename_string = Fcopy_sequence (ENCODE_FILE (pattern));
949 tempfile = SSDATA (filename_string);
951 count = SPECPDL_INDEX ();
952 record_unwind_protect_nothing ();
953 fd = mkostemp (tempfile, O_BINARY | O_CLOEXEC);
954 if (fd < 0)
955 report_file_error ("Failed to open temporary file using pattern",
956 pattern);
957 set_unwind_protect (count, delete_temp_file, filename_string);
958 record_unwind_protect_int (close_file_unwind, fd);
961 start = args[0];
962 end = args[1];
963 /* Decide coding-system of the contents of the temporary file. */
964 if (!NILP (Vcoding_system_for_write))
965 val = Vcoding_system_for_write;
966 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
967 val = Qraw_text;
968 else
970 Lisp_Object coding_systems;
971 Lisp_Object *args2;
972 USE_SAFE_ALLOCA;
973 SAFE_NALLOCA (args2, 1, nargs + 1);
974 args2[0] = Qcall_process_region;
975 memcpy (args2 + 1, args, nargs * sizeof *args);
976 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
977 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
978 SAFE_FREE ();
980 val = complement_process_encoding_system (val);
983 ptrdiff_t count1 = SPECPDL_INDEX ();
985 specbind (intern ("coding-system-for-write"), val);
986 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
987 happen to get a ".Z" suffix. */
988 specbind (Qfile_name_handler_alist, Qnil);
989 write_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil, fd);
991 unbind_to (count1, Qnil);
994 if (lseek (fd, 0, SEEK_SET) < 0)
995 report_file_error ("Setting file position", filename_string);
997 /* Note that Fcall_process takes care of binding
998 coding-system-for-read. */
1000 *filename_string_ptr = filename_string;
1001 return fd;
1004 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1005 3, MANY, 0,
1006 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1007 The remaining arguments are optional.
1008 Delete the text if fourth arg DELETE is non-nil.
1010 Insert output in BUFFER before point; t means current buffer; nil for
1011 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1012 FILE)', where FILE is a file name string, means that it should be
1013 written to that file (if the file already exists it is overwritten).
1014 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1015 REAL-BUFFER says what to do with standard output, as above,
1016 while STDERR-FILE says what to do with standard error in the child.
1017 STDERR-FILE may be nil (discard standard error output),
1018 t (mix it with ordinary output), or a file name string.
1020 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1021 Remaining args are passed to PROGRAM at startup as command args.
1023 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1024 Otherwise it waits for PROGRAM to terminate
1025 and returns a numeric exit status or a signal description string.
1026 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1028 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1029 (ptrdiff_t nargs, Lisp_Object *args)
1031 Lisp_Object infile, val;
1032 ptrdiff_t count = SPECPDL_INDEX ();
1033 Lisp_Object start = args[0];
1034 Lisp_Object end = args[1];
1035 bool empty_input;
1036 int fd;
1038 if (STRINGP (start))
1039 empty_input = SCHARS (start) == 0;
1040 else if (NILP (start))
1041 empty_input = BEG == Z;
1042 else
1044 validate_region (&args[0], &args[1]);
1045 start = args[0];
1046 end = args[1];
1047 empty_input = XINT (start) == XINT (end);
1050 if (!empty_input)
1051 fd = create_temp_file (nargs, args, &infile);
1052 else
1054 infile = Qnil;
1055 fd = emacs_open (NULL_DEVICE, O_RDONLY, 0);
1056 if (fd < 0)
1057 report_file_error ("Opening null device", Qnil);
1058 record_unwind_protect_int (close_file_unwind, fd);
1061 if (nargs > 3 && !NILP (args[3]))
1062 Fdelete_region (start, end);
1064 if (nargs > 3)
1066 args += 2;
1067 nargs -= 2;
1069 else
1071 args[0] = args[2];
1072 nargs = 2;
1074 args[1] = infile;
1076 val = call_process (nargs, args, fd, empty_input ? -1 : count);
1077 return unbind_to (count, val);
1080 static char **
1081 add_env (char **env, char **new_env, char *string)
1083 char **ep;
1084 bool ok = 1;
1085 if (string == NULL)
1086 return new_env;
1088 /* See if this string duplicates any string already in the env.
1089 If so, don't put it in.
1090 When an env var has multiple definitions,
1091 we keep the definition that comes first in process-environment. */
1092 for (ep = env; ok && ep != new_env; ep++)
1094 char *p = *ep, *q = string;
1095 while (ok)
1097 if (*q != *p)
1098 break;
1099 if (*q == 0)
1100 /* The string is a lone variable name; keep it for now, we
1101 will remove it later. It is a placeholder for a
1102 variable that is not to be included in the environment. */
1103 break;
1104 if (*q == '=')
1105 ok = 0;
1106 p++, q++;
1109 if (ok)
1110 *new_env++ = string;
1111 return new_env;
1114 #ifndef DOS_NT
1116 /* 'exec' failed inside a child running NAME, with error number ERR.
1117 Possibly a vforked child needed to allocate a large vector on the
1118 stack; such a child cannot fall back on malloc because that might
1119 mess up the allocator's data structures in the parent.
1120 Report the error and exit the child. */
1122 static _Noreturn void
1123 exec_failed (char const *name, int err)
1125 /* Avoid deadlock if the child's perror writes to a full pipe; the
1126 pipe's reader is the parent, but with vfork the parent can't
1127 run until the child exits. Truncate the diagnostic instead. */
1128 fcntl (STDERR_FILENO, F_SETFL, O_NONBLOCK);
1130 errno = err;
1131 emacs_perror (name);
1132 _exit (err == ENOENT ? EXIT_ENOENT : EXIT_CANNOT_INVOKE);
1135 #else
1137 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1138 fork and exec, and handle alloca exhaustion in a different way. */
1140 static void
1141 exec_failed (char const *name, int err)
1145 #endif
1147 /* This is the last thing run in a newly forked inferior
1148 either synchronous or asynchronous.
1149 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1150 Initialize inferior's priority, pgrp, connected dir and environment.
1151 then exec another program based on new_argv.
1153 If SET_PGRP, put the subprocess into a separate process group.
1155 CURRENT_DIR is an elisp string giving the path of the current
1156 directory the subprocess should have. Since we can't really signal
1157 a decent error from within the child, this should be verified as an
1158 executable directory by the parent. */
1161 child_setup (int in, int out, int err, char **new_argv, bool set_pgrp,
1162 Lisp_Object current_dir)
1164 char **env;
1165 char *pwd_var;
1166 #ifdef WINDOWSNT
1167 int cpid;
1168 HANDLE handles[3];
1169 #else
1170 pid_t pid = getpid ();
1171 #endif /* WINDOWSNT */
1173 /* Note that use of alloca is always safe here. It's obvious for systems
1174 that do not have true vfork or that have true (stack) alloca.
1175 If using vfork and C_ALLOCA (when Emacs used to include
1176 src/alloca.c) it is safe because that changes the superior's
1177 static variables as if the superior had done alloca and will be
1178 cleaned up in the usual way. */
1180 char *temp;
1181 ptrdiff_t i;
1183 i = SBYTES (current_dir);
1184 #ifdef MSDOS
1185 /* MSDOS must have all environment variables malloc'ed, because
1186 low-level libc functions that launch subsidiary processes rely
1187 on that. */
1188 pwd_var = xmalloc (i + 5);
1189 #else
1190 if (MAX_ALLOCA - 5 < i)
1191 exec_failed (new_argv[0], ENOMEM);
1192 pwd_var = alloca (i + 5);
1193 #endif
1194 temp = pwd_var + 4;
1195 memcpy (pwd_var, "PWD=", 4);
1196 lispstpcpy (temp, current_dir);
1198 #ifndef DOS_NT
1199 /* We can't signal an Elisp error here; we're in a vfork. Since
1200 the callers check the current directory before forking, this
1201 should only return an error if the directory's permissions
1202 are changed between the check and this chdir, but we should
1203 at least check. */
1204 if (chdir (temp) < 0)
1205 _exit (EXIT_CANCELED);
1206 #else /* DOS_NT */
1207 /* Get past the drive letter, so that d:/ is left alone. */
1208 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1210 temp += 2;
1211 i -= 2;
1213 #endif /* DOS_NT */
1215 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1216 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1217 temp[--i] = 0;
1220 /* Set `env' to a vector of the strings in the environment. */
1222 register Lisp_Object tem;
1223 register char **new_env;
1224 char **p, **q;
1225 register int new_length;
1226 Lisp_Object display = Qnil;
1228 new_length = 0;
1230 for (tem = Vprocess_environment;
1231 CONSP (tem) && STRINGP (XCAR (tem));
1232 tem = XCDR (tem))
1234 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1235 && (SDATA (XCAR (tem)) [7] == '\0'
1236 || SDATA (XCAR (tem)) [7] == '='))
1237 /* DISPLAY is specified in process-environment. */
1238 display = Qt;
1239 new_length++;
1242 /* If not provided yet, use the frame's DISPLAY. */
1243 if (NILP (display))
1245 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1246 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1247 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1248 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1249 Vinitial_environment);
1250 if (STRINGP (tmp))
1252 display = tmp;
1253 new_length++;
1257 /* new_length + 2 to include PWD and terminating 0. */
1258 if (MAX_ALLOCA / sizeof *env - 2 < new_length)
1259 exec_failed (new_argv[0], ENOMEM);
1260 env = new_env = alloca ((new_length + 2) * sizeof *env);
1261 /* If we have a PWD envvar, pass one down,
1262 but with corrected value. */
1263 if (egetenv ("PWD"))
1264 *new_env++ = pwd_var;
1266 if (STRINGP (display))
1268 if (MAX_ALLOCA - sizeof "DISPLAY=" < SBYTES (display))
1269 exec_failed (new_argv[0], ENOMEM);
1270 char *vdata = alloca (sizeof "DISPLAY=" + SBYTES (display));
1271 lispstpcpy (stpcpy (vdata, "DISPLAY="), display);
1272 new_env = add_env (env, new_env, vdata);
1275 /* Overrides. */
1276 for (tem = Vprocess_environment;
1277 CONSP (tem) && STRINGP (XCAR (tem));
1278 tem = XCDR (tem))
1279 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1281 *new_env = 0;
1283 /* Remove variable names without values. */
1284 p = q = env;
1285 while (*p != 0)
1287 while (*q != 0 && strchr (*q, '=') == NULL)
1288 q++;
1289 *p = *q++;
1290 if (*p != 0)
1291 p++;
1296 #ifdef WINDOWSNT
1297 prepare_standard_handles (in, out, err, handles);
1298 set_process_dir (SDATA (current_dir));
1299 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1300 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1301 reset_standard_handles (in, out, err, handles);
1302 if (cpid == -1)
1303 /* An error occurred while trying to spawn the process. */
1304 report_file_error ("Spawning child process", Qnil);
1305 return cpid;
1307 #else /* not WINDOWSNT */
1309 #ifndef MSDOS
1310 /* Redirect file descriptors and clear the close-on-exec flag on the
1311 redirected ones. IN, OUT, and ERR are close-on-exec so they
1312 need not be closed explicitly. */
1313 dup2 (in, STDIN_FILENO);
1314 dup2 (out, STDOUT_FILENO);
1315 dup2 (err, STDERR_FILENO);
1317 setpgid (0, 0);
1318 tcsetpgrp (0, pid);
1320 execve (new_argv[0], new_argv, env);
1321 exec_failed (new_argv[0], errno);
1323 #else /* MSDOS */
1324 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1325 xfree (pwd_var);
1326 if (pid == -1)
1327 /* An error occurred while trying to run the subprocess. */
1328 report_file_error ("Spawning child process", Qnil);
1329 return pid;
1330 #endif /* MSDOS */
1331 #endif /* not WINDOWSNT */
1334 static bool
1335 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1336 ptrdiff_t *valuelen, Lisp_Object env)
1338 for (; CONSP (env); env = XCDR (env))
1340 Lisp_Object entry = XCAR (env);
1341 if (STRINGP (entry)
1342 && SBYTES (entry) >= varlen
1343 #ifdef WINDOWSNT
1344 /* NT environment variables are case insensitive. */
1345 && ! strnicmp (SDATA (entry), var, varlen)
1346 #else /* not WINDOWSNT */
1347 && ! memcmp (SDATA (entry), var, varlen)
1348 #endif /* not WINDOWSNT */
1351 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1353 *value = SSDATA (entry) + (varlen + 1);
1354 *valuelen = SBYTES (entry) - (varlen + 1);
1355 return 1;
1357 else if (SBYTES (entry) == varlen)
1359 /* Lone variable names in Vprocess_environment mean that
1360 variable should be removed from the environment. */
1361 *value = NULL;
1362 return 1;
1366 return 0;
1369 static bool
1370 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1371 ptrdiff_t *valuelen, Lisp_Object frame)
1373 /* Try to find VAR in Vprocess_environment first. */
1374 if (getenv_internal_1 (var, varlen, value, valuelen,
1375 Vprocess_environment))
1376 return *value ? 1 : 0;
1378 /* For DISPLAY try to get the values from the frame or the initial env. */
1379 if (strcmp (var, "DISPLAY") == 0)
1381 Lisp_Object display
1382 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1383 if (STRINGP (display))
1385 *value = SSDATA (display);
1386 *valuelen = SBYTES (display);
1387 return 1;
1389 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1390 if (getenv_internal_1 (var, varlen, value, valuelen,
1391 Vinitial_environment))
1392 return *value ? 1 : 0;
1395 return 0;
1398 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1399 doc: /* Get the value of environment variable VARIABLE.
1400 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1401 the environment. Otherwise, value is a string.
1403 This function searches `process-environment' for VARIABLE.
1405 If optional parameter ENV is a list, then search this list instead of
1406 `process-environment', and return t when encountering a negative entry
1407 \(an entry for a variable with no value). */)
1408 (Lisp_Object variable, Lisp_Object env)
1410 char *value;
1411 ptrdiff_t valuelen;
1413 CHECK_STRING (variable);
1414 if (CONSP (env))
1416 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1417 &value, &valuelen, env))
1418 return value ? make_string (value, valuelen) : Qt;
1419 else
1420 return Qnil;
1422 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1423 &value, &valuelen, env))
1424 return make_string (value, valuelen);
1425 else
1426 return Qnil;
1429 /* A version of getenv that consults the Lisp environment lists,
1430 easily callable from C. This is usually called from egetenv. */
1431 char *
1432 egetenv_internal (const char *var, ptrdiff_t len)
1434 char *value;
1435 ptrdiff_t valuelen;
1437 if (getenv_internal (var, len, &value, &valuelen, Qnil))
1438 return value;
1439 else
1440 return 0;
1444 /* This is run before init_cmdargs. */
1446 void
1447 init_callproc_1 (void)
1449 #ifdef HAVE_NS
1450 const char *etc_dir = ns_etc_directory ();
1451 const char *path_exec = ns_exec_path ();
1452 #endif
1454 Vdata_directory = decode_env_path ("EMACSDATA",
1455 #ifdef HAVE_NS
1456 etc_dir ? etc_dir :
1457 #endif
1458 PATH_DATA, 0);
1459 Vdata_directory = Ffile_name_as_directory (Fcar (Vdata_directory));
1461 Vdoc_directory = decode_env_path ("EMACSDOC",
1462 #ifdef HAVE_NS
1463 etc_dir ? etc_dir :
1464 #endif
1465 PATH_DOC, 0);
1466 Vdoc_directory = Ffile_name_as_directory (Fcar (Vdoc_directory));
1468 /* Check the EMACSPATH environment variable, defaulting to the
1469 PATH_EXEC path from epaths.h. */
1470 Vexec_path = decode_env_path ("EMACSPATH",
1471 #ifdef HAVE_NS
1472 path_exec ? path_exec :
1473 #endif
1474 PATH_EXEC, 0);
1475 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1476 /* FIXME? For ns, path_exec should go at the front? */
1477 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1480 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1482 void
1483 init_callproc (void)
1485 bool data_dir = egetenv ("EMACSDATA") != 0;
1487 char *sh;
1488 Lisp_Object tempdir;
1489 #ifdef HAVE_NS
1490 if (data_dir == 0)
1491 data_dir = ns_etc_directory () != 0;
1492 #endif
1494 if (!NILP (Vinstallation_directory))
1496 /* Add to the path the lib-src subdir of the installation dir. */
1497 Lisp_Object tem;
1498 tem = Fexpand_file_name (build_string ("lib-src"),
1499 Vinstallation_directory);
1500 #ifndef MSDOS
1501 /* MSDOS uses wrapped binaries, so don't do this. */
1502 if (NILP (Fmember (tem, Vexec_path)))
1504 #ifdef HAVE_NS
1505 const char *path_exec = ns_exec_path ();
1506 #endif
1507 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1508 Vexec_path = decode_env_path ("EMACSPATH",
1509 #ifdef HAVE_NS
1510 path_exec ? path_exec :
1511 #endif
1512 SSDATA (tem), 0);
1513 Vexec_path = nconc2 (decode_env_path ("PATH", "", 0), Vexec_path);
1516 Vexec_directory = Ffile_name_as_directory (tem);
1517 #endif /* not MSDOS */
1519 /* Maybe use ../etc as well as ../lib-src. */
1520 if (data_dir == 0)
1522 tem = Fexpand_file_name (build_string ("etc"),
1523 Vinstallation_directory);
1524 Vdoc_directory = Ffile_name_as_directory (tem);
1528 /* Look for the files that should be in etc. We don't use
1529 Vinstallation_directory, because these files are never installed
1530 near the executable, and they are never in the build
1531 directory when that's different from the source directory.
1533 Instead, if these files are not in the nominal place, we try the
1534 source directory. */
1535 if (data_dir == 0)
1537 Lisp_Object tem, tem1, srcdir;
1538 Lisp_Object lispdir = Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH, 0));
1540 srcdir = Fexpand_file_name (build_string ("../src/"), lispdir);
1542 tem = Fexpand_file_name (build_string ("NEWS"), Vdata_directory);
1543 tem1 = Ffile_exists_p (tem);
1544 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1546 Lisp_Object newdir;
1547 newdir = Fexpand_file_name (build_string ("../etc/"), lispdir);
1548 tem = Fexpand_file_name (build_string ("NEWS"), newdir);
1549 tem1 = Ffile_exists_p (tem);
1550 if (!NILP (tem1))
1551 Vdata_directory = newdir;
1555 #ifndef CANNOT_DUMP
1556 if (initialized)
1557 #endif
1559 tempdir = Fdirectory_file_name (Vexec_directory);
1560 if (! file_accessible_directory_p (tempdir))
1561 dir_warning ("arch-dependent data dir", Vexec_directory);
1564 tempdir = Fdirectory_file_name (Vdata_directory);
1565 if (! file_accessible_directory_p (tempdir))
1566 dir_warning ("arch-independent data dir", Vdata_directory);
1568 sh = getenv ("SHELL");
1569 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1571 #ifdef DOS_NT
1572 Vshared_game_score_directory = Qnil;
1573 #else
1574 Vshared_game_score_directory = build_unibyte_string (PATH_GAME);
1575 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory)))
1576 Vshared_game_score_directory = Qnil;
1577 #endif
1580 void
1581 set_initial_environment (void)
1583 char **envp;
1584 for (envp = environ; *envp; envp++)
1585 Vprocess_environment = Fcons (build_string (*envp),
1586 Vprocess_environment);
1587 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1588 to use `delete' and friends on process-environment. */
1589 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1592 void
1593 syms_of_callproc (void)
1595 #ifndef DOS_NT
1596 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1597 #else /* DOS_NT */
1598 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1599 #endif
1600 staticpro (&Vtemp_file_name_pattern);
1602 #ifdef MSDOS
1603 synch_process_tempfile = make_number (0);
1604 staticpro (&synch_process_tempfile);
1605 #endif
1607 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1608 doc: /* File name to load inferior shells from.
1609 Initialized from the SHELL environment variable, or to a system-dependent
1610 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1612 DEFVAR_LISP ("exec-path", Vexec_path,
1613 doc: /* List of directories to search programs to run in subprocesses.
1614 Each element is a string (directory name) or nil (try default directory).
1616 By default the last element of this list is `exec-directory'. The
1617 last element is not always used, for example in shell completion
1618 \(`shell-dynamic-complete-command'). */);
1620 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1621 doc: /* List of suffixes to try to find executable file names.
1622 Each element is a string. */);
1623 Vexec_suffixes = Qnil;
1625 DEFVAR_LISP ("exec-directory", Vexec_directory,
1626 doc: /* Directory for executables for Emacs to invoke.
1627 More generally, this includes any architecture-dependent files
1628 that are built and installed from the Emacs distribution. */);
1630 DEFVAR_LISP ("data-directory", Vdata_directory,
1631 doc: /* Directory of machine-independent files that come with GNU Emacs.
1632 These are files intended for Emacs to use while it runs. */);
1634 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1635 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1636 This is usually the same as `data-directory'. */);
1638 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1639 doc: /* For internal use by the build procedure only.
1640 This is the name of the directory in which the build procedure installed
1641 Emacs's info files; the default value for `Info-default-directory-list'
1642 includes this. */);
1643 Vconfigure_info_directory = build_string (PATH_INFO);
1645 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1646 doc: /* Directory of score files for games which come with GNU Emacs.
1647 If this variable is nil, then Emacs is unable to use a shared directory. */);
1648 #ifdef DOS_NT
1649 Vshared_game_score_directory = Qnil;
1650 #else
1651 Vshared_game_score_directory = build_string (PATH_GAME);
1652 #endif
1654 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1655 doc: /* List of environment variables inherited from the parent process.
1656 Each element should be a string of the form ENVVARNAME=VALUE.
1657 The elements must normally be decoded (using `locale-coding-system') for use. */);
1658 Vinitial_environment = Qnil;
1660 DEFVAR_LISP ("process-environment", Vprocess_environment,
1661 doc: /* List of overridden environment variables for subprocesses to inherit.
1662 Each element should be a string of the form ENVVARNAME=VALUE.
1664 Entries in this list take precedence to those in the frame-local
1665 environments. Therefore, let-binding `process-environment' is an easy
1666 way to temporarily change the value of an environment variable,
1667 irrespective of where it comes from. To use `process-environment' to
1668 remove an environment variable, include only its name in the list,
1669 without "=VALUE".
1671 This variable is set to nil when Emacs starts.
1673 If multiple entries define the same variable, the first one always
1674 takes precedence.
1676 Non-ASCII characters are encoded according to the initial value of
1677 `locale-coding-system', i.e. the elements must normally be decoded for
1678 use.
1680 See `setenv' and `getenv'. */);
1681 Vprocess_environment = Qnil;
1683 defsubr (&Scall_process);
1684 defsubr (&Sgetenv_internal);
1685 defsubr (&Scall_process_region);