1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1993, 1994, 1995, 1999, 2000, 2001,
3 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 Free Software Foundation, Inc.
6 This file is part of GNU Emacs.
8 GNU Emacs is free software: you can redistribute it and/or modify
9 it under the terms of the GNU General Public License as published by
10 the Free Software Foundation, either version 3 of the License, or
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/>. */
31 /* Define SIGCHLD as an alias for SIGCLD. */
33 #if !defined (SIGCHLD) && defined (SIGCLD)
34 #define SIGCHLD SIGCLD
37 #include <sys/types.h>
45 #define INCLUDED_FCNTL
52 #include <stdlib.h> /* for proper declaration of environ */
55 #define _P_NOWAIT 1 /* from process.h */
58 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
59 #define INCLUDED_FCNTL
62 #include <sys/param.h>
77 #include "character.h"
80 #include "composite.h"
83 #include "syssignal.h"
85 #include "blockinput.h"
87 #include "termhooks.h"
94 extern char **environ
;
98 #if !defined (USG) || defined (BSD_PGRPS)
100 #define setpgrp setpgid
104 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
105 Lisp_Object Vdata_directory
, Vdoc_directory
;
106 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
107 Lisp_Object Vtemp_file_name_pattern
;
109 Lisp_Object Vshell_file_name
;
111 Lisp_Object Vprocess_environment
, Vinitial_environment
;
114 Lisp_Object Qbuffer_file_type
;
117 /* True if we are about to fork off a synchronous process or if we
118 are waiting for it. */
119 int synch_process_alive
;
121 /* Nonzero => this is a string explaining death of synchronous subprocess. */
122 char *synch_process_death
;
124 /* Nonzero => this is the signal number that terminated the subprocess. */
125 int synch_process_termsig
;
127 /* If synch_process_death is zero,
128 this is exit code of synchronous subprocess. */
129 int synch_process_retcode
;
132 /* Clean up when exiting Fcall_process.
133 On MSDOS, delete the temporary file on any kind of termination.
134 On Unix, kill the process and any children on termination by signal. */
136 /* Nonzero if this is termination due to exit. */
137 static int call_process_exited
;
139 EXFUN (Fgetenv_internal
, 2);
142 call_process_kill (fdpid
)
145 emacs_close (XFASTINT (Fcar (fdpid
)));
146 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
147 synch_process_alive
= 0;
152 call_process_cleanup (fdpid
)
156 /* for MSDOS fdpid is really (fd . tempfile) */
157 register Lisp_Object file
;
159 emacs_close (XFASTINT (Fcar (fdpid
)));
160 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
161 unlink (SDATA (file
));
162 #else /* not MSDOS */
163 register int pid
= XFASTINT (Fcdr (fdpid
));
165 if (call_process_exited
)
167 emacs_close (XFASTINT (Fcar (fdpid
)));
171 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
173 int count
= SPECPDL_INDEX ();
174 record_unwind_protect (call_process_kill
, fdpid
);
175 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
178 wait_for_termination (pid
);
180 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
181 message1 ("Waiting for process to die...done");
183 synch_process_alive
= 0;
184 emacs_close (XFASTINT (Fcar (fdpid
)));
185 #endif /* not MSDOS */
189 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
190 doc
: /* Call PROGRAM synchronously in separate process.
191 The remaining arguments are optional.
192 The program's input comes from file INFILE (nil means `/dev/null').
193 Insert output in BUFFER before point; t means current buffer;
194 nil for BUFFER means discard it; 0 means discard and don't wait.
195 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
196 REAL-BUFFER says what to do with standard output, as above,
197 while STDERR-FILE says what to do with standard error in the child.
198 STDERR-FILE may be nil (discard standard error output),
199 t (mix it with ordinary output), or a file name string.
201 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
202 Remaining arguments are strings passed as command arguments to PROGRAM.
204 If executable PROGRAM can't be found as an executable, `call-process'
205 signals a Lisp error. `call-process' reports errors in execution of
206 the program only through its return and output.
208 If BUFFER is 0, `call-process' returns immediately with value nil.
209 Otherwise it waits for PROGRAM to terminate
210 and returns a numeric exit status or a signal description string.
211 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
213 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
216 register Lisp_Object
*args
;
218 Lisp_Object infile
, buffer
, current_dir
, path
;
223 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
224 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
225 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
226 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
227 int count
= SPECPDL_INDEX ();
229 register const unsigned char **new_argv
230 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
231 struct buffer
*old
= current_buffer
;
232 /* File to use for stderr in the child.
233 t means use same as standard output. */
234 Lisp_Object error_file
;
235 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
236 char *outf
, *tempfile
;
242 struct coding_system process_coding
; /* coding-system of process output */
243 struct coding_system argument_coding
; /* coding-system of arguments */
244 /* Set to the return value of Ffind_operation_coding_system. */
245 Lisp_Object coding_systems
;
247 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
250 CHECK_STRING (args
[0]);
255 /* Without asynchronous processes we cannot have BUFFER == 0. */
257 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
258 error ("Operating system cannot handle asynchronous subprocesses");
259 #endif /* subprocesses */
261 /* Decide the coding-system for giving arguments. */
263 Lisp_Object val
, *args2
;
266 /* If arguments are supplied, we may have to encode them. */
270 Lisp_Object coding_attrs
;
272 for (i
= 4; i
< nargs
; i
++)
273 CHECK_STRING (args
[i
]);
275 for (i
= 4; i
< nargs
; i
++)
276 if (STRING_MULTIBYTE (args
[i
]))
279 if (!NILP (Vcoding_system_for_write
))
280 val
= Vcoding_system_for_write
;
281 else if (! must_encode
)
285 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
286 args2
[0] = Qcall_process
;
287 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
288 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
289 if (CONSP (coding_systems
))
290 val
= XCDR (coding_systems
);
291 else if (CONSP (Vdefault_process_coding_system
))
292 val
= XCDR (Vdefault_process_coding_system
);
296 val
= coding_inherit_eol_type (val
, Qnil
);
297 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
298 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
299 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
301 /* We should not use an ASCII incompatible coding system. */
302 val
= raw_text_coding_system (val
);
303 setup_coding_system (val
, &argument_coding
);
308 if (nargs
>= 2 && ! NILP (args
[1]))
310 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
311 CHECK_STRING (infile
);
314 infile
= build_string (NULL_DEVICE
);
320 /* If BUFFER is a list, its meaning is
321 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
324 if (CONSP (XCDR (buffer
)))
326 Lisp_Object stderr_file
;
327 stderr_file
= XCAR (XCDR (buffer
));
329 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
330 error_file
= stderr_file
;
332 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
335 buffer
= XCAR (buffer
);
338 if (!(EQ (buffer
, Qnil
)
340 || INTEGERP (buffer
)))
342 Lisp_Object spec_buffer
;
343 spec_buffer
= buffer
;
344 buffer
= Fget_buffer_create (buffer
);
345 /* Mention the buffer name for a better error message. */
347 CHECK_BUFFER (spec_buffer
);
348 CHECK_BUFFER (buffer
);
354 /* Make sure that the child will be able to chdir to the current
355 buffer's current directory, or its unhandled equivalent. We
356 can't just have the child check for an error when it does the
357 chdir, since it's in a vfork.
359 We have to GCPRO around this because Fexpand_file_name,
360 Funhandled_file_name_directory, and Ffile_accessible_directory_p
361 might call a file name handling function. The argument list is
362 protected by the caller, so all we really have to worry about is
365 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
367 current_dir
= current_buffer
->directory
;
369 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
371 current_dir
= Funhandled_file_name_directory (current_dir
);
372 if (NILP (current_dir
))
373 /* If the file name handler says that current_dir is unreachable, use
374 a sensible default. */
375 current_dir
= build_string ("~/");
376 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
377 if (NILP (Ffile_accessible_directory_p (current_dir
)))
378 report_file_error ("Setting current directory",
379 Fcons (current_buffer
->directory
, Qnil
));
381 if (STRING_MULTIBYTE (infile
))
382 infile
= ENCODE_FILE (infile
);
383 if (STRING_MULTIBYTE (current_dir
))
384 current_dir
= ENCODE_FILE (current_dir
);
385 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
386 error_file
= ENCODE_FILE (error_file
);
390 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
392 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
395 infile
= DECODE_FILE (infile
);
396 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
398 /* Search for program; barf if not found. */
402 GCPRO1 (current_dir
);
403 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
408 emacs_close (filefd
);
409 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
412 /* If program file name starts with /: for quoting a magic name,
414 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
415 && SREF (path
, 1) == ':')
416 path
= Fsubstring (path
, make_number (2), Qnil
);
418 new_argv
[0] = SDATA (path
);
422 struct gcpro gcpro1
, gcpro2
, gcpro3
;
424 GCPRO3 (infile
, buffer
, current_dir
);
425 argument_coding
.dst_multibyte
= 0;
426 for (i
= 4; i
< nargs
; i
++)
428 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
429 if (CODING_REQUIRE_ENCODING (&argument_coding
))
430 /* We must encode this argument. */
431 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
432 new_argv
[i
- 3] = SDATA (args
[i
]);
435 new_argv
[nargs
- 3] = 0;
440 #ifdef MSDOS /* MW, July 1993 */
441 if ((outf
= egetenv ("TMPDIR")))
442 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
445 tempfile
= alloca (20);
448 dostounix_filename (tempfile
);
449 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
450 strcat (tempfile
, "/");
451 strcat (tempfile
, "detmp.XXX");
454 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
457 emacs_close (filefd
);
458 report_file_error ("Opening process output file",
459 Fcons (build_string (tempfile
), Qnil
));
465 if (INTEGERP (buffer
))
466 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
473 emacs_close (filefd
);
474 report_file_error ("Creating process pipe", Qnil
);
478 /* Replaced by close_process_descs */
479 set_exclusive_use (fd
[0]);
484 /* child_setup must clobber environ in systems with true vfork.
485 Protect it from permanent change. */
486 register char **save_environ
= environ
;
487 register int fd1
= fd
[1];
490 #if 0 /* Some systems don't have sigblock. */
491 mask
= sigblock (sigmask (SIGCHLD
));
494 /* Record that we're about to create a synchronous process. */
495 synch_process_alive
= 1;
497 /* These vars record information from process termination.
498 Clear them now before process can possibly terminate,
499 to avoid timing error if process terminates soon. */
500 synch_process_death
= 0;
501 synch_process_retcode
= 0;
502 synch_process_termsig
= 0;
504 if (NILP (error_file
))
505 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
506 else if (STRINGP (error_file
))
509 fd_error
= emacs_open (SDATA (error_file
),
510 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
512 #else /* not DOS_NT */
513 fd_error
= creat (SDATA (error_file
), 0666);
514 #endif /* not DOS_NT */
519 emacs_close (filefd
);
527 if (NILP (error_file
))
528 error_file
= build_string (NULL_DEVICE
);
529 else if (STRINGP (error_file
))
530 error_file
= DECODE_FILE (error_file
);
531 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
534 #ifdef MSDOS /* MW, July 1993 */
535 /* Note that on MSDOS `child_setup' actually returns the child process
536 exit status, not its PID, so we assign it to `synch_process_retcode'
538 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
541 /* Record that the synchronous process exited and note its
542 termination status. */
543 synch_process_alive
= 0;
544 synch_process_retcode
= pid
;
545 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
547 synchronize_system_messages_locale ();
548 synch_process_death
= strerror (errno
);
551 emacs_close (outfilefd
);
552 if (fd_error
!= outfilefd
)
553 emacs_close (fd_error
);
554 fd1
= -1; /* No harm in closing that one! */
555 /* Since CRLF is converted to LF within `decode_coding', we can
556 always open a file with binary mode. */
557 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
561 emacs_close (filefd
);
562 report_file_error ("Cannot re-open temporary file", Qnil
);
564 #else /* not MSDOS */
566 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
568 #else /* not WINDOWSNT */
580 #if defined (USG) && !defined (BSD_PGRPS)
585 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
590 #endif /* not WINDOWSNT */
592 /* The MSDOS case did this already. */
594 emacs_close (fd_error
);
595 #endif /* not MSDOS */
597 environ
= save_environ
;
599 /* Close most of our fd's, but not fd[0]
600 since we will use that to read input from. */
601 emacs_close (filefd
);
602 if (fd1
>= 0 && fd1
!= fd_error
)
610 report_file_error ("Doing vfork", Qnil
);
613 if (INTEGERP (buffer
))
618 /* If Emacs has been built with asynchronous subprocess support,
619 we don't need to do this, I think because it will then have
620 the facilities for handling SIGCHLD. */
621 wait_without_blocking ();
622 #endif /* subprocesses */
626 /* Enable sending signal if user quits below. */
627 call_process_exited
= 0;
630 /* MSDOS needs different cleanup information. */
631 record_unwind_protect (call_process_cleanup
,
632 Fcons (make_number (fd
[0]), build_string (tempfile
)));
634 record_unwind_protect (call_process_cleanup
,
635 Fcons (make_number (fd
[0]), make_number (pid
)));
636 #endif /* not MSDOS */
639 if (BUFFERP (buffer
))
640 Fset_buffer (buffer
);
644 /* If BUFFER is nil, we must read process output once and then
645 discard it, so setup coding system but with nil. */
646 setup_coding_system (Qnil
, &process_coding
);
650 Lisp_Object val
, *args2
;
653 if (!NILP (Vcoding_system_for_read
))
654 val
= Vcoding_system_for_read
;
657 if (EQ (coding_systems
, Qt
))
661 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
662 args2
[0] = Qcall_process
;
663 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
665 = Ffind_operation_coding_system (nargs
+ 1, args2
);
667 if (CONSP (coding_systems
))
668 val
= XCAR (coding_systems
);
669 else if (CONSP (Vdefault_process_coding_system
))
670 val
= XCAR (Vdefault_process_coding_system
);
674 Fcheck_coding_system (val
);
675 /* In unibyte mode, character code conversion should not take
676 place but EOL conversion should. So, setup raw-text or one
677 of the subsidiary according to the information just setup. */
678 if (NILP (current_buffer
->enable_multibyte_characters
)
680 val
= raw_text_coding_system (val
);
681 setup_coding_system (val
, &process_coding
);
692 int display_on_the_fly
= display_p
;
693 struct coding_system saved_coding
;
695 saved_coding
= process_coding
;
698 /* Repeatedly read until we've filled as much as possible
699 of the buffer size we have. But don't read
700 less than 1024--save that for the next bufferful. */
702 while (nread
< bufsize
- 1024)
704 int this_read
= emacs_read (fd
[0], buf
+ nread
,
712 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
717 total_read
+= this_read
;
719 if (display_on_the_fly
)
723 /* Now NREAD is the total amount of data in the buffer. */
728 if (NILP (current_buffer
->enable_multibyte_characters
)
729 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
730 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
732 { /* We have to decode the input. */
735 XSETBUFFER (curbuf
, current_buffer
);
736 decode_coding_c_string (&process_coding
, buf
, nread
,
738 if (display_on_the_fly
739 && CODING_REQUIRE_DETECTION (&saved_coding
)
740 && ! CODING_REQUIRE_DETECTION (&process_coding
))
742 /* We have detected some coding system. But,
743 there's a possibility that the detection was
744 done by insufficient data. So, we give up
745 displaying on the fly. */
746 if (process_coding
.produced
> 0)
747 del_range_2 (process_coding
.dst_pos
,
748 process_coding
.dst_pos_byte
,
749 process_coding
.dst_pos
750 + process_coding
.produced_char
,
751 process_coding
.dst_pos_byte
752 + process_coding
.produced
, 0);
753 display_on_the_fly
= 0;
754 process_coding
= saved_coding
;
756 /* This is to make the above condition always
757 fails in the future. */
758 saved_coding
.common_flags
759 &= ~CODING_REQUIRE_DETECTION_MASK
;
763 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
764 PT_BYTE
+ process_coding
.produced
);
765 carryover
= process_coding
.carryover_bytes
;
767 /* As CARRYOVER should not be that large, we had
768 better avoid overhead of bcopy. */
769 BCOPY_SHORT (process_coding
.carryover
, buf
,
770 process_coding
.carryover_bytes
);
774 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
777 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
778 /* Make the buffer bigger as we continue to read more data,
779 but not past CALLPROC_BUFFER_SIZE_MAX. */
780 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
781 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
782 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
788 prepare_menu_bars ();
790 redisplay_preserve_echo_area (1);
791 /* This variable might have been set to 0 for code
792 detection. In that case, we set it back to 1 because
793 we should have already detected a coding system. */
794 display_on_the_fly
= 1;
801 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
802 /* If the caller required, let the buffer inherit the
803 coding-system used to decode the process output. */
804 if (inherit_process_coding_system
)
805 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
806 make_number (total_read
));
809 /* Wait for it to terminate, unless it already has. */
810 wait_for_termination (pid
);
814 set_buffer_internal (old
);
816 /* Don't kill any children that the subprocess may have left behind
818 call_process_exited
= 1;
820 unbind_to (count
, Qnil
);
822 if (synch_process_termsig
)
826 synchronize_system_messages_locale ();
827 signame
= strsignal (synch_process_termsig
);
832 synch_process_death
= signame
;
835 if (synch_process_death
)
836 return code_convert_string_norecord (build_string (synch_process_death
),
837 Vlocale_coding_system
, 0);
838 return make_number (synch_process_retcode
);
842 delete_temp_file (name
)
845 /* Suppress jka-compr handling, etc. */
846 int count
= SPECPDL_INDEX ();
847 specbind (intern ("file-name-handler-alist"), Qnil
);
848 internal_delete_file (name
);
849 unbind_to (count
, Qnil
);
853 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
855 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
856 The remaining arguments are optional.
857 Delete the text if fourth arg DELETE is non-nil.
859 Insert output in BUFFER before point; t means current buffer;
860 nil for BUFFER means discard it; 0 means discard and don't wait.
861 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
862 REAL-BUFFER says what to do with standard output, as above,
863 while STDERR-FILE says what to do with standard error in the child.
864 STDERR-FILE may be nil (discard standard error output),
865 t (mix it with ordinary output), or a file name string.
867 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
868 Remaining args are passed to PROGRAM at startup as command args.
870 If BUFFER is 0, `call-process-region' returns immediately with value nil.
871 Otherwise it waits for PROGRAM to terminate
872 and returns a numeric exit status or a signal description string.
873 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
875 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
878 register Lisp_Object
*args
;
881 Lisp_Object filename_string
;
882 register Lisp_Object start
, end
;
883 int count
= SPECPDL_INDEX ();
884 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
885 Lisp_Object coding_systems
;
886 Lisp_Object val
, *args2
;
892 if ((outf
= egetenv ("TMPDIR"))
893 || (outf
= egetenv ("TMP"))
894 || (outf
= egetenv ("TEMP")))
895 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
898 tempfile
= alloca (20);
901 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
902 strcat (tempfile
, "/");
903 if ('/' == DIRECTORY_SEP
)
904 dostounix_filename (tempfile
);
906 unixtodos_filename (tempfile
);
908 strcat (tempfile
, "emXXXXXX");
910 strcat (tempfile
, "detmp.XXX");
912 #else /* not DOS_NT */
913 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
914 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
915 SBYTES (Vtemp_file_name_pattern
) + 1);
916 #endif /* not DOS_NT */
925 fd
= mkstemp (tempfile
);
928 report_file_error ("Failed to open temporary file",
929 Fcons (Vtemp_file_name_pattern
, Qnil
));
937 filename_string
= build_string (tempfile
);
938 GCPRO1 (filename_string
);
941 /* Decide coding-system of the contents of the temporary file. */
942 if (!NILP (Vcoding_system_for_write
))
943 val
= Vcoding_system_for_write
;
944 else if (NILP (current_buffer
->enable_multibyte_characters
))
948 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
949 args2
[0] = Qcall_process_region
;
950 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
951 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
952 if (CONSP (coding_systems
))
953 val
= XCDR (coding_systems
);
954 else if (CONSP (Vdefault_process_coding_system
))
955 val
= XCDR (Vdefault_process_coding_system
);
961 int count1
= SPECPDL_INDEX ();
963 specbind (intern ("coding-system-for-write"), val
);
964 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
965 happen to get a ".Z" suffix. */
966 specbind (intern ("file-name-handler-alist"), Qnil
);
967 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
969 unbind_to (count1
, Qnil
);
972 /* Note that Fcall_process takes care of binding
973 coding-system-for-read. */
975 record_unwind_protect (delete_temp_file
, filename_string
);
977 if (nargs
> 3 && !NILP (args
[3]))
978 Fdelete_region (start
, end
);
990 args
[1] = filename_string
;
992 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
995 static int relocate_fd ();
998 add_env (char **env
, char **new_env
, char *string
)
1005 /* See if this string duplicates any string already in the env.
1006 If so, don't put it in.
1007 When an env var has multiple definitions,
1008 we keep the definition that comes first in process-environment. */
1009 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1011 char *p
= *ep
, *q
= string
;
1017 /* The string is a lone variable name; keep it for now, we
1018 will remove it later. It is a placeholder for a
1019 variable that is not to be included in the environment. */
1027 *new_env
++ = string
;
1031 /* This is the last thing run in a newly forked inferior
1032 either synchronous or asynchronous.
1033 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1034 Initialize inferior's priority, pgrp, connected dir and environment.
1035 then exec another program based on new_argv.
1037 This function may change environ for the superior process.
1038 Therefore, the superior process must save and restore the value
1039 of environ around the vfork and the call to this function.
1041 SET_PGRP is nonzero if we should put the subprocess into a separate
1044 CURRENT_DIR is an elisp string giving the path of the current
1045 directory the subprocess should have. Since we can't really signal
1046 a decent error from within the child, this should be verified as an
1047 executable directory by the parent. */
1050 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1052 register char **new_argv
;
1054 Lisp_Object current_dir
;
1061 #endif /* WINDOWSNT */
1063 int pid
= getpid ();
1065 #ifdef SET_EMACS_PRIORITY
1067 extern EMACS_INT emacs_priority
;
1069 if (emacs_priority
< 0)
1070 nice (- emacs_priority
);
1075 /* Close Emacs's descriptors that this process should not have. */
1076 close_process_descs ();
1078 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1079 we will lose if we call close_load_descs here. */
1081 close_load_descs ();
1084 /* Note that use of alloca is always safe here. It's obvious for systems
1085 that do not have true vfork or that have true (stack) alloca.
1086 If using vfork and C_ALLOCA (when Emacs used to include
1087 src/alloca.c) it is safe because that changes the superior's
1088 static variables as if the superior had done alloca and will be
1089 cleaned up in the usual way. */
1091 register char *temp
;
1094 i
= SBYTES (current_dir
);
1096 /* MSDOS must have all environment variables malloc'ed, because
1097 low-level libc functions that launch subsidiary processes rely
1099 pwd_var
= (char *) xmalloc (i
+ 6);
1101 pwd_var
= (char *) alloca (i
+ 6);
1104 bcopy ("PWD=", pwd_var
, 4);
1105 bcopy (SDATA (current_dir
), temp
, i
);
1106 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1110 /* We can't signal an Elisp error here; we're in a vfork. Since
1111 the callers check the current directory before forking, this
1112 should only return an error if the directory's permissions
1113 are changed between the check and this chdir, but we should
1115 if (chdir (temp
) < 0)
1120 /* Get past the drive letter, so that d:/ is left alone. */
1121 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1128 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1129 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1133 /* Set `env' to a vector of the strings in the environment. */
1135 register Lisp_Object tem
;
1136 register char **new_env
;
1138 register int new_length
;
1139 Lisp_Object display
= Qnil
;
1143 for (tem
= Vprocess_environment
;
1144 CONSP (tem
) && STRINGP (XCAR (tem
));
1147 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1148 && (SDATA (XCAR (tem
)) [7] == '\0'
1149 || SDATA (XCAR (tem
)) [7] == '='))
1150 /* DISPLAY is specified in process-environment. */
1155 /* If not provided yet, use the frame's DISPLAY. */
1158 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1159 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1160 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1161 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1162 Vinitial_environment
);
1170 /* new_length + 2 to include PWD and terminating 0. */
1171 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1172 /* If we have a PWD envvar, pass one down,
1173 but with corrected value. */
1174 if (egetenv ("PWD"))
1175 *new_env
++ = pwd_var
;
1177 if (STRINGP (display
))
1179 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1180 char *vdata
= (char *) alloca (vlen
);
1181 strcpy (vdata
, "DISPLAY=");
1182 strcat (vdata
, SDATA (display
));
1183 new_env
= add_env (env
, new_env
, vdata
);
1187 for (tem
= Vprocess_environment
;
1188 CONSP (tem
) && STRINGP (XCAR (tem
));
1190 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1194 /* Remove variable names without values. */
1198 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1208 prepare_standard_handles (in
, out
, err
, handles
);
1209 set_process_dir (SDATA (current_dir
));
1210 #else /* not WINDOWSNT */
1211 /* Make sure that in, out, and err are not actually already in
1212 descriptors zero, one, or two; this could happen if Emacs is
1213 started with its standard in, out, or error closed, as might
1216 int oin
= in
, oout
= out
;
1218 /* We have to avoid relocating the same descriptor twice! */
1220 in
= relocate_fd (in
, 3);
1225 out
= relocate_fd (out
, 3);
1229 else if (err
== oout
)
1232 err
= relocate_fd (err
, 3);
1246 #endif /* not MSDOS */
1247 #endif /* not WINDOWSNT */
1249 #if defined(USG) && !defined(BSD_PGRPS)
1250 #ifndef SETPGRP_RELEASES_CTTY
1251 setpgrp (); /* No arguments but equivalent in this case */
1256 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1257 EMACS_SET_TTY_PGRP (0, &pid
);
1260 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1263 /* An error occurred while trying to run the subprocess. */
1264 report_file_error ("Spawning child process", Qnil
);
1266 #else /* not MSDOS */
1268 /* Spawn the child. (See ntproc.c:Spawnve). */
1269 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1270 reset_standard_handles (in
, out
, err
, handles
);
1272 /* An error occurred while trying to spawn the process. */
1273 report_file_error ("Spawning child process", Qnil
);
1275 #else /* not WINDOWSNT */
1276 /* execvp does not accept an environment arg so the only way
1277 to pass this environment is to set environ. Our caller
1278 is responsible for restoring the ambient value of environ. */
1280 execvp (new_argv
[0], new_argv
);
1282 emacs_write (1, "Can't exec program: ", 20);
1283 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1284 emacs_write (1, "\n", 1);
1286 #endif /* not WINDOWSNT */
1287 #endif /* not MSDOS */
1290 /* Move the file descriptor FD so that its number is not less than MINFD.
1291 If the file descriptor is moved at all, the original is freed. */
1293 relocate_fd (fd
, minfd
)
1303 char *message1
= "Error while setting up child: ";
1304 char *errmessage
= strerror (errno
);
1305 char *message2
= "\n";
1306 emacs_write (2, message1
, strlen (message1
));
1307 emacs_write (2, errmessage
, strlen (errmessage
));
1308 emacs_write (2, message2
, strlen (message2
));
1311 /* Note that we hold the original FD open while we recurse,
1312 to guarantee we'll get a new FD if we need it. */
1313 new = relocate_fd (new, minfd
);
1320 getenv_internal_1 (var
, varlen
, value
, valuelen
, env
)
1327 for (; CONSP (env
); env
= XCDR (env
))
1329 Lisp_Object entry
= XCAR (env
);
1331 && SBYTES (entry
) >= varlen
1333 /* NT environment variables are case insensitive. */
1334 && ! strnicmp (SDATA (entry
), var
, varlen
)
1335 #else /* not WINDOWSNT */
1336 && ! bcmp (SDATA (entry
), var
, varlen
)
1337 #endif /* not WINDOWSNT */
1340 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1342 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1343 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1346 else if (SBYTES (entry
) == varlen
)
1348 /* Lone variable names in Vprocess_environment mean that
1349 variable should be removed from the environment. */
1359 getenv_internal (var
, varlen
, value
, valuelen
, frame
)
1366 /* Try to find VAR in Vprocess_environment first. */
1367 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1368 Vprocess_environment
))
1369 return *value
? 1 : 0;
1371 /* For DISPLAY try to get the values from the frame or the initial env. */
1372 if (strcmp (var
, "DISPLAY") == 0)
1375 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1376 if (STRINGP (display
))
1378 *value
= (char *) SDATA (display
);
1379 *valuelen
= SBYTES (display
);
1382 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1383 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1384 Vinitial_environment
))
1385 return *value
? 1 : 0;
1391 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1392 doc
: /* Get the value of environment variable VARIABLE.
1393 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1394 the environment. Otherwise, value is a string.
1396 This function searches `process-environment' for VARIABLE. If it is
1397 not found there, then it continues the search in the environment list
1398 of the selected frame.
1400 If optional parameter ENV is a list, then search this list instead of
1401 `process-environment', and return t when encountering a negative entry.
1403 If it is a frame, then this function will ignore `process-environment' and
1404 will simply look up the variable in that frame's environment. */)
1406 Lisp_Object variable
, env
;
1411 CHECK_STRING (variable
);
1414 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1415 &value
, &valuelen
, env
))
1416 return value
? make_string (value
, valuelen
) : Qt
;
1420 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1421 &value
, &valuelen
, env
))
1422 return make_string (value
, valuelen
);
1427 /* A version of getenv that consults the Lisp environment lists,
1428 easily callable from C. */
1436 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1443 /* This is run before init_cmdargs. */
1448 char *data_dir
= egetenv ("EMACSDATA");
1449 char *doc_dir
= egetenv ("EMACSDOC");
1452 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1455 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1458 /* Check the EMACSPATH environment variable, defaulting to the
1459 PATH_EXEC path from epaths.h. */
1460 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1461 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1462 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1465 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1470 char *data_dir
= egetenv ("EMACSDATA");
1473 Lisp_Object tempdir
;
1475 if (!NILP (Vinstallation_directory
))
1477 /* Add to the path the lib-src subdir of the installation dir. */
1479 tem
= Fexpand_file_name (build_string ("lib-src"),
1480 Vinstallation_directory
);
1482 /* MSDOS uses wrapped binaries, so don't do this. */
1483 if (NILP (Fmember (tem
, Vexec_path
)))
1485 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1486 Vexec_path
= Fcons (tem
, Vexec_path
);
1487 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1490 Vexec_directory
= Ffile_name_as_directory (tem
);
1491 #endif /* not DOS_NT */
1493 /* Maybe use ../etc as well as ../lib-src. */
1496 tem
= Fexpand_file_name (build_string ("etc"),
1497 Vinstallation_directory
);
1498 Vdoc_directory
= Ffile_name_as_directory (tem
);
1502 /* Look for the files that should be in etc. We don't use
1503 Vinstallation_directory, because these files are never installed
1504 near the executable, and they are never in the build
1505 directory when that's different from the source directory.
1507 Instead, if these files are not in the nominal place, we try the
1508 source directory. */
1511 Lisp_Object tem
, tem1
, srcdir
;
1513 srcdir
= Fexpand_file_name (build_string ("../src/"),
1514 build_string (PATH_DUMPLOADSEARCH
));
1515 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1516 tem1
= Ffile_exists_p (tem
);
1517 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1520 newdir
= Fexpand_file_name (build_string ("../etc/"),
1521 build_string (PATH_DUMPLOADSEARCH
));
1522 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1523 tem1
= Ffile_exists_p (tem
);
1525 Vdata_directory
= newdir
;
1533 tempdir
= Fdirectory_file_name (Vexec_directory
);
1534 if (access (SDATA (tempdir
), 0) < 0)
1535 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1539 tempdir
= Fdirectory_file_name (Vdata_directory
);
1540 if (access (SDATA (tempdir
), 0) < 0)
1541 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1544 sh
= (char *) getenv ("SHELL");
1545 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1547 if (getenv ("TMPDIR"))
1549 char *dir
= getenv ("TMPDIR");
1550 Vtemp_file_name_pattern
1551 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1552 build_string (dir
));
1555 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1558 Vshared_game_score_directory
= Qnil
;
1560 Vshared_game_score_directory
= build_string (PATH_GAME
);
1561 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1562 Vshared_game_score_directory
= Qnil
;
1567 set_initial_environment ()
1569 register char **envp
;
1575 Vprocess_environment
= Qnil
;
1577 for (envp
= environ
; *envp
; envp
++)
1578 Vprocess_environment
= Fcons (build_string (*envp
),
1579 Vprocess_environment
);
1580 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1581 to use `delete' and friends on process-environment. */
1582 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1590 Qbuffer_file_type
= intern ("buffer-file-type");
1591 staticpro (&Qbuffer_file_type
);
1594 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1595 doc
: /* *File name to load inferior shells from.
1596 Initialized from the SHELL environment variable, or to a system-dependent
1597 default if SHELL is not set. */);
1599 DEFVAR_LISP ("exec-path", &Vexec_path
,
1600 doc
: /* *List of directories to search programs to run in subprocesses.
1601 Each element is a string (directory name) or nil (try default directory). */);
1603 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1604 doc
: /* *List of suffixes to try to find executable file names.
1605 Each element is a string. */);
1606 Vexec_suffixes
= Qnil
;
1608 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1609 doc
: /* Directory for executables for Emacs to invoke.
1610 More generally, this includes any architecture-dependent files
1611 that are built and installed from the Emacs distribution. */);
1613 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1614 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1615 These are files intended for Emacs to use while it runs. */);
1617 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1618 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1619 This is usually the same as `data-directory'. */);
1621 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1622 doc
: /* For internal use by the build procedure only.
1623 This is the name of the directory in which the build procedure installed
1624 Emacs's info files; the default value for `Info-default-directory-list'
1626 Vconfigure_info_directory
= build_string (PATH_INFO
);
1628 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1629 doc
: /* Directory of score files for games which come with GNU Emacs.
1630 If this variable is nil, then Emacs is unable to use a shared directory. */);
1632 Vshared_game_score_directory
= Qnil
;
1634 Vshared_game_score_directory
= build_string (PATH_GAME
);
1637 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1638 doc
: /* Pattern for making names for temporary files.
1639 This is used by `call-process-region'. */);
1640 /* This variable is initialized in init_callproc. */
1642 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1643 doc
: /* List of environment variables inherited from the parent process.
1644 Each element should be a string of the form ENVVARNAME=VALUE.
1645 The elements must normally be decoded (using `locale-coding-system') for use. */);
1646 Vinitial_environment
= Qnil
;
1648 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1649 doc
: /* List of overridden environment variables for subprocesses to inherit.
1650 Each element should be a string of the form ENVVARNAME=VALUE.
1652 Entries in this list take precedence to those in the frame-local
1653 environments. Therefore, let-binding `process-environment' is an easy
1654 way to temporarily change the value of an environment variable,
1655 irrespective of where it comes from. To use `process-environment' to
1656 remove an environment variable, include only its name in the list,
1659 This variable is set to nil when Emacs starts.
1661 If multiple entries define the same variable, the first one always
1664 Non-ASCII characters are encoded according to the initial value of
1665 `locale-coding-system', i.e. the elements must normally be decoded for
1668 See `setenv' and `getenv'. */);
1669 Vprocess_environment
= Qnil
;
1671 defsubr (&Scall_process
);
1672 defsubr (&Sgetenv_internal
);
1673 defsubr (&Scall_process_region
);
1676 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1677 (do not change this comment) */