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, 2011
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>
37 #define _P_NOWAIT 1 /* from process.h */
40 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/param.h>
48 #include "character.h"
51 #include "composite.h"
54 #include "syssignal.h"
56 #include "blockinput.h"
58 #include "termhooks.h"
65 extern char **environ
;
71 #define setpgrp setpgid
75 /* Pattern used by call-process-region to make temp files. */
76 static Lisp_Object Vtemp_file_name_pattern
;
79 Lisp_Object Qbuffer_file_type
;
82 /* True if we are about to fork off a synchronous process or if we
83 are waiting for it. */
84 int synch_process_alive
;
86 /* Nonzero => this is a string explaining death of synchronous subprocess. */
87 const char *synch_process_death
;
89 /* Nonzero => this is the signal number that terminated the subprocess. */
90 int synch_process_termsig
;
92 /* If synch_process_death is zero,
93 this is exit code of synchronous subprocess. */
94 int synch_process_retcode
;
97 /* Clean up when exiting Fcall_process.
98 On MSDOS, delete the temporary file on any kind of termination.
99 On Unix, kill the process and any children on termination by signal. */
101 /* Nonzero if this is termination due to exit. */
102 static int call_process_exited
;
104 EXFUN (Fgetenv_internal
, 2);
107 call_process_kill (Lisp_Object fdpid
)
109 emacs_close (XFASTINT (Fcar (fdpid
)));
110 EMACS_KILLPG (XFASTINT (Fcdr (fdpid
)), SIGKILL
);
111 synch_process_alive
= 0;
116 call_process_cleanup (Lisp_Object arg
)
118 Lisp_Object fdpid
= Fcdr (arg
);
125 Fset_buffer (Fcar (arg
));
128 /* for MSDOS fdpid is really (fd . tempfile) */
130 emacs_close (XFASTINT (Fcar (fdpid
)));
131 if (strcmp (SDATA (file
), NULL_DEVICE
) != 0)
132 unlink (SDATA (file
));
133 #else /* not MSDOS */
134 pid
= XFASTINT (Fcdr (fdpid
));
136 if (call_process_exited
)
138 emacs_close (XFASTINT (Fcar (fdpid
)));
142 if (EMACS_KILLPG (pid
, SIGINT
) == 0)
144 int count
= SPECPDL_INDEX ();
145 record_unwind_protect (call_process_kill
, fdpid
);
146 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
149 wait_for_termination (pid
);
151 specpdl_ptr
= specpdl
+ count
; /* Discard the unwind protect. */
152 message1 ("Waiting for process to die...done");
154 synch_process_alive
= 0;
155 emacs_close (XFASTINT (Fcar (fdpid
)));
156 #endif /* not MSDOS */
160 DEFUN ("call-process", Fcall_process
, Scall_process
, 1, MANY
, 0,
161 doc
: /* Call PROGRAM synchronously in separate process.
162 The remaining arguments are optional.
163 The program's input comes from file INFILE (nil means `/dev/null').
164 Insert output in BUFFER before point; t means current buffer;
165 nil for BUFFER means discard it; 0 means discard and don't wait.
166 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
167 REAL-BUFFER says what to do with standard output, as above,
168 while STDERR-FILE says what to do with standard error in the child.
169 STDERR-FILE may be nil (discard standard error output),
170 t (mix it with ordinary output), or a file name string.
172 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
173 Remaining arguments are strings passed as command arguments to PROGRAM.
175 If executable PROGRAM can't be found as an executable, `call-process'
176 signals a Lisp error. `call-process' reports errors in execution of
177 the program only through its return and output.
179 If BUFFER is 0, `call-process' returns immediately with value nil.
180 Otherwise it waits for PROGRAM to terminate
181 and returns a numeric exit status or a signal description string.
182 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
184 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
185 (int nargs
, register Lisp_Object
*args
)
187 Lisp_Object infile
, buffer
, current_dir
, path
;
192 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
193 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
194 char buf
[CALLPROC_BUFFER_SIZE_MAX
];
195 int bufsize
= CALLPROC_BUFFER_SIZE_MIN
;
196 int count
= SPECPDL_INDEX ();
198 register const unsigned char **new_argv
;
199 /* File to use for stderr in the child.
200 t means use same as standard output. */
201 Lisp_Object error_file
;
202 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
203 char *outf
, *tempfile
;
206 struct coding_system process_coding
; /* coding-system of process output */
207 struct coding_system argument_coding
; /* coding-system of arguments */
208 /* Set to the return value of Ffind_operation_coding_system. */
209 Lisp_Object coding_systems
;
211 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
214 CHECK_STRING (args
[0]);
219 /* Without asynchronous processes we cannot have BUFFER == 0. */
221 && (INTEGERP (CONSP (args
[2]) ? XCAR (args
[2]) : args
[2])))
222 error ("Operating system cannot handle asynchronous subprocesses");
223 #endif /* subprocesses */
225 /* Decide the coding-system for giving arguments. */
227 Lisp_Object val
, *args2
;
230 /* If arguments are supplied, we may have to encode them. */
234 Lisp_Object coding_attrs
;
236 for (i
= 4; i
< nargs
; i
++)
237 CHECK_STRING (args
[i
]);
239 for (i
= 4; i
< nargs
; i
++)
240 if (STRING_MULTIBYTE (args
[i
]))
243 if (!NILP (Vcoding_system_for_write
))
244 val
= Vcoding_system_for_write
;
245 else if (! must_encode
)
249 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
250 args2
[0] = Qcall_process
;
251 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
252 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
253 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
255 val
= complement_process_encoding_system (val
);
256 setup_coding_system (Fcheck_coding_system (val
), &argument_coding
);
257 coding_attrs
= CODING_ID_ATTRS (argument_coding
.id
);
258 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs
)))
260 /* We should not use an ASCII incompatible coding system. */
261 val
= raw_text_coding_system (val
);
262 setup_coding_system (val
, &argument_coding
);
267 if (nargs
>= 2 && ! NILP (args
[1]))
269 infile
= Fexpand_file_name (args
[1], current_buffer
->directory
);
270 CHECK_STRING (infile
);
273 infile
= build_string (NULL_DEVICE
);
279 /* If BUFFER is a list, its meaning is
280 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
283 if (CONSP (XCDR (buffer
)))
285 Lisp_Object stderr_file
;
286 stderr_file
= XCAR (XCDR (buffer
));
288 if (NILP (stderr_file
) || EQ (Qt
, stderr_file
))
289 error_file
= stderr_file
;
291 error_file
= Fexpand_file_name (stderr_file
, Qnil
);
294 buffer
= XCAR (buffer
);
297 if (!(EQ (buffer
, Qnil
)
299 || INTEGERP (buffer
)))
301 Lisp_Object spec_buffer
;
302 spec_buffer
= buffer
;
303 buffer
= Fget_buffer_create (buffer
);
304 /* Mention the buffer name for a better error message. */
306 CHECK_BUFFER (spec_buffer
);
307 CHECK_BUFFER (buffer
);
313 /* Make sure that the child will be able to chdir to the current
314 buffer's current directory, or its unhandled equivalent. We
315 can't just have the child check for an error when it does the
316 chdir, since it's in a vfork.
318 We have to GCPRO around this because Fexpand_file_name,
319 Funhandled_file_name_directory, and Ffile_accessible_directory_p
320 might call a file name handling function. The argument list is
321 protected by the caller, so all we really have to worry about is
324 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
326 current_dir
= current_buffer
->directory
;
328 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
330 current_dir
= Funhandled_file_name_directory (current_dir
);
331 if (NILP (current_dir
))
332 /* If the file name handler says that current_dir is unreachable, use
333 a sensible default. */
334 current_dir
= build_string ("~/");
335 current_dir
= expand_and_dir_to_file (current_dir
, Qnil
);
336 current_dir
= Ffile_name_as_directory (current_dir
);
338 if (NILP (Ffile_accessible_directory_p (current_dir
)))
339 report_file_error ("Setting current directory",
340 Fcons (current_buffer
->directory
, Qnil
));
342 if (STRING_MULTIBYTE (infile
))
343 infile
= ENCODE_FILE (infile
);
344 if (STRING_MULTIBYTE (current_dir
))
345 current_dir
= ENCODE_FILE (current_dir
);
346 if (STRINGP (error_file
) && STRING_MULTIBYTE (error_file
))
347 error_file
= ENCODE_FILE (error_file
);
351 display_p
= INTERACTIVE
&& nargs
>= 4 && !NILP (args
[3]);
353 filefd
= emacs_open (SDATA (infile
), O_RDONLY
, 0);
356 infile
= DECODE_FILE (infile
);
357 report_file_error ("Opening process input file", Fcons (infile
, Qnil
));
359 /* Search for program; barf if not found. */
361 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
;
363 GCPRO4 (infile
, buffer
, current_dir
, error_file
);
364 openp (Vexec_path
, args
[0], Vexec_suffixes
, &path
, make_number (X_OK
));
369 emacs_close (filefd
);
370 report_file_error ("Searching for program", Fcons (args
[0], Qnil
));
373 /* If program file name starts with /: for quoting a magic name,
375 if (SBYTES (path
) > 2 && SREF (path
, 0) == '/'
376 && SREF (path
, 1) == ':')
377 path
= Fsubstring (path
, make_number (2), Qnil
);
379 new_argv
= (const unsigned char **)
380 alloca (max (2, nargs
- 2) * sizeof (char *));
384 struct gcpro gcpro1
, gcpro2
, gcpro3
, gcpro4
, gcpro5
;
386 GCPRO5 (infile
, buffer
, current_dir
, path
, error_file
);
387 argument_coding
.dst_multibyte
= 0;
388 for (i
= 4; i
< nargs
; i
++)
390 argument_coding
.src_multibyte
= STRING_MULTIBYTE (args
[i
]);
391 if (CODING_REQUIRE_ENCODING (&argument_coding
))
392 /* We must encode this argument. */
393 args
[i
] = encode_coding_string (&argument_coding
, args
[i
], 1);
396 for (i
= 4; i
< nargs
; i
++)
397 new_argv
[i
- 3] = SDATA (args
[i
]);
402 new_argv
[0] = SDATA (path
);
404 #ifdef MSDOS /* MW, July 1993 */
405 if ((outf
= egetenv ("TMPDIR")))
406 strcpy (tempfile
= alloca (strlen (outf
) + 20), outf
);
409 tempfile
= alloca (20);
412 dostounix_filename (tempfile
);
413 if (*tempfile
== '\0' || tempfile
[strlen (tempfile
) - 1] != '/')
414 strcat (tempfile
, "/");
415 strcat (tempfile
, "detmp.XXX");
418 outfilefd
= creat (tempfile
, S_IREAD
| S_IWRITE
);
421 emacs_close (filefd
);
422 report_file_error ("Opening process output file",
423 Fcons (build_string (tempfile
), Qnil
));
429 if (INTEGERP (buffer
))
430 fd
[1] = emacs_open (NULL_DEVICE
, O_WRONLY
, 0), fd
[0] = -1;
437 emacs_close (filefd
);
438 report_file_error ("Creating process pipe", Qnil
);
444 /* child_setup must clobber environ in systems with true vfork.
445 Protect it from permanent change. */
446 register char **save_environ
= environ
;
447 register int fd1
= fd
[1];
450 #if 0 /* Some systems don't have sigblock. */
451 mask
= sigblock (sigmask (SIGCHLD
));
454 /* Record that we're about to create a synchronous process. */
455 synch_process_alive
= 1;
457 /* These vars record information from process termination.
458 Clear them now before process can possibly terminate,
459 to avoid timing error if process terminates soon. */
460 synch_process_death
= 0;
461 synch_process_retcode
= 0;
462 synch_process_termsig
= 0;
464 if (NILP (error_file
))
465 fd_error
= emacs_open (NULL_DEVICE
, O_WRONLY
, 0);
466 else if (STRINGP (error_file
))
469 fd_error
= emacs_open (SDATA (error_file
),
470 O_WRONLY
| O_TRUNC
| O_CREAT
| O_TEXT
,
472 #else /* not DOS_NT */
473 fd_error
= creat (SDATA (error_file
), 0666);
474 #endif /* not DOS_NT */
479 emacs_close (filefd
);
487 if (NILP (error_file
))
488 error_file
= build_string (NULL_DEVICE
);
489 else if (STRINGP (error_file
))
490 error_file
= DECODE_FILE (error_file
);
491 report_file_error ("Cannot redirect stderr", Fcons (error_file
, Qnil
));
494 #ifdef MSDOS /* MW, July 1993 */
495 /* Note that on MSDOS `child_setup' actually returns the child process
496 exit status, not its PID, so we assign it to `synch_process_retcode'
498 pid
= child_setup (filefd
, outfilefd
, fd_error
, (char **) new_argv
,
501 /* Record that the synchronous process exited and note its
502 termination status. */
503 synch_process_alive
= 0;
504 synch_process_retcode
= pid
;
505 if (synch_process_retcode
< 0) /* means it couldn't be exec'ed */
507 synchronize_system_messages_locale ();
508 synch_process_death
= strerror (errno
);
511 emacs_close (outfilefd
);
512 if (fd_error
!= outfilefd
)
513 emacs_close (fd_error
);
514 fd1
= -1; /* No harm in closing that one! */
515 /* Since CRLF is converted to LF within `decode_coding', we can
516 always open a file with binary mode. */
517 fd
[0] = emacs_open (tempfile
, O_RDONLY
| O_BINARY
, 0);
521 emacs_close (filefd
);
522 report_file_error ("Cannot re-open temporary file", Qnil
);
524 #else /* not MSDOS */
526 pid
= child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
528 #else /* not WINDOWSNT */
545 child_setup (filefd
, fd1
, fd_error
, (char **) new_argv
,
550 #endif /* not WINDOWSNT */
552 /* The MSDOS case did this already. */
554 emacs_close (fd_error
);
555 #endif /* not MSDOS */
557 environ
= save_environ
;
559 /* Close most of our fd's, but not fd[0]
560 since we will use that to read input from. */
561 emacs_close (filefd
);
562 if (fd1
>= 0 && fd1
!= fd_error
)
570 report_file_error ("Doing vfork", Qnil
);
573 if (INTEGERP (buffer
))
580 /* Enable sending signal if user quits below. */
581 call_process_exited
= 0;
584 /* MSDOS needs different cleanup information. */
585 record_unwind_protect (call_process_cleanup
,
586 Fcons (Fcurrent_buffer (),
587 Fcons (make_number (fd
[0]),
588 build_string (tempfile
))));
590 record_unwind_protect (call_process_cleanup
,
591 Fcons (Fcurrent_buffer (),
592 Fcons (make_number (fd
[0]), make_number (pid
))));
593 #endif /* not MSDOS */
596 if (BUFFERP (buffer
))
597 Fset_buffer (buffer
);
601 /* If BUFFER is nil, we must read process output once and then
602 discard it, so setup coding system but with nil. */
603 setup_coding_system (Qnil
, &process_coding
);
607 Lisp_Object val
, *args2
;
610 if (!NILP (Vcoding_system_for_read
))
611 val
= Vcoding_system_for_read
;
614 if (EQ (coding_systems
, Qt
))
618 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
619 args2
[0] = Qcall_process
;
620 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
622 = Ffind_operation_coding_system (nargs
+ 1, args2
);
624 if (CONSP (coding_systems
))
625 val
= XCAR (coding_systems
);
626 else if (CONSP (Vdefault_process_coding_system
))
627 val
= XCAR (Vdefault_process_coding_system
);
631 Fcheck_coding_system (val
);
632 /* In unibyte mode, character code conversion should not take
633 place but EOL conversion should. So, setup raw-text or one
634 of the subsidiary according to the information just setup. */
635 if (NILP (current_buffer
->enable_multibyte_characters
)
637 val
= raw_text_coding_system (val
);
638 setup_coding_system (val
, &process_coding
);
645 register EMACS_INT nread
;
647 EMACS_INT total_read
= 0;
649 int display_on_the_fly
= display_p
;
650 struct coding_system saved_coding
;
652 saved_coding
= process_coding
;
655 /* Repeatedly read until we've filled as much as possible
656 of the buffer size we have. But don't read
657 less than 1024--save that for the next bufferful. */
659 while (nread
< bufsize
- 1024)
661 int this_read
= emacs_read (fd
[0], buf
+ nread
,
669 process_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
674 total_read
+= this_read
;
676 if (display_on_the_fly
)
680 /* Now NREAD is the total amount of data in the buffer. */
685 if (NILP (current_buffer
->enable_multibyte_characters
)
686 && ! CODING_MAY_REQUIRE_DECODING (&process_coding
))
687 insert_1_both (buf
, nread
, nread
, 0, 1, 0);
689 { /* We have to decode the input. */
691 int count1
= SPECPDL_INDEX ();
693 XSETBUFFER (curbuf
, current_buffer
);
694 /* We cannot allow after-change-functions be run
695 during decoding, because that might modify the
696 buffer, while we rely on process_coding.produced to
697 faithfully reflect inserted text until we
698 TEMP_SET_PT_BOTH below. */
699 specbind (Qinhibit_modification_hooks
, Qt
);
700 decode_coding_c_string (&process_coding
, buf
, nread
,
702 unbind_to (count1
, Qnil
);
703 if (display_on_the_fly
704 && CODING_REQUIRE_DETECTION (&saved_coding
)
705 && ! CODING_REQUIRE_DETECTION (&process_coding
))
707 /* We have detected some coding system. But,
708 there's a possibility that the detection was
709 done by insufficient data. So, we give up
710 displaying on the fly. */
711 if (process_coding
.produced
> 0)
712 del_range_2 (process_coding
.dst_pos
,
713 process_coding
.dst_pos_byte
,
714 process_coding
.dst_pos
715 + process_coding
.produced_char
,
716 process_coding
.dst_pos_byte
717 + process_coding
.produced
, 0);
718 display_on_the_fly
= 0;
719 process_coding
= saved_coding
;
721 /* This is to make the above condition always
722 fails in the future. */
723 saved_coding
.common_flags
724 &= ~CODING_REQUIRE_DETECTION_MASK
;
728 TEMP_SET_PT_BOTH (PT
+ process_coding
.produced_char
,
729 PT_BYTE
+ process_coding
.produced
);
730 carryover
= process_coding
.carryover_bytes
;
732 memcpy (buf
, process_coding
.carryover
,
733 process_coding
.carryover_bytes
);
737 if (process_coding
.mode
& CODING_MODE_LAST_BLOCK
)
740 /* Make the buffer bigger as we continue to read more data,
741 but not past CALLPROC_BUFFER_SIZE_MAX. */
742 if (bufsize
< CALLPROC_BUFFER_SIZE_MAX
&& total_read
> 32 * bufsize
)
743 if ((bufsize
*= 2) > CALLPROC_BUFFER_SIZE_MAX
)
744 bufsize
= CALLPROC_BUFFER_SIZE_MAX
;
749 prepare_menu_bars ();
751 redisplay_preserve_echo_area (1);
752 /* This variable might have been set to 0 for code
753 detection. In that case, we set it back to 1 because
754 we should have already detected a coding system. */
755 display_on_the_fly
= 1;
762 Vlast_coding_system_used
= CODING_ID_NAME (process_coding
.id
);
763 /* If the caller required, let the buffer inherit the
764 coding-system used to decode the process output. */
765 if (inherit_process_coding_system
)
766 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
767 make_number (total_read
));
771 /* Wait for it to terminate, unless it already has. */
772 wait_for_termination (pid
);
777 /* Don't kill any children that the subprocess may have left behind
779 call_process_exited
= 1;
781 unbind_to (count
, Qnil
);
783 if (synch_process_termsig
)
787 synchronize_system_messages_locale ();
788 signame
= strsignal (synch_process_termsig
);
793 synch_process_death
= signame
;
796 if (synch_process_death
)
797 return code_convert_string_norecord (build_string (synch_process_death
),
798 Vlocale_coding_system
, 0);
799 return make_number (synch_process_retcode
);
803 delete_temp_file (Lisp_Object name
)
805 /* Suppress jka-compr handling, etc. */
806 int count
= SPECPDL_INDEX ();
807 specbind (intern ("file-name-handler-alist"), Qnil
);
808 internal_delete_file (name
);
809 unbind_to (count
, Qnil
);
813 DEFUN ("call-process-region", Fcall_process_region
, Scall_process_region
,
815 doc
: /* Send text from START to END to a synchronous process running PROGRAM.
816 The remaining arguments are optional.
817 Delete the text if fourth arg DELETE is non-nil.
819 Insert output in BUFFER before point; t means current buffer;
820 nil for BUFFER means discard it; 0 means discard and don't wait.
821 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
822 REAL-BUFFER says what to do with standard output, as above,
823 while STDERR-FILE says what to do with standard error in the child.
824 STDERR-FILE may be nil (discard standard error output),
825 t (mix it with ordinary output), or a file name string.
827 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
828 Remaining args are passed to PROGRAM at startup as command args.
830 If BUFFER is 0, `call-process-region' returns immediately with value nil.
831 Otherwise it waits for PROGRAM to terminate
832 and returns a numeric exit status or a signal description string.
833 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
835 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
836 (int nargs
, register Lisp_Object
*args
)
839 Lisp_Object filename_string
;
840 register Lisp_Object start
, end
;
841 int count
= SPECPDL_INDEX ();
842 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
843 Lisp_Object coding_systems
;
844 Lisp_Object val
, *args2
;
847 Lisp_Object tmpdir
, pattern
;
849 if (STRINGP (Vtemporary_file_directory
))
850 tmpdir
= Vtemporary_file_directory
;
854 if (getenv ("TMPDIR"))
855 tmpdir
= build_string (getenv ("TMPDIR"));
857 tmpdir
= build_string ("/tmp/");
860 if ((outf
= egetenv ("TMPDIR"))
861 || (outf
= egetenv ("TMP"))
862 || (outf
= egetenv ("TEMP")))
863 tmpdir
= build_string (outf
);
865 tmpdir
= Ffile_name_as_directory (build_string ("c:/temp"));
869 pattern
= Fexpand_file_name (Vtemp_file_name_pattern
, tmpdir
);
870 tempfile
= (char *) alloca (SBYTES (pattern
) + 1);
871 memcpy (tempfile
, SDATA (pattern
), SBYTES (pattern
) + 1);
879 fd
= mkstemp (tempfile
);
882 report_file_error ("Failed to open temporary file",
883 Fcons (Vtemp_file_name_pattern
, Qnil
));
891 filename_string
= build_string (tempfile
);
892 GCPRO1 (filename_string
);
895 /* Decide coding-system of the contents of the temporary file. */
896 if (!NILP (Vcoding_system_for_write
))
897 val
= Vcoding_system_for_write
;
898 else if (NILP (current_buffer
->enable_multibyte_characters
))
902 args2
= (Lisp_Object
*) alloca ((nargs
+ 1) * sizeof *args2
);
903 args2
[0] = Qcall_process_region
;
904 for (i
= 0; i
< nargs
; i
++) args2
[i
+ 1] = args
[i
];
905 coding_systems
= Ffind_operation_coding_system (nargs
+ 1, args2
);
906 val
= CONSP (coding_systems
) ? XCDR (coding_systems
) : Qnil
;
908 val
= complement_process_encoding_system (val
);
911 int count1
= SPECPDL_INDEX ();
913 specbind (intern ("coding-system-for-write"), val
);
914 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
915 happen to get a ".Z" suffix. */
916 specbind (intern ("file-name-handler-alist"), Qnil
);
917 Fwrite_region (start
, end
, filename_string
, Qnil
, Qlambda
, Qnil
, Qnil
);
919 unbind_to (count1
, Qnil
);
922 /* Note that Fcall_process takes care of binding
923 coding-system-for-read. */
925 record_unwind_protect (delete_temp_file
, filename_string
);
927 if (nargs
> 3 && !NILP (args
[3]))
928 Fdelete_region (start
, end
);
940 args
[1] = filename_string
;
942 RETURN_UNGCPRO (unbind_to (count
, Fcall_process (nargs
, args
)));
946 static int relocate_fd (int fd
, int minfd
);
950 add_env (char **env
, char **new_env
, char *string
)
957 /* See if this string duplicates any string already in the env.
958 If so, don't put it in.
959 When an env var has multiple definitions,
960 we keep the definition that comes first in process-environment. */
961 for (ep
= env
; ok
&& ep
!= new_env
; ep
++)
963 char *p
= *ep
, *q
= string
;
969 /* The string is a lone variable name; keep it for now, we
970 will remove it later. It is a placeholder for a
971 variable that is not to be included in the environment. */
983 /* This is the last thing run in a newly forked inferior
984 either synchronous or asynchronous.
985 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
986 Initialize inferior's priority, pgrp, connected dir and environment.
987 then exec another program based on new_argv.
989 This function may change environ for the superior process.
990 Therefore, the superior process must save and restore the value
991 of environ around the vfork and the call to this function.
993 SET_PGRP is nonzero if we should put the subprocess into a separate
996 CURRENT_DIR is an elisp string giving the path of the current
997 directory the subprocess should have. Since we can't really signal
998 a decent error from within the child, this should be verified as an
999 executable directory by the parent. */
1002 child_setup (int in
, int out
, int err
, register char **new_argv
, int set_pgrp
, Lisp_Object current_dir
)
1009 #endif /* WINDOWSNT */
1011 int pid
= getpid ();
1013 /* Close Emacs's descriptors that this process should not have. */
1014 close_process_descs ();
1016 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1017 we will lose if we call close_load_descs here. */
1019 close_load_descs ();
1022 /* Note that use of alloca is always safe here. It's obvious for systems
1023 that do not have true vfork or that have true (stack) alloca.
1024 If using vfork and C_ALLOCA (when Emacs used to include
1025 src/alloca.c) it is safe because that changes the superior's
1026 static variables as if the superior had done alloca and will be
1027 cleaned up in the usual way. */
1029 register char *temp
;
1032 i
= SBYTES (current_dir
);
1034 /* MSDOS must have all environment variables malloc'ed, because
1035 low-level libc functions that launch subsidiary processes rely
1037 pwd_var
= (char *) xmalloc (i
+ 6);
1039 pwd_var
= (char *) alloca (i
+ 6);
1042 memcpy (pwd_var
, "PWD=", 4);
1043 memcpy (temp
, SDATA (current_dir
), i
);
1044 if (!IS_DIRECTORY_SEP (temp
[i
- 1])) temp
[i
++] = DIRECTORY_SEP
;
1048 /* We can't signal an Elisp error here; we're in a vfork. Since
1049 the callers check the current directory before forking, this
1050 should only return an error if the directory's permissions
1051 are changed between the check and this chdir, but we should
1053 if (chdir (temp
) < 0)
1056 /* Get past the drive letter, so that d:/ is left alone. */
1057 if (i
> 2 && IS_DEVICE_SEP (temp
[1]) && IS_DIRECTORY_SEP (temp
[2]))
1064 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1065 while (i
> 2 && IS_DIRECTORY_SEP (temp
[i
- 1]))
1069 /* Set `env' to a vector of the strings in the environment. */
1071 register Lisp_Object tem
;
1072 register char **new_env
;
1074 register int new_length
;
1075 Lisp_Object display
= Qnil
;
1079 for (tem
= Vprocess_environment
;
1080 CONSP (tem
) && STRINGP (XCAR (tem
));
1083 if (strncmp (SDATA (XCAR (tem
)), "DISPLAY", 7) == 0
1084 && (SDATA (XCAR (tem
)) [7] == '\0'
1085 || SDATA (XCAR (tem
)) [7] == '='))
1086 /* DISPLAY is specified in process-environment. */
1091 /* If not provided yet, use the frame's DISPLAY. */
1094 Lisp_Object tmp
= Fframe_parameter (selected_frame
, Qdisplay
);
1095 if (!STRINGP (tmp
) && CONSP (Vinitial_environment
))
1096 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1097 tmp
= Fgetenv_internal (build_string ("DISPLAY"),
1098 Vinitial_environment
);
1106 /* new_length + 2 to include PWD and terminating 0. */
1107 env
= new_env
= (char **) alloca ((new_length
+ 2) * sizeof (char *));
1108 /* If we have a PWD envvar, pass one down,
1109 but with corrected value. */
1110 if (egetenv ("PWD"))
1111 *new_env
++ = pwd_var
;
1113 if (STRINGP (display
))
1115 int vlen
= strlen ("DISPLAY=") + strlen (SDATA (display
)) + 1;
1116 char *vdata
= (char *) alloca (vlen
);
1117 strcpy (vdata
, "DISPLAY=");
1118 strcat (vdata
, SDATA (display
));
1119 new_env
= add_env (env
, new_env
, vdata
);
1123 for (tem
= Vprocess_environment
;
1124 CONSP (tem
) && STRINGP (XCAR (tem
));
1126 new_env
= add_env (env
, new_env
, SDATA (XCAR (tem
)));
1130 /* Remove variable names without values. */
1134 while (*q
!= 0 && strchr (*q
, '=') == NULL
)
1144 prepare_standard_handles (in
, out
, err
, handles
);
1145 set_process_dir (SDATA (current_dir
));
1146 /* Spawn the child. (See ntproc.c:Spawnve). */
1147 cpid
= spawnve (_P_NOWAIT
, new_argv
[0], new_argv
, env
);
1148 reset_standard_handles (in
, out
, err
, handles
);
1150 /* An error occurred while trying to spawn the process. */
1151 report_file_error ("Spawning child process", Qnil
);
1154 #else /* not WINDOWSNT */
1155 /* Make sure that in, out, and err are not actually already in
1156 descriptors zero, one, or two; this could happen if Emacs is
1157 started with its standard in, out, or error closed, as might
1160 int oin
= in
, oout
= out
;
1162 /* We have to avoid relocating the same descriptor twice! */
1164 in
= relocate_fd (in
, 3);
1169 out
= relocate_fd (out
, 3);
1173 else if (err
== oout
)
1176 err
= relocate_fd (err
, 3);
1190 if (err
!= in
&& err
!= out
)
1194 #ifndef SETPGRP_RELEASES_CTTY
1195 setpgrp (); /* No arguments but equivalent in this case */
1199 #endif /* not USG */
1201 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1204 /* execvp does not accept an environment arg so the only way
1205 to pass this environment is to set environ. Our caller
1206 is responsible for restoring the ambient value of environ. */
1208 execvp (new_argv
[0], new_argv
);
1210 emacs_write (1, "Can't exec program: ", 20);
1211 emacs_write (1, new_argv
[0], strlen (new_argv
[0]));
1212 emacs_write (1, "\n", 1);
1216 pid
= run_msdos_command (new_argv
, pwd_var
+ 4, in
, out
, err
, env
);
1219 /* An error occurred while trying to run the subprocess. */
1220 report_file_error ("Spawning child process", Qnil
);
1223 #endif /* not WINDOWSNT */
1227 /* Move the file descriptor FD so that its number is not less than MINFD.
1228 If the file descriptor is moved at all, the original is freed. */
1230 relocate_fd (int fd
, int minfd
)
1238 new = fcntl (fd
, F_DUPFD
, minfd
);
1242 /* Note that we hold the original FD open while we recurse,
1243 to guarantee we'll get a new FD if we need it. */
1244 new = relocate_fd (new, minfd
);
1248 const char *message1
= "Error while setting up child: ";
1249 const char *errmessage
= strerror (errno
);
1250 const char *message2
= "\n";
1251 emacs_write (2, message1
, strlen (message1
));
1252 emacs_write (2, errmessage
, strlen (errmessage
));
1253 emacs_write (2, message2
, strlen (message2
));
1260 #endif /* not WINDOWSNT */
1263 getenv_internal_1 (const char *var
, int varlen
, char **value
, int *valuelen
,
1266 for (; CONSP (env
); env
= XCDR (env
))
1268 Lisp_Object entry
= XCAR (env
);
1270 && SBYTES (entry
) >= varlen
1272 /* NT environment variables are case insensitive. */
1273 && ! strnicmp (SDATA (entry
), var
, varlen
)
1274 #else /* not WINDOWSNT */
1275 && ! memcmp (SDATA (entry
), var
, varlen
)
1276 #endif /* not WINDOWSNT */
1279 if (SBYTES (entry
) > varlen
&& SREF (entry
, varlen
) == '=')
1281 *value
= SSDATA (entry
) + (varlen
+ 1);
1282 *valuelen
= SBYTES (entry
) - (varlen
+ 1);
1285 else if (SBYTES (entry
) == varlen
)
1287 /* Lone variable names in Vprocess_environment mean that
1288 variable should be removed from the environment. */
1298 getenv_internal (const char *var
, int varlen
, char **value
, int *valuelen
,
1301 /* Try to find VAR in Vprocess_environment first. */
1302 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1303 Vprocess_environment
))
1304 return *value
? 1 : 0;
1306 /* For DISPLAY try to get the values from the frame or the initial env. */
1307 if (strcmp (var
, "DISPLAY") == 0)
1310 = Fframe_parameter (NILP (frame
) ? selected_frame
: frame
, Qdisplay
);
1311 if (STRINGP (display
))
1313 *value
= SSDATA (display
);
1314 *valuelen
= SBYTES (display
);
1317 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1318 if (getenv_internal_1 (var
, varlen
, value
, valuelen
,
1319 Vinitial_environment
))
1320 return *value
? 1 : 0;
1326 DEFUN ("getenv-internal", Fgetenv_internal
, Sgetenv_internal
, 1, 2, 0,
1327 doc
: /* Get the value of environment variable VARIABLE.
1328 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1329 the environment. Otherwise, value is a string.
1331 This function searches `process-environment' for VARIABLE.
1333 If optional parameter ENV is a list, then search this list instead of
1334 `process-environment', and return t when encountering a negative entry
1335 \(an entry for a variable with no value). */)
1336 (Lisp_Object variable
, Lisp_Object env
)
1341 CHECK_STRING (variable
);
1344 if (getenv_internal_1 (SDATA (variable
), SBYTES (variable
),
1345 &value
, &valuelen
, env
))
1346 return value
? make_string (value
, valuelen
) : Qt
;
1350 else if (getenv_internal (SDATA (variable
), SBYTES (variable
),
1351 &value
, &valuelen
, env
))
1352 return make_string (value
, valuelen
);
1357 /* A version of getenv that consults the Lisp environment lists,
1358 easily callable from C. */
1360 egetenv (const char *var
)
1365 if (getenv_internal (var
, strlen (var
), &value
, &valuelen
, Qnil
))
1372 /* This is run before init_cmdargs. */
1375 init_callproc_1 (void)
1377 char *data_dir
= egetenv ("EMACSDATA");
1378 char *doc_dir
= egetenv ("EMACSDOC");
1381 = Ffile_name_as_directory (build_string (data_dir
? data_dir
1384 = Ffile_name_as_directory (build_string (doc_dir
? doc_dir
1387 /* Check the EMACSPATH environment variable, defaulting to the
1388 PATH_EXEC path from epaths.h. */
1389 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1390 Vexec_directory
= Ffile_name_as_directory (Fcar (Vexec_path
));
1391 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1394 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1397 init_callproc (void)
1399 char *data_dir
= egetenv ("EMACSDATA");
1402 Lisp_Object tempdir
;
1404 if (!NILP (Vinstallation_directory
))
1406 /* Add to the path the lib-src subdir of the installation dir. */
1408 tem
= Fexpand_file_name (build_string ("lib-src"),
1409 Vinstallation_directory
);
1411 /* MSDOS uses wrapped binaries, so don't do this. */
1412 if (NILP (Fmember (tem
, Vexec_path
)))
1414 Vexec_path
= decode_env_path ("EMACSPATH", PATH_EXEC
);
1415 Vexec_path
= Fcons (tem
, Vexec_path
);
1416 Vexec_path
= nconc2 (decode_env_path ("PATH", ""), Vexec_path
);
1419 Vexec_directory
= Ffile_name_as_directory (tem
);
1420 #endif /* not DOS_NT */
1422 /* Maybe use ../etc as well as ../lib-src. */
1425 tem
= Fexpand_file_name (build_string ("etc"),
1426 Vinstallation_directory
);
1427 Vdoc_directory
= Ffile_name_as_directory (tem
);
1431 /* Look for the files that should be in etc. We don't use
1432 Vinstallation_directory, because these files are never installed
1433 near the executable, and they are never in the build
1434 directory when that's different from the source directory.
1436 Instead, if these files are not in the nominal place, we try the
1437 source directory. */
1440 Lisp_Object tem
, tem1
, srcdir
;
1442 srcdir
= Fexpand_file_name (build_string ("../src/"),
1443 build_string (PATH_DUMPLOADSEARCH
));
1444 tem
= Fexpand_file_name (build_string ("GNU"), Vdata_directory
);
1445 tem1
= Ffile_exists_p (tem
);
1446 if (!NILP (Fequal (srcdir
, Vinvocation_directory
)) || NILP (tem1
))
1449 newdir
= Fexpand_file_name (build_string ("../etc/"),
1450 build_string (PATH_DUMPLOADSEARCH
));
1451 tem
= Fexpand_file_name (build_string ("GNU"), newdir
);
1452 tem1
= Ffile_exists_p (tem
);
1454 Vdata_directory
= newdir
;
1462 tempdir
= Fdirectory_file_name (Vexec_directory
);
1463 if (access (SDATA (tempdir
), 0) < 0)
1464 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1468 tempdir
= Fdirectory_file_name (Vdata_directory
);
1469 if (access (SDATA (tempdir
), 0) < 0)
1470 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1473 sh
= (char *) getenv ("SHELL");
1474 Vshell_file_name
= build_string (sh
? sh
: "/bin/sh");
1477 Vshared_game_score_directory
= Qnil
;
1479 Vshared_game_score_directory
= build_string (PATH_GAME
);
1480 if (NILP (Ffile_directory_p (Vshared_game_score_directory
)))
1481 Vshared_game_score_directory
= Qnil
;
1486 set_initial_environment (void)
1488 register char **envp
;
1490 Vprocess_environment
= Qnil
;
1495 for (envp
= environ
; *envp
; envp
++)
1496 Vprocess_environment
= Fcons (build_string (*envp
),
1497 Vprocess_environment
);
1498 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1499 to use `delete' and friends on process-environment. */
1500 Vinitial_environment
= Fcopy_sequence (Vprocess_environment
);
1505 syms_of_callproc (void)
1508 Qbuffer_file_type
= intern_c_string ("buffer-file-type");
1509 staticpro (&Qbuffer_file_type
);
1513 Vtemp_file_name_pattern
= build_string ("emacsXXXXXX");
1514 #elif defined (WINDOWSNT)
1515 Vtemp_file_name_pattern
= build_string ("emXXXXXX");
1517 Vtemp_file_name_pattern
= build_string ("detmp.XXX");
1519 staticpro (&Vtemp_file_name_pattern
);
1521 DEFVAR_LISP ("shell-file-name", Vshell_file_name
,
1522 doc
: /* *File name to load inferior shells from.
1523 Initialized from the SHELL environment variable, or to a system-dependent
1524 default if SHELL is not set. */);
1526 DEFVAR_LISP ("exec-path", Vexec_path
,
1527 doc
: /* *List of directories to search programs to run in subprocesses.
1528 Each element is a string (directory name) or nil (try default directory). */);
1530 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes
,
1531 doc
: /* *List of suffixes to try to find executable file names.
1532 Each element is a string. */);
1533 Vexec_suffixes
= Qnil
;
1535 DEFVAR_LISP ("exec-directory", Vexec_directory
,
1536 doc
: /* Directory for executables for Emacs to invoke.
1537 More generally, this includes any architecture-dependent files
1538 that are built and installed from the Emacs distribution. */);
1540 DEFVAR_LISP ("data-directory", Vdata_directory
,
1541 doc
: /* Directory of machine-independent files that come with GNU Emacs.
1542 These are files intended for Emacs to use while it runs. */);
1544 DEFVAR_LISP ("doc-directory", Vdoc_directory
,
1545 doc
: /* Directory containing the DOC file that comes with GNU Emacs.
1546 This is usually the same as `data-directory'. */);
1548 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory
,
1549 doc
: /* For internal use by the build procedure only.
1550 This is the name of the directory in which the build procedure installed
1551 Emacs's info files; the default value for `Info-default-directory-list'
1553 Vconfigure_info_directory
= build_string (PATH_INFO
);
1555 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory
,
1556 doc
: /* Directory of score files for games which come with GNU Emacs.
1557 If this variable is nil, then Emacs is unable to use a shared directory. */);
1559 Vshared_game_score_directory
= Qnil
;
1561 Vshared_game_score_directory
= build_string (PATH_GAME
);
1564 DEFVAR_LISP ("initial-environment", Vinitial_environment
,
1565 doc
: /* List of environment variables inherited from the parent process.
1566 Each element should be a string of the form ENVVARNAME=VALUE.
1567 The elements must normally be decoded (using `locale-coding-system') for use. */);
1568 Vinitial_environment
= Qnil
;
1570 DEFVAR_LISP ("process-environment", Vprocess_environment
,
1571 doc
: /* List of overridden environment variables for subprocesses to inherit.
1572 Each element should be a string of the form ENVVARNAME=VALUE.
1574 Entries in this list take precedence to those in the frame-local
1575 environments. Therefore, let-binding `process-environment' is an easy
1576 way to temporarily change the value of an environment variable,
1577 irrespective of where it comes from. To use `process-environment' to
1578 remove an environment variable, include only its name in the list,
1581 This variable is set to nil when Emacs starts.
1583 If multiple entries define the same variable, the first one always
1586 Non-ASCII characters are encoded according to the initial value of
1587 `locale-coding-system', i.e. the elements must normally be decoded for
1590 See `setenv' and `getenv'. */);
1591 Vprocess_environment
= Qnil
;
1593 defsubr (&Scall_process
);
1594 defsubr (&Sgetenv_internal
);
1595 defsubr (&Scall_process_region
);