* lisp/emacs-lisp/pcase.el (pcase-UPAT, pcase-QPAT): New edebug specs.
[emacs.git] / src / callproc.c
blob976d3061c8bf2f056f4951dc98c67594c8bae396
1 /* Synchronous subprocess invocation for GNU Emacs.
2 Copyright (C) 1985-1988, 1993-1995, 1999-2012
3 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 3 of the License, or
10 (at your option) 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. If not, see <http://www.gnu.org/licenses/>. */
21 #include <config.h>
22 #include <signal.h>
23 #include <errno.h>
24 #include <stdio.h>
25 #include <setjmp.h>
26 #include <sys/types.h>
27 #include <unistd.h>
29 #include <sys/file.h>
30 #include <fcntl.h>
32 #include "lisp.h"
34 #ifdef WINDOWSNT
35 #define NOMINMAX
36 #include <windows.h>
37 #include "w32.h"
38 #define _P_NOWAIT 1 /* from process.h */
39 #endif
41 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
42 #include <sys/stat.h>
43 #include <sys/param.h>
44 #endif /* MSDOS */
46 #include "commands.h"
47 #include "buffer.h"
48 #include "character.h"
49 #include "ccl.h"
50 #include "coding.h"
51 #include "composite.h"
52 #include <epaths.h>
53 #include "process.h"
54 #include "syssignal.h"
55 #include "systty.h"
56 #include "blockinput.h"
57 #include "frame.h"
58 #include "termhooks.h"
60 #ifdef MSDOS
61 #include "msdos.h"
62 #endif
64 #ifndef USE_CRT_DLL
65 extern char **environ;
66 #endif
68 #ifdef HAVE_SETPGID
69 #if !defined (USG)
70 #undef setpgrp
71 #define setpgrp setpgid
72 #endif
73 #endif
75 /* Pattern used by call-process-region to make temp files. */
76 static Lisp_Object Vtemp_file_name_pattern;
78 /* True if we are about to fork off a synchronous process or if we
79 are waiting for it. */
80 int synch_process_alive;
82 /* Nonzero => this is a string explaining death of synchronous subprocess. */
83 const char *synch_process_death;
85 /* Nonzero => this is the signal number that terminated the subprocess. */
86 int synch_process_termsig;
88 /* If synch_process_death is zero,
89 this is exit code of synchronous subprocess. */
90 int synch_process_retcode;
93 /* Clean up when exiting Fcall_process.
94 On MSDOS, delete the temporary file on any kind of termination.
95 On Unix, kill the process and any children on termination by signal. */
97 /* Nonzero if this is termination due to exit. */
98 static int call_process_exited;
100 static Lisp_Object Fgetenv_internal (Lisp_Object, Lisp_Object);
102 static Lisp_Object
103 call_process_kill (Lisp_Object fdpid)
105 int fd;
106 pid_t pid;
107 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
108 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
109 emacs_close (fd);
110 EMACS_KILLPG (pid, SIGKILL);
111 synch_process_alive = 0;
112 return Qnil;
115 static Lisp_Object
116 call_process_cleanup (Lisp_Object arg)
118 Lisp_Object fdpid = Fcdr (arg);
119 int fd;
120 #if defined (MSDOS)
121 Lisp_Object file;
122 #else
123 pid_t pid;
124 #endif
126 Fset_buffer (Fcar (arg));
127 CONS_TO_INTEGER (Fcar (fdpid), int, fd);
129 #if defined (MSDOS)
130 /* for MSDOS fdpid is really (fd . tempfile) */
131 file = Fcdr (fdpid);
132 /* FD is -1 and FILE is "" when we didn't actually create a
133 temporary file in call-process. */
134 if (fd >= 0)
135 emacs_close (fd);
136 if (!(strcmp (SDATA (file), NULL_DEVICE) == 0 || SREF (file, 0) == '\0'))
137 unlink (SDATA (file));
138 #else /* not MSDOS */
139 CONS_TO_INTEGER (Fcdr (fdpid), pid_t, pid);
141 if (call_process_exited)
143 emacs_close (fd);
144 return Qnil;
147 if (EMACS_KILLPG (pid, SIGINT) == 0)
149 ptrdiff_t count = SPECPDL_INDEX ();
150 record_unwind_protect (call_process_kill, fdpid);
151 message1 ("Waiting for process to die...(type C-g again to kill it instantly)");
152 immediate_quit = 1;
153 QUIT;
154 wait_for_termination (pid);
155 immediate_quit = 0;
156 specpdl_ptr = specpdl + count; /* Discard the unwind protect. */
157 message1 ("Waiting for process to die...done");
159 synch_process_alive = 0;
160 emacs_close (fd);
161 #endif /* not MSDOS */
162 return Qnil;
165 DEFUN ("call-process", Fcall_process, Scall_process, 1, MANY, 0,
166 doc: /* Call PROGRAM synchronously in separate process.
167 The remaining arguments are optional.
168 The program's input comes from file INFILE (nil means `/dev/null').
169 Insert output in BUFFER before point; t means current buffer; nil for BUFFER
170 means discard it; 0 means discard and don't wait; and `(:file FILE)', where
171 FILE is a file name string, means that it should be written to that file
172 \(if the file already exists it is overwritten).
173 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
174 REAL-BUFFER says what to do with standard output, as above,
175 while STDERR-FILE says what to do with standard error in the child.
176 STDERR-FILE may be nil (discard standard error output),
177 t (mix it with ordinary output), or a file name string.
179 Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
180 Remaining arguments are strings passed as command arguments to PROGRAM.
182 If executable PROGRAM can't be found as an executable, `call-process'
183 signals a Lisp error. `call-process' reports errors in execution of
184 the program only through its return and output.
186 If BUFFER is 0, `call-process' returns immediately with value nil.
187 Otherwise it waits for PROGRAM to terminate
188 and returns a numeric exit status or a signal description string.
189 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
191 usage: (call-process PROGRAM &optional INFILE BUFFER DISPLAY &rest ARGS) */)
192 (ptrdiff_t nargs, Lisp_Object *args)
194 Lisp_Object infile, buffer, current_dir, path, cleanup_info_tail;
195 int display_p;
196 int fd[2];
197 int filefd;
198 #define CALLPROC_BUFFER_SIZE_MIN (16 * 1024)
199 #define CALLPROC_BUFFER_SIZE_MAX (4 * CALLPROC_BUFFER_SIZE_MIN)
200 char buf[CALLPROC_BUFFER_SIZE_MAX];
201 int bufsize = CALLPROC_BUFFER_SIZE_MIN;
202 ptrdiff_t count = SPECPDL_INDEX ();
203 USE_SAFE_ALLOCA;
205 register const unsigned char **new_argv;
206 /* File to use for stderr in the child.
207 t means use same as standard output. */
208 Lisp_Object error_file;
209 Lisp_Object output_file = Qnil;
210 #ifdef MSDOS /* Demacs 1.1.1 91/10/16 HIRANO Satoshi */
211 char *outf, *tempfile = NULL;
212 int outfilefd;
213 int pid;
214 #else
215 pid_t pid;
216 #endif
217 int fd_output = -1;
218 struct coding_system process_coding; /* coding-system of process output */
219 struct coding_system argument_coding; /* coding-system of arguments */
220 /* Set to the return value of Ffind_operation_coding_system. */
221 Lisp_Object coding_systems;
222 int output_to_buffer = 1;
224 /* Qt denotes that Ffind_operation_coding_system is not yet called. */
225 coding_systems = Qt;
227 CHECK_STRING (args[0]);
229 error_file = Qt;
231 #ifndef subprocesses
232 /* Without asynchronous processes we cannot have BUFFER == 0. */
233 if (nargs >= 3
234 && (INTEGERP (CONSP (args[2]) ? XCAR (args[2]) : args[2])))
235 error ("Operating system cannot handle asynchronous subprocesses");
236 #endif /* subprocesses */
238 /* Decide the coding-system for giving arguments. */
240 Lisp_Object val, *args2;
241 ptrdiff_t i;
243 /* If arguments are supplied, we may have to encode them. */
244 if (nargs >= 5)
246 int must_encode = 0;
247 Lisp_Object coding_attrs;
249 for (i = 4; i < nargs; i++)
250 CHECK_STRING (args[i]);
252 for (i = 4; i < nargs; i++)
253 if (STRING_MULTIBYTE (args[i]))
254 must_encode = 1;
256 if (!NILP (Vcoding_system_for_write))
257 val = Vcoding_system_for_write;
258 else if (! must_encode)
259 val = Qraw_text;
260 else
262 SAFE_NALLOCA (args2, 1, nargs + 1);
263 args2[0] = Qcall_process;
264 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
265 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
266 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
268 val = complement_process_encoding_system (val);
269 setup_coding_system (Fcheck_coding_system (val), &argument_coding);
270 coding_attrs = CODING_ID_ATTRS (argument_coding.id);
271 if (NILP (CODING_ATTR_ASCII_COMPAT (coding_attrs)))
273 /* We should not use an ASCII incompatible coding system. */
274 val = raw_text_coding_system (val);
275 setup_coding_system (val, &argument_coding);
280 if (nargs >= 2 && ! NILP (args[1]))
282 infile = Fexpand_file_name (args[1], BVAR (current_buffer, directory));
283 CHECK_STRING (infile);
285 else
286 infile = build_string (NULL_DEVICE);
288 if (nargs >= 3)
290 buffer = args[2];
292 /* If BUFFER is a list, its meaning is (BUFFER-FOR-STDOUT
293 FILE-FOR-STDERR), unless the first element is :file, in which case see
294 the next paragraph. */
295 if (CONSP (buffer)
296 && (! SYMBOLP (XCAR (buffer))
297 || strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file")))
299 if (CONSP (XCDR (buffer)))
301 Lisp_Object stderr_file;
302 stderr_file = XCAR (XCDR (buffer));
304 if (NILP (stderr_file) || EQ (Qt, stderr_file))
305 error_file = stderr_file;
306 else
307 error_file = Fexpand_file_name (stderr_file, Qnil);
310 buffer = XCAR (buffer);
313 /* If the buffer is (still) a list, it might be a (:file "file") spec. */
314 if (CONSP (buffer)
315 && SYMBOLP (XCAR (buffer))
316 && ! strcmp (SSDATA (SYMBOL_NAME (XCAR (buffer))), ":file"))
318 output_file = Fexpand_file_name (XCAR (XCDR (buffer)),
319 BVAR (current_buffer, directory));
320 CHECK_STRING (output_file);
321 buffer = Qnil;
324 if (!(EQ (buffer, Qnil)
325 || EQ (buffer, Qt)
326 || INTEGERP (buffer)))
328 Lisp_Object spec_buffer;
329 spec_buffer = buffer;
330 buffer = Fget_buffer_create (buffer);
331 /* Mention the buffer name for a better error message. */
332 if (NILP (buffer))
333 CHECK_BUFFER (spec_buffer);
334 CHECK_BUFFER (buffer);
337 else
338 buffer = Qnil;
340 /* Make sure that the child will be able to chdir to the current
341 buffer's current directory, or its unhandled equivalent. We
342 can't just have the child check for an error when it does the
343 chdir, since it's in a vfork.
345 We have to GCPRO around this because Fexpand_file_name,
346 Funhandled_file_name_directory, and Ffile_accessible_directory_p
347 might call a file name handling function. The argument list is
348 protected by the caller, so all we really have to worry about is
349 buffer. */
351 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
353 current_dir = BVAR (current_buffer, directory);
355 GCPRO5 (infile, buffer, current_dir, error_file, output_file);
357 current_dir = Funhandled_file_name_directory (current_dir);
358 if (NILP (current_dir))
359 /* If the file name handler says that current_dir is unreachable, use
360 a sensible default. */
361 current_dir = build_string ("~/");
362 current_dir = expand_and_dir_to_file (current_dir, Qnil);
363 current_dir = Ffile_name_as_directory (current_dir);
365 if (NILP (Ffile_accessible_directory_p (current_dir)))
366 report_file_error ("Setting current directory",
367 Fcons (BVAR (current_buffer, directory), Qnil));
369 if (STRING_MULTIBYTE (infile))
370 infile = ENCODE_FILE (infile);
371 if (STRING_MULTIBYTE (current_dir))
372 current_dir = ENCODE_FILE (current_dir);
373 if (STRINGP (error_file) && STRING_MULTIBYTE (error_file))
374 error_file = ENCODE_FILE (error_file);
375 if (STRINGP (output_file) && STRING_MULTIBYTE (output_file))
376 output_file = ENCODE_FILE (output_file);
377 UNGCPRO;
380 display_p = INTERACTIVE && nargs >= 4 && !NILP (args[3]);
382 filefd = emacs_open (SSDATA (infile), O_RDONLY, 0);
383 if (filefd < 0)
385 infile = DECODE_FILE (infile);
386 report_file_error ("Opening process input file", Fcons (infile, Qnil));
389 if (STRINGP (output_file))
391 #ifdef DOS_NT
392 fd_output = emacs_open (SSDATA (output_file),
393 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
394 S_IREAD | S_IWRITE);
395 #else /* not DOS_NT */
396 fd_output = creat (SSDATA (output_file), 0666);
397 #endif /* not DOS_NT */
398 if (fd_output < 0)
400 output_file = DECODE_FILE (output_file);
401 report_file_error ("Opening process output file",
402 Fcons (output_file, Qnil));
404 if (STRINGP (error_file) || NILP (error_file))
405 output_to_buffer = 0;
408 /* Search for program; barf if not found. */
410 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
412 GCPRO4 (infile, buffer, current_dir, error_file);
413 openp (Vexec_path, args[0], Vexec_suffixes, &path, make_number (X_OK));
414 UNGCPRO;
416 if (NILP (path))
418 emacs_close (filefd);
419 report_file_error ("Searching for program", Fcons (args[0], Qnil));
422 /* If program file name starts with /: for quoting a magic name,
423 discard that. */
424 if (SBYTES (path) > 2 && SREF (path, 0) == '/'
425 && SREF (path, 1) == ':')
426 path = Fsubstring (path, make_number (2), Qnil);
428 SAFE_ALLOCA (new_argv, const unsigned char **,
429 (nargs > 4 ? nargs - 2 : 2) * sizeof *new_argv);
430 if (nargs > 4)
432 ptrdiff_t i;
433 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4, gcpro5;
435 GCPRO5 (infile, buffer, current_dir, path, error_file);
436 argument_coding.dst_multibyte = 0;
437 for (i = 4; i < nargs; i++)
439 argument_coding.src_multibyte = STRING_MULTIBYTE (args[i]);
440 if (CODING_REQUIRE_ENCODING (&argument_coding))
441 /* We must encode this argument. */
442 args[i] = encode_coding_string (&argument_coding, args[i], 1);
444 UNGCPRO;
445 for (i = 4; i < nargs; i++)
446 new_argv[i - 3] = SDATA (args[i]);
447 new_argv[i - 3] = 0;
449 else
450 new_argv[1] = 0;
451 new_argv[0] = SDATA (path);
453 #ifdef MSDOS /* MW, July 1993 */
455 /* If we're redirecting STDOUT to a file, that file is already open
456 on fd_output. */
457 if (fd_output < 0)
459 if ((outf = egetenv ("TMPDIR")))
460 strcpy (tempfile = alloca (strlen (outf) + 20), outf);
461 else
463 tempfile = alloca (20);
464 *tempfile = '\0';
466 dostounix_filename (tempfile);
467 if (*tempfile == '\0' || tempfile[strlen (tempfile) - 1] != '/')
468 strcat (tempfile, "/");
469 strcat (tempfile, "detmp.XXX");
470 mktemp (tempfile);
471 outfilefd = creat (tempfile, S_IREAD | S_IWRITE);
472 if (outfilefd < 0) {
473 emacs_close (filefd);
474 report_file_error ("Opening process output file",
475 Fcons (build_string (tempfile), Qnil));
478 else
479 outfilefd = fd_output;
480 fd[0] = filefd;
481 fd[1] = outfilefd;
482 #endif /* MSDOS */
484 if (INTEGERP (buffer))
485 fd[1] = emacs_open (NULL_DEVICE, O_WRONLY, 0), fd[0] = -1;
486 else
488 #ifndef MSDOS
489 errno = 0;
490 if (pipe (fd) == -1)
492 emacs_close (filefd);
493 report_file_error ("Creating process pipe", Qnil);
495 #endif
499 /* child_setup must clobber environ in systems with true vfork.
500 Protect it from permanent change. */
501 register char **save_environ = environ;
502 register int fd1 = fd[1];
503 int fd_error = fd1;
504 #ifdef HAVE_WORKING_VFORK
505 sigset_t procmask;
506 sigset_t blocked;
507 struct sigaction sigpipe_action;
508 #endif
510 if (fd_output >= 0)
511 fd1 = fd_output;
512 #if 0 /* Some systems don't have sigblock. */
513 mask = sigblock (sigmask (SIGCHLD));
514 #endif
516 /* Record that we're about to create a synchronous process. */
517 synch_process_alive = 1;
519 /* These vars record information from process termination.
520 Clear them now before process can possibly terminate,
521 to avoid timing error if process terminates soon. */
522 synch_process_death = 0;
523 synch_process_retcode = 0;
524 synch_process_termsig = 0;
526 if (NILP (error_file))
527 fd_error = emacs_open (NULL_DEVICE, O_WRONLY, 0);
528 else if (STRINGP (error_file))
530 #ifdef DOS_NT
531 fd_error = emacs_open (SSDATA (error_file),
532 O_WRONLY | O_TRUNC | O_CREAT | O_TEXT,
533 S_IREAD | S_IWRITE);
534 #else /* not DOS_NT */
535 fd_error = creat (SSDATA (error_file), 0666);
536 #endif /* not DOS_NT */
539 if (fd_error < 0)
541 emacs_close (filefd);
542 if (fd[0] != filefd)
543 emacs_close (fd[0]);
544 if (fd1 >= 0)
545 emacs_close (fd1);
546 #ifdef MSDOS
547 unlink (tempfile);
548 #endif
549 if (NILP (error_file))
550 error_file = build_string (NULL_DEVICE);
551 else if (STRINGP (error_file))
552 error_file = DECODE_FILE (error_file);
553 report_file_error ("Cannot redirect stderr", Fcons (error_file, Qnil));
556 #ifdef MSDOS /* MW, July 1993 */
557 /* Note that on MSDOS `child_setup' actually returns the child process
558 exit status, not its PID, so we assign it to `synch_process_retcode'
559 below. */
560 pid = child_setup (filefd, outfilefd, fd_error, (char **) new_argv,
561 0, current_dir);
563 /* Record that the synchronous process exited and note its
564 termination status. */
565 synch_process_alive = 0;
566 synch_process_retcode = pid;
567 if (synch_process_retcode < 0) /* means it couldn't be exec'ed */
569 synchronize_system_messages_locale ();
570 synch_process_death = strerror (errno);
573 emacs_close (outfilefd);
574 if (fd_error != outfilefd)
575 emacs_close (fd_error);
576 fd1 = -1; /* No harm in closing that one! */
577 if (tempfile)
579 /* Since CRLF is converted to LF within `decode_coding', we
580 can always open a file with binary mode. */
581 fd[0] = emacs_open (tempfile, O_RDONLY | O_BINARY, 0);
582 if (fd[0] < 0)
584 unlink (tempfile);
585 emacs_close (filefd);
586 report_file_error ("Cannot re-open temporary file",
587 Fcons (build_string (tempfile), Qnil));
590 else
591 fd[0] = -1; /* We are not going to read from tempfile. */
592 #else /* not MSDOS */
593 #ifdef WINDOWSNT
594 pid = child_setup (filefd, fd1, fd_error, (char **) new_argv,
595 0, current_dir);
596 #else /* not WINDOWSNT */
598 #ifdef HAVE_WORKING_VFORK
599 /* On many hosts (e.g. Solaris 2.4), if a vforked child calls `signal',
600 this sets the parent's signal handlers as well as the child's.
601 So delay all interrupts whose handlers the child might munge,
602 and record the current handlers so they can be restored later. */
603 sigemptyset (&blocked);
604 sigaddset (&blocked, SIGPIPE);
605 sigaction (SIGPIPE, 0, &sigpipe_action);
606 pthread_sigmask (SIG_BLOCK, &blocked, &procmask);
607 #endif
609 BLOCK_INPUT;
611 /* vfork, and prevent local vars from being clobbered by the vfork. */
613 Lisp_Object volatile buffer_volatile = buffer;
614 Lisp_Object volatile coding_systems_volatile = coding_systems;
615 Lisp_Object volatile current_dir_volatile = current_dir;
616 int volatile display_p_volatile = display_p;
617 int volatile fd1_volatile = fd1;
618 int volatile fd_error_volatile = fd_error;
619 int volatile fd_output_volatile = fd_output;
620 int volatile output_to_buffer_volatile = output_to_buffer;
621 int volatile sa_must_free_volatile = sa_must_free;
622 ptrdiff_t volatile sa_count_volatile = sa_count;
623 unsigned char const **volatile new_argv_volatile = new_argv;
625 pid = vfork ();
627 buffer = buffer_volatile;
628 coding_systems = coding_systems_volatile;
629 current_dir = current_dir_volatile;
630 display_p = display_p_volatile;
631 fd1 = fd1_volatile;
632 fd_error = fd_error_volatile;
633 fd_output = fd_output_volatile;
634 output_to_buffer = output_to_buffer_volatile;
635 sa_must_free = sa_must_free_volatile;
636 sa_count = sa_count_volatile;
637 new_argv = new_argv_volatile;
640 if (pid == 0)
642 if (fd[0] >= 0)
643 emacs_close (fd[0]);
644 #ifdef HAVE_SETSID
645 setsid ();
646 #endif
647 #if defined (USG)
648 setpgrp ();
649 #else
650 setpgrp (pid, pid);
651 #endif /* USG */
653 /* GConf causes us to ignore SIGPIPE, make sure it is restored
654 in the child. */
655 signal (SIGPIPE, SIG_DFL);
656 #ifdef HAVE_WORKING_VFORK
657 pthread_sigmask (SIG_SETMASK, &procmask, 0);
658 #endif
660 child_setup (filefd, fd1, fd_error, (char **) new_argv,
661 0, current_dir);
664 UNBLOCK_INPUT;
666 #ifdef HAVE_WORKING_VFORK
667 /* Restore the signal state. */
668 sigaction (SIGPIPE, &sigpipe_action, 0);
669 pthread_sigmask (SIG_SETMASK, &procmask, 0);
670 #endif
672 #endif /* not WINDOWSNT */
674 /* The MSDOS case did this already. */
675 if (fd_error >= 0)
676 emacs_close (fd_error);
677 #endif /* not MSDOS */
679 environ = save_environ;
681 /* Close most of our fd's, but not fd[0]
682 since we will use that to read input from. */
683 emacs_close (filefd);
684 if (fd_output >= 0)
685 emacs_close (fd_output);
686 if (fd1 >= 0 && fd1 != fd_error)
687 emacs_close (fd1);
690 if (pid < 0)
692 if (fd[0] >= 0)
693 emacs_close (fd[0]);
694 report_file_error ("Doing vfork", Qnil);
697 if (INTEGERP (buffer))
699 if (fd[0] >= 0)
700 emacs_close (fd[0]);
701 return Qnil;
704 /* Enable sending signal if user quits below. */
705 call_process_exited = 0;
707 #if defined (MSDOS)
708 /* MSDOS needs different cleanup information. */
709 cleanup_info_tail = build_string (tempfile ? tempfile : "");
710 #else
711 cleanup_info_tail = INTEGER_TO_CONS (pid);
712 #endif /* not MSDOS */
713 record_unwind_protect (call_process_cleanup,
714 Fcons (Fcurrent_buffer (),
715 Fcons (INTEGER_TO_CONS (fd[0]),
716 cleanup_info_tail)));
718 if (BUFFERP (buffer))
719 Fset_buffer (buffer);
721 if (NILP (buffer))
723 /* If BUFFER is nil, we must read process output once and then
724 discard it, so setup coding system but with nil. */
725 setup_coding_system (Qnil, &process_coding);
726 process_coding.dst_multibyte = 0;
728 else
730 Lisp_Object val, *args2;
732 val = Qnil;
733 if (!NILP (Vcoding_system_for_read))
734 val = Vcoding_system_for_read;
735 else
737 if (EQ (coding_systems, Qt))
739 ptrdiff_t i;
741 SAFE_NALLOCA (args2, 1, nargs + 1);
742 args2[0] = Qcall_process;
743 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
744 coding_systems
745 = Ffind_operation_coding_system (nargs + 1, args2);
747 if (CONSP (coding_systems))
748 val = XCAR (coding_systems);
749 else if (CONSP (Vdefault_process_coding_system))
750 val = XCAR (Vdefault_process_coding_system);
751 else
752 val = Qnil;
754 Fcheck_coding_system (val);
755 /* In unibyte mode, character code conversion should not take
756 place but EOL conversion should. So, setup raw-text or one
757 of the subsidiary according to the information just setup. */
758 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
759 && !NILP (val))
760 val = raw_text_coding_system (val);
761 setup_coding_system (val, &process_coding);
762 process_coding.dst_multibyte
763 = ! NILP (BVAR (current_buffer, enable_multibyte_characters));
765 process_coding.src_multibyte = 0;
767 immediate_quit = 1;
768 QUIT;
770 if (output_to_buffer)
772 register int nread;
773 int first = 1;
774 EMACS_INT total_read = 0;
775 int carryover = 0;
776 int display_on_the_fly = display_p;
777 struct coding_system saved_coding;
779 saved_coding = process_coding;
780 while (1)
782 /* Repeatedly read until we've filled as much as possible
783 of the buffer size we have. But don't read
784 less than 1024--save that for the next bufferful. */
785 nread = carryover;
786 while (nread < bufsize - 1024)
788 int this_read = emacs_read (fd[0], buf + nread,
789 bufsize - nread);
791 if (this_read < 0)
792 goto give_up;
794 if (this_read == 0)
796 process_coding.mode |= CODING_MODE_LAST_BLOCK;
797 break;
800 nread += this_read;
801 total_read += this_read;
803 if (display_on_the_fly)
804 break;
807 /* Now NREAD is the total amount of data in the buffer. */
808 immediate_quit = 0;
810 if (!NILP (buffer))
812 if (NILP (BVAR (current_buffer, enable_multibyte_characters))
813 && ! CODING_MAY_REQUIRE_DECODING (&process_coding))
814 insert_1_both (buf, nread, nread, 0, 1, 0);
815 else
816 { /* We have to decode the input. */
817 Lisp_Object curbuf;
818 ptrdiff_t count1 = SPECPDL_INDEX ();
820 XSETBUFFER (curbuf, current_buffer);
821 /* We cannot allow after-change-functions be run
822 during decoding, because that might modify the
823 buffer, while we rely on process_coding.produced to
824 faithfully reflect inserted text until we
825 TEMP_SET_PT_BOTH below. */
826 specbind (Qinhibit_modification_hooks, Qt);
827 decode_coding_c_string (&process_coding,
828 (unsigned char *) buf, nread, curbuf);
829 unbind_to (count1, Qnil);
830 if (display_on_the_fly
831 && CODING_REQUIRE_DETECTION (&saved_coding)
832 && ! CODING_REQUIRE_DETECTION (&process_coding))
834 /* We have detected some coding system. But,
835 there's a possibility that the detection was
836 done by insufficient data. So, we give up
837 displaying on the fly. */
838 if (process_coding.produced > 0)
839 del_range_2 (process_coding.dst_pos,
840 process_coding.dst_pos_byte,
841 process_coding.dst_pos
842 + process_coding.produced_char,
843 process_coding.dst_pos_byte
844 + process_coding.produced, 0);
845 display_on_the_fly = 0;
846 process_coding = saved_coding;
847 carryover = nread;
848 /* This is to make the above condition always
849 fails in the future. */
850 saved_coding.common_flags
851 &= ~CODING_REQUIRE_DETECTION_MASK;
852 continue;
855 TEMP_SET_PT_BOTH (PT + process_coding.produced_char,
856 PT_BYTE + process_coding.produced);
857 carryover = process_coding.carryover_bytes;
858 if (carryover > 0)
859 memcpy (buf, process_coding.carryover,
860 process_coding.carryover_bytes);
864 if (process_coding.mode & CODING_MODE_LAST_BLOCK)
865 break;
867 /* Make the buffer bigger as we continue to read more data,
868 but not past CALLPROC_BUFFER_SIZE_MAX. */
869 if (bufsize < CALLPROC_BUFFER_SIZE_MAX && total_read > 32 * bufsize)
870 if ((bufsize *= 2) > CALLPROC_BUFFER_SIZE_MAX)
871 bufsize = CALLPROC_BUFFER_SIZE_MAX;
873 if (display_p)
875 if (first)
876 prepare_menu_bars ();
877 first = 0;
878 redisplay_preserve_echo_area (1);
879 /* This variable might have been set to 0 for code
880 detection. In that case, we set it back to 1 because
881 we should have already detected a coding system. */
882 display_on_the_fly = 1;
884 immediate_quit = 1;
885 QUIT;
887 give_up: ;
889 Vlast_coding_system_used = CODING_ID_NAME (process_coding.id);
890 /* If the caller required, let the buffer inherit the
891 coding-system used to decode the process output. */
892 if (inherit_process_coding_system)
893 call1 (intern ("after-insert-file-set-buffer-file-coding-system"),
894 make_number (total_read));
897 #ifndef MSDOS
898 /* Wait for it to terminate, unless it already has. */
899 if (output_to_buffer)
900 wait_for_termination (pid);
901 else
902 interruptible_wait_for_termination (pid);
903 #endif
905 immediate_quit = 0;
907 /* Don't kill any children that the subprocess may have left behind
908 when exiting. */
909 call_process_exited = 1;
911 SAFE_FREE ();
912 unbind_to (count, Qnil);
914 if (synch_process_termsig)
916 const char *signame;
918 synchronize_system_messages_locale ();
919 signame = strsignal (synch_process_termsig);
921 if (signame == 0)
922 signame = "unknown";
924 synch_process_death = signame;
927 if (synch_process_death)
928 return code_convert_string_norecord (build_string (synch_process_death),
929 Vlocale_coding_system, 0);
930 return make_number (synch_process_retcode);
933 static Lisp_Object
934 delete_temp_file (Lisp_Object name)
936 /* Suppress jka-compr handling, etc. */
937 ptrdiff_t count = SPECPDL_INDEX ();
938 specbind (intern ("file-name-handler-alist"), Qnil);
939 internal_delete_file (name);
940 unbind_to (count, Qnil);
941 return Qnil;
944 DEFUN ("call-process-region", Fcall_process_region, Scall_process_region,
945 3, MANY, 0,
946 doc: /* Send text from START to END to a synchronous process running PROGRAM.
947 The remaining arguments are optional.
948 Delete the text if fourth arg DELETE is non-nil.
950 Insert output in BUFFER before point; t means current buffer; nil for
951 BUFFER means discard it; 0 means discard and don't wait; and `(:file
952 FILE)', where FILE is a file name string, means that it should be
953 written to that file (if the file already exists it is overwritten).
954 BUFFER can also have the form (REAL-BUFFER STDERR-FILE); in that case,
955 REAL-BUFFER says what to do with standard output, as above,
956 while STDERR-FILE says what to do with standard error in the child.
957 STDERR-FILE may be nil (discard standard error output),
958 t (mix it with ordinary output), or a file name string.
960 Sixth arg DISPLAY non-nil means redisplay buffer as output is inserted.
961 Remaining args are passed to PROGRAM at startup as command args.
963 If BUFFER is 0, `call-process-region' returns immediately with value nil.
964 Otherwise it waits for PROGRAM to terminate
965 and returns a numeric exit status or a signal description string.
966 If you quit, the process is killed with SIGINT, or SIGKILL if you quit again.
968 usage: (call-process-region START END PROGRAM &optional DELETE BUFFER DISPLAY &rest ARGS) */)
969 (ptrdiff_t nargs, Lisp_Object *args)
971 struct gcpro gcpro1;
972 Lisp_Object filename_string;
973 register Lisp_Object start, end;
974 ptrdiff_t count = SPECPDL_INDEX ();
975 /* Qt denotes we have not yet called Ffind_operation_coding_system. */
976 Lisp_Object coding_systems;
977 Lisp_Object val, *args2;
978 ptrdiff_t i;
979 char *tempfile;
980 Lisp_Object tmpdir, pattern;
982 if (STRINGP (Vtemporary_file_directory))
983 tmpdir = Vtemporary_file_directory;
984 else
986 #ifndef DOS_NT
987 if (getenv ("TMPDIR"))
988 tmpdir = build_string (getenv ("TMPDIR"));
989 else
990 tmpdir = build_string ("/tmp/");
991 #else /* DOS_NT */
992 char *outf;
993 if ((outf = egetenv ("TMPDIR"))
994 || (outf = egetenv ("TMP"))
995 || (outf = egetenv ("TEMP")))
996 tmpdir = build_string (outf);
997 else
998 tmpdir = Ffile_name_as_directory (build_string ("c:/temp"));
999 #endif
1003 USE_SAFE_ALLOCA;
1004 pattern = Fexpand_file_name (Vtemp_file_name_pattern, tmpdir);
1005 SAFE_ALLOCA (tempfile, char *, SBYTES (pattern) + 1);
1006 memcpy (tempfile, SDATA (pattern), SBYTES (pattern) + 1);
1007 coding_systems = Qt;
1009 #ifdef HAVE_MKSTEMP
1011 int fd;
1013 BLOCK_INPUT;
1014 fd = mkstemp (tempfile);
1015 UNBLOCK_INPUT;
1016 if (fd == -1)
1017 report_file_error ("Failed to open temporary file",
1018 Fcons (build_string (tempfile), Qnil));
1019 else
1020 close (fd);
1022 #else
1023 mktemp (tempfile);
1024 #endif
1026 filename_string = build_string (tempfile);
1027 GCPRO1 (filename_string);
1028 SAFE_FREE ();
1031 start = args[0];
1032 end = args[1];
1033 /* Decide coding-system of the contents of the temporary file. */
1034 if (!NILP (Vcoding_system_for_write))
1035 val = Vcoding_system_for_write;
1036 else if (NILP (BVAR (current_buffer, enable_multibyte_characters)))
1037 val = Qraw_text;
1038 else
1040 USE_SAFE_ALLOCA;
1041 SAFE_NALLOCA (args2, 1, nargs + 1);
1042 args2[0] = Qcall_process_region;
1043 for (i = 0; i < nargs; i++) args2[i + 1] = args[i];
1044 coding_systems = Ffind_operation_coding_system (nargs + 1, args2);
1045 val = CONSP (coding_systems) ? XCDR (coding_systems) : Qnil;
1046 SAFE_FREE ();
1048 val = complement_process_encoding_system (val);
1051 ptrdiff_t count1 = SPECPDL_INDEX ();
1053 specbind (intern ("coding-system-for-write"), val);
1054 /* POSIX lets mk[s]temp use "."; don't invoke jka-compr if we
1055 happen to get a ".Z" suffix. */
1056 specbind (intern ("file-name-handler-alist"), Qnil);
1057 Fwrite_region (start, end, filename_string, Qnil, Qlambda, Qnil, Qnil);
1059 unbind_to (count1, Qnil);
1062 /* Note that Fcall_process takes care of binding
1063 coding-system-for-read. */
1065 record_unwind_protect (delete_temp_file, filename_string);
1067 if (nargs > 3 && !NILP (args[3]))
1068 Fdelete_region (start, end);
1070 if (nargs > 3)
1072 args += 2;
1073 nargs -= 2;
1075 else
1077 args[0] = args[2];
1078 nargs = 2;
1080 args[1] = filename_string;
1082 RETURN_UNGCPRO (unbind_to (count, Fcall_process (nargs, args)));
1085 #ifndef WINDOWSNT
1086 static int relocate_fd (int fd, int minfd);
1087 #endif
1089 static char **
1090 add_env (char **env, char **new_env, char *string)
1092 char **ep;
1093 int ok = 1;
1094 if (string == NULL)
1095 return new_env;
1097 /* See if this string duplicates any string already in the env.
1098 If so, don't put it in.
1099 When an env var has multiple definitions,
1100 we keep the definition that comes first in process-environment. */
1101 for (ep = env; ok && ep != new_env; ep++)
1103 char *p = *ep, *q = string;
1104 while (ok)
1106 if (*q != *p)
1107 break;
1108 if (*q == 0)
1109 /* The string is a lone variable name; keep it for now, we
1110 will remove it later. It is a placeholder for a
1111 variable that is not to be included in the environment. */
1112 break;
1113 if (*q == '=')
1114 ok = 0;
1115 p++, q++;
1118 if (ok)
1119 *new_env++ = string;
1120 return new_env;
1123 /* This is the last thing run in a newly forked inferior
1124 either synchronous or asynchronous.
1125 Copy descriptors IN, OUT and ERR as descriptors 0, 1 and 2.
1126 Initialize inferior's priority, pgrp, connected dir and environment.
1127 then exec another program based on new_argv.
1129 This function may change environ for the superior process.
1130 Therefore, the superior process must save and restore the value
1131 of environ around the vfork and the call to this function.
1133 SET_PGRP is nonzero if we should put the subprocess into a separate
1134 process group.
1136 CURRENT_DIR is an elisp string giving the path of the current
1137 directory the subprocess should have. Since we can't really signal
1138 a decent error from within the child, this should be verified as an
1139 executable directory by the parent. */
1142 child_setup (int in, int out, int err, register char **new_argv, int set_pgrp, Lisp_Object current_dir)
1144 char **env;
1145 char *pwd_var;
1146 #ifdef WINDOWSNT
1147 int cpid;
1148 HANDLE handles[3];
1149 #endif /* WINDOWSNT */
1151 pid_t pid = getpid ();
1153 /* Close Emacs's descriptors that this process should not have. */
1154 close_process_descs ();
1156 /* DOS_NT isn't in a vfork, so if we are in the middle of load-file,
1157 we will lose if we call close_load_descs here. */
1158 #ifndef DOS_NT
1159 close_load_descs ();
1160 #endif
1162 /* Note that use of alloca is always safe here. It's obvious for systems
1163 that do not have true vfork or that have true (stack) alloca.
1164 If using vfork and C_ALLOCA (when Emacs used to include
1165 src/alloca.c) it is safe because that changes the superior's
1166 static variables as if the superior had done alloca and will be
1167 cleaned up in the usual way. */
1169 register char *temp;
1170 size_t i; /* size_t, because ptrdiff_t might overflow here! */
1172 i = SBYTES (current_dir);
1173 #ifdef MSDOS
1174 /* MSDOS must have all environment variables malloc'ed, because
1175 low-level libc functions that launch subsidiary processes rely
1176 on that. */
1177 pwd_var = (char *) xmalloc (i + 6);
1178 #else
1179 pwd_var = (char *) alloca (i + 6);
1180 #endif
1181 temp = pwd_var + 4;
1182 memcpy (pwd_var, "PWD=", 4);
1183 memcpy (temp, SDATA (current_dir), i);
1184 if (!IS_DIRECTORY_SEP (temp[i - 1])) temp[i++] = DIRECTORY_SEP;
1185 temp[i] = 0;
1187 #ifndef DOS_NT
1188 /* We can't signal an Elisp error here; we're in a vfork. Since
1189 the callers check the current directory before forking, this
1190 should only return an error if the directory's permissions
1191 are changed between the check and this chdir, but we should
1192 at least check. */
1193 if (chdir (temp) < 0)
1194 _exit (errno);
1195 #else /* DOS_NT */
1196 /* Get past the drive letter, so that d:/ is left alone. */
1197 if (i > 2 && IS_DEVICE_SEP (temp[1]) && IS_DIRECTORY_SEP (temp[2]))
1199 temp += 2;
1200 i -= 2;
1202 #endif /* DOS_NT */
1204 /* Strip trailing slashes for PWD, but leave "/" and "//" alone. */
1205 while (i > 2 && IS_DIRECTORY_SEP (temp[i - 1]))
1206 temp[--i] = 0;
1209 /* Set `env' to a vector of the strings in the environment. */
1211 register Lisp_Object tem;
1212 register char **new_env;
1213 char **p, **q;
1214 register int new_length;
1215 Lisp_Object display = Qnil;
1217 new_length = 0;
1219 for (tem = Vprocess_environment;
1220 CONSP (tem) && STRINGP (XCAR (tem));
1221 tem = XCDR (tem))
1223 if (strncmp (SSDATA (XCAR (tem)), "DISPLAY", 7) == 0
1224 && (SDATA (XCAR (tem)) [7] == '\0'
1225 || SDATA (XCAR (tem)) [7] == '='))
1226 /* DISPLAY is specified in process-environment. */
1227 display = Qt;
1228 new_length++;
1231 /* If not provided yet, use the frame's DISPLAY. */
1232 if (NILP (display))
1234 Lisp_Object tmp = Fframe_parameter (selected_frame, Qdisplay);
1235 if (!STRINGP (tmp) && CONSP (Vinitial_environment))
1236 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1237 tmp = Fgetenv_internal (build_string ("DISPLAY"),
1238 Vinitial_environment);
1239 if (STRINGP (tmp))
1241 display = tmp;
1242 new_length++;
1246 /* new_length + 2 to include PWD and terminating 0. */
1247 env = new_env = (char **) alloca ((new_length + 2) * sizeof (char *));
1248 /* If we have a PWD envvar, pass one down,
1249 but with corrected value. */
1250 if (egetenv ("PWD"))
1251 *new_env++ = pwd_var;
1253 if (STRINGP (display))
1255 char *vdata = (char *) alloca (sizeof "DISPLAY=" + SBYTES (display));
1256 strcpy (vdata, "DISPLAY=");
1257 strcat (vdata, SSDATA (display));
1258 new_env = add_env (env, new_env, vdata);
1261 /* Overrides. */
1262 for (tem = Vprocess_environment;
1263 CONSP (tem) && STRINGP (XCAR (tem));
1264 tem = XCDR (tem))
1265 new_env = add_env (env, new_env, SSDATA (XCAR (tem)));
1267 *new_env = 0;
1269 /* Remove variable names without values. */
1270 p = q = env;
1271 while (*p != 0)
1273 while (*q != 0 && strchr (*q, '=') == NULL)
1274 q++;
1275 *p = *q++;
1276 if (*p != 0)
1277 p++;
1282 #ifdef WINDOWSNT
1283 prepare_standard_handles (in, out, err, handles);
1284 set_process_dir (SDATA (current_dir));
1285 /* Spawn the child. (See ntproc.c:Spawnve). */
1286 cpid = spawnve (_P_NOWAIT, new_argv[0], new_argv, env);
1287 reset_standard_handles (in, out, err, handles);
1288 if (cpid == -1)
1289 /* An error occurred while trying to spawn the process. */
1290 report_file_error ("Spawning child process", Qnil);
1291 return cpid;
1293 #else /* not WINDOWSNT */
1294 /* Make sure that in, out, and err are not actually already in
1295 descriptors zero, one, or two; this could happen if Emacs is
1296 started with its standard in, out, or error closed, as might
1297 happen under X. */
1299 int oin = in, oout = out;
1301 /* We have to avoid relocating the same descriptor twice! */
1303 in = relocate_fd (in, 3);
1305 if (out == oin)
1306 out = in;
1307 else
1308 out = relocate_fd (out, 3);
1310 if (err == oin)
1311 err = in;
1312 else if (err == oout)
1313 err = out;
1314 else
1315 err = relocate_fd (err, 3);
1318 #ifndef MSDOS
1319 emacs_close (0);
1320 emacs_close (1);
1321 emacs_close (2);
1323 dup2 (in, 0);
1324 dup2 (out, 1);
1325 dup2 (err, 2);
1326 emacs_close (in);
1327 if (out != in)
1328 emacs_close (out);
1329 if (err != in && err != out)
1330 emacs_close (err);
1332 #if defined (USG)
1333 #ifndef SETPGRP_RELEASES_CTTY
1334 setpgrp (); /* No arguments but equivalent in this case */
1335 #endif
1336 #else /* not USG */
1337 setpgrp (pid, pid);
1338 #endif /* not USG */
1340 /* setpgrp_of_tty is incorrect here; it uses input_fd. */
1341 tcsetpgrp (0, pid);
1343 /* execvp does not accept an environment arg so the only way
1344 to pass this environment is to set environ. Our caller
1345 is responsible for restoring the ambient value of environ. */
1346 environ = env;
1347 execvp (new_argv[0], new_argv);
1349 emacs_write (1, "Can't exec program: ", 20);
1350 emacs_write (1, new_argv[0], strlen (new_argv[0]));
1351 emacs_write (1, "\n", 1);
1352 _exit (1);
1354 #else /* MSDOS */
1355 pid = run_msdos_command (new_argv, pwd_var + 4, in, out, err, env);
1356 xfree (pwd_var);
1357 if (pid == -1)
1358 /* An error occurred while trying to run the subprocess. */
1359 report_file_error ("Spawning child process", Qnil);
1360 return pid;
1361 #endif /* MSDOS */
1362 #endif /* not WINDOWSNT */
1365 #ifndef WINDOWSNT
1366 /* Move the file descriptor FD so that its number is not less than MINFD.
1367 If the file descriptor is moved at all, the original is freed. */
1368 static int
1369 relocate_fd (int fd, int minfd)
1371 if (fd >= minfd)
1372 return fd;
1373 else
1375 int new;
1376 #ifdef F_DUPFD
1377 new = fcntl (fd, F_DUPFD, minfd);
1378 #else
1379 new = dup (fd);
1380 if (new != -1)
1381 /* Note that we hold the original FD open while we recurse,
1382 to guarantee we'll get a new FD if we need it. */
1383 new = relocate_fd (new, minfd);
1384 #endif
1385 if (new == -1)
1387 const char *message_1 = "Error while setting up child: ";
1388 const char *errmessage = strerror (errno);
1389 const char *message_2 = "\n";
1390 emacs_write (2, message_1, strlen (message_1));
1391 emacs_write (2, errmessage, strlen (errmessage));
1392 emacs_write (2, message_2, strlen (message_2));
1393 _exit (1);
1395 emacs_close (fd);
1396 return new;
1399 #endif /* not WINDOWSNT */
1401 static int
1402 getenv_internal_1 (const char *var, ptrdiff_t varlen, char **value,
1403 ptrdiff_t *valuelen, Lisp_Object env)
1405 for (; CONSP (env); env = XCDR (env))
1407 Lisp_Object entry = XCAR (env);
1408 if (STRINGP (entry)
1409 && SBYTES (entry) >= varlen
1410 #ifdef WINDOWSNT
1411 /* NT environment variables are case insensitive. */
1412 && ! strnicmp (SDATA (entry), var, varlen)
1413 #else /* not WINDOWSNT */
1414 && ! memcmp (SDATA (entry), var, varlen)
1415 #endif /* not WINDOWSNT */
1418 if (SBYTES (entry) > varlen && SREF (entry, varlen) == '=')
1420 *value = SSDATA (entry) + (varlen + 1);
1421 *valuelen = SBYTES (entry) - (varlen + 1);
1422 return 1;
1424 else if (SBYTES (entry) == varlen)
1426 /* Lone variable names in Vprocess_environment mean that
1427 variable should be removed from the environment. */
1428 *value = NULL;
1429 return 1;
1433 return 0;
1436 static int
1437 getenv_internal (const char *var, ptrdiff_t varlen, char **value,
1438 ptrdiff_t *valuelen, Lisp_Object frame)
1440 /* Try to find VAR in Vprocess_environment first. */
1441 if (getenv_internal_1 (var, varlen, value, valuelen,
1442 Vprocess_environment))
1443 return *value ? 1 : 0;
1445 /* For DISPLAY try to get the values from the frame or the initial env. */
1446 if (strcmp (var, "DISPLAY") == 0)
1448 Lisp_Object display
1449 = Fframe_parameter (NILP (frame) ? selected_frame : frame, Qdisplay);
1450 if (STRINGP (display))
1452 *value = SSDATA (display);
1453 *valuelen = SBYTES (display);
1454 return 1;
1456 /* If still not found, Look for DISPLAY in Vinitial_environment. */
1457 if (getenv_internal_1 (var, varlen, value, valuelen,
1458 Vinitial_environment))
1459 return *value ? 1 : 0;
1462 return 0;
1465 DEFUN ("getenv-internal", Fgetenv_internal, Sgetenv_internal, 1, 2, 0,
1466 doc: /* Get the value of environment variable VARIABLE.
1467 VARIABLE should be a string. Value is nil if VARIABLE is undefined in
1468 the environment. Otherwise, value is a string.
1470 This function searches `process-environment' for VARIABLE.
1472 If optional parameter ENV is a list, then search this list instead of
1473 `process-environment', and return t when encountering a negative entry
1474 \(an entry for a variable with no value). */)
1475 (Lisp_Object variable, Lisp_Object env)
1477 char *value;
1478 ptrdiff_t valuelen;
1480 CHECK_STRING (variable);
1481 if (CONSP (env))
1483 if (getenv_internal_1 (SSDATA (variable), SBYTES (variable),
1484 &value, &valuelen, env))
1485 return value ? make_string (value, valuelen) : Qt;
1486 else
1487 return Qnil;
1489 else if (getenv_internal (SSDATA (variable), SBYTES (variable),
1490 &value, &valuelen, env))
1491 return make_string (value, valuelen);
1492 else
1493 return Qnil;
1496 /* A version of getenv that consults the Lisp environment lists,
1497 easily callable from C. */
1498 char *
1499 egetenv (const char *var)
1501 char *value;
1502 ptrdiff_t valuelen;
1504 if (getenv_internal (var, strlen (var), &value, &valuelen, Qnil))
1505 return value;
1506 else
1507 return 0;
1511 /* This is run before init_cmdargs. */
1513 void
1514 init_callproc_1 (void)
1516 char *data_dir = egetenv ("EMACSDATA");
1517 char *doc_dir = egetenv ("EMACSDOC");
1519 Vdata_directory
1520 = Ffile_name_as_directory (build_string (data_dir ? data_dir
1521 : PATH_DATA));
1522 Vdoc_directory
1523 = Ffile_name_as_directory (build_string (doc_dir ? doc_dir
1524 : PATH_DOC));
1526 /* Check the EMACSPATH environment variable, defaulting to the
1527 PATH_EXEC path from epaths.h. */
1528 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
1529 Vexec_directory = Ffile_name_as_directory (Fcar (Vexec_path));
1530 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1533 /* This is run after init_cmdargs, when Vinstallation_directory is valid. */
1535 void
1536 init_callproc (void)
1538 char *data_dir = egetenv ("EMACSDATA");
1540 register char * sh;
1541 Lisp_Object tempdir;
1543 if (!NILP (Vinstallation_directory))
1545 /* Add to the path the lib-src subdir of the installation dir. */
1546 Lisp_Object tem;
1547 tem = Fexpand_file_name (build_string ("lib-src"),
1548 Vinstallation_directory);
1549 #ifndef DOS_NT
1550 /* MSDOS uses wrapped binaries, so don't do this. */
1551 if (NILP (Fmember (tem, Vexec_path)))
1553 Vexec_path = decode_env_path ("EMACSPATH", PATH_EXEC);
1554 Vexec_path = Fcons (tem, Vexec_path);
1555 Vexec_path = nconc2 (decode_env_path ("PATH", ""), Vexec_path);
1558 Vexec_directory = Ffile_name_as_directory (tem);
1559 #endif /* not DOS_NT */
1561 /* Maybe use ../etc as well as ../lib-src. */
1562 if (data_dir == 0)
1564 tem = Fexpand_file_name (build_string ("etc"),
1565 Vinstallation_directory);
1566 Vdoc_directory = Ffile_name_as_directory (tem);
1570 /* Look for the files that should be in etc. We don't use
1571 Vinstallation_directory, because these files are never installed
1572 near the executable, and they are never in the build
1573 directory when that's different from the source directory.
1575 Instead, if these files are not in the nominal place, we try the
1576 source directory. */
1577 if (data_dir == 0)
1579 Lisp_Object tem, tem1, srcdir;
1581 srcdir = Fexpand_file_name (build_string ("../src/"),
1582 build_string (PATH_DUMPLOADSEARCH));
1583 tem = Fexpand_file_name (build_string ("GNU"), Vdata_directory);
1584 tem1 = Ffile_exists_p (tem);
1585 if (!NILP (Fequal (srcdir, Vinvocation_directory)) || NILP (tem1))
1587 Lisp_Object newdir;
1588 newdir = Fexpand_file_name (build_string ("../etc/"),
1589 build_string (PATH_DUMPLOADSEARCH));
1590 tem = Fexpand_file_name (build_string ("GNU"), newdir);
1591 tem1 = Ffile_exists_p (tem);
1592 if (!NILP (tem1))
1593 Vdata_directory = newdir;
1597 #ifndef CANNOT_DUMP
1598 if (initialized)
1599 #endif
1601 tempdir = Fdirectory_file_name (Vexec_directory);
1602 if (access (SSDATA (tempdir), 0) < 0)
1603 dir_warning ("Warning: arch-dependent data dir (%s) does not exist.\n",
1604 Vexec_directory);
1607 tempdir = Fdirectory_file_name (Vdata_directory);
1608 if (access (SSDATA (tempdir), 0) < 0)
1609 dir_warning ("Warning: arch-independent data dir (%s) does not exist.\n",
1610 Vdata_directory);
1612 sh = (char *) getenv ("SHELL");
1613 Vshell_file_name = build_string (sh ? sh : "/bin/sh");
1615 #ifdef DOS_NT
1616 Vshared_game_score_directory = Qnil;
1617 #else
1618 Vshared_game_score_directory = build_string (PATH_GAME);
1619 if (NILP (Ffile_directory_p (Vshared_game_score_directory)))
1620 Vshared_game_score_directory = Qnil;
1621 #endif
1624 void
1625 set_initial_environment (void)
1627 char **envp;
1628 for (envp = environ; *envp; envp++)
1629 Vprocess_environment = Fcons (build_string (*envp),
1630 Vprocess_environment);
1631 /* Ideally, the `copy' shouldn't be necessary, but it seems it's frequent
1632 to use `delete' and friends on process-environment. */
1633 Vinitial_environment = Fcopy_sequence (Vprocess_environment);
1636 void
1637 syms_of_callproc (void)
1639 #ifndef DOS_NT
1640 Vtemp_file_name_pattern = build_string ("emacsXXXXXX");
1641 #elif defined (WINDOWSNT)
1642 Vtemp_file_name_pattern = build_string ("emXXXXXX");
1643 #else
1644 Vtemp_file_name_pattern = build_string ("detmp.XXX");
1645 #endif
1646 staticpro (&Vtemp_file_name_pattern);
1648 DEFVAR_LISP ("shell-file-name", Vshell_file_name,
1649 doc: /* File name to load inferior shells from.
1650 Initialized from the SHELL environment variable, or to a system-dependent
1651 default if SHELL is not set. */);
1653 DEFVAR_LISP ("exec-path", Vexec_path,
1654 doc: /* List of directories to search programs to run in subprocesses.
1655 Each element is a string (directory name) or nil (try default directory). */);
1657 DEFVAR_LISP ("exec-suffixes", Vexec_suffixes,
1658 doc: /* List of suffixes to try to find executable file names.
1659 Each element is a string. */);
1660 Vexec_suffixes = Qnil;
1662 DEFVAR_LISP ("exec-directory", Vexec_directory,
1663 doc: /* Directory for executables for Emacs to invoke.
1664 More generally, this includes any architecture-dependent files
1665 that are built and installed from the Emacs distribution. */);
1667 DEFVAR_LISP ("data-directory", Vdata_directory,
1668 doc: /* Directory of machine-independent files that come with GNU Emacs.
1669 These are files intended for Emacs to use while it runs. */);
1671 DEFVAR_LISP ("doc-directory", Vdoc_directory,
1672 doc: /* Directory containing the DOC file that comes with GNU Emacs.
1673 This is usually the same as `data-directory'. */);
1675 DEFVAR_LISP ("configure-info-directory", Vconfigure_info_directory,
1676 doc: /* For internal use by the build procedure only.
1677 This is the name of the directory in which the build procedure installed
1678 Emacs's info files; the default value for `Info-default-directory-list'
1679 includes this. */);
1680 Vconfigure_info_directory = build_string (PATH_INFO);
1682 DEFVAR_LISP ("shared-game-score-directory", Vshared_game_score_directory,
1683 doc: /* Directory of score files for games which come with GNU Emacs.
1684 If this variable is nil, then Emacs is unable to use a shared directory. */);
1685 #ifdef DOS_NT
1686 Vshared_game_score_directory = Qnil;
1687 #else
1688 Vshared_game_score_directory = build_string (PATH_GAME);
1689 #endif
1691 DEFVAR_LISP ("initial-environment", Vinitial_environment,
1692 doc: /* List of environment variables inherited from the parent process.
1693 Each element should be a string of the form ENVVARNAME=VALUE.
1694 The elements must normally be decoded (using `locale-coding-system') for use. */);
1695 Vinitial_environment = Qnil;
1697 DEFVAR_LISP ("process-environment", Vprocess_environment,
1698 doc: /* List of overridden environment variables for subprocesses to inherit.
1699 Each element should be a string of the form ENVVARNAME=VALUE.
1701 Entries in this list take precedence to those in the frame-local
1702 environments. Therefore, let-binding `process-environment' is an easy
1703 way to temporarily change the value of an environment variable,
1704 irrespective of where it comes from. To use `process-environment' to
1705 remove an environment variable, include only its name in the list,
1706 without "=VALUE".
1708 This variable is set to nil when Emacs starts.
1710 If multiple entries define the same variable, the first one always
1711 takes precedence.
1713 Non-ASCII characters are encoded according to the initial value of
1714 `locale-coding-system', i.e. the elements must normally be decoded for
1715 use.
1717 See `setenv' and `getenv'. */);
1718 Vprocess_environment = Qnil;
1720 defsubr (&Scall_process);
1721 defsubr (&Sgetenv_internal);
1722 defsubr (&Scall_process_region);