(all): Make `indicate-buffer-boundaries' display values set outside
[bpt/emacs.git] / lisp / progmodes / octave-inf.el
CommitLineData
092af6d8 1;;; octave-inf.el --- running Octave as an inferior Emacs process
081bf30e 2
034babe1
NR
3;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005
4;; Free Software Foundation, Inc.
081bf30e
RS
5
6;; Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
7;; Author: John Eaton <jwe@bevo.che.wisc.edu>
8;; Maintainer: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>
9;; Keywords: languages
10
11;; This file is part of GNU Emacs.
12
13;; GNU Emacs is free software; you can redistribute it and/or modify
14;; it under the terms of the GNU General Public License as published by
15;; the Free Software Foundation; either version 2, or (at your option)
16;; any later version.
17
18;; GNU Emacs is distributed in the hope that it will be useful,
19;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21;; GNU General Public License for more details.
22
23;; You should have received a copy of the GNU General Public License
24;; along with GNU Emacs; see the file COPYING. If not, write to the
3a35cf56
LK
25;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
26;; Boston, MA 02110-1301, USA.
081bf30e 27
e8af40ee
PJ
28;;; Commentary:
29
081bf30e
RS
30;;; Code:
31
f7bbab75 32(require 'octave-mod)
081bf30e
RS
33(require 'comint)
34
28d16ed3
AS
35(defgroup octave-inferior nil
36 "Running Octave as an inferior Emacs process."
37 :group 'octave)
081bf30e 38
28d16ed3
AS
39(defcustom inferior-octave-program "octave"
40 "*Program invoked by `inferior-octave'."
41 :type 'string
42 :group 'octave-inferior)
43
44(defcustom inferior-octave-prompt
b2fc0976 45 "\\(^octave\\(\\|.bin\\)\\(-[.0-9]+\\)?\\(:[0-9]+\\)?\\|^debug\\|^\\)>+ "
28d16ed3
AS
46 "*Regexp to match prompts for the inferior Octave process."
47 :type 'regexp
48 :group 'octave-inferior)
081bf30e 49
28d16ed3 50(defcustom inferior-octave-startup-file nil
081bf30e
RS
51 "*Name of the inferior Octave startup file.
52The contents of this file are sent to the inferior Octave process on
28d16ed3
AS
53startup."
54 :type '(choice (const :tag "None" nil)
55 file)
56 :group 'octave-inferior)
081bf30e 57
3a5a5d36 58(defcustom inferior-octave-startup-args nil
081bf30e
RS
59 "*List of command line arguments for the inferior Octave process.
60For example, for suppressing the startup message and using `traditional'
28d16ed3
AS
61mode, set this to (\"-q\" \"--traditional\")."
62 :type '(repeat string)
63 :group 'octave-inferior)
081bf30e
RS
64
65(defvar inferior-octave-mode-map nil
66 "Keymap used in Inferior Octave mode.")
67(if inferior-octave-mode-map
68 ()
69 (let ((map (copy-keymap comint-mode-map)))
70 (define-key map "\t" 'comint-dynamic-complete)
71 (define-key map "\M-?" 'comint-dynamic-list-filename-completions)
72 (define-key map "\C-c\C-l" 'inferior-octave-dynamic-list-input-ring)
73 (define-key map [menu-bar inout list-history]
74 '("List Input History" . inferior-octave-dynamic-list-input-ring))
75 (define-key map "\C-c\C-h" 'octave-help)
76 (setq inferior-octave-mode-map map)))
77
78(defvar inferior-octave-mode-syntax-table nil
79 "Syntax table in use in inferior-octave-mode buffers.")
80(if inferior-octave-mode-syntax-table
81 ()
82 (let ((table (make-syntax-table)))
83 (modify-syntax-entry ?\` "w" table)
84 (modify-syntax-entry ?\# "<" table)
85 (modify-syntax-entry ?\n ">" table)
86 (setq inferior-octave-mode-syntax-table table)))
87
28d16ed3
AS
88(defcustom inferior-octave-mode-hook nil
89 "*Hook to be run when Inferior Octave mode is started."
90 :type 'hook
91 :group 'octave-inferior)
081bf30e
RS
92
93(defvar inferior-octave-font-lock-keywords
94 (list
95 (cons inferior-octave-prompt 'font-lock-type-face))
96 ;; Could certainly do more font locking in inferior Octave ...
97 "Additional expressions to highlight in Inferior Octave mode.")
98
9d245da5
MB
99
100;;; Compatibility functions
101(if (not (fboundp 'comint-line-beginning-position))
102 ;; comint-line-beginning-position is defined in Emacs 21
103 (defun comint-line-beginning-position ()
104 "Returns the buffer position of the beginning of the line, after any prompt.
105The prompt is assumed to be any text at the beginning of the line matching
106the regular expression `comint-prompt-regexp', a buffer local variable."
107 (save-excursion (comint-bol nil) (point))))
108
109
081bf30e
RS
110(defvar inferior-octave-output-list nil)
111(defvar inferior-octave-output-string nil)
112(defvar inferior-octave-receive-in-progress nil)
113
114(defvar inferior-octave-startup-hook nil)
115
116(defvar inferior-octave-complete-impossible nil
117 "Non-nil means that `inferior-octave-complete' is impossible.")
118
119(defvar inferior-octave-dynamic-complete-functions
a1506d29 120 '(inferior-octave-complete comint-dynamic-complete-filename)
081bf30e
RS
121 "List of functions called to perform completion for inferior Octave.
122This variable is used to initialize `comint-dynamic-complete-functions'
123in the Inferior Octave buffer.")
124
125(defun inferior-octave-mode ()
126 "Major mode for interacting with an inferior Octave process.
127Runs Octave as a subprocess of Emacs, with Octave I/O through an Emacs
128buffer.
129
130Entry to this mode successively runs the hooks `comint-mode-hook' and
131`inferior-octave-mode-hook'."
132 (interactive)
cb1b44b0 133 (delay-mode-hooks (comint-mode))
081bf30e
RS
134 (setq comint-prompt-regexp inferior-octave-prompt
135 major-mode 'inferior-octave-mode
136 mode-name "Inferior Octave"
137 mode-line-process '(":%s")
138 local-abbrev-table octave-abbrev-table)
139 (use-local-map inferior-octave-mode-map)
140 (set-syntax-table inferior-octave-mode-syntax-table)
141
a1506d29 142 (make-local-variable 'comment-start)
081bf30e
RS
143 (setq comment-start octave-comment-start)
144 (make-local-variable 'comment-end)
145 (setq comment-end "")
146 (make-local-variable 'comment-column)
a1506d29 147 (setq comment-column 32)
081bf30e
RS
148 (make-local-variable 'comment-start-skip)
149 (setq comment-start-skip octave-comment-start-skip)
150
151 (make-local-variable 'font-lock-defaults)
152 (setq font-lock-defaults '(inferior-octave-font-lock-keywords nil nil))
153
154 (setq comint-input-ring-file-name
155 (or (getenv "OCTAVE_HISTFILE") "~/.octave_hist")
156 comint-input-ring-size (or (getenv "OCTAVE_HISTSIZE") 1024)
157 comint-input-filter-functions '(inferior-octave-directory-tracker)
158 comint-dynamic-complete-functions
159 inferior-octave-dynamic-complete-functions)
160 (comint-read-input-ring t)
161
9a969196 162 (run-mode-hooks 'inferior-octave-mode-hook))
081bf30e
RS
163
164;;;###autoload
165(defun inferior-octave (&optional arg)
166 "Run an inferior Octave process, I/O via `inferior-octave-buffer'.
167This buffer is put in Inferior Octave mode. See `inferior-octave-mode'.
168
169Unless ARG is non-nil, switches to this buffer.
170
171The elements of the list `inferior-octave-startup-args' are sent as
172command line arguments to the inferior Octave process on startup.
173
174Additional commands to be executed on startup can be provided either in
175the file specified by `inferior-octave-startup-file' or by the default
176startup file, `~/.emacs-octave'."
177 (interactive "P")
178 (let ((buffer inferior-octave-buffer))
179 (get-buffer-create buffer)
180 (if (comint-check-proc buffer)
181 ()
182 (save-excursion
183 (set-buffer buffer)
184 (comint-mode)
185 (inferior-octave-startup)
186 (inferior-octave-mode)))
187 (if (not arg)
188 (pop-to-buffer buffer))))
189
190;;;###autoload
191(defalias 'run-octave 'inferior-octave)
192
193(defun inferior-octave-startup ()
194 "Start an inferior Octave process."
195 (let ((proc (comint-exec-1
196 (substring inferior-octave-buffer 1 -1)
197 inferior-octave-buffer
198 inferior-octave-program
3a5a5d36
SE
199 (append (list "-i" "--no-line-editing")
200 inferior-octave-startup-args))))
081bf30e
RS
201 (set-process-filter proc 'inferior-octave-output-digest)
202 (setq comint-ptyp process-connection-type
203 inferior-octave-process proc
204 inferior-octave-output-list nil
205 inferior-octave-output-string nil
206 inferior-octave-receive-in-progress t)
207
208 ;; This may look complicated ... However, we need to make sure that
209 ;; we additional startup code only AFTER Octave is ready (otherwise,
210 ;; output may be mixed up). Hence, we need to digest the Octave
211 ;; output to see when it issues a prompt.
212 (while inferior-octave-receive-in-progress
213 (accept-process-output inferior-octave-process))
214 (goto-char (point-max))
215 (set-marker (process-mark proc) (point))
216 (insert-before-markers
217 (concat
218 (if (not (bobp)) "\f\n")
219 (if inferior-octave-output-list
220 (concat (mapconcat
221 'identity inferior-octave-output-list "\n")
222 "\n"))))
223 ;; O.k., now we are ready for the Inferior Octave startup commands.
224 (let* (commands
225 (program (file-name-nondirectory inferior-octave-program))
226 (file (or inferior-octave-startup-file
227 (concat "~/.emacs-" program))))
228 (setq commands
229 (list "page_screen_output = 0;\n"
230 (if (not (string-equal
a1506d29 231 inferior-octave-output-string ">> "))
081bf30e
RS
232 "PS1=\"\\\\s> \";\n")
233 (if (file-exists-p file)
234 (format "source (\"%s\");\n" file))))
235 (inferior-octave-send-list-and-digest commands))
236 (insert-before-markers
237 (concat
238 (if inferior-octave-output-list
239 (concat (mapconcat
240 'identity inferior-octave-output-list "\n")
241 "\n"))
242 inferior-octave-output-string))
243 ;; Next, we check whether Octave supports `completion_matches' ...
244 (inferior-octave-send-list-and-digest
245 (list "exist \"completion_matches\"\n"))
246 (setq inferior-octave-complete-impossible
247 (not (string-match "5$" (car inferior-octave-output-list))))
248
249 ;; And finally, everything is back to normal.
250 (set-process-filter proc 'inferior-octave-output-filter)
251 (run-hooks 'inferior-octave-startup-hook)))
252
253\f
254(defun inferior-octave-complete ()
255 "Perform completion on the Octave symbol preceding point.
256This is implemented using the Octave command `completion_matches' which
257is NOT available with versions of Octave prior to 2.0."
258 (interactive)
259 (let* ((end (point))
502166d2
MB
260 (command
261 (save-excursion
262 (skip-syntax-backward "w_" (comint-line-beginning-position))
263 (buffer-substring-no-properties (point) end)))
081bf30e
RS
264 (proc (get-buffer-process inferior-octave-buffer))
265 (filter (process-filter proc)))
266 (cond (inferior-octave-complete-impossible
267 (error (concat
268 "Your Octave does not have `completion_matches'. "
269 "Please upgrade to version 2.X.")))
270 ((string-equal command "")
271 (message "Cannot complete an empty string"))
272 (t
273 (inferior-octave-send-list-and-digest
274 (list (concat "completion_matches (\"" command "\");\n")))
275 ;; Sort the list
276 (setq inferior-octave-output-list
277 (sort inferior-octave-output-list 'string-lessp))
278 ;; Remove duplicates
279 (let* ((x inferior-octave-output-list)
280 (y (cdr x)))
281 (while y
282 (if (string-equal (car x) (car y))
283 (setcdr x (setq y (cdr y)))
284 (setq x y
285 y (cdr y)))))
286 ;; And let comint handle the rest
287 (comint-dynamic-simple-complete
288 command inferior-octave-output-list)))))
289
290(defun inferior-octave-dynamic-list-input-ring ()
291 "List the buffer's input history in a help buffer"
292 ;; We cannot use `comint-dynamic-list-input-ring', because it replaces
293 ;; "completion" by "history reference" ...
294 (interactive)
295 (if (or (not (ring-p comint-input-ring))
296 (ring-empty-p comint-input-ring))
297 (message "No history")
298 (let ((history nil)
299 (history-buffer " *Input History*")
300 (index (1- (ring-length comint-input-ring)))
301 (conf (current-window-configuration)))
302 ;; We have to build up a list ourselves from the ring vector.
303 (while (>= index 0)
304 (setq history (cons (ring-ref comint-input-ring index) history)
305 index (1- index)))
306 ;; Change "completion" to "history reference"
307 ;; to make the display accurate.
308 (with-output-to-temp-buffer history-buffer
309 (display-completion-list history)
310 (set-buffer history-buffer))
311 (message "Hit space to flush")
312 (let ((ch (read-event)))
313 (if (eq ch ?\ )
314 (set-window-configuration conf)
315 (setq unread-command-events (list ch)))))))
316
317(defun inferior-octave-strip-ctrl-g (string)
318 "Strip leading `^G' character.
319If STRING starts with a `^G', ring the bell and strip it."
320 (if (string-match "^\a" string)
321 (progn
322 (ding)
323 (setq string (substring string 1))))
324 string)
325
326(defun inferior-octave-output-filter (proc string)
327 "Standard output filter for the inferior Octave process.
328Ring Emacs bell if process output starts with an ASCII bell, and pass
329the rest to `comint-output-filter'."
330 (comint-output-filter proc (inferior-octave-strip-ctrl-g string)))
331
332(defun inferior-octave-output-digest (proc string)
333 "Special output filter for the inferior Octave process.
334Save all output between newlines into `inferior-octave-output-list', and
335the rest to `inferior-octave-output-string'."
336 (setq string (concat inferior-octave-output-string string))
337 (while (string-match "\n" string)
338 (setq inferior-octave-output-list
339 (append inferior-octave-output-list
340 (list (substring string 0 (match-beginning 0))))
341 string (substring string (match-end 0))))
342 (if (string-match inferior-octave-prompt string)
343 (setq inferior-octave-receive-in-progress nil))
344 (setq inferior-octave-output-string string))
345
346(defun inferior-octave-send-list-and-digest (list)
347 "Send LIST to the inferior Octave process and digest the output.
348The elements of LIST have to be strings and are sent one by one. All
349output is passed to the filter `inferior-octave-output-digest'."
350 (let* ((proc inferior-octave-process)
351 (filter (process-filter proc))
352 string)
353 (set-process-filter proc 'inferior-octave-output-digest)
354 (setq inferior-octave-output-list nil)
355 (unwind-protect
356 (while (setq string (car list))
357 (setq inferior-octave-output-string nil
358 inferior-octave-receive-in-progress t)
359 (comint-send-string proc string)
360 (while inferior-octave-receive-in-progress
361 (accept-process-output proc))
362 (setq list (cdr list)))
363 (set-process-filter proc filter))))
364
365(defun inferior-octave-directory-tracker (string)
366 "Tracks `cd' commands issued to the inferior Octave process.
367Use \\[inferior-octave-resync-dirs] to resync if Emacs gets confused."
df287ddb
SE
368 (cond
369 ((string-match "^[ \t]*cd[ \t;]*$" string)
370 (cd "~"))
371 ((string-match "^[ \t]*cd[ \t]+\\([^ \t\n;]*\\)[ \t\n;]*" string)
372 (cd (substring string (match-beginning 1) (match-end 1))))))
081bf30e
RS
373
374(defun inferior-octave-resync-dirs ()
375 "Resync the buffer's idea of the current directory.
376This command queries the inferior Octave process about its current
377directory and makes this the current buffer's default directory."
378 (interactive)
379 (inferior-octave-send-list-and-digest '("pwd\n"))
380 (cd (car inferior-octave-output-list)))
381
15c2d736
KH
382;;; provide ourself
383
384(provide 'octave-inf)
385
ab5796a9 386;;; arch-tag: bdce0395-24d1-4bb4-bfba-6fb1eeb1a660
e96a83c8 387;;; octave-inf.el ends here