process.h 5.21 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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, 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 55 56
    /* Buffer that output is going to */
    Lisp_Object buffer;
    /* Number of this process */
    Lisp_Object pid;
    /* Non-nil if this is really a command channel */
    Lisp_Object command_channel_p;
Richard M. Stallman's avatar
Richard M. Stallman committed
57
    /* t if this is a real child process.
58
       For a net connection, it is a plist based on the arguments to make-network-process.  */
Jim Blandy's avatar
Jim Blandy committed
59
    Lisp_Object childp;
60 61
    /* Plist for programs to keep per-process state information, parameters, etc.  */
    Lisp_Object plist;
Jim Blandy's avatar
Jim Blandy committed
62 63
    /* Marker set to end of last buffer-inserted output from this process */
    Lisp_Object mark;
64 65
    /* 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
66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
    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;
83 84 85 86
    /* Coding-system for decoding the input from this process.  */
    Lisp_Object decode_coding_system;
    /* Working buffer for decoding.  */
    Lisp_Object decoding_buf;
87 88
    /* Size of carryover in decoding.  */
    Lisp_Object decoding_carryover;
89 90 91 92
    /* Coding-system for encoding the output to this process.  */
    Lisp_Object encode_coding_system;
    /* Working buffer for encoding.  */
    Lisp_Object encoding_buf;
93 94
    /* Size of carryover in encoding.  */
    Lisp_Object encoding_carryover;
95 96
    /* Flag to set coding-system of the process buffer from the
       coding_system used to decode process output.  */
97
    Lisp_Object inherit_coding_system_flag;
98 99 100 101 102 103
    /* 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;
Jim Blandy's avatar
Jim Blandy committed
104 105
};

106 107 108
/* 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
109 110
#define ChannelMask(n) (1<<(n))

111
/* Indexed by descriptor, gives the process (if any) for that descriptor.  */
112
extern Lisp_Object chan_process[];
113 114 115 116

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

Jim Blandy's avatar
Jim Blandy committed
117 118 119 120
/* 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
121
/* Communicate exit status of sync process to from sigchld_handler
Jim Blandy's avatar
Jim Blandy committed
122 123
   to Fcall_process.  */

Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129 130
/* Nonzero => this is a string explaining death of synchronous subprocess.  */
extern char *synch_process_death;

/* If synch_process_death is zero,
   this is exit code of synchronous subprocess.  */
extern int synch_process_retcode;

131 132 133 134 135
/* 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