X-Git-Url: https://cgit.sxemacs.org/?p=riece;a=blobdiff_plain;f=lisp%2Friece-ruby.el;h=8a3c66b4722ccd6e10043e9f5283cdb01c50dffa;hp=4759f10e3b8401727856c06f2ab4a04c0ee6d20c;hb=cb1953a1b444d106365282266ab2465a58b6fad4;hpb=c5697906fc4d3b19b752e85a23d0b7e55ac772a5

diff --git a/lisp/riece-ruby.el b/lisp/riece-ruby.el
index 4759f10..8a3c66b 100644
--- a/lisp/riece-ruby.el
+++ b/lisp/riece-ruby.el
@@ -3,7 +3,7 @@
 
 ;; Author: Daiki Ueno <ueno@unixuser.org>
 ;; Created: 1998-09-28
-;; Keywords: IRC, riece
+;; Keywords: IRC, riece, Ruby
 
 ;; This file is part of Riece.
 
@@ -24,7 +24,7 @@
 
 ;;; Commentary:
 
-;; riece-ruby.el is a library to interact with the Ruby interpreter.
+;; riece-ruby.el is a library to interact with Ruby interpreter.
 ;; It supports concurrent execution of Ruby programs in a single
 ;; session.  For example:
 ;; 
@@ -38,40 +38,85 @@
 ;; => "rubyserv2"
 ;;
 ;; (riece-ruby-inspect "rubyserv0")
-;; => ((OK nil) nil "running")
+;; => ((OK nil) nil (("running")))
 ;;
 ;; (riece-ruby-inspect "rubyserv1")
-;; => ((OK nil) "2" "finished")
+;; => ((OK nil) "2" (("finished")))
 ;;
 ;; (riece-ruby-inspect "rubyserv2")
-;; => ((OK nil) "(eval):1: unterminated string meets end of file" "exited")
+;; => ((OK nil) "(eval):1: unterminated string meets end of file" (("exited")))
 
 ;;; Code:
 
