[4898ef]: contrib / sb-aclrepl / inspect.lisp Maximize Restore History

Download this file

inspect.lisp    898 lines (776 with data), 33.5 kB

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
;;;; Inspector for sb-aclrepl
;;;;
;;;; The documentation, which may or may not apply in its entirety at
;;;; any given time, for this functionality is on the ACL website:
;;;; <http://www.franz.com/support/documentation/6.2/doc/inspector.htm>.
;;;;
;;;; A summary of inspector navigation is contained in the below *INSPECT-HELP*
;;;; variable.
(cl:in-package #:sb-aclrepl)
(eval-when (:compile-toplevel :load-toplevel :execute)
(defconstant +default-inspect-length+ 20))
(defstruct (%inspect (:constructor make-inspect)
(:conc-name inspect-))
;; stack of parents of inspected object
object-stack
;; a stack of indices of parent object components
select-stack)
;; FIXME - raw mode isn't currently used in object display
(defparameter *current-inspect* nil
"current inspect")
(defparameter *inspect-raw* nil
"Raw mode for object display.")
(defparameter *inspect-length* +default-inspect-length+
"maximum number of components to print")
(defparameter *skip-address-display* nil
"Skip displaying addresses of objects.")
(defvar *inspect-help*
":istep takes between 0 to 3 arguments.
The commands are:
:i redisplay current object
:i = redisplay current object
:i nil redisplay current object
:i ? display this help
:i * inspect the current * value
:i + <form> inspect the (eval form)
:i slot <name> inspect component of object, even if name is an istep cmd
:i <index> inspect the numbered component of object
:i <name> inspect the named component of object
:i <form> evaluation and inspect form
:i - inspect parent
:i ^ inspect parent
:i < inspect previous parent component
:i > inspect next parent component
:i set <index> <form> set indexed component to evalated form
:i print <max> set the maximum number of components to print
:i skip <n> skip a number of components when printing
:i tree print inspect stack
")
;;; When *INSPECT-UNBOUND-OBJECT-MARKER* occurs in a parts list, it
;;; indicates that that a slot is unbound.
(eval-when (:compile-toplevel :load-toplevel :execute)
(defvar *inspect-unbound-object-marker* (gensym "INSPECT-UNBOUND-OBJECT-")))
(defun inspector-fun (object input-stream output-stream)
(let ((*current-inspect* nil)
(*inspect-raw* nil)
(*inspect-length* *inspect-length*)
(*skip-address-display* nil))
(setq *current-inspect* (make-inspect))
(reset-stack object "(inspect ...)")
(redisplay output-stream)
(let ((*input* input-stream)
(*output* output-stream))
(repl :inspect t)))
(values))
(setq sb-impl::*inspect-fun* #'inspector-fun)
(defun istep (args stream)
(unless *current-inspect*
(setq *current-inspect* (make-inspect)))
(istep-dispatch args
(first args)
(when (first args) (read-from-string (first args)))
stream))
(defun istep-dispatch (args option-string option stream)
(cond
((or (string= "=" option-string) (zerop (length args)))
(istep-cmd-redisplay stream))
((or (string= "-" option-string) (string= "^" option-string))
(istep-cmd-parent stream))
((string= "*" option-string)
(istep-cmd-inspect-* stream))
((string= "+" option-string)
(istep-cmd-inspect-new-form (read-from-string (second args)) stream))
((or (string= "<" option-string)
(string= ">" option-string))
(istep-cmd-select-parent-component option-string stream))
((string-equal "set" option-string)
(istep-cmd-set (second args) (third args) stream))
((string-equal "raw" option-string)
(istep-cmd-set-raw (second args) stream))
((string-equal "q" option-string)
(istep-cmd-reset))
((string-equal "?" option-string)
(istep-cmd-help stream))
((string-equal "skip" option-string)
(istep-cmd-skip (second args) stream))
((string-equal "tree" option-string)
(istep-cmd-tree stream))
((string-equal "print" option-string)
(istep-cmd-print (second args) stream))
((string-equal "slot" option-string)
(istep-cmd-select-component (read-from-string (second args)) stream))
((or (symbolp option)
(integerp option))
(istep-cmd-select-component option stream))
(t
(istep-cmd-set-stack option stream))))
(defun set-current-inspect (inspect)
(setq *current-inspect* inspect))
(defun reset-stack (&optional object label)
(cond
((null label)
(setf (inspect-object-stack *current-inspect*) nil)
(setf (inspect-select-stack *current-inspect*) nil))
(t
(setf (inspect-object-stack *current-inspect*) (list object))
(setf (inspect-select-stack *current-inspect*) (list label)))))
(defun output-inspect-note (stream note &rest args)
(apply #'format stream note args)
(princ #\Newline stream))
(defun stack ()
(inspect-object-stack *current-inspect*))
(defun redisplay (stream &optional (skip 0))
(display-current stream *inspect-length* skip))
;;;
;;; istep command processing
;;;
(defun istep-cmd-redisplay (stream)
(redisplay stream))
(defun istep-cmd-parent (stream)
(cond
((> (length (inspect-object-stack *current-inspect*)) 1)
(setf (inspect-object-stack *current-inspect*)
(cdr (inspect-object-stack *current-inspect*)))
(setf (inspect-select-stack *current-inspect*)
(cdr (inspect-select-stack *current-inspect*)))
(redisplay stream))
((stack)
(output-inspect-note stream "Object has no parent"))
(t
(no-object-msg stream))))
(defun istep-cmd-inspect-* (stream)
(reset-stack * "(inspect *)")
(redisplay stream))
(defun istep-cmd-inspect-new-form (form stream)
(inspector-fun (eval form) nil stream))
(defun istep-cmd-select-parent-component (option stream)
(if (stack)
(if (eql (length (stack)) 1)
(output-inspect-note stream "Object does not have a parent")
(let ((parent (second (stack)))
(id (car (inspect-select-stack *current-inspect*))))
(multiple-value-bind (position parts)
(find-part-id parent id)
(let ((new-position (if (string= ">" option)
(1+ position)
(1- position))))
(if (< -1 new-position (parts-count parts))
(let* ((value (component-at parts new-position)))
(setf (car (inspect-object-stack *current-inspect*))
value)
(setf (car (inspect-select-stack *current-inspect*))
(id-at parts new-position))
(redisplay stream))
(output-inspect-note stream
"Parent has no selectable component indexed by ~d"
new-position))))))
(no-object-msg stream)))
(defun istep-cmd-set-raw (option-string stream)
(when (inspect-object-stack *current-inspect*)
(cond
((null option-string)
(setq *inspect-raw* t))
((eq (read-from-string option-string) t)
(setq *inspect-raw* t))
((eq (read-from-string option-string) nil)
(setq *inspect-raw* nil)))
(redisplay stream)))
(defun istep-cmd-reset ()
(reset-stack)
(throw 'repl-catcher (values :inspect nil)))
(defun istep-cmd-help (stream)
(format stream *inspect-help*))
(defun istep-cmd-skip (option-string stream)
(if option-string
(let ((len (read-from-string option-string)))
(if (and (integerp len) (>= len 0))
(redisplay stream len)
(output-inspect-note stream "Skip length invalid")))
(output-inspect-note stream "Skip length missing")))
(defun istep-cmd-print (option-string stream)
(if option-string
(let ((len (read-from-string option-string)))
(if (and (integerp len) (plusp len))
(setq *inspect-length* len)
(output-inspect-note stream "Cannot set print limit to ~A~%" len)))
(output-inspect-note stream "Print length missing")))
(defun select-description (select)
(typecase select
(integer
(format nil "which is componenent number ~d of" select))
(symbol
(format nil "which is the ~a component of" select))
(string
(format nil "which was selected by ~A" select))
(t
(write-to-string select))))
(defun istep-cmd-tree (stream)
(let ((stack (inspect-object-stack *current-inspect*)))
(if stack
(progn
(output-inspect-note stream "The current object is:")
(dotimes (i (length stack))
(output-inspect-note
stream "~A, ~A"
(inspected-description (nth i stack))
(select-description
(nth i (inspect-select-stack *current-inspect*))))))
(no-object-msg stream))))
(defun istep-cmd-set (id-string value-string stream)
(if (stack)
(let ((id (when id-string (read-from-string id-string))))
(multiple-value-bind (position parts)
(find-part-id (car (stack)) id)
(if parts
(if position
(when value-string
(let ((new-value (eval (read-from-string value-string))))
(let ((result (set-component-value (car (stack))
id
new-value
(component-at
parts position))))
(typecase result
(string
(output-inspect-note stream result))
(t
(redisplay stream))))))
(output-inspect-note
stream
"Object has no selectable component named by ~A" id))
(output-inspect-note stream
"Object has no selectable components"))))
(no-object-msg stream)))
(defun istep-cmd-select-component (id stream)
(if (stack)
(multiple-value-bind (position parts)
(find-part-id (car (stack)) id)
(cond
((integerp position)
(let* ((value (component-at parts position)))
(cond ((eq value *inspect-unbound-object-marker*)
(output-inspect-note stream "That slot is unbound"))
(t
(push value (inspect-object-stack *current-inspect*))
(push id (inspect-select-stack *current-inspect*))
(redisplay stream)))))
((null parts)
(output-inspect-note stream "Object does not contain any subobjects"))
(t
(typecase id
(symbol
(output-inspect-note
stream "Object has no selectable component named ~A"
id))
(integer
(output-inspect-note
stream "Object has no selectable component indexed by ~d"
id))))))
(no-object-msg stream)))
(defun istep-cmd-set-stack (form stream)
(reset-stack (eval form) ":i ...")
(redisplay stream))
(defun no-object-msg (s)
(output-inspect-note s "No object is being inspected"))
(defun display-current (s length skip)
(if (stack)
(let ((inspected (car (stack))))
(setq cl:* inspected)
(display-inspect inspected s length skip))
(no-object-msg s)))
;;;
;;; aclrepl-specific inspection display
;;;
(defun display-inspect (object stream &optional length (skip 0))
(multiple-value-bind (elements labels count)
(inspected-elements object length skip)
(fresh-line stream)
(format stream "~A" (inspected-description object))
(unless (or *skip-address-display*
(eq object *inspect-unbound-object-marker*)
(characterp object) (typep object 'fixnum))
(write-string " at #x" stream)
(format stream (n-word-bits-hex-format)
(logand (sb-kernel:get-lisp-obj-address object)
(lognot sb-vm:lowtag-mask))))
(dotimes (i count)
(fresh-line stream)
(display-labeled-element (elt elements i) (elt labels i) stream))))
(defun array-label-p (label)
(and (consp label)
(stringp (cdr label))
(char= (char (cdr label) 0) #\[)))
(defun named-or-array-label-p (label)
(and (consp label) (not (hex-label-p label))))
(defun hex-label-p (label &optional width)
(and (consp label)
(case width
(32 (eq (cdr label) :hex32))
(64 (eq (cdr label) :hex64))
(t (or (eq (cdr label) :hex32)
(eq (cdr label) :hex64))))))
(defun display-labeled-element (element label stream)
(cond
((eq label :ellipses)
(format stream " ..."))
((eq label :tail)
(format stream "tail-> ~A" (inspected-description element)))
((named-or-array-label-p label)
(format stream
(if (array-label-p label)
"~4,' D ~A-> ~A"
"~4,' D ~16,1,1,'-A> ~A")
(car label)
(format nil "~A " (cdr label))
(inspected-description element)))
((hex-label-p label 32)
(format stream "~4,' D-> #x~8,'0X" (car label) element))
((hex-label-p label 64)
(format stream "~4,' D-> #x~16,'0X" (car label) element))
(t
(format stream "~4,' D-> ~A" label (inspected-description element)))))
;;; THE BEGINNINGS OF AN INSPECTOR API
;;; which can be used to retrieve object descriptions as component values/labels and also
;;; process print length and skip selectors
;;;
;;; FUNCTIONS TO CONSIDER FOR EXPORT
;;; FIND-PART-ID
;;; COMPONENT-AT
;;; ID-AT
;;; INSPECTED-ELEMENTS
;;; INSPECTED-DESCRIPTION
;;;
;;; will also need hooks
;;; *inspect-start-inspection*
;;; (maybe. Would setup a window for a GUI inspector)
;;; *inspect-prompt-fun*
;;; *inspect-read-cmd*
;;;
;;; and, either an *inspect-process-cmd*, or *inspect-display* hook
;;; That'll depend if choose to have standardized inspector commands such that
;;; (funcall *inspect-read-cmd*) will return a standard command that SBCL will
;;; process and then call the *inspect-display* hook, or if the
;;; *inspect-read-cmd* will return an impl-dependent cmd that sbcl will
;;; send to the contributed inspector for processing and display.
(defun find-part-id (object id)
"COMPONENT-ID can be an integer or a name of a id.
Returns (VALUES POSITION PARTS).
POSITION is NIL if the id is invalid or not found."
(let* ((parts (inspected-parts object))
(name (if (symbolp id) (symbol-name id) id)))
(values
(cond
((and (numberp id)
(< -1 id (parts-count parts))
(not (eq (parts-seq-type parts) :bignum)))
id)
(t
(case (parts-seq-type parts)
(:named
(position name (the list (parts-components parts))
:key #'car :test #'string-equal))
((:dotted-list :cyclic-list)
(when (string-equal name "tail")
(1- (parts-count parts)))))))
parts)))
(defun component-at (parts position)
(let ((count (parts-count parts))
(components (parts-components parts)))
(when (< -1 position count)
(case (parts-seq-type parts)
(:dotted-list
(if (= position (1- count))
(cdr (last components))
(elt components position)))
(:cyclic-list
(if (= position (1- count))
components
(elt components position)))
(:named
(cdr (elt components position)))
(:array
(aref (the array components) position))
(:bignum
(bignum-component-at components position))
(t
(elt components position))))))
(defun id-at (parts position)
(let ((count (parts-count parts)))
(when (< -1 position count)
(case (parts-seq-type parts)
((:dotted-list :cyclic-list)
(if (= position (1- count))
:tail
position))
(:array
(array-index-string position parts))
(:named
(car (elt (parts-components parts) position)))
(t
position)))))
(defun inspected-elements (object &optional length (skip 0))
"Returns elements of an object that have been trimmed and labeled based on
length and skip. Returns (VALUES ELEMENTS LABELS ELEMENT-COUNT)
where ELEMENTS and LABELS are vectors containing ELEMENT-COUNT items.
LABELS elements may be a string, number, cons pair, :tail, or :ellipses.
This function may return an ELEMENT-COUNT of up to (+ 3 length) which would
include an :ellipses at the beginning, :ellipses at the end,
and the last element."
(let* ((parts (inspected-parts object))
(print-length (if length length (parts-count parts)))
(last-part (last-part parts))
(last-requested (last-requested parts print-length skip))
(element-count (compute-elements-count parts print-length skip))
(first-to (if (first-element-ellipses-p parts skip) 1 0))
(elements (when (plusp element-count) (make-array element-count)))
(labels (when (plusp element-count) (make-array element-count))))
(when (plusp element-count)
;; possible first ellipses
(when (first-element-ellipses-p parts skip)
(set-element-values elements labels 0 nil :ellipses))
;; main elements
(do* ((i 0 (1+ i)))
((> i (- last-requested skip)))
(set-element elements labels parts (+ i first-to) (+ i skip)))
;; last parts value if needed
(when (< last-requested last-part)
(set-element elements labels parts (- element-count 1) last-part))
;; ending ellipses or next to last parts value if needed
(when (< last-requested (1- last-part))
(if (= last-requested (- last-part 2))
(set-element elements labels parts (- element-count 2) (1- last-part))
(set-element-values elements labels (- element-count 2) nil :ellipses))))
(values elements labels element-count)))
(defun last-requested (parts print skip)
(min (1- (parts-count parts)) (+ skip print -1)))
(defun last-part (parts)
(1- (parts-count parts)))
(defun compute-elements-count (parts length skip)
"Compute the number of elements in parts given the print length and skip."
(let ((element-count (min (parts-count parts) length
(max 0 (- (parts-count parts) skip)))))
(when (and (plusp (parts-count parts)) (plusp skip)) ; starting ellipses
(incf element-count))
(when (< (last-requested parts length skip)
(last-part parts)) ; last value
(incf element-count)
(when (< (last-requested parts length skip)
(1- (last-part parts))) ; ending ellipses
(incf element-count)))
element-count))
(defun set-element (elements labels parts to-index from-index)
(set-element-values elements labels to-index (component-at parts from-index)
(label-at parts from-index)))
(defun set-element-values (elements labels index element label)
(setf (aref elements index) element)
(setf (aref labels index) label))
(defun first-element-ellipses-p (parts skip)
(and (parts-count parts) (plusp skip)))
(defun label-at (parts position)
"Helper function for inspected-elements. Conses the
position with the label if the label is a string."
(let ((id (id-at parts position)))
(cond
((stringp id)
(cons position id))
((eq (parts-seq-type parts) :bignum)
(cons position (case sb-vm::n-word-bits
(32 :hex32)
(64 :hex64))))
(t
id))))
(defun array-index-string (index parts)
"Formats an array index in row major format."
(let ((rev-dimensions (parts-seq-hint parts)))
(if (null rev-dimensions)
"[]"
(let ((list nil))
(dolist (dim rev-dimensions)
(multiple-value-bind (q r) (floor index dim)
(setq index q)
(push r list)))
(format nil "[~W~{,~W~}]" (car list) (cdr list))))))
;;; INSPECTED-DESCRIPTION
;;;
;;; Accepts an object and returns
;;; DESCRIPTION is a summary description of the destructured object,
;;; e.g. "the object is a CONS".
(defgeneric inspected-description (object))
(defmethod inspected-description ((object symbol))
(format nil "the symbol ~A" object))
(defmethod inspected-description ((object structure-object))
(format nil "~W" (find-class (type-of object))))
(defmethod inspected-description ((object package))
(format nil "the ~A package" (package-name object)))
(defmethod inspected-description ((object standard-object))
(format nil "~W" (class-of object)))
(defmethod inspected-description ((object sb-kernel:funcallable-instance))
(format nil "a funcallable-instance of type ~S" (type-of object)))
(defmethod inspected-description ((object function))
(format nil "~S" object) nil)
(defmethod inspected-description ((object vector))
(declare (vector object))
(format nil "a ~:[~;displaced ~]vector (~W)"
(and (sb-kernel:array-header-p object)
(sb-kernel:%array-displaced-p object))
(length object)))
(defmethod inspected-description ((object simple-vector))
(declare (simple-vector object))
(format nil "a simple ~A vector (~D)"
(array-element-type object)
(length object)))
(defmethod inspected-description ((object array))
(declare (array object))
(format nil "~:[A displaced~;An~] array of ~A with dimensions ~W"
(and (sb-kernel:array-header-p object)
(sb-kernel:%array-displaced-p object))
(array-element-type object)
(array-dimensions object)))
(defun simple-cons-pair-p (object)
(atom (cdr object)))
(defmethod inspected-description ((object cons))
(if (simple-cons-pair-p object)
"a cons cell"
(inspected-description-of-nontrivial-list object)))
(defun cons-safe-length (object)
"Returns (VALUES LENGTH LIST-TYPE) where length is the number of
cons cells and LIST-TYPE is :normal, :dotted, or :cyclic"
(do ((length 1 (1+ length))
(lst (cdr object) (cdr lst)))
((or (not (consp lst))
(eq object lst))
(cond
((null lst)
(values length :normal))
((atom lst)
(values length :dotted))
((eq object lst)
(values length :cyclic))))
;; nothing to do in body
))
(defun inspected-description-of-nontrivial-list (object)
(multiple-value-bind (length list-type) (cons-safe-length object)
(format nil "a ~A list with ~D element~:*~P~A"
(string-downcase (symbol-name list-type)) length
(ecase list-type
((:dotted :cyclic) "+tail")
(:normal "")))))
(defun n-word-bits-hex-format ()
(case sb-vm::n-word-bits
(64 "~16,'0X")
(32 "~8,'0X")
(t "~X")))
(defun ref32-hexstr (obj &optional (offset 0))
(format nil "~8,'0X" (ref32 obj offset)))
(defun ref32 (obj &optional (offset 0))
(sb-sys::without-gcing
(sb-sys:sap-ref-32
(sb-sys:int-sap
(logand (sb-kernel:get-lisp-obj-address obj) (lognot sb-vm:lowtag-mask)))
offset)))
(defun description-maybe-internals (fmt objects internal-fmt &rest args)
(let ((base (apply #'format nil fmt objects)))
(if *skip-address-display*
base
(concatenate 'string
base " " (apply #'format nil internal-fmt args)))))
(defmethod inspected-description ((object double-float))
(let ((start (round (* 2 sb-vm::n-word-bits) 8)))
(description-maybe-internals "double-float ~W" (list object)
"[#~A ~A]"
(ref32-hexstr object (+ start 4))
(ref32-hexstr object start))))
(defmethod inspected-description ((object single-float))
(description-maybe-internals "single-float ~W" (list object)
"[#x~A]"
(ref32-hexstr object (round sb-vm::n-word-bits 8))))
(defmethod inspected-description ((object fixnum))
(description-maybe-internals
"fixnum ~W" (list object)
(concatenate 'string "[#x" (n-word-bits-hex-format) "]")
(ash object (1- sb-vm:n-lowtag-bits))))
(defmethod inspected-description ((object complex))
(format nil "complex number ~W" object))
(defmethod inspected-description ((object simple-string))
(format nil "a simple-string (~W) ~W" (length object) object))
(defun bignum-words (bignum)
"Return the number of words in a bignum"
(ash
(logand (ref32 bignum) (lognot sb-vm:widetag-mask))
(- sb-vm:n-widetag-bits)))
(defun bignum-component-at (bignum offset)
"Return the word at offset"
(case sb-vm::n-word-bits
(32
(ref32 bignum (* 4 (1+ offset))))
(64
(let ((start (* 8 (1+ offset))))
(+ (ref32 bignum start)
(ash (ref32 bignum (+ 4 start)) 32))))))
(defmethod inspected-description ((object bignum))
(format nil "bignum ~W with ~D ~A-bit word~P" object
(bignum-words object) sb-vm::n-word-bits (bignum-words object)))
(defmethod inspected-description ((object ratio))
(format nil "ratio ~W" object))
(defmethod inspected-description ((object character))
;; FIXME: This will need to change as and when we get more characters
;; than just the 256 we have today.
(description-maybe-internals
"character ~W char-code #x~2,'0X"
(list object (char-code object))
"[#x~8,'0X]"
(logior sb-vm:character-widetag (ash (char-code object)
sb-vm:n-widetag-bits))))
(defmethod inspected-description ((object t))
(format nil "a generic object ~W" object))
(defmethod inspected-description ((object (eql *inspect-unbound-object-marker*)))
"..unbound..")
;;; INSPECTED-PARTS
;;;
;;; Accepts the arguments OBJECT LENGTH SKIP and returns,
;;; (LIST COMPONENTS SEQ-TYPE COUNT SEQ-HINT)
;;; where..
;;;
;;; COMPONENTS are the component parts of OBJECT (whose
;;; representation is determined by SEQ-TYPE). Except for the
;;; SEQ-TYPE :named and :array, components is just the OBJECT itself
;;;
;;; SEQ-TYPE determines what representation is used for components
;;; of COMPONENTS.
;;; If SEQ-TYPE is :named, then each element is (CONS NAME VALUE)
;;; If SEQ-TYPE is :dotted-list, then each element is just value,
;;; but the last element must be retrieved by
;;; (cdr (last components))
;;; If SEQ-TYPE is :cylic-list, then each element is just value,
;;; If SEQ-TYPE is :list, then each element is a value of an array
;;; If SEQ-TYPE is :vector, then each element is a value of an vector
;;; If SEQ-TYPE is :array, then each element is a value of an array
;;; with rank >= 2. The
;;; If SEQ-TYPE is :bignum, then object is just a bignum and not a
;;; a sequence
;;;
;;; COUNT is the total number of components in the OBJECT
;;;
;;; SEQ-HINT is a seq-type dependent hint. Used by SEQ-TYPE :array
;;; to hold the reverse-dimensions of the orignal array.
(declaim (inline parts-components))
(defun parts-components (parts)
(first parts))
(declaim (inline parts-count))
(defun parts-count (parts)
(second parts))
(declaim (inline parts-seq-type))
(defun parts-seq-type (parts)
(third parts))
(declaim (inline parts-seq-hint))
(defun parts-seq-hint (parts)
(fourth parts))
;;; FIXME: Most of this should be refactored to share the code
;;; with the vanilla inspector. Also, we should check what the
;;; Slime inspector does, and provide a an interface for it to
;;; use that would propagate any SBCL inspector improvements
;;; automagically to Slime. -- ns 2005-02-20
(defgeneric inspected-parts (object))
(defmethod inspected-parts ((object symbol))
(let ((components
(list (cons "NAME" (symbol-name object))
(cons "PACKAGE" (symbol-package object))
(cons "VALUE" (if (boundp object)
(symbol-value object)
*inspect-unbound-object-marker*))
(cons "FUNCTION" (if (fboundp object)
(symbol-function object)
*inspect-unbound-object-marker*))
(cons "PLIST" (symbol-plist object)))))
(list components (length components) :named nil)))
(defun inspected-structure-parts (object)
(let ((components-list '())
(info (sb-kernel:layout-info (sb-kernel:layout-of object))))
(when (sb-kernel::defstruct-description-p info)
(dolist (dd-slot (sb-kernel:dd-slots info) (nreverse components-list))
(push (cons (string (sb-kernel:dsd-name dd-slot))
(funcall (sb-kernel:dsd-accessor-name dd-slot) object))
components-list)))))
(defmethod inspected-parts ((object structure-object))
(let ((components (inspected-structure-parts object)))
(list components (length components) :named nil)))
(defun inspected-standard-object-parts (object)
(let ((components nil)
(class-slots (sb-pcl::class-slots (class-of object))))
(dolist (class-slot class-slots (nreverse components))
(let* ((slot-name (slot-value class-slot 'sb-pcl::name))
(slot-value (if (slot-boundp object slot-name)
(slot-value object slot-name)
*inspect-unbound-object-marker*)))
(push (cons (symbol-name slot-name) slot-value) components)))))
(defmethod inspected-parts ((object standard-object))
(let ((components (inspected-standard-object-parts object)))
(list components (length components) :named nil)))
(defmethod inspected-parts ((object sb-kernel:funcallable-instance))
(let ((components (inspected-standard-object-parts object)))
(list components (length components) :named nil)))
(defmethod inspected-parts ((object condition))
(let ((components (inspected-standard-object-parts object)))
(list components (length components) :named nil)))
(defmethod inspected-parts ((object function))
(let* ((type (sb-kernel:widetag-of object))
(object (if (= type sb-vm:closure-header-widetag)
(sb-kernel:%closure-fun object)
object))
(components (list (cons "arglist"
(sb-kernel:%simple-fun-arglist object)))))
(list components (length components) :named nil)))
(defmethod inspected-parts ((object vector))
(list object (length object) :vector nil))
(defmethod inspected-parts ((object array))
(let ((size (array-total-size object)))
(list (make-array size
:element-type (array-element-type object)
:displaced-to object)
size
:array
(reverse (array-dimensions object)))))
(defmethod inspected-parts ((object cons))
(if (simple-cons-pair-p object)
(inspected-parts-of-simple-cons object)
(inspected-parts-of-nontrivial-list object)))
(defun inspected-parts-of-simple-cons (object)
(let ((components (list (cons "car" (car object))
(cons "cdr" (cdr object)))))
(list components 2 :named nil)))
(defun inspected-parts-of-nontrivial-list (object)
(multiple-value-bind (count list-type) (cons-safe-length object)
(case list-type
(:normal
(list object count :list nil))
(:cyclic
(list object (1+ count) :cyclic-list nil))
(:dotted
;; count tail element
(list object (1+ count) :dotted-list nil)))))
(defmethod inspected-parts ((object complex))
(let ((components (list (cons "real" (realpart object))
(cons "imag" (imagpart object)))))
(list components (length components) :named nil)))
(defmethod inspected-parts ((object ratio))
(let ((components (list (cons "numerator" (numerator object))
(cons "denominator" (denominator object)))))
(list components (length components) :named nil)))
(defmethod inspected-parts ((object bignum))
(list object (bignum-words object) :bignum nil))
(defmethod inspected-parts ((object t))
(list nil 0 nil nil))
;; FIXME - implement setting of component values
(defgeneric set-component-value (object component-id value element))
(defmethod set-component-value ((object cons) id value element)
(format nil "Cons object does not support setting of component ~A" id))
(defmethod set-component-value ((object array) id value element)
(format nil "Array object does not support setting of component ~A" id))
(defmethod set-component-value ((object symbol) id value element)
(format nil "Symbol object does not support setting of component ~A" id))
(defmethod set-component-value ((object structure-object) id value element)
(format nil "Structure object does not support setting of component ~A" id))
(defmethod set-component-value ((object standard-object) id value element)
(format nil "Standard object does not support setting of component ~A" id))
(defmethod set-component-value ((object t) id value element)
(format nil "Object does not support setting of component ~A" id))