X-Git-Url: https://git.hcoop.net/bpt/guile.git/blobdiff_plain/9630e974d2227a3735169bdcb82073dc913561ab..2e203f2d11444eaa935e50acd7dce7fe0fce638b:/ice-9/expect.scm

diff --git a/ice-9/expect.scm b/ice-9/expect.scm
index 600a205eb..ba12b2ab0 100644
--- a/ice-9/expect.scm
+++ b/ice-9/expect.scm
@@ -1,44 +1,82 @@
-;;; installed-scm-file
-
-;;;; 	Copyright (C) 1996, 1998 Free Software Foundation, Inc.
-;;;; 
+;;;; 	Copyright (C) 1996, 1998, 1999, 2001 Free Software Foundation, Inc.
+;;;;
 ;;;; This program is free software; you can redistribute it and/or modify
 ;;;; it under the terms of the GNU General Public License as published by
 ;;;; the Free Software Foundation; either version 2, or (at your option)
 ;;;; any later version.
-;;;; 
+;;;;
 ;;;; This program 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 this software; see the file COPYING.  If not, write to
 ;;;; the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 ;;;; Boston, MA 02111-1307 USA
-;;;; 
+;;;;
+;;;; As a special exception, the Free Software Foundation gives permission
+;;;; for additional uses of the text contained in its release of GUILE.
+;;;;
+;;;; The exception is that, if you link the GUILE library with other files
+;;;; to produce an executable, this does not by itself cause the
+;;;; resulting executable to be covered by the GNU General Public License.
+;;;; Your use of that executable is in no way restricted on account of
+;;;; linking the GUILE library code into it.
+;;;;
+;;;; This exception does not however invalidate any other reasons why
+;;;; the executable file might be covered by the GNU General Public License.
+;;;;
+;;;; This exception applies only to the code released by the
+;;;; Free Software Foundation under the name GUILE.  If you copy
+;;;; code from other Free Software Foundation releases into a copy of
+;;;; GUILE, as the General Public License permits, the exception does
+;;;; not apply to the code that you add in this way.  To avoid misleading
+;;;; anyone as to the status of such modified files, you must delete
+;;;; this exception notice from them.
+;;;;
+;;;; If you write modifications of your own for GUILE, it is your choice
+;;;; whether to permit this exception to apply to your modifications.
+;;;; If you do not wish that, delete this exception notice.
+;;;;
 
+;;; Commentary:
+
+;; This module is documented in the Guile Reference Manual.
+;; Briefly, these are exported:
+;;  procedures: expect-select, expect-regexec
+;;   variables: expect-port, expect-timeout, expect-timeout-proc,
+;;              expect-eof-proc, expect-char-proc,
+;;              expect-strings-compile-flags, expect-strings-exec-flags,
+;;      macros: expect, expect-strings
+
+;;; Code:
 
-(define-module (ice-9 expect) :use-module (ice-9 regex))
+(define-module (ice-9 expect)
+  :use-module (ice-9 regex)
+  :export-syntax (expect expect-strings)
+  :export (expect-port expect-timeout expect-timeout-proc
+	   expect-eof-proc expect-char-proc expect-strings-compile-flags
+	   expect-strings-exec-flags expect-select expect-regexec))
 
 ;;; Expect: a macro for selecting actions based on what it reads from a port.
 ;;; The idea is from Don Libes' expect based on Tcl.
 ;;; This version by Gary Houston incorporating ideas from Aubrey Jaffer.
 
 
