annotate src/process.h @ 45625:28f0b229040c

Initial revision
author Thien-Thi Nguyen <ttn@gnuvola.org>
date Mon, 03 Jun 2002 03:15:34 +0000
parents 7e0389460d9d
children 5697f31e3ca6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
1 /* Definitions for asynchronous process control in GNU Emacs.
7307
cd81dba38a49 Update copyright.
Karl Heuer <kwzh@gnu.org>
parents: 6191
diff changeset
2 Copyright (C) 1985, 1994 Free Software Foundation, Inc.
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
3
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
4 This file is part of GNU Emacs.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
5
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
6 GNU Emacs is free software; you can redistribute it and/or modify
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
7 it under the terms of the GNU General Public License as published by
12244
ac7375e60931 Update GPL to version 2.
Karl Heuer <kwzh@gnu.org>
parents: 10286
diff changeset
8 the Free Software Foundation; either version 2, or (at your option)
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
9 any later version.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
10
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
11 GNU Emacs is distributed in the hope that it will be useful,
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
14 GNU General Public License for more details.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
15
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
17 along with GNU Emacs; see the file COPYING. If not, write to
14186
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 14036
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
ee40177f6c68 Update FSF's address in the preamble.
Erik Naggum <erik@naggum.no>
parents: 14036
diff changeset
19 Boston, MA 02111-1307, USA. */
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
20
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
21
21849
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
22 /* This structure records information about a subprocess
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
23 or network connection.
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
24
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
25 Every field in this structure except for the first two
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
26 must be a Lisp_Object, for GC's sake. */
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
27
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
28 struct Lisp_Process
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
29 {
10286
5689759b9329 Make size field an EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents: 8888
diff changeset
30 EMACS_INT size;
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
31 struct Lisp_Vector *v_next;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
32 /* Descriptor by which we read from this process */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
33 Lisp_Object infd;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
34 /* Descriptor by which we write to this process */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
35 Lisp_Object outfd;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
36 /* Descriptor for the tty which this process is using.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
37 nil if we didn't record it (on some systems, there's no need). */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
38 Lisp_Object subtty;
8888
84527c2d9f75 (struct process): New field tty_name.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
39 /* Name of subprocess terminal. */
84527c2d9f75 (struct process): New field tty_name.
Richard M. Stallman <rms@gnu.org>
parents: 7307
diff changeset
40 Lisp_Object tty_name;
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
41 /* Name of this process */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
42 Lisp_Object name;
43967
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
43 /* List of command arguments that this process was run with.
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
44 Is set to t for a stopped network process; nil otherwise. */
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
45 Lisp_Object command;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
46 /* (funcall FILTER PROC STRING) (if FILTER is non-nil)
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
47 to dispose of a bunch of chars from the process all at once */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
48 Lisp_Object filter;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
49 /* (funcall SENTINEL PROCESS) when process state changes */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
50 Lisp_Object sentinel;
43967
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
51 /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
52 accepts a connection from a client. */
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
53 Lisp_Object log;
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
54 /* Buffer that output is going to */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
55 Lisp_Object buffer;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
56 /* Number of this process */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
57 Lisp_Object pid;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
58 /* Non-nil if this is really a command channel */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
59 Lisp_Object command_channel_p;
16059
ad4cd2505623 Comment change.
Richard M. Stallman <rms@gnu.org>
parents: 14451
diff changeset
60 /* t if this is a real child process.
43967
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
61 For a net connection, it is a plist based on the arguments to make-network-process. */
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
62 Lisp_Object childp;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
63 /* Marker set to end of last buffer-inserted output from this process */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
64 Lisp_Object mark;
43967
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
65 /* Non-nil means kill silently if Emacs is exited.
7e0389460d9d (struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents: 39935
diff changeset
66 This is the inverse of the `query-on-exit' flag. */
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
67 Lisp_Object kill_without_query;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
68 /* Record the process status in the raw form in which it comes from `wait'.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
69 This is to avoid consing in a signal handler. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
70 Lisp_Object raw_status_low;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
71 Lisp_Object raw_status_high;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
72 /* Symbol indicating status of process.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
73 This may be a symbol: run, open, or closed.
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
74 Or it may be a list, whose car is stop, exit or signal
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
75 and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
76 or (SIGNAL_NUMBER . COREDUMP_FLAG). */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
77 Lisp_Object status;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
78 /* Non-nil if communicating through a pty. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
79 Lisp_Object pty_flag;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
80 /* Event-count of last event in which this process changed status. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
81 Lisp_Object tick;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
82 /* Event-count of last such event reported. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
83 Lisp_Object update_tick;
17042
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
84 /* Coding-system for decoding the input from this process. */
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
85 Lisp_Object decode_coding_system;
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
86 /* Working buffer for decoding. */
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
87 Lisp_Object decoding_buf;
20714
ead6c5a556e1 (struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents: 17042
diff changeset
88 /* Size of carryover in decoding. */
ead6c5a556e1 (struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents: 17042
diff changeset
89 Lisp_Object decoding_carryover;
17042
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
90 /* Coding-system for encoding the output to this process. */
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
91 Lisp_Object encode_coding_system;
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
92 /* Working buffer for encoding. */
00b923d54108 (struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents: 16059
diff changeset
93 Lisp_Object encoding_buf;
20714
ead6c5a556e1 (struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents: 17042
diff changeset
94 /* Size of carryover in encoding. */
ead6c5a556e1 (struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents: 17042
diff changeset
95 Lisp_Object encoding_carryover;
21657
373f809e0b95 (struct Lisp_Process): Add inherit_coding_system_flag member.
Eli Zaretskii <eliz@gnu.org>
parents: 20714
diff changeset
96 /* Flag to set coding-system of the process buffer from the
373f809e0b95 (struct Lisp_Process): Add inherit_coding_system_flag member.
Eli Zaretskii <eliz@gnu.org>
parents: 20714
diff changeset
97 coding_system used to decode process output. */
21849
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
98 Lisp_Object inherit_coding_system_flag;
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
99 };
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
100
21849
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
101 /* Every field in the preceding structure except for the first two
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
102 must be a Lisp_Object, for GC's sake. */
96fd475a324d (struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents: 21657
diff changeset
103
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
104 #define ChannelMask(n) (1<<(n))
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
105
6165
9c0cc4128da8 (chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 2432
diff changeset
106 /* Indexed by descriptor, gives the process (if any) for that descriptor. */
6191
84fc456177e2 (chan_process): Don't specify size.
Karl Heuer <kwzh@gnu.org>
parents: 6165
diff changeset
107 extern Lisp_Object chan_process[];
6165
9c0cc4128da8 (chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 2432
diff changeset
108
9c0cc4128da8 (chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 2432
diff changeset
109 /* Alist of elements (NAME . PROCESS). */
9c0cc4128da8 (chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 2432
diff changeset
110 extern Lisp_Object Vprocess_alist;
9c0cc4128da8 (chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents: 2432
diff changeset
111
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
112 /* True iff we are about to fork off a synchronous process or if we
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
113 are waiting for it. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
114 extern int synch_process_alive;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
115
14036
621a575db6f7 Comment fixes.
Karl Heuer <kwzh@gnu.org>
parents: 12244
diff changeset
116 /* Communicate exit status of sync process to from sigchld_handler
546
c10a468c6203 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 365
diff changeset
117 to Fcall_process. */
c10a468c6203 entered into RCS
Jim Blandy <jimb@redhat.com>
parents: 365
diff changeset
118
365
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
119 /* Nonzero => this is a string explaining death of synchronous subprocess. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
120 extern char *synch_process_death;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
121
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
122 /* If synch_process_death is zero,
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
123 this is exit code of synchronous subprocess. */
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
124 extern int synch_process_retcode;
cba0546ba47c Initial revision
Jim Blandy <jimb@redhat.com>
parents:
diff changeset
125
2432
17a84e60603b New macros NULL_DEVICE and EXEC_SUFFIXES, to give the name of the
Jim Blandy <jimb@redhat.com>
parents: 546
diff changeset
126 /* The name of the file open to get a null file, or a data sink.
17a84e60603b New macros NULL_DEVICE and EXEC_SUFFIXES, to give the name of the
Jim Blandy <jimb@redhat.com>
parents: 546
diff changeset
127 VMS, MS-DOS, and OS/2 redefine this. */
17a84e60603b New macros NULL_DEVICE and EXEC_SUFFIXES, to give the name of the
Jim Blandy <jimb@redhat.com>
parents: 546
diff changeset
128 #ifndef NULL_DEVICE
17a84e60603b New macros NULL_DEVICE and EXEC_SUFFIXES, to give the name of the
Jim Blandy <jimb@redhat.com>
parents: 546
diff changeset
129 #define NULL_DEVICE "/dev/null"
17a84e60603b New macros NULL_DEVICE and EXEC_SUFFIXES, to give the name of the
Jim Blandy <jimb@redhat.com>
parents: 546
diff changeset
130 #endif