(syms_of_ntterm) <w32-use-full-screen-buffer>: Doc fix - default value changed.
[emacs.git] / src / callproc.c
blob7b8ba8fea21efcaad33cfe4edc35937bd163fa6a
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 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 2, or (at your option)
10 any later version.
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
23 #include <config.h>
24 #include <signal.h>
25 #include <errno.h>
26 #include <stdio.h>
28 #ifndef USE_CRT_DLL
29 extern int errno;
30 #endif
32 /* Define SIGCHLD as an alias for SIGCLD. */
34 #if !defined (SIGCHLD) && defined (SIGCLD)
35 #define SIGCHLD SIGCLD
36 #endif /* SIGCLD */
38 #include <sys/types.h>
40 #ifdef HAVE_UNISTD_H
41 #include <unistd.h>
42 #endif
44 #include <sys/file.h>
45 #ifdef HAVE_FCNTL_H
46 #define INCLUDED_FCNTL
47 #include <fcntl.h>
48 #endif
50 #ifdef WINDOWSNT
51 #define NOMINMAX
52 #include <windows.h>
53 #include <stdlib.h> /* for proper declaration of environ */
54 #include <fcntl.h>
55 #include "w32.h"
56 #define _P_NOWAIT 1 /* from process.h */
57 #endif
59 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
60 #define INCLUDED_FCNTL
61 #include <fcntl.h>
62 #include <sys/stat.h>
63 #include <sys/param.h>
64 #include <errno.h>
65 #endif /* MSDOS */
67 #ifndef O_RDONLY
68 #define O_RDONLY 0
69 #endif
71 #ifndef O_WRONLY
72 #define O_WRONLY 1
73 #endif
75 #include "lisp.h"
76 #include "commands.h"
77 #include "buffer.h"
78 #include "charset.h"
79 #include "ccl.h"
80 #include "coding.h"
81 #include "composite.h"
82 #include <epaths.h>
83 #include "process.h"
84 #include "syssignal.h"
85 #include "systty.h"
86 #include "blockinput.h"
88 #ifdef MSDOS
89 #include "msdos.h"
90 #endif
92 #ifdef VMS
93 extern noshare char **environ;
94 #else
95 #ifndef USE_CRT_DLL
96 extern char **environ;
97 #endif
98 #endif
100 #ifdef HAVE_SETPGID
101 #if !defined (USG) || defined (BSD_PGRPS)
102 #undef setpgrp
103 #define setpgrp setpgid
104 #endif
105 #endif
107 Lisp_Object Vexec_path, Vexec_directory, Vexec_suffixes;
108 Lisp_Object Vdata_directory, Vdoc_directory;
109 Lisp_Object Vconfigure_info_directory, Vshared_game_score_directory;
110 Lisp_Object Vtemp_file_name_pattern;
112 Lisp_Object Vshell_file_name;
114 Lisp_Object Vprocess_environment;
116 #ifdef DOS_NT
117 Lisp_Object Qbuffer_file_type;
118 #endif /* DOS_NT */
120 /* True iff we are about to fork off a synchronous process or if we
121 are waiting for it. */
122 int synch_process_alive;
124 /* Nonzero => this is a string explaining death of synchronous subprocess. */
125 char *synch_process_death;
127 /* Nonzero => this is the signal number that terminated the subprocess. */
128 int synch_process_termsig;
130 /* If synch_process_death is zero,
131 this is exit code of synchronous subprocess. */
132 int synch_process_retcode;
134 /* Clean up when exiting Fcall_process.
135 On MSDOS, delete the temporary file on any kind of termination.
136 On Unix, kill the process and any children on termination by signal. */
138 /* Nonzero if this is termination due to exit. */
139 static int call_process_exited;
141 #ifndef VMS /* VMS version is in vmsproc.c. */
143 static Lisp_Object
144 call_process_kill (fdpid)
145 Lisp_Object fdpid;
147 emacs_close (XFASTINT (Fcar (fdpid)));
148 EMACS_KILLPG (XFASTINT (Fcdr (fdpid)), SIGKILL);
149 synch_process_alive = 0;
150 return Qnil;
153 Lisp_Object
154 call_process_cleanup (fdpid)
155 Lisp_Object fdpid;
157 #if defined (MSDOS) || defined (MAC_OS8)
158 /* for MSDOS fdpid is really (fd . tempfile) */
159 register Lisp_Object file;
160 file = Fcdr (fdpid);
161 emacs_close (XFASTINT (Fcar (fdpid)));
162 if (strcmp (SDATA (file), NULL_DEVICE) != 0)
163 unlink (SDATA (file));
164 #else /* not MSDOS and not MAC_OS8 */
165 register int pid = XFASTINT (Fcdr (fdpid));
167 if (call_process_exited)
169 emacs_close (XFASTINT (Fcar (fdpid)));
170 return Qnil;
173 if (EMACS_KILLPG (pid, SIGINT) == 0)
175 int count = SPECPDL_INDEX ();
176 record_unwind_protect (call_process_kill, fdpid);
177 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
178 immediate_quit = 1;
179 QUIT;
180 wait_for_termination (pid);
181 immediate_quit = 0;
182 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
183 message1 ("Waiting for process to die...done");
185 synch_process_alive = 0;
186 emacs_close (XFASTINT (Fcar (fdpid)));
187 #endif /* not MSDOS */
188 return Qnil;
191 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
192 doc: /* Call PROGRAM synchronously in separate process.
193 The remaining arguments are optional.
194 The program's input comes from file INFILE (nil means `/dev/null').
195 Insert output in BUFFER before point; t means current buffer;
196 nil for BUFFER means discard it; 0 means discard and don't wait.
197 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
198 REAL-BUFFER says what to do with standard output, as above,
199 while STDERR-FILE says what to do with standard error in the child.
200 STDERR-FILE may be nil (discard standard error output),
201 t (mix it with ordinary output), or a file name string.
203 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
204 Remaining arguments are strings passed as command arguments to PROGRAM.
206 If executable PROGRAM can't be found as an executable, `call-process'
207 signals a Lisp error. `call-process' reports errors in execution of
208 the program only through its return and output.
210 If BUFFER is 0, `call-process' returns immediately with value nil.
211 Otherwise it waits for PROGRAM to terminate
212 and returns a numeric exit status or a signal description string.
213 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
215 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
216 (nargs, args)
217 int nargs;
218 register Lisp_Object *args;
220 Lisp_Object infile, buffer, current_dir, path;
221 int display_p;
222 int fd[2];
223 int filefd;
224 register int pid;
225 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
226 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
227 char buf[CALLPROC_BUFFER_SIZE_MAX];
228 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
229 int count = SPECPDL_INDEX ();
231 register const unsigned char **new_argv
232 = (const unsigned char **) alloca ((max (2, nargs - 2)) * sizeof (char *));
233 struct buffer *old = current_buffer;
234 /* File to use for stderr in the child.
235 t means use same as standard output. */
236 Lisp_Object error_file;
237 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
238 char *outf, *tempfile;
239 int outfilefd;
240 #endif
241 #ifdef MAC_OS8
242 char *tempfile;
243 int outfilefd;
244 #endif
245 #if 0
246 int mask;
247 #endif
248 struct coding_system process_coding; /* coding-system of process output */
249 struct coding_system argument_coding; /* coding-system of arguments */
250 /* Set to the return value of Ffind_operation_coding_system. */
251 Lisp_Object coding_systems;
253 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
254 coding_systems = Qt;
256 CHECK_STRING (args[0]);
258 error_file = Qt;
260 #ifndef subprocesses
261 /* Without asynchronous processes we cannot have BUFFER == 0. */
262 if (nargs >= 3
263 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
264 error ("Operating system cannot handle asynchronous subprocesses");
265 #endif /* subprocesses */
267 /* Decide the coding-system for giving arguments. */
269 Lisp_Object val, *args2;
270 int i;
272 /* If arguments are supplied, we may have to encode them. */
273 if (nargs >= 5)
275 int must_encode = 0;
277 for (i = 4; i < nargs; i++)
278 CHECK_STRING (args[i]);
280 for (i = 4; i < nargs; i++)
281 if (STRING_MULTIBYTE (args[i]))
282 must_encode = 1;
284 if (!NILP (Vcoding_system_for_write))
285 val = Vcoding_system_for_write;
286 else if (! must_encode)
287 val = Qnil;
288 else
290 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
291 args2[0] = Qcall_process;
292 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
293 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
294 if (CONSP (coding_systems))
295 val = XCDR (coding_systems);
296 else if (CONSP (Vdefault_process_coding_system))
297 val = XCDR (Vdefault_process_coding_system);
298 else
299 val = Qnil;
301 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
302 if (argument_coding.common_flags & CODING_ASCII_INCOMPATIBLE_MASK)
303 setup_coding_system (Qraw_text, &argument_coding);
304 if (argument_coding.eol_type == CODING_EOL_UNDECIDED)
305 argument_coding.eol_type = system_eol_type;
309 if (nargs >= 2 && ! NILP (args[1]))
311 infile = Fexpand_file_name (args[1], current_buffer->directory);
312 CHECK_STRING (infile);
314 else
315 infile = build_string (NULL_DEVICE);
317 if (nargs >= 3)
319 buffer = args[2];
321 /* If BUFFER is a list, its meaning is
322 (BUFFER-FOR-STDOUT FILE-FOR-STDERR). */
323 if (CONSP (buffer))
325 if (CONSP (XCDR (buffer)))
327 Lisp_Object stderr_file;
328 stderr_file = XCAR (XCDR (buffer));
330 if (NILP (stderr_file) || EQ (Qt, stderr_file))
331 error_file = stderr_file;
332 else
333 error_file = Fexpand_file_name (stderr_file, Qnil);
336 buffer = XCAR (buffer);
339 if (!(EQ (buffer, Qnil)
340 || EQ (buffer, Qt)
341 || INTEGERP (buffer)))
343 Lisp_Object spec_buffer;
344 spec_buffer = buffer;
345 buffer = Fget_buffer_create (buffer);
346 /* Mention the buffer name for a better error message. */
347 if (NILP (buffer))
348 CHECK_BUFFER (spec_buffer);
349 CHECK_BUFFER (buffer);
352 else
353 buffer = Qnil;
355 /* Make sure that the child will be able to chdir to the current
356 buffer's current directory, or its unhandled equivalent. We
357 can't just have the child check for an error when it does the
358 chdir, since it's in a vfork.
360 We have to GCPRO around this because Fexpand_file_name,
361 Funhandled_file_name_directory, and Ffile_accessible_directory_p
362 might call a file name handling function. The argument list is
363 protected by the caller, so all we really have to worry about is
364 buffer. */
366 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
368 current_dir = current_buffer->directory;
370 GCPRO4 (infile, buffer, current_dir, error_file);
372 current_dir
373 = expand_and_dir_to_file (Funhandled_file_name_directory (current_dir),
374 Qnil);
375 if (NILP (Ffile_accessible_directory_p (current_dir)))
376 report_file_error ("Setting current directory",
377 Fcons (current_buffer->directory, Qnil));
379 if (STRING_MULTIBYTE (infile))
380 infile = ENCODE_FILE (infile);
381 if (STRING_MULTIBYTE (current_dir))
382 current_dir = ENCODE_FILE (current_dir);
383 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
384 error_file = ENCODE_FILE (error_file);
385 UNGCPRO;
388 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
390 filefd = emacs_open (SDATA (infile), O_RDONLY, 0);
391 if (filefd < 0)
393 infile = DECODE_FILE (infile);
394 report_file_error ("Opening process input file", Fcons (infile, Qnil));
396 /* Search for program; barf if not found. */
398 struct gcpro gcpro1;
400 GCPRO1 (current_dir);
401 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
402 UNGCPRO;
404 if (NILP (path))
406 emacs_close (filefd);
407 report_file_error ("Searching for program", Fcons (args[0], Qnil));
410 /* If program file name starts with /: for quoting a magic name,
411 discard that. */
412 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
413 && SREF (path, 1) == ':')
414 path = Fsubstring (path, make_number (2), Qnil);
416 new_argv[0] = SDATA (path);
417 if (nargs > 4)
419 register int i;
420 struct gcpro gcpro1, gcpro2, gcpro3;
422 GCPRO3 (infile, buffer, current_dir);
423 argument_coding.dst_multibyte = 0;
424 for (i = 4; i < nargs; i++)
426 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
427 if (CODING_REQUIRE_ENCODING (&argument_coding))
429 /* We must encode this argument. */
430 args[i] = encode_coding_string (args[i], &argument_coding, 1);
431 if (argument_coding.type == coding_type_ccl)
432 setup_ccl_program (&(argument_coding.spec.ccl.encoder), Qnil);
434 new_argv[i - 3] = SDATA (args[i]);
436 UNGCPRO;
437 new_argv[nargs - 3] = 0;
439 else
440 new_argv[1] = 0;
442 #ifdef MSDOS /* MW, July 1993 */
443 if ((outf = egetenv ("TMPDIR")))
444 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
445 else
447 tempfile = alloca (20);
448 *tempfile = '\0';
450 dostounix_filename (tempfile);
451 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
452 strcat (tempfile, "/");
453 strcat (tempfile, "detmp.XXX");
454 mktemp (tempfile);
456 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
457 if (outfilefd < 0)
459 emacs_close (filefd);
460 report_file_error ("Opening process output file",
461 Fcons (build_string (tempfile), Qnil));
463 fd[0] = filefd;
464 fd[1] = outfilefd;
465 #endif /* MSDOS */
467 #ifdef MAC_OS8
468 /* Since we don't have pipes on the Mac, create a temporary file to
469 hold the output of the subprocess. */
470 tempfile = (char *) alloca (SBYTES (Vtemp_file_name_pattern) + 1);
471 bcopy (SDATA (Vtemp_file_name_pattern), tempfile,
472 SBYTES (Vtemp_file_name_pattern) + 1);
474 mktemp (tempfile);
476 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
477 if (outfilefd < 0)
479 close (filefd);
480 report_file_error ("Opening process output file",
481 Fcons (build_string (tempfile), Qnil));
483 fd[0] = filefd;
484 fd[1] = outfilefd;
485 #endif /* MAC_OS8 */
487 if (INTEGERP (buffer))
488 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
489 else
491 #ifndef MSDOS
492 #ifndef MAC_OS8
493 errno = 0;
494 if (pipe (fd) == -1)
496 emacs_close (filefd);
497 report_file_error ("Creating process pipe", Qnil);
499 #endif
500 #endif
501 #if 0
502 /* Replaced by close_process_descs */
503 set_exclusive_use (fd[0]);
504 #endif
508 /* child_setup must clobber environ in systems with true vfork.
509 Protect it from permanent change. */
510 register char **save_environ = environ;
511 register int fd1 = fd[1];
512 int fd_error = fd1;
514 #if 0 /* Some systems don't have sigblock. */
515 mask = sigblock (sigmask (SIGCHLD));
516 #endif
518 /* Record that we're about to create a synchronous process. */
519 synch_process_alive = 1;
521 /* These vars record information from process termination.
522 Clear them now before process can possibly terminate,
523 to avoid timing error if process terminates soon. */
524 synch_process_death = 0;
525 synch_process_retcode = 0;
526 synch_process_termsig = 0;
528 if (NILP (error_file))
529 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
530 else if (STRINGP (error_file))
532 #ifdef DOS_NT
533 fd_error = emacs_open (SDATA (error_file),
534 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
535 S_IREAD | S_IWRITE);
536 #else /* not DOS_NT */
537 fd_error = creat (SDATA (error_file), 0666);
538 #endif /* not DOS_NT */
541 if (fd_error < 0)
543 emacs_close (filefd);
544 if (fd[0] != filefd)
545 emacs_close (fd[0]);
546 if (fd1 >= 0)
547 emacs_close (fd1);
548 #ifdef MSDOS
549 unlink (tempfile);
550 #endif
551 if (NILP (error_file))
552 error_file = build_string (NULL_DEVICE);
553 else if (STRINGP (error_file))
554 error_file = DECODE_FILE (error_file);
555 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
558 #ifdef MAC_OS8
560 /* Call run_mac_command in sysdep.c here directly instead of doing
561 a child_setup as for MSDOS and other platforms. Note that this
562 code does not handle passing the environment to the synchronous
563 Mac subprocess. */
564 char *infn, *outfn, *errfn, *currdn;
566 /* close these files so subprocess can write to them */
567 close (outfilefd);
568 if (fd_error != outfilefd)
569 close (fd_error);
570 fd1 = -1; /* No harm in closing that one! */
572 infn = SDATA (infile);
573 outfn = tempfile;
574 if (NILP (error_file))
575 errfn = NULL_DEVICE;
576 else if (EQ (Qt, error_file))
577 errfn = outfn;
578 else
579 errfn = SDATA (error_file);
580 currdn = SDATA (current_dir);
581 pid = run_mac_command (new_argv, currdn, infn, outfn, errfn);
583 /* Record that the synchronous process exited and note its
584 termination status. */
585 synch_process_alive = 0;
586 synch_process_retcode = pid;
587 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
589 synchronize_system_messages_locale ();
590 synch_process_death = strerror (errno);
593 /* Since CRLF is converted to LF within `decode_coding', we can
594 always open a file with binary mode. */
595 fd[0] = open (tempfile, O_BINARY);
596 if (fd[0] < 0)
598 unlink (tempfile);
599 close (filefd);
600 report_file_error ("Cannot re-open temporary file", Qnil);
603 #else /* not MAC_OS8 */
604 #ifdef MSDOS /* MW, July 1993 */
605 /* Note that on MSDOS `child_setup' actually returns the child process
606 exit status, not its PID, so we assign it to `synch_process_retcode'
607 below. */
608 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
609 0, current_dir);
611 /* Record that the synchronous process exited and note its
612 termination status. */
613 synch_process_alive = 0;
614 synch_process_retcode = pid;
615 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
617 synchronize_system_messages_locale ();
618 synch_process_death = strerror (errno);
621 emacs_close (outfilefd);
622 if (fd_error != outfilefd)
623 emacs_close (fd_error);
624 fd1 = -1; /* No harm in closing that one! */
625 /* Since CRLF is converted to LF within `decode_coding', we can
626 always open a file with binary mode. */
627 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
628 if (fd[0] < 0)
630 unlink (tempfile);
631 emacs_close (filefd);
632 report_file_error ("Cannot re-open temporary file", Qnil);
634 #else /* not MSDOS */
635 #ifdef WINDOWSNT
636 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
637 0, current_dir);
638 #else /* not WINDOWSNT */
639 BLOCK_INPUT;
641 pid = vfork ();
643 if (pid == 0)
645 if (fd[0] >= 0)
646 emacs_close (fd[0]);
647 #ifdef HAVE_SETSID
648 setsid ();
649 #endif
650 #if defined (USG) && !defined (BSD_PGRPS)
651 setpgrp ();
652 #else
653 setpgrp (pid, pid);
654 #endif /* USG */
655 child_setup (filefd, fd1, fd_error, (char **) new_argv,
656 0, current_dir);
659 UNBLOCK_INPUT;
660 #endif /* not WINDOWSNT */
662 /* The MSDOS case did this already. */
663 if (fd_error >= 0)
664 emacs_close (fd_error);
665 #endif /* not MSDOS */
666 #endif /* not MAC_OS8 */
668 environ = save_environ;
670 /* Close most of our fd's, but not fd[0]
671 since we will use that to read input from. */
672 emacs_close (filefd);
673 if (fd1 >= 0 && fd1 != fd_error)
674 emacs_close (fd1);
677 if (pid < 0)
679 if (fd[0] >= 0)
680 emacs_close (fd[0]);
681 report_file_error ("Doing vfork", Qnil);
684 if (INTEGERP (buffer))
686 if (fd[0] >= 0)
687 emacs_close (fd[0]);
688 #ifndef subprocesses
689 /* If Emacs has been built with asynchronous subprocess support,
690 we don't need to do this, I think because it will then have
691 the facilities for handling SIGCHLD. */
692 wait_without_blocking ();
693 #endif /* subprocesses */
694 return Qnil;
697 /* Enable sending signal if user quits below. */
698 call_process_exited = 0;
700 #if defined(MSDOS) || defined(MAC_OS8)
701 /* MSDOS needs different cleanup information. */
702 record_unwind_protect (call_process_cleanup,
703 Fcons (make_number (fd[0]), build_string (tempfile)));
704 #else
705 record_unwind_protect (call_process_cleanup,
706 Fcons (make_number (fd[0]), make_number (pid)));
707 #endif /* not MSDOS and not MAC_OS8 */
710 if (BUFFERP (buffer))
711 Fset_buffer (buffer);
713 if (NILP (buffer))
715 /* If BUFFER is nil, we must read process output once and then
716 discard it, so setup coding system but with nil. */
717 setup_coding_system (Qnil, &process_coding);
719 else
721 Lisp_Object val, *args2;
723 val = Qnil;
724 if (!NILP (Vcoding_system_for_read))
725 val = Vcoding_system_for_read;
726 else
728 if (EQ (coding_systems, Qt))
730 int i;
732 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
733 args2[0] = Qcall_process;
734 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
735 coding_systems
736 = Ffind_operation_coding_system (nargs + 1, args2);
738 if (CONSP (coding_systems))
739 val = XCAR (coding_systems);
740 else if (CONSP (Vdefault_process_coding_system))
741 val = XCAR (Vdefault_process_coding_system);
742 else
743 val = Qnil;
745 setup_coding_system (Fcheck_coding_system (val), &process_coding);
746 /* In unibyte mode, character code conversion should not take
747 place but EOL conversion should. So, setup raw-text or one
748 of the subsidiary according to the information just setup. */
749 if (NILP (current_buffer->enable_multibyte_characters)
750 && !NILP (val))
751 setup_raw_text_coding_system (&process_coding);
753 process_coding.src_multibyte = 0;
754 process_coding.dst_multibyte
755 = (BUFFERP (buffer)
756 ? ! NILP (XBUFFER (buffer)->enable_multibyte_characters)
757 : ! NILP (current_buffer->enable_multibyte_characters));
759 immediate_quit = 1;
760 QUIT;
763 register int nread;
764 int first = 1;
765 int total_read = 0;
766 int carryover = 0;
767 int display_on_the_fly = display_p;
768 struct coding_system saved_coding;
769 int pt_orig = PT, pt_byte_orig = PT_BYTE;
770 int inserted;
772 saved_coding = process_coding;
773 if (process_coding.composing != COMPOSITION_DISABLED)
774 coding_allocate_composition_data (&process_coding, PT);
775 while (1)
777 /* Repeatedly read until we've filled as much as possible
778 of the buffer size we have. But don't read
779 less than 1024--save that for the next bufferful. */
780 nread = carryover;
781 while (nread < bufsize - 1024)
783 int this_read = emacs_read (fd[0], buf + nread,
784 bufsize - nread);
786 if (this_read < 0)
787 goto give_up;
789 if (this_read == 0)
791 process_coding.mode |= CODING_MODE_LAST_BLOCK;
792 break;
795 nread += this_read;
796 total_read += this_read;
798 if (display_on_the_fly)
799 break;
802 /* Now NREAD is the total amount of data in the buffer. */
803 immediate_quit = 0;
805 if (!NILP (buffer))
807 if (! CODING_MAY_REQUIRE_DECODING (&process_coding))
808 insert_1_both (buf, nread, nread, 0, 1, 0);
809 else
810 { /* We have to decode the input. */
811 int size;
812 char *decoding_buf;
814 repeat_decoding:
815 size = decoding_buffer_size (&process_coding, nread);
816 decoding_buf = (char *) xmalloc (size);
818 /* We can't use the macro CODING_REQUIRE_DETECTION
819 because it always returns nonzero if the coding
820 system requires EOL detection. Here, we have to
821 check only whether or not the coding system
822 requires text-encoding detection. */
823 if (process_coding.type == coding_type_undecided)
825 detect_coding (&process_coding, buf, nread);
826 if (process_coding.composing != COMPOSITION_DISABLED)
827 /* We have not yet allocated the composition
828 data because the coding type was undecided. */
829 coding_allocate_composition_data (&process_coding, PT);
831 if (process_coding.cmp_data)
832 process_coding.cmp_data->char_offset = PT;
834 decode_coding (&process_coding, buf, decoding_buf,
835 nread, size);
837 if (display_on_the_fly
838 && saved_coding.type == coding_type_undecided
839 && process_coding.type != coding_type_undecided)
841 /* We have detected some coding system. But,
842 there's a possibility that the detection was
843 done by insufficient data. So, we try the code
844 detection again with more data. */
845 xfree (decoding_buf);
846 display_on_the_fly = 0;
847 process_coding = saved_coding;
848 carryover = nread;
849 /* This is to make the above condition always
850 fails in the future. */
851 saved_coding.type = coding_type_no_conversion;
852 continue;
855 if (process_coding.produced > 0)
856 insert_1_both (decoding_buf, process_coding.produced_char,
857 process_coding.produced, 0, 1, 0);
858 xfree (decoding_buf);
860 if (process_coding.result == CODING_FINISH_INCONSISTENT_EOL)
862 Lisp_Object eol_type, coding;
864 if (process_coding.eol_type == CODING_EOL_CR)
866 /* CRs have been replaced with LFs. Undo
867 that in the text inserted above. */
868 unsigned char *p;
870 move_gap_both (PT, PT_BYTE);
872 p = BYTE_POS_ADDR (pt_byte_orig);
873 for (; p < GPT_ADDR; ++p)
874 if (*p == '\n')
875 *p = '\r';
877 else if (process_coding.eol_type == CODING_EOL_CRLF)
879 /* CR LFs have been replaced with LFs. Undo
880 that by inserting CRs in front of LFs in
881 the text inserted above. */
882 EMACS_INT bytepos, old_pt, old_pt_byte, nCR;
884 old_pt = PT;
885 old_pt_byte = PT_BYTE;
886 nCR = 0;
888 for (bytepos = PT_BYTE - 1;
889 bytepos >= pt_byte_orig;
890 --bytepos)
891 if (FETCH_BYTE (bytepos) == '\n')
893 EMACS_INT charpos = BYTE_TO_CHAR (bytepos);
894 TEMP_SET_PT_BOTH (charpos, bytepos);
895 insert_1_both ("\r", 1, 1, 0, 1, 0);
896 ++nCR;
899 TEMP_SET_PT_BOTH (old_pt + nCR, old_pt_byte + nCR);
902 /* Set the coding system symbol to that for
903 Unix-like EOL. */
904 eol_type = Fget (saved_coding.symbol, Qeol_type);
905 if (VECTORP (eol_type)
906 && ASIZE (eol_type) == 3
907 && SYMBOLP (AREF (eol_type, CODING_EOL_LF)))
908 coding = AREF (eol_type, CODING_EOL_LF);
909 else
910 coding = saved_coding.symbol;
912 process_coding.symbol = coding;
913 process_coding.eol_type = CODING_EOL_LF;
914 process_coding.mode
915 &= ~CODING_MODE_INHIBIT_INCONSISTENT_EOL;
918 nread -= process_coding.consumed;
919 carryover = nread;
920 if (carryover > 0)
921 /* As CARRYOVER should not be that large, we had
922 better avoid overhead of bcopy. */
923 BCOPY_SHORT (buf + process_coding.consumed, buf,
924 carryover);
925 if (process_coding.result == CODING_FINISH_INSUFFICIENT_CMP)
927 /* The decoding ended because of insufficient data
928 area to record information about composition.
929 We must try decoding with additional data area
930 before reading more output for the process. */
931 coding_allocate_composition_data (&process_coding, PT);
932 goto repeat_decoding;
937 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
938 break;
940 #if (CALLPROC_BUFFER_SIZE_MIN != CALLPROC_BUFFER_SIZE_MAX)
941 /* Make the buffer bigger as we continue to read more data,
942 but not past CALLPROC_BUFFER_SIZE_MAX. */
943 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
944 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
945 bufsize = CALLPROC_BUFFER_SIZE_MAX;
946 #endif
948 if (display_p)
950 if (first)
951 prepare_menu_bars ();
952 first = 0;
953 redisplay_preserve_echo_area (1);
954 /* This variable might have been set to 0 for code
955 detection. In that case, we set it back to 1 because
956 we should have already detected a coding system. */
957 display_on_the_fly = 1;
959 immediate_quit = 1;
960 QUIT;
962 give_up: ;
964 if (!NILP (buffer)
965 && process_coding.cmp_data)
967 coding_restore_composition (&process_coding, Fcurrent_buffer ());
968 coding_free_composition_data (&process_coding);
972 int post_read_count = SPECPDL_INDEX ();
974 record_unwind_protect (save_excursion_restore, save_excursion_save ());
975 inserted = PT - pt_orig;
976 TEMP_SET_PT_BOTH (pt_orig, pt_byte_orig);
977 if (SYMBOLP (process_coding.post_read_conversion)
978 && !NILP (Ffboundp (process_coding.post_read_conversion)))
979 call1 (process_coding.post_read_conversion, make_number (inserted));
981 Vlast_coding_system_used = process_coding.symbol;
983 /* If the caller required, let the buffer inherit the
984 coding-system used to decode the process output. */
985 if (inherit_process_coding_system)
986 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
987 make_number (total_read));
989 unbind_to (post_read_count, Qnil);
993 /* Wait for it to terminate, unless it already has. */
994 wait_for_termination (pid);
996 immediate_quit = 0;
998 set_buffer_internal (old);
1000 /* Don't kill any children that the subprocess may have left behind
1001 when exiting. */
1002 call_process_exited = 1;
1004 unbind_to (count, Qnil);
1006 if (synch_process_termsig)
1008 char *signame;
1010 synchronize_system_messages_locale ();
1011 signame = strsignal (synch_process_termsig);
1013 if (signame == 0)
1014 signame = "unknown";
1016 synch_process_death = signame;
1019 if (synch_process_death)
1020 return code_convert_string_norecord (build_string (synch_process_death),
1021 Vlocale_coding_system, 0);
1022 return make_number (synch_process_retcode);
1024 #endif
1026 static Lisp_Object
1027 delete_temp_file (name)
1028 Lisp_Object name;
1030 /* Suppress jka-compr handling, etc. */
1031 int count = SPECPDL_INDEX ();
1032 specbind (intern ("file-name-handler-alist"), Qnil);
1033 internal_delete_file (name);
1034 unbind_to (count, Qnil);
1035 return Qnil;
1038 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
1039 3, MANY, 0,
1040 doc: /* Send text from START to END to a synchronous process running PROGRAM.
1041 The remaining arguments are optional.
1042 Delete the text if fourth arg DELETE is non-nil.
1044 Insert output in BUFFER before point; t means current buffer;
1045 nil for BUFFER means discard it; 0 means discard and don't wait.
1046 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
1047 REAL-BUFFER says what to do with standard output, as above,
1048 while STDERR-FILE says what to do with standard error in the child.
1049 STDERR-FILE may be nil (discard standard error output),
1050 t (mix it with ordinary output), or a file name string.
1052 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
1053 Remaining args are passed to PROGRAM at startup as command args.
1055 If BUFFER is 0, `call-process-region' returns immediately with value nil.
1056 Otherwise it waits for PROGRAM to terminate
1057 and returns a numeric exit status or a signal description string.
1058 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
1060 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
1061 (nargs, args)
1062 int nargs;
1063 register Lisp_Object *args;
1065 struct gcpro gcpro1;
1066 Lisp_Object filename_string;
1067 register Lisp_Object start, end;
1068 int count = SPECPDL_INDEX ();
1069 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
1070 Lisp_Object coding_systems;
1071 Lisp_Object val, *args2;
1072 int i;
1073 #ifdef DOS_NT
1074 char *tempfile;
1075 char *outf = '\0';
1077 if ((outf = egetenv ("TMPDIR"))
1078 || (outf = egetenv ("TMP"))
1079 || (outf = egetenv ("TEMP")))
1080 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
1081 else
1083 tempfile = alloca (20);
1084 *tempfile = '\0';
1086 if (!IS_DIRECTORY_SEP (tempfile[strlen (tempfile) - 1]))
1087 strcat (tempfile, "/");
1088 if ('/' == DIRECTORY_SEP)
1089 dostounix_filename (tempfile);
1090 else
1091 unixtodos_filename (tempfile);
1092 #ifdef WINDOWSNT
1093 strcat (tempfile, "emXXXXXX");
1094 #else
1095 strcat (tempfile, "detmp.XXX");
1096 #endif
1097 #else /* not DOS_NT */
1098 char *tempfile = (char *) alloca (SBYTES (Vtemp_file_name_pattern) + 1);
1099 bcopy (SDATA (Vtemp_file_name_pattern), tempfile,
1100 SBYTES (Vtemp_file_name_pattern) + 1);
1101 #endif /* not DOS_NT */
1103 coding_systems = Qt;
1105 #ifdef HAVE_MKSTEMP
1107 int fd = mkstemp (tempfile);
1108 if (fd == -1)
1109 report_file_error ("Failed to open temporary file",
1110 Fcons (Vtemp_file_name_pattern, Qnil));
1111 else
1112 close (fd);
1114 #else
1115 mktemp (tempfile);
1116 #endif
1118 filename_string = build_string (tempfile);
1119 GCPRO1 (filename_string);
1120 start = args[0];
1121 end = args[1];
1122 /* Decide coding-system of the contents of the temporary file. */
1123 if (!NILP (Vcoding_system_for_write))
1124 val = Vcoding_system_for_write;
1125 else if (NILP (current_buffer->enable_multibyte_characters))
1126 val = Qnil;
1127 else
1129 args2 = (Lisp_Object *) alloca ((nargs + 1) * sizeof *args2);
1130 args2[0] = Qcall_process_region;
1131 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1132 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1133 if (CONSP (coding_systems))
1134 val = XCDR (coding_systems);
1135 else if (CONSP (Vdefault_process_coding_system))
1136 val = XCDR (Vdefault_process_coding_system);
1137 else
1138 val = Qnil;
1142 int count1 = SPECPDL_INDEX ();
1144 specbind (intern ("coding-system-for-write"), val);
1145 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1146 happen to get a ".Z" suffix. */
1147 specbind (intern ("file-name-handler-alist"), Qnil);
1148 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1150 unbind_to (count1, Qnil);
1153 /* Note that Fcall_process takes care of binding
1154 coding-system-for-read. */
1156 record_unwind_protect (delete_temp_file, filename_string);
1158 if (nargs > 3 && !NILP (args[3]))
1159 Fdelete_region (start, end);
1161 if (nargs > 3)
1163 args += 2;
1164 nargs -= 2;
1166 else
1168 args[0] = args[2];
1169 nargs = 2;
1171 args[1] = filename_string;
1173 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1176 #ifndef VMS /* VMS version is in vmsproc.c. */
1178 static int relocate_fd ();
1180 /* This is the last thing run in a newly forked inferior
1181 either synchronous or asynchronous.
1182 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1183 Initialize inferior's priority, pgrp, connected dir and environment.
1184 then exec another program based on new_argv.
1186 This function may change environ for the superior process.
1187 Therefore, the superior process must save and restore the value
1188 of environ around the vfork and the call to this function.
1190 SET_PGRP is nonzero if we should put the subprocess into a separate
1191 process group.
1193 CURRENT_DIR is an elisp string giving the path of the current
1194 directory the subprocess should have. Since we can't really signal
1195 a decent error from within the child, this should be verified as an
1196 executable directory by the parent. */
1199 child_setup (in, out, err, new_argv, set_pgrp, current_dir)
1200 int in, out, err;
1201 register char **new_argv;
1202 int set_pgrp;
1203 Lisp_Object current_dir;
1205 char **env;
1206 char *pwd_var;
1207 #ifdef WINDOWSNT
1208 int cpid;
1209 HANDLE handles[3];
1210 #endif /* WINDOWSNT */
1212 int pid = getpid ();
1214 #ifdef SET_EMACS_PRIORITY
1216 extern EMACS_INT emacs_priority;
1218 if (emacs_priority < 0)
1219 nice (- emacs_priority);
1221 #endif
1223 #ifdef subprocesses
1224 /* Close Emacs's descriptors that this process should not have. */
1225 close_process_descs ();
1226 #endif
1227 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1228 we will lose if we call close_load_descs here. */
1229 #ifndef DOS_NT
1230 close_load_descs ();
1231 #endif
1233 /* Note that use of alloca is always safe here. It's obvious for systems
1234 that do not have true vfork or that have true (stack) alloca.
1235 If using vfork and C_ALLOCA it is safe because that changes
1236 the superior's static variables as if the superior had done alloca
1237 and will be cleaned up in the usual way. */
1239 register char *temp;
1240 register int i;
1242 i = SBYTES (current_dir);
1243 #ifdef MSDOS
1244 /* MSDOS must have all environment variables malloc'ed, because
1245 low-level libc functions that launch subsidiary processes rely
1246 on that. */
1247 pwd_var = (char *) xmalloc (i + 6);
1248 #else
1249 pwd_var = (char *) alloca (i + 6);
1250 #endif
1251 temp = pwd_var + 4;
1252 bcopy ("PWD=", pwd_var, 4);
1253 bcopy (SDATA (current_dir), temp, i);
1254 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1255 temp[i] = 0;
1257 #ifndef DOS_NT
1258 /* We can't signal an Elisp error here; we're in a vfork. Since
1259 the callers check the current directory before forking, this
1260 should only return an error if the directory's permissions
1261 are changed between the check and this chdir, but we should
1262 at least check. */
1263 if (chdir (temp) < 0)
1264 _exit (errno);
1265 #endif
1267 #ifdef DOS_NT
1268 /* Get past the drive letter, so that d:/ is left alone. */
1269 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1271 temp += 2;
1272 i -= 2;
1274 #endif
1276 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1277 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1278 temp[--i] = 0;
1281 /* Set `env' to a vector of the strings in Vprocess_environment. */
1283 register Lisp_Object tem;
1284 register char **new_env;
1285 register int new_length;
1287 new_length = 0;
1288 for (tem = Vprocess_environment;
1289 CONSP (tem) && STRINGP (XCAR (tem));
1290 tem = XCDR (tem))
1291 new_length++;
1293 /* new_length + 2 to include PWD and terminating 0. */
1294 env = new_env = (char **) alloca ((new_length + 2) * sizeof (char *));
1296 /* If we have a PWD envvar, pass one down,
1297 but with corrected value. */
1298 if (getenv ("PWD"))
1299 *new_env++ = pwd_var;
1301 /* Copy the Vprocess_environment strings into new_env. */
1302 for (tem = Vprocess_environment;
1303 CONSP (tem) && STRINGP (XCAR (tem));
1304 tem = XCDR (tem))
1306 char **ep = env;
1307 char *string = (char *) SDATA (XCAR (tem));
1308 /* See if this string duplicates any string already in the env.
1309 If so, don't put it in.
1310 When an env var has multiple definitions,
1311 we keep the definition that comes first in process-environment. */
1312 for (; ep != new_env; ep++)
1314 char *p = *ep, *q = string;
1315 while (1)
1317 if (*q == 0)
1318 /* The string is malformed; might as well drop it. */
1319 goto duplicate;
1320 if (*q != *p)
1321 break;
1322 if (*q == '=')
1323 goto duplicate;
1324 p++, q++;
1327 *new_env++ = string;
1328 duplicate: ;
1330 *new_env = 0;
1332 #ifdef WINDOWSNT
1333 prepare_standard_handles (in, out, err, handles);
1334 set_process_dir (SDATA (current_dir));
1335 #else /* not WINDOWSNT */
1336 /* Make sure that in, out, and err are not actually already in
1337 descriptors zero, one, or two; this could happen if Emacs is
1338 started with its standard in, out, or error closed, as might
1339 happen under X. */
1341 int oin = in, oout = out;
1343 /* We have to avoid relocating the same descriptor twice! */
1345 in = relocate_fd (in, 3);
1347 if (out == oin)
1348 out = in;
1349 else
1350 out = relocate_fd (out, 3);
1352 if (err == oin)
1353 err = in;
1354 else if (err == oout)
1355 err = out;
1356 else
1357 err = relocate_fd (err, 3);
1360 #ifndef MSDOS
1361 emacs_close (0);
1362 emacs_close (1);
1363 emacs_close (2);
1365 dup2 (in, 0);
1366 dup2 (out, 1);
1367 dup2 (err, 2);
1368 emacs_close (in);
1369 emacs_close (out);
1370 emacs_close (err);
1371 #endif /* not MSDOS */
1372 #endif /* not WINDOWSNT */
1374 #if defined(USG) && !defined(BSD_PGRPS)
1375 #ifndef SETPGRP_RELEASES_CTTY
1376 setpgrp (); /* No arguments but equivalent in this case */
1377 #endif
1378 #else
1379 setpgrp (pid, pid);
1380 #endif /* USG */
1381 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1382 EMACS_SET_TTY_PGRP (0, &pid);
1384 #ifdef MSDOS
1385 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1386 xfree (pwd_var);
1387 if (pid == -1)
1388 /* An error occurred while trying to run the subprocess. */
1389 report_file_error ("Spawning child process", Qnil);
1390 return pid;
1391 #else /* not MSDOS */
1392 #ifdef WINDOWSNT
1393 /* Spawn the child. (See ntproc.c:Spawnve). */
1394 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1395 reset_standard_handles (in, out, err, handles);
1396 if (cpid == -1)
1397 /* An error occurred while trying to spawn the process. */
1398 report_file_error ("Spawning child process", Qnil);
1399 return cpid;
1400 #else /* not WINDOWSNT */
1401 /* execvp does not accept an environment arg so the only way
1402 to pass this environment is to set environ. Our caller
1403 is responsible for restoring the ambient value of environ. */
1404 environ = env;
1405 execvp (new_argv[0], new_argv);
1407 emacs_write (1, "Can't exec program: ", 20);
1408 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1409 emacs_write (1, "\n", 1);
1410 _exit (1);
1411 #endif /* not WINDOWSNT */
1412 #endif /* not MSDOS */
1415 /* Move the file descriptor FD so that its number is not less than MINFD.
1416 If the file descriptor is moved at all, the original is freed. */
1417 static int
1418 relocate_fd (fd, minfd)
1419 int fd, minfd;
1421 if (fd >= minfd)
1422 return fd;
1423 else
1425 int new = dup (fd);
1426 if (new == -1)
1428 char *message1 = "Error while setting up child: ";
1429 char *errmessage = strerror (errno);
1430 char *message2 = "\n";
1431 emacs_write (2, message1, strlen (message1));
1432 emacs_write (2, errmessage, strlen (errmessage));
1433 emacs_write (2, message2, strlen (message2));
1434 _exit (1);
1436 /* Note that we hold the original FD open while we recurse,
1437 to guarantee we'll get a new FD if we need it. */
1438 new = relocate_fd (new, minfd);
1439 emacs_close (fd);
1440 return new;
1444 static int
1445 getenv_internal (var, varlen, value, valuelen)
1446 char *var;
1447 int varlen;
1448 char **value;
1449 int *valuelen;
1451 Lisp_Object scan;
1453 for (scan = Vprocess_environment; CONSP (scan); scan = XCDR (scan))
1455 Lisp_Object entry;
1457 entry = XCAR (scan);
1458 if (STRINGP (entry)
1459 && SBYTES (entry) > varlen
1460 && SREF (entry, varlen) == '='
1461 #ifdef WINDOWSNT
1462 /* NT environment variables are case insensitive. */
1463 && ! strnicmp (SDATA (entry), var, varlen)
1464 #else /* not WINDOWSNT */
1465 && ! bcmp (SDATA (entry), var, varlen)
1466 #endif /* not WINDOWSNT */
1469 *value = (char *) SDATA (entry) + (varlen + 1);
1470 *valuelen = SBYTES (entry) - (varlen + 1);
1471 return 1;
1475 return 0;
1478 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 1, 0,
1479 doc: /* Return the value of environment variable VAR, as a string.
1480 VAR should be a string. Value is nil if VAR is undefined in the environment.
1481 This function consults the variable ``process-environment'' for its value. */)
1482 (var)
1483 Lisp_Object var;
1485 char *value;
1486 int valuelen;
1488 CHECK_STRING (var);
1489 if (getenv_internal (SDATA (var), SBYTES (var),
1490 &value, &valuelen))
1491 return make_string (value, valuelen);
1492 else
1493 return Qnil;
1496 /* A version of getenv that consults process_environment, easily
1497 callable from C. */
1498 char *
1499 egetenv (var)
1500 char *var;
1502 char *value;
1503 int valuelen;
1505 if (getenv_internal (var, strlen (var), &value, &valuelen))
1506 return value;
1507 else
1508 return 0;
1511 #endif /* not VMS */
1513 /* This is run before init_cmdargs. */
1515 void
1516 init_callproc_1 ()
1518 char *data_dir = egetenv ("EMACSDATA");
1519 char *doc_dir = egetenv ("EMACSDOC");
1521 Vdata_directory
1522 = Ffile_name_as_directory (build_string (data_dir ? data_dir
1523 : PATH_DATA));
1524 Vdoc_directory
1525 = Ffile_name_as_directory (build_string (doc_dir ? doc_dir
1526 : PATH_DOC));
1528 /* Check the EMACSPATH environment variable, defaulting to the
1529 PATH_EXEC path from epaths.h. */
1530 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
1531 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1532 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1535 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1537 void
1538 init_callproc ()
1540 char *data_dir = egetenv ("EMACSDATA");
1542 register char * sh;
1543 Lisp_Object tempdir;
1545 if (!NILP (Vinstallation_directory))
1547 /* Add to the path the lib-src subdir of the installation dir. */
1548 Lisp_Object tem;
1549 tem = Fexpand_file_name (build_string ("lib-src"),
1550 Vinstallation_directory);
1551 #ifndef DOS_NT
1552 /* MSDOS uses wrapped binaries, so don't do this. */
1553 if (NILP (Fmember (tem, Vexec_path)))
1555 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
1556 Vexec_path = Fcons (tem, Vexec_path);
1557 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1560 Vexec_directory = Ffile_name_as_directory (tem);
1561 #endif /* not DOS_NT */
1563 /* Maybe use ../etc as well as ../lib-src. */
1564 if (data_dir == 0)
1566 tem = Fexpand_file_name (build_string ("etc"),
1567 Vinstallation_directory);
1568 Vdoc_directory = Ffile_name_as_directory (tem);
1572 /* Look for the files that should be in etc. We don't use
1573 Vinstallation_directory, because these files are never installed
1574 near the executable, and they are never in the build
1575 directory when that's different from the source directory.
1577 Instead, if these files are not in the nominal place, we try the
1578 source directory. */
1579 if (data_dir == 0)
1581 Lisp_Object tem, tem1, srcdir;
1583 srcdir = Fexpand_file_name (build_string ("../src/"),
1584 build_string (PATH_DUMPLOADSEARCH));
1585 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1586 tem1 = Ffile_exists_p (tem);
1587 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1589 Lisp_Object newdir;
1590 newdir = Fexpand_file_name (build_string ("../etc/"),
1591 build_string (PATH_DUMPLOADSEARCH));
1592 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1593 tem1 = Ffile_exists_p (tem);
1594 if (!NILP (tem1))
1595 Vdata_directory = newdir;
1599 #ifndef CANNOT_DUMP
1600 if (initialized)
1601 #endif
1603 tempdir = Fdirectory_file_name (Vexec_directory);
1604 if (access (SDATA (tempdir), 0) < 0)
1605 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1606 Vexec_directory);
1609 tempdir = Fdirectory_file_name (Vdata_directory);
1610 if (access (SDATA (tempdir), 0) < 0)
1611 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1612 Vdata_directory);
1614 #ifdef VMS
1615 Vshell_file_name = build_string ("*dcl*");
1616 #else
1617 sh = (char *) getenv ("SHELL");
1618 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1619 #endif
1621 #ifdef VMS
1622 Vtemp_file_name_pattern = build_string ("tmp:emacsXXXXXX.");
1623 #else
1624 if (getenv ("TMPDIR"))
1626 char *dir = getenv ("TMPDIR");
1627 Vtemp_file_name_pattern
1628 = Fexpand_file_name (build_string ("emacsXXXXXX"),
1629 build_string (dir));
1631 else
1632 Vtemp_file_name_pattern = build_string ("/tmp/emacsXXXXXX");
1633 #endif
1635 #ifdef DOS_NT
1636 Vshared_game_score_directory = Qnil;
1637 #else
1638 Vshared_game_score_directory = build_string (PATH_GAME);
1639 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1640 Vshared_game_score_directory = Qnil;
1641 #endif
1644 void
1645 set_process_environment ()
1647 register char **envp;
1649 Vprocess_environment = Qnil;
1650 #ifndef CANNOT_DUMP
1651 if (initialized)
1652 #endif
1653 for (envp = environ; *envp; envp++)
1654 Vprocess_environment = Fcons (build_string (*envp),
1655 Vprocess_environment);
1658 void
1659 syms_of_callproc ()
1661 #ifdef DOS_NT
1662 Qbuffer_file_type = intern ("buffer-file-type");
1663 staticpro (&Qbuffer_file_type);
1664 #endif /* DOS_NT */
1666 DEFVAR_LISP ("shell-file-name", &Vshell_file_name,
1667 doc: /* *File name to load inferior shells from.
1668 Initialized from the SHELL environment variable. */);
1670 DEFVAR_LISP ("exec-path", &Vexec_path,
1671 doc: /* *List of directories to search programs to run in subprocesses.
1672 Each element is a string (directory name) or nil (try default directory). */);
1674 DEFVAR_LISP ("exec-suffixes", &Vexec_suffixes,
1675 doc: /* *List of suffixes to try to find executable file names.
1676 Each element is a string. */);
1677 Vexec_suffixes = Qnil;
1679 DEFVAR_LISP ("exec-directory", &Vexec_directory,
1680 doc: /* Directory for executables for Emacs to invoke.
1681 More generally, this includes any architecture-dependent files
1682 that are built and installed from the Emacs distribution. */);
1684 DEFVAR_LISP ("data-directory", &Vdata_directory,
1685 doc: /* Directory of machine-independent files that come with GNU Emacs.
1686 These are files intended for Emacs to use while it runs. */);
1688 DEFVAR_LISP ("doc-directory", &Vdoc_directory,
1689 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1690 This is usually the same as data-directory. */);
1692 DEFVAR_LISP ("configure-info-directory", &Vconfigure_info_directory,
1693 doc: /* For internal use by the build procedure only.
1694 This is the name of the directory in which the build procedure installed
1695 Emacs's info files; the default value for Info-default-directory-list
1696 includes this. */);
1697 Vconfigure_info_directory = build_string (PATH_INFO);
1699 DEFVAR_LISP ("shared-game-score-directory", &Vshared_game_score_directory,
1700 doc: /* Directory of score files for games which come with GNU Emacs.
1701 If this variable is nil, then Emacs is unable to use a shared directory. */);
1702 #ifdef DOS_NT
1703 Vshared_game_score_directory = Qnil;
1704 #else
1705 Vshared_game_score_directory = build_string (PATH_GAME);
1706 #endif
1708 DEFVAR_LISP ("temp-file-name-pattern", &Vtemp_file_name_pattern,
1709 doc: /* Pattern for making names for temporary files.
1710 This is used by `call-process-region'. */);
1711 /* This variable is initialized in init_callproc. */
1713 DEFVAR_LISP ("process-environment", &Vprocess_environment,
1714 doc: /* List of environment variables for subprocesses to inherit.
1715 Each element should be a string of the form ENVVARNAME=VALUE.
1716 If multiple entries define the same variable, the first one always
1717 takes precedence.
1718 The environment which Emacs inherits is placed in this variable
1719 when Emacs starts.
1720 Non-ASCII characters are encoded according to the initial value of
1721 `locale-coding-system', i.e. the elements must normally be decoded for use.
1722 See `setenv' and `getenv'. */);
1724 #ifndef VMS
1725 defsubr (&Scall_process);
1726 defsubr (&Sgetenv_internal);
1727 #endif
1728 defsubr (&Scall_process_region);
1731 /* arch-tag: 769b8045-1df7-4d2b-8968-e3fb49017f95
1732 (do not change this comment) */