annotate src/procimpl.h @ 278:90d73dddcdc4 r21-0b37

Import from CVS: tag r21-0b37
author cvs
date Mon, 13 Aug 2007 10:31:29 +0200
parents 727739f917cb
children e11d67e05968
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
263
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
1 /* Processes implementation header
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
2 Copyright (C) 1985, 1992, 1993, 1994 Free Software Foundation, Inc.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
3
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
4 This file is part of XEmacs.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
5
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
9 later version.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
10
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
14 for more details.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
15
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
20
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
21 /* This file must be only included by the process implementation files:
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
22 process-unix.c, process-msw.c etc. The Lisp_Process structure and other
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
23 contents of this file is not exported to the rest of the world */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
24
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
25 #ifndef _XEMACS_PROCIMPL_H_
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
26 #define _XEMACS_PROCIMPL_H_
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
27
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
28 struct Lisp_Process;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
29
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
30 /*
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
31 * Structure which keeps methods of the process implementation.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
32 * There is only one object of this class exists in a perticular
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
33 * XEmacs implementation.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
34 */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
35
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
36 /* #### Comment me... */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
37
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
38 struct process_methods
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
39 {
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
40 void (*mark_process_data) (struct Lisp_Process *proc,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
41 void (*markobj) (Lisp_Object));
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
42 void (*print_process_data) (struct Lisp_Process *proc,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
43 Lisp_Object printcharfun);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
44 void (*finalize_process_data) (struct Lisp_Process *proc, int for_disksave);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
45 void (*alloc_process_data) (struct Lisp_Process *p);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
46 void (*init_process_io_handles) (struct Lisp_Process *p,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
47 void* in, void* out, int flags);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
48 int (*create_process) (struct Lisp_Process *p,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
49 char **new_argv, CONST char *current_dir);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
50 int (*tooltalk_connection_p) (struct Lisp_Process *p);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
51 #ifdef HAVE_SOCKETS
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
52 void (*open_network_stream) (Lisp_Object name, Lisp_Object host,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
53 Lisp_Object service, Lisp_Object family,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
54 void** vinfd, void** voutfd);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
55 #ifdef HAVE_MULTICAST
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
56 void (*open_multicast_group) (Lisp_Object name, Lisp_Object dest,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
57 Lisp_Object port, Lisp_Object ttl,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
58 void** vinfd, void** voutfd);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
59 #endif /* HAVE_MULTICAST */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
60 #endif /* HAVE_SOCKETS */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
61 Lisp_Object (*canonicalize_host_name) (Lisp_Object host);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
62 int (*set_window_size) (struct Lisp_Process* p, int height, int width);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
63 void (*send_process) (Lisp_Object proc, struct lstream* lstream);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
64 void (*reap_exited_processes) (void);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
65 void (*update_status_if_terminated) (struct Lisp_Process* p);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
66 void (*kill_child_process) (Lisp_Object proc, int signo,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
67 int current_group, int nomsg);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
68 int (*kill_process_by_pid) (int pid, int sigcode);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
69 int (*process_send_eof) (Lisp_Object proc);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
70 Lisp_Object (*get_tty_name) (struct Lisp_Process *p);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
71 USID (*deactivate_process) (struct Lisp_Process *p);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
72 void (*init_process) (void);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
73 };
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
74
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
75 extern struct process_methods the_process_methods;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
76
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
77 /*
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
78 * Accessors for process_methods
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
79 */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
80
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
81 #define HAS_PROCMETH_P(name) (the_process_methods.name != 0)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
82 #define PROCMETH(name, par) ((the_process_methods.name) par)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
83 #define PROCMETH_OR_GIVEN(name, par, given) (HAS_PROCMETH_P(name) ? PROCMETH(name, par) : (given))
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
84 #define MAYBE_PROCMETH(name, par) do { if (HAS_PROCMETH_P(name)) PROCMETH(name, par); } while (0);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
85 #define MAYBE_LISP_PROCMETH(name, par) PROCMETH_OR_GIVEN(name, par, Qnil)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
86 #define MAYBE_INT_PROCMETH(name, par) PROCMETH_OR_GIVEN(name, par, 0)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
87 #define PROCESS_HAS_METHOD(os, name) the_process_methods.name = os##_##name
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
88
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
89 /*
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
90 * Structure records pertinent information about open channels.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
91 * There is one channel associated with each process.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
92 */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
93
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
94 struct Lisp_Process
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
95 {
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
96 struct lcrecord_header header;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
97 /* Name of this process */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
98 Lisp_Object name;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
99 /* List of command arguments that this process was run with */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
100 Lisp_Object command;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
101 /* (funcall FILTER PROC STRING) (if FILTER is non-nil)
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
102 to dispose of a bunch of chars from the process all at once */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
103 Lisp_Object filter;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
104 /* (funcall SENTINEL PROCESS) when process state changes */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
105 Lisp_Object sentinel;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
106 /* Buffer that output is going to */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
107 Lisp_Object buffer;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
108 /* Marker set to end of last buffer-inserted output from this process */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
109 Lisp_Object mark;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
110 /* Lisp_Int of subprocess' PID, or a cons of
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
111 service/host if this is really a network connection */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
112 Lisp_Object pid;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
113
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
114 /* Symbol indicating status of process.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
115 This may be a symbol: run, stop, exit, signal */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
116 Lisp_Object status_symbol;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
117
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
118 /* Exit code if process has terminated,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
119 signal which stopped/interrupted process
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
120 or 0 if process is running */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
121 int exit_code;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
122 /* Non-false if process has exited and "dumped core" on its way down */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
123 char core_dumped;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
124
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
125 /* This next field is only actually used #ifdef ENERGIZE */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
126 /* if this flag is not NIL, then filter will do the read on the
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
127 channel, rather than having a call to make_string.
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
128 This only works if the filter is a subr. */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
129 char filter_does_read;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
130 /* Non-nil means kill silently if Emacs is exited. */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
131 char kill_without_query;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
132 char selected;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
133 /* Event-count of last event in which this process changed status. */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
134 volatile int tick;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
135 /* Event-count of last such event reported. */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
136 int update_tick;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
137 /* Low level streams used in input and output, connected to child */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
138 Lisp_Object pipe_instream;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
139 Lisp_Object pipe_outstream;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
140 #ifdef FILE_CODING
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
141 /* Data end streams, decoding and encoding pipe_* streams */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
142 Lisp_Object coding_instream;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
143 Lisp_Object coding_outstream;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
144 #endif
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
145
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
146 /* Implementation dependent data */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
147 void *process_data;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
148 };
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
149
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
150 /* Macros to refer to data connection streams */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
151 #ifdef FILE_CODING
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
152 #define DATA_INSTREAM(p) (p)->coding_instream
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
153 #define DATA_OUTSTREAM(p) (p)->coding_outstream
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
154 #else
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
155 #define DATA_INSTREAM(p) (p)->pipe_instream
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
156 #define DATA_OUTSTREAM(p) (p)->pipe_outstream
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
157 #endif
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
158
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
159 /* Random externs from process.c */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
160 extern Lisp_Object Qrun, Qstop, Qopen, Qclosed;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
161 extern Lisp_Object Qtcpip;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
162 extern Lisp_Object Vprocess_connection_type;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
163 extern Lisp_Object Vprocess_list;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
164
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
165 extern c_hashtable usid_to_process;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
166
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
167 extern volatile int process_tick;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
168
278
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 263
diff changeset
169 extern int windowed_process_io;
90d73dddcdc4 Import from CVS: tag r21-0b37
cvs
parents: 263
diff changeset
170
263
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
171 #ifdef HAVE_MULTICAST
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
172 extern Lisp_Object Qmulticast;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
173 #endif
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
174
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
175 #ifdef PROCESS_IO_BLOCKING
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
176 extern Lisp_Object network_stream_blocking_port_list;
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
177 #endif /* PROCESS_IO_BLOCKING */
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
178
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
179 Lisp_Object make_process_internal (Lisp_Object name);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
180 void init_process_io_handles (struct Lisp_Process *p, void* in,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
181 void* out, int flags);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
182 void send_process (Lisp_Object proc,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
183 Lisp_Object relocatable,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
184 CONST Bufbyte *nonrelocatable,
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
185 int start, int len);
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
186
727739f917cb Import from CVS: tag r20-5b30
cvs
parents:
diff changeset
187 #endif /* _XEMACS_PROCIMPL_H_ */