HCoop / bpt / emacs.git / blame
| Commit | Line | Data |
|---|---|---|
| 092af6d8 | 1 | ;;; octave-mod.el --- editing Octave source files under Emacs |
| f2727dfb | 2 | |
| 092af6d8 | 3 | ;; Copyright (C) 1997 Free Software Foundation, Inc. |
| f2727dfb RS |
4 | |
| 5 | ;; Author: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at> | |
| 6 | ;; Author: John Eaton <jwe@bevo.che.wisc.edu> | |
| 7 | ;; Maintainer: Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at> | |
| 8 | ;; Keywords: languages | |
| 9 | ||
| 10 | ;; This file is part of GNU Emacs. | |
| 11 | ||
| 12 | ;; GNU Emacs is free software; you can redistribute it and/or modify | |
| 13 | ;; it under the terms of the GNU General Public License as published by | |
| 14 | ;; the Free Software Foundation; either version 2, or (at your option) | |
| 15 | ;; any later version. | |
| 16 | ||
| 17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
| 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
| 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
| 20 | ;; GNU General Public License for more details. | |
| 21 | ||
| 22 | ;; You should have received a copy of the GNU General Public License | |
| 23 | ;; along with GNU Emacs; see the file COPYING. If not, write to the | |
| 24 | ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330, | |
| 25 | ;; Boston, MA 02111-1307, USA. | |
| 26 | ||
| 27 | ;;; Commentary: | |
| 28 | ||
| d1e49742 RS |
29 | ;; This package provides Emacs support for Octave. |
| 30 | ;; It defines Octave mode, a major mode for editing | |
| 31 | ;; Octave code. | |
| 32 | ||
| 33 | ;; The file octave-hlp.el provides `octave-help', a facility for looking up | |
| 34 | ;; documentation on a symbol in the Octave info files. | |
| 35 | ||
| 36 | ;; The file octave-inf.el contains code for interacting with an inferior | |
| 37 | ;; Octave process using comint. | |
| f2727dfb | 38 | |
| d1e49742 RS |
39 | ;; See the documentation of `octave-mode', `octave-help' and |
| 40 | ;; `run-octave' for further information on usage and customization. | |
| f2727dfb | 41 | |
| d1e49742 | 42 | ;;; Code: |
| f2727dfb | 43 | |
| 28d16ed3 AS |
44 | (defgroup octave nil |
| 45 | "Major mode for editing Octave source files." | |
| 46 | :group 'languages) | |
| 47 | ||
| e09735aa RS |
48 | (defvar inferior-octave-output-list nil) |
| 49 | (defvar inferior-octave-output-string nil) | |
| 50 | (defvar inferior-octave-receive-in-progress nil) | |
| 51 | ||
| e7017ef9 RS |
52 | (defconst octave-maintainer-address |
| 53 | "Kurt Hornik <Kurt.Hornik@ci.tuwien.ac.at>, bug-gnu-emacs@prep.ai.mit.edu" | |
| 54 | "Current maintainer of the Emacs Octave package.") | |
| 55 | ||
| 56 | (defvar octave-abbrev-table nil | |
| 57 | "Abbrev table for Octave's reserved words. | |
| 58 | Used in octave-mode and inferior-octave-mode buffers. | |
| 59 | All Octave abbrevs start with a grave accent (`).") | |
| 60 | (if octave-abbrev-table | |
| 61 | () | |
| 62 | (let ((ac abbrevs-changed)) | |
| 63 | (define-abbrev-table 'octave-abbrev-table ()) | |
| 64 | (define-abbrev octave-abbrev-table "`a" "all_va_args" nil) | |
| 65 | (define-abbrev octave-abbrev-table "`b" "break" nil) | |
| 6e6d2764 | 66 | (define-abbrev octave-abbrev-table "`cs" "case" nil) |
| e7017ef9 RS |
67 | (define-abbrev octave-abbrev-table "`ca" "catch" nil) |
| 68 | (define-abbrev octave-abbrev-table "`c" "continue" nil) | |
| 69 | (define-abbrev octave-abbrev-table "`el" "else" nil) | |
| 70 | (define-abbrev octave-abbrev-table "`eli" "elseif" nil) | |
| 71 | (define-abbrev octave-abbrev-table "`et" "end_try_catch" nil) | |
| 72 | (define-abbrev octave-abbrev-table "`eu" "end_unwind_protect" nil) | |
| 73 | (define-abbrev octave-abbrev-table "`ef" "endfor" nil) | |
| 74 | (define-abbrev octave-abbrev-table "`efu" "endfunction" nil) | |
| 75 | (define-abbrev octave-abbrev-table "`ei" "endif" nil) | |
| 6e6d2764 | 76 | (define-abbrev octave-abbrev-table "`es" "endswitch" nil) |
| e7017ef9 RS |
77 | (define-abbrev octave-abbrev-table "`ew" "endwhile" nil) |
| 78 | (define-abbrev octave-abbrev-table "`f" "for" nil) | |
| 79 | (define-abbrev octave-abbrev-table "`fu" "function" nil) | |
| 80 | (define-abbrev octave-abbrev-table "`gl" "global" nil) | |
| 81 | (define-abbrev octave-abbrev-table "`gp" "gplot" nil) | |
| 82 | (define-abbrev octave-abbrev-table "`gs" "gsplot" nil) | |
| 83 | (define-abbrev octave-abbrev-table "`if" "if ()" nil) | |
| 6e6d2764 | 84 | (define-abbrev octave-abbrev-table "`o" "otherwise" nil) |
| e7017ef9 RS |
85 | (define-abbrev octave-abbrev-table "`rp" "replot" nil) |
| 86 | (define-abbrev octave-abbrev-table "`r" "return" nil) | |
| 6e6d2764 | 87 | (define-abbrev octave-abbrev-table "`s" "switch" nil) |
| e7017ef9 RS |
88 | (define-abbrev octave-abbrev-table "`t" "try" nil) |
| 89 | (define-abbrev octave-abbrev-table "`up" "unwind_protect" nil) | |
| 90 | (define-abbrev octave-abbrev-table "`upc" "unwind_protect_cleanup" nil) | |
| 91 | (define-abbrev octave-abbrev-table "`w" "while ()" nil) | |
| 92 | (setq abbrevs-changed ac))) | |
| 93 | ||
| 94 | (defvar octave-comment-char ?# | |
| 95 | "Character to start an Octave comment.") | |
| 96 | (defvar octave-comment-start | |
| 97 | (concat (make-string 1 octave-comment-char) " ") | |
| 98 | "String to insert to start a new Octave in-line comment.") | |
| 99 | (defvar octave-comment-start-skip "\\s<+\\s-*" | |
| 100 | "Regexp to match the start of an Octave comment up to its body.") | |
| 101 | ||
| 102 | (defvar octave-begin-keywords | |
| 6e6d2764 | 103 | '("for" "function" "if" "switch" "try" "unwind_protect" "while")) |
| e7017ef9 | 104 | (defvar octave-else-keywords |
| 6e6d2764 | 105 | '("case" "catch" "else" "elseif" "otherwise" "unwind_protect_cleanup")) |
| e7017ef9 | 106 | (defvar octave-end-keywords |
| 6e6d2764 | 107 | '("end" "endfor" "endfunction" "endif" "endswitch" "end_try_catch" |
| e7017ef9 RS |
108 | "end_unwind_protect" "endwhile")) |
| 109 | ||
| 110 | (defvar octave-reserved-words | |
| 6e6d2764 KH |
111 | (append octave-begin-keywords |
| 112 | octave-else-keywords | |
| 113 | octave-end-keywords | |
| e7017ef9 RS |
114 | '("all_va_args" "break" "continue" "global" "gplot" "gsplot" |
| 115 | "replot" "return")) | |
| 116 | "Reserved words in Octave.") | |
| 117 | ||
| 118 | (defvar octave-text-functions | |
| 119 | '("casesen" "cd" "chdir" "clear" "diary" "dir" "document" "echo" | |
| 120 | "edit_history" "format" "gset" "gshow" "help" "history" "hold" | |
| 121 | "load" "ls" "more" "run_history" "save" "set" "show" "type" | |
| 122 | "which" "who" "whos") | |
| 123 | "Text functions in Octave (these names are also reserved).") | |
| 124 | ||
| 125 | (defvar octave-variables | |
| 126 | '("EDITOR" "EXEC_PATH" "F_DUPFD" "F_GETFD" "F_GETFL" "F_SETFD" | |
| 127 | "F_SETFL" "I" "IMAGEPATH" "INFO_FILE" "INFO_PROGRAM" "Inf" "J" | |
| 128 | "LOADPATH" "NaN" "OCTAVE_VERSION" "O_APPEND" "O_CREAT" "O_EXCL" | |
| 129 | "O_NONBLOCK" "O_RDONLY" "O_RDWR" "O_TRUNC" "O_WRONLY" "PAGER" "PS1" | |
| 130 | "PS2" "PS4" "PWD" "SEEK_CUR" "SEEK_END" "SEEK_SET" "__F_DUPFD__" | |
| 131 | "__F_GETFD__" "__F_GETFL__" "__F_SETFD__" "__F_SETFL__" "__I__" | |
| 132 | "__Inf__" "__J__" "__NaN__" "__OCTAVE_VERSION__" "__O_APPEND__" | |
| 133 | "__O_CREAT__" "__O_EXCL__" "__O_NONBLOCK__" "__O_RDONLY__" | |
| 134 | "__O_RDWR__" "__O_TRUNC__" "__O_WRONLY__" "__PWD__" "__SEEK_CUR__" | |
| 135 | "__SEEK_END__" "__SEEK_SET__" "__argv__" "__e__" "__eps__" | |
| 136 | "__error_text__" "__i__" "__inf__" "__j__" "__nan__" "__pi__" | |
| 137 | "__program_invocation_name__" "__program_name__" "__realmax__" | |
| 138 | "__realmin__" "__stderr__" "__stdin__" "__stdout__" "ans" "argv" | |
| 139 | "automatic_replot" "beep_on_error" "completion_append_char" | |
| 140 | "default_return_value" "default_save_format" | |
| 141 | "define_all_return_values" "do_fortran_indexing" "e" | |
| 142 | "echo_executing_commands" "empty_list_elements_ok" "eps" | |
| 143 | "error_text" "gnuplot_binary" "gnuplot_has_multiplot" "history_file" | |
| 144 | "history_size" "ignore_function_time_stamp" "implicit_str_to_num_ok" | |
| 145 | "inf" "nan" "nargin" "ok_to_lose_imaginary_part" | |
| 146 | "output_max_field_width" "output_precision" | |
| 147 | "page_output_immediately" "page_screen_output" "pi" | |
| 148 | "prefer_column_vectors" "prefer_zero_one_indexing" | |
| 149 | "print_answer_id_name" "print_empty_dimensions" | |
| 150 | "program_invocation_name" "program_name" "propagate_empty_matrices" | |
| 151 | "realmax" "realmin" "resize_on_range_error" | |
| 152 | "return_last_computed_value" "save_precision" "saving_history" | |
| 153 | "silent_functions" "split_long_rows" "stderr" "stdin" "stdout" | |
| 154 | "string_fill_char" "struct_levels_to_print" | |
| 155 | "suppress_verbose_help_message" "treat_neg_dim_as_zero" | |
| 156 | "warn_assign_as_truth_value" "warn_comma_in_global_decl" | |
| 157 | "warn_divide_by_zero" "warn_function_name_clash" | |
| 158 | "warn_missing_semicolon" "whitespace_in_literal_matrix") | |
| 159 | "Builtin variables in Octave.") | |
| 160 | ||
| 161 | (defvar octave-function-header-regexp | |
| 162 | (concat "^\\s-*\\<\\(function\\)\\>" | |
| 163 | "\\([^=;\n]*=[ \t]*\\|[ \t]*\\)\\(\\w+\\)\\>") | |
| 164 | "Regexp to match an Octave function header. | |
| 165 | The string `function' and its name are given by the first and third | |
| 166 | parenthetical grouping.") | |
| 167 | ||
| 168 | (defvar octave-font-lock-keywords | |
| 169 | (list | |
| 170 | ;; Fontify all builtin keywords. | |
| 171 | (cons (concat "\\<\\(" | |
| 172 | (mapconcat 'identity octave-reserved-words "\\|") | |
| 173 | (mapconcat 'identity octave-text-functions "\\|") | |
| 174 | "\\)\\>") | |
| 175 | 'font-lock-keyword-face) | |
| 176 | ;; Fontify all builtin operators. | |
| 177 | (cons "\\(&\\||\\|<=\\|>=\\|==\\|<\\|>\\|!=\\|!\\)" | |
| 883212ce | 178 | 'font-lock-builtin-face) |
| e7017ef9 RS |
179 | ;; Fontify all builtin variables. |
| 180 | (cons (concat "\\<\\(" | |
| 181 | (mapconcat 'identity octave-variables "\\|") | |
| 182 | "\\)\\>") | |
| 183 | 'font-lock-variable-name-face) | |
| 184 | ;; Fontify all function declarations. | |
| 185 | (list octave-function-header-regexp | |
| 186 | '(1 font-lock-keyword-face) | |
| 187 | '(3 font-lock-function-name-face nil t))) | |
| 188 | "Additional Octave expressions to highlight.") | |
| 189 | ||
| 28d16ed3 AS |
190 | (defcustom inferior-octave-buffer "*Inferior Octave*" |
| 191 | "*Name of buffer for running an inferior Octave process." | |
| 192 | :type 'string | |
| 193 | :group 'octave-inferior) | |
| e7017ef9 RS |
194 | |
| 195 | (defvar inferior-octave-process nil) | |
| 196 | \f | |
| f2727dfb RS |
197 | (defvar octave-mode-map nil |
| 198 | "Keymap used in Octave mode.") | |
| 199 | (if octave-mode-map | |
| 200 | () | |
| 201 | (let ((map (make-sparse-keymap))) | |
| 202 | (define-key map "`" 'octave-abbrev-start) | |
| 203 | (define-key map ";" 'octave-electric-semi) | |
| 204 | (define-key map " " 'octave-electric-space) | |
| 205 | (define-key map "\n" 'octave-reindent-then-newline-and-indent) | |
| 206 | (define-key map "\t" 'indent-according-to-mode) | |
| 207 | (define-key map "\e;" 'octave-indent-for-comment) | |
| 208 | (define-key map "\e\n" 'octave-indent-new-comment-line) | |
| 209 | (define-key map "\e\t" 'octave-complete-symbol) | |
| 210 | (define-key map "\M-\C-a" 'octave-beginning-of-defun) | |
| 211 | (define-key map "\M-\C-e" 'octave-end-of-defun) | |
| 212 | (define-key map "\M-\C-h" 'octave-mark-defun) | |
| 213 | (define-key map "\M-\C-q" 'octave-indent-defun) | |
| 214 | (define-key map "\C-c;" 'octave-comment-region) | |
| 215 | (define-key map "\C-c:" 'octave-uncomment-region) | |
| 216 | (define-key map "\C-c\C-b" 'octave-submit-bug-report) | |
| 217 | (define-key map "\C-c\C-p" 'octave-previous-code-line) | |
| 218 | (define-key map "\C-c\C-n" 'octave-next-code-line) | |
| 219 | (define-key map "\C-c\C-a" 'octave-beginning-of-line) | |
| 220 | (define-key map "\C-c\C-e" 'octave-end-of-line) | |
| 221 | (define-key map "\C-c\M-\C-n" 'octave-forward-block) | |
| 222 | (define-key map "\C-c\M-\C-p" 'octave-backward-block) | |
| 223 | (define-key map "\C-c\M-\C-u" 'octave-backward-up-block) | |
| 224 | (define-key map "\C-c\M-\C-d" 'octave-down-block) | |
| 225 | (define-key map "\C-c\M-\C-h" 'octave-mark-block) | |
| 226 | (define-key map "\C-c]" 'octave-close-block) | |
| 227 | (define-key map "\C-cf" 'octave-insert-defun) | |
| 228 | (define-key map "\C-c\C-h" 'octave-help) | |
| 229 | (define-key map "\C-cil" 'octave-send-line) | |
| 230 | (define-key map "\C-cib" 'octave-send-block) | |
| 231 | (define-key map "\C-cif" 'octave-send-defun) | |
| 232 | (define-key map "\C-cir" 'octave-send-region) | |
| 233 | (define-key map "\C-cis" 'octave-show-process-buffer) | |
| 234 | (define-key map "\C-cih" 'octave-hide-process-buffer) | |
| 235 | (define-key map "\C-cik" 'octave-kill-process) | |
| 236 | (setq octave-mode-map map))) | |
| 237 | ||
| 238 | (defvar octave-mode-menu | |
| 239 | (list "Octave" | |
| 240 | (list "Lines" | |
| 241 | ["Previous Code Line" octave-previous-code-line t] | |
| 242 | ["Next Code Line" octave-next-code-line t] | |
| 243 | ["Begin of Continuation" octave-beginning-of-line t] | |
| 244 | ["End of Continuation" octave-end-of-line t] | |
| 245 | ["Split Line at Point" octave-indent-new-comment-line t]) | |
| 246 | (list "Blocks" | |
| 247 | ["Next Block" octave-forward-block t] | |
| 248 | ["Previous Block" octave-backward-block t] | |
| 249 | ["Down Block" octave-down-block t] | |
| 250 | ["Up Block" octave-backward-up-block t] | |
| 251 | ["Mark Block" octave-mark-block t] | |
| 252 | ["Close Block" octave-close-block t]) | |
| 253 | (list "Functions" | |
| 254 | ["Begin of Function" octave-beginning-of-defun t] | |
| 255 | ["End of Function" octave-end-of-defun t] | |
| 256 | ["Mark Function" octave-mark-defun t] | |
| 257 | ["Indent Function" octave-indent-defun t] | |
| 258 | ["Insert Function" octave-insert-defun t]) | |
| 259 | "-" | |
| 260 | (list "Debug" | |
| 261 | ["Send Current Line" octave-send-line t] | |
| 262 | ["Send Current Block" octave-send-block t] | |
| 263 | ["Send Current Function" octave-send-defun t] | |
| 264 | ["Send Region" octave-send-region t] | |
| 265 | ["Show Process Buffer" octave-show-process-buffer t] | |
| 266 | ["Hide Process Buffer" octave-hide-process-buffer t] | |
| 267 | ["Kill Process" octave-kill-process t]) | |
| 268 | "-" | |
| 269 | ["Indent Line" indent-according-to-mode t] | |
| 270 | ["Complete Symbol" octave-complete-symbol t] | |
| 271 | "-" | |
| 272 | ["Toggle Abbrev Mode" abbrev-mode t] | |
| 273 | ["Toggle Auto-Fill Mode" auto-fill-mode t] | |
| 274 | "-" | |
| 275 | ["Submit Bug Report" octave-submit-bug-report t] | |
| 276 | "-" | |
| 277 | ["Describe Octave Mode" octave-describe-major-mode t] | |
| 278 | ["Lookup Octave Index" octave-help t]) | |
| 279 | "Menu for Octave mode.") | |
| 280 | ||
| 281 | (defvar octave-mode-syntax-table nil | |
| 282 | "Syntax table in use in octave-mode buffers.") | |
| 283 | (if octave-mode-syntax-table | |
| 284 | () | |
| 285 | (let ((table (make-syntax-table))) | |
| 286 | (modify-syntax-entry ?\r " " table) | |
| 287 | (modify-syntax-entry ?+ "." table) | |
| 288 | (modify-syntax-entry ?- "." table) | |
| 289 | (modify-syntax-entry ?= "." table) | |
| 290 | (modify-syntax-entry ?* "." table) | |
| 291 | (modify-syntax-entry ?/ "." table) | |
| 292 | (modify-syntax-entry ?> "." table) | |
| 293 | (modify-syntax-entry ?< "." table) | |
| 294 | (modify-syntax-entry ?& "." table) | |
| 295 | (modify-syntax-entry ?| "." table) | |
| 296 | (modify-syntax-entry ?! "." table) | |
| 297 | (modify-syntax-entry ?\\ "\\" table) | |
| 298 | (modify-syntax-entry ?\' "." table) | |
| 299 | (modify-syntax-entry ?\` "w" table) | |
| 300 | (modify-syntax-entry ?\" "\"" table) | |
| 301 | (modify-syntax-entry ?. "w" table) | |
| 302 | (modify-syntax-entry ?_ "w" table) | |
| 303 | (modify-syntax-entry ?\% "." table) | |
| 304 | (modify-syntax-entry ?\# "<" table) | |
| 305 | (modify-syntax-entry ?\n ">" table) | |
| 306 | (setq octave-mode-syntax-table table))) | |
| 307 | ||
| 28d16ed3 AS |
308 | (defcustom octave-auto-indent nil |
| 309 | "*Non-nil means indent line after a semicolon or space in Octave mode." | |
| 310 | :type 'boolean | |
| cd32a7ba DN |
311 | :group 'octave |
| 312 | :version "20.3") | |
| d83ee578 | 313 | |
| 28d16ed3 AS |
314 | (defcustom octave-auto-newline nil |
| 315 | "*Non-nil means automatically newline after a semicolon in Octave mode." | |
| 316 | :type 'boolean | |
| 317 | :group 'octave) | |
| f2727dfb | 318 | |
| 28d16ed3 | 319 | (defcustom octave-blink-matching-block t |
| f2727dfb RS |
320 | "*Control the blinking of matching Octave block keywords. |
| 321 | Non-nil means show matching begin of block when inserting a space, | |
| 28d16ed3 AS |
322 | newline or semicolon after an else or end keyword." |
| 323 | :type 'boolean | |
| 324 | :group 'octave) | |
| 325 | (defcustom octave-block-offset 2 | |
| 326 | "*Extra indentation applied to statements in Octave block structures." | |
| 327 | :type 'integer | |
| 328 | :group 'octave) | |
| f2727dfb RS |
329 | |
| 330 | (defvar octave-block-begin-regexp | |
| 331 | (concat "\\<\\(" | |
| 332 | (mapconcat 'identity octave-begin-keywords "\\|") | |
| 333 | "\\)\\>")) | |
| 334 | (defvar octave-block-else-regexp | |
| 335 | (concat "\\<\\(" | |
| 336 | (mapconcat 'identity octave-else-keywords "\\|") | |
| 337 | "\\)\\>")) | |
| 338 | (defvar octave-block-end-regexp | |
| 339 | (concat "\\<\\(" | |
| 340 | (mapconcat 'identity octave-end-keywords "\\|") | |
| 341 | "\\)\\>")) | |
| 342 | (defvar octave-block-begin-or-end-regexp | |
| 343 | (concat octave-block-begin-regexp "\\|" octave-block-end-regexp)) | |
| 344 | (defvar octave-block-else-or-end-regexp | |
| 345 | (concat octave-block-else-regexp "\\|" octave-block-end-regexp)) | |
| 346 | (defvar octave-block-match-alist | |
| 347 | '(("for" . ("end" "endfor")) | |
| 348 | ("function" . ("end" "endfunction")) | |
| 349 | ("if" . ("else" "elseif" "end" "endif")) | |
| d83ee578 | 350 | ("switch" . ("case" "otherwise" "end" "endswitch")) |
| f2727dfb RS |
351 | ("try" . ("catch" "end" "end_try_catch")) |
| 352 | ("unwind_protect" . ("unwind_protect_cleanup" "end" | |
| 353 | "end_unwind_protect")) | |
| 354 | ("while" . ("end" "endwhile"))) | |
| 355 | "Alist with Octave's matching block keywords. | |
| 356 | Has Octave's begin keywords as keys and a list of the matching else or | |
| 357 | end keywords as associated values.") | |
| 358 | ||
| 359 | (defvar octave-block-comment-start | |
| 360 | (concat (make-string 2 octave-comment-char) " ") | |
| 361 | "String to insert to start a new Octave comment on an empty line.") | |
| 362 | ||
| 28d16ed3 AS |
363 | (defcustom octave-continuation-offset 4 |
| 364 | "*Extra indentation applied to Octave continuation lines." | |
| 365 | :type 'integer | |
| 366 | :group 'octave) | |
| f2727dfb RS |
367 | (defvar octave-continuation-regexp |
| 368 | "[^#%\n]*\\(\\\\\\|\\.\\.\\.\\)\\s-*\\(\\s<.*\\)?$") | |
| 28d16ed3 AS |
369 | (defcustom octave-continuation-string "\\" |
| 370 | "*Character string used for Octave continuation lines. Normally \\." | |
| 371 | :type 'string | |
| 372 | :group 'octave) | |
| f2727dfb RS |
373 | |
| 374 | (defvar octave-completion-alist nil | |
| 375 | "Alist of Octave symbols for completion in Octave mode. | |
| 376 | Each element looks like (VAR . VAR), where the car and cdr are the same | |
| 377 | symbol (an Octave command or variable name). | |
| 378 | Currently, only builtin variables can be completed.") | |
| 379 | ||
| 380 | (defvar octave-mode-imenu-generic-expression | |
| 381 | (list | |
| 382 | ;; Functions | |
| 383 | (list nil octave-function-header-regexp 3)) | |
| 384 | "Imenu expression for Octave mode. See `imenu-generic-expression'.") | |
| 385 | ||
| 28d16ed3 AS |
386 | (defcustom octave-mode-startup-message t |
| 387 | "*Nil means do not display the Octave mode startup message." | |
| 388 | :type 'boolean | |
| 389 | :group 'octave) | |
| 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 | |
| f2727dfb | 401 | "*Control auto-forward after sending to the inferior Octave process. |
| 28d16ed3 AS |
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) | |
| f2727dfb RS |
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 bevo.che.wisc.edu 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 | ||
| d83ee578 KH |
440 | octave-auto-indent |
| 441 | Non-nil means indent current line after a semicolon or space. | |
| 442 | Default is nil. | |
| 443 | ||
| f2727dfb RS |
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-mode-startup-message | |
| 465 | Nil means do not display the Octave mode startup message. | |
| 466 | Default is t. | |
| 467 | ||
| 468 | octave-send-echo-input | |
| 469 | Non-nil means always display `inferior-octave-buffer' after sending a | |
| 470 | command to the inferior Octave process. | |
| 471 | ||
| 472 | octave-send-line-auto-forward | |
| 473 | Non-nil means always go to the next unsent line of Octave code after | |
| 474 | sending a line to the inferior Octave process. | |
| 475 | ||
| 476 | octave-send-echo-input | |
| 477 | Non-nil means echo input sent to the inferior Octave process. | |
| 478 | ||
| 479 | Turning on Octave mode runs the hook `octave-mode-hook'. | |
| 480 | ||
| 481 | To begin using this mode for all `.m' files that you edit, add the | |
| 482 | following lines to your `.emacs' file: | |
| 483 | ||
| 484 | (autoload 'octave-mode \"octave-mod\" nil t) | |
| 485 | (setq auto-mode-alist | |
| 486 | (cons '(\"\\\\.m$\" . octave-mode) auto-mode-alist)) | |
| 487 | ||
| 488 | To automatically turn on the abbrev, auto-fill and font-lock features, | |
| 489 | add the following lines to your `.emacs' file as well: | |
| 490 | ||
| 491 | (add-hook 'octave-mode-hook | |
| 492 | (lambda () | |
| 493 | (abbrev-mode 1) | |
| 494 | (auto-fill-mode 1) | |
| 495 | (if (eq window-system 'x) | |
| 496 | (font-lock-mode 1)))) | |
| 497 | ||
| 498 | To submit a problem report, enter \\[octave-submit-bug-report] from \ | |
| 499 | an Octave mode buffer. | |
| 500 | This automatically sets up a mail buffer with version information | |
| 501 | already added. You just need to add a description of the problem, | |
| 502 | including a reproducible test case and send the message." | |
| 503 | (interactive) | |
| 504 | (kill-all-local-variables) | |
| 505 | ||
| 506 | (use-local-map octave-mode-map) | |
| 507 | (setq major-mode 'octave-mode) | |
| 508 | (setq mode-name "Octave") | |
| 509 | (setq local-abbrev-table octave-abbrev-table) | |
| 510 | (set-syntax-table octave-mode-syntax-table) | |
| 511 | ||
| 512 | (make-local-variable 'indent-line-function) | |
| 513 | (setq indent-line-function 'octave-indent-line) | |
| 514 | ||
| 515 | (make-local-variable 'comment-start) | |
| 516 | (setq comment-start octave-comment-start) | |
| 517 | (make-local-variable 'comment-end) | |
| 518 | (setq comment-end "") | |
| 519 | (make-local-variable 'comment-column) | |
| 520 | (setq comment-column 32) | |
| 521 | (make-local-variable 'comment-start-skip) | |
| 522 | (setq comment-start-skip "\\s<+\\s-*") | |
| 523 | (make-local-variable 'comment-indent-function) | |
| 524 | (setq comment-indent-function 'octave-comment-indent) | |
| 525 | ||
| 526 | (make-local-variable 'parse-sexp-ignore-comments) | |
| 527 | (setq parse-sexp-ignore-comments t) | |
| 528 | (make-local-variable 'paragraph-start) | |
| 529 | (setq paragraph-start (concat "\\s-*$\\|" page-delimiter)) | |
| 530 | (make-local-variable 'paragraph-separate) | |
| 531 | (setq paragraph-separate paragraph-start) | |
| 532 | (make-local-variable 'paragraph-ignore-fill-prefix) | |
| 533 | (setq paragraph-ignore-fill-prefix t) | |
| 534 | (make-local-variable 'fill-paragraph-function) | |
| 535 | (setq fill-paragraph-function 'octave-fill-paragraph) | |
| 536 | (make-local-variable 'adaptive-fill-regexp) | |
| 537 | (setq adaptive-fill-regexp nil) | |
| 538 | (make-local-variable 'fill-column) | |
| 539 | (setq fill-column 72) | |
| 540 | (make-local-variable 'normal-auto-fill-function) | |
| 541 | (setq normal-auto-fill-function 'octave-auto-fill) | |
| 542 | ||
| 543 | (make-local-variable 'font-lock-defaults) | |
| 544 | (setq font-lock-defaults '(octave-font-lock-keywords nil nil)) | |
| 545 | ||
| 546 | (make-local-variable 'imenu-generic-expression) | |
| c0b08eb0 DL |
547 | (setq imenu-generic-expression octave-mode-imenu-generic-expression |
| 548 | imenu-case-fold-search nil) | |
| f2727dfb RS |
549 | |
| 550 | (octave-add-octave-menu) | |
| 551 | (octave-initialize-completions) | |
| 777874d0 | 552 | (run-hooks 'octave-mode-hook)) |
| f2727dfb RS |
553 | \f |
| 554 | ;;; Miscellaneous useful functions | |
| 555 | (defun octave-describe-major-mode () | |
| 556 | "Describe the current major mode." | |
| 557 | (interactive) | |
| 558 | (describe-function major-mode)) | |
| 559 | ||
| 560 | (defun octave-point (position) | |
| 561 | "Returns the value of point at certain positions." | |
| 562 | (save-excursion | |
| 563 | (cond | |
| 564 | ((eq position 'bol) (beginning-of-line)) | |
| 565 | ((eq position 'eol) (end-of-line)) | |
| 566 | ((eq position 'boi) (back-to-indentation)) | |
| 567 | ((eq position 'bonl) (forward-line 1)) | |
| 568 | ((eq position 'bopl) (forward-line -1)) | |
| 569 | (t (error "unknown buffer position requested: %s" position))) | |
| 570 | (point))) | |
| 571 | ||
| 572 | (defsubst octave-in-comment-p () | |
| 573 | "Returns t if point is inside an Octave comment, nil otherwise." | |
| 574 | (interactive) | |
| 575 | (save-excursion | |
| 576 | (nth 4 (parse-partial-sexp (octave-point 'bol) (point))))) | |
| 577 | ||
| 578 | (defsubst octave-in-string-p () | |
| 579 | "Returns t if point is inside an Octave string, nil otherwise." | |
| 580 | (interactive) | |
| 581 | (save-excursion | |
| 582 | (nth 3 (parse-partial-sexp (octave-point 'bol) (point))))) | |
| 583 | ||
| 584 | (defsubst octave-not-in-string-or-comment-p () | |
| 585 | "Returns t iff point is not inside an Octave string or comment." | |
| 586 | (let ((pps (parse-partial-sexp (octave-point 'bol) (point)))) | |
| 587 | (not (or (nth 3 pps) (nth 4 pps))))) | |
| 588 | ||
| 589 | (defun octave-in-block-p () | |
| 590 | "Returns t if point is inside an Octave block, nil otherwise. | |
| 591 | The block is taken to start at the first letter of the begin keyword and | |
| 592 | to end after the end keyword." | |
| 593 | (let ((pos (point))) | |
| 594 | (save-excursion | |
| 595 | (condition-case nil | |
| 596 | (progn | |
| 597 | (skip-syntax-forward "w") | |
| 598 | (octave-up-block -1) | |
| 599 | (octave-forward-block) | |
| 600 | t) | |
| 601 | (error nil)) | |
| 602 | (< pos (point))))) | |
| 603 | ||
| 604 | (defun octave-in-defun-p () | |
| 605 | "Returns t iff point is inside an Octave function declaration. | |
| 606 | The function is taken to start at the `f' of `function' and to end after | |
| 607 | the end keyword." | |
| 608 | (let ((pos (point))) | |
| 609 | (save-excursion | |
| 610 | (or (and (looking-at "\\<function\\>") | |
| 611 | (octave-not-in-string-or-comment-p)) | |
| 612 | (and (octave-beginning-of-defun) | |
| 613 | (condition-case nil | |
| 614 | (progn | |
| 615 | (octave-forward-block) | |
| 616 | t) | |
| 617 | (error nil)) | |
| 618 | (< pos (point))))))) | |
| 619 | ||
| d83ee578 KH |
620 | (defun octave-maybe-insert-continuation-string () |
| 621 | (if (or (octave-in-comment-p) | |
| 622 | (save-excursion | |
| 623 | (beginning-of-line) | |
| 624 | (looking-at octave-continuation-regexp))) | |
| 625 | nil | |
| 626 | (delete-horizontal-space) | |
| 627 | (insert (concat " " octave-continuation-string)))) | |
| 628 | ||
| aa82f4fb KH |
629 | (defvar octave-xemacs-p |
| 630 | (string-match "XEmacs\\|Lucid" emacs-version)) | |
| 631 | ||
| f2727dfb RS |
632 | ;;; Comments |
| 633 | (defun octave-comment-region (beg end &optional arg) | |
| 634 | "Comment or uncomment each line in the region as Octave code. | |
| 635 | See `comment-region'." | |
| 636 | (interactive "r\nP") | |
| 637 | (let ((comment-start (char-to-string octave-comment-char))) | |
| 638 | (comment-region beg end arg))) | |
| 639 | ||
| 640 | (defun octave-uncomment-region (beg end &optional arg) | |
| 641 | "Uncomment each line in the region as Octave code." | |
| 642 | (interactive "r\nP") | |
| 643 | (or arg (setq arg 1)) | |
| 644 | (octave-comment-region beg end (- arg))) | |
| 645 | ||
| 646 | \f | |
| 647 | ;;; Indentation | |
| 648 | (defun calculate-octave-indent () | |
| 649 | "Return appropriate indentation for current line as Octave code. | |
| 650 | Returns an integer (the column to indent to) unless the line is a | |
| 651 | comment line with fixed goal golumn. In that case, returns a list whose | |
| 652 | car is the column to indent to, and whose cdr is the current indentation | |
| 653 | level." | |
| 654 | (let ((is-continuation-line | |
| 655 | (save-excursion | |
| 656 | (if (zerop (octave-previous-code-line)) | |
| 657 | (looking-at octave-continuation-regexp)))) | |
| 658 | (icol 0)) | |
| 659 | (save-excursion | |
| 660 | (beginning-of-line) | |
| 661 | ;; If we can move backward out one level of parentheses, take 1 | |
| 662 | ;; plus the indentation of that parenthesis. Otherwise, go back | |
| 663 | ;; to the beginning of the previous code line, and compute the | |
| 664 | ;; offset this line gives. | |
| 665 | (if (condition-case nil | |
| 666 | (progn | |
| 667 | (up-list -1) | |
| 668 | t) | |
| 669 | (error nil)) | |
| 670 | (setq icol (+ 1 (current-column))) | |
| 671 | (if (zerop (octave-previous-code-line)) | |
| 672 | (progn | |
| 673 | (octave-beginning-of-line) | |
| 674 | (back-to-indentation) | |
| 675 | (setq icol (current-column)) | |
| 676 | (let ((bot (point)) | |
| 677 | (eol (octave-point 'eol))) | |
| 678 | (while (< (point) eol) | |
| 679 | (if (octave-not-in-string-or-comment-p) | |
| 680 | (cond | |
| 6e6d2764 KH |
681 | ((looking-at "\\<switch\\>") |
| 682 | (setq icol (+ icol (* 2 octave-block-offset)))) | |
| f2727dfb RS |
683 | ((looking-at octave-block-begin-regexp) |
| 684 | (setq icol (+ icol octave-block-offset))) | |
| 685 | ((looking-at octave-block-else-regexp) | |
| 686 | (if (= bot (point)) | |
| 687 | (setq icol (+ icol octave-block-offset)))) | |
| 688 | ((looking-at octave-block-end-regexp) | |
| 689 | (if (not (= bot (point))) | |
| 6e6d2764 KH |
690 | (setq icol (- icol |
| 691 | (octave-block-end-offset))))))) | |
| f2727dfb RS |
692 | (forward-char))) |
| 693 | (if is-continuation-line | |
| 694 | (setq icol (+ icol octave-continuation-offset))))))) | |
| 695 | (save-excursion | |
| 696 | (back-to-indentation) | |
| 697 | (cond | |
| 6e6d2764 | 698 | ((and (looking-at octave-block-else-regexp) |
| f2727dfb RS |
699 | (octave-not-in-string-or-comment-p)) |
| 700 | (setq icol (- icol octave-block-offset))) | |
| 6e6d2764 KH |
701 | ((and (looking-at octave-block-end-regexp) |
| 702 | (octave-not-in-string-or-comment-p)) | |
| 703 | (setq icol (- icol (octave-block-end-offset)))) | |
| d83ee578 KH |
704 | ((or (looking-at "\\s<\\s<\\s<\\S<") |
| 705 | (octave-before-magic-comment-p)) | |
| f2727dfb RS |
706 | (setq icol (list 0 icol))) |
| 707 | ((looking-at "\\s<\\S<") | |
| 708 | (setq icol (list comment-column icol))))) | |
| 709 | icol)) | |
| 710 | ||
| 6e6d2764 KH |
711 | (defun octave-block-end-offset () |
| 712 | (save-excursion | |
| 713 | (octave-backward-up-block 1) | |
| 714 | (* octave-block-offset | |
| 715 | (if (string-match (match-string 0) "switch") 2 1)))) | |
| 716 | ||
| d83ee578 KH |
717 | (defun octave-before-magic-comment-p () |
| 718 | (save-excursion | |
| 719 | (beginning-of-line) | |
| 720 | (and (bobp) (looking-at "\\s-*#!")))) | |
| 721 | ||
| f2727dfb | 722 | (defun octave-comment-indent () |
| d83ee578 KH |
723 | (if (or (looking-at "\\s<\\s<\\s<") |
| 724 | (octave-before-magic-comment-p)) | |
| f2727dfb RS |
725 | 0 |
| 726 | (if (looking-at "\\s<\\s<") | |
| 727 | (calculate-octave-indent) | |
| 728 | (skip-syntax-backward " ") | |
| 6e6d2764 | 729 | (max (if (bolp) 0 (+ 1 (current-column))) |
| f2727dfb RS |
730 | comment-column)))) |
| 731 | ||
| 732 | (defun octave-indent-for-comment () | |
| 733 | "Maybe insert and indent an Octave comment. | |
| 734 | If there is no comment already on this line, create a code-level comment | |
| 735 | (started by two comment characters) if the line is empty, or an in-line | |
| 736 | comment (started by one comment character) otherwise. | |
| 737 | Point is left after the start of the comment which is properly aligned." | |
| 738 | (interactive) | |
| 739 | (indent-for-comment) | |
| 740 | (indent-according-to-mode)) | |
| 741 | ||
| 742 | (defun octave-indent-line (&optional arg) | |
| 743 | "Indent current line as Octave code. | |
| 744 | With optional ARG, use this as offset unless this line is a comment with | |
| 745 | fixed 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. | |
| 761 | If within code, insert `octave-continuation-string' before breaking the | |
| 762 | line. If within a string, signal an error. | |
| 763 | The 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 | \f | |
| 785 | ;;; Motion | |
| 786 | (defun octave-next-code-line (&optional arg) | |
| 787 | "Move ARG lines of Octave code forward (backward if ARG is negative). | |
| 788 | Skips past all empty and comment lines. Default for ARG is 1. | |
| 789 | ||
| 790 | On 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). | |
| 806 | Skips past all empty and comment lines. Default for ARG is 1. | |
| 807 | ||
| 808 | On 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. | |
| 815 | If on an empty or comment line, go to the beginning of that line. | |
| 816 | Otherwise, move backward to the beginning of the first Octave code line | |
| 817 | which is not inside a continuation statement, i.e., which does not | |
| 818 | follow a code line ending in `...' or `\\', or is inside an open | |
| 819 | parenthesis 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. | |
| 837 | If on an empty or comment line, go to the end of that line. | |
| 838 | Otherwise, move forward to the end of the first Octave code line which | |
| 839 | does 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. | |
| 861 | Returns the character number of the position thus found. | |
| 862 | ||
| 863 | If DEPTH is nonzero, block depth begins counting from that value. | |
| 864 | Only places where the depth in blocks becomes zero are candidates for | |
| 865 | stopping; COUNT such places are counted. | |
| 866 | ||
| 867 | If the beginning or end of the buffer is reached and the depth is wrong, | |
| 868 | an 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. | |
| 894 | With argument, do it that many times. | |
| 895 | Negative 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. | |
| 902 | With argument, do it that many times. | |
| 903 | Negative 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. | |
| 910 | With argument, do this that many times. | |
| 911 | A negative argument means move backward but still go down a level. | |
| 912 | In 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. | |
| 922 | With argument, do this that many times. | |
| 923 | A negative argument means move forward but still to a less deep spot. | |
| 924 | In 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. | |
| 930 | With argument, do this that many times. | |
| 931 | A negative argument means move backward but still to a less deep spot. | |
| 932 | In 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. | |
| 942 | The 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. | |
| 962 | An 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. | |
| 985 | If point is right after an Octave else or end type block keyword, move | |
| 986 | cursor momentarily to the corresponding begin keyword. | |
| 987 | Signal 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 (octave-point 'eol) | |
| 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. | |
| 1033 | With positive ARG, do it that many times. Negative argument -N means | |
| 1034 | move forward to Nth following beginning of a function. | |
| 1035 | Returns 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. | |
| 1055 | With positive ARG, do it that many times. Negative argument -N means | |
| 1056 | move back to Nth preceding end of a function. | |
| 1057 | ||
| 1058 | An 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. | |
| 1072 | The 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 | \f | |
| 1088 | ;;; Filling | |
| 1089 | (defun octave-auto-fill () | |
| d83ee578 KH |
1090 | "Perform auto-fill in Octave mode. |
| 1091 | Returns nil if no feasible place to break the line could be found, and t | |
| 1092 | otherwise." | |
| 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]" (octave-point 'eol) | |
| 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)))) | |
| f2727dfb RS |
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 an 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)))) | |
| d83ee578 KH |
1213 | ;; We might also try to combine continued code lines> Perhaps |
| 1214 | ;; some other time ... | |
| f2727dfb RS |
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 " ")) | |
| d83ee578 KH |
1221 | (or (octave-auto-fill) |
| 1222 | (forward-line 1))))) | |
| f2727dfb RS |
1223 | t))) |
| 1224 | ||
| 1225 | \f | |
| 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. | |
| 1239 | Compare that symbol against Octave's reserved words and builtin | |
| 1240 | variables." | |
| 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)) | |
| 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 | \f | |
| 1281 | ;;; Electric characters && friends | |
| 1282 | (defun octave-reindent-then-newline-and-indent () | |
| 1283 | "Reindent current Octave line, insert newline, and indent the new line. | |
| 1284 | If 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. | |
| d83ee578 KH |
1297 | Maybe expand abbrevs and blink matching block open keywords. |
| 1298 | Reindent the line of `octave-auto-indent' is non-nil. | |
| 1299 | Insert a newline if `octave-auto-newline' is non-nil." | |
| f2727dfb RS |
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)) | |
| d83ee578 KH |
1306 | (if octave-auto-indent |
| 1307 | (indent-according-to-mode)) | |
| f2727dfb RS |
1308 | (insert ";") |
| 1309 | (if octave-auto-newline | |
| 1310 | (newline-and-indent)))) | |
| 1311 | ||
| 1312 | (defun octave-electric-space () | |
| 1313 | "Insert a space in Octave mode. | |
| d83ee578 KH |
1314 | Maybe expand abbrevs and blink matching block open keywords. |
| 1315 | Reindent the line of `octave-auto-indent' is non-nil." | |
| f2727dfb RS |
1316 | (interactive) |
| 1317 | (setq last-command-char ? ) | |
| 1318 | (if (not (octave-not-in-string-or-comment-p)) | |
| 1319 | (progn | |
| 1320 | (indent-according-to-mode) | |
| 1321 | (self-insert-command 1)) | |
| 1322 | (if abbrev-mode (expand-abbrev)) | |
| 1323 | (if octave-blink-matching-block | |
| 1324 | (octave-blink-matching-block-open)) | |
| d83ee578 KH |
1325 | (if (and octave-auto-indent |
| 1326 | (save-excursion | |
| 1327 | (skip-syntax-backward " ") | |
| 1328 | (not (bolp)))) | |
| f2727dfb RS |
1329 | (indent-according-to-mode)) |
| 1330 | (self-insert-command 1))) | |
| 1331 | ||
| 1332 | (defun octave-abbrev-start () | |
| 1333 | "Start entering an Octave abbreviation. | |
| 1334 | If Abbrev mode is turned on, typing ` (grave accent) followed by ? or | |
| 1335 | \\[help-command] lists all Octave abbrevs. Any other key combination is | |
| 1336 | executed normally. | |
| 1337 | Note that all Octave mode abbrevs start with a grave accent." | |
| 1338 | (interactive) | |
| 1339 | (if (not abbrev-mode) | |
| 1340 | (self-insert-command 1) | |
| 1341 | (let (c) | |
| 1342 | (insert last-command-char) | |
| aa82f4fb KH |
1343 | (if (if octave-xemacs-p |
| 1344 | (or (eq (event-to-character (setq c (next-event))) ??) | |
| 1345 | (eq (event-to-character c) help-char)) | |
| 1346 | (or (eq (setq c (read-event)) ??) | |
| 1347 | (eq c help-char))) | |
| 1348 | (let ((abbrev-table-name-list '(octave-abbrev-table))) | |
| f2727dfb RS |
1349 | (list-abbrevs)) |
| 1350 | (setq unread-command-events (list c)))))) | |
| 1351 | ||
| 1352 | (defun octave-insert-defun (name args vals) | |
| 1353 | "Insert an Octave function skeleton. | |
| 1354 | Prompt for the function's name, arguments and return values (to be | |
| 1355 | entered without parens)." | |
| 1356 | (interactive | |
| 1357 | (list | |
| 1358 | (read-from-minibuffer "Function name: " | |
| 1359 | (substring (buffer-name) 0 -2)) | |
| 1360 | (read-from-minibuffer "Arguments: ") | |
| 1361 | (read-from-minibuffer "Return values: "))) | |
| 1362 | (let ((string (format "%s %s (%s)" | |
| 1363 | (cond | |
| 1364 | ((string-equal vals "") | |
| 1365 | vals) | |
| 1366 | ((string-match "[ ,]" vals) | |
| 1367 | (concat " [" vals "] =")) | |
| 1368 | (t | |
| 1369 | (concat " " vals " ="))) | |
| 1370 | name | |
| 1371 | args)) | |
| 1372 | (prefix octave-block-comment-start)) | |
| 1373 | (if (not (bobp)) (newline)) | |
| 1374 | (insert "function" string) | |
| 1375 | (indent-according-to-mode) | |
| 1376 | (newline 2) | |
| 1377 | (insert prefix "usage: " string) | |
| 1378 | (reindent-then-newline-and-indent) | |
| 1379 | (insert prefix) | |
| 1380 | (reindent-then-newline-and-indent) | |
| 1381 | (insert prefix) | |
| 1382 | (indent-according-to-mode) | |
| 1383 | (save-excursion | |
| 1384 | (newline 2) | |
| 1385 | (insert "endfunction") | |
| 1386 | (indent-according-to-mode)))) | |
| 1387 | ||
| 1388 | \f | |
| 1389 | ;;; Menu | |
| 1390 | (defun octave-add-octave-menu () | |
| 1391 | "Adds the `Octave' menu to the menu bar in Octave mode." | |
| 1392 | (require 'easymenu) | |
| 1393 | (easy-menu-define octave-mode-menu-map octave-mode-map | |
| 1394 | "Menu keymap for Octave mode." octave-mode-menu) | |
| 1395 | (easy-menu-add octave-mode-menu-map octave-mode-map)) | |
| 1396 | ||
| 1397 | \f | |
| 1398 | ;;; Communication with the inferior Octave process | |
| 1399 | (defun octave-kill-process () | |
| 1400 | "Kill inferior Octave process and its buffer." | |
| 1401 | (interactive) | |
| 1402 | (if inferior-octave-process | |
| 1403 | (progn | |
| 1404 | (process-send-string inferior-octave-process "quit;\n") | |
| 1405 | (accept-process-output inferior-octave-process))) | |
| 1406 | (if inferior-octave-buffer | |
| 1407 | (kill-buffer inferior-octave-buffer))) | |
| 1408 | ||
| 1409 | (defun octave-show-process-buffer () | |
| 1410 | "Make sure that `inferior-octave-buffer' is displayed." | |
| 1411 | (interactive) | |
| 1412 | (if (get-buffer inferior-octave-buffer) | |
| 1413 | (display-buffer inferior-octave-buffer) | |
| 1414 | (message "No buffer named %s" inferior-octave-buffer))) | |
| 1415 | ||
| 1416 | (defun octave-hide-process-buffer () | |
| 1417 | "Delete all windows that display `inferior-octave-buffer'." | |
| 1418 | (interactive) | |
| 1419 | (if (get-buffer inferior-octave-buffer) | |
| 1420 | (delete-windows-on inferior-octave-buffer) | |
| 1421 | (message "No buffer named %s" inferior-octave-buffer))) | |
| 1422 | ||
| 1423 | (defun octave-send-region (beg end) | |
| 1424 | "Send current region to the inferior Octave process." | |
| 1425 | (interactive "r") | |
| 1426 | (inferior-octave t) | |
| 1427 | (let ((proc inferior-octave-process) | |
| 1428 | (string (buffer-substring-no-properties beg end)) | |
| 1429 | line) | |
| 1430 | (save-excursion | |
| 1431 | (set-buffer inferior-octave-buffer) | |
| 1432 | (setq inferior-octave-output-list nil) | |
| 1433 | (while (not (string-equal string "")) | |
| 1434 | (if (string-match "\n" string) | |
| 1435 | (setq line (substring string 0 (match-beginning 0)) | |
| 1436 | string (substring string (match-end 0))) | |
| 1437 | (setq line string string "")) | |
| 1438 | (setq inferior-octave-receive-in-progress t) | |
| 1439 | (inferior-octave-send-list-and-digest (list (concat line "\n"))) | |
| 1440 | (while inferior-octave-receive-in-progress | |
| 1441 | (accept-process-output proc)) | |
| 1442 | (insert-before-markers | |
| 1443 | (mapconcat 'identity | |
| 1444 | (append | |
| 1445 | (if octave-send-echo-input (list line) (list "")) | |
| 1446 | (mapcar 'inferior-octave-strip-ctrl-g | |
| 1447 | inferior-octave-output-list) | |
| 1448 | (list inferior-octave-output-string)) | |
| 1449 | "\n"))))) | |
| 1450 | (if octave-send-show-buffer | |
| 1451 | (display-buffer inferior-octave-buffer))) | |
| 1452 | ||
| 1453 | (defun octave-send-block () | |
| 1454 | "Send current Octave block to the inferior Octave process." | |
| 1455 | (interactive) | |
| 1456 | (save-excursion | |
| 1457 | (octave-mark-block) | |
| 1458 | (octave-send-region (point) (mark)))) | |
| 1459 | ||
| 1460 | (defun octave-send-defun () | |
| 1461 | "Send current Octave function to the inferior Octave process." | |
| 1462 | (interactive) | |
| 1463 | (save-excursion | |
| 1464 | (octave-mark-defun) | |
| 1465 | (octave-send-region (point) (mark)))) | |
| 1466 | ||
| 1467 | (defun octave-send-line (&optional arg) | |
| 1468 | "Send current Octave code line to the inferior Octave process. | |
| 1469 | With positive prefix ARG, send that many lines. | |
| 1470 | If `octave-send-line-auto-forward' is non-nil, go to the next unsent | |
| 1471 | code line." | |
| 1472 | (interactive "P") | |
| 1473 | (or arg (setq arg 1)) | |
| 1474 | (if (> arg 0) | |
| 1475 | (let (beg end) | |
| 1476 | (beginning-of-line) | |
| 1477 | (setq beg (point)) | |
| 1478 | (octave-next-code-line (- arg 1)) | |
| 1479 | (end-of-line) | |
| 1480 | (setq end (point)) | |
| 1481 | (if octave-send-line-auto-forward | |
| 1482 | (octave-next-code-line 1)) | |
| 1483 | (octave-send-region beg end)))) | |
| 1484 | ||
| 1485 | (defun octave-eval-print-last-sexp () | |
| 1486 | "Evaluate Octave sexp before point and print value into current buffer." | |
| 1487 | (interactive) | |
| 1488 | (inferior-octave t) | |
| 1489 | (let ((standard-output (current-buffer)) | |
| 1490 | (print-escape-newlines nil) | |
| 1491 | (opoint (point))) | |
| 1492 | (terpri) | |
| 1493 | (prin1 | |
| 1494 | (save-excursion | |
| 1495 | (forward-sexp -1) | |
| 1496 | (inferior-octave-send-list-and-digest | |
| 1497 | (list (concat (buffer-substring-no-properties (point) opoint) | |
| 1498 | "\n"))) | |
| 1499 | (mapconcat 'identity inferior-octave-output-list "\n"))) | |
| 1500 | (terpri))) | |
| d1e49742 | 1501 | \f |
| d1e49742 RS |
1502 | ;;; Bug reporting |
| 1503 | (defun octave-submit-bug-report () | |
| 1504 | "Submit a bug report on the Emacs Octave package via mail." | |
| 1505 | (interactive) | |
| 1506 | (require 'reporter) | |
| 1507 | (and | |
| 1508 | (y-or-n-p "Do you want to submit a bug report? ") | |
| 1509 | (reporter-submit-bug-report | |
| 1510 | octave-maintainer-address | |
| 1511 | (concat "Emacs version " emacs-version) | |
| 1512 | (list | |
| d83ee578 | 1513 | 'octave-auto-indent |
| d1e49742 RS |
1514 | 'octave-auto-newline |
| 1515 | 'octave-blink-matching-block | |
| 1516 | 'octave-block-offset | |
| 1517 | 'octave-comment-char | |
| 1518 | 'octave-continuation-offset | |
| 1519 | 'octave-continuation-string | |
| 1520 | 'octave-help-files | |
| 1521 | 'octave-mode-startup-message | |
| 1522 | 'octave-send-echo-input | |
| 1523 | 'octave-send-line-auto-forward | |
| 1524 | 'octave-send-show-buffer)))) | |
| 1525 | ||
| 1526 | ;;; provide ourself | |
| 1527 | ||
| e7017ef9 | 1528 | (provide 'octave-mod) |
| d1e49742 RS |
1529 | |
| 1530 | ;;; octave-mod.el ends here |