unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
* bug#70464: [PATCH] Add font-locking for Rust macro variables
@ 2024-04-19  1:42 Noah Peart
  2024-04-19  7:41 ` Yuan Fu
  0 siblings, 1 reply; 6+ messages in thread
From: Noah Peart @ 2024-04-19  1:42 UTC (permalink / raw)
  To: 70464


[-- Attachment #1.1: Type: text/plain, Size: 1668 bytes --]

Tags: patch


Adds some tree-sitter font-locking rules in rust-ts-mode to fontify
meta variables, their types, and repetition operators in macros.

These rules add new font-locking as indicated in the following
snippet:

    macro_rules! unsafe_raw_call {
        ($env:expr, $name:ident $(, $args:expr)*) => {
//          ^ font-lock-variable-name-face
//                  ^ font-lock-type-face
//                                              ^ font-lock-operator-face
//                                                                     ^
font-lock-operator-face
            {
                let env = $env;
//                                ^ font-lock-variable-use-face
                let result = unsafe {
                    let $name = raw_fn!(env, $name);
                    $name(env.raw $(, $args)*)
                };
                env.handle_exit(result)
            }
        };
    }

I also removed the last occurrence of the following duplicated rule from
the `type` feature:
    (type_identifier) @font-lock-type-face

In GNU Emacs 30.0.50 (build 1, x86_64-pc-linux-gnu, GTK+ Version
3.24.33, cairo version 1.16.0) of 2024-04-18 built on noah-X580VD
Repository revision: 0a57dfcff8d0abcf4427cfbfd886264bb3b8eaab
Repository branch: master
Windowing system distributor 'The X.Org Foundation', version 11.0.12101004
System Description: Ubuntu 22.04.4 LTS

Configured using:
 'configure --prefix=/usr/local --with-modules --with-tree-sitter
--with-threads --with-x-toolkit=gtk3 --with-xwidgets --with-gnutls
--with-json --with-mailutils --with-jpeg --with-png --with-rsvg
--with-tiff --with-xml2 --with-xpm --with-imagemagick CC=gcc-12
CXX=gcc-12'

[-- Attachment #1.2: Type: text/html, Size: 2078 bytes --]

[-- Attachment #2: 0001-Add-font-locking-for-Rust-macros.patch --]
[-- Type: text/x-patch, Size: 3148 bytes --]

From b7eb9b37eb9cfd6a94a862f5944b00c113ee7efb Mon Sep 17 00:00:00 2001
From: Noah Peart <noah.v.peart@gmail.com>
Date: Thu, 18 Apr 2024 18:22:05 -0700
Subject: [PATCH] Add font-locking for Rust macros

* lisp/progmodes/rust-ts-mode.el
(rust-ts-mode--font-lock-settings): Add font-locking for Rust
macro metavariables, fragment specifiers and repitition patterns.
---
 lisp/progmodes/rust-ts-mode.el | 15 +++++++++------
 1 file changed, 9 insertions(+), 6 deletions(-)

diff --git a/lisp/progmodes/rust-ts-mode.el b/lisp/progmodes/rust-ts-mode.el
index 7112ceced57..69538568d1c 100644
--- a/lisp/progmodes/rust-ts-mode.el
+++ b/lisp/progmodes/rust-ts-mode.el
@@ -178,6 +178,8 @@ rust-ts-mode--font-lock-settings
    '((function_item name: (identifier) @font-lock-function-name-face)
      (macro_definition "macro_rules!" @font-lock-constant-face)
      (macro_definition (identifier) @font-lock-preprocessor-face)
+     (token_binding_pattern
+      name: (metavariable) @font-lock-variable-name-face)
      (field_declaration name: (field_identifier) @font-lock-property-name-face)
      (parameter pattern: (_) @rust-ts-mode--fontify-pattern)
      (closure_parameters (_) @rust-ts-mode--fontify-pattern)
@@ -218,7 +220,9 @@ rust-ts-mode--font-lock-settings
 
    :language 'rust
    :feature 'operator
-   `([,@rust-ts-mode--operators] @font-lock-operator-face)
+   `([,@rust-ts-mode--operators] @font-lock-operator-face
+     (token_repetition_pattern ["$" "*" "+"] @font-lock-operator-face)
+     (token_repetition ["$" "*" "+"] @font-lock-operator-face))
 
    :language 'rust
    :feature 'string
@@ -248,8 +252,7 @@ rust-ts-mode--font-lock-settings
                 (_ type: (scoped_identifier
                           path: (identifier) @font-lock-type-face))))
      (mod_item name: (identifier) @font-lock-constant-face)
-     (primitive_type) @font-lock-type-face
-     (type_identifier) @font-lock-type-face
+     [(fragment_specifier) (primitive_type) (type_identifier)] @font-lock-type-face
      ((scoped_identifier name: (identifier) @rust-ts-mode--fontify-tail))
      ((scoped_identifier path: (identifier) @font-lock-type-face)
       (:match ,(rx bos
@@ -259,8 +262,7 @@ rust-ts-mode--font-lock-settings
                    eos)
               @font-lock-type-face))
      ((scoped_identifier path: (identifier) @rust-ts-mode--fontify-scope))
-     ((scoped_type_identifier path: (identifier) @rust-ts-mode--fontify-scope))
-     (type_identifier) @font-lock-type-face)
+     ((scoped_type_identifier path: (identifier) @rust-ts-mode--fontify-scope)))
 
    :language 'rust
    :feature 'property
@@ -294,7 +296,8 @@ rust-ts-mode--font-lock-settings
      (return_expression (identifier) @font-lock-variable-use-face)
      (tuple_expression (identifier) @font-lock-variable-use-face)
      (unary_expression (identifier) @font-lock-variable-use-face)
-     (while_expression condition: (identifier) @font-lock-variable-use-face))
+     (while_expression condition: (identifier) @font-lock-variable-use-face)
+     (metavariable) @font-lock-variable-use-face)
 
    :language 'rust
    :feature 'escape-sequence
-- 
2.34.1


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

* bug#70464: [PATCH] Add font-locking for Rust macro variables
  2024-04-19  1:42 bug#70464: [PATCH] Add font-locking for Rust macro variables Noah Peart
@ 2024-04-19  7:41 ` Yuan Fu
  2024-04-19  8:02   ` Vladimir Kazanov
  0 siblings, 1 reply; 6+ messages in thread
From: Yuan Fu @ 2024-04-19  7:41 UTC (permalink / raw)
  To: Noah Peart; +Cc: 70464


Noah Peart <noah.v.peart@gmail.com> writes:

> Tags: patch
>
> Adds some tree-sitter font-locking rules in rust-ts-mode to fontify
> meta variables, their types, and repetition operators in macros.
>
> These rules add new font-locking as indicated in the following
> snippet:
>
>     macro_rules! unsafe_raw_call {
>         ($env:expr, $name:ident $(, $args:expr)*) => {
> //          ^ font-lock-variable-name-face
> //                  ^ font-lock-type-face
> //                                              ^ font-lock-operator-face
> //                                                                     ^ font-lock-operator-face
>             {
>                 let env = $env;
> //                                ^ font-lock-variable-use-face
>                 let result = unsafe {
>                     let $name = raw_fn!(env, $name);
>                     $name(env.raw $(, $args)*)
>                 };
>                 env.handle_exit(result)
>             }
>         };
>     }
>
> I also removed the last occurrence of the following duplicated rule from the `type` feature:
>     (type_identifier) @font-lock-type-face
>

Great! Thanks! I’ll merge this in some time once I figure out whether
should we apply it to emacs-29 or master.

Meanwhile, it seems that you’ve recently working on tree-sitter modes.
If you’re interested, maybe you can take a look at ert-font-lock, and
add some tests that cover the bugs your patches fixes? This is
completely optional, of course. I bought it up because I think you might
be interested.

Yuan





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

* bug#70464: [PATCH] Add font-locking for Rust macro variables
  2024-04-19  7:41 ` Yuan Fu
