* riece-ruby.el (riece-ruby-filter): Call output-handler/exit-handler
[riece] / lisp / riece-ruby.el
index 2c38afa..eb1fab7 100644 (file)
@@ -1,4 +1,4 @@
-;;; riece-ruby.el --- interact with ruby interpreter
+;;; riece-ruby.el --- interact with Ruby interpreter
 ;; Copyright (C) 1998-2005 Daiki Ueno
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
 
 ;;; Commentary:
 
-;; (riece-ruby-execute "t1" "sleep 30")
+;; riece-ruby.el is a library to interact with the Ruby interpreter.
+;; It supports concurrent execution of Ruby programs in a single
+;; session.  For example:
+;; 
+;; (riece-ruby-execute "sleep 30"); returns immediately
+;; => "rubyserv0"
 ;;
-;; (riece-ruby-execute "t2" "1 + 1")
+;; (riece-ruby-execute "1 + 1")
+;; => "rubyserv1"
 ;;
-;; (riece-ruby-execute "t3" "\"")
+;; (riece-ruby-execute "\"")
+;; => "rubyserv2"
 ;;
-;; (riece-ruby-inspect "t1")
+;; (riece-ruby-inspect "rubyserv0")
 ;; => ((OK nil) nil "running")
 ;;
-;; (riece-ruby-inspect "t2")
+;; (riece-ruby-inspect "rubyserv1")
 ;; => ((OK nil) "2" "finished")
 ;;
