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