src/process.h

   1 /* Definitions for asynchronous process control in GNU Emacs.
   2    Copyright (C) 1985, 1994 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   6 GNU Emacs is free software; you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation; either version 2, or (at your option)
   9 any later version.
  10
  11 GNU Emacs is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with GNU Emacs; see the file COPYING.  If not, write to
  18 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */
  19
  20
  21 /*
  22  * Structure records pertinent information about open channels.
  23  * There is one channel associated with each process.
  24  */
  25
  26 struct Lisp_Process
  27   {
  28     EMACS_INT size;
  29     struct Lisp_Vector *v_next;
  30     /* Descriptor by which we read from this process */
  31     Lisp_Object infd;
  32     /* Descriptor by which we write to this process */
  33     Lisp_Object outfd;
  34     /* Descriptor for the tty which this process is using.
  35        nil if we didn't record it (on some systems, there's no need).  */
  36     Lisp_Object subtty;
  37     /* Name of subprocess terminal.  */
  38     Lisp_Object tty_name;
  39     /* Name of this process */
  40     Lisp_Object name;
  41     /* List of command arguments that this process was run with */
  42     Lisp_Object command;
  43     /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
  44        to dispose of a bunch of chars from the process all at once */
  45     Lisp_Object filter;
  46     /* (funcall SENTINEL PROCESS) when process state changes */
  47     Lisp_Object sentinel;
  48     /* Buffer that output is going to */
  49     Lisp_Object buffer;
  50     /* Number of this process */
  51     Lisp_Object pid;
  52     /* Non-nil if this is really a command channel */
  53     Lisp_Object command_channel_p;
  54     /* Non-nil if this is really a child process */
  55     Lisp_Object childp;
  56     /* Marker set to end of last buffer-inserted output from this process */
  57     Lisp_Object mark;
  58     /* Non-nil means kill silently if Emacs is exited.  */
  59     Lisp_Object kill_without_query;
  60     /* Record the process status in the raw form in which it comes from `wait'.
  61        This is to avoid consing in a signal handler.  */
  62     Lisp_Object raw_status_low;
  63     Lisp_Object raw_status_high;
  64     /* Symbol indicating status of process.
  65        This may be a symbol: run, open, or closed.
  66        Or it may be a list, whose car is stop, exit or signal
  67        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  68        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  69     Lisp_Object status;
  70     /* Non-nil if communicating through a pty.  */
  71     Lisp_Object pty_flag;
  72     /* Event-count of last event in which this process changed status.  */
  73     Lisp_Object tick;
  74     /* Event-count of last such event reported.  */
  75     Lisp_Object update_tick;
  76 };
  77
  78 #define ChannelMask(n) (1<<(n))
  79
  80 /* Indexed by descriptor, gives the process (if any) for that descriptor.  */
  81 extern Lisp_Object chan_process[];
  82
  83 /* Alist of elements (NAME . PROCESS).  */
  84 extern Lisp_Object Vprocess_alist;
  85
  86 /* True iff we are about to fork off a synchronous process or if we
  87    are waiting for it.  */
  88 extern int synch_process_alive;
  89
  90 /* Communicate exit status of synch process to from sigchld_handler
  91    to Fcall_process.  */
  92 extern int synch_process_retcode;
  93 extern char *synch_process_death;
  94
  95 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
  96 extern char *synch_process_death;
  97
  98 /* If synch_process_death is zero,
  99    this is exit code of synchronous subprocess.  */
 100 extern int synch_process_retcode;
 101
 102 /* The name of the file open to get a null file, or a data sink.
 103    VMS, MS-DOS, and OS/2 redefine this.  */
 104 #ifndef NULL_DEVICE
 105 #define NULL_DEVICE "/dev/null"
 106 #endif
 107
 108 /* A string listing the possible suffixes used for executable files,
 109    separated by colons.  VMS, MS-DOS, and OS/2 redefine this.  */
 110 #ifndef EXEC_SUFFIXES
 111 #define EXEC_SUFFIXES ""
 112 #endif