* highlight current argument in Eldoc for Elisp
@ 2007-06-30 15:13 Paul Pogonyshev
2007-07-01 0:30 ` Richard Stallman
0 siblings, 1 reply; 12+ messages in thread
From: Paul Pogonyshev @ 2007-06-30 15:13 UTC (permalink / raw)
To: emacs-devel
Hi,
This is my old patch for Eldoc mode, which I recovered. I also made
some improvements. I hope now that 22.1 is finally out, this patch
won't be delayed.
Briefly, it highlights the current argument in Eldoc mode with bold
text. So, if you write `(> 2' it will print `>: (NUM1 NUM2)' with
`NUM1' in bold. If you now put a space, it will highlight `NUM2'
instead. If you start a third arg, it will remove boldness and
highlight the closing paren in `font-lock-warning-face'.
Paul
2007-06-30 Paul Pogonyshev <pogonyshev@gmx.net>
* emacs-lisp/eldoc.el (eldoc-last-data): Revise documentation.
(eldoc-print-current-symbol-info): Adjust for changed helper
function signatures.
(eldoc-get-fnsym-args-string): Add `args' argument. Use new
`eldoc-highlight-function-argument'.
(eldoc-highlight-function-argument): New function.
(eldoc-get-var-docstring): Format documentation with
`font-lock-variable-name-face'.
(eldoc-docstring-format-sym-doc): Add `face' argument and apply it
where suited.
(eldoc-fnsym-in-current-sexp): Return a list with argument index.
(eldoc-beginning-of-sexp): Return number of skipped sexps.
Index: lisp/emacs-lisp/eldoc.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/eldoc.el,v
retrieving revision 1.42
diff -c -p -r1.42 eldoc.el
*** lisp/emacs-lisp/eldoc.el 7 May 2007 01:09:35 -0000 1.42
--- lisp/emacs-lisp/eldoc.el 30 Jun 2007 14:58:25 -0000
*************** directly. Instead, use `eldoc-add-comma
*** 124,131 ****
(defconst eldoc-last-data (make-vector 3 nil)
"Bookkeeping; elements are as follows:
0 - contains the last symbol read from the buffer.
! 1 - contains the string last displayed in the echo area for that
! symbol, so it can be printed again if necessary without reconsing.
2 - 'function if function args, 'variable if variable documentation.")
(defvar eldoc-last-message nil)
--- 124,131 ----
(defconst eldoc-last-data (make-vector 3 nil)
"Bookkeeping; elements are as follows:
0 - contains the last symbol read from the buffer.
! 1 - contains the string last displayed in the echo area for variables,
! or argument string for functions.
2 - 'function if function args, 'variable if variable documentation.")
(defvar eldoc-last-message nil)
*************** Emacs Lisp mode) that support Eldoc.")
*** 249,260 ****
(let* ((current-symbol (eldoc-current-symbol))
(current-fnsym (eldoc-fnsym-in-current-sexp))
(doc (cond
! ((eq current-symbol current-fnsym)
! (or (eldoc-get-fnsym-args-string current-fnsym)
(eldoc-get-var-docstring current-symbol)))
(t
(or (eldoc-get-var-docstring current-symbol)
! (eldoc-get-fnsym-args-string current-fnsym))))))
(eldoc-message doc))))
;; This is run from post-command-hook or some idle timer thing,
;; so we need to be careful that errors aren't ignored.
--- 249,262 ----
(let* ((current-symbol (eldoc-current-symbol))
(current-fnsym (eldoc-fnsym-in-current-sexp))
(doc (cond
! ((eq current-symbol (car current-fnsym))
! (or (apply 'eldoc-get-fnsym-args-string
! current-fnsym)
(eldoc-get-var-docstring current-symbol)))
(t
(or (eldoc-get-var-docstring current-symbol)
! (apply 'eldoc-get-fnsym-args-string
! current-fnsym))))))
(eldoc-message doc))))
;; This is run from post-command-hook or some idle timer thing,
;; so we need to be careful that errors aren't ignored.
*************** Emacs Lisp mode) that support Eldoc.")
*** 263,286 ****
;; Return a string containing the function parameter list, or 1-line
;; docstring if function is a subr and no arglist is obtainable from the
;; docstring or elsewhere.
! (defun eldoc-get-fnsym-args-string (sym)
(let ((args nil)
(doc nil))
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
(eq 'function (aref eldoc-last-data 2)))
! (setq doc (aref eldoc-last-data 1)))
((setq doc (help-split-fundoc (documentation sym t) sym))
(setq args (car doc))
(string-match "\\`[^ )]* ?" args)
! (setq args (concat "(" (substring args (match-end 0)))))
(t
(setq args (eldoc-function-argstring sym))))
! (cond (args
! (setq doc (eldoc-docstring-format-sym-doc sym args))
! (eldoc-last-data-store sym doc 'function)))
doc))
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
--- 265,326 ----
;; Return a string containing the function parameter list, or 1-line
;; docstring if function is a subr and no arglist is obtainable from the
;; docstring or elsewhere.
! (defun eldoc-get-fnsym-args-string (sym argument-index)
(let ((args nil)
(doc nil))
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
(eq 'function (aref eldoc-last-data 2)))
! (setq args (aref eldoc-last-data 1)))
((setq doc (help-split-fundoc (documentation sym t) sym))
(setq args (car doc))
(string-match "\\`[^ )]* ?" args)
! (setq args (concat "(" (substring args (match-end 0))))
! (eldoc-last-data-store sym args 'function))
(t
(setq args (eldoc-function-argstring sym))))
! (when args
! (setq doc (eldoc-highlight-function-argument sym args argument-index)))
doc))
+ ;; Highlight argument INDEX in ARGS list for SYM.
+ (defun eldoc-highlight-function-argument (sym args index)
+ (let ((start nil)
+ (end 0)
+ (argument-face 'bold))
+ ;; Find the current argument in the argument string. We need to
+ ;; handle `&rest' and informal `...' properly.
+ ;;
+ ;; FIXME: What to do with optional arguments, like in
+ ;; (defun NAME ARGLIST [DOCSTRING] BODY...) case?
+ ;; The problem is there is no robust way to determine if
+ ;; the current argument is indeed a docstring.
+ (while (>= index 1)
+ (if (string-match "[^ ()]+" args end)
+ (progn
+ (setq start (match-beginning 0)
+ end (match-end 0))
+ (let ((argument (match-string 0 args)))
+ (cond ((string= argument "&rest")
+ ;; All the rest arguments are the same.
+ (setq index 1))
+ ((string= argument "&optional"))
+ ((string-match "\\.\\.\\.$" argument)
+ (setq index 0))
+ (t
+ (setq index (1- index))))))
+ (setq end (length args)
+ start (1- end)
+ argument-face 'font-lock-warning-face
+ index 0)))
+ (let ((doc args))
+ (when start
+ (setq doc (copy-sequence args))
+ (add-text-properties start end (list 'face argument-face) doc))
+ (setq doc (eldoc-docstring-format-sym-doc
+ sym doc 'font-lock-function-name-face))
+ doc)))
+
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
*************** Emacs Lisp mode) that support Eldoc.")
*** 292,298 ****
(let ((doc (documentation-property sym 'variable-documentation t)))
(cond (doc
(setq doc (eldoc-docstring-format-sym-doc
! sym (eldoc-docstring-first-line doc)))
(eldoc-last-data-store sym doc 'variable)))
doc)))))
--- 332,339 ----
(let ((doc (documentation-property sym 'variable-documentation t)))
(cond (doc
(setq doc (eldoc-docstring-format-sym-doc
! sym (eldoc-docstring-first-line doc)
! 'font-lock-variable-name-face))
(eldoc-last-data-store sym doc 'variable)))
doc)))))
*************** Emacs Lisp mode) that support Eldoc.")
*** 316,322 ****
;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
! (defun eldoc-docstring-format-sym-doc (sym doc)
(save-match-data
(let* ((name (symbol-name sym))
(ea-multi eldoc-echo-area-use-multiline-p)
--- 357,363 ----
;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
! (defun eldoc-docstring-format-sym-doc (sym doc face)
(save-match-data
(let* ((name (symbol-name sym))
(ea-multi eldoc-echo-area-use-multiline-p)
*************** Emacs Lisp mode) that support Eldoc.")
*** 328,334 ****
(cond ((or (<= strip 0)
(eq ea-multi t)
(and ea-multi (> (length doc) ea-width)))
! (format "%s: %s" sym doc))
((> (length doc) ea-width)
(substring (format "%s" doc) 0 ea-width))
((>= strip (length name))
--- 369,375 ----
(cond ((or (<= strip 0)
(eq ea-multi t)
(and ea-multi (> (length doc) ea-width)))
! (format "%s: %s" (propertize name 'face face) doc))
((> (length doc) ea-width)
(substring (format "%s" doc) 0 ea-width))
((>= strip (length name))
*************** Emacs Lisp mode) that support Eldoc.")
*** 338,364 ****
;; than the beginning, since the former is more likely
;; to be unique given package namespace conventions.
(setq name (substring name strip))
! (format "%s: %s" name doc))))))
(defun eldoc-fnsym-in-current-sexp ()
! (let ((p (point)))
! (eldoc-beginning-of-sexp)
! (prog1
! ;; Don't do anything if current word is inside a string.
! (if (= (or (char-after (1- (point))) 0) ?\")
! nil
! (eldoc-current-symbol))
! (goto-char p))))
(defun eldoc-beginning-of-sexp ()
! (let ((parse-sexp-ignore-comments t))
(condition-case err
! (while (progn
! (forward-sexp -1)
! (or (= (char-before) ?\")
! (> (point) (point-min)))))
! (error nil))))
;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
--- 379,422 ----
;; than the beginning, since the former is more likely
;; to be unique given package namespace conventions.
(setq name (substring name strip))
! (format "%s: %s" (propertize name 'face face) doc))))))
+ ;; Return a list of current function name and argument index.
(defun eldoc-fnsym-in-current-sexp ()
! (save-excursion
! (let ((argument-index (1- (eldoc-beginning-of-sexp))))
! ;; If we are at the beginning of function name, this will be -1.
! (when (< argument-index 0)
! (setq argument-index 0))
! ;; Don't do anything if current word is inside a string.
! (if (= (or (char-after (1- (point))) 0) ?\")
! nil
! (list (eldoc-current-symbol) argument-index)))))
+ ;; Move to the beginnig of current sexp. Return the number of nested
+ ;; sexp the point was over or after.
(defun eldoc-beginning-of-sexp ()
! (let ((parse-sexp-ignore-comments t)
! (num-skipped-sexps 0))
(condition-case err
! (progn
! ;; First account for the case the point is directly over a
! ;; beginning of a nested sexp.
! (condition-case err
! (let ((p (point)))
! (forward-sexp -1)
! (forward-sexp 1)
! (when (< (point) p)
! (setq num-skipped-sexps 1)))
! (error))
! (while
! (let ((p (point)))
! (forward-sexp -1)
! (when (< (point) p)
! (setq num-skipped-sexps (1+ num-skipped-sexps))))))
! (error))
! num-skipped-sexps))
;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-06-30 15:13 highlight current argument in Eldoc for Elisp Paul Pogonyshev
@ 2007-07-01 0:30 ` Richard Stallman
2007-07-01 18:13 ` Tom Tromey
2007-07-01 20:54 ` Tom Tromey
0 siblings, 2 replies; 12+ messages in thread
From: Richard Stallman @ 2007-07-01 0:30 UTC (permalink / raw)
To: Paul Pogonyshev; +Cc: emacs-devel
Thanks for posting the patch. Would people please try it
and report any problems?
In a week, if nobody has reported problems, would someone
please install this?
(Paul, if nobody installs it then, please ping us.)
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-01 0:30 ` Richard Stallman
@ 2007-07-01 18:13 ` Tom Tromey
2007-07-01 20:54 ` Tom Tromey
1 sibling, 0 replies; 12+ messages in thread
From: Tom Tromey @ 2007-07-01 18:13 UTC (permalink / raw)
To: rms; +Cc: emacs-devel, Paul Pogonyshev
>>>>> "rms" == Richard Stallman <rms@gnu.org> writes:
rms> Thanks for posting the patch. Would people please try it
rms> and report any problems?
I backed out my patch and tried this one for a bit. It seems to work
a bit more nicely. I like it. I haven't run into any problems
(though to be clear I have not used it very long -- I just spot
checked it on various cases I looked at when writing my variant).
Tom
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-01 0:30 ` Richard Stallman
2007-07-01 18:13 ` Tom Tromey
@ 2007-07-01 20:54 ` Tom Tromey
2007-07-02 12:24 ` Paul Pogonyshev
1 sibling, 1 reply; 12+ messages in thread
From: Tom Tromey @ 2007-07-01 20:54 UTC (permalink / raw)
To: rms; +Cc: emacs-devel, Paul Pogonyshev
>>>>> "rms" == Richard Stallman <rms@gnu.org> writes:
rms> Thanks for posting the patch. Would people please try it
rms> and report any problems?
I get this error occasionally:
eldoc error: (wrong-number-of-arguments (lambda (sym argument-index) (let ((args nil) (doc nil)) (cond ((not (and sym (symbolp sym) (fboundp sym)))) ((and (eq sym (aref eldoc-last-data 0)) (eq (quote function) (aref eldoc-last-data 2))) (setq args (aref eldoc-last-data 1))) ((setq doc (help-split-fundoc (documentation sym t) sym)) (setq args (car doc)) (string-match \`[^ )]* ? args) (setq args (concat ( (substring args (match-end 0)))) (eldoc-last-data-store sym args (quote function))) (t (setq args (eldoc-function-argstring sym)))) (when args (setq doc (eldoc-highlight-function-argument sym args argument-index))) doc)) 0)
To see this, open gnus/mm-view.el and search for "defcustom". Put
point in the docstring and wait. This reliably shows the error for
me.
Tom
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-01 20:54 ` Tom Tromey
@ 2007-07-02 12:24 ` Paul Pogonyshev
2007-07-02 20:37 ` Tom Tromey
2007-07-02 22:40 ` Richard Stallman
0 siblings, 2 replies; 12+ messages in thread
From: Paul Pogonyshev @ 2007-07-02 12:24 UTC (permalink / raw)
To: emacs-devel, tromey; +Cc: rms
Tom Tromey wrote:
> >>>>> "rms" == Richard Stallman <rms@gnu.org> writes:
>
> rms> Thanks for posting the patch. Would people please try it
> rms> and report any problems?
>
> I get this error occasionally:
Fixed in the new version of the patch below.
Paul
2007-07-02 Paul Pogonyshev <pogonyshev@gmx.net>
* emacs-lisp/eldoc.el (eldoc-last-data): Revise documentation.
(eldoc-print-current-symbol-info): Adjust for changed helper
function signatures.
(eldoc-get-fnsym-args-string): Add `args' argument. Use new
`eldoc-highlight-function-argument'.
(eldoc-highlight-function-argument): New function.
(eldoc-get-var-docstring): Format documentation with
`font-lock-variable-name-face'.
(eldoc-docstring-format-sym-doc): Add `face' argument and apply it
where suited.
(eldoc-fnsym-in-current-sexp): Return a list with argument index.
(eldoc-beginning-of-sexp): Return number of skipped sexps.
Index: lisp/emacs-lisp/eldoc.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/eldoc.el,v
retrieving revision 1.42
diff -c -r1.42 eldoc.el
*** lisp/emacs-lisp/eldoc.el 7 May 2007 01:09:35 -0000 1.42
--- lisp/emacs-lisp/eldoc.el 2 Jul 2007 12:07:32 -0000
***************
*** 124,131 ****
(defconst eldoc-last-data (make-vector 3 nil)
"Bookkeeping; elements are as follows:
0 - contains the last symbol read from the buffer.
! 1 - contains the string last displayed in the echo area for that
! symbol, so it can be printed again if necessary without reconsing.
2 - 'function if function args, 'variable if variable documentation.")
(defvar eldoc-last-message nil)
--- 124,131 ----
(defconst eldoc-last-data (make-vector 3 nil)
"Bookkeeping; elements are as follows:
0 - contains the last symbol read from the buffer.
! 1 - contains the string last displayed in the echo area for variables,
! or argument string for functions.
2 - 'function if function args, 'variable if variable documentation.")
(defvar eldoc-last-message nil)
***************
*** 249,260 ****
(let* ((current-symbol (eldoc-current-symbol))
(current-fnsym (eldoc-fnsym-in-current-sexp))
(doc (cond
! ((eq current-symbol current-fnsym)
! (or (eldoc-get-fnsym-args-string current-fnsym)
(eldoc-get-var-docstring current-symbol)))
(t
(or (eldoc-get-var-docstring current-symbol)
! (eldoc-get-fnsym-args-string current-fnsym))))))
(eldoc-message doc))))
;; This is run from post-command-hook or some idle timer thing,
;; so we need to be careful that errors aren't ignored.
--- 249,264 ----
(let* ((current-symbol (eldoc-current-symbol))
(current-fnsym (eldoc-fnsym-in-current-sexp))
(doc (cond
! ((null current-fnsym)
! nil)
! ((eq current-symbol (car current-fnsym))
! (or (apply 'eldoc-get-fnsym-args-string
! current-fnsym)
(eldoc-get-var-docstring current-symbol)))
(t
(or (eldoc-get-var-docstring current-symbol)
! (apply 'eldoc-get-fnsym-args-string
! current-fnsym))))))
(eldoc-message doc))))
;; This is run from post-command-hook or some idle timer thing,
;; so we need to be careful that errors aren't ignored.
***************
*** 263,286 ****
;; Return a string containing the function parameter list, or 1-line
;; docstring if function is a subr and no arglist is obtainable from the
;; docstring or elsewhere.
! (defun eldoc-get-fnsym-args-string (sym)
(let ((args nil)
(doc nil))
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
(eq 'function (aref eldoc-last-data 2)))
! (setq doc (aref eldoc-last-data 1)))
((setq doc (help-split-fundoc (documentation sym t) sym))
(setq args (car doc))
(string-match "\\`[^ )]* ?" args)
! (setq args (concat "(" (substring args (match-end 0)))))
(t
(setq args (eldoc-function-argstring sym))))
! (cond (args
! (setq doc (eldoc-docstring-format-sym-doc sym args))
! (eldoc-last-data-store sym doc 'function)))
doc))
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
--- 267,328 ----
;; Return a string containing the function parameter list, or 1-line
;; docstring if function is a subr and no arglist is obtainable from the
;; docstring or elsewhere.
! (defun eldoc-get-fnsym-args-string (sym argument-index)
(let ((args nil)
(doc nil))
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
(eq 'function (aref eldoc-last-data 2)))
! (setq args (aref eldoc-last-data 1)))
((setq doc (help-split-fundoc (documentation sym t) sym))
(setq args (car doc))
(string-match "\\`[^ )]* ?" args)
! (setq args (concat "(" (substring args (match-end 0))))
! (eldoc-last-data-store sym args 'function))
(t
(setq args (eldoc-function-argstring sym))))
! (when args
! (setq doc (eldoc-highlight-function-argument sym args argument-index)))
doc))
+ ;; Highlight argument INDEX in ARGS list for SYM.
+ (defun eldoc-highlight-function-argument (sym args index)
+ (let ((start nil)
+ (end 0)
+ (argument-face 'bold))
+ ;; Find the current argument in the argument string. We need to
+ ;; handle `&rest' and informal `...' properly.
+ ;;
+ ;; FIXME: What to do with optional arguments, like in
+ ;; (defun NAME ARGLIST [DOCSTRING] BODY...) case?
+ ;; The problem is there is no robust way to determine if
+ ;; the current argument is indeed a docstring.
+ (while (>= index 1)
+ (if (string-match "[^ ()]+" args end)
+ (progn
+ (setq start (match-beginning 0)
+ end (match-end 0))
+ (let ((argument (match-string 0 args)))
+ (cond ((string= argument "&rest")
+ ;; All the rest arguments are the same.
+ (setq index 1))
+ ((string= argument "&optional"))
+ ((string-match "\\.\\.\\.$" argument)
+ (setq index 0))
+ (t
+ (setq index (1- index))))))
+ (setq end (length args)
+ start (1- end)
+ argument-face 'font-lock-warning-face
+ index 0)))
+ (let ((doc args))
+ (when start
+ (setq doc (copy-sequence args))
+ (add-text-properties start end (list 'face argument-face) doc))
+ (setq doc (eldoc-docstring-format-sym-doc
+ sym doc 'font-lock-function-name-face))
+ doc)))
+
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
***************
*** 292,298 ****
(let ((doc (documentation-property sym 'variable-documentation t)))
(cond (doc
(setq doc (eldoc-docstring-format-sym-doc
! sym (eldoc-docstring-first-line doc)))
(eldoc-last-data-store sym doc 'variable)))
doc)))))
--- 334,341 ----
(let ((doc (documentation-property sym 'variable-documentation t)))
(cond (doc
(setq doc (eldoc-docstring-format-sym-doc
! sym (eldoc-docstring-first-line doc)
! 'font-lock-variable-name-face))
(eldoc-last-data-store sym doc 'variable)))
doc)))))
***************
*** 316,322 ****
;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
! (defun eldoc-docstring-format-sym-doc (sym doc)
(save-match-data
(let* ((name (symbol-name sym))
(ea-multi eldoc-echo-area-use-multiline-p)
--- 359,365 ----
;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
! (defun eldoc-docstring-format-sym-doc (sym doc face)
(save-match-data
(let* ((name (symbol-name sym))
(ea-multi eldoc-echo-area-use-multiline-p)
***************
*** 328,334 ****
(cond ((or (<= strip 0)
(eq ea-multi t)
(and ea-multi (> (length doc) ea-width)))
! (format "%s: %s" sym doc))
((> (length doc) ea-width)
(substring (format "%s" doc) 0 ea-width))
((>= strip (length name))
--- 371,377 ----
(cond ((or (<= strip 0)
(eq ea-multi t)
(and ea-multi (> (length doc) ea-width)))
! (format "%s: %s" (propertize name 'face face) doc))
((> (length doc) ea-width)
(substring (format "%s" doc) 0 ea-width))
((>= strip (length name))
***************
*** 338,364 ****
;; than the beginning, since the former is more likely
;; to be unique given package namespace conventions.
(setq name (substring name strip))
! (format "%s: %s" name doc))))))
(defun eldoc-fnsym-in-current-sexp ()
! (let ((p (point)))
! (eldoc-beginning-of-sexp)
! (prog1
! ;; Don't do anything if current word is inside a string.
! (if (= (or (char-after (1- (point))) 0) ?\")
! nil
! (eldoc-current-symbol))
! (goto-char p))))
(defun eldoc-beginning-of-sexp ()
! (let ((parse-sexp-ignore-comments t))
(condition-case err
! (while (progn
! (forward-sexp -1)
! (or (= (char-before) ?\")
! (> (point) (point-min)))))
! (error nil))))
;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
--- 381,424 ----
;; than the beginning, since the former is more likely
;; to be unique given package namespace conventions.
(setq name (substring name strip))
! (format "%s: %s" (propertize name 'face face) doc))))))
+ ;; Return a list of current function name and argument index.
(defun eldoc-fnsym-in-current-sexp ()
! (save-excursion
! (let ((argument-index (1- (eldoc-beginning-of-sexp))))
! ;; If we are at the beginning of function name, this will be -1.
! (when (< argument-index 0)
! (setq argument-index 0))
! ;; Don't do anything if current word is inside a string.
! (if (= (or (char-after (1- (point))) 0) ?\")
! nil
! (list (eldoc-current-symbol) argument-index)))))
+ ;; Move to the beginnig of current sexp. Return the number of nested
+ ;; sexp the point was over or after.
(defun eldoc-beginning-of-sexp ()
! (let ((parse-sexp-ignore-comments t)
! (num-skipped-sexps 0))
(condition-case err
! (progn
! ;; First account for the case the point is directly over a
! ;; beginning of a nested sexp.
! (condition-case err
! (let ((p (point)))
! (forward-sexp -1)
! (forward-sexp 1)
! (when (< (point) p)
! (setq num-skipped-sexps 1)))
! (error))
! (while
! (let ((p (point)))
! (forward-sexp -1)
! (when (< (point) p)
! (setq num-skipped-sexps (1+ num-skipped-sexps))))))
! (error))
! num-skipped-sexps))
;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-02 12:24 ` Paul Pogonyshev
@ 2007-07-02 20:37 ` Tom Tromey
2007-07-02 21:22 ` Paul Pogonyshev
2007-07-02 22:40 ` Richard Stallman
1 sibling, 1 reply; 12+ messages in thread
From: Tom Tromey @ 2007-07-02 20:37 UTC (permalink / raw)
To: Paul Pogonyshev; +Cc: rms, emacs-devel
>>>>> "Paul" == Paul Pogonyshev <pogonyshev@gmx.net> writes:
>> I get this error occasionally:
Paul> Fixed in the new version of the patch below.
Thanks. This works for me.
Note that the patch didn't apply cleanly. CVS eldoc.el has a ^L
character that throws off finding the context.
Tom
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-02 20:37 ` Tom Tromey
@ 2007-07-02 21:22 ` Paul Pogonyshev
0 siblings, 0 replies; 12+ messages in thread
From: Paul Pogonyshev @ 2007-07-02 21:22 UTC (permalink / raw)
To: emacs-devel, tromey; +Cc: rms
[-- Attachment #1: Type: text/plain, Size: 416 bytes --]
Tom Tromey wrote:
> >>>>> "Paul" == Paul Pogonyshev <pogonyshev@gmx.net> writes:
>
> >> I get this error occasionally:
>
> Paul> Fixed in the new version of the patch below.
>
> Thanks. This works for me.
>
> Note that the patch didn't apply cleanly. CVS eldoc.el has a ^L
> character that throws off finding the context.
Mmm, possibly it got eaten by my mail client. Attaching instead
of appending.
Paul
[-- Attachment #2: eldoc-highlight-argument.diff --]
[-- Type: text/x-diff, Size: 10619 bytes --]
Index: lisp/emacs-lisp/eldoc.el
===================================================================
RCS file: /cvsroot/emacs/emacs/lisp/emacs-lisp/eldoc.el,v
retrieving revision 1.42
diff -c -r1.42 eldoc.el
*** lisp/emacs-lisp/eldoc.el 7 May 2007 01:09:35 -0000 1.42
--- lisp/emacs-lisp/eldoc.el 2 Jul 2007 12:07:32 -0000
***************
*** 124,131 ****
(defconst eldoc-last-data (make-vector 3 nil)
"Bookkeeping; elements are as follows:
0 - contains the last symbol read from the buffer.
! 1 - contains the string last displayed in the echo area for that
! symbol, so it can be printed again if necessary without reconsing.
2 - 'function if function args, 'variable if variable documentation.")
(defvar eldoc-last-message nil)
--- 124,131 ----
(defconst eldoc-last-data (make-vector 3 nil)
"Bookkeeping; elements are as follows:
0 - contains the last symbol read from the buffer.
! 1 - contains the string last displayed in the echo area for variables,
! or argument string for functions.
2 - 'function if function args, 'variable if variable documentation.")
(defvar eldoc-last-message nil)
***************
*** 249,260 ****
(let* ((current-symbol (eldoc-current-symbol))
(current-fnsym (eldoc-fnsym-in-current-sexp))
(doc (cond
! ((eq current-symbol current-fnsym)
! (or (eldoc-get-fnsym-args-string current-fnsym)
(eldoc-get-var-docstring current-symbol)))
(t
(or (eldoc-get-var-docstring current-symbol)
! (eldoc-get-fnsym-args-string current-fnsym))))))
(eldoc-message doc))))
;; This is run from post-command-hook or some idle timer thing,
;; so we need to be careful that errors aren't ignored.
--- 249,264 ----
(let* ((current-symbol (eldoc-current-symbol))
(current-fnsym (eldoc-fnsym-in-current-sexp))
(doc (cond
! ((null current-fnsym)
! nil)
! ((eq current-symbol (car current-fnsym))
! (or (apply 'eldoc-get-fnsym-args-string
! current-fnsym)
(eldoc-get-var-docstring current-symbol)))
(t
(or (eldoc-get-var-docstring current-symbol)
! (apply 'eldoc-get-fnsym-args-string
! current-fnsym))))))
(eldoc-message doc))))
;; This is run from post-command-hook or some idle timer thing,
;; so we need to be careful that errors aren't ignored.
***************
*** 263,286 ****
;; Return a string containing the function parameter list, or 1-line
;; docstring if function is a subr and no arglist is obtainable from the
;; docstring or elsewhere.
! (defun eldoc-get-fnsym-args-string (sym)
(let ((args nil)
(doc nil))
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
(eq 'function (aref eldoc-last-data 2)))
! (setq doc (aref eldoc-last-data 1)))
((setq doc (help-split-fundoc (documentation sym t) sym))
(setq args (car doc))
(string-match "\\`[^ )]* ?" args)
! (setq args (concat "(" (substring args (match-end 0)))))
(t
(setq args (eldoc-function-argstring sym))))
! (cond (args
! (setq doc (eldoc-docstring-format-sym-doc sym args))
! (eldoc-last-data-store sym doc 'function)))
doc))
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
--- 267,328 ----
;; Return a string containing the function parameter list, or 1-line
;; docstring if function is a subr and no arglist is obtainable from the
;; docstring or elsewhere.
! (defun eldoc-get-fnsym-args-string (sym argument-index)
(let ((args nil)
(doc nil))
(cond ((not (and sym (symbolp sym) (fboundp sym))))
((and (eq sym (aref eldoc-last-data 0))
(eq 'function (aref eldoc-last-data 2)))
! (setq args (aref eldoc-last-data 1)))
((setq doc (help-split-fundoc (documentation sym t) sym))
(setq args (car doc))
(string-match "\\`[^ )]* ?" args)
! (setq args (concat "(" (substring args (match-end 0))))
! (eldoc-last-data-store sym args 'function))
(t
(setq args (eldoc-function-argstring sym))))
! (when args
! (setq doc (eldoc-highlight-function-argument sym args argument-index)))
doc))
+ ;; Highlight argument INDEX in ARGS list for SYM.
+ (defun eldoc-highlight-function-argument (sym args index)
+ (let ((start nil)
+ (end 0)
+ (argument-face 'bold))
+ ;; Find the current argument in the argument string. We need to
+ ;; handle `&rest' and informal `...' properly.
+ ;;
+ ;; FIXME: What to do with optional arguments, like in
+ ;; (defun NAME ARGLIST [DOCSTRING] BODY...) case?
+ ;; The problem is there is no robust way to determine if
+ ;; the current argument is indeed a docstring.
+ (while (>= index 1)
+ (if (string-match "[^ ()]+" args end)
+ (progn
+ (setq start (match-beginning 0)
+ end (match-end 0))
+ (let ((argument (match-string 0 args)))
+ (cond ((string= argument "&rest")
+ ;; All the rest arguments are the same.
+ (setq index 1))
+ ((string= argument "&optional"))
+ ((string-match "\\.\\.\\.$" argument)
+ (setq index 0))
+ (t
+ (setq index (1- index))))))
+ (setq end (length args)
+ start (1- end)
+ argument-face 'font-lock-warning-face
+ index 0)))
+ (let ((doc args))
+ (when start
+ (setq doc (copy-sequence args))
+ (add-text-properties start end (list 'face argument-face) doc))
+ (setq doc (eldoc-docstring-format-sym-doc
+ sym doc 'font-lock-function-name-face))
+ doc)))
+
;; Return a string containing a brief (one-line) documentation string for
;; the variable.
(defun eldoc-get-var-docstring (sym)
***************
*** 292,298 ****
(let ((doc (documentation-property sym 'variable-documentation t)))
(cond (doc
(setq doc (eldoc-docstring-format-sym-doc
! sym (eldoc-docstring-first-line doc)))
(eldoc-last-data-store sym doc 'variable)))
doc)))))
--- 334,341 ----
(let ((doc (documentation-property sym 'variable-documentation t)))
(cond (doc
(setq doc (eldoc-docstring-format-sym-doc
! sym (eldoc-docstring-first-line doc)
! 'font-lock-variable-name-face))
(eldoc-last-data-store sym doc 'variable)))
doc)))))
***************
*** 316,322 ****
;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
! (defun eldoc-docstring-format-sym-doc (sym doc)
(save-match-data
(let* ((name (symbol-name sym))
(ea-multi eldoc-echo-area-use-multiline-p)
--- 359,365 ----
;; If the entire line cannot fit in the echo area, the symbol name may be
;; truncated or eliminated entirely from the output to make room for the
;; description.
! (defun eldoc-docstring-format-sym-doc (sym doc face)
(save-match-data
(let* ((name (symbol-name sym))
(ea-multi eldoc-echo-area-use-multiline-p)
***************
*** 328,334 ****
(cond ((or (<= strip 0)
(eq ea-multi t)
(and ea-multi (> (length doc) ea-width)))
! (format "%s: %s" sym doc))
((> (length doc) ea-width)
(substring (format "%s" doc) 0 ea-width))
((>= strip (length name))
--- 371,377 ----
(cond ((or (<= strip 0)
(eq ea-multi t)
(and ea-multi (> (length doc) ea-width)))
! (format "%s: %s" (propertize name 'face face) doc))
((> (length doc) ea-width)
(substring (format "%s" doc) 0 ea-width))
((>= strip (length name))
***************
*** 338,364 ****
;; than the beginning, since the former is more likely
;; to be unique given package namespace conventions.
(setq name (substring name strip))
! (format "%s: %s" name doc))))))
\f
(defun eldoc-fnsym-in-current-sexp ()
! (let ((p (point)))
! (eldoc-beginning-of-sexp)
! (prog1
! ;; Don't do anything if current word is inside a string.
! (if (= (or (char-after (1- (point))) 0) ?\")
! nil
! (eldoc-current-symbol))
! (goto-char p))))
(defun eldoc-beginning-of-sexp ()
! (let ((parse-sexp-ignore-comments t))
(condition-case err
! (while (progn
! (forward-sexp -1)
! (or (= (char-before) ?\")
! (> (point) (point-min)))))
! (error nil))))
;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
--- 381,424 ----
;; than the beginning, since the former is more likely
;; to be unique given package namespace conventions.
(setq name (substring name strip))
! (format "%s: %s" (propertize name 'face face) doc))))))
\f
+ ;; Return a list of current function name and argument index.
(defun eldoc-fnsym-in-current-sexp ()
! (save-excursion
! (let ((argument-index (1- (eldoc-beginning-of-sexp))))
! ;; If we are at the beginning of function name, this will be -1.
! (when (< argument-index 0)
! (setq argument-index 0))
! ;; Don't do anything if current word is inside a string.
! (if (= (or (char-after (1- (point))) 0) ?\")
! nil
! (list (eldoc-current-symbol) argument-index)))))
+ ;; Move to the beginnig of current sexp. Return the number of nested
+ ;; sexp the point was over or after.
(defun eldoc-beginning-of-sexp ()
! (let ((parse-sexp-ignore-comments t)
! (num-skipped-sexps 0))
(condition-case err
! (progn
! ;; First account for the case the point is directly over a
! ;; beginning of a nested sexp.
! (condition-case err
! (let ((p (point)))
! (forward-sexp -1)
! (forward-sexp 1)
! (when (< (point) p)
! (setq num-skipped-sexps 1)))
! (error))
! (while
! (let ((p (point)))
! (forward-sexp -1)
! (when (< (point) p)
! (setq num-skipped-sexps (1+ num-skipped-sexps))))))
! (error))
! num-skipped-sexps))
;; returns nil unless current word is an interned symbol.
(defun eldoc-current-symbol ()
[-- Attachment #3: Type: text/plain, Size: 142 bytes --]
_______________________________________________
Emacs-devel mailing list
Emacs-devel@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-devel
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-02 12:24 ` Paul Pogonyshev
2007-07-02 20:37 ` Tom Tromey
@ 2007-07-02 22:40 ` Richard Stallman
2007-07-07 10:40 ` Paul Pogonyshev
1 sibling, 1 reply; 12+ messages in thread
From: Richard Stallman @ 2007-07-02 22:40 UTC (permalink / raw)
To: Paul Pogonyshev; +Cc: tromey, emacs-devel
In a few days, if there are no further problems, would you please
install it? Or start bugging others to install it?
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-02 22:40 ` Richard Stallman
@ 2007-07-07 10:40 ` Paul Pogonyshev
2007-07-07 20:47 ` Richard Stallman
0 siblings, 1 reply; 12+ messages in thread
From: Paul Pogonyshev @ 2007-07-07 10:40 UTC (permalink / raw)
To: emacs-devel, rms; +Cc: tromey
Richard Stallman wrote:
> In a few days, if there are no further problems, would you please
> install it? Or start bugging others to install it?
So, anyone cares to install patch?
Paul
http://lists.gnu.org/archive/html/emacs-devel/2007-07/msg00114.html
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-07 10:40 ` Paul Pogonyshev
@ 2007-07-07 20:47 ` Richard Stallman
2007-07-11 21:29 ` Paul Pogonyshev
0 siblings, 1 reply; 12+ messages in thread
From: Richard Stallman @ 2007-07-07 20:47 UTC (permalink / raw)
To: emacs-devel; +Cc: Paul Pogonyshev
Would someone please install this patch
http://lists.gnu.org/archive/html/emacs-devel/2007-07/msg00114.html
and then ack?
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-07 20:47 ` Richard Stallman
@ 2007-07-11 21:29 ` Paul Pogonyshev
2007-07-12 1:52 ` Stefan Monnier
0 siblings, 1 reply; 12+ messages in thread
From: Paul Pogonyshev @ 2007-07-11 21:29 UTC (permalink / raw)
To: emacs-devel
Richard Stallman wrote:
> Would someone please install this patch
>
> http://lists.gnu.org/archive/html/emacs-devel/2007-07/msg00114.html
>
> and then ack?
Anyone...
Paul
^ permalink raw reply [flat|nested] 12+ messages in thread
* Re: highlight current argument in Eldoc for Elisp
2007-07-11 21:29 ` Paul Pogonyshev
@ 2007-07-12 1:52 ` Stefan Monnier
0 siblings, 0 replies; 12+ messages in thread
From: Stefan Monnier @ 2007-07-12 1:52 UTC (permalink / raw)
To: Paul Pogonyshev; +Cc: emacs-devel
>> Would someone please install this patch
>>
>> http://lists.gnu.org/archive/html/emacs-devel/2007-07/msg00114.html
>>
>> and then ack?
> Anyone...
Done, and sorry for the delay,
Stefan
^ permalink raw reply [flat|nested] 12+ messages in thread
end of thread, other threads:[~2007-07-12 1:52 UTC | newest]
Thread overview: 12+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2007-06-30 15:13 highlight current argument in Eldoc for Elisp Paul Pogonyshev
2007-07-01 0:30 ` Richard Stallman
2007-07-01 18:13 ` Tom Tromey
2007-07-01 20:54 ` Tom Tromey
2007-07-02 12:24 ` Paul Pogonyshev
2007-07-02 20:37 ` Tom Tromey
2007-07-02 21:22 ` Paul Pogonyshev
2007-07-02 22:40 ` Richard Stallman
2007-07-07 10:40 ` Paul Pogonyshev
2007-07-07 20:47 ` Richard Stallman
2007-07-11 21:29 ` Paul Pogonyshev
2007-07-12 1:52 ` Stefan Monnier
Code repositories for project(s) associated with this public inbox
https://git.savannah.gnu.org/cgit/emacs.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).