@ 2024-04-19  8:02   ` Vladimir Kazanov
  2024-04-19 16:44     ` Noah Peart
  0 siblings, 1 reply; 6+ messages in thread
From: Vladimir Kazanov @ 2024-04-19  8:02 UTC (permalink / raw)
  To: Yuan Fu; +Cc: Noah Peart, 70464

Noah,

...and if you decide to add ert-font-lock tests and something is not
working as expected - let me know, happy to fix or extend
ert-font-lock.

Thanks!

On Fri, 19 Apr 2024 at 08:42, Yuan Fu <casouri@gmail.com> wrote:
>
>
> Noah Peart <noah.v.peart@gmail.com> writes:
>
> > Tags: patch
> >
> > Adds some tree-sitter font-locking rules in rust-ts-mode to fontify
> > meta variables, their types, and repetition operators in macros.
> >
> > These rules add new font-locking as indicated in the following
> > snippet:
> >
> >     macro_rules! unsafe_raw_call {
> >         ($env:expr, $name:ident $(, $args:expr)*) => {
> > //          ^ font-lock-variable-name-face
> > //                  ^ font-lock-type-face
> > //                                              ^ font-lock-operator-face
> > //                                                                     ^ font-lock-operator-face
> >             {
> >                 let env = $env;
> > //                                ^ font-lock-variable-use-face
> >                 let result = unsafe {
> >                     let $name = raw_fn!(env, $name);
> >                     $name(env.raw $(, $args)*)
> >                 };
> >                 env.handle_exit(result)
> >             }
> >         };
> >     }
> >
> > I also removed the last occurrence of the following duplicated rule from the `type` feature:
> >     (type_identifier) @font-lock-type-face
> >
>
> Great! Thanks! I’ll merge this in some time once I figure out whether
> should we apply it to emacs-29 or master.
>
> Meanwhile, it seems that you’ve recently working on tree-sitter modes.
> If you’re interested, maybe you can take a look at ert-font-lock, and
> add some tests that cover the bugs your patches fixes? This is
> completely optional, of course. I bought it up because I think you might
> be interested.
>
> Yuan
>
>
>