-(defvar riece-ruby-command "ruby"
-  "Command name for Ruby interpreter.")
+(require 'riece-debug)
 
-(defvar riece-ruby-server-program "server.rb")
+(defgroup riece-ruby nil
+  "Interact with Ruby interpreter."
+  :group 'riece)
 
-(defvar riece-ruby-process nil)
+(defcustom riece-ruby-command "ruby"
+  "Command name for Ruby interpreter."
+  :type 'string
+  :group 'riece-ruby)
 
-(defvar riece-ruby-lock nil)
-(defvar riece-ruby-response nil)
-(defvar riece-ruby-data nil)
-(defvar riece-ruby-escaped-data nil)
-(defvar riece-ruby-status-alist nil)
+(defcustom riece-ruby-out-file (expand-file-name "riece-ruby.out"
+						 riece-directory)
+  "A file which records stdout of Ruby programs."
+  :type 'string
+  :group 'riece-ruby)
 
-(defvar riece-ruby-output-handler-alist nil)
-(defvar riece-ruby-exit-handler-alist nil)
+(defcustom riece-ruby-err-file (expand-file-name "riece-ruby.err"
+						 riece-directory)
+  "A file which records stderr of Ruby programs."
+  :type 'string
+  :group 'riece-ruby)
 
-(defun riece-ruby-substitute-variables (program variable value)
-  (setq program (copy-sequence program))
-  (let ((pointer program))
-    (while pointer
-      (setq pointer (memq variable program))
-      (if pointer
-	  (setcar pointer value)))
-    program))
+(defcustom riece-ruby-log-file (expand-file-name "riece-ruby.log"
+						 riece-directory)
+  "A file used to logging."
+  :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-server-program-arguments (list "-o" riece-ruby-out-file
+						  "-e" riece-ruby-err-file
+						  "-l" riece-ruby-log-file)
+  "Command line arguments passed to `riece-ruby-server-program'.")
+
+(defvar riece-ruby-process nil
+  "Process object of Ruby interpreter.")
+
+(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
+  "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.")
+(defvar riece-ruby-property-alist nil
+  "An alist mapping from program name to the property list.
+Use `riece-ruby-set-property' to set this variable.")
 
 (defun riece-ruby-escape-data (data)
   (let ((index 0))
@@ -136,7 +181,7 @@
     (set-buffer (process-buffer process))
     (goto-char (point-max))
     (insert input)
-    (goto-char (process-mark process))
+    (goto-char (point-min))
     (beginning-of-line)
     (while (looking-at ".*\r\n")
       (if (looking-at "OK\\( \\(.*\\)\\)?\r")
@@ -157,7 +202,7 @@
 	  (if (looking-at "D \\(.*\\)\r")
 	      (setq riece-ruby-escaped-data (cons (match-string 1)
 						  riece-ruby-escaped-data))
-	    (if (looking-at "S \\(.*\\) \\(.*\\)\r")
+	    (if (looking-at "S \\([^ ]*\\) \\(.*\\)\r")
 		(progn
 		  (setq riece-ruby-status-alist (cons (cons (match-string 1)
 							    (match-string 2))
@@ -166,41 +211,50 @@
 			      '("finished" "exited"))
 		      (riece-ruby-run-exit-handler
 		       (cdr (car riece-ruby-status-alist)))))
-	      (if (looking-at "# output \\(.*\\) \\(.*\\)\r")
+	      (if (looking-at "# output \\([^ ]*\\) \\(.*\\)\r")
 		  (let ((entry (assoc (match-string 1)
 				      riece-ruby-output-handler-alist)))
 		    (if entry
-			(funcall (cdr entry) (match-string 2))))
+			(riece-debug-with-backtrace
+			  (funcall (cdr entry) (car entry) (match-string 2)))))
 		(if (looking-at "# exit \\(.*\\)\r")
 		    (riece-ruby-run-exit-handler (match-string 1))))))))
       (forward-line))
-    (set-marker (process-mark process) (point-marker))))
+    (delete-region (point-min) (point))))
 
 (defun riece-ruby-run-exit-handler (name)
   (let ((entry (assoc name riece-ruby-exit-handler-alist)))
     (if entry
 	(progn
-	  (funcall (cdr entry))
-	  (setq riece-ruby-exit-handler-alist (delq entry))))))
+	  (setq riece-ruby-exit-handler-alist
+		(delq entry riece-ruby-exit-handler-alist))
+	  (riece-debug-with-backtrace
+	    (funcall (cdr entry) (car entry)))
+	  (riece-ruby-clear name)))))
 
 (defun riece-ruby-sentinel (process status)
   (kill-buffer (process-buffer process)))
 
 (defun riece-ruby-execute (program)
+  "Schedule an execution of a Ruby PROGRAM.
+Return a string name assigned by the server."
   (unless (and riece-ruby-process
 	       (eq (process-status riece-ruby-process) 'run))
     (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))))))
+	    (apply #'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
+		       (locate-library
+			(symbol-file 'riece-ruby-execute)))))
+		   riece-ruby-server-program-arguments))
+      (process-kill-without-query riece-ruby-process)
       (set-process-filter riece-ruby-process #'riece-ruby-filter)
       (set-process-sentinel riece-ruby-process #'riece-ruby-sentinel)))
   (save-excursion
@@ -216,37 +270,105 @@
     (cdr (assoc "name" riece-ruby-status-alist))))
 
 (defun riece-ruby-inspect (name)
+  "Inspect a result of program execution distinguished by NAME.
+Return a three element list.
+The car is protocol response line which looks like:
+  \(ERR 103 \"Not implemented\").
+The cadr is data from the server, that is, the result of the program.
+The caddr is status from the server."
   (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)
+    (while riece-ruby-lock
       (accept-process-output riece-ruby-process))
     (list riece-ruby-response
 	  riece-ruby-data
 	  riece-ruby-status-alist)))
 
 (defun riece-ruby-clear (name)
+  "Clear a result of program execution distinguished by NAME.
+Note that riece-ruby-clear is automatically called iff an exit-handler
+is specified.  Otherwise, it should be called explicitly."
   (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))))
+    (while riece-ruby-lock
+      (accept-process-output riece-ruby-process)))
+  (let ((entry (assoc name riece-ruby-property-alist)))
+    (if entry
+	(delq entry riece-ruby-property-alist))))
 
 (defun riece-ruby-set-exit-handler (name handler)
+  "Set an exit-handler HANDLER for the program distinguished by NAME.
+An exit-handler is called when the program is finished or exited abnormally.
+An exit-handler is called with an argument same as NAME.
+Note that riece-ruby-clear is automatically called iff an exit-handler
+is specified.  Otherwise, it should be called explicitly."
   (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)))
+    (if handler
+	(progn
+	  (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 name))
+      (if entry
+	  (setq riece-ruby-exit-handler-alist
+		(delq entry riece-ruby-exit-handler-alist))))))
+
+(defun riece-ruby-set-output-handler (name handler)
+  "Set an output-handler HANDLER for the program distinguished by NAME.
+An output-handler is called when the program sends any output by using
+`output' method in the Ruby program.
+An output-handler is called with two argument.  The first argument is
+the same as NAME.  The second argument is output string."
+  (let ((entry (assoc name riece-ruby-output-handler-alist)))
+    (if handler
+	(progn
+	  (if entry
+	      (setcdr entry handler)
+	    (setq riece-ruby-output-handler-alist
+		  (cons (cons name handler)
+			riece-ruby-output-handler-alist))))
+      (if entry
+	  (setq riece-ruby-output-handler-alist
+		(delq entry riece-ruby-output-handler-alist))))))
+
+(defun riece-ruby-set-property (name property value)
+  "Set given PROPERTY/VALUE pair to the program distinguished by NAME."
+  (let ((entry (assoc name riece-ruby-property-alist))
+	property-entry)
+    (unless entry
+      (setq entry (list name)
+	    riece-ruby-property-alist (cons entry riece-ruby-property-alist)))
+    (if (setq property-entry (assoc property (cdr entry)))
+	(setcdr property-entry value)
+      (setcdr entry (cons (cons property value) (cdr entry))))))
+
+(defun riece-ruby-property (name property)
+  "Return the value of PROPERTY set to the program distinguished by NAME."
+  (cdr (assoc property (cdr (assoc name riece-ruby-property-alist)))))
+
+(defun riece-ruby-substitute-variables (program alist)
+  "Substitute symbols in PROGRAM by looking up ALIST.
+Return a string concatenating elements in PROGRAM."
+  (setq program (copy-sequence 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))
 
 (provide 'riece-ruby)