all messages for Emacs-related lists mirrored at yhetil.org
 help / color / mirror / code / Atom feed
* bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters.
@ 2015-09-09 20:10 Alan Mackenzie
  2015-09-10  3:30 ` Stefan Monnier
  2019-10-31 17:00 ` Lars Ingebrigtsen
  0 siblings, 2 replies; 6+ messages in thread
From: Alan Mackenzie @ 2015-09-09 20:10 UTC (permalink / raw)
  To: 21449

Hello, Emacs.

In Emacs lisp mode, write something like:

    (defun fix-re--RA|RB->R\(A|B\) (foo bar) ...)
                           ^^^^^^^

.  The part of the symbol indicated remains unfontified.  This happens
because the fontification patterns in .../lisp/emacs-lisp/lisp-mode.el
dont't take account of escaped characters in symbol names.

By replacing lots of "\\(?:\\sw\\|\\s_\\)" by
"\\(?:\\sw\\|\\s_\\|\\\\.\\)", the fontification is repaired.

As a bonus, this fix makes imenu work properly with these symbols too.

Unfortunately, as yet the regular expression expressions "\\_<" and
"\\_>" don't work properly with these symbols.  To fix that would need
an amendment to .../src/regex.c, with possibly .../src/syntax.c needing
one too.  It feels like there really ought to be some major mode
dependent flag saying whether or not escaped characters are valid in
identifiers.  They are in Emacs lisp, but they're not in C.

Anyhow, here's the patch:



diff --git a/lisp/emacs-lisp/lisp-mode.el b/lisp/emacs-lisp/lisp-mode.el
index 8aa34c7..7be7cb3 100644
--- a/lisp/emacs-lisp/lisp-mode.el
+++ b/lisp/emacs-lisp/lisp-mode.el
@@ -110,7 +110,7 @@
                                 ;; CLOS and EIEIO
 				"defgeneric" "defmethod")
                               t))
-			   "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
+			   "\\s-+\\(\\(\\sw\\|\\s_\\|\\\\.\\)+\\)"))
 	 2)
    (list (purecopy "Variables")
 	 (purecopy (concat "^\\s-*("
@@ -122,11 +122,11 @@
                                 "defconstant"
 				"defparameter" "define-symbol-macro")
                               t))
-			   "\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"))
+			   "\\s-+\\(\\(\\sw\\|\\s_\\|\\\\.\\)+\\)"))
 	 2)
    ;; For `defvar', we ignore (defvar FOO) constructs.
    (list (purecopy "Variables")
-	 (purecopy (concat "^\\s-*(defvar\\s-+\\(\\(\\sw\\|\\s_\\)+\\)"
+	 (purecopy (concat "^\\s-*(defvar\\s-+\\(\\(\\sw\\|\\s_\\|\\\\.\\)+\\)"
 			   "[[:space:]\n]+[^)]"))
 	 1)
    (list (purecopy "Types")
@@ -143,7 +143,7 @@
                                 ;; CLOS and EIEIO
                                 "defclass")
                               t))
-			   "\\s-+'?\\(\\(\\sw\\|\\s_\\)+\\)"))
+			   "\\s-+'?\\(\\(\\sw\\|\\s_\\|\\\\.\\)+\\)"))
 	 2))
 
   "Imenu generic expression for Lisp mode.  See `imenu-generic-expression'.")