-(define-public expect-port #f)
-(define-public expect-timeout #f)
-(define-public expect-timeout-proc #f)
-(define-public expect-eof-proc #f)
-(define-public expect-char-proc #f)
+(define expect-port #f)
+(define expect-timeout #f)
+(define expect-timeout-proc #f)
+(define expect-eof-proc #f)
+(define expect-char-proc #f)
 
 ;;; expect: each test is a procedure which is applied to the accumulating
 ;;; string.
-(defmacro-public expect clauses
-  (let ((s (gentemp))
-	(c (gentemp))
-	(port (gentemp))
-	(timeout (gentemp)))
+(defmacro expect clauses
+  (let ((s (gensym))
+	(c (gensym))
+	(port (gensym))
+	(timeout (gensym)))
     `(let ((,s "")
 	   (,port (or expect-port (current-input-port)))
 	   ;; when timeout occurs, in floating point seconds.
@@ -51,54 +89,61 @@
 			 #f)))
        (let next-char ()
 	 (if (and expect-timeout
-		  (or (>= (get-internal-real-time) ,timeout)
-		      (and (not (char-ready? ,port))
-			   (not (expect-select ,port ,timeout)))))
+		  (not (expect-select ,port ,timeout)))
 	     (if expect-timeout-proc
 		 (expect-timeout-proc ,s)
 		 #f)
 	     (let ((,c (read-char ,port)))
 	       (if expect-char-proc
 		   (expect-char-proc ,c))
-	       (cond ((eof-object? ,c)
-		      (if expect-eof-proc
-			  (expect-eof-proc ,s)
-			  #f))
+	       (if (not (eof-object? ,c))
+		   (set! ,s (string-append ,s (string ,c))))
+	       (cond
+		;; this expands to clauses where the car invokes the
+		;; match proc and the cdr is the return value from expect
+		;; if the proc matched.
+		,@(let next-expr ((tests (map car clauses))
+				  (exprs (map cdr clauses))
+				  (body '()))
+		    (cond
+		     ((null? tests)
+		      (reverse body))
 		     (else
-		      (set! ,s (string-append ,s (string ,c)))
-		      (cond
-		       ,@(let next-expr ((tests (map car clauses))
-					 (exprs (map cdr clauses))
-					 (body '()))
-			   (cond
-			    ((null? tests)
-			     (reverse body))
+		      (next-expr
+		       (cdr tests)
+		       (cdr exprs)
+		       (cons
+			`((,(car tests) ,s (eof-object? ,c))
+			  ,@(cond ((null? (car exprs))
+				   '())
+				  ((eq? (caar exprs) '=>)
+				   (if (not (= (length (car exprs))
+					       2))
+				       (scm-error 'misc-error
+						  "expect"
+						  "bad recipient: ~S"
+						  (list (car exprs))
+						  #f)
+				       `((apply ,(cadar exprs)
+						(,(car tests) ,s ,port)))))
+				  (else
+				   (car exprs))))
+			body)))))
+		;; if none of the clauses matched the current string.
+		(else (cond ((eof-object? ,c)
+			     (if expect-eof-proc
+				 (expect-eof-proc ,s)
+				 #f))
 			    (else
-			     (next-expr
-			      (cdr tests)
-			      (cdr exprs)
-			      (cons
-			       `((,(car tests) ,s)
-				 ,@(cond ((null? (car exprs))
-					  '())
-					 ((eq? (caar exprs) '=>)
-					  (if (not (= (length (car exprs))
-						      2))
-					      (scm-error 'misc-error
-							 "expect"
-							 "bad recipient: %S"
-							 (list (car exprs))
-							 #f)
-					      `((apply ,(cadar exprs)
-						       (,(car tests) ,s)))))
-					 (else 
-					  (car exprs))))
-			       body)))))
-		       (else (next-char)))))))))))
+			     (next-char)))))))))))
+
+
+(define expect-strings-compile-flags regexp/newline)
+(define expect-strings-exec-flags regexp/noteol)
 
 ;;; the regexec front-end to expect:
 ;;; each test must evaluate to a regular expression.
-(defmacro-public expect-strings clauses
+(defmacro expect-strings clauses
   `(let ,@(let next-test ((tests (map car clauses))
 			  (exprs (map cdr clauses))
 			  (defs '())
@@ -106,22 +151,24 @@
 	    (cond ((null? tests)
 		   (list (reverse defs) `(expect ,@(reverse body))))
 		  (else
-		   (let ((rxname (gentemp)))
+		   (let ((rxname (gensym)))
 		     (next-test (cdr tests)
 				(cdr exprs)
-				(cons `(,rxname (make-regexp ,(car tests)
-							     regexp/newline))
+				(cons `(,rxname (make-regexp
+						 ,(car tests)
+						 expect-strings-compile-flags))
 				      defs)
-				(cons `((lambda (s)
-					  (expect-regexec ,rxname s))
+				(cons `((lambda (s eof?)
+					  (expect-regexec ,rxname s eof?))
 					,@(car exprs))
 				      body))))))))
 
-;;; simplified select: returns #t if input is waiting or #f if timed out.
+;;; simplified select: returns #t if input is waiting or #f if timed out or
+;;; select was interrupted by a signal.
 ;;; timeout is an absolute time in floating point seconds.
-(define-public (expect-select port timeout)
+(define (expect-select port timeout)
   (let* ((secs-usecs (gettimeofday))
-	 (relative (- timeout 
+	 (relative (- timeout
 		      (car secs-usecs)
 		      (/ (cdr secs-usecs)
 			 1000000))))	; one million.
@@ -129,11 +176,21 @@
 	 (pair? (car (select (list port) '() '()
 			     relative))))))
 
-;;; convert a match object to a list of strings, for the => syntax.
-(define-public (expect-regexec rx s)
-  (let ((match (regexp-exec rx s)))
+;;; match a string against a regexp, returning a list of strings (required
+;;; by the => syntax) or #f.  called once each time a character is added
+;;; to s (eof? will be #f), and once when eof is reached (with eof? #t).
+(define (expect-regexec rx s eof?)
+  ;; if expect-strings-exec-flags contains regexp/noteol,
+  ;; remove it for the eof test.
+  (let* ((flags (if (and eof?
+			 (logand expect-strings-exec-flags regexp/noteol))
+		    (logxor expect-strings-exec-flags regexp/noteol)
+		    expect-strings-exec-flags))
+	 (match (regexp-exec rx s 0 flags)))
     (if match
 	(do ((i (- (match:count match) 1) (- i 1))
 	     (result '() (cons (match:substring match i) result)))
 	    ((< i 0) result))
 	#f)))
+
+;;; expect.scm ends here