octave.el 72.8 KB
Newer Older
1
;;; octave.el --- editing octave source files under emacs  -*- lexical-binding: t; -*-
Richard M. Stallman's avatar
Richard M. Stallman committed
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 1997, 2001-2019 Free Software Foundation, Inc.
Richard M. Stallman's avatar
Richard M. Stallman committed
4

5
;; Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
Glenn Morris's avatar
Glenn Morris committed
6
;;	   John Eaton <jwe@octave.org>
7
;; Maintainer: emacs-devel@gnu.org
Richard M. Stallman's avatar
Richard M. Stallman committed
8 9 10 11
;; Keywords: languages

;; This file is part of GNU Emacs.

12
;; GNU Emacs is free software: you can redistribute it and/or modify
Richard M. Stallman's avatar
Richard M. Stallman committed
13
;; it under the terms of the GNU General Public License as published by
14 15
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Richard M. Stallman's avatar
Richard M. Stallman committed
16 17 18 19 20 21 22

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
23
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
Richard M. Stallman's avatar
Richard M. Stallman committed
24 25 26

;;; Commentary:

27
;; This package provides Emacs support for Octave.  It defines a major
28 29
;; mode for editing Octave code and contains code for interacting with
;; an inferior Octave process using comint.
30

31 32
;; See the documentation of `octave-mode' and `run-octave' for further
;; information on usage and customization.
Richard M. Stallman's avatar
Richard M. Stallman committed
33

