1/* Definitions for asynchronous process control in GNU Emacs. 2 Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004, 3 2005, 2006, 2007 Free Software Foundation, Inc. 4 5This file is part of GNU Emacs. 6 7GNU Emacs is free software; you can redistribute it and/or modify 8it under the terms of the GNU General Public License as published by 9the Free Software Foundation; either version 2, or (at your option) 10any later version. 11 12GNU Emacs is distributed in the hope that it will be useful, 13but WITHOUT ANY WARRANTY; without even the implied warranty of 14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 15GNU General Public License for more details. 16 17You should have received a copy of the GNU General Public License 18along with GNU Emacs; see the file COPYING. If not, write to 19the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, 20Boston, MA 02110-1301, USA. */ 21 22#ifdef HAVE_SYS_TYPES_H 23#include <sys/types.h> 24#endif 25#ifdef HAVE_UNISTD_H 26#include <unistd.h> 27#endif 28 29/* This structure records information about a subprocess 30 or network connection. 31 32 Every field in this structure except for the first two 33 must be a Lisp_Object, for GC's sake. */ 34 35struct Lisp_Process 36 { 37 EMACS_INT size; 38 struct Lisp_Vector *v_next; 39 /* Descriptor by which we read from this process */ 40 Lisp_Object infd; 41 /* Descriptor by which we write to this process */ 42 Lisp_Object outfd; 43 /* Name of subprocess terminal. */ 44 Lisp_Object tty_name; 45 /* Name of this process */ 46 Lisp_Object name; 47 /* List of command arguments that this process was run with. 48 Is set to t for a stopped network process; nil otherwise. */ 49 Lisp_Object command; 50 /* (funcall FILTER PROC STRING) (if FILTER is non-nil) 51 to dispose of a bunch of chars from the process all at once */ 52 Lisp_Object filter; 53 /* (funcall SENTINEL PROCESS) when process state changes */ 54 Lisp_Object sentinel; 55 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process 56 accepts a connection from a client. */ 57 Lisp_Object log; 58 /* Buffer that output is going to */ 59 Lisp_Object buffer; 60 /* t if this is a real child process. 61 For a net connection, it is a plist based on the arguments to make-network-process. */ 62 Lisp_Object childp; 63 /* Plist for programs to keep per-process state information, parameters, etc. */ 64 Lisp_Object plist; 65 /* Marker set to end of last buffer-inserted output from this process */ 66 Lisp_Object mark; 67 /* Non-nil means kill silently if Emacs is exited. 68 This is the inverse of the `query-on-exit' flag. */ 69 Lisp_Object kill_without_query; 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 /* After this point, there are no Lisp_Objects any more. */ 117 118 /* Number of this process. 119 allocate_process assumes this is the first non-Lisp_Object field. 120 A value 0 is used for pseudo-processes such as network connections. */ 121 pid_t pid; 122 /* Record the process status in the raw form in which it comes from `wait'. 123 This is to avoid consing in a signal handler. The `raw_status_new' 124 flag indicates that `raw_status' contains a new status that still 125 needs to be synced to `status'. */ 126 int raw_status_new : 1; 127 int raw_status; 128}; 129 130/* Every field in the preceding structure except for the first two 131 must be a Lisp_Object, for GC's sake. */ 132 133#define ChannelMask(n) (1<<(n)) 134 135/* Indexed by descriptor, gives the process (if any) for that descriptor. */ 136extern Lisp_Object chan_process[]; 137 138/* Alist of elements (NAME . PROCESS). */ 139extern Lisp_Object Vprocess_alist; 140 141/* True iff we are about to fork off a synchronous process or if we 142 are waiting for it. */ 143extern int synch_process_alive; 144 145/* Communicate exit status of sync process to from sigchld_handler 146 to Fcall_process. */ 147 148/* Nonzero => this is a string explaining death of synchronous subprocess. */ 149extern char *synch_process_death; 150 151/* Nonzero => this is the signal number that terminated the subprocess. */ 152extern int synch_process_termsig; 153 154/* If synch_process_death is zero, 155 this is exit code of synchronous subprocess. */ 156extern int synch_process_retcode; 157 158/* The name of the file open to get a null file, or a data sink. 159 VMS, MS-DOS, and OS/2 redefine this. */ 160#ifndef NULL_DEVICE 161#define NULL_DEVICE "/dev/null" 162#endif 163 164/* Nonzero means don't run process sentinels. This is used 165 when exiting. */ 166extern int inhibit_sentinels; 167 168/* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72 169 (do not change this comment) */ 170