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