org.armedbear.lisp.inspect.lisp Maven / Gradle / Ivy
;;; inspect.lisp
;;;
;;; Copyright (C) 2003-2005 Peter Graves
;;; $Id$
;;;
;;; 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
;;; of the License, 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 program; if not, write to the Free Software
;;; Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
;;;
;;; As a special exception, the copyright holders of this library give you
;;; permission to link this library with independent modules to produce an
;;; executable, regardless of the license terms of these independent
;;; modules, and to copy and distribute the resulting executable under
;;; terms of your choice, provided that you also meet, for each linked
;;; independent module, the terms and conditions of the license of that
;;; module. An independent module is a module which is not derived from
;;; or based on this library. If you modify this library, you may extend
;;; this exception to your version of the library, but you are not
;;; obligated to do so. If you do not wish to do so, delete this
;;; exception statement from your version.
(in-package #:system)
(require 'clos)
(require 'format)
(defvar *inspect-break* nil)
(defvar *inspected-object-stack* nil)
(defvar *inspected-object* nil)
(defun leader (name)
(let ((size (max 0 (- 16 (length (string name))))))
(concatenate 'string (make-string size :initial-element #\-) "->")))
(defun safe-length (x)
(do ((n 0 (+ n 2))
(fast x (cddr fast))
(slow x (cdr slow)))
(())
(when (null fast)
(return (values n :proper)))
(when (atom fast)
(return (values n :dotted)))
(when (null (cdr fast))
(return (values (+ n 1) :proper)))
(when (atom (cdr fast))
(return (values (+ n 1) :dotted)))
(when (and (eq fast slow) (> n 0))
(return (values nil :circular)))))
(defun display-object (obj)
(let ((*print-length* 2)
(*print-level* 2))
(cond ((typep obj 'standard-object)
(let ((parts (inspected-parts obj))
(i 0))
(dolist (part parts)
(let ((name (car part))
(value (cdr part)))
(format t "~4D ~A ~A ~S~%"
i
name
(leader name)
value)
(incf i)))))
((simple-vector-p obj)
(format t "~A at #x~X~%" (inspected-description obj) (identity-hash-code obj))
(let ((limit (min (length obj) 25)))
(dotimes (i limit)
(format t "~4D-> ~A~%" i (aref obj i)))))
((vectorp obj)
(format t "~A~%" (inspected-description obj))
(let ((limit (min (length obj) 25)))
(dotimes (i limit)
(format t "~4D-> ~A~%" i (aref obj i)))))
((consp obj)
(multiple-value-bind (len kind) (safe-length obj)
(case kind
(:proper
(format t "A proper list with ~D elements at #x~X~%"
len
(identity-hash-code obj))
(let ((i 0))
(dolist (item obj)
(cond ((< i 25)
(format t "~4D-> ~S~%" i item))
((= i 25)
(format t " ...~%"))
((= i (1- len))
(format t "~4D-> ~S~%" i item)))
(incf i))))
(:dotted
(format t "A dotted list with ~D elements at #x~X~%"
len
(identity-hash-code obj))
(let* ((rest obj)
(item (car rest))
(i 0))
(loop
(cond ((< i 25)
(format t "~4D-> ~S~%" i item))
((= i 25)
(format t " ...~%")))
(incf i)
(setf rest (cdr rest))
(when (atom rest)
(return))
(setf item (car rest)))
(format t "tail-> ~S~%" rest)))
(:circular
(format t "A circular list at #x~X~%" (identity-hash-code obj))))))
(t
(format t "~A~%" (inspected-description obj))
(let ((parts (inspected-parts obj))
(i 0)
(limit 25))
(dolist (part parts)
(let ((name (string (car part)))
(value (cdr part)))
(format t "~4D ~A ~A ~S~%" i
name
(leader name)
value)
(incf i)
(when (> i limit)
(return))))))))
(values))
(defun display-current ()
(if *inspect-break*
(display-object *inspected-object*)
(format t "No object is being inspected.")))
(defun inspect (obj)
(when ext:*inspector-hook*
(funcall ext:*inspector-hook* obj))
(when *inspected-object*
(push *inspected-object* *inspected-object-stack*))
(setf *inspected-object* obj)
(let* ((*inspect-break* t)
(*debug-level* (1+ *debug-level*)))
(setf *** **
** *
* obj)
(display-current)
(catch 'inspect-exit
(tpl::repl)))
(setf *** **
** *
* obj)
(values))
(defun istep (args)
(if (null args)
(display-current)
(let* ((pos (position #\space args))
(option-string (if pos (subseq args 0 pos) args))
(option (read-from-string option-string)))
(cond ((string= option-string "-")
(if *inspected-object-stack*
(progn
(setf *inspected-object* (pop *inspected-object-stack*))
(setf *** **
** *
* *inspected-object*)
(display-current))
(format t "Object has no parent.")))
((string= option-string "q")
(setf *inspected-object* nil
*inspected-object-stack* nil
*inspect-break* nil)
(throw 'inspect-exit nil))
((fixnump option)
(let* ((index option)
(parts (inspected-parts *inspected-object*)))
(cond ((null parts)
(if (typep *inspected-object* 'sequence)
(if (or (minusp index)
(>= index (length *inspected-object*)))
(format t "Invalid index (~D)." index)
(progn
(push *inspected-object* *inspected-object-stack*)
(setf *inspected-object*
(elt *inspected-object* index))
(setf * *inspected-object*)
(display-current)))
(format t "Object has no selectable components.")))
((or (minusp index)
(>= index (length parts)))
(format t "Invalid index (~D)." index))
(t
(push *inspected-object* *inspected-object-stack*)
(setf *inspected-object* (cdr (elt parts index)))
(setf * *inspected-object*)
(display-current)))))))))