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