Mercurial > hg > xemacs-beta

diff lisp/code-process.el @ 853:2b6fa2618f76

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
[xemacs-hg @ 2002-05-28 08:44:22 by ben] merge my stderr-proc ws make-docfile.c: Fix places where we forget to check for EOF. code-init.el: Don't use CRLF conversion by default on process output. CMD.EXE and friends work both ways but Cygwin programs don't like the CRs. code-process.el, multicast.el, process.el: Removed. Improvements to call-process-internal: -- allows a buffer to be specified for input and stderr output -- use it on all systems -- implement C-g as documented -- clean up and comment call-process-region uses new call-process facilities; no temp file. remove duplicate funs in process.el. comment exactly how coding systems work and fix various problems. open-multicast-group now does similar coding-system frobbing to open-network-stream. dumped-lisp.el, faces.el, msw-faces.el: Fix some hidden errors due to code not being defined at the right time. xemacs.mak: Add -DSTRICT. ================================================================ ALLOW SEPARATION OF STDOUT AND STDERR IN PROCESSES ================================================================ Standard output and standard error can be processed separately in a process. Each can have its own buffer, its own mark in that buffer, and its filter function. You can specify a separate buffer for stderr in `start-process' to get things started, or use the new primitives: set-process-stderr-buffer process-stderr-buffer process-stderr-mark set-process-stderr-filter process-stderr-filter Also, process-send-region takes a 4th optional arg, a buffer. Currently always uses a pipe() under Unix to read the error output. (#### Would a PTY be better?) sysdep.h, sysproc.h, unexfreebsd.c, unexsunos4.c, nt.c, emacs.c, callproc.c, symsinit.h, sysdep.c, Makefile.in.in, process-unix.c: Delete callproc.c. Move child_setup() to process-unix.c. wait_for_termination() now only needed on a few really old systems. console-msw.h, event-Xt.c, event-msw.c, event-stream.c, event-tty.c, event-unixoid.c, events.h, process-nt.c, process-unix.c, process.c, process.h, procimpl.h: Rewrite the process methods to handle a separate channel for error input. Create Lstreams for reading in the error channel. Many process methods need change. In general the changes are fairly clear as they involve duplicating what's used for reading the normal stdout and changing for stderr -- although tedious, as such changes are required throughout the entire process code. Rewrote the code that reads process output to do two loops, one for stdout and one for stderr. gpmevent.c, tooltalk.c: set_process_filter takes an argument for stderr. ================================================================ NEW ERROR-TRAPPING MECHANISM ================================================================ Totally rewrite error trapping code to be unified and support more features. Basic function is call_trapping_problems(), which lets you specify, by means of flags, what sorts of problems you want trapped. these can include -- quit -- errors -- throws past the function -- creation of "display objects" (e.g. buffers) -- deletion of already-existing "display objects" (e.g. buffers) -- modification of already-existing buffers -- entering the debugger -- gc -- errors->warnings (ala suspended errors) etc. All other error funs rewritten in terms of this one. Various older mechanisms removed or rewritten. window.c, insdel.c, console.c, buffer.c, device.c, frame.c: When creating a display object, added call to note_object_created(), for use with trapping_problems mechanism. When deleting, call check_allowed_operation() and note_object deleted(). The trapping-problems code records the objects created since the call-trapping-problems began. Those objects can be deleted, but none others (i.e. previously existing ones). bytecode.c, cmdloop.c: internal_catch takes another arg. eval.c: Add long comments describing the "five lists" used to maintain state (backtrace, gcpro, specbind, etc.) in the Lisp engine. backtrace.h, eval.c: Implement trapping-problems mechanism, eliminate old mechanisms or redo in terms of new one. frame.c, gutter.c: Flush out the concept of "critical display section", defined by the in_display() var. Use an internal_bind() to get it reset, rather than just doing it at end, because there may be a non-local exit. event-msw.c, event-stream.c, console-msw.h, device.c, dialog-msw.c, frame.c, frame.h, intl.c, toolbar.c, menubar-msw.c, redisplay.c, alloc.c, menubar-x.c: Make use of new trapping-errors stuff and rewrite code based on old mechanisms. glyphs-widget.c, redisplay.h: Protect calling Lisp in redisplay. insdel.c: Protect hooks against deleting existing buffers. frame-msw.c: Use EQ, not EQUAL in hash tables whose keys are just numbers. Otherwise we run into stickiness in redisplay because internal_equal() can QUIT. ================================================================ SIGNAL, C-G CHANGES ================================================================ Here we change the way that C-g interacts with event reading. The idea is that a C-g occurring while we're reading a user event should be read as C-g, but elsewhere should be a QUIT. The former code did all sorts of bizarreness -- requiring that no QUIT occurs anywhere in event-reading code (impossible to enforce given the stuff called or Lisp code invoked), and having some weird system involving enqueue/dequeue of a C-g and interaction with Vquit_flag -- and it didn't work. Now, we simply enclose all code where we want C-g read as an event with {begin/end}_dont_check_for_quit(). This completely turns off the mechanism that checks (and may remove or alter) C-g in the read-ahead queues, so we just get the C-g normal. Signal.c documents this very carefully. cmdloop.c: Correct use of dont_check_for_quit to new scheme, remove old out-of-date comments. event-stream.c: Fix C-g handling to actually work. device-x.c: Disable quit checking when err out. signal.c: Cleanup. Add large descriptive comment. process-unix.c, process-nt.c, sysdep.c: Use QUIT instead of REALLY_QUIT. It's not necessary to use REALLY_QUIT and just confuses the issue. lisp.h: Comment quit handlers. ================================================================ CONS CHANGES ================================================================ free_cons() now takes a Lisp_Object not the result of XCONS(). car and cdr have been renamed so that they don't get used directly; go through XCAR(), XCDR() instead. alloc.c, dired.c, editfns.c, emodules.c, fns.c, glyphs-msw.c, glyphs-x.c, glyphs.c, keymap.c, minibuf.c, search.c, eval.c, lread.c, lisp.h: Correct free_cons calling convention: now takes Lisp_Object, not Lisp_Cons chartab.c: Eliminate direct use of ->car, ->cdr, should be black box. callint.c: Rewrote using EXTERNAL_LIST_LOOP to avoid use of Lisp_Cons. ================================================================ USE INTERNAL-BIND-* ================================================================ eval.c: Cleanups of these funs. alloc.c, fileio.c, undo.c, specifier.c, text.c, profile.c, lread.c, redisplay.c, menubar-x.c, macros.c: Rewrote to use internal_bind_int() and internal_bind_lisp_object() in place of whatever varied and cumbersome mechanisms were formerly there. ================================================================ SPECBIND SANITY ================================================================ backtrace.h: - Improved comments backtrace.h, bytecode.c, eval.c: Add new mechanism check_specbind_stack_sanity() for sanity checking code each time the catchlist or specbind stack change. Removed older prototype of same mechanism. ================================================================ MISC ================================================================ lisp.h, insdel.c, window.c, device.c, console.c, buffer.c: Fleshed out authorship. device-msw.c: Correct bad Unicode-ization. print.c: Be more careful when not initialized or in fatal error handling. search.c: Eliminate running_asynch_code, an FSF holdover. alloc.c: Added comments about gc-cons-threshold. dialog-x.c: Use begin_gc_forbidden() around code to build up a widget value tree, like in menubar-x.c. gui.c: Use Qunbound not Qnil as the default for gethash. lisp-disunion.h, lisp-union.h: Added warnings on use of VOID_TO_LISP(). lisp.h: Use ERROR_CHECK_STRUCTURES to turn on ERROR_CHECK_TRAPPING_PROBLEMS and ERROR_CHECK_TYPECHECK lisp.h: Add assert_with_message. lisp.h: Add macros for gcproing entire arrays. (You could do this before but it required manual twiddling the gcpro structure.) lisp.h: Add prototypes for new functions defined elsewhere.
author ben
date Tue, 28 May 2002 08:45:36 +0000
parents 0490271de7d8
children b5278486690c
line wrap: on
line diff
--- a/lisp/code-process.el	Sat May 25 01:55:30 2002 +0000
+++ b/lisp/code-process.el	Tue May 28 08:45:36 2002 +0000
@@ -1,7 +1,7 @@
 ;;; code-process.el --- Process coding functions for XEmacs.
 
 ;; Copyright (C) 1985-1987, 1993, 1994, 1997 Free Software Foundation, Inc.
-;; Copyright (C) 1995, 2000 Ben Wing
+;; Copyright (C) 1995, 2000, 2002 Ben Wing
 ;; Copyright (C) 1997 MORIOKA Tomohiko
 
 ;; Author: Ben Wing
@@ -39,12 +39,22 @@
 from the program and encoding what sent to the program.
 If VAL is a cons of coding systems, the car part is used for decoding,
 and the cdr part is used for encoding.
-If VAL is a function symbol, the function must return a coding system
-or a cons of coding systems which are used as above.")
+If VAL is a function symbol, it is called with two arguments, a symbol
+indicating the operation being performed (one of `start-process',
+`call-process', `open-network-stream', or `open-multicast-group') and the
+program name.  The function must return a coding system or a cons of
+coding systems which are used as above.")
 
 (defun call-process (program &optional infile buffer displayp &rest args)
   "Call PROGRAM synchronously in separate process.
+
 The program's input comes from file INFILE (nil means `/dev/null').
