1 /* Synchronous subprocess invocation for GNU Emacs.
3 Copyright (C) 1985-1988, 1993-1995, 1999-2014 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
11 (at 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/>. */
25 #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>
47 #include "character.h"
51 #include "composite.h"
54 #include "syssignal.h"
57 #include "blockinput.h"
59 #include "termhooks.h"
69 /* Pattern used by call-process-region to make temp files. */
70 static Lisp_Object Vtemp_file_name_pattern
;
72 /* The next two variables are used while record-unwind-protect is in place
73 during call-process for a subprocess for which record_deleted_pid has
74 not yet been called. At other times, synch_process_pid is zero and
75 synch_process_tempfile's contents are irrelevant. Doing this via static
76 C variables is more convenient than putting them into the arguments
77 of record-unwind-protect, as they need to be updated at randomish
78 times in the code, and Lisp cannot always store these values as
79 Emacs integers. It's safe to use static variables here, as the
80 code is never invoked reentrantly. */
82 /* If nonzero, a process-ID that has not been reaped. */
83 static pid_t synch_process_pid
;
85 static Lisp_Object synch_process_tempfile
;
87 /* Indexes of file descriptors that need closing on call_process_kill. */
90 /* The subsidiary process's stdout and stderr. stdin is handled
91 separately, in either Fcall_process_region or create_temp_file. */
92 CALLPROC_STDOUT
, CALLPROC_STDERR
,
94 /* How to read from a pipe (or substitute) from the subsidiary process. */
97 /* A bound on the number of file descriptors. */
101 static Lisp_Object
call_process (ptrdiff_t, Lisp_Object
*, int *, Lisp_Object
*);
103 /* Return the current buffer's working directory, or the home
104 directory if it's unreachable, as a string suitable for a system call.
105 Signal an error if the result would not be an accessible directory. */
108 encode_current_directory (void)
113 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 (STRING_MULTIBYTE (dir
))
126 dir
= ENCODE_FILE (dir
);
127 if (! file_accessible_directory_p (SSDATA (dir
)))
128 report_file_error ("Setting current directory",
129 BVAR (current_buffer
, directory
));
131 RETURN_UNGCPRO (dir
);
134 /* If P is reapable, record it as a deleted process and kill it.
135 Do this in a critical section. Unless PID is wedged it will be
136 reaped on receipt of the first SIGCHLD after the critical section. */
139 record_kill_process (struct Lisp_Process
*p
, Lisp_Object tempfile
)
143 block_child_signal (&oldset
);
147 record_deleted_pid (p
->pid
, tempfile
);
149 kill (- p
->pid
, SIGKILL
);
152 unblock_child_signal (&oldset
);
156 /* Clean up files, file descriptors and processes created by Fcall_process. */
159 delete_temp_file_ptr (Lisp_Object
*name_ptr
)
161 Lisp_Object name
= *name_ptr
;
163 unlink (SSDATA (name
));
167 call_process_kill (void *ptr
)
169 int *callproc_fd
= ptr
;
171 for (i
= 0; i
< CALLPROC_FDS
; i
++)
172 if (0 <= callproc_fd
[i
])
173 emacs_close (callproc_fd
[i
]);
175 if (synch_process_pid
)
177 struct Lisp_Process proc
;
179 proc
.pid
= synch_process_pid
;
180 record_kill_process (&proc
, synch_process_tempfile
);
181 synch_process_pid
= 0;
183 else if (STRINGP (synch_process_tempfile
))
184 delete_temp_file_ptr (&synch_process_tempfile
);
187 /* Clean up when exiting Fcall_process: restore the buffer, and
188 kill the subsidiary process group if the process still exists. */
191 call_process_cleanup (Lisp_Object buffer
)
193 Fset_buffer (buffer
);
196 if (synch_process_pid
)
198 kill (-synch_process_pid
, SIGINT
);
199 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
202 wait_for_termination (synch_process_pid
, 0, 1);
203 synch_process_pid
= 0;
205 message1 ("Waiting for process to die...done");
211 static mode_t
const default_output_mode
= S_IREAD
| S_IWRITE
;
213 static mode_t
const default_output_mode
= 0666;
216 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
217 doc
: /* Call PROGRAM synchronously in separate process.
218 The remaining arguments are optional.
219 The program's input comes from file INFILE (nil means `/dev/null').
220 Insert output in DESTINATION before point; t means current buffer; nil for DESTINATION
221 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
222 FILE is a file name string, means that it should be written to that file
223 \(if the file already exists it is overwritten).
224 DESTINATION can also have the form (REAL-BUFFER STDERR-FILE); in that case,
225 REAL-BUFFER says what to do with standard output, as above,
226 while STDERR-FILE says what to do with standard error in the child.
227 STDERR-FILE may be nil (discard standard error output),
228 t (mix it with ordinary output), or a file name string.
230 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
231 Remaining arguments are strings passed as command arguments to PROGRAM.
233 If executable PROGRAM can't be found as an executable, `call-process'
234 signals a Lisp error. `call-process' reports errors in execution of
235 the program only through its return and output.
237 If DESTINATION is 0, `call-process' returns immediately with value nil.
238 Otherwise it waits for PROGRAM to terminate
239 and returns a numeric exit status or a signal description string.
240 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
242 usage: (call-process PROGRAM &optional INFILE DESTINATION DISPLAY &rest ARGS) */)
243 (ptrdiff_t nargs
, Lisp_Object
*args
)
245 Lisp_Object infile
, encoded_infile
;
248 ptrdiff_t count
= SPECPDL_INDEX ();
250 if (nargs
>= 2 && ! NILP (args
[1]))
252 infile
= Fexpand_file_name (args
[1], BVAR (current_buffer
, directory
));
253 CHECK_STRING (infile
);
256 infile
= build_string (NULL_DEVICE
);
259 encoded_infile
= STRING_MULTIBYTE (infile
) ? ENCODE_FILE (infile
) : infile
;
261 filefd
= emacs_open (SSDATA (encoded_infile
), O_RDONLY
, 0);
263 report_file_error ("Opening process input file", infile
);
264 record_unwind_protect_ptr (close_file_ptr_unwind
, &filefd
);
266 return unbind_to (count
, call_process (nargs
, args
, &filefd
, NULL
));
269 /* Like Fcall_process (NARGS, ARGS), except use FILEFD as the input file.
271 If TEMPFILE_INDEX is nonnegative, it is the specpdl index of an
272 unwinder that is intended to remove the input temporary file; in
273 this case NARGS must be at least 2 and ARGS[1] is the file's name.
275 At entry, the specpdl stack top entry must be close_file_unwind (FILEFD). */
278 call_process (ptrdiff_t nargs
, Lisp_Object
*args
, int *filefd
, Lisp_Object
*tempfile_ptr
)
280 Lisp_Object buffer
, current_dir
, path
;
283 int callproc_fd
[CALLPROC_FDS
];
289 /* File to use for stderr in the child.
290 t means use same as standard output. */
291 Lisp_Object error_file
;
292 Lisp_Object output_file
= Qnil
;
293 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
294 char *tempfile
= NULL
;
301 int fd_output
, fd_error
;
302 struct coding_system process_coding
; /* coding-system of process output */
303 struct coding_system argument_coding
; /* coding-system of arguments */
304 /* Set to the return value of Ffind_operation_coding_system. */
305 Lisp_Object coding_systems
;
310 if (synch_process_pid
)
311 error ("call-process invoked recursively");
313 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
316 CHECK_STRING (args
[0]);
321 /* Without asynchronous processes we cannot have BUFFER == 0. */
323 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
324 error ("Operating system cannot handle asynchronous subprocesses");
325 #endif /* subprocesses */
327 /* Decide the coding-system for giving arguments. */
329 Lisp_Object val
, *args2
;
331 /* If arguments are supplied, we may have to encode them. */
334 bool must_encode
= 0;
335 Lisp_Object coding_attrs
;
337 for (i
= 4; i
< nargs
; i
++)
338 CHECK_STRING (args
[i
]);
340 for (i
= 4; i
< nargs
; i
++)
341 if (STRING_MULTIBYTE (args
[i
]))
344 if (!NILP (Vcoding_system_for_write
))
345 val
= Vcoding_system_for_write
;
346 else if (! must_encode
)
350 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
351 args2
[0] = Qcall_process
;
352 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
353 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
354 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
356 val
= complement_process_encoding_system (val
);
357 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
358 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
359 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
361 /* We should not use an ASCII incompatible coding system. */
362 val
= raw_text_coding_system (val
);
363 setup_coding_system (val
, &argument_coding
);
374 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
375 FILE-FOR-STDERR), unless the first element is :file, in which case see
376 the next paragraph. */
377 if (CONSP (buffer
) && !EQ (XCAR (buffer
), QCfile
))
379 if (CONSP (XCDR (buffer
)))
381 Lisp_Object stderr_file
;
382 stderr_file
= XCAR (XCDR (buffer
));
384 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
385 error_file
= stderr_file
;
387 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
390 buffer
= XCAR (buffer
);
393 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
394 if (CONSP (buffer
) && EQ (XCAR (buffer
), QCfile
))
396 output_file
= Fexpand_file_name (XCAR (XCDR (buffer
)),
397 BVAR (current_buffer
, directory
));
398 CHECK_STRING (output_file
);
402 if (! (NILP (buffer
) || EQ (buffer
, Qt
) || INTEGERP (buffer
)))
404 Lisp_Object spec_buffer
;
405 spec_buffer
= buffer
;
406 buffer
= Fget_buffer_create (buffer
);
407 /* Mention the buffer name for a better error message. */
409 CHECK_BUFFER (spec_buffer
);
410 CHECK_BUFFER (buffer
);
414 /* Make sure that the child will be able to chdir to the current
415 buffer's current directory, or its unhandled equivalent. We
416 can't just have the child check for an error when it does the
417 chdir, since it's in a vfork.
419 We have to GCPRO around this because Fexpand_file_name,
420 Funhandled_file_name_directory, and Ffile_accessible_directory_p
421 might call a file name handling function. The argument list is
422 protected by the caller, so all we really have to worry about is
425 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
427 current_dir
= encode_current_directory ();
429 GCPRO4 (buffer
, current_dir
, error_file
, output_file
);
431 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
432 error_file
= ENCODE_FILE (error_file
);
433 if (STRINGP (output_file
) && STRING_MULTIBYTE (output_file
))
434 output_file
= ENCODE_FILE (output_file
);
438 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
440 for (i
= 0; i
< CALLPROC_FDS
; i
++)
443 synch_process_tempfile
= make_number (0);
445 record_unwind_protect_ptr (call_process_kill
, callproc_fd
);
447 /* Search for program; barf if not found. */
449 struct gcpro gcpro1
, gcpro2
, gcpro3
;
452 GCPRO3 (buffer
, current_dir
, error_file
);
453 ok
= openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
,
454 make_number (X_OK
), false);
457 report_file_error ("Searching for program", args
[0]);
460 /* If program file name starts with /: for quoting a magic name,
462 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
463 && SREF (path
, 1) == ':')
464 path
= Fsubstring (path
, make_number (2), Qnil
);
466 new_argv
= SAFE_ALLOCA ((nargs
> 4 ? nargs
- 2 : 2) * sizeof *new_argv
);
469 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
471 GCPRO4 (buffer
, current_dir
, path
, error_file
);
476 argument_coding
.dst_multibyte
= 0;
477 for (i
= 4; i
< nargs
; i
++)
479 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
480 if (CODING_REQUIRE_ENCODING (&argument_coding
))
481 /* We must encode this argument. */
482 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
484 for (i
= 4; i
< nargs
; i
++)
485 new_argv
[i
- 3] = SSDATA (args
[i
]);
490 if (STRING_MULTIBYTE (path
))
491 path
= ENCODE_FILE (path
);
492 new_argv
[0] = SSDATA (path
);
496 discard_output
= INTEGERP (buffer
) || (NILP (buffer
) && NILP (output_file
));
499 if (! discard_output
&& ! STRINGP (output_file
))
501 char const *tmpdir
= egetenv ("TMPDIR");
502 char const *outf
= tmpdir
? tmpdir
: "";
503 tempfile
= alloca (strlen (outf
) + 20);
504 strcpy (tempfile
, outf
);
505 dostounix_filename (tempfile
);
506 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
507 strcat (tempfile
, "/");
508 strcat (tempfile
, "emXXXXXX");
511 report_file_error ("Opening process output file", Qnil
);
512 output_file
= build_string (tempfile
);
513 synch_process_tempfile
= output_file
;
519 fd_output
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
521 report_file_error ("Opening null device", Qnil
);
523 else if (STRINGP (output_file
))
525 fd_output
= emacs_open (SSDATA (output_file
),
526 O_WRONLY
| O_CREAT
| O_TRUNC
| O_TEXT
,
527 default_output_mode
);
530 int open_errno
= errno
;
531 output_file
= DECODE_FILE (output_file
);
532 report_file_errno ("Opening process output file",
533 output_file
, open_errno
);
539 if (emacs_pipe (fd
) != 0)
540 report_file_error ("Creating process pipe", Qnil
);
541 callproc_fd
[CALLPROC_PIPEREAD
] = fd
[0];
544 callproc_fd
[CALLPROC_STDOUT
] = fd_output
;
546 fd_error
= fd_output
;
548 if (STRINGP (error_file
) || (NILP (error_file
) && !discard_output
))
550 fd_error
= emacs_open ((STRINGP (error_file
)
551 ? SSDATA (error_file
)
553 O_WRONLY
| O_CREAT
| O_TRUNC
| O_TEXT
,
554 default_output_mode
);
557 int open_errno
= errno
;
558 report_file_errno ("Cannot redirect stderr",
559 (STRINGP (error_file
)
560 ? DECODE_FILE (error_file
)
561 : build_string (NULL_DEVICE
)),
564 callproc_fd
[CALLPROC_STDERR
] = fd_error
;
567 #ifdef MSDOS /* MW, July 1993 */
568 /* Note that on MSDOS `child_setup' actually returns the child process
569 exit status, not its PID, so assign it to status below. */
570 pid
= child_setup (*filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
576 synchronize_system_messages_locale ();
578 code_convert_string_norecord (build_string (strerror (child_errno
)),
579 Vlocale_coding_system
, 0);
583 for (i
= 0; i
< CALLPROC_FDS
; i
++)
584 if (0 <= callproc_fd
[i
])
586 emacs_close (callproc_fd
[i
]);
589 emacs_close (*filefd
);
594 /* Since CRLF is converted to LF within `decode_coding', we
595 can always open a file with binary mode. */
596 callproc_fd
[CALLPROC_PIPEREAD
] = emacs_open (tempfile
,
597 O_RDONLY
| O_BINARY
, 0);
598 if (callproc_fd
[CALLPROC_PIPEREAD
] < 0)
600 int open_errno
= errno
;
601 report_file_errno ("Cannot re-open temporary file",
602 build_string (tempfile
), open_errno
);
608 /* Do the unwind-protect now, even though the pid is not known, so
609 that no storage allocation is done in the critical section.
610 The actual PID will be filled in during the critical section. */
611 record_unwind_protect (call_process_cleanup
, Fcurrent_buffer ());
616 block_child_signal (&oldset
);
619 pid
= child_setup (*filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
620 #else /* not WINDOWSNT */
622 /* vfork, and prevent local vars from being clobbered by the vfork. */
624 Lisp_Object
volatile buffer_volatile
= buffer
;
625 Lisp_Object
volatile coding_systems_volatile
= coding_systems
;
626 Lisp_Object
volatile current_dir_volatile
= current_dir
;
627 bool volatile display_p_volatile
= display_p
;
628 int volatile fd_error_volatile
= fd_error
;
629 int *volatile filefd_volatile
= filefd
;
630 char **volatile new_argv_volatile
= new_argv
;
631 int volatile callproc_fd_volatile
[CALLPROC_FDS
];
632 for (i
= 0; i
< CALLPROC_FDS
; i
++)
633 callproc_fd_volatile
[i
] = callproc_fd
[i
];
637 buffer
= buffer_volatile
;
638 coding_systems
= coding_systems_volatile
;
639 current_dir
= current_dir_volatile
;
640 display_p
= display_p_volatile
;
641 fd_error
= fd_error_volatile
;
642 filefd
= filefd_volatile
;
643 new_argv
= new_argv_volatile
;
645 for (i
= 0; i
< CALLPROC_FDS
; i
++)
646 callproc_fd
[i
] = callproc_fd_volatile
[i
];
647 fd_output
= callproc_fd
[CALLPROC_STDOUT
];
652 unblock_child_signal (&oldset
);
656 /* Emacs ignores SIGPIPE, but the child should not. */
657 signal (SIGPIPE
, SIG_DFL
);
658 /* Likewise for SIGPROF. */
660 signal (SIGPROF
, SIG_DFL
);
663 child_setup (*filefd
, fd_output
, fd_error
, new_argv
, 0, current_dir
);
666 #endif /* not WINDOWSNT */
672 synch_process_pid
= pid
;
674 if (INTEGERP (buffer
))
678 record_deleted_pid (pid
, *tempfile_ptr
);
679 *tempfile_ptr
= Qnil
;
683 record_deleted_pid (pid
, Qnil
);
685 synch_process_pid
= 0;
689 unblock_child_signal (&oldset
);
693 report_file_errno ("Doing vfork", Qnil
, child_errno
);
695 /* Close our file descriptors, except for callproc_fd[CALLPROC_PIPEREAD]
696 since we will use that to read input from. */
697 for (i
= 0; i
< CALLPROC_FDS
; i
++)
698 if (i
!= CALLPROC_PIPEREAD
&& 0 <= callproc_fd
[i
])
700 emacs_close (callproc_fd
[i
]);
703 emacs_close (*filefd
);
706 #endif /* not MSDOS */
708 if (INTEGERP (buffer
))
714 if (BUFFERP (buffer
))
715 Fset_buffer (buffer
);
717 fd0
= callproc_fd
[CALLPROC_PIPEREAD
];
721 Lisp_Object val
, *args2
;
724 if (!NILP (Vcoding_system_for_read
))
725 val
= Vcoding_system_for_read
;
728 if (EQ (coding_systems
, Qt
))
732 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
733 args2
[0] = Qcall_process
;
734 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
736 = Ffind_operation_coding_system (nargs
+ 1, args2
);
738 if (CONSP (coding_systems
))
739 val
= XCAR (coding_systems
);
740 else if (CONSP (Vdefault_process_coding_system
))
741 val
= XCAR (Vdefault_process_coding_system
);
745 Fcheck_coding_system (val
);
746 /* In unibyte mode, character code conversion should not take
747 place but EOL conversion should. So, setup raw-text or one
748 of the subsidiary according to the information just setup. */
749 if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
751 val
= raw_text_coding_system (val
);
752 setup_coding_system (val
, &process_coding
);
753 process_coding
.dst_multibyte
754 = ! NILP (BVAR (current_buffer
, enable_multibyte_characters
));
755 process_coding
.src_multibyte
= 0;
763 enum { CALLPROC_BUFFER_SIZE_MIN
= 16 * 1024 };
764 enum { CALLPROC_BUFFER_SIZE_MAX
= 4 * CALLPROC_BUFFER_SIZE_MIN
};
765 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
766 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
768 EMACS_INT total_read
= 0;
770 bool display_on_the_fly
= display_p
;
771 struct coding_system saved_coding
= process_coding
;
775 /* Repeatedly read until we've filled as much as possible
776 of the buffer size we have. But don't read
777 less than 1024--save that for the next bufferful. */
779 while (nread
< bufsize
- 1024)
781 int this_read
= emacs_read (fd0
, buf
+ nread
,
789 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
794 total_read
+= this_read
;
796 if (display_on_the_fly
)
800 /* Now NREAD is the total amount of data in the buffer. */
805 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
))
806 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
807 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
809 { /* We have to decode the input. */
813 XSETBUFFER (curbuf
, current_buffer
);
814 /* FIXME: Call signal_after_change! */
815 prepare_to_modify_buffer (PT
, PT
, NULL
);
816 /* We cannot allow after-change-functions be run
817 during decoding, because that might modify the
818 buffer, while we rely on process_coding.produced to
819 faithfully reflect inserted text until we
820 TEMP_SET_PT_BOTH below. */
821 specbind (Qinhibit_modification_hooks
, Qt
);
822 decode_coding_c_string (&process_coding
,
823 (unsigned char *) buf
, nread
, curbuf
);
825 if (display_on_the_fly
826 && CODING_REQUIRE_DETECTION (&saved_coding
)
827 && ! CODING_REQUIRE_DETECTION (&process_coding
))
829 /* We have detected some coding system, but the
830 detection may have been via insufficient data.
831 So give up displaying on the fly. */
832 if (process_coding
.produced
> 0)
833 del_range_2 (process_coding
.dst_pos
,
834 process_coding
.dst_pos_byte
,
835 (process_coding
.dst_pos
836 + process_coding
.produced_char
),
837 (process_coding
.dst_pos_byte
838 + process_coding
.produced
),
840 display_on_the_fly
= 0;
841 process_coding
= saved_coding
;
843 /* Make the above condition always fail in the future. */
844 saved_coding
.common_flags
845 &= ~CODING_REQUIRE_DETECTION_MASK
;
849 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
850 PT_BYTE
+ process_coding
.produced
);
851 carryover
= process_coding
.carryover_bytes
;
853 memcpy (buf
, process_coding
.carryover
,
854 process_coding
.carryover_bytes
);
857 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
860 /* Make the buffer bigger as we continue to read more data,
861 but not past CALLPROC_BUFFER_SIZE_MAX. */
862 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
863 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
864 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
868 redisplay_preserve_echo_area (1);
869 /* This variable might have been set to 0 for code
870 detection. In that case, set it back to 1 because
871 we should have already detected a coding system. */
872 display_on_the_fly
= 1;
879 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
880 /* If the caller required, let the buffer inherit the
881 coding-system used to decode the process output. */
882 if (inherit_process_coding_system
)
883 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
884 make_number (total_read
));
888 /* Wait for it to terminate, unless it already has. */
889 wait_for_termination (pid
, &status
, fd0
< 0);
894 /* Don't kill any children that the subprocess may have left behind
896 synch_process_pid
= 0;
901 if (WIFSIGNALED (status
))
905 synchronize_system_messages_locale ();
906 signame
= strsignal (WTERMSIG (status
));
911 return code_convert_string_norecord (build_string (signame
),
912 Vlocale_coding_system
, 0);
915 eassert (WIFEXITED (status
));
916 return make_number (WEXITSTATUS (status
));
919 /* Create a temporary file suitable for storing the input data of
920 call-process-region. NARGS and ARGS are the same as for
921 call-process-region. Store into *FILENAME_STRING_PTR a Lisp string
922 naming the file, and return a file descriptor for reading.
923 Unwind-protect the file, so that the file descriptor will be closed
924 and the file removed when the caller unwinds the specpdl stack. */
927 create_temp_file (ptrdiff_t nargs
, Lisp_Object
*args
,
928 Lisp_Object
*filename_string_ptr
, int *fdp
)
932 Lisp_Object filename_string
;
933 Lisp_Object val
, start
, end
;
936 if (STRINGP (Vtemporary_file_directory
))
937 tmpdir
= Vtemporary_file_directory
;
942 outf
= getenv ("TMPDIR");
943 tmpdir
= build_string (outf
? outf
: "/tmp/");
945 if ((outf
= egetenv ("TMPDIR"))
946 || (outf
= egetenv ("TMP"))
947 || (outf
= egetenv ("TEMP")))
948 tmpdir
= build_string (outf
);
950 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
955 Lisp_Object pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
960 /* Cannot use the result of Fexpand_file_name, because it
961 downcases the XXXXXX part of the pattern, and mktemp then
962 doesn't recognize it. */
963 if (!NILP (Vw32_downcase_file_names
))
965 Lisp_Object dirname
= Ffile_name_directory (pattern
);
968 pattern
= Vtemp_file_name_pattern
;
970 pattern
= concat2 (dirname
, Vtemp_file_name_pattern
);
974 filename_string
= Fcopy_sequence (ENCODE_FILE (pattern
));
975 GCPRO1 (filename_string
);
976 tempfile
= SSDATA (filename_string
);
978 fd
= mkostemp (tempfile
, O_CLOEXEC
);
980 report_file_error ("Failed to open temporary file using pattern",
983 *filename_string_ptr
= filename_string
;
984 record_unwind_protect (delete_temp_file_ptr
, filename_string_ptr
);
985 record_unwind_protect_ptr (close_file_ptr_unwind
, fdp
);
990 /* Decide coding-system of the contents of the temporary file. */
991 if (!NILP (Vcoding_system_for_write
))
992 val
= Vcoding_system_for_write
;
993 else if (NILP (BVAR (current_buffer
, enable_multibyte_characters
)))
997 Lisp_Object coding_systems
;
1000 SAFE_NALLOCA (args2
, 1, nargs
+ 1);
1001 args2
[0] = Qcall_process_region
;
1002 memcpy (args2
+ 1, args
, nargs
* sizeof *args
);
1003 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
1004 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
1007 val
= complement_process_encoding_system (val
);
1010 ptrdiff_t count1
= SPECPDL_INDEX ();
1012 specbind (intern ("coding-system-for-write"), val
);
1013 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1014 happen to get a ".Z" suffix. */
1015 specbind (intern ("file-name-handler-alist"), Qnil
);
1016 write_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
, fd
);
1018 unbind_to (count1
, Qnil
);
1021 if (lseek (fd
, 0, SEEK_SET
) < 0)
1022 report_file_error ("Setting file position", filename_string
);
1024 /* Note that Fcall_process takes care of binding
1025 coding-system-for-read. */
1030 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
1032 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
1033 The remaining arguments are optional.
1034 Delete the text if fourth arg DELETE is non-nil.
1036 Insert output in BUFFER before point; t means current buffer; nil for
1037 BUFFER means discard it; 0 means discard and don't wait; and `(:file
1038 FILE)', where FILE is a file name string, means that it should be
1039 written to that file (if the file already exists it is overwritten).
1040 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1041 REAL-BUFFER says what to do with standard output, as above,
1042 while STDERR-FILE says what to do with standard error in the child.
1043 STDERR-FILE may be nil (discard standard error output),
1044 t (mix it with ordinary output), or a file name string.
1046 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1047 Remaining args are passed to PROGRAM at startup as command args.
1049 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1050 Otherwise it waits for PROGRAM to terminate
1051 and returns a numeric exit status or a signal description string.
1052 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1054 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1055 (ptrdiff_t nargs
, Lisp_Object
*args
)
1057 struct gcpro gcpro1
;
1058 Lisp_Object infile
, val
;
1059 ptrdiff_t count
= SPECPDL_INDEX ();
1060 Lisp_Object start
= args
[0];
1061 Lisp_Object end
= args
[1];
1065 if (STRINGP (start
))
1066 empty_input
= SCHARS (start
) == 0;
1067 else if (NILP (start
))
1068 empty_input
= BEG
== Z
;
1071 validate_region (&args
[0], &args
[1]);
1074 empty_input
= XINT (start
) == XINT (end
);
1078 create_temp_file (nargs
, args
, &infile
, &fd
);
1082 fd
= emacs_open (NULL_DEVICE
, O_RDONLY
, 0);
1084 report_file_error ("Opening null device", Qnil
);
1085 record_unwind_protect_ptr (close_file_ptr_unwind
, &fd
);
1090 if (nargs
> 3 && !NILP (args
[3]))
1091 Fdelete_region (start
, end
);
1105 val
= call_process (nargs
, args
, &fd
, &infile
);
1106 RETURN_UNGCPRO (unbind_to (count
, val
));
1110 static int relocate_fd (int fd
, int minfd
);
1114 add_env (char **env
, char **new_env
, char *string
)
1121 /* See if this string duplicates any string already in the env.
1122 If so, don't put it in.
1123 When an env var has multiple definitions,
1124 we keep the definition that comes first in process-environment. */
1125 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1127 char *p
= *ep
, *q
= string
;
1133 /* The string is a lone variable name; keep it for now, we
1134 will remove it later. It is a placeholder for a
1135 variable that is not to be included in the environment. */
1143 *new_env
++ = string
;
1147 /* This is the last thing run in a newly forked inferior
1148 either synchronous or asynchronous.
1149 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1150 Initialize inferior's priority, pgrp, connected dir and environment.
1151 then exec another program based on new_argv.
1153 If SET_PGRP, put the subprocess into a separate process group.
1155 CURRENT_DIR is an elisp string giving the path of the current
1156 directory the subprocess should have. Since we can't really signal
1157 a decent error from within the child, this should be verified as an
1158 executable directory by the parent. */
1161 child_setup (int in
, int out
, int err
, char **new_argv
, bool set_pgrp
,
1162 Lisp_Object current_dir
)
1172 pid_t pid
= getpid ();
1173 #endif /* WINDOWSNT */
1175 /* Note that use of alloca is always safe here. It's obvious for systems
1176 that do not have true vfork or that have true (stack) alloca.
1177 If using vfork and C_ALLOCA (when Emacs used to include
1178 src/alloca.c) it is safe because that changes the superior's
1179 static variables as if the superior had done alloca and will be
1180 cleaned up in the usual way. */
1185 i
= SBYTES (current_dir
);
1187 /* MSDOS must have all environment variables malloc'ed, because
1188 low-level libc functions that launch subsidiary processes rely
1190 pwd_var
= xmalloc (i
+ 5);
1192 pwd_var
= alloca (i
+ 5);
1195 memcpy (pwd_var
, "PWD=", 4);
1196 strcpy (temp
, SSDATA (current_dir
));
1199 /* We can't signal an Elisp error here; we're in a vfork. Since
1200 the callers check the current directory before forking, this
1201 should only return an error if the directory's permissions
1202 are changed between the check and this chdir, but we should
1204 if (chdir (temp
) < 0)
1205 _exit (EXIT_CANCELED
);
1207 /* Get past the drive letter, so that d:/ is left alone. */
1208 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1215 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1216 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1220 /* Set `env' to a vector of the strings in the environment. */
1222 register Lisp_Object tem
;
1223 register char **new_env
;
1225 register int new_length
;
1226 Lisp_Object display
= Qnil
;
1230 for (tem
= Vprocess_environment
;
1231 CONSP (tem
) && STRINGP (XCAR (tem
));
1234 if (strncmp (SSDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1235 && (SDATA (XCAR (tem
)) [7] == '\0'
1236 || SDATA (XCAR (tem
)) [7] == '='))
1237 /* DISPLAY is specified in process-environment. */
1242 /* If not provided yet, use the frame's DISPLAY. */
1245 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1246 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1247 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1248 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1249 Vinitial_environment
);
1257 /* new_length + 2 to include PWD and terminating 0. */
1258 env
= new_env
= alloca ((new_length
+ 2) * sizeof *env
);
1259 /* If we have a PWD envvar, pass one down,
1260 but with corrected value. */
1261 if (egetenv ("PWD"))
1262 *new_env
++ = pwd_var
;
1264 if (STRINGP (display
))
1266 char *vdata
= alloca (sizeof "DISPLAY=" + SBYTES (display
));
1267 strcpy (vdata
, "DISPLAY=");
1268 strcat (vdata
, SSDATA (display
));
1269 new_env
= add_env (env
, new_env
, vdata
);
1273 for (tem
= Vprocess_environment
;
1274 CONSP (tem
) && STRINGP (XCAR (tem
));
1276 new_env
= add_env (env
, new_env
, SSDATA (XCAR (tem
)));
1280 /* Remove variable names without values. */
1284 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1294 prepare_standard_handles (in
, out
, err
, handles
);
1295 set_process_dir (SDATA (current_dir
));
1296 /* Spawn the child. (See w32proc.c:sys_spawnve). */
1297 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1298 reset_standard_handles (in
, out
, err
, handles
);
1300 /* An error occurred while trying to spawn the process. */
1301 report_file_error ("Spawning child process", Qnil
);
1304 #else /* not WINDOWSNT */
1305 /* Make sure that in, out, and err are not actually already in
1306 descriptors zero, one, or two; this could happen if Emacs is
1307 started with its standard in, out, or error closed, as might
1310 int oin
= in
, oout
= out
;
1312 /* We have to avoid relocating the same descriptor twice! */
1314 in
= relocate_fd (in
, 3);
1319 out
= relocate_fd (out
, 3);
1323 else if (err
== oout
)
1326 err
= relocate_fd (err
, 3);
1330 /* Redirect file descriptors and clear the close-on-exec flag on the
1331 redirected ones. IN, OUT, and ERR are close-on-exec so they
1332 need not be closed explicitly. */
1340 execve (new_argv
[0], new_argv
, env
);
1343 /* Avoid deadlock if the child's perror writes to a full pipe; the
1344 pipe's reader is the parent, but with vfork the parent can't
1345 run until the child exits. Truncate the diagnostic instead. */
1346 fcntl (STDERR_FILENO
, F_SETFL
, O_NONBLOCK
);
1349 emacs_perror (new_argv
[0]);
1350 _exit (exec_errno
== ENOENT
? EXIT_ENOENT
: EXIT_CANNOT_INVOKE
);
1353 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1356 /* An error occurred while trying to run the subprocess. */
1357 report_file_error ("Spawning child process", Qnil
);
1360 #endif /* not WINDOWSNT */
1364 /* Move the file descriptor FD so that its number is not less than MINFD.
1365 If the file descriptor is moved at all, the original is closed on MSDOS,
1366 but not elsewhere as the caller will close it anyway. */
1368 relocate_fd (int fd
, int minfd
)
1374 int new = fcntl (fd
, F_DUPFD_CLOEXEC
, minfd
);
1377 emacs_perror ("while setting up child");
1378 _exit (EXIT_CANCELED
);
1386 #endif /* not WINDOWSNT */
1389 getenv_internal_1 (const char *var
, ptrdiff_t varlen
, char **value
,
1390 ptrdiff_t *valuelen
, Lisp_Object env
)
1392 for (; CONSP (env
); env
= XCDR (env
))
1394 Lisp_Object entry
= XCAR (env
);
1396 && SBYTES (entry
) >= varlen
1398 /* NT environment variables are case insensitive. */
1399 && ! strnicmp (SDATA (entry
), var
, varlen
)
1400 #else /* not WINDOWSNT */
1401 && ! memcmp (SDATA (entry
), var
, varlen
)
1402 #endif /* not WINDOWSNT */
1405 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1407 *value
= SSDATA (entry
) + (varlen
+ 1);
1408 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1411 else if (SBYTES (entry
) == varlen
)
1413 /* Lone variable names in Vprocess_environment mean that
1414 variable should be removed from the environment. */
1424 getenv_internal (const char *var
, ptrdiff_t varlen
, char **value
,
1425 ptrdiff_t *valuelen
, Lisp_Object frame
)
1427 /* Try to find VAR in Vprocess_environment first. */
1428 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1429 Vprocess_environment
))
1430 return *value
? 1 : 0;
1432 /* For DISPLAY try to get the values from the frame or the initial env. */
1433 if (strcmp (var
, "DISPLAY") == 0)
1436 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1437 if (STRINGP (display
))
1439 *value
= SSDATA (display
);
1440 *valuelen
= SBYTES (display
);
1443 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1444 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1445 Vinitial_environment
))
1446 return *value
? 1 : 0;
1452 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1453 doc
: /* Get the value of environment variable VARIABLE.
1454 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1455 the environment. Otherwise, value is a string.
1457 This function searches `process-environment' for VARIABLE.
1459 If optional parameter ENV is a list, then search this list instead of
1460 `process-environment', and return t when encountering a negative entry
1461 \(an entry for a variable with no value). */)
1462 (Lisp_Object variable
, Lisp_Object env
)
1467 CHECK_STRING (variable
);
1470 if (getenv_internal_1 (SSDATA (variable
), SBYTES (variable
),
1471 &value
, &valuelen
, env
))
1472 return value
? make_string (value
, valuelen
) : Qt
;
1476 else if (getenv_internal (SSDATA (variable
), SBYTES (variable
),
1477 &value
, &valuelen
, env
))
1478 return make_string (value
, valuelen
);
1483 /* A version of getenv that consults the Lisp environment lists,
1484 easily callable from C. */
1486 egetenv (const char *var
)
1491 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1498 /* This is run before init_cmdargs. */
1501 init_callproc_1 (void)
1504 const char *etc_dir
= ns_etc_directory ();
1505 const char *path_exec
= ns_exec_path ();
1508 Vdata_directory
= decode_env_path ("EMACSDATA",
1513 Vdata_directory
= Ffile_name_as_directory (Fcar (Vdata_directory
));
1515 Vdoc_directory
= decode_env_path ("EMACSDOC",
1520 Vdoc_directory
= Ffile_name_as_directory (Fcar (Vdoc_directory
));
1522 /* Check the EMACSPATH environment variable, defaulting to the
1523 PATH_EXEC path from epaths.h. */
1524 Vexec_path
= decode_env_path ("EMACSPATH",
1526 path_exec
? path_exec
:
1529 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1530 /* FIXME? For ns, path_exec should go at the front? */
1531 Vexec_path
= nconc2 (decode_env_path ("PATH", "", 0), Vexec_path
);
1534 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1537 init_callproc (void)
1539 char *data_dir
= egetenv ("EMACSDATA");
1542 Lisp_Object tempdir
;
1546 const char *etc_dir
= ns_etc_directory ();
1549 data_dir
= alloca (strlen (etc_dir
) + 1);
1550 strcpy (data_dir
, etc_dir
);
1555 if (!NILP (Vinstallation_directory
))
1557 /* Add to the path the lib-src subdir of the installation dir. */
1559 tem
= Fexpand_file_name (build_string ("lib-src"),
1560 Vinstallation_directory
);
1562 /* MSDOS uses wrapped binaries, so don't do this. */
1563 if (NILP (Fmember (tem
, Vexec_path
)))
1566 const char *path_exec
= ns_exec_path ();
1568 Vexec_path
= decode_env_path ("EMACSPATH",
1570 path_exec
? path_exec
:
1573 Vexec_path
= Fcons (tem
, Vexec_path
);
1574 Vexec_path
= nconc2 (decode_env_path ("PATH", "", 0), Vexec_path
);
1577 Vexec_directory
= Ffile_name_as_directory (tem
);
1578 #endif /* not MSDOS */
1580 /* Maybe use ../etc as well as ../lib-src. */
1583 tem
= Fexpand_file_name (build_string ("etc"),
1584 Vinstallation_directory
);
1585 Vdoc_directory
= Ffile_name_as_directory (tem
);
1589 /* Look for the files that should be in etc. We don't use
1590 Vinstallation_directory, because these files are never installed
1591 near the executable, and they are never in the build
1592 directory when that's different from the source directory.
1594 Instead, if these files are not in the nominal place, we try the
1595 source directory. */
1598 Lisp_Object tem
, tem1
, srcdir
;
1599 Lisp_Object lispdir
= Fcar (decode_env_path (0, PATH_DUMPLOADSEARCH
, 0));
1601 srcdir
= Fexpand_file_name (build_string ("../src/"), lispdir
);
1603 tem
= Fexpand_file_name (build_string ("NEWS"), Vdata_directory
);
1604 tem1
= Ffile_exists_p (tem
);
1605 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1608 newdir
= Fexpand_file_name (build_string ("../etc/"), lispdir
);
1609 tem
= Fexpand_file_name (build_string ("NEWS"), newdir
);
1610 tem1
= Ffile_exists_p (tem
);
1612 Vdata_directory
= newdir
;
1620 tempdir
= Fdirectory_file_name (Vexec_directory
);
1621 if (! file_accessible_directory_p (SSDATA (tempdir
)))
1622 dir_warning ("arch-dependent data dir", Vexec_directory
);
1625 tempdir
= Fdirectory_file_name (Vdata_directory
);
1626 if (! file_accessible_directory_p (SSDATA (tempdir
)))
1627 dir_warning ("arch-independent data dir", Vdata_directory
);
1629 sh
= getenv ("SHELL");
1630 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1633 Vshared_game_score_directory
= Qnil
;
1635 Vshared_game_score_directory
= build_unibyte_string (PATH_GAME
);
1636 if (NILP (Ffile_accessible_directory_p (Vshared_game_score_directory
)))
1637 Vshared_game_score_directory
= Qnil
;
1642 set_initial_environment (void)
1645 for (envp
= environ
; *envp
; envp
++)
1646 Vprocess_environment
= Fcons (build_string (*envp
),
1647 Vprocess_environment
);
1648 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1649 to use `delete' and friends on process-environment. */
1650 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1654 syms_of_callproc (void)
1656 #include "callproc.x"
1659 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1661 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1663 staticpro (&Vtemp_file_name_pattern
);
1665 synch_process_tempfile
= make_number (0);
1666 staticpro (&synch_process_tempfile
);
1668 DEFVAR_LISP ("shell-file-name", Vshell_file_name
,
1669 doc
: /* File name to load inferior shells from.
1670 Initialized from the SHELL environment variable, or to a system-dependent
1671 default if SHELL is not set. */);
1673 DEFVAR_LISP ("exec-path", Vexec_path
,
1674 doc
: /* List of directories to search programs to run in subprocesses.
1675 Each element is a string (directory name) or nil (try default directory).
1677 By default the last element of this list is `exec-directory'. The
1678 last element is not always used, for example in shell completion
1679 (`shell-dynamic-complete-command'). */);
1681 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes
,
1682 doc
: /* List of suffixes to try to find executable file names.
1683 Each element is a string. */);
1684 Vexec_suffixes
= Qnil
;
1686 DEFVAR_LISP ("exec-directory", Vexec_directory
,
1687 doc
: /* Directory for executables for Emacs to invoke.
1688 More generally, this includes any architecture-dependent files
1689 that are built and installed from the Emacs distribution. */);
1691 DEFVAR_LISP ("data-directory", Vdata_directory
,
1692 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1693 These are files intended for Emacs to use while it runs. */);
1695 DEFVAR_LISP ("doc-directory", Vdoc_directory
,
1696 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1697 This is usually the same as `data-directory'. */);
1699 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory
,
1700 doc
: /* For internal use by the build procedure only.
1701 This is the name of the directory in which the build procedure installed
1702 Emacs's info files; the default value for `Info-default-directory-list'
1704 Vconfigure_info_directory
= build_string (PATH_INFO
);
1706 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory
,
1707 doc
: /* Directory of score files for games which come with GNU Emacs.
1708 If this variable is nil, then Emacs is unable to use a shared directory. */);
1710 Vshared_game_score_directory
= Qnil
;
1712 Vshared_game_score_directory
= build_string (PATH_GAME
);
1715 DEFVAR_LISP ("initial-environment", Vinitial_environment
,
1716 doc
: /* List of environment variables inherited from the parent process.
1717 Each element should be a string of the form ENVVARNAME=VALUE.
1718 The elements must normally be decoded (using `locale-coding-system') for use. */);
1719 Vinitial_environment
= Qnil
;
1721 DEFVAR_LISP ("process-environment", Vprocess_environment
,
1722 doc
: /* List of overridden environment variables for subprocesses to inherit.
1723 Each element should be a string of the form ENVVARNAME=VALUE.
1725 Entries in this list take precedence to those in the frame-local
1726 environments. Therefore, let-binding `process-environment' is an easy
1727 way to temporarily change the value of an environment variable,
1728 irrespective of where it comes from. To use `process-environment' to
1729 remove an environment variable, include only its name in the list,
1732 This variable is set to nil when Emacs starts.
1734 If multiple entries define the same variable, the first one always
1737 Non-ASCII characters are encoded according to the initial value of
1738 `locale-coding-system', i.e. the elements must normally be decoded for
1741 See `setenv' and `getenv'. */);
1742 Vprocess_environment
= Qnil
;