annotate src/process.h @ 132:757f1c4d15f7 xemacs-20-1

Added tag xemacs-20-1p4 for changeset 869e1851236b
author cvs
date Mon, 13 Aug 2007 09:29:09 +0200
parents 4be1180a9e89
children 3d6bfa290dbd
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
1 /* Definitions for asynchronous process control in XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
2 Copyright (C) 1985, 1992, 1993, 1994 Free Software Foundation, Inc.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
3
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
4 This file is part of XEmacs.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
5
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
6 XEmacs is free software; you can redistribute it and/or modify it
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
7 under the terms of the GNU General Public License as published by the
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
8 Free Software Foundation; either version 2, or (at your option) any
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
9 later version.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
10
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
11 XEmacs is distributed in the hope that it will be useful, but WITHOUT
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
12 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
13 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
14 for more details.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
15
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
16 You should have received a copy of the GNU General Public License
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
17 along with XEmacs; see the file COPYING. If not, write to
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
18 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
19 Boston, MA 02111-1307, USA. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
20
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
21 /* Synched up with: FSF 19.30. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
22
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
23 #ifndef _XEMACS_PROCESS_H_
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
24 #define _XEMACS_PROCESS_H_
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
25
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
26 #if defined (NO_SUBPROCESSES)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
27 #undef XPROCESS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
28 #undef CHECK_PROCESS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
29 #undef XSETPROCESS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
30 #define PROCESSP(x) 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
31 #define PROCESS_LIVE_P(x) 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
32 #define Fprocess_status(x) Qnil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
33 #define Fget_process(x) Qnil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
34 #define Fget_buffer_process(x) Qnil
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
35 #define kill_buffer_processes(x) 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
36 #define close_process_descs() 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
37 #define init_xemacs_process() 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
38 extern void wait_without_blocking (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
39
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
40 #else /* not NO_SUBPROCESSES */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
41
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
42 /* Only process.c needs to know about the guts of this */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
43 struct Lisp_Process;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
44
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
45 DECLARE_LRECORD (process, struct Lisp_Process);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
46 #define XPROCESS(x) XRECORD (x, process, struct Lisp_Process)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
47 #define XSETPROCESS(x, p) XSETRECORD (x, p, process)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
48 #define PROCESSP(x) RECORDP (x, process)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
49 #define GC_PROCESSP(x) GC_RECORDP (x, process)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
50 #define CHECK_PROCESS(x) CHECK_RECORD (x, process)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
51 #define PROCESS_LIVE_P(x) (XPROCESS(x)->infd >= 0)
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
52
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
53 #ifdef emacs
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
54
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
55 Lisp_Object Fget_process (Lisp_Object name);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
56 Lisp_Object Fget_buffer_process (Lisp_Object name);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
57 Lisp_Object Fprocessp (Lisp_Object object);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
58 Lisp_Object Fprocess_status (Lisp_Object process);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
59 Lisp_Object Fkill_process (Lisp_Object process,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
60 Lisp_Object current_group);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
61 Lisp_Object Fdelete_process (Lisp_Object process);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
62 Lisp_Object Fopen_network_stream_internal (Lisp_Object name,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
63 Lisp_Object buffer,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
64 Lisp_Object host,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
65 Lisp_Object service);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
66 Lisp_Object Fprocess_kill_without_query (Lisp_Object, Lisp_Object);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
67
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
68 Lisp_Object connect_to_file_descriptor (Lisp_Object name,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
69 Lisp_Object buffer,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
70 Lisp_Object infd,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
71 Lisp_Object outfd);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
72 int connected_via_filedesc_p (struct Lisp_Process *p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
73 void kill_buffer_processes (Lisp_Object buffer);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
74 void close_process_descs (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
75
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
76 void set_process_filter (Lisp_Object proc,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
77 Lisp_Object filter, int filter_does_read);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
78
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
79 /* True iff we are about to fork off a synchronous process or if we
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
80 are waiting for it. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
81 extern volatile int synch_process_alive;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
82
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
83 /* Nonzero => this is a string explaining death of synchronous subprocess. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
84 extern CONST char *synch_process_death;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
85
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
86 /* If synch_process_death is zero,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
87 this is exit code of synchronous subprocess. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
88 extern int synch_process_retcode;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
89
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
90
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
91 void update_process_status (Lisp_Object p,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
92 Lisp_Object status_symbol,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
93 int exit_code, int core_dumped);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
94
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
95 void get_process_file_descriptors (struct Lisp_Process *p,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
96 int *infd, int *outfd);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
97 int get_process_selected_p (struct Lisp_Process *p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
98 void set_process_selected_p (struct Lisp_Process *p, int selected_p);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
99
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
100 struct Lisp_Process *get_process_from_input_descriptor (int infd);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
101
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
102 #ifdef HAVE_SOCKETS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
103 int network_connection_p (Lisp_Object process);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
104 #else
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
105 #define network_connection_p(x) 0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
106 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
107
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
108 extern Lisp_Object Qrun, Qexit, Qopen, Qclosed;
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
109
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
110 /* Report all recent events of a change in process status
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
111 (either run the sentinel or output a message).
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
112 This is done while Emacs is waiting for keyboard input. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
113 void status_notify (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
114 void kick_status_notify (void);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
115
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
116 void deactivate_process (Lisp_Object proc);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
117
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
118 #ifdef VMS
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
119 void create_process (Lisp_Object process, char **new_argv,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
120 CONST char *current_dir);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
121 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
122
100
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 0
diff changeset
123 #ifdef WINDOWSNT
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 0
diff changeset
124 int
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 0
diff changeset
125 #else
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 0
diff changeset
126 void
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 0
diff changeset
127 #endif
4be1180a9e89 Import from CVS: tag r20-1b2
cvs
parents: 0
diff changeset
128 child_setup (int in, int out, int err,
0
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
129 char **new_argv, CONST char *current_dir);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
130
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
131 Charcount read_process_output (Lisp_Object proc);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
132
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
133 CONST char *signal_name (int signum);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
134
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
135 Lisp_Object canonicalize_host_name (Lisp_Object host);
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
136
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
137 #endif /* not NO_SUBPROCESSES */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
138
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
139 /* The name of the file open to get a null file, or a data sink.
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
140 VMS, MS-DOS, and OS/2 redefine this. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
141 #ifndef NULL_DEVICE
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
142 #define NULL_DEVICE "/dev/null"
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
143 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
144
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
145 /* A string listing the possible suffixes used for executable files,
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
146 separated by colons. VMS, MS-DOS, and OS/2 redefine this. */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
147 #ifndef EXEC_SUFFIXES
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
148 #define EXEC_SUFFIXES ""
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
149 #endif
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
150
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
151 #endif /* emacs */
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
152
376386a54a3c Import from CVS: tag r19-14
cvs
parents:
diff changeset
153 #endif /* _XEMACS_PROCESS_H_ */