1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2019 Free Software Foundation,
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 <https://www.gnu.org/licenses/>. */
26 #include <sys/types.h>
35 #include <sys/socket.h> /* for fcntl */
38 #define _P_NOWAIT 1 /* from process.h */
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
43 #include <sys/param.h>
51 #include "syssignal.h"
53 #include "blockinput.h"
66 /* Pattern used by call-process-region to make temp files. */
67 static Lisp_Object Vtemp_file_name_pattern
;
69 /* The next two variables are used while record-unwind-protect is in place
70 during call-process for a subprocess for which record_deleted_pid has
71 not yet been called. At other times, synch_process_pid is zero and
72 synch_process_tempfile's contents are irrelevant. Doing this via static
73 C variables is more convenient than putting them into the arguments
74 of record-unwind-protect, as they need to be updated at randomish
75 times in the code, and Lisp cannot always store these values as
76 Emacs integers. It's safe to use static variables here, as the
77 code is never invoked reentrantly. */
79 /* If nonzero, a process-ID that has not been reaped. */
80 static pid_t synch_process_pid
;
82 /* If a string, the name of a temp file that has not been removed. */
84 static Lisp_Object synch_process_tempfile
;
86 # define synch_process_tempfile make_number (0)
89 /* Indexes of file descriptors that need closing on call_process_kill. */
92 /* The subsidiary process's stdout and stderr. stdin is handled
93 separately, in either Fcall_process_region or create_temp_file. */
94 CALLPROC_STDOUT
, CALLPROC_STDERR
,
96 /* How to read from a pipe (or substitute) from the subsidiary process. */
99 /* A bound on the number of file descriptors. */
103 static Lisp_Object
call_process (ptrdiff_t, Lisp_Object
*, int, ptrdiff_t);
105 /* Return the current buffer's working directory, or the home
106 directory if it's unreachable, as a string suitable for a system call.
107 Signal an error if the result would not be an accessible directory. */
110 encode_current_directory (void)
114 dir
= BVAR (current_buffer
, directory
);
116 dir
= Funhandled_file_name_directory (dir
);
118 /* If the file name handler says that dir is unreachable, use
119 a sensible default. */
121 dir
= build_string ("~");
123 dir
= expand_and_dir_to_file (dir
);
125 if (NILP (Ffile_accessible_directory_p (dir
)))
126 report_file_error ("Setting current directory",
127 BVAR (current_buffer
, directory
));
129 /* Remove "/:" from DIR and encode it. */
130 dir
= ENCODE_FILE (remove_slash_colon (dir
));
132 if (! file_accessible_directory_p (dir
))
133 report_file_error ("Setting current directory",
134 BVAR (current_buffer
, directory
));
139 /* If P is reapable, record it as a deleted process and kill it.
140 Do this in a critical section. Unless PID is wedged it will be
141 reaped on receipt of the first SIGCHLD after the critical section. */
144 record_kill_process (struct Lisp_Process
*p
, Lisp_Object tempfile
)
148 block_child_signal (&oldset
);
152 record_deleted_pid (p
->pid
, tempfile
);
154 kill (- p
->pid
, SIGKILL
);
157 unblock_child_signal (&oldset
);
161 /* Clean up files, file descriptors and processes created by Fcall_process. */
164 delete_temp_file (Lisp_Object name
)
166 unlink (SSDATA (name
));
170 call_process_kill (void *ptr
)
172 int *callproc_fd
= ptr
;
174 for (i
= 0; i
< CALLPROC_FDS
; i
++)
175 if (0 <= callproc_fd
[i
])
176 emacs_close (callproc_fd
[i
]);
178 if (synch_process_pid
)
180 struct Lisp_Process proc
;
182 proc
.pid
= synch_process_pid
;
183 record_kill_process (&proc
, synch_process_tempfile
);
184 synch_process_pid
= 0;
186 else if (STRINGP (synch_process_tempfile
))
187 delete_temp_file (synch_process_tempfile
);
190 /* Clean up when exiting Fcall_process: restore the buffer, and
191 kill the subsidiary process group if the process still exists. */
194 call_process_cleanup (Lisp_Object buffer
)
196 Fset_buffer (buffer
);
199 if (synch_process_pid
)
201 kill (-synch_process_pid
, SIGINT
);
202 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
204 /* This will quit on C-g. */
205 bool wait_ok
= wait_for_termination (synch_process_pid
, NULL
, true);
206 synch_process_pid
= 0;
208 ? "Waiting for process to die...done"
209 : "Waiting for process to die...internal error");
215 static mode_t
const default_output_mode
= S_IREAD
| S_IWRITE
;
217 static mode_t
const default_output_mode
= 0666;
220 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
221 doc
: /* Call PROGRAM synchronously in separate process.
222 The remaining arguments are optional.
223 The program's input comes from file INFILE (nil means `/dev/null').
225 Third argument DESTINATION specifies how to handle program's output.
226 If DESTINATION is a buffer, or t that stands for the current buffer,
227 it means insert output in that buffer before point.
228 If DESTINATION is nil, it means discard output; 0 means discard
229 and don't wait for the program to terminate.
230 If DESTINATION is `(:file FILE)', where FILE is a file name string,
231 it means that output should be written to that file (if the file
232 already exists it is overwritten).
233 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
234 REAL-BUFFER says what to do with standard output, as above,
235 while STDERR-FILE says what to do with standard error in the child.
236 STDERR-FILE may be nil (discard standard error output),
237 t (mix it with ordinary output), or a file name string.
239 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
240 Remaining arguments are strings passed as command arguments to PROGRAM.
242 If executable PROGRAM can't be found as an executable, `call-process'
243 signals a Lisp error. `call-process' reports errors in execution of
244 the program only through its return and output.
246 If DESTINATION is 0, `call-process' returns immediately with value nil.
247 Otherwise it waits for PROGRAM to terminate
248 and returns a numeric exit status or a signal description string.
249 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
251 The process runs in `default-directory' if that is local (as
252 determined by `unhandled-file-name-directory'), or "~" otherwise. If
253 you want to run a process in a remote directory use `process-file'.
255 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
256 (ptrdiff_t nargs
, Lisp_Object
*args
)
258 Lisp_Object infile
, encoded_infile
;
260 ptrdiff_t count
= SPECPDL_INDEX ();
262 if (nargs
>= 2 && ! NILP (args
[1]))
264 infile
= Fexpand_file_name (args
[1], BVAR (current_buffer
, directory
));
265 CHECK_STRING (infile
);
268 infile
= build_string (NULL_DEVICE
);
270 encoded_infile
= ENCODE_FILE (infile
);
272 filefd
= emacs_open (SSDATA (encoded_infile
), O_RDONLY
, 0);
274 report_file_error ("Opening process input file", infile
);
275 record_unwind_protect_int (close_file_unwind
, filefd
);
276 return unbind_to (count
, call_process (nargs
, args
, filefd
, -1));
279 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
281 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
282 unwinder that is intended to remove the input temporary file; in
283 this case NARGS must be at least 2 and ARGS[1] is the file's name.
285 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
288 call_process (ptrdiff_t nargs
, Lisp_Object
*args
, int filefd
,
289 ptrdiff_t tempfile_index
)
291 Lisp_Object buffer
, current_dir
, path
;
294 int callproc_fd
[CALLPROC_FDS
];
297 ptrdiff_t count
= SPECPDL_INDEX ();
301 /* File to use for stderr in the child.
302 t means use same as standard output. */
303 Lisp_Object error_file
;
304 Lisp_Object output_file
= Qnil
;
305 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
306 char *tempfile
= NULL
;
312 int fd_output
, fd_error
;
313 struct coding_system process_coding
; /* coding-system of process output */
314 struct coding_system argument_coding
; /* coding-system of arguments */
315 /* Set to the return value of Ffind_operation_coding_system. */
316 Lisp_Object coding_systems
;
319 if (synch_process_pid
)
320 error ("call-process invoked recursively");
322 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
325 CHECK_STRING (args
[0]);
330 /* Without asynchronous processes we cannot have BUFFER == 0. */
332 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
333 error ("Operating system cannot handle asynchronous subprocesses");
334 #endif /* subprocesses */
336 /* Decide the coding-system for giving arguments. */
338 Lisp_Object val
, *args2
;
340 /* If arguments are supplied, we may have to encode them. */
343 bool must_encode
= 0;
344 Lisp_Object coding_attrs
;
346 for (i
= 4; i
< nargs
; i
++)
347 CHECK_STRING (args
[i
]);
349 for (i
= 4; i
< nargs
; i
++)
350 if (STRING_MULTIBYTE (args
[i
]))
353 if (!NILP (Vcoding_system_for_write
))
354 val
= Vcoding_system_for_write
;
355 else if (! must_encode
)
359 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
360 args2
[0] = Qcall_process
;
361 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
362 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
363 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
365 val
= complement_process_encoding_system (val
);
366 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
367 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
368 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
370 /* We should not use an ASCII incompatible coding system. */
371 val
= raw_text_coding_system (val
);
372 setup_coding_system (val
, &argument_coding
);
383 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
384 FILE-FOR-STDERR), unless the first element is :file, in which case see
385 the next paragraph. */
386 if (CONSP (buffer
) && !EQ (XCAR (buffer
), QCfile
))
388 if (CONSP (XCDR (buffer
)))
390 Lisp_Object stderr_file
;
391 stderr_file
= XCAR (XCDR (buffer
));
393 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
394 error_file
= stderr_file
;
396 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
399 buffer
= XCAR (buffer
);
402 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
403 if (CONSP (buffer
) && EQ (XCAR (buffer
), QCfile
))
405 output_file
= Fexpand_file_name (XCAR (XCDR (buffer
)),
406 BVAR (current_buffer
, directory
));
407 CHECK_STRING (output_file
);
411 if (! (NILP (buffer
) || EQ (buffer
, Qt
) || INTEGERP (buffer
)))
413 Lisp_Object spec_buffer
;
414 spec_buffer
= buffer
;
415 buffer
= Fget_buffer_create (buffer
);
416 /* Mention the buffer name for a better error message. */
418 CHECK_BUFFER (spec_buffer
);
419 CHECK_BUFFER (buffer
);
423 /* Make sure that the child will be able to chdir to the current
424 buffer's current directory, or its unhandled equivalent. We
425 can't just have the child check for an error when it does the
426 chdir, since it's in a vfork. */
427 current_dir
= encode_current_directory ();
429 if (STRINGP (error_file
))
430 error_file
= ENCODE_FILE (error_file
);
431 if (STRINGP (output_file
))
432 output_file
= ENCODE_FILE (output_file
);
434 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
436 for (i
= 0; i
< CALLPROC_FDS
; i
++)
439 synch_process_tempfile
= make_number (0);
441 record_unwind_protect_ptr (call_process_kill
, callproc_fd
);
443 /* Search for program; barf if not found. */
447 ok
= openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
,
448 make_number (X_OK
), false);
450 report_file_error ("Searching for program", args
[0]);
453 /* Remove "/:" from PATH. */
454 path
= remove_slash_colon (path
);
456 SAFE_NALLOCA (new_argv
, 1, nargs
< 4 ? 2 : nargs
- 2);
462 argument_coding
.dst_multibyte
= 0;
463 for (i
= 4; i
< nargs
; i
++)
465 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
466 if (CODING_REQUIRE_ENCODING (&argument_coding
))
467 /* We must encode this argument. */
468 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
470 for (i
= 4; i
< nargs
; i
++)
471 new_argv
[i
- 3] = SSDATA (args
[i
]);
476 path
= ENCODE_FILE (path
);
477 new_argv
[0] = SSDATA (path
);
479 discard_output
= INTEGERP (buffer
) || (NILP (buffer
) && NILP (output_file
));
482 if (! discard_output
&& ! STRINGP (output_file
))
484 char const *tmpdir
= egetenv ("TMPDIR");
485 char const *outf
= tmpdir
? tmpdir
: "";
486 tempfile
= alloca (strlen (outf
) + 20);
487 strcpy (tempfile
, outf
);
488 dostounix_filename (tempfile
);
489 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
490 strcat (tempfile
, "/");
491 strcat (tempfile
, "emXXXXXX");
494 report_file_error ("Opening process output file", Qnil
);
495 output_file
= build_string (tempfile
);
496 synch_process_tempfile
= output_file
;
502 fd_output
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
504 report_file_error ("Opening null device", Qnil
);
506 else if (STRINGP (output_file
))
508 fd_output
= emacs_open (SSDATA (output_file
),
509 O_WRONLY
| O_CREAT
| O_TRUNC
| O_TEXT
,
510 default_output_mode
);
513 int open_errno
= errno
;
514 output_file
= DECODE_FILE (output_file
);
515 report_file_errno ("Opening process output file",
516 output_file
, open_errno
);
522 if (emacs_pipe (fd
) != 0)
523 report_file_error ("Creating process pipe", Qnil
);
524 callproc_fd
[CALLPROC_PIPEREAD
] = fd
[0];
527 callproc_fd
[CALLPROC_STDOUT
] = fd_output
;
529 fd_error
= fd_output
;
531 if (STRINGP (error_file
) || (NILP (error_file
) && !discard_output
))
533 fd_error
= emacs_open ((STRINGP (error_file
)
534 ? SSDATA (error_file
)
536 O_WRONLY
| O_CREAT
| O_TRUNC
| O_TEXT
,
537 default_output_mode
);
540 int open_errno
= errno
;
541 report_file_errno ("Cannot redirect stderr",
542 (STRINGP (error_file
)
543 ? DECODE_FILE (error_file
)
544 : build_string (NULL_DEVICE
)),
547 callproc_fd
[CALLPROC_STDERR
] = fd_error
;
550 #ifdef MSDOS /* MW, July 1993 */
551 status
= child_setup (filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
556 unbind_to (count
, Qnil
);
557 synchronize_system_messages_locale ();
559 code_convert_string_norecord (build_string (strerror (child_errno
)),
560 Vlocale_coding_system
, 0);
563 for (i
= 0; i
< CALLPROC_FDS
; i
++)
564 if (0 <= callproc_fd
[i
])
566 emacs_close (callproc_fd
[i
]);
569 emacs_close (filefd
);
570 clear_unwind_protect (count
- 1);
574 /* Since CRLF is converted to LF within `decode_coding', we
575 can always open a file with binary mode. */
576 callproc_fd
[CALLPROC_PIPEREAD
] = emacs_open (tempfile
, O_RDONLY
, 0);
577 if (callproc_fd
[CALLPROC_PIPEREAD
] < 0)
579 int open_errno
= errno
;
580 report_file_errno ("Cannot re-open temporary file",
581 build_string (tempfile
), open_errno
);
587 /* Do the unwind-protect now, even though the pid is not known, so
588 that no storage allocation is done in the critical section.
589 The actual PID will be filled in during the critical section. */
590 record_unwind_protect (call_process_cleanup
, Fcurrent_buffer ());
595 block_child_signal (&oldset
);
598 pid
= child_setup (filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
599 #else /* not WINDOWSNT */
601 /* vfork, and prevent local vars from being clobbered by the vfork. */
603 Lisp_Object
volatile buffer_volatile
= buffer
;
604 Lisp_Object
volatile coding_systems_volatile
= coding_systems
;
605 Lisp_Object
volatile current_dir_volatile
= current_dir
;
606 bool volatile display_p_volatile
= display_p
;
607 bool volatile sa_must_free_volatile
= sa_must_free
;
608 int volatile fd_error_volatile
= fd_error
;
609 int volatile filefd_volatile
= filefd
;
610 ptrdiff_t volatile count_volatile
= count
;
611 ptrdiff_t volatile sa_avail_volatile
= sa_avail
;
612 ptrdiff_t volatile sa_count_volatile
= sa_count
;
613 char **volatile new_argv_volatile
= new_argv
;
614 int volatile callproc_fd_volatile
[CALLPROC_FDS
];
615 for (i
= 0; i
< CALLPROC_FDS
; i
++)
616 callproc_fd_volatile
[i
] = callproc_fd
[i
];
620 buffer
= buffer_volatile
;
621 coding_systems
= coding_systems_volatile
;
622 current_dir
= current_dir_volatile
;
623 display_p
= display_p_volatile
;
624 sa_must_free
= sa_must_free_volatile
;
625 fd_error
= fd_error_volatile
;
626 filefd
= filefd_volatile
;
627 count
= count_volatile
;
628 sa_avail
= sa_avail_volatile
;
629 sa_count
= sa_count_volatile
;
630 new_argv
= new_argv_volatile
;
632 for (i
= 0; i
< CALLPROC_FDS
; i
++)
633 callproc_fd
[i
] = callproc_fd_volatile
[i
];
634 fd_output
= callproc_fd
[CALLPROC_STDOUT
];
640 /* Work around a macOS bug, where SIGCHLD is apparently
641 delivered to a vforked child instead of to its parent. See:
642 https://lists.gnu.org/r/emacs-devel/2017-05/msg00342.html
644 signal (SIGCHLD
, SIG_DFL
);
647 unblock_child_signal (&oldset
);
650 /* Darwin doesn't let us run setsid after a vfork, so use
651 TIOCNOTTY when necessary. */
652 int j
= emacs_open (DEV_TTY
, O_RDWR
, 0);
655 ioctl (j
, TIOCNOTTY
, 0);
662 /* Emacs ignores SIGPIPE, but the child should not. */
663 signal (SIGPIPE
, SIG_DFL
);
664 /* Likewise for SIGPROF. */
666 signal (SIGPROF
, SIG_DFL
);
669 child_setup (filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
672 #endif /* not WINDOWSNT */
678 synch_process_pid
= pid
;
680 if (INTEGERP (buffer
))
682 if (tempfile_index
< 0)
683 record_deleted_pid (pid
, Qnil
);
687 record_deleted_pid (pid
, args
[1]);
688 clear_unwind_protect (tempfile_index
);
690 synch_process_pid
= 0;
694 unblock_child_signal (&oldset
);
698 report_file_errno ("Doing vfork", Qnil
, child_errno
);
700 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
701 since we will use that to read input from. */
702 for (i
= 0; i
< CALLPROC_FDS
; i
++)
703 if (i
!= CALLPROC_PIPEREAD
&& 0 <= callproc_fd
[i
])
705 emacs_close (callproc_fd
[i
]);
708 emacs_close (filefd
);
709 clear_unwind_protect (count
- 1);
711 #endif /* not MSDOS */
713 if (INTEGERP (buffer
))
714 return unbind_to (count
, Qnil
);
716 if (BUFFERP (buffer
))
717 Fset_buffer (buffer
);
719 fd0
= callproc_fd
[CALLPROC_PIPEREAD
];
723 Lisp_Object val
, *args2
;
726 if (!NILP (Vcoding_system_for_read
))
727 val
= Vcoding_system_for_read
;
730 if (EQ (coding_systems
, Qt
))
734 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
735 args2
[0] = Qcall_process
;
736 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
738 = Ffind_operation_coding_system (nargs
+ 1, args2
);
740 if (CONSP (coding_systems
))
741 val
= XCAR (coding_systems
);
742 else if (CONSP (Vdefault_process_coding_system
))
743 val
= XCAR (Vdefault_process_coding_system
);
747 Fcheck_coding_system (val
);
748 /* In unibyte mode, character code conversion should not take
749 place but EOL conversion should. So, setup raw-text or one
750 of the subsidiary according to the information just setup. */
751 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
753 val
= raw_text_coding_system (val
);
754 setup_coding_system (val
, &process_coding
);
755 process_coding
.dst_multibyte
756 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
757 process_coding
.src_multibyte
= 0;
762 enum { CALLPROC_BUFFER_SIZE_MIN
= 16 * 1024 };
763 enum { CALLPROC_BUFFER_SIZE_MAX
= 4 * CALLPROC_BUFFER_SIZE_MIN
};
764 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
765 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
767 EMACS_INT total_read
= 0;
769 bool display_on_the_fly
= display_p
;
770 struct coding_system saved_coding
= process_coding
;
774 /* Repeatedly read until we've filled as much as possible
775 of the buffer size we have. But don't read
776 less than 1024--save that for the next bufferful. */
778 while (nread
< bufsize
- 1024)
780 int this_read
= emacs_read_quit (fd0
, buf
+ nread
,
788 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
793 total_read
+= this_read
;
795 if (display_on_the_fly
)
799 /* Now NREAD is the total amount of data in the buffer. */
803 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
804 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
805 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
807 { /* We have to decode the input. */
809 ptrdiff_t count1
= SPECPDL_INDEX ();
811 XSETBUFFER (curbuf
, current_buffer
);
812 /* FIXME: Call signal_after_change! */
813 prepare_to_modify_buffer (PT
, PT
, NULL
);
814 /* We cannot allow after-change-functions be run
815 during decoding, because that might modify the
816 buffer, while we rely on process_coding.produced to
817 faithfully reflect inserted text until we
818 TEMP_SET_PT_BOTH below. */
819 specbind (Qinhibit_modification_hooks
, Qt
);
820 decode_coding_c_string (&process_coding
,
821 (unsigned char *) buf
, nread
, curbuf
);
822 unbind_to (count1
, Qnil
);
823 if (display_on_the_fly
824 && CODING_REQUIRE_DETECTION (&saved_coding
)
825 && ! CODING_REQUIRE_DETECTION (&process_coding
))
827 /* We have detected some coding system, but the
828 detection may have been via insufficient data.
829 So give up displaying on the fly. */
830 if (process_coding
.produced
> 0)
831 del_range_2 (process_coding
.dst_pos
,
832 process_coding
.dst_pos_byte
,
833 (process_coding
.dst_pos
834 + process_coding
.produced_char
),
835 (process_coding
.dst_pos_byte
836 + process_coding
.produced
),
838 display_on_the_fly
= false;
839 process_coding
= saved_coding
;
841 /* Make the above condition always fail in the future. */
842 saved_coding
.common_flags
843 &= ~CODING_REQUIRE_DETECTION_MASK
;
847 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
848 PT_BYTE
+ process_coding
.produced
);
849 carryover
= process_coding
.carryover_bytes
;
851 memcpy (buf
, process_coding
.carryover
,
852 process_coding
.carryover_bytes
);
855 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
858 /* Make the buffer bigger as we continue to read more data,
859 but not past CALLPROC_BUFFER_SIZE_MAX. */
860 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
861 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
862 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
866 redisplay_preserve_echo_area (1);
867 /* This variable might have been set to 0 for code
868 detection. In that case, set it back to 1 because
869 we should have already detected a coding system. */
870 display_on_the_fly
= true;
875 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
876 /* If the caller required, let the buffer inherit the
877 coding-system used to decode the process output. */
878 if (inherit_process_coding_system
)
879 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
880 make_number (total_read
));
885 /* Wait for it to terminate, unless it already has. */
886 wait_ok
= wait_for_termination (pid
, &status
, fd0
< 0);
889 /* Don't kill any children that the subprocess may have left behind
891 synch_process_pid
= 0;
894 unbind_to (count
, Qnil
);
897 return build_unibyte_string ("internal error");
899 if (WIFSIGNALED (status
))
903 synchronize_system_messages_locale ();
904 signame
= strsignal (WTERMSIG (status
));
909 return code_convert_string_norecord (build_string (signame
),
910 Vlocale_coding_system
, 0);
913 eassert (WIFEXITED (status
));
914 return make_number (WEXITSTATUS (status
));
917 /* Create a temporary file suitable for storing the input data of
918 call-process-region. NARGS and ARGS are the same as for
919 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
920 naming the file, and return a file descriptor for reading.
921 Unwind-protect the file, so that the file descriptor will be closed
922 and the file removed when the caller unwinds the specpdl stack. */
925 create_temp_file (ptrdiff_t nargs
, Lisp_Object
*args
,
926 Lisp_Object
*filename_string_ptr
)
929 Lisp_Object filename_string
;
930 Lisp_Object val
, start
, end
;
933 if (STRINGP (Vtemporary_file_directory
))
934 tmpdir
= Vtemporary_file_directory
;
939 outf
= getenv ("TMPDIR");
940 tmpdir
= build_string (outf
? outf
: "/tmp/");
942 if ((outf
= egetenv ("TMPDIR"))
943 || (outf
= egetenv ("TMP"))
944 || (outf
= egetenv ("TEMP")))
945 tmpdir
= build_string (outf
);
947 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
952 Lisp_Object pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
957 /* Cannot use the result of Fexpand_file_name, because it
958 downcases the XXXXXX part of the pattern, and mktemp then
959 doesn't recognize it. */
960 if (!NILP (Vw32_downcase_file_names
))
962 Lisp_Object dirname
= Ffile_name_directory (pattern
);
965 pattern
= Vtemp_file_name_pattern
;
967 pattern
= concat2 (dirname
, Vtemp_file_name_pattern
);
971 filename_string
= Fcopy_sequence (ENCODE_FILE (pattern
));
972 tempfile
= SSDATA (filename_string
);
974 count
= SPECPDL_INDEX ();
975 record_unwind_protect_nothing ();
976 fd
= mkostemp (tempfile
, O_BINARY
| O_CLOEXEC
);
978 report_file_error ("Failed to open temporary file using pattern",
980 set_unwind_protect (count
, delete_temp_file
, filename_string
);
981 record_unwind_protect_int (close_file_unwind
, fd
);
986 /* Decide coding-system of the contents of the temporary file. */
987 if (!NILP (Vcoding_system_for_write
))
988 val
= Vcoding_system_for_write
;
989 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
993 Lisp_Object coding_systems
;
996 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
997 args2
[0] = Qcall_process_region
;
998 memcpy (args2
+ 1, args
, nargs
* sizeof *args
);
999 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1000 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
1003 val
= complement_process_encoding_system (val
);
1006 ptrdiff_t count1
= SPECPDL_INDEX ();
1008 specbind (intern ("coding-system-for-write"), val
);
1009 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1010 happen to get a ".Z" suffix. */
1011 specbind (Qfile_name_handler_alist
, Qnil
);
1012 write_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
, fd
);
1014 unbind_to (count1
, Qnil
);
1017 if (lseek (fd
, 0, SEEK_SET
) < 0)
1018 report_file_error ("Setting file position", filename_string
);
1020 /* Note that Fcall_process takes care of binding
1021 coding-system-for-read. */
1023 *filename_string_ptr
= filename_string
;
1027 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1029 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1031 START and END are normally buffer positions specifying the part of the
1032 buffer to send to the process.
1033 If START is nil, that means to use the entire buffer contents; END is
1035 If START is a string, then send that string to the process
1036 instead of any buffer contents; END is ignored.
1037 The remaining arguments are optional.
1038 Delete the text if fourth arg DELETE is non-nil.
1040 Insert output in BUFFER before point; t means current buffer; nil for
1041 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1042 FILE)', where FILE is a file name string, means that it should be
1043 written to that file (if the file already exists it is overwritten).
1044 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1045 REAL-BUFFER says what to do with standard output, as above,
1046 while STDERR-FILE says what to do with standard error in the child.
1047 STDERR-FILE may be nil (discard standard error output),
1048 t (mix it with ordinary output), or a file name string.
1050 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1051 Remaining args are passed to PROGRAM at startup as command args.
1053 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1054 Otherwise it waits for PROGRAM to terminate
1055 and returns a numeric exit status or a signal description string.
1056 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1058 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1059 (ptrdiff_t nargs
, Lisp_Object
*args
)
1061 Lisp_Object infile
, val
;
1062 ptrdiff_t count
= SPECPDL_INDEX ();
1063 Lisp_Object start
= args
[0];
1064 Lisp_Object end
= args
[1];
1068 if (STRINGP (start
))
1069 empty_input
= SCHARS (start
) == 0;
1070 else if (NILP (start
))
1071 empty_input
= BEG
== Z
;
1074 validate_region (&args
[0], &args
[1]);
1077 empty_input
= XINT (start
) == XINT (end
);
1081 fd
= create_temp_file (nargs
, args
, &infile
);
1085 fd
= emacs_open (NULL_DEVICE
, O_RDONLY
, 0);
1087 report_file_error ("Opening null device", Qnil
);
1088 record_unwind_protect_int (close_file_unwind
, fd
);
1091 if (nargs
> 3 && !NILP (args
[3]))
1092 Fdelete_region (start
, end
);
1106 val
= call_process (nargs
, args
, fd
, empty_input
? -1 : count
);
1107 return unbind_to (count
, val
);
1111 add_env (char **env
, char **new_env
, char *string
)
1118 /* See if this string duplicates any string already in the env.
1119 If so, don't put it in.
1120 When an env var has multiple definitions,
1121 we keep the definition that comes first in process-environment. */
1122 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1124 char *p
= *ep
, *q
= string
;
1130 /* The string is a lone variable name; keep it for now, we
1131 will remove it later. It is a placeholder for a
1132 variable that is not to be included in the environment. */
1140 *new_env
++ = string
;
1146 /* 'exec' failed inside a child running NAME, with error number ERR.
1147 Possibly a vforked child needed to allocate a large vector on the
1148 stack; such a child cannot fall back on malloc because that might
1149 mess up the allocator's data structures in the parent.
1150 Report the error and exit the child. */
1152 static _Noreturn
void
1153 exec_failed (char const *name
, int err
)
1155 /* Avoid deadlock if the child's perror writes to a full pipe; the
1156 pipe's reader is the parent, but with vfork the parent can't
1157 run until the child exits. Truncate the diagnostic instead. */
1158 fcntl (STDERR_FILENO
, F_SETFL
, O_NONBLOCK
);
1161 emacs_perror (name
);
1162 _exit (err
== ENOENT
? EXIT_ENOENT
: EXIT_CANNOT_INVOKE
);
1167 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1168 fork and exec, and handle alloca exhaustion in a different way. */
1171 exec_failed (char const *name
, int err
)
1177 /* This is the last thing run in a newly forked inferior
1178 either synchronous or asynchronous.
1179 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1180 Initialize inferior's priority, pgrp, connected dir and environment.
1181 then exec another program based on new_argv.
1183 If SET_PGRP, put the subprocess into a separate process group.
1185 CURRENT_DIR is an elisp string giving the path of the current
1186 directory the subprocess should have. Since we can't really signal
1187 a decent error from within the child, this should be verified as an
1188 executable directory by the parent.
1190 On GNUish hosts, either exec or return an error number.
1191 On MS-Windows, either return a pid or signal an error.
1192 On MS-DOS, either return an exit status or signal an error. */
1195 child_setup (int in
, int out
, int err
, char **new_argv
, bool set_pgrp
,
1196 Lisp_Object current_dir
)
1204 pid_t pid
= getpid ();
1205 #endif /* WINDOWSNT */
1207 /* Note that use of alloca is always safe here. It's obvious for systems
1208 that do not have true vfork or that have true (stack) alloca.
1209 If using vfork and C_ALLOCA (when Emacs used to include
1210 src/alloca.c) it is safe because that changes the superior's
1211 static variables as if the superior had done alloca and will be
1212 cleaned up in the usual way. */
1217 i
= SBYTES (current_dir
);
1219 /* MSDOS must have all environment variables malloc'ed, because
1220 low-level libc functions that launch subsidiary processes rely
1222 pwd_var
= xmalloc (i
+ 5);
1224 if (MAX_ALLOCA
- 5 < i
)
1225 exec_failed (new_argv
[0], ENOMEM
);
1226 pwd_var
= alloca (i
+ 5);
1229 memcpy (pwd_var
, "PWD=", 4);
1230 lispstpcpy (temp
, current_dir
);
1233 /* We can't signal an Elisp error here; we're in a vfork. Since
1234 the callers check the current directory before forking, this
1235 should only return an error if the directory's permissions
1236 are changed between the check and this chdir, but we should
1238 if (chdir (temp
) < 0)
1239 _exit (EXIT_CANCELED
);
1241 /* Get past the drive letter, so that d:/ is left alone. */
1242 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1249 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1250 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1254 /* Set `env' to a vector of the strings in the environment. */
1256 register Lisp_Object tem
;
1257 register char **new_env
;
1259 register int new_length
;
1260 Lisp_Object display
= Qnil
;
1264 for (tem
= Vprocess_environment
;
1265 CONSP (tem
) && STRINGP (XCAR (tem
));
1268 if (strncmp (SSDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1269 && (SDATA (XCAR (tem
)) [7] == '\0'
1270 || SDATA (XCAR (tem
)) [7] == '='))
1271 /* DISPLAY is specified in process-environment. */
1276 /* If not provided yet, use the frame's DISPLAY. */
1279 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1280 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1281 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1282 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1283 Vinitial_environment
);
1291 /* new_length + 2 to include PWD and terminating 0. */
1292 if (MAX_ALLOCA
/ sizeof *env
- 2 < new_length
)
1293 exec_failed (new_argv
[0], ENOMEM
);
1294 env
= new_env
= alloca ((new_length
+ 2) * sizeof *env
);
1295 /* If we have a PWD envvar, pass one down,
1296 but with corrected value. */
1297 if (egetenv ("PWD"))
1298 *new_env
++ = pwd_var
;
1300 if (STRINGP (display
))
1302 if (MAX_ALLOCA
- sizeof "DISPLAY=" < SBYTES (display
))
1303 exec_failed (new_argv
[0], ENOMEM
);
1304 char *vdata
= alloca (sizeof "DISPLAY=" + SBYTES (display
));
1305 lispstpcpy (stpcpy (vdata
, "DISPLAY="), display
);
1306 new_env
= add_env (env
, new_env
, vdata
);
1310 for (tem
= Vprocess_environment
;
1311 CONSP (tem
) && STRINGP (XCAR (tem
));
1313 new_env
= add_env (env
, new_env
, SSDATA (XCAR (tem
)));
1317 /* Remove variable names without values. */
1321 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1331 prepare_standard_handles (in
, out
, err
, handles
);
1332 set_process_dir (SSDATA (current_dir
));
1333 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1334 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1335 reset_standard_handles (in
, out
, err
, handles
);
1337 /* An error occurred while trying to spawn the process. */
1338 report_file_error ("Spawning child process", Qnil
);
1341 #else /* not WINDOWSNT */
1345 restore_nofile_limit ();
1347 /* Redirect file descriptors and clear the close-on-exec flag on the
1348 redirected ones. IN, OUT, and ERR are close-on-exec so they
1349 need not be closed explicitly. */
1350 dup2 (in
, STDIN_FILENO
);
1351 dup2 (out
, STDOUT_FILENO
);
1352 dup2 (err
, STDERR_FILENO
);
1357 int errnum
= emacs_exec_file (new_argv
[0], new_argv
, env
);
1358 exec_failed (new_argv
[0], errnum
);
1361 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1364 /* An error occurred while trying to run the subprocess. */
1365 report_file_error ("Spawning child process", Qnil
);
1368 #endif /* not WINDOWSNT */
1372 getenv_internal_1 (const char *var
, ptrdiff_t varlen
, char **value
,
1373 ptrdiff_t *valuelen
, Lisp_Object env
)
1375 for (; CONSP (env
); env
= XCDR (env
))
1377 Lisp_Object entry
= XCAR (env
);
1379 && SBYTES (entry
) >= varlen
1381 /* NT environment variables are case insensitive. */
1382 && ! strnicmp (SSDATA (entry
), var
, varlen
)
1383 #else /* not WINDOWSNT */
1384 && ! memcmp (SDATA (entry
), var
, varlen
)
1385 #endif /* not WINDOWSNT */
1388 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1390 *value
= SSDATA (entry
) + (varlen
+ 1);
1391 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1394 else if (SBYTES (entry
) == varlen
)
1396 /* Lone variable names in Vprocess_environment mean that
1397 variable should be removed from the environment. */
1407 getenv_internal (const char *var
, ptrdiff_t varlen
, char **value
,
1408 ptrdiff_t *valuelen
, Lisp_Object frame
)
1410 /* Try to find VAR in Vprocess_environment first. */
1411 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1412 Vprocess_environment
))
1413 return *value
? 1 : 0;
1415 /* On Windows we make some modifications to Emacs' environment
1416 without recording them in Vprocess_environment. */
1419 char *tmpval
= getenv (var
);
1423 *valuelen
= strlen (tmpval
);
1429 /* For DISPLAY try to get the values from the frame or the initial env. */
1430 if (strcmp (var
, "DISPLAY") == 0)
1433 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1434 if (STRINGP (display
))
1436 *value
= SSDATA (display
);
1437 *valuelen
= SBYTES (display
);
1440 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1441 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1442 Vinitial_environment
))
1443 return *value
? 1 : 0;
1449 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1450 doc
: /* Get the value of environment variable VARIABLE.
1451 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1452 the environment. Otherwise, value is a string.
1454 This function searches `process-environment' for VARIABLE.
1456 If optional parameter ENV is a list, then search this list instead of
1457 `process-environment', and return t when encountering a negative entry
1458 \(an entry for a variable with no value). */)
1459 (Lisp_Object variable
, Lisp_Object env
)
1464 CHECK_STRING (variable
);
1467 if (getenv_internal_1 (SSDATA (variable
), SBYTES (variable
),
1468 &value
, &valuelen
, env
))
1469 return value
? make_string (value
, valuelen
) : Qt
;
1473 else if (getenv_internal (SSDATA (variable
), SBYTES (variable
),
1474 &value
, &valuelen
, env
))
1475 return make_string (value
, valuelen
);
1480 /* A version of getenv that consults the Lisp environment lists,
1481 easily callable from C. This is usually called from egetenv. */
1483 egetenv_internal (const char *var
, ptrdiff_t len
)
1488 if (getenv_internal (var
, len
, &value
, &valuelen
, Qnil
))
1495 /* This is run before init_cmdargs. */
1498 init_callproc_1 (void)
1501 const char *etc_dir
= ns_etc_directory ();
1502 const char *path_exec
= ns_exec_path ();
1505 Vdata_directory
= decode_env_path ("EMACSDATA",
1510 Vdata_directory
= Ffile_name_as_directory (Fcar (Vdata_directory
));
1512 Vdoc_directory
= decode_env_path ("EMACSDOC",
1517 Vdoc_directory
= Ffile_name_as_directory (Fcar (Vdoc_directory
));
1519 /* Check the EMACSPATH environment variable, defaulting to the
1520 PATH_EXEC path from epaths.h. */
1521 Vexec_path
= decode_env_path ("EMACSPATH",
1523 path_exec
? path_exec
:
1526 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1527 /* FIXME? For ns, path_exec should go at the front? */
1528 Vexec_path
= nconc2 (decode_env_path ("PATH", "", 0), Vexec_path
);
1531 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1534 init_callproc (void)
1536 bool data_dir
= egetenv ("EMACSDATA") != 0;
1539 Lisp_Object tempdir
;
1542 data_dir
= ns_etc_directory () != 0;
1545 if (!NILP (Vinstallation_directory
))
1547 /* Add to the path the lib-src subdir of the installation dir. */
1549 tem
= Fexpand_file_name (build_string ("lib-src"),
1550 Vinstallation_directory
);
1552 /* MSDOS uses wrapped binaries, so don't do this. */
1553 if (NILP (Fmember (tem
, Vexec_path
)))
1556 const char *path_exec
= ns_exec_path ();
1558 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1559 Vexec_path
= decode_env_path ("EMACSPATH",
1561 path_exec
? path_exec
:
1564 Vexec_path
= nconc2 (decode_env_path ("PATH", "", 0), Vexec_path
);
1567 Vexec_directory
= Ffile_name_as_directory (tem
);
1568 #endif /* not MSDOS */
1570 /* Maybe use ../etc as well as ../lib-src. */
1573 tem
= Fexpand_file_name (build_string ("etc"),
1574 Vinstallation_directory
);
1575 Vdoc_directory
= Ffile_name_as_directory (tem
);
1579 /* Look for the files that should be in etc. We don't use
1580 Vinstallation_directory, because these files are never installed
1581 near the executable, and they are never in the build
1582 directory when that's different from the source directory.
1584 Instead, if these files are not in the nominal place, we try the
1585 source directory. */
1588 Lisp_Object tem
, tem1
, srcdir
;
1589 Lisp_Object lispdir
= Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH
, 0));
1591 srcdir
= Fexpand_file_name (build_string ("../src/"), lispdir
);
1593 tem
= Fexpand_file_name (build_string ("NEWS"), Vdata_directory
);
1594 tem1
= Ffile_exists_p (tem
);
1595 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1598 newdir
= Fexpand_file_name (build_string ("../etc/"), lispdir
);
1599 tem
= Fexpand_file_name (build_string ("NEWS"), newdir
);
1600 tem1
= Ffile_exists_p (tem
);
1602 Vdata_directory
= newdir
;
1610 tempdir
= Fdirectory_file_name (Vexec_directory
);
1611 if (! file_accessible_directory_p (tempdir
))
1612 dir_warning ("arch-dependent data dir", Vexec_directory
);
1615 tempdir
= Fdirectory_file_name (Vdata_directory
);
1616 if (! file_accessible_directory_p (tempdir
))
1617 dir_warning ("arch-independent data dir", Vdata_directory
);
1619 sh
= getenv ("SHELL");
1620 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1622 Lisp_Object gamedir
= Qnil
;
1625 Lisp_Object path_game
= build_unibyte_string (PATH_GAME
);
1626 if (file_accessible_directory_p (path_game
))
1627 gamedir
= path_game
;
1629 Vshared_game_score_directory
= gamedir
;
1633 set_initial_environment (void)
1636 for (envp
= environ
; *envp
; envp
++)
1637 Vprocess_environment
= Fcons (build_string (*envp
),
1638 Vprocess_environment
);
1639 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1640 to use `delete' and friends on process-environment. */
1641 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1645 syms_of_callproc (void)
1648 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1650 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1652 staticpro (&Vtemp_file_name_pattern
);
1655 synch_process_tempfile
= make_number (0);
1656 staticpro (&synch_process_tempfile
);
1659 DEFVAR_LISP ("shell-file-name", Vshell_file_name
,
1660 doc
: /* File name to load inferior shells from.
1661 Initialized from the SHELL environment variable, or to a system-dependent
1662 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1664 DEFVAR_LISP ("exec-path", Vexec_path
,
1665 doc
: /* List of directories to search programs to run in subprocesses.
1666 Each element is a string (directory name) or nil (try default directory).
1668 By default the last element of this list is `exec-directory'. The
1669 last element is not always used, for example in shell completion
1670 \(`shell-dynamic-complete-command'). */);
1672 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes
,
1673 doc
: /* List of suffixes to try to find executable file names.
1674 Each element is a string. */);
1675 Vexec_suffixes
= Qnil
;
1677 DEFVAR_LISP ("exec-directory", Vexec_directory
,
1678 doc
: /* Directory for executables for Emacs to invoke.
1679 More generally, this includes any architecture-dependent files
1680 that are built and installed from the Emacs distribution. */);
1682 DEFVAR_LISP ("data-directory", Vdata_directory
,
1683 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1684 These are files intended for Emacs to use while it runs. */);
1686 DEFVAR_LISP ("doc-directory", Vdoc_directory
,
1687 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1688 This is usually the same as `data-directory'. */);
1690 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory
,
1691 doc
: /* For internal use by the build procedure only.
1692 This is the name of the directory in which the build procedure installed
1693 Emacs's info files; the default value for `Info-default-directory-list'
1695 Vconfigure_info_directory
= build_string (PATH_INFO
);
1697 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory
,
1698 doc
: /* Directory of score files for games which come with GNU Emacs.
1699 If this variable is nil, then Emacs is unable to use a shared directory. */);
1701 DEFVAR_LISP ("initial-environment", Vinitial_environment
,
1702 doc
: /* List of environment variables inherited from the parent process.
1703 Each element should be a string of the form ENVVARNAME=VALUE.
1704 The elements must normally be decoded (using `locale-coding-system') for use. */);
1705 Vinitial_environment
= Qnil
;
1707 DEFVAR_LISP ("process-environment", Vprocess_environment
,
1708 doc
: /* List of overridden environment variables for subprocesses to inherit.
1709 Each element should be a string of the form ENVVARNAME=VALUE.
1711 Entries in this list take precedence to those in the frame-local
1712 environments. Therefore, let-binding `process-environment' is an easy
1713 way to temporarily change the value of an environment variable,
1714 irrespective of where it comes from. To use `process-environment' to
1715 remove an environment variable, include only its name in the list,
1718 This variable is set to nil when Emacs starts.
1720 If multiple entries define the same variable, the first one always
1723 Non-ASCII characters are encoded according to the initial value of
1724 `locale-coding-system', i.e. the elements must normally be decoded for
1727 See `setenv' and `getenv'. */);
1728 Vprocess_environment
= Qnil
;
1730 defsubr (&Scall_process
);
1731 defsubr (&Sgetenv_internal
);
1732 defsubr (&Scall_process_region
);