update.
[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) (EQ ((x)->status_symbol, Qrun))
49 #define PROCESS_READABLE_P(x) (!NILP ((x)->pipe_instream))
50
51 #define CHECK_LIVE_PROCESS(x) do {                      \
52   CHECK_PROCESS (x);                                    \
53   if (! PROCESS_LIVE_P (XPROCESS (x)))                  \
54     dead_wrong_type_argument (Qprocess_live_p, (x));    \
55 } while (0)
56
57 #define CHECK_READABLE_PROCESS(x) do {                  \
58   CHECK_PROCESS (x);                                    \
59   if (! PROCESS_READABLE_P (XPROCESS (x)))              \
60     dead_wrong_type_argument (Qprocess_readable_p, (x));        \
61 } while (0)
62
63 #ifdef emacs
64
65 EXFUN (Fprocess_kill_without_query, 2);
66 EXFUN (Fprocess_id, 1);
67
68 Lisp_Object connect_to_file_descriptor (Lisp_Object name,
69                                         Lisp_Object buffer,
70                                         Lisp_Object infd,
71                                         Lisp_Object outfd);
72 int connected_via_filedesc_p (Lisp_Process *p);
73 void kill_buffer_processes (Lisp_Object buffer);
74 void close_process_descs (void);
75
76 void set_process_filter (Lisp_Object proc,
77                          Lisp_Object filter, int filter_does_read);
78
79 /* True iff we are about to fork off a synchronous process or if we
80    are waiting for it.  */
81 extern volatile int synch_process_alive;
82
83 /* Nonzero => this is a string explaining death of synchronous subprocess.  */
84 extern const char *synch_process_death;
85
86 /* If synch_process_death is zero,
87    this is exit code of synchronous subprocess.  */
88 extern int synch_process_retcode;
89
90
91 void update_process_status (Lisp_Object p,
92                             Lisp_Object status_symbol,
93                             int exit_code, int core_dumped);
94
95 void get_process_streams (Lisp_Process *p,
96                           Lisp_Object *instr, Lisp_Object *outstr);
97 int get_process_selected_p (Lisp_Process *p);
98 void set_process_selected_p (Lisp_Process *p, int selected_p);
99
100 Lisp_Process *get_process_from_usid (USID usid);
101
102 #ifdef HAVE_SOCKETS
103 int network_connection_p (Lisp_Object process);
104 #else
105 #define network_connection_p(x) 0
106 #endif
107
108 extern Lisp_Object Qclosed, Qmulticast, Qopen, Qrun, Qstop, Qtcp, Qudp;
109 extern Lisp_Object Vprocess_connection_type, Vprocess_list;
110
111 /* Report all recent events of a change in process status
112    (either run the sentinel or output a message).
113    This is done while Emacs is waiting for keyboard input.  */
114 void status_notify (void);
115 void kick_status_notify (void);
116
117 void deactivate_process (Lisp_Object proc);
118
119 #ifdef WIN32_NATIVE
120 int
121 #else
122 void
123 #endif
124 child_setup (int in, int out, int err,
125                   char **new_argv, const char *current_dir);
126
127 Charcount read_process_output (Lisp_Object proc);
128
129 const char *signal_name (int signum);
130
131 Lisp_Object canonicalize_host_name (Lisp_Object host);
132
133 #endif /* not NO_SUBPROCESSES */
134
135 /* The name of the file open to get a null file, or a data sink.
136    MS-DOS, and OS/2 redefine this.  */
137 #ifndef NULL_DEVICE
138 #define NULL_DEVICE "/dev/null"
139 #endif
140
141 /* A string listing the possible suffixes used for executable files,
142    separated by colons.  MS-DOS, and OS/2 redefine this.  */
143 #ifndef EXEC_SUFFIXES
144 #define EXEC_SUFFIXES ""
145 #endif
146
147 #endif /* emacs */
148
149 #endif /* INCLUDED_process_h_ */