process.h 6.26 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Definitions for asynchronous process control in GNU Emacs.
2
   Copyright (C) 1985, 1994, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008  Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 3, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21

Stefan Monnier's avatar
Stefan Monnier committed
22 23 24 25 26 27
#ifdef HAVE_SYS_TYPES_H
#include <sys/types.h>
#endif
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif
Jim Blandy's avatar
Jim Blandy committed
28

29 30 31 32 33
/* 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
34 35 36

struct Lisp_Process
  {
Stefan Monnier's avatar
Stefan Monnier committed
37
    EMACS_UINT size;
Jim Blandy's avatar
Jim Blandy committed
38
    struct Lisp_Vector *v_next;
39 40
    /* Name of subprocess terminal.  */
    Lisp_Object tty_name;
Jim Blandy's avatar
Jim Blandy committed
41 42
    /* Name of this process */
    Lisp_Object name;
43 44
    /* 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
45 46 47 48 49 50
    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;
51 52 53
    /* (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
54 55
    /* Buffer that output is going to */
    Lisp_Object buffer;
Richard M. Stallman's avatar
Richard M. Stallman committed
56
    /* t if this is a real child process.
57
       For a net connection, it is a plist based on the arguments to make-network-process.  */
Jim Blandy's avatar
Jim Blandy committed
58
    Lisp_Object childp;
59 60
    /* Plist for programs to keep per-process state information, parameters, etc.  */
    Lisp_Object plist;
Jim Blandy's avatar
Jim Blandy committed
61 62 63 64 65 66 67 68
    /* Marker set to end of last buffer-inserted output from this process */
    Lisp_Object mark;
    /* 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;
69 70 71 72 73 74 75 76
    /* Coding-system for decoding the input from this process.  */
    Lisp_Object decode_coding_system;
    /* Working buffer for decoding.  */
    Lisp_Object decoding_buf;
    /* Coding-system for encoding the output to this process.  */
    Lisp_Object encode_coding_system;
    /* Working buffer for encoding.  */
    Lisp_Object encoding_buf;
77 78

    /* After this point, there are no Lisp_Objects any more.  */
79
    /* alloc.c assumes that `pid' is the first such non-Lisp slot.  */
80 81 82 83 84

    /* Number of this process.
       allocate_process assumes this is the first non-Lisp_Object field.
       A value 0 is used for pseudo-processes such as network connections.  */
    pid_t pid;
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    /* Descriptor by which we read from this process */
    int infd;
    /* Descriptor by which we write to this process */
    int outfd;
    /* Event-count of last event in which this process changed status.  */
    int tick;
    /* Event-count of last such event reported.  */
    int update_tick;
    /* Size of carryover in decoding.  */
    int decoding_carryover;
    /* Hysteresis to try to read process output in larger blocks.
       On some systems, e.g. GNU/Linux, Emacs is seen as
       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.  */
    int read_output_delay;
    /* Should we delay reading output from this process.
       Initialized from `Vprocess_adaptive_read_buffering'.
       0 = nil, 1 = t, 2 = other.  */
105
    unsigned int adaptive_read_buffering : 2;
106
    /* Skip reading this process on next read.  */
107
    unsigned int read_output_skip : 1;
108 109
    /* Non-nil means kill silently if Emacs is exited.
       This is the inverse of the `query-on-exit' flag.  */
110
    unsigned int kill_without_query : 1;
111
    /* Non-nil if communicating through a pty.  */
112
    unsigned int pty_flag : 1;
113 114
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
115
    unsigned int inherit_coding_system_flag : 1;
116 117 118 119
    /* Record the process status in the raw form in which it comes from `wait'.
       This is to avoid consing in a signal handler.  The `raw_status_new'
       flag indicates that `raw_status' contains a new status that still
       needs to be synced to `status'.  */
120
    unsigned int raw_status_new : 1;
121
    int raw_status;
Jim Blandy's avatar
Jim Blandy committed
122 123
};

124 125 126
/* 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
127 128
#define ChannelMask(n) (1<<(n))

129
/* Indexed by descriptor, gives the process (if any) for that descriptor.  */
130
extern Lisp_Object chan_process[];
131 132 133 134

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

Glenn Morris's avatar
Glenn Morris committed
135
/* True if we are about to fork off a synchronous process or if we
Jim Blandy's avatar
Jim Blandy committed
136 137 138
   are waiting for it.  */
extern int synch_process_alive;

Karl Heuer's avatar
Karl Heuer committed
139
/* Communicate exit status of sync process to from sigchld_handler
Jim Blandy's avatar
Jim Blandy committed
140 141
   to Fcall_process.  */

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

145
/* Nonzero => this is the signal number that terminated the subprocess.  */
146
extern int synch_process_termsig;
147

Jim Blandy's avatar
Jim Blandy committed
148 149 150 151
/* If synch_process_death is zero,
   this is exit code of synchronous subprocess.  */
extern int synch_process_retcode;

152 153 154 155 156
/* 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
157

158 159 160 161
/* Nonzero means don't run process sentinels.  This is used
   when exiting.  */
extern int inhibit_sentinels;

Miles Bader's avatar
Miles Bader committed
162 163
/* arch-tag: dffedfc4-d7bc-4b58-a26f-c16155449c72
   (do not change this comment) */