merge from 1.8 branch
[bpt/guile.git] / ice-9 / expect.scm
index 20beac4..a024e91 100644 (file)
@@ -1,42 +1,57 @@
-;;;;   Copyright (C) 1996, 1998, 1999 Free Software Foundation, Inc.
+;;;;   Copyright (C) 1996, 1998, 1999, 2001, 2006 Free Software Foundation, Inc.
+;;;;
+;;;; This library is free software; you can redistribute it and/or
+;;;; modify it under the terms of the GNU Lesser General Public
+;;;; License as published by the Free Software Foundation; either
+;;;; version 2.1 of the License, or (at your option) any later version.
 ;;;; 
-;;;; 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,
+;;;; This library 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
+;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+;;;; Lesser General Public License for more details.
 ;;;; 
+;;;; You should have received a copy of the GNU Lesser General Public
+;;;; License along with this library; if not, write to the Free Software
+;;;; Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+;;;;
 \f
+;;; 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.
 \f
 
-(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.
@@ -49,9 +64,7 @@
                         #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)
@@ -61,8 +74,9 @@
               (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.
+               ;; 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 '()))
                                               2))
                                       (scm-error 'misc-error
                                                  "expect"
-                                                 "bad recipient: %S"
+                                                 "bad recipient: ~S"
                                                  (list (car exprs))
                                                  #f)
                                       `((apply ,(cadar exprs)
                                                (,(car tests) ,s ,port)))))
-                                 (else 
+                                 (else
                                   (car exprs))))
                        body)))))
                ;; if none of the clauses matched the current string.
                             (next-char)))))))))))
 
 
-(define-public expect-strings-compile-flags regexp/newline)
-(define-public expect-strings-exec-flags regexp/noteol)
+(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 '())
            (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 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.
 ;;; 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-public (expect-regexec rx s eof?)
+(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?
            ((< i 0) result))
        #f)))
 
+;;; expect.scm ends here