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