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 /* This structure records information about a subprocess
  23    or network connection.
  24
  25    Every field in this structure except for the first two
  26    must be a Lisp_Object, for GC's sake.  */
  27
  28 struct Lisp_Process
  29   {
  30     EMACS_INT size;
  31     struct Lisp_Vector *v_next;
  32     /* Descriptor by which we read from this process */
  33     Lisp_Object infd;
  34     /* Descriptor by which we write to this process */
  35     Lisp_Object outfd;
  36     /* Name of subprocess terminal.  */
  37     Lisp_Object tty_name;
  38     /* Name of this process */
  39     Lisp_Object name;
  40     /* List of command arguments that this process was run with.
  41        Is set to t for a stopped network process; nil otherwise. */
  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     /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
  49        accepts a connection from a client.  */
  50     Lisp_Object log;
  51     /* Buffer that output is going to */
  52     Lisp_Object buffer;
  53     /* Number of this process */
  54     Lisp_Object pid;
  55     /* Non-nil if this is really a command channel */
  56     Lisp_Object command_channel_p;
  57     /* t if this is a real child process.
  58        For a net connection, it is a plist based on the arguments to make-network-process.  */
  59     Lisp_Object childp;
  60     /* Plist for programs to keep per-process state information, parameters, etc.  */
  61     Lisp_Object plist;
  62     /* Marker set to end of last buffer-inserted output from this process */
  63     Lisp_Object mark;
  64     /* Non-nil means kill silently if Emacs is exited.
  65        This is the inverse of the `query-on-exit' flag.  */
  66     Lisp_Object kill_without_query;
  67     /* Record the process status in the raw form in which it comes from `wait'.
  68        This is to avoid consing in a signal handler.  */
  69     Lisp_Object raw_status_low;
  70     Lisp_Object raw_status_high;
  71     /* Symbol indicating status of process.
  72        This may be a symbol: run, open, or closed.
  73        Or it may be a list, whose car is stop, exit or signal
  74        and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
  75        or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
  76     Lisp_Object status;
  77     /* Non-nil if communicating through a pty.  */
  78     Lisp_Object pty_flag;
  79     /* Event-count of last event in which this process changed status.  */
  80     Lisp_Object tick;
  81     /* Event-count of last such event reported.  */
  82     Lisp_Object update_tick;
  83     /* Coding-system for decoding the input from this process.  */
  84     Lisp_Object decode_coding_system;
  85     /* Working buffer for decoding.  */
  86     Lisp_Object decoding_buf;
  87     /* Size of carryover in decoding.  */
  88     Lisp_Object decoding_carryover;
  89     /* Coding-system for encoding the output to this process.  */
  90     Lisp_Object encode_coding_system;
  91     /* Working buffer for encoding.  */
  92     Lisp_Object encoding_buf;
  93     /* Size of carryover in encoding.  */
  94     Lisp_Object encoding_carryover;
  95     /* Flag to set coding-system of the process buffer from the
  96        coding_system used to decode process output.  */
  97     Lisp_Object inherit_coding_system_flag;
  98     /* Flat to decide the multibyteness of a string given to the
  99        filter (if any).  It is initialized to the value of
 100        `default-enable-multibyte-characters' when the process is
 101        generated, and can be changed by the function
 102        `set-process-fileter-multibyte'. */
 103     Lisp_Object filter_multibyte;
 104     /* Should we delay reading output from this process.
 105        Initialized from `Vprocess_adaptive_read_buffering'.  */
 106     Lisp_Object adaptive_read_buffering;
 107     /* Hysteresis to try to read process output in larger blocks.
 108        On some systems, e.g. the Linux kernel, emacs is seen as
 109        an interactive app also when reading process output, meaning
 110        that process output can be read in as little as 1 byte at a
 111        time.  Value is micro-seconds to delay reading output from
 112        this process.  Range is 0 .. 50000.  */
 113     Lisp_Object read_output_delay;
 114     /* Skip reading this process on next read.  */
 115     Lisp_Object read_output_skip;
 116 };
 117
 118 /* Every field in the preceding structure except for the first two
 119    must be a Lisp_Object, for GC's sake.  */
 120
 121 #define ChannelMask(n) (1<<(n))
 122
 123 /* Indexed by descriptor, gives the process (if any) for that descriptor.  */
 124 extern Lisp_Object chan_process[];
 125
 126 /* Alist of elements (NAME . PROCESS).  */
 127 extern Lisp_Object Vprocess_alist;
 128
 129 /* True iff we are about to fork off a synchronous process or if we
 130    are waiting for it.  */
 131 extern int synch_process_alive;
 132
 133 /* Communicate exit status of sync process to from sigchld_handler
 134    to Fcall_process.  */
 135
 136 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
 137 extern char *synch_process_death;
 138
 139 /* Nonzero => this is the signal number that terminated the subprocess.  */
 140 extern int synch_process_termsig;
 141
 142 /* If synch_process_death is zero,
 143    this is exit code of synchronous subprocess.  */
 144 extern int synch_process_retcode;
 145
 146 /* The name of the file open to get a null file, or a data sink.
 147    VMS, MS-DOS, and OS/2 redefine this.  */
 148 #ifndef NULL_DEVICE
 149 #define NULL_DEVICE "/dev/null"
 150 #endif
 151
 152 /* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72
 153    (do not change this comment) */