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, or (at your option)
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; see the file COPYING. If not, write to
20 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
21 Boston, MA 02110-1301, USA. */
33 /* Define SIGCHLD as an alias for SIGCLD. */
35 #if !defined (SIGCHLD) && defined (SIGCLD)
36 #define SIGCHLD SIGCLD
39 #include <sys/types.h>
47 #define INCLUDED_FCNTL
54 #include <stdlib.h> /* for proper declaration of environ */
57 #define _P_NOWAIT 1 /* from process.h */
60 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
61 #define INCLUDED_FCNTL
64 #include <sys/param.h>
79 #include "character.h"
82 #include "composite.h"
85 #include "syssignal.h"
87 #include "blockinput.h"
89 #include "termhooks.h"
96 extern noshare
char **environ
;
99 extern char **environ
;
104 #if !defined (USG) || defined (BSD_PGRPS)
106 #define setpgrp setpgid
110 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
111 Lisp_Object Vdata_directory
, Vdoc_directory
;
112 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
113 Lisp_Object Vtemp_file_name_pattern
;
115 Lisp_Object Vshell_file_name
;
117 Lisp_Object Vprocess_environment
, Vinitial_environment
;
120 Lisp_Object Qbuffer_file_type
;
123 /* True if we are about to fork off a synchronous process or if we
124 are waiting for it. */
125 int synch_process_alive
;
127 /* Nonzero => this is a string explaining death of synchronous subprocess. */
128 char *synch_process_death
;
130 /* Nonzero => this is the signal number that terminated the subprocess. */
131 int synch_process_termsig
;
133 /* If synch_process_death is zero,
134 this is exit code of synchronous subprocess. */
135 int synch_process_retcode
;
138 /* Clean up when exiting Fcall_process.
139 On MSDOS, delete the temporary file on any kind of termination.
140 On Unix, kill the process and any children on termination by signal. */
142 /* Nonzero if this is termination due to exit. */
143 static int call_process_exited
;
145 EXFUN (Fgetenv_internal
, 2);
147 #ifndef VMS /* VMS version is in vmsproc.c. */
150 call_process_kill (fdpid
)
153 emacs_close (XFASTINT (Fcar (fdpid
)));
154 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
155 synch_process_alive
= 0;
160 call_process_cleanup (fdpid
)
164 /* for MSDOS fdpid is really (fd . tempfile) */
165 register Lisp_Object file
;
167 emacs_close (XFASTINT (Fcar (fdpid
)));
168 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
169 unlink (SDATA (file
));
170 #else /* not MSDOS */
171 register int pid
= XFASTINT (Fcdr (fdpid
));
173 if (call_process_exited
)
175 emacs_close (XFASTINT (Fcar (fdpid
)));
179 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
181 int count
= SPECPDL_INDEX ();
182 record_unwind_protect (call_process_kill
, fdpid
);
183 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
186 wait_for_termination (pid
);
188 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
189 message1 ("Waiting for process to die...done");
191 synch_process_alive
= 0;
192 emacs_close (XFASTINT (Fcar (fdpid
)));
193 #endif /* not MSDOS */
197 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
198 doc
: /* Call PROGRAM synchronously in separate process.
199 The remaining arguments are optional.
200 The program's input comes from file INFILE (nil means `/dev/null').
201 Insert output in BUFFER before point; t means current buffer;
202 nil for BUFFER means discard it; 0 means discard and don't wait.
203 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
204 REAL-BUFFER says what to do with standard output, as above,
205 while STDERR-FILE says what to do with standard error in the child.
206 STDERR-FILE may be nil (discard standard error output),
207 t (mix it with ordinary output), or a file name string.
209 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
210 Remaining arguments are strings passed as command arguments to PROGRAM.
212 If executable PROGRAM can't be found as an executable, `call-process'
213 signals a Lisp error. `call-process' reports errors in execution of
214 the program only through its return and output.
216 If BUFFER is 0, `call-process' returns immediately with value nil.
217 Otherwise it waits for PROGRAM to terminate
218 and returns a numeric exit status or a signal description string.
219 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
221 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
224 register Lisp_Object
*args
;
226 Lisp_Object infile
, buffer
, current_dir
, path
;
231 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
232 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
233 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
234 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
235 int count
= SPECPDL_INDEX ();
237 register const unsigned char **new_argv
238 = (const unsigned char **) alloca ((max (2, nargs
- 2)) * sizeof (char *));
239 struct buffer
*old
= current_buffer
;
240 /* File to use for stderr in the child.
241 t means use same as standard output. */
242 Lisp_Object error_file
;
243 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
244 char *outf
, *tempfile
;
250 struct coding_system process_coding
; /* coding-system of process output */
251 struct coding_system argument_coding
; /* coding-system of arguments */
252 /* Set to the return value of Ffind_operation_coding_system. */
253 Lisp_Object coding_systems
;
255 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
258 CHECK_STRING (args
[0]);
263 /* Without asynchronous processes we cannot have BUFFER == 0. */
265 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
266 error ("Operating system cannot handle asynchronous subprocesses");
267 #endif /* subprocesses */
269 /* Decide the coding-system for giving arguments. */
271 Lisp_Object val
, *args2
;
274 /* If arguments are supplied, we may have to encode them. */
278 Lisp_Object coding_attrs
;
280 for (i
= 4; i
< nargs
; i
++)
281 CHECK_STRING (args
[i
]);
283 for (i
= 4; i
< nargs
; i
++)
284 if (STRING_MULTIBYTE (args
[i
]))
287 if (!NILP (Vcoding_system_for_write
))
288 val
= Vcoding_system_for_write
;
289 else if (! must_encode
)
293 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
294 args2
[0] = Qcall_process
;
295 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
296 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
297 if (CONSP (coding_systems
))
298 val
= XCDR (coding_systems
);
299 else if (CONSP (Vdefault_process_coding_system
))
300 val
= XCDR (Vdefault_process_coding_system
);
304 val
= coding_inherit_eol_type (val
, Qnil
);
305 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
306 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
307 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
309 /* We should not use an ASCII incompatible coding system. */
310 val
= raw_text_coding_system (val
);
311 setup_coding_system (val
, &argument_coding
);
316 if (nargs
>= 2 && ! NILP (args
[1]))
318 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
319 CHECK_STRING (infile
);
322 infile
= build_string (NULL_DEVICE
);
328 /* If BUFFER is a list, its meaning is
329 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
332 if (CONSP (XCDR (buffer
)))
334 Lisp_Object stderr_file
;
335 stderr_file
= XCAR (XCDR (buffer
));
337 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
338 error_file
= stderr_file
;
340 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
343 buffer
= XCAR (buffer
);
346 if (!(EQ (buffer
, Qnil
)
348 || INTEGERP (buffer
)))
350 Lisp_Object spec_buffer
;
351 spec_buffer
= buffer
;
352 buffer
= Fget_buffer_create (buffer
);
353 /* Mention the buffer name for a better error message. */
355 CHECK_BUFFER (spec_buffer
);
356 CHECK_BUFFER (buffer
);
362 /* Make sure that the child will be able to chdir to the current
363 buffer's current directory, or its unhandled equivalent. We
364 can't just have the child check for an error when it does the
365 chdir, since it's in a vfork.
367 We have to GCPRO around this because Fexpand_file_name,
368 Funhandled_file_name_directory, and Ffile_accessible_directory_p
369 might call a file name handling function. The argument list is
370 protected by the caller, so all we really have to worry about is
373 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
375 current_dir
= current_buffer
->directory
;
377 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
379 current_dir
= Funhandled_file_name_directory (current_dir
);
380 if (NILP (current_dir
))
381 /* If the file name handler says that current_dir is unreachable, use
382 a sensible default. */
383 current_dir
= build_string ("~/");
384 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
385 if (NILP (Ffile_accessible_directory_p (current_dir
)))
386 report_file_error ("Setting current directory",
387 Fcons (current_buffer
->directory
, Qnil
));
389 if (STRING_MULTIBYTE (infile
))
390 infile
= ENCODE_FILE (infile
);
391 if (STRING_MULTIBYTE (current_dir
))
392 current_dir
= ENCODE_FILE (current_dir
);
393 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
394 error_file
= ENCODE_FILE (error_file
);
398 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
400 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
403 infile
= DECODE_FILE (infile
);
404 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
406 /* Search for program; barf if not found. */
410 GCPRO1 (current_dir
);
411 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
416 emacs_close (filefd
);
417 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
420 /* If program file name starts with /: for quoting a magic name,
422 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
423 && SREF (path
, 1) == ':')
424 path
= Fsubstring (path
, make_number (2), Qnil
);
426 new_argv
[0] = SDATA (path
);
430 struct gcpro gcpro1
, gcpro2
, gcpro3
;
432 GCPRO3 (infile
, buffer
, current_dir
);
433 argument_coding
.dst_multibyte
= 0;
434 for (i
= 4; i
< nargs
; i
++)
436 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
437 if (CODING_REQUIRE_ENCODING (&argument_coding
))
438 /* We must encode this argument. */
439 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
440 new_argv
[i
- 3] = SDATA (args
[i
]);
443 new_argv
[nargs
- 3] = 0;
448 #ifdef MSDOS /* MW, July 1993 */
449 if ((outf
= egetenv ("TMPDIR")))
450 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
453 tempfile
= alloca (20);
456 dostounix_filename (tempfile
);
457 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
458 strcat (tempfile
, "/");
459 strcat (tempfile
, "detmp.XXX");
462 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
465 emacs_close (filefd
);
466 report_file_error ("Opening process output file",
467 Fcons (build_string (tempfile
), Qnil
));
473 if (INTEGERP (buffer
))
474 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
481 emacs_close (filefd
);
482 report_file_error ("Creating process pipe", Qnil
);
486 /* Replaced by close_process_descs */
487 set_exclusive_use (fd
[0]);
492 /* child_setup must clobber environ in systems with true vfork.
493 Protect it from permanent change. */
494 register char **save_environ
= environ
;
495 register int fd1
= fd
[1];
498 #if 0 /* Some systems don't have sigblock. */
499 mask
= sigblock (sigmask (SIGCHLD
));
502 /* Record that we're about to create a synchronous process. */
503 synch_process_alive
= 1;
505 /* These vars record information from process termination.
506 Clear them now before process can possibly terminate,
507 to avoid timing error if process terminates soon. */
508 synch_process_death
= 0;
509 synch_process_retcode
= 0;
510 synch_process_termsig
= 0;
512 if (NILP (error_file
))
513 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
514 else if (STRINGP (error_file
))
517 fd_error
= emacs_open (SDATA (error_file
),
518 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
520 #else /* not DOS_NT */
521 fd_error
= creat (SDATA (error_file
), 0666);
522 #endif /* not DOS_NT */
527 emacs_close (filefd
);
535 if (NILP (error_file
))
536 error_file
= build_string (NULL_DEVICE
);
537 else if (STRINGP (error_file
))
538 error_file
= DECODE_FILE (error_file
);
539 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
542 #ifdef MSDOS /* MW, July 1993 */
543 /* Note that on MSDOS `child_setup' actually returns the child process
544 exit status, not its PID, so we assign it to `synch_process_retcode'
546 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
549 /* Record that the synchronous process exited and note its
550 termination status. */
551 synch_process_alive
= 0;
552 synch_process_retcode
= pid
;
553 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
555 synchronize_system_messages_locale ();
556 synch_process_death
= strerror (errno
);
559 emacs_close (outfilefd
);
560 if (fd_error
!= outfilefd
)
561 emacs_close (fd_error
);
562 fd1
= -1; /* No harm in closing that one! */
563 /* Since CRLF is converted to LF within `decode_coding', we can
564 always open a file with binary mode. */
565 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
569 emacs_close (filefd
);
570 report_file_error ("Cannot re-open temporary file", Qnil
);
572 #else /* not MSDOS */
574 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
576 #else /* not WINDOWSNT */
588 #if defined (USG) && !defined (BSD_PGRPS)
593 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
598 #endif /* not WINDOWSNT */
600 /* The MSDOS case did this already. */
602 emacs_close (fd_error
);
603 #endif /* not MSDOS */
605 environ
= save_environ
;
607 /* Close most of our fd's, but not fd[0]
608 since we will use that to read input from. */
609 emacs_close (filefd
);
610 if (fd1
>= 0 && fd1
!= fd_error
)
618 report_file_error ("Doing vfork", Qnil
);
621 if (INTEGERP (buffer
))
626 /* If Emacs has been built with asynchronous subprocess support,
627 we don't need to do this, I think because it will then have
628 the facilities for handling SIGCHLD. */
629 wait_without_blocking ();
630 #endif /* subprocesses */
634 /* Enable sending signal if user quits below. */
635 call_process_exited
= 0;
638 /* MSDOS needs different cleanup information. */
639 record_unwind_protect (call_process_cleanup
,
640 Fcons (make_number (fd
[0]), build_string (tempfile
)));
642 record_unwind_protect (call_process_cleanup
,
643 Fcons (make_number (fd
[0]), make_number (pid
)));
644 #endif /* not MSDOS */
647 if (BUFFERP (buffer
))
648 Fset_buffer (buffer
);
652 /* If BUFFER is nil, we must read process output once and then
653 discard it, so setup coding system but with nil. */
654 setup_coding_system (Qnil
, &process_coding
);
658 Lisp_Object val
, *args2
;
661 if (!NILP (Vcoding_system_for_read
))
662 val
= Vcoding_system_for_read
;
665 if (EQ (coding_systems
, Qt
))
669 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
670 args2
[0] = Qcall_process
;
671 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
673 = Ffind_operation_coding_system (nargs
+ 1, args2
);
675 if (CONSP (coding_systems
))
676 val
= XCAR (coding_systems
);
677 else if (CONSP (Vdefault_process_coding_system
))
678 val
= XCAR (Vdefault_process_coding_system
);
682 Fcheck_coding_system (val
);
683 /* In unibyte mode, character code conversion should not take
684 place but EOL conversion should. So, setup raw-text or one
685 of the subsidiary according to the information just setup. */
686 if (NILP (current_buffer
->enable_multibyte_characters
)
688 val
= raw_text_coding_system (val
);
689 setup_coding_system (val
, &process_coding
);
700 int display_on_the_fly
= display_p
;
701 struct coding_system saved_coding
;
703 saved_coding
= process_coding
;
706 /* Repeatedly read until we've filled as much as possible
707 of the buffer size we have. But don't read
708 less than 1024--save that for the next bufferful. */
710 while (nread
< bufsize
- 1024)
712 int this_read
= emacs_read (fd
[0], buf
+ nread
,
720 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
725 total_read
+= this_read
;
727 if (display_on_the_fly
)
731 /* Now NREAD is the total amount of data in the buffer. */
736 if (NILP (current_buffer
->enable_multibyte_characters
)
737 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
738 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
740 { /* We have to decode the input. */
743 XSETBUFFER (curbuf
, current_buffer
);
744 decode_coding_c_string (&process_coding
, buf
, nread
,
746 if (display_on_the_fly
747 && CODING_REQUIRE_DETECTION (&saved_coding
)
748 && ! CODING_REQUIRE_DETECTION (&process_coding
))
750 /* We have detected some coding system. But,
751 there's a possibility that the detection was
752 done by insufficient data. So, we give up
753 displaying on the fly. */
754 if (process_coding
.produced
> 0)
755 del_range_2 (process_coding
.dst_pos
,
756 process_coding
.dst_pos_byte
,
757 process_coding
.dst_pos
758 + process_coding
.produced_char
,
759 process_coding
.dst_pos_byte
760 + process_coding
.produced
, 0);
761 display_on_the_fly
= 0;
762 process_coding
= saved_coding
;
764 /* This is to make the above condition always
765 fails in the future. */
766 saved_coding
.common_flags
767 &= ~CODING_REQUIRE_DETECTION_MASK
;
771 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
772 PT_BYTE
+ process_coding
.produced
);
773 carryover
= process_coding
.carryover_bytes
;
775 /* As CARRYOVER should not be that large, we had
776 better avoid overhead of bcopy. */
777 BCOPY_SHORT (process_coding
.carryover
, buf
,
778 process_coding
.carryover_bytes
);
782 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
785 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
786 /* Make the buffer bigger as we continue to read more data,
787 but not past CALLPROC_BUFFER_SIZE_MAX. */
788 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
789 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
790 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
796 prepare_menu_bars ();
798 redisplay_preserve_echo_area (1);
799 /* This variable might have been set to 0 for code
800 detection. In that case, we set it back to 1 because
801 we should have already detected a coding system. */
802 display_on_the_fly
= 1;
809 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
810 /* If the caller required, let the buffer inherit the
811 coding-system used to decode the process output. */
812 if (inherit_process_coding_system
)
813 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
814 make_number (total_read
));
817 /* Wait for it to terminate, unless it already has. */
818 wait_for_termination (pid
);
822 set_buffer_internal (old
);
824 /* Don't kill any children that the subprocess may have left behind
826 call_process_exited
= 1;
828 unbind_to (count
, Qnil
);
830 if (synch_process_termsig
)
834 synchronize_system_messages_locale ();
835 signame
= strsignal (synch_process_termsig
);
840 synch_process_death
= signame
;
843 if (synch_process_death
)
844 return code_convert_string_norecord (build_string (synch_process_death
),
845 Vlocale_coding_system
, 0);
846 return make_number (synch_process_retcode
);
851 delete_temp_file (name
)
854 /* Suppress jka-compr handling, etc. */
855 int count
= SPECPDL_INDEX ();
856 specbind (intern ("file-name-handler-alist"), Qnil
);
857 internal_delete_file (name
);
858 unbind_to (count
, Qnil
);
862 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
864 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
865 The remaining arguments are optional.
866 Delete the text if fourth arg DELETE is non-nil.
868 Insert output in BUFFER before point; t means current buffer;
869 nil for BUFFER means discard it; 0 means discard and don't wait.
870 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
871 REAL-BUFFER says what to do with standard output, as above,
872 while STDERR-FILE says what to do with standard error in the child.
873 STDERR-FILE may be nil (discard standard error output),
874 t (mix it with ordinary output), or a file name string.
876 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
877 Remaining args are passed to PROGRAM at startup as command args.
879 If BUFFER is 0, `call-process-region' returns immediately with value nil.
880 Otherwise it waits for PROGRAM to terminate
881 and returns a numeric exit status or a signal description string.
882 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
884 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
887 register Lisp_Object
*args
;
890 Lisp_Object filename_string
;
891 register Lisp_Object start
, end
;
892 int count
= SPECPDL_INDEX ();
893 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
894 Lisp_Object coding_systems
;
895 Lisp_Object val
, *args2
;
901 if ((outf
= egetenv ("TMPDIR"))
902 || (outf
= egetenv ("TMP"))
903 || (outf
= egetenv ("TEMP")))
904 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
907 tempfile
= alloca (20);
910 if (!IS_DIRECTORY_SEP (tempfile
[strlen (tempfile
) - 1]))
911 strcat (tempfile
, "/");
912 if ('/' == DIRECTORY_SEP
)
913 dostounix_filename (tempfile
);
915 unixtodos_filename (tempfile
);
917 strcat (tempfile
, "emXXXXXX");
919 strcat (tempfile
, "detmp.XXX");
921 #else /* not DOS_NT */
922 char *tempfile
= (char *) alloca (SBYTES (Vtemp_file_name_pattern
) + 1);
923 bcopy (SDATA (Vtemp_file_name_pattern
), tempfile
,
924 SBYTES (Vtemp_file_name_pattern
) + 1);
925 #endif /* not DOS_NT */
934 fd
= mkstemp (tempfile
);
937 report_file_error ("Failed to open temporary file",
938 Fcons (Vtemp_file_name_pattern
, Qnil
));
946 filename_string
= build_string (tempfile
);
947 GCPRO1 (filename_string
);
950 /* Decide coding-system of the contents of the temporary file. */
951 if (!NILP (Vcoding_system_for_write
))
952 val
= Vcoding_system_for_write
;
953 else if (NILP (current_buffer
->enable_multibyte_characters
))
957 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
958 args2
[0] = Qcall_process_region
;
959 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
960 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
961 if (CONSP (coding_systems
))
962 val
= XCDR (coding_systems
);
963 else if (CONSP (Vdefault_process_coding_system
))
964 val
= XCDR (Vdefault_process_coding_system
);
970 int count1
= SPECPDL_INDEX ();
972 specbind (intern ("coding-system-for-write"), val
);
973 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
974 happen to get a ".Z" suffix. */
975 specbind (intern ("file-name-handler-alist"), Qnil
);
976 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
978 unbind_to (count1
, Qnil
);
981 /* Note that Fcall_process takes care of binding
982 coding-system-for-read. */
984 record_unwind_protect (delete_temp_file
, filename_string
);
986 if (nargs
> 3 && !NILP (args
[3]))
987 Fdelete_region (start
, end
);
999 args
[1] = filename_string
;
1001 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
1004 #ifndef VMS /* VMS version is in vmsproc.c. */
1006 static int relocate_fd ();
1009 add_env (char **env
, char **new_env
, char *string
)
1016 /* See if this string duplicates any string already in the env.
1017 If so, don't put it in.
1018 When an env var has multiple definitions,
1019 we keep the definition that comes first in process-environment. */
1020 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
1022 char *p
= *ep
, *q
= string
;
1028 /* The string is a lone variable name; keep it for now, we
1029 will remove it later. It is a placeholder for a
1030 variable that is not to be included in the environment. */
1038 *new_env
++ = string
;
1042 /* This is the last thing run in a newly forked inferior
1043 either synchronous or asynchronous.
1044 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1045 Initialize inferior's priority, pgrp, connected dir and environment.
1046 then exec another program based on new_argv.
1048 This function may change environ for the superior process.
1049 Therefore, the superior process must save and restore the value
1050 of environ around the vfork and the call to this function.
1052 SET_PGRP is nonzero if we should put the subprocess into a separate
1055 CURRENT_DIR is an elisp string giving the path of the current
1056 directory the subprocess should have. Since we can't really signal
1057 a decent error from within the child, this should be verified as an
1058 executable directory by the parent. */
1061 child_setup (in
, out
, err
, new_argv
, set_pgrp
, current_dir
)
1063 register char **new_argv
;
1065 Lisp_Object current_dir
;
1072 #endif /* WINDOWSNT */
1074 int pid
= getpid ();
1076 #ifdef SET_EMACS_PRIORITY
1078 extern EMACS_INT emacs_priority
;
1080 if (emacs_priority
< 0)
1081 nice (- emacs_priority
);
1086 /* Close Emacs's descriptors that this process should not have. */
1087 close_process_descs ();
1089 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1090 we will lose if we call close_load_descs here. */
1092 close_load_descs ();
1095 /* Note that use of alloca is always safe here. It's obvious for systems
1096 that do not have true vfork or that have true (stack) alloca.
1097 If using vfork and C_ALLOCA (when Emacs used to include
1098 src/alloca.c) it is safe because that changes the superior's
1099 static variables as if the superior had done alloca and will be
1100 cleaned up in the usual way. */
1102 register char *temp
;
1105 i
= SBYTES (current_dir
);
1107 /* MSDOS must have all environment variables malloc'ed, because
1108 low-level libc functions that launch subsidiary processes rely
1110 pwd_var
= (char *) xmalloc (i
+ 6);
1112 pwd_var
= (char *) alloca (i
+ 6);
1115 bcopy ("PWD=", pwd_var
, 4);
1116 bcopy (SDATA (current_dir
), temp
, i
);
1117 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1121 /* We can't signal an Elisp error here; we're in a vfork. Since
1122 the callers check the current directory before forking, this
1123 should only return an error if the directory's permissions
1124 are changed between the check and this chdir, but we should
1126 if (chdir (temp
) < 0)
1131 /* Get past the drive letter, so that d:/ is left alone. */
1132 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1139 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1140 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1144 /* Set `env' to a vector of the strings in the environment. */
1146 register Lisp_Object tem
;
1147 register char **new_env
;
1149 register int new_length
;
1150 Lisp_Object display
= Qnil
;
1154 for (tem
= Vprocess_environment
;
1155 CONSP (tem
) && STRINGP (XCAR (tem
));
1158 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1159 && (SDATA (XCAR (tem
)) [7] == '\0'
1160 || SDATA (XCAR (tem
)) [7] == '='))
1161 /* DISPLAY is specified in process-environment. */
1166 /* If not provided yet, use the frame's DISPLAY. */
1169 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1170 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1171 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1172 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1173 Vinitial_environment
);
1181 /* new_length + 2 to include PWD and terminating 0. */
1182 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1183 /* If we have a PWD envvar, pass one down,
1184 but with corrected value. */
1185 if (egetenv ("PWD"))
1186 *new_env
++ = pwd_var
;
1188 if (STRINGP (display
))
1190 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1191 char *vdata
= (char *) alloca (vlen
);
1192 strcpy (vdata
, "DISPLAY=");
1193 strcat (vdata
, SDATA (display
));
1194 new_env
= add_env (env
, new_env
, vdata
);
1198 for (tem
= Vprocess_environment
;
1199 CONSP (tem
) && STRINGP (XCAR (tem
));
1201 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1205 /* Remove variable names without values. */
1209 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1219 prepare_standard_handles (in
, out
, err
, handles
);
1220 set_process_dir (SDATA (current_dir
));
1221 #else /* not WINDOWSNT */
1222 /* Make sure that in, out, and err are not actually already in
1223 descriptors zero, one, or two; this could happen if Emacs is
1224 started with its standard in, out, or error closed, as might
1227 int oin
= in
, oout
= out
;
1229 /* We have to avoid relocating the same descriptor twice! */
1231 in
= relocate_fd (in
, 3);
1236 out
= relocate_fd (out
, 3);
1240 else if (err
== oout
)
1243 err
= relocate_fd (err
, 3);
1257 #endif /* not MSDOS */
1258 #endif /* not WINDOWSNT */
1260 #if defined(USG) && !defined(BSD_PGRPS)
1261 #ifndef SETPGRP_RELEASES_CTTY
1262 setpgrp (); /* No arguments but equivalent in this case */
1267 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1268 EMACS_SET_TTY_PGRP (0, &pid
);
1271 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1274 /* An error occurred while trying to run the subprocess. */
1275 report_file_error ("Spawning child process", Qnil
);
1277 #else /* not MSDOS */
1279 /* Spawn the child. (See ntproc.c:Spawnve). */
1280 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1281 reset_standard_handles (in
, out
, err
, handles
);
1283 /* An error occurred while trying to spawn the process. */
1284 report_file_error ("Spawning child process", Qnil
);
1286 #else /* not WINDOWSNT */
1287 /* execvp does not accept an environment arg so the only way
1288 to pass this environment is to set environ. Our caller
1289 is responsible for restoring the ambient value of environ. */
1291 execvp (new_argv
[0], new_argv
);
1293 emacs_write (1, "Can't exec program: ", 20);
1294 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1295 emacs_write (1, "\n", 1);
1297 #endif /* not WINDOWSNT */
1298 #endif /* not MSDOS */
1301 /* Move the file descriptor FD so that its number is not less than MINFD.
1302 If the file descriptor is moved at all, the original is freed. */
1304 relocate_fd (fd
, minfd
)
1314 char *message1
= "Error while setting up child: ";
1315 char *errmessage
= strerror (errno
);
1316 char *message2
= "\n";
1317 emacs_write (2, message1
, strlen (message1
));
1318 emacs_write (2, errmessage
, strlen (errmessage
));
1319 emacs_write (2, message2
, strlen (message2
));
1322 /* Note that we hold the original FD open while we recurse,
1323 to guarantee we'll get a new FD if we need it. */
1324 new = relocate_fd (new, minfd
);
1331 getenv_internal_1 (var
, varlen
, value
, valuelen
, env
)
1338 for (; CONSP (env
); env
= XCDR (env
))
1340 Lisp_Object entry
= XCAR (env
);
1342 && SBYTES (entry
) >= varlen
1344 /* NT environment variables are case insensitive. */
1345 && ! strnicmp (SDATA (entry
), var
, varlen
)
1346 #else /* not WINDOWSNT */
1347 && ! bcmp (SDATA (entry
), var
, varlen
)
1348 #endif /* not WINDOWSNT */
1351 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1353 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1354 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1357 else if (SBYTES (entry
) == varlen
)
1359 /* Lone variable names in Vprocess_environment mean that
1360 variable should be removed from the environment. */
1370 getenv_internal (var
, varlen
, value
, valuelen
, frame
)
1377 /* Try to find VAR in Vprocess_environment first. */
1378 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1379 Vprocess_environment
))
1380 return *value
? 1 : 0;
1382 /* For DISPLAY try to get the values from the frame or the initial env. */
1383 if (strcmp (var
, "DISPLAY") == 0)
1386 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1387 if (STRINGP (display
))
1389 *value
= (char *) SDATA (display
);
1390 *valuelen
= SBYTES (display
);
1393 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1394 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1395 Vinitial_environment
))
1396 return *value
? 1 : 0;
1402 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1403 doc
: /* Get the value of environment variable VARIABLE.
1404 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1405 the environment. Otherwise, value is a string.
1407 This function searches `process-environment' for VARIABLE. If it is
1408 not found there, then it continues the search in the environment list
1409 of the selected frame.
1411 If optional parameter ENV is a list, then search this list instead of
1412 `process-environment', and return t when encountering a negative entry.
1414 If it is a frame, then this function will ignore `process-environment' and
1415 will simply look up the variable in that frame's environment. */)
1417 Lisp_Object variable
, env
;
1422 CHECK_STRING (variable
);
1425 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1426 &value
, &valuelen
, env
))
1427 return value
? make_string (value
, valuelen
) : Qt
;
1431 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1432 &value
, &valuelen
, env
))
1433 return make_string (value
, valuelen
);
1438 /* A version of getenv that consults the Lisp environment lists,
1439 easily callable from C. */
1447 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1453 #endif /* not VMS */
1455 /* This is run before init_cmdargs. */
1460 char *data_dir
= egetenv ("EMACSDATA");
1461 char *doc_dir
= egetenv ("EMACSDOC");
1464 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1467 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1470 /* Check the EMACSPATH environment variable, defaulting to the
1471 PATH_EXEC path from epaths.h. */
1472 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1473 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1474 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1477 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1482 char *data_dir
= egetenv ("EMACSDATA");
1485 Lisp_Object tempdir
;
1487 if (!NILP (Vinstallation_directory
))
1489 /* Add to the path the lib-src subdir of the installation dir. */
1491 tem
= Fexpand_file_name (build_string ("lib-src"),
1492 Vinstallation_directory
);
1494 /* MSDOS uses wrapped binaries, so don't do this. */
1495 if (NILP (Fmember (tem
, Vexec_path
)))
1497 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1498 Vexec_path
= Fcons (tem
, Vexec_path
);
1499 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1502 Vexec_directory
= Ffile_name_as_directory (tem
);
1503 #endif /* not DOS_NT */
1505 /* Maybe use ../etc as well as ../lib-src. */
1508 tem
= Fexpand_file_name (build_string ("etc"),
1509 Vinstallation_directory
);
1510 Vdoc_directory
= Ffile_name_as_directory (tem
);
1514 /* Look for the files that should be in etc. We don't use
1515 Vinstallation_directory, because these files are never installed
1516 near the executable, and they are never in the build
1517 directory when that's different from the source directory.
1519 Instead, if these files are not in the nominal place, we try the
1520 source directory. */
1523 Lisp_Object tem
, tem1
, srcdir
;
1525 srcdir
= Fexpand_file_name (build_string ("../src/"),
1526 build_string (PATH_DUMPLOADSEARCH
));
1527 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1528 tem1
= Ffile_exists_p (tem
);
1529 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1532 newdir
= Fexpand_file_name (build_string ("../etc/"),
1533 build_string (PATH_DUMPLOADSEARCH
));
1534 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1535 tem1
= Ffile_exists_p (tem
);
1537 Vdata_directory
= newdir
;
1545 tempdir
= Fdirectory_file_name (Vexec_directory
);
1546 if (access (SDATA (tempdir
), 0) < 0)
1547 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1551 tempdir
= Fdirectory_file_name (Vdata_directory
);
1552 if (access (SDATA (tempdir
), 0) < 0)
1553 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1557 Vshell_file_name
= build_string ("*dcl*");
1559 sh
= (char *) getenv ("SHELL");
1560 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1564 Vtemp_file_name_pattern
= build_string ("tmp:emacsXXXXXX.");
1566 if (getenv ("TMPDIR"))
1568 char *dir
= getenv ("TMPDIR");
1569 Vtemp_file_name_pattern
1570 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1571 build_string (dir
));
1574 Vtemp_file_name_pattern
= build_string ("/tmp/emacsXXXXXX");
1578 Vshared_game_score_directory
= Qnil
;
1580 Vshared_game_score_directory
= build_string (PATH_GAME
);
1581 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1582 Vshared_game_score_directory
= Qnil
;
1587 set_initial_environment ()
1589 register char **envp
;
1594 for (envp
= environ
; *envp
; envp
++)
1595 Vprocess_environment
= Fcons (build_string (*envp
),
1596 Vprocess_environment
);
1597 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1598 to use `delete' and friends on process-environment. */
1599 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1607 Qbuffer_file_type
= intern ("buffer-file-type");
1608 staticpro (&Qbuffer_file_type
);
1611 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1612 doc
: /* *File name to load inferior shells from.
1613 Initialized from the SHELL environment variable, or to a system-dependent
1614 default if SHELL is not set. */);
1616 DEFVAR_LISP ("exec-path", &Vexec_path
,
1617 doc
: /* *List of directories to search programs to run in subprocesses.
1618 Each element is a string (directory name) or nil (try default directory). */);
1620 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1621 doc
: /* *List of suffixes to try to find executable file names.
1622 Each element is a string. */);
1623 Vexec_suffixes
= Qnil
;
1625 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1626 doc
: /* Directory for executables for Emacs to invoke.
1627 More generally, this includes any architecture-dependent files
1628 that are built and installed from the Emacs distribution. */);
1630 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1631 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1632 These are files intended for Emacs to use while it runs. */);
1634 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1635 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1636 This is usually the same as `data-directory'. */);
1638 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1639 doc
: /* For internal use by the build procedure only.
1640 This is the name of the directory in which the build procedure installed
1641 Emacs's info files; the default value for `Info-default-directory-list'
1643 Vconfigure_info_directory
= build_string (PATH_INFO
);
1645 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1646 doc
: /* Directory of score files for games which come with GNU Emacs.
1647 If this variable is nil, then Emacs is unable to use a shared directory. */);
1649 Vshared_game_score_directory
= Qnil
;
1651 Vshared_game_score_directory
= build_string (PATH_GAME
);
1654 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern
,
1655 doc
: /* Pattern for making names for temporary files.
1656 This is used by `call-process-region'. */);
1657 /* This variable is initialized in init_callproc. */
1659 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1660 doc
: /* List of environment variables inherited from the parent process.
1661 Each element should be a string of the form ENVVARNAME=VALUE.
1662 The elements must normally be decoded (using `locale-coding-system') for use. */);
1663 Vinitial_environment
= Qnil
;
1665 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1666 doc
: /* List of overridden environment variables for subprocesses to inherit.
1667 Each element should be a string of the form ENVVARNAME=VALUE.
1669 Entries in this list take precedence to those in the frame-local
1670 environments. Therefore, let-binding `process-environment' is an easy
1671 way to temporarily change the value of an environment variable,
1672 irrespective of where it comes from. To use `process-environment' to
1673 remove an environment variable, include only its name in the list,
1676 This variable is set to nil when Emacs starts.
1678 If multiple entries define the same variable, the first one always
1681 Non-ASCII characters are encoded according to the initial value of
1682 `locale-coding-system', i.e. the elements must normally be decoded for
1685 See `setenv' and `getenv'. */);
1686 Vprocess_environment
= Qnil
;
1689 defsubr (&Scall_process
);
1690 defsubr (&Sgetenv_internal
);
1692 defsubr (&Scall_process_region
);
1695 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1696 (do not change this comment) */