source: trunk/source/cocoa-ide/cocoa-listener.lisp @ 14216

Last change on this file since 14216 was 14216, checked in by gb, 10 years ago

Changes to support "background" listener processes (processes where
*TERMINAL-IO* and its synonym streams are bound to lazily-created
hemlock-listener streams, with associated document/window/buffer etc.)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 39.9 KB
Line 
1;;;-*-Mode: LISP; Package: GUI -*-
2;;;
3;;;   Copyright (C) 2007 Clozure Associates
4
5(in-package "GUI")
6
7(def-cocoa-default *listener-input-font* :font #'(lambda ()
8                                                   (#/fontWithName:size:
9                                                    ns:ns-font
10                                                    #+darwin-target
11                                                    #@"Monaco"
12                                                    #-darwin-target
13                                                    #@"Courier New"
14                                                    (font-size-kludge 10.0)))
15                   "Default font for listener input")
16(def-cocoa-default *listener-output-font* :font #'(lambda ()
17                                                    (#/fontWithName:size:
18                                                     ns:ns-font
19                                                     #+darwin-target
20                                                     #@"Monaco"
21                                                     #-darwin-target
22                                                     #@"Courier New"
23                                                     (font-size-kludge 10.0)))
24                   "Default font for listener output")
25
26(def-cocoa-default *listener-rows* :int 16 "Initial height of listener windows, in characters")
27(def-cocoa-default *listener-columns* :int 80 "Initial height of listener windows, in characters")
28
29(def-cocoa-default hi::*listener-output-style* :int 1 "Text style index for listener output")
30
31(def-cocoa-default hi::*listener-input-style* :int 0 "Text style index for listener output")
32
33(def-cocoa-default *listener-background-color* :color '(1.0 1.0 1.0 1.0) "Listener default background color")
34
35(def-cocoa-default *read-only-listener* :bool t "Do not allow editing old listener output")
36
37(defun hemlock-ext:read-only-listener-p ()
38  *read-only-listener*)
39
40
41(defclass cocoa-listener-input-stream (fundamental-character-input-stream)
42  ((queue :initform ())
43   (queue-lock :initform (make-lock))
44   (read-lock :initform (make-lock))
45   (queue-semaphore :initform (make-semaphore)) ;; total queue count
46   (text-semaphore :initform (make-semaphore))  ;; text-only queue count
47   (cur-string :initform nil)
48   (cur-string-pos :initform 0)
49   (cur-env :initform nil)
50   (cur-sstream :initform nil)
51   (cur-offset :initform nil)
52   (source-map :initform nil)
53   (reading-line :initform nil :accessor hi:input-stream-reading-line)))
54
55(defmethod interactive-stream-p ((stream cocoa-listener-input-stream))
56  t)
57
58
59
60
61(defmethod dequeue-listener-char ((stream cocoa-listener-input-stream) wait-p)
62  (with-slots (queue queue-lock read-lock queue-semaphore text-semaphore cur-string cur-string-pos) stream
63    (with-lock-grabbed (read-lock)
64      (or (with-lock-grabbed (queue-lock)
65            (when (< cur-string-pos (length cur-string))
66              (prog1 (aref cur-string cur-string-pos) (incf cur-string-pos))))
67          (loop
68            (unless (if wait-p
69                      (wait-on-semaphore text-semaphore nil "Listener Input")
70                      (timed-wait-on-semaphore text-semaphore 0))
71              (return nil))
72            (assert (timed-wait-on-semaphore queue-semaphore 0) () "queue/text mismatch!")
73            (with-lock-grabbed (queue-lock)
74              (let* ((s (find-if #'stringp queue)))
75                (assert s () "queue/semaphore mismatch!")
76                (setq queue (delq s queue 1))
77                (when (< 0 (length s))
78                  (setf cur-string s cur-string-pos 1)
79                  (return (aref s 0))))))))))
80
81(defmethod ccl::read-toplevel-form ((stream cocoa-listener-input-stream) &key eof-value)
82  (with-slots (queue queue-lock read-lock queue-semaphore text-semaphore cur-string cur-string-pos cur-sstream
83               cur-env source-map cur-offset)
84    stream
85    (with-lock-grabbed (read-lock)
86      (loop
87        (when cur-sstream
88          #+debug (log-debug "About to recursively read from sstring in env: ~s" cur-env)
89          (let* ((env cur-env)
90                 (form (progv (car env) (cdr env)
91                         (ccl::read-toplevel-form cur-sstream
92                                                  :eof-value eof-value
93                                                  :file-name *loading-file-source-file*
94                                                  :start-offset cur-offset
95                                                  :map source-map)))
96                 (last-form-in-selection (not (listen cur-sstream))))
97            #+debug (log-debug " --> ~s" form)
98            (when last-form-in-selection
99              (setf cur-sstream nil cur-env nil))
100            (return (values form env (or last-form-in-selection ccl::*verbose-eval-selection*)))))
101        (when (with-lock-grabbed (queue-lock)
102                (loop
103                  unless (< cur-string-pos (length cur-string)) return nil
104                  unless (whitespacep (aref cur-string cur-string-pos)) return t
105                  do (incf cur-string-pos)))
106          (return (values (call-next-method) nil t)))
107        (wait-on-semaphore queue-semaphore nil "Toplevel Read")
108        (let ((val (with-lock-grabbed (queue-lock) (pop queue))))
109          (cond ((stringp val)
110                 (assert (timed-wait-on-semaphore text-semaphore 0) () "text/queue mismatch!")
111                 (setq cur-string val cur-string-pos 0))
112                (t
113                 (destructuring-bind (string package-name pathname offset) val
114                   ;; This env is used both for read and eval.  *nx-source-note-map* is for the latter.
115                   (let ((env (cons '(*loading-file-source-file* *loading-toplevel-location* ccl::*nx-source-note-map*)
116                                    (list pathname nil source-map))))
117                     (when package-name
118                       (push '*package* (car env))
119                       (push (ccl::pkg-arg package-name) (cdr env)))
120                     (if source-map
121                       (clrhash source-map)
122                       (setf source-map (make-hash-table :test 'eq :shared nil)))
123                     (setf cur-sstream (make-string-input-stream string) cur-env env cur-offset offset))))))))))
124
125(defmethod enqueue-toplevel-form ((stream cocoa-listener-input-stream) string &key package-name pathname offset)
126  (with-slots (queue-lock queue queue-semaphore) stream
127    (with-lock-grabbed (queue-lock)
128      (setq queue (nconc queue (list (list string package-name pathname offset))))
129      (signal-semaphore queue-semaphore))))
130
131(defmethod enqueue-listener-input ((stream cocoa-listener-input-stream) string)
132  (with-slots (queue-lock queue queue-semaphore text-semaphore) stream
133    (with-lock-grabbed (queue-lock)
134      (setq queue (nconc queue (list string)))
135      (signal-semaphore queue-semaphore)
136      (signal-semaphore text-semaphore))))
137
138(defmethod stream-read-char-no-hang ((stream cocoa-listener-input-stream))
139  (dequeue-listener-char stream nil))
140
141(defmethod stream-read-char ((stream cocoa-listener-input-stream))
142  (dequeue-listener-char stream t))
143
144(defmethod stream-unread-char ((stream cocoa-listener-input-stream) char)
145  ;; Can't guarantee the right order of reads/unreads, just make sure not to
146  ;; introduce any internal inconsistencies (and dtrt for the non-conflict case).
147  (with-slots (queue queue-lock queue-semaphore text-semaphore cur-string cur-string-pos) stream
148    (with-lock-grabbed (queue-lock)
149      (cond ((>= cur-string-pos (length cur-string))
150             (push (string char) queue)
151             (signal-semaphore queue-semaphore)
152             (signal-semaphore text-semaphore))
153            ((< 0 cur-string-pos)
154             (decf cur-string-pos)
155             (setf (aref cur-string cur-string-pos) char))
156            (t (setf cur-string (concatenate 'string (string char) cur-string)))))))
157
158(defmethod ccl::stream-eof-transient-p ((stream cocoa-listener-input-stream))
159  t)
160
161(defmethod stream-clear-input ((stream cocoa-listener-input-stream))
162  (with-slots (queue-lock cur-string cur-string-pos cur-sstream cur-env) stream
163    (with-lock-grabbed (queue-lock)
164      (setf (hi::input-stream-reading-line stream) nil)
165      (setf cur-string nil cur-string-pos 0 cur-sstream nil cur-env nil))))
166
167(defmethod stream-read-line ((stream cocoa-listener-input-stream))
168  (let* ((old-reading-line (hi:input-stream-reading-line stream)))
169    (unwind-protect
170         (progn
171           (setf (hi::input-stream-reading-line stream) t)
172           (call-next-method))
173      (setf (hi:input-stream-reading-line stream) old-reading-line))))
174
175(defparameter $listener-flush-limit 4095)
176
177(defclass cocoa-listener-output-stream (fundamental-character-output-stream)
178  ((lock :initform (make-lock))
179   (hemlock-view :initarg :hemlock-view)
180   (data :initform (make-array (1+ $listener-flush-limit)
181                               :adjustable t :fill-pointer 0
182                               :element-type 'character))
183   (limit :initform $listener-flush-limit)))
184
185(defmethod stream-element-type ((stream cocoa-listener-output-stream))
186  (with-slots (data) stream
187    (array-element-type data)))
188
189(defmethod ccl:stream-write-char ((stream cocoa-listener-output-stream) char)
190  (with-slots (data lock limit) stream
191    (when (with-lock-grabbed (lock)
192            (>= (vector-push-extend char data) limit))
193      (stream-force-output stream))))
194
195;; This isn't really thread safe, but it's not too bad...  I'll take a chance - trying
196;; to get it to execute in the gui thread is too deadlock-prone.
197(defmethod hemlock-listener-output-mark-column ((view hi::hemlock-view))
198  (let* ((output-region (hi::variable-value 'hemlock::current-output-font-region
199                                            :buffer (hi::hemlock-view-buffer view))))
200    (hi::mark-charpos (hi::region-end output-region))))
201
202;; TODO: doesn't do the right thing for embedded tabs (in buffer or data)
203(defmethod ccl:stream-line-column ((stream cocoa-listener-output-stream))
204  (with-slots (hemlock-view data lock) stream
205    (with-lock-grabbed (lock)
206      (let* ((n (length data))
207             (pos (position #\Newline data :from-end t)))
208        (if (null pos)
209          (+ (hemlock-listener-output-mark-column hemlock-view) n)
210          (- n pos 1))))))
211
212(defmethod ccl:stream-fresh-line  ((stream cocoa-listener-output-stream))
213  (with-slots (hemlock-view data lock limit) stream
214    (when (with-lock-grabbed (lock)
215            (let ((n (length data)))
216              (unless (if (= n 0)
217                        (= (hemlock-listener-output-mark-column hemlock-view) 0)
218                        (eq (aref data (1- n)) #\Newline))
219                (>= (vector-push-extend #\Newline data) limit))))
220      (stream-force-output stream))))
221
222(defmethod ccl::stream-finish-output ((stream cocoa-listener-output-stream))
223  (stream-force-output stream))
224
225(defmethod ccl:stream-force-output ((stream cocoa-listener-output-stream))
226  (if (typep *current-process* 'appkit-process)
227    (with-slots (hemlock-view data lock) stream
228      (with-lock-grabbed (lock)
229        (when (> (fill-pointer data) 0)
230          (append-output hemlock-view data)
231          (setf (fill-pointer data) 0))))
232    (with-slots (data) stream
233      (when (> (fill-pointer data) 0)
234        (queue-for-gui #'(lambda () (stream-force-output stream)))))))
235
236(defmethod ccl:stream-clear-output ((stream cocoa-listener-output-stream))
237  (with-slots (data lock) stream
238    (with-lock-grabbed (lock)
239      (setf (fill-pointer data) 0))))
240
241(defmethod ccl:stream-line-length ((stream cocoa-listener-output-stream))
242  (with-slots (hemlock-view) stream
243    (values (hemlock-view-size hemlock-view))))
244
245(defloadvar *cocoa-listener-count* 0)
246
247(defclass cocoa-listener-process (process)
248    ((input-stream :reader cocoa-listener-process-input-stream)
249     (output-stream :reader cocoa-listener-process-output-stream)
250     (backtrace-contexts :initform nil
251                         :accessor cocoa-listener-process-backtrace-contexts)
252     (window :reader cocoa-listener-process-window :initform nil)))
253 
254(defloadvar *first-listener* t)
255
256(defun new-cocoa-listener-process (procname window)
257  (declare (special *standalone-cocoa-ide*))
258  (let* ((input-stream (make-instance 'cocoa-listener-input-stream))
259         (output-stream (make-instance 'cocoa-listener-output-stream
260                          :hemlock-view (hemlock-view window)))
261         
262         (proc
263          (ccl::make-mcl-listener-process 
264           procname
265           input-stream
266           output-stream
267           ;; cleanup function
268           #'(lambda ()
269               (mapcar #'(lambda (buf)
270                           (when (eq (buffer-process buf) *current-process*)
271                             (let ((doc (hi::buffer-document buf)))
272                               (when doc
273                                 (setf (hemlock-document-process doc) nil) ;; so #/close doesn't kill it.
274                                 (#/performSelectorOnMainThread:withObject:waitUntilDone:
275                                  doc
276                                  (@selector #/close)
277                                  +null-ptr+
278                                  nil)))))
279                       hi:*buffer-list*))
280           :initial-function
281           #'(lambda ()
282               (setq ccl::*listener-autorelease-pool* (create-autorelease-pool))               (when (and *standalone-cocoa-ide*
283                        (prog1 *first-listener* (setq *first-listener* nil)))
284                 (ccl::startup-ccl (ccl::application-init-file ccl::*application*))
285                 (ui-object-note-package *nsapp* *package*))
286               (ccl::listener-function))
287           :echoing nil
288           :class 'cocoa-listener-process)))
289    (setf (slot-value proc 'input-stream) input-stream)
290    (setf (slot-value proc 'output-stream) output-stream)
291    (setf (slot-value proc 'window) window)
292    proc))
293 
294(defclass hemlock-listener-frame (hemlock-frame)
295    ()
296  (:metaclass ns:+ns-object))
297(declaim (special hemlock-listener-frame))
298
299(objc:defmethod (#/setDocumentEdited: :void) ((w hemlock-listener-frame)
300                                              (edited #>BOOL))
301  (declare (ignorable edited)))
302
303(objc:defmethod (#/windowShouldClose: #>BOOL) ((w hemlock-listener-frame)
304                                               sender)
305  (let* ((doc (#/document w)))
306    (if (or (%null-ptr-p doc)
307            (and (hemlock-document-process doc)
308                 (perform-close-kills-process-p doc)))
309      t
310      (progn
311        (#/orderOut: w sender)
312        nil))))
313
314
315
316(defclass hemlock-listener-window-controller (hemlock-editor-window-controller)
317    ()
318  (:metaclass ns:+ns-object)
319  )
320(declaim (special hemlock-listener-window-controller))
321
322;;; Listener documents are never (or always) ediited.  Don't cause their
323;;; close boxes to be highlighted.
324(objc:defmethod (#/setDocumentEdited: :void)
325    ((self hemlock-listener-window-controller) (edited :<BOOL>))
326  (declare (ignorable edited)))
327
328
329
330(objc:defmethod #/windowTitleForDocumentDisplayName: ((self hemlock-listener-window-controller) name)
331  (let* ((doc (#/document self)))
332    (if (or (%null-ptr-p doc)
333            (not (%null-ptr-p (#/fileURL doc))))
334      (call-next-method name)
335      (let* ((buffer (hemlock-buffer doc))
336             (bufname (if buffer (hi::buffer-name buffer))))
337        (if bufname
338          (%make-nsstring bufname)
339          (call-next-method name))))))
340
341
342;;; The HemlockListenerDocument class.
343
344
345(defclass hemlock-listener-document (hemlock-editor-document)
346  ((process :reader %hemlock-document-process :writer (setf hemlock-document-process) :initform nil))
347  (:metaclass ns:+ns-object))
348(declaim (special hemlock-listener-document))
349
350(defgeneric hemlock-document-process (doc)
351  (:method ((unknown t)) nil)
352  (:method ((doc hemlock-listener-document)) (%hemlock-document-process doc)))
353
354;; Nowadays this is nil except for listeners.
355(defun buffer-process (buffer)
356  (hemlock-document-process (hi::buffer-document buffer)))
357
358(defmethod update-buffer-package ((doc hemlock-listener-document) buffer)
359  (declare (ignore buffer)))
360
361(defmethod document-encoding-name ((doc hemlock-listener-document))
362  "UTF-8")
363
364(defmethod user-input-style ((doc hemlock-listener-document))
365  hi::*listener-input-style*)
366 
367(defmethod textview-background-color ((doc hemlock-listener-document))
368  *listener-background-color*)
369
370;; For use with the :process-info listener modeline field
371(defmethod hemlock-ext:buffer-process-description (buffer)
372  (let ((proc (buffer-process buffer)))
373    (when proc
374      (format nil "~a(~d) [~a]"
375              (ccl:process-name proc)
376              (ccl::process-serial-number proc)
377              ;; TODO: this doesn't really work as a modeline item, because the modeline
378              ;; doesn't get notified when it changes.
379              (ccl:process-whostate proc)))))
380
381(objc:defmethod #/topListener ((self +hemlock-listener-document))
382  (let* ((all-windows (#/orderedWindows *NSApp*)))
383    (dotimes (i (#/count all-windows) +null-ptr+)
384      (let* ((w (#/objectAtIndex: all-windows i)))
385        (when (#/isVisible w)
386          (let* ((wc (#/windowController w))
387                 (doc (#/document wc)))
388            (when (#/isKindOfClass: doc self)
389              (return doc))))))))
390
391(defun symbol-value-in-top-listener-process (symbol)
392  (let* ((process (hemlock-document-process (#/topListener hemlock-listener-document))))
393     (if process
394       (ignore-errors (symbol-value-in-process symbol process))
395       (values nil t))))
396 
397(defun hemlock-ext:top-listener-output-stream ()
398  (let* ((process (hemlock-document-process (#/topListener hemlock-listener-document))))
399    (when process
400      (setq process (require-type process 'cocoa-listener-process))
401      (cocoa-listener-process-output-stream process))))
402
403(defun hemlock-ext:top-listener-input-stream ()
404  (let* ((process (hemlock-document-process (#/topListener hemlock-listener-document))))
405    (when process
406      (setq process (require-type process 'cocoa-listener-process))
407      (cocoa-listener-process-input-stream process))))
408
409
410
411(objc:defmethod (#/isDocumentEdited :<BOOL>) ((self hemlock-listener-document))
412  nil)
413
414
415
416(objc:defmethod #/init ((self hemlock-listener-document))
417  (let* ((doc (call-next-method)))
418    (unless (%null-ptr-p doc)
419      (let* ((listener-name (if (eql 1 (incf *cocoa-listener-count*))
420                              "Listener"
421                              (format nil
422                                      "Listener-~d" *cocoa-listener-count*)))
423             (buffer (hemlock-buffer doc)))
424        (setf (hi::buffer-pathname buffer) nil
425              (hi::buffer-minor-mode buffer "Listener") t
426              (hi::buffer-name buffer) listener-name)
427        (hi::set-buffer-modeline-fields buffer hemlock::*listener-modeline-fields*)))
428    doc))
429
430(def-cocoa-default *initial-listener-x-pos* :float -100.0f0 "X position of upper-left corner of initial listener")
431
432(def-cocoa-default *initial-listener-y-pos* :float 100.0f0 "Y position of upper-left corner of initial listener")
433
434(defloadvar *next-listener-x-pos* nil) ; set after defaults initialized
435(defloadvar *next-listener-y-pos* nil) ; likewise
436
437(objc:defmethod (#/dealloc :void) ((self hemlock-listener-document))
438  (if (zerop (decf *cocoa-listener-count*))
439    (setq *next-listener-x-pos* nil
440          *next-listener-y-pos* nil))
441  (let* ((p (shiftf (hemlock-document-process self) nil)))
442    (when p
443      (process-kill p)))
444  (call-next-method))
445
446
447
448
449(objc:defmethod (#/makeWindowControllers :void) ((self hemlock-listener-document))
450  (let* ((textstorage (slot-value self 'textstorage))
451         (window (%hemlock-frame-for-textstorage
452                  hemlock-listener-frame
453                  textstorage
454                  *listener-columns*
455                  *listener-rows*
456                  t
457                  (textview-background-color self)
458                  (user-input-style self)))
459         (listener-styles (#/arrayWithObjects: ns:ns-mutable-array
460                                               (rme-create-text-attributes
461                                                :font *listener-input-font*)
462                                               (rme-create-text-attributes
463                                                :font *listener-output-font*)
464                                               +null-ptr+))
465         (controller (make-instance
466                      'hemlock-listener-window-controller
467                      :with-window window))
468         (listener-name (hi::buffer-name (hemlock-buffer self)))
469         (path (#/windowTitleForDocumentDisplayName: controller (#/displayName self ))))
470    (when (slot-exists-p textstorage 'styles)
471      (with-slots (styles) textstorage
472        ;; We probably should be more disciplined about
473        ;; Cocoa memory management.  Having retain/release in
474        ;; random places all over the code is going to get
475        ;; unwieldy.
476        (#/release styles)
477        (setf styles (#/retain listener-styles))))
478    ;; Disabling background layout on listeners is an attempt to work
479    ;; around a bug.  The bug's probably gone ...
480    #-cocotron                          ;no concept of background layout
481    (let* ((layout-managers (#/layoutManagers textstorage)))
482      (dotimes (i (#/count layout-managers))
483        (let* ((layout (#/objectAtIndex: layout-managers i)))
484          (#/setBackgroundLayoutEnabled: layout nil))))
485    (#/setDelegate: window controller)
486    (#/setDelegate: (text-pane-text-view (slot-value window 'pane)) self)
487    (#/setShouldCascadeWindows: controller nil)
488    (#/addWindowController: self controller)
489    (#/release controller)
490    (unless (hemlock-document-process self)
491      (setf (hemlock-document-process self)
492            (new-cocoa-listener-process listener-name window)))
493    (when path
494      (unless (#/setFrameAutosaveName: window path)
495        (setq path nil)))
496    (unless (and path
497                 (when (#/setFrameUsingName: window path)
498                   (let* ((frame (#/frame window)))
499                     (ns:with-ns-point (current-point
500                                        (ns:ns-rect-x frame)
501                                        (+ (ns:ns-rect-y frame)
502                                           (ns:ns-rect-height frame)))
503                       (let* ((next-point (#/cascadeTopLeftFromPoint:
504                                           window
505                                           current-point)))
506                         (setq *next-listener-x-pos*
507                               (ns:ns-point-x next-point)
508                               *next-listener-y-pos*
509                               (ns:ns-point-y next-point)))))
510                   t))
511      (ns:with-ns-point (current-point
512                         (or *next-listener-x-pos*
513                             (x-pos-for-window window *initial-listener-x-pos*))
514                         (or *next-listener-y-pos*
515                             (y-pos-for-window window *initial-listener-y-pos*)))
516        (let* ((new-point (#/cascadeTopLeftFromPoint: window current-point)))
517          (setf *next-listener-x-pos* (ns:ns-point-x new-point)
518                *next-listener-y-pos* (ns:ns-point-y new-point)))))
519    (#/synchronizeWindowTitleWithDocumentName controller)
520    controller))
521
522(objc:defmethod (#/textView:shouldChangeTextInRange:replacementString: :<BOOL>)
523    ((self hemlock-listener-document)
524     tv
525     (range :<NSR>ange)
526     string)
527  (declare (ignore tv string))
528  (let* ((range-start (ns:ns-range-location range))
529         (range-end (+ range-start (ns:ns-range-length range)))
530         (buffer (hemlock-buffer self))
531         (protected-region (hi::buffer-protected-region buffer)))
532    (if protected-region
533      (let* ((prot-start (hi:mark-absolute-position (hi::region-start protected-region)))
534             (prot-end (hi:mark-absolute-position (hi::region-end protected-region))))
535        (not (or (and (>= range-start prot-start)
536                      (< range-start prot-end))
537                 (and (>= range-end prot-start)
538                      (< range-end prot-end)))))
539      t)))
540   
541   
542;;; Action methods
543(objc:defmethod (#/interrupt: :void) ((self hemlock-listener-document) sender)
544  (declare (ignore sender))
545  (let* ((process (hemlock-document-process self)))
546    (when process
547      (ccl::force-break-in-listener process))))
548
549
550
551(objc:defmethod (#/exitBreak: :void) ((self hemlock-listener-document) sender)
552  (declare (ignore sender))
553  (let* ((process (hemlock-document-process self)))
554    #+debug (log-debug  "~&exitBreak process ~s" process)
555    (when process
556      (process-interrupt process #'abort-break))))
557
558(defmethod listener-backtrace-context ((proc cocoa-listener-process))
559  (car (cocoa-listener-process-backtrace-contexts proc)))
560
561(objc:defmethod (#/backtrace: :void) ((self hemlock-listener-document) sender)
562  (let* ((process (hemlock-document-process self)))
563    (when process
564      (let* ((context (listener-backtrace-context process)))
565        (when context
566          (#/makeKeyAndOrderFront: (#/windowForSheet self) nil)
567          (#/showWindow: (backtrace-controller-for-context context) sender))))))
568
569(defun restarts-controller-for-context (context)
570  (or (car (ccl::bt.restarts context))
571      (setf (car (ccl::bt.restarts context))
572            (let* ((tcr (ccl::bt.tcr context))
573                   (tsp-range (inspector::make-tsp-stack-range tcr context))
574                   (vsp-range (inspector::make-vsp-stack-range tcr context))
575                   (csp-range (inspector::make-csp-stack-range tcr context))
576                   (process (ccl::tcr->process tcr)))
577              (make-instance 'sequence-window-controller
578                             :sequence (cdr (ccl::bt.restarts context))
579                             :result-callback #'(lambda (r)
580                                                  (process-interrupt
581                                                   process
582                                                   #'invoke-restart-interactively
583                                                   r))
584                             :display #'(lambda (item stream)
585                                          (let* ((ccl::*aux-vsp-ranges* vsp-range)
586                                                 (ccl::*aux-tsp-ranges* tsp-range)
587                                                 (ccl::*aux-csp-ranges* csp-range))
588                                          (princ item stream)))
589                             :title (format nil "Restarts for ~a(~d), break level ~d"
590                                            (process-name process)
591                                            (process-serial-number process)
592                                            (ccl::bt.break-level context)))))))
593                           
594(objc:defmethod (#/restarts: :void) ((self hemlock-listener-document) sender)
595  (let* ((process (hemlock-document-process self)))
596    (when process
597      (let* ((context (listener-backtrace-context process)))
598        (when context
599          (#/showWindow: (restarts-controller-for-context context) sender))))))
600
601(objc:defmethod (#/continue: :void) ((self hemlock-listener-document) sender)
602  (declare (ignore sender))
603  (let* ((process (hemlock-document-process self)))
604    (when process
605      (let* ((context (listener-backtrace-context process)))
606        (when context
607          (process-interrupt process #'invoke-restart-interactively 'continue))))))
608
609
610
611
612
613
614;;; Menu item action validation.  It'd be nice if we could distribute this a
615;;; bit better, so that this method didn't have to change whenever a new
616;;; action was implemented in this class.  For now, we have to do so.
617
618(defmethod document-validate-menu-item ((doc hemlock-listener-document) item)
619  ;; Return two values: the first is true if the second is definitive.
620  ;; So far, all actions demand that there be an underlying process, so
621  ;; check for that first.
622  (let* ((process (hemlock-document-process doc)))
623    (if process
624      (let* ((action (#/action item)))
625        (cond
626          ((or (eql action (@selector #/revertDocumentToSaved:))
627               (eql action (@selector #/saveDocument:))
628               (eql action (@selector #/saveDocumentAs:)))
629           (values t nil))
630          ((eql action (@selector #/interrupt:)) (values t t))
631          ((eql action (@selector #/continue:))
632           (let* ((context (listener-backtrace-context process)))
633             (values
634              t
635              (and context
636                   (find 'continue (cdr (ccl::bt.restarts context))
637                         :key #'restart-name)))))
638          ((or (eql action (@selector #/backtrace:))
639               (eql action (@selector #/exitBreak:))
640               (eql action (@selector #/restarts:)))
641           (values t
642                   (not (null (listener-backtrace-context process)))))))
643      (values nil nil))))
644
645(objc:defmethod (#/validateMenuItem: :<BOOL>)
646    ((self hemlock-listener-document) item)
647  (multiple-value-bind (have-opinion opinion)
648      (document-validate-menu-item self item)
649    (if have-opinion
650      opinion
651      (call-next-method item))))
652
653(defmethod perform-close-kills-process-p ((self hemlock-listener-document))
654  t)
655
656(defun shortest-package-name (package)
657  (let* ((name (package-name package))
658         (len (length name)))
659    (dolist (nick (package-nicknames package) name)
660      (let* ((nicklen (length nick)))
661        (if (< nicklen len)
662          (setq name nick len nicklen))))))
663
664(defmethod ui-object-note-package ((app ns:ns-application) package)
665  (let ((proc *current-process*)
666        (name (shortest-package-name package)))
667    (execute-in-gui #'(lambda ()
668                        (dolist (buf hi::*buffer-list*)
669                          (when (eq proc (buffer-process buf))
670                            (setf (hi::variable-value 'hemlock::current-package :buffer buf) name)))))))
671
672
673(defmethod eval-in-listener-process ((process cocoa-listener-process)
674                                     string &key path package offset)
675  (enqueue-toplevel-form (cocoa-listener-process-input-stream process) string
676                         :package-name package :pathname path :offset offset))
677
678;;; This is basically used to provide INPUT to the listener process, by
679;;; writing to an fd which is connected to that process's standard
680;;; input.
681(defun hemlock-ext:send-string-to-listener (listener-buffer string)
682  (let* ((process (buffer-process listener-buffer)))
683    (unless process
684      (error "No listener process found for ~s" listener-buffer))
685    (enqueue-listener-input (cocoa-listener-process-input-stream process) string)))
686
687(defmethod ui-object-choose-listener-for-selection ((app ns:ns-application)
688                                                    selection)
689  (declare (ignore selection))
690  (#/performSelectorOnMainThread:withObject:waitUntilDone:
691   (#/delegate *NSApp*)
692   (@selector #/ensureListener:)
693   +null-ptr+
694   #$YES)
695  (hemlock-document-process (#/topListener hemlock-listener-document)))
696
697(defmethod ui-object-eval-selection ((app ns:ns-application)
698                                     selection)
699  (let* ((target-listener (ui-object-choose-listener-for-selection
700                           app selection)))
701    (when target-listener
702      (destructuring-bind (package path string &optional offset) selection
703        (eval-in-listener-process target-listener string :package package :path path :offset offset)))))
704
705(defmethod ui-object-load-buffer ((app ns:ns-application) selection)
706  (let* ((target-listener (ui-object-choose-listener-for-selection app nil)))
707    (when target-listener
708      (destructuring-bind (package path) selection
709        (let ((string (format nil "(load ~S)" path)))
710          (eval-in-listener-process target-listener string :package package))))))
711
712(defmethod ui-object-compile-buffer ((app ns:ns-application) selection)
713  (let* ((target-listener (ui-object-choose-listener-for-selection app nil)))
714    (when target-listener
715      (destructuring-bind (package path) selection
716        (let ((string (format nil "(compile-file ~S)" path)))
717          (eval-in-listener-process target-listener string :package package))))))
718
719(defmethod ui-object-compile-and-load-buffer ((app ns:ns-application) selection)
720  (let* ((target-listener (ui-object-choose-listener-for-selection app nil)))
721    (when target-listener
722      (destructuring-bind (package path) selection
723        (let ((string (format nil "(progn (compile-file ~S)(load ~S))" 
724                              path
725                              (make-pathname :directory (pathname-directory path)
726                                             :name (pathname-name path)
727                                             :type (pathname-type path)))))
728          (eval-in-listener-process target-listener string :package package))))))
729
730       
731;;; Support for background processes that acquire listener window/document/
732;;; buffer infrastructure iff they try to do I/O to *TERMINAL-IO*.
733
734(defclass hemlock-background-listener-document (hemlock-listener-document)
735    ()
736  (:metaclass ns:+ns-object))
737
738(defmethod perform-close-kills-process-p ((self hemlock-background-listener-document))
739  nil)
740
741(defstruct deferred-cocoa-listener-stream-info
742  real-input-stream
743  real-output-stream
744  process
745  window)
746
747   
748(defclass deferred-cocoa-listener-stream (fundamental-character-stream)
749    ((info :initarg :info :accessor deferred-cocoa-listener-stream-info)))
750
751(defmethod ensure-deferred-stream-info-for-io ((s deferred-cocoa-listener-stream))
752  (let* ((info (slot-value s 'info)))
753    (when info
754      (unless (deferred-cocoa-listener-stream-info-window info)
755        (with-autorelease-pool
756            (let* ((doc (make-instance 'hemlock-background-listener-document))
757                   (buffer (hemlock-buffer doc))
758                   (process (deferred-cocoa-listener-stream-info-process info)))
759              (setf (hi::buffer-name buffer)
760                    (format nil "~a(~d)" (process-name process) (process-serial-number process))
761                    (hemlock-document-process doc) process)
762              (execute-in-gui (lambda () (#/makeWindowControllers doc)))
763              (let* ((wc (#/lastObject (#/windowControllers doc)))
764                     (window (#/window wc)))
765                (setf
766                 (deferred-cocoa-listener-stream-info-real-input-stream info)
767                 (make-instance 'cocoa-listener-input-stream)
768                 (deferred-cocoa-listener-stream-info-real-output-stream info)
769                 (make-instance 'cocoa-listener-output-stream
770                                :hemlock-view (hemlock-view window))
771                 (deferred-cocoa-listener-stream-info-window info)
772                 window
773                 (slot-value process 'window) window)
774                (ui-object-note-package *nsapp* *package*))))))
775    info))
776               
777                     
778
779(defclass deferred-cocoa-listener-output-stream
780          (fundamental-character-output-stream deferred-cocoa-listener-stream)
781    ())
782
783(defmethod stream-element-type ((s deferred-cocoa-listener-output-stream))
784  'character)
785
786
787(defmethod underlying-output-stream ((s deferred-cocoa-listener-output-stream))
788  (let* ((info (ensure-deferred-stream-info-for-io s)))
789    (if info
790      (progn
791        (let* ((window (deferred-cocoa-listener-stream-info-window info)))
792          (unless (#/isVisible window)
793            (execute-in-gui
794             (lambda ()
795               (#/makeKeyAndOrderFront: window (%null-ptr)))))
796          (deferred-cocoa-listener-stream-info-real-output-stream info)))
797      (ccl::stream-is-closed s))))
798
799(defmethod ccl:stream-write-char ((s deferred-cocoa-listener-output-stream)
800                                   char)
801  (with-autorelease-pool
802      (stream-write-char (underlying-output-stream s) char)))
803
804(defmethod ccl:stream-line-column ((s deferred-cocoa-listener-output-stream))
805  (stream-line-column (underlying-output-stream s)))
806
807(defmethod ccl:stream-fresh-line ((s deferred-cocoa-listener-output-stream))
808  (stream-fresh-line (underlying-output-stream s)))
809
810(defmethod ccl::stream-finish-output ((s deferred-cocoa-listener-output-stream))
811  (stream-force-output s))
812
813(defmethod ccl:stream-force-output ((s deferred-cocoa-listener-output-stream))
814  (let* ((info (slot-value s 'info)))
815    (if info
816      (let* ((out (deferred-cocoa-listener-stream-info-real-output-stream info)))
817        (if out
818          (stream-force-output out)))
819      (ccl::stream-is-closed s))))
820
821(defmethod ccl:stream-clear-output ((s deferred-cocoa-listener-output-stream))
822  (stream-clear-output (underlying-output-stream s)))
823
824(defmethod ccl:stream-line-length ((s deferred-cocoa-listener-output-stream))
825  (stream-line-length (underlying-output-stream s)))
826
827(defmethod close ((s deferred-cocoa-listener-output-stream)
828                  &key abort)
829  (let* ((info (slot-value s 'info)))
830    (when info
831      (let* ((out (deferred-cocoa-listener-stream-info-real-output-stream info)))
832        (when out
833          (stream-force-output out)
834          (close out :abort abort)))
835      (setf (slot-value s 'info) nil)
836      t)))
837         
838
839(defclass deferred-cocoa-listener-input-stream
840          (fundamental-character-input-stream deferred-cocoa-listener-stream)
841    ((reading-line :initform nil :accessor hi:input-stream-reading-line)))
842
843
844(defmethod underlying-input-stream ((s deferred-cocoa-listener-input-stream))
845  (let* ((info (ensure-deferred-stream-info-for-io s)))
846    (if info
847      (progn
848        (let* ((window (deferred-cocoa-listener-stream-info-window info)))
849          (unless (#/isVisible window)
850            (execute-in-gui
851             (lambda ()
852               (#/makeKeyAndOrderFront: window (%null-ptr)))))
853          (deferred-cocoa-listener-stream-info-real-input-stream info)))
854      (ccl::stream-is-closed s))))
855
856(defmethod interactive-stream-p ((s deferred-cocoa-listener-input-stream))
857  t)
858
859(defmethod ccl::read-toplevel-form ((s deferred-cocoa-listener-input-stream)
860                                    &key eof-value)
861  (ccl::read-toplevel-form (underlying-input-stream s) :eof-value eof-value))
862
863(defmethod enqueue-toplevel-form ((s deferred-cocoa-listener-input-stream) string &rest args)
864  (apply #'enqueue-toplevel-form (underlying-input-stream s) string args))
865
866(defmethod enqueue-listener-input ((s deferred-cocoa-listener-input-stream) string)
867  (enqueue-listener-input (underlying-input-stream s) string))
868
869(defmethod stream-read-char-no-hang ((s deferred-cocoa-listener-input-stream))
870  (stream-read-char-no-hang (underlying-input-stream s)))
871
872(defmethod stream-read-char ((s deferred-cocoa-listener-input-stream))
873  (stream-read-char (underlying-input-stream s)))
874
875(defmethod stream-unread-char ((s deferred-cocoa-listener-input-stream) char)
876  (stream-unread-char (underlying-input-stream s) char))
877
878(defmethod stream-clear-input ((s deferred-cocoa-listener-input-stream))
879  (stream-clear-input (underlying-input-stream s)))
880
881(defmethod stream-read-line ((s deferred-cocoa-listener-input-stream))
882  (let* ((old-reading-line (hi:input-stream-reading-line s)))
883    (unwind-protect
884         (progn
885           (setf (hi::input-stream-reading-line s) t)
886           (stream-read-line (underlying-input-stream s)))
887      (setf (hi:input-stream-reading-line s) old-reading-line))))
888
889(defclass background-cocoa-listener-process (cocoa-listener-process)
890    ())
891
892(defun background-process-run-function (name function)
893  (let* ((process (make-process name :class 'background-cocoa-listener-process))
894         (info (make-deferred-cocoa-listener-stream-info :process process))
895         (input-stream (make-instance 'deferred-cocoa-listener-input-stream
896                                      :info info))
897         (output-stream (make-instance 'deferred-cocoa-listener-output-stream
898                                       :info info)))
899    (setf (slot-value process 'input-stream) input-stream
900          (slot-value process 'output-stream) output-stream)
901    (process-preset process
902                    (lambda ()
903                      (let* ((*terminal-io* (make-two-way-stream input-stream output-stream)))
904                        (ccl::add-auto-flush-stream output-stream)
905                        (unwind-protect
906                             (funcall function)
907                          (remove-auto-flush-stream output-stream)
908                          (let* ((w (slot-value process 'window)))
909                            (when w
910                              (let* ((doc (#/document w)))
911                                (unless (%null-ptr-p doc)
912                                  (when (eq *current-process*
913                                            (hemlock-document-process doc))
914                                    (setf (hemlock-document-process doc) nil))))
915                              (cond ((#/isVisible w)
916                                     (format output-stream "~%~%{process ~s exiting}~%" *current-process*))
917                                    (t
918                                     (#/performSelectorOnMainThread:withObject:waitUntilDone:
919                                      w
920                                      (@selector #/close)
921                                      +null-ptr+
922                                      t)))
923                              (close input-stream)
924                              (close output-stream)))))))
925    (process-enable process)))
Note: See TracBrowser for help on using the repository browser.