Commit | Line | Data |
---|---|---|
92d97f2c | 1 | /* Definitions for asynchronous process control in GNU Emacs. |
0b5538bd | 2 | Copyright (C) 1985, 1994, 2002, 2003, 2004, |
aaef169d | 3 | 2005, 2006 Free Software Foundation, Inc. |
92d97f2c JB |
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 | |
7c938215 | 9 | the Free Software Foundation; either version 2, or (at your option) |
92d97f2c JB |
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 | |
4fc5845f LK |
19 | the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
20 | Boston, MA 02110-1301, USA. */ | |
92d97f2c JB |
21 | |
22 | ||
2ba993db RS |
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. */ | |
92d97f2c JB |
28 | |
29 | struct Lisp_Process | |
30 | { | |
776332c4 | 31 | EMACS_INT size; |
92d97f2c JB |
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; | |
93103d17 RS |
37 | /* Name of subprocess terminal. */ |
38 | Lisp_Object tty_name; | |
92d97f2c JB |
39 | /* Name of this process */ |
40 | Lisp_Object name; | |
cfa955c2 KS |
41 | /* List of command arguments that this process was run with. |
42 | Is set to t for a stopped network process; nil otherwise. */ | |
92d97f2c JB |
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; | |
cfa955c2 KS |
49 | /* (funcall LOG SERVER CLIENT MESSAGE) when a server process |
50 | accepts a connection from a client. */ | |
51 | Lisp_Object log; | |
92d97f2c JB |
52 | /* Buffer that output is going to */ |
53 | Lisp_Object buffer; | |
217666dd | 54 | /* t if this is a real child process. |
cfa955c2 | 55 | For a net connection, it is a plist based on the arguments to make-network-process. */ |
92d97f2c | 56 | Lisp_Object childp; |
59be51d7 KS |
57 | /* Plist for programs to keep per-process state information, parameters, etc. */ |
58 | Lisp_Object plist; | |
92d97f2c JB |
59 | /* Marker set to end of last buffer-inserted output from this process */ |
60 | Lisp_Object mark; | |
cfa955c2 KS |
61 | /* Non-nil means kill silently if Emacs is exited. |
62 | This is the inverse of the `query-on-exit' flag. */ | |
92d97f2c | 63 | Lisp_Object kill_without_query; |
92d97f2c JB |
64 | /* Symbol indicating status of process. |
65 | This may be a symbol: run, open, or closed. | |
66 | Or it may be a list, whose car is stop, exit or signal | |
67 | and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG) | |
68 | or (SIGNAL_NUMBER . COREDUMP_FLAG). */ | |
69 | Lisp_Object status; | |
70 | /* Non-nil if communicating through a pty. */ | |
71 | Lisp_Object pty_flag; | |
72 | /* Event-count of last event in which this process changed status. */ | |
73 | Lisp_Object tick; | |
74 | /* Event-count of last such event reported. */ | |
75 | Lisp_Object update_tick; | |
3b92c4f5 KH |
76 | /* Coding-system for decoding the input from this process. */ |
77 | Lisp_Object decode_coding_system; | |
78 | /* Working buffer for decoding. */ | |
79 | Lisp_Object decoding_buf; | |
095d64ee KH |
80 | /* Size of carryover in decoding. */ |
81 | Lisp_Object decoding_carryover; | |
3b92c4f5 KH |
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; | |
095d64ee KH |
86 | /* Size of carryover in encoding. */ |
87 | Lisp_Object encoding_carryover; | |
8d051ef1 EZ |
88 | /* Flag to set coding-system of the process buffer from the |
89 | coding_system used to decode process output. */ | |
2ba993db | 90 | Lisp_Object inherit_coding_system_flag; |
56533d51 KH |
91 | /* Flat to decide the multibyteness of a string given to the |
92 | filter (if any). It is initialized to the value of | |
93 | `default-enable-multibyte-characters' when the process is | |
94 | generated, and can be changed by the function | |
95 | `set-process-fileter-multibyte'. */ | |
96 | Lisp_Object filter_multibyte; | |
2ba4be11 KS |
97 | /* Should we delay reading output from this process. |
98 | Initialized from `Vprocess_adaptive_read_buffering'. */ | |
99 | Lisp_Object adaptive_read_buffering; | |
100 | /* Hysteresis to try to read process output in larger blocks. | |
638322a4 | 101 | On some systems, e.g. GNU/Linux, Emacs is seen as |
2ba4be11 KS |
102 | an interactive app also when reading process output, meaning |
103 | that process output can be read in as little as 1 byte at a | |
104 | time. Value is micro-seconds to delay reading output from | |
105 | this process. Range is 0 .. 50000. */ | |
106 | Lisp_Object read_output_delay; | |
107 | /* Skip reading this process on next read. */ | |
108 | Lisp_Object read_output_skip; | |
6bfd98e7 SM |
109 | |
110 | /* After this point, there are no Lisp_Objects any more. */ | |
111 | ||
112 | /* Number of this process. | |
113 | allocate_process assumes this is the first non-Lisp_Object field. | |
114 | A value 0 is used for pseudo-processes such as network connections. */ | |
115 | pid_t pid; | |
116 | /* Record the process status in the raw form in which it comes from `wait'. | |
117 | This is to avoid consing in a signal handler. The `raw_status_new' | |
118 | flag indicates that `raw_status' contains a new status that still | |
119 | needs to be synced to `status'. */ | |
120 | int raw_status_new : 1; | |
121 | int raw_status; | |
92d97f2c JB |
122 | }; |
123 | ||
2ba993db RS |
124 | /* Every field in the preceding structure except for the first two |
125 | must be a Lisp_Object, for GC's sake. */ | |
126 | ||
92d97f2c JB |
127 | #define ChannelMask(n) (1<<(n)) |
128 | ||
fcf84876 | 129 | /* Indexed by descriptor, gives the process (if any) for that descriptor. */ |
b28e2cc6 | 130 | extern Lisp_Object chan_process[]; |
fcf84876 RS |
131 | |
132 | /* Alist of elements (NAME . PROCESS). */ | |
133 | extern Lisp_Object Vprocess_alist; | |
134 | ||
92d97f2c JB |
135 | /* True iff we are about to fork off a synchronous process or if we |
136 | are waiting for it. */ | |
137 | extern int synch_process_alive; | |
138 | ||
8e6208c5 | 139 | /* Communicate exit status of sync process to from sigchld_handler |
7a04feb0 | 140 | to Fcall_process. */ |
7a04feb0 | 141 | |
92d97f2c JB |
142 | /* Nonzero => this is a string explaining death of synchronous subprocess. */ |
143 | extern char *synch_process_death; | |
144 | ||
b0c681e2 | 145 | /* Nonzero => this is the signal number that terminated the subprocess. */ |
eb37b8fd | 146 | extern int synch_process_termsig; |
b0c681e2 | 147 | |
92d97f2c JB |
148 | /* If synch_process_death is zero, |
149 | this is exit code of synchronous subprocess. */ | |
150 | extern int synch_process_retcode; | |
151 | ||
5437e9f9 JB |
152 | /* The name of the file open to get a null file, or a data sink. |
153 | VMS, MS-DOS, and OS/2 redefine this. */ | |
154 | #ifndef NULL_DEVICE | |
155 | #define NULL_DEVICE "/dev/null" | |
156 | #endif | |
ab5796a9 MB |
157 | |
158 | /* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72 | |
159 | (do not change this comment) */ |