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