XEmacs 21.2.32 "Kastor & Polydeukes".
[chise/xemacs-chise.git.1] / src / process.h
1 /* Definitions for asynchronous process control in XEmacs.
2    Copyright (C) 1985, 1992, 1993, 1994 Free Software Foundation, Inc.
3
4 This file is part of XEmacs.
5
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
9 later version.
10
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
14 for more details.
15
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.  */
20
21 #ifndef INCLUDED_process_h_
22 #define INCLUDED_process_h_
23
24 #if defined (NO_SUBPROCESSES)
25 #undef XPROCESS
26 #undef CHECK_PROCESS
27 #undef XSETPROCESS
28 #define PROCESSP(x) 0
29 #define PROCESS_LIVE_P(x) 0
30 #define Fprocess_status(x) Qnil
31 #define Fget_process(x) Qnil
32 #define Fget_buffer_process(x) Qnil
33 #define kill_buffer_processes(x) 0
34 #define close_process_descs() 0
35 #define init_xemacs_process() 0
36 void wait_without_blocking (void);
37
38 #else /* not NO_SUBPROCESSES */
39
40 /* struct Lisp_Process is defined in procimpl.h; only process-*.c need
41    to know about the guts of it. */
42
43 DECLARE_LRECORD (process, Lisp_Process);
44 #define XPROCESS(x) XRECORD (x, process, Lisp_Process)
45 #define XSETPROCESS(x, p) XSETRECORD (x, p, process)
46 #define PROCESSP(x) RECORDP (x, process)
47 #define CHECK_PROCESS(x) CHECK_RECORD (x, process)
48 #define PROCESS_LIVE_P(x) (!NILP ((x)->pipe_instream))
49
50 #define CHECK_LIVE_PROCESS(x) do {                      \
51   CHECK_PROCESS (x);                                    \
52   if (! PROCESS_LIVE_P (XPROCESS (x)))                  \
53     dead_wrong_type_argument (Qprocess_live_p, (x));    \
54 } while (0)
55
56 #ifdef emacs
57
58 EXFUN (Fprocess_kill_without_query, 2);
59 EXFUN (Fprocess_id, 1);
60
61 Lisp_Object connect_to_file_descriptor (Lisp_Object name,
62                                         Lisp_Object buffer,
63                                         Lisp_Object infd,
64                                         Lisp_Object outfd);
65 int connected_via_filedesc_p (Lisp_Process *p);
66 void kill_buffer_processes (Lisp_Object buffer);
67 void close_process_descs (void);
68
69 void set_process_filter (Lisp_Object proc,
70                          Lisp_Object filter, int filter_does_read);
71
72 /* True iff we are about to fork off a synchronous process or if we
73    are waiting for it.  */
74 extern volatile int synch_process_alive;
75
76 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
77 extern const char *synch_process_death;
78
79 /* If synch_process_death is zero,
80    this is exit code of synchronous subprocess.  */
81 extern int synch_process_retcode;
82
83
84 void update_process_status (Lisp_Object p,
85                             Lisp_Object status_symbol,
86                             int exit_code, int core_dumped);
87
88 void get_process_streams (Lisp_Process *p,
89                           Lisp_Object *instr, Lisp_Object *outstr);
90 int get_process_selected_p (Lisp_Process *p);
91 void set_process_selected_p (Lisp_Process *p, int selected_p);
92
93 Lisp_Process *get_process_from_usid (USID usid);
94
95 #ifdef HAVE_SOCKETS
96 int network_connection_p (Lisp_Object process);
97 #else
98 #define network_connection_p(x) 0
99 #endif
100
101 extern Lisp_Object Qclosed, Qmulticast, Qopen, Qrun, Qstop, Qtcp, Qudp;
102 extern Lisp_Object Vprocess_connection_type, Vprocess_list;
103
104 /* Report all recent events of a change in process status
105    (either run the sentinel or output a message).
106    This is done while Emacs is waiting for keyboard input.  */
107 void status_notify (void);
108 void kick_status_notify (void);
109
110 void deactivate_process (Lisp_Object proc);
111
112 #ifdef WINDOWSNT
113 int
114 #else
115 void
116 #endif
117 child_setup (int in, int out, int err,
118                   char **new_argv, const char *current_dir);
119
120 Charcount read_process_output (Lisp_Object proc);
121
122 const char *signal_name (int signum);
123
124 Lisp_Object canonicalize_host_name (Lisp_Object host);
125
126 #endif /* not NO_SUBPROCESSES */
127
128 /* The name of the file open to get a null file, or a data sink.
129    MS-DOS, and OS/2 redefine this.  */
130 #ifndef NULL_DEVICE
131 #define NULL_DEVICE "/dev/null"
132 #endif
133
134 /* A string listing the possible suffixes used for executable files,
135    separated by colons.  MS-DOS, and OS/2 redefine this.  */
136 #ifndef EXEC_SUFFIXES
137 #define EXEC_SUFFIXES ""
138 #endif
139
140 #endif /* emacs */
141
142 #ifdef HAVE_GETPT
143 #define PTY_ITERATION
144 #define PTY_OPEN \
145     if ((fd = getpt()) < 0 || grantpt (fd) < 0 || unlockpt (fd) < 0) \
146       return -1;
147 #define PTY_NAME_SPRINTF
148 #define PTY_TTY_NAME_SPRINTF strcpy (pty_name, ptsname (fd));
149 #endif
150
151 #endif /* INCLUDED_process_h_ */