34
;;; Code:
35
(require 'comint)
Richard M. Stallman's avatar
Richard M. Stallman committed
36

Andreas Schwab's avatar
Andreas Schwab committed
37
(defgroup octave nil
38
  "Editing Octave code."
39
  :link '(custom-manual "(octave-mode)Top")
40
  :link '(url-link "https://www.gnu.org/s/octave")
41
  :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
Andreas Schwab's avatar
Andreas Schwab committed
42 43
  :group 'languages)

44 45
(define-obsolete-function-alias 'octave-submit-bug-report
  'report-emacs-bug "24.4")
46

47
(define-abbrev-table 'octave-abbrev-table nil
48
  "Abbrev table for Octave's reserved words.
49
Used in `octave-mode' and `inferior-octave-mode' buffers.")
50 51 52

(defvar octave-comment-char ?#
  "Character to start an Octave comment.")
53

54 55
(defvar octave-comment-start (char-to-string octave-comment-char)
  "Octave-specific `comment-start' (which see).")
56

57 58
(defvar octave-comment-start-skip "\\(^\\|\\S<\\)\\(?:%!\\|\\s<+\\)\\s-*"
  "Octave-specific `comment-start-skip' (which see).")
59 60

(defvar octave-function-header-regexp
61
  (concat "^\\s-*\\_<\\(function\\)\\_>"
62
	  "\\([^=;(\n]*=[ \t]*\\|[ \t]*\\)\\(\\(?:\\w\\|\\s_\\)+\\)\\_>")
63 64 65 66 67
  "Regexp to match an Octave function header.
The string `function' and its name are given by the first and third
parenthetical grouping.")


68
(defvar octave-mode-map
Richard M. Stallman's avatar
Richard M. Stallman committed
69
  (let ((map (make-sparse-keymap)))
70 71
    (define-key map "\M-."     'octave-find-definition)
    (define-key map "\M-\C-j"  'octave-indent-new-comment-line)
Richard M. Stallman's avatar
Richard M. Stallman committed
72 73 74
    (define-key map "\C-c\C-p" 'octave-previous-code-line)
    (define-key map "\C-c\C-n" 'octave-next-code-line)
    (define-key map "\C-c\C-a" 'octave-beginning-of-line)
75
    (define-key map "\C-c\C-e" 'octave-end-of-line)
76
    (define-key map [remap down-list] 'smie-down-list)
Richard M. Stallman's avatar
Richard M. Stallman committed
77
    (define-key map "\C-c\M-\C-h" 'octave-mark-block)
Stefan Monnier's avatar
Stefan Monnier committed
78 79
    (define-key map "\C-c]" 'smie-close-block)
    (define-key map "\C-c/" 'smie-close-block)
80
    (define-key map "\C-c;" 'octave-update-function-file-comment)
81
    (define-key map "\C-hd" 'octave-help)
82
    (define-key map "\C-ha" 'octave-lookfor)
83
    (define-key map "\C-c\C-l" 'octave-source-file)
84 85 86 87
    (define-key map "\C-c\C-f" 'octave-insert-defun)
    (define-key map "\C-c\C-il" 'octave-send-line)
    (define-key map "\C-c\C-ib" 'octave-send-block)
    (define-key map "\C-c\C-if" 'octave-send-defun)
88
    (define-key map "\C-c\C-ir" 'octave-send-region)
89
    (define-key map "\C-c\C-ia" 'octave-send-buffer)
90
    (define-key map "\C-c\C-is" 'octave-show-process-buffer)
Leo Liu's avatar
Leo Liu committed
91
    (define-key map "\C-c\C-iq" 'octave-hide-process-buffer)
92 93 94 95
    (define-key map "\C-c\C-ik" 'octave-kill-process)
    (define-key map "\C-c\C-i\C-l" 'octave-send-line)
    (define-key map "\C-c\C-i\C-b" 'octave-send-block)
    (define-key map "\C-c\C-i\C-f" 'octave-send-defun)
96
    (define-key map "\C-c\C-i\C-r" 'octave-send-region)
97
    (define-key map "\C-c\C-i\C-a" 'octave-send-buffer)
98
    (define-key map "\C-c\C-i\C-s" 'octave-show-process-buffer)
99
    (define-key map "\C-c\C-i\C-q" 'octave-hide-process-buffer)
100
    (define-key map "\C-c\C-i\C-k" 'octave-kill-process)
101 102 103
    map)
  "Keymap used in Octave mode.")

Richard M. Stallman's avatar
Richard M. Stallman committed
104

105 106 107

(easy-menu-define octave-mode-menu octave-mode-map
  "Menu for Octave mode."
108
  '("Octave"
109 110 111 112 113 114 115 116 117
    ["Split Line at Point"          octave-indent-new-comment-line t]
    ["Previous Code Line"           octave-previous-code-line t]
    ["Next Code Line"               octave-next-code-line t]
    ["Begin of Line"                octave-beginning-of-line t]
    ["End of Line"                  octave-end-of-line t]
    ["Mark Block"                   octave-mark-block t]
    ["Close Block"                  smie-close-block t]
    "---"
    ["Start Octave Process"         run-octave t]
Leo Liu's avatar
Leo Liu committed
118
    ["Documentation Lookup"         info-lookup-symbol t]
119
    ["Help on Function"             octave-help t]
120
    ["Search help"                  octave-lookfor t]
121 122 123 124
    ["Find Function Definition"     octave-find-definition t]
    ["Insert Function"              octave-insert-defun t]
    ["Update Function File Comment" octave-update-function-file-comment t]
    "---"
125 126
    ["Function Syntax Hints" (eldoc-mode 'toggle)
     :style toggle :selected (bound-and-true-p eldoc-mode)
127
     :help "Display function signatures after typing `SPC' or `('"]
128 129
    ["Delimiter Matching"           show-paren-mode
     :style toggle :selected show-paren-mode
130
     :help "Highlight matched pairs such as `if ... end'"
131
     :visible (fboundp 'smie--matching-block-data)]
132 133 134 135 136 137 138
    ["Auto Fill"                    auto-fill-mode
     :style toggle :selected auto-fill-function
     :help "Automatic line breaking"]
    ["Electric Layout"              electric-layout-mode
     :style toggle :selected electric-layout-mode
     :help "Automatically insert newlines around some chars"]
    "---"
139
    ("Debug"
140 141 142 143
     ["Send Current Line"       octave-send-line t]
     ["Send Current Block"      octave-send-block t]
     ["Send Current Function"   octave-send-defun t]
     ["Send Region"             octave-send-region t]
144
     ["Send Buffer"             octave-send-buffer t]
145
     ["Source Current File"     octave-source-file t]
146 147 148 149
     ["Show Process Buffer"     octave-show-process-buffer t]
     ["Hide Process Buffer"     octave-hide-process-buffer t]
     ["Kill Process"            octave-kill-process t])
    "---"
150
    ["Octave Mode Manual"       (info "(octave-mode)Top") t]
151 152
    ["Customize Octave"         (customize-group 'octave) t]
    ["Submit Bug Report"        report-emacs-bug t]))
Richard M. Stallman's avatar
Richard M. Stallman committed
153

154
(defvar octave-mode-syntax-table
Richard M. Stallman's avatar
Richard M. Stallman committed
155 156 157 158 159 160 161 162 163 164 165 166
  (let ((table (make-syntax-table)))
    (modify-syntax-entry ?\r " "  table)
    (modify-syntax-entry ?+ "."   table)
    (modify-syntax-entry ?- "."   table)
    (modify-syntax-entry ?= "."   table)
    (modify-syntax-entry ?* "."   table)
    (modify-syntax-entry ?/ "."   table)
    (modify-syntax-entry ?> "."   table)
    (modify-syntax-entry ?< "."   table)
    (modify-syntax-entry ?& "."   table)
    (modify-syntax-entry ?| "."   table)
    (modify-syntax-entry ?! "."   table)
167
    (modify-syntax-entry ?\\ "."  table)
Richard M. Stallman's avatar
Richard M. Stallman committed
168
    (modify-syntax-entry ?\' "."  table)
169
    (modify-syntax-entry ?\` "."  table)
170
    (modify-syntax-entry ?. "."   table)
Richard M. Stallman's avatar
Richard M. Stallman committed
171
    (modify-syntax-entry ?\" "\"" table)
172
    (modify-syntax-entry ?_ "_"   table)
173
    ;; The "b" flag only applies to the second letter of the comstart
Stefan Monnier's avatar
Stefan Monnier committed
174 175 176 177
    ;; and the first letter of the comend, i.e. the "4b" below is ineffective.
    ;; If we try to put `b' on the single-line comments, we get a similar
    ;; problem where the % and # chars appear as first chars of the 2-char
    ;; comend, so the multi-line ender is also turned into style-b.
178
    ;; So we need the new "c" comment style.
179 180
    (modify-syntax-entry ?\% "< 13"  table)
    (modify-syntax-entry ?\# "< 13"  table)
181 182
    (modify-syntax-entry ?\{ "(} 2c"  table)
    (modify-syntax-entry ?\} "){ 4c"  table)
Richard M. Stallman's avatar
Richard M. Stallman committed
183
    (modify-syntax-entry ?\n ">"  table)
184 185
    table)
  "Syntax table in use in `octave-mode' buffers.")
Richard M. Stallman's avatar
Richard M. Stallman committed
186

187 188 189 190 191
(defcustom octave-font-lock-texinfo-comment t
  "Control whether to highlight the texinfo comment block."
  :type 'boolean
  :version "24.4")

Andreas Schwab's avatar
Andreas Schwab committed
192
(defcustom octave-blink-matching-block t
193
  "Control the blinking of matching Octave block keywords.
Richard M. Stallman's avatar
Richard M. Stallman committed
194
Non-nil means show matching begin of block when inserting a space,
Andreas Schwab's avatar
Andreas Schwab committed
195
newline or semicolon after an else or end keyword."
196
  :type 'boolean)
197

Andreas Schwab's avatar
Andreas Schwab committed
198
(defcustom octave-block-offset 2
199
  "Extra indentation applied to statements in Octave block structures."
200
  :type 'integer)
Richard M. Stallman's avatar
Richard M. Stallman committed
201 202 203 204 205

(defvar octave-block-comment-start
  (concat (make-string 2 octave-comment-char) " ")
  "String to insert to start a new Octave comment on an empty line.")

Andreas Schwab's avatar
Andreas Schwab committed
206
(defcustom octave-continuation-offset 4
207
  "Extra indentation applied to Octave continuation lines."
208
  :type 'integer)
209

Stefan Monnier's avatar
Stefan Monnier committed
210 211
(eval-and-compile
  (defconst octave-continuation-marker-regexp "\\\\\\|\\.\\.\\."))
212

Richard M. Stallman's avatar
Richard M. Stallman committed
213
(defvar octave-continuation-regexp
Stefan Monnier's avatar
Stefan Monnier committed
214 215
  (concat "[^#%\n]*\\(" octave-continuation-marker-regexp
          "\\)\\s-*\\(\\s<.*\\)?$"))
216 217 218 219

;; Char \ is considered a bad decision for continuing a line.
(defconst octave-continuation-string "..."
  "Character string used for Octave continuation lines.")
Richard M. Stallman's avatar
Richard M. Stallman committed
220 221 222 223 224 225 226

(defvar octave-mode-imenu-generic-expression
  (list
   ;; Functions
   (list nil octave-function-header-regexp 3))
  "Imenu expression for Octave mode.  See `imenu-generic-expression'.")

Andreas Schwab's avatar
Andreas Schwab committed
227
(defcustom octave-mode-hook nil
228
  "Hook to be run when Octave mode is started."
229
  :type 'hook)
Andreas Schwab's avatar
Andreas Schwab committed
230 231

(defcustom octave-send-show-buffer t
232
  "Non-nil means display `inferior-octave-buffer' after sending to it."
233
  :type 'boolean)
234

Andreas Schwab's avatar
Andreas Schwab committed
235
(defcustom octave-send-line-auto-forward t
236
  "Control auto-forward after sending to the inferior Octave process.
Andreas Schwab's avatar
Andreas Schwab committed
237
Non-nil means always go to the next Octave code line after sending."
238
  :type 'boolean)
239

Andreas Schwab's avatar
Andreas Schwab committed
240
(defcustom octave-send-echo-input t
241
  "Non-nil means echo input sent to the inferior Octave process."
242
  :type 'boolean)
Richard M. Stallman's avatar
Richard M. Stallman committed
243 244


Stefan Monnier's avatar
Stefan Monnier committed
245 246 247 248
;;; SMIE indentation

(require 'smie)

249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327
(let-when-compile
    ((operator-table
      ;; Use '__operators__' in Octave REPL to get a full list?
      '((assoc ";" "\n") (assoc ",") ;The doc says they have equal precedence!?
        (right "=" "+=" "-=" "*=" "/=")
        (assoc "&&") (assoc "||") ; The doc claims they have equal precedence!?
        (assoc "&") (assoc "|") ; The doc claims they have equal precedence!?
        (nonassoc "<" "<=" "==" ">=" ">" "!=" "~=")
        (nonassoc ":")                  ;No idea what this is.
        (assoc "+" "-")
        (assoc "*" "/" "\\" ".\\" ".*" "./")
        (nonassoc "'" ".'")
        (nonassoc "++" "--" "!" "~")    ;And unary "+" and "-".
        (right "^" "**" ".^" ".**")
        ;; It's not really an operator, but for indentation purposes it
        ;; could be convenient to treat it as one.
        (assoc "...")))

     (matchedrules
      ;; We can't distinguish the first element in a sequence with
      ;; precedence grammars, so we can't distinguish the condition
      ;; of the `if' from the subsequent body, for example.
      ;; This has to be done later in the indentation rules.
      '(("try" exp "catch" exp "end_try_catch")
        ("unwind_protect" exp
         "unwind_protect_cleanup" exp "end_unwind_protect")
        ("for" exp "endfor")
        ("parfor" exp "endparfor")
        ("while" exp "endwhile")
        ("if" exp "endif")
        ("if" exp "else" exp "endif")
        ("if" exp "elseif" exp "else" exp "endif")
        ("if" exp "elseif" exp "elseif" exp "else" exp "endif")
        ("switch" exp "case" exp "endswitch")
        ("switch" exp "case" exp "otherwise" exp "endswitch")
        ("switch" exp "case" exp "case" exp "otherwise" exp "endswitch")
        ("function" exp "endfunction")
        ("enumeration" exp "endenumeration")
        ("events" exp "endevents")
        ("methods" exp "endmethods")
        ("properties" exp "endproperties")
        ("classdef" exp "endclassdef")
        ))

     (bnf-table
      `((atom)
        ;; FIXME: We don't parse these declarations correctly since
        ;; SMIE *really* likes to parse "a b = 2 c" as "(a b) = (2 c)".
        ;; IOW to do it right, we'd need to change octave-smie-*ward-token
        ;; so that the spaces between vars in var-decls are lexed as
        ;; something like ",".
        ;; Doesn't seem worth the trouble/slowdown for now.
        ;; We could hack smie-rules so as to work around the bad parse,
        ;; but even that doesn't seem worth the trouble.
        (var-decls (atom "=" atom)) ;; (var-decls "," var-decls)
        (single-exp (atom "=" atom))
        (exp (exp "\n" exp)
             ;; We need to mention at least one of the operators in this part
             ;; of the grammar: if the BNF and the operator table have
             ;; no overlap, SMIE can't know how they relate.
             (exp ";" exp)
             ("do" exp "until" single-exp)
             ,@matchedrules
           ;; For every rule that ends in "endfoo", add a corresponding
           ;; rule which uses "end" instead.
           ,@(mapcar (lambda (rule) (nconc (butlast rule) '("end")))
                     matchedrules)
           ("global" var-decls) ("persistent" var-decls)
           ;; These aren't super-important, but having them here
           ;; makes it easier to extract all keywords.
           ("break") ("continue") ("return")
           ;; The following rules do not correspond to valid code AFAIK,
           ;; but they lead to a grammar that degrades more gracefully
           ;; on incomplete/incorrect code.  It also helps us in
           ;; computing octave--block-offset-keywords.
           ("try" exp "end") ("unwind_protect" exp "end")
           )
      ;; (fundesc (atom "=" atom))
      )))
328

329
(defconst octave-smie-grammar
330 331 332 333 334
  (eval-when-compile
    (smie-prec2->grammar
     (smie-merge-prec2s
      (smie-bnf->prec2 bnf-table '((assoc "\n" ";")))
      (smie-precs->prec2 operator-table)))))
Stefan Monnier's avatar
Stefan Monnier committed
335

336 337 338 339
(defconst octave-operator-regexp
  (eval-when-compile
    (regexp-opt (remove "\n" (apply #'append
                                    (mapcar #'cdr operator-table)))))))
Stefan Monnier's avatar
Stefan Monnier committed
340 341 342 343 344

;; Tokenizing needs to be refined so that ";;" is treated as two
;; tokens and also so as to recognize the \n separator (and
;; corresponding continuation lines).

345 346 347 348 349 350 351 352 353 354 355 356 357
(defun octave-smie--funcall-p ()
  "Return non-nil if we're in an expression context.  Moves point."
  (looking-at "[ \t]*("))

(defun octave-smie--end-index-p ()
  (let ((ppss (syntax-ppss)))
    (and (nth 1 ppss)
         (memq (char-after (nth 1 ppss)) '(?\( ?\[ ?\{)))))

(defun octave-smie--in-parens-p ()
  (let ((ppss (syntax-ppss)))
    (and (nth 1 ppss)
         (eq ?\( (char-after (nth 1 ppss))))))
Stefan Monnier's avatar
Stefan Monnier committed
358 359 360 361 362 363 364 365 366 367 368 369 370

(defun octave-smie-backward-token ()
  (let ((pos (point)))
    (forward-comment (- (point)))
    (cond
     ((and (not (eq (char-before) ?\;)) ;Coalesce ";" and "\n".
           (> pos (line-end-position))
           (if (looking-back octave-continuation-marker-regexp (- (point) 3))
               (progn
                 (goto-char (match-beginning 0))
                 (forward-comment (- (point)))
                 nil)
             t)
371
           (not (octave-smie--in-parens-p)))
Stefan Monnier's avatar
Stefan Monnier committed
372 373 374 375 376 377 378 379 380
      (skip-chars-forward " \t")
      ;; Why bother distinguishing \n and ;?
      ";") ;;"\n"
     ((and (looking-back octave-operator-regexp (- (point) 3) 'greedy)
           ;; Don't mistake a string quote for a transpose.
           (not (looking-back "\\s\"" (1- (point)))))
      (goto-char (match-beginning 0))
      (match-string-no-properties 0))
     (t
381 382 383 384 385 386 387 388 389
      (let ((tok (smie-default-backward-token)))
        (cond
         ((equal tok "enumeration")
          (if (save-excursion (smie-default-forward-token)
                              (octave-smie--funcall-p))
              "enumeration (function)"
            tok))
         ((equal tok "end") (if (octave-smie--end-index-p) "end (index)" tok))
         (t tok)))))))
Stefan Monnier's avatar
Stefan Monnier committed
390 391 392 393 394 395 396 397 398

(defun octave-smie-forward-token ()
  (skip-chars-forward " \t")
  (when (looking-at (eval-when-compile
                      (concat "\\(" octave-continuation-marker-regexp
                              "\\)[ \t]*\\($\\|[%#]\\)")))
    (goto-char (match-end 1))
    (forward-comment 1))
  (cond
399 400 401
   ((and (looking-at "[%#\n]")
         (not (or (save-excursion (skip-chars-backward " \t")
                                  ;; Only add implicit ; when needed.
402
                                  (or (bolp) (eq (char-before) ?\;)))
403
                  (octave-smie--in-parens-p))))
404
    (if (eolp) (forward-char 1) (forward-comment 1))
Stefan Monnier's avatar
Stefan Monnier committed
405 406
    ;; Why bother distinguishing \n and ;?
    ";") ;;"\n"
407
   ((progn (forward-comment (point-max)) nil))
Stefan Monnier's avatar
Stefan Monnier committed
408 409 410 411 412 413 414 415 416 417 418
   ((looking-at ";[ \t]*\\($\\|[%#]\\)")
    ;; Combine the ; with the subsequent \n.
    (goto-char (match-beginning 1))
    (forward-comment 1)
    ";")
   ((and (looking-at octave-operator-regexp)
         ;; Don't mistake a string quote for a transpose.
         (not (looking-at "\\s\"")))
    (goto-char (match-end 0))
    (match-string-no-properties 0))
   (t
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437
    (let ((tok (smie-default-forward-token)))
      (cond
       ((equal tok "enumeration")
        (if (octave-smie--funcall-p)
            "enumeration (function)"
          tok))
       ((equal tok "end") (if (octave-smie--end-index-p) "end (index)" tok))
       (t tok))))))

(defconst octave--block-offset-keywords
  (let* ((end-prec (nth 1 (assoc "end" octave-smie-grammar)))
         (end-matchers
          (delq nil
                (mapcar (lambda (x) (if (eq end-prec (nth 2 x)) (car x)))
                        octave-smie-grammar))))
    ;; Not sure if it would harm to keep "switch", but the previous code
    ;; excluded it, presumably because there shouldn't be any code on
    ;; the lines between "switch" and "case".
    (delete "switch" end-matchers)))
Stefan Monnier's avatar
Stefan Monnier committed
438

439 440
(defun octave-smie-rules (kind token)
  (pcase (cons kind token)
441 442 443 444
    ;; We could set smie-indent-basic instead, but that would have two
    ;; disadvantages:
    ;; - changes to octave-block-offset wouldn't take effect immediately.
    ;; - edebug wouldn't show the use of this variable.
445
    (`(:elem . basic) octave-block-offset)
446
    (`(:list-intro . ,(or "global" "persistent")) t)
447 448 449
    ;; Since "case" is in the same BNF rules as switch..end, SMIE by default
    ;; aligns it with "switch".
    (`(:before . "case") (if (not (smie-rule-sibling-p)) octave-block-offset))
450
    (`(:after . ";")
451
     (if (apply #'smie-rule-parent-p octave--block-offset-keywords)
452
         (smie-rule-parent octave-block-offset)
453
       ;; For (invalid) code between switch and case.
454
       ;; (if (smie-rule-parent-p "switch") 4)
455
       nil))))
Stefan Monnier's avatar
Stefan Monnier committed
456

457 458 459 460
(defun octave-indent-comment ()
  "A function for `smie-indent-functions' (which see)."
  (save-excursion
    (back-to-indentation)
461 462
    (cond
     ((octave-in-string-or-comment-p) nil)
463
     ((looking-at-p "\\(\\s<\\)\\1\\{2,\\}")
464
      0)
465 466
     ;; Exclude %{, %} and %!.
     ((and (looking-at-p "\\s<\\(?:[^{}!]\\|$\\)")
467
           (not (looking-at-p "\\(\\s<\\)\\1")))
468
      (comment-choose-indent)))))
469

470

471 472 473 474 475 476 477 478
(defvar octave-reserved-words
  (delq nil
        (mapcar (lambda (x)
                  (setq x (car x))
                  (and (stringp x) (string-match "\\`[[:alpha:]]" x) x))
                octave-smie-grammar))
  "Reserved words in Octave.")

479 480 481
(defvar octave-font-lock-keywords
  (list
   ;; Fontify all builtin keywords.
482
   (cons (concat "\\_<" (regexp-opt octave-reserved-words) "\\_>")
483
         'font-lock-keyword-face)
484 485
   ;; Note: 'end' also serves as the last index in an indexing expression,
   ;; and 'enumerate' is also a function.
486
   ;; Ref: http://www.mathworks.com/help/matlab/ref/end.html
487
   ;; Ref: http://www.mathworks.com/help/matlab/ref/enumeration.html
488
   (list (lambda (limit)
489 490
           (while (re-search-forward "\\_<en\\(?:d\\|umeratio\\(n\\)\\)\\_>"
                                     limit 'move)
491 492 493
             (let ((beg (match-beginning 0))
                   (end (match-end 0)))
               (unless (octave-in-string-or-comment-p)
494 495 496 497
                 (when (if (match-end 1)
                           (octave-smie--funcall-p)
                         (octave-smie--end-index-p))
                   (put-text-property beg end 'face nil)))))
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533
           nil))
   ;; Fontify all operators.
   (cons octave-operator-regexp 'font-lock-builtin-face)
   ;; Fontify all function declarations.
   (list octave-function-header-regexp
         '(1 font-lock-keyword-face)
         '(3 font-lock-function-name-face nil t)))
  "Additional Octave expressions to highlight.")

(defun octave-syntax-propertize-function (start end)
  (goto-char start)
  (octave-syntax-propertize-sqs end)
  (funcall (syntax-propertize-rules
            ("\\\\" (0 (when (eq (nth 3 (save-excursion
                                          (syntax-ppss (match-beginning 0))))
                                 ?\")
                         (string-to-syntax "\\"))))
            ;; Try to distinguish the string-quotes from the transpose-quotes.
            ("\\(?:^\\|[[({,; ]\\)\\('\\)"
             (1 (prog1 "\"'" (octave-syntax-propertize-sqs end)))))
           (point) end))

(defun octave-syntax-propertize-sqs (end)
  "Propertize the content/end of single-quote strings."
  (when (eq (nth 3 (syntax-ppss)) ?\')
    ;; A '..' string.
    (when (re-search-forward
           "\\(?:\\=\\|[^']\\)\\(?:''\\)*\\('\\)\\($\\|[^']\\)" end 'move)
      (goto-char (match-beginning 2))
      (when (eq (char-before (match-beginning 1)) ?\\)
        ;; Backslash cannot escape a single quote.
        (put-text-property (1- (match-beginning 1)) (match-beginning 1)
                           'syntax-table (string-to-syntax ".")))
      (put-text-property (match-beginning 1) (match-end 1)
                         'syntax-table (string-to-syntax "\"'")))))

534
(defvar electric-layout-rules)
535

Richard M. Stallman's avatar
Richard M. Stallman committed
536
;;;###autoload
537
(define-derived-mode octave-mode prog-mode "Octave"
Richard M. Stallman's avatar
Richard M. Stallman committed
538 539
  "Major mode for editing Octave code.

540 541 542
Octave is a high-level language, primarily intended for numerical
computations.  It provides a convenient command line interface
for solving linear and nonlinear problems numerically.  Function
543 544 545 546 547 548
definitions can also be stored in files and used in batch mode.

See Info node `(octave-mode) Using Octave Mode' for more details.

Key bindings:
\\{octave-mode-map}"
549
  :abbrev-table octave-abbrev-table
550
  :group 'octave
551

552
  (smie-setup octave-smie-grammar #'octave-smie-rules
553 554
              :forward-token  #'octave-smie-forward-token
              :backward-token #'octave-smie-backward-token)
555
  (setq-local smie-indent-basic 'octave-block-offset)
556
  (add-hook 'smie-indent-functions #'octave-indent-comment nil t)
557

558 559
  (setq-local smie-blink-matching-triggers
              (cons ?\; smie-blink-matching-triggers))
560 561
  (unless octave-blink-matching-block
    (remove-hook 'post-self-insert-hook #'smie-blink-matching-open 'local))
562

563 564
  (setq-local electric-indent-chars
              (cons ?\; electric-indent-chars))
565 566
  ;; IIUC matlab-mode takes the opposite approach: it makes RET insert
  ;; a ";" at those places where it's correct (i.e. outside of parens).
567
  (setq-local electric-layout-rules '((?\; . after)))
568

569
  (setq-local comment-use-syntax t)
570 571
  (setq-local comment-start octave-comment-start)
  (setq-local comment-end "")
572
  (setq-local comment-start-skip octave-comment-start-skip)
573 574 575 576 577 578 579
  (setq-local comment-add 1)

  (setq-local parse-sexp-ignore-comments t)
  (setq-local paragraph-start (concat "\\s-*$\\|" page-delimiter))
  (setq-local paragraph-separate paragraph-start)
  (setq-local paragraph-ignore-fill-prefix t)
  (setq-local fill-paragraph-function 'octave-fill-paragraph)
580

581 582
  (setq-local fill-nobreak-predicate
              (lambda () (eq (octave-in-string-p) ?')))
583 584
  (add-function :around (local 'comment-line-break-function)
                #'octave--indent-new-comment-line)
585

586
  (setq font-lock-defaults '(octave-font-lock-keywords))
587

588
  (setq-local syntax-propertize-function #'octave-syntax-propertize-function)
589

590 591
  (setq-local imenu-generic-expression octave-mode-imenu-generic-expression)
  (setq-local imenu-case-fold-search nil)
592

593 594
  (setq-local add-log-current-defun-function #'octave-add-log-current-defun)

595
  (add-hook 'completion-at-point-functions 'octave-completion-at-point nil t)
596
  (add-hook 'before-save-hook 'octave-sync-function-file-names nil t)
597
  (setq-local beginning-of-defun-function 'octave-beginning-of-defun)
598
  (and octave-font-lock-texinfo-comment (octave-font-lock-texinfo-comment))
599 600
  (add-function :before-until (local 'eldoc-documentation-function)
                'octave-eldoc-function)
Richard M. Stallman's avatar
Richard M. Stallman committed
601

602
  (easy-menu-add octave-mode-menu))
603 604 605 606


(defcustom inferior-octave-program "octave"
  "Program invoked by `inferior-octave'."
607
  :type 'string)
608 609 610

(defcustom inferior-octave-buffer "*Inferior Octave*"
  "Name of buffer for running an inferior Octave process."
611
  :type 'string)
612 613

(defcustom inferior-octave-prompt
614
  ;; For Octave >= 3.8, default is always 'octave', see
615
  ;; https://hg.savannah.gnu.org/hgweb/octave/rev/708173343c50
616
  "\\(?:^octave\\(?:.bin\\|.exe\\)?\\(?:-[.0-9]+\\)?\\(?::[0-9]+\\)?\\|^debug\\|^\\)>+ "
617
  "Regexp to match prompts for the inferior Octave process."
618
  :type 'regexp)
619

620
(defcustom inferior-octave-prompt-read-only comint-prompt-read-only
621
  "If non-nil, the Octave prompt is read only.
622
See `comint-prompt-read-only' for details."
623 624 625
  :type 'boolean
  :version "24.4")

626
(defcustom inferior-octave-startup-file
627 628
  (let ((n (file-name-nondirectory inferior-octave-program)))
    (locate-user-emacs-file (format "init_%s.m" n) (format ".emacs-%s" n)))
629 630 631
  "Name of the inferior Octave startup file.
The contents of this file are sent to the inferior Octave process on
startup."
632 633
  :type '(choice (const :tag "None" nil) file)
  :version "24.4")
634

635
(defcustom inferior-octave-startup-args '("-i" "--no-line-editing")
636 637
  "List of command line arguments for the inferior Octave process.
For example, for suppressing the startup message and using `traditional'
638
mode, include \"-q\" and \"--traditional\"."
639
  :type '(repeat string)
640
  :version "24.4")
641 642 643

(defcustom inferior-octave-mode-hook nil
  "Hook to be run when Inferior Octave mode is started."
644
  :type 'hook)
645

646 647 648 649 650 651
(defcustom inferior-octave-error-regexp-alist
  '(("error:\\s-*\\(.*?\\) at line \\([0-9]+\\), column \\([0-9]+\\)"
     1 2 3 2 1)
    ("warning:\\s-*\\([^:\n]+\\):.*at line \\([0-9]+\\), column \\([0-9]+\\)"
     1 2 3 1 1))
  "Value for `compilation-error-regexp-alist' in inferior octave."
652
  :version "24.4"
653
  :type '(repeat (choice (symbol :tag "Predefined symbol")
654
                         (sexp :tag "Error specification"))))
655 656 657 658 659 660 661 662 663

(defvar inferior-octave-compilation-font-lock-keywords
  '(("\\_<PASS\\_>" . compilation-info-face)
    ("\\_<FAIL\\_>" . compilation-error-face)
    ("\\_<\\(warning\\):" 1 compilation-warning-face)
    ("\\_<\\(error\\):" 1 compilation-error-face)
    ("^\\s-*!!!!!.*\\|^.*failed$" . compilation-error-face))
  "Value for `compilation-mode-font-lock-keywords' in inferior octave.")

664 665 666 667 668
(defvar inferior-octave-process nil)

(defvar inferior-octave-mode-map
  (let ((map (make-sparse-keymap)))
    (set-keymap-parent map comint-mode-map)
669
    (define-key map "\M-." 'octave-find-definition)
670
    (define-key map "\t" 'completion-at-point)
671
    (define-key map "\C-hd" 'octave-help)
672
    (define-key map "\C-ha" 'octave-lookfor)
673
    ;; Same as in `shell-mode'.
674 675 676 677 678 679 680 681 682 683
    (define-key map "\M-?" 'comint-dynamic-list-filename-completions)
    (define-key map "\C-c\C-l" 'inferior-octave-dynamic-list-input-ring)
    (define-key map [menu-bar inout list-history]
      '("List Input History" . inferior-octave-dynamic-list-input-ring))
    map)
  "Keymap used in Inferior Octave mode.")

(defvar inferior-octave-mode-syntax-table
  (let ((table (make-syntax-table octave-mode-syntax-table)))
    table)
684
  "Syntax table in use in `inferior-octave-mode' buffers.")
685 686 687 688 689 690 691 692 693 694 695

(defvar inferior-octave-font-lock-keywords
  (list
   (cons inferior-octave-prompt 'font-lock-type-face))
  ;; Could certainly do more font locking in inferior Octave ...
  "Additional expressions to highlight in Inferior Octave mode.")

(defvar inferior-octave-output-list nil)
(defvar inferior-octave-output-string nil)
(defvar inferior-octave-receive-in-progress nil)

696 697
(define-obsolete-variable-alias 'inferior-octave-startup-hook
  'inferior-octave-mode-hook "24.4")
698 699 700 701 702 703 704 705

(defvar inferior-octave-dynamic-complete-functions
  '(inferior-octave-completion-at-point comint-filename-completion)
  "List of functions called to perform completion for inferior Octave.
This variable is used to initialize `comint-dynamic-complete-functions'
in the Inferior Octave buffer.")

(defvar info-lookup-mode)
706 707
(defvar compilation-error-regexp-alist)
(defvar compilation-mode-font-lock-keywords)
708

709 710
(declare-function compilation-forget-errors "compile" ())

711
(defun inferior-octave-process-live-p ()
712
  (process-live-p inferior-octave-process))
713

714
(define-derived-mode inferior-octave-mode comint-mode "Inferior Octave"
715 716 717 718 719 720 721
  "Major mode for interacting with an inferior Octave process.

See Info node `(octave-mode) Running Octave from Within Emacs' for more
details.

Key bindings:
\\{inferior-octave-mode-map}"
722
  :abbrev-table octave-abbrev-table
723 724
  :group 'octave

725
  (setq comint-prompt-regexp inferior-octave-prompt)
726

727
  (setq-local comment-use-syntax t)
728 729 730 731
  (setq-local comment-start octave-comment-start)
  (setq-local comment-end "")
  (setq comment-column 32)
  (setq-local comment-start-skip octave-comment-start-skip)
732

733
  (setq font-lock-defaults '(inferior-octave-font-lock-keywords nil nil))
734

735
  (setq-local info-lookup-mode 'octave-mode)
736
  (setq-local eldoc-documentation-function 'octave-eldoc-function)
737

738 739 740 741
  (setq-local comint-input-ring-file-name
              (or (getenv "OCTAVE_HISTFILE") "~/.octave_hist"))
  (setq-local comint-input-ring-size
              (string-to-number (or (getenv "OCTAVE_HISTSIZE") "1024")))
742
  (comint-read-input-ring t)
743 744
  (setq-local comint-dynamic-complete-functions
              inferior-octave-dynamic-complete-functions)
745
  (setq-local comint-prompt-read-only inferior-octave-prompt-read-only)
746
  (add-hook 'comint-input-filter-functions
747
            'inferior-octave-directory-tracker nil t)
748 749 750
  ;; http://thread.gmane.org/gmane.comp.gnu.octave.general/48572
  (add-hook 'window-configuration-change-hook
            'inferior-octave-track-window-width-change nil t)
751 752 753
  (setq-local compilation-error-regexp-alist inferior-octave-error-regexp-alist)
  (setq-local compilation-mode-font-lock-keywords
              inferior-octave-compilation-font-lock-keywords)
754 755
  (compilation-shell-minor-mode 1)
  (compilation-forget-errors))
756 757 758 759 760 761 762 763 764 765 766 767 768 769 770

;;;###autoload
(defun inferior-octave (&optional arg)
  "Run an inferior Octave process, I/O via `inferior-octave-buffer'.
This buffer is put in Inferior Octave mode.  See `inferior-octave-mode'.

Unless ARG is non-nil, switches to this buffer.

The elements of the list `inferior-octave-startup-args' are sent as
command line arguments to the inferior Octave process on startup.

Additional commands to be executed on startup can be provided either in
the file specified by `inferior-octave-startup-file' or by the default
startup file, `~/.emacs-octave'."
  (interactive "P")
771
  (let ((buffer (get-buffer-create inferior-octave-buffer)))
772 773
    (unless arg
      (pop-to-buffer buffer))
774
    (unless (comint-check-proc buffer)
775
      (with-current-buffer buffer
776 777 778
        (inferior-octave-startup)
        (inferior-octave-mode)))
    buffer))
779 780 781 782 783 784 785

;;;###autoload
(defalias 'run-octave 'inferior-octave)

(defun inferior-octave-startup ()
  "Start an inferior Octave process."
  (let ((proc (comint-exec-1
786 787 788
               (substring inferior-octave-buffer 1 -1)
               inferior-octave-buffer
               inferior-octave-program
789 790 791 792 793 794 795
               (append
                inferior-octave-startup-args
                ;; --no-gui is introduced in Octave > 3.7
                (and (not (member "--no-gui" inferior-octave-startup-args))
                     (zerop (process-file inferior-octave-program
                                          nil nil nil "--no-gui" "--help"))
                     '("--no-gui"))))))
796
    (set-process-filter proc 'inferior-octave-output-digest)
797 798 799 800
    (setq inferior-octave-process proc
          inferior-octave-output-list nil
          inferior-octave-output-string nil
          inferior-octave-receive-in-progress t)
801 802 803 804 805 806

    ;; This may look complicated ... However, we need to make sure that
    ;; we additional startup code only AFTER Octave is ready (otherwise,
    ;; output may be mixed up).  Hence, we need to digest the Octave
    ;; output to see when it issues a prompt.
    (while inferior-octave-receive-in-progress
807 808 809 810 811 812 813
      (unless (inferior-octave-process-live-p)
        ;; Spit out the error messages.
        (when inferior-octave-output-list
          (princ (concat (mapconcat 'identity inferior-octave-output-list "\n")
                         "\n")
                 (process-mark inferior-octave-process)))
        (error "Process `%s' died" inferior-octave-process))
814 815 816 817 818 819 820
      (accept-process-output inferior-octave-process))
    (goto-char (point-max))
    (set-marker (process-mark proc) (point))
    (insert-before-markers
     (concat
      (if (not (bobp)) "\n")
      (if inferior-octave-output-list
821 822 823
          (concat (mapconcat
                   'identity inferior-octave-output-list "\n")
                  "\n"))))
824 825 826 827

    ;; An empty secondary prompt, as e.g. obtained by '--braindead',
    ;; means trouble.
    (inferior-octave-send-list-and-digest (list "PS2\n"))
828 829
    (when (string-match "\\(PS2\\|ans\\) = *$"
                        (car inferior-octave-output-list))
830
      (inferior-octave-send-list-and-digest (list "PS2 ('> ');\n")))
831

832
    (inferior-octave-send-list-and-digest
833
     (list "disp (getenv ('OCTAVE_SRCDIR'))\n"))
834 835 836
    (process-put proc 'octave-srcdir
                 (unless (equal (car inferior-octave-output-list) "")
                   (car inferior-octave-output-list)))
837

838 839 840 841
    ;; O.K., now we are ready for the Inferior Octave startup commands.
    (inferior-octave-send-list-and-digest
     (list "more off;\n"
           (unless (equal inferior-octave-output-string ">> ")
842
             ;; See https://hg.savannah.gnu.org/hgweb/octave/rev/708173343c50
843
             "PS1 ('octave> ');\n")
844 845
           (when (and inferior-octave-startup-file
                      (file-exists-p inferior-octave-startup-file))
846
             (format "source ('%s');\n" inferior-octave-startup-file))))
847 848 849
    (when inferior-octave-output-list
      (insert-before-markers
       (mapconcat 'identity inferior-octave-output-list "\n")))
850 851

    ;; And finally, everything is back to normal.
852
    (set-process-filter proc 'comint-output-filter)
853 854 855
    ;; Just in case, to be sure a cd in the startup file won't have
    ;; detrimental effects.
    (with-demoted-errors (inferior-octave-resync-dirs))
856 857
    ;; Generate a proper prompt, which is critical to
    ;; `comint-history-isearch-backward-regexp'.  Bug#14433.
858
    (comint-send-string proc "\n")))
859

860 861 862 863 864 865 866
(defun inferior-octave-completion-table ()
  (completion-table-with-cache
   (lambda (command)
     (inferior-octave-send-list-and-digest
      (list (format "completion_matches ('%s');\n" command)))
     (delete-consecutive-dups
      (sort inferior-octave-output-list 'string-lessp)))))
867

868 869
(defun inferior-octave-completion-at-point ()
  "Return the data to complete the Octave symbol at point."
870
  ;; https://debbugs.gnu.org/14300
871 872 873 874 875 876 877
  (unless (string-match-p "/" (or (comint--match-partial-filename) ""))
    (let ((beg (save-excursion
                 (skip-syntax-backward "w_" (comint-line-beginning-position))
                 (point)))
          (end (point)))
      (when (and beg (> end beg))
        (list beg end (completion-table-in-turn
878
                       (inferior-octave-completion-table)
879
                       'comint-completion-file-name-table))))))
880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905

(defun inferior-octave-dynamic-list-input-ring ()
  "List the buffer's input history in a help buffer."
  ;; We cannot use `comint-dynamic-list-input-ring', because it replaces
  ;; "completion" by "history reference" ...
  (interactive)
  (if (or (not (ring-p comint-input-ring))
          (ring-empty-p comint-input-ring))
      (message "No history")
    (let ((history nil)
          (history-buffer " *Input History*")
          (index (1- (ring-length comint-input-ring)))
          (conf (current-window-configuration)))
      ;; We have to build up a list ourselves from the ring vector.
      (while (>= index 0)
        (setq history (cons (ring-ref comint-input-ring index) history)
              index (1- index)))
      ;; Change "completion" to "history reference"
      ;; to make the display accurate.
      (with-output-to-temp-buffer history-buffer
        (display-completion-list history)
        (set-buffer history-buffer))
      (message "Hit space to flush")
      (let ((ch (read-event)))
        (if (eq ch ?\ )
            (set-window-configuration conf)
906
          (push ch unread-command-events))))))
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921

(defun inferior-octave-output-digest (_proc string)
  "Special output filter for the inferior Octave process.
Save all output between newlines into `inferior-octave-output-list', and
the rest to `inferior-octave-output-string'."
  (setq string (concat inferior-octave-output-string string))
  (while (string-match "\n" string)
    (setq inferior-octave-output-list
	  (append inferior-octave-output-list
		  (list (substring string 0 (match-beginning 0))))
	  string (substring string (match-end 0))))
  (if (string-match inferior-octave-prompt string)
      (setq inferior-octave-receive-in-progress nil))
  (setq inferior-octave-output-string string))

922
(defun inferior-octave-check-process ()
923
  (or (inferior-octave-process-live-p)
924 925 926
      (error (substitute-command-keys
              "No inferior octave process running. Type \\[run-octave]"))))

927 928 929 930
(defun inferior-octave-send-list-and-digest (list)
  "Send LIST to the inferior Octave process and digest the output.
The elements of LIST have to be strings and are sent one by one.  All
output is passed to the filter `inferior-octave-output-digest'."
931
  (inferior-octave-check-process)
932 933 934 935 936 937 938 939 940 941 942