-;; (riece-ruby-inspect "t3")
-;; => ((OK nil) "(eval):1:in `dispatch_eval': compile error
-;; (eval):1: unterminated string meets end of file" "exited")
-
+;; (riece-ruby-inspect "rubyserv2")
+;; => ((OK nil) "(eval):1: unterminated string meets end of file" "exited")
 
 ;;; Code:
 
-(defvar riece-ruby-command "ruby"
-  "Command name for Ruby interpreter.")
+(defgroup riece-ruby nil
+  "Interact with the Ruby interpreter."
+  :group 'riece)
+
+(defcustom riece-ruby-command "ruby"
+  "Command name for Ruby interpreter."
+  :type 'string
+  :group 'riece-ruby)
+
+(defvar riece-ruby-server-program "server.rb"
+  "The server program file.  If the filename is not absolute, it is
+assumed that the file is in the same directory of this file.")
 
-(defvar riece-ruby-process nil)
+(defvar riece-ruby-process nil
+  "Process object of the Ruby interpreter.")
 
-(defvar riece-ruby-lock nil)
-(defvar riece-ruby-response nil)
-(defvar riece-ruby-data nil)
-(defvar riece-ruby-input nil)
-(defvar riece-ruby-status nil)
+(defvar riece-ruby-lock nil
+  "Lock for waiting server response.
+Local to the process buffer.")
+(defvar riece-ruby-response nil
+  "The server response.
+Local to the process buffer.")
+(defvar riece-ruby-data nil
+  "Data from server.
+Local to the process buffer.")
+(defvar riece-ruby-escaped-data nil
+  "Escaped data from server.  This variable is cleared every time
+server response arrives.
+Local to the process buffer.")
+(defvar riece-ruby-status-alist nil
+  "Status from server.
+Local to the process buffer.")
 
-(defvar riece-ruby-output-handler-alist nil)
-(defvar riece-ruby-exit-handler-alist nil)
+(defvar riece-ruby-output-handler-alist nil
+  "An alist mapping from program name to output handler.
+Output handlers are called every time \"# output\" line arrives.
+Use `riece-ruby-set-output-handler' to set this variable.")
+(defvar riece-ruby-exit-handler-alist nil
+  "An alist mapping from program name to exit handler.
+Exit handlers are called once when \"# exit\" line arrives.
+Use `riece-ruby-set-exit-handler' to set this variable.")
 
-(defun riece-ruby-substitute-variables (program variable value)
+(defun riece-ruby-substitute-variables (program alist)
   (setq program (copy-sequence program))
-  (let ((pointer program))
-    (while pointer
-      (setq pointer (memq variable program))
-      (if pointer
-         (setcar pointer value)))
-    program))
+  (while alist
+    (let ((pointer program))
+      (while pointer
+       (setq pointer (memq (car (car alist)) program))
+       (if pointer
+           (setcar pointer (cdr (car alist))))))
+    (setq alist (cdr alist)))
+  (apply #'concat program))
 
 (defun riece-ruby-escape-data (data)
   (let ((index 0))
            index (- (match-end 0) 2)))
     data))
 
-(defun riece-ruby-send-eval (name program)
+(defun riece-ruby-reset-process-buffer ()
+  (save-excursion
+    (set-buffer (process-buffer riece-ruby-process))
+    (buffer-disable-undo)
+    (make-local-variable 'riece-ruby-response)
+    (setq riece-ruby-response nil)
+    (make-local-variable 'riece-ruby-data)
+    (setq riece-ruby-data nil)
+    (make-local-variable 'riece-ruby-escaped-data)
+    (setq riece-ruby-escaped-data nil)
+    (make-local-variable 'riece-ruby-status-alist)
+    (setq riece-ruby-status-alist nil)))
+
+(defun riece-ruby-send-eval (program)
   (let* ((string (riece-ruby-escape-data program))
         (length (- (length string) 998))
         (index 0)
                       data)))
     (setq data (cons (substring string index) data)
          data (nreverse data))
-    (save-excursion
-      (set-buffer (process-buffer riece-ruby-process))
-      (make-local-variable 'riece-ruby-lock)
-      (setq riece-ruby-lock nil)
-      (make-local-variable 'riece-ruby-response)
-      (setq riece-ruby-response nil)
-      (make-local-variable 'riece-ruby-data)
-      (setq riece-ruby-data nil)
-      (make-local-variable 'riece-ruby-input)
-      (setq riece-ruby-input nil)
-      (make-local-variable 'riece-ruby-status)
-      (setq riece-ruby-status nil))
-    (process-send-string riece-ruby-process
-                        (concat "EVAL " name "\r\n"))
+    (process-send-string riece-ruby-process "EVAL\r\n")
     (while data
       (process-send-string riece-ruby-process
                           (concat "D " (car data) "\r\n"))
       (setq data (cdr data)))
     (process-send-string riece-ruby-process "END\r\n")))
-    
+
 (defun riece-ruby-send-poll (name)
-  (save-excursion
-    (set-buffer (process-buffer riece-ruby-process))
-    (make-local-variable 'riece-ruby-lock)
-    (setq riece-ruby-lock nil)
-    (make-local-variable 'riece-ruby-response)
-    (setq riece-ruby-response nil)
-    (make-local-variable 'riece-ruby-data)
-    (setq riece-ruby-data nil)
-    (make-local-variable 'riece-ruby-input)
-    (setq riece-ruby-input nil)
-    (make-local-variable 'riece-ruby-status)
-    (setq riece-ruby-status nil))
   (process-send-string riece-ruby-process
                       (concat "POLL " name "\r\n")))
 
+(defun riece-ruby-send-exit (name)
+  (process-send-string riece-ruby-process
+                      (concat "EXIT " name "\r\n")))
+
 (defun riece-ruby-filter (process input)
   (save-excursion
     (set-buffer (process-buffer process))
     (insert input)
     (goto-char (process-mark process))
     (beginning-of-line)
-    (while (looking-at ".*\r?\n")
+    (while (looking-at ".*\r\n")
       (if (looking-at "OK\\( \\(.*\\)\\)?\r")
          (progn
-           (if riece-ruby-input
+           (if riece-ruby-escaped-data
                (setq riece-ruby-data (mapconcat #'riece-ruby-unescape-data
-                                                riece-ruby-input "")))
-           (setq riece-ruby-input nil
+                                                riece-ruby-escaped-data "")))
+           (setq riece-ruby-escaped-data nil
                  riece-ruby-response (list 'OK (match-string 2))
                  riece-ruby-lock nil))
        (if (looking-at "ERR \\([0-9]+\\)\\( \\(.*\\)\\)?\r")
            (progn
-             (setq riece-ruby-input nil
+             (setq riece-ruby-escaped-data nil
                    riece-ruby-response
                    (list 'ERR (string-to-number (match-string 2))
                          (match-string 3))
                    riece-ruby-lock nil))
          (if (looking-at "D \\(.*\\)\r")
-             (setq riece-ruby-input (cons (match-string 1) riece-ruby-input))
-           (if (looking-at "S program \\(.*\\)\r")
-               (setq riece-ruby-status (match-string 1))
+             (setq riece-ruby-escaped-data (cons (match-string 1)
+                                                 riece-ruby-escaped-data))
+           (if (looking-at "S \\(.*\\) \\(.*\\)\r")
+               (progn
+                 (setq riece-ruby-status-alist (cons (cons (match-string 1)
+                                                           (match-string 2))
+                                                     riece-ruby-status-alist))
+                 (if (member (car (car riece-ruby-status-alist))
+                             '("finished" "exited"))
+                     (riece-ruby-run-exit-handler
+                      (cdr (car riece-ruby-status-alist)))))
              (if (looking-at "# output \\(.*\\) \\(.*\\)\r")
                  (let ((entry (assoc (match-string 1)
                                      riece-ruby-output-handler-alist)))
                    (if entry
-                       (funcall (cdr entry) (match-string 2))))
+                       (funcall (car entry) (cdr entry) (match-string 2))))
                (if (looking-at "# exit \\(.*\\)\r")
-                   (let ((entry (assoc (match-string 1)
-                                       riece-ruby-exit-handler-alist)))
-                     (if entry
-                         (funcall (cdr entry))))))))))
+                   (riece-ruby-run-exit-handler (match-string 1))))))))
       (forward-line))
     (set-marker (process-mark process) (point-marker))))
 
+(defun riece-ruby-run-exit-handler (name)
+  (let ((entry (assoc name riece-ruby-exit-handler-alist)))
+    (if entry
+       (progn
+         (funcall (cdr entry) (car entry))
+         (setq riece-ruby-exit-handler-alist (delq entry))))))
+
 (defun riece-ruby-sentinel (process status)
   (kill-buffer (process-buffer process)))
 
-(defun riece-ruby-execute (name program)
+(defun riece-ruby-execute (program)
   (unless (and riece-ruby-process
               (eq (process-status riece-ruby-process) 'run))
-    (setq riece-ruby-process
-         (start-process "riece-ruby" (generate-new-buffer " *Ruby*")
-                        riece-ruby-command
-                        (expand-file-name
-                         "rubyserv.rb"
-                         (file-name-directory
-                          (symbol-file 'riece-ruby-execute)))))
-    (set-process-filter riece-ruby-process #'riece-ruby-filter)
-    (set-process-sentinel riece-ruby-process #'riece-ruby-sentinel))
+    (let (selective-display
+         (coding-system-for-write 'binary)
+         (coding-system-for-read 'binary))
+      (setq riece-ruby-process
+           (start-process "riece-ruby" (generate-new-buffer " *Ruby*")
+                          riece-ruby-command
+                          (if (file-name-absolute-p riece-ruby-server-program)
+                              riece-ruby-server-program
+                            (expand-file-name
+                             riece-ruby-server-program
+                             (file-name-directory
+                              (symbol-file 'riece-ruby-execute))))))
+      (set-process-filter riece-ruby-process #'riece-ruby-filter)
+      (set-process-sentinel riece-ruby-process #'riece-ruby-sentinel)))
   (save-excursion
     (set-buffer (process-buffer riece-ruby-process))
+    (riece-ruby-reset-process-buffer)
+    (make-local-variable 'riece-ruby-lock)
     (setq riece-ruby-lock t)
-    (riece-ruby-send-eval name program)
+    (riece-ruby-send-eval program)
     (while riece-ruby-lock
-      (accept-process-output riece-ruby-process))))
+      (accept-process-output riece-ruby-process))
+    (if (eq (car riece-ruby-response) 'ERR)
+       (error "Couldn't execute: %S" (cdr riece-ruby-response)))
+    (cdr (assoc "name" riece-ruby-status-alist))))
 
 (defun riece-ruby-inspect (name)
   (save-excursion
     (set-buffer (process-buffer riece-ruby-process))
+    (riece-ruby-reset-process-buffer)
+    (make-local-variable 'riece-ruby-lock)
     (setq riece-ruby-lock t)
     (riece-ruby-send-poll name)
     (while (null riece-ruby-response)
       (accept-process-output riece-ruby-process))
     (list riece-ruby-response
          riece-ruby-data
-         riece-ruby-status)))
+         riece-ruby-status-alist)))
+
+(defun riece-ruby-clear (name)
+  (save-excursion
+    (set-buffer (process-buffer riece-ruby-process))
+    (riece-ruby-reset-process-buffer)
+    (make-local-variable 'riece-ruby-lock)
+    (setq riece-ruby-lock t)
+    (riece-ruby-send-exit name)
+    (while (null riece-ruby-response)
+      (accept-process-output riece-ruby-process))))
+
+(defun riece-ruby-set-exit-handler (name handler)
+  (let ((entry (assoc name riece-ruby-exit-handler-alist)))
+    (if entry
+       (setcdr entry handler)
+      (setq riece-ruby-exit-handler-alist
+           (cons (cons name handler)
+                 riece-ruby-exit-handler-alist)))
+    ;;check if the program already exited
+    (riece-ruby-inspect)))
+
+(defun riece-ruby-set-output-handler (name handler)
+  (let ((entry (assoc name riece-ruby-output-handler-alist)))
+    (if entry
+       (setcdr entry handler)
+      (setq riece-ruby-output-handler-alist
+           (cons (cons name handler)
+                 riece-ruby-output-handler-alist)))))
 
 (provide 'riece-ruby)