290fecb29695799698166b832df96cfdff673e13
[riece] / lisp / riece-ruby.el
1 ;;; riece-ruby.el --- interact with Ruby interpreter
2 ;; Copyright (C) 1998-2005 Daiki Ueno
3
4 ;; Author: Daiki Ueno <ueno@unixuser.org>
5 ;; Created: 1998-09-28
6 ;; Keywords: IRC, riece, Ruby
7
8 ;; This file is part of Riece.
9
10 ;; This program is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; This program is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;; riece-ruby.el is a library to interact with Ruby interpreter.
28 ;; It supports concurrent execution of Ruby programs in a single
29 ;; session.  For example:
30 ;; 
31 ;; (riece-ruby-execute "sleep 30"); returns immediately
32 ;; => "rubyserv0"
33 ;;
34 ;; (riece-ruby-execute "1 + 1")
35 ;; => "rubyserv1"
36 ;;
37 ;; (riece-ruby-execute "\"")
38 ;; => "rubyserv2"
39 ;;
40 ;; (riece-ruby-inspect "rubyserv0")
41 ;; => ((OK nil) nil (("running")))
42 ;;
43 ;; (riece-ruby-inspect "rubyserv1")
44 ;; => ((OK nil) "2" (("finished")))
45 ;;
46 ;; (riece-ruby-inspect "rubyserv2")
47 ;; => ((OK nil) "(eval):1: unterminated string meets end of file" (("exited")))
48
49 ;;; Code:
50
51 (require 'riece-debug)
52
53 (defgroup riece-ruby nil
54   "Interact with Ruby interpreter."
55   :group 'riece)
56
57 (defcustom riece-ruby-command "ruby"
58   "Command name for Ruby interpreter."
59   :type 'string
60   :group 'riece-ruby)
61
62 (defcustom riece-ruby-out-file (expand-file-name "riece-ruby.out"
63                                                  riece-directory)
64   "A file which records stdout of Ruby programs."
65   :type 'string
66   :group 'riece-ruby)
67
68 (defcustom riece-ruby-err-file (expand-file-name "riece-ruby.err"
69                                                  riece-directory)
70   "A file which records stderr of Ruby programs."
71   :type 'string
72   :group 'riece-ruby)
73
74 (defcustom riece-ruby-log-file (expand-file-name "riece-ruby.log"
75                                                  riece-directory)
76   "A file used to logging."
77   :type 'string
78   :group 'riece-ruby)
79
80 (defvar riece-ruby-server-program "server.rb"
81   "The server program file.  If the filename is not absolute, it is
82 assumed that the file is in the same directory of this file.")
83
84 (defvar riece-ruby-server-program-arguments (list "-o" riece-ruby-out-file
85                                                   "-e" riece-ruby-err-file
86                                                   "-l" riece-ruby-log-file)
87   "Command line arguments passed to `riece-ruby-server-program'.")
88
89 (defvar riece-ruby-process nil
90   "Process object of Ruby interpreter.")
91
92 (defvar riece-ruby-lock nil
93   "Lock for waiting server response.
94 Local to the process buffer.")
95 (defvar riece-ruby-response nil
96   "The server response.
97 Local to the process buffer.")
98 (defvar riece-ruby-data nil
99   "Data from server.
100 Local to the process buffer.")
101 (defvar riece-ruby-escaped-data nil
102   "Escaped data from server.  This variable is cleared every time
103 server response arrives.
104 Local to the process buffer.")
105 (defvar riece-ruby-status-alist nil
106   "Status from server.
107 Local to the process buffer.")
108
109 (defvar riece-ruby-output-queue-alist nil
110   "An alist mapping from program name to output data.")
111 (defvar riece-ruby-output-handler-alist nil
112   "An alist mapping from program name to output handler.
113 Output handlers are called every time \"# output\" line arrives.
114 Use `riece-ruby-set-output-handler' to set this variable.")
115 (defvar riece-ruby-exit-handler-alist nil
116   "An alist mapping from program name to exit handler.
117 Exit handlers are called once when \"# exit\" line arrives.
118 Use `riece-ruby-set-exit-handler' to set this variable.")
119 (defvar riece-ruby-property-alist nil
120   "An alist mapping from program name to the property list.
121 Use `riece-ruby-set-property' to set this variable.")
122
123 (defun riece-ruby-escape-data (data)
124   (let ((index 0))
125     (while (string-match "[%\r\n]+" data index)
126       (setq data (replace-match
127                   (mapconcat (lambda (c) (format "%%%02X" c))
128                              (match-string 0 data) "")
129                   nil nil data)
130             index (+ (match-end 0)
131                      (* (- (match-end 0) (match-beginning 0)) 2))))
132     data))
133
134 (defun riece-ruby-unescape-data (data)
135   (let ((index 0))
136     (while (string-match "%\\([0-9A-F][0-9A-F]\\)" data index)
137       (setq data (replace-match
138                   (read (concat "\"\\x" (match-string 1 data) "\""))
139                   nil nil data)
140             index (- (match-end 0) 2)))
141     data))
142
143 (defun riece-ruby-reset-process-buffer ()
144   (save-excursion
145     (set-buffer (process-buffer riece-ruby-process))
146     (buffer-disable-undo)
147     (make-local-variable 'riece-ruby-response)
148     (setq riece-ruby-response nil)
149     (make-local-variable 'riece-ruby-data)
150     (setq riece-ruby-data nil)
151     (make-local-variable 'riece-ruby-escaped-data)
152     (setq riece-ruby-escaped-data nil)
153     (make-local-variable 'riece-ruby-status-alist)
154     (setq riece-ruby-status-alist nil)))
155
156 (defun riece-ruby-send-eval (program)
157   (let* ((string (riece-ruby-escape-data program))
158          (length (- (length string) 998))
159          (index 0)
160          data)
161     (while (< index length)
162       (setq data (cons (substring string index (setq index (+ index 998)))
163                        data)))
164     (setq data (cons (substring string index) data)
165           data (nreverse data))
166     (process-send-string riece-ruby-process "EVAL\r\n")
167     (while data
168       (process-send-string riece-ruby-process
169                            (concat "D " (car data) "\r\n"))
170       (setq data (cdr data)))
171     (process-send-string riece-ruby-process "END\r\n")))
172
173 (defun riece-ruby-send-poll (name)
174   (process-send-string riece-ruby-process
175                        (concat "POLL " name "\r\n")))
176
177 (defun riece-ruby-send-exit (name)
178   (process-send-string riece-ruby-process
179                        (concat "EXIT " name "\r\n")))
180
181 (defun riece-ruby-filter (process input)
182   (save-excursion
183     (set-buffer (process-buffer process))
184     (goto-char (point-max))
185     (insert input)
186     (goto-char (point-min))
187     (beginning-of-line)
188     (while (looking-at ".*\r\n")
189       (if (looking-at "OK\\( \\(.*\\)\\)?\r")
190           (progn
191             (if riece-ruby-escaped-data
192                 (setq riece-ruby-data (mapconcat #'riece-ruby-unescape-data
193                                                  riece-ruby-escaped-data "")))
194             (setq riece-ruby-escaped-data nil
195                   riece-ruby-response (list 'OK (match-string 2))
196                   riece-ruby-lock nil))
197         (if (looking-at "ERR \\([0-9]+\\)\\( \\(.*\\)\\)?\r")
198             (progn
199               (setq riece-ruby-escaped-data nil
200                     riece-ruby-response
201                     (list 'ERR (string-to-number (match-string 1))
202                           (match-string 3))
203                     riece-ruby-lock nil))
204           (if (looking-at "D \\(.*\\)\r")
205               (setq riece-ruby-escaped-data (cons (match-string 1)
206                                                   riece-ruby-escaped-data))
207             (if (looking-at "S \\([^ ]*\\) \\(.*\\)\r")
208                 (progn
209                   (setq riece-ruby-status-alist (cons (cons (match-string 1)
210                                                             (match-string 2))
211                                                       riece-ruby-status-alist))
212                   (if (member (car (car riece-ruby-status-alist))
213                               '("finished" "exited"))
214                       (riece-ruby-run-exit-handler
215                        (cdr (car riece-ruby-status-alist)))))
216               (if (looking-at "# output \\([^ ]*\\) \\(.*\\)\r")
217                   (riece-ruby-run-output-handler (match-string 1)
218                                                  (match-string 2)
219                                                  (current-time))
220                 (if (looking-at "# exit \\(.*\\)\r")
221                     (riece-ruby-run-exit-handler (match-string 1))))))))
222       (forward-line))
223     (delete-region (point-min) (point))))
224
225 (defun riece-ruby-run-exit-handler (name)
226   (let ((entry (assoc name riece-ruby-exit-handler-alist)))
227     (when entry
228       (setq riece-ruby-exit-handler-alist
229             (delq entry riece-ruby-exit-handler-alist))
230       (riece-funcall-ignore-errors (if (symbolp (cdr entry))
231                                        (symbol-name (cdr entry))
232                                      (format "%s-exit-handler" name))
233                                    (cdr entry) (car entry))
234       (riece-ruby-clear name))))
235
236 (defun riece-ruby-run-output-handler (name output time)
237   (let ((handler-entry (assoc name riece-ruby-output-handler-alist))
238         (entry (assoc name riece-ruby-output-queue-alist)))
239     (if handler-entry
240         (riece-funcall-ignore-errors (if (symbolp (cdr handler-entry))
241                                          (symbol-name (cdr handler-entry))
242                                        (format "%s-output-handler" name))
243                                      (cdr handler-entry) name output time)
244       (if entry
245           (setcdr entry (cons output (cdr entry)))
246         (setq riece-ruby-output-queue-alist
247               (cons (list name (cons output time))
248                     riece-ruby-output-queue-alist))))))
249
250 (defun riece-ruby-sentinel (process status)
251   (kill-buffer (process-buffer process)))
252
253 (defun riece-ruby-execute (program)
254   "Schedule an execution of a Ruby PROGRAM.
255 Return a string name assigned by the server."
256   (unless (and riece-ruby-process
257                (eq (process-status riece-ruby-process) 'run))
258     (let (selective-display
259           (coding-system-for-write 'binary)
260           (coding-system-for-read 'binary)
261           process-connection-type)
262       (setq riece-ruby-process
263             (apply #'start-process "riece-ruby" (generate-new-buffer " *Ruby*")
264                    riece-ruby-command
265                    (expand-file-name riece-ruby-server-program
266                                      riece-data-directory)
267                    riece-ruby-server-program-arguments))
268       (process-kill-without-query riece-ruby-process)
269       (set-process-filter riece-ruby-process #'riece-ruby-filter)
270       (set-process-sentinel riece-ruby-process #'riece-ruby-sentinel)))
271   (save-excursion
272     (set-buffer (process-buffer riece-ruby-process))
273     (riece-ruby-reset-process-buffer)
274     (make-local-variable 'riece-ruby-lock)
275     (setq riece-ruby-lock t)
276     (riece-ruby-send-eval program)
277     (while riece-ruby-lock
278       (accept-process-output riece-ruby-process))
279     (if (eq (car riece-ruby-response) 'ERR)
280         (error "Couldn't execute: %S" (cdr riece-ruby-response)))
281     (cdr (assoc "name" riece-ruby-status-alist))))
282
283 (defun riece-ruby-inspect (name)
284   "Inspect a result of program execution distinguished by NAME.
285 Return a three element list.
286 The car is protocol response line which looks like:
287   \(ERR 103 \"Not implemented\").
288 The cadr is data from the server, that is, the result of the program.
289 The caddr is status from the server."
290   (save-excursion
291     (set-buffer (process-buffer riece-ruby-process))
292     (riece-ruby-reset-process-buffer)
293     (make-local-variable 'riece-ruby-lock)
294     (setq riece-ruby-lock t)
295     (riece-ruby-send-poll name)
296     (while riece-ruby-lock
297       (accept-process-output riece-ruby-process))
298     (list riece-ruby-response
299           riece-ruby-data
300           riece-ruby-status-alist)))
301
302 (defun riece-ruby-clear (name)
303   "Clear a result of program execution distinguished by NAME.
304 Note that riece-ruby-clear is automatically called iff an exit-handler
305 is specified.  Otherwise, it should be called explicitly."
306   (save-excursion
307     (set-buffer (process-buffer riece-ruby-process))
308     (riece-ruby-reset-process-buffer)
309     (make-local-variable 'riece-ruby-lock)
310     (setq riece-ruby-lock t)
311     (riece-ruby-send-exit name)
312     (while riece-ruby-lock
313       (accept-process-output riece-ruby-process)))
314   (let ((entry (assoc name riece-ruby-property-alist)))
315     (if entry
316         (delq entry riece-ruby-property-alist))))
317
318 (defun riece-ruby-set-exit-handler (name handler)
319   "Set an exit-handler HANDLER for the program distinguished by NAME.
320 An exit-handler is called when the program is finished or exited abnormally.
321 An exit-handler is called with an argument same as NAME.
322 Note that riece-ruby-clear is automatically called iff an exit-handler
323 is specified.  Otherwise, it should be called explicitly."
324   (let ((entry (assoc name riece-ruby-exit-handler-alist)))
325     (if handler
326         (progn
327           (if entry
328               (setcdr entry handler)
329             (setq riece-ruby-exit-handler-alist
330                   (cons (cons name handler)
331                         riece-ruby-exit-handler-alist)))
332           ;;check if the program already exited
333           (riece-ruby-inspect name))
334       (if entry
335           (setq riece-ruby-exit-handler-alist
336                 (delq entry riece-ruby-exit-handler-alist))))))
337
338 (defun riece-ruby-set-output-handler (name handler)
339   "Set an output-handler HANDLER for the program distinguished by NAME.
340 An output-handler is called when the program sends any output by using
341 `output' method in the Ruby program.
342 An output-handler is called with three argument.  The first argument
343 is the same as NAME.  The second argument is the output string.  The
344 third argument is the timestamp of the output event."
345   (let ((entry (assoc name riece-ruby-output-handler-alist))
346         queue-entry pointer)
347     (if handler
348         (progn
349           (when (setq queue-entry (assoc name riece-ruby-output-queue-alist))
350             (setq pointer (nreverse (cdr queue-entry))
351                   riece-ruby-output-queue-alist
352                   (delq queue-entry riece-ruby-output-queue-alist))
353             (while pointer
354               (riece-funcall-ignore-errors (if (symbolp handler)
355                                                (symbol-name handler)
356                                              (format "%s-output-handler" name))
357                                            handler name (car (car pointer))
358                                            (cdr (car pointer)))
359               (setq pointer (cdr pointer))))
360           (if entry
361               (setcdr entry handler)
362             (setq riece-ruby-output-handler-alist
363                   (cons (cons name handler)
364                         riece-ruby-output-handler-alist))))
365       (if entry
366           (setq riece-ruby-output-handler-alist
367                 (delq entry riece-ruby-output-handler-alist))))))
368
369 (defun riece-ruby-set-property (name property value)
370   "Set given PROPERTY/VALUE pair to the program distinguished by NAME."
371   (let ((entry (assoc name riece-ruby-property-alist))
372         property-entry)
373     (unless entry
374       (setq entry (list name)
375             riece-ruby-property-alist (cons entry riece-ruby-property-alist)))
376     (if (setq property-entry (assoc property (cdr entry)))
377         (setcdr property-entry value)
378       (setcdr entry (cons (cons property value) (cdr entry))))))
379
380 (defun riece-ruby-property (name property)
381   "Return the value of PROPERTY set to the program distinguished by NAME."
382   (cdr (assoc property (cdr (assoc name riece-ruby-property-alist)))))
383
384 (defun riece-ruby-substitute-variables (program alist)
385   "Substitute symbols in PROGRAM by looking up ALIST.
386 Return a string concatenating elements in PROGRAM."
387   (setq program (copy-sequence program))
388   (while alist
389     (let ((pointer program))
390       (while pointer
391         (setq pointer (memq (car (car alist)) program))
392         (if pointer
393             (setcar pointer (cdr (car alist))))))
394     (setq alist (cdr alist)))
395   (apply #'concat program))
396
397 (provide 'riece-ruby)
398
399 ;;; riece-ruby.el ends here