Error-Free Navigation in Trees of Sub-Expressions (sexp) in Font-Locking Function Matchers

Error-Free Navigation in Trees of Sub-Expressions (sexp) in Font-Locking Function Matchers

[Nordlöw]

How can I programmatically iterate over all sexps in an emacs-lisp
expression without risking getting an error? I have tried forward-
sexp() and backward-sexp() and up/down-list() but these generate an
error when I get to the beginning or end in each "direction". Why, on
earth, doesn't these functions have an optional argument, say no-
error, that inhibits errors in these cases and instead indicates this
event by returning nil?

I believe I need these functions because I am currently extending font-
locking in emacs-lisp-mode to highlight variables in let and defun-
like statements.

Here is my moccup so far:

(defun pnw-fancy/setq-args-matcher (limit)
  (let ((start (point)))    ; remember beginning
    (if (looking-at (concat "[[:blank:]\n]*" "'?\\(\\w+\\)")) ; One
more SYM?
        (progn (goto-char (match-end 1))
               (forward-sexp); skip VAL
               t)); signal hit
    ))
(defun pnw-fancy/emacs-lisp-variables-font-locking ()
  (font-lock-add-keywords
   nil
   (list
    ;; setq-statements: (setq SYM VAL ...)
    `(;; MATCHER: (SETQ
      ,(concat "(" (regexp-opt '("set"
                                 "setq"
                                 "setq-default"
                                 "setq-mode-local") t)
               "[[:blank:]\n]*")
      ;; SUBEXP-HIGHLIGHTER
      (1 'font-lock-function-call-face keep)
      ;; ANCHORED-HIGHLIGHTER: (setq SYM VAL ...)
      (;; ANCHORED-MATCHER
       pnw-fancy/setq-args-matcher
       nil ; PRE-FORM
       nil ; POST-FORM
       (1 'font-lock-variable-name-face prepend) ; SUBEXP-HIGHLIGHTERS
       ))
    ) t))
(add-hook 'emacs-lisp-mode-hook 'pnw-fancy/emacs-lisp-variables-font-
locking)

Test on these examples:

(setq a 1 b 2 c 3)
(setq a 1
      b 2
      c 3)
(setq x-1 '(1 1) x-2 '(2 2) x-3 '(3 3))

It currently doesn't work for multi-line variants of setq-form. Is
this beyond the capabilities of font-lock?

As I have said above it siliently errors when the last VAL is missing
like in the following statement:
(setq a 1 b 2 c)
What is the most clever way of checking when we are at the last sexp
(forward-sexp will fail as mentioned above)?

Thanks in advance,
Nordlöw

Re: Error-Free Navigation in Trees of Sub-Expressions (sexp) in Font-Locking Function Matchers

[Nordlöw]

Ooops...

My initial posting contained two errors.
Here is the correct test code that works in Vanilla Emacs:

(defun pnw-fancy/setq-args-matcher (limit)
  (let ((start (point)))    ; remember beginning
    (if (looking-at (concat "[[:blank:]\n]*" "'?\\(\\w+\\)"))
        (progn (goto-char (match-end 1))
               (forward-sexp); skip VAL
               t)); signal hit
    ))
(defun pnw-fancy/emacs-lisp-variables-font-locking ()
  (font-lock-add-keywords
   nil
   (list
    ;; setq-statements: (setq SYM VAL ...)
    `(;; MATCHER: (SETQ
      ,(concat "(" (regexp-opt '("set"
                                 "setq"
                                 "setq-default"
                                 "setq-mode-local") t)
               "[[:blank:]\n]*")
      ;; SUBEXP-HIGHLIGHTER
      (1 'font-lock-function-name-face keep)
      ;; ANCHORED-HIGHLIGHTER: (setq SYM VAL ...)
      (;; ANCHORED-MATCHER
       pnw-fancy/setq-args-matcher
       nil ; PRE-FORM
       nil ; POST-FORM
       (1 'font-lock-variable-name-face prepend) ; SUBEXP-HIGHLIGHTERS
       ))
    ) t))
(add-hook 'emacs-lisp-mode-hook 'pnw-fancy/emacs-lisp-variables-font-
locking)

/Nordlöw

Re: Error-Free Navigation in Trees of Sub-Expressions (sexp) in Font-Locking Function Matchers

[Nikolaj Schumacher]

Nordlöw <per.nordlow@gmail.com> wrote:

> What is the most clever way of checking when we are at the last sexp
> (forward-sexp will fail as mentioned above)?

You could use either:

(condition-case err
   (while t
     (forward-sexp)
     ...)
 (scan-error . nil))

to break the loop on an error, or:

(while (ignore-errors (forward-sexp) t)
  ...)

to get a nil when forward-sexp fails.


regards,
Nikolaj Schumacher

Re: Error-Free Navigation in Trees of Sub-Expressions (sexp) in Font-Locking Function Matchers

[Nordlöw]

On 8 Okt, 16:15, Nikolaj Schumacher <m...@nschum.de> wrote:
> Nordlöw <per.nord...@gmail.com> wrote:
> > What is the most clever way of checking when we are at the last sexp
> > (forward-sexp will fail as mentioned above)?
>
> You could use either:
>
> (condition-case err
>    (while t
>      (forward-sexp)
>      ...)
>  (scan-error . nil))
>
> to break the loop on an error, or:
>
> (while (ignore-errors (forward-sexp) t)
>   ...)
>
> to get a nil when forward-sexp fails.
>
> regards,
> Nikolaj Schumacher

Superb!

One can do everything in elisp, if you only know how ;)

/Nordlöw