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 noshare
char **environ
;
97 extern char **environ
;
102 #if !defined (USG) || defined (BSD_PGRPS)
104 #define setpgrp setpgid
108 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
109 Lisp_Object Vdata_directory
, Vdoc_directory
;
110 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
111 Lisp_Object Vtemp_file_name_pattern
;
113 Lisp_Object Vshell_file_name
;
115 Lisp_Object Vprocess_environment
, Vinitial_environment
;
118 Lisp_Object Qbuffer_file_type
;
121 /* True if we are about to fork off a synchronous process or if we
122 are waiting for it. */
123 int synch_process_alive
;
125 /* Nonzero => this is a string explaining death of synchronous subprocess. */
126 char *synch_process_death
;
128 /* Nonzero => this is the signal number that terminated the subprocess. */
129 int synch_process_termsig
;
131 /* If synch_process_death is zero,
132 this is exit code of synchronous subprocess. */
133 int synch_process_retcode
;
136 /* Clean up when exiting Fcall_process.
137 On MSDOS, delete the temporary file on any kind of termination.
138 On Unix, kill the process and any children on termination by signal. */
140 /* Nonzero if this is termination due to exit. */
141 static int call_process_exited
;
143 EXFUN (Fgetenv_internal
, 2);
145 #ifndef VMS /* VMS version is in vmsproc.c. */
148 call_process_kill (fdpid
)
151 emacs_close (XFASTINT (Fcar (fdpid
)));
152 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
153 synch_process_alive
= 0;
158 call_process_cleanup (fdpid
)
162 /* for MSDOS fdpid is really (fd . tempfile) */
163 register Lisp_Object file
;
165 emacs_close (XFASTINT (Fcar (fdpid
)));
166 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
167 unlink (SDATA (file
));
168 #else /* not MSDOS */
169 register int pid
= XFASTINT (Fcdr (fdpid
));
171 if (call_process_exited
)
173 emacs_close (XFASTINT (Fcar (fdpid
)));
177 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
179 int count
= SPECPDL_INDEX ();
180 record_unwind_protect (call_process_kill
, fdpid
);
181 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
184 wait_for_termination (pid
);
186 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
187 message1 ("Waiting for process to die...done");
189 synch_process_alive
= 0;
190 emacs_close (XFASTINT (Fcar (fdpid
)));
191 #endif /* not MSDOS */
195 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
196 doc
: /* Call PROGRAM synchronously in separate process.
197 The remaining arguments are optional.
198 The program's input comes from file INFILE (nil means `/dev/null').
199 Insert output in BUFFER before point; t means current buffer;
200 nil for BUFFER means discard it; 0 means discard and don't wait.
201 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
202 REAL-BUFFER says what to do with standard output, as above,
203 while STDERR-FILE says what to do with standard error in the child.
204 STDERR-FILE may be nil (discard standard error output),
205 t (mix it with ordinary output), or a file name string.
207 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
208 Remaining arguments are strings passed as command arguments to PROGRAM.
210 If executable PROGRAM can't be found as an executable, `call-process'
211 signals a Lisp error. `call-process' reports errors in execution of
212 the program only through its return and output.
214 If BUFFER is 0, `call-process' returns immediately with value nil.
215 Otherwise it waits for PROGRAM to terminate
216 and returns a numeric exit status or a signal description string.
217 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
219 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
222 register Lisp_Object
*args
;
224 Lisp_Object infile
, buffer
, current_dir
, path
;
229 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
230 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
231 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
232 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
233 int count
= SPECPDL_INDEX ();
235 register const unsigned char **new_argv
236 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
237 struct buffer
*old
= current_buffer
;
238 /* File to use for stderr in the child.
239 t means use same as standard output. */
240 Lisp_Object error_file
;
241 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
242 char *outf
, *tempfile
;
248 struct coding_system process_coding
; /* coding-system of process output */
249 struct coding_system argument_coding
; /* coding-system of arguments */
250 /* Set to the return value of Ffind_operation_coding_system. */
251 Lisp_Object coding_systems
;
253 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
256 CHECK_STRING (args
[0]);
261 /* Without asynchronous processes we cannot have BUFFER == 0. */
263 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
264 error ("Operating system cannot handle asynchronous subprocesses");
265 #endif /* subprocesses */
267 /* Decide the coding-system for giving arguments. */
269 Lisp_Object val
, *args2
;
272 /* If arguments are supplied, we may have to encode them. */
276 Lisp_Object coding_attrs
;
278 for (i
= 4; i
< nargs
; i
++)
279 CHECK_STRING (args
[i
]);
281 for (i
= 4; i
< nargs
; i
++)
282 if (STRING_MULTIBYTE (args
[i
]))
285 if (!NILP (Vcoding_system_for_write
))
286 val
= Vcoding_system_for_write
;
287 else if (! must_encode
)
291 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
292 args2
[0] = Qcall_process
;
293 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
294 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
295 if (CONSP (coding_systems
))
296 val
= XCDR (coding_systems
);
297 else if (CONSP (Vdefault_process_coding_system
))
298 val
= XCDR (Vdefault_process_coding_system
);
302 val
= coding_inherit_eol_type (val
, Qnil
);
303 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
304 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
305 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
307 /* We should not use an ASCII incompatible coding system. */
308 val
= raw_text_coding_system (val
);
309 setup_coding_system (val
, &argument_coding
);
314 if (nargs
>= 2 && ! NILP (args
[1]))
316 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
317 CHECK_STRING (infile
);
320 infile
= build_string (NULL_DEVICE
);
326 /* If BUFFER is a list, its meaning is
327 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
330 if (CONSP (XCDR (buffer
)))
332 Lisp_Object stderr_file
;
333 stderr_file
= XCAR (XCDR (buffer
));
335 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
336 error_file
= stderr_file
;
338 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
341 buffer
= XCAR (buffer
);
344 if (!(EQ (buffer
, Qnil
)
346 || INTEGERP (buffer
)))
348 Lisp_Object spec_buffer
;
349 spec_buffer
= buffer
;
350 buffer
= Fget_buffer_create (buffer
);
351 /* Mention the buffer name for a better error message. */
353 CHECK_BUFFER (spec_buffer
);
354 CHECK_BUFFER (buffer
);
360 /* Make sure that the child will be able to chdir to the current
361 buffer's current directory, or its unhandled equivalent. We
362 can't just have the child check for an error when it does the
363 chdir, since it's in a vfork.
365 We have to GCPRO around this because Fexpand_file_name,
366 Funhandled_file_name_directory, and Ffile_accessible_directory_p
367 might call a file name handling function. The argument list is
368 protected by the caller, so all we really have to worry about is
371 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
373 current_dir
= current_buffer
->directory
;
375 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
377 current_dir
= Funhandled_file_name_directory (current_dir
);
378 if (NILP (current_dir
))
379 /* If the file name handler says that current_dir is unreachable, use
380 a sensible default. */
381 current_dir
= build_string ("~/");
382 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
383 if (NILP (Ffile_accessible_directory_p (current_dir
)))
384 report_file_error ("Setting current directory",
385 Fcons (current_buffer
->directory
, Qnil
));
387 if (STRING_MULTIBYTE (infile
))
388 infile
= ENCODE_FILE (infile
);
389 if (STRING_MULTIBYTE (current_dir
))
390 current_dir
= ENCODE_FILE (current_dir
);
391 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
392 error_file
= ENCODE_FILE (error_file
);
396 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
398 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
401 infile
= DECODE_FILE (infile
);
402 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
404 /* Search for program; barf if not found. */
408 GCPRO1 (current_dir
);
409 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
414 emacs_close (filefd
);
415 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
418 /* If program file name starts with /: for quoting a magic name,
420 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
421 && SREF (path
, 1) == ':')
422 path
= Fsubstring (path
, make_number (2), Qnil
);
424 new_argv
[0] = SDATA (path
);
428 struct gcpro gcpro1
, gcpro2
, gcpro3
;
430 GCPRO3 (infile
, buffer
, current_dir
);
431 argument_coding
.dst_multibyte
= 0;
432 for (i
= 4; i
< nargs
; i
++)
434 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
435 if (CODING_REQUIRE_ENCODING (&argument_coding
))
436 /* We must encode this argument. */
437 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
438 new_argv
[i
- 3] = SDATA (args
[i
]);
441 new_argv
[nargs
- 3] = 0;
446 #ifdef MSDOS /* MW, July 1993 */
447 if ((outf
= egetenv ("TMPDIR")))
448 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
451 tempfile
= alloca (20);
454 dostounix_filename (tempfile
);
455 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
456 strcat (tempfile
, "/");
457 strcat (tempfile
, "detmp.XXX");
460 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
463 emacs_close (filefd
);
464 report_file_error ("Opening process output file",
465 Fcons (build_string (tempfile
), Qnil
));
471 if (INTEGERP (buffer
))
472 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
479 emacs_close (filefd
);
480 report_file_error ("Creating process pipe", Qnil
);
484 /* Replaced by close_process_descs */
485 set_exclusive_use (fd
[0]);
490 /* child_setup must clobber environ in systems with true vfork.
491 Protect it from permanent change. */
492 register char **save_environ
= environ
;
493 register int fd1
= fd
[1];
496 #if 0 /* Some systems don't have sigblock. */
497 mask
= sigblock (sigmask (SIGCHLD
));
500 /* Record that we're about to create a synchronous process. */
501 synch_process_alive
= 1;
503 /* These vars record information from process termination.
504 Clear them now before process can possibly terminate,
505 to avoid timing error if process terminates soon. */
506 synch_process_death
= 0;
507 synch_process_retcode
= 0;
508 synch_process_termsig
= 0;
510 if (NILP (error_file
))
511 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
512 else if (STRINGP (error_file
))
515 fd_error
= emacs_open (SDATA (error_file
),
516 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
518 #else /* not DOS_NT */
519 fd_error
= creat (SDATA (error_file
), 0666);
520 #endif /* not DOS_NT */
525 emacs_close (filefd
);
533 if (NILP (error_file
))
534 error_file
= build_string (NULL_DEVICE
);
535 else if (STRINGP (error_file
))
536 error_file
= DECODE_FILE (error_file
);
537 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
540 #ifdef MSDOS /* MW, July 1993 */
541 /* Note that on MSDOS `child_setup' actually returns the child process
542 exit status, not its PID, so we assign it to `synch_process_retcode'
544 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
547 /* Record that the synchronous process exited and note its
548 termination status. */
549 synch_process_alive
= 0;
550 synch_process_retcode
= pid
;
551 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
553 synchronize_system_messages_locale ();
554 synch_process_death
= strerror (errno
);
557 emacs_close (outfilefd
);
558 if (fd_error
!= outfilefd
)
559 emacs_close (fd_error
);
560 fd1
= -1; /* No harm in closing that one! */
561 /* Since CRLF is converted to LF within `decode_coding', we can
562 always open a file with binary mode. */
563 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
567 emacs_close (filefd
);
568 report_file_error ("Cannot re-open temporary file", Qnil
);
570 #else /* not MSDOS */
572 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
574 #else /* not WINDOWSNT */
586 #if defined (USG) && !defined (BSD_PGRPS)
591 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
596 #endif /* not WINDOWSNT */
598 /* The MSDOS case did this already. */
600 emacs_close (fd_error
);
601 #endif /* not MSDOS */
603 environ
= save_environ
;
605 /* Close most of our fd's, but not fd[0]
606 since we will use that to read input from. */
607 emacs_close (filefd
);
608 if (fd1
>= 0 && fd1
!= fd_error
)
616 report_file_error ("Doing vfork", Qnil
);
619 if (INTEGERP (buffer
))
624 /* If Emacs has been built with asynchronous subprocess support,
625 we don't need to do this, I think because it will then have
626 the facilities for handling SIGCHLD. */
627 wait_without_blocking ();
628 #endif /* subprocesses */
632 /* Enable sending signal if user quits below. */
633 call_process_exited
= 0;
636 /* MSDOS needs different cleanup information. */
637 record_unwind_protect (call_process_cleanup
,
638 Fcons (make_number (fd
[0]), build_string (tempfile
)));
640 record_unwind_protect (call_process_cleanup
,
641 Fcons (make_number (fd
[0]), make_number (pid
)));
642 #endif /* not MSDOS */
645 if (BUFFERP (buffer
))
646 Fset_buffer (buffer
);
650 /* If BUFFER is nil, we must read process output once and then
651 discard it, so setup coding system but with nil. */
652 setup_coding_system (Qnil
, &process_coding
);
656 Lisp_Object val
, *args2
;
659 if (!NILP (Vcoding_system_for_read
))
660 val
= Vcoding_system_for_read
;
663 if (EQ (coding_systems
, Qt
))
667 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
668 args2
[0] = Qcall_process
;
669 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
671 = Ffind_operation_coding_system (nargs
+ 1, args2
);
673 if (CONSP (coding_systems
))
674 val
= XCAR (coding_systems
);
675 else if (CONSP (Vdefault_process_coding_system
))
676 val
= XCAR (Vdefault_process_coding_system
);
680 Fcheck_coding_system (val
);
681 /* In unibyte mode, character code conversion should not take
682 place but EOL conversion should. So, setup raw-text or one
683 of the subsidiary according to the information just setup. */
684 if (NILP (current_buffer
->enable_multibyte_characters
)
686 val
= raw_text_coding_system (val
);
687 setup_coding_system (val
, &process_coding
);
698 int display_on_the_fly
= display_p
;
699 struct coding_system saved_coding
;
701 saved_coding
= process_coding
;
704 /* Repeatedly read until we've filled as much as possible
705 of the buffer size we have. But don't read
706 less than 1024--save that for the next bufferful. */
708 while (nread
< bufsize
- 1024)
710 int this_read
= emacs_read (fd
[0], buf
+ nread
,
718 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
723 total_read
+= this_read
;
725 if (display_on_the_fly
)
729 /* Now NREAD is the total amount of data in the buffer. */
734 if (NILP (current_buffer
->enable_multibyte_characters
)
735 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
736 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
738 { /* We have to decode the input. */
741 XSETBUFFER (curbuf
, current_buffer
);
742 decode_coding_c_string (&process_coding
, buf
, nread
,
744 if (display_on_the_fly
745 && CODING_REQUIRE_DETECTION (&saved_coding
)
746 && ! CODING_REQUIRE_DETECTION (&process_coding
))
748 /* We have detected some coding system. But,
749 there's a possibility that the detection was
750 done by insufficient data. So, we give up
751 displaying on the fly. */
752 if (process_coding
.produced
> 0)
753 del_range_2 (process_coding
.dst_pos
,
754 process_coding
.dst_pos_byte
,
755 process_coding
.dst_pos
756 + process_coding
.produced_char
,
757 process_coding
.dst_pos_byte
758 + process_coding
.produced
, 0);
759 display_on_the_fly
= 0;
760 process_coding
= saved_coding
;
762 /* This is to make the above condition always
763 fails in the future. */
764 saved_coding
.common_flags
765 &= ~CODING_REQUIRE_DETECTION_MASK
;
769 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
770 PT_BYTE
+ process_coding
.produced
);
771 carryover
= process_coding
.carryover_bytes
;
773 /* As CARRYOVER should not be that large, we had
774 better avoid overhead of bcopy. */
775 BCOPY_SHORT (process_coding
.carryover
, buf
,
776 process_coding
.carryover_bytes
);
780 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
783 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
784 /* Make the buffer bigger as we continue to read more data,
785 but not past CALLPROC_BUFFER_SIZE_MAX. */
786 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
787 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
788 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
794 prepare_menu_bars ();
796 redisplay_preserve_echo_area (1);
797 /* This variable might have been set to 0 for code
798 detection. In that case, we set it back to 1 because
799 we should have already detected a coding system. */
800 display_on_the_fly
= 1;
807 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
808 /* If the caller required, let the buffer inherit the
809 coding-system used to decode the process output. */
810 if (inherit_process_coding_system
)
811 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
812 make_number (total_read
));
815 /* Wait for it to terminate, unless it already has. */
816 wait_for_termination (pid
);
820 set_buffer_internal (old
);
822 /* Don't kill any children that the subprocess may have left behind
824 call_process_exited
= 1;
826 unbind_to (count
, Qnil
);
828 if (synch_process_termsig
)
832 synchronize_system_messages_locale ();
833 signame
= strsignal (synch_process_termsig
);
838 synch_process_death
= signame
;
841 if (synch_process_death
)
842 return code_convert_string_norecord (build_string (synch_process_death
),
843 Vlocale_coding_system
, 0);
844 return make_number (synch_process_retcode
);
849 delete_temp_file (name
)
852 /* Suppress jka-compr handling, etc. */
853 int count
= SPECPDL_INDEX ();
854 specbind (intern ("file-name-handler-alist"), Qnil
);
855 internal_delete_file (name
);
856 unbind_to (count
, Qnil
);
860 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
862 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
863 The remaining arguments are optional.
864 Delete the text if fourth arg DELETE is non-nil.
866 Insert output in BUFFER before point; t means current buffer;
867 nil for BUFFER means discard it; 0 means discard and don't wait.
868 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
869 REAL-BUFFER says what to do with standard output, as above,
870 while STDERR-FILE says what to do with standard error in the child.
871 STDERR-FILE may be nil (discard standard error output),
872 t (mix it with ordinary output), or a file name string.
874 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
875 Remaining args are passed to PROGRAM at startup as command args.
877 If BUFFER is 0, `call-process-region' returns immediately with value nil.
878 Otherwise it waits for PROGRAM to terminate
879 and returns a numeric exit status or a signal description string.
880 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
882 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
885 register Lisp_Object
*args
;
888 Lisp_Object filename_string
;
889 register Lisp_Object start
, end
;
890 int count
= SPECPDL_INDEX ();
891 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
892 Lisp_Object coding_systems
;
893 Lisp_Object val
, *args2
;
899 if ((outf
= egetenv ("TMPDIR"))
900 || (outf
= egetenv ("TMP"))
901 || (outf
= egetenv ("TEMP")))
902 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
905 tempfile
= alloca (20);
908 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
909 strcat (tempfile
, "/");
910 if ('/' == DIRECTORY_SEP
)
911 dostounix_filename (tempfile
);
913 unixtodos_filename (tempfile
);
915 strcat (tempfile
, "emXXXXXX");
917 strcat (tempfile
, "detmp.XXX");
919 #else /* not DOS_NT */
920 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
921 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
922 SBYTES (Vtemp_file_name_pattern
) + 1);
923 #endif /* not DOS_NT */
932 fd
= mkstemp (tempfile
);
935 report_file_error ("Failed to open temporary file",
936 Fcons (Vtemp_file_name_pattern
, Qnil
));
944 filename_string
= build_string (tempfile
);
945 GCPRO1 (filename_string
);
948 /* Decide coding-system of the contents of the temporary file. */
949 if (!NILP (Vcoding_system_for_write
))
950 val
= Vcoding_system_for_write
;
951 else if (NILP (current_buffer
->enable_multibyte_characters
))
955 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
956 args2
[0] = Qcall_process_region
;
957 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
958 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
959 if (CONSP (coding_systems
))
960 val
= XCDR (coding_systems
);
961 else if (CONSP (Vdefault_process_coding_system
))
962 val
= XCDR (Vdefault_process_coding_system
);
968 int count1
= SPECPDL_INDEX ();
970 specbind (intern ("coding-system-for-write"), val
);
971 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
972 happen to get a ".Z" suffix. */
973 specbind (intern ("file-name-handler-alist"), Qnil
);
974 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
976 unbind_to (count1
, Qnil
);
979 /* Note that Fcall_process takes care of binding
980 coding-system-for-read. */
982 record_unwind_protect (delete_temp_file
, filename_string
);
984 if (nargs
> 3 && !NILP (args
[3]))
985 Fdelete_region (start
, end
);
997 args
[1] = filename_string
;
999 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1002 #ifndef VMS /* VMS version is in vmsproc.c. */
1004 static int relocate_fd ();
1007 add_env (char **env
, char **new_env
, char *string
)
1014 /* See if this string duplicates any string already in the env.
1015 If so, don't put it in.
1016 When an env var has multiple definitions,
1017 we keep the definition that comes first in process-environment. */
1018 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1020 char *p
= *ep
, *q
= string
;
1026 /* The string is a lone variable name; keep it for now, we
1027 will remove it later. It is a placeholder for a
1028 variable that is not to be included in the environment. */
1036 *new_env
++ = string
;
1040 /* This is the last thing run in a newly forked inferior
1041 either synchronous or asynchronous.
1042 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1043 Initialize inferior's priority, pgrp, connected dir and environment.
1044 then exec another program based on new_argv.
1046 This function may change environ for the superior process.
1047 Therefore, the superior process must save and restore the value
1048 of environ around the vfork and the call to this function.
1050 SET_PGRP is nonzero if we should put the subprocess into a separate
1053 CURRENT_DIR is an elisp string giving the path of the current
1054 directory the subprocess should have. Since we can't really signal
1055 a decent error from within the child, this should be verified as an
1056 executable directory by the parent. */
1059 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1061 register char **new_argv
;
1063 Lisp_Object current_dir
;
1070 #endif /* WINDOWSNT */
1072 int pid
= getpid ();
1074 #ifdef SET_EMACS_PRIORITY
1076 extern EMACS_INT emacs_priority
;
1078 if (emacs_priority
< 0)
1079 nice (- emacs_priority
);
1084 /* Close Emacs's descriptors that this process should not have. */
1085 close_process_descs ();
1087 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1088 we will lose if we call close_load_descs here. */
1090 close_load_descs ();
1093 /* Note that use of alloca is always safe here. It's obvious for systems
1094 that do not have true vfork or that have true (stack) alloca.
1095 If using vfork and C_ALLOCA (when Emacs used to include
1096 src/alloca.c) it is safe because that changes the superior's
1097 static variables as if the superior had done alloca and will be
1098 cleaned up in the usual way. */
1100 register char *temp
;
1103 i
= SBYTES (current_dir
);
1105 /* MSDOS must have all environment variables malloc'ed, because
1106 low-level libc functions that launch subsidiary processes rely
1108 pwd_var
= (char *) xmalloc (i
+ 6);
1110 pwd_var
= (char *) alloca (i
+ 6);
1113 bcopy ("PWD=", pwd_var
, 4);
1114 bcopy (SDATA (current_dir
), temp
, i
);
1115 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1119 /* We can't signal an Elisp error here; we're in a vfork. Since
1120 the callers check the current directory before forking, this
1121 should only return an error if the directory's permissions
1122 are changed between the check and this chdir, but we should
1124 if (chdir (temp
) < 0)
1129 /* Get past the drive letter, so that d:/ is left alone. */
1130 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1137 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1138 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1142 /* Set `env' to a vector of the strings in the environment. */
1144 register Lisp_Object tem
;
1145 register char **new_env
;
1147 register int new_length
;
1148 Lisp_Object display
= Qnil
;
1152 for (tem
= Vprocess_environment
;
1153 CONSP (tem
) && STRINGP (XCAR (tem
));
1156 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1157 && (SDATA (XCAR (tem
)) [7] == '\0'
1158 || SDATA (XCAR (tem
)) [7] == '='))
1159 /* DISPLAY is specified in process-environment. */
1164 /* If not provided yet, use the frame's DISPLAY. */
1167 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1168 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1169 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1170 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1171 Vinitial_environment
);
1179 /* new_length + 2 to include PWD and terminating 0. */
1180 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1181 /* If we have a PWD envvar, pass one down,
1182 but with corrected value. */
1183 if (egetenv ("PWD"))
1184 *new_env
++ = pwd_var
;
1186 if (STRINGP (display
))
1188 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1189 char *vdata
= (char *) alloca (vlen
);
1190 strcpy (vdata
, "DISPLAY=");
1191 strcat (vdata
, SDATA (display
));
1192 new_env
= add_env (env
, new_env
, vdata
);
1196 for (tem
= Vprocess_environment
;
1197 CONSP (tem
) && STRINGP (XCAR (tem
));
1199 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1203 /* Remove variable names without values. */
1207 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1217 prepare_standard_handles (in
, out
, err
, handles
);
1218 set_process_dir (SDATA (current_dir
));
1219 #else /* not WINDOWSNT */
1220 /* Make sure that in, out, and err are not actually already in
1221 descriptors zero, one, or two; this could happen if Emacs is
1222 started with its standard in, out, or error closed, as might
1225 int oin
= in
, oout
= out
;
1227 /* We have to avoid relocating the same descriptor twice! */
1229 in
= relocate_fd (in
, 3);
1234 out
= relocate_fd (out
, 3);
1238 else if (err
== oout
)
1241 err
= relocate_fd (err
, 3);
1255 #endif /* not MSDOS */
1256 #endif /* not WINDOWSNT */
1258 #if defined(USG) && !defined(BSD_PGRPS)
1259 #ifndef SETPGRP_RELEASES_CTTY
1260 setpgrp (); /* No arguments but equivalent in this case */
1265 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1266 EMACS_SET_TTY_PGRP (0, &pid
);
1269 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1272 /* An error occurred while trying to run the subprocess. */
1273 report_file_error ("Spawning child process", Qnil
);
1275 #else /* not MSDOS */
1277 /* Spawn the child. (See ntproc.c:Spawnve). */
1278 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1279 reset_standard_handles (in
, out
, err
, handles
);
1281 /* An error occurred while trying to spawn the process. */
1282 report_file_error ("Spawning child process", Qnil
);
1284 #else /* not WINDOWSNT */
1285 /* execvp does not accept an environment arg so the only way
1286 to pass this environment is to set environ. Our caller
1287 is responsible for restoring the ambient value of environ. */
1289 execvp (new_argv
[0], new_argv
);
1291 emacs_write (1, "Can't exec program: ", 20);
1292 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1293 emacs_write (1, "\n", 1);
1295 #endif /* not WINDOWSNT */
1296 #endif /* not MSDOS */
1299 /* Move the file descriptor FD so that its number is not less than MINFD.
1300 If the file descriptor is moved at all, the original is freed. */
1302 relocate_fd (fd
, minfd
)
1312 char *message1
= "Error while setting up child: ";
1313 char *errmessage
= strerror (errno
);
1314 char *message2
= "\n";
1315 emacs_write (2, message1
, strlen (message1
));
1316 emacs_write (2, errmessage
, strlen (errmessage
));
1317 emacs_write (2, message2
, strlen (message2
));
1320 /* Note that we hold the original FD open while we recurse,
1321 to guarantee we'll get a new FD if we need it. */
1322 new = relocate_fd (new, minfd
);
1329 getenv_internal_1 (var
, varlen
, value
, valuelen
, env
)
1336 for (; CONSP (env
); env
= XCDR (env
))
1338 Lisp_Object entry
= XCAR (env
);
1340 && SBYTES (entry
) >= varlen
1342 /* NT environment variables are case insensitive. */
1343 && ! strnicmp (SDATA (entry
), var
, varlen
)
1344 #else /* not WINDOWSNT */
1345 && ! bcmp (SDATA (entry
), var
, varlen
)
1346 #endif /* not WINDOWSNT */
1349 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1351 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1352 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1355 else if (SBYTES (entry
) == varlen
)
1357 /* Lone variable names in Vprocess_environment mean that
1358 variable should be removed from the environment. */
1368 getenv_internal (var
, varlen
, value
, valuelen
, frame
)
1375 /* Try to find VAR in Vprocess_environment first. */
1376 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1377 Vprocess_environment
))
1378 return *value
? 1 : 0;
1380 /* For DISPLAY try to get the values from the frame or the initial env. */
1381 if (strcmp (var
, "DISPLAY") == 0)
1384 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1385 if (STRINGP (display
))
1387 *value
= (char *) SDATA (display
);
1388 *valuelen
= SBYTES (display
);
1391 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1392 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1393 Vinitial_environment
))
1394 return *value
? 1 : 0;
1400 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1401 doc
: /* Get the value of environment variable VARIABLE.
1402 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1403 the environment. Otherwise, value is a string.
1405 This function searches `process-environment' for VARIABLE. If it is
1406 not found there, then it continues the search in the environment list
1407 of the selected frame.
1409 If optional parameter ENV is a list, then search this list instead of
1410 `process-environment', and return t when encountering a negative entry.
1412 If it is a frame, then this function will ignore `process-environment' and
1413 will simply look up the variable in that frame's environment. */)
1415 Lisp_Object variable
, env
;
1420 CHECK_STRING (variable
);
1423 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1424 &value
, &valuelen
, env
))
1425 return value
? make_string (value
, valuelen
) : Qt
;
1429 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1430 &value
, &valuelen
, env
))
1431 return make_string (value
, valuelen
);
1436 /* A version of getenv that consults the Lisp environment lists,
1437 easily callable from C. */
1445 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1451 #endif /* not VMS */
1453 /* This is run before init_cmdargs. */
1458 char *data_dir
= egetenv ("EMACSDATA");
1459 char *doc_dir
= egetenv ("EMACSDOC");
1462 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1465 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1468 /* Check the EMACSPATH environment variable, defaulting to the
1469 PATH_EXEC path from epaths.h. */
1470 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1471 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1472 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1475 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1480 char *data_dir
= egetenv ("EMACSDATA");
1483 Lisp_Object tempdir
;
1485 if (!NILP (Vinstallation_directory
))
1487 /* Add to the path the lib-src subdir of the installation dir. */
1489 tem
= Fexpand_file_name (build_string ("lib-src"),
1490 Vinstallation_directory
);
1492 /* MSDOS uses wrapped binaries, so don't do this. */
1493 if (NILP (Fmember (tem
, Vexec_path
)))
1495 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1496 Vexec_path
= Fcons (tem
, Vexec_path
);
1497 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1500 Vexec_directory
= Ffile_name_as_directory (tem
);
1501 #endif /* not DOS_NT */
1503 /* Maybe use ../etc as well as ../lib-src. */
1506 tem
= Fexpand_file_name (build_string ("etc"),
1507 Vinstallation_directory
);
1508 Vdoc_directory
= Ffile_name_as_directory (tem
);
1512 /* Look for the files that should be in etc. We don't use
1513 Vinstallation_directory, because these files are never installed
1514 near the executable, and they are never in the build
1515 directory when that's different from the source directory.
1517 Instead, if these files are not in the nominal place, we try the
1518 source directory. */
1521 Lisp_Object tem
, tem1
, srcdir
;
1523 srcdir
= Fexpand_file_name (build_string ("../src/"),
1524 build_string (PATH_DUMPLOADSEARCH
));
1525 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1526 tem1
= Ffile_exists_p (tem
);
1527 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1530 newdir
= Fexpand_file_name (build_string ("../etc/"),
1531 build_string (PATH_DUMPLOADSEARCH
));
1532 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1533 tem1
= Ffile_exists_p (tem
);
1535 Vdata_directory
= newdir
;
1543 tempdir
= Fdirectory_file_name (Vexec_directory
);
1544 if (access (SDATA (tempdir
), 0) < 0)
1545 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1549 tempdir
= Fdirectory_file_name (Vdata_directory
);
1550 if (access (SDATA (tempdir
), 0) < 0)
1551 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1555 Vshell_file_name
= build_string ("*dcl*");
1557 sh
= (char *) getenv ("SHELL");
1558 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1562 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1564 if (getenv ("TMPDIR"))
1566 char *dir
= getenv ("TMPDIR");
1567 Vtemp_file_name_pattern
1568 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1569 build_string (dir
));
1572 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1576 Vshared_game_score_directory
= Qnil
;
1578 Vshared_game_score_directory
= build_string (PATH_GAME
);
1579 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1580 Vshared_game_score_directory
= Qnil
;
1585 set_initial_environment ()
1587 register char **envp
;
1593 Vprocess_environment
= Qnil
;
1595 for (envp
= environ
; *envp
; envp
++)
1596 Vprocess_environment
= Fcons (build_string (*envp
),
1597 Vprocess_environment
);
1598 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1599 to use `delete' and friends on process-environment. */
1600 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1608 Qbuffer_file_type
= intern ("buffer-file-type");
1609 staticpro (&Qbuffer_file_type
);
1612 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1613 doc
: /* *File name to load inferior shells from.
1614 Initialized from the SHELL environment variable, or to a system-dependent
1615 default if SHELL is not set. */);
1617 DEFVAR_LISP ("exec-path", &Vexec_path
,
1618 doc
: /* *List of directories to search programs to run in subprocesses.
1619 Each element is a string (directory name) or nil (try default directory). */);
1621 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1622 doc
: /* *List of suffixes to try to find executable file names.
1623 Each element is a string. */);
1624 Vexec_suffixes
= Qnil
;
1626 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1627 doc
: /* Directory for executables for Emacs to invoke.
1628 More generally, this includes any architecture-dependent files
1629 that are built and installed from the Emacs distribution. */);
1631 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1632 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1633 These are files intended for Emacs to use while it runs. */);
1635 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1636 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1637 This is usually the same as `data-directory'. */);
1639 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1640 doc
: /* For internal use by the build procedure only.
1641 This is the name of the directory in which the build procedure installed
1642 Emacs's info files; the default value for `Info-default-directory-list'
1644 Vconfigure_info_directory
= build_string (PATH_INFO
);
1646 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1647 doc
: /* Directory of score files for games which come with GNU Emacs.
1648 If this variable is nil, then Emacs is unable to use a shared directory. */);
1650 Vshared_game_score_directory
= Qnil
;
1652 Vshared_game_score_directory
= build_string (PATH_GAME
);
1655 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1656 doc
: /* Pattern for making names for temporary files.
1657 This is used by `call-process-region'. */);
1658 /* This variable is initialized in init_callproc. */
1660 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1661 doc
: /* List of environment variables inherited from the parent process.
1662 Each element should be a string of the form ENVVARNAME=VALUE.
1663 The elements must normally be decoded (using `locale-coding-system') for use. */);
1664 Vinitial_environment
= Qnil
;
1666 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1667 doc
: /* List of overridden environment variables for subprocesses to inherit.
1668 Each element should be a string of the form ENVVARNAME=VALUE.
1670 Entries in this list take precedence to those in the frame-local
1671 environments. Therefore, let-binding `process-environment' is an easy
1672 way to temporarily change the value of an environment variable,
1673 irrespective of where it comes from. To use `process-environment' to
1674 remove an environment variable, include only its name in the list,
1677 This variable is set to nil when Emacs starts.
1679 If multiple entries define the same variable, the first one always
1682 Non-ASCII characters are encoded according to the initial value of
1683 `locale-coding-system', i.e. the elements must normally be decoded for
1686 See `setenv' and `getenv'. */);
1687 Vprocess_environment
= Qnil
;
1690 defsubr (&Scall_process
);
1691 defsubr (&Sgetenv_internal
);
1693 defsubr (&Scall_process_region
);
1696 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1697 (do not change this comment) */