-;;; octave.el --- editing octave source files under emacs -*- lexical-binding: t; -*-
+;;; octave.el --- editing octave source files under emacs -*- lexical-binding: t; -*-
;; Copyright (C) 1997, 2001-2013 Free Software Foundation, Inc.
;;; Commentary:
-;; This package provides emacs support for octave. It defines a major
-;; mode for editing octave code and contains code for interacting with
-;; an inferior octave process using comint.
+;; This package provides Emacs support for Octave. It defines a major
+;; mode for editing Octave code and contains code for interacting with
+;; an inferior Octave process using comint.
;; See the documentation of `octave-mode' and `run-octave' for further
;; information on usage and customization.
(require 'newcomment)
(eval-and-compile
(unless (fboundp 'user-error)
- (defalias 'user-error 'error)))
+ (defalias 'user-error 'error))
+ (unless (fboundp 'delete-consecutive-dups)
+ (defalias 'delete-consecutive-dups 'delete-dups)))
(eval-when-compile
(unless (fboundp 'setq-local)
(defmacro setq-local (var val)
(defvar octave-comment-char ?#
"Character to start an Octave comment.")
-(defvar octave-comment-start
- (string octave-comment-char ?\s)
- "String to insert to start a new Octave in-line comment.")
+(defvar octave-comment-start (char-to-string octave-comment-char)
+ "Octave-specific `comment-start' (which see).")
-(defvar octave-comment-start-skip "\\s<+\\s-*"
- "Regexp to match the start of an Octave comment up to its body.")
+(defvar octave-comment-start-skip "\\(^\\|\\S<\\)\\(?:%!\\|\\s<+\\)\\s-*"
+ "Octave-specific `comment-start-skip' (which see).")
(defvar octave-begin-keywords
- '("do" "for" "function" "if" "switch" "try" "unwind_protect" "while"))
+ '("classdef" "do" "enumeration" "events" "for" "function" "if" "methods"
+ "parfor" "properties" "switch" "try" "unwind_protect" "while"))
(defvar octave-else-keywords
'("case" "catch" "else" "elseif" "otherwise" "unwind_protect_cleanup"))
(defvar octave-end-keywords
- '("endfor" "endfunction" "endif" "endswitch" "end_try_catch"
+ '("endclassdef" "endenumeration" "endevents" "endfor" "endfunction" "endif"
+ "endmethods" "endparfor" "endproperties" "endswitch" "end_try_catch"
"end_unwind_protect" "endwhile" "until" "end"))
(defvar octave-reserved-words
(append octave-begin-keywords
octave-else-keywords
octave-end-keywords
- '("break" "continue" "end" "global" "persistent" "return"))
+ '("break" "continue" "global" "persistent" "return"))
"Reserved words in Octave.")
-(defvar octave-text-functions
- '("casesen" "cd" "chdir" "clear" "diary" "dir" "document" "echo"
- "edit_history" "format" "help" "history" "hold"
- "load" "ls" "more" "run_history" "save" "type"
- "which" "who" "whos")
- "Text functions in Octave.")
-
(defvar octave-function-header-regexp
(concat "^\\s-*\\_<\\(function\\)\\_>"
- "\\([^=;\n]*=[ \t]*\\|[ \t]*\\)\\(\\(?:\\w\\|\\s_\\)+\\)\\_>")
+ "\\([^=;(\n]*=[ \t]*\\|[ \t]*\\)\\(\\(?:\\w\\|\\s_\\)+\\)\\_>")
"Regexp to match an Octave function header.
The string `function' and its name are given by the first and third
parenthetical grouping.")
\f
-(defvar octave-font-lock-keywords
- (list
- ;; Fontify all builtin keywords.
- (cons (concat "\\_<\\("
- (regexp-opt (append octave-reserved-words
- octave-text-functions))
- "\\)\\_>")
- 'font-lock-keyword-face)
- ;; Note: 'end' also serves as the last index in an indexing expression.
- ;; Ref: http://www.mathworks.com/help/matlab/ref/end.html
- '((lambda (limit)
- (while (re-search-forward "\\_<end\\_>" limit 'move)
- (let ((beg (match-beginning 0))
- (end (match-end 0)))
- (unless (octave-in-string-or-comment-p)
- (unwind-protect
- (progn
- (goto-char beg)
- (backward-up-list)
- (when (memq (char-after) '(?\( ?\[ ?\{))
- (put-text-property beg end 'face nil)))
- (goto-char end)))))
- nil))
- ;; Fontify all builtin operators.
- (cons "\\(&\\||\\|<=\\|>=\\|==\\|<\\|>\\|!=\\|!\\)"
- (if (boundp 'font-lock-builtin-face)
- 'font-lock-builtin-face
- 'font-lock-preprocessor-face))
- ;; Fontify all function declarations.
- (list octave-function-header-regexp
- '(1 font-lock-keyword-face)
- '(3 font-lock-function-name-face nil t)))
- "Additional Octave expressions to highlight.")
-
-(defun octave-syntax-propertize-function (start end)
- (goto-char start)
- (octave-syntax-propertize-sqs end)
- (funcall (syntax-propertize-rules
- ;; Try to distinguish the string-quotes from the transpose-quotes.
- ("\\(?:^\\|[[({,; ]\\)\\('\\)"
- (1 (prog1 "\"'" (octave-syntax-propertize-sqs end)))))
- (point) end))
-
-(defun octave-syntax-propertize-sqs (end)
- "Propertize the content/end of single-quote strings."
- (when (eq (nth 3 (syntax-ppss)) ?\')
- ;; A '..' string.
- (when (re-search-forward
- "\\(?:\\=\\|[^']\\)\\(?:''\\)*\\('\\)\\($\\|[^']\\)" end 'move)
- (goto-char (match-beginning 2))
- (when (eq (char-before (match-beginning 1)) ?\\)
- ;; Backslash cannot escape a single quote.
- (put-text-property (1- (match-beginning 1)) (match-beginning 1)
- 'syntax-table (string-to-syntax ".")))
- (put-text-property (match-beginning 1) (match-end 1)
- 'syntax-table (string-to-syntax "\"'")))))
-
-\f
(defvar octave-mode-map
(let ((map (make-sparse-keymap)))
- (define-key map "\M-." 'octave-find-definition)
- (define-key map "\e\n" 'octave-indent-new-comment-line)
- (define-key map "\M-\C-q" 'octave-indent-defun)
+ (define-key map "\M-." 'octave-find-definition)
+ (define-key map "\M-\C-j" 'octave-indent-new-comment-line)
(define-key map "\C-c\C-p" 'octave-previous-code-line)
(define-key map "\C-c\C-n" 'octave-next-code-line)
(define-key map "\C-c\C-a" 'octave-beginning-of-line)
(define-key map "\C-c/" 'smie-close-block)
(define-key map "\C-c;" 'octave-update-function-file-comment)
(define-key map "\C-hd" 'octave-help)
+ (define-key map "\C-ha" 'octave-lookfor)
(define-key map "\C-c\C-f" 'octave-insert-defun)
(define-key map "\C-c\C-il" 'octave-send-line)
(define-key map "\C-c\C-ib" 'octave-send-block)
(define-key map "\C-c\C-if" 'octave-send-defun)
(define-key map "\C-c\C-ir" 'octave-send-region)
+ (define-key map "\C-c\C-ia" 'octave-send-buffer)
(define-key map "\C-c\C-is" 'octave-show-process-buffer)
(define-key map "\C-c\C-iq" 'octave-hide-process-buffer)
(define-key map "\C-c\C-ik" 'octave-kill-process)
(define-key map "\C-c\C-i\C-b" 'octave-send-block)
(define-key map "\C-c\C-i\C-f" 'octave-send-defun)
(define-key map "\C-c\C-i\C-r" 'octave-send-region)
+ (define-key map "\C-c\C-i\C-a" 'octave-send-buffer)
(define-key map "\C-c\C-i\C-s" 'octave-show-process-buffer)
(define-key map "\C-c\C-i\C-q" 'octave-hide-process-buffer)
(define-key map "\C-c\C-i\C-k" 'octave-kill-process)
(easy-menu-define octave-mode-menu octave-mode-map
"Menu for Octave mode."
'("Octave"
- ("Lines"
- ["Previous Code Line" octave-previous-code-line t]
- ["Next Code Line" octave-next-code-line t]
- ["Begin of Continuation" octave-beginning-of-line t]
- ["End of Continuation" octave-end-of-line t]
- ["Split Line at Point" octave-indent-new-comment-line t])
- ("Blocks"
- ["Mark Block" octave-mark-block t]
- ["Close Block" smie-close-block t])
- ("Functions"
- ["Indent Function" octave-indent-defun t]
- ["Insert Function" octave-insert-defun t]
- ["Update function file comment" octave-update-function-file-comment t])
- "-"
+ ["Split Line at Point" octave-indent-new-comment-line t]
+ ["Previous Code Line" octave-previous-code-line t]
+ ["Next Code Line" octave-next-code-line t]
+ ["Begin of Line" octave-beginning-of-line t]
+ ["End of Line" octave-end-of-line t]
+ ["Mark Block" octave-mark-block t]
+ ["Close Block" smie-close-block t]
+ "---"
+ ["Start Octave Process" run-octave t]
+ ["Documentation Lookup" info-lookup-symbol t]
+ ["Help on Function" octave-help t]
+ ["Search help" octave-lookfor t]
+ ["Find Function Definition" octave-find-definition t]
+ ["Insert Function" octave-insert-defun t]
+ ["Update Function File Comment" octave-update-function-file-comment t]
+ "---"
+ ["Function Syntax Hints" (call-interactively
+ (if (fboundp 'eldoc-post-insert-mode)
+ 'eldoc-post-insert-mode
+ 'eldoc-mode))
+ :style toggle :selected (or eldoc-post-insert-mode eldoc-mode)
+ :help "Display function signatures after typing `SPC' or `('"]
+ ["Delimiter Matching" show-paren-mode
+ :style toggle :selected show-paren-mode
+ :help "Highlight matched pairs such as `if ... end'"
+ :visible (fboundp 'smie--matching-block-data)]
+ ["Auto Fill" auto-fill-mode
+ :style toggle :selected auto-fill-function
+ :help "Automatic line breaking"]
+ ["Electric Layout" electric-layout-mode
+ :style toggle :selected electric-layout-mode
+ :help "Automatically insert newlines around some chars"]
+ "---"
("Debug"
- ["Send Current Line" octave-send-line t]
- ["Send Current Block" octave-send-block t]
- ["Send Current Function" octave-send-defun t]
- ["Send Region" octave-send-region t]
- ["Show Process Buffer" octave-show-process-buffer t]
- ["Hide Process Buffer" octave-hide-process-buffer t]
- ["Kill Process" octave-kill-process t])
- "-"
- ["Indent Line" indent-according-to-mode t]
- ["Complete Symbol" completion-at-point t]
- ["Toggle Auto-Fill Mode" auto-fill-mode
- :style toggle :selected auto-fill-function]
- "-"
- ["Describe Octave Mode" describe-mode t]
- ["Lookup Octave Index" info-lookup-symbol t]
- ["Customize Octave" (customize-group 'octave) t]
- "-"
- ["Submit Bug Report" report-emacs-bug t]))
+ ["Send Current Line" octave-send-line t]
+ ["Send Current Block" octave-send-block t]
+ ["Send Current Function" octave-send-defun t]
+ ["Send Region" octave-send-region t]
+ ["Send Buffer" octave-send-buffer t]
+ ["Show Process Buffer" octave-show-process-buffer t]
+ ["Hide Process Buffer" octave-hide-process-buffer t]
+ ["Kill Process" octave-kill-process t])
+ "---"
+ ["Customize Octave" (customize-group 'octave) t]
+ ["Submit Bug Report" report-emacs-bug t]))
(defvar octave-mode-syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?! "." table)
(modify-syntax-entry ?\\ "." table)
(modify-syntax-entry ?\' "." table)
- ;; Was "w" for abbrevs, but now that it's not necessary any more,
(modify-syntax-entry ?\` "." table)
+ (modify-syntax-entry ?. "." table)
(modify-syntax-entry ?\" "\"" table)
- (modify-syntax-entry ?. "_" table)
(modify-syntax-entry ?_ "_" table)
;; The "b" flag only applies to the second letter of the comstart
;; and the first letter of the comend, i.e. the "4b" below is ineffective.
(require 'smie)
+;; Use '__operators__' in Octave REPL to get a full list.
(defconst octave-operator-table
'((assoc ";" "\n") (assoc ",") ; The doc claims they have equal precedence!?
(right "=" "+=" "-=" "*=" "/=")
("unwind_protect" exp "unwind_protect_cleanup" exp "end")
("for" exp "endfor")
("for" exp "end")
+ ("parfor" exp "endparfor")
+ ("parfor" exp "end")
("do" exp "until" atom)
("while" exp "endwhile")
("while" exp "end")
("switch" exp "case" exp "case" exp "otherwise" exp "endswitch")
("switch" exp "case" exp "case" exp "otherwise" exp "end")
("function" exp "endfunction")
- ("function" exp "end"))
+ ("function" exp "end")
+ ("enumeration" exp "endenumeration")
+ ("enumeration" exp "end")
+ ("events" exp "endevents")
+ ("events" exp "end")
+ ("methods" exp "endmethods")
+ ("methods" exp "end")
+ ("properties" exp "endproperties")
+ ("properties" exp "end")
+ ("classdef" exp "endclassdef")
+ ("classdef" exp "end"))
;; (fundesc (atom "=" atom))
))
(goto-char (match-end 1))
(forward-comment 1))
(cond
- ((and (looking-at "$\\|[%#]")
- ;; Ignore it if it's within parentheses or if the newline does not end
- ;; some preceding text.
- (prog1 (and (not (smie-rule-bolp))
- (let ((ppss (syntax-ppss)))
- (not (and (nth 1 ppss)
- (eq ?\( (char-after (nth 1 ppss)))))))
- (forward-comment (point-max))))
+ ((and (looking-at "[%#\n]")
+ (not (or (save-excursion (skip-chars-backward " \t")
+ ;; Only add implicit ; when needed.
+ (or (bolp) (eq (char-before) ?\;)))
+ ;; Ignore it if it's within parentheses.
+ (let ((ppss (syntax-ppss)))
+ (and (nth 1 ppss)
+ (eq ?\( (char-after (nth 1 ppss))))))))
+ (if (eolp) (forward-char 1) (forward-comment 1))
;; Why bother distinguishing \n and ;?
";") ;;"\n"
+ ((progn (forward-comment (point-max)) nil))
((looking-at ";[ \t]*\\($\\|[%#]\\)")
;; Combine the ; with the subsequent \n.
(goto-char (match-beginning 1))
;; aligns it with "switch".
(`(:before . "case") (if (not (smie-rule-sibling-p)) octave-block-offset))
(`(:after . ";")
- (if (smie-rule-parent-p "function" "if" "while" "else" "elseif" "for"
- "otherwise" "case" "try" "catch" "unwind_protect"
+ (if (smie-rule-parent-p "classdef" "events" "enumeration" "function" "if"
+ "while" "else" "elseif" "for" "parfor"
+ "properties" "methods" "otherwise" "case"
+ "try" "catch" "unwind_protect"
"unwind_protect_cleanup")
(smie-rule-parent octave-block-offset)
;; For (invalid) code between switch and case.
;; (if (smie-parent-p "switch") 4)
- 0))))
+ nil))))
+
+(defun octave-indent-comment ()
+ "A function for `smie-indent-functions' (which see)."
+ (save-excursion
+ (back-to-indentation)
+ (cond
+ ((octave-in-string-or-comment-p) nil)
+ ((looking-at-p "\\(\\s<\\)\\1\\{2,\\}")
+ 0)
+ ;; Exclude %{, %} and %!.
+ ((and (looking-at-p "\\s<\\(?:[^{}!]\\|$\\)")
+ (not (looking-at-p "\\(\\s<\\)\\1")))
+ (comment-choose-indent)))))
+
+\f
+(defvar octave-font-lock-keywords
+ (list
+ ;; Fontify all builtin keywords.
+ (cons (concat "\\_<\\("
+ (regexp-opt octave-reserved-words)
+ "\\)\\_>")
+ 'font-lock-keyword-face)
+ ;; Note: 'end' also serves as the last index in an indexing expression.
+ ;; Ref: http://www.mathworks.com/help/matlab/ref/end.html
+ (list (lambda (limit)
+ (while (re-search-forward "\\_<end\\_>" limit 'move)
+ (let ((beg (match-beginning 0))
+ (end (match-end 0)))
+ (unless (octave-in-string-or-comment-p)
+ (condition-case nil
+ (progn
+ (goto-char beg)
+ (backward-up-list)
+ (when (memq (char-after) '(?\( ?\[ ?\{))
+ (put-text-property beg end 'face nil))
+ (goto-char end))
+ (error (goto-char end))))))
+ nil))
+ ;; Fontify all operators.
+ (cons octave-operator-regexp 'font-lock-builtin-face)
+ ;; Fontify all function declarations.
+ (list octave-function-header-regexp
+ '(1 font-lock-keyword-face)
+ '(3 font-lock-function-name-face nil t)))
+ "Additional Octave expressions to highlight.")
+
+(defun octave-syntax-propertize-function (start end)
+ (goto-char start)
+ (octave-syntax-propertize-sqs end)
+ (funcall (syntax-propertize-rules
+ ("\\\\" (0 (when (eq (nth 3 (save-excursion
+ (syntax-ppss (match-beginning 0))))
+ ?\")
+ (string-to-syntax "\\"))))
+ ;; Try to distinguish the string-quotes from the transpose-quotes.
+ ("\\(?:^\\|[[({,; ]\\)\\('\\)"
+ (1 (prog1 "\"'" (octave-syntax-propertize-sqs end)))))
+ (point) end))
+
+(defun octave-syntax-propertize-sqs (end)
+ "Propertize the content/end of single-quote strings."
+ (when (eq (nth 3 (syntax-ppss)) ?\')
+ ;; A '..' string.
+ (when (re-search-forward
+ "\\(?:\\=\\|[^']\\)\\(?:''\\)*\\('\\)\\($\\|[^']\\)" end 'move)
+ (goto-char (match-beginning 2))
+ (when (eq (char-before (match-beginning 1)) ?\\)
+ ;; Backslash cannot escape a single quote.
+ (put-text-property (1- (match-beginning 1)) (match-beginning 1)
+ 'syntax-table (string-to-syntax ".")))
+ (put-text-property (match-beginning 1) (match-end 1)
+ 'syntax-table (string-to-syntax "\"'")))))
(defvar electric-layout-rules)
:forward-token #'octave-smie-forward-token
:backward-token #'octave-smie-backward-token)
(setq-local smie-indent-basic 'octave-block-offset)
+ (add-hook 'smie-indent-functions #'octave-indent-comment nil t)
(setq-local smie-blink-matching-triggers
(cons ?\; smie-blink-matching-triggers))
;; a ";" at those places where it's correct (i.e. outside of parens).
(setq-local electric-layout-rules '((?\; . after)))
+ (setq-local comment-use-global-state t)
(setq-local comment-start octave-comment-start)
(setq-local comment-end "")
- ;; Don't set it here: it's not really a property of the language,
- ;; just a personal preference of the author.
- ;; (setq-local comment-column 32)
- (setq-local comment-start-skip "\\s<+\\s-*")
+ (setq-local comment-start-skip octave-comment-start-skip)
(setq-local comment-add 1)
(setq-local parse-sexp-ignore-comments t)
(setq-local paragraph-separate paragraph-start)
(setq-local paragraph-ignore-fill-prefix t)
(setq-local fill-paragraph-function 'octave-fill-paragraph)
- ;; FIXME: Why disable it?
- ;; (setq-local adaptive-fill-regexp nil)
- ;; Again, this is not a property of the language, don't set it here.
- ;; (setq fill-column 72)
- (setq-local normal-auto-fill-function 'octave-auto-fill)
+
+ (setq-local fill-nobreak-predicate
+ (lambda () (eq (octave-in-string-p) ?')))
+ (with-no-warnings
+ (if (fboundp 'add-function) ; new in 24.4
+ (add-function :around (local 'comment-line-break-function)
+ #'octave--indent-new-comment-line)
+ (setq-local comment-line-break-function
+ (apply-partially #'octave--indent-new-comment-line
+ #'comment-indent-new-line))))
(setq font-lock-defaults '(octave-font-lock-keywords))
(setq-local syntax-propertize-function #'octave-syntax-propertize-function)
- (setq imenu-generic-expression octave-mode-imenu-generic-expression)
- (setq imenu-case-fold-search nil)
+ (setq-local imenu-generic-expression octave-mode-imenu-generic-expression)
+ (setq-local imenu-case-fold-search nil)
+
+ (setq-local add-log-current-defun-function #'octave-add-log-current-defun)
- (add-hook 'completion-at-point-functions
- 'octave-completion-at-point-function nil t)
+ (add-hook 'completion-at-point-functions 'octave-completion-at-point nil t)
(add-hook 'before-save-hook 'octave-sync-function-file-names nil t)
(setq-local beginning-of-defun-function 'octave-beginning-of-defun)
(and octave-font-lock-texinfo-comment (octave-font-lock-texinfo-comment))
+ (setq-local eldoc-documentation-function 'octave-eldoc-function)
(easy-menu-add octave-mode-menu))
:version "24.4")
(defcustom inferior-octave-startup-file
- (convert-standard-filename
- (concat "~/.emacs-" (file-name-nondirectory inferior-octave-program)))
+ (let ((n (file-name-nondirectory inferior-octave-program)))
+ (locate-user-emacs-file (format "init_%s.m" n) (format ".emacs-%s" n)))
"Name of the inferior Octave startup file.
The contents of this file are sent to the inferior Octave process on
startup."
:group 'octave
:version "24.4")
-(defcustom inferior-octave-startup-args nil
+(defcustom inferior-octave-startup-args '("-i" "--no-line-editing")
"List of command line arguments for the inferior Octave process.
For example, for suppressing the startup message and using `traditional'
-mode, set this to (\"-q\" \"--traditional\")."
+mode, include \"-q\" and \"--traditional\"."
:type '(repeat string)
- :group 'octave)
+ :group 'octave
+ :version "24.4")
(defcustom inferior-octave-mode-hook nil
"Hook to be run when Inferior Octave mode is started."
:type 'hook
:group 'octave)
+(defcustom inferior-octave-error-regexp-alist
+ '(("error:\\s-*\\(.*?\\) at line \\([0-9]+\\), column \\([0-9]+\\)"
+ 1 2 3 2 1)
+ ("warning:\\s-*\\([^:\n]+\\):.*at line \\([0-9]+\\), column \\([0-9]+\\)"
+ 1 2 3 1 1))
+ "Value for `compilation-error-regexp-alist' in inferior octave."
+ :type '(repeat (choice (symbol :tag "Predefined symbol")
+ (sexp :tag "Error specification")))
+ :group 'octave)
+
+(defvar inferior-octave-compilation-font-lock-keywords
+ '(("\\_<PASS\\_>" . compilation-info-face)
+ ("\\_<FAIL\\_>" . compilation-error-face)
+ ("\\_<\\(warning\\):" 1 compilation-warning-face)
+ ("\\_<\\(error\\):" 1 compilation-error-face)
+ ("^\\s-*!!!!!.*\\|^.*failed$" . compilation-error-face))
+ "Value for `compilation-mode-font-lock-keywords' in inferior octave.")
+
(defvar inferior-octave-process nil)
(defvar inferior-octave-mode-map
(define-key map "\M-." 'octave-find-definition)
(define-key map "\t" 'completion-at-point)
(define-key map "\C-hd" 'octave-help)
+ (define-key map "\C-ha" 'octave-lookfor)
;; Same as in `shell-mode'.
(define-key map "\M-?" 'comint-dynamic-list-filename-completions)
(define-key map "\C-c\C-l" 'inferior-octave-dynamic-list-input-ring)
(defvar inferior-octave-mode-syntax-table
(let ((table (make-syntax-table octave-mode-syntax-table)))
table)
- "Syntax table in use in inferior-octave-mode buffers.")
+ "Syntax table in use in `inferior-octave-mode' buffers.")
(defvar inferior-octave-font-lock-keywords
(list
in the Inferior Octave buffer.")
(defvar info-lookup-mode)
+(defvar compilation-error-regexp-alist)
+(defvar compilation-mode-font-lock-keywords)
+
+(declare-function compilation-forget-errors "compile" ())
(define-derived-mode inferior-octave-mode comint-mode "Inferior Octave"
"Major mode for interacting with an inferior Octave process."
:abbrev-table octave-abbrev-table
(setq comint-prompt-regexp inferior-octave-prompt)
+ (setq-local comment-use-global-state t)
(setq-local comment-start octave-comment-start)
(setq-local comment-end "")
(setq comment-column 32)
(setq font-lock-defaults '(inferior-octave-font-lock-keywords nil nil))
- (setq info-lookup-mode 'octave-mode)
+ (setq-local info-lookup-mode 'octave-mode)
+ (setq-local eldoc-documentation-function 'octave-eldoc-function)
(setq comint-input-ring-file-name
- (or (getenv "OCTAVE_HISTFILE") "~/.octave_hist")
- comint-input-ring-size (or (getenv "OCTAVE_HISTSIZE") 1024))
+ (or (getenv "OCTAVE_HISTFILE") "~/.octave_hist")
+ comint-input-ring-size (or (getenv "OCTAVE_HISTSIZE") 1024))
+ (comint-read-input-ring t)
(setq-local comint-dynamic-complete-functions
inferior-octave-dynamic-complete-functions)
(setq-local comint-prompt-read-only inferior-octave-prompt-read-only)
(add-hook 'comint-input-filter-functions
- 'inferior-octave-directory-tracker nil t)
- (comint-read-input-ring t))
+ 'inferior-octave-directory-tracker nil t)
+ ;; http://thread.gmane.org/gmane.comp.gnu.octave.general/48572
+ (add-hook 'window-configuration-change-hook
+ 'inferior-octave-track-window-width-change nil t)
+ (setq-local compilation-error-regexp-alist inferior-octave-error-regexp-alist)
+ (setq-local compilation-mode-font-lock-keywords
+ inferior-octave-compilation-font-lock-keywords)
+ (compilation-shell-minor-mode 1)
+ (compilation-forget-errors))
;;;###autoload
(defun inferior-octave (&optional arg)
startup file, `~/.emacs-octave'."
(interactive "P")
(let ((buffer (get-buffer-create inferior-octave-buffer)))
+ (unless arg
+ (pop-to-buffer buffer))
(unless (comint-check-proc buffer)
(with-current-buffer buffer
(inferior-octave-startup)
(inferior-octave-mode)))
- (unless arg
- (pop-to-buffer buffer))
buffer))
;;;###autoload
(substring inferior-octave-buffer 1 -1)
inferior-octave-buffer
inferior-octave-program
- (append (list "-i" "--no-line-editing")
- inferior-octave-startup-args))))
+ (append
+ inferior-octave-startup-args
+ ;; --no-gui is introduced in Octave > 3.7
+ (and (not (member "--no-gui" inferior-octave-startup-args))
+ (zerop (process-file inferior-octave-program
+ nil nil nil "--no-gui" "--help"))
+ '("--no-gui"))))))
(set-process-filter proc 'inferior-octave-output-digest)
(setq inferior-octave-process proc
inferior-octave-output-list nil
;; output may be mixed up). Hence, we need to digest the Octave
;; output to see when it issues a prompt.
(while inferior-octave-receive-in-progress
+ (or (process-live-p inferior-octave-process)
+ (error "Process `%s' died" inferior-octave-process))
(accept-process-output inferior-octave-process))
(goto-char (point-max))
(set-marker (process-mark proc) (point))
(inferior-octave-send-list-and-digest (list "PS2\n"))
(when (string-match "\\(PS2\\|ans\\) = *$"
(car inferior-octave-output-list))
- (inferior-octave-send-list-and-digest (list "PS2 (\"> \");\n")))
+ (inferior-octave-send-list-and-digest (list "PS2 ('> ');\n")))
+
+ (inferior-octave-send-list-and-digest
+ (list "disp (getenv ('OCTAVE_SRCDIR'))\n"))
+ (process-put proc 'octave-srcdir
+ (unless (equal (car inferior-octave-output-list) "")
+ (car inferior-octave-output-list)))
;; O.K., now we are ready for the Inferior Octave startup commands.
(inferior-octave-send-list-and-digest
(list "more off;\n"
(unless (equal inferior-octave-output-string ">> ")
- "PS1 (\"\\\\s> \");\n")
+ "PS1 ('\\s> ');\n")
(when (and inferior-octave-startup-file
(file-exists-p inferior-octave-startup-file))
- (format "source (\"%s\");\n" inferior-octave-startup-file))))
- ;; XXX: the first prompt is incorrectly highlighted
- (insert-before-markers
- (concat
- (if inferior-octave-output-list
- (concat (mapconcat
- 'identity inferior-octave-output-list "\n")
- "\n"))
- inferior-octave-output-string))
+ (format "source ('%s');\n" inferior-octave-startup-file))))
+ (when inferior-octave-output-list
+ (insert-before-markers
+ (mapconcat 'identity inferior-octave-output-list "\n")))
;; And finally, everything is back to normal.
(set-process-filter proc 'comint-output-filter)
- ;; Just in case, to be sure a cd in the startup file
- ;; won't have detrimental effects.
- (inferior-octave-resync-dirs)))
-
-(defun inferior-octave-completion-table ()
- (completion-table-dynamic
- (lambda (command)
- (inferior-octave-send-list-and-digest
- (list (concat "completion_matches (\"" command "\");\n")))
- (sort (delete-dups inferior-octave-output-list)
- 'string-lessp))))
+ ;; Just in case, to be sure a cd in the startup file won't have
+ ;; detrimental effects.
+ (with-demoted-errors (inferior-octave-resync-dirs))
+ ;; Generate a proper prompt, which is critical to
+ ;; `comint-history-isearch-backward-regexp'. Bug#14433.
+ (comint-send-string proc "\n")))
+
+(defvar inferior-octave-completion-table
+ ;;
+ ;; Use cache to avoid repetitive computation of completions due to
+ ;; bug#11906 - http://debbugs.gnu.org/11906 - which may cause
+ ;; noticeable delay. CACHE: (CMD . VALUE).
+ (let ((cache))
+ (completion-table-dynamic
+ (lambda (command)
+ (unless (equal (car cache) command)
+ (inferior-octave-send-list-and-digest
+ (list (format "completion_matches ('%s');\n" command)))
+ (setq cache (cons command
+ (delete-consecutive-dups
+ (sort inferior-octave-output-list 'string-lessp)))))
+ (cdr cache)))))
(defun inferior-octave-completion-at-point ()
"Return the data to complete the Octave symbol at point."
- (let* ((end (point))
- (start
- (save-excursion
- (skip-syntax-backward "w_" (comint-line-beginning-position))
- (point))))
- (when (> end start)
- (list start end (inferior-octave-completion-table)))))
+ ;; http://debbugs.gnu.org/14300
+ (unless (string-match-p "/" (or (comint--match-partial-filename) ""))
+ (let ((beg (save-excursion
+ (skip-syntax-backward "w_" (comint-line-beginning-position))
+ (point)))
+ (end (point)))
+ (when (and beg (> end beg))
+ (list beg end (completion-table-in-turn
+ inferior-octave-completion-table
+ 'comint-completion-file-name-table))))))
(define-obsolete-function-alias 'inferior-octave-complete
'completion-at-point "24.1")
(setq inferior-octave-receive-in-progress nil))
(setq inferior-octave-output-string string))
+(defun inferior-octave-check-process ()
+ (or (and inferior-octave-process
+ (process-live-p inferior-octave-process))
+ (error (substitute-command-keys
+ "No inferior octave process running. Type \\[run-octave]"))))
+
(defun inferior-octave-send-list-and-digest (list)
"Send LIST to the inferior Octave process and digest the output.
The elements of LIST have to be strings and are sent one by one. All
output is passed to the filter `inferior-octave-output-digest'."
+ (inferior-octave-check-process)
(let* ((proc inferior-octave-process)
(filter (process-filter proc))
string)
(setq list (cdr list)))
(set-process-filter proc filter))))
+(defvar inferior-octave-directory-tracker-resync nil)
+(make-variable-buffer-local 'inferior-octave-directory-tracker-resync)
+
(defun inferior-octave-directory-tracker (string)
"Tracks `cd' commands issued to the inferior Octave process.
Use \\[inferior-octave-resync-dirs] to resync if Emacs gets confused."
+ (when inferior-octave-directory-tracker-resync
+ (or (inferior-octave-resync-dirs 'noerror)
+ (setq inferior-octave-directory-tracker-resync nil)))
(cond
((string-match "^[ \t]*cd[ \t;]*$" string)
(cd "~"))
((string-match "^[ \t]*cd[ \t]+\\([^ \t\n;]*\\)[ \t\n;]*" string)
- (cd (substring string (match-beginning 1) (match-end 1))))))
-
-(defun inferior-octave-resync-dirs ()
+ (condition-case err
+ (cd (match-string 1 string))
+ (error (setq inferior-octave-directory-tracker-resync t)
+ (message "%s: `%s'"
+ (error-message-string err)
+ (match-string 1 string)))))))
+
+(defun inferior-octave-resync-dirs (&optional noerror)
"Resync the buffer's idea of the current directory.
This command queries the inferior Octave process about its current
directory and makes this the current buffer's default directory."
(interactive)
(inferior-octave-send-list-and-digest '("disp (pwd ())\n"))
- (cd (car inferior-octave-output-list)))
+ (condition-case err
+ (progn
+ (cd (car inferior-octave-output-list))
+ t)
+ (error (unless noerror (signal (car err) (cdr err))))))
+
+(defcustom inferior-octave-minimal-columns 80
+ "The minimal column width for the inferior Octave process."
+ :type 'integer
+ :group 'octave
+ :version "24.4")
+
+(defvar inferior-octave-last-column-width nil)
+
+(defun inferior-octave-track-window-width-change ()
+ ;; http://thread.gmane.org/gmane.comp.gnu.octave.general/48572
+ (let ((width (max inferior-octave-minimal-columns (window-width))))
+ (unless (eq inferior-octave-last-column-width width)
+ (setq-local inferior-octave-last-column-width width)
+ (when (and inferior-octave-process
+ (process-live-p inferior-octave-process))
+ (inferior-octave-send-list-and-digest
+ (list (format "putenv ('COLUMNS', '%s');\n" width)))))))
\f
;;; Miscellaneous useful functions
(completing-read
(format (if def "Function (default %s): "
"Function: ") def)
- (inferior-octave-completion-table)
+ inferior-octave-completion-table
nil nil nil nil def)))
-(defun octave-goto-function-definition ()
- "Go to the first function definition."
- (when (save-excursion
- (goto-char (point-min))
- (re-search-forward octave-function-header-regexp nil t))
- (goto-char (match-beginning 3))
- (match-string 3)))
+(defun octave-goto-function-definition (fn)
+ "Go to the function definition of FN in current buffer."
+ (let ((search
+ (lambda (re sub)
+ (let ((orig (point)) found)
+ (goto-char (point-min))
+ (while (and (not found) (re-search-forward re nil t))
+ (when (and (equal (match-string sub) fn)
+ (not (nth 8 (syntax-ppss))))
+ (setq found t)))
+ (unless found (goto-char orig))
+ found))))
+ (pcase (and buffer-file-name (file-name-extension buffer-file-name))
+ (`"cc" (funcall search
+ "\\_<DEFUN\\(?:_DLD\\)?\\s-*(\\s-*\\(\\(?:\\sw\\|\\s_\\)+\\)" 1))
+ (t (funcall search octave-function-header-regexp 3)))))
(defun octave-function-file-p ()
"Return non-nil if the first token is \"function\".
nil 'delimited nil nil beg end)
(message "Function names match")))))
-;; Adapted from texinfo-font-lock-keywords
-(defvar octave-texinfo-font-lock-keywords
- `(("@\\([a-zA-Z]+\\|[^ \t\n]\\)" 1 font-lock-keyword-face prepend) ;commands
- ("^\\*\\([^\n:]*\\)" 1 font-lock-function-name-face prepend) ;menu items
- ("@\\(emph\\|i\\|sc\\){\\([^}]+\\)" 2 'italic prepend)
- ("@\\(strong\\|b\\){\\([^}]+\\)" 2 'bold prepend)
- ("@\\(kbd\\|key\\|url\\|uref\\){\\([^}]+\\)"
- 2 font-lock-string-face prepend)
- ("@\\(file\\|email\\){\\([^}]+\\)" 2 font-lock-string-face prepend)
- ("@\\(samp\\|code\\|var\\|math\\|env\\|command\\|option\\){\\([^}]+\\)"
- 2 font-lock-variable-name-face prepend)
- ("@\\(cite\\|x?ref\\|pxref\\|dfn\\|inforef\\){\\([^}]+\\)"
- 2 font-lock-constant-face prepend)
- ("@\\(anchor\\){\\([^}]+\\)" 2 font-lock-type-face prepend)
- ("@\\(dmn\\|acronym\\|value\\){\\([^}]+\\)"
- 2 font-lock-builtin-face prepend)
- ("@\\(end\\|itemx?\\) +\\(.+\\)" 2 font-lock-keyword-face prepend))
- "Additional keywords to highlight in texinfo comment block.")
-
(defface octave-function-comment-block
'((t (:inherit font-lock-doc-face)))
"Face used to highlight function comment block."
:group 'octave)
+(eval-when-compile (require 'texinfo))
+
(defun octave-font-lock-texinfo-comment ()
- (font-lock-add-keywords
- nil
- '(((lambda (limit)
- (while (and (search-forward "-*- texinfo -*-" limit t)
- (octave-in-comment-p))
- (let ((beg (nth 8 (syntax-ppss)))
- (end (progn
- (octave-skip-comment-forward (point-max))
- (point))))
- (put-text-property beg end 'font-lock-multiline t)
- (font-lock-prepend-text-property
- beg end 'face 'octave-function-comment-block)
- (dolist (kw octave-texinfo-font-lock-keywords)
- (goto-char beg)
- (while (re-search-forward (car kw) end 'move)
- (font-lock-apply-highlight (cdr kw))))))
- nil)))
- 'append))
+ (let ((kws
+ (eval-when-compile
+ (delq nil (mapcar
+ (lambda (kw)
+ (if (numberp (nth 1 kw))
+ `(,(nth 0 kw) ,(nth 1 kw) ,(nth 2 kw) prepend)
+ (message "Ignoring Texinfo highlight: %S" kw)))
+ texinfo-font-lock-keywords)))))
+ (font-lock-add-keywords
+ nil
+ `((,(lambda (limit)
+ (while (and (< (point) limit)
+ (search-forward "-*- texinfo -*-" limit t)
+ (octave-in-comment-p))
+ (let ((beg (nth 8 (syntax-ppss)))
+ (end (progn
+ (octave-skip-comment-forward (point-max))
+ (point))))
+ (put-text-property beg end 'font-lock-multiline t)
+ (font-lock-prepend-text-property
+ beg end 'face 'octave-function-comment-block)
+ (dolist (kw kws)
+ (goto-char beg)
+ (while (re-search-forward (car kw) end 'move)
+ (font-lock-apply-highlight (cdr kw))))))
+ nil)))
+ 'append)))
\f
;;; Indentation
-(defun octave-indent-new-comment-line ()
+(defun octave-indent-new-comment-line (&optional soft)
"Break Octave line at point, continuing comment if within one.
-If within code, insert `octave-continuation-string' before breaking the
-line. If within a string, signal an error.
-The new line is properly indented."
+Insert `octave-continuation-string' before breaking the line
+unless inside a list. Signal an error if within a single-quoted
+string."
(interactive)
- (delete-horizontal-space)
+ (funcall comment-line-break-function soft))
+
+(defun octave--indent-new-comment-line (orig &rest args)
(cond
- ((octave-in-comment-p)
- (indent-new-comment-line))
- ((octave-in-string-p)
- (error "Cannot split a code line inside a string"))
+ ((octave-in-comment-p) nil)
+ ((eq (octave-in-string-p) ?')
+ (error "Cannot split a single-quoted string"))
+ ((eq (octave-in-string-p) ?\")
+ (insert octave-continuation-string))
(t
- (insert (concat " " octave-continuation-string))
- (reindent-then-newline-and-indent))))
+ (delete-horizontal-space)
+ (unless (and (cadr (syntax-ppss))
+ (eq (char-after (cadr (syntax-ppss))) ?\())
+ (insert " " octave-continuation-string))))
+ (apply orig args)
+ (indent-according-to-mode))
-(defun octave-indent-defun ()
- "Properly indent the Octave function which contains point."
- (interactive)
- (save-excursion
- (mark-defun)
- (message "Indenting function...")
- (indent-region (point) (mark) nil))
- (message "Indenting function...done."))
+(define-obsolete-function-alias
+ 'octave-indent-defun 'prog-indent-sexp "24.4")
\f
;;; Motion
If on an empty or comment line, go to the beginning of that line.
Otherwise, move backward to the beginning of the first Octave code line
which is not inside a continuation statement, i.e., which does not
-follow a code line ending in `...' or `\\', or is inside an open
+follow a code line ending with `...' or is inside an open
parenthesis list."
(interactive)
(beginning-of-line)
- (if (not (looking-at "\\s-*\\($\\|\\s<\\)"))
- (while (or (condition-case nil
- (progn
- (up-list -1)
- (beginning-of-line)
- t)
- (error nil))
- (and (or (looking-at "\\s-*\\($\\|\\s<\\)")
- (save-excursion
- (if (zerop (octave-previous-code-line))
- (looking-at octave-continuation-regexp))))
- (zerop (forward-line -1)))))))
+ (unless (looking-at "\\s-*\\($\\|\\s<\\)")
+ (while (or (when (cadr (syntax-ppss))
+ (goto-char (cadr (syntax-ppss)))
+ (beginning-of-line)
+ t)
+ (and (or (looking-at "\\s-*\\($\\|\\s<\\)")
+ (save-excursion
+ (if (zerop (octave-previous-code-line))
+ (looking-at octave-continuation-regexp))))
+ (zerop (forward-line -1)))))))
(defun octave-end-of-line ()
"Move point to end of current Octave line.
If on an empty or comment line, go to the end of that line.
Otherwise, move forward to the end of the first Octave code line which
-does not end in `...' or `\\' or is inside an open parenthesis list."
+does not end with `...' or is inside an open parenthesis list."
(interactive)
(end-of-line)
- (if (save-excursion
- (beginning-of-line)
- (looking-at "\\s-*\\($\\|\\s<\\)"))
- ()
- (while (or (condition-case nil
- (progn
- (up-list 1)
- (end-of-line)
- t)
- (error nil))
- (and (save-excursion
- (beginning-of-line)
- (or (looking-at "\\s-*\\($\\|\\s<\\)")
- (looking-at octave-continuation-regexp)))
- (zerop (forward-line 1)))))
+ (unless (save-excursion
+ (beginning-of-line)
+ (looking-at "\\s-*\\($\\|\\s<\\)"))
+ (while (or (when (cadr (syntax-ppss))
+ (condition-case nil
+ (progn
+ (up-list 1)
+ (end-of-line)
+ t)
+ (error nil)))
+ (and (save-excursion
+ (beginning-of-line)
+ (or (looking-at "\\s-*\\($\\|\\s<\\)")
+ (looking-at octave-continuation-regexp)))
+ (zerop (forward-line 1)))))
(end-of-line)))
(defun octave-mark-block ()
(mark-sexp))
(defun octave-beginning-of-defun (&optional arg)
- "Move backward to the beginning of an Octave function.
-With positive ARG, do it that many times. Negative argument -N means
-move forward to Nth following beginning of a function.
-Returns t unless search stops at the beginning or end of the buffer."
- (let* ((arg (or arg 1))
- (inc (if (> arg 0) 1 -1))
- (found nil)
- (case-fold-search nil))
- (and (not (eobp))
- (not (and (> arg 0) (looking-at "\\_<function\\_>")))
- (skip-syntax-forward "w"))
- (while (and (/= arg 0)
- (setq found
- (re-search-backward "\\_<function\\_>" inc)))
- (unless (octave-in-string-or-comment-p)
- (setq arg (- arg inc))))
- (if found
- (progn
- (and (< inc 0) (goto-char (match-beginning 0)))
- t))))
-
-\f
-;;; Filling
-(defun octave-auto-fill ()
- "Perform auto-fill in Octave mode.
-Returns nil if no feasible place to break the line could be found, and t
-otherwise."
- (let (fc give-up)
- (if (or (null (setq fc (current-fill-column)))
- (save-excursion
- (beginning-of-line)
- (and auto-fill-inhibit-regexp
- (octave-looking-at-kw auto-fill-inhibit-regexp))))
- nil ; Can't do anything
- (if (and (not (octave-in-comment-p))
- (> (current-column) fc))
- (setq fc (- fc (+ (length octave-continuation-string) 1))))
- (while (and (not give-up) (> (current-column) fc))
- (let* ((opoint (point))
- (fpoint
- (save-excursion
- (move-to-column (+ fc 1))
- (skip-chars-backward "^ \t\n")
- ;; If we're at the beginning of the line, break after
- ;; the first word
- (if (bolp)
- (re-search-forward "[ \t]" opoint t))
- ;; If we're in a comment line, don't break after the
- ;; comment chars
- (if (save-excursion
- (skip-syntax-backward " <")
- (bolp))
- (re-search-forward "[ \t]" (line-end-position)
- 'move))
- ;; If we're not in a comment line and just ahead the
- ;; continuation string, don't break here.
- (if (and (not (octave-in-comment-p))
- (looking-at
- (concat "\\s-*"
- (regexp-quote
- octave-continuation-string)
- "\\s-*$")))
- (end-of-line))
- (skip-chars-backward " \t")
- (point))))
- (if (save-excursion
- (goto-char fpoint)
- (not (or (bolp) (eolp))))
- (let ((prev-column (current-column)))
- (if (save-excursion
- (skip-chars-backward " \t")
- (= (point) fpoint))
- (progn
- (octave-maybe-insert-continuation-string)
- (indent-new-comment-line t))
- (save-excursion
- (goto-char fpoint)
- (octave-maybe-insert-continuation-string)
- (indent-new-comment-line t)))
- (if (>= (current-column) prev-column)
- (setq give-up t)))
- (setq give-up t))))
- (not give-up))))
+ "Octave-specific `beginning-of-defun-function' (which see)."
+ (or arg (setq arg 1))
+ ;; Move out of strings or comments.
+ (when (octave-in-string-or-comment-p)
+ (goto-char (octave-in-string-or-comment-p)))
+ (letrec ((orig (point))
+ (toplevel (lambda (pos)
+ (condition-case nil
+ (progn
+ (backward-up-list 1)
+ (funcall toplevel (point)))
+ (scan-error pos)))))
+ (goto-char (funcall toplevel (point)))
+ (when (and (> arg 0) (/= orig (point)))
+ (setq arg (1- arg)))
+ (forward-sexp (- arg))
+ (and (< arg 0) (forward-sexp -1))
+ (/= orig (point))))
(defun octave-fill-paragraph (&optional _arg)
"Fill paragraph of Octave code, handling Octave comments."
(and (= (current-column) cfc) (eolp)))
(forward-line 1)
(if (not (eolp)) (insert " "))
- (or (octave-auto-fill)
+ (or (funcall normal-auto-fill-function)
(forward-line 1))))
t)))
-\f
-;;; Completions
-
-(defun octave-completion-at-point-function ()
+(defun octave-completion-at-point ()
"Find the text to complete and the corresponding table."
(let* ((beg (save-excursion (skip-syntax-backward "w_") (point)))
(end (point)))
;; Extend region past point, if applicable.
(save-excursion (skip-syntax-forward "w_")
(setq end (point))))
- (list beg end (or (and inferior-octave-process
- (process-live-p inferior-octave-process)
- (inferior-octave-completion-table))
- (append octave-reserved-words
- octave-text-functions)))))
+ (when (> end beg)
+ (list beg end (or (and inferior-octave-process
+ (process-live-p inferior-octave-process)
+ inferior-octave-completion-table)
+ octave-reserved-words)))))
(define-obsolete-function-alias 'octave-complete-symbol
'completion-at-point "24.1")
+
+(defun octave-add-log-current-defun ()
+ "A function for `add-log-current-defun-function' (which see)."
+ (save-excursion
+ (end-of-line)
+ (and (beginning-of-defun)
+ (re-search-forward octave-function-header-regexp
+ (line-end-position) t)
+ (match-string 3))))
+
\f
;;; Electric characters && friends
(define-skeleton octave-insert-defun
"function " > str \n
_ \n
"endfunction" > \n)
-\f
+
;;; Communication with the inferior Octave process
(defun octave-kill-process ()
"Kill inferior Octave process and its buffer."
(if octave-send-show-buffer
(display-buffer inferior-octave-buffer)))
+(defun octave-send-buffer ()
+ "Send current buffer to the inferior Octave process."
+ (interactive)
+ (octave-send-region (point-min) (point-max)))
+
(defun octave-send-block ()
"Send current Octave block to the inferior Octave process."
(interactive)
\f
+(defcustom octave-eldoc-message-style 'auto
+ "Octave eldoc message style: auto, oneline, multiline."
+ :type '(choice (const :tag "Automatic" auto)
+ (const :tag "One Line" oneline)
+ (const :tag "Multi Line" multiline))
+ :group 'octave
+ :version "24.4")
+
+;; (FN SIGNATURE1 SIGNATURE2 ...)
+(defvar octave-eldoc-cache nil)
+
+(defun octave-eldoc-function-signatures (fn)
+ (unless (equal fn (car octave-eldoc-cache))
+ (inferior-octave-send-list-and-digest
+ (list (format "print_usage ('%s');\n" fn)))
+ (let (result)
+ (dolist (line inferior-octave-output-list)
+ (when (string-match
+ "\\s-*\\(?:--[^:]+\\|usage\\):\\s-*\\(.*\\)$"
+ line)
+ (push (match-string 1 line) result)))
+ (setq octave-eldoc-cache
+ (cons (substring-no-properties fn)
+ (nreverse result)))))
+ (cdr octave-eldoc-cache))
+
+(defun octave-eldoc-function ()
+ "A function for `eldoc-documentation-function' (which see)."
+ (when (and inferior-octave-process
+ (process-live-p inferior-octave-process))
+ (let* ((ppss (syntax-ppss))
+ (paren-pos (cadr ppss))
+ (fn (save-excursion
+ (if (and paren-pos
+ ;; PAREN-POS must be after the prompt
+ (>= paren-pos
+ (if (eq (get-buffer-process (current-buffer))
+ inferior-octave-process)
+ (process-mark inferior-octave-process)
+ (point-min)))
+ (or (not (eq (get-buffer-process (current-buffer))
+ inferior-octave-process))
+ (< (process-mark inferior-octave-process)
+ paren-pos))
+ (eq (char-after paren-pos) ?\())
+ (goto-char paren-pos)
+ (setq paren-pos nil))
+ (when (or (< (skip-syntax-backward "-") 0) paren-pos)
+ (thing-at-point 'symbol))))
+ (sigs (and fn (octave-eldoc-function-signatures fn)))
+ (oneline (mapconcat 'identity sigs
+ (propertize " | " 'face 'warning)))
+ (multiline (mapconcat (lambda (s) (concat "-- " s)) sigs "\n")))
+ ;;
+ ;; Return the value according to style.
+ (pcase octave-eldoc-message-style
+ (`auto (if (< (length oneline) (window-width (minibuffer-window)))
+ oneline
+ multiline))
+ (`oneline oneline)
+ (`multiline multiline)))))
+
(defcustom octave-help-buffer "*Octave Help*"
"Buffer name for `octave-help'."
:type 'string
:group 'octave
:version "24.4")
+;; Used in a mode derived from help-mode.
+(declare-function help-button-action "help-mode" (button))
+
(define-button-type 'octave-help-file
'follow-link t
'action #'help-button-action
(octave-help
(buffer-substring (button-start b) (button-end b)))))
-(defvar help-xref-following)
+(defvar octave-help-mode-map
+ (let ((map (make-sparse-keymap)))
+ (define-key map "\M-." 'octave-find-definition)
+ (define-key map "\C-hd" 'octave-help)
+ (define-key map "\C-ha" 'octave-lookfor)
+ map))
+
+(define-derived-mode octave-help-mode help-mode "OctHelp"
+ "Major mode for displaying Octave documentation."
+ :abbrev-table nil
+ :syntax-table octave-mode-syntax-table
+ (eval-and-compile (require 'help-mode))
+ ;; Mostly stolen from `help-make-xrefs'.
+ (let ((inhibit-read-only t))
+ (setq-local info-lookup-mode 'octave-mode)
+ ;; Delete extraneous newlines at the end of the docstring
+ (goto-char (point-max))
+ (while (and (not (bobp)) (bolp))
+ (delete-char -1))
+ (insert "\n")
+ (when (or help-xref-stack help-xref-forward-stack)
+ (insert "\n"))
+ (when help-xref-stack
+ (help-insert-xref-button help-back-label 'help-back
+ (current-buffer)))
+ (when help-xref-forward-stack
+ (when help-xref-stack
+ (insert "\t"))
+ (help-insert-xref-button help-forward-label 'help-forward
+ (current-buffer)))
+ (when (or help-xref-stack help-xref-forward-stack)
+ (insert "\n"))))
(defun octave-help (fn)
"Display the documentation of FN."
(interactive (list (octave-completing-read)))
(inferior-octave-send-list-and-digest
- (list (format "help \"%s\"\n" fn)))
- (let ((lines inferior-octave-output-list))
+ (list (format "help ('%s');\n" fn)))
+ (let ((lines inferior-octave-output-list)
+ (inhibit-read-only t))
(when (string-match "error: \\(.*\\)$" (car lines))
(error "%s" (match-string 1 (car lines))))
(with-help-window octave-help-buffer
(when (re-search-forward "from the file \\(.*\\)$"
(line-end-position)
t)
- (let ((file (match-string 1)))
+ (let* ((file (match-string 1))
+ (dir (file-name-directory
+ (directory-file-name (file-name-directory file)))))
(replace-match "" nil nil nil 1)
(insert "`")
- (help-insert-xref-button (file-name-nondirectory file)
+ ;; Include the parent directory which may be regarded as
+ ;; the category for the FN.
+ (help-insert-xref-button (file-relative-name file dir)
'octave-help-file fn)
(insert "'")))
- ;; Make 'See also' clickable
+ ;; Make 'See also' clickable.
(with-syntax-table octave-mode-syntax-table
(when (re-search-forward "^\\s-*See also:" nil t)
- (while (re-search-forward "\\_<\\(?:\\sw\\|\\s_\\)+\\_>" nil t)
- (make-text-button (match-beginning 0)
- (match-end 0)
- :type 'octave-help-function))))))))
-
-(defcustom octave-binary-file-extensions '("oct" "mex")
- "A list of binary file extensions for Octave."
- :type '(repeat string)
+ (let ((end (save-excursion (re-search-forward "^\\s-*$" nil t))))
+ (while (re-search-forward
+ "\\s-*\\([^,\n]+?\\)\\s-*\\(?:[,]\\|[.]?$\\)" end t)
+ (make-text-button (match-beginning 1) (match-end 1)
+ :type 'octave-help-function)))))
+ (octave-help-mode)))))
+
+(defun octave-lookfor (str &optional all)
+ "Search for the string STR in all function help strings.
+If ALL is non-nil search the entire help string else only search the first
+sentence."
+ (interactive "sSearch for: \nP")
+ (inferior-octave-send-list-and-digest
+ (list (format "lookfor (%s'%s');\n"
+ (if all "'-all', " "")
+ str)))
+ (let ((lines inferior-octave-output-list))
+ (when (string-match "error: \\(.*\\)$" (car lines))
+ (error "%s" (match-string 1 (car lines))))
+ (with-help-window octave-help-buffer
+ (princ (mapconcat 'identity lines "\n"))
+ (with-current-buffer octave-help-buffer
+ ;; Bound to t so that `help-buffer' returns current buffer for
+ ;; `help-setup-xref'.
+ (let ((help-xref-following t))
+ (help-setup-xref (list 'octave-lookfor str all)
+ (called-interactively-p 'interactive)))
+ (goto-char (point-min))
+ (while (re-search-forward "^\\([^[:blank:]]+\\) " nil 'noerror)
+ (make-text-button (match-beginning 1) (match-end 1)
+ :type 'octave-help-function))
+ (octave-help-mode)))))
+
+(defcustom octave-source-directories nil
+ "A list of directories for Octave sources.
+If the environment variable OCTAVE_SRCDIR is set, it is searched first."
+ :type '(repeat directory)
:group 'octave
:version "24.4")
+(defun octave-source-directories ()
+ (let ((srcdir (or (and inferior-octave-process
+ (process-get inferior-octave-process 'octave-srcdir))
+ (getenv "OCTAVE_SRCDIR"))))
+ (if srcdir
+ (cons srcdir octave-source-directories)
+ octave-source-directories)))
+
+(defvar octave-find-definition-filename-function
+ #'octave-find-definition-default-filename)
+
+(defun octave-find-definition-default-filename (name)
+ "Default value for `octave-find-definition-filename-function'."
+ (pcase (file-name-extension name)
+ (`"oct"
+ (octave-find-definition-default-filename
+ (concat "libinterp/dldfcn/"
+ (file-name-sans-extension (file-name-nondirectory name))
+ ".cc")))
+ (`"cc"
+ (let ((file (or (locate-file name (octave-source-directories))
+ (locate-file (file-name-nondirectory name)
+ (octave-source-directories)))))
+ (or (and file (file-exists-p file))
+ (error "File `%s' not found" name))
+ file))
+ (`"mex"
+ (if (yes-or-no-p (format "File `%s' may be binary; open? "
+ (file-name-nondirectory name)))
+ name
+ (user-error "Aborted")))
+ (t name)))
+
(defvar find-tag-marker-ring)
(defun octave-find-definition (fn)
- "Find the definition of FN."
+ "Find the definition of FN.
+Functions implemented in C++ can be found if
+variable `octave-source-directories' is set correctly."
(interactive (list (octave-completing-read)))
- (inferior-octave-send-list-and-digest
- ;; help NAME is more verbose
- (list (format "\
-if iskeyword(\"%s\") disp(\"`%s' is a keyword\") else which(\"%s\") endif\n"
- fn fn fn)))
- (let* ((line (car inferior-octave-output-list))
- (file (when (and line (string-match "from the file \\(.*\\)$" line))
- (match-string 1 line))))
- (if (not file)
- (user-error "%s" (or line (format "`%s' not found" fn)))
- (when (and (member (file-name-extension file)
- octave-binary-file-extensions)
- (not (yes-or-no-p (format "File `%s' may be binary; open? "
- (file-name-nondirectory file)))))
- (error "Aborted"))
- (require 'etags)
- (ring-insert find-tag-marker-ring (point-marker))
- (find-file file)
- (octave-goto-function-definition))))
-
+ (require 'etags)
+ (let ((orig (point)))
+ (if (and (derived-mode-p 'octave-mode)
+ (octave-goto-function-definition fn))
+ (ring-insert find-tag-marker-ring (copy-marker orig))
+ (inferior-octave-send-list-and-digest
+ ;; help NAME is more verbose
+ (list (format "\
+if iskeyword('%s') disp('`%s'' is a keyword') else which('%s') endif\n"
+ fn fn fn)))
+ (let (line file)
+ ;; Skip garbage lines such as
+ ;; warning: fmincg.m: possible Matlab-style ....
+ (while (and (not file) (consp inferior-octave-output-list))
+ (setq line (pop inferior-octave-output-list))
+ (when (string-match "from the file \\(.*\\)$" line)
+ (setq file (match-string 1 line))))
+ (if (not file)
+ (user-error "%s" (or line (format "`%s' not found" fn)))
+ (ring-insert find-tag-marker-ring (point-marker))
+ (setq file (funcall octave-find-definition-filename-function file))
+ (when file
+ (find-file file)
+ (octave-goto-function-definition fn)))))))
(provide 'octave)
;;; octave.el ends here
HCoop / bpt / emacs.git / blobdiff