process.h 5.96 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions for asynchronous process control in GNU Emacs.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985, 1994 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
any later version.

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
18 19
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22 23 24 25 26
/* This structure records information about a subprocess
   or network connection.

   Every field in this structure except for the first two
   must be a Lisp_Object, for GC's sake.  */
Jim Blandy's avatar
Jim Blandy committed
27 28 29

struct Lisp_Process
  {
30
    EMACS_INT size;
Jim Blandy's avatar
Jim Blandy committed
31 32 33 34 35
    struct Lisp_Vector *v_next;
    /* Descriptor by which we read from this process */
    Lisp_Object infd;
    /* Descriptor by which we write to this process */
    Lisp_Object outfd;
36 37
    /* Name of subprocess terminal.  */
    Lisp_Object tty_name;
Jim Blandy's avatar
Jim Blandy committed
38 39
    /* Name of this process */
    Lisp_Object name;
40 41
    /* List of command arguments that this process was run with.
       Is set to t for a stopped network process; nil otherwise. */
Jim Blandy's avatar
Jim Blandy committed
42 43 44 45 46 47
    Lisp_Object command;
    /* (funcall FILTER PROC STRING)  (if FILTER is non-nil)
       to dispose of a bunch of chars from the process all at once */
    Lisp_Object filter;
    /* (funcall SENTINEL PROCESS) when process state changes */
    Lisp_Object sentinel;
48 49 50
    /* (funcall LOG SERVER CLIENT MESSAGE) when a server process
       accepts a connection from a client.  */
    Lisp_Object log;
Jim Blandy's avatar
Jim Blandy committed
51 52 53 54
    /* Buffer that output is going to */
    Lisp_Object buffer;
    /* Number of this process */
    Lisp_Object pid;
Richard M. Stallman's avatar
Richard M. Stallman committed
55
    /* t if this is a real child process.
56
       For a net connection, it is a plist based on the arguments to make-network-process.  */
Jim Blandy's avatar
Jim Blandy committed
57
    Lisp_Object childp;
58 59
    /* Plist for programs to keep per-process state information, parameters, etc.  */
    Lisp_Object plist;
Jim Blandy's avatar
Jim Blandy committed
60 61
    /* Marker set to end of last buffer-inserted output from this process */
    Lisp_Object mark;
62 63
    /* Non-nil means kill silently if Emacs is exited.
       This is the inverse of the `query-on-exit' flag.  */
Jim Blandy's avatar
Jim Blandy committed
64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
    Lisp_Object kill_without_query;
    /* Record the process status in the raw form in which it comes from `wait'.
       This is to avoid consing in a signal handler.  */
    Lisp_Object raw_status_low;
    Lisp_Object raw_status_high;
    /* Symbol indicating status of process.
       This may be a symbol: run, open, or closed.
       Or it may be a list, whose car is stop, exit or signal
       and whose cdr is a pair (EXIT_CODE . COREDUMP_FLAG)
       or (SIGNAL_NUMBER . COREDUMP_FLAG).  */
    Lisp_Object status;
    /* Non-nil if communicating through a pty.  */
    Lisp_Object pty_flag;
    /* Event-count of last event in which this process changed status.  */
    Lisp_Object tick;
    /* Event-count of last such event reported.  */
    Lisp_Object update_tick;
81 82 83 84
    /* Coding-system for decoding the input from this process.  */
    Lisp_Object decode_coding_system;
    /* Working buffer for decoding.  */
    Lisp_Object decoding_buf;
85 86
    /* Size of carryover in decoding.  */
    Lisp_Object decoding_carryover;
87 88 89 90
    /* Coding-system for encoding the output to this process.  */
    Lisp_Object encode_coding_system;
    /* Working buffer for encoding.  */
    Lisp_Object encoding_buf;
91 92
    /* Size of carryover in encoding.  */
    Lisp_Object encoding_carryover;
93 94
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
95
    Lisp_Object inherit_coding_system_flag;
96 97 98 99 100 101
    /* Flat to decide the multibyteness of a string given to the
       filter (if any).  It is initialized to the value of
       `default-enable-multibyte-characters' when the process is
       generated, and can be changed by the function
       `set-process-fileter-multibyte'. */
    Lisp_Object filter_multibyte;
102 103 104 105
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.  */
    Lisp_Object adaptive_read_buffering;
    /* Hysteresis to try to read process output in larger blocks.
106
       On some systems, e.g. GNU/Linux, Emacs is seen as 
107 108 109 110 111 112 113
       an interactive app also when reading process output, meaning
       that process output can be read in as little as 1 byte at a
       time.  Value is micro-seconds to delay reading output from
       this process.  Range is 0 .. 50000.  */
    Lisp_Object read_output_delay;
    /* Skip reading this process on next read.  */
    Lisp_Object read_output_skip;
Jim Blandy's avatar
Jim Blandy committed
114 115
};

116 117 118
/* Every field in the preceding structure except for the first two
   must be a Lisp_Object, for GC's sake.  */

Jim Blandy's avatar
Jim Blandy committed
119 120
#define ChannelMask(n) (1<<(n))

121
/* Indexed by descriptor, gives the process (if any) for that descriptor.  */
122
extern Lisp_Object chan_process[];
123 124 125 126

/* Alist of elements (NAME . PROCESS).  */
extern Lisp_Object Vprocess_alist;

Jim Blandy's avatar
Jim Blandy committed
127 128 129 130
/* True iff we are about to fork off a synchronous process or if we
   are waiting for it.  */
extern int synch_process_alive;

Karl Heuer's avatar
Karl Heuer committed
131
/* Communicate exit status of sync process to from sigchld_handler
Jim Blandy's avatar
Jim Blandy committed
132 133
   to Fcall_process.  */

Jim Blandy's avatar
Jim Blandy committed
134 135 136
/* Nonzero => this is a string explaining death of synchronous subprocess.  */
extern char *synch_process_death;

137
/* Nonzero => this is the signal number that terminated the subprocess.  */
138
extern int synch_process_termsig;
139

Jim Blandy's avatar
Jim Blandy committed
140 141 142 143
/* If synch_process_death is zero,
   this is exit code of synchronous subprocess.  */
extern int synch_process_retcode;

144 145 146 147 148
/* The name of the file open to get a null file, or a data sink.
   VMS, MS-DOS, and OS/2 redefine this.  */
#ifndef NULL_DEVICE
#define NULL_DEVICE "/dev/null"
#endif
Miles Bader's avatar
Miles Bader committed
149 150 151

/* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72
   (do not change this comment) */