src/process.h

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