+XEmacs feature: INFILE can also be a list of (BUFFER [START [END]]), i.e.
+a list of one to three elements, consisting of a buffer and optionally
+a start position or start and end position.  In this case, input comes
+from the buffer, starting from START (defaults to the beginning of the
+buffer) and ending at END (defaults to the end of the buffer).
+
 Insert output in BUFFER before point; t means current buffer;
  nil for BUFFER means discard it; 0 means discard and don't wait.
 If BUFFER is a string, then find or create a buffer with that name,
@@ -53,38 +63,78 @@
 REAL-BUFFER says what to do with standard output, as above,
 while STDERR-FILE says what to do with standard error in the child.
 STDERR-FILE may be nil (discard standard error output),
-t (mix it with ordinary output), or a file name string.
+t (mix it with ordinary output), a file name string, or (XEmacs feature)
+a buffer object.  If STDERR-FILE is a buffer object (but not the name of
+a buffer, since that would be interpreted as a file), the standard error
+output will be inserted into the buffer before point.
 
-Fourth arg DISPLAYP non-nil means redisplay buffer as output is inserted.
+Fourth arg DISPLAY non-nil means redisplay buffer as output is inserted.
 Remaining arguments are strings passed as command arguments to PROGRAM.
 
-If BUFFER is 0, `call-process' returns immediately with value nil.
-Otherwise it waits for PROGRAM to terminate and returns a numeric exit status
- or a signal description string.
-If you quit, the process is killed with SIGINT, or SIGKILL if you
- quit again."
-  (let* ((coding-system-for-read
-	  (or coding-system-for-read
-	      (let (ret)
-		(catch 'found
-		  (let ((alist process-coding-system-alist)
-			(case-fold-search nil))
-		    (while alist
-		      (if (string-match (car (car alist)) program)
-			  (throw 'found (setq ret (cdr (car alist))))
-			)
-		      (setq alist (cdr alist))
-		      )))
-		(if (functionp ret)
-		    (setq ret (funcall ret 'call-process program))
-		  )
-		(cond ((consp ret) (car ret))
-		      ((not ret) 'undecided)
-		      ((find-coding-system ret) ret)
-		      )
-		))))
-    (apply 'call-process-internal program infile buffer displayp args)
-    ))
+If BUFFER is 0, returns immediately with value nil.
+Otherwise waits for PROGRAM to terminate and returns a numeric exit status
+or a signal description string.  If you quit, the process is first killed
+with SIGINT, then with SIGKILL if you quit again before the process exits.
+
+If INFILE is a file, we transfer its exact contents to the process without
+any encoding/decoding. (#### This policy might change.)
+
+Otherwise, the read/write coding systems used for process I/O on the
+process are determined as follows:
+
+1. `coding-system-for-read', `coding-system-for-write', if non-nil.
+      (Intended as a temporary overriding mechanism for use by Lisp
+      code.)
+2. The matching value for the process name from `process-coding-system-alist',
+      if any, and if non-nil.  The value may be either a single coding
+      system, used for both read and write; or a cons of read/write; or a
+      function, called to get one of the other two values.
+3. For writing: If a buffer was given in INFILE, the value of
+      `buffer-file-coding-system' in that buffer.
+   For reading: if a buffer was given in BUFFER, the value of
+      `buffer-file-coding-system-for-read' in that buffer.
+4. The value of `default-process-coding-system', which should be a cons
+      of read/write coding systems, if the values are non-nil.
+5. The coding system `undecided' for read, and `raw-text' for write.
+
+Note that the processes of determining the read and write coding systems
+proceed essentially independently one from the other, as in `start-process'."
+  (let (cs-r cs-w)
+    (let (ret)
+      (catch 'found
+	(let ((alist process-coding-system-alist)
+	      (case-fold-search nil))
+	  (while alist
+	    (if (string-match (car (car alist)) program)
+		(throw 'found (setq ret (cdr (car alist)))))
+	    (setq alist (cdr alist))
+	    )))
+      (if (functionp ret)
+	  (setq ret (funcall ret 'call-process program)))
+      (cond ((consp ret)
+	     (setq cs-r (car ret)
+		   cs-w (cdr ret)))
+	    ((and ret (find-coding-system ret))
+	     (setq cs-r ret
+		   cs-w ret))))
+    (let ((coding-system-for-read
+	   (or coding-system-for-read cs-r
+	       (let ((thebuf (if (consp buffer) (car buffer) buffer)))
+		 (and (or (bufferp thebuf) (stringp thebuf))
+		      (get-buffer thebuf)
+		      (symbol-value-in-buffer
+		       'buffer-file-coding-system-for-read thebuf)))
+	       (car default-process-coding-system)
+	       'undecided))
+	  (coding-system-for-write
+	   (or coding-system-for-write cs-w
+	       (and (consp infile)
+		    (symbol-value-in-buffer
+		     'buffer-file-coding-system
+		     (get-buffer (car infile))))
+	       (cdr default-process-coding-system)
+	       'raw-text)))
+      (apply 'call-process-internal program infile buffer displayp args))))
 
 (defun call-process-region (start end program
 				  &optional deletep buffer displayp
@@ -100,63 +150,77 @@
 REAL-BUFFER says what to do with standard output, as above,
 while STDERR-FILE says what to do with standard error in the child.
 STDERR-FILE may be nil (discard standard error output),
-t (mix it with ordinary output), or a file name string.
+t (mix it with ordinary output), a file name string, or (XEmacs feature)
+a buffer object.  If STDERR-FILE is a buffer object (but not the name of
+a buffer, since that would be interpreted as a file), the standard error
+output will be inserted into the buffer before point.
 
 Sixth arg DISPLAYP non-nil means redisplay buffer as output is inserted.
 Remaining args are passed to PROGRAM at startup as command args.
 
 If BUFFER is 0, returns immediately with value nil.
-Otherwise waits for PROGRAM to terminate
-and returns a numeric exit status or a signal description string.
-If you quit, the process is first killed with SIGINT, then with SIGKILL if
-you quit again before the process exits."
-  (let ((temp
-	 (make-temp-name
-	  (concat (file-name-as-directory (temp-directory)) "emacs"))))
-    (unwind-protect
-	(let (cs-r cs-w)
-	  (let (ret)
-	    (catch 'found
-	      (let ((alist process-coding-system-alist)
-		    (case-fold-search nil))
-		(while alist
-		  (if (string-match (car (car alist)) program)
-		      (throw 'found (setq ret (cdr (car alist)))))
-		  (setq alist (cdr alist))
-		  )))
-	    (if (functionp ret)
-		(setq ret (funcall ret 'call-process-region program)))
-	    (cond ((consp ret)
-		   (setq cs-r (car ret)
-			 cs-w (cdr ret)))
-		  ((null ret)
-		   (setq cs-r buffer-file-coding-system
-			 cs-w buffer-file-coding-system))
-		  ((find-coding-system ret)
-		   (setq cs-r ret
-			 cs-w ret))))
-	  (let ((coding-system-for-read
-		 (or coding-system-for-read cs-r))
-		(coding-system-for-write
-		 (or coding-system-for-write cs-w)))
-	    (write-region start end temp nil 'silent)
-	    (if deletep (delete-region start end))
-	    (apply #'call-process program temp buffer displayp args)))
-      (ignore-file-errors (delete-file temp)))))
+Otherwise waits for PROGRAM to terminate and returns a numeric exit status
+or a signal description string.  If you quit, the process is first killed
+with SIGINT, then with SIGKILL if you quit again before the process exits.
+
+The read/write coding systems used for process I/O on the process are
+the same as for `call-process'."
+  ;; We used to delete the text before calling call-process; that was when
+  ;; a temporary file was used to pass the text to call-process.  Now that
+  ;; we don't do that, we delete the text afterward; if it's being inserted
+  ;; in the same buffer, make sure we track the insertion, and don't get
+  ;; any of it in the deleted region if insertion happens at either end
+  ;; of the region.
+  (let ((s (and deletep (copy-marker start t)))
+	(e (and deletep (copy-marker end))))
+    (apply #'call-process program (list (current-buffer) start end)
+	   buffer displayp args)
+    (if deletep (delete-region s e))))
 
 (defun start-process (name buffer program &rest program-args)
   "Start a program in a subprocess.  Return the process object for it.
-Args are NAME BUFFER PROGRAM &rest PROGRAM-ARGS
 NAME is name for process.  It is modified if necessary to make it unique.
 BUFFER is the buffer or (buffer-name) to associate with the process.
-Process output goes at end of that buffer, unless you specify
-an output stream or filter function to handle the output.
-BUFFER may also be nil, meaning that this process is not associated
-with any buffer.
+ Process output goes at end of that buffer, unless you specify
+ an output stream or filter function to handle the output.
+ BUFFER may be also nil, meaning that this process is not associated
+ with any buffer.
+BUFFER can also have the form (REAL-BUFFER STDERR-BUFFER); in that case,
+ REAL-BUFFER says what to do with standard output, as above,
+ while STDERR-BUFFER says what to do with standard error in the child.
+ STDERR-BUFFER may be nil (discard standard error output, unless a stderr
+ filter is set).  Note that if you do not use this form at process creation,
+ stdout and stderr will be mixed in the output buffer, and this cannot be
+ changed, even by setting a stderr filter.
 Third arg is program file name.  It is searched for as in the shell.
 Remaining arguments are strings to give program as arguments.
-INCODE and OUTCODE specify the coding-system objects used in input/output
- from/to the process."
+
+The read/write coding systems used for process I/O on the process are
+determined as follows:
+
+1. `coding-system-for-read', `coding-system-for-write', if non-nil.
+      (Intended as a temporary overriding mechanism for use by Lisp
+      code.)
+2. The matching value for the process name from `process-coding-system-alist',
+      if any, and if non-nil.  The value may be either a single coding
+      system, used for both read and write; or a cons of read/write; or a
+      function, called to get one of the other two values.
+3. The value of `default-process-coding-system', which should be a cons
+      of read/write coding systems, if the values are non-nil.
+4. The coding system `undecided' for read, and `raw-text' for write.
+
+Note that the processes of determining the read and write coding systems
+proceed essentially independently one from the other.  For example, a value
+determined from `process-coding-system-alist' might specify a read coding
+system but not a write coding system, in which the read coding system is as
+specified and the write coding system comes from proceeding to step 3 (and
+looking in `default-process-coding-system').
+
+You can change the coding systems later on using
+`set-process-coding-system', `set-process-input-coding-system', or
+`set-process-output-coding-system'.
+
+See also `set-process-filter' and `set-process-stderr-filter'."
   (let (cs-r cs-w)
     (let (ret)
       (catch 'found
@@ -172,15 +236,15 @@
       (cond ((consp ret)
 	     (setq cs-r (car ret)
 		   cs-w (cdr ret)))
-	    ((find-coding-system ret)
+	    ((and ret (find-coding-system ret))
 	     (setq cs-r ret
 		   cs-w ret))))
     (let ((coding-system-for-read
 	   (or coding-system-for-read cs-r
-	       (car default-process-coding-system)))
+	       (car default-process-coding-system) 'undecided))
 	  (coding-system-for-write
 	   (or coding-system-for-write cs-w
-	       (cdr default-process-coding-system))))
+	       (cdr default-process-coding-system) 'raw-text)))
       (apply 'start-process-internal name buffer program program-args)
       )))
 
@@ -203,13 +267,12 @@
   "Open a TCP connection for a service to a host.
 Return a process object to represent the connection.
 Input and output work as for subprocesses; `delete-process' closes it.
-Args are NAME BUFFER HOST SERVICE.
 NAME is name for process.  It is modified if necessary to make it unique.
 BUFFER is the buffer (or buffer-name) to associate with the process.
  Process output goes at end of that buffer, unless you specify
  an output stream or filter function to handle the output.
  BUFFER may be also nil, meaning that this process is not associated
- with any buffer
+ with any buffer.
 Third arg is name of the host to connect to, or its IP address.
 Fourth arg SERVICE is name of the service desired, or an integer
  specifying a port number to connect to.
@@ -222,7 +285,28 @@
 not guaranteed to be sent and received in discrete packets. (But small
 datagrams around 500 bytes that are not truncated by `process-send-string'
 are usually fine.)  Note further that UDP protocol does not guard against 
-lost packets."
+lost packets.
+
+The read/write coding systems used for process I/O on the process are
+determined as follows:
+
+1. `coding-system-for-read', `coding-system-for-write', if non-nil.
+      (Intended as a temporary overriding mechanism for use by Lisp
+      code.)
+2. The matching value for the service from `network-coding-system-alist',
+      if any, and if non-nil.  The value may be either a single coding
+      system, used for both read and write; or a cons of read/write; or a
+      function, called to get one of the other two values.
+3. The value of `default-network-coding-system', which should be a cons
+      of read/write coding systems, if the values are non-nil.
+4. The coding system `undecided' for read, and `raw-text' for write.
+
+Note that the processes of determining the read and write coding systems
+proceed essentially independently one from the other, as in `start-process'.
+
+You can change the coding systems later on using
+`set-process-coding-system', `set-process-input-coding-system', or
+`set-process-output-coding-system'."
   (let (cs-r cs-w)
     (let (ret)
       (catch 'found
@@ -249,13 +333,17 @@
       (cond ((consp ret)
 	     (setq cs-r (car ret)
 		   cs-w (cdr ret)))
-	    ((find-coding-system ret)
+	    ((and ret (find-coding-system ret))
 	     (setq cs-r ret
 		   cs-w ret))))
     (let ((coding-system-for-read
-	   (or coding-system-for-read cs-r))
+	   (or coding-system-for-read cs-r
+	       (car default-network-coding-system)
+	       'undecided))
 	  (coding-system-for-write
-	   (or coding-system-for-write cs-w)))
+	   (or coding-system-for-write cs-w
+	       (cdr default-network-coding-system)
+	       'raw-text)))
       (open-network-stream-internal name buffer host service protocol))))
 
 (defun set-buffer-process-coding-system (decoding encoding)
@@ -263,7 +351,7 @@
 DECODING is the coding system to be used to decode input from the process,
 ENCODING is the coding system to be used to encode output to the process.
 
-For a list of possible values of CODING-SYSTEM, use \\[list-coding-systems]."
+For a list of possible values of CODING-SYSTEM, use \\[coding-system-list]."
   (interactive
    "zCoding-system for process input: \nzCoding-system for process output: ")
   (let ((proc (get-buffer-process (current-buffer))))