* src/casefiddle.c (casify_word): Return Qnil.
[emacs.git] / src / process.h
blob9926050b9c3659244a0d81e0a7c9421b4b32aab9
1 /* Definitions for asynchronous process control in GNU Emacs.
2 Copyright (C) 1985, 1994, 2001-2016 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
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 3 of the License, or (at
9 your option) any later version.
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.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
19 #ifndef EMACS_PROCESS_H
20 #define EMACS_PROCESS_H
22 #ifdef HAVE_SYS_TYPES_H
23 #include <sys/types.h>
24 #endif
26 #include <unistd.h>
28 #ifdef HAVE_GNUTLS
29 #include "gnutls.h"
30 #endif
32 INLINE_HEADER_BEGIN
34 /* Bound on number of file descriptors opened on behalf of a process,
35 that need to be closed. */
37 enum { PROCESS_OPEN_FDS = 6 };
39 /* This structure records information about a subprocess
40 or network connection. */
42 struct Lisp_Process
44 struct vectorlike_header header;
46 /* Name of subprocess terminal. */
47 Lisp_Object tty_name;
49 /* Name of this process. */
50 Lisp_Object name;
52 /* List of command arguments that this process was run with.
53 Is set to t for a stopped network process; nil otherwise. */
54 Lisp_Object command;
56 /* (funcall FILTER PROC STRING) (if FILTER is non-nil)
57 to dispose of a bunch of chars from the process all at once. */
58 Lisp_Object filter;
60 /* (funcall SENTINEL PROCESS) when process state changes. */
61 Lisp_Object sentinel;
63 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
64 accepts a connection from a client. */
65 Lisp_Object log;
67 /* Buffer that output is going to. */
68 Lisp_Object buffer;
70 /* t if this is a real child process. For a network or serial
71 connection, it is a plist based on the arguments to
72 make-network-process or make-serial-process. */
74 Lisp_Object childp;
76 /* Plist for programs to keep per-process state information, parameters, etc. */
77 Lisp_Object plist;
79 /* Symbol indicating the type of process: real, network, serial. */
80 Lisp_Object type;
82 /* Marker set to end of last buffer-inserted output from this process. */
83 Lisp_Object mark;
85 /* Symbol indicating status of process.
86 This may be a symbol: run, open, closed, listen, or failed.
87 Or it may be a pair (connect . ADDRINFOS) where ADDRINFOS is
88 a list of remaining (PROTOCOL . ADDRINFO) pairs to try.
89 Or it may be (failed ERR) where ERR is an integer, string or symbol.
90 Or it may be a list, whose car is stop, exit or signal
91 and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
92 or (SIGNAL_NUMBER . COREDUMP_FLAG). */
93 Lisp_Object status;
95 /* Coding-system for decoding the input from this process. */
96 Lisp_Object decode_coding_system;
98 /* Working buffer for decoding. */
99 Lisp_Object decoding_buf;
101 /* Coding-system for encoding the output to this process. */
102 Lisp_Object encode_coding_system;
104 /* Working buffer for encoding. */
105 Lisp_Object encoding_buf;
107 /* Queue for storing waiting writes. */
108 Lisp_Object write_queue;
110 #ifdef HAVE_GNUTLS
111 Lisp_Object gnutls_cred_type;
112 Lisp_Object gnutls_boot_parameters;
113 #endif
115 /* Pipe process attached to the standard error of this process. */
116 Lisp_Object stderrproc;
118 /* After this point, there are no Lisp_Objects any more. */
119 /* alloc.c assumes that `pid' is the first such non-Lisp slot. */
121 /* Process ID. A positive value is a child process ID.
122 Zero is for pseudo-processes such as network or serial connections,
123 or for processes that have not been fully created yet.
124 -1 is for a process that was not created successfully.
125 -2 is for a pty with no process, e.g., for GDB. */
126 pid_t pid;
127 /* Descriptor by which we read from this process. */
128 int infd;
129 /* Descriptor by which we write to this process. */
130 int outfd;
131 /* Descriptors that were created for this process and that need
132 closing. Unused entries are negative. */
133 int open_fd[PROCESS_OPEN_FDS];
134 /* Event-count of last event in which this process changed status. */
135 EMACS_INT tick;
136 /* Event-count of last such event reported. */
137 EMACS_INT update_tick;
138 /* Size of carryover in decoding. */
139 int decoding_carryover;
140 /* Hysteresis to try to read process output in larger blocks.
141 On some systems, e.g. GNU/Linux, Emacs is seen as
142 an interactive app also when reading process output, meaning
143 that process output can be read in as little as 1 byte at a
144 time. Value is nanoseconds to delay reading output from
145 this process. Range is 0 .. 50 * 1000 * 1000. */
146 int read_output_delay;
147 /* Should we delay reading output from this process.
148 Initialized from `Vprocess_adaptive_read_buffering'.
149 0 = nil, 1 = t, 2 = other. */
150 unsigned int adaptive_read_buffering : 2;
151 /* Skip reading this process on next read. */
152 bool_bf read_output_skip : 1;
153 /* True means kill silently if Emacs is exited.
154 This is the inverse of the `query-on-exit' flag. */
155 bool_bf kill_without_query : 1;
156 /* True if communicating through a pty. */
157 bool_bf pty_flag : 1;
158 /* Flag to set coding-system of the process buffer from the
159 coding_system used to decode process output. */
160 bool_bf inherit_coding_system_flag : 1;
161 /* Whether the process is alive, i.e., can be waited for. Running
162 processes can be waited for, but exited and fake processes cannot. */
163 bool_bf alive : 1;
164 /* Record the process status in the raw form in which it comes from `wait'.
165 This is to avoid consing in a signal handler. The `raw_status_new'
166 flag indicates that `raw_status' contains a new status that still
167 needs to be synced to `status'. */
168 bool_bf raw_status_new : 1;
169 /* Whether this is a nonblocking socket. */
170 bool_bf is_non_blocking_client : 1;
171 /* Whether this is a server or a client socket. */
172 bool_bf is_server : 1;
173 int raw_status;
174 /* The length of the socket backlog. */
175 int backlog;
176 /* The port number. */
177 int port;
178 /* The socket type. */
179 int socktype;
181 #ifdef HAVE_GETADDRINFO_A
182 /* Whether the socket is waiting for response from an asynchronous
183 DNS call. */
184 struct gaicb *dns_request;
185 #endif
187 #ifdef HAVE_GNUTLS
188 gnutls_initstage_t gnutls_initstage;
189 gnutls_session_t gnutls_state;
190 gnutls_certificate_client_credentials gnutls_x509_cred;
191 gnutls_anon_client_credentials_t gnutls_anon_cred;
192 gnutls_x509_crt_t gnutls_certificate;
193 unsigned int gnutls_peer_verification;
194 unsigned int gnutls_extra_peer_verification;
195 int gnutls_log_level;
196 int gnutls_handshakes_tried;
197 bool_bf gnutls_p : 1;
198 bool_bf gnutls_complete_negotiation_p : 1;
199 #endif
202 /* Every field in the preceding structure except for the first two
203 must be a Lisp_Object, for GC's sake. */
205 #define ChannelMask(n) (1 << (n))
207 /* Most code should use these functions to set Lisp fields in struct
208 process. */
210 INLINE void
211 pset_childp (struct Lisp_Process *p, Lisp_Object val)
213 p->childp = val;
216 INLINE void
217 pset_status (struct Lisp_Process *p, Lisp_Object val)
219 p->status = val;
222 #ifdef HAVE_GNUTLS
223 INLINE void
224 pset_gnutls_cred_type (struct Lisp_Process *p, Lisp_Object val)
226 p->gnutls_cred_type = val;
228 #endif
230 /* True means don't run process sentinels. This is used
231 when exiting. */
232 extern bool inhibit_sentinels;
234 /* Exit statuses for GNU programs that exec other programs. */
235 enum
237 EXIT_CANCELED = 125, /* Internal error prior to exec attempt. */
238 EXIT_CANNOT_INVOKE = 126, /* Program located, but not usable. */
239 EXIT_ENOENT = 127 /* Could not find program to exec. */
242 /* Defined in callproc.c. */
244 extern Lisp_Object encode_current_directory (void);
245 extern void record_kill_process (struct Lisp_Process *, Lisp_Object);
247 /* Defined in sysdep.c. */
249 extern Lisp_Object list_system_processes (void);
250 extern Lisp_Object system_process_attributes (Lisp_Object);
252 /* Defined in process.c. */
254 extern void record_deleted_pid (pid_t, Lisp_Object);
255 struct sockaddr;
256 extern Lisp_Object conv_sockaddr_to_lisp (struct sockaddr *, ptrdiff_t);
257 extern void hold_keyboard_input (void);
258 extern void unhold_keyboard_input (void);
259 extern bool kbd_on_hold_p (void);
261 typedef void (*fd_callback) (int fd, void *data);
263 extern void add_read_fd (int fd, fd_callback func, void *data);
264 extern void delete_read_fd (int fd);
265 extern void add_write_fd (int fd, fd_callback func, void *data);
266 extern void delete_write_fd (int fd);
267 extern void catch_child_signal (void);
269 #ifdef WINDOWSNT
270 extern Lisp_Object network_interface_list (void);
271 extern Lisp_Object network_interface_info (Lisp_Object);
272 #endif
274 extern Lisp_Object remove_slash_colon (Lisp_Object);
276 INLINE_HEADER_END
278 #endif /* EMACS_PROCESS_H */