Rename *ll* and *ul* to ll and ul in method-by-limits

[maxima.git] / src / mload.lisp

;;; -*-  Mode: Lisp; Package: Maxima; Syntax: Common-Lisp; Base: 10 -*- ;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;     The data in this file contains enhancements.                   ;;;;;
;;;                                                                    ;;;;;
;;;  Copyright (c) 1984,1987 by William Schelter,University of Texas   ;;;;;
;;;     All rights reserved                                            ;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;;       (c) Copyright 1982 Massachusetts Institute of Technology       ;;;
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

(in-package :maxima)
(macsyma-module mload)

(defun load-and-tell (filename)
  (loadfile filename t ;; means this is a lisp-level call, not user-level.
            $loadprint))
       
(defun errset-namestring (x)
  (let ((errset nil))
    (errset (pathname x))))

(defmfun $filename_merge (&rest file-specs)
  (when (or (null file-specs) (cddr file-specs))
    (wna-err '$filename_merge))
  (setq file-specs (mapcar #'macsyma-namestring-sub file-specs))
  (pathname (if (null (cdr file-specs))
                (car file-specs)
                (merge-pathnames (cadr file-specs) (car file-specs)))))

(defun macsyma-namestring-sub (user-object)
  (if (pathnamep user-object) user-object
      (let* ((system-object
              (cond ((and (atom user-object) (not (symbolp user-object)))
                     user-object)
                    ((atom user-object) ;hence a symbol in view of the
                     (print-invert-case (fullstrip1 user-object))) ; first clause
                    (($listp user-object)
                     (fullstrip (cdr user-object)))
                    (t
                     (merror (intl:gettext "filename_merge: unexpected argument: ~M") user-object))))
             (namestring-try (errset-namestring system-object)))
        (if namestring-try (car namestring-try)
            ;; know its small now, so print on same line.
            (merror (intl:gettext "filename_merge: unexpected argument: ~:M") user-object)))))

;; Returns the truename corresponding to a stream, or nil (for non-file streams).
;; Previously we used (subtypep (type-of stream) 'file-stream) to determine whether
;; a stream is a file stream, but this doesn't work on GCL.
(defun get-stream-truename (stream)
  (handler-case
    (probe-file stream)
    (error () nil)))

(defmfun $batchload (filename-or-stream &aux (*mread-prompt* ""))
  (declare (special *mread-prompt*))
  (if (streamp filename-or-stream)
      (batchload-stream filename-or-stream)
    (let
      ((filename ($file_search1 filename-or-stream '((mlist) $file_search_maxima))))
      (with-open-file (in-stream filename)
        (batchload-stream in-stream)))))

(defun batchload-stream (in-stream &key autoloading-p)
  (let ($load_pathname)
    (let*
      ((noevalargs nil)
       (*read-base* 10.)
       (stream-truename (get-stream-truename in-stream))
       (in-stream-string-rep
        (if stream-truename
          (setq $load_pathname (cl:namestring stream-truename))
          (format nil "~A" in-stream)))
       ;; If we arrived here from autoloading, call MEVAL instead of MEVAL*
       ;; since MEVAL* is intended to be called from the interpreter top level;
       ;; MEVAL* modifies global state, resetting VARLIST and calling CLEARSIGN.
       (meval-fcn (symbol-function (if autoloading-p 'meval 'meval*)))
       (expr nil))
      (declare (special *prompt-on-read-hang*))
      (when $loadprint
        (format t (intl:gettext "~&read and interpret ~A~&") in-stream-string-rep))
      (cleanup)
      (newline in-stream)
      (loop while (and
                    (setq  expr (let (*prompt-on-read-hang*) (mread in-stream nil)))
                    (consp expr))
            do (funcall meval-fcn (third expr)))
      in-stream-string-rep)))

;;returns appropriate error or existing pathname.
;; the second argument is a maxima list of variables
;; each of which contains a list of paths.   This is
;; so users can correct the variable..
(defmfun $file_search1 (name search-lists &aux lis)
  (if (pathnamep name)
      (setq name (namestring name)))
  (setq lis (apply '$append (mapcar 'symbol-value (cdr search-lists))))
  (let ((res ($file_search name lis)))
    (or res
        (merror (intl:gettext "file_search1: ~M not found in ~A.")
                name
                (string-trim "[]" ($sconcat search-lists))))))

(defmfun $load (filename)
  "This is the generic file loading function.
  LOAD(filename) will either BATCHLOAD or LOADFILE the file,
  depending on whether the file contains Macsyma, Lisp, or Compiled
  code. The file specifications default such that a compiled file
  is searched for first, then a lisp file, and finally a macsyma batch
  file. This command is designed to provide maximum utility and
  convenience for writers of packages and users of the macsyma->lisp
  translator."

  (if (or (stringp filename) (symbolp filename) (pathnamep filename))
    (let ((searched-for
         ($file_search1 filename
                        '((mlist) $file_search_maxima $file_search_lisp  )))
        type)
      (setq type ($file_type searched-for))
      (case type
        (($maxima)
         ($batchload searched-for))
        (($lisp $object)
         ;; do something about handling errors
         ;; during loading. Foobar fail act errors.
         (load-and-tell searched-for))
        (t
         ;; UNREACHABLE MESSAGE: DEFAULT TYPE IS '$OBJECT (SEE $FILE_TYPE BELOW)
         (merror "Maxima bug: Unknown file type ~M" type)))
      searched-for)
    (merror "load: argument must be a string, symbol, or pathname; found: ~M" filename)))

(defmvar $file_type_lisp
    (list '(mlist) "l" "lsp" "lisp"))

(defmvar $file_type_maxima
    (list '(mlist) "mac" "mc" "demo" "dem" "dm1" "dm2" "dm3" "dmt" "wxm"))

(defmfun $file_type (fil)
  (let ((typ ($pathname_type fil)))
    (cond
      ((member typ (cdr $file_type_lisp) :test #'string=)
       '$lisp)
      ((member typ (cdr $file_type_maxima) :test #'string=)
       '$maxima)
      (t
       '$object))))

(defmfun $pathname_directory (path)
  (let ((pathname (pathname path)))
    (namestring (make-pathname :directory (pathname-directory pathname)))))

(defmfun $pathname_name (path)
  (let ((pathname (pathname path)))
    (pathname-name pathname)))

(defmfun $pathname_type (path)
  (let ((pathname (pathname path)))
    (pathname-type pathname)))
  

(defvar *macsyma-startup-queue* nil)

(declaim (special *mread-prompt*))

;;;; batch & demo search hacks

(defmfun $batch (filename-or-stream &optional (demo :batch)
               &aux tem   (possible '(:demo :batch :test)))
  "giving a second argument makes it use demo mode, ie pause after evaluation
   of each command line"

  ;; Try to get rid of testsuite failures on machines that are low on RAM.
  ($garbage_collect)
  (cond
    ((setq tem (member ($mkey demo) possible :test #'eq))
     (setq demo (car tem)))
    (t (format t (intl:gettext "batch: second argument must be 'demo', 'batch' or 'test'; found: ~A, assumed 'batch'~%") demo)))
  (if (streamp filename-or-stream)
    (batch-stream filename-or-stream demo)
    (let
      ((filename ($file_search1 filename-or-stream
                                (if (eql demo :demo)
                                  '((mlist) $file_search_demo )
                                  '((mlist) $file_search_maxima)))))
      (cond
        ((eq demo :test)
         (test-batch filename nil :show-all t)) ;; NEED TO ACCEPT INPUT STREAM HERE TOO
        (t
          (with-open-file (in-stream filename)
            (batch-stream in-stream demo)))))))

(defun batch-stream (in-stream demo)
  (let ($load_pathname)
    (let*
      ((*read-base* 10.)
      (stream-truename (get-stream-truename in-stream))
       (in-stream-string-rep
        (if stream-truename
          (setq $load_pathname (cl:namestring stream-truename))
          (format nil "~A" in-stream))))
      (format t (intl:gettext "~%read and interpret ~A~%") in-stream-string-rep)
      (catch 'macsyma-quit (continue :stream in-stream :batch-or-demo-flag demo))
      (incf $linenum)
      in-stream-string-rep)))

;; When either a or b are special float values (NaN or +/-Inf), return true iff
;; a and b are the both NaN or both +Inf or both -Inf.
;; Note that float_approx_equal(NaN, NaN) returns true.
;;
;; When a and b to finite, nonzero floats, return true iff
;;
;;   |a - b| <= float_approx_equal_tolerance * min(2^n, 2^m)
;;
;; where a = af * 2^m, |af| < 1, and m is an integer (similarly for b). 
;; See Knuth, "The Art of Computer Programming" (3rd ed.), Vol. 2, Sec. 4.2.2, Eq. 24, page 233.
;;
;; Note that Eq. 24 isn't well-defined for a or b equal to zero.
;; To make progress, let's consider the limit as b --> 0,
;; therefore n --> -inf. For any finite a, that means that min(2^n, 2^m) = 2^n
;; and therefore |a - b| --> |a|, but to pass the test,
;; |a| must be less than or equal to float_approx_equal_tolerance * 2^n --> 0.
;; Therefore the test fails for all nonzero, finite a, when b = 0.
;; i.e. when either a or b is zero but not both, return false.
;;
;; Note also that if a < 0 and b > 0 or vice versa, the test must fail:
;; without loss of generality assume |a| > |b|. Then n <= m and min(2^n, 2^m) = 2^n.
;; Now |a - b| = |a| + |b| since a and b are different signs.
;; Then |a - b| / min(2^n, 2^m) = |a/min(2^n, 2^m)| + |b/min(2^n, 2^m)| = |af|*2^m/2^n + |bf| >= |af| + |bf| > 1.
;; So unless float_approx_equal_tolerance is unusually large, the test must fail.
;;
;; Otherwise, either a or b is not a float, so return false.

(defmvar $float_approx_equal_tolerance (* 8 +flonum-epsilon+))

(defmfun $float_approx_equal (a b)
  (setq a (if (floatp a) a ($float a)))
  (setq b (if (floatp b) b ($float b)))
  (and
   (floatp a)
   (floatp b)
   (cond
     ;; look for NaN
     ((/= a a) (/= b b))
     ((/= b b) nil)
     ;; look for Inf
     ((> (abs a) most-positive-double-float) (= a b))
     ((> (abs b) most-positive-double-float) nil)
     ;; look for zero
     ((= a 0d0) (= b 0d0))
     ((= b 0d0) nil)
     ;; look for A = B
     ((= a b))
     (t
      ;; Implement test without involving floating-point arithmetic,
      ;; to avoid errors which could occur with extreme values.
      (multiple-value-bind (a-significand a-expt a-sign)
          (decode-float a)
        (declare (ignore a-significand))
        (multiple-value-bind (b-significand b-expt b-sign)
            (decode-float b)
          (declare (ignore b-significand))
          (when (or (= a-sign b-sign)
                    (>= $float_approx_equal_tolerance 1d0))
            (multiple-value-bind (a-b-significand a-b-expt)
                (integer-decode-float (abs (- a b)))
              (multiple-value-bind (tol-significand tol-expt)
                  (integer-decode-float $float_approx_equal_tolerance)
                (or (< a-b-expt (+ tol-expt (min a-expt b-expt)))
                    (and (= a-b-expt (+ tol-expt (min a-expt b-expt)))
                         (<= a-b-significand tol-significand))))))))))))

;; Big float version of float_approx_equal. But for bfloat_approx_equal, the tolerance isn't
;; user settable; instead, it is 32 / 2^fpprec. The factor of 32 is too large, I suppose. But
;; the test suite gives a few errors with a factor of 16. These errors might be due to 
;; float / big float comparisons.

(defmfun $bfloat_approx_equal (a b)
  (setq a (if ($bfloatp a) a ($bfloat a)))
  (setq b (if ($bfloatp b) b ($bfloat b)))
  (let ((m) (bits))
    (and
     ($bfloatp a)
     ($bfloatp b)
     (setq bits (min (third (first a)) (third (first b))))
     (setq m (* 32 (expt 2 (- bits)) (min (expt 2 (- (car (last a)) 1)) (expt 2 (- (car (last b)) 1)))))
     (setq m (if (rationalp m) (div (numerator m) (denominator m)) m))
     (eq t (mgqp m (take '(mabs) (sub a b)))))))


;; The first argument 'f' is the expected result; the second argument 
;; 'g' is the output of the test. By explicit evaluation, the expected 
;; result *can* be a CL array, CL hashtable, or a taylor polynomial. Such
;; a test would look something like (yes, it's a silly test)

;;    taylor(x,x,0,2);
;;    ''(taylor(x,x,0,2)
 
(defun approx-alike (f g)
 
  (cond ((floatp f) (and (floatp g) ($float_approx_equal f g)))
        
        (($bfloatp f) (and ($bfloatp g) ($bfloat_approx_equal f g)))
        
        (($taylorp g)
         (approx-alike 0 (sub (ratdisrep f) (ratdisrep g))))
        
        ((stringp f)
         (and (stringp g) (string= f g)))

        ((arrayp f)
         (and (arrayp g)
          (equal (array-dimensions f) (array-dimensions g))
          (approx-alike ($listarray f) ($listarray g))))

        ((hash-table-p f)
         (and (hash-table-p g) (approx-alike ($listarray f) ($listarray g))))

        ((atom f)
         (and (atom g) (equal f g)))
                     
        ((op-equalp f 'lambda)
         (and (op-equalp g 'lambda)
              (approx-alike-list (mapcar #'(lambda (s) (simplifya s nil)) (margs f))
                                 (mapcar #'(lambda (s) (simplifya s nil)) (margs g)))))
        
        (($ratp f)
         (and ($ratp g) (approx-alike (ratdisrep f) (ratdisrep g))))
        
        ;; maybe we don't want this.
        ((op-equalp f 'mquote)
         (approx-alike (second f) g))
         
        ;; I'm pretty sure that (mop f) and (mop g) won't signal errors, but
        ;; let's be extra careful.

        ((and (consp f) (consp (car f)) (consp g) (consp (car g))
              (or (approx-alike (mop f) (mop g)) 
                  (and (symbolp (mop f)) (symbolp (mop g))
                       (approx-alike ($nounify (mop f)) ($nounify (mop g)))))
              (eq ($subvarp f) ($subvarp g))
              (approx-alike-list (margs f) (margs g))))
        
        (t nil)))

(defun approx-alike-list (p q)
  (cond ((null p) (null q))
        ((null q) (null p))
        (t (and (approx-alike (first p) (first q)) (approx-alike-list (rest p) (rest q))))))

(defun simple-equal-p (f g)
  (approx-alike (simplifya f nil) (simplifya g nil)))

(defun batch-equal-check (expected result)
  (let ((answer (catch 'macsyma-quit (simple-equal-p expected result))))
    (if (eql answer 'maxima-error) nil answer)))

(defvar *collect-errors* t)

;; Execute the code in FILENAME as a batch file.  If EXPECTED-ERRORS
;; is non-NIL, it is a list of numbers denoting which tests in this
;; file are expected to fail.  OUT specifies the stream where any
;; output goes (defaulting to *standard-output*).  SHOW-EXPECTED is
;; non-NIL if the expected results should also be printed.  SHOW-ALL
;; is non-NIL if all tests (including expected failures) should be
;; shown.  Finally, SHOWTIME is non-NIL if the execution time should
;; be displayed.
;;
;; This function returns four values:
;;   1.  the filename
;;   2.  NIL or a Maxima list of test numbers that failed
;;   3.  NIL or a Maxima list of test numbers that were expected to
;;       fail but actually passed.
;;   4.  Total number of tests in the file
(defun test-batch (filename expected-errors
                            &key (out *standard-output*) (show-expected nil)
                            (show-all nil) (showtime nil))

  (let (result
        next-result
        next
        error-log
        all-differences
        unexpected-pass
        strm
        expr
        problem-lineinfo
        problem-lineno
        tmp-output
        save-output
        ($ratprint nil)
        (*mread-prompt* "")
        (*read-base* 10.)
        (num-problems 0)
        (i 0)
        (start-run-time 0)
        (end-run-time 0)
        (start-real-time 0)
        (end-real-time 0)
        (test-start-run-time 0)
        (test-end-run-time 0)
        (test-start-real-time 0)
        (test-end-real-time 0))
    
    (cond (*collect-errors*
           (setq error-log
                 (if (streamp *collect-errors*) *collect-errors*
                   (handler-case
                       (open (alter-pathname filename :type "ERR") :direction :output :if-exists :supersede)
                     (file-error () nil))))
           (when error-log
             (format t (intl:gettext "~%batch: write error log to ~a") error-log)
             (format error-log (intl:gettext "~%/* Maxima error log from tests in ~A") filename)
             (format error-log " */~2%"))))
 
    (unwind-protect 
        (progn
          (setq strm (open filename :direction :input))
          (setq start-real-time (get-internal-real-time))
          (setq start-run-time (get-internal-run-time))
          (while (not (eq 'eof (setq expr (mread strm 'eof))))
            (incf num-problems)
            (setq problem-lineinfo (second (first expr)))
            (setq problem-lineno (if (and (consp problem-lineinfo) (integerp (first problem-lineinfo)))
                                     (1+ (first problem-lineinfo))))
            (incf i)
            (setf tmp-output (make-string-output-stream))
            (setf save-output *standard-output*)
            (setf *standard-output* tmp-output)
          
            (unwind-protect
                 (progn
                   (setq test-start-run-time (get-internal-run-time))
                   (setq test-start-real-time (get-internal-real-time))
                   (let (($errormsg t))
                     (setq result (meval* `(($errcatch) ,(third expr)))))
                   (setq result (if ($emptyp result) 'error-catch (second result)))
                   (setq test-end-run-time (get-internal-run-time))
                   (setq test-end-real-time (get-internal-real-time))
                   (setq $% result))
              (setf *standard-output* save-output))

            (setq next (mread strm 'eof))
            (if (eq next 'eof) (merror (intl:gettext "batch: missing expected result in test script.")))
          
            (setq next-result (third next))
            (let* ((correct (batch-equal-check next-result result))
                   (expected-error (member i expected-errors))
                   (pass (or correct expected-error)))
              (when (or show-all (not pass) (and correct expected-error)
                        (and expected-error show-expected))
                (format out (intl:gettext "~%********************** Problem ~A~A***************")
                        i (if problem-lineno (format nil " (line ~S) " problem-lineno) " "))
                (format out (intl:gettext "~%Input:~%"))
                (displa (third expr))
                (format out (intl:gettext "~%~%Result:~%"))
                (format out "~a" (get-output-stream-string tmp-output))
                (displa $%)
                (when (eq showtime '$all)
                  (format out (intl:gettext "~%Time:  ~,3F sec (~,3F elapsed)")
                          (float (/ (- test-end-run-time test-start-run-time)
                                    internal-time-units-per-second))
                          (float (/ (- test-end-real-time test-start-real-time)
                                    internal-time-units-per-second)))))
              (cond ((and correct expected-error)
                     (push i unexpected-pass)
                     (format t
                             (intl:gettext "~%... Which was correct, but was expected ~
                              to be wrong due to a known bug in~% Maxima or ~A.~%")
                             (lisp-implementation-type)))
                    (correct
                     (if show-all (format t (intl:gettext "~%... Which was correct.~%"))))
                    ((and (not correct) expected-error)
                     (when (or show-all show-expected)
                       (format t
                               (intl:gettext "~%This is a known error in Maxima or in ~A. ~
                                    The correct result is:~%")
                               (lisp-implementation-type))
                       (displa next-result)))
                    (t (format t (intl:gettext "~%This differed from the expected result:~%"))
                     (push i all-differences)
                     (displa next-result)
                     (cond ((and *collect-errors* error-log)
                            (format error-log (intl:gettext "/* Problem ~A~A*/~%")
                                    i (if problem-lineno (format nil " (line ~S) " problem-lineno) " "))
                            (mgrind (third expr) error-log)
                            (list-variable-bindings (third expr) error-log)
                            (format error-log ";~%")
                            (format error-log (intl:gettext "/* Erroneous Result?:~%"))
                            (mgrind result error-log) (format error-log " */ ")
                            (terpri error-log)
                            (format error-log (intl:gettext "/* Expected result: */~%"))
                            (mgrind next-result error-log)
                            (format error-log ";~%~%"))))))))
      (close strm))
    (setq end-run-time (get-internal-run-time))
    (setq end-real-time (get-internal-real-time))
    (cond (error-log
           (or (streamp *collect-errors*)
               (close error-log))))
    (let*
      ((n-expected-errors (length expected-errors))
       (expected-errors-trailer
         (if (= n-expected-errors 0)
            ""
            (format nil (intl:gettext " (not counting ~a expected errors)") n-expected-errors)))
       (time (if showtime
                 (format nil (intl:gettext "   using ~,3F seconds (~,3F elapsed).~%")
                         (float (/ (- end-run-time start-run-time) internal-time-units-per-second))
                         (float (/ (- end-real-time start-real-time) internal-time-units-per-second)))
                 "")))
      (cond ((null all-differences)
             (format t (intl:gettext "~a/~a tests passed~a~%~A")
                     (- num-problems n-expected-errors) (- num-problems n-expected-errors)
                     expected-errors-trailer
                     time)
             (when unexpected-pass
               (multiple-value-bind (plural was-were)
                 (if (> (length unexpected-pass) 1)
                     (values "s" "were")
                     (values "" "was"))
               (format t (intl:gettext "~%The following ~A problem~A passed but ~A expected to fail: ~A~%")
                       (length unexpected-pass) plural was-were (reverse unexpected-pass))))
             (values filename
                     nil
                     `((mlist) ,@(reverse unexpected-pass))
                     num-problems))
            (t
             (format t (intl:gettext "~%~a/~a tests passed~a~%~A")
                     (- num-problems n-expected-errors (length all-differences)) (- num-problems n-expected-errors) expected-errors-trailer
                     time)
             (let ((s (if (> (length all-differences) 1) "s" "")))
               (format t (intl:gettext "~%The following ~A problem~A failed: ~A~%")
                       (length all-differences) s (reverse all-differences)))
             (when unexpected-pass
               (multiple-value-bind (plural was-were)
                 (if (> (length unexpected-pass) 1)
                     (values "s" "were")
                     (values "" "was"))
               (format t (intl:gettext "~%The following ~A problem~A passed but ~A expected to fail: ~A~%")
                       (length unexpected-pass) plural was-were (reverse unexpected-pass))))
             (values filename
                     `((mlist) ,@(reverse all-differences))
                     `((mlist) ,@(reverse unexpected-pass))
                     num-problems))))))
       
;;to keep track of global values during the error:
(defun list-variable-bindings (expr &optional str &aux tem)
  (loop for v in(cdr ($listofvars  expr))
    when (member v $values :test #'equal)
    collecting (setq tem`((mequal) ,v ,(meval* v)))
    and
    do (cond (str (format str ",")(mgrind tem str)))))

;;in init_max
;; name = foo or foo.type or dir/foo.type or dir/foo 
;; the empty parts are filled successively from defaults in templates in
;; the path.   A template may use multiple {a,b,c} constructions to indicate
;; multiple possibilities.  eg foo.l{i,}sp or foo.{dem,dm1,dm2}
(defmfun $file_search (name &optional paths)
  (if (and (symbolp name)
           (char= (char (symbol-name name) 0) #\$))
      (setq name (subseq (print-invert-case name) 1)))
  (if (symbolp name)  (setf name (string name)))
  (if (file-exists-p name) (return-from $file_search name))
  (or paths (setq paths ($append $file_search_lisp  $file_search_maxima
                                 $file_search_demo)))
  (atomchk paths '$file_search t)
  (new-file-search (string name) (cdr paths)))

;; Returns T if NAME exists and it does not appear to be a directory.
;; Note that Clisp throws an error from PROBE-FILE if NAME exists
;; and is a directory; hence the use of IGNORE-ERRORS.

(defun file-exists-p (name)
  (let ((foo (ignore-errors (probe-file name))))
    (if foo (not (apparently-a-directory-p foo)))))

(defun apparently-a-directory-p (path)
  (eq (pathname-name path) nil))

;; We keep these here in case we want to optimize the search.  To
;; speed things up, we might want to support search lists like
;; "share/**/*.{mac,wxm,mc}" so that we only descend the directory
;; once.  Then we would take the list of paths and try to match the
;; one with the given extensions.
;;
;; Currently, the search list is ["share/**/*.mac", "share/**/*.wxm",
;; "share/**/*.mc"].  Thus to find "foo.mc", we end up doing a
;; directory 3 times.
#+nil
(defun new-file-search (name template)
  (cond ((file-exists-p name))
        ((atom template)
         (let ((lis (loop for w in (split-string template "{}")
                          when (null (position #\, w))
                          collect w
                          else
                          collect (split-string w ","))))
           (new-file-search1 name "" lis)))
        (t
         (let ((temp nil))
           (loop for v in template
                 when (setq temp (new-file-search name v))
                   do (return temp))))))

#+nil
(defun new-file-search1 (name begin lis)
  (cond ((null lis)
         (let ((file (namestring ($filename_merge begin name))))
           (if (file-exists-p file) file nil)))
        ((atom (car lis))
         (new-file-search1 name
                           (if begin
                               ($sconcat begin (car lis)) (car lis))
                           (cdr lis)))
        (t (loop for v in (car lis) with tem
                  when (setq tem  (new-file-search1 name begin (cons v (cdr lis))))
                  do (return tem)))))

(defvar *debug-new-file-search* nil)

;; Search for a file named NAME.  If the file exists, return it.
;; Otherwise, TEMPLATE is a list of wildcard paths to be searched for
;; the NAME.  Each entry in TEMPLATE should be a Lisp wildcard
;; pathname.
(defun new-file-search (name template)
  (cond ((file-exists-p name))
        (t
         (let ((filename (pathname name)))
           (dolist (path template)
             (let ((pathnames (directory (merge-pathnames filename path))))
               (when *debug-new-file-search*
                 (format *debug-io* "wildpath ~S~%" (merge-pathnames filename path)))
               (when pathnames
                 ;; We MUST sort the results in alphabetical order
                 ;; because that's how the old search paths were
                 ;; sorted.
                 (setf pathnames (sort pathnames #'string< :key #'namestring))
                 (when *debug-new-file-search*
                   (format *debug-io* "pathname = ~S~%" pathnames))
                 ;; If more than one path is returned, print a warning
                 ;; that we're selecting the first file.  Print all
                 ;; the matches too so the user knows.
                 (unless (= 1 (length pathnames))
                   (mwarning
                    (format nil
                            "More than one file matches.  Selecting the first file from:~
~%~{  ~A~^~%~}~%"
                            (mapcar #'namestring pathnames))))
                 (return-from new-file-search (namestring (first pathnames))))))))))

(defun save-linenumbers (&key (c-lines t) d-lines (from 1) (below $linenum) a-list
                         (file  "/tmp/lines")
                         &aux input-symbol ($linel 79))
  (cond ((null a-list) (setq a-list (loop for i from from below below collecting i))))
  (with-open-file (st file :direction :output)
    (format st "/* -*- Mode: MACSYMA; Package: MACSYMA -*- */")
    (format st "~%~%       /*    ~A     */  ~%"
            (let ((tem (cdddr
                                (multiple-value-list (get-decoded-time)))))
                      (format nil "~a:~a:~a" (car tem) (cadr tem) (caadr tem))))
    (loop for i in a-list
           when (and c-lines (boundp (setq input-symbol (intern (format nil "$~A~A" '#:c i)))))
           do
           (format st "~% C~3A;  "   i)
           (mgrind (symbol-value input-symbol) st)
           (format st ";")
           when (and d-lines
                     (boundp (setq input-symbol (intern (format nil "$~A~A" '#:d i)))))
           do
           (format st "~% D~3A:  "   i)
           (mgrind (symbol-value input-symbol) st)
           (format st "$"))))


(defmfun $printfile (file)
  (setq file ($file_search1 file '((mlist) $file_search_usage)))
  (with-open-file (st file)
    (loop
       with tem
       while (setq tem (read-char st nil 'eof)) 
       do
       (if (eq tem 'eof) (return t))
       (princ tem))
    (namestring file)))

(defun disable-some-lisp-warnings ()
  ;; Suppress warnings about redefining functions;
  ;; it appears that only Clisp and SBCL emit these warnings
  ;; (ECL, GCL, CMUCL, and Clozure CL apparently do not).
  ;; Such warnings are generated by the autoload mechanism.
  ;; I guess it is plausible that we could also avoid the warnings by
  ;; reworking autoload to not trigger them. I don't have enough
  ;; motivation to attempt that right now.
  #+sbcl
  (setq sb-ext:*muffled-warnings* '(or sb-kernel:redefinition-with-defun sb-kernel:uninteresting-redefinition))
  #+sbcl
  (declaim (sb-ext:muffle-conditions sb-ext:compiler-note))
  #+clisp
  (setq custom:*suppress-check-redefinition* t)

  ;; Suppress compiler output messages.
  ;; These include the "0 errors, 0 warnings" message output from Clisp,
  ;; and maybe other messages from other Lisps.
  (setq *compile-verbose* nil))

(defun enable-some-lisp-warnings ()
  ;; SB-KERNEL:UNINTERESTING-REDEFINITION appears to be the default value.
  #+sbcl
  (setq sb-ext:*muffled-warnings* 'sb-kernel:uninteresting-redefinition)
  #+sbcl
  (declaim (sb-ext:unmuffle-conditions sb-ext:compiler-note))
  #+clisp
  (setq custom:*suppress-check-redefinition* nil)
  (setq *compile-verbose* t))

(defun simple-remove-dollarsign (x)
  "Like stripdollar, but less heavy.  Intended for use with the
  testsuite implementation."
  (if (symbolp x)
      (subseq (maxima-string x) 1)
      x))

(defun intersect-tests (tests)
  ;; If TESTS is non-NIL, we assume it's a Maxima list of (maxima)
  ;; strings naming the tests we want to run.  They must match the
  ;; file names in $testsuite_files.  We ignore any items that aren't
  ;; in $testsuite_files.
  (mapcar #'simple-remove-dollarsign
          (cond (tests
                 (let ((results nil))
                   ;; Using INTERSECTION would be convenient, but
                   ;; INTERSECTION can return the result in any
                   ;; order, and we'd prefer that the order of the
                   ;; tests be preserved.  CMUCL and CCL returns the
                   ;; intersection in reverse order.  Clisp produces
                   ;; the original order.  Fortunately, this doesn't
                   ;; have to be very fast, so we do it very naively.
                   (dolist (test (mapcar #'simple-remove-dollarsign (cdr tests)))
                     (let ((matching-test (find test (cdr $testsuite_files)
                                                :key #'(lambda (x)
                                                         (maxima-string (if (listp x)
                                                                            (second x)
                                                                            x)))
                                                :test #'string=)))
                       (when matching-test
                         (push matching-test results))))
                   (nreverse results)))
                (t
                 (cdr $testsuite_files)))))

(defun print-testsuite-summary (errs unexpected-pass error-count total-count)
  (flet
      ((problem-summary (x)
         ;; We want to print all the elements in the list.
         (let ((*print-length* nil)
               (s (if (> (length (rest x)) 1) "s" "")))
           (format t
                   (intl:gettext
                    "  ~a problem~a:~%    ~a~%")
                   (first x)
                   s
                   (sort (rest x) #'<)))))
    (if (null errs)
        (format t
                (intl:gettext
                 "~%~%No unexpected errors found out of ~:d tests.~%")
                total-count)
        (format t (intl:gettext "~%Error summary:~%")))
    (when errs
      (format t (intl:gettext "Error(s) found:~%"))
      (mapcar #'problem-summary (reverse errs)))
    (when unexpected-pass
      (format t (intl:gettext "Tests that were expected to fail but passed:~%"))
      (mapcar #'problem-summary (reverse unexpected-pass)))
    (when errs
      (format t
              (intl:gettext
               "~&~:d test~p failed out of ~:d total tests.~%")
              error-count
              error-count
              total-count))))

(defun validate-given-tests (tests share-tests-p)
  ;; Check the test names and print out some warnings if it
  ;; doesn't exist, or if it does and is part of the share test
  ;; suite, but share_tests was not set.
  (dolist (test (mapcar #'simple-remove-dollarsign
                        (if (listp tests)
                            (cdr tests)
                            (list tests))))
    (cond ((and (not share-tests-p)
                (find test (cdr $share_testsuite_files)
                      :key #'(lambda (x)
                               (maxima-string (if (listp x)
                                                  (second x)
                                                  x)))
                      :test #'string=))
           (mwarning test "is a share test, but share_tests was not set"))
          ((not (find test (cdr $testsuite_files)
                      :key #'(lambda (x)
                               (maxima-string (if (listp x)
                                                  (second x)
                                                  x)))
                      :test #'string=))
           (mwarning "Unknown test: " test)))))
  
(defmfun $run_testsuite (&key tests display_all display_known_bugs share_tests time debug)
  "Run the testsuite.  Options are
  tests                List of tests to run
  display_all          Display output from each test entry
  display_known_bugs   Include tests that are known to fail.
  time                 Display time to run each test entry
  share_tests          Whether to include the share testsuite or not
  debug                Set to enable some debugging prints.
"
  (enable-some-lisp-warnings)
  (let ((test-file)
        (expected-failures)
        (test-file-path))
    (format t "Testsuite run for ~a ~a:~%"
            (lisp-implementation-type) (lisp-implementation-version))
    ;; Allow only T and NIL for display_known_bugs and display_all
    (unless (member display_known_bugs '(t nil))
      (merror (intl:gettext "run_testsuite: display_known_bugs must be true or false; found: ~M") display_known_bugs))
    (unless (member display_all  '(t nil))
      (merror (intl:gettext "run_testsuite: display_all must be true or false; found: ~M") display_all))
    (unless (member time '(t nil $all))
      (merror (intl:gettext "run_testsuite: time must be true, false, or all; found: ~M") time))

    (unless (member share_tests '(t nil $only))
      (merror (intl:gettext "run_testsuite: share_tests must be true, false or only: found ~M") share_tests))
    
    (setq *collect-errors* nil)

    (multiple-value-bind (desired-tests desired-search-path)
        (ecase share_tests
          ((nil)
           ;; Do nothing
           (values $testsuite_files $file_search_tests))
          ((t)
           ;; Append the share files and concatenate the search paths
           ;; for tests and maxima so we can find both sets of tests.
           (values ($append $testsuite_files $share_testsuite_files)
                   ;; Is there a better way to do this?
                   (concatenate 'list
                                '((mlist))
                                (rest $file_search_tests)
                                (rest $file_search_maxima))))
          ($only
           ;; Only the share test files
           (values $share_testsuite_files $file_search_maxima)))
      (let* (($testsuite_files desired-tests)
             ($file_search_tests desired-search-path)
             (error-break-file)
             (tests-to-run (intersect-tests (cond ((consp tests) tests)
                                                  (tests (list '(mlist) tests)))))
             (test-count 0)
             (total-count 0)
             (error-count 0)
             filename
             diff
             upass)

        (validate-given-tests tests share_tests)

        (when debug
          (let (($stringdisp t))
            (mformat t "$testsuite_files = ~M~%" $testsuite_files)
            (mformat t "$file_search_tests = ~M~%" $file_search_tests)))
        (when debug
          (let (($stringdisp t))
            (mformat t "tests-to-run = ~M~%" tests-to-run)))

        (unless tests-to-run
          (mwarning "No tests to run")
          (return-from $run_testsuite '$done))

        (flet
            ((testsuite ()
               (loop with errs = 'nil
                     with unexpected-pass = nil
                     for testentry in tests-to-run
                     do (if (atom testentry)
                            (progn
                              (setf test-file testentry)
                              (setf expected-failures nil))
                            (progn
                              (setf test-file (second testentry))
                              (setf expected-failures
                                    ;; Support the expected failures list in
                                    ;; two formats:
                                    ;;
                                    ;; ((mlist) "test" 1 2 3)
                                    ;; ((mlist) "test" ((mlist) 1 2 3))
                                    ;;
                                    ;; The first is the old style whereas the
                                    ;; second is the new style.  We support
                                    ;; the old style for backward
                                    ;; compatibility.
                                    (if (consp (caddr testentry))
                                        (cdaddr testentry)
                                        (cddr testentry)))))
                        (setf test-file-path ($file_search test-file $file_search_tests))
                        (format t
                                (intl:gettext "Running tests in ~a: ")
                                (if (symbolp test-file)
                                    (subseq (print-invert-case test-file) 1)
                                    test-file))
                        (when debug
                          (format t (intl:gettext "(~A) ") test-file-path))
                        (or
                          (errset
                            (progn
                              (multiple-value-setq (filename diff upass test-count)
                                (test-batch test-file-path
                                            expected-failures :show-expected display_known_bugs
                                            :show-all display_all :showtime time))
                              (incf total-count test-count)
                              (when (or (rest diff) (rest upass))
                                (incf error-count (length (rest diff)))
                                (when (rest diff)
                                  (push (list* filename (rest diff))
                                        errs))
                                (when (rest upass)
                                  (push (list* filename (rest upass))
                                        unexpected-pass)))))
                          (progn
                            (setq error-break-file (format nil "~a" test-file))
                            (push (list error-break-file "error break")
                                  errs)
                            (format t
                                    (intl:gettext "~%Caused an error break: ~a")
                                    test-file)
                            ;; If the test failed because we
                            ;; couldn't find the file, make a note of
                            ;; that.
                            (unless test-file-path
                              (format t (intl:gettext ": test file not found.")))
                            (format t "~%")))
                     finally
                        (print-testsuite-summary errs unexpected-pass error-count total-count))))
          (time (testsuite))))))
  (disable-some-lisp-warnings)
  '$done)