lisp/progmodes/octave-mod.el

   1 ;;; octave-mod.el --- editing Octave source files under Emacs
   2
   3 ;; Copyright (C) 1997, 2001, 2002, 2003, 2004, 2005, 2006, 2007
   4 ;; Free Software Foundation, Inc.
   5
   6 ;; Author: Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>
   7 ;; Author: John Eaton <jwe@bevo.che.wisc.edu>
   8 ;; Maintainer: Kurt Hornik <Kurt.Hornik@wu-wien.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 3, 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
  25 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  26 ;; Boston, MA 02110-1301, USA.
  27
  28 ;;; Commentary:
  29
  30 ;; This package provides Emacs support for Octave.
  31 ;; It defines Octave mode, a major mode for editing
  32 ;; Octave code.
  33
  34 ;; The file octave-hlp.el provides `octave-help', a facility for looking up
  35 ;; documentation on a symbol in the Octave info files.
  36
  37 ;; The file octave-inf.el contains code for interacting with an inferior
  38 ;; Octave process using comint.
  39
  40 ;; See the documentation of `octave-mode', `octave-help' and
  41 ;; `run-octave' for further information on usage and customization.
  42
  43 ;;; Code:
  44 (require 'custom)
  45
  46 (defgroup octave nil
  47   "Major mode for editing Octave source files."
  48   :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
  49   :group 'languages)
  50
  51 (defvar inferior-octave-output-list nil)
  52 (defvar inferior-octave-output-string nil)
  53 (defvar inferior-octave-receive-in-progress nil)
  54
  55 (defconst octave-maintainer-address
  56   "Kurt Hornik <Kurt.Hornik@wu-wien.ac.at>, bug-gnu-emacs@gnu.org"
  57   "Current maintainer of the Emacs Octave package.")
  58
  59 (defvar octave-abbrev-table nil
  60   "Abbrev table for Octave's reserved words.
  61 Used in `octave-mode' and inferior-octave-mode buffers.
  62 All Octave abbrevs start with a grave accent (`).")
  63 (unless octave-abbrev-table
  64   (define-abbrev-table 'octave-abbrev-table ()))
  65
  66 (let ((abbrevs-changed abbrevs-changed))
  67   (define-abbrev octave-abbrev-table "`a" "all_va_args" nil 0 t)
  68   (define-abbrev octave-abbrev-table "`b" "break" nil 0 t)
  69   (define-abbrev octave-abbrev-table "`cs" "case" nil 0 t)
  70   (define-abbrev octave-abbrev-table "`ca" "catch" nil 0 t)
  71   (define-abbrev octave-abbrev-table "`c" "continue" nil 0 t)
  72   (define-abbrev octave-abbrev-table "`el" "else" nil 0 t)
  73   (define-abbrev octave-abbrev-table "`eli" "elseif" nil 0 t)
  74   (define-abbrev octave-abbrev-table "`et" "end_try_catch" nil 0 t)
  75   (define-abbrev octave-abbrev-table "`eu" "end_unwind_protect" nil 0 t)
  76   (define-abbrev octave-abbrev-table "`ef" "endfor" nil 0 t)
  77   (define-abbrev octave-abbrev-table "`efu" "endfunction" nil 0 t)
  78   (define-abbrev octave-abbrev-table "`ei" "endif" nil 0 t)
  79   (define-abbrev octave-abbrev-table "`es" "endswitch" nil 0 t)
  80   (define-abbrev octave-abbrev-table "`ew" "endwhile" nil 0 t)
  81   (define-abbrev octave-abbrev-table "`f" "for" nil 0 t)
  82   (define-abbrev octave-abbrev-table "`fu" "function" nil 0 t)
  83   (define-abbrev octave-abbrev-table "`gl" "global" nil 0 t)
  84   (define-abbrev octave-abbrev-table "`gp" "gplot" nil 0 t)
  85   (define-abbrev octave-abbrev-table "`gs" "gsplot" nil 0 t)
  86   (define-abbrev octave-abbrev-table "`if" "if ()" nil 0 t)
  87   (define-abbrev octave-abbrev-table "`o" "otherwise" nil 0 t)
  88   (define-abbrev octave-abbrev-table "`rp" "replot" nil 0 t)
  89   (define-abbrev octave-abbrev-table "`r" "return" nil 0 t)
  90   (define-abbrev octave-abbrev-table "`s" "switch" nil 0 t)
  91   (define-abbrev octave-abbrev-table "`t" "try" nil 0 t)
  92   (define-abbrev octave-abbrev-table "`u" "until ()" nil 0 t)
  93   (define-abbrev octave-abbrev-table "`up" "unwind_protect" nil 0 t)
  94   (define-abbrev octave-abbrev-table "`upc" "unwind_protect_cleanup" nil 0 t)
  95   (define-abbrev octave-abbrev-table "`w" "while ()" nil 0 t))
  96
  97 (defvar octave-comment-char ?#
  98   "Character to start an Octave comment.")
  99 (defvar octave-comment-start
 100   (string octave-comment-char ?\ )
 101   "String to insert to start a new Octave in-line comment.")
 102 (defvar octave-comment-start-skip "\\s<+\\s-*"
 103   "Regexp to match the start of an Octave comment up to its body.")
 104
 105 (defvar octave-begin-keywords
 106   '("do" "for" "function" "if" "switch" "try" "unwind_protect" "while"))
 107 (defvar octave-else-keywords
 108   '("case" "catch" "else" "elseif" "otherwise" "unwind_protect_cleanup"))
 109 ;; FIXME: only use specific "end" tokens here to avoid confusion when "end"
 110 ;; is used in indexing (the real fix is much more complex).
 111 (defvar octave-end-keywords
 112   '("endfor" "endfunction" "endif" "endswitch" "end_try_catch"
 113     "end_unwind_protect" "endwhile" "until"))
 114
 115 (defvar octave-reserved-words
 116   (append octave-begin-keywords
 117           octave-else-keywords
 118           octave-end-keywords
 119           '("break" "continue" "end" "global" "persistent" "return"))
 120   "Reserved words in Octave.")
 121
 122 (defvar octave-text-functions
 123   '("casesen" "cd" "chdir" "clear" "diary" "dir" "document" "echo"
 124     "edit_history" "format" "help" "history" "hold"
 125     "load" "ls" "more" "run_history" "save" "type"
 126     "which" "who" "whos")
 127   "Text functions in Octave.")
 128
 129 (defvar octave-variables
 130   '("DEFAULT_EXEC_PATH" "DEFAULT_LOADPATH"
 131     "EDITOR" "EXEC_PATH" "F_DUPFD" "F_GETFD" "F_GETFL" "F_SETFD"
 132     "F_SETFL" "I" "IMAGE_PATH" "Inf" "J"
 133     "NaN" "OCTAVE_VERSION" "O_APPEND" "O_CREAT" "O_EXCL"
 134     "O_NONBLOCK" "O_RDONLY" "O_RDWR" "O_TRUNC" "O_WRONLY" "PAGER" "PS1"
 135     "PS2" "PS4" "PWD" "SEEK_CUR" "SEEK_END" "SEEK_SET" "__F_DUPFD__"
 136     "__F_GETFD__" "__F_GETFL__" "__F_SETFD__" "__F_SETFL__" "__I__"
 137     "__Inf__" "__J__" "__NaN__" "__OCTAVE_VERSION__" "__O_APPEND__"
 138     "__O_CREAT__" "__O_EXCL__" "__O_NONBLOCK__" "__O_RDONLY__"
 139     "__O_RDWR__" "__O_TRUNC__" "__O_WRONLY__" "__PWD__" "__SEEK_CUR__"
 140     "__SEEK_END__" "__SEEK_SET__" "__argv__" "__e__" "__eps__"
 141     "__i__" "__inf__" "__j__" "__nan__" "__pi__"
 142     "__program_invocation_name__" "__program_name__" "__realmax__"
 143     "__realmin__" "__stderr__" "__stdin__" "__stdout__" "ans" "argv"
 144     "beep_on_error" "completion_append_char"
 145     "crash_dumps_octave_core" "default_save_format"
 146     "e" "echo_executing_commands" "eps"
 147     "error_text" "gnuplot_binary" "history_file"
 148     "history_size" "ignore_function_time_stamp"
 149     "inf" "nan" "nargin" "output_max_field_width" "output_precision"
 150     "page_output_immediately" "page_screen_output" "pi"
 151     "print_answer_id_name" "print_empty_dimensions"
 152     "program_invocation_name" "program_name"
 153     "realmax" "realmin" "return_last_computed_value" "save_precision"
 154     "saving_history" "sighup_dumps_octave_core" "sigterm_dumps_octave_core"
 155     "silent_functions" "split_long_rows" "stderr" "stdin" "stdout"
 156     "string_fill_char" "struct_levels_to_print"
 157     "suppress_verbose_help_message")
 158   "Builtin variables in Octave.")
 159
 160 (defvar octave-function-header-regexp
 161   (concat "^\\s-*\\<\\(function\\)\\>"
 162           "\\([^=;\n]*=[ \t]*\\|[ \t]*\\)\\(\\w+\\)\\>")
 163   "Regexp to match an Octave function header.
 164 The string `function' and its name are given by the first and third
 165 parenthetical grouping.")
 166
 167 (defvar octave-font-lock-keywords
 168   (list
 169    ;; Fontify all builtin keywords.
 170    (cons (concat "\\<\\("
 171                  (mapconcat 'identity octave-reserved-words "\\|")
 172                  (mapconcat 'identity octave-text-functions "\\|")
 173                  "\\)\\>")
 174          'font-lock-keyword-face)
 175    ;; Fontify all builtin operators.
 176    (cons "\\(&\\||\\|<=\\|>=\\|==\\|<\\|>\\|!=\\|!\\)"
 177          (if (boundp 'font-lock-builtin-face)
 178              'font-lock-builtin-face
 179            'font-lock-preprocessor-face))
 180    ;; Fontify all builtin variables.
 181    (cons (concat "\\<\\("
 182                  (mapconcat 'identity octave-variables "\\|")
 183                  "\\)\\>")
 184          'font-lock-variable-name-face)
 185    ;; Fontify all function declarations.
 186    (list octave-function-header-regexp
 187          '(1 font-lock-keyword-face)
 188          '(3 font-lock-function-name-face nil t)))
 189   "Additional Octave expressions to highlight.")
 190
 191 (defcustom inferior-octave-buffer "*Inferior Octave*"
 192   "Name of buffer for running an inferior Octave process."
 193   :type 'string
 194   :group 'octave-inferior)
 195
 196 (defvar inferior-octave-process nil)
 197 \f
 198 (defvar octave-mode-map
 199   (let ((map (make-sparse-keymap)))
 200     (define-key map "`" 'octave-abbrev-start)
 201     (define-key map ";" 'octave-electric-semi)
 202     (define-key map " " 'octave-electric-space)
 203     (define-key map "\n" 'octave-reindent-then-newline-and-indent)
 204     (define-key map "\e;" 'octave-indent-for-comment)
 205     (define-key map "\e\n" 'octave-indent-new-comment-line)
 206     (define-key map "\e\t" 'octave-complete-symbol)
 207     (define-key map "\M-\C-a" 'octave-beginning-of-defun)
 208     (define-key map "\M-\C-e" 'octave-end-of-defun)
 209     (define-key map "\M-\C-h" 'octave-mark-defun)
 210     (define-key map "\M-\C-q" 'octave-indent-defun)
 211     (define-key map "\C-c;" 'octave-comment-region)
 212     (define-key map "\C-c:" 'octave-uncomment-region)
 213     (define-key map "\C-c\C-b" 'octave-submit-bug-report)
 214     (define-key map "\C-c\C-p" 'octave-previous-code-line)
 215     (define-key map "\C-c\C-n" 'octave-next-code-line)
 216     (define-key map "\C-c\C-a" 'octave-beginning-of-line)
 217     (define-key map "\C-c\C-e" 'octave-end-of-line)
 218     (define-key map "\C-c\M-\C-n" 'octave-forward-block)
 219     (define-key map "\C-c\M-\C-p" 'octave-backward-block)
 220     (define-key map "\C-c\M-\C-u" 'octave-backward-up-block)
 221     (define-key map "\C-c\M-\C-d" 'octave-down-block)
 222     (define-key map "\C-c\M-\C-h" 'octave-mark-block)
 223     (define-key map "\C-c]" 'octave-close-block)
 224     (define-key map "\C-c\C-f" 'octave-insert-defun)
 225     (define-key map "\C-c\C-h" 'octave-help)
 226     (define-key map "\C-c\C-il" 'octave-send-line)
 227     (define-key map "\C-c\C-ib" 'octave-send-block)
 228     (define-key map "\C-c\C-if" 'octave-send-defun)
 229     (define-key map "\C-c\C-ir" 'octave-send-region)
 230     (define-key map "\C-c\C-is" 'octave-show-process-buffer)
 231     (define-key map "\C-c\C-ih" 'octave-hide-process-buffer)
 232     (define-key map "\C-c\C-ik" 'octave-kill-process)
 233     (define-key map "\C-c\C-i\C-l" 'octave-send-line)
 234     (define-key map "\C-c\C-i\C-b" 'octave-send-block)
 235     (define-key map "\C-c\C-i\C-f" 'octave-send-defun)
 236     (define-key map "\C-c\C-i\C-r" 'octave-send-region)
 237     (define-key map "\C-c\C-i\C-s" 'octave-show-process-buffer)
 238     (define-key map "\C-c\C-i\C-h" 'octave-hide-process-buffer)
 239     (define-key map "\C-c\C-i\C-k" 'octave-kill-process)
 240     map)
 241   "Keymap used in Octave mode.")
 242
 243
 244 (defvar octave-mode-menu
 245   '("Octave"
 246     '("Lines"
 247       ["Previous Code Line"     octave-previous-code-line t]
 248       ["Next Code Line"         octave-next-code-line t]
 249       ["Begin of Continuation"  octave-beginning-of-line t]
 250       ["End of Continuation"    octave-end-of-line t]
 251       ["Split Line at Point"    octave-indent-new-comment-line t])
 252     '("Blocks"
 253       ["Next Block"             octave-forward-block t]
 254       ["Previous Block"         octave-backward-block t]
 255       ["Down Block"             octave-down-block t]
 256       ["Up Block"               octave-backward-up-block t]
 257       ["Mark Block"             octave-mark-block t]
 258       ["Close Block"            octave-close-block t])
 259     '("Functions"
 260       ["Begin of Function"      octave-beginning-of-defun t]
 261       ["End of Function"        octave-end-of-defun t]
 262       ["Mark Function"          octave-mark-defun t]
 263       ["Indent Function"        octave-indent-defun t]
 264       ["Insert Function"        octave-insert-defun t])
 265     "-"
 266     '("Debug"
 267       ["Send Current Line"      octave-send-line t]
 268       ["Send Current Block"     octave-send-block t]
 269       ["Send Current Function"  octave-send-defun t]
 270       ["Send Region"            octave-send-region t]
 271       ["Show Process Buffer"    octave-show-process-buffer t]
 272       ["Hide Process Buffer"    octave-hide-process-buffer t]
 273       ["Kill Process"           octave-kill-process t])
 274     "-"
 275     ["Indent Line"              indent-according-to-mode t]
 276     ["Complete Symbol"          octave-complete-symbol t]
 277     "-"
 278     ["Toggle Abbrev Mode"       abbrev-mode t]
 279     ["Toggle Auto-Fill Mode"    auto-fill-mode t]
 280     "-"
 281     ["Submit Bug Report"        octave-submit-bug-report t]
 282     "-"
 283     ["Describe Octave Mode"     octave-describe-major-mode t]
 284     ["Lookup Octave Index"      octave-help t])
 285   "Menu for Octave mode.")
 286
 287 (defvar octave-mode-syntax-table
 288   (let ((table (make-syntax-table)))
 289     (modify-syntax-entry ?\r " "  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     (modify-syntax-entry ?\\ "\\" table)
 301     (modify-syntax-entry ?\' "."  table)
 302     (modify-syntax-entry ?\` "w"  table)
 303     (modify-syntax-entry ?\" "\"" table)
 304     (modify-syntax-entry ?. "w"   table)
 305     (modify-syntax-entry ?_ "w"   table)
 306     (modify-syntax-entry ?\% "<"  table)
 307     (modify-syntax-entry ?\# "<"  table)
 308     (modify-syntax-entry ?\n ">"  table)
 309     table)
 310   "Syntax table in use in `octave-mode' buffers.")
 311
 312 (defcustom octave-auto-indent nil
 313   "Non-nil means indent line after a semicolon or space in Octave mode."
 314   :type 'boolean
 315   :group 'octave)
 316
 317 (defcustom octave-auto-newline nil
 318   "Non-nil means automatically newline after a semicolon in Octave mode."
 319   :type 'boolean
 320   :group 'octave)
 321
 322 (defcustom octave-blink-matching-block t
 323   "Control the blinking of matching Octave block keywords.
 324 Non-nil means show matching begin of block when inserting a space,
 325 newline or semicolon after an else or end keyword."
 326   :type 'boolean
 327   :group 'octave)
 328 (defcustom octave-block-offset 2
 329   "Extra indentation applied to statements in Octave block structures."
 330   :type 'integer
 331   :group 'octave)
 332
 333 (defvar octave-block-begin-regexp
 334   (concat "\\<\\("
 335           (mapconcat 'identity octave-begin-keywords "\\|")
 336           "\\)\\>"))
 337 (defvar octave-block-else-regexp
 338   (concat "\\<\\("
 339           (mapconcat 'identity octave-else-keywords "\\|")
 340           "\\)\\>"))
 341 (defvar octave-block-end-regexp
 342   (concat "\\<\\("
 343           (mapconcat 'identity octave-end-keywords "\\|")
 344           "\\)\\>"))
 345 (defvar octave-block-begin-or-end-regexp
 346   (concat octave-block-begin-regexp "\\|" octave-block-end-regexp))
 347 (defvar octave-block-else-or-end-regexp
 348   (concat octave-block-else-regexp "\\|" octave-block-end-regexp))
 349 ;; FIXME: only use specific "end" tokens here to avoid confusion when "end"
 350 ;; is used in indexing (the real fix is much more complex).
 351 (defvar octave-block-match-alist
 352   '(("do" . ("until"))
 353     ("for" . ("endfor"))
 354     ("function" . ("endfunction"))
 355     ("if" . ("else" "elseif" "endif"))
 356     ("switch" . ("case" "otherwise" "endswitch"))
 357     ("try" . ("catch" "end_try_catch"))
 358     ("unwind_protect" . ("unwind_protect_cleanup" "end_unwind_protect"))
 359     ("while" . ("endwhile")))
 360   "Alist with Octave's matching block keywords.
 361 Has Octave's begin keywords as keys and a list of the matching else or
 362 end keywords as associated values.")
 363
 364 (defvar octave-block-comment-start
 365   (concat (make-string 2 octave-comment-char) " ")
 366   "String to insert to start a new Octave comment on an empty line.")
 367
 368 (defcustom octave-continuation-offset 4
 369   "Extra indentation applied to Octave continuation lines."
 370   :type 'integer
 371   :group 'octave)
 372 (defvar octave-continuation-regexp
 373   "[^#%\n]*\\(\\\\\\|\\.\\.\\.\\)\\s-*\\(\\s<.*\\)?$")
 374 (defcustom octave-continuation-string "\\"
 375   "Character string used for Octave continuation lines.  Normally \\."
 376   :type 'string
 377   :group 'octave)
 378
 379 (defvar octave-completion-alist nil
 380   "Alist of Octave symbols for completion in Octave mode.
 381 Each element looks like (VAR . VAR), where the car and cdr are the same
 382 symbol (an Octave command or variable name).
 383 Currently, only builtin variables can be completed.")
 384
 385 (defvar octave-mode-imenu-generic-expression
 386   (list
 387    ;; Functions
 388    (list nil octave-function-header-regexp 3))
 389   "Imenu expression for Octave mode.  See `imenu-generic-expression'.")
 390
 391 (defcustom octave-mode-hook nil
 392   "Hook to be run when Octave mode is started."
 393   :type 'hook
 394   :group 'octave)
 395
 396 (defcustom octave-send-show-buffer t
 397   "Non-nil means display `inferior-octave-buffer' after sending to it."
 398   :type 'boolean
 399   :group 'octave)
 400 (defcustom octave-send-line-auto-forward t
 401   "Control auto-forward after sending to the inferior Octave process.
 402 Non-nil means always go to the next Octave code line after sending."
 403   :type 'boolean
 404   :group 'octave)
 405 (defcustom octave-send-echo-input t
 406   "Non-nil means echo input sent to the inferior Octave process."
 407   :type 'boolean
 408   :group 'octave)
 409
 410 \f
 411 ;;;###autoload
 412 (defun octave-mode ()
 413   "Major mode for editing Octave code.
 414
 415 This mode makes it easier to write Octave code by helping with
 416 indentation, doing some of the typing for you (with Abbrev mode) and by
 417 showing keywords, comments, strings, etc.. in different faces (with
 418 Font Lock mode on terminals that support it).
 419
 420 Octave itself is a high-level language, primarily intended for numerical
 421 computations.  It provides a convenient command line interface for
 422 solving linear and nonlinear problems numerically.  Function definitions
 423 can also be stored in files, and it can be used in a batch mode (which
 424 is why you need this mode!).
 425
 426 The latest released version of Octave is always available via anonymous
 427 ftp from ftp.octave.org in the directory `/pub/octave'.  Complete
 428 source and binaries for several popular systems are available.
 429
 430 Type \\[list-abbrevs] to display the built-in abbrevs for Octave keywords.
 431
 432 Keybindings
 433 ===========
 434
 435 \\{octave-mode-map}
 436
 437 Variables you can use to customize Octave mode
 438 ==============================================
 439
 440 `octave-auto-indent'
 441   Non-nil means indent current line after a semicolon or space.
 442   Default is nil.
 443
 444 `octave-auto-newline'
 445   Non-nil means auto-insert a newline and indent after a semicolon.
 446   Default is nil.
 447
 448 `octave-blink-matching-block'
 449   Non-nil means show matching begin of block when inserting a space,
 450   newline or semicolon after an else or end keyword.  Default is t.
 451
 452 `octave-block-offset'
 453   Extra indentation applied to statements in block structures.
 454   Default is 2.
 455
 456 `octave-continuation-offset'
 457   Extra indentation applied to Octave continuation lines.
 458   Default is 4.
 459
 460 `octave-continuation-string'
 461   String used for Octave continuation lines.
 462   Default is a backslash.
 463
 464 `octave-send-echo-input'
 465   Non-nil means always display `inferior-octave-buffer' after sending a
 466   command to the inferior Octave process.
 467
 468 `octave-send-line-auto-forward'
 469   Non-nil means always go to the next unsent line of Octave code after
 470   sending a line to the inferior Octave process.
 471
 472 `octave-send-echo-input'
 473   Non-nil means echo input sent to the inferior Octave process.
 474
 475 Turning on Octave mode runs the hook `octave-mode-hook'.
 476
 477 To begin using this mode for all `.m' files that you edit, add the
 478 following lines to your `.emacs' file:
 479
 480   (add-to-list 'auto-mode-alist '(\"\\\\.m\\\\'\" . octave-mode))
 481
 482 To automatically turn on the abbrev and auto-fill features,
 483 add the following lines to your `.emacs' file as well:
 484
 485   (add-hook 'octave-mode-hook
 486             (lambda ()
 487               (abbrev-mode 1)
 488               (auto-fill-mode 1)))
 489
 490 To submit a problem report, enter \\[octave-submit-bug-report] from \
 491 an Octave mode buffer.
 492 This automatically sets up a mail buffer with version information
 493 already added.  You just need to add a description of the problem,
 494 including a reproducible test case and send the message."
 495   (interactive)
 496   (kill-all-local-variables)
 497
 498   (use-local-map octave-mode-map)
 499   (setq major-mode 'octave-mode)
 500   (setq mode-name "Octave")
 501   (setq local-abbrev-table octave-abbrev-table)
 502   (set-syntax-table octave-mode-syntax-table)
 503
 504   (make-local-variable 'indent-line-function)
 505   (setq indent-line-function 'octave-indent-line)
 506
 507   (make-local-variable 'comment-start)
 508   (setq comment-start octave-comment-start)
 509   (make-local-variable 'comment-end)
 510   (setq comment-end "")
 511   (make-local-variable 'comment-column)
 512   (setq comment-column 32)
 513   (make-local-variable 'comment-start-skip)
 514   (setq comment-start-skip "\\s<+\\s-*")
 515   (make-local-variable 'comment-indent-function)
 516   (setq comment-indent-function 'octave-comment-indent)
 517
 518   (make-local-variable 'parse-sexp-ignore-comments)
 519   (setq parse-sexp-ignore-comments t)
 520   (make-local-variable 'paragraph-start)
 521   (setq paragraph-start (concat "\\s-*$\\|" page-delimiter))
 522   (make-local-variable 'paragraph-separate)
 523   (setq paragraph-separate paragraph-start)
 524   (make-local-variable 'paragraph-ignore-fill-prefix)
 525   (setq paragraph-ignore-fill-prefix t)
 526   (make-local-variable 'fill-paragraph-function)
 527   (setq fill-paragraph-function 'octave-fill-paragraph)
 528   (make-local-variable 'adaptive-fill-regexp)
 529   (setq adaptive-fill-regexp nil)
 530   (make-local-variable 'fill-column)
 531   (setq fill-column 72)
 532   (make-local-variable 'normal-auto-fill-function)
 533   (setq normal-auto-fill-function 'octave-auto-fill)
 534
 535   (make-local-variable 'font-lock-defaults)
 536   (setq font-lock-defaults '(octave-font-lock-keywords nil nil))
 537
 538   (make-local-variable 'imenu-generic-expression)
 539   (setq imenu-generic-expression octave-mode-imenu-generic-expression
 540         imenu-case-fold-search nil)
 541
 542   (octave-add-octave-menu)
 543   (octave-initialize-completions)
 544   (run-mode-hooks 'octave-mode-hook))
 545 \f
 546 ;;; Miscellaneous useful functions
 547 (defun octave-describe-major-mode ()
 548   "Describe the current major mode."
 549   (interactive)
 550   (describe-function major-mode))
 551
 552 (defsubst octave-in-comment-p ()
 553   "Return t if point is inside an Octave comment."
 554   (interactive)
 555   (save-excursion
 556     (nth 4 (parse-partial-sexp (line-beginning-position) (point)))))
 557
 558 (defsubst octave-in-string-p ()
 559   "Return t if point is inside an Octave string."
 560   (interactive)
 561   (save-excursion
 562     (nth 3 (parse-partial-sexp (line-beginning-position) (point)))))
 563
 564 (defsubst octave-not-in-string-or-comment-p ()
 565   "Return t if point is not inside an Octave string or comment."
 566   (let ((pps (parse-partial-sexp (line-beginning-position) (point))))
 567     (not (or (nth 3 pps) (nth 4 pps)))))
 568
 569 (defun octave-in-block-p ()
 570   "Return t if point is inside an Octave block.
 571 The block is taken to start at the first letter of the begin keyword and
 572 to end after the end keyword."
 573   (let ((pos (point)))
 574     (save-excursion
 575       (condition-case nil
 576           (progn
 577             (skip-syntax-forward "w")
 578             (octave-up-block -1)
 579             (octave-forward-block)
 580             t)
 581         (error nil))
 582       (< pos (point)))))
 583
 584 (defun octave-looking-at-kw (regexp)
 585   "Like `looking-at', but sets `case-fold-search' nil."
 586   (let ((case-fold-search nil))
 587     (looking-at regexp)))
 588
 589 (defun octave-re-search-forward-kw (regexp count)
 590   "Like `re-search-forward', but sets `case-fold-search' nil, and moves point."
 591   (let ((case-fold-search nil))
 592     (re-search-forward regexp nil 'move count)))
 593
 594 (defun octave-re-search-backward-kw (regexp count)
 595   "Like `re-search-backward', but sets `case-fold-search' nil, and moves point."
 596   (let ((case-fold-search nil))
 597     (re-search-backward regexp nil 'move count)))
 598
 599 (defun octave-in-defun-p ()
 600   "Return t if point is inside an Octave function declaration.
 601 The function is taken to start at the `f' of `function' and to end after
 602 the end keyword."
 603   (let ((pos (point)))
 604     (save-excursion
 605       (or (and (octave-looking-at-kw "\\<function\\>")
 606                (octave-not-in-string-or-comment-p))
 607           (and (octave-beginning-of-defun)
 608                (condition-case nil
 609                    (progn
 610                      (octave-forward-block)
 611                      t)
 612                  (error nil))
 613                (< pos (point)))))))
 614
 615 (defun octave-maybe-insert-continuation-string ()
 616   (if (or (octave-in-comment-p)
 617           (save-excursion
 618             (beginning-of-line)
 619             (looking-at octave-continuation-regexp)))
 620       nil
 621     (delete-horizontal-space)
 622     (insert (concat " " octave-continuation-string))))
 623
 624 ;;; Comments
 625 (defun octave-comment-region (beg end &optional arg)
 626   "Comment or uncomment each line in the region as Octave code.
 627 See `comment-region'."
 628   (interactive "r\nP")
 629   (let ((comment-start (char-to-string octave-comment-char)))
 630     (comment-region beg end arg)))
 631
 632 (defun octave-uncomment-region (beg end &optional arg)
 633   "Uncomment each line in the region as Octave code."
 634   (interactive "r\nP")
 635   (or arg (setq arg 1))
 636   (octave-comment-region beg end (- arg)))
 637
 638 \f
 639 ;;; Indentation
 640 (defun calculate-octave-indent ()
 641   "Return appropriate indentation for current line as Octave code.
 642 Returns an integer (the column to indent to) unless the line is a
 643 comment line with fixed goal golumn.  In that case, returns a list whose
 644 car is the column to indent to, and whose cdr is the current indentation
 645 level."
 646   (let ((is-continuation-line
 647          (save-excursion
 648            (if (zerop (octave-previous-code-line))
 649                (looking-at octave-continuation-regexp))))
 650         (icol 0))
 651     (save-excursion
 652       (beginning-of-line)
 653       ;; If we can move backward out one level of parentheses, take 1
 654       ;; plus the indentation of that parenthesis.  Otherwise, go back
 655       ;; to the beginning of the previous code line, and compute the
 656       ;; offset this line gives.
 657       (if (condition-case nil
 658               (progn
 659                 (up-list -1)
 660                 t)
 661             (error nil))
 662           (setq icol (+ 1 (current-column)))
 663         (if (zerop (octave-previous-code-line))
 664             (progn
 665               (octave-beginning-of-line)
 666               (back-to-indentation)
 667               (setq icol (current-column))
 668               (let ((bot (point))
 669                     (eol (line-end-position)))
 670                 (while (< (point) eol)
 671                   (if (octave-not-in-string-or-comment-p)
 672                       (cond
 673                        ((octave-looking-at-kw "\\<switch\\>")
 674                         (setq icol (+ icol (* 2 octave-block-offset))))
 675                        ((octave-looking-at-kw octave-block-begin-regexp)
 676                         (setq icol (+ icol octave-block-offset)))
 677                        ((octave-looking-at-kw octave-block-else-regexp)
 678                         (if (= bot (point))
 679                             (setq icol (+ icol octave-block-offset))))
 680                        ((octave-looking-at-kw octave-block-end-regexp)
 681                         (if (not (= bot (point)))
 682                             (setq icol (- icol
 683                                           (octave-block-end-offset)))))))
 684                   (forward-char)))
 685               (if is-continuation-line
 686                   (setq icol (+ icol octave-continuation-offset)))))))
 687     (save-excursion
 688       (back-to-indentation)
 689       (cond
 690        ((and (octave-looking-at-kw octave-block-else-regexp)
 691              (octave-not-in-string-or-comment-p))
 692         (setq icol (- icol octave-block-offset)))
 693        ((and (octave-looking-at-kw octave-block-end-regexp)
 694              (octave-not-in-string-or-comment-p))
 695         (setq icol (- icol (octave-block-end-offset))))
 696        ((or (looking-at "\\s<\\s<\\s<\\S<")
 697             (octave-before-magic-comment-p))
 698         (setq icol (list 0 icol)))
 699        ((looking-at "\\s<\\S<")
 700         (setq icol (list comment-column icol)))))
 701     icol))
 702
 703 (defun octave-block-end-offset ()
 704   (save-excursion
 705     (octave-backward-up-block 1)
 706     (* octave-block-offset
 707        (if (string-match (match-string 0) "switch") 2 1))))
 708
 709 (defun octave-before-magic-comment-p ()
 710   (save-excursion
 711     (beginning-of-line)
 712     (and (bobp) (looking-at "\\s-*#!"))))
 713
 714 (defun octave-comment-indent ()
 715   (if (or (looking-at "\\s<\\s<\\s<")
 716           (octave-before-magic-comment-p))
 717       0
 718     (if (looking-at "\\s<\\s<")
 719         (calculate-octave-indent)
 720       (skip-syntax-backward " ")
 721       (max (if (bolp) 0 (+ 1 (current-column)))
 722            comment-column))))
 723
 724 (defun octave-indent-for-comment ()
 725   "Maybe insert and indent an Octave comment.
 726 If there is no comment already on this line, create a code-level comment
 727 \(started by two comment characters) if the line is empty, or an in-line
 728 comment (started by one comment character) otherwise.
 729 Point is left after the start of the comment which is properly aligned."
 730   (interactive)
 731   (beginning-of-line)
 732   (if (looking-at "^\\s-*$")
 733       (insert octave-block-comment-start)
 734     (indent-for-comment))
 735   (indent-according-to-mode))
 736
 737 (defun octave-indent-line (&optional arg)
 738   "Indent current line as Octave code.
 739 With optional ARG, use this as offset unless this line is a comment with
 740 fixed goal column."
 741   (interactive)
 742   (or arg (setq arg 0))
 743   (let ((icol (calculate-octave-indent))
 744         (relpos (- (current-column) (current-indentation))))
 745     (if (listp icol)
 746         (setq icol (car icol))
 747       (setq icol (+ icol arg)))
 748     (if (< icol 0)
 749         (error "Unmatched end keyword")
 750       (indent-line-to icol)
 751       (if (> relpos 0)
 752           (move-to-column (+ icol relpos))))))
 753
 754 (defun octave-indent-new-comment-line ()
 755   "Break Octave line at point, continuing comment if within one.
 756 If within code, insert `octave-continuation-string' before breaking the
 757 line.  If within a string, signal an error.
 758 The new line is properly indented."
 759   (interactive)
 760   (delete-horizontal-space)
 761   (cond
 762    ((octave-in-comment-p)
 763     (indent-new-comment-line))
 764    ((octave-in-string-p)
 765     (error "Cannot split a code line inside a string"))
 766    (t
 767     (insert (concat " " octave-continuation-string))
 768     (octave-reindent-then-newline-and-indent))))
 769
 770 (defun octave-indent-defun ()
 771   "Properly indent the Octave function which contains point."
 772   (interactive)
 773   (save-excursion
 774     (octave-mark-defun)
 775     (message "Indenting function...")
 776     (indent-region (point) (mark) nil))
 777   (message "Indenting function...done."))
 778
 779 \f
 780 ;;; Motion
 781 (defun octave-next-code-line (&optional arg)
 782   "Move ARG lines of Octave code forward (backward if ARG is negative).
 783 Skips past all empty and comment lines.  Default for ARG is 1.
 784
 785 On success, return 0.  Otherwise, go as far as possible and return -1."
 786   (interactive "p")
 787   (or arg (setq arg 1))
 788   (beginning-of-line)
 789   (let ((n 0)
 790         (inc (if (> arg 0) 1 -1)))
 791     (while (and (/= arg 0) (= n 0))
 792       (setq n (forward-line inc))
 793       (while (and (= n 0)
 794                   (looking-at "\\s-*\\($\\|\\s<\\)"))
 795         (setq n (forward-line inc)))
 796       (setq arg (- arg inc)))
 797     n))
 798
 799 (defun octave-previous-code-line (&optional arg)
 800   "Move ARG lines of Octave code backward (forward if ARG is negative).
 801 Skips past all empty and comment lines.  Default for ARG is 1.
 802
 803 On success, return 0.  Otherwise, go as far as possible and return -1."
 804   (interactive "p")
 805   (or arg (setq arg 1))
 806   (octave-next-code-line (- arg)))
 807
 808 (defun octave-beginning-of-line ()
 809   "Move point to beginning of current Octave line.
 810 If on an empty or comment line, go to the beginning of that line.
 811 Otherwise, move backward to the beginning of the first Octave code line
 812 which is not inside a continuation statement, i.e., which does not
 813 follow a code line ending in `...' or `\\', or is inside an open
 814 parenthesis list."
 815   (interactive)
 816   (beginning-of-line)
 817   (if (not (looking-at "\\s-*\\($\\|\\s<\\)"))
 818       (while (or (condition-case nil
 819                      (progn
 820                        (up-list -1)
 821                        (beginning-of-line)
 822                        t)
 823                    (error nil))
 824                  (and (or (looking-at "\\s-*\\($\\|\\s<\\)")
 825                           (save-excursion
 826                             (if (zerop (octave-previous-code-line))
 827                                 (looking-at octave-continuation-regexp))))
 828                       (zerop (forward-line -1)))))))
 829
 830 (defun octave-end-of-line ()
 831   "Move point to end of current Octave line.
 832 If on an empty or comment line, go to the end of that line.
 833 Otherwise, move forward to the end of the first Octave code line which
 834 does not end in `...' or `\\' or is inside an open parenthesis list."
 835   (interactive)
 836   (end-of-line)
 837   (if (save-excursion
 838         (beginning-of-line)
 839         (looking-at "\\s-*\\($\\|\\s<\\)"))
 840       ()
 841     (while (or (condition-case nil
 842                    (progn
 843                      (up-list 1)
 844                      (end-of-line)
 845                      t)
 846                  (error nil))
 847                (and (save-excursion
 848                       (beginning-of-line)
 849                       (or (looking-at "\\s-*\\($\\|\\s<\\)")
 850                           (looking-at octave-continuation-regexp)))
 851                     (zerop (forward-line 1)))))
 852     (end-of-line)))
 853
 854 (defun octave-scan-blocks (count depth)
 855   "Scan from point by COUNT Octave begin-end blocks.
 856 Returns the character number of the position thus found.
 857
 858 If DEPTH is nonzero, block depth begins counting from that value.
 859 Only places where the depth in blocks becomes zero are candidates for
 860 stopping; COUNT such places are counted.
 861
 862 If the beginning or end of the buffer is reached and the depth is wrong,
 863 an error is signaled."
 864   (let ((min-depth (if (> depth 0) 0 depth))
 865         (inc (if (> count 0) 1 -1)))
 866     (save-excursion
 867       (while (/= count 0)
 868         (catch 'foo
 869           (while (or (octave-re-search-forward-kw
 870                       octave-block-begin-or-end-regexp inc)
 871                      (if (/= depth 0)
 872                          (error "Unbalanced block")))
 873             (if (octave-not-in-string-or-comment-p)
 874                 (progn
 875                   (cond
 876                    ((match-end 1)
 877                     (setq depth (+ depth inc)))
 878                    ((match-end 2)
 879                     (setq depth (- depth inc))))
 880                   (if (< depth min-depth)
 881                       (error "Containing expression ends prematurely"))
 882                   (if (= depth 0)
 883                       (throw 'foo nil))))))
 884         (setq count (- count inc)))
 885       (point))))
 886
 887 (defun octave-forward-block (&optional arg)
 888   "Move forward across one balanced Octave begin-end block.
 889 With argument, do it that many times.
 890 Negative arg -N means move backward across N blocks."
 891   (interactive "p")
 892   (or arg (setq arg 1))
 893   (goto-char (or (octave-scan-blocks arg 0) (buffer-end arg))))
 894
 895 (defun octave-backward-block (&optional arg)
 896   "Move backward across one balanced Octave begin-end block.
 897 With argument, do it that many times.
 898 Negative arg -N means move forward across N blocks."
 899   (interactive "p")
 900   (or arg (setq arg 1))
 901   (octave-forward-block (- arg)))
 902
 903 (defun octave-down-block (arg)
 904   "Move forward down one begin-end block level of Octave code.
 905 With argument, do this that many times.
 906 A negative argument means move backward but still go down a level.
 907 In Lisp programs, an argument is required."
 908   (interactive "p")
 909   (let ((inc (if (> arg 0) 1 -1)))
 910     (while (/= arg 0)
 911       (goto-char (or (octave-scan-blocks inc -1)
 912                      (buffer-end arg)))
 913       (setq arg (- arg inc)))))
 914
 915 (defun octave-backward-up-block (arg)
 916   "Move backward out of one begin-end block level of Octave code.
 917 With argument, do this that many times.
 918 A negative argument means move forward but still to a less deep spot.
 919 In Lisp programs, an argument is required."
 920   (interactive "p")
 921   (octave-up-block (- arg)))
 922
 923 (defun octave-up-block (arg)
 924   "Move forward out of one begin-end block level of Octave code.
 925 With argument, do this that many times.
 926 A negative argument means move backward but still to a less deep spot.
 927 In Lisp programs, an argument is required."
 928   (interactive "p")
 929   (let ((inc (if (> arg 0) 1 -1)))
 930     (while (/= arg 0)
 931       (goto-char (or (octave-scan-blocks inc 1)
 932                      (buffer-end arg)))
 933       (setq arg (- arg inc)))))
 934
 935 (defun octave-mark-block ()
 936   "Put point at the beginning of this Octave block, mark at the end.
 937 The block marked is the one that contains point or follows point."
 938   (interactive)
 939   (let ((pos (point)))
 940     (if (or (and (octave-in-block-p)
 941                  (skip-syntax-forward "w"))
 942             (condition-case nil
 943                 (progn
 944                   (octave-down-block 1)
 945                   (octave-in-block-p))
 946               (error nil)))
 947         (progn
 948           (octave-up-block -1)
 949           (push-mark (point))
 950           (octave-forward-block)
 951           (exchange-point-and-mark))
 952       (goto-char pos)
 953       (message "No block to mark found"))))
 954
 955 (defun octave-close-block ()
 956   "Close the current Octave block on a separate line.
 957 An error is signaled if no block to close is found."
 958   (interactive)
 959   (let (bb-keyword)
 960     (condition-case nil
 961         (progn
 962           (save-excursion
 963             (octave-backward-up-block 1)
 964             (setq bb-keyword (buffer-substring-no-properties
 965                               (match-beginning 1) (match-end 1))))
 966           (if (save-excursion
 967                 (beginning-of-line)
 968                 (looking-at "^\\s-*$"))
 969               (indent-according-to-mode)
 970             (octave-reindent-then-newline-and-indent))
 971           (insert (car (reverse
 972                         (assoc bb-keyword
 973                                octave-block-match-alist))))
 974           (octave-reindent-then-newline-and-indent)
 975           t)
 976       (error (message "No block to close found")))))
 977
 978 (defun octave-blink-matching-block-open ()
 979   "Blink the matching Octave begin block keyword.
 980 If point is right after an Octave else or end type block keyword, move
 981 cursor momentarily to the corresponding begin keyword.
 982 Signal an error if the keywords are incompatible."
 983   (interactive)
 984   (let (bb-keyword bb-arg eb-keyword pos eol)
 985     (if (and (octave-not-in-string-or-comment-p)
 986              (looking-at "\\>")
 987              (save-excursion
 988                (skip-syntax-backward "w")
 989                (octave-looking-at-kw octave-block-else-or-end-regexp)))
 990         (save-excursion
 991           (cond
 992            ((match-end 1)
 993             (setq eb-keyword
 994                   (buffer-substring-no-properties
 995                    (match-beginning 1) (match-end 1)))
 996             (octave-backward-up-block 1))
 997            ((match-end 2)
 998             (setq eb-keyword
 999                   (buffer-substring-no-properties
1000                    (match-beginning 2) (match-end 2)))
1001             (octave-backward-block)))
1002           (setq pos (match-end 0)
1003                 bb-keyword
1004                 (buffer-substring-no-properties
1005                  (match-beginning 0) pos)
1006                 pos (+ pos 1)
1007                 eol (line-end-position)
1008                 bb-arg
1009                 (save-excursion
1010                   (save-restriction
1011                     (goto-char pos)
1012                     (while (and (skip-syntax-forward "^<" eol)
1013                                 (octave-in-string-p)
1014                                 (not (forward-char 1))))
1015                     (skip-syntax-backward " ")
1016                     (buffer-substring-no-properties pos (point)))))
1017           (if (member eb-keyword
1018                       (cdr (assoc bb-keyword octave-block-match-alist)))
1019               (progn
1020                 (message "Matches `%s %s'" bb-keyword bb-arg)
1021                 (if (pos-visible-in-window-p)
1022                     (sit-for blink-matching-delay)))
1023             (error "Block keywords `%s' and `%s' do not match"
1024                    bb-keyword eb-keyword))))))
1025
1026 (defun octave-beginning-of-defun (&optional arg)
1027   "Move backward to the beginning of an Octave function.
1028 With positive ARG, do it that many times.  Negative argument -N means
1029 move forward to Nth following beginning of a function.
1030 Returns t unless search stops at the beginning or end of the buffer."
1031   (interactive "p")
1032   (let* ((arg (or arg 1))
1033          (inc (if (> arg 0) 1 -1))
1034          (found))
1035     (and (not (eobp))
1036          (not (and (> arg 0) (octave-looking-at-kw "\\<function\\>")))
1037          (skip-syntax-forward "w"))
1038     (while (and (/= arg 0)
1039                 (setq found
1040                       (octave-re-search-backward-kw "\\<function\\>" inc)))
1041       (if (octave-not-in-string-or-comment-p)
1042           (setq arg (- arg inc))))
1043     (if found
1044         (progn
1045           (and (< inc 0) (goto-char (match-beginning 0)))
1046           t))))
1047
1048 (defun octave-end-of-defun (&optional arg)
1049   "Move forward to the end of an Octave function.
1050 With positive ARG, do it that many times.  Negative argument -N means
1051 move back to Nth preceding end of a function.
1052
1053 An end of a function occurs right after the end keyword matching the
1054 `function' keyword that starts the function."
1055   (interactive "p")
1056   (or arg (setq arg 1))
1057   (and (< arg 0) (skip-syntax-backward "w"))
1058   (and (> arg 0) (skip-syntax-forward "w"))
1059   (if (octave-in-defun-p)
1060       (setq arg (- arg 1)))
1061   (if (= arg 0) (setq arg -1))
1062   (if (octave-beginning-of-defun (- arg))
1063       (octave-forward-block)))
1064
1065 (defun octave-mark-defun ()
1066   "Put point at the beginning of this Octave function, mark at its end.
1067 The function marked is the one containing point or following point."
1068   (interactive)
1069   (let ((pos (point)))
1070     (if (or (octave-in-defun-p)
1071             (and (octave-beginning-of-defun -1)
1072                  (octave-in-defun-p)))
1073         (progn
1074           (skip-syntax-forward "w")
1075           (octave-beginning-of-defun)
1076           (push-mark (point))
1077           (octave-end-of-defun)
1078           (exchange-point-and-mark))
1079       (goto-char pos)
1080       (message "No function to mark found"))))
1081
1082 \f
1083 ;;; Filling
1084 (defun octave-auto-fill ()
1085   "Perform auto-fill in Octave mode.
1086 Returns nil if no feasible place to break the line could be found, and t
1087 otherwise."
1088   (let (fc give-up)
1089     (if (or (null (setq fc (current-fill-column)))
1090             (save-excursion
1091               (beginning-of-line)
1092               (and auto-fill-inhibit-regexp
1093                    (octave-looking-at-kw auto-fill-inhibit-regexp))))
1094         nil                             ; Can't do anything
1095       (if (and (not (octave-in-comment-p))
1096                (> (current-column) fc))
1097           (setq fc (- fc (+ (length octave-continuation-string) 1))))
1098       (while (and (not give-up) (> (current-column) fc))
1099         (let* ((opoint (point))
1100                (fpoint
1101                 (save-excursion
1102                   (move-to-column (+ fc 1))
1103                   (skip-chars-backward "^ \t\n")
1104                   ;; If we're at the beginning of the line, break after
1105                   ;; the first word
1106                   (if (bolp)
1107                       (re-search-forward "[ \t]" opoint t))
1108                   ;; If we're in a comment line, don't break after the
1109                   ;; comment chars
1110                   (if (save-excursion
1111                         (skip-syntax-backward " <")
1112                         (bolp))
1113                       (re-search-forward "[ \t]" (line-end-position)
1114                                          'move))
1115                   ;; If we're not in a comment line and just ahead the
1116                   ;; continuation string, don't break here.
1117                   (if (and (not (octave-in-comment-p))
1118                            (looking-at
1119                             (concat "\\s-*"
1120                                     (regexp-quote
1121                                      octave-continuation-string)
1122                                     "\\s-*$")))
1123                       (end-of-line))
1124                   (skip-chars-backward " \t")
1125                   (point))))
1126           (if (save-excursion
1127                 (goto-char fpoint)
1128                 (not (or (bolp) (eolp))))
1129               (let ((prev-column (current-column)))
1130                 (if (save-excursion
1131                       (skip-chars-backward " \t")
1132                       (= (point) fpoint))
1133                     (progn
1134                       (octave-maybe-insert-continuation-string)
1135                       (indent-new-comment-line t))
1136                   (save-excursion
1137                     (goto-char fpoint)
1138                     (octave-maybe-insert-continuation-string)
1139                     (indent-new-comment-line t)))
1140                 (if (>= (current-column) prev-column)
1141                     (setq give-up t)))
1142             (setq give-up t))))
1143       (not give-up))))
1144
1145 (defun octave-fill-paragraph (&optional arg)
1146  "Fill paragraph of Octave code, handling Octave comments."
1147  ;; FIXME: now that the default fill-paragraph takes care of similar issues,
1148  ;; this seems obsolete.  --Stef
1149  (interactive "P")
1150  (save-excursion
1151    (let ((end (progn (forward-paragraph) (point)))
1152          (beg (progn
1153                 (forward-paragraph -1)
1154                 (skip-chars-forward " \t\n")
1155                 (beginning-of-line)
1156                 (point)))
1157          (cfc (current-fill-column))
1158          (ind (calculate-octave-indent))
1159          comment-prefix)
1160      (save-restriction
1161        (goto-char beg)
1162        (narrow-to-region beg end)
1163        (if (listp ind) (setq ind (nth 1 ind)))
1164        (while (not (eobp))
1165          (condition-case nil
1166              (octave-indent-line ind)
1167            (error nil))
1168          (if (and (> ind 0)
1169                   (not
1170                    (save-excursion
1171                      (beginning-of-line)
1172                      (looking-at "^\\s-*\\($\\|\\s<+\\)"))))
1173              (setq ind 0))
1174          (move-to-column cfc)
1175          ;; First check whether we need to combine non-empty comment lines
1176          (if (and (< (current-column) cfc)
1177                   (octave-in-comment-p)
1178                   (not (save-excursion
1179                          (beginning-of-line)
1180                          (looking-at "^\\s-*\\s<+\\s-*$"))))
1181              ;; This is a nonempty comment line which does not extend
1182              ;; past the fill column.  If it is followed by a nonempty
1183              ;; comment line with the same comment prefix, try to
1184              ;; combine them, and repeat this until either we reach the
1185              ;; fill-column or there is nothing more to combine.
1186              (progn
1187                ;; Get the comment prefix
1188                (save-excursion
1189                  (beginning-of-line)
1190                  (while (and (re-search-forward "\\s<+")
1191                              (not (octave-in-comment-p))))
1192                  (setq comment-prefix (match-string 0)))
1193                ;; And keep combining ...
1194                (while (and (< (current-column) cfc)
1195                            (save-excursion
1196                              (forward-line 1)
1197                              (and (looking-at
1198                                    (concat "^\\s-*"
1199                                            comment-prefix
1200                                            "\\S<"))
1201                                   (not (looking-at
1202                                         (concat "^\\s-*"
1203                                                 comment-prefix
1204                                                 "\\s-*$"))))))
1205                  (delete-char 1)
1206                  (re-search-forward comment-prefix)
1207                  (delete-region (match-beginning 0) (match-end 0))
1208                  (fixup-whitespace)
1209                  (move-to-column cfc))))
1210          ;; We might also try to combine continued code lines>  Perhaps
1211          ;; some other time ...
1212          (skip-chars-forward "^ \t\n")
1213          (delete-horizontal-space)
1214          (if (or (< (current-column) cfc)
1215                  (and (= (current-column) cfc) (eolp)))
1216              (forward-line 1)
1217            (if (not (eolp)) (insert " "))
1218            (or (octave-auto-fill)
1219                (forward-line 1)))))
1220      t)))
1221
1222 \f
1223 ;;; Completions
1224 (defun octave-initialize-completions ()
1225   "Create an alist for Octave completions."
1226   (if octave-completion-alist
1227       ()
1228     (setq octave-completion-alist
1229           (mapcar '(lambda (var) (cons var var))
1230                   (append octave-reserved-words
1231                           octave-text-functions
1232                           octave-variables)))))
1233
1234 (defun octave-complete-symbol ()
1235   "Perform completion on Octave symbol preceding point.
1236 Compare that symbol against Octave's reserved words and builtin
1237 variables."
1238   ;; This code taken from lisp-complete-symbol
1239   (interactive)
1240   (let* ((end (point))
1241          (beg (save-excursion (backward-sexp 1) (point)))
1242          (string (buffer-substring-no-properties beg end))
1243          (completion (try-completion string octave-completion-alist)))
1244     (cond ((eq completion t))           ; ???
1245           ((null completion)
1246            (message "Can't find completion for \"%s\"" string)
1247            (ding))
1248           ((not (string= string completion))
1249            (delete-region beg end)
1250            (insert completion))
1251           (t
1252            (let ((list (all-completions string octave-completion-alist))
1253                  (conf (current-window-configuration)))
1254              ;; Taken from comint.el
1255              (message "Making completion list...")
1256              (with-output-to-temp-buffer "*Completions*"
1257                (display-completion-list list string))
1258              (message "Hit space to flush")
1259              (let (key first)
1260                (if (save-excursion
1261                      (set-buffer (get-buffer "*Completions*"))
1262                      (setq key (read-key-sequence nil)
1263                            first (aref key 0))
1264                      (and (consp first) (consp (event-start first))
1265                           (eq (window-buffer (posn-window (event-start
1266                                                            first)))
1267                               (get-buffer "*Completions*"))
1268                           (eq (key-binding key) 'mouse-choose-completion)))
1269                    (progn
1270                      (mouse-choose-completion first)
1271                      (set-window-configuration conf))
1272                  (if (eq first ?\ )
1273                      (set-window-configuration conf)
1274                    (setq unread-command-events
1275                          (listify-key-sequence key))))))))))
1276
1277 \f
1278 ;;; Electric characters && friends
1279 (defun octave-reindent-then-newline-and-indent ()
1280   "Reindent current Octave line, insert newline, and indent the new line.
1281 If Abbrev mode is on, expand abbrevs first."
1282   (interactive)
1283   (if abbrev-mode (expand-abbrev))
1284   (if octave-blink-matching-block
1285       (octave-blink-matching-block-open))
1286   (save-excursion
1287     (delete-region (point) (progn (skip-chars-backward " \t") (point)))
1288     (indent-according-to-mode))
1289   (insert "\n")
1290   (indent-according-to-mode))
1291
1292 (defun octave-electric-semi ()
1293   "Insert a semicolon in Octave mode.
1294 Maybe expand abbrevs and blink matching block open keywords.
1295 Reindent the line of `octave-auto-indent' is non-nil.
1296 Insert a newline if `octave-auto-newline' is non-nil."
1297   (interactive)
1298   (if (not (octave-not-in-string-or-comment-p))
1299       (insert ";")
1300     (if abbrev-mode (expand-abbrev))
1301     (if octave-blink-matching-block
1302         (octave-blink-matching-block-open))
1303     (if octave-auto-indent
1304         (indent-according-to-mode))
1305     (insert ";")
1306     (if octave-auto-newline
1307         (newline-and-indent))))
1308
1309 (defun octave-electric-space ()
1310   "Insert a space in Octave mode.
1311 Maybe expand abbrevs and blink matching block open keywords.
1312 Reindent the line of `octave-auto-indent' is non-nil."
1313   (interactive)
1314   (setq last-command-char ? )
1315   (if (and octave-auto-indent
1316            (not (octave-not-in-string-or-comment-p)))
1317       (progn
1318         (indent-according-to-mode)
1319         (self-insert-command 1))
1320     (if abbrev-mode (expand-abbrev))
1321     (if octave-blink-matching-block
1322         (octave-blink-matching-block-open))
1323     (if (and octave-auto-indent
1324              (save-excursion
1325                (skip-syntax-backward " ")
1326                (not (bolp))))
1327         (indent-according-to-mode))
1328     (self-insert-command 1)))
1329
1330 (defun octave-abbrev-start ()
1331   "Start entering an Octave abbreviation.
1332 If Abbrev mode is turned on, typing ` (grave accent) followed by ? or
1333 \\[help-command] lists all Octave abbrevs.  Any other key combination is
1334 executed normally.
1335 Note that all Octave mode abbrevs start with a grave accent."
1336   (interactive)
1337   (if (not abbrev-mode)
1338       (self-insert-command 1)
1339     (let (c)
1340       (insert last-command-char)
1341       (if (if (featurep 'xemacs)
1342               (or (eq (event-to-character (setq c (next-event))) ??)
1343                   (eq (event-to-character c) help-char))
1344             (or (eq (setq c (read-event)) ??)
1345                 (eq c help-char)))
1346           (let ((abbrev-table-name-list '(octave-abbrev-table)))
1347             (list-abbrevs))
1348         (setq unread-command-events (list c))))))
1349
1350 (defun octave-insert-defun (name args vals)
1351   "Insert an Octave function skeleton.
1352 Prompt for the function's name, arguments and return values (to be
1353 entered without parens)."
1354   (interactive
1355    (list
1356     (read-from-minibuffer "Function name: "
1357                           (substring (buffer-name) 0 -2))
1358     (read-from-minibuffer "Arguments: ")
1359     (read-from-minibuffer "Return values: ")))
1360   (let ((string (format "%s %s (%s)"
1361                         (cond
1362                          ((string-equal vals "")
1363                           vals)
1364                          ((string-match "[ ,]" vals)
1365                           (concat " [" vals "] ="))
1366                          (t
1367                           (concat " " vals " =")))
1368                         name
1369                         args))
1370         (prefix octave-block-comment-start))
1371     (if (not (bobp)) (newline))
1372     (insert "function" string)
1373     (indent-according-to-mode)
1374     (newline 2)
1375     (insert prefix "usage: " string)
1376     (reindent-then-newline-and-indent)
1377     (insert prefix)
1378     (reindent-then-newline-and-indent)
1379     (insert prefix)
1380     (indent-according-to-mode)
1381     (save-excursion
1382       (newline 2)
1383       (insert "endfunction")
1384       (indent-according-to-mode))))
1385
1386 \f
1387 ;;; Menu
1388 (defun octave-add-octave-menu ()
1389   "Add the `Octave' menu to the menu bar in Octave mode."
1390   (require 'easymenu)
1391   (easy-menu-define octave-mode-menu-map octave-mode-map
1392                     "Menu keymap for Octave mode." octave-mode-menu)
1393   (easy-menu-add octave-mode-menu-map octave-mode-map))
1394
1395 \f
1396 ;;; Communication with the inferior Octave process
1397 (defun octave-kill-process ()
1398   "Kill inferior Octave process and its buffer."
1399   (interactive)
1400   (if inferior-octave-process
1401       (progn
1402         (process-send-string inferior-octave-process "quit;\n")
1403         (accept-process-output inferior-octave-process)))
1404   (if inferior-octave-buffer
1405       (kill-buffer inferior-octave-buffer)))
1406
1407 (defun octave-show-process-buffer ()
1408   "Make sure that `inferior-octave-buffer' is displayed."
1409   (interactive)
1410   (if (get-buffer inferior-octave-buffer)
1411       (display-buffer inferior-octave-buffer)
1412     (message "No buffer named %s" inferior-octave-buffer)))
1413
1414 (defun octave-hide-process-buffer ()
1415   "Delete all windows that display `inferior-octave-buffer'."
1416   (interactive)
1417   (if (get-buffer inferior-octave-buffer)
1418       (delete-windows-on inferior-octave-buffer)
1419     (message "No buffer named %s" inferior-octave-buffer)))
1420
1421 (defun octave-send-region (beg end)
1422   "Send current region to the inferior Octave process."
1423   (interactive "r")
1424   (inferior-octave t)
1425   (let ((proc inferior-octave-process)
1426         (string (buffer-substring-no-properties beg end))
1427         line)
1428     (save-excursion
1429       (set-buffer inferior-octave-buffer)
1430       (setq inferior-octave-output-list nil)
1431       (while (not (string-equal string ""))
1432         (if (string-match "\n" string)
1433             (setq line (substring string 0 (match-beginning 0))
1434                   string (substring string (match-end 0)))
1435           (setq line string string ""))
1436         (setq inferior-octave-receive-in-progress t)
1437         (inferior-octave-send-list-and-digest (list (concat line "\n")))
1438         (while inferior-octave-receive-in-progress
1439           (accept-process-output proc))
1440         (insert-before-markers
1441          (mapconcat 'identity
1442                     (append
1443                      (if octave-send-echo-input (list line) (list ""))
1444                      (mapcar 'inferior-octave-strip-ctrl-g
1445                              inferior-octave-output-list)
1446                      (list inferior-octave-output-string))
1447                     "\n")))))
1448   (if octave-send-show-buffer
1449       (display-buffer inferior-octave-buffer)))
1450
1451 (defun octave-send-block ()
1452   "Send current Octave block to the inferior Octave process."
1453   (interactive)
1454   (save-excursion
1455     (octave-mark-block)
1456     (octave-send-region (point) (mark))))
1457
1458 (defun octave-send-defun ()
1459   "Send current Octave function to the inferior Octave process."
1460   (interactive)
1461   (save-excursion
1462     (octave-mark-defun)
1463     (octave-send-region (point) (mark))))
1464
1465 (defun octave-send-line (&optional arg)
1466   "Send current Octave code line to the inferior Octave process.
1467 With positive prefix ARG, send that many lines.
1468 If `octave-send-line-auto-forward' is non-nil, go to the next unsent
1469 code line."
1470   (interactive "P")
1471   (or arg (setq arg 1))
1472   (if (> arg 0)
1473       (let (beg end)
1474         (beginning-of-line)
1475         (setq beg (point))
1476         (octave-next-code-line (- arg 1))
1477         (end-of-line)
1478         (setq end (point))
1479         (if octave-send-line-auto-forward
1480             (octave-next-code-line 1))
1481         (octave-send-region beg end))))
1482
1483 (defun octave-eval-print-last-sexp ()
1484   "Evaluate Octave sexp before point and print value into current buffer."
1485   (interactive)
1486   (inferior-octave t)
1487   (let ((standard-output (current-buffer))
1488         (print-escape-newlines nil)
1489         (opoint (point)))
1490     (terpri)
1491     (prin1
1492      (save-excursion
1493        (forward-sexp -1)
1494        (inferior-octave-send-list-and-digest
1495         (list (concat (buffer-substring-no-properties (point) opoint)
1496                       "\n")))
1497        (mapconcat 'identity inferior-octave-output-list "\n")))
1498     (terpri)))
1499 \f
1500 ;;; Bug reporting
1501 (defun octave-submit-bug-report ()
1502   "Submit a bug report on the Emacs Octave package via mail."
1503   (interactive)
1504   (require 'reporter)
1505   (and
1506    (y-or-n-p "Do you want to submit a bug report? ")
1507    (reporter-submit-bug-report
1508     octave-maintainer-address
1509     (concat "Emacs version " emacs-version)
1510     (list
1511      'octave-auto-indent
1512      'octave-auto-newline
1513      'octave-blink-matching-block
1514      'octave-block-offset
1515      'octave-comment-char
1516      'octave-continuation-offset
1517      'octave-continuation-string
1518      'octave-help-files
1519      'octave-send-echo-input
1520      'octave-send-line-auto-forward
1521      'octave-send-show-buffer))))
1522
1523 ;;; provide ourself
1524
1525 (provide 'octave-mod)
1526
1527 ;; arch-tag: 05f1ce09-be87-4c00-803e-4919ffa26c23
1528 ;;; octave-mod.el ends here