Mercurial > emacs
annotate src/process.h @ 77471:be6b2b081602
Whitespace change.
author | Luc Teirlinck <teirllm@auburn.edu> |
---|---|
date | Tue, 24 Apr 2007 00:10:21 +0000 |
parents | e90d04cd455a |
children | 922696f363b0 077a1e6fd3f2 95d0cdf160ea |
rev | line source |
---|---|
365 | 1 /* Definitions for asynchronous process control in GNU Emacs. |
75227
e90d04cd455a
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
72726
diff
changeset
|
2 Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004, |
e90d04cd455a
Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents:
72726
diff
changeset
|
3 2005, 2006, 2007 Free Software Foundation, Inc. |
365 | 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 | |
12244 | 9 the Free Software Foundation; either version 2, or (at your option) |
365 | 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 | |
64084 | 19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
20 Boston, MA 02110-1301, USA. */ | |
365 | 21 |
70209
7077caf6dc5a
Include headers for pid_t.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
69873
diff
changeset
|
22 #ifdef HAVE_SYS_TYPES_H |
7077caf6dc5a
Include headers for pid_t.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
69873
diff
changeset
|
23 #include <sys/types.h> |
7077caf6dc5a
Include headers for pid_t.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
69873
diff
changeset
|
24 #endif |
7077caf6dc5a
Include headers for pid_t.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
69873
diff
changeset
|
25 #ifdef HAVE_UNISTD_H |
7077caf6dc5a
Include headers for pid_t.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
69873
diff
changeset
|
26 #include <unistd.h> |
7077caf6dc5a
Include headers for pid_t.
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
69873
diff
changeset
|
27 #endif |
365 | 28 |
21849
96fd475a324d
(struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
21657
diff
changeset
|
29 /* 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
|
30 or network connection. |
96fd475a324d
(struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
21657
diff
changeset
|
31 |
96fd475a324d
(struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
21657
diff
changeset
|
32 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
|
33 must be a Lisp_Object, for GC's sake. */ |
365 | 34 |
35 struct Lisp_Process | |
36 { | |
10286
5689759b9329
Make size field an EMACS_INT.
Richard M. Stallman <rms@gnu.org>
parents:
8888
diff
changeset
|
37 EMACS_INT size; |
365 | 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; | |
8888
84527c2d9f75
(struct process): New field tty_name.
Richard M. Stallman <rms@gnu.org>
parents:
7307
diff
changeset
|
43 /* Name of subprocess terminal. */ |
84527c2d9f75
(struct process): New field tty_name.
Richard M. Stallman <rms@gnu.org>
parents:
7307
diff
changeset
|
44 Lisp_Object tty_name; |
365 | 45 /* Name of this process */ |
46 Lisp_Object name; | |
43967
7e0389460d9d
(struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents:
39935
diff
changeset
|
47 /* 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
|
48 Is set to t for a stopped network process; nil otherwise. */ |
365 | 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; | |
43967
7e0389460d9d
(struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents:
39935
diff
changeset
|
55 /* (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
|
56 accepts a connection from a client. */ |
7e0389460d9d
(struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents:
39935
diff
changeset
|
57 Lisp_Object log; |
365 | 58 /* Buffer that output is going to */ |
59 Lisp_Object buffer; | |
16059 | 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 | 62 Lisp_Object childp; |
49222
bfa7cad7b524
(struct Lisp_Process): New member plist replaces old
Kim F. Storm <storm@cua.dk>
parents:
49163
diff
changeset
|
63 /* Plist for programs to keep per-process state information, parameters, etc. */ |
bfa7cad7b524
(struct Lisp_Process): New member plist replaces old
Kim F. Storm <storm@cua.dk>
parents:
49163
diff
changeset
|
64 Lisp_Object plist; |
365 | 65 /* Marker set to end of last buffer-inserted output from this process */ |
66 Lisp_Object mark; | |
43967
7e0389460d9d
(struct Lisp_Process): New member log.
Kim F. Storm <storm@cua.dk>
parents:
39935
diff
changeset
|
67 /* 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
|
68 This is the inverse of the `query-on-exit' flag. */ |
365 | 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; | |
17042
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
82 /* Coding-system for decoding the input from this process. */ |
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
83 Lisp_Object decode_coding_system; |
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
84 /* Working buffer for decoding. */ |
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
85 Lisp_Object decoding_buf; |
20714
ead6c5a556e1
(struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents:
17042
diff
changeset
|
86 /* Size of carryover in decoding. */ |
ead6c5a556e1
(struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents:
17042
diff
changeset
|
87 Lisp_Object decoding_carryover; |
17042
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
88 /* Coding-system for encoding the output to this process. */ |
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
89 Lisp_Object encode_coding_system; |
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
90 /* Working buffer for encoding. */ |
00b923d54108
(struct Lisp_Process): New members
Karl Heuer <kwzh@gnu.org>
parents:
16059
diff
changeset
|
91 Lisp_Object encoding_buf; |
20714
ead6c5a556e1
(struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents:
17042
diff
changeset
|
92 /* Size of carryover in encoding. */ |
ead6c5a556e1
(struct Lisp_Process): New members decoding_carryover
Kenichi Handa <handa@m17n.org>
parents:
17042
diff
changeset
|
93 Lisp_Object encoding_carryover; |
21657
373f809e0b95
(struct Lisp_Process): Add inherit_coding_system_flag member.
Eli Zaretskii <eliz@gnu.org>
parents:
20714
diff
changeset
|
94 /* 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
|
95 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
|
96 Lisp_Object inherit_coding_system_flag; |
49666
9f435c19ea6f
(struct Lisp_Process): New member filter_multibyte.
Kenichi Handa <handa@m17n.org>
parents:
49222
diff
changeset
|
97 /* Flat to decide the multibyteness of a string given to the |
9f435c19ea6f
(struct Lisp_Process): New member filter_multibyte.
Kenichi Handa <handa@m17n.org>
parents:
49222
diff
changeset
|
98 filter (if any). It is initialized to the value of |
9f435c19ea6f
(struct Lisp_Process): New member filter_multibyte.
Kenichi Handa <handa@m17n.org>
parents:
49222
diff
changeset
|
99 `default-enable-multibyte-characters' when the process is |
9f435c19ea6f
(struct Lisp_Process): New member filter_multibyte.
Kenichi Handa <handa@m17n.org>
parents:
49222
diff
changeset
|
100 generated, and can be changed by the function |
9f435c19ea6f
(struct Lisp_Process): New member filter_multibyte.
Kenichi Handa <handa@m17n.org>
parents:
49222
diff
changeset
|
101 `set-process-fileter-multibyte'. */ |
9f435c19ea6f
(struct Lisp_Process): New member filter_multibyte.
Kenichi Handa <handa@m17n.org>
parents:
49222
diff
changeset
|
102 Lisp_Object filter_multibyte; |
53471
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
103 /* Should we delay reading output from this process. |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
104 Initialized from `Vprocess_adaptive_read_buffering'. */ |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
105 Lisp_Object adaptive_read_buffering; |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
106 /* Hysteresis to try to read process output in larger blocks. |
63127
20c2d120fc79
(struct process): Conditionalize slots adaptive_read_buffering,
Richard M. Stallman <rms@gnu.org>
parents:
53726
diff
changeset
|
107 On some systems, e.g. GNU/Linux, Emacs is seen as |
53471
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
108 an interactive app also when reading process output, meaning |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
109 that process output can be read in as little as 1 byte at a |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
110 time. Value is micro-seconds to delay reading output from |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
111 this process. Range is 0 .. 50000. */ |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
112 Lisp_Object read_output_delay; |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
113 /* Skip reading this process on next read. */ |
b3ac4cfe9253
(struct Lisp_Process): New members for adaptive read
Kim F. Storm <storm@cua.dk>
parents:
52401
diff
changeset
|
114 Lisp_Object read_output_skip; |
69873
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
115 |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
116 /* After this point, there are no Lisp_Objects any more. */ |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
117 |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
118 /* Number of this process. |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
119 allocate_process assumes this is the first non-Lisp_Object field. |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
120 A value 0 is used for pseudo-processes such as network connections. */ |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
121 pid_t pid; |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
122 /* Record the process status in the raw form in which it comes from `wait'. |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
123 This is to avoid consing in a signal handler. The `raw_status_new' |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
124 flag indicates that `raw_status' contains a new status that still |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
125 needs to be synced to `status'. */ |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
126 int raw_status_new : 1; |
2d844bbbccd4
* process.h (struct Lisp_Process): Replace Lisp_Objects `pid',
Stefan Monnier <monnier@iro.umontreal.ca>
parents:
68651
diff
changeset
|
127 int raw_status; |
365 | 128 }; |
129 | |
21849
96fd475a324d
(struct process): Make inherit_coding_system_flag a Lisp_Object.
Richard M. Stallman <rms@gnu.org>
parents:
21657
diff
changeset
|
130 /* 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
|
131 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
|
132 |
365 | 133 #define ChannelMask(n) (1<<(n)) |
134 | |
6165
9c0cc4128da8
(chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2432
diff
changeset
|
135 /* 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
|
136 extern Lisp_Object chan_process[]; |
6165
9c0cc4128da8
(chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2432
diff
changeset
|
137 |
9c0cc4128da8
(chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2432
diff
changeset
|
138 /* Alist of elements (NAME . PROCESS). */ |
9c0cc4128da8
(chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2432
diff
changeset
|
139 extern Lisp_Object Vprocess_alist; |
9c0cc4128da8
(chan_process, Vprocess_alist): Declared.
Richard M. Stallman <rms@gnu.org>
parents:
2432
diff
changeset
|
140 |
365 | 141 /* True iff we are about to fork off a synchronous process or if we |
142 are waiting for it. */ | |
143 extern int synch_process_alive; | |
144 | |
14036 | 145 /* Communicate exit status of sync process to from sigchld_handler |
546 | 146 to Fcall_process. */ |
147 | |
365 | 148 /* Nonzero => this is a string explaining death of synchronous subprocess. */ |
149 extern char *synch_process_death; | |
150 | |
53714
77ad9650fc55
synch_process_termsig new variable.
Jan Djärv <jan.h.d@swipnet.se>
parents:
53471
diff
changeset
|
151 /* Nonzero => this is the signal number that terminated the subprocess. */ |
53726
f37373c2902a
* process.h: Add extern to synch_process_termsig.
Jan Djärv <jan.h.d@swipnet.se>
parents:
53714
diff
changeset
|
152 extern int synch_process_termsig; |
53714
77ad9650fc55
synch_process_termsig new variable.
Jan Djärv <jan.h.d@swipnet.se>
parents:
53471
diff
changeset
|
153 |
365 | 154 /* If synch_process_death is zero, |
155 this is exit code of synchronous subprocess. */ | |
156 extern int synch_process_retcode; | |
157 | |
2432
17a84e60603b
New macros NULL_DEVICE and EXEC_SUFFIXES, to give the name of the
Jim Blandy <jimb@redhat.com>
parents:
546
diff
changeset
|
158 /* 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
|
159 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
|
160 #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
|
161 #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
|
162 #endif |
52401 | 163 |
72726
c7ba95ddeb1d
(inhibit_sentinels): Add decl.
Richard M. Stallman <rms@gnu.org>
parents:
70209
diff
changeset
|
164 /* Nonzero means don't run process sentinels. This is used |
c7ba95ddeb1d
(inhibit_sentinels): Add decl.
Richard M. Stallman <rms@gnu.org>
parents:
70209
diff
changeset
|
165 when exiting. */ |
c7ba95ddeb1d
(inhibit_sentinels): Add decl.
Richard M. Stallman <rms@gnu.org>
parents:
70209
diff
changeset
|
166 extern int inhibit_sentinels; |
c7ba95ddeb1d
(inhibit_sentinels): Add decl.
Richard M. Stallman <rms@gnu.org>
parents:
70209
diff
changeset
|
167 |
52401 | 168 /* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72 |
169 (do not change this comment) */ |