-- 
Regards,

Vladimir Kazanov





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

* bug#70464: [PATCH] Add font-locking for Rust macro variables
  2024-04-19  8:02   ` Vladimir Kazanov
@ 2024-04-19 16:44     ` Noah Peart
  2024-04-19 17:38       ` Noah Peart
  0 siblings, 1 reply; 6+ messages in thread
From: Noah Peart @ 2024-04-19 16:44 UTC (permalink / raw)
  To: Vladimir Kazanov; +Cc: Yuan Fu, 70464

[-- Attachment #1: Type: text/plain, Size: 2297 bytes --]

Sounds good!

> If you’re interested, maybe you can take a look at ert-font-lock, and
add some tests that cover the bugs your patches fixes?

Sure thing, Ill look into that.

On Fri, Apr 19, 2024 at 1:02 AM Vladimir Kazanov <vekazanov@gmail.com>
wrote:

> Noah,
>
> ...and if you decide to add ert-font-lock tests and something is not
> working as expected - let me know, happy to fix or extend
> ert-font-lock.
>
> Thanks!
>
> On Fri, 19 Apr 2024 at 08:42, Yuan Fu <casouri@gmail.com> wrote:
> >
> >
> > Noah Peart <noah.v.peart@gmail.com> writes:
> >
> > > Tags: patch
> > >
> > > Adds some tree-sitter font-locking rules in rust-ts-mode to fontify
> > > meta variables, their types, and repetition operators in macros.
> > >
> > > These rules add new font-locking as indicated in the following
> > > snippet:
> > >
> > >     macro_rules! unsafe_raw_call {
> > >         ($env:expr, $name:ident $(, $args:expr)*) => {
> > > //          ^ font-lock-variable-name-face
> > > //                  ^ font-lock-type-face
> > > //                                              ^
> font-lock-operator-face
> > > //
>  ^ font-lock-operator-face
> > >             {
> > >                 let env = $env;
> > > //                                ^ font-lock-variable-use-face
> > >                 let result = unsafe {
> > >                     let $name = raw_fn!(env, $name);
> > >                     $name(env.raw $(, $args)*)
> > >                 };
> > >                 env.handle_exit(result)
> > >             }
> > >         };
> > >     }
> > >
> > > I also removed the last occurrence of the following duplicated rule
> from the `type` feature:
> > >     (type_identifier) @font-lock-type-face
> > >
> >
> > Great! Thanks! I’ll merge this in some time once I figure out whether
> > should we apply it to emacs-29 or master.
> >
> > Meanwhile, it seems that you’ve recently working on tree-sitter modes.
> > If you’re interested, maybe you can take a look at ert-font-lock, and
> > add some tests that cover the bugs your patches fixes? This is
> > completely optional, of course. I bought it up because I think you might
> > be interested.
> >
> > Yuan
> >
> >
> >
>
>
> --
> Regards,
>
> Vladimir Kazanov
>

[-- Attachment #2: Type: text/html, Size: 3344 bytes --]

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

* bug#70464: [PATCH] Add font-locking for Rust macro variables
  2024-04-19 16:44     ` Noah Peart