@@ -220,7 +220,7 @@
 (defun lisp--el-match-keyword (limit)
   ;; FIXME: Move to elisp-mode.el.
   (catch 'found
-    (while (re-search-forward "(\\(\\(?:\\sw\\|\\s_\\)+\\)\\_>" limit t)
+    (while (re-search-forward "(\\(\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)\\_>" limit t)
       (let ((sym (intern-soft (match-string 1))))
 	(when (or (special-form-p sym)
 		  (and (macrop sym)
@@ -349,7 +349,7 @@
                   ;; Any whitespace and defined object.
                   "[ \t']*"
                   "\\(([ \t']*\\)?" ;; An opening paren.
-                  "\\(\\(setf\\)[ \t]+\\(?:\\sw\\|\\s_\\)+\\|\\(?:\\sw\\|\\s_\\)+\\)?")
+                  "\\(\\(setf\\)[ \t]+\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\|\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)?")
           (1 font-lock-keyword-face)
           (3 (let ((type (get (intern-soft (match-string 1)) 'lisp-define-type)))
                (cond ((eq type 'var) font-lock-variable-name-face)
@@ -373,7 +373,7 @@
                   ;; Any whitespace and defined object.
                   "[ \t']*"
                   "\\(([ \t']*\\)?" ;; An opening paren.
-                  "\\(\\(setf\\)[ \t]+\\(?:\\sw\\|\\s_\\)+\\|\\(?:\\sw\\|\\s_\\)+\\)?")
+                  "\\(\\(setf\\)[ \t]+\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\|\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)?")
           (1 font-lock-keyword-face)
           (3 (let ((type (get (intern-soft (match-string 1)) 'lisp-define-type)))
                (cond ((eq type 'var) font-lock-variable-name-face)
@@ -395,22 +395,22 @@
          (lisp--el-match-keyword . 1)
          ;; Exit/Feature symbols as constants.
          (,(concat "(\\(catch\\|throw\\|featurep\\|provide\\|require\\)\\_>"
-                   "[ \t']*\\(\\(?:\\sw\\|\\s_\\)+\\)?")
+                   "[ \t']*\\(\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)?")
            (1 font-lock-keyword-face)
            (2 font-lock-constant-face nil t))
          ;; Erroneous structures.
          (,(concat "(" el-errs-re "\\_>")
            (1 font-lock-warning-face))
          ;; Words inside \\[] tend to be for `substitute-command-keys'.
-         ("\\\\\\\\\\[\\(\\(?:\\sw\\|\\s_\\)+\\)\\]"
+         ("\\\\\\\\\\[\\(\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)\\]"
           (1 font-lock-constant-face prepend))
          ;; Words inside ‘’ and '' and `' tend to be symbol names.
-         ("['`‘]\\(\\(?:\\sw\\|\\s_\\)\\(?:\\sw\\|\\s_\\)+\\)['’]"
+         ("['`‘]\\(\\(?:\\sw\\|\\s_\\|\\\\.\\)\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)['’]"
           (1 font-lock-constant-face prepend))
          ;; Constant values.
-         ("\\_<:\\(?:\\sw\\|\\s_\\)+\\_>" 0 font-lock-builtin-face)
+         ("\\_<:\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\_>" 0 font-lock-builtin-face)
          ;; ELisp and CLisp `&' keywords as types.
-         ("\\_<\\&\\(?:\\sw\\|\\s_\\)+\\_>" . font-lock-type-face)
+         ("\\_<\\&\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\_>" . font-lock-type-face)
          ;; ELisp regexp grouping constructs
          (,(lambda (bound)
              (catch 'found
@@ -447,19 +447,19 @@
          (,(concat "(" cl-kws-re "\\_>") . 1)
          ;; Exit/Feature symbols as constants.
          (,(concat "(\\(catch\\|throw\\|provide\\|require\\)\\_>"
-                   "[ \t']*\\(\\(?:\\sw\\|\\s_\\)+\\)?")
+                   "[ \t']*\\(\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)?")
            (1 font-lock-keyword-face)
            (2 font-lock-constant-face nil t))
          ;; Erroneous structures.
          (,(concat "(" cl-errs-re "\\_>")
            (1 font-lock-warning-face))
          ;; Words inside ‘’ and '' and `' tend to be symbol names.
-         ("['`‘]\\(\\(?:\\sw\\|\\s_\\)\\(?:\\sw\\|\\s_\\)+\\)['’]"
+         ("['`‘]\\(\\(?:\\sw\\|\\s_\\|\\\\.\\)\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\)['’]"
           (1 font-lock-constant-face prepend))
          ;; Constant values.
-         ("\\_<:\\(?:\\sw\\|\\s_\\)+\\_>" 0 font-lock-builtin-face)
+         ("\\_<:\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\_>" 0 font-lock-builtin-face)
          ;; ELisp and CLisp `&' keywords as types.
-         ("\\_<\\&\\(?:\\sw\\|\\s_\\)+\\_>" . font-lock-type-face)
+         ("\\_<\\&\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\_>" . font-lock-type-face)
          ;; This is too general -- rms.
          ;; A user complained that he has functions whose names start with `do'
          ;; and that they get the wrong color.
@@ -482,7 +482,7 @@
   (let* ((firstsym (and listbeg
                         (save-excursion
                           (goto-char listbeg)
-                          (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\)+\\)")
+                          (and (looking-at "([ \t\n]*\\(\\(\\sw\\|\\s_\\|\\\\.\\)+\\)")
                                (match-string 1)))))
          (docelt (and firstsym
                       (function-get (intern-soft firstsym)



-- 
Alan Mackenzie (Nuremberg, Germany).





^ permalink raw reply related	[flat|nested] 6+ messages in thread

* bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters.
  2015-09-09 20:10 bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters Alan Mackenzie
@ 2015-09-10  3:30 ` Stefan Monnier
  2015-09-10 10:44   ` Alan Mackenzie
  2015-09-11 14:49   ` Alan Mackenzie
  2019-10-31 17:00 ` Lars Ingebrigtsen
  1 sibling, 2 replies; 6+ messages in thread
From: Stefan Monnier @ 2015-09-10  3:30 UTC (permalink / raw)
  To: Alan Mackenzie; +Cc: 21449

> one too.  It feels like there really ought to be some major mode
> dependent flag saying whether or not escaped characters are valid in
> identifiers.  They are in Emacs lisp, but they're not in C.

You mean like words-include-escapes?


        Stefan





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters.
  2015-09-10  3:30 ` Stefan Monnier
@ 2015-09-10 10:44   ` Alan Mackenzie
  2015-09-11 14:49   ` Alan Mackenzie
  1 sibling, 0 replies; 6+ messages in thread
From: Alan Mackenzie @ 2015-09-10 10:44 UTC (permalink / raw)
  To: Stefan Monnier; +Cc: 21449

Hello, Stefan.

On Wed, Sep 09, 2015 at 11:30:31PM -0400, Stefan Monnier wrote:
> > one too.  It feels like there really ought to be some major mode
> > dependent flag saying whether or not escaped characters are valid in
> > identifiers.  They are in Emacs lisp, but they're not in C.

> You mean like words-include-escapes?

Something like that, yes.

I don't think words-include-escapes is the right thing to use, though.
I think that doing M-f on "R\(A|B\)", one would want point to move to
just after the R, not just after the A; escaped characters should be
word separators, just like -s are; they should be thought of as \\s_
rather than \\sw.

Something like `identifiers-include-escapes', maybe?

>         Stefan

-- 
Alan Mackenzie (Nuremberg, Germany).





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters.
  2015-09-10  3:30 ` Stefan Monnier
  2015-09-10 10:44   ` Alan Mackenzie
@ 2015-09-11 14:49   ` Alan Mackenzie
  2015-09-11 16:56     ` Stefan Monnier
  1 sibling, 1 reply; 6+ messages in thread
From: Alan Mackenzie @ 2015-09-11 14:49 UTC (permalink / raw)
  To: Stefan Monnier; +Cc: 21449

Hello, Stefan.

On Wed, Sep 09, 2015 at 11:30:31PM -0400, Stefan Monnier wrote:
> > one too.  It feels like there really ought to be some major mode
> > dependent flag saying whether or not escaped characters are valid in
> > identifiers.  They are in Emacs lisp, but they're not in C.

> You mean like words-include-escapes?

Is there any objection to me installing the patch to lisp-mode.el?

It inserts "\\|\\\\." into each font-locking regexp which contains a bit
looking like "(?:\\sw\\|\\s_", so that escaped characters will be picked
up.  There are no other changes.

I think it unlikely this will do any damage.

>         Stefan

-- 
Alan Mackenzie (Nuremberg, Germany).





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters.
  2015-09-11 14:49   ` Alan Mackenzie
@ 2015-09-11 16:56     ` Stefan Monnier
  0 siblings, 0 replies; 6+ messages in thread
From: Stefan Monnier @ 2015-09-11 16:56 UTC (permalink / raw)
  To: Alan Mackenzie; +Cc: 21449

> Is there any objection to me installing the patch to lisp-mode.el?

The resulting regexps are harder to read, for a very small benefit since
identifiers with backslashes should be avoided for the sanity of the
human reader anyway.

But if you like it, fell free to install it,


        Stefan





^ permalink raw reply	[flat|nested] 6+ messages in thread

* bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters.
  2015-09-09 20:10 bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters Alan Mackenzie
  2015-09-10  3:30 ` Stefan Monnier
@ 2019-10-31 17:00 ` Lars Ingebrigtsen
  1 sibling, 0 replies; 6+ messages in thread
From: Lars Ingebrigtsen @ 2019-10-31 17:00 UTC (permalink / raw)
  To: Alan Mackenzie; +Cc: 21449

Alan Mackenzie <acm@muc.de> writes:

>           ;; Constant values.
> -         ("\\_<:\\(?:\\sw\\|\\s_\\)+\\_>" 0 font-lock-builtin-face)
> +         ("\\_<:\\(?:\\sw\\|\\s_\\|\\\\.\\)+\\_>" 0 font-lock-builtin-face)

This code has changed a lot since this was reported:

         ;; Constant values.
         (,(concat "\\_<:" lisp-mode-symbol-regexp "\\_>")
          (0 font-lock-builtin-face))

But:

lisp-mode-symbol-regexp
=> "\\(?:\\sw\\|\\s_\\|\\\\.\\)+"

So it basically looks like this was added in some form or other, and the
test case fontifies correctly for me now, so I'm going to go ahead and
guess that this works as it's supposed to now, and I'm closing this bug
report.

Please reopen if it's still an issue.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no





^ permalink raw reply	[flat|nested] 6+ messages in thread

end of thread, other threads:[~2019-10-31 17:00 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2015-09-09 20:10 bug#21449: Emacs lisp mode: incorrect fontification of symbols containing escaped characters Alan Mackenzie
2015-09-10  3:30 ` Stefan Monnier
2015-09-10 10:44   ` Alan Mackenzie
2015-09-11 14:49   ` Alan Mackenzie
2015-09-11 16:56     ` Stefan Monnier
2019-10-31 17:00 ` Lars Ingebrigtsen

Code repositories for project(s) associated with this external index

	https://git.savannah.gnu.org/cgit/emacs.git
	https://git.savannah.gnu.org/cgit/emacs/org-mode.git

This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.