1 /* Processes implementation header
2 Copyright (C) 1985, 1992, 1993, 1994 Free Software Foundation, Inc.
4 This file is part of XEmacs.
6 XEmacs is free software; you can redistribute it and/or modify it
7 under the terms of the GNU General Public License as published by the
8 Free Software Foundation; either version 2, or (at your option) any
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
16 You should have received a copy of the GNU General Public License
17 along with XEmacs; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19 Boston, MA 02111-1307, USA. */
21 /* This file must be only included by the process implementation files:
22 process-unix.c, process-msw.c etc. The Lisp_Process structure and other
23 contents of this file is not exported to the rest of the world */
25 #ifndef _XEMACS_PROCIMPL_H_
26 #define _XEMACS_PROCIMPL_H_
31 * Structure which keeps methods of the process implementation.
32 * There is only one object of this class exists in a particular
33 * XEmacs implementation.
36 /* #### Comment me... */
38 struct process_methods
40 void (*mark_process_data) (struct Lisp_Process *proc,
41 void (*markobj) (Lisp_Object));
42 void (*print_process_data) (struct Lisp_Process *proc,
43 Lisp_Object printcharfun);
44 void (*finalize_process_data) (struct Lisp_Process *proc, int for_disksave);
45 void (*alloc_process_data) (struct Lisp_Process *p);
46 void (*init_process_io_handles) (struct Lisp_Process *p,
47 void* in, void* out, int flags);
48 int (*create_process) (struct Lisp_Process *p,
49 Lisp_Object *argv, int nargv,
50 Lisp_Object program, Lisp_Object cur_dir);
51 int (*tooltalk_connection_p) (struct Lisp_Process *p);
53 void (*open_network_stream) (Lisp_Object name, Lisp_Object host,
54 Lisp_Object service, Lisp_Object family,
55 void** vinfd, void** voutfd);
57 void (*open_multicast_group) (Lisp_Object name, Lisp_Object dest,
58 Lisp_Object port, Lisp_Object ttl,
59 void** vinfd, void** voutfd);
60 #endif /* HAVE_MULTICAST */
61 #endif /* HAVE_SOCKETS */
62 Lisp_Object (*canonicalize_host_name) (Lisp_Object host);
63 int (*set_window_size) (struct Lisp_Process* p, int height, int width);
64 void (*send_process) (Lisp_Object proc, struct lstream* lstream);
65 void (*reap_exited_processes) (void);
66 void (*update_status_if_terminated) (struct Lisp_Process* p);
67 void (*kill_child_process) (Lisp_Object proc, int signo,
68 int current_group, int nomsg);
69 int (*kill_process_by_pid) (int pid, int sigcode);
70 int (*process_send_eof) (Lisp_Object proc);
71 Lisp_Object (*get_tty_name) (struct Lisp_Process *p);
72 USID (*deactivate_process) (struct Lisp_Process *p);
73 void (*init_process) (void);
76 extern struct process_methods the_process_methods;
79 * Accessors for process_methods
82 #define HAS_PROCMETH_P(name) (the_process_methods.name != 0)
83 #define PROCMETH(name, par) ((the_process_methods.name) par)
84 #define PROCMETH_OR_GIVEN(name, par, given) (HAS_PROCMETH_P(name) ? PROCMETH(name, par) : (given))
85 #define MAYBE_PROCMETH(name, par) do { if (HAS_PROCMETH_P(name)) PROCMETH(name, par); } while (0);
86 #define MAYBE_LISP_PROCMETH(name, par) PROCMETH_OR_GIVEN(name, par, Qnil)
87 #define MAYBE_INT_PROCMETH(name, par) PROCMETH_OR_GIVEN(name, par, 0)
88 #define PROCESS_HAS_METHOD(os, name) the_process_methods.name = os##_##name
91 * Structure records pertinent information about open channels.
92 * There is one channel associated with each process.
97 struct lcrecord_header header;
98 /* Name of this process */
100 /* List of command arguments that this process was run with */
102 /* (funcall FILTER PROC STRING) (if FILTER is non-nil)
103 to dispose of a bunch of chars from the process all at once */
105 /* (funcall SENTINEL PROCESS) when process state changes */
106 Lisp_Object sentinel;
107 /* Buffer that output is going to */
109 /* Marker set to end of last buffer-inserted output from this process */
111 /* Lisp_Int of subprocess' PID, or a cons of
112 service/host if this is really a network connection */
115 /* Symbol indicating status of process.
116 This may be a symbol: run, stop, exit, signal */
117 Lisp_Object status_symbol;
119 /* Exit code if process has terminated,
120 signal which stopped/interrupted process
121 or 0 if process is running */
123 /* Non-false if process has exited and "dumped core" on its way down */
126 /* This next field is only actually used #ifdef ENERGIZE */
127 /* if this flag is not NIL, then filter will do the read on the
128 channel, rather than having a call to make_string.
129 This only works if the filter is a subr. */
130 char filter_does_read;
131 /* Non-nil means kill silently if Emacs is exited. */
132 char kill_without_query;
134 /* Event-count of last event in which this process changed status. */
136 /* Event-count of last such event reported. */
138 /* Low level streams used in input and output, connected to child */
139 Lisp_Object pipe_instream;
140 Lisp_Object pipe_outstream;
142 /* Data end streams, decoding and encoding pipe_* streams */
143 Lisp_Object coding_instream;
144 Lisp_Object coding_outstream;
147 /* Implementation dependent data */
151 /* Macros to refer to data connection streams */
153 #define DATA_INSTREAM(p) (p)->coding_instream
154 #define DATA_OUTSTREAM(p) (p)->coding_outstream
156 #define DATA_INSTREAM(p) (p)->pipe_instream
157 #define DATA_OUTSTREAM(p) (p)->pipe_outstream
160 /* Random externs from process.c */
161 extern Lisp_Object Qrun, Qstop, Qopen, Qclosed;
162 extern Lisp_Object Qtcpip;
163 extern Lisp_Object Vprocess_connection_type;
164 extern Lisp_Object Vprocess_list;
166 extern struct hash_table *usid_to_process;
168 extern volatile int process_tick;
170 extern int windowed_process_io;
172 #ifdef HAVE_MULTICAST
173 extern Lisp_Object Qmulticast;
176 #ifdef PROCESS_IO_BLOCKING
177 extern Lisp_Object network_stream_blocking_port_list;
178 #endif /* PROCESS_IO_BLOCKING */
180 Lisp_Object make_process_internal (Lisp_Object name);
181 void init_process_io_handles (struct Lisp_Process *p, void* in,
182 void* out, int flags);
183 void send_process (Lisp_Object proc,
184 Lisp_Object relocatable,
185 CONST Bufbyte *nonrelocatable,
188 #endif /* _XEMACS_PROCIMPL_H_ */