1 ;;; octave-mod.el --- editing Octave source files under Emacs
3 ;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009, 2010, 2011
4 ;; Free Software Foundation, Inc.
6 ;; Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
7 ;; Author: John Eaton <jwe@octave.org>
8 ;; Maintainer: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
11 ;; This file is part of GNU Emacs.
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 3 of the License, or
16 ;; (at your option) any later version.
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.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; This package provides Emacs support for Octave.
29 ;; It defines Octave mode, a major mode for editing
32 ;; The file octave-inf.el contains code for interacting with an inferior
33 ;; Octave process using comint.
35 ;; See the documentation of `octave-mode' and
36 ;; `run-octave' for further information on usage and customization.
42 "Major mode for editing Octave source files."
43 :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
46 (defvar inferior-octave-output-list nil)
47 (defvar inferior-octave-output-string nil)
48 (defvar inferior-octave-receive-in-progress nil)
50 (declare-function inferior-octave-send-list-and-digest "octave-inf" (list))
52 (defconst octave-maintainer-address
53 "Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>, bug-gnu-emacs@gnu.org"
54 "Current maintainer of the Emacs Octave package.")
56 (define-abbrev-table 'octave-abbrev-table
57 (mapcar (lambda (e) (append e '(nil 0 t)))
58 '(("`a" "all_va_args")
65 ("`et" "end_try_catch")
66 ("`eu" "end_unwind_protect")
68 ("`efu" "endfunction")
84 ("`up" "unwind_protect")
85 ("`upc" "unwind_protect_cleanup")
87 "Abbrev table for Octave's reserved words.
88 Used in `octave-mode' and inferior-octave-mode buffers.
89 All Octave abbrevs start with a grave accent (`)."
90 :regexp "\\(?:[^`]\\|^\\)\\(\\(?:\\<\\|`\\)\\w+\\)\\W*")
92 (defvar octave-comment-char ?#
93 "Character to start an Octave comment.")
94 (defvar octave-comment-start
95 (string octave-comment-char ?\s)
96 "String to insert to start a new Octave in-line comment.")
97 (defvar octave-comment-start-skip "\\s<+\\s-*"
98 "Regexp to match the start of an Octave comment up to its body.")
100 (defvar octave-begin-keywords
101 '("do" "for" "function" "if" "switch" "try" "unwind_protect" "while"))
102 (defvar octave-else-keywords
103 '("case" "catch" "else" "elseif" "otherwise" "unwind_protect_cleanup"))
104 (defvar octave-end-keywords
105 '("endfor" "endfunction" "endif" "endswitch" "end_try_catch"
106 "end_unwind_protect" "endwhile" "until" "end"))
108 (defvar octave-reserved-words
109 (append octave-begin-keywords
112 '("break" "continue" "end" "global" "persistent" "return"))
113 "Reserved words in Octave.")
115 (defvar octave-text-functions
116 '("casesen" "cd" "chdir" "clear" "diary" "dir" "document" "echo"
117 "edit_history" "format" "help" "history" "hold"
118 "load" "ls" "more" "run_history" "save" "type"
119 "which" "who" "whos")
120 "Text functions in Octave.")
122 (defvar octave-variables
123 '("DEFAULT_EXEC_PATH" "DEFAULT_LOADPATH"
124 "EDITOR" "EXEC_PATH" "F_DUPFD" "F_GETFD" "F_GETFL" "F_SETFD"
125 "F_SETFL" "I" "IMAGE_PATH" "Inf" "J"
126 "NaN" "OCTAVE_VERSION" "O_APPEND" "O_CREAT" "O_EXCL"
127 "O_NONBLOCK" "O_RDONLY" "O_RDWR" "O_TRUNC" "O_WRONLY" "PAGER" "PS1"
128 "PS2" "PS4" "PWD" "SEEK_CUR" "SEEK_END" "SEEK_SET" "__F_DUPFD__"
129 "__F_GETFD__" "__F_GETFL__" "__F_SETFD__" "__F_SETFL__" "__I__"
130 "__Inf__" "__J__" "__NaN__" "__OCTAVE_VERSION__" "__O_APPEND__"
131 "__O_CREAT__" "__O_EXCL__" "__O_NONBLOCK__" "__O_RDONLY__"
132 "__O_RDWR__" "__O_TRUNC__" "__O_WRONLY__" "__PWD__" "__SEEK_CUR__"
133 "__SEEK_END__" "__SEEK_SET__" "__argv__" "__e__" "__eps__"
134 "__i__" "__inf__" "__j__" "__nan__" "__pi__"
135 "__program_invocation_name__" "__program_name__" "__realmax__"
136 "__realmin__" "__stderr__" "__stdin__" "__stdout__" "ans" "argv"
137 "beep_on_error" "completion_append_char"
138 "crash_dumps_octave_core" "default_save_format"
139 "e" "echo_executing_commands" "eps"
140 "error_text" "gnuplot_binary" "history_file"
141 "history_size" "ignore_function_time_stamp"
142 "inf" "nan" "nargin" "output_max_field_width" "output_precision"
143 "page_output_immediately" "page_screen_output" "pi"
144 "print_answer_id_name" "print_empty_dimensions"
145 "program_invocation_name" "program_name"
146 "realmax" "realmin" "return_last_computed_value" "save_precision"
147 "saving_history" "sighup_dumps_octave_core" "sigterm_dumps_octave_core"
148 "silent_functions" "split_long_rows" "stderr" "stdin" "stdout"
149 "string_fill_char" "struct_levels_to_print"
150 "suppress_verbose_help_message")
151 "Builtin variables in Octave.")
153 (defvar octave-function-header-regexp
154 (concat "^\\s-*\\<\\(function\\)\\>"
155 "\\([^=;\n]*=[ \t]*\\|[ \t]*\\)\\(\\w+\\)\\>")
156 "Regexp to match an Octave function header.
157 The string `function' and its name are given by the first and third
158 parenthetical grouping.")
160 (defvar octave-font-lock-keywords
162 ;; Fontify all builtin keywords.
163 (cons (concat "\\<\\("
164 (regexp-opt (append octave-reserved-words
165 octave-text-functions))
167 'font-lock-keyword-face)
168 ;; Fontify all builtin operators.
169 (cons "\\(&\\||\\|<=\\|>=\\|==\\|<\\|>\\|!=\\|!\\)"
170 (if (boundp 'font-lock-builtin-face)
171 'font-lock-builtin-face
172 'font-lock-preprocessor-face))
173 ;; Fontify all builtin variables.
174 (cons (concat "\\<" (regexp-opt octave-variables) "\\>")
175 'font-lock-variable-name-face)
176 ;; Fontify all function declarations.
177 (list octave-function-header-regexp
178 '(1 font-lock-keyword-face)
179 '(3 font-lock-function-name-face nil t)))
180 "Additional Octave expressions to highlight.")
182 (defun octave-syntax-propertize-function (start end)
184 (octave-syntax-propertize-sqs end)
185 (funcall (syntax-propertize-rules
186 ;; Try to distinguish the string-quotes from the transpose-quotes.
188 (1 (prog1 "\"'" (octave-syntax-propertize-sqs end)))))
191 (defun octave-syntax-propertize-sqs (end)
192 "Propertize the content/end of single-quote strings."
193 (when (eq (nth 3 (syntax-ppss)) ?\')
195 (when (re-search-forward
196 "\\(?:\\=\\|[^']\\)\\(?:''\\)*\\('\\)\\($\\|[^']\\)" end 'move)
197 (goto-char (match-beginning 2))
198 (when (eq (char-before (match-beginning 1)) ?\\)
199 ;; Backslash cannot escape a single quote.
200 (put-text-property (1- (match-beginning 1)) (match-beginning 1)
201 'syntax-table (string-to-syntax ".")))
202 (put-text-property (match-beginning 1) (match-end 1)
203 'syntax-table (string-to-syntax "\"'")))))
205 (defcustom inferior-octave-buffer "*Inferior Octave*"
206 "Name of buffer for running an inferior Octave process."
208 :group 'octave-inferior)
210 (defvar inferior-octave-process nil)
212 (defvar octave-mode-map
213 (let ((map (make-sparse-keymap)))
214 (define-key map "`" 'octave-abbrev-start)
215 (define-key map "\e\n" 'octave-indent-new-comment-line)
216 (define-key map "\M-\C-q" 'octave-indent-defun)
217 (define-key map "\C-c\C-b" 'octave-submit-bug-report)
218 (define-key map "\C-c\C-p" 'octave-previous-code-line)
219 (define-key map "\C-c\C-n" 'octave-next-code-line)
220 (define-key map "\C-c\C-a" 'octave-beginning-of-line)
221 (define-key map "\C-c\C-e" 'octave-end-of-line)
222 (define-key map [remap down-list] 'smie-down-list)
223 (define-key map "\C-c\M-\C-h" 'octave-mark-block)
224 (define-key map "\C-c]" 'smie-close-block)
225 (define-key map "\C-c/" 'smie-close-block)
226 (define-key map "\C-c\C-f" 'octave-insert-defun)
227 (define-key map "\C-c\C-h" 'octave-help)
228 (define-key map "\C-c\C-il" 'octave-send-line)
229 (define-key map "\C-c\C-ib" 'octave-send-block)
230 (define-key map "\C-c\C-if" 'octave-send-defun)
231 (define-key map "\C-c\C-ir" 'octave-send-region)
232 (define-key map "\C-c\C-is" 'octave-show-process-buffer)
233 (define-key map "\C-c\C-ih" 'octave-hide-process-buffer)
234 (define-key map "\C-c\C-ik" 'octave-kill-process)
235 (define-key map "\C-c\C-i\C-l" 'octave-send-line)
236 (define-key map "\C-c\C-i\C-b" 'octave-send-block)
237 (define-key map "\C-c\C-i\C-f" 'octave-send-defun)
238 (define-key map "\C-c\C-i\C-r" 'octave-send-region)
239 (define-key map "\C-c\C-i\C-s" 'octave-show-process-buffer)
240 (define-key map "\C-c\C-i\C-h" 'octave-hide-process-buffer)
241 (define-key map "\C-c\C-i\C-k" 'octave-kill-process)
243 "Keymap used in Octave mode.")
247 (easy-menu-define octave-mode-menu octave-mode-map
248 "Menu for Octave mode."
251 ["Previous Code Line" octave-previous-code-line t]
252 ["Next Code Line" octave-next-code-line t]
253 ["Begin of Continuation" octave-beginning-of-line t]
254 ["End of Continuation" octave-end-of-line t]
255 ["Split Line at Point" octave-indent-new-comment-line t])
257 ["Mark Block" octave-mark-block t]
258 ["Close Block" smie-close-block t])
260 ["Indent Function" octave-indent-defun t]
261 ["Insert Function" octave-insert-defun t])
264 ["Send Current Line" octave-send-line t]
265 ["Send Current Block" octave-send-block t]
266 ["Send Current Function" octave-send-defun t]
267 ["Send Region" octave-send-region t]
268 ["Show Process Buffer" octave-show-process-buffer t]
269 ["Hide Process Buffer" octave-hide-process-buffer t]
270 ["Kill Process" octave-kill-process t])
272 ["Indent Line" indent-according-to-mode t]
273 ["Complete Symbol" completion-at-point t]
275 ["Toggle Abbrev Mode" abbrev-mode
276 :style toggle :selected abbrev-mode]
277 ["Toggle Auto-Fill Mode" auto-fill-mode
278 :style toggle :selected auto-fill-function]
280 ["Submit Bug Report" octave-submit-bug-report t]
282 ["Describe Octave Mode" describe-mode t]
283 ["Lookup Octave Index" info-lookup-symbol t]))
285 (defvar octave-mode-syntax-table
286 (let ((table (make-syntax-table)))
287 (modify-syntax-entry ?\r " " table)
288 (modify-syntax-entry ?+ "." table)
289 (modify-syntax-entry ?- "." table)
290 (modify-syntax-entry ?= "." table)
291 (modify-syntax-entry ?* "." table)
292 (modify-syntax-entry ?/ "." table)
293 (modify-syntax-entry ?> "." table)
294 (modify-syntax-entry ?< "." table)
295 (modify-syntax-entry ?& "." table)
296 (modify-syntax-entry ?| "." table)
297 (modify-syntax-entry ?! "." table)
298 (modify-syntax-entry ?\\ "\\" table)
299 (modify-syntax-entry ?\' "." table)
300 ;; Was "w" for abbrevs, but now that it's not necessary any more,
301 (modify-syntax-entry ?\` "." table)
302 (modify-syntax-entry ?\" "\"" table)
303 (modify-syntax-entry ?. "w" table)
304 (modify-syntax-entry ?_ "w" table)
305 ;; The "b" flag only applies to the second letter of the comstart
306 ;; and the first letter of the comend, i.e. the "4b" below is ineffective.
307 ;; If we try to put `b' on the single-line comments, we get a similar
308 ;; problem where the % and # chars appear as first chars of the 2-char
309 ;; comend, so the multi-line ender is also turned into style-b.
310 ;; So we need the new "c" comment style.
311 (modify-syntax-entry ?\% "< 13" table)
312 (modify-syntax-entry ?\# "< 13" table)
313 (modify-syntax-entry ?\{ "(} 2c" table)
314 (modify-syntax-entry ?\} "){ 4c" table)
315 (modify-syntax-entry ?\n ">" table)
317 "Syntax table in use in `octave-mode' buffers.")
319 (defcustom octave-blink-matching-block t
320 "Control the blinking of matching Octave block keywords.
321 Non-nil means show matching begin of block when inserting a space,
322 newline or semicolon after an else or end keyword."
326 (defcustom octave-block-offset 2
327 "Extra indentation applied to statements in Octave block structures."
331 (defvar octave-block-comment-start
332 (concat (make-string 2 octave-comment-char) " ")
333 "String to insert to start a new Octave comment on an empty line.")
335 (defcustom octave-continuation-offset 4
336 "Extra indentation applied to Octave continuation lines."
340 (defconst octave-continuation-marker-regexp "\\\\\\|\\.\\.\\."))
341 (defvar octave-continuation-regexp
342 (concat "[^#%\n]*\\(" octave-continuation-marker-regexp
343 "\\)\\s-*\\(\\s<.*\\)?$"))
344 (defcustom octave-continuation-string "\\"
345 "Character string used for Octave continuation lines. Normally \\."
349 (defvar octave-completion-alist nil
350 "Alist of Octave symbols for completion in Octave mode.
351 Each element looks like (VAR . VAR), where the car and cdr are the same
352 symbol (an Octave command or variable name).
353 Currently, only builtin variables can be completed.")
355 (defvar octave-mode-imenu-generic-expression
358 (list nil octave-function-header-regexp 3))
359 "Imenu expression for Octave mode. See `imenu-generic-expression'.")
361 (defcustom octave-mode-hook nil
362 "Hook to be run when Octave mode is started."
366 (defcustom octave-send-show-buffer t
367 "Non-nil means display `inferior-octave-buffer' after sending to it."
370 (defcustom octave-send-line-auto-forward t
371 "Control auto-forward after sending to the inferior Octave process.
372 Non-nil means always go to the next Octave code line after sending."
375 (defcustom octave-send-echo-input t
376 "Non-nil means echo input sent to the inferior Octave process."
385 (defconst octave-operator-table
386 '((assoc ";" "\n") (assoc ",") ; The doc claims they have equal precedence!?
387 (right "=" "+=" "-=" "*=" "/=")
388 (assoc "&&") (assoc "||") ; The doc claims they have equal precedence!?
389 (assoc "&") (assoc "|") ; The doc claims they have equal precedence!?
390 (nonassoc "<" "<=" "==" ">=" ">" "!=" "~=")
391 (nonassoc ":") ;No idea what this is.
393 (assoc "*" "/" "\\" ".\\" ".*" "./")
395 (nonassoc "++" "--" "!" "~") ;And unary "+" and "-".
396 (right "^" "**" ".^" ".**")
397 ;; It's not really an operator, but for indentation purposes it
398 ;; could be convenient to treat it as one.
401 (defconst octave-smie-bnf-table
403 ;; We can't distinguish the first element in a sequence with
404 ;; precedence grammars, so we can't distinguish the condition
405 ;; if the `if' from the subsequent body, for example.
406 ;; This has to be done later in the indentation rules.
408 ;; We need to mention at least one of the operators in this part
409 ;; of the grammar: if the BNF and the operator table have
410 ;; no overlap, SMIE can't know how they relate.
412 ("try" exp "catch" exp "end_try_catch")
413 ("try" exp "catch" exp "end")
414 ("unwind_protect" exp
415 "unwind_protect_cleanup" exp "end_unwind_protect")
416 ("unwind_protect" exp "unwind_protect_cleanup" exp "end")
419 ("do" exp "until" atom)
420 ("while" exp "endwhile")
423 ("if" exp "else" exp "endif")
424 ("if" exp "elseif" exp "else" exp "endif")
425 ("if" exp "elseif" exp "elseif" exp "else" exp "endif")
426 ("if" exp "elseif" exp "elseif" exp "else" exp "end")
427 ("switch" exp "case" exp "endswitch")
428 ("switch" exp "case" exp "otherwise" exp "endswitch")
429 ("switch" exp "case" exp "case" exp "otherwise" exp "endswitch")
430 ("switch" exp "case" exp "case" exp "otherwise" exp "end")
431 ("function" exp "endfunction")
432 ("function" exp "end"))
433 ;; (fundesc (atom "=" atom))
436 (defconst octave-smie-grammar
439 (smie-bnf->prec2 octave-smie-bnf-table
442 (smie-precs->prec2 octave-operator-table))))
444 ;; Tokenizing needs to be refined so that ";;" is treated as two
445 ;; tokens and also so as to recognize the \n separator (and
446 ;; corresponding continuation lines).
448 (defconst octave-operator-regexp
449 (regexp-opt (apply 'append (mapcar 'cdr octave-operator-table))))
451 (defun octave-smie-backward-token ()
453 (forward-comment (- (point)))
455 ((and (not (eq (char-before) ?\;)) ;Coalesce ";" and "\n".
456 (> pos (line-end-position))
457 (if (looking-back octave-continuation-marker-regexp (- (point) 3))
459 (goto-char (match-beginning 0))
460 (forward-comment (- (point)))
463 ;; Ignore it if it's within parentheses.
464 (let ((ppss (syntax-ppss)))
465 (not (and (nth 1 ppss)
466 (eq ?\( (char-after (nth 1 ppss)))))))
467 (skip-chars-forward " \t")
468 ;; Why bother distinguishing \n and ;?
470 ((and (looking-back octave-operator-regexp (- (point) 3) 'greedy)
471 ;; Don't mistake a string quote for a transpose.
472 (not (looking-back "\\s\"" (1- (point)))))
473 (goto-char (match-beginning 0))
474 (match-string-no-properties 0))
476 (smie-default-backward-token)))))
478 (defun octave-smie-forward-token ()
479 (skip-chars-forward " \t")
480 (when (looking-at (eval-when-compile
481 (concat "\\(" octave-continuation-marker-regexp
482 "\\)[ \t]*\\($\\|[%#]\\)")))
483 (goto-char (match-end 1))
486 ((and (looking-at "$\\|[%#]")
487 ;; Ignore it if it's within parentheses.
488 (prog1 (let ((ppss (syntax-ppss)))
489 (not (and (nth 1 ppss)
490 (eq ?\( (char-after (nth 1 ppss))))))
491 (forward-comment (point-max))))
492 ;; Why bother distinguishing \n and ;?
494 ((looking-at ";[ \t]*\\($\\|[%#]\\)")
495 ;; Combine the ; with the subsequent \n.
496 (goto-char (match-beginning 1))
499 ((and (looking-at octave-operator-regexp)
500 ;; Don't mistake a string quote for a transpose.
501 (not (looking-at "\\s\"")))
502 (goto-char (match-end 0))
503 (match-string-no-properties 0))
505 (smie-default-forward-token))))
507 (defun octave-smie-rules (kind token)
508 (pcase (cons kind token)
509 ;; We could set smie-indent-basic instead, but that would have two
511 ;; - changes to octave-block-offset wouldn't take effect immediately.
512 ;; - edebug wouldn't show the use of this variable.
513 (`(:elem . basic) octave-block-offset)
514 ;; Since "case" is in the same BNF rules as switch..end, SMIE by default
515 ;; aligns it with "switch".
516 (`(:before . "case") (if (not (smie-rule-sibling-p)) octave-block-offset))
518 (if (smie-rule-parent-p "function" "if" "while" "else" "elseif" "for"
519 "otherwise" "case" "try" "catch" "unwind_protect"
520 "unwind_protect_cleanup")
521 (smie-rule-parent octave-block-offset)
522 ;; For (invalid) code between switch and case.
523 ;; (if (smie-parent-p "switch") 4)
526 (defvar electric-layout-rules)
529 (define-derived-mode octave-mode prog-mode "Octave"
530 "Major mode for editing Octave code.
532 This mode makes it easier to write Octave code by helping with
533 indentation, doing some of the typing for you (with Abbrev mode) and by
534 showing keywords, comments, strings, etc. in different faces (with
535 Font Lock mode on terminals that support it).
537 Octave itself is a high-level language, primarily intended for numerical
538 computations. It provides a convenient command line interface for
539 solving linear and nonlinear problems numerically. Function definitions
540 can also be stored in files, and it can be used in a batch mode (which
541 is why you need this mode!).
543 The latest released version of Octave is always available via anonymous
544 ftp from ftp.octave.org in the directory `/pub/octave'. Complete
545 source and binaries for several popular systems are available.
547 Type \\[list-abbrevs] to display the built-in abbrevs for Octave keywords.
554 Variables you can use to customize Octave mode
555 ==============================================
557 `octave-blink-matching-block'
558 Non-nil means show matching begin of block when inserting a space,
559 newline or semicolon after an else or end keyword. Default is t.
561 `octave-block-offset'
562 Extra indentation applied to statements in block structures.
565 `octave-continuation-offset'
566 Extra indentation applied to Octave continuation lines.
569 `octave-continuation-string'
570 String used for Octave continuation lines.
571 Default is a backslash.
573 `octave-send-echo-input'
574 Non-nil means always display `inferior-octave-buffer' after sending a
575 command to the inferior Octave process.
577 `octave-send-line-auto-forward'
578 Non-nil means always go to the next unsent line of Octave code after
579 sending a line to the inferior Octave process.
581 `octave-send-echo-input'
582 Non-nil means echo input sent to the inferior Octave process.
584 Turning on Octave mode runs the hook `octave-mode-hook'.
586 To begin using this mode for all `.m' files that you edit, add the
587 following lines to your `.emacs' file:
589 (add-to-list 'auto-mode-alist '(\"\\\\.m\\\\'\" . octave-mode))
591 To automatically turn on the abbrev and auto-fill features,
592 add the following lines to your `.emacs' file as well:
594 (add-hook 'octave-mode-hook
599 To submit a problem report, enter \\[octave-submit-bug-report] from \
600 an Octave mode buffer.
601 This automatically sets up a mail buffer with version information
602 already added. You just need to add a description of the problem,
603 including a reproducible test case and send the message."
604 (setq local-abbrev-table octave-abbrev-table)
606 (smie-setup octave-smie-grammar #'octave-smie-rules
607 :forward-token #'octave-smie-forward-token
608 :backward-token #'octave-smie-backward-token)
609 (set (make-local-variable 'smie-indent-basic) 'octave-block-offset)
611 (set (make-local-variable 'smie-blink-matching-triggers)
612 (cons ?\; smie-blink-matching-triggers))
613 (unless octave-blink-matching-block
614 (remove-hook 'post-self-insert-hook #'smie-blink-matching-open 'local))
616 (set (make-local-variable 'electric-indent-chars)
617 (cons ?\; electric-indent-chars))
618 ;; IIUC matlab-mode takes the opposite approach: it makes RET insert
619 ;; a ";" at those places where it's correct (i.e. outside of parens).
620 (set (make-local-variable 'electric-layout-rules) '((?\; . after)))
622 (set (make-local-variable 'comment-start) octave-comment-start)
623 (set (make-local-variable 'comment-end) "")
624 ;; Don't set it here: it's not really a property of the language,
625 ;; just a personal preference of the author.
626 ;; (set (make-local-variable 'comment-column) 32)
627 (set (make-local-variable 'comment-start-skip) "\\s<+\\s-*")
628 (set (make-local-variable 'comment-add) 1)
630 (set (make-local-variable 'parse-sexp-ignore-comments) t)
631 (set (make-local-variable 'paragraph-start)
632 (concat "\\s-*$\\|" page-delimiter))
633 (set (make-local-variable 'paragraph-separate) paragraph-start)
634 (set (make-local-variable 'paragraph-ignore-fill-prefix) t)
635 (set (make-local-variable 'fill-paragraph-function) 'octave-fill-paragraph)
636 ;; FIXME: Why disable it?
637 ;; (set (make-local-variable 'adaptive-fill-regexp) nil)
638 ;; Again, this is not a property of the language, don't set it here.
639 ;; (set (make-local-variable 'fill-column) 72)
640 (set (make-local-variable 'normal-auto-fill-function) 'octave-auto-fill)
642 (set (make-local-variable 'font-lock-defaults)
643 '(octave-font-lock-keywords))
645 (set (make-local-variable 'syntax-propertize-function)
646 #'octave-syntax-propertize-function)
648 (set (make-local-variable 'imenu-generic-expression)
649 octave-mode-imenu-generic-expression)
650 (set (make-local-variable 'imenu-case-fold-search) nil)
652 (add-hook 'completion-at-point-functions
653 'octave-completion-at-point-function nil t)
654 (set (make-local-variable 'beginning-of-defun-function)
655 'octave-beginning-of-defun)
657 (easy-menu-add octave-mode-menu)
658 (octave-initialize-completions))
660 (defvar info-lookup-mode)
662 (defun octave-help ()
663 "Get help on Octave symbols from the Octave info files.
664 Look up symbol in the function, operator and variable indices of the info files."
665 (let ((info-lookup-mode 'octave-mode))
666 (call-interactively 'info-lookup-symbol)))
668 ;;; Miscellaneous useful functions
670 (defsubst octave-in-comment-p ()
671 "Return t if point is inside an Octave comment."
673 ;; FIXME: use syntax-ppss?
674 (nth 4 (parse-partial-sexp (line-beginning-position) (point)))))
676 (defsubst octave-in-string-p ()
677 "Return t if point is inside an Octave string."
679 ;; FIXME: use syntax-ppss?
680 (nth 3 (parse-partial-sexp (line-beginning-position) (point)))))
682 (defsubst octave-not-in-string-or-comment-p ()
683 "Return t if point is not inside an Octave string or comment."
684 ;; FIXME: Use syntax-ppss?
685 (let ((pps (parse-partial-sexp (line-beginning-position) (point))))
686 (not (or (nth 3 pps) (nth 4 pps)))))
689 (defun octave-looking-at-kw (regexp)
690 "Like `looking-at', but sets `case-fold-search' nil."
691 (let ((case-fold-search nil))
692 (looking-at regexp)))
694 (defun octave-maybe-insert-continuation-string ()
695 (if (or (octave-in-comment-p)
698 (looking-at octave-continuation-regexp)))
700 (delete-horizontal-space)
701 (insert (concat " " octave-continuation-string))))
706 (defun octave-indent-new-comment-line ()
707 "Break Octave line at point, continuing comment if within one.
708 If within code, insert `octave-continuation-string' before breaking the
709 line. If within a string, signal an error.
710 The new line is properly indented."
712 (delete-horizontal-space)
714 ((octave-in-comment-p)
715 (indent-new-comment-line))
716 ((octave-in-string-p)
717 (error "Cannot split a code line inside a string"))
719 (insert (concat " " octave-continuation-string))
720 (reindent-then-newline-and-indent))))
722 (defun octave-indent-defun ()
723 "Properly indent the Octave function which contains point."
727 (message "Indenting function...")
728 (indent-region (point) (mark) nil))
729 (message "Indenting function...done."))
733 (defun octave-next-code-line (&optional arg)
734 "Move ARG lines of Octave code forward (backward if ARG is negative).
735 Skips past all empty and comment lines. Default for ARG is 1.
737 On success, return 0. Otherwise, go as far as possible and return -1."
739 (or arg (setq arg 1))
742 (inc (if (> arg 0) 1 -1)))
743 (while (and (/= arg 0) (= n 0))
744 (setq n (forward-line inc))
746 (looking-at "\\s-*\\($\\|\\s<\\)"))
747 (setq n (forward-line inc)))
748 (setq arg (- arg inc)))
751 (defun octave-previous-code-line (&optional arg)
752 "Move ARG lines of Octave code backward (forward if ARG is negative).
753 Skips past all empty and comment lines. Default for ARG is 1.
755 On success, return 0. Otherwise, go as far as possible and return -1."
757 (or arg (setq arg 1))
758 (octave-next-code-line (- arg)))
760 (defun octave-beginning-of-line ()
761 "Move point to beginning of current Octave line.
762 If on an empty or comment line, go to the beginning of that line.
763 Otherwise, move backward to the beginning of the first Octave code line
764 which is not inside a continuation statement, i.e., which does not
765 follow a code line ending in `...' or `\\', or is inside an open
769 (if (not (looking-at "\\s-*\\($\\|\\s<\\)"))
770 (while (or (condition-case nil
776 (and (or (looking-at "\\s-*\\($\\|\\s<\\)")
778 (if (zerop (octave-previous-code-line))
779 (looking-at octave-continuation-regexp))))
780 (zerop (forward-line -1)))))))
782 (defun octave-end-of-line ()
783 "Move point to end of current Octave line.
784 If on an empty or comment line, go to the end of that line.
785 Otherwise, move forward to the end of the first Octave code line which
786 does not end in `...' or `\\' or is inside an open parenthesis list."
791 (looking-at "\\s-*\\($\\|\\s<\\)"))
793 (while (or (condition-case nil
801 (or (looking-at "\\s-*\\($\\|\\s<\\)")
802 (looking-at octave-continuation-regexp)))
803 (zerop (forward-line 1)))))
806 (defun octave-mark-block ()
807 "Put point at the beginning of this Octave block, mark at the end.
808 The block marked is the one that contains point or follows point."
810 (unless (or (looking-at "\\s(")
812 (let* ((token (funcall smie-forward-token-function))
813 (level (assoc token smie-grammar)))
814 (and level (null (cadr level))))))
815 (backward-up-list 1))
818 (defun octave-beginning-of-defun (&optional arg)
819 "Move backward to the beginning of an Octave function.
820 With positive ARG, do it that many times. Negative argument -N means
821 move forward to Nth following beginning of a function.
822 Returns t unless search stops at the beginning or end of the buffer."
823 (let* ((arg (or arg 1))
824 (inc (if (> arg 0) 1 -1))
826 (case-fold-search nil))
828 (not (and (> arg 0) (looking-at "\\<function\\>")))
829 (skip-syntax-forward "w"))
830 (while (and (/= arg 0)
832 (re-search-backward "\\<function\\>" inc)))
833 (if (octave-not-in-string-or-comment-p)
834 (setq arg (- arg inc))))
837 (and (< inc 0) (goto-char (match-beginning 0)))
842 (defun octave-auto-fill ()
843 "Perform auto-fill in Octave mode.
844 Returns nil if no feasible place to break the line could be found, and t
847 (if (or (null (setq fc (current-fill-column)))
850 (and auto-fill-inhibit-regexp
851 (octave-looking-at-kw auto-fill-inhibit-regexp))))
852 nil ; Can't do anything
853 (if (and (not (octave-in-comment-p))
854 (> (current-column) fc))
855 (setq fc (- fc (+ (length octave-continuation-string) 1))))
856 (while (and (not give-up) (> (current-column) fc))
857 (let* ((opoint (point))
860 (move-to-column (+ fc 1))
861 (skip-chars-backward "^ \t\n")
862 ;; If we're at the beginning of the line, break after
865 (re-search-forward "[ \t]" opoint t))
866 ;; If we're in a comment line, don't break after the
869 (skip-syntax-backward " <")
871 (re-search-forward "[ \t]" (line-end-position)
873 ;; If we're not in a comment line and just ahead the
874 ;; continuation string, don't break here.
875 (if (and (not (octave-in-comment-p))
879 octave-continuation-string)
882 (skip-chars-backward " \t")
886 (not (or (bolp) (eolp))))
887 (let ((prev-column (current-column)))
889 (skip-chars-backward " \t")
892 (octave-maybe-insert-continuation-string)
893 (indent-new-comment-line t))
896 (octave-maybe-insert-continuation-string)
897 (indent-new-comment-line t)))
898 (if (>= (current-column) prev-column)
903 (defun octave-fill-paragraph (&optional arg)
904 "Fill paragraph of Octave code, handling Octave comments."
905 ;; FIXME: difference with generic fill-paragraph:
906 ;; - code lines are only split, never joined.
907 ;; - \n that end comments are never removed.
908 ;; - insert continuation marker when splitting code lines.
911 (let ((end (progn (forward-paragraph) (copy-marker (point) t)))
913 (forward-paragraph -1)
914 (skip-chars-forward " \t\n")
917 (cfc (current-fill-column))
920 (while (< (point) end)
922 (indent-according-to-mode)
925 ;; First check whether we need to combine non-empty comment lines
926 (if (and (< (current-column) cfc)
927 (octave-in-comment-p)
930 (looking-at "^\\s-*\\s<+\\s-*$"))))
931 ;; This is a nonempty comment line which does not extend
932 ;; past the fill column. If it is followed by a nonempty
933 ;; comment line with the same comment prefix, try to
934 ;; combine them, and repeat this until either we reach the
935 ;; fill-column or there is nothing more to combine.
937 ;; Get the comment prefix
940 (while (and (re-search-forward "\\s<+")
941 (not (octave-in-comment-p))))
942 (setq comment-prefix (match-string 0)))
943 ;; And keep combining ...
944 (while (and (< (current-column) cfc)
956 (re-search-forward comment-prefix)
957 (delete-region (match-beginning 0) (match-end 0))
959 (move-to-column cfc))))
960 ;; We might also try to combine continued code lines> Perhaps
961 ;; some other time ...
962 (skip-chars-forward "^ \t\n")
963 (delete-horizontal-space)
964 (if (or (< (current-column) cfc)
965 (and (= (current-column) cfc) (eolp)))
967 (if (not (eolp)) (insert " "))
968 (or (octave-auto-fill)
974 (defun octave-initialize-completions ()
975 "Create an alist for Octave completions."
976 (if octave-completion-alist
978 (setq octave-completion-alist
979 (append octave-reserved-words
980 octave-text-functions
983 (defun octave-completion-at-point-function ()
984 "Find the text to complete and the corresponding table."
985 (let* ((beg (save-excursion (backward-sexp 1) (point)))
988 ;; Extend region past point, if applicable.
989 (save-excursion (goto-char beg) (forward-sexp 1)
990 (setq end (max end (point)))))
991 (list beg end octave-completion-alist)))
993 (defun octave-complete-symbol ()
994 "Perform completion on Octave symbol preceding point.
995 Compare that symbol against Octave's reserved words and builtin
998 (apply 'completion-in-region (octave-completion-at-point-function)))
1000 ;;; Electric characters && friends
1002 (defun octave-abbrev-start ()
1003 "Start entering an Octave abbreviation.
1004 If Abbrev mode is turned on, typing ` (grave accent) followed by ? or
1005 \\[help-command] lists all Octave abbrevs. Any other key combination is
1007 Note that all Octave mode abbrevs start with a grave accent."
1009 (if (not abbrev-mode)
1010 (self-insert-command 1)
1012 (insert last-command-event)
1013 (if (if (featurep 'xemacs)
1014 (or (eq (event-to-character (setq c (next-event))) ??)
1015 (eq (event-to-character c) help-char))
1016 (or (eq (setq c (read-event)) ??)
1018 (let ((abbrev-table-name-list '(octave-abbrev-table)))
1020 (setq unread-command-events (list c))))))
1022 (define-skeleton octave-insert-defun
1023 "Insert an Octave function skeleton.
1024 Prompt for the function's name, arguments and return values (to be
1025 entered without parens)."
1026 (let* ((defname (substring (buffer-name) 0 -2))
1027 (name (read-string (format "Function name (default %s): " defname)
1029 (args (read-string "Arguments: "))
1030 (vals (read-string "Return values: ")))
1033 ((string-equal vals "") vals)
1034 ((string-match "[ ,]" vals) (concat "[" vals "] = "))
1035 (t (concat vals " = ")))
1038 \n "function " > str \n \n
1039 octave-block-comment-start "usage: " str \n
1040 octave-block-comment-start \n octave-block-comment-start
1044 ;;; Communication with the inferior Octave process
1045 (defun octave-kill-process ()
1046 "Kill inferior Octave process and its buffer."
1048 (if inferior-octave-process
1050 (process-send-string inferior-octave-process "quit;\n")
1051 (accept-process-output inferior-octave-process)))
1052 (if inferior-octave-buffer
1053 (kill-buffer inferior-octave-buffer)))
1055 (defun octave-show-process-buffer ()
1056 "Make sure that `inferior-octave-buffer' is displayed."
1058 (if (get-buffer inferior-octave-buffer)
1059 (display-buffer inferior-octave-buffer)
1060 (message "No buffer named %s" inferior-octave-buffer)))
1062 (defun octave-hide-process-buffer ()
1063 "Delete all windows that display `inferior-octave-buffer'."
1065 (if (get-buffer inferior-octave-buffer)
1066 (delete-windows-on inferior-octave-buffer)
1067 (message "No buffer named %s" inferior-octave-buffer)))
1069 (defun octave-send-region (beg end)
1070 "Send current region to the inferior Octave process."
1073 (let ((proc inferior-octave-process)
1074 (string (buffer-substring-no-properties beg end))
1076 (with-current-buffer inferior-octave-buffer
1077 (setq inferior-octave-output-list nil)
1078 (while (not (string-equal string ""))
1079 (if (string-match "\n" string)
1080 (setq line (substring string 0 (match-beginning 0))
1081 string (substring string (match-end 0)))
1082 (setq line string string ""))
1083 (setq inferior-octave-receive-in-progress t)
1084 (inferior-octave-send-list-and-digest (list (concat line "\n")))
1085 (while inferior-octave-receive-in-progress
1086 (accept-process-output proc))
1087 (insert-before-markers
1088 (mapconcat 'identity
1090 (if octave-send-echo-input (list line) (list ""))
1091 (mapcar 'inferior-octave-strip-ctrl-g
1092 inferior-octave-output-list)
1093 (list inferior-octave-output-string))
1095 (if octave-send-show-buffer
1096 (display-buffer inferior-octave-buffer)))
1098 (defun octave-send-block ()
1099 "Send current Octave block to the inferior Octave process."
1103 (octave-send-region (point) (mark))))
1105 (defun octave-send-defun ()
1106 "Send current Octave function to the inferior Octave process."
1110 (octave-send-region (point) (mark))))
1112 (defun octave-send-line (&optional arg)
1113 "Send current Octave code line to the inferior Octave process.
1114 With positive prefix ARG, send that many lines.
1115 If `octave-send-line-auto-forward' is non-nil, go to the next unsent
1118 (or arg (setq arg 1))
1123 (octave-next-code-line (- arg 1))
1126 (if octave-send-line-auto-forward
1127 (octave-next-code-line 1))
1128 (octave-send-region beg end))))
1130 (defun octave-eval-print-last-sexp ()
1131 "Evaluate Octave sexp before point and print value into current buffer."
1134 (let ((standard-output (current-buffer))
1135 (print-escape-newlines nil)
1141 (inferior-octave-send-list-and-digest
1142 (list (concat (buffer-substring-no-properties (point) opoint)
1144 (mapconcat 'identity inferior-octave-output-list "\n")))
1148 (defun octave-submit-bug-report ()
1149 "Submit a bug report on the Emacs Octave package via mail."
1153 (y-or-n-p "Do you want to submit a bug report? ")
1154 (reporter-submit-bug-report
1155 octave-maintainer-address
1156 (concat "Emacs version " emacs-version)
1158 'octave-blink-matching-block
1159 'octave-block-offset
1160 'octave-comment-char
1161 'octave-continuation-offset
1162 'octave-continuation-string
1163 'octave-send-echo-input
1164 'octave-send-line-auto-forward
1165 'octave-send-show-buffer))))
1169 (provide 'octave-mod)
1171 ;;; octave-mod.el ends here