From 5edf9bd675b35f97cc0245036ae6ceeb91de1c52 Mon Sep 17 00:00:00 2001 From: Theodor Thornhill Date: Thu, 8 Dec 2022 20:06:09 +0100 Subject: [PATCH] Add treesit-text-type-regexp Sometimes it is good to easily differentiate between textual nodes and normal code. One such case is for a filling and reindenting command, where we fill the textual node if point is on one, and reindent code otherwise. This is a part of bug#59662. * lisp/treesit.el: New variable. * lisp/progmodes/c-ts-mode.el (c-ts-mode--font-lock-settings): Add raw_string_literal for C++. (c-ts-mode, c++-ts-mode): Add regexp for the new variable. * lisp/progmodes/csharp-mode.el: Add regexp for the new variable. * lisp/progmodes/java-ts-mode.el (java-ts-mode--indent-rules): Add text_block as no-indent. (java-ts-mode--font-lock-settings): Add text_block font-lock-rule. (java-ts-mode): Add regexp for the new variable. * lisp/progmodes/js.el (js-ts-mode): Add regexp for the new variable. * lisp/progmodes/json-ts-mode.el (json-ts-mode--font-lock-settings): Add comment font-lock-rule. (json-ts-mode): Add regexp for the new variable, and use the new comment feature. * lisp/progmodes/python.el (python-ts-mode): Add regexp for the new variable. * lisp/progmodes/sh-script.el (bash-ts-mode): Add regexp for the new variable. * lisp/progmodes/typescript-ts-mode.el (typescript-ts-base-mode): Add regexp for the new variable. * lisp/textmodes/css-mode.el (css-ts-mode): Add regexp for the new variable. --- lisp/progmodes/c-ts-mode.el | 12 +++++++++++- lisp/progmodes/csharp-mode.el | 5 +++++ lisp/progmodes/java-ts-mode.el | 9 ++++++++- lisp/progmodes/js.el | 5 +++++ lisp/progmodes/json-ts-mode.el | 8 +++++++- lisp/progmodes/python.el | 2 ++ lisp/progmodes/sh-script.el | 4 ++++ lisp/progmodes/typescript-ts-mode.el | 4 ++++ lisp/textmodes/css-mode.el | 2 ++ lisp/treesit.el | 8 ++++++++ 10 files changed, 56 insertions(+), 3 deletions(-) diff --git a/lisp/progmodes/c-ts-mode.el b/lisp/progmodes/c-ts-mode.el index 0b17541a0a..10aec36c2f 100644 --- a/lisp/progmodes/c-ts-mode.el +++ b/lisp/progmodes/c-ts-mode.el @@ -252,7 +252,9 @@ c-ts-mode--font-lock-settings :language mode :feature 'string `((string_literal) @font-lock-string-face - (system_lib_string) @font-lock-string-face) + (system_lib_string) @font-lock-string-face + ,@(when (eq mode 'cpp) + '((raw_string_literal) @font-lock-string-face))) :language mode :feature 'literal @@ -592,6 +594,10 @@ c-ts-mode (setq-local comment-start-skip (rx (or (seq "/" (+ "/")) (seq "/" (+ "*"))) (* (syntax whitespace)))) + + (setq-local treesit-text-type-regexp + (regexp-opt '("comment"))) + (setq-local comment-end-skip (rx (* (syntax whitespace)) (group (or (syntax comment-end) @@ -628,6 +634,10 @@ c++-ts-mode (group (or (syntax comment-end) (seq (+ "*") "/"))))) + (setq-local treesit-text-type-regexp + (regexp-opt '("comment" + "raw_string_literal"))) + (treesit-parser-create 'cpp) (setq-local treesit-simple-indent-rules diff --git a/lisp/progmodes/csharp-mode.el b/lisp/progmodes/csharp-mode.el index 82e3bc0d54..f83ab16caa 100644 --- a/lisp/progmodes/csharp-mode.el +++ b/lisp/progmodes/csharp-mode.el @@ -912,6 +912,11 @@ csharp-ts-mode (group (or (syntax comment-end) (seq (+ "*") "/"))))) + (setq-local treesit-text-type-regexp + (regexp-opt '("comment" + "verbatim_string-literal" + "interpolated_verbatim_string-text"))) + ;; Indent. (setq-local treesit-simple-indent-rules csharp-ts-mode--indent-rules) diff --git a/lisp/progmodes/java-ts-mode.el b/lisp/progmodes/java-ts-mode.el index bda4ac86c8..30c920be7f 100644 --- a/lisp/progmodes/java-ts-mode.el +++ b/lisp/progmodes/java-ts-mode.el @@ -73,6 +73,7 @@ java-ts-mode--indent-rules ((node-is "]") parent-bol 0) ((and (parent-is "comment") comment-end) comment-start -1) ((parent-is "comment") comment-start-skip 0) + ((parent-is "text_block") no-indent) ((parent-is "class_body") parent-bol java-ts-mode-indent-offset) ((parent-is "interface_body") parent-bol java-ts-mode-indent-offset) ((parent-is "constructor_body") parent-bol java-ts-mode-indent-offset) @@ -162,7 +163,8 @@ java-ts-mode--font-lock-settings :language 'java :override t :feature 'string - `((string_literal) @font-lock-string-face) + `((string_literal) @font-lock-string-face + (text_block) @font-lock-string-face) :language 'java :override t :feature 'literal @@ -313,6 +315,11 @@ java-ts-mode (group (or (syntax comment-end) (seq (+ "*") "/"))))) + (setq-local treesit-text-type-regexp + (regexp-opt '("line_comment" + "block_comment" + "text_block"))) + ;; Indent. (setq-local treesit-simple-indent-rules java-ts-mode--indent-rules) diff --git a/lisp/progmodes/js.el b/lisp/progmodes/js.el index 45dfef372c..d0b243a22f 100644 --- a/lisp/progmodes/js.el +++ b/lisp/progmodes/js.el @@ -3857,6 +3857,11 @@ js-ts-mode (group (or (syntax comment-end) (seq (+ "*") "/"))))) (setq-local comment-multi-line t) + + (setq-local treesit-text-type-regexp + (regexp-opt '("comment" + "template_string"))) + ;; Electric-indent. (setq-local electric-indent-chars (append "{}():;," electric-indent-chars)) ;FIXME: js2-mode adds "[]*". diff --git a/lisp/progmodes/json-ts-mode.el b/lisp/progmodes/json-ts-mode.el index f3bd93923e..d655821ec9 100644 --- a/lisp/progmodes/json-ts-mode.el +++ b/lisp/progmodes/json-ts-mode.el @@ -75,6 +75,9 @@ json-ts--indent-rules (defvar json-ts-mode--font-lock-settings (treesit-font-lock-rules + :language 'json + :feature 'comment + '((comment) @font-lock-comment-face) :language 'json :feature 'bracket '((["[" "]" "{" "}"]) @font-lock-bracket-face) @@ -159,10 +162,13 @@ json-ts-mode (setq-local treesit-defun-type-regexp (rx (or "pair" "object"))) + (setq-local treesit-text-type-regexp + (regexp-opt '("comment"))) + ;; Font-lock. (setq-local treesit-font-lock-settings json-ts-mode--font-lock-settings) (setq-local treesit-font-lock-feature-list - '((constant number pair string) + '((comment constant number pair string) (escape-sequence) (bracket delimiter error))) diff --git a/lisp/progmodes/python.el b/lisp/progmodes/python.el index ebee703499..f678e10fdf 100644 --- a/lisp/progmodes/python.el +++ b/lisp/progmodes/python.el @@ -6631,6 +6631,8 @@ python-ts-mode #'python-imenu-treesit-create-index) (setq-local treesit-defun-type-regexp (rx (or "function" "class") "_definition")) + (setq-local treesit-text-type-regexp + (regexp-opt '("comment"))) (treesit-major-mode-setup) (when python-indent-guess-indent-offset diff --git a/lisp/progmodes/sh-script.el b/lisp/progmodes/sh-script.el index e170d18afe..1605e40347 100644 --- a/lisp/progmodes/sh-script.el +++ b/lisp/progmodes/sh-script.el @@ -1619,6 +1619,10 @@ bash-ts-mode ( bracket delimiter misc-punctuation operator))) (setq-local treesit-font-lock-settings sh-mode--treesit-settings) + (setq-local treesit-text-type-regexp + (regexp-opt '("comment" + "heredoc_start" + "heredoc_body"))) (treesit-major-mode-setup))) (advice-add 'bash-ts-mode :around #'sh--redirect-bash-ts-mode diff --git a/lisp/progmodes/typescript-ts-mode.el b/lisp/progmodes/typescript-ts-mode.el index a56568ae78..e502c6d249 100644 --- a/lisp/progmodes/typescript-ts-mode.el +++ b/lisp/progmodes/typescript-ts-mode.el @@ -329,6 +329,10 @@ typescript-ts-base-mode (group (or (syntax comment-end) (seq (+ "*") "/"))))) + (setq-local treesit-text-type-regexp + (regexp-opt '("comment" + "template_string"))) + ;; Electric (setq-local electric-indent-chars (append "{}():;," electric-indent-chars)) diff --git a/lisp/textmodes/css-mode.el b/lisp/textmodes/css-mode.el index 822097a86d..eb4fbc887c 100644 --- a/lisp/textmodes/css-mode.el +++ b/lisp/textmodes/css-mode.el @@ -1835,6 +1835,8 @@ css-ts-mode (treesit-parser-create 'css) (setq-local treesit-simple-indent-rules css--treesit-indent-rules) (setq-local treesit-defun-type-regexp "rule_set") + (setq-local treesit-text-type-regexp + (regexp-opt '("comment"))) (setq-local treesit-font-lock-settings css--treesit-settings) (setq-local treesit-font-lock-feature-list '((selector comment query keyword) diff --git a/lisp/treesit.el b/lisp/treesit.el index 85154d0d1c..cc94b460c7 100644 --- a/lisp/treesit.el +++ b/lisp/treesit.el @@ -1639,6 +1639,14 @@ treesit-end-of-defun (when top (goto-char (treesit-node-end top))))) +(defvar-local treesit-text-type-regexp nil + "A regexp that matches the node type of textual nodes. + +A textual is a node that is not normal code, such as comments and +multiline string literals. For example, \"(line|block)_comment\" +in the case of a comment, or \"verbatim_string_literal\" in the +case of a string.") + ;;; Activating tree-sitter (defun treesit-ready-p (language &optional quiet) -- 2.34.1