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 struct buffer
*old
= current_buffer
;
231 /* File to use for stderr in the child.
232 t means use same as standard output. */
233 Lisp_Object error_file
;
234 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
235 char *outf
, *tempfile
;
238 struct coding_system process_coding
; /* coding-system of process output */
239 struct coding_system argument_coding
; /* coding-system of arguments */
240 /* Set to the return value of Ffind_operation_coding_system. */
241 Lisp_Object coding_systems
;
243 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
246 CHECK_STRING (args
[0]);
251 /* Without asynchronous processes we cannot have BUFFER == 0. */
253 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
254 error ("Operating system cannot handle asynchronous subprocesses");
255 #endif /* subprocesses */
257 /* Decide the coding-system for giving arguments. */
259 Lisp_Object val
, *args2
;
262 /* If arguments are supplied, we may have to encode them. */
266 Lisp_Object coding_attrs
;
268 for (i
= 4; i
< nargs
; i
++)
269 CHECK_STRING (args
[i
]);
271 for (i
= 4; i
< nargs
; i
++)
272 if (STRING_MULTIBYTE (args
[i
]))
275 if (!NILP (Vcoding_system_for_write
))
276 val
= Vcoding_system_for_write
;
277 else if (! must_encode
)
281 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
282 args2
[0] = Qcall_process
;
283 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
284 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
285 if (CONSP (coding_systems
))
286 val
= XCDR (coding_systems
);
287 else if (CONSP (Vdefault_process_coding_system
))
288 val
= XCDR (Vdefault_process_coding_system
);
292 val
= coding_inherit_eol_type (val
, Qnil
);
293 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
294 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
295 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
297 /* We should not use an ASCII incompatible coding system. */
298 val
= raw_text_coding_system (val
);
299 setup_coding_system (val
, &argument_coding
);
304 if (nargs
>= 2 && ! NILP (args
[1]))
306 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
307 CHECK_STRING (infile
);
310 infile
= build_string (NULL_DEVICE
);
316 /* If BUFFER is a list, its meaning is
317 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
320 if (CONSP (XCDR (buffer
)))
322 Lisp_Object stderr_file
;
323 stderr_file
= XCAR (XCDR (buffer
));
325 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
326 error_file
= stderr_file
;
328 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
331 buffer
= XCAR (buffer
);
334 if (!(EQ (buffer
, Qnil
)
336 || INTEGERP (buffer
)))
338 Lisp_Object spec_buffer
;
339 spec_buffer
= buffer
;
340 buffer
= Fget_buffer_create (buffer
);
341 /* Mention the buffer name for a better error message. */
343 CHECK_BUFFER (spec_buffer
);
344 CHECK_BUFFER (buffer
);
350 /* Make sure that the child will be able to chdir to the current
351 buffer's current directory, or its unhandled equivalent. We
352 can't just have the child check for an error when it does the
353 chdir, since it's in a vfork.
355 We have to GCPRO around this because Fexpand_file_name,
356 Funhandled_file_name_directory, and Ffile_accessible_directory_p
357 might call a file name handling function. The argument list is
358 protected by the caller, so all we really have to worry about is
361 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
363 current_dir
= current_buffer
->directory
;
365 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
367 current_dir
= Funhandled_file_name_directory (current_dir
);
368 if (NILP (current_dir
))
369 /* If the file name handler says that current_dir is unreachable, use
370 a sensible default. */
371 current_dir
= build_string ("~/");
372 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
373 current_dir
= Ffile_name_as_directory (current_dir
);
375 if (NILP (Ffile_accessible_directory_p (current_dir
)))
376 report_file_error ("Setting current directory",
377 Fcons (current_buffer
->directory
, Qnil
));
379 if (STRING_MULTIBYTE (infile
))
380 infile
= ENCODE_FILE (infile
);
381 if (STRING_MULTIBYTE (current_dir
))
382 current_dir
= ENCODE_FILE (current_dir
);
383 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
384 error_file
= ENCODE_FILE (error_file
);
388 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
390 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
393 infile
= DECODE_FILE (infile
);
394 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
396 /* Search for program; barf if not found. */
400 GCPRO1 (current_dir
);
401 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
406 emacs_close (filefd
);
407 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
410 /* If program file name starts with /: for quoting a magic name,
412 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
413 && SREF (path
, 1) == ':')
414 path
= Fsubstring (path
, make_number (2), Qnil
);
416 new_argv
= (const unsigned char **)
417 alloca (max (2, nargs
- 2) * sizeof (char *));
421 struct gcpro gcpro1
, gcpro2
, gcpro3
;
423 GCPRO3 (infile
, buffer
, current_dir
);
424 argument_coding
.dst_multibyte
= 0;
425 for (i
= 4; i
< nargs
; i
++)
427 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
428 if (CODING_REQUIRE_ENCODING (&argument_coding
))
429 /* We must encode this argument. */
430 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
433 for (i
= 4; i
< nargs
; i
++)
434 new_argv
[i
- 3] = SDATA (args
[i
]);
439 new_argv
[0] = SDATA (path
);
441 #ifdef MSDOS /* MW, July 1993 */
442 if ((outf
= egetenv ("TMPDIR")))
443 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
446 tempfile
= alloca (20);
449 dostounix_filename (tempfile
);
450 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
451 strcat (tempfile
, "/");
452 strcat (tempfile
, "detmp.XXX");
455 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
458 emacs_close (filefd
);
459 report_file_error ("Opening process output file",
460 Fcons (build_string (tempfile
), Qnil
));
466 if (INTEGERP (buffer
))
467 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
474 emacs_close (filefd
);
475 report_file_error ("Creating process pipe", Qnil
);
481 /* child_setup must clobber environ in systems with true vfork.
482 Protect it from permanent change. */
483 register char **save_environ
= environ
;
484 register int fd1
= fd
[1];
487 #if 0 /* Some systems don't have sigblock. */
488 mask
= sigblock (sigmask (SIGCHLD
));
491 /* Record that we're about to create a synchronous process. */
492 synch_process_alive
= 1;
494 /* These vars record information from process termination.
495 Clear them now before process can possibly terminate,
496 to avoid timing error if process terminates soon. */
497 synch_process_death
= 0;
498 synch_process_retcode
= 0;
499 synch_process_termsig
= 0;
501 if (NILP (error_file
))
502 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
503 else if (STRINGP (error_file
))
506 fd_error
= emacs_open (SDATA (error_file
),
507 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
509 #else /* not DOS_NT */
510 fd_error
= creat (SDATA (error_file
), 0666);
511 #endif /* not DOS_NT */
516 emacs_close (filefd
);
524 if (NILP (error_file
))
525 error_file
= build_string (NULL_DEVICE
);
526 else if (STRINGP (error_file
))
527 error_file
= DECODE_FILE (error_file
);
528 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
531 #ifdef MSDOS /* MW, July 1993 */
532 /* Note that on MSDOS `child_setup' actually returns the child process
533 exit status, not its PID, so we assign it to `synch_process_retcode'
535 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
538 /* Record that the synchronous process exited and note its
539 termination status. */
540 synch_process_alive
= 0;
541 synch_process_retcode
= pid
;
542 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
544 synchronize_system_messages_locale ();
545 synch_process_death
= strerror (errno
);
548 emacs_close (outfilefd
);
549 if (fd_error
!= outfilefd
)
550 emacs_close (fd_error
);
551 fd1
= -1; /* No harm in closing that one! */
552 /* Since CRLF is converted to LF within `decode_coding', we can
553 always open a file with binary mode. */
554 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
558 emacs_close (filefd
);
559 report_file_error ("Cannot re-open temporary file", Qnil
);
561 #else /* not MSDOS */
563 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
565 #else /* not WINDOWSNT */
577 #if defined (USG) && !defined (BSD_PGRPS)
582 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
587 #endif /* not WINDOWSNT */
589 /* The MSDOS case did this already. */
591 emacs_close (fd_error
);
592 #endif /* not MSDOS */
594 environ
= save_environ
;
596 /* Close most of our fd's, but not fd[0]
597 since we will use that to read input from. */
598 emacs_close (filefd
);
599 if (fd1
>= 0 && fd1
!= fd_error
)
607 report_file_error ("Doing vfork", Qnil
);
610 if (INTEGERP (buffer
))
615 /* If Emacs has been built with asynchronous subprocess support,
616 we don't need to do this, I think because it will then have
617 the facilities for handling SIGCHLD. */
618 wait_without_blocking ();
619 #endif /* subprocesses */
623 /* Enable sending signal if user quits below. */
624 call_process_exited
= 0;
627 /* MSDOS needs different cleanup information. */
628 record_unwind_protect (call_process_cleanup
,
629 Fcons (make_number (fd
[0]), build_string (tempfile
)));
631 record_unwind_protect (call_process_cleanup
,
632 Fcons (make_number (fd
[0]), make_number (pid
)));
633 #endif /* not MSDOS */
636 if (BUFFERP (buffer
))
637 Fset_buffer (buffer
);
641 /* If BUFFER is nil, we must read process output once and then
642 discard it, so setup coding system but with nil. */
643 setup_coding_system (Qnil
, &process_coding
);
647 Lisp_Object val
, *args2
;
650 if (!NILP (Vcoding_system_for_read
))
651 val
= Vcoding_system_for_read
;
654 if (EQ (coding_systems
, Qt
))
658 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
659 args2
[0] = Qcall_process
;
660 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
662 = Ffind_operation_coding_system (nargs
+ 1, args2
);
664 if (CONSP (coding_systems
))
665 val
= XCAR (coding_systems
);
666 else if (CONSP (Vdefault_process_coding_system
))
667 val
= XCAR (Vdefault_process_coding_system
);
671 Fcheck_coding_system (val
);
672 /* In unibyte mode, character code conversion should not take
673 place but EOL conversion should. So, setup raw-text or one
674 of the subsidiary according to the information just setup. */
675 if (NILP (current_buffer
->enable_multibyte_characters
)
677 val
= raw_text_coding_system (val
);
678 setup_coding_system (val
, &process_coding
);
689 int display_on_the_fly
= display_p
;
690 struct coding_system saved_coding
;
692 saved_coding
= process_coding
;
695 /* Repeatedly read until we've filled as much as possible
696 of the buffer size we have. But don't read
697 less than 1024--save that for the next bufferful. */
699 while (nread
< bufsize
- 1024)
701 int this_read
= emacs_read (fd
[0], buf
+ nread
,
709 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
714 total_read
+= this_read
;
716 if (display_on_the_fly
)
720 /* Now NREAD is the total amount of data in the buffer. */
725 if (NILP (current_buffer
->enable_multibyte_characters
)
726 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
727 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
729 { /* We have to decode the input. */
732 XSETBUFFER (curbuf
, current_buffer
);
733 decode_coding_c_string (&process_coding
, buf
, nread
,
735 if (display_on_the_fly
736 && CODING_REQUIRE_DETECTION (&saved_coding
)
737 && ! CODING_REQUIRE_DETECTION (&process_coding
))
739 /* We have detected some coding system. But,
740 there's a possibility that the detection was
741 done by insufficient data. So, we give up
742 displaying on the fly. */
743 if (process_coding
.produced
> 0)
744 del_range_2 (process_coding
.dst_pos
,
745 process_coding
.dst_pos_byte
,
746 process_coding
.dst_pos
747 + process_coding
.produced_char
,
748 process_coding
.dst_pos_byte
749 + process_coding
.produced
, 0);
750 display_on_the_fly
= 0;
751 process_coding
= saved_coding
;
753 /* This is to make the above condition always
754 fails in the future. */
755 saved_coding
.common_flags
756 &= ~CODING_REQUIRE_DETECTION_MASK
;
760 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
761 PT_BYTE
+ process_coding
.produced
);
762 carryover
= process_coding
.carryover_bytes
;
764 /* As CARRYOVER should not be that large, we had
765 better avoid overhead of bcopy. */
766 BCOPY_SHORT (process_coding
.carryover
, buf
,
767 process_coding
.carryover_bytes
);
771 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
774 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
775 /* Make the buffer bigger as we continue to read more data,
776 but not past CALLPROC_BUFFER_SIZE_MAX. */
777 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
778 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
779 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
785 prepare_menu_bars ();
787 redisplay_preserve_echo_area (1);
788 /* This variable might have been set to 0 for code
789 detection. In that case, we set it back to 1 because
790 we should have already detected a coding system. */
791 display_on_the_fly
= 1;
798 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
799 /* If the caller required, let the buffer inherit the
800 coding-system used to decode the process output. */
801 if (inherit_process_coding_system
)
802 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
803 make_number (total_read
));
806 /* Wait for it to terminate, unless it already has. */
807 wait_for_termination (pid
);
811 set_buffer_internal (old
);
813 /* Don't kill any children that the subprocess may have left behind
815 call_process_exited
= 1;
817 unbind_to (count
, Qnil
);
819 if (synch_process_termsig
)
823 synchronize_system_messages_locale ();
824 signame
= strsignal (synch_process_termsig
);
829 synch_process_death
= signame
;
832 if (synch_process_death
)
833 return code_convert_string_norecord (build_string (synch_process_death
),
834 Vlocale_coding_system
, 0);
835 return make_number (synch_process_retcode
);
839 delete_temp_file (name
)
842 /* Suppress jka-compr handling, etc. */
843 int count
= SPECPDL_INDEX ();
844 specbind (intern ("file-name-handler-alist"), Qnil
);
845 internal_delete_file (name
);
846 unbind_to (count
, Qnil
);
850 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
852 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
853 The remaining arguments are optional.
854 Delete the text if fourth arg DELETE is non-nil.
856 Insert output in BUFFER before point; t means current buffer;
857 nil for BUFFER means discard it; 0 means discard and don't wait.
858 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
859 REAL-BUFFER says what to do with standard output, as above,
860 while STDERR-FILE says what to do with standard error in the child.
861 STDERR-FILE may be nil (discard standard error output),
862 t (mix it with ordinary output), or a file name string.
864 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
865 Remaining args are passed to PROGRAM at startup as command args.
867 If BUFFER is 0, `call-process-region' returns immediately with value nil.
868 Otherwise it waits for PROGRAM to terminate
869 and returns a numeric exit status or a signal description string.
870 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
872 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
875 register Lisp_Object
*args
;
878 Lisp_Object filename_string
;
879 register Lisp_Object start
, end
;
880 int count
= SPECPDL_INDEX ();
881 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
882 Lisp_Object coding_systems
;
883 Lisp_Object val
, *args2
;
889 if ((outf
= egetenv ("TMPDIR"))
890 || (outf
= egetenv ("TMP"))
891 || (outf
= egetenv ("TEMP")))
892 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
895 tempfile
= alloca (20);
898 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
899 strcat (tempfile
, "/");
900 if ('/' == DIRECTORY_SEP
)
901 dostounix_filename (tempfile
);
903 unixtodos_filename (tempfile
);
905 strcat (tempfile
, "emXXXXXX");
907 strcat (tempfile
, "detmp.XXX");
909 #else /* not DOS_NT */
910 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
911 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
912 SBYTES (Vtemp_file_name_pattern
) + 1);
913 #endif /* not DOS_NT */
922 fd
= mkstemp (tempfile
);
925 report_file_error ("Failed to open temporary file",
926 Fcons (Vtemp_file_name_pattern
, Qnil
));
934 filename_string
= build_string (tempfile
);
935 GCPRO1 (filename_string
);
938 /* Decide coding-system of the contents of the temporary file. */
939 if (!NILP (Vcoding_system_for_write
))
940 val
= Vcoding_system_for_write
;
941 else if (NILP (current_buffer
->enable_multibyte_characters
))
945 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
946 args2
[0] = Qcall_process_region
;
947 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
948 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
949 if (CONSP (coding_systems
))
950 val
= XCDR (coding_systems
);
951 else if (CONSP (Vdefault_process_coding_system
))
952 val
= XCDR (Vdefault_process_coding_system
);
958 int count1
= SPECPDL_INDEX ();
960 specbind (intern ("coding-system-for-write"), val
);
961 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
962 happen to get a ".Z" suffix. */
963 specbind (intern ("file-name-handler-alist"), Qnil
);
964 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
966 unbind_to (count1
, Qnil
);
969 /* Note that Fcall_process takes care of binding
970 coding-system-for-read. */
972 record_unwind_protect (delete_temp_file
, filename_string
);
974 if (nargs
> 3 && !NILP (args
[3]))
975 Fdelete_region (start
, end
);
987 args
[1] = filename_string
;
989 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
992 static int relocate_fd ();
995 add_env (char **env
, char **new_env
, char *string
)
1002 /* See if this string duplicates any string already in the env.
1003 If so, don't put it in.
1004 When an env var has multiple definitions,
1005 we keep the definition that comes first in process-environment. */
1006 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1008 char *p
= *ep
, *q
= string
;
1014 /* The string is a lone variable name; keep it for now, we
1015 will remove it later. It is a placeholder for a
1016 variable that is not to be included in the environment. */
1024 *new_env
++ = string
;
1028 /* This is the last thing run in a newly forked inferior
1029 either synchronous or asynchronous.
1030 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1031 Initialize inferior's priority, pgrp, connected dir and environment.
1032 then exec another program based on new_argv.
1034 This function may change environ for the superior process.
1035 Therefore, the superior process must save and restore the value
1036 of environ around the vfork and the call to this function.
1038 SET_PGRP is nonzero if we should put the subprocess into a separate
1041 CURRENT_DIR is an elisp string giving the path of the current
1042 directory the subprocess should have. Since we can't really signal
1043 a decent error from within the child, this should be verified as an
1044 executable directory by the parent. */
1047 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1049 register char **new_argv
;
1051 Lisp_Object current_dir
;
1058 #endif /* WINDOWSNT */
1060 int pid
= getpid ();
1062 #ifdef SET_EMACS_PRIORITY
1064 extern EMACS_INT emacs_priority
;
1066 if (emacs_priority
< 0)
1067 nice (- emacs_priority
);
1072 /* Close Emacs's descriptors that this process should not have. */
1073 close_process_descs ();
1075 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1076 we will lose if we call close_load_descs here. */
1078 close_load_descs ();
1081 /* Note that use of alloca is always safe here. It's obvious for systems
1082 that do not have true vfork or that have true (stack) alloca.
1083 If using vfork and C_ALLOCA (when Emacs used to include
1084 src/alloca.c) it is safe because that changes the superior's
1085 static variables as if the superior had done alloca and will be
1086 cleaned up in the usual way. */
1088 register char *temp
;
1091 i
= SBYTES (current_dir
);
1093 /* MSDOS must have all environment variables malloc'ed, because
1094 low-level libc functions that launch subsidiary processes rely
1096 pwd_var
= (char *) xmalloc (i
+ 6);
1098 pwd_var
= (char *) alloca (i
+ 6);
1101 bcopy ("PWD=", pwd_var
, 4);
1102 bcopy (SDATA (current_dir
), temp
, i
);
1103 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1107 /* We can't signal an Elisp error here; we're in a vfork. Since
1108 the callers check the current directory before forking, this
1109 should only return an error if the directory's permissions
1110 are changed between the check and this chdir, but we should
1112 if (chdir (temp
) < 0)
1117 /* Get past the drive letter, so that d:/ is left alone. */
1118 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1125 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1126 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1130 /* Set `env' to a vector of the strings in the environment. */
1132 register Lisp_Object tem
;
1133 register char **new_env
;
1135 register int new_length
;
1136 Lisp_Object display
= Qnil
;
1140 for (tem
= Vprocess_environment
;
1141 CONSP (tem
) && STRINGP (XCAR (tem
));
1144 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1145 && (SDATA (XCAR (tem
)) [7] == '\0'
1146 || SDATA (XCAR (tem
)) [7] == '='))
1147 /* DISPLAY is specified in process-environment. */
1152 /* If not provided yet, use the frame's DISPLAY. */
1155 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1156 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1157 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1158 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1159 Vinitial_environment
);
1167 /* new_length + 2 to include PWD and terminating 0. */
1168 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1169 /* If we have a PWD envvar, pass one down,
1170 but with corrected value. */
1171 if (egetenv ("PWD"))
1172 *new_env
++ = pwd_var
;
1174 if (STRINGP (display
))
1176 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1177 char *vdata
= (char *) alloca (vlen
);
1178 strcpy (vdata
, "DISPLAY=");
1179 strcat (vdata
, SDATA (display
));
1180 new_env
= add_env (env
, new_env
, vdata
);
1184 for (tem
= Vprocess_environment
;
1185 CONSP (tem
) && STRINGP (XCAR (tem
));
1187 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1191 /* Remove variable names without values. */
1195 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1205 prepare_standard_handles (in
, out
, err
, handles
);
1206 set_process_dir (SDATA (current_dir
));
1207 #else /* not WINDOWSNT */
1208 /* Make sure that in, out, and err are not actually already in
1209 descriptors zero, one, or two; this could happen if Emacs is
1210 started with its standard in, out, or error closed, as might
1213 int oin
= in
, oout
= out
;
1215 /* We have to avoid relocating the same descriptor twice! */
1217 in
= relocate_fd (in
, 3);
1222 out
= relocate_fd (out
, 3);
1226 else if (err
== oout
)
1229 err
= relocate_fd (err
, 3);
1243 #endif /* not MSDOS */
1244 #endif /* not WINDOWSNT */
1246 #if defined(USG) && !defined(BSD_PGRPS)
1247 #ifndef SETPGRP_RELEASES_CTTY
1248 setpgrp (); /* No arguments but equivalent in this case */
1253 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1254 EMACS_SET_TTY_PGRP (0, &pid
);
1257 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1260 /* An error occurred while trying to run the subprocess. */
1261 report_file_error ("Spawning child process", Qnil
);
1263 #else /* not MSDOS */
1265 /* Spawn the child. (See ntproc.c:Spawnve). */
1266 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1267 reset_standard_handles (in
, out
, err
, handles
);
1269 /* An error occurred while trying to spawn the process. */
1270 report_file_error ("Spawning child process", Qnil
);
1272 #else /* not WINDOWSNT */
1273 /* execvp does not accept an environment arg so the only way
1274 to pass this environment is to set environ. Our caller
1275 is responsible for restoring the ambient value of environ. */
1277 execvp (new_argv
[0], new_argv
);
1279 emacs_write (1, "Can't exec program: ", 20);
1280 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1281 emacs_write (1, "\n", 1);
1283 #endif /* not WINDOWSNT */
1284 #endif /* not MSDOS */
1287 /* Move the file descriptor FD so that its number is not less than MINFD.
1288 If the file descriptor is moved at all, the original is freed. */
1290 relocate_fd (fd
, minfd
)
1300 char *message1
= "Error while setting up child: ";
1301 char *errmessage
= strerror (errno
);
1302 char *message2
= "\n";
1303 emacs_write (2, message1
, strlen (message1
));
1304 emacs_write (2, errmessage
, strlen (errmessage
));
1305 emacs_write (2, message2
, strlen (message2
));
1308 /* Note that we hold the original FD open while we recurse,
1309 to guarantee we'll get a new FD if we need it. */
1310 new = relocate_fd (new, minfd
);
1317 getenv_internal_1 (var
, varlen
, value
, valuelen
, env
)
1324 for (; CONSP (env
); env
= XCDR (env
))
1326 Lisp_Object entry
= XCAR (env
);
1328 && SBYTES (entry
) >= varlen
1330 /* NT environment variables are case insensitive. */
1331 && ! strnicmp (SDATA (entry
), var
, varlen
)
1332 #else /* not WINDOWSNT */
1333 && ! bcmp (SDATA (entry
), var
, varlen
)
1334 #endif /* not WINDOWSNT */
1337 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1339 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1340 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1343 else if (SBYTES (entry
) == varlen
)
1345 /* Lone variable names in Vprocess_environment mean that
1346 variable should be removed from the environment. */
1356 getenv_internal (var
, varlen
, value
, valuelen
, frame
)
1363 /* Try to find VAR in Vprocess_environment first. */
1364 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1365 Vprocess_environment
))
1366 return *value
? 1 : 0;
1368 /* For DISPLAY try to get the values from the frame or the initial env. */
1369 if (strcmp (var
, "DISPLAY") == 0)
1372 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1373 if (STRINGP (display
))
1375 *value
= (char *) SDATA (display
);
1376 *valuelen
= SBYTES (display
);
1379 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1380 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1381 Vinitial_environment
))
1382 return *value
? 1 : 0;
1388 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1389 doc
: /* Get the value of environment variable VARIABLE.
1390 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1391 the environment. Otherwise, value is a string.
1393 This function searches `process-environment' for VARIABLE. If it is
1394 not found there, then it continues the search in the environment list
1395 of the selected frame.
1397 If optional parameter ENV is a list, then search this list instead of
1398 `process-environment', and return t when encountering a negative entry.
1400 If it is a frame, then this function will ignore `process-environment' and
1401 will simply look up the variable in that frame's environment. */)
1403 Lisp_Object variable
, env
;
1408 CHECK_STRING (variable
);
1411 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1412 &value
, &valuelen
, env
))
1413 return value
? make_string (value
, valuelen
) : Qt
;
1417 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1418 &value
, &valuelen
, env
))
1419 return make_string (value
, valuelen
);
1424 /* A version of getenv that consults the Lisp environment lists,
1425 easily callable from C. */
1433 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1440 /* This is run before init_cmdargs. */
1445 char *data_dir
= egetenv ("EMACSDATA");
1446 char *doc_dir
= egetenv ("EMACSDOC");
1449 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1452 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1455 /* Check the EMACSPATH environment variable, defaulting to the
1456 PATH_EXEC path from epaths.h. */
1457 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1458 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1459 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1462 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1467 char *data_dir
= egetenv ("EMACSDATA");
1470 Lisp_Object tempdir
;
1472 if (!NILP (Vinstallation_directory
))
1474 /* Add to the path the lib-src subdir of the installation dir. */
1476 tem
= Fexpand_file_name (build_string ("lib-src"),
1477 Vinstallation_directory
);
1479 /* MSDOS uses wrapped binaries, so don't do this. */
1480 if (NILP (Fmember (tem
, Vexec_path
)))
1482 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1483 Vexec_path
= Fcons (tem
, Vexec_path
);
1484 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1487 Vexec_directory
= Ffile_name_as_directory (tem
);
1488 #endif /* not DOS_NT */
1490 /* Maybe use ../etc as well as ../lib-src. */
1493 tem
= Fexpand_file_name (build_string ("etc"),
1494 Vinstallation_directory
);
1495 Vdoc_directory
= Ffile_name_as_directory (tem
);
1499 /* Look for the files that should be in etc. We don't use
1500 Vinstallation_directory, because these files are never installed
1501 near the executable, and they are never in the build
1502 directory when that's different from the source directory.
1504 Instead, if these files are not in the nominal place, we try the
1505 source directory. */
1508 Lisp_Object tem
, tem1
, srcdir
;
1510 srcdir
= Fexpand_file_name (build_string ("../src/"),
1511 build_string (PATH_DUMPLOADSEARCH
));
1512 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1513 tem1
= Ffile_exists_p (tem
);
1514 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1517 newdir
= Fexpand_file_name (build_string ("../etc/"),
1518 build_string (PATH_DUMPLOADSEARCH
));
1519 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1520 tem1
= Ffile_exists_p (tem
);
1522 Vdata_directory
= newdir
;
1530 tempdir
= Fdirectory_file_name (Vexec_directory
);
1531 if (access (SDATA (tempdir
), 0) < 0)
1532 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1536 tempdir
= Fdirectory_file_name (Vdata_directory
);
1537 if (access (SDATA (tempdir
), 0) < 0)
1538 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1541 sh
= (char *) getenv ("SHELL");
1542 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1544 if (getenv ("TMPDIR"))
1546 char *dir
= getenv ("TMPDIR");
1547 Vtemp_file_name_pattern
1548 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1549 build_string (dir
));
1552 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1555 Vshared_game_score_directory
= Qnil
;
1557 Vshared_game_score_directory
= build_string (PATH_GAME
);
1558 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1559 Vshared_game_score_directory
= Qnil
;
1564 set_initial_environment ()
1566 register char **envp
;
1572 Vprocess_environment
= Qnil
;
1574 for (envp
= environ
; *envp
; envp
++)
1575 Vprocess_environment
= Fcons (build_string (*envp
),
1576 Vprocess_environment
);
1577 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1578 to use `delete' and friends on process-environment. */
1579 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1587 Qbuffer_file_type
= intern ("buffer-file-type");
1588 staticpro (&Qbuffer_file_type
);
1591 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1592 doc
: /* *File name to load inferior shells from.
1593 Initialized from the SHELL environment variable, or to a system-dependent
1594 default if SHELL is not set. */);
1596 DEFVAR_LISP ("exec-path", &Vexec_path
,
1597 doc
: /* *List of directories to search programs to run in subprocesses.
1598 Each element is a string (directory name) or nil (try default directory). */);
1600 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1601 doc
: /* *List of suffixes to try to find executable file names.
1602 Each element is a string. */);
1603 Vexec_suffixes
= Qnil
;
1605 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1606 doc
: /* Directory for executables for Emacs to invoke.
1607 More generally, this includes any architecture-dependent files
1608 that are built and installed from the Emacs distribution. */);
1610 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1611 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1612 These are files intended for Emacs to use while it runs. */);
1614 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1615 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1616 This is usually the same as `data-directory'. */);
1618 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1619 doc
: /* For internal use by the build procedure only.
1620 This is the name of the directory in which the build procedure installed
1621 Emacs's info files; the default value for `Info-default-directory-list'
1623 Vconfigure_info_directory
= build_string (PATH_INFO
);
1625 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1626 doc
: /* Directory of score files for games which come with GNU Emacs.
1627 If this variable is nil, then Emacs is unable to use a shared directory. */);
1629 Vshared_game_score_directory
= Qnil
;
1631 Vshared_game_score_directory
= build_string (PATH_GAME
);
1634 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1635 doc
: /* Pattern for making names for temporary files.
1636 This is used by `call-process-region'. */);
1637 /* This variable is initialized in init_callproc. */
1639 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1640 doc
: /* List of environment variables inherited from the parent process.
1641 Each element should be a string of the form ENVVARNAME=VALUE.
1642 The elements must normally be decoded (using `locale-coding-system') for use. */);
1643 Vinitial_environment
= Qnil
;
1645 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1646 doc
: /* List of overridden environment variables for subprocesses to inherit.
1647 Each element should be a string of the form ENVVARNAME=VALUE.
1649 Entries in this list take precedence to those in the frame-local
1650 environments. Therefore, let-binding `process-environment' is an easy
1651 way to temporarily change the value of an environment variable,
1652 irrespective of where it comes from. To use `process-environment' to
1653 remove an environment variable, include only its name in the list,
1656 This variable is set to nil when Emacs starts.
1658 If multiple entries define the same variable, the first one always
1661 Non-ASCII characters are encoded according to the initial value of
1662 `locale-coding-system', i.e. the elements must normally be decoded for
1665 See `setenv' and `getenv'. */);
1666 Vprocess_environment
= Qnil
;
1668 defsubr (&Scall_process
);
1669 defsubr (&Sgetenv_internal
);
1670 defsubr (&Scall_process_region
);
1673 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1674 (do not change this comment) */