annotate lispref/processes.texi @ 78453:aebddcb3277b

New function image-refresh.
author Chong Yidong <cyd@stupidchicken.com>
date Tue, 07 Aug 2007 16:41:36 +0000
parents 61d6d08c1ecf
children 4143f6123df1 326bae23bda1 d7172f202ab8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1 @c -*-texinfo-*-
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
2 @c This is part of the GNU Emacs Lisp Reference Manual.
75250
6d19c76d81c5 Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 75050
diff changeset
3 @c Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995, 1998, 1999, 2001,
6d19c76d81c5 Update copyright for years from Emacs 21 to present (mainly adding
Glenn Morris <rgm@gnu.org>
parents: 75050
diff changeset
4 @c 2002, 2003, 2004, 2005, 2006, 2007 Free Software Foundation, Inc.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
5 @c See the file elisp.texi for copying conditions.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
6 @setfilename ../info/processes
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
7 @node Processes, Display, Abbrevs, Top
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
8 @chapter Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
9 @cindex child process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
10 @cindex parent process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
11 @cindex subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
12 @cindex process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
13
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
14 In the terminology of operating systems, a @dfn{process} is a space in
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
15 which a program can execute. Emacs runs in a process. Emacs Lisp
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
16 programs can invoke other programs in processes of their own. These are
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
17 called @dfn{subprocesses} or @dfn{child processes} of the Emacs process,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
18 which is their @dfn{parent process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
19
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
20 A subprocess of Emacs may be @dfn{synchronous} or @dfn{asynchronous},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
21 depending on how it is created. When you create a synchronous
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
22 subprocess, the Lisp program waits for the subprocess to terminate
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
23 before continuing execution. When you create an asynchronous
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
24 subprocess, it can run in parallel with the Lisp program. This kind of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
25 subprocess is represented within Emacs by a Lisp object which is also
71957
61cb5aae3bc3 Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents: 71697
diff changeset
26 called a ``process.'' Lisp programs can use this object to communicate
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
27 with the subprocess or to control it. For example, you can send
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
28 signals, obtain status information, receive output from the process, or
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
29 send input to it.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
30
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
31 @defun processp object
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
32 This function returns @code{t} if @var{object} is a process,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
33 @code{nil} otherwise.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
34 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
35
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
36 @menu
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
37 * Subprocess Creation:: Functions that start subprocesses.
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
38 * Shell Arguments:: Quoting an argument to pass it to a shell.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
39 * Synchronous Processes:: Details of using synchronous subprocesses.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
40 * Asynchronous Processes:: Starting up an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
41 * Deleting Processes:: Eliminating an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
42 * Process Information:: Accessing run-status and other attributes.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
43 * Input to Processes:: Sending input to an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
44 * Signals to Processes:: Stopping, continuing or interrupting
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
45 an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
46 * Output from Processes:: Collecting output from an asynchronous subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
47 * Sentinels:: Sentinels run when process run-status changes.
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
48 * Query Before Exit:: Whether to query if exiting will kill a process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
49 * Transaction Queues:: Transaction-based communication with subprocesses.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
50 * Network:: Opening network connections.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
51 * Network Servers:: Network servers let Emacs accept net connections.
62245
a9109def6d90 (Processes): Add menu description.
Lute Kamstra <lute@gnu.org>
parents: 62230
diff changeset
52 * Datagrams:: UDP network connections.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
53 * Low-Level Network:: Lower-level but more general function
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
54 to create connections and servers.
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
55 * Misc Network:: Additional relevant functions for network connections.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
56 * Byte Packing:: Using bindat to pack and unpack binary data.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
57 @end menu
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
58
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
59 @node Subprocess Creation
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
60 @section Functions that Create Subprocesses
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
61
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
62 There are three functions that create a new subprocess in which to run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
63 a program. One of them, @code{start-process}, creates an asynchronous
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
64 process and returns a process object (@pxref{Asynchronous Processes}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
65 The other two, @code{call-process} and @code{call-process-region},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
66 create a synchronous process and do not return a process object
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
67 (@pxref{Synchronous Processes}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
68
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
69 Synchronous and asynchronous processes are explained in the following
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
70 sections. Since the three functions are all called in a similar
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
71 fashion, their common arguments are described here.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
72
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
73 @cindex execute program
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
74 @cindex @code{PATH} environment variable
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
75 @cindex @code{HOME} environment variable
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
76 In all cases, the function's @var{program} argument specifies the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
77 program to be run. An error is signaled if the file is not found or
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
78 cannot be executed. If the file name is relative, the variable
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
79 @code{exec-path} contains a list of directories to search. Emacs
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
80 initializes @code{exec-path} when it starts up, based on the value of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
81 the environment variable @code{PATH}. The standard file name
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
82 constructs, @samp{~}, @samp{.}, and @samp{..}, are interpreted as
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
83 usual in @code{exec-path}, but environment variable substitutions
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
84 (@samp{$HOME}, etc.) are not recognized; use
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
85 @code{substitute-in-file-name} to perform them (@pxref{File Name
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
86 Expansion}). @code{nil} in this list refers to
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
87 @code{default-directory}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
88
51922
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
89 Executing a program can also try adding suffixes to the specified
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
90 name:
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
91
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
92 @defvar exec-suffixes
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
93 This variable is a list of suffixes (strings) to try adding to the
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
94 specified program file name. The list should include @code{""} if you
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
95 want the name to be tried exactly as specified. The default value is
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
96 system-dependent.
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
97 @end defvar
97cfe6cd3e4f (Subprocess Creation): Add exec-suffixes.
Richard M. Stallman <rms@gnu.org>
parents: 49600
diff changeset
98
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
99 @strong{Please note:} The argument @var{program} contains only the
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
100 name of the program; it may not contain any command-line arguments. You
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
101 must use @var{args} to provide those.
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
102
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
103 Each of the subprocess-creating functions has a @var{buffer-or-name}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
104 argument which specifies where the standard output from the program will
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
105 go. It should be a buffer or a buffer name; if it is a buffer name,
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
106 that will create the buffer if it does not already exist. It can also
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
107 be @code{nil}, which says to discard the output unless a filter function
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
108 handles it. (@xref{Filter Functions}, and @ref{Read and Print}.)
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
109 Normally, you should avoid having multiple processes send output to the
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
110 same buffer because their output would be intermixed randomly.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
111
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
112 @cindex program arguments
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
113 All three of the subprocess-creating functions have a @code{&rest}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
114 argument, @var{args}. The @var{args} must all be strings, and they are
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
115 supplied to @var{program} as separate command line arguments. Wildcard
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
116 characters and other shell constructs have no special meanings in these
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
117 strings, since the strings are passed directly to the specified program.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
118
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
119 The subprocess gets its current directory from the value of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
120 @code{default-directory} (@pxref{File Name Expansion}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
121
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
122 @cindex environment variables, subprocesses
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
123 The subprocess inherits its environment from Emacs, but you can
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
124 specify overrides for it with @code{process-environment}. @xref{System
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
125 Environment}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
126
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
127 @defvar exec-directory
17611
1b2afa6391ca (exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents: 16664
diff changeset
128 @pindex movemail
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
129 The value of this variable is a string, the name of a directory that
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
130 contains programs that come with GNU Emacs, programs intended for Emacs
17611
1b2afa6391ca (exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents: 16664
diff changeset
131 to invoke. The program @code{movemail} is an example of such a program;
1b2afa6391ca (exec-directory): Wakeup no longer exists, so use movemail as example.
Richard M. Stallman <rms@gnu.org>
parents: 16664
diff changeset
132 Rmail uses it to fetch new mail from an inbox.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
133 @end defvar
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
134
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
135 @defopt exec-path
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
136 The value of this variable is a list of directories to search for
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
137 programs to run in subprocesses. Each element is either the name of a
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
138 directory (i.e., a string), or @code{nil}, which stands for the default
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
139 directory (which is the value of @code{default-directory}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
140 @cindex program directories
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
141
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
142 The value of @code{exec-path} is used by @code{call-process} and
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
143 @code{start-process} when the @var{program} argument is not an absolute
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
144 file name.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
145 @end defopt
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
146
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
147 @node Shell Arguments
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
148 @section Shell Arguments
76993
55c9ef5f1559 Improve index entries.
Richard M. Stallman <rms@gnu.org>
parents: 76922
diff changeset
149 @cindex arguments for shell commands
55c9ef5f1559 Improve index entries.
Richard M. Stallman <rms@gnu.org>
parents: 76922
diff changeset
150 @cindex shell command arguments
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
151
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
152 Lisp programs sometimes need to run a shell and give it a command
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
153 that contains file names that were specified by the user. These
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
154 programs ought to be able to support any valid file name. But the shell
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
155 gives special treatment to certain characters, and if these characters
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
156 occur in the file name, they will confuse the shell. To handle these
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
157 characters, use the function @code{shell-quote-argument}:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
158
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
159 @defun shell-quote-argument argument
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
160 This function returns a string which represents, in shell syntax,
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
161 an argument whose actual contents are @var{argument}. It should
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
162 work reliably to concatenate the return value into a shell command
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
163 and then pass it to a shell for execution.
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
164
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
165 Precisely what this function does depends on your operating system. The
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
166 function is designed to work with the syntax of your system's standard
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
167 shell; if you use an unusual shell, you will need to redefine this
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
168 function.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
169
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
170 @example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
171 ;; @r{This example shows the behavior on GNU and Unix systems.}
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
172 (shell-quote-argument "foo > bar")
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
173 @result{} "foo\\ \\>\\ bar"
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
174
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
175 ;; @r{This example shows the behavior on MS-DOS and MS-Windows.}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
176 (shell-quote-argument "foo > bar")
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
177 @result{} "\"foo > bar\""
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
178 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
179
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
180 Here's an example of using @code{shell-quote-argument} to construct
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
181 a shell command:
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
182
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
183 @example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
184 (concat "diff -c "
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
185 (shell-quote-argument oldfile)
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
186 " "
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
187 (shell-quote-argument newfile))
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
188 @end example
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
189 @end defun
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
190
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
191 @node Synchronous Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
192 @section Creating a Synchronous Process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
193 @cindex synchronous subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
194
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
195 After a @dfn{synchronous process} is created, Emacs waits for the
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
196 process to terminate before continuing. Starting Dired on GNU or
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
197 Unix@footnote{On other systems, Emacs uses a Lisp emulation of
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
198 @code{ls}; see @ref{Contents of Directories}.} is an example of this: it
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
199 runs @code{ls} in a synchronous process, then modifies the output
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
200 slightly. Because the process is synchronous, the entire directory
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
201 listing arrives in the buffer before Emacs tries to do anything with it.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
202
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
203 While Emacs waits for the synchronous subprocess to terminate, the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
204 user can quit by typing @kbd{C-g}. The first @kbd{C-g} tries to kill
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
205 the subprocess with a @code{SIGINT} signal; but it waits until the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
206 subprocess actually terminates before quitting. If during that time the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
207 user types another @kbd{C-g}, that kills the subprocess instantly with
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
208 @code{SIGKILL} and quits immediately (except on MS-DOS, where killing
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
209 other processes doesn't work). @xref{Quitting}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
210
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
211 The synchronous subprocess functions return an indication of how the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
212 process terminated.
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
213
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
214 The output from a synchronous subprocess is generally decoded using a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
215 coding system, much like text read from a file. The input sent to a
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
216 subprocess by @code{call-process-region} is encoded using a coding
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
217 system, much like text written into a file. @xref{Coding Systems}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
218
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
219 @defun call-process program &optional infile destination display &rest args
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
220 This function calls @var{program} in a separate process and waits for
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
221 it to finish.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
222
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
223 The standard input for the process comes from file @var{infile} if
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
224 @var{infile} is not @code{nil}, and from the null device otherwise.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
225 The argument @var{destination} says where to put the process output.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
226 Here are the possibilities:
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
227
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
228 @table @asis
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
229 @item a buffer
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
230 Insert the output in that buffer, before point. This includes both the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
231 standard output stream and the standard error stream of the process.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
232
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
233 @item a string
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
234 Insert the output in a buffer with that name, before point.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
235
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
236 @item @code{t}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
237 Insert the output in the current buffer, before point.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
238
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
239 @item @code{nil}
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
240 Discard the output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
241
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
242 @item 0
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
243 Discard the output, and return @code{nil} immediately without waiting
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
244 for the subprocess to finish.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
245
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
246 In this case, the process is not truly synchronous, since it can run in
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
247 parallel with Emacs; but you can think of it as synchronous in that
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
248 Emacs is essentially finished with the subprocess as soon as this
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
249 function returns.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
250
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
251 MS-DOS doesn't support asynchronous subprocesses, so this option doesn't
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
252 work there.
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
253
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
254 @item @code{(@var{real-destination} @var{error-destination})}
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
255 Keep the standard output stream separate from the standard error stream;
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
256 deal with the ordinary output as specified by @var{real-destination},
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
257 and dispose of the error output according to @var{error-destination}.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
258 If @var{error-destination} is @code{nil}, that means to discard the
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
259 error output, @code{t} means mix it with the ordinary output, and a
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
260 string specifies a file name to redirect error output into.
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
261
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
262 You can't directly specify a buffer to put the error output in; that is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
263 too difficult to implement. But you can achieve this result by sending
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
264 the error output to a temporary file and then inserting the file into a
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
265 buffer.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
266 @end table
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
267
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
268 If @var{display} is non-@code{nil}, then @code{call-process} redisplays
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
269 the buffer as output is inserted. (However, if the coding system chosen
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
270 for decoding output is @code{undecided}, meaning deduce the encoding
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
271 from the actual data, then redisplay sometimes cannot continue once
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
272 non-@acronym{ASCII} characters are encountered. There are fundamental
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
273 reasons why it is hard to fix this; see @ref{Output from Processes}.)
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
274
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
275 Otherwise the function @code{call-process} does no redisplay, and the
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
276 results become visible on the screen only when Emacs redisplays that
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
277 buffer in the normal course of events.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
278
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
279 The remaining arguments, @var{args}, are strings that specify command
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
280 line arguments for the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
281
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
282 The value returned by @code{call-process} (unless you told it not to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
283 wait) indicates the reason for process termination. A number gives the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
284 exit status of the subprocess; 0 means success, and any other value
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
285 means failure. If the process terminated with a signal,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
286 @code{call-process} returns a string describing the signal.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
287
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
288 In the examples below, the buffer @samp{foo} is current.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
289
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
290 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
291 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
292 (call-process "pwd" nil t)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
293 @result{} 0
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
294
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
295 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
296 /usr/user/lewis/manual
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
297 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
298 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
299
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
300 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
301 (call-process "grep" nil "bar" nil "lewis" "/etc/passwd")
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
302 @result{} 0
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
303
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
304 ---------- Buffer: bar ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
305 lewis:5LTsHm66CSWKg:398:21:Bil Lewis:/user/lewis:/bin/csh
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
306
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
307 ---------- Buffer: bar ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
308 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
309 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
310
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
311 Here is a good example of the use of @code{call-process}, which used to
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
312 be found in the definition of @code{insert-directory}:
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
313
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
314 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
315 @group
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
316 (call-process insert-directory-program nil t nil @var{switches}
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
317 (if full-directory-p
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
318 (concat (file-name-as-directory file) ".")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
319 file))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
320 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
321 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
322 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
323
57670
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
324 @defun process-file program &optional infile buffer display &rest args
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
325 This function processes files synchronously in a separate process. It
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
326 is similar to @code{call-process} but may invoke a file handler based
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
327 on the value of the variable @code{default-directory}. The current
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
328 working directory of the subprocess is @code{default-directory}.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
329
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
330 The arguments are handled in almost the same way as for
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
331 @code{call-process}, with the following differences:
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
332
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
333 Some file handlers may not support all combinations and forms of the
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
334 arguments @var{infile}, @var{buffer}, and @var{display}. For example,
58500
6f8c0631e5aa (Synchronous Processes): Grammar fix.
Richard M. Stallman <rms@gnu.org>
parents: 58405
diff changeset
335 some file handlers might behave as if @var{display} were @code{nil},
57670
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
336 regardless of the value actually passed. As another example, some
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
337 file handlers might not support separating standard output and error
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
338 output by way of the @var{buffer} argument.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
339
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
340 If a file handler is invoked, it determines the program to run based
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
341 on the first argument @var{program}. For instance, consider that a
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
342 handler for remote files is invoked. Then the path that is used for
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
343 searching the program might be different than @code{exec-path}.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
344
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
345 The second argument @var{infile} may invoke a file handler. The file
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
346 handler could be different from the handler chosen for the
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
347 @code{process-file} function itself. (For example,
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
348 @code{default-directory} could be on a remote host, whereas
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
349 @var{infile} is on another remote host. Or @code{default-directory}
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
350 could be non-special, whereas @var{infile} is on a remote host.)
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
351
77123
4d7a5d9bbe76 improve breaks in 8.5x11
Karl Berry <karl@gnu.org>
parents: 76993
diff changeset
352 If @var{buffer} is a list of the form @code{(@var{real-destination}
57670
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
353 @var{error-destination})}, and @var{error-destination} names a file,
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
354 then the same remarks as for @var{infile} apply.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
355
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
356 The remaining arguments (@var{args}) will be passed to the process
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
357 verbatim. Emacs is not involved in processing file names that are
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
358 present in @var{args}. To avoid confusion, it may be best to avoid
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
359 absolute file names in @var{args}, but rather to specify all file
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
360 names as relative to @code{default-directory}. The function
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
361 @code{file-relative-name} is useful for constructing such relative
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
362 file names.
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
363 @end defun
dd36fc88814a (Synchronous Processes): Document process-file.
Kai Großjohann <kgrossjo@eu.uu.net>
parents: 56704
diff changeset
364
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
365 @defun call-process-region start end program &optional delete destination display &rest args
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
366 This function sends the text from @var{start} to @var{end} as
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
367 standard input to a process running @var{program}. It deletes the text
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
368 sent if @var{delete} is non-@code{nil}; this is useful when
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
369 @var{destination} is @code{t}, to insert the output in the current
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
370 buffer in place of the input.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
371
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
372 The arguments @var{destination} and @var{display} control what to do
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
373 with the output from the subprocess, and whether to update the display
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
374 as it comes in. For details, see the description of
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
375 @code{call-process}, above. If @var{destination} is the integer 0,
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
376 @code{call-process-region} discards the output and returns @code{nil}
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
377 immediately, without waiting for the subprocess to finish (this only
27370
70846ee19545 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27259
diff changeset
378 works if asynchronous subprocesses are supported).
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
379
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
380 The remaining arguments, @var{args}, are strings that specify command
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
381 line arguments for the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
382
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
383 The return value of @code{call-process-region} is just like that of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
384 @code{call-process}: @code{nil} if you told it to return without
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
385 waiting; otherwise, a number or string which indicates how the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
386 subprocess terminated.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
387
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
388 In the following example, we use @code{call-process-region} to run the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
389 @code{cat} utility, with standard input being the first five characters
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
390 in buffer @samp{foo} (the word @samp{input}). @code{cat} copies its
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
391 standard input into its standard output. Since the argument
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
392 @var{destination} is @code{t}, this output is inserted in the current
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
393 buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
394
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
395 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
396 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
397 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
398 input@point{}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
399 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
400 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
401
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
402 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
403 (call-process-region 1 6 "cat" nil t)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
404 @result{} 0
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
405
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
406 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
407 inputinput@point{}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
408 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
409 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
410 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
411
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
412 The @code{shell-command-on-region} command uses
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
413 @code{call-process-region} like this:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
414
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
415 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
416 @group
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
417 (call-process-region
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
418 start end
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
419 shell-file-name ; @r{Name of program.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
420 nil ; @r{Do not delete region.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
421 buffer ; @r{Send output to @code{buffer}.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
422 nil ; @r{No redisplay during output.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
423 "-c" command) ; @r{Arguments for the shell.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
424 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
425 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
426 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
427
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
428 @defun call-process-shell-command command &optional infile destination display &rest args
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
429 This function executes the shell command @var{command} synchronously
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
430 in a separate process. The final arguments @var{args} are additional
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
431 arguments to add at the end of @var{command}. The other arguments
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
432 are handled as in @code{call-process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
433 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
434
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
435 @defun shell-command-to-string command
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
436 This function executes @var{command} (a string) as a shell command,
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
437 then returns the command's output as a string.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
438 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
439
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
440 @node Asynchronous Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
441 @section Creating an Asynchronous Process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
442 @cindex asynchronous subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
443
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
444 After an @dfn{asynchronous process} is created, Emacs and the subprocess
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
445 both continue running immediately. The process thereafter runs
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
446 in parallel with Emacs, and the two can communicate with each other
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
447 using the functions described in the following sections. However,
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
448 communication is only partially asynchronous: Emacs sends data to the
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
449 process only when certain functions are called, and Emacs accepts data
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
450 from the process only when Emacs is waiting for input or for a time
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
451 delay.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
452
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
453 Here we describe how to create an asynchronous process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
454
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
455 @defun start-process name buffer-or-name program &rest args
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
456 This function creates a new asynchronous subprocess and starts the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
457 program @var{program} running in it. It returns a process object that
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
458 stands for the new subprocess in Lisp. The argument @var{name}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
459 specifies the name for the process object; if a process with this name
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
460 already exists, then @var{name} is modified (by appending @samp{<1>},
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
461 etc.) to be unique. The buffer @var{buffer-or-name} is the buffer to
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
462 associate with the process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
463
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
464 The remaining arguments, @var{args}, are strings that specify command
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
465 line arguments for the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
466
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
467 In the example below, the first process is started and runs (rather,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
468 sleeps) for 100 seconds. Meanwhile, the second process is started, and
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
469 given the name @samp{my-process<1>} for the sake of uniqueness. It
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
470 inserts the directory listing at the end of the buffer @samp{foo},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
471 before the first process finishes. Then it finishes, and a message to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
472 that effect is inserted in the buffer. Much later, the first process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
473 finishes, and another message is inserted in the buffer for it.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
474
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
475 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
476 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
477 (start-process "my-process" "foo" "sleep" "100")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
478 @result{} #<process my-process>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
479 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
480
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
481 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
482 (start-process "my-process" "foo" "ls" "-l" "/user/lewis/bin")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
483 @result{} #<process my-process<1>>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
484
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
485 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
486 total 2
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
487 lrwxrwxrwx 1 lewis 14 Jul 22 10:12 gnuemacs --> /emacs
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
488 -rwxrwxrwx 1 lewis 19 Jul 30 21:02 lemon
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
489
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
490 Process my-process<1> finished
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
491
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
492 Process my-process finished
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
493 ---------- Buffer: foo ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
494 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
495 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
496 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
497
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
498 @defun start-process-shell-command name buffer-or-name command &rest command-args
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
499 This function is like @code{start-process} except that it uses a shell
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
500 to execute the specified command. The argument @var{command} is a shell
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
501 command name, and @var{command-args} are the arguments for the shell
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
502 command. The variable @code{shell-file-name} specifies which shell to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
503 use.
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
504
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
505 The point of running a program through the shell, rather than directly
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
506 with @code{start-process}, is so that you can employ shell features such
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
507 as wildcards in the arguments. It follows that if you include an
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
508 arbitrary user-specified arguments in the command, you should quote it
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
509 with @code{shell-quote-argument} first, so that any special shell
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
510 characters do @emph{not} have their special shell meanings. @xref{Shell
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
511 Arguments}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
512 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
513
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
514 @defvar process-connection-type
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
515 @cindex pipes
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
516 @cindex @acronym{PTY}s
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
517 This variable controls the type of device used to communicate with
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
518 asynchronous subprocesses. If it is non-@code{nil}, then @acronym{PTY}s are
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
519 used, when available. Otherwise, pipes are used.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
520
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
521 @acronym{PTY}s are usually preferable for processes visible to the user, as
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
522 in Shell mode, because they allow job control (@kbd{C-c}, @kbd{C-z},
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
523 etc.) to work between the process and its children, whereas pipes do
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
524 not. For subprocesses used for internal purposes by programs, it is
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
525 often better to use a pipe, because they are more efficient. In
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
526 addition, the total number of @acronym{PTY}s is limited on many systems and
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
527 it is good not to waste them.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
528
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
529 The value of @code{process-connection-type} takes effect when
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
530 @code{start-process} is called. So you can specify how to communicate
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
531 with one subprocess by binding the variable around the call to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
532 @code{start-process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
533
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
534 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
535 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
536 (let ((process-connection-type nil)) ; @r{Use a pipe.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
537 (start-process @dots{}))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
538 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
539 @end smallexample
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
540
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
541 To determine whether a given subprocess actually got a pipe or a
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
542 @acronym{PTY}, use the function @code{process-tty-name} (@pxref{Process
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
543 Information}).
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
544 @end defvar
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
545
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
546 @node Deleting Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
547 @section Deleting Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
548 @cindex deleting processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
549
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
550 @dfn{Deleting a process} disconnects Emacs immediately from the
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
551 subprocess. Processes are deleted automatically after they terminate,
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
552 but not necessarily right away. You can delete a process explicitly
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
553 at any time. If you delete a terminated process explicitly before it
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
554 is deleted automatically, no harm results. Deleting a running
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
555 process sends a signal to terminate it (and its child processes if
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
556 any), and calls the process sentinel if it has one. @xref{Sentinels}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
557
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
558 When a process is deleted, the process object itself continues to
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
559 exist as long as other Lisp objects point to it. All the Lisp
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
560 primitives that work on process objects accept deleted processes, but
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
561 those that do I/O or send signals will report an error. The process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
562 mark continues to point to the same place as before, usually into a
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
563 buffer where output from the process was being inserted.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
564
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
565 @defopt delete-exited-processes
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
566 This variable controls automatic deletion of processes that have
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
567 terminated (due to calling @code{exit} or to a signal). If it is
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
568 @code{nil}, then they continue to exist until the user runs
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
569 @code{list-processes}. Otherwise, they are deleted immediately after
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
570 they exit.
22252
40089afa2b1d *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22138
diff changeset
571 @end defopt
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
572
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
573 @defun delete-process process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
574 This function deletes a process, killing it with a @code{SIGKILL}
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
575 signal. The argument may be a process, the name of a process, a
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
576 buffer, or the name of a buffer. (A buffer or buffer-name stands for
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
577 the process that @code{get-buffer-process} returns.) Calling
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
578 @code{delete-process} on a running process terminates it, updates the
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
579 process status, and runs the sentinel (if any) immediately. If the
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
580 process has already terminated, calling @code{delete-process} has no
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
581 effect on its status, or on the running of its sentinel (which will
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
582 happen sooner or later).
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
583
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
584 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
585 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
586 (delete-process "*shell*")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
587 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
588 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
589 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
590 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
591
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
592 @node Process Information
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
593 @section Process Information
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
594
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
595 Several functions return information about processes.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
596 @code{list-processes} is provided for interactive use.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
597
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
598 @deffn Command list-processes &optional query-only
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
599 This command displays a listing of all living processes. In addition,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
600 it finally deletes any process whose status was @samp{Exited} or
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
601 @samp{Signaled}. It returns @code{nil}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
602
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
603 If @var{query-only} is non-@code{nil} then it lists only processes
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
604 whose query flag is non-@code{nil}. @xref{Query Before Exit}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
605 @end deffn
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
606
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
607 @defun process-list
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
608 This function returns a list of all processes that have not been deleted.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
609
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
610 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
611 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
612 (process-list)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
613 @result{} (#<process display-time> #<process shell>)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
614 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
615 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
616 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
617
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
618 @defun get-process name
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
619 This function returns the process named @var{name}, or @code{nil} if
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
620 there is none. An error is signaled if @var{name} is not a string.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
621
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
622 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
623 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
624 (get-process "shell")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
625 @result{} #<process shell>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
626 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
627 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
628 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
629
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
630 @defun process-command process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
631 This function returns the command that was executed to start
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
632 @var{process}. This is a list of strings, the first string being the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
633 program executed and the rest of the strings being the arguments that
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
634 were given to the program.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
635
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
636 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
637 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
638 (process-command (get-process "shell"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
639 @result{} ("/bin/csh" "-i")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
640 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
641 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
642 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
643
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
644 @defun process-id process
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
645 This function returns the @acronym{PID} of @var{process}. This is an
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
646 integer that distinguishes the process @var{process} from all other
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
647 processes running on the same computer at the current time. The
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
648 @acronym{PID} of a process is chosen by the operating system kernel when the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
649 process is started and remains constant as long as the process exists.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
650 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
651
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
652 @defun process-name process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
653 This function returns the name of @var{process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
654 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
655
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
656 @defun process-status process-name
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
657 This function returns the status of @var{process-name} as a symbol.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
658 The argument @var{process-name} must be a process, a buffer, a
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
659 process name (string) or a buffer name (string).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
660
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
661 The possible values for an actual subprocess are:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
662
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
663 @table @code
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
664 @item run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
665 for a process that is running.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
666 @item stop
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
667 for a process that is stopped but continuable.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
668 @item exit
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
669 for a process that has exited.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
670 @item signal
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
671 for a process that has received a fatal signal.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
672 @item open
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
673 for a network connection that is open.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
674 @item closed
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
675 for a network connection that is closed. Once a connection
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
676 is closed, you cannot reopen it, though you might be able to open
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
677 a new connection to the same place.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
678 @item connect
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
679 for a non-blocking connection that is waiting to complete.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
680 @item failed
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
681 for a non-blocking connection that has failed to complete.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
682 @item listen
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
683 for a network server that is listening.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
684 @item nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
685 if @var{process-name} is not the name of an existing process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
686 @end table
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
687
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
688 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
689 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
690 (process-status "shell")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
691 @result{} run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
692 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
693 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
694 (process-status (get-buffer "*shell*"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
695 @result{} run
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
696 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
697 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
698 x
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
699 @result{} #<process xx<1>>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
700 (process-status x)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
701 @result{} exit
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
702 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
703 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
704
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
705 For a network connection, @code{process-status} returns one of the symbols
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
706 @code{open} or @code{closed}. The latter means that the other side
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
707 closed the connection, or Emacs did @code{delete-process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
708 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
709
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
710 @defun process-exit-status process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
711 This function returns the exit status of @var{process} or the signal
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
712 number that killed it. (Use the result of @code{process-status} to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
713 determine which of those it is.) If @var{process} has not yet
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
714 terminated, the value is 0.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
715 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
716
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
717 @defun process-tty-name process
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
718 This function returns the terminal name that @var{process} is using for
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
719 its communication with Emacs---or @code{nil} if it is using pipes
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
720 instead of a terminal (see @code{process-connection-type} in
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
721 @ref{Asynchronous Processes}).
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
722 @end defun
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
723
56215
c9aa4127a482 Reposition @anchor's.
Luc Teirlinck <teirllm@auburn.edu>
parents: 54916
diff changeset
724 @defun process-coding-system process
53292
5408fe43d709 (Process Information): Add anchor.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52978
diff changeset
725 @anchor{Coding systems for a subprocess}
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
726 This function returns a cons cell describing the coding systems in use
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
727 for decoding output from @var{process} and for encoding input to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
728 @var{process} (@pxref{Coding Systems}). The value has this form:
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
729
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
730 @example
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
731 (@var{coding-system-for-decoding} . @var{coding-system-for-encoding})
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
732 @end example
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
733 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
734
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
735 @defun set-process-coding-system process &optional decoding-system encoding-system
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
736 This function specifies the coding systems to use for subsequent output
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
737 from and input to @var{process}. It will use @var{decoding-system} to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
738 decode subprocess output, and @var{encoding-system} to encode subprocess
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
739 input.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
740 @end defun
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
741
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
742 Every process also has a property list that you can use to store
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
743 miscellaneous values associated with the process.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
744
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
745 @defun process-get process propname
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
746 This function returns the value of the @var{propname} property
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
747 of @var{process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
748 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
749
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
750 @defun process-put process propname value
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
751 This function sets the value of the @var{propname} property
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
752 of @var{process} to @var{value}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
753 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
754
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
755 @defun process-plist process
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
756 This function returns the process plist of @var{process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
757 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
758
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
759 @defun set-process-plist process plist
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
760 This function sets the process plist of @var{process} to @var{plist}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
761 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
762
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
763 @node Input to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
764 @section Sending Input to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
765 @cindex process input
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
766
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
767 Asynchronous subprocesses receive input when it is sent to them by
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
768 Emacs, which is done with the functions in this section. You must
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
769 specify the process to send input to, and the input data to send. The
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
770 data appears on the ``standard input'' of the subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
771
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
772 Some operating systems have limited space for buffered input in a
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
773 @acronym{PTY}. On these systems, Emacs sends an @acronym{EOF}
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
774 periodically amidst the other characters, to force them through. For
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
775 most programs, these @acronym{EOF}s do no harm.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
776
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
777 Subprocess input is normally encoded using a coding system before the
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
778 subprocess receives it, much like text written into a file. You can use
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
779 @code{set-process-coding-system} to specify which coding system to use
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
780 (@pxref{Process Information}). Otherwise, the coding system comes from
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
781 @code{coding-system-for-write}, if that is non-@code{nil}; or else from
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
782 the defaulting mechanism (@pxref{Default Coding Systems}).
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
783
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
784 Sometimes the system is unable to accept input for that process,
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
785 because the input buffer is full. When this happens, the send functions
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
786 wait a short while, accepting output from subprocesses, and then try
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
787 again. This gives the subprocess a chance to read more of its pending
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
788 input and make space in the buffer. It also allows filters, sentinels
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
789 and timers to run---so take account of that in writing your code.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
790
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
791 In these functions, the @var{process} argument can be a process or
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
792 the name of a process, or a buffer or buffer name (which stands
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
793 for a process via @code{get-buffer-process}). @code{nil} means
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
794 the current buffer's process.
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
795
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
796 @defun process-send-string process string
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
797 This function sends @var{process} the contents of @var{string} as
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
798 standard input. If it is @code{nil}, the current buffer's process is used.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
799
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
800 The function returns @code{nil}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
801
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
802 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
803 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
804 (process-send-string "shell<1>" "ls\n")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
805 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
806 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
807
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
808
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
809 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
810 ---------- Buffer: *shell* ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
811 ...
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
812 introduction.texi syntax-tables.texi~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
813 introduction.texi~ text.texi
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
814 introduction.txt text.texi~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
815 ...
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
816 ---------- Buffer: *shell* ----------
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
817 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
818 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
819 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
820
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
821 @defun process-send-region process start end
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
822 This function sends the text in the region defined by @var{start} and
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
823 @var{end} as standard input to @var{process}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
824
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
825 An error is signaled unless both @var{start} and @var{end} are
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
826 integers or markers that indicate positions in the current buffer. (It
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
827 is unimportant which number is larger.)
25751
467b88fab665 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 24951
diff changeset
828 @end defun
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
829
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
830 @defun process-send-eof &optional process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
831 This function makes @var{process} see an end-of-file in its
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
832 input. The @acronym{EOF} comes after any text already sent to it.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
833
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
834 The function returns @var{process}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
835
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
836 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
837 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
838 (process-send-eof "shell")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
839 @result{} "shell"
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
840 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
841 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
842 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
843
24951
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
844 @defun process-running-child-p process
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
845 This function will tell you whether a subprocess has given control of
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
846 its terminal to its own child process. The value is @code{t} if this is
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
847 true, or if Emacs cannot tell; it is @code{nil} if Emacs can be certain
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
848 that this is not so.
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
849 @end defun
7451b1458af1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 22267
diff changeset
850
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
851 @node Signals to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
852 @section Sending Signals to Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
853 @cindex process signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
854 @cindex sending signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
855 @cindex signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
856
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
857 @dfn{Sending a signal} to a subprocess is a way of interrupting its
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
858 activities. There are several different signals, each with its own
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
859 meaning. The set of signals and their names is defined by the operating
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
860 system. For example, the signal @code{SIGINT} means that the user has
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
861 typed @kbd{C-c}, or that some analogous thing has happened.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
862
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
863 Each signal has a standard effect on the subprocess. Most signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
864 kill the subprocess, but some stop or resume execution instead. Most
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
865 signals can optionally be handled by programs; if the program handles
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
866 the signal, then we can say nothing in general about its effects.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
867
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
868 You can send signals explicitly by calling the functions in this
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
869 section. Emacs also sends signals automatically at certain times:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
870 killing a buffer sends a @code{SIGHUP} signal to all its associated
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
871 processes; killing Emacs sends a @code{SIGHUP} signal to all remaining
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
872 processes. (@code{SIGHUP} is a signal that usually indicates that the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
873 user hung up the phone.)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
874
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
875 Each of the signal-sending functions takes two optional arguments:
62229
789b9a24928a (Signals to Processes): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 60270
diff changeset
876 @var{process} and @var{current-group}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
877
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
878 The argument @var{process} must be either a process, a process
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
879 name, a buffer, a buffer name, or @code{nil}. A buffer or buffer name
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
880 stands for a process through @code{get-buffer-process}. @code{nil}
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
881 stands for the process associated with the current buffer. An error
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
882 is signaled if @var{process} does not identify a process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
883
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
884 The argument @var{current-group} is a flag that makes a difference
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
885 when you are running a job-control shell as an Emacs subprocess. If it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
886 is non-@code{nil}, then the signal is sent to the current process-group
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
887 of the terminal that Emacs uses to communicate with the subprocess. If
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
888 the process is a job-control shell, this means the shell's current
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
889 subjob. If it is @code{nil}, the signal is sent to the process group of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
890 the immediate subprocess of Emacs. If the subprocess is a job-control
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
891 shell, this is the shell itself.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
892
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
893 The flag @var{current-group} has no effect when a pipe is used to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
894 communicate with the subprocess, because the operating system does not
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
895 support the distinction in the case of pipes. For the same reason,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
896 job-control shells won't work when a pipe is used. See
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
897 @code{process-connection-type} in @ref{Asynchronous Processes}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
898
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
899 @defun interrupt-process &optional process current-group
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
900 This function interrupts the process @var{process} by sending the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
901 signal @code{SIGINT}. Outside of Emacs, typing the ``interrupt
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
902 character'' (normally @kbd{C-c} on some systems, and @code{DEL} on
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
903 others) sends this signal. When the argument @var{current-group} is
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
904 non-@code{nil}, you can think of this function as ``typing @kbd{C-c}''
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
905 on the terminal by which Emacs talks to the subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
906 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
907
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
908 @defun kill-process &optional process current-group
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
909 This function kills the process @var{process} by sending the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
910 signal @code{SIGKILL}. This signal kills the subprocess immediately,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
911 and cannot be handled by the subprocess.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
912 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
913
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
914 @defun quit-process &optional process current-group
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
915 This function sends the signal @code{SIGQUIT} to the process
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
916 @var{process}. This signal is the one sent by the ``quit
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
917 character'' (usually @kbd{C-b} or @kbd{C-\}) when you are not inside
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
918 Emacs.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
919 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
920
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
921 @defun stop-process &optional process current-group
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
922 This function stops the process @var{process} by sending the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
923 signal @code{SIGTSTP}. Use @code{continue-process} to resume its
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
924 execution.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
925
21682
90da2489c498 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21007
diff changeset
926 Outside of Emacs, on systems with job control, the ``stop character''
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
927 (usually @kbd{C-z}) normally sends this signal. When
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
928 @var{current-group} is non-@code{nil}, you can think of this function as
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
929 ``typing @kbd{C-z}'' on the terminal Emacs uses to communicate with the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
930 subprocess.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
931 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
932
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
933 @defun continue-process &optional process current-group
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
934 This function resumes execution of the process @var{process} by sending
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
935 it the signal @code{SIGCONT}. This presumes that @var{process} was
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
936 stopped previously.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
937 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
938
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
939 @c Emacs 19 feature
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
940 @defun signal-process process signal
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
941 This function sends a signal to process @var{process}. The argument
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
942 @var{signal} specifies which signal to send; it should be an integer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
943
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
944 The @var{process} argument can be a system process @acronym{ID}; that
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
945 allows you to send signals to processes that are not children of
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
946 Emacs.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
947 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
948
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
949 @node Output from Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
950 @section Receiving Output from Processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
951 @cindex process output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
952 @cindex output from processes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
953
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
954 There are two ways to receive the output that a subprocess writes to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
955 its standard output stream. The output can be inserted in a buffer,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
956 which is called the associated buffer of the process, or a function
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
957 called the @dfn{filter function} can be called to act on the output. If
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
958 the process has no buffer and no filter function, its output is
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
959 discarded.
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
960
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
961 When a subprocess terminates, Emacs reads any pending output,
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
962 then stops reading output from that subprocess. Therefore, if the
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
963 subprocess has children that are still live and still producing
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
964 output, Emacs won't receive that output.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
965
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
966 Output from a subprocess can arrive only while Emacs is waiting: when
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
967 reading terminal input, in @code{sit-for} and @code{sleep-for}
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
968 (@pxref{Waiting}), and in @code{accept-process-output} (@pxref{Accepting
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
969 Output}). This minimizes the problem of timing errors that usually
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
970 plague parallel programming. For example, you can safely create a
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
971 process and only then specify its buffer or filter function; no output
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
972 can arrive before you finish, if the code in between does not call any
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
973 primitive that waits.
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
974
56704
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
975 @defvar process-adaptive-read-buffering
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
976 On some systems, when Emacs reads the output from a subprocess, the
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
977 output data is read in very small blocks, potentially resulting in
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
978 very poor performance. This behavior can be remedied to some extent
56704
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
979 by setting the variable @var{process-adaptive-read-buffering} to a
58405
4fe765649696 (Synchronous Processes, Output from Processes):
Jesper Harder <harder@ifa.au.dk>
parents: 57670
diff changeset
980 non-@code{nil} value (the default), as it will automatically delay reading
56704
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
981 from such processes, thus allowing them to produce more output before
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
982 Emacs tries to read it.
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
983 @end defvar
900340a218c9 (Output from Processes): New var `process-adaptive-read-buffering'.
Kim F. Storm <storm@cua.dk>
parents: 56703
diff changeset
984
27259
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
985 It is impossible to separate the standard output and standard error
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
986 streams of the subprocess, because Emacs normally spawns the subprocess
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
987 inside a pseudo-TTY, and a pseudo-TTY has only one output channel. If
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
988 you want to keep the output to those streams separate, you should
54916
07f4773453a0 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54864
diff changeset
989 redirect one of them to a file---for example, by using an appropriate
27259
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
990 shell command.
c41efa6c4be1 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 27189
diff changeset
991
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
992 @menu
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
993 * Process Buffers:: If no filter, output is put in a buffer.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
994 * Filter Functions:: Filter functions accept output from the process.
51994
eb38ba134224 Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 51993
diff changeset
995 * Decoding Output:: Filters can get unibyte or multibyte strings.
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
996 * Accepting Output:: How to wait until process output arrives.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
997 @end menu
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
998
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
999 @node Process Buffers
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1000 @subsection Process Buffers
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1001
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1002 A process can (and usually does) have an @dfn{associated buffer},
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1003 which is an ordinary Emacs buffer that is used for two purposes: storing
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1004 the output from the process, and deciding when to kill the process. You
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1005 can also use the buffer to identify a process to operate on, since in
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1006 normal practice only one process is associated with any given buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1007 Many applications of processes also use the buffer for editing input to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1008 be sent to the process, but this is not built into Emacs Lisp.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1009
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1010 Unless the process has a filter function (@pxref{Filter Functions}),
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1011 its output is inserted in the associated buffer. The position to insert
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1012 the output is determined by the @code{process-mark}, which is then
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1013 updated to point to the end of the text just inserted. Usually, but not
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1014 always, the @code{process-mark} is at the end of the buffer.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1015
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1016 @defun process-buffer process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1017 This function returns the associated buffer of the process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1018 @var{process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1019
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1020 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1021 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1022 (process-buffer (get-process "shell"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1023 @result{} #<buffer *shell*>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1024 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1025 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1026 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1027
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1028 @defun process-mark process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1029 This function returns the process marker for @var{process}, which is the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1030 marker that says where to insert output from the process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1031
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1032 If @var{process} does not have a buffer, @code{process-mark} returns a
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1033 marker that points nowhere.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1034
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1035 Insertion of process output in a buffer uses this marker to decide where
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1036 to insert, and updates it to point after the inserted text. That is why
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1037 successive batches of output are inserted consecutively.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1038
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1039 Filter functions normally should use this marker in the same fashion
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1040 as is done by direct insertion of output in the buffer. A good
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1041 example of a filter function that uses @code{process-mark} is found at
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1042 the end of the following section.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1043
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1044 When the user is expected to enter input in the process buffer for
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1045 transmission to the process, the process marker separates the new input
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1046 from previous output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1047 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1048
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1049 @defun set-process-buffer process buffer
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1050 This function sets the buffer associated with @var{process} to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1051 @var{buffer}. If @var{buffer} is @code{nil}, the process becomes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1052 associated with no buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1053 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1054
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1055 @defun get-buffer-process buffer-or-name
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1056 This function returns a nondeleted process associated with the buffer
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1057 specified by @var{buffer-or-name}. If there are several processes
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1058 associated with it, this function chooses one (currently, the one most
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1059 recently created, but don't count on that). Deletion of a process
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1060 (see @code{delete-process}) makes it ineligible for this function to
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1061 return.
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1062
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1063 It is usually a bad idea to have more than one process associated with
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1064 the same buffer.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1065
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1066 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1067 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1068 (get-buffer-process "*shell*")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1069 @result{} #<process shell>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1070 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1071 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1072
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1073 Killing the process's buffer deletes the process, which kills the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1074 subprocess with a @code{SIGHUP} signal (@pxref{Signals to Processes}).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1075 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1076
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1077 @node Filter Functions
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1078 @subsection Process Filter Functions
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1079 @cindex filter function
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1080 @cindex process filter
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1081
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1082 A process @dfn{filter function} is a function that receives the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1083 standard output from the associated process. If a process has a filter,
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1084 then @emph{all} output from that process is passed to the filter. The
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1085 process buffer is used directly for output from the process only when
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1086 there is no filter.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1087
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1088 The filter function can only be called when Emacs is waiting for
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1089 something, because process output arrives only at such times. Emacs
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1090 waits when reading terminal input, in @code{sit-for} and
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1091 @code{sleep-for} (@pxref{Waiting}), and in @code{accept-process-output}
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1092 (@pxref{Accepting Output}).
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1093
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1094 A filter function must accept two arguments: the associated process
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1095 and a string, which is output just received from it. The function is
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1096 then free to do whatever it chooses with the output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1097
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1098 Quitting is normally inhibited within a filter function---otherwise,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1099 the effect of typing @kbd{C-g} at command level or to quit a user
66152
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1100 command would be unpredictable. If you want to permit quitting inside
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1101 a filter function, bind @code{inhibit-quit} to @code{nil}. In most
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1102 cases, the right way to do this is with the macro
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1103 @code{with-local-quit}. @xref{Quitting}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1104
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1105 If an error happens during execution of a filter function, it is
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1106 caught automatically, so that it doesn't stop the execution of whatever
12125
995be67f3fd1 updates for version 19.29.
Melissa Weisshaus <melissa@gnu.org>
parents: 12098
diff changeset
1107 program was running when the filter function was started. However, if
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1108 @code{debug-on-error} is non-@code{nil}, the error-catching is turned
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1109 off. This makes it possible to use the Lisp debugger to debug the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1110 filter function. @xref{Debugger}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1111
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1112 Many filter functions sometimes or always insert the text in the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1113 process's buffer, mimicking the actions of Emacs when there is no
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1114 filter. Such filter functions need to use @code{set-buffer} in order to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1115 be sure to insert in that buffer. To avoid setting the current buffer
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1116 semipermanently, these filter functions must save and restore the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1117 current buffer. They should also update the process marker, and in some
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1118 cases update the value of point. Here is how to do these things:
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1119
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1120 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1121 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1122 (defun ordinary-insertion-filter (proc string)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1123 (with-current-buffer (process-buffer proc)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1124 (let ((moving (= (point) (process-mark proc))))
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1125 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1126 @group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1127 (save-excursion
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1128 ;; @r{Insert the text, advancing the process marker.}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1129 (goto-char (process-mark proc))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1130 (insert string)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1131 (set-marker (process-mark proc) (point)))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1132 (if moving (goto-char (process-mark proc))))))
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1133 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1134 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1135
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1136 @noindent
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1137 The reason to use @code{with-current-buffer}, rather than using
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1138 @code{save-excursion} to save and restore the current buffer, is so as
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1139 to preserve the change in point made by the second call to
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1140 @code{goto-char}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1141
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1142 To make the filter force the process buffer to be visible whenever new
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1143 text arrives, insert the following line just before the
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1144 @code{with-current-buffer} construct:
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1145
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1146 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1147 (display-buffer (process-buffer proc))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1148 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1149
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1150 To force point to the end of the new output, no matter where it was
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1151 previously, eliminate the variable @code{moving} and call
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1152 @code{goto-char} unconditionally.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1153
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1154 In earlier Emacs versions, every filter function that did regular
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1155 expression searching or matching had to explicitly save and restore the
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1156 match data. Now Emacs does this automatically for filter functions;
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1157 they never need to do it explicitly. @xref{Match Data}.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1158
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1159 A filter function that writes the output into the buffer of the
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1160 process should check whether the buffer is still alive. If it tries to
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1161 insert into a dead buffer, it will get an error. The expression
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1162 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1163 if the buffer is dead.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1164
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1165 The output to the function may come in chunks of any size. A program
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1166 that produces the same output twice in a row may send it as one batch of
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1167 200 characters one time, and five batches of 40 characters the next. If
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1168 the filter looks for certain text strings in the subprocess output, make
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1169 sure to handle the case where one of these strings is split across two
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1170 or more batches of output.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1171
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1172 @defun set-process-filter process filter
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1173 This function gives @var{process} the filter function @var{filter}. If
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1174 @var{filter} is @code{nil}, it gives the process no filter.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1175 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1176
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1177 @defun process-filter process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1178 This function returns the filter function of @var{process}, or @code{nil}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1179 if it has none.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1180 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1181
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1182 Here is an example of use of a filter function:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1183
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1184 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1185 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1186 (defun keep-output (process output)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1187 (setq kept (cons output kept)))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1188 @result{} keep-output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1189 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1190 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1191 (setq kept nil)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1192 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1193 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1194 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1195 (set-process-filter (get-process "shell") 'keep-output)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1196 @result{} keep-output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1197 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1198 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1199 (process-send-string "shell" "ls ~/other\n")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1200 @result{} nil
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1201 kept
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1202 @result{} ("lewis@@slug[8] % "
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1203 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1204 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1205 "FINAL-W87-SHORT.MSS backup.otl kolstad.mss~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1206 address.txt backup.psf kolstad.psf
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1207 backup.bib~ david.mss resume-Dec-86.mss~
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1208 backup.err david.psf resume-Dec.psf
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1209 backup.mss dland syllabus.mss
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1210 "
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1211 "#backups.mss# backup.mss~ kolstad.mss
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1212 ")
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1213 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1214 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1215
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1216 @ignore @c The code in this example doesn't show the right way to do things.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1217 Here is another, more realistic example, which demonstrates how to use
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1218 the process mark to do insertion in the same fashion as is done when
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1219 there is no filter function:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1220
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1221 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1222 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1223 ;; @r{Insert input in the buffer specified by @code{my-shell-buffer}}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1224 ;; @r{and make sure that buffer is shown in some window.}
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1225 (defun my-process-filter (proc str)
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1226 (let ((cur (selected-window))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1227 (pop-up-windows t))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1228 (pop-to-buffer my-shell-buffer)
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1229 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1230 @group
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1231 (goto-char (point-max))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1232 (insert str)
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1233 (set-marker (process-mark proc) (point-max))
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1234 (select-window cur)))
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1235 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1236 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1237 @end ignore
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1238
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1239 @node Decoding Output
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1240 @subsection Decoding Process Output
76835
e5b96737f906 Improve indexing.
Eli Zaretskii <eliz@gnu.org>
parents: 76833
diff changeset
1241 @cindex decode process output
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1242
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1243 When Emacs writes process output directly into a multibyte buffer,
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1244 it decodes the output according to the process output coding system.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1245 If the coding system is @code{raw-text} or @code{no-conversion}, Emacs
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1246 converts the unibyte output to multibyte using
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
1247 @code{string-to-multibyte}, and inserts the resulting multibyte text.
51993
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1248
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1249 You can use @code{set-process-coding-system} to specify which coding
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1250 system to use (@pxref{Process Information}). Otherwise, the coding
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1251 system comes from @code{coding-system-for-read}, if that is
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1252 non-@code{nil}; or else from the defaulting mechanism (@pxref{Default
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1253 Coding Systems}).
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1254
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1255 @strong{Warning:} Coding systems such as @code{undecided} which
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1256 determine the coding system from the data do not work entirely
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1257 reliably with asynchronous subprocess output. This is because Emacs
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1258 has to process asynchronous subprocess output in batches, as it
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1259 arrives. Emacs must try to detect the proper coding system from one
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1260 batch at a time, and this does not always work. Therefore, if at all
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1261 possible, specify a coding system that determines both the character
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1262 code conversion and the end of line conversion---that is, one like
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1263 @code{latin-1-unix}, rather than @code{undecided} or @code{latin-1}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1264
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1265 @cindex filter multibyte flag, of process
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1266 @cindex process filter multibyte flag
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1267 When Emacs calls a process filter function, it provides the process
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1268 output as a multibyte string or as a unibyte string according to the
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1269 process's filter multibyte flag. If the flag is non-@code{nil}, Emacs
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1270 decodes the output according to the process output coding system to
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1271 produce a multibyte string, and passes that to the process. If the
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1272 flag is @code{nil}, Emacs puts the output into a unibyte string, with
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1273 no decoding, and passes that.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1274
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1275 When you create a process, the filter multibyte flag takes its
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1276 initial value from @code{default-enable-multibyte-characters}. If you
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1277 want to change the flag later on, use
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1278 @code{set-process-filter-multibyte}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1279
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1280 @defun set-process-filter-multibyte process multibyte
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1281 This function sets the filter multibyte flag of @var{process}
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1282 to @var{multibyte}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1283 @end defun
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1284
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1285 @defun process-filter-multibyte-p process
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1286 This function returns the filter multibyte flag of @var{process}.
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1287 @end defun
d99e407c0a21 (Decoding Output): New node.
Richard M. Stallman <rms@gnu.org>
parents: 51922
diff changeset
1288
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1289 @node Accepting Output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1290 @subsection Accepting Output from Processes
76835
e5b96737f906 Improve indexing.
Eli Zaretskii <eliz@gnu.org>
parents: 76833
diff changeset
1291 @cindex accept input from processes
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1292
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1293 Output from asynchronous subprocesses normally arrives only while
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1294 Emacs is waiting for some sort of external event, such as elapsed time
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1295 or terminal input. Occasionally it is useful in a Lisp program to
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1296 explicitly permit output to arrive at a specific point, or even to wait
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1297 until output arrives from a process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1298
77655
61d6d08c1ecf (Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents: 77648
diff changeset
1299 @defun accept-process-output &optional process seconds millisec just-this-one
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1300 This function allows Emacs to read pending output from processes. The
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1301 output is inserted in the associated buffers or given to their filter
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1302 functions. If @var{process} is non-@code{nil} then this function does
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1303 not return until some output has been received from @var{process}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1304
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1305 @c Emacs 19 feature
77655
61d6d08c1ecf (Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents: 77648
diff changeset
1306 The arguments @var{seconds} and @var{millisec} let you specify timeout
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1307 periods. The former specifies a period measured in seconds and the
77655
61d6d08c1ecf (Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents: 77648
diff changeset
1308 latter specifies one measured in milliseconds. The two time periods
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1309 thus specified are added together, and @code{accept-process-output}
77648
5fac150d631b (Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents: 77123
diff changeset
1310 returns after that much time, whether or not there has been any
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1311 subprocess output.
77655
61d6d08c1ecf (Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents: 77648
diff changeset
1312
61d6d08c1ecf (Accepting Output): Revert most of previous change.
Richard M. Stallman <rms@gnu.org>
parents: 77648
diff changeset
1313 The argument @var{millisec} is semi-obsolete nowadays because
77648
5fac150d631b (Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents: 77123
diff changeset
1314 @var{seconds} can be a floating point number to specify waiting a
5fac150d631b (Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents: 77123
diff changeset
1315 fractional number of seconds. If @var{seconds} is 0, the function
5fac150d631b (Accepting Output): accept-process-output
Richard M. Stallman <rms@gnu.org>
parents: 77123
diff changeset
1316 accepts whatever output is pending but does not wait.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1317
59996
aac0a33f5772 Change release version from 21.4 to 22.1 throughout.
Kim F. Storm <storm@cua.dk>
parents: 58500
diff changeset
1318 @c Emacs 22.1 feature
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1319 If @var{process} is a process, and the argument @var{just-this-one} is
58405
4fe765649696 (Synchronous Processes, Output from Processes):
Jesper Harder <harder@ifa.au.dk>
parents: 57670
diff changeset
1320 non-@code{nil}, only output from that process is handled, suspending output
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1321 from other processes until some output has been received from that
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1322 process or the timeout expires. If @var{just-this-one} is an integer,
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1323 also inhibit running timers. This feature is generally not
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1324 recommended, but may be necessary for specific applications, such as
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1325 speech synthesis.
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1326
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1327 The function @code{accept-process-output} returns non-@code{nil} if it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1328 did get some output, or @code{nil} if the timeout expired before output
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1329 arrived.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1330 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1331
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1332 @node Sentinels
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1333 @section Sentinels: Detecting Process Status Changes
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1334 @cindex process sentinel
76993
55c9ef5f1559 Improve index entries.
Richard M. Stallman <rms@gnu.org>
parents: 76922
diff changeset
1335 @cindex sentinel (of process)
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1336
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1337 A @dfn{process sentinel} is a function that is called whenever the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1338 associated process changes status for any reason, including signals
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1339 (whether sent by Emacs or caused by the process's own actions) that
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1340 terminate, stop, or continue the process. The process sentinel is
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1341 also called if the process exits. The sentinel receives two
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1342 arguments: the process for which the event occurred, and a string
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1343 describing the type of event.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1344
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1345 The string describing the event looks like one of the following:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1346
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1347 @itemize @bullet
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
1348 @item
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1349 @code{"finished\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1350
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1351 @item
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1352 @code{"exited abnormally with code @var{exitcode}\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1353
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1354 @item
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1355 @code{"@var{name-of-signal}\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1356
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1357 @item
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1358 @code{"@var{name-of-signal} (core dumped)\n"}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1359 @end itemize
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1360
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1361 A sentinel runs only while Emacs is waiting (e.g., for terminal
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1362 input, or for time to elapse, or for process output). This avoids the
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1363 timing errors that could result from running them at random places in
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1364 the middle of other Lisp programs. A program can wait, so that
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1365 sentinels will run, by calling @code{sit-for} or @code{sleep-for}
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1366 (@pxref{Waiting}), or @code{accept-process-output} (@pxref{Accepting
22138
d4ac295a98b3 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 21682
diff changeset
1367 Output}). Emacs also allows sentinels to run when the command loop is
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1368 reading input. @code{delete-process} calls the sentinel when it
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1369 terminates a running process.
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1370
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1371 Emacs does not keep a queue of multiple reasons to call the sentinel
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1372 of one process; it records just the current status and the fact that
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1373 there has been a change. Therefore two changes in status, coming in
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1374 quick succession, can call the sentinel just once. However, process
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1375 termination will always run the sentinel exactly once. This is
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1376 because the process status can't change again after termination.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1377
66152
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1378 Emacs explicitly checks for output from the process before running
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1379 the process sentinel. Once the sentinel runs due to process
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1380 termination, no further output can arrive from the process.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1381
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1382 A sentinel that writes the output into the buffer of the process
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1383 should check whether the buffer is still alive. If it tries to insert
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1384 into a dead buffer, it will get an error. If the buffer is dead,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1385 @code{(buffer-name (process-buffer @var{process}))} returns @code{nil}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1386
66152
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1387 Quitting is normally inhibited within a sentinel---otherwise, the
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1388 effect of typing @kbd{C-g} at command level or to quit a user command
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1389 would be unpredictable. If you want to permit quitting inside a
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1390 sentinel, bind @code{inhibit-quit} to @code{nil}. In most cases, the
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1391 right way to do this is with the macro @code{with-local-quit}.
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1392 @xref{Quitting}.
6677034b52bb (Sentinels): Clarify about output and quitting.
Richard M. Stallman <rms@gnu.org>
parents: 64913
diff changeset
1393
12067
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1394 If an error happens during execution of a sentinel, it is caught
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1395 automatically, so that it doesn't stop the execution of whatever
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1396 programs was running when the sentinel was started. However, if
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1397 @code{debug-on-error} is non-@code{nil}, the error-catching is turned
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1398 off. This makes it possible to use the Lisp debugger to debug the
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1399 sentinel. @xref{Debugger}.
73dc8205d259 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 10039
diff changeset
1400
44428
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1401 While a sentinel is running, the process sentinel is temporarily
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1402 set to @code{nil} so that the sentinel won't run recursively.
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1403 For this reason it is not possible for a sentinel to specify
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1404 a new sentinel.
7e1a0877a121 Explain that sentinels cannot run recursively.
Richard M. Stallman <rms@gnu.org>
parents: 44345
diff changeset
1405
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1406 In earlier Emacs versions, every sentinel that did regular expression
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1407 searching or matching had to explicitly save and restore the match data.
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1408 Now Emacs does this automatically for sentinels; they never need to do
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1409 it explicitly. @xref{Match Data}.
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1410
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1411 @defun set-process-sentinel process sentinel
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1412 This function associates @var{sentinel} with @var{process}. If
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1413 @var{sentinel} is @code{nil}, then the process will have no sentinel.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1414 The default behavior when there is no sentinel is to insert a message in
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1415 the process's buffer when the process status changes.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1416
44345
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1417 Changes in process sentinel take effect immediately---if the sentinel
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1418 is slated to be run but has not been called yet, and you specify a new
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1419 sentinel, the eventual call to the sentinel will use the new one.
d2f43521efb4 New node Query Before Exit broken out of Deleting Processes.
Richard M. Stallman <rms@gnu.org>
parents: 39426
diff changeset
1420
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1421 @smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1422 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1423 (defun msg-me (process event)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1424 (princ
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1425 (format "Process: %s had the event `%s'" process event)))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1426 (set-process-sentinel (get-process "shell") 'msg-me)
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1427 @result{} msg-me
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1428 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1429 @group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1430 (kill-process (get-process "shell"))
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1431 @print{} Process: #<process shell> had the event `killed'
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1432 @result{} #<process shell>
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1433 @end group
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1434 @end smallexample
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1435 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1436
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1437 @defun process-sentinel process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1438 This function returns the sentinel of @var{process}, or @code{nil} if it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1439 has none.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1440 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1441
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1442 @defun waiting-for-user-input-p
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1443 While a sentinel or filter function is running, this function returns
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1444 non-@code{nil} if Emacs was waiting for keyboard input from the user at
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1445 the time the sentinel or filter function was called, @code{nil} if it
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1446 was not.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1447 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1448
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1449 @node Query Before Exit
49600
23a1cea22d13 Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents: 46340
diff changeset
1450 @section Querying Before Exit
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1451
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1452 When Emacs exits, it terminates all its subprocesses by sending them
60270
b87ad571b7a8 (Subprocess Creation): Explain nil in exec-path. Cleanup.
Richard M. Stallman <rms@gnu.org>
parents: 59996
diff changeset
1453 the @code{SIGHUP} signal. Because subprocesses may be doing
46340
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1454 valuable work, Emacs normally asks the user to confirm that it is ok
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1455 to terminate them. Each process has a query flag which, if
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1456 non-@code{nil}, says that Emacs should ask for confirmation before
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1457 exiting and thus killing that process. The default for the query flag
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1458 is @code{t}, meaning @emph{do} query.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1459
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1460 @defun process-query-on-exit-flag process
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1461 This returns the query flag of @var{process}.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1462 @end defun
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1463
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1464 @defun set-process-query-on-exit-flag process flag
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1465 This function sets the query flag of @var{process} to @var{flag}. It
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1466 returns @var{flag}.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1467
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1468 @smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1469 @group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1470 ;; @r{Don't query about the shell process}
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1471 (set-process-query-on-exit-flag (get-process "shell") nil)
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1472 @result{} t
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1473 @end group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1474 @end smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1475 @end defun
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1476
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1477 @defun process-kill-without-query process &optional do-query
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1478 This function clears the query flag of @var{process}, so that
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1479 Emacs will not query the user on account of that process.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1480
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1481 Actually, the function does more than that: it returns the old value of
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1482 the process's query flag, and sets the query flag to @var{do-query}.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1483 Please don't use this function to do those things any more---please
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1484 use the newer, cleaner functions @code{process-query-on-exit-flag} and
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1485 @code{set-process-query-on-exit-flag} in all but the simplest cases.
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1486 The only way you should use @code{process-kill-without-query} nowadays
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1487 is like this:
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1488
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1489 @smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1490 @group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1491 ;; @r{Don't query about the shell process}
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1492 (process-kill-without-query (get-process "shell"))
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1493 @end group
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1494 @end smallexample
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1495 @end defun
dd413d2af8ad Move the node Query Before Exit down.
Richard M. Stallman <rms@gnu.org>
parents: 44428
diff changeset
1496
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1497 @node Transaction Queues
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1498 @section Transaction Queues
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1499 @cindex transaction queue
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1500
21007
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1501 You can use a @dfn{transaction queue} to communicate with a subprocess
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1502 using transactions. First use @code{tq-create} to create a transaction
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1503 queue communicating with a specified process. Then you can call
66d807bdc5b4 *** empty log message ***
Richard M. Stallman <rms@gnu.org>
parents: 17611
diff changeset
1504 @code{tq-enqueue} to send a transaction.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1505
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1506 @defun tq-create process
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1507 This function creates and returns a transaction queue communicating with
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1508 @var{process}. The argument @var{process} should be a subprocess
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1509 capable of sending and receiving streams of bytes. It may be a child
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1510 process, or it may be a TCP connection to a server, possibly on another
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1511 machine.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1512 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1513
70034
db4c2d467e9a Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents: 69708
diff changeset
1514 @defun tq-enqueue queue question regexp closure fn &optional delay-question
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1515 This function sends a transaction to queue @var{queue}. Specifying the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1516 queue has the effect of specifying the subprocess to talk to.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1517
9009
7cdfcd5e71ff entered into RCS
Richard M. Stallman <rms@gnu.org>
parents: 7735
diff changeset
1518 The argument @var{question} is the outgoing message that starts the
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1519 transaction. The argument @var{fn} is the function to call when the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1520 corresponding answer comes back; it is called with two arguments:
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1521 @var{closure}, and the answer received.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1522
39426
4520697c8aa5 (tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents: 27370
diff changeset
1523 The argument @var{regexp} is a regular expression that should match
4520697c8aa5 (tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents: 27370
diff changeset
1524 text at the end of the entire answer, but nothing before; that's how
4520697c8aa5 (tq-enqueue): Clarify meaning of REGEXP.
Richard M. Stallman <rms@gnu.org>
parents: 27370
diff changeset
1525 @code{tq-enqueue} determines where the answer ends.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1526
70034
db4c2d467e9a Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents: 69708
diff changeset
1527 If the argument @var{delay-question} is non-nil, delay sending this
db4c2d467e9a Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents: 69708
diff changeset
1528 question until the process has finished replying to any previous
72548
e5542d6aad7f Miscellaneous tq-related fixes.
Miles Bader <miles@gnu.org>
parents: 72010
diff changeset
1529 questions. This produces more reliable results with some processes.
70034
db4c2d467e9a Revision: emacs@sv.gnu.org/emacs--devo--0--patch-220
Miles Bader <miles@gnu.org>
parents: 69708
diff changeset
1530
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1531 The return value of @code{tq-enqueue} itself is not meaningful.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1532 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1533
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1534 @defun tq-close queue
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1535 Shut down transaction queue @var{queue}, waiting for all pending transactions
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1536 to complete, and then terminate the connection or child process.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1537 @end defun
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1538
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1539 Transaction queues are implemented by means of a filter function.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1540 @xref{Filter Functions}.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1541
12098
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1542 @node Network
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1543 @section Network Connections
a6eb5f12b0f3 *** empty log message ***
Karl Heuer <kwzh@gnu.org>
parents: 12067
diff changeset
1544 @cindex network connection
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1545 @cindex TCP
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1546 @cindex UDP
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1547
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1548 Emacs Lisp programs can open stream (TCP) and datagram (UDP) network
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1549 connections to other processes on the same machine or other machines.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1550 A network connection is handled by Lisp much like a subprocess, and is
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1551 represented by a process object. However, the process you are
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1552 communicating with is not a child of the Emacs process, so it has no
52978
1a5c50faf357 Replace @sc{foo} with @acronym{FOO}.
Eli Zaretskii <eliz@gnu.org>
parents: 52830
diff changeset
1553 process @acronym{ID}, and you can't kill it or send it signals. All you
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1554 can do is send and receive data. @code{delete-process} closes the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1555 connection, but does not kill the program at the other end; that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1556 program must decide what to do about closure of the connection.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1557
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1558 Lisp programs can listen for connections by creating network
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1559 servers. A network server is also represented by a kind of process
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1560 object, but unlike a network connection, the network server never
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1561 transfers data itself. When it receives a connection request, it
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1562 creates a new network connection to represent the connection just
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1563 made. (The network connection inherits certain information, including
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1564 the process plist, from the server.) The network server then goes
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1565 back to listening for more connection requests.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1566
52818
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1567 Network connections and servers are created by calling
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1568 @code{make-network-process} with an argument list consisting of
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1569 keyword/argument pairs, for example @code{:server t} to create a
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1570 server process, or @code{:type 'datagram} to create a datagram
52830
b4281fb5cff8 (Network): Fix typo in xref (from Robert J. Chassell).
Kim F. Storm <storm@cua.dk>
parents: 52818
diff changeset
1571 connection. @xref{Low-Level Network}, for details. You can also use
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
1572 the @code{open-network-stream} function described below.
52818
39239421c7e3 (Network): Introduce make-network-process.
Kim F. Storm <storm@cua.dk>
parents: 52759
diff changeset
1573
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1574 You can distinguish process objects representing network connections
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1575 and servers from those representing subprocesses with the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1576 @code{process-status} function. The possible status values for
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1577 network connections are @code{open}, @code{closed}, @code{connect},
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1578 and @code{failed}. For a network server, the status is always
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1579 @code{listen}. None of those values is possible for a real
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1580 subprocess. @xref{Process Information}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1581
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1582 You can stop and resume operation of a network process by calling
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1583 @code{stop-process} and @code{continue-process}. For a server
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1584 process, being stopped means not accepting new connections. (Up to 5
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1585 connection requests will be queued for when you resume the server; you
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1586 can increase this limit, unless it is imposed by the operating
64720
3d8efebded47 Fix typo.
Juanma Barranquero <lekktu@gmail.com>
parents: 63583
diff changeset
1587 system.) For a network stream connection, being stopped means not
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1588 processing input (any arriving input waits until you resume the
52695
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1589 connection). For a datagram connection, some number of packets may be
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1590 queued but input may be lost. You can use the function
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1591 @code{process-command} to determine whether a network connection or
e5c94aabfe90 (Network): Say what stopped datagram connections do.
Richard M. Stallman <rms@gnu.org>
parents: 52598
diff changeset
1592 server is stopped; a non-@code{nil} value means yes.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1593
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1594 @defun open-network-stream name buffer-or-name host service
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1595 This function opens a TCP connection, and returns a process object
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1596 that represents the connection.
6558
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1597
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1598 The @var{name} argument specifies the name for the process object. It
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1599 is modified as necessary to make it unique.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1600
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1601 The @var{buffer-or-name} argument is the buffer to associate with the
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1602 connection. Output from the connection is inserted in the buffer,
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1603 unless you specify a filter function to handle the output. If
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1604 @var{buffer-or-name} is @code{nil}, it means that the connection is not
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1605 associated with any buffer.
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1606
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1607 The arguments @var{host} and @var{service} specify where to connect to;
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1608 @var{host} is the host name (a string), and @var{service} is the name of
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1609 a defined network service (a string) or a port number (an integer).
fa8ff07eaafc Initial revision
Richard M. Stallman <rms@gnu.org>
parents:
diff changeset
1610 @end defun
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
1611
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1612 @defun process-contact process &optional key
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1613 This function returns information about how a network process was set
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1614 up. For a connection, when @var{key} is @code{nil}, it returns
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1615 @code{(@var{hostname} @var{service})} which specifies what you
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1616 connected to.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1617
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1618 If @var{key} is @code{t}, the value is the complete status information
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1619 for the connection or server; that is, the list of keywords and values
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1620 specified in @code{make-network-process}, except that some of the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1621 values represent the current status instead of what you specified:
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1622
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1623 @table @code
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1624 @item :buffer
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1625 The associated value is the process buffer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1626 @item :filter
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1627 The associated value is the process filter function.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1628 @item :sentinel
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1629 The associated value is the process sentinel function.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1630 @item :remote
76922
e1bce097669d wording
Karl Berry <karl@gnu.org>
parents: 76878
diff changeset
1631 In a connection, the address in internal format of the remote peer.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1632 @item :local
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1633 The local address, in internal format.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1634 @item :service
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1635 In a server, if you specified @code{t} for @var{service},
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1636 this value is the actual port number.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1637 @end table
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1638
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1639 @code{:local} and @code{:remote} are included even if they were not
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1640 specified explicitly in @code{make-network-process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1641
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1642 If @var{key} is a keyword, the function returns the value corresponding
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1643 to that keyword.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1644
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1645 For an ordinary child process, this function always returns @code{t}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1646 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1647
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1648 @node Network Servers
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1649 @section Network Servers
76835
e5b96737f906 Improve indexing.
Eli Zaretskii <eliz@gnu.org>
parents: 76833
diff changeset
1650 @cindex network servers
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1651
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1652 You create a server by calling @code{make-network-process} with
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1653 @code{:server t}. The server will listen for connection requests from
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1654 clients. When it accepts a client connection request, that creates a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1655 new network connection, itself a process object, with the following
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1656 parameters:
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1657
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1658 @itemize @bullet
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1659 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1660 The connection's process name is constructed by concatenating the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1661 server process' @var{name} with a client identification string. The
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1662 client identification string for an IPv4 connection looks like
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1663 @samp{<@var{a}.@var{b}.@var{c}.@var{d}:@var{p}>}. Otherwise, it is a
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1664 unique number in brackets, as in @samp{<@var{nnn}>}. The number
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1665 is unique for each connection in the Emacs session.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1666
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1667 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1668 If the server's filter is non-@code{nil}, the connection process does
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1669 not get a separate process buffer; otherwise, Emacs creates a new
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1670 buffer for the purpose. The buffer name is the server's buffer name
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1671 or process name, concatenated with the client identification string.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1672
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1673 The server's process buffer value is never used directly by Emacs, but
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1674 it is passed to the log function, which can log connections by
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1675 inserting text there.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1676
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1677 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1678 The communication type and the process filter and sentinel are
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1679 inherited from those of the server. The server never directly
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1680 uses its filter and sentinel; their sole purpose is to initialize
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1681 connections made to the server.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1682
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1683 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1684 The connection's process contact info is set according to the client's
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1685 addressing information (typically an IP address and a port number).
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1686 This information is associated with the @code{process-contact}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1687 keywords @code{:host}, @code{:service}, @code{:remote}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1688
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1689 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1690 The connection's local address is set up according to the port
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1691 number used for the connection.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1692
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1693 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1694 The client process' plist is initialized from the server's plist.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1695 @end itemize
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1696
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1697 @node Datagrams
56703
fdf8546f215b (Accepting Output): Add `just-this-one' arg to `accept-process-output'.
Kim F. Storm <storm@cua.dk>
parents: 56215
diff changeset
1698 @section Datagrams
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1699 @cindex datagrams
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1700
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1701 A datagram connection communicates with individual packets rather
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1702 than streams of data. Each call to @code{process-send} sends one
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1703 datagram packet (@pxref{Input to Processes}), and each datagram
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1704 received results in one call to the filter function.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1705
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1706 The datagram connection doesn't have to talk with the same remote
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1707 peer all the time. It has a @dfn{remote peer address} which specifies
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1708 where to send datagrams to. Each time an incoming datagram is passed
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1709 to the filter function, the peer address is set to the address that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1710 datagram came from; that way, if the filter function sends a datagram,
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1711 it will go back to that place. You can specify the remote peer
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1712 address when you create the datagram connection using the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1713 @code{:remote} keyword. You can change it later on by calling
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1714 @code{set-process-datagram-address}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1715
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1716 @defun process-datagram-address process
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1717 If @var{process} is a datagram connection or server, this function
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1718 returns its remote peer address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1719 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1720
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1721 @defun set-process-datagram-address process address
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1722 If @var{process} is a datagram connection or server, this function
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1723 sets its remote peer address to @var{address}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1724 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1725
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1726 @node Low-Level Network
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1727 @section Low-Level Network Access
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1728
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1729 You can also create network connections by operating at a lower
76878
e4d2810db0e9 wording matters
Karl Berry <karl@gnu.org>
parents: 76837
diff changeset
1730 level than that of @code{open-network-stream}, using
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1731 @code{make-network-process}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1732
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1733 @menu
72010
248521aae95b (Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents: 71999
diff changeset
1734 * Proc: Network Processes. Using @code{make-network-process}.
248521aae95b (Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents: 71999
diff changeset
1735 * Options: Network Options. Further control over network connections.
248521aae95b (Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents: 71999
diff changeset
1736 * Features: Network Feature Testing.
248521aae95b (Low-Level Network): Make menu more convenient.
Richard M. Stallman <rms@gnu.org>
parents: 71999
diff changeset
1737 Determining which network features work on
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1738 the machine you are using.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1739 @end menu
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1740
71999
77f1713977dd (Low-Level Network): Rename node "Make Network"
Kim F. Storm <storm@cua.dk>
parents: 71957
diff changeset
1741 @node Network Processes
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1742 @subsection @code{make-network-process}
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1743
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1744 The basic function for creating network connections and network
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1745 servers is @code{make-network-process}. It can do either of those
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1746 jobs, depending on the arguments you give it.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1747
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1748 @defun make-network-process &rest args
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1749 This function creates a network connection or server and returns the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1750 process object that represents it. The arguments @var{args} are a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1751 list of keyword/argument pairs. Omitting a keyword is always
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1752 equivalent to specifying it with value @code{nil}, except for
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1753 @code{:coding}, @code{:filter-multibyte}, and @code{:reuseaddr}. Here
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1754 are the meaningful keywords:
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1755
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1756 @table @asis
62230
98c45ed7ca3f (Low-Level Network): Fix typo.
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 62229
diff changeset
1757 @item :name @var{name}
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1758 Use the string @var{name} as the process name. It is modified if
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1759 necessary to make it unique.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1760
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1761 @item :type @var{type}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1762 Specify the communication type. A value of @code{nil} specifies a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1763 stream connection (the default); @code{datagram} specifies a datagram
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1764 connection. Both connections and servers can be of either type.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1765
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1766 @item :server @var{server-flag}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1767 If @var{server-flag} is non-@code{nil}, create a server. Otherwise,
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1768 create a connection. For a stream type server, @var{server-flag} may
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1769 be an integer which then specifies the length of the queue of pending
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1770 connections to the server. The default queue length is 5.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1771
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1772 @item :host @var{host}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1773 Specify the host to connect to. @var{host} should be a host name or
70603
0d799d14ece7 Fix spelling errors.
Eli Zaretskii <eliz@gnu.org>
parents: 70034
diff changeset
1774 Internet address, as a string, or the symbol @code{local} to specify
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1775 the local host. If you specify @var{host} for a server, it must
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1776 specify a valid address for the local host, and only clients
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1777 connecting to that address will be accepted.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1778
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1779 @item :service @var{service}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1780 @var{service} specifies a port number to connect to, or, for a server,
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1781 the port number to listen on. It should be a service name that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1782 translates to a port number, or an integer specifying the port number
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1783 directly. For a server, it can also be @code{t}, which means to let
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1784 the system select an unused port number.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1785
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1786 @item :family @var{family}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1787 @var{family} specifies the address (and protocol) family for
68029
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
1788 communication. @code{nil} means determine the proper address family
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
1789 automatically for the given @var{host} and @var{service}.
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
1790 @code{local} specifies a Unix socket, in which case @var{host} is
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
1791 ignored. @code{ipv4} and @code{ipv6} specify to use IPv4 and IPv6
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
1792 respectively.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1793
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1794 @item :local @var{local-address}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1795 For a server process, @var{local-address} is the address to listen on.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1796 It overrides @var{family}, @var{host} and @var{service}, and you
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1797 may as well not specify them.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1798
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1799 @item :remote @var{remote-address}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1800 For a connection, @var{remote-address} is the address to connect to.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1801 It overrides @var{family}, @var{host} and @var{service}, and you
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1802 may as well not specify them.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1803
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1804 For a datagram server, @var{remote-address} specifies the initial
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1805 setting of the remote datagram address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1806
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1807 The format of @var{local-address} or @var{remote-address} depends on
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1808 the address family:
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1809
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1810 @itemize -
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1811 @item
68009
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1812 An IPv4 address is represented as a five-element vector of four 8-bit
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1813 integers and one 16-bit integer
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1814 @code{[@var{a} @var{b} @var{c} @var{d} @var{p}]} corresponding to
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1815 numeric IPv4 address @var{a}.@var{b}.@var{c}.@var{d} and port number
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1816 @var{p}.
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1817
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1818 @item
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1819 An IPv6 address is represented as a nine-element vector of 16-bit
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1820 integers @code{[@var{a} @var{b} @var{c} @var{d} @var{e} @var{f}
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1821 @var{g} @var{h} @var{p}]} corresponding to numeric IPv6 address
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1822 @var{a}:@var{b}:@var{c}:@var{d}:@var{e}:@var{f}:@var{g}:@var{h} and
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1823 port number @var{p}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1824
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1825 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1826 A local address is represented as a string which specifies the address
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1827 in the local address space.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1828
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1829 @item
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1830 An ``unsupported family'' address is represented by a cons
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1831 @code{(@var{f} . @var{av})}, where @var{f} is the family number and
54265
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1832 @var{av} is a vector specifying the socket address using one element
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1833 per address data byte. Do not rely on this format in portable code,
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1834 as it may depend on implementation defined constants, data sizes, and
1f7cd275e61f Fix typos.
Richard M. Stallman <rms@gnu.org>
parents: 54004
diff changeset
1835 data structure alignment.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1836 @end itemize
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1837
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1838 @item :nowait @var{bool}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1839 If @var{bool} is non-@code{nil} for a stream connection, return
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1840 without waiting for the connection to complete. When the connection
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1841 succeeds or fails, Emacs will call the sentinel function, with a
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1842 second argument matching @code{"open"} (if successful) or
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1843 @code{"failed"}. The default is to block, so that
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1844 @code{make-network-process} does not return until the connection
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1845 has succeeded or failed.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1846
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1847 @item :stop @var{stopped}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1848 Start the network connection or server in the `stopped' state if
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1849 @var{stopped} is non-@code{nil}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1850
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1851 @item :buffer @var{buffer}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1852 Use @var{buffer} as the process buffer.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1853
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1854 @item :coding @var{coding}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1855 Use @var{coding} as the coding system for this process. To specify
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1856 different coding systems for decoding data from the connection and for
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1857 encoding data sent to it, specify @code{(@var{decoding} .
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1858 @var{encoding})} for @var{coding}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1859
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1860 If you don't specify this keyword at all, the default
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1861 is to determine the coding systems from the data.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1862
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1863 @item :noquery @var{query-flag}
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
1864 Initialize the process query flag to @var{query-flag}.
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
1865 @xref{Query Before Exit}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1866
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1867 @item :filter @var{filter}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1868 Initialize the process filter to @var{filter}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1869
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1870 @item :filter-multibyte @var{bool}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1871 If @var{bool} is non-@code{nil}, strings given to the process filter
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1872 are multibyte, otherwise they are unibyte. If you don't specify this
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1873 keyword at all, the default is that the strings are multibyte if
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1874 @code{default-enable-multibyte-characters} is non-@code{nil}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1875
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1876 @item :sentinel @var{sentinel}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1877 Initialize the process sentinel to @var{sentinel}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1878
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1879 @item :log @var{log}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1880 Initialize the log function of a server process to @var{log}. The log
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1881 function is called each time the server accepts a network connection
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1882 from a client. The arguments passed to the log function are
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1883 @var{server}, @var{connection}, and @var{message}, where @var{server}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1884 is the server process, @var{connection} is the new process for the
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1885 connection, and @var{message} is a string describing what has
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1886 happened.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1887
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1888 @item :plist @var{plist}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1889 Initialize the process plist to @var{plist}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1890 @end table
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
1891
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1892 The original argument list, modified with the actual connection
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1893 information, is available via the @code{process-contact} function.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1894 @end defun
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1895
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1896 @node Network Options
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1897 @subsection Network Options
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1898
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1899 The following network options can be specified when you create a
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1900 network process. Except for @code{:reuseaddr}, you can also set or
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1901 modify these options later, using @code{set-network-process-option}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1902
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1903 For a server process, the options specified with
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1904 @code{make-network-process} are not inherited by the client
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1905 connections, so you will need to set the necessary options for each
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1906 child connection as it is created.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1907
52598
a0ba017ef9ef (Low-Level Network): Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents: 52596
diff changeset
1908 @table @asis
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1909 @item :bindtodevice @var{device-name}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1910 If @var{device-name} is a non-empty string identifying a network
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1911 interface name (see @code{network-interface-list}), only handle
54777
5745bf089073 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54265
diff changeset
1912 packets received on that interface. If @var{device-name} is @code{nil}
5745bf089073 Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54265
diff changeset
1913 (the default), handle packets received on any interface.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1914
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1915 Using this option may require special privileges on some systems.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1916
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1917 @item :broadcast @var{broadcast-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1918 If @var{broadcast-flag} is non-@code{nil} for a datagram process, the
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1919 process will receive datagram packet sent to a broadcast address, and
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1920 be able to send packets to a broadcast address. Ignored for a stream
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1921 connection.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1922
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1923 @item :dontroute @var{dontroute-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1924 If @var{dontroute-flag} is non-@code{nil}, the process can only send
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1925 to hosts on the same network as the local host.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1926
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1927 @item :keepalive @var{keepalive-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1928 If @var{keepalive-flag} is non-@code{nil} for a stream connection,
54004
8cc16a7bf4ce (Low-Level Network): Fix a typo.
Eli Zaretskii <eliz@is.elta.co.il>
parents: 53292
diff changeset
1929 enable exchange of low-level keep-alive messages.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1930
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1931 @item :linger @var{linger-arg}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1932 If @var{linger-arg} is non-@code{nil}, wait for successful
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1933 transmission of all queued packets on the connection before it is
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1934 deleted (see @code{delete-process}). If @var{linger-arg} is an
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1935 integer, it specifies the maximum time in seconds to wait for queued
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1936 packets to be sent before closing the connection. Default is
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1937 @code{nil} which means to discard unsent queued packets when the
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1938 process is deleted.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1939
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1940 @item :oobinline @var{oobinline-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1941 If @var{oobinline-flag} is non-@code{nil} for a stream connection,
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1942 receive out-of-band data in the normal data stream. Otherwise, ignore
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1943 out-of-band data.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1944
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1945 @item :priority @var{priority}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1946 Set the priority for packets sent on this connection to the integer
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1947 @var{priority}. The interpretation of this number is protocol
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1948 specific, such as setting the TOS (type of service) field on IP
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1949 packets sent on this connection. It may also have system dependent
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1950 effects, such as selecting a specific output queue on the network
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1951 interface.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1952
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1953 @item :reuseaddr @var{reuseaddr-flag}
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1954 If @var{reuseaddr-flag} is non-@code{nil} (the default) for a stream
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1955 server process, allow this server to reuse a specific port number (see
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1956 @code{:service}) unless another process on this host is already
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1957 listening on that port. If @var{reuseaddr-flag} is @code{nil}, there
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1958 may be a period of time after the last use of that port (by any
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1959 process on the host), where it is not possible to make a new server on
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1960 that port.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1961 @end table
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1962
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1963 @defun set-network-process-option process option value
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1964 This function sets or modifies a network option for network process
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1965 @var{process}. See @code{make-network-process} for details of options
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1966 @var{option} and their corresponding values @var{value}.
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1967
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1968 The current setting of an option is available via the
54864
ca548870d87a Markup fixes.
Jesper Harder <harder@ifa.au.dk>
parents: 54777
diff changeset
1969 @code{process-contact} function.
52596
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1970 @end defun
f277840b17b2 (Network, Network Servers): Fix typos.
Kim F. Storm <storm@cua.dk>
parents: 52542
diff changeset
1971
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1972 @node Network Feature Testing
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1973 @subsection Testing Availability of Network Features
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1974
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1975 To test for the availability of a given network feature, use
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1976 @code{featurep} like this:
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1977
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1978 @example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1979 (featurep 'make-network-process '(@var{keyword} @var{value}))
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1980 @end example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1981
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1982 @noindent
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1983 The result of the first form is @code{t} if it works to specify
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1984 @var{keyword} with value @var{value} in @code{make-network-process}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1985 The result of the second form is @code{t} if @var{keyword} is
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1986 supported by @code{make-network-process}. Here are some of the
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1987 @var{keyword}---@var{value} pairs you can test in
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1988 this way.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1989
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1990 @table @code
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1991 @item (:nowait t)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1992 Non-@code{nil} if non-blocking connect is supported.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1993 @item (:type datagram)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1994 Non-@code{nil} if datagrams are supported.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1995 @item (:family local)
70603
0d799d14ece7 Fix spelling errors.
Eli Zaretskii <eliz@gnu.org>
parents: 70034
diff changeset
1996 Non-@code{nil} if local (a.k.a.@: ``UNIX domain'') sockets are supported.
68009
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1997 @item (:family ipv6)
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
1998 Non-@code{nil} if IPv6 is supported.
64913
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
1999 @item (:service t)
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2000 Non-@code{nil} if the system can select the port for a server.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2001 @end table
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2002
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2003 To test for the availability of a given network option, use
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2004 @code{featurep} like this:
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2005
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2006 @example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2007 (featurep 'make-network-process '@var{keyword})
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2008 @end example
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2009
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2010 @noindent
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2011 Here are some of the options you can test in this way.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2012
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2013 @table @code
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2014 @item :bindtodevice
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2015 @itemx :broadcast
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2016 @itemx :dontroute
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2017 @itemx :keepalive
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2018 @itemx :linger
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2019 @itemx :oobinline
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2020 @itemx :priority
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2021 @itemx :reuseaddr
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2022 That particular network option is supported by
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2023 @code{make-network-process} and @code{set-network-process-option}.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2024 @end table
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2025
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2026 @node Misc Network
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2027 @section Misc Network Facilities
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2028
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2029 These additional functions are useful for creating and operating
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2030 on network connections.
989a5fc8da03 (Misc Network, Network Feature Testing)
Richard M. Stallman <rms@gnu.org>
parents: 64889
diff changeset
2031
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2032 @defun network-interface-list
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2033 This function returns a list describing the network interfaces
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2034 of the machine you are using. The value is an alist whose
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2035 elements have the form @code{(@var{name} . @var{address})}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2036 @var{address} has the same form as the @var{local-address}
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2037 and @var{remote-address} arguments to @code{make-network-process}.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2038 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2039
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2040 @defun network-interface-info ifname
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2041 This function returns information about the network interface named
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2042 @var{ifname}. The value is a list of the form
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2043 @code{(@var{addr} @var{bcast} @var{netmask} @var{hwaddr} @var{flags})}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2044
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2045 @table @var
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2046 @item addr
70603
0d799d14ece7 Fix spelling errors.
Eli Zaretskii <eliz@gnu.org>
parents: 70034
diff changeset
2047 The Internet protocol address.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2048 @item bcast
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2049 The broadcast address.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2050 @item netmask
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2051 The network mask.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2052 @item hwaddr
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2053 The layer 2 address (Ethernet MAC address, for instance).
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2054 @item flags
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2055 The current flags of the interface.
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2056 @end table
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2057 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2058
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2059 @defun format-network-address address &optional omit-port
52759
b85ed952e000 Fix typo.
Richard M. Stallman <rms@gnu.org>
parents: 52695
diff changeset
2060 This function converts the Lisp representation of a network address to
68009
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
2061 a string.
68029
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2062
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2063 A five-element vector @code{[@var{a} @var{b} @var{c} @var{d} @var{p}]}
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2064 represents an IPv4 address @var{a}.@var{b}.@var{c}.@var{d} and port
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2065 number @var{p}. @code{format-network-address} converts that to the
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2066 string @code{"@var{a}.@var{b}.@var{c}.@var{d}:@var{p}"}.
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2067
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2068 A nine-element vector @code{[@var{a} @var{b} @var{c} @var{d} @var{e}
77123
4d7a5d9bbe76 improve breaks in 8.5x11
Karl Berry <karl@gnu.org>
parents: 76993
diff changeset
2069 @var{f} @var{g} @var{h} @var{p}]} represents an IPv6 address along
4d7a5d9bbe76 improve breaks in 8.5x11
Karl Berry <karl@gnu.org>
parents: 76993
diff changeset
2070 with a port number. @code{format-network-address} converts that to
4d7a5d9bbe76 improve breaks in 8.5x11
Karl Berry <karl@gnu.org>
parents: 76993
diff changeset
2071 the string
68009
dd865bff7357 (Make Network): Add IPv6 addresses and handling.
Kim F. Storm <storm@cua.dk>
parents: 67044
diff changeset
2072 @code{"[@var{a}:@var{b}:@var{c}:@var{d}:@var{e}:@var{f}:@var{g}:@var{h}]:@var{p}"}.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2073
68029
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2074 If the vector does not include the port number, @var{p}, or if
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2075 @var{omit-port} is non-@code{nil}, the result does not include the
61a03413f18b (Misc Network, Make Network): Minor cleanups.
Richard M. Stallman <rms@gnu.org>
parents: 68010
diff changeset
2076 @code{:@var{p}} suffix.
52542
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2077 @end defun
0df4c5163e4e (Process Information): Add list-processes arg QUERY-ONLY.
Richard M. Stallman <rms@gnu.org>
parents: 52401
diff changeset
2078
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2079 @node Byte Packing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2080 @section Packing and Unpacking Byte Arrays
76833
8c3661f15764 Improve indexing.
Eli Zaretskii <eliz@gnu.org>
parents: 75992
diff changeset
2081 @cindex byte packing and unpacking
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2082
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2083 This section describes how to pack and unpack arrays of bytes,
63563
c78918330811 (Byte Packing): Fix ungrammatical sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63562
diff changeset
2084 usually for binary network protocols. These functions convert byte arrays
c78918330811 (Byte Packing): Fix ungrammatical sentence.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63562
diff changeset
2085 to alists, and vice versa. The byte array can be represented as a
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2086 unibyte string or as a vector of integers, while the alist associates
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2087 symbols either with fixed-size objects or with recursive sub-alists.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2088
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2089 @cindex serializing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2090 @cindex deserializing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2091 @cindex packing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2092 @cindex unpacking
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2093 Conversion from byte arrays to nested alists is also known as
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2094 @dfn{deserializing} or @dfn{unpacking}, while going in the opposite
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2095 direction is also known as @dfn{serializing} or @dfn{packing}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2096
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2097 @menu
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2098 * Bindat Spec:: Describing data layout.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2099 * Bindat Functions:: Doing the unpacking and packing.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2100 * Bindat Examples:: Samples of what bindat.el can do for you!
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2101 @end menu
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2102
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2103 @node Bindat Spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2104 @subsection Describing Data Layout
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2105
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2106 To control unpacking and packing, you write a @dfn{data layout
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2107 specification}, a special nested list describing named and typed
63568
3586a05f26ff Fix typo.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63563
diff changeset
2108 @dfn{fields}. This specification controls length of each field to be
72723
e32b692e4da5 (Bindat Spec): Suggest names ending in -bindat-spec.
Richard M. Stallman <rms@gnu.org>
parents: 72640
diff changeset
2109 processed, and how to pack or unpack it. We normally keep bindat specs
e32b692e4da5 (Bindat Spec): Suggest names ending in -bindat-spec.
Richard M. Stallman <rms@gnu.org>
parents: 72640
diff changeset
2110 in variables whose names end in @samp{-bindat-spec}; that kind of name
e32b692e4da5 (Bindat Spec): Suggest names ending in -bindat-spec.
Richard M. Stallman <rms@gnu.org>
parents: 72640
diff changeset
2111 is automatically recognized as ``risky.''
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2112
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2113 @cindex endianness
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2114 @cindex big endian
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2115 @cindex little endian
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2116 @cindex network byte ordering
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2117 A field's @dfn{type} describes the size (in bytes) of the object
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2118 that the field represents and, in the case of multibyte fields, how
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2119 the bytes are ordered within the field. The two possible orderings
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2120 are ``big endian'' (also known as ``network byte ordering'') and
71957
61cb5aae3bc3 Put period and comma inside quotes.
Richard M. Stallman <rms@gnu.org>
parents: 71697
diff changeset
2121 ``little endian.'' For instance, the number @code{#x23cd} (decimal
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2122 9165) in big endian would be the two bytes @code{#x23} @code{#xcd};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2123 and in little endian, @code{#xcd} @code{#x23}. Here are the possible
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2124 type values:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2125
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2126 @table @code
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2127 @item u8
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2128 @itemx byte
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2129 Unsigned byte, with length 1.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2130
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2131 @item u16
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2132 @itemx word
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2133 @itemx short
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2134 Unsigned integer in network byte order, with length 2.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2135
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2136 @item u24
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2137 Unsigned integer in network byte order, with length 3.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2138
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2139 @item u32
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2140 @itemx dword
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2141 @itemx long
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2142 Unsigned integer in network byte order, with length 4.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2143 Note: These values may be limited by Emacs' integer implementation limits.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2144
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2145 @item u16r
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2146 @itemx u24r
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2147 @itemx u32r
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2148 Unsigned integer in little endian order, with length 2, 3 and 4, respectively.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2149
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2150 @item str @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2151 String of length @var{len}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2152
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2153 @item strz @var{len}
74952
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2154 Zero-terminated string, in a fixed-size field with length @var{len}.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2155
75987
9012e6e12d0e (Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents: 75250
diff changeset
2156 @item vec @var{len} [@var{type}]
9012e6e12d0e (Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents: 75250
diff changeset
2157 Vector of @var{len} elements of type @var{type}, or bytes if not
9012e6e12d0e (Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents: 75250
diff changeset
2158 @var{type} is specified.
9012e6e12d0e (Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents: 75250
diff changeset
2159 The @var{type} is any of the simple types above, or another vector
9012e6e12d0e (Bindat Spec): Vector types can have optional element type.
Kim F. Storm <storm@cua.dk>
parents: 75250
diff changeset
2160 specified as a list @code{(vec @var{len} [@var{type}])}.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2161
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2162 @item ip
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2163 Four-byte vector representing an Internet address. For example:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2164 @code{[127 0 0 1]} for localhost.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2165
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2166 @item bits @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2167 List of set bits in @var{len} bytes. The bytes are taken in big
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2168 endian order and the bits are numbered starting with @code{8 *
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2169 @var{len} @minus{} 1} and ending with zero. For example: @code{bits
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2170 2} unpacks @code{#x28} @code{#x1c} to @code{(2 3 4 11 13)} and
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2171 @code{#x1c} @code{#x28} to @code{(3 5 10 11 12)}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2172
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2173 @item (eval @var{form})
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2174 @var{form} is a Lisp expression evaluated at the moment the field is
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2175 unpacked or packed. The result of the evaluation should be one of the
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2176 above-listed type specifications.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2177 @end table
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2178
74970
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2179 For a fixed-size field, the length @var{len} is given as an integer
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2180 specifying the number of bytes in the field.
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2181
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2182 When the length of a field is not fixed, it typically depends on the
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2183 value of a preceding field. In this case, the length @var{len} can be
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2184 given either as a list @code{(@var{name} ...)} identifying a
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2185 @dfn{field name} in the format specified for @code{bindat-get-field}
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2186 below, or by an expression @code{(eval @var{form})} where @var{form}
d278931df0dd (Bindat Spec): Clarify using field names in
Kim F. Storm <storm@cua.dk>
parents: 74952
diff changeset
2187 should evaluate to an integer, specifying the field length.
74952
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2188
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2189 A field specification generally has the form @code{([@var{name}]
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2190 @var{handler})}. The square braces indicate that @var{name} is
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2191 optional. (Don't use names that are symbols meaningful as type
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2192 specifications (above) or handler specifications (below), since that
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2193 would be ambiguous.) @var{name} can be a symbol or the expression
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2194 @code{(eval @var{form})}, in which case @var{form} should evaluate to
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2195 a symbol.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2196
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2197 @var{handler} describes how to unpack or pack the field and can be one
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2198 of the following:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2199
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2200 @table @code
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2201 @item @var{type}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2202 Unpack/pack this field according to the type specification @var{type}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2203
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2204 @item eval @var{form}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2205 Evaluate @var{form}, a Lisp expression, for side-effect only. If the
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2206 field name is specified, the value is bound to that field name.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2207
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2208 @item fill @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2209 Skip @var{len} bytes. In packing, this leaves them unchanged,
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2210 which normally means they remain zero. In unpacking, this means
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2211 they are ignored.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2212
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2213 @item align @var{len}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2214 Skip to the next multiple of @var{len} bytes.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2215
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2216 @item struct @var{spec-name}
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2217 Process @var{spec-name} as a sub-specification. This describes a
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2218 structure nested within another structure.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2219
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2220 @item union @var{form} (@var{tag} @var{spec})@dots{}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2221 @c ??? I don't see how one would actually use this.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2222 @c ??? what kind of expression would be useful for @var{form}?
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2223 Evaluate @var{form}, a Lisp expression, find the first @var{tag}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2224 that matches it, and process its associated data layout specification
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2225 @var{spec}. Matching can occur in one of three ways:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2226
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2227 @itemize
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2228 @item
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2229 If a @var{tag} has the form @code{(eval @var{expr})}, evaluate
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2230 @var{expr} with the variable @code{tag} dynamically bound to the value
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2231 of @var{form}. A non-@code{nil} result indicates a match.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2232
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2233 @item
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2234 @var{tag} matches if it is @code{equal} to the value of @var{form}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2235
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2236 @item
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2237 @var{tag} matches unconditionally if it is @code{t}.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2238 @end itemize
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2239
71394
4b4feab31516 (Bindat Spec): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents: 71035
diff changeset
2240 @item repeat @var{count} @var{field-specs}@dots{}
4b4feab31516 (Bindat Spec): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents: 71035
diff changeset
2241 Process the @var{field-specs} recursively, in order, then repeat
4b4feab31516 (Bindat Spec): Clarify previous change.
Richard M. Stallman <rms@gnu.org>
parents: 71035
diff changeset
2242 starting from the first one, processing all the specs @var{count}
74952
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2243 times overall. The @var{count} is given using the same formats as a
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2244 field length---if an @code{eval} form is used, it is evaluated just once.
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2245 For correct operation, each spec in @var{field-specs} must include a name.
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2246 @end table
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2247
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2248 For the @code{(eval @var{form})} forms used in a bindat specification,
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2249 the @var{form} can access and update these dynamically bound variables
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2250 during evaluation:
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2251
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2252 @table @code
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2253 @item last
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2254 Value of the last field processed.
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2255
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2256 @item bindat-raw
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2257 The data as a byte array.
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2258
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2259 @item bindat-idx
75050
27f521750ce8 (Bindat Spec): Fix Texinfo usage.
Richard M. Stallman <rms@gnu.org>
parents: 74970
diff changeset
2260 Current index (within @code{bindat-raw}) for unpacking or packing.
74952
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2261
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2262 @item struct
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2263 The alist containing the structured data that have been unpacked so
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2264 far, or the entire structure being packed. You can use
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2265 @code{bindat-get-field} to access specific fields of this structure.
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2266
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2267 @item count
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2268 @itemx index
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2269 Inside a @code{repeat} block, these contain the maximum number of
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2270 repetitions (as specified by the @var{count} parameter), and the
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2271 current repetition number (counting from 0). Setting @code{count} to
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2272 zero will terminate the inner-most repeat block after the current
0e7b380a6c47 (Bindat Spec): Explain eval forms and lengths better.
Kim F. Storm <storm@cua.dk>
parents: 72723
diff changeset
2273 repetition has completed.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2274 @end table
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2275
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2276 @node Bindat Functions
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2277 @subsection Functions to Unpack and Pack Bytes
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2278
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2279 In the following documentation, @var{spec} refers to a data layout
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2280 specification, @code{bindat-raw} to a byte array, and @var{struct} to an
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2281 alist representing unpacked field data.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2282
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2283 @defun bindat-unpack spec bindat-raw &optional bindat-idx
70907
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2284 This function unpacks data from the unibyte string or byte
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2285 array @code{bindat-raw}
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2286 according to @var{spec}. Normally this starts unpacking at the
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2287 beginning of the byte array, but if @var{bindat-idx} is non-@code{nil}, it
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2288 specifies a zero-based starting position to use instead.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2289
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2290 The value is an alist or nested alist in which each element describes
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2291 one unpacked field.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2292 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2293
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2294 @defun bindat-get-field struct &rest name
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2295 This function selects a field's data from the nested alist
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2296 @var{struct}. Usually @var{struct} was returned by
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2297 @code{bindat-unpack}. If @var{name} corresponds to just one argument,
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2298 that means to extract a top-level field value. Multiple @var{name}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2299 arguments specify repeated lookup of sub-structures. An integer name
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2300 acts as an array index.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2301
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2302 For example, if @var{name} is @code{(a b 2 c)}, that means to find
67044
a40ac89f9800 (Bindat Functions): Say "third" to refer to zero-based index "2".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 66152
diff changeset
2303 field @code{c} in the third element of subfield @code{b} of field
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2304 @code{a}. (This corresponds to @code{struct.a.b[2].c} in C.)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2305 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2306
70985
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2307 Although packing and unpacking operations change the organization of
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2308 data (in memory), they preserve the data's @dfn{total length}, which is
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2309 the sum of all the fields' lengths, in bytes. This value is not
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2310 generally inherent in either the specification or alist alone; instead,
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2311 both pieces of information contribute to its calculation. Likewise, the
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2312 length of a string or array being unpacked may be longer than the data's
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2313 total length as described by the specification.
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2314
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2315 @defun bindat-length spec struct
70985
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2316 This function returns the total length of the data in @var{struct},
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2317 according to @var{spec}.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2318 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2319
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2320 @defun bindat-pack spec struct &optional bindat-raw bindat-idx
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2321 This function returns a byte array packed according to @var{spec} from
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2322 the data in the alist @var{struct}. Normally it creates and fills a
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2323 new byte array starting at the beginning. However, if @var{bindat-raw}
70907
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2324 is non-@code{nil}, it specifies a pre-allocated unibyte string or vector to
71035
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2325 pack into. If @var{bindat-idx} is non-@code{nil}, it specifies the starting
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2326 offset for packing into @code{bindat-raw}.
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2327
3574bac9e172 (Bindat Functions): Rename `pos' and `raw-data' to
Kim F. Storm <storm@cua.dk>
parents: 71013
diff changeset
2328 When pre-allocating, you should make sure @code{(length @var{bindat-raw})}
70985
183e16c7e0b2 (Bindat Functions): Explain term "total length".
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70907
diff changeset
2329 meets or exceeds the total length to avoid an out-of-range error.
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2330 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2331
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2332 @defun bindat-ip-to-string ip
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2333 Convert the Internet address vector @var{ip} to a string in the usual
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2334 dotted notation.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2335
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2336 @example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2337 (bindat-ip-to-string [127 0 0 1])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2338 @result{} "127.0.0.1"
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2339 @end example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2340 @end defun
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2341
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2342 @node Bindat Examples
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2343 @subsection Examples of Byte Unpacking and Packing
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2344
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2345 Here is a complete example of byte unpacking and packing:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2346
63569
bd65461db3b8 (Bindat Examples): Move @lisp to beginning of line. (Whitespace change.)
Luc Teirlinck <teirllm@auburn.edu>
parents: 63568
diff changeset
2347 @lisp
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2348 (defvar fcookie-index-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2349 '((:version u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2350 (:count u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2351 (:longest u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2352 (:shortest u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2353 (:flags u32)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2354 (:delim u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2355 (:ignored fill 3)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2356 (:offset repeat (:count)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2357 (:foo u32)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2358 "Description of a fortune cookie index file's contents.")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2359
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2360 (defun fcookie (cookies &optional index)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2361 "Display a random fortune cookie from file COOKIES.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2362 Optional second arg INDEX specifies the associated index
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2363 filename, which is by default constructed by appending
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2364 \".dat\" to COOKIES. Display cookie text in possibly
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2365 new buffer \"*Fortune Cookie: BASENAME*\" where BASENAME
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2366 is COOKIES without the directory part."
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2367 (interactive "fCookies file: ")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2368 (let* ((info (with-temp-buffer
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2369 (insert-file-contents-literally
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2370 (or index (concat cookies ".dat")))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2371 (bindat-unpack fcookie-index-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2372 (buffer-string))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2373 (sel (random (bindat-get-field info :count)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2374 (beg (cdar (bindat-get-field info :offset sel)))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2375 (end (or (cdar (bindat-get-field info
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2376 :offset (1+ sel)))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2377 (nth 7 (file-attributes cookies)))))
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2378 (switch-to-buffer
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2379 (get-buffer-create
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2380 (format "*Fortune Cookie: %s*"
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2381 (file-name-nondirectory cookies))))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2382 (erase-buffer)
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2383 (insert-file-contents-literally
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2384 cookies nil beg (- end 3))))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2385
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2386 (defun fcookie-create-index (cookies &optional index delim)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2387 "Scan file COOKIES, and write out its index file.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2388 Optional second arg INDEX specifies the index filename,
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2389 which is by default constructed by appending \".dat\" to
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2390 COOKIES. Optional third arg DELIM specifies the unibyte
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2391 character which, when found on a line of its own in
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2392 COOKIES, indicates the border between entries."
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2393 (interactive "fCookies file: ")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2394 (setq delim (or delim ?%))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2395 (let ((delim-line (format "\n%c\n" delim))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2396 (count 0)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2397 (max 0)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2398 min p q len offsets)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2399 (unless (= 3 (string-bytes delim-line))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2400 (error "Delimiter cannot be represented in one byte"))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2401 (with-temp-buffer
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2402 (insert-file-contents-literally cookies)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2403 (while (and (setq p (point))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2404 (search-forward delim-line (point-max) t)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2405 (setq len (- (point) 3 p)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2406 (setq count (1+ count)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2407 max (max max len)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2408 min (min (or min max) len)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2409 offsets (cons (1- p) offsets))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2410 (with-temp-buffer
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2411 (set-buffer-multibyte nil)
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2412 (insert
70907
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2413 (bindat-pack
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2414 fcookie-index-spec
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2415 `((:version . 2)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2416 (:count . ,count)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2417 (:longest . ,max)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2418 (:shortest . ,min)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2419 (:flags . 0)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2420 (:delim . ,delim)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2421 (:offset . ,(mapcar (lambda (o)
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2422 (list (cons :foo o)))
4f3bfa0df084 (Bindat Functions): Say "unibyte string"
Thien-Thi Nguyen <ttn@gnuvola.org>
parents: 70603
diff changeset
2423 (nreverse offsets))))))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2424 (let ((coding-system-for-write 'raw-text-unix))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2425 (write-file (or index (concat cookies ".dat")))))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2426 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2427
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2428 Following is an example of defining and unpacking a complex structure.
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2429 Consider the following C structures:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2430
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2431 @example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2432 struct header @{
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2433 unsigned long dest_ip;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2434 unsigned long src_ip;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2435 unsigned short dest_port;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2436 unsigned short src_port;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2437 @};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2438
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2439 struct data @{
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2440 unsigned char type;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2441 unsigned char opcode;
75992
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2442 unsigned short length; /* In network byte order */
63560
35d12dd91d05 Fix typos.
Luc Teirlinck <teirllm@auburn.edu>
parents: 63542
diff changeset
2443 unsigned char id[8]; /* null-terminated string */
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2444 unsigned char data[/* (length + 3) & ~3 */];
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2445 @};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2446
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2447 struct packet @{
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2448 struct header header;
75992
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2449 unsigned long counters[2]; /* In little endian order */
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2450 unsigned char items;
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2451 unsigned char filler[3];
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2452 struct data item[/* items */];
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2453
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2454 @};
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2455 @end example
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2456
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2457 The corresponding data layout specification:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2458
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2459 @lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2460 (setq header-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2461 '((dest-ip ip)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2462 (src-ip ip)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2463 (dest-port u16)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2464 (src-port u16)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2465
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2466 (setq data-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2467 '((type u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2468 (opcode u8)
75992
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2469 (length u16) ;; network byte order
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2470 (id strz 8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2471 (data vec (length))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2472 (align 4)))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2473
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2474 (setq packet-spec
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2475 '((header struct header-spec)
75992
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2476 (counters vec 2 u32r) ;; little endian order
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2477 (items u8)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2478 (fill 3)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2479 (item repeat (items)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2480 (struct data-spec))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2481 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2482
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2483 A binary data representation:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2484
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2485 @lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2486 (setq binary-data
75992
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2487 [ 192 168 1 100 192 168 1 101 01 28 21 32
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2488 160 134 1 0 5 1 0 0 2 0 0 0
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2489 2 3 0 5 ?A ?B ?C ?D ?E ?F 0 0 1 2 3 4 5 0 0 0
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2490 1 4 0 7 ?B ?C ?D ?E ?F ?G 0 0 6 7 8 9 10 11 12 0 ])
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2491 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2492
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2493 The corresponding decoded structure:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2494
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2495 @lisp
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2496 (setq decoded (bindat-unpack packet-spec binary-data))
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2497 @result{}
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2498 ((header
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2499 (dest-ip . [192 168 1 100])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2500 (src-ip . [192 168 1 101])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2501 (dest-port . 284)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2502 (src-port . 5408))
75992
035ff8761729 More fixes to bindat example.
Kim F. Storm <storm@cua.dk>
parents: 75987
diff changeset
2503 (counters . [100000 261])
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2504 (items . 2)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2505 (item ((data . [1 2 3 4 5])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2506 (id . "ABCDEF")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2507 (length . 5)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2508 (opcode . 3)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2509 (type . 2))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2510 ((data . [6 7 8 9 10 11 12])
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2511 (id . "BCDEFG")
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2512 (length . 7)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2513 (opcode . 4)
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2514 (type . 1))))
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2515 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2516
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2517 Fetching data from this structure:
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2518
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2519 @lisp
63583
99e9892a51d9 Fix formatting ugliness.
Richard M. Stallman <rms@gnu.org>
parents: 63569
diff changeset
2520 (bindat-get-field decoded 'item 1 'id)
63542
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2521 @result{} "BCDEFG"
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2522 @end lisp
e8205c5fb59b (Byte Packing): New node.
Richard M. Stallman <rms@gnu.org>
parents: 62370
diff changeset
2523
52401
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
2524 @ignore
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
2525 arch-tag: ba9da253-e65f-4e7f-b727-08fba0a1df7a
695cf19ef79e Add arch taglines
Miles Bader <miles@gnu.org>
parents: 51994
diff changeset
2526 @end ignore