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, Inc., 59 Temple Place - Suite 330,
  19 Boston, MA 02111-1307, USA.  */
  20
  21
  22 /*
  23  * Structure records pertinent information about open channels.
  24  * There is one channel associated with each process.
  25  */
  26
  27 struct Lisp_Process
  28   {
  29     EMACS_INT size;
  30     struct Lisp_Vector *v_next;
  31     /* Descriptor by which we read from this process */
  32     Lisp_Object infd;
  33     /* Descriptor by which we write to this process */
  34     Lisp_Object outfd;
  35     /* Descriptor for the tty which this process is using.
  36        nil if we didn't record it (on some systems, there's no need).  */
  37     Lisp_Object subtty;
  38     /* Name of subprocess terminal.  */
  39     Lisp_Object tty_name;
  40     /* Name of this process */
  41     Lisp_Object name;
  42     /* List of command arguments that this process was run with */
  43     Lisp_Object command;
  44     /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
  45        to dispose of a bunch of chars from the process all at once */
  46     Lisp_Object filter;
  47     /* (funcall SENTINEL PROCESS) when process state changes */
  48     Lisp_Object sentinel;
  49     /* Buffer that output is going to */
  50     Lisp_Object buffer;
  51     /* Number of this process */
  52     Lisp_Object pid;
  53     /* Non-nil if this is really a command channel */
  54     Lisp_Object command_channel_p;
  55     /* t if this is a real child process.
  56        For a net connection, it is (HOST SERVICE).  */
  57     Lisp_Object childp;
  58     /* Marker set to end of last buffer-inserted output from this process */
  59     Lisp_Object mark;
  60     /* Non-nil means kill silently if Emacs is exited.  */
  61     Lisp_Object kill_without_query;
  62     /* Record the process status in the raw form in which it comes from `wait'.
  63        This is to avoid consing in a signal handler.  */
  64     Lisp_Object raw_status_low;
  65     Lisp_Object raw_status_high;
  66     /* Symbol indicating status of process.
  67        This may be a symbol: run, open, or closed.
  68        Or it may be a list, whose car is stop, exit or signal
  69        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  70        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  71     Lisp_Object status;
  72     /* Non-nil if communicating through a pty.  */
  73     Lisp_Object pty_flag;
  74     /* Event-count of last event in which this process changed status.  */
  75     Lisp_Object tick;
  76     /* Event-count of last such event reported.  */
  77     Lisp_Object update_tick;
  78     /* Coding-system for decoding the input from this process.  */
  79     Lisp_Object decode_coding_system;
  80     /* Working buffer for decoding.  */
  81     Lisp_Object decoding_buf;
  82     /* Coding-system for encoding the output to this process.  */
  83     Lisp_Object encode_coding_system;
  84     /* Working buffer for encoding.  */
  85     Lisp_Object encoding_buf;
  86 };
  87
  88 #define ChannelMask(n) (1<<(n))
  89
  90 /* Indexed by descriptor, gives the process (if any) for that descriptor.  */
  91 extern Lisp_Object chan_process[];
  92
  93 /* Alist of elements (NAME . PROCESS).  */
  94 extern Lisp_Object Vprocess_alist;
  95
  96 /* True iff we are about to fork off a synchronous process or if we
  97    are waiting for it.  */
  98 extern int synch_process_alive;
  99
 100 /* Communicate exit status of sync process to from sigchld_handler
 101    to Fcall_process.  */
 102
 103 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
 104 extern char *synch_process_death;
 105
 106 /* If synch_process_death is zero,
 107    this is exit code of synchronous subprocess.  */
 108 extern int synch_process_retcode;
 109
 110 /* The name of the file open to get a null file, or a data sink.
 111    VMS, MS-DOS, and OS/2 redefine this.  */
 112 #ifndef NULL_DEVICE
 113 #define NULL_DEVICE "/dev/null"
 114 #endif
 115
 116 /* A string listing the possible suffixes used for executable files,
 117    separated by colons.  VMS, MS-DOS, and OS/2 redefine this.  */
 118 #ifndef EXEC_SUFFIXES
 119 #define EXEC_SUFFIXES ""
 120 #endif