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

Last change on this file since 15183 was 15183, checked in by gb, 9 years ago

In ENSURE-DEFERRED-STREAM-INFO-FOR-IO, force the document object (and
all of the related infrastructure) to be created on the event thread.
This is probably a good idea in general and doing this avoids the race
condition described in ticket:905.

Hemlock buffer creation isn't really thread-safe; if we ever want it
to be, we might want to do locking/serialization at a different level.

Fixes ticket:905 in the trunk.

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