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, 2009, 2010
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/>. */
27 #include <sys/types.h>
40 #define _P_NOWAIT 1 /* from process.h */
43 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
45 #include <sys/param.h>
51 #include "character.h"
54 #include "composite.h"
57 #include "syssignal.h"
59 #include "blockinput.h"
61 #include "termhooks.h"
68 extern char **environ
;
74 #define setpgrp setpgid
78 Lisp_Object Vexec_path
, Vexec_directory
, Vexec_suffixes
;
79 Lisp_Object Vdata_directory
, Vdoc_directory
;
80 Lisp_Object Vconfigure_info_directory
, Vshared_game_score_directory
;
82 /* Pattern used by call-process-region to make temp files. */
83 static Lisp_Object Vtemp_file_name_pattern
;
85 Lisp_Object Vshell_file_name
;
87 Lisp_Object Vprocess_environment
, Vinitial_environment
;
90 Lisp_Object Qbuffer_file_type
;
93 /* True if we are about to fork off a synchronous process or if we
94 are waiting for it. */
95 int synch_process_alive
;
97 /* Nonzero => this is a string explaining death of synchronous subprocess. */
98 const char *synch_process_death
;
100 /* Nonzero => this is the signal number that terminated the subprocess. */
101 int synch_process_termsig
;
103 /* If synch_process_death is zero,
104 this is exit code of synchronous subprocess. */
105 int synch_process_retcode
;
108 /* Clean up when exiting Fcall_process.
109 On MSDOS, delete the temporary file on any kind of termination.
110 On Unix, kill the process and any children on termination by signal. */
112 /* Nonzero if this is termination due to exit. */
113 static int call_process_exited
;
115 EXFUN (Fgetenv_internal
, 2);
118 call_process_kill (Lisp_Object fdpid
)
120 emacs_close (XFASTINT (Fcar (fdpid
)));
121 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
122 synch_process_alive
= 0;
127 call_process_cleanup (Lisp_Object arg
)
129 Lisp_Object fdpid
= Fcdr (arg
);
136 Fset_buffer (Fcar (arg
));
139 /* for MSDOS fdpid is really (fd . tempfile) */
141 emacs_close (XFASTINT (Fcar (fdpid
)));
142 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
143 unlink (SDATA (file
));
144 #else /* not MSDOS */
145 pid
= XFASTINT (Fcdr (fdpid
));
147 if (call_process_exited
)
149 emacs_close (XFASTINT (Fcar (fdpid
)));
153 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
155 int count
= SPECPDL_INDEX ();
156 record_unwind_protect (call_process_kill
, fdpid
);
157 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
160 wait_for_termination (pid
);
162 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
163 message1 ("Waiting for process to die...done");
165 synch_process_alive
= 0;
166 emacs_close (XFASTINT (Fcar (fdpid
)));
167 #endif /* not MSDOS */
171 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
172 doc
: /* Call PROGRAM synchronously in separate process.
173 The remaining arguments are optional.
174 The program's input comes from file INFILE (nil means `/dev/null').
175 Insert output in BUFFER before point; t means current buffer;
176 nil for BUFFER means discard it; 0 means discard and don't wait.
177 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
178 REAL-BUFFER says what to do with standard output, as above,
179 while STDERR-FILE says what to do with standard error in the child.
180 STDERR-FILE may be nil (discard standard error output),
181 t (mix it with ordinary output), or a file name string.
183 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
184 Remaining arguments are strings passed as command arguments to PROGRAM.
186 If executable PROGRAM can't be found as an executable, `call-process'
187 signals a Lisp error. `call-process' reports errors in execution of
188 the program only through its return and output.
190 If BUFFER is 0, `call-process' returns immediately with value nil.
191 Otherwise it waits for PROGRAM to terminate
192 and returns a numeric exit status or a signal description string.
193 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
195 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
196 (int nargs
, register Lisp_Object
*args
)
198 Lisp_Object infile
, buffer
, current_dir
, path
;
203 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
204 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
205 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
206 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
207 int count
= SPECPDL_INDEX ();
209 register const unsigned char **new_argv
;
210 /* File to use for stderr in the child.
211 t means use same as standard output. */
212 Lisp_Object error_file
;
213 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
214 char *outf
, *tempfile
;
217 struct coding_system process_coding
; /* coding-system of process output */
218 struct coding_system argument_coding
; /* coding-system of arguments */
219 /* Set to the return value of Ffind_operation_coding_system. */
220 Lisp_Object coding_systems
;
222 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
225 CHECK_STRING (args
[0]);
230 /* Without asynchronous processes we cannot have BUFFER == 0. */
232 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
233 error ("Operating system cannot handle asynchronous subprocesses");
234 #endif /* subprocesses */
236 /* Decide the coding-system for giving arguments. */
238 Lisp_Object val
, *args2
;
241 /* If arguments are supplied, we may have to encode them. */
245 Lisp_Object coding_attrs
;
247 for (i
= 4; i
< nargs
; i
++)
248 CHECK_STRING (args
[i
]);
250 for (i
= 4; i
< nargs
; i
++)
251 if (STRING_MULTIBYTE (args
[i
]))
254 if (!NILP (Vcoding_system_for_write
))
255 val
= Vcoding_system_for_write
;
256 else if (! must_encode
)
260 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
261 args2
[0] = Qcall_process
;
262 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
263 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
264 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
266 val
= complement_process_encoding_system (val
);
267 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
268 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
269 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
271 /* We should not use an ASCII incompatible coding system. */
272 val
= raw_text_coding_system (val
);
273 setup_coding_system (val
, &argument_coding
);
278 if (nargs
>= 2 && ! NILP (args
[1]))
280 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
281 CHECK_STRING (infile
);
284 infile
= build_string (NULL_DEVICE
);
290 /* If BUFFER is a list, its meaning is
291 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
294 if (CONSP (XCDR (buffer
)))
296 Lisp_Object stderr_file
;
297 stderr_file
= XCAR (XCDR (buffer
));
299 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
300 error_file
= stderr_file
;
302 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
305 buffer
= XCAR (buffer
);
308 if (!(EQ (buffer
, Qnil
)
310 || INTEGERP (buffer
)))
312 Lisp_Object spec_buffer
;
313 spec_buffer
= buffer
;
314 buffer
= Fget_buffer_create (buffer
);
315 /* Mention the buffer name for a better error message. */
317 CHECK_BUFFER (spec_buffer
);
318 CHECK_BUFFER (buffer
);
324 /* Make sure that the child will be able to chdir to the current
325 buffer's current directory, or its unhandled equivalent. We
326 can't just have the child check for an error when it does the
327 chdir, since it's in a vfork.
329 We have to GCPRO around this because Fexpand_file_name,
330 Funhandled_file_name_directory, and Ffile_accessible_directory_p
331 might call a file name handling function. The argument list is
332 protected by the caller, so all we really have to worry about is
335 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
337 current_dir
= current_buffer
->directory
;
339 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
341 current_dir
= Funhandled_file_name_directory (current_dir
);
342 if (NILP (current_dir
))
343 /* If the file name handler says that current_dir is unreachable, use
344 a sensible default. */
345 current_dir
= build_string ("~/");
346 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
347 current_dir
= Ffile_name_as_directory (current_dir
);
349 if (NILP (Ffile_accessible_directory_p (current_dir
)))
350 report_file_error ("Setting current directory",
351 Fcons (current_buffer
->directory
, Qnil
));
353 if (STRING_MULTIBYTE (infile
))
354 infile
= ENCODE_FILE (infile
);
355 if (STRING_MULTIBYTE (current_dir
))
356 current_dir
= ENCODE_FILE (current_dir
);
357 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
358 error_file
= ENCODE_FILE (error_file
);
362 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
364 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
367 infile
= DECODE_FILE (infile
);
368 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
370 /* Search for program; barf if not found. */
372 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
374 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
375 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
380 emacs_close (filefd
);
381 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
384 /* If program file name starts with /: for quoting a magic name,
386 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
387 && SREF (path
, 1) == ':')
388 path
= Fsubstring (path
, make_number (2), Qnil
);
390 new_argv
= (const unsigned char **)
391 alloca (max (2, nargs
- 2) * sizeof (char *));
395 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
397 GCPRO5 (infile
, buffer
, current_dir
, path
, error_file
);
398 argument_coding
.dst_multibyte
= 0;
399 for (i
= 4; i
< nargs
; i
++)
401 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
402 if (CODING_REQUIRE_ENCODING (&argument_coding
))
403 /* We must encode this argument. */
404 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
407 for (i
= 4; i
< nargs
; i
++)
408 new_argv
[i
- 3] = SDATA (args
[i
]);
413 new_argv
[0] = SDATA (path
);
415 #ifdef MSDOS /* MW, July 1993 */
416 if ((outf
= egetenv ("TMPDIR")))
417 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
420 tempfile
= alloca (20);
423 dostounix_filename (tempfile
);
424 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
425 strcat (tempfile
, "/");
426 strcat (tempfile
, "detmp.XXX");
429 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
432 emacs_close (filefd
);
433 report_file_error ("Opening process output file",
434 Fcons (build_string (tempfile
), Qnil
));
440 if (INTEGERP (buffer
))
441 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
448 emacs_close (filefd
);
449 report_file_error ("Creating process pipe", Qnil
);
455 /* child_setup must clobber environ in systems with true vfork.
456 Protect it from permanent change. */
457 register char **save_environ
= environ
;
458 register int fd1
= fd
[1];
461 #if 0 /* Some systems don't have sigblock. */
462 mask
= sigblock (sigmask (SIGCHLD
));
465 /* Record that we're about to create a synchronous process. */
466 synch_process_alive
= 1;
468 /* These vars record information from process termination.
469 Clear them now before process can possibly terminate,
470 to avoid timing error if process terminates soon. */
471 synch_process_death
= 0;
472 synch_process_retcode
= 0;
473 synch_process_termsig
= 0;
475 if (NILP (error_file
))
476 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
477 else if (STRINGP (error_file
))
480 fd_error
= emacs_open (SDATA (error_file
),
481 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
483 #else /* not DOS_NT */
484 fd_error
= creat (SDATA (error_file
), 0666);
485 #endif /* not DOS_NT */
490 emacs_close (filefd
);
498 if (NILP (error_file
))
499 error_file
= build_string (NULL_DEVICE
);
500 else if (STRINGP (error_file
))
501 error_file
= DECODE_FILE (error_file
);
502 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
505 #ifdef MSDOS /* MW, July 1993 */
506 /* Note that on MSDOS `child_setup' actually returns the child process
507 exit status, not its PID, so we assign it to `synch_process_retcode'
509 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
512 /* Record that the synchronous process exited and note its
513 termination status. */
514 synch_process_alive
= 0;
515 synch_process_retcode
= pid
;
516 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
518 synchronize_system_messages_locale ();
519 synch_process_death
= strerror (errno
);
522 emacs_close (outfilefd
);
523 if (fd_error
!= outfilefd
)
524 emacs_close (fd_error
);
525 fd1
= -1; /* No harm in closing that one! */
526 /* Since CRLF is converted to LF within `decode_coding', we can
527 always open a file with binary mode. */
528 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
532 emacs_close (filefd
);
533 report_file_error ("Cannot re-open temporary file", Qnil
);
535 #else /* not MSDOS */
537 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
539 #else /* not WINDOWSNT */
556 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
561 #endif /* not WINDOWSNT */
563 /* The MSDOS case did this already. */
565 emacs_close (fd_error
);
566 #endif /* not MSDOS */
568 environ
= save_environ
;
570 /* Close most of our fd's, but not fd[0]
571 since we will use that to read input from. */
572 emacs_close (filefd
);
573 if (fd1
>= 0 && fd1
!= fd_error
)
581 report_file_error ("Doing vfork", Qnil
);
584 if (INTEGERP (buffer
))
591 /* Enable sending signal if user quits below. */
592 call_process_exited
= 0;
595 /* MSDOS needs different cleanup information. */
596 record_unwind_protect (call_process_cleanup
,
597 Fcons (Fcurrent_buffer (),
598 Fcons (make_number (fd
[0]),
599 build_string (tempfile
))));
601 record_unwind_protect (call_process_cleanup
,
602 Fcons (Fcurrent_buffer (),
603 Fcons (make_number (fd
[0]), make_number (pid
))));
604 #endif /* not MSDOS */
607 if (BUFFERP (buffer
))
608 Fset_buffer (buffer
);
612 /* If BUFFER is nil, we must read process output once and then
613 discard it, so setup coding system but with nil. */
614 setup_coding_system (Qnil
, &process_coding
);
618 Lisp_Object val
, *args2
;
621 if (!NILP (Vcoding_system_for_read
))
622 val
= Vcoding_system_for_read
;
625 if (EQ (coding_systems
, Qt
))
629 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
630 args2
[0] = Qcall_process
;
631 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
633 = Ffind_operation_coding_system (nargs
+ 1, args2
);
635 if (CONSP (coding_systems
))
636 val
= XCAR (coding_systems
);
637 else if (CONSP (Vdefault_process_coding_system
))
638 val
= XCAR (Vdefault_process_coding_system
);
642 Fcheck_coding_system (val
);
643 /* In unibyte mode, character code conversion should not take
644 place but EOL conversion should. So, setup raw-text or one
645 of the subsidiary according to the information just setup. */
646 if (NILP (current_buffer
->enable_multibyte_characters
)
648 val
= raw_text_coding_system (val
);
649 setup_coding_system (val
, &process_coding
);
656 register EMACS_INT nread
;
658 EMACS_INT total_read
= 0;
660 int display_on_the_fly
= display_p
;
661 struct coding_system saved_coding
;
663 saved_coding
= process_coding
;
666 /* Repeatedly read until we've filled as much as possible
667 of the buffer size we have. But don't read
668 less than 1024--save that for the next bufferful. */
670 while (nread
< bufsize
- 1024)
672 int this_read
= emacs_read (fd
[0], buf
+ nread
,
680 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
685 total_read
+= this_read
;
687 if (display_on_the_fly
)
691 /* Now NREAD is the total amount of data in the buffer. */
696 if (NILP (current_buffer
->enable_multibyte_characters
)
697 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
698 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
700 { /* We have to decode the input. */
702 int count1
= SPECPDL_INDEX ();
704 XSETBUFFER (curbuf
, current_buffer
);
705 /* We cannot allow after-change-functions be run
706 during decoding, because that might modify the
707 buffer, while we rely on process_coding.produced to
708 faithfully reflect inserted text until we
709 TEMP_SET_PT_BOTH below. */
710 specbind (Qinhibit_modification_hooks
, Qt
);
711 decode_coding_c_string (&process_coding
, buf
, nread
,
713 unbind_to (count1
, Qnil
);
714 if (display_on_the_fly
715 && CODING_REQUIRE_DETECTION (&saved_coding
)
716 && ! CODING_REQUIRE_DETECTION (&process_coding
))
718 /* We have detected some coding system. But,
719 there's a possibility that the detection was
720 done by insufficient data. So, we give up
721 displaying on the fly. */
722 if (process_coding
.produced
> 0)
723 del_range_2 (process_coding
.dst_pos
,
724 process_coding
.dst_pos_byte
,
725 process_coding
.dst_pos
726 + process_coding
.produced_char
,
727 process_coding
.dst_pos_byte
728 + process_coding
.produced
, 0);
729 display_on_the_fly
= 0;
730 process_coding
= saved_coding
;
732 /* This is to make the above condition always
733 fails in the future. */
734 saved_coding
.common_flags
735 &= ~CODING_REQUIRE_DETECTION_MASK
;
739 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
740 PT_BYTE
+ process_coding
.produced
);
741 carryover
= process_coding
.carryover_bytes
;
743 memcpy (buf
, process_coding
.carryover
,
744 process_coding
.carryover_bytes
);
748 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
751 /* Make the buffer bigger as we continue to read more data,
752 but not past CALLPROC_BUFFER_SIZE_MAX. */
753 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
754 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
755 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
760 prepare_menu_bars ();
762 redisplay_preserve_echo_area (1);
763 /* This variable might have been set to 0 for code
764 detection. In that case, we set it back to 1 because
765 we should have already detected a coding system. */
766 display_on_the_fly
= 1;
773 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
774 /* If the caller required, let the buffer inherit the
775 coding-system used to decode the process output. */
776 if (inherit_process_coding_system
)
777 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
778 make_number (total_read
));
782 /* Wait for it to terminate, unless it already has. */
783 wait_for_termination (pid
);
788 /* Don't kill any children that the subprocess may have left behind
790 call_process_exited
= 1;
792 unbind_to (count
, Qnil
);
794 if (synch_process_termsig
)
798 synchronize_system_messages_locale ();
799 signame
= strsignal (synch_process_termsig
);
804 synch_process_death
= signame
;
807 if (synch_process_death
)
808 return code_convert_string_norecord (build_string (synch_process_death
),
809 Vlocale_coding_system
, 0);
810 return make_number (synch_process_retcode
);
814 delete_temp_file (Lisp_Object name
)
816 /* Suppress jka-compr handling, etc. */
817 int count
= SPECPDL_INDEX ();
818 specbind (intern ("file-name-handler-alist"), Qnil
);
819 internal_delete_file (name
);
820 unbind_to (count
, Qnil
);
824 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
826 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
827 The remaining arguments are optional.
828 Delete the text if fourth arg DELETE is non-nil.
830 Insert output in BUFFER before point; t means current buffer;
831 nil for BUFFER means discard it; 0 means discard and don't wait.
832 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
833 REAL-BUFFER says what to do with standard output, as above,
834 while STDERR-FILE says what to do with standard error in the child.
835 STDERR-FILE may be nil (discard standard error output),
836 t (mix it with ordinary output), or a file name string.
838 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
839 Remaining args are passed to PROGRAM at startup as command args.
841 If BUFFER is 0, `call-process-region' returns immediately with value nil.
842 Otherwise it waits for PROGRAM to terminate
843 and returns a numeric exit status or a signal description string.
844 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
846 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
847 (int nargs
, register Lisp_Object
*args
)
850 Lisp_Object filename_string
;
851 register Lisp_Object start
, end
;
852 int count
= SPECPDL_INDEX ();
853 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
854 Lisp_Object coding_systems
;
855 Lisp_Object val
, *args2
;
858 Lisp_Object tmpdir
, pattern
;
860 if (STRINGP (Vtemporary_file_directory
))
861 tmpdir
= Vtemporary_file_directory
;
865 if (getenv ("TMPDIR"))
866 tmpdir
= build_string (getenv ("TMPDIR"));
868 tmpdir
= build_string ("/tmp/");
871 if ((outf
= egetenv ("TMPDIR"))
872 || (outf
= egetenv ("TMP"))
873 || (outf
= egetenv ("TEMP")))
874 tmpdir
= build_string (outf
);
876 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
880 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
881 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
882 memcpy (tempfile
, SDATA (pattern
), SBYTES (pattern
) + 1);
890 fd
= mkstemp (tempfile
);
893 report_file_error ("Failed to open temporary file",
894 Fcons (Vtemp_file_name_pattern
, Qnil
));
902 filename_string
= build_string (tempfile
);
903 GCPRO1 (filename_string
);
906 /* Decide coding-system of the contents of the temporary file. */
907 if (!NILP (Vcoding_system_for_write
))
908 val
= Vcoding_system_for_write
;
909 else if (NILP (current_buffer
->enable_multibyte_characters
))
913 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
914 args2
[0] = Qcall_process_region
;
915 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
916 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
917 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
919 val
= complement_process_encoding_system (val
);
922 int count1
= SPECPDL_INDEX ();
924 specbind (intern ("coding-system-for-write"), val
);
925 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
926 happen to get a ".Z" suffix. */
927 specbind (intern ("file-name-handler-alist"), Qnil
);
928 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
930 unbind_to (count1
, Qnil
);
933 /* Note that Fcall_process takes care of binding
934 coding-system-for-read. */
936 record_unwind_protect (delete_temp_file
, filename_string
);
938 if (nargs
> 3 && !NILP (args
[3]))
939 Fdelete_region (start
, end
);
951 args
[1] = filename_string
;
953 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
957 static int relocate_fd (int fd
, int minfd
);
961 add_env (char **env
, char **new_env
, char *string
)
968 /* See if this string duplicates any string already in the env.
969 If so, don't put it in.
970 When an env var has multiple definitions,
971 we keep the definition that comes first in process-environment. */
972 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
974 char *p
= *ep
, *q
= string
;
980 /* The string is a lone variable name; keep it for now, we
981 will remove it later. It is a placeholder for a
982 variable that is not to be included in the environment. */
994 /* This is the last thing run in a newly forked inferior
995 either synchronous or asynchronous.
996 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
997 Initialize inferior's priority, pgrp, connected dir and environment.
998 then exec another program based on new_argv.
1000 This function may change environ for the superior process.
1001 Therefore, the superior process must save and restore the value
1002 of environ around the vfork and the call to this function.
1004 SET_PGRP is nonzero if we should put the subprocess into a separate
1007 CURRENT_DIR is an elisp string giving the path of the current
1008 directory the subprocess should have. Since we can't really signal
1009 a decent error from within the child, this should be verified as an
1010 executable directory by the parent. */
1013 child_setup (int in
, int out
, int err
, register char **new_argv
, int set_pgrp
, Lisp_Object current_dir
)
1020 #endif /* WINDOWSNT */
1022 int pid
= getpid ();
1024 /* Close Emacs's descriptors that this process should not have. */
1025 close_process_descs ();
1027 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1028 we will lose if we call close_load_descs here. */
1030 close_load_descs ();
1033 /* Note that use of alloca is always safe here. It's obvious for systems
1034 that do not have true vfork or that have true (stack) alloca.
1035 If using vfork and C_ALLOCA (when Emacs used to include
1036 src/alloca.c) it is safe because that changes the superior's
1037 static variables as if the superior had done alloca and will be
1038 cleaned up in the usual way. */
1040 register char *temp
;
1043 i
= SBYTES (current_dir
);
1045 /* MSDOS must have all environment variables malloc'ed, because
1046 low-level libc functions that launch subsidiary processes rely
1048 pwd_var
= (char *) xmalloc (i
+ 6);
1050 pwd_var
= (char *) alloca (i
+ 6);
1053 memcpy (pwd_var
, "PWD=", 4);
1054 memcpy (temp
, SDATA (current_dir
), i
);
1055 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1059 /* We can't signal an Elisp error here; we're in a vfork. Since
1060 the callers check the current directory before forking, this
1061 should only return an error if the directory's permissions
1062 are changed between the check and this chdir, but we should
1064 if (chdir (temp
) < 0)
1067 /* Get past the drive letter, so that d:/ is left alone. */
1068 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1075 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1076 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1080 /* Set `env' to a vector of the strings in the environment. */
1082 register Lisp_Object tem
;
1083 register char **new_env
;
1085 register int new_length
;
1086 Lisp_Object display
= Qnil
;
1090 for (tem
= Vprocess_environment
;
1091 CONSP (tem
) && STRINGP (XCAR (tem
));
1094 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1095 && (SDATA (XCAR (tem
)) [7] == '\0'
1096 || SDATA (XCAR (tem
)) [7] == '='))
1097 /* DISPLAY is specified in process-environment. */
1102 /* If not provided yet, use the frame's DISPLAY. */
1105 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1106 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1107 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1108 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1109 Vinitial_environment
);
1117 /* new_length + 2 to include PWD and terminating 0. */
1118 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1119 /* If we have a PWD envvar, pass one down,
1120 but with corrected value. */
1121 if (egetenv ("PWD"))
1122 *new_env
++ = pwd_var
;
1124 if (STRINGP (display
))
1126 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1127 char *vdata
= (char *) alloca (vlen
);
1128 strcpy (vdata
, "DISPLAY=");
1129 strcat (vdata
, SDATA (display
));
1130 new_env
= add_env (env
, new_env
, vdata
);
1134 for (tem
= Vprocess_environment
;
1135 CONSP (tem
) && STRINGP (XCAR (tem
));
1137 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1141 /* Remove variable names without values. */
1145 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1155 prepare_standard_handles (in
, out
, err
, handles
);
1156 set_process_dir (SDATA (current_dir
));
1157 /* Spawn the child. (See ntproc.c:Spawnve). */
1158 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1159 reset_standard_handles (in
, out
, err
, handles
);
1161 /* An error occurred while trying to spawn the process. */
1162 report_file_error ("Spawning child process", Qnil
);
1165 #else /* not WINDOWSNT */
1166 /* Make sure that in, out, and err are not actually already in
1167 descriptors zero, one, or two; this could happen if Emacs is
1168 started with its standard in, out, or error closed, as might
1171 int oin
= in
, oout
= out
;
1173 /* We have to avoid relocating the same descriptor twice! */
1175 in
= relocate_fd (in
, 3);
1180 out
= relocate_fd (out
, 3);
1184 else if (err
== oout
)
1187 err
= relocate_fd (err
, 3);
1201 if (err
!= in
&& err
!= out
)
1205 #ifndef SETPGRP_RELEASES_CTTY
1206 setpgrp (); /* No arguments but equivalent in this case */
1210 #endif /* not USG */
1212 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1215 /* execvp does not accept an environment arg so the only way
1216 to pass this environment is to set environ. Our caller
1217 is responsible for restoring the ambient value of environ. */
1219 execvp (new_argv
[0], new_argv
);
1221 emacs_write (1, "Can't exec program: ", 20);
1222 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1223 emacs_write (1, "\n", 1);
1227 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1230 /* An error occurred while trying to run the subprocess. */
1231 report_file_error ("Spawning child process", Qnil
);
1234 #endif /* not WINDOWSNT */
1238 /* Move the file descriptor FD so that its number is not less than MINFD.
1239 If the file descriptor is moved at all, the original is freed. */
1241 relocate_fd (int fd
, int minfd
)
1249 new = fcntl (fd
, F_DUPFD
, minfd
);
1253 /* Note that we hold the original FD open while we recurse,
1254 to guarantee we'll get a new FD if we need it. */
1255 new = relocate_fd (new, minfd
);
1259 const char *message1
= "Error while setting up child: ";
1260 const char *errmessage
= strerror (errno
);
1261 const char *message2
= "\n";
1262 emacs_write (2, message1
, strlen (message1
));
1263 emacs_write (2, errmessage
, strlen (errmessage
));
1264 emacs_write (2, message2
, strlen (message2
));
1271 #endif /* not WINDOWSNT */
1274 getenv_internal_1 (const char *var
, int varlen
, char **value
, int *valuelen
,
1277 for (; CONSP (env
); env
= XCDR (env
))
1279 Lisp_Object entry
= XCAR (env
);
1281 && SBYTES (entry
) >= varlen
1283 /* NT environment variables are case insensitive. */
1284 && ! strnicmp (SDATA (entry
), var
, varlen
)
1285 #else /* not WINDOWSNT */
1286 && ! memcmp (SDATA (entry
), var
, varlen
)
1287 #endif /* not WINDOWSNT */
1290 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1292 *value
= (char *) SDATA (entry
) + (varlen
+ 1);
1293 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1296 else if (SBYTES (entry
) == varlen
)
1298 /* Lone variable names in Vprocess_environment mean that
1299 variable should be removed from the environment. */
1309 getenv_internal (const char *var
, int varlen
, char **value
, int *valuelen
,
1312 /* Try to find VAR in Vprocess_environment first. */
1313 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1314 Vprocess_environment
))
1315 return *value
? 1 : 0;
1317 /* For DISPLAY try to get the values from the frame or the initial env. */
1318 if (strcmp (var
, "DISPLAY") == 0)
1321 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1322 if (STRINGP (display
))
1324 *value
= (char *) SDATA (display
);
1325 *valuelen
= SBYTES (display
);
1328 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1329 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1330 Vinitial_environment
))
1331 return *value
? 1 : 0;
1337 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1338 doc
: /* Get the value of environment variable VARIABLE.
1339 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1340 the environment. Otherwise, value is a string.
1342 This function searches `process-environment' for VARIABLE.
1344 If optional parameter ENV is a list, then search this list instead of
1345 `process-environment', and return t when encountering a negative entry
1346 \(an entry for a variable with no value). */)
1347 (Lisp_Object variable
, Lisp_Object env
)
1352 CHECK_STRING (variable
);
1355 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1356 &value
, &valuelen
, env
))
1357 return value
? make_string (value
, valuelen
) : Qt
;
1361 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1362 &value
, &valuelen
, env
))
1363 return make_string (value
, valuelen
);
1368 /* A version of getenv that consults the Lisp environment lists,
1369 easily callable from C. */
1371 egetenv (const char *var
)
1376 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1383 /* This is run before init_cmdargs. */
1386 init_callproc_1 (void)
1388 char *data_dir
= egetenv ("EMACSDATA");
1389 char *doc_dir
= egetenv ("EMACSDOC");
1392 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1395 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1398 /* Check the EMACSPATH environment variable, defaulting to the
1399 PATH_EXEC path from epaths.h. */
1400 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1401 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1402 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1405 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1408 init_callproc (void)
1410 char *data_dir
= egetenv ("EMACSDATA");
1413 Lisp_Object tempdir
;
1415 if (!NILP (Vinstallation_directory
))
1417 /* Add to the path the lib-src subdir of the installation dir. */
1419 tem
= Fexpand_file_name (build_string ("lib-src"),
1420 Vinstallation_directory
);
1422 /* MSDOS uses wrapped binaries, so don't do this. */
1423 if (NILP (Fmember (tem
, Vexec_path
)))
1425 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1426 Vexec_path
= Fcons (tem
, Vexec_path
);
1427 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1430 Vexec_directory
= Ffile_name_as_directory (tem
);
1431 #endif /* not DOS_NT */
1433 /* Maybe use ../etc as well as ../lib-src. */
1436 tem
= Fexpand_file_name (build_string ("etc"),
1437 Vinstallation_directory
);
1438 Vdoc_directory
= Ffile_name_as_directory (tem
);
1442 /* Look for the files that should be in etc. We don't use
1443 Vinstallation_directory, because these files are never installed
1444 near the executable, and they are never in the build
1445 directory when that's different from the source directory.
1447 Instead, if these files are not in the nominal place, we try the
1448 source directory. */
1451 Lisp_Object tem
, tem1
, srcdir
;
1453 srcdir
= Fexpand_file_name (build_string ("../src/"),
1454 build_string (PATH_DUMPLOADSEARCH
));
1455 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1456 tem1
= Ffile_exists_p (tem
);
1457 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1460 newdir
= Fexpand_file_name (build_string ("../etc/"),
1461 build_string (PATH_DUMPLOADSEARCH
));
1462 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1463 tem1
= Ffile_exists_p (tem
);
1465 Vdata_directory
= newdir
;
1473 tempdir
= Fdirectory_file_name (Vexec_directory
);
1474 if (access (SDATA (tempdir
), 0) < 0)
1475 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1479 tempdir
= Fdirectory_file_name (Vdata_directory
);
1480 if (access (SDATA (tempdir
), 0) < 0)
1481 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1484 sh
= (char *) getenv ("SHELL");
1485 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1488 Vshared_game_score_directory
= Qnil
;
1490 Vshared_game_score_directory
= build_string (PATH_GAME
);
1491 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1492 Vshared_game_score_directory
= Qnil
;
1497 set_initial_environment (void)
1499 register char **envp
;
1501 Vprocess_environment
= Qnil
;
1506 for (envp
= environ
; *envp
; envp
++)
1507 Vprocess_environment
= Fcons (build_string (*envp
),
1508 Vprocess_environment
);
1509 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1510 to use `delete' and friends on process-environment. */
1511 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1516 syms_of_callproc (void)
1519 Qbuffer_file_type
= intern_c_string ("buffer-file-type");
1520 staticpro (&Qbuffer_file_type
);
1524 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1525 #elif defined (WINDOWSNT)
1526 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1528 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1530 staticpro (&Vtemp_file_name_pattern
);
1532 DEFVAR_LISP ("shell-file-name", &Vshell_file_name
,
1533 doc
: /* *File name to load inferior shells from.
1534 Initialized from the SHELL environment variable, or to a system-dependent
1535 default if SHELL is not set. */);
1537 DEFVAR_LISP ("exec-path", &Vexec_path
,
1538 doc
: /* *List of directories to search programs to run in subprocesses.
1539 Each element is a string (directory name) or nil (try default directory). */);
1541 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes
,
1542 doc
: /* *List of suffixes to try to find executable file names.
1543 Each element is a string. */);
1544 Vexec_suffixes
= Qnil
;
1546 DEFVAR_LISP ("exec-directory", &Vexec_directory
,
1547 doc
: /* Directory for executables for Emacs to invoke.
1548 More generally, this includes any architecture-dependent files
1549 that are built and installed from the Emacs distribution. */);
1551 DEFVAR_LISP ("data-directory", &Vdata_directory
,
1552 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1553 These are files intended for Emacs to use while it runs. */);
1555 DEFVAR_LISP ("doc-directory", &Vdoc_directory
,
1556 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1557 This is usually the same as `data-directory'. */);
1559 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory
,
1560 doc
: /* For internal use by the build procedure only.
1561 This is the name of the directory in which the build procedure installed
1562 Emacs's info files; the default value for `Info-default-directory-list'
1564 Vconfigure_info_directory
= build_string (PATH_INFO
);
1566 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory
,
1567 doc
: /* Directory of score files for games which come with GNU Emacs.
1568 If this variable is nil, then Emacs is unable to use a shared directory. */);
1570 Vshared_game_score_directory
= Qnil
;
1572 Vshared_game_score_directory
= build_string (PATH_GAME
);
1575 DEFVAR_LISP ("initial-environment", &Vinitial_environment
,
1576 doc
: /* List of environment variables inherited from the parent process.
1577 Each element should be a string of the form ENVVARNAME=VALUE.
1578 The elements must normally be decoded (using `locale-coding-system') for use. */);
1579 Vinitial_environment
= Qnil
;
1581 DEFVAR_LISP ("process-environment", &Vprocess_environment
,
1582 doc
: /* List of overridden environment variables for subprocesses to inherit.
1583 Each element should be a string of the form ENVVARNAME=VALUE.
1585 Entries in this list take precedence to those in the frame-local
1586 environments. Therefore, let-binding `process-environment' is an easy
1587 way to temporarily change the value of an environment variable,
1588 irrespective of where it comes from. To use `process-environment' to
1589 remove an environment variable, include only its name in the list,
1592 This variable is set to nil when Emacs starts.
1594 If multiple entries define the same variable, the first one always
1597 Non-ASCII characters are encoded according to the initial value of
1598 `locale-coding-system', i.e. the elements must normally be decoded for
1601 See `setenv' and `getenv'. */);
1602 Vprocess_environment
= Qnil
;
1604 defsubr (&Scall_process
);
1605 defsubr (&Sgetenv_internal
);
1606 defsubr (&Scall_process_region
);