1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2017 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 <http://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
, Qnil
);
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 wait_for_termination (synch_process_pid
, 0, 1);
207 synch_process_pid
= 0;
208 message1 ("Waiting for process to die...done");
214 static mode_t
const default_output_mode
= S_IREAD
| S_IWRITE
;
216 static mode_t
const default_output_mode
= 0666;
219 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
220 doc
: /* Call PROGRAM synchronously in separate process.
221 The remaining arguments are optional.
222 The program's input comes from file INFILE (nil means `/dev/null').
223 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
224 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
225 FILE is a file name string, means that it should be written to that file
226 (if the file already exists it is overwritten).
227 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
228 REAL-BUFFER says what to do with standard output, as above,
229 while STDERR-FILE says what to do with standard error in the child.
230 STDERR-FILE may be nil (discard standard error output),
231 t (mix it with ordinary output), or a file name string.
233 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
234 Remaining arguments are strings passed as command arguments to PROGRAM.
236 If executable PROGRAM can't be found as an executable, `call-process'
237 signals a Lisp error. `call-process' reports errors in execution of
238 the program only through its return and output.
240 If DESTINATION is 0, `call-process' returns immediately with value nil.
241 Otherwise it waits for PROGRAM to terminate
242 and returns a numeric exit status or a signal description string.
243 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
245 The process runs in `default-directory' if that is local (as
246 determined by `unhandled-file-name-directory'), or "~" otherwise. If
247 you want to run a process in a remote directory use `process-file'.
249 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
250 (ptrdiff_t nargs
, Lisp_Object
*args
)
252 Lisp_Object infile
, encoded_infile
;
254 ptrdiff_t count
= SPECPDL_INDEX ();
256 if (nargs
>= 2 && ! NILP (args
[1]))
258 infile
= Fexpand_file_name (args
[1], BVAR (current_buffer
, directory
));
259 CHECK_STRING (infile
);
262 infile
= build_string (NULL_DEVICE
);
264 encoded_infile
= ENCODE_FILE (infile
);
266 filefd
= emacs_open (SSDATA (encoded_infile
), O_RDONLY
, 0);
268 report_file_error ("Opening process input file", infile
);
269 record_unwind_protect_int (close_file_unwind
, filefd
);
270 return unbind_to (count
, call_process (nargs
, args
, filefd
, -1));
273 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
275 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
276 unwinder that is intended to remove the input temporary file; in
277 this case NARGS must be at least 2 and ARGS[1] is the file's name.
279 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
282 call_process (ptrdiff_t nargs
, Lisp_Object
*args
, int filefd
,
283 ptrdiff_t tempfile_index
)
285 Lisp_Object buffer
, current_dir
, path
;
288 int callproc_fd
[CALLPROC_FDS
];
291 ptrdiff_t count
= SPECPDL_INDEX ();
295 /* File to use for stderr in the child.
296 t means use same as standard output. */
297 Lisp_Object error_file
;
298 Lisp_Object output_file
= Qnil
;
299 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
300 char *tempfile
= NULL
;
306 int fd_output
, fd_error
;
307 struct coding_system process_coding
; /* coding-system of process output */
308 struct coding_system argument_coding
; /* coding-system of arguments */
309 /* Set to the return value of Ffind_operation_coding_system. */
310 Lisp_Object coding_systems
;
313 if (synch_process_pid
)
314 error ("call-process invoked recursively");
316 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
319 CHECK_STRING (args
[0]);
324 /* Without asynchronous processes we cannot have BUFFER == 0. */
326 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
327 error ("Operating system cannot handle asynchronous subprocesses");
328 #endif /* subprocesses */
330 /* Decide the coding-system for giving arguments. */
332 Lisp_Object val
, *args2
;
334 /* If arguments are supplied, we may have to encode them. */
337 bool must_encode
= 0;
338 Lisp_Object coding_attrs
;
340 for (i
= 4; i
< nargs
; i
++)
341 CHECK_STRING (args
[i
]);
343 for (i
= 4; i
< nargs
; i
++)
344 if (STRING_MULTIBYTE (args
[i
]))
347 if (!NILP (Vcoding_system_for_write
))
348 val
= Vcoding_system_for_write
;
349 else if (! must_encode
)
353 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
354 args2
[0] = Qcall_process
;
355 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
356 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
357 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
359 val
= complement_process_encoding_system (val
);
360 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
361 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
362 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
364 /* We should not use an ASCII incompatible coding system. */
365 val
= raw_text_coding_system (val
);
366 setup_coding_system (val
, &argument_coding
);
377 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
378 FILE-FOR-STDERR), unless the first element is :file, in which case see
379 the next paragraph. */
380 if (CONSP (buffer
) && !EQ (XCAR (buffer
), QCfile
))
382 if (CONSP (XCDR (buffer
)))
384 Lisp_Object stderr_file
;
385 stderr_file
= XCAR (XCDR (buffer
));
387 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
388 error_file
= stderr_file
;
390 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
393 buffer
= XCAR (buffer
);
396 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
397 if (CONSP (buffer
) && EQ (XCAR (buffer
), QCfile
))
399 output_file
= Fexpand_file_name (XCAR (XCDR (buffer
)),
400 BVAR (current_buffer
, directory
));
401 CHECK_STRING (output_file
);
405 if (! (NILP (buffer
) || EQ (buffer
, Qt
) || INTEGERP (buffer
)))
407 Lisp_Object spec_buffer
;
408 spec_buffer
= buffer
;
409 buffer
= Fget_buffer_create (buffer
);
410 /* Mention the buffer name for a better error message. */
412 CHECK_BUFFER (spec_buffer
);
413 CHECK_BUFFER (buffer
);
417 /* Make sure that the child will be able to chdir to the current
418 buffer's current directory, or its unhandled equivalent. We
419 can't just have the child check for an error when it does the
420 chdir, since it's in a vfork. */
421 current_dir
= encode_current_directory ();
423 if (STRINGP (error_file
))
424 error_file
= ENCODE_FILE (error_file
);
425 if (STRINGP (output_file
))
426 output_file
= ENCODE_FILE (output_file
);
428 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
430 for (i
= 0; i
< CALLPROC_FDS
; i
++)
433 synch_process_tempfile
= make_number (0);
435 record_unwind_protect_ptr (call_process_kill
, callproc_fd
);
437 /* Search for program; barf if not found. */
441 ok
= openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
,
442 make_number (X_OK
), false);
444 report_file_error ("Searching for program", args
[0]);
447 /* Remove "/:" from PATH. */
448 path
= remove_slash_colon (path
);
450 SAFE_NALLOCA (new_argv
, 1, nargs
< 4 ? 2 : nargs
- 2);
456 argument_coding
.dst_multibyte
= 0;
457 for (i
= 4; i
< nargs
; i
++)
459 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
460 if (CODING_REQUIRE_ENCODING (&argument_coding
))
461 /* We must encode this argument. */
462 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
464 for (i
= 4; i
< nargs
; i
++)
465 new_argv
[i
- 3] = SSDATA (args
[i
]);
470 path
= ENCODE_FILE (path
);
471 new_argv
[0] = SSDATA (path
);
473 discard_output
= INTEGERP (buffer
) || (NILP (buffer
) && NILP (output_file
));
476 if (! discard_output
&& ! STRINGP (output_file
))
478 char const *tmpdir
= egetenv ("TMPDIR");
479 char const *outf
= tmpdir
? tmpdir
: "";
480 tempfile
= alloca (strlen (outf
) + 20);
481 strcpy (tempfile
, outf
);
482 dostounix_filename (tempfile
);
483 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
484 strcat (tempfile
, "/");
485 strcat (tempfile
, "emXXXXXX");
488 report_file_error ("Opening process output file", Qnil
);
489 output_file
= build_string (tempfile
);
490 synch_process_tempfile
= output_file
;
496 fd_output
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
498 report_file_error ("Opening null device", Qnil
);
500 else if (STRINGP (output_file
))
502 fd_output
= emacs_open (SSDATA (output_file
),
503 O_WRONLY
| O_CREAT
| O_TRUNC
| O_TEXT
,
504 default_output_mode
);
507 int open_errno
= errno
;
508 output_file
= DECODE_FILE (output_file
);
509 report_file_errno ("Opening process output file",
510 output_file
, open_errno
);
516 if (emacs_pipe (fd
) != 0)
517 report_file_error ("Creating process pipe", Qnil
);
518 callproc_fd
[CALLPROC_PIPEREAD
] = fd
[0];
521 callproc_fd
[CALLPROC_STDOUT
] = fd_output
;
523 fd_error
= fd_output
;
525 if (STRINGP (error_file
) || (NILP (error_file
) && !discard_output
))
527 fd_error
= emacs_open ((STRINGP (error_file
)
528 ? SSDATA (error_file
)
530 O_WRONLY
| O_CREAT
| O_TRUNC
| O_TEXT
,
531 default_output_mode
);
534 int open_errno
= errno
;
535 report_file_errno ("Cannot redirect stderr",
536 (STRINGP (error_file
)
537 ? DECODE_FILE (error_file
)
538 : build_string (NULL_DEVICE
)),
541 callproc_fd
[CALLPROC_STDERR
] = fd_error
;
544 #ifdef MSDOS /* MW, July 1993 */
545 status
= child_setup (filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
550 unbind_to (count
, Qnil
);
551 synchronize_system_messages_locale ();
553 code_convert_string_norecord (build_string (strerror (child_errno
)),
554 Vlocale_coding_system
, 0);
557 for (i
= 0; i
< CALLPROC_FDS
; i
++)
558 if (0 <= callproc_fd
[i
])
560 emacs_close (callproc_fd
[i
]);
563 emacs_close (filefd
);
564 clear_unwind_protect (count
- 1);
568 /* Since CRLF is converted to LF within `decode_coding', we
569 can always open a file with binary mode. */
570 callproc_fd
[CALLPROC_PIPEREAD
] = emacs_open (tempfile
, O_RDONLY
, 0);
571 if (callproc_fd
[CALLPROC_PIPEREAD
] < 0)
573 int open_errno
= errno
;
574 report_file_errno ("Cannot re-open temporary file",
575 build_string (tempfile
), open_errno
);
581 /* Do the unwind-protect now, even though the pid is not known, so
582 that no storage allocation is done in the critical section.
583 The actual PID will be filled in during the critical section. */
584 record_unwind_protect (call_process_cleanup
, Fcurrent_buffer ());
589 block_child_signal (&oldset
);
592 pid
= child_setup (filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
593 #else /* not WINDOWSNT */
595 /* vfork, and prevent local vars from being clobbered by the vfork. */
597 Lisp_Object
volatile buffer_volatile
= buffer
;
598 Lisp_Object
volatile coding_systems_volatile
= coding_systems
;
599 Lisp_Object
volatile current_dir_volatile
= current_dir
;
600 bool volatile display_p_volatile
= display_p
;
601 bool volatile sa_must_free_volatile
= sa_must_free
;
602 int volatile fd_error_volatile
= fd_error
;
603 int volatile filefd_volatile
= filefd
;
604 ptrdiff_t volatile count_volatile
= count
;
605 ptrdiff_t volatile sa_avail_volatile
= sa_avail
;
606 ptrdiff_t volatile sa_count_volatile
= sa_count
;
607 char **volatile new_argv_volatile
= new_argv
;
608 int volatile callproc_fd_volatile
[CALLPROC_FDS
];
609 for (i
= 0; i
< CALLPROC_FDS
; i
++)
610 callproc_fd_volatile
[i
] = callproc_fd
[i
];
614 buffer
= buffer_volatile
;
615 coding_systems
= coding_systems_volatile
;
616 current_dir
= current_dir_volatile
;
617 display_p
= display_p_volatile
;
618 sa_must_free
= sa_must_free_volatile
;
619 fd_error
= fd_error_volatile
;
620 filefd
= filefd_volatile
;
621 count
= count_volatile
;
622 sa_avail
= sa_avail_volatile
;
623 sa_count
= sa_count_volatile
;
624 new_argv
= new_argv_volatile
;
626 for (i
= 0; i
< CALLPROC_FDS
; i
++)
627 callproc_fd
[i
] = callproc_fd_volatile
[i
];
628 fd_output
= callproc_fd
[CALLPROC_STDOUT
];
633 unblock_child_signal (&oldset
);
636 /* Darwin doesn't let us run setsid after a vfork, so use
637 TIOCNOTTY when necessary. */
638 int j
= emacs_open (DEV_TTY
, O_RDWR
, 0);
641 ioctl (j
, TIOCNOTTY
, 0);
648 /* Emacs ignores SIGPIPE, but the child should not. */
649 signal (SIGPIPE
, SIG_DFL
);
650 /* Likewise for SIGPROF. */
652 signal (SIGPROF
, SIG_DFL
);
655 child_setup (filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
658 #endif /* not WINDOWSNT */
664 synch_process_pid
= pid
;
666 if (INTEGERP (buffer
))
668 if (tempfile_index
< 0)
669 record_deleted_pid (pid
, Qnil
);
673 record_deleted_pid (pid
, args
[1]);
674 clear_unwind_protect (tempfile_index
);
676 synch_process_pid
= 0;
680 unblock_child_signal (&oldset
);
684 report_file_errno ("Doing vfork", Qnil
, child_errno
);
686 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
687 since we will use that to read input from. */
688 for (i
= 0; i
< CALLPROC_FDS
; i
++)
689 if (i
!= CALLPROC_PIPEREAD
&& 0 <= callproc_fd
[i
])
691 emacs_close (callproc_fd
[i
]);
694 emacs_close (filefd
);
695 clear_unwind_protect (count
- 1);
697 #endif /* not MSDOS */
699 if (INTEGERP (buffer
))
700 return unbind_to (count
, Qnil
);
702 if (BUFFERP (buffer
))
703 Fset_buffer (buffer
);
705 fd0
= callproc_fd
[CALLPROC_PIPEREAD
];
709 Lisp_Object val
, *args2
;
712 if (!NILP (Vcoding_system_for_read
))
713 val
= Vcoding_system_for_read
;
716 if (EQ (coding_systems
, Qt
))
720 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
721 args2
[0] = Qcall_process
;
722 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
724 = Ffind_operation_coding_system (nargs
+ 1, args2
);
726 if (CONSP (coding_systems
))
727 val
= XCAR (coding_systems
);
728 else if (CONSP (Vdefault_process_coding_system
))
729 val
= XCAR (Vdefault_process_coding_system
);
733 Fcheck_coding_system (val
);
734 /* In unibyte mode, character code conversion should not take
735 place but EOL conversion should. So, setup raw-text or one
736 of the subsidiary according to the information just setup. */
737 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
739 val
= raw_text_coding_system (val
);
740 setup_coding_system (val
, &process_coding
);
741 process_coding
.dst_multibyte
742 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
743 process_coding
.src_multibyte
= 0;
748 enum { CALLPROC_BUFFER_SIZE_MIN
= 16 * 1024 };
749 enum { CALLPROC_BUFFER_SIZE_MAX
= 4 * CALLPROC_BUFFER_SIZE_MIN
};
750 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
751 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
753 EMACS_INT total_read
= 0;
755 bool display_on_the_fly
= display_p
;
756 struct coding_system saved_coding
= process_coding
;
760 /* Repeatedly read until we've filled as much as possible
761 of the buffer size we have. But don't read
762 less than 1024--save that for the next bufferful. */
764 while (nread
< bufsize
- 1024)
766 int this_read
= emacs_read_quit (fd0
, buf
+ nread
,
774 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
779 total_read
+= this_read
;
781 if (display_on_the_fly
)
785 /* Now NREAD is the total amount of data in the buffer. */
789 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
790 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
791 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
793 { /* We have to decode the input. */
795 ptrdiff_t count1
= SPECPDL_INDEX ();
797 XSETBUFFER (curbuf
, current_buffer
);
798 /* FIXME: Call signal_after_change! */
799 prepare_to_modify_buffer (PT
, PT
, NULL
);
800 /* We cannot allow after-change-functions be run
801 during decoding, because that might modify the
802 buffer, while we rely on process_coding.produced to
803 faithfully reflect inserted text until we
804 TEMP_SET_PT_BOTH below. */
805 specbind (Qinhibit_modification_hooks
, Qt
);
806 decode_coding_c_string (&process_coding
,
807 (unsigned char *) buf
, nread
, curbuf
);
808 unbind_to (count1
, Qnil
);
809 if (display_on_the_fly
810 && CODING_REQUIRE_DETECTION (&saved_coding
)
811 && ! CODING_REQUIRE_DETECTION (&process_coding
))
813 /* We have detected some coding system, but the
814 detection may have been via insufficient data.
815 So give up displaying on the fly. */
816 if (process_coding
.produced
> 0)
817 del_range_2 (process_coding
.dst_pos
,
818 process_coding
.dst_pos_byte
,
819 (process_coding
.dst_pos
820 + process_coding
.produced_char
),
821 (process_coding
.dst_pos_byte
822 + process_coding
.produced
),
824 display_on_the_fly
= false;
825 process_coding
= saved_coding
;
827 /* Make the above condition always fail in the future. */
828 saved_coding
.common_flags
829 &= ~CODING_REQUIRE_DETECTION_MASK
;
833 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
834 PT_BYTE
+ process_coding
.produced
);
835 carryover
= process_coding
.carryover_bytes
;
837 memcpy (buf
, process_coding
.carryover
,
838 process_coding
.carryover_bytes
);
841 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
844 /* Make the buffer bigger as we continue to read more data,
845 but not past CALLPROC_BUFFER_SIZE_MAX. */
846 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
847 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
848 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
852 redisplay_preserve_echo_area (1);
853 /* This variable might have been set to 0 for code
854 detection. In that case, set it back to 1 because
855 we should have already detected a coding system. */
856 display_on_the_fly
= true;
861 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
862 /* If the caller required, let the buffer inherit the
863 coding-system used to decode the process output. */
864 if (inherit_process_coding_system
)
865 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
866 make_number (total_read
));
870 /* Wait for it to terminate, unless it already has. */
871 wait_for_termination (pid
, &status
, fd0
< 0);
874 /* Don't kill any children that the subprocess may have left behind
876 synch_process_pid
= 0;
879 unbind_to (count
, Qnil
);
881 if (WIFSIGNALED (status
))
885 synchronize_system_messages_locale ();
886 signame
= strsignal (WTERMSIG (status
));
891 return code_convert_string_norecord (build_string (signame
),
892 Vlocale_coding_system
, 0);
895 eassert (WIFEXITED (status
));
896 return make_number (WEXITSTATUS (status
));
899 /* Create a temporary file suitable for storing the input data of
900 call-process-region. NARGS and ARGS are the same as for
901 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
902 naming the file, and return a file descriptor for reading.
903 Unwind-protect the file, so that the file descriptor will be closed
904 and the file removed when the caller unwinds the specpdl stack. */
907 create_temp_file (ptrdiff_t nargs
, Lisp_Object
*args
,
908 Lisp_Object
*filename_string_ptr
)
911 Lisp_Object filename_string
;
912 Lisp_Object val
, start
, end
;
915 if (STRINGP (Vtemporary_file_directory
))
916 tmpdir
= Vtemporary_file_directory
;
921 outf
= getenv ("TMPDIR");
922 tmpdir
= build_string (outf
? outf
: "/tmp/");
924 if ((outf
= egetenv ("TMPDIR"))
925 || (outf
= egetenv ("TMP"))
926 || (outf
= egetenv ("TEMP")))
927 tmpdir
= build_string (outf
);
929 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
934 Lisp_Object pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
939 /* Cannot use the result of Fexpand_file_name, because it
940 downcases the XXXXXX part of the pattern, and mktemp then
941 doesn't recognize it. */
942 if (!NILP (Vw32_downcase_file_names
))
944 Lisp_Object dirname
= Ffile_name_directory (pattern
);
947 pattern
= Vtemp_file_name_pattern
;
949 pattern
= concat2 (dirname
, Vtemp_file_name_pattern
);
953 filename_string
= Fcopy_sequence (ENCODE_FILE (pattern
));
954 tempfile
= SSDATA (filename_string
);
956 count
= SPECPDL_INDEX ();
957 record_unwind_protect_nothing ();
958 fd
= mkostemp (tempfile
, O_BINARY
| O_CLOEXEC
);
960 report_file_error ("Failed to open temporary file using pattern",
962 set_unwind_protect (count
, delete_temp_file
, filename_string
);
963 record_unwind_protect_int (close_file_unwind
, fd
);
968 /* Decide coding-system of the contents of the temporary file. */
969 if (!NILP (Vcoding_system_for_write
))
970 val
= Vcoding_system_for_write
;
971 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
975 Lisp_Object coding_systems
;
978 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
979 args2
[0] = Qcall_process_region
;
980 memcpy (args2
+ 1, args
, nargs
* sizeof *args
);
981 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
982 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
985 val
= complement_process_encoding_system (val
);
988 ptrdiff_t count1
= SPECPDL_INDEX ();
990 specbind (intern ("coding-system-for-write"), val
);
991 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
992 happen to get a ".Z" suffix. */
993 specbind (Qfile_name_handler_alist
, Qnil
);
994 write_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
, fd
);
996 unbind_to (count1
, Qnil
);
999 if (lseek (fd
, 0, SEEK_SET
) < 0)
1000 report_file_error ("Setting file position", filename_string
);
1002 /* Note that Fcall_process takes care of binding
1003 coding-system-for-read. */
1005 *filename_string_ptr
= filename_string
;
1009 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1011 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1013 START and END are normally buffer positions specifying the part of the
1014 buffer to send to the process.
1015 If START is nil, that means to use the entire buffer contents; END is
1017 If START is a string, then send that string to the process
1018 instead of any buffer contents; END is ignored.
1019 The remaining arguments are optional.
1020 Delete the text if fourth arg DELETE is non-nil.
1022 Insert output in BUFFER before point; t means current buffer; nil for
1023 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1024 FILE)', where FILE is a file name string, means that it should be
1025 written to that file (if the file already exists it is overwritten).
1026 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1027 REAL-BUFFER says what to do with standard output, as above,
1028 while STDERR-FILE says what to do with standard error in the child.
1029 STDERR-FILE may be nil (discard standard error output),
1030 t (mix it with ordinary output), or a file name string.
1032 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1033 Remaining args are passed to PROGRAM at startup as command args.
1035 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1036 Otherwise it waits for PROGRAM to terminate
1037 and returns a numeric exit status or a signal description string.
1038 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1040 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1041 (ptrdiff_t nargs
, Lisp_Object
*args
)
1043 Lisp_Object infile
, val
;
1044 ptrdiff_t count
= SPECPDL_INDEX ();
1045 Lisp_Object start
= args
[0];
1046 Lisp_Object end
= args
[1];
1050 if (STRINGP (start
))
1051 empty_input
= SCHARS (start
) == 0;
1052 else if (NILP (start
))
1053 empty_input
= BEG
== Z
;
1056 validate_region (&args
[0], &args
[1]);
1059 empty_input
= XINT (start
) == XINT (end
);
1063 fd
= create_temp_file (nargs
, args
, &infile
);
1067 fd
= emacs_open (NULL_DEVICE
, O_RDONLY
, 0);
1069 report_file_error ("Opening null device", Qnil
);
1070 record_unwind_protect_int (close_file_unwind
, fd
);
1073 if (nargs
> 3 && !NILP (args
[3]))
1074 Fdelete_region (start
, end
);
1088 val
= call_process (nargs
, args
, fd
, empty_input
? -1 : count
);
1089 return unbind_to (count
, val
);
1093 add_env (char **env
, char **new_env
, char *string
)
1100 /* See if this string duplicates any string already in the env.
1101 If so, don't put it in.
1102 When an env var has multiple definitions,
1103 we keep the definition that comes first in process-environment. */
1104 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1106 char *p
= *ep
, *q
= string
;
1112 /* The string is a lone variable name; keep it for now, we
1113 will remove it later. It is a placeholder for a
1114 variable that is not to be included in the environment. */
1122 *new_env
++ = string
;
1128 /* 'exec' failed inside a child running NAME, with error number ERR.
1129 Possibly a vforked child needed to allocate a large vector on the
1130 stack; such a child cannot fall back on malloc because that might
1131 mess up the allocator's data structures in the parent.
1132 Report the error and exit the child. */
1134 static _Noreturn
void
1135 exec_failed (char const *name
, int err
)
1137 /* Avoid deadlock if the child's perror writes to a full pipe; the
1138 pipe's reader is the parent, but with vfork the parent can't
1139 run until the child exits. Truncate the diagnostic instead. */
1140 fcntl (STDERR_FILENO
, F_SETFL
, O_NONBLOCK
);
1143 emacs_perror (name
);
1144 _exit (err
== ENOENT
? EXIT_ENOENT
: EXIT_CANNOT_INVOKE
);
1149 /* Do nothing. There is no need to fail, as DOS_NT platforms do not
1150 fork and exec, and handle alloca exhaustion in a different way. */
1153 exec_failed (char const *name
, int err
)
1159 /* This is the last thing run in a newly forked inferior
1160 either synchronous or asynchronous.
1161 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1162 Initialize inferior's priority, pgrp, connected dir and environment.
1163 then exec another program based on new_argv.
1165 If SET_PGRP, put the subprocess into a separate process group.
1167 CURRENT_DIR is an elisp string giving the path of the current
1168 directory the subprocess should have. Since we can't really signal
1169 a decent error from within the child, this should be verified as an
1170 executable directory by the parent.
1172 On GNUish hosts, either exec or return an error number.
1173 On MS-Windows, either return a pid or signal an error.
1174 On MS-DOS, either return an exit status or signal an error. */
1177 child_setup (int in
, int out
, int err
, char **new_argv
, bool set_pgrp
,
1178 Lisp_Object current_dir
)
1186 pid_t pid
= getpid ();
1187 #endif /* WINDOWSNT */
1189 /* Note that use of alloca is always safe here. It's obvious for systems
1190 that do not have true vfork or that have true (stack) alloca.
1191 If using vfork and C_ALLOCA (when Emacs used to include
1192 src/alloca.c) it is safe because that changes the superior's
1193 static variables as if the superior had done alloca and will be
1194 cleaned up in the usual way. */
1199 i
= SBYTES (current_dir
);
1201 /* MSDOS must have all environment variables malloc'ed, because
1202 low-level libc functions that launch subsidiary processes rely
1204 pwd_var
= xmalloc (i
+ 5);
1206 if (MAX_ALLOCA
- 5 < i
)
1207 exec_failed (new_argv
[0], ENOMEM
);
1208 pwd_var
= alloca (i
+ 5);
1211 memcpy (pwd_var
, "PWD=", 4);
1212 lispstpcpy (temp
, current_dir
);
1215 /* We can't signal an Elisp error here; we're in a vfork. Since
1216 the callers check the current directory before forking, this
1217 should only return an error if the directory's permissions
1218 are changed between the check and this chdir, but we should
1220 if (chdir (temp
) < 0)
1221 _exit (EXIT_CANCELED
);
1223 /* Get past the drive letter, so that d:/ is left alone. */
1224 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1231 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1232 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1236 /* Set `env' to a vector of the strings in the environment. */
1238 register Lisp_Object tem
;
1239 register char **new_env
;
1241 register int new_length
;
1242 Lisp_Object display
= Qnil
;
1246 for (tem
= Vprocess_environment
;
1247 CONSP (tem
) && STRINGP (XCAR (tem
));
1250 if (strncmp (SSDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1251 && (SDATA (XCAR (tem
)) [7] == '\0'
1252 || SDATA (XCAR (tem
)) [7] == '='))
1253 /* DISPLAY is specified in process-environment. */
1258 /* If not provided yet, use the frame's DISPLAY. */
1261 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1262 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1263 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1264 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1265 Vinitial_environment
);
1273 /* new_length + 2 to include PWD and terminating 0. */
1274 if (MAX_ALLOCA
/ sizeof *env
- 2 < new_length
)
1275 exec_failed (new_argv
[0], ENOMEM
);
1276 env
= new_env
= alloca ((new_length
+ 2) * sizeof *env
);
1277 /* If we have a PWD envvar, pass one down,
1278 but with corrected value. */
1279 if (egetenv ("PWD"))
1280 *new_env
++ = pwd_var
;
1282 if (STRINGP (display
))
1284 if (MAX_ALLOCA
- sizeof "DISPLAY=" < SBYTES (display
))
1285 exec_failed (new_argv
[0], ENOMEM
);
1286 char *vdata
= alloca (sizeof "DISPLAY=" + SBYTES (display
));
1287 lispstpcpy (stpcpy (vdata
, "DISPLAY="), display
);
1288 new_env
= add_env (env
, new_env
, vdata
);
1292 for (tem
= Vprocess_environment
;
1293 CONSP (tem
) && STRINGP (XCAR (tem
));
1295 new_env
= add_env (env
, new_env
, SSDATA (XCAR (tem
)));
1299 /* Remove variable names without values. */
1303 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1313 prepare_standard_handles (in
, out
, err
, handles
);
1314 set_process_dir (SSDATA (current_dir
));
1315 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1316 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1317 reset_standard_handles (in
, out
, err
, handles
);
1319 /* An error occurred while trying to spawn the process. */
1320 report_file_error ("Spawning child process", Qnil
);
1323 #else /* not WINDOWSNT */
1327 restore_nofile_limit ();
1329 /* Redirect file descriptors and clear the close-on-exec flag on the
1330 redirected ones. IN, OUT, and ERR are close-on-exec so they
1331 need not be closed explicitly. */
1332 dup2 (in
, STDIN_FILENO
);
1333 dup2 (out
, STDOUT_FILENO
);
1334 dup2 (err
, STDERR_FILENO
);
1339 int errnum
= emacs_exec_file (new_argv
[0], new_argv
, env
);
1340 exec_failed (new_argv
[0], errnum
);
1343 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1346 /* An error occurred while trying to run the subprocess. */
1347 report_file_error ("Spawning child process", Qnil
);
1350 #endif /* not WINDOWSNT */
1354 getenv_internal_1 (const char *var
, ptrdiff_t varlen
, char **value
,
1355 ptrdiff_t *valuelen
, Lisp_Object env
)
1357 for (; CONSP (env
); env
= XCDR (env
))
1359 Lisp_Object entry
= XCAR (env
);
1361 && SBYTES (entry
) >= varlen
1363 /* NT environment variables are case insensitive. */
1364 && ! strnicmp (SSDATA (entry
), var
, varlen
)
1365 #else /* not WINDOWSNT */
1366 && ! memcmp (SDATA (entry
), var
, varlen
)
1367 #endif /* not WINDOWSNT */
1370 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1372 *value
= SSDATA (entry
) + (varlen
+ 1);
1373 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1376 else if (SBYTES (entry
) == varlen
)
1378 /* Lone variable names in Vprocess_environment mean that
1379 variable should be removed from the environment. */
1389 getenv_internal (const char *var
, ptrdiff_t varlen
, char **value
,
1390 ptrdiff_t *valuelen
, Lisp_Object frame
)
1392 /* Try to find VAR in Vprocess_environment first. */
1393 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1394 Vprocess_environment
))
1395 return *value
? 1 : 0;
1397 /* On Windows we make some modifications to Emacs' environment
1398 without recording them in Vprocess_environment. */
1401 char *tmpval
= getenv (var
);
1405 *valuelen
= strlen (tmpval
);
1411 /* For DISPLAY try to get the values from the frame or the initial env. */
1412 if (strcmp (var
, "DISPLAY") == 0)
1415 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1416 if (STRINGP (display
))
1418 *value
= SSDATA (display
);
1419 *valuelen
= SBYTES (display
);
1422 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1423 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1424 Vinitial_environment
))
1425 return *value
? 1 : 0;
1431 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1432 doc
: /* Get the value of environment variable VARIABLE.
1433 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1434 the environment. Otherwise, value is a string.
1436 This function searches `process-environment' for VARIABLE.
1438 If optional parameter ENV is a list, then search this list instead of
1439 `process-environment', and return t when encountering a negative entry
1440 \(an entry for a variable with no value). */)
1441 (Lisp_Object variable
, Lisp_Object env
)
1446 CHECK_STRING (variable
);
1449 if (getenv_internal_1 (SSDATA (variable
), SBYTES (variable
),
1450 &value
, &valuelen
, env
))
1451 return value
? make_string (value
, valuelen
) : Qt
;
1455 else if (getenv_internal (SSDATA (variable
), SBYTES (variable
),
1456 &value
, &valuelen
, env
))
1457 return make_string (value
, valuelen
);
1462 /* A version of getenv that consults the Lisp environment lists,
1463 easily callable from C. This is usually called from egetenv. */
1465 egetenv_internal (const char *var
, ptrdiff_t len
)
1470 if (getenv_internal (var
, len
, &value
, &valuelen
, Qnil
))
1477 /* This is run before init_cmdargs. */
1480 init_callproc_1 (void)
1483 const char *etc_dir
= ns_etc_directory ();
1484 const char *path_exec
= ns_exec_path ();
1487 Vdata_directory
= decode_env_path ("EMACSDATA",
1492 Vdata_directory
= Ffile_name_as_directory (Fcar (Vdata_directory
));
1494 Vdoc_directory
= decode_env_path ("EMACSDOC",
1499 Vdoc_directory
= Ffile_name_as_directory (Fcar (Vdoc_directory
));
1501 /* Check the EMACSPATH environment variable, defaulting to the
1502 PATH_EXEC path from epaths.h. */
1503 Vexec_path
= decode_env_path ("EMACSPATH",
1505 path_exec
? path_exec
:
1508 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1509 /* FIXME? For ns, path_exec should go at the front? */
1510 Vexec_path
= nconc2 (decode_env_path ("PATH", "", 0), Vexec_path
);
1513 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1516 init_callproc (void)
1518 bool data_dir
= egetenv ("EMACSDATA") != 0;
1521 Lisp_Object tempdir
;
1524 data_dir
= ns_etc_directory () != 0;
1527 if (!NILP (Vinstallation_directory
))
1529 /* Add to the path the lib-src subdir of the installation dir. */
1531 tem
= Fexpand_file_name (build_string ("lib-src"),
1532 Vinstallation_directory
);
1534 /* MSDOS uses wrapped binaries, so don't do this. */
1535 if (NILP (Fmember (tem
, Vexec_path
)))
1538 const char *path_exec
= ns_exec_path ();
1540 /* Running uninstalled, so default to tem rather than PATH_EXEC. */
1541 Vexec_path
= decode_env_path ("EMACSPATH",
1543 path_exec
? path_exec
:
1546 Vexec_path
= nconc2 (decode_env_path ("PATH", "", 0), Vexec_path
);
1549 Vexec_directory
= Ffile_name_as_directory (tem
);
1550 #endif /* not MSDOS */
1552 /* Maybe use ../etc as well as ../lib-src. */
1555 tem
= Fexpand_file_name (build_string ("etc"),
1556 Vinstallation_directory
);
1557 Vdoc_directory
= Ffile_name_as_directory (tem
);
1561 /* Look for the files that should be in etc. We don't use
1562 Vinstallation_directory, because these files are never installed
1563 near the executable, and they are never in the build
1564 directory when that's different from the source directory.
1566 Instead, if these files are not in the nominal place, we try the
1567 source directory. */
1570 Lisp_Object tem
, tem1
, srcdir
;
1571 Lisp_Object lispdir
= Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH
, 0));
1573 srcdir
= Fexpand_file_name (build_string ("../src/"), lispdir
);
1575 tem
= Fexpand_file_name (build_string ("NEWS"), Vdata_directory
);
1576 tem1
= Ffile_exists_p (tem
);
1577 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1580 newdir
= Fexpand_file_name (build_string ("../etc/"), lispdir
);
1581 tem
= Fexpand_file_name (build_string ("NEWS"), newdir
);
1582 tem1
= Ffile_exists_p (tem
);
1584 Vdata_directory
= newdir
;
1592 tempdir
= Fdirectory_file_name (Vexec_directory
);
1593 if (! file_accessible_directory_p (tempdir
))
1594 dir_warning ("arch-dependent data dir", Vexec_directory
);
1597 tempdir
= Fdirectory_file_name (Vdata_directory
);
1598 if (! file_accessible_directory_p (tempdir
))
1599 dir_warning ("arch-independent data dir", Vdata_directory
);
1601 sh
= getenv ("SHELL");
1602 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1604 Lisp_Object gamedir
= Qnil
;
1607 Lisp_Object path_game
= build_unibyte_string (PATH_GAME
);
1608 if (file_accessible_directory_p (path_game
))
1609 gamedir
= path_game
;
1611 Vshared_game_score_directory
= gamedir
;
1615 set_initial_environment (void)
1618 for (envp
= environ
; *envp
; envp
++)
1619 Vprocess_environment
= Fcons (build_string (*envp
),
1620 Vprocess_environment
);
1621 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1622 to use `delete' and friends on process-environment. */
1623 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1627 syms_of_callproc (void)
1630 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1632 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1634 staticpro (&Vtemp_file_name_pattern
);
1637 synch_process_tempfile
= make_number (0);
1638 staticpro (&synch_process_tempfile
);
1641 DEFVAR_LISP ("shell-file-name", Vshell_file_name
,
1642 doc
: /* File name to load inferior shells from.
1643 Initialized from the SHELL environment variable, or to a system-dependent
1644 default if SHELL is unset. See Info node `(elisp)Security Considerations'. */);
1646 DEFVAR_LISP ("exec-path", Vexec_path
,
1647 doc
: /* List of directories to search programs to run in subprocesses.
1648 Each element is a string (directory name) or nil (try default directory).
1650 By default the last element of this list is `exec-directory'. The
1651 last element is not always used, for example in shell completion
1652 \(`shell-dynamic-complete-command'). */);
1654 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes
,
1655 doc
: /* List of suffixes to try to find executable file names.
1656 Each element is a string. */);
1657 Vexec_suffixes
= Qnil
;
1659 DEFVAR_LISP ("exec-directory", Vexec_directory
,
1660 doc
: /* Directory for executables for Emacs to invoke.
1661 More generally, this includes any architecture-dependent files
1662 that are built and installed from the Emacs distribution. */);
1664 DEFVAR_LISP ("data-directory", Vdata_directory
,
1665 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1666 These are files intended for Emacs to use while it runs. */);
1668 DEFVAR_LISP ("doc-directory", Vdoc_directory
,
1669 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1670 This is usually the same as `data-directory'. */);
1672 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory
,
1673 doc
: /* For internal use by the build procedure only.
1674 This is the name of the directory in which the build procedure installed
1675 Emacs's info files; the default value for `Info-default-directory-list'
1677 Vconfigure_info_directory
= build_string (PATH_INFO
);
1679 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory
,
1680 doc
: /* Directory of score files for games which come with GNU Emacs.
1681 If this variable is nil, then Emacs is unable to use a shared directory. */);
1683 DEFVAR_LISP ("initial-environment", Vinitial_environment
,
1684 doc
: /* List of environment variables inherited from the parent process.
1685 Each element should be a string of the form ENVVARNAME=VALUE.
1686 The elements must normally be decoded (using `locale-coding-system') for use. */);
1687 Vinitial_environment
= Qnil
;
1689 DEFVAR_LISP ("process-environment", Vprocess_environment
,
1690 doc
: /* List of overridden environment variables for subprocesses to inherit.
1691 Each element should be a string of the form ENVVARNAME=VALUE.
1693 Entries in this list take precedence to those in the frame-local
1694 environments. Therefore, let-binding `process-environment' is an easy
1695 way to temporarily change the value of an environment variable,
1696 irrespective of where it comes from. To use `process-environment' to
1697 remove an environment variable, include only its name in the list,
1700 This variable is set to nil when Emacs starts.
1702 If multiple entries define the same variable, the first one always
1705 Non-ASCII characters are encoded according to the initial value of
1706 `locale-coding-system', i.e. the elements must normally be decoded for
1709 See `setenv' and `getenv'. */);
1710 Vprocess_environment
= Qnil
;
1712 defsubr (&Scall_process
);
1713 defsubr (&Sgetenv_internal
);
1714 defsubr (&Scall_process_region
);