source: trunk/ccl/level-1/l1-readloop-lds.lisp @ 7808

Last change on this file since 7808 was 7808, checked in by gb, 14 years ago

Use *LISTENER-PROMPT-FORMAT*.in PRINT-LISTENER-PROMPT.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 22.2 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 1994-2001 Digitool, Inc
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17; l1-readloop-lds.lisp
18
19(in-package "CCL")
20
21
22
23(defun toplevel-loop ()
24  (loop
25    (if (eq (catch :toplevel 
26              (read-loop :break-level 0 )) $xstkover)
27      (format t "~&;[Stacks reset due to overflow.]")
28      (when (eq *current-process* *initial-process*)
29        (toplevel)))))
30
31
32(defvar *defined-toplevel-commands* ())
33(defvar *active-toplevel-commands* ())
34
35(defun %define-toplevel-command (group-name key name fn doc args)
36  (let* ((group (or (assoc group-name *defined-toplevel-commands*)
37                    (car (push (list group-name)
38                               *defined-toplevel-commands*))))
39         (pair (assoc key (cdr group) :test #'eq)))
40    (if pair
41      (rplacd pair (list* fn doc args))
42      (push (cons key (list* fn doc args)) (cdr group))))
43  name)
44
45(define-toplevel-command 
46    :global y (&optional p) "Yield control of terminal-input to process
47whose name or ID matches <p>, or to any process if <p> is null"
48    (%%yield-terminal-to (if p (find-process p))))      ;may be nil
49
50
51(define-toplevel-command
52    :global kill (p) "Kill process whose name or ID matches <p>"
53    (let* ((proc (find-process p)))
54      (if proc
55        (process-kill proc))))
56
57(define-toplevel-command 
58    :global proc (&optional p) "Show information about specified process <p>/all processes"
59    (flet ((show-process-info (proc)
60             (format t "~&~d : ~a ~a ~20t[~a] "
61                     (process-serial-number proc)
62                     (if (eq proc *current-process*)
63                       "->"
64                       "  ")
65                     (process-name proc)
66                     (process-whostate proc))
67             (let* ((suspend-count (process-suspend-count proc)))
68               (if (and suspend-count (not (eql 0 suspend-count)))
69                 (format t " (Suspended)")))
70             (let* ((terminal-input-shared-resource
71                     (if (typep *terminal-io* 'two-way-stream)
72                       (input-stream-shared-resource
73                        (two-way-stream-input-stream *terminal-io*)))))
74               (if (and terminal-input-shared-resource
75                        (%shared-resource-requestor-p
76                         terminal-input-shared-resource proc))
77                 (format t " (Requesting terminal input)")))
78             (fresh-line)))
79      (if p
80        (let* ((proc (find-process p)))
81          (if (null proc)
82            (format t "~&;; not found - ~s" p)
83            (show-process-info proc)))
84        (dolist (proc (all-processes) (values))
85          (show-process-info proc)))))
86
87(define-toplevel-command :global cd (dir) "Change to directory DIR" (setf (current-directory) dir) (toplevel-print (list (current-directory))))
88
89(define-toplevel-command :global pwd () "Print the pathame of the current directory" (toplevel-print (list (current-directory))))
90
91
92
93(define-toplevel-command :break pop () "exit current break loop" (abort-break))
94(define-toplevel-command :break go () "continue" (continue))
95(define-toplevel-command :break q () "return to toplevel" (toplevel))
96(define-toplevel-command :break r () "list restarts"
97  (format t "~&   (:C <n>) can be used to invoke one of the following restarts in this break loop:")
98  (let* ((r (apply #'vector (compute-restarts *break-condition*))))
99    (dotimes (i (length r) (terpri))
100      (format *debug-io* "~&~d. ~a" i (svref r i)))))
101
102;;; From Marco Baringer 2003/03/18
103
104(define-toplevel-command :break set (n frame value) "Set <n>th item of frame <frame> to <value>"
105  (let* ((frame-sp (nth-raw-frame frame *break-frame* nil)))
106    (if frame-sp
107        (toplevel-print (list (set-nth-value-in-frame frame-sp n nil value)))
108        (format *debug-io* "No frame with number ~D~%" frame))))
109
110(define-toplevel-command :break nframes ()
111                         "print the number of stack frames accessible from this break loop"
112                         (do* ((p *break-frame* (parent-frame p nil))
113                               (i 0 (1+ i))
114                               (last (last-frame-ptr)))
115                              ((eql p last) (toplevel-print (list i)))))
116
117(define-toplevel-command :global ? () "help"
118  (dolist (g *active-toplevel-commands*)
119    (dolist (c (cdr g))
120      (let* ((command (car c))
121             (doc (caddr c))
122             (args (cdddr c)))
123        (if args
124          (format t "~& (~S~{ ~A~}) ~8T~A" command args doc)
125          (format t "~& ~S  ~8T~A" command doc))))))
126
127
128(define-toplevel-command :break b (&key start count show-frame-contents) "backtrace"
129  (when *break-frame*
130      (print-call-history :detailed-p show-frame-contents
131                          :origin *break-frame*
132                          :count count
133                          :start-frame-number (or start 0))))
134
135(define-toplevel-command :break c (n) "Choose restart <n>"
136   (select-restart n))
137
138(define-toplevel-command :break f (n) "Show backtrace frame <n>"
139   (print-call-history :origin *break-frame*
140                       :start-frame-number n
141                       :count 1
142                       :detailed-p t))
143
144(define-toplevel-command :break raw (n) "Show raw contents of backtrace frame <n>"
145   (print-call-history :origin *break-frame*
146                       :start-frame-number n
147                       :count 1
148                       :detailed-p :raw))
149
150(define-toplevel-command :break v (n frame-number) "Return value <n> in frame <frame-number>"
151  (let* ((frame-sp (nth-raw-frame frame-number *break-frame* nil)))
152    (if frame-sp
153      (toplevel-print (list (nth-value-in-frame frame-sp n nil))))))
154
155(define-toplevel-command :break form (frame-number)
156   "Return a form which looks like the call which established the stack frame identified by <frame-number>.  This is only well-defined in certain cases: when the function is globally named and not a lexical closure and when it was compiled with *SAVE-LOCAL-SYMBOLS* in effect."
157   (let* ((form (dbg-form frame-number)))
158     (when form
159       (let* ((*print-level* *backtrace-print-level*)
160              (*print-length* *backtrace-print-length*))
161         (toplevel-print (list form))))))
162
163;;; Ordinarily, form follows function.
164(define-toplevel-command :break function (frame-number)
165  "Returns the function invoked in backtrace frame <frame-number>.  This may be useful for, e.g., disassembly"
166  (let* ((cfp (nth-raw-frame frame-number *break-frame* nil)))
167    (when (and cfp (not (catch-csp-p cfp nil)))
168      (let* ((function (cfp-lfun cfp)))
169        (when function
170          (toplevel-print (list function)))))))
171 
172
173
174         
175
176 
177
178(defun %use-toplevel-commands (group-name)
179  ;; Push the whole group
180  (pushnew (assoc group-name *defined-toplevel-commands*)
181           *active-toplevel-commands*
182           :key #'(lambda (x) (car x))))  ; #'car not defined yet ...
183
184(%use-toplevel-commands :global)
185
186(defun check-toplevel-command (form)
187  (let* ((cmd (if (consp form) (car form) form))
188         (args (if (consp form) (cdr form))))
189    (if (keywordp cmd)
190      (dolist (g *active-toplevel-commands*)
191        (when
192            (let* ((pair (assoc cmd (cdr g))))
193              (if pair 
194                (progn (apply (cadr pair) args)
195                       t)))
196          (return t))))))
197
198(defparameter *quit-on-eof* nil)
199
200;;; This is the part common to toplevel loop and inner break loops.
201(defun read-loop (&key (input-stream *standard-input*)
202                       (output-stream *standard-output*)
203                       (break-level *break-level*)
204                       (prompt-function #'(lambda (stream) (print-listener-prompt stream t))))
205  (let* ((*break-level* break-level)
206         (*last-break-level* break-level)
207         *loading-file-source-file*
208         *in-read-loop*
209         *** ** * +++ ++ + /// // / -
210         (eof-value (cons nil nil)))
211    (declare (dynamic-extent eof-value))
212    (loop
213      (restart-case
214       (catch :abort                    ;last resort...
215         (loop
216           (catch-cancel
217            (loop               
218              (setq *in-read-loop* nil
219                    *break-level* break-level)
220              (multiple-value-bind (form path print-result)
221                  (toplevel-read :input-stream input-stream
222                                 :output-stream output-stream
223                                 :prompt-function prompt-function
224                                 :eof-value eof-value)
225                (if (eq form eof-value)
226                  (if (and (not *batch-flag*)
227                           (not *quit-on-eof*)
228                           (eof-transient-p (stream-device input-stream :input)))
229                    (progn
230                      (stream-clear-input input-stream)
231                      (abort-break))
232                    (exit-interactive-process *current-process*))
233                    (or (check-toplevel-command form)
234                        (let* ((values (toplevel-eval form path)))
235                          (if print-result (toplevel-print values))))))))
236           (format *terminal-io* "~&Cancelled")))
237       (abort () :report (lambda (stream)
238                           (if (eq break-level 0)
239                             (format stream "Return to toplevel.")
240                             (format stream "Return to break level ~D." break-level)))
241              #|                        ; Handled by interactive-abort
242                                        ; go up one more if abort occurred while awaiting/reading input               
243              (when (and *in-read-loop* (neq break-level 0))
244              (abort))
245              |#
246               )
247        (abort-break () 
248                     (unless (eq break-level 0)
249                       (abort))))
250       (clear-input input-stream)
251      (format output-stream "~%"))))
252
253;;; The first non-whitespace character available on INPUT-STREAM is a colon.
254;;; Try to interpret the line as a colon command (or possibly just a keyword.)
255(defun read-command-or-keyword (input-stream eof-value)
256  (let* ((line (read-line input-stream nil eof-value)))
257    (if (eq line eof-value)
258      eof-value
259      (let* ((in (make-string-input-stream line))
260             (keyword (read in nil eof-value)))
261        (if (eq keyword eof-value)
262          eof-value
263          (if (not (keywordp keyword))
264            keyword
265            (collect ((params))
266              (loop
267                (let* ((param (read in nil eof-value)))
268                  (if (eq param eof-value)
269                    (return
270                      (let* ((params (params)))
271                        (if params
272                          (cons keyword params)
273                          keyword)))
274                    (params param)))))))))))
275
276;;; Read a form from the specified stream.
277(defun toplevel-read (&key (input-stream *standard-input*)
278                           (output-stream *standard-output*)
279                           (prompt-function #'print-listener-prompt)
280                           (eof-value *eof-value*))
281  (force-output output-stream)
282  (funcall prompt-function output-stream)
283  (read-toplevel-form input-stream eof-value))
284
285(defvar *always-eval-user-defvars* nil)
286
287(defun process-single-selection (form)
288  (if (and *always-eval-user-defvars*
289           (listp form) (eq (car form) 'defvar) (cddr form))
290    `(defparameter ,@(cdr form))
291    form))
292
293(defun toplevel-eval (form &optional *loading-file-source-file*)
294  (setq +++ ++ ++ + + - - form)
295  (let* ((package *package*)
296         (values (multiple-value-list (cheap-eval-in-environment form nil))))
297    (unless (eq package *package*)
298      (application-ui-operation *application* :note-current-package *package*))
299    values))
300
301(defun toplevel-print (values &optional (out *standard-output*))
302  (setq /// // // / / values)
303  (unless (eq (car values) (%unbound-marker))
304    (setq *** ** ** * *  (%car values)))
305  (when values
306    (fresh-line out)
307    (dolist (val values) (write val :stream out) (terpri out))))
308
309(defparameter *listener-prompt-format* "~[?~:;~:*~d>~] ")
310
311 
312(defun print-listener-prompt (stream &optional (force t))
313  (unless *quiet-flag*
314    (when (or force (neq *break-level* *last-break-level*))
315      (let* ((*listener-indent* nil))
316        (fresh-line stream)
317        (format stream *listener-prompt-format* *break-level*))
318      (setq *last-break-level* *break-level*)))
319    (force-output stream))
320
321
322;;; Fairly crude default error-handlingbehavior, and a fairly crude mechanism
323;;; for customizing it.
324
325(defvar *app-error-handler-mode* :quit
326  "one of :quit, :quit-quietly, :listener might be useful.")
327
328(defmethod application-error ((a application) condition error-pointer)
329  (case *app-error-handler-mode*
330    (:listener   (break-loop-handle-error condition error-pointer))
331    (:quit-quietly (quit -1))
332    (:quit  (format t "~&Fatal error in ~s : ~a"
333                    (pathname-name (car *command-line-argument-list*))
334                    condition)
335                    (quit -1))))
336
337(defun make-application-error-handler (app mode)
338  (declare (ignore app))
339  (setq *app-error-handler-mode* mode))
340
341
342; You may want to do this anyway even if your application
343; does not otherwise wish to be a "lisp-development-system"
344(defmethod application-error ((a lisp-development-system) condition error-pointer)
345  (break-loop-handle-error condition error-pointer))
346
347(defun break-loop-handle-error (condition error-pointer)
348  (multiple-value-bind (bogus-globals newvals oldvals) (%check-error-globals)
349    (dolist (x bogus-globals)
350      (set x (funcall (pop newvals))))
351    (when (and *debugger-hook* *break-on-errors*)
352      (let ((hook *debugger-hook*)
353            (*debugger-hook* nil))
354        (funcall hook condition hook)))
355    (%break-message "Error" condition error-pointer)
356    (with-terminal-input
357      (let* ((s *error-output*))
358        (dolist (bogusness bogus-globals)
359          (let ((oldval (pop oldvals)))
360            (format s "~&;  NOTE: ~S was " bogusness)
361            (if (eq oldval (%unbound-marker-8))
362              (format s "unbound")
363              (format s "~s" oldval))
364            (format s ", was reset to ~s ." (symbol-value bogusness)))))
365      (if *break-on-errors*
366        (break-loop condition error-pointer)
367        (abort)))))
368
369(defun break (&optional string &rest args)
370  "Print a message and invoke the debugger without allowing any possibility
371   of condition handling occurring."
372  (apply #'%break-in-frame (%get-frame-ptr) string args))
373
374(defun %break-in-frame (fp &optional string &rest args)
375  (flet ((do-break-loop ()
376           (let ((c (if (typep string 'condition)
377                      string
378                      (make-condition 'simple-condition
379                                    :format-control (or string "")
380                                    :format-arguments args))))
381             (cbreak-loop "Break" "Return from BREAK." c fp))))
382    (cond ((%i> *interrupt-level* -1)
383           (do-break-loop))
384          (*break-loop-when-uninterruptable*
385           (format *error-output* "Break while interrupt-level less than zero; binding to 0 during break-loop.")
386           (let ((interrupt-level (interrupt-level)))
387             (unwind-protect
388                  (progn
389                    (setf (interrupt-level) 0)
390                    (do-break-loop))
391               (setf (interrupt-level) interrupt-level))))
392          (t (format *error-output* "Break while interrupt-level less than zero; ignored.")))))
393
394
395(defun invoke-debugger (condition &aux (fp (%get-frame-ptr)))
396  "Enter the debugger."
397  (let ((c (require-type condition 'condition)))
398    (when *debugger-hook*
399      (let ((hook *debugger-hook*)
400            (*debugger-hook* nil))
401        (funcall hook c hook)))
402    (%break-message "Debug" c fp)
403    (with-terminal-input
404        (break-loop c fp))))
405
406(defun %break-message (msg condition error-pointer &optional (prefixchar #\>))
407  (let ((*print-circle* *error-print-circle*)
408        ;(*print-prett*y nil)
409        (*print-array* nil)
410        (*print-escape* t)
411        (*print-gensym* t)
412        (*print-length* *backtrace-print-length*)  ; ?
413        (*print-level* *backtrace-print-level*)   ; ?
414        (*print-lines* nil)
415        (*print-miser-width* nil)
416        (*print-readably* nil)
417        (*print-right-margin* nil)
418        (*signal-printing-errors* nil)
419        (s (make-indenting-string-output-stream prefixchar nil)))
420    (format s "~A ~A: " prefixchar msg)
421    (setf (indenting-string-output-stream-indent s) (column s))
422    ;(format s "~A" condition) ; evil if circle
423    (report-condition condition s)
424    (if (not (and (typep condition 'simple-program-error)
425                  (simple-program-error-context condition)))
426      (format *error-output* "~&~A~%~A While executing: ~S"
427              (get-output-stream-string s) prefixchar (%real-err-fn-name error-pointer))
428      (format *error-output* "~&~A"
429              (get-output-stream-string s)))
430    (format *error-output* ", in process ~a(~d).~%" (process-name *current-process*) (process-serial-number *current-process*))
431  (force-output *error-output*)))
432                                        ; returns NIL
433
434(defun cbreak-loop (msg cont-string condition error-pointer)
435  (let* ((*print-readably* nil))
436    (%break-message msg condition error-pointer)
437    (with-terminal-input
438      (restart-case (break-loop condition error-pointer)
439                    (continue () :report (lambda (stream) (write-string cont-string stream))))
440      (fresh-line *error-output*)
441      nil)))
442
443(defun warn (condition-or-format-string &rest args)
444  "Warn about a situation by signalling a condition formed by DATUM and
445   ARGUMENTS. While the condition is being signaled, a MUFFLE-WARNING restart
446   exists that causes WARN to immediately return NIL."
447  (when (typep condition-or-format-string 'condition)
448    (unless (typep condition-or-format-string 'warning)
449      (report-bad-arg condition-or-format-string 'warning))
450    (when args
451      (error 'type-error :datum args :expected-type 'null
452             :format-control "Extra arguments in ~s.")))
453  (let ((fp (%get-frame-ptr))
454        (c (require-type (condition-arg condition-or-format-string args 'simple-warning) 'warning)))
455    (when *break-on-warnings*
456      (cbreak-loop "Warning" "Signal the warning." c fp))
457    (restart-case (signal c)
458      (muffle-warning () :report "Skip the warning" (return-from warn nil)))
459    (%break-message (if (typep c 'compiler-warning) "Compiler warning" "Warning") c fp #\;)
460    ))
461
462(declaim (notinline select-backtrace))
463
464(defmacro new-backtrace-info (dialog youngest oldest tcr condition current fake db-link level)
465  (let* ((cond (gensym)))
466  `(let* ((,cond ,condition))
467    (vector ,dialog ,youngest ,oldest ,tcr (cons nil (compute-restarts ,cond)) (%catch-top ,tcr) ,cond ,current ,fake ,db-link ,level))))
468
469(defun select-backtrace ()
470  (declare (notinline select-backtrace))
471  ;(require 'new-backtrace)
472  (require :inspector)
473  (select-backtrace))
474
475(defvar *break-condition* nil "condition argument to innermost break-loop.")
476(defvar *break-frame* nil "frame-pointer arg to break-loop")
477(defvar *break-loop-when-uninterruptable* t)
478
479(defvar *error-reentry-count* 0)
480
481(defun funcall-with-error-reentry-detection (thunk)
482  (let* ((count *error-reentry-count*)
483         (*error-reentry-count* (1+ count)))
484    (cond ((eql count 0) (funcall thunk))
485          ((eql count 1) (error "Error reporting error"))
486          (t (bug "Error reporting error")))))
487
488
489
490
491(defvar %last-continue% nil)
492(defun break-loop (condition frame-pointer)
493  "Never returns"
494  (let* ((%handlers% (last %handlers%)) ; firewall
495         (*break-frame* frame-pointer)
496         (*break-condition* condition)
497         (*compiling-file* nil)
498         (*backquote-stack* nil)
499         (continue (find-restart 'continue))
500         (*continuablep* (unless (eq %last-continue% continue) continue))
501         (%last-continue% continue)
502         (*standard-input* *debug-io*)
503         (*standard-output* *debug-io*)
504         (*signal-printing-errors* nil)
505         (*read-suppress* nil)
506         (*print-readably* nil))
507    (let* ((context (new-backtrace-info nil
508                                        frame-pointer
509                                        (if *backtrace-contexts*
510                                          (or (child-frame
511                                               (bt.youngest (car *backtrace-contexts*))
512                                               nil)
513                                              (last-frame-ptr))
514                                          (last-frame-ptr))
515                                        (%current-tcr)
516                                        condition
517                                        (%current-frame-ptr)
518                                        #+ppc-target *fake-stack-frames*
519                                        #+x86-target (%current-frame-ptr)
520                                        (db-link)
521                                        (1+ *break-level*)))
522           (*backtrace-contexts* (cons context *backtrace-contexts*)))
523      (with-toplevel-commands :break
524        (if *continuablep*
525          (let* ((*print-circle* *error-print-circle*)
526                 (*print-level* *backtrace-print-level*)
527                 (*print-length* *backtrace-print-length*)
528                                        ;(*print-pretty* nil)
529                 (*print-array* nil))
530            (format t "~&> Type :GO to continue, :POP to abort, :R for a list of available restarts.")
531            (format t "~&> If continued: ~A~%" continue))
532          (format t "~&> Type :POP to abort, :R for a list of available restarts.~%"))
533        (format t "~&> Type :? for other options.")
534        (terpri)
535        (force-output)
536
537        (clear-input *debug-io*)
538        (setq *error-reentry-count* 0)  ; succesfully reported error
539        (ignoring-without-interrupts
540         (unwind-protect
541              (progn
542                (application-ui-operation *application*
543                                          :enter-backtrace-context context)
544                  (read-loop :break-level (1+ *break-level*)
545                             :input-stream *debug-io*
546                             :output-stream *debug-io*))
547           (application-ui-operation *application* :exit-backtrace-context
548                                     context)))))))
549
550
551
552(defun display-restarts (&optional (condition *break-condition*))
553  (let ((i 0))
554    (format t "~&[Pretend that these are buttons.]")
555    (dolist (r (compute-restarts condition) i)
556      (format t "~&~a : ~A" i r)
557      (setq i (%i+ i 1)))
558    (fresh-line nil)))
559
560(defun select-restart (n &optional (condition *break-condition*))
561  (let* ((restarts (compute-restarts condition)))
562    (invoke-restart-interactively
563     (nth (require-type n `(integer 0 (,(length restarts)))) restarts))))
564
565
566
567
568; End of l1-readloop-lds.lisp
Note: See TracBrowser for help on using the repository browser.