@ 2024-04-19 17:38       ` Noah Peart
  2024-04-22  5:00         ` Yuan Fu
  0 siblings, 1 reply; 6+ messages in thread
From: Noah Peart @ 2024-04-19 17:38 UTC (permalink / raw)
  To: Vladimir Kazanov; +Cc: Yuan Fu, 70464


[-- Attachment #1.1: Type: text/plain, Size: 2627 bytes --]

I've attached a patch with font-locking tests for the recent additions
in (bug#70464) and (bug#70465).  So, it will fail without those being
merged.

Thanks!

On Fri, Apr 19, 2024 at 9:44 AM Noah Peart <noah.v.peart@gmail.com> wrote:

> Sounds good!
>
> > If you’re interested, maybe you can take a look at ert-font-lock, and
> add some tests that cover the bugs your patches fixes?
>
> Sure thing, Ill look into that.
>
> On Fri, Apr 19, 2024 at 1:02 AM Vladimir Kazanov <vekazanov@gmail.com>
> wrote:
>
>> Noah,
>>
>> ...and if you decide to add ert-font-lock tests and something is not
>> working as expected - let me know, happy to fix or extend
>> ert-font-lock.
>>
>> Thanks!
>>
>> On Fri, 19 Apr 2024 at 08:42, Yuan Fu <casouri@gmail.com> wrote:
>> >
>> >
>> > Noah Peart <noah.v.peart@gmail.com> writes:
>> >
>> > > Tags: patch
>> > >
>> > > Adds some tree-sitter font-locking rules in rust-ts-mode to fontify
>> > > meta variables, their types, and repetition operators in macros.
>> > >
>> > > These rules add new font-locking as indicated in the following
>> > > snippet:
>> > >
>> > >     macro_rules! unsafe_raw_call {
>> > >         ($env:expr, $name:ident $(, $args:expr)*) => {
>> > > //          ^ font-lock-variable-name-face
>> > > //                  ^ font-lock-type-face
>> > > //                                              ^
>> font-lock-operator-face
>> > > //
>>  ^ font-lock-operator-face
>> > >             {
>> > >                 let env = $env;
>> > > //                                ^ font-lock-variable-use-face
>> > >                 let result = unsafe {
>> > >                     let $name = raw_fn!(env, $name);
>> > >                     $name(env.raw $(, $args)*)
>> > >                 };
>> > >                 env.handle_exit(result)
>> > >             }
>> > >         };
>> > >     }
>> > >
>> > > I also removed the last occurrence of the following duplicated rule
>> from the `type` feature:
>> > >     (type_identifier) @font-lock-type-face
>> > >
>> >
>> > Great! Thanks! I’ll merge this in some time once I figure out whether
>> > should we apply it to emacs-29 or master.
>> >
>> > Meanwhile, it seems that you’ve recently working on tree-sitter modes.
>> > If you’re interested, maybe you can take a look at ert-font-lock, and
>> > add some tests that cover the bugs your patches fixes? This is
>> > completely optional, of course. I bought it up because I think you might
>> > be interested.
>> >
>> > Yuan
>> >
>> >
>> >
>>
>>
>> --
>> Regards,
>>
>> Vladimir Kazanov
>>
>

[-- Attachment #1.2: Type: text/html, Size: 3930 bytes --]

[-- Attachment #2: 0001-Add-rust-ts-mode-font-locking-tests.patch --]
[-- Type: text/x-patch, Size: 3414 bytes --]

From a090b6dc06d43ec5904db0028710d00c2a0e7acb Mon Sep 17 00:00:00 2001
From: Noah Peart <noah.v.peart@gmail.com>
Date: Fri, 19 Apr 2024 10:27:10 -0700
Subject: [PATCH] Add rust-ts-mode font-locking tests

* test/lisp/progmodes/rust-ts-mode-tests.el: New file for
rust-ts-mode tests.
* test/lisp/progmodes/rust-ts-mode-resources/font-lock.rs: New
file with rust-ts-mode font-locking tests. New tests added for
macro font-locking (bug#70464) and function signatures
(bug#70465).
---
 .../rust-ts-mode-resources/font-lock.rs       | 25 ++++++++++++++
 test/lisp/progmodes/rust-ts-mode-tests.el     | 34 +++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100644 test/lisp/progmodes/rust-ts-mode-resources/font-lock.rs
 create mode 100644 test/lisp/progmodes/rust-ts-mode-tests.el

diff --git a/test/lisp/progmodes/rust-ts-mode-resources/font-lock.rs b/test/lisp/progmodes/rust-ts-mode-resources/font-lock.rs
new file mode 100644
index 00000000000..377cda0e3b9
--- /dev/null
+++ b/test/lisp/progmodes/rust-ts-mode-resources/font-lock.rs
@@ -0,0 +1,25 @@
+// -*- rust-ts-mode-indent-offset: 0 -*-
+// Trait with function signature
+trait Foo {
+    fn foo();
+//      ^ font-lock-function-name-face
+}
+
+// Macros
+macro_rules! unsafe_foo {
+    ($env:expr, $name:ident $(, $args:expr)*) => {
+//    ^ font-lock-variable-name-face
+//         ^ font-lock-type-face
+//                ^ font-lock-variable-name-face
+//                      ^ font-lock-type-face
+//                          ^ font-lock-operator-face
+//                                ^ font-lock-variable-name-face
+//                                      ^ font-lock-type-face
+//                                         ^ font-lock-operator-face
+        {
+            foo!($env, $name $(, $args)*);
+//                ^ font-lock-variable-use-face
+//                           ^ font-lock-operator-face
+//                                     ^ font-lock-operator-face
+        }
+    };
diff --git a/test/lisp/progmodes/rust-ts-mode-tests.el b/test/lisp/progmodes/rust-ts-mode-tests.el
new file mode 100644
index 00000000000..f718a57fc9e
--- /dev/null
+++ b/test/lisp/progmodes/rust-ts-mode-tests.el
@@ -0,0 +1,34 @@
+;;; rust-ts-mode-tests.el --- Tests for rust-ts-mode -*- lexical-binding: t; -*-
+
+;; Copyright (C) 2023-2024 Free Software Foundation, Inc.
+
+;; This file is part of GNU Emacs.
+
+;; GNU Emacs is free software: you can redistribute it and/or modify
+;; it under the terms of the GNU General Public License as published by
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
+
+;; GNU Emacs is distributed in the hope that it will be useful,
+;; but WITHOUT ANY WARRANTY; without even the implied warranty of
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+;; GNU General Public License for more details.
+
+;; You should have received a copy of the GNU General Public License
+;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
+
+;;; Code:
+
+(require 'ert)
+(require 'ert-font-lock)
+(require 'ert-x)
+(require 'treesit)
+
+(ert-deftest rust-ts-test-font-lock ()
+  (skip-unless (treesit-ready-p 'rust))
+  (let ((treesit-font-lock-level 4))
+    (ert-font-lock-test-file (ert-resource-file "font-lock.rs") 'rust-ts-mode)))
+
+(provide 'rust-ts-mode-tests)
+
+;;; rust-ts-mode-tests.el ends here
-- 
2.34.1


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

* bug#70464: [PATCH] Add font-locking for Rust macro variables
  2024-04-19 17:38       ` Noah Peart
@ 2024-04-22  5:00         ` Yuan Fu
  0 siblings, 0 replies; 6+ messages in thread
From: Yuan Fu @ 2024-04-22  5:00 UTC (permalink / raw)
  To: Noah Peart; +Cc: Vladimir Kazanov, 70464-done



> On Apr 19, 2024, at 10:38 AM, Noah Peart <noah.v.peart@gmail.com> wrote:
> 
> I've attached a patch with font-locking tests for the recent additions
> in (bug#70464) and (bug#70465).  So, it will fail without those being
> merged.
> 
> Thanks!

This is great! Thanks a ton!! I’ve applied both patches, and they work brilliantly, thanks to you both, Noah and Vladimir!

Yuan






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

end of thread, other threads:[~2024-04-22  5:00 UTC | newest]

Thread overview: 6+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-04-19  1:42 bug#70464: [PATCH] Add font-locking for Rust macro variables Noah Peart
2024-04-19  7:41 ` Yuan Fu
2024-04-19  8:02   ` Vladimir Kazanov
2024-04-19 16:44     ` Noah Peart
2024-04-19 17:38       ` Noah Peart
2024-04-22  5:00         ` Yuan Fu

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).