From d36a86b28609f1d060cf282bcdf75bdbef46b909 Mon Sep 17 00:00:00 2001 From: Theodor Thornhill Date: Sun, 13 Nov 2022 21:37:01 +0100 Subject: [PATCH] Fix some inconsistencies in *-ts-modes * lisp/progmodes/c-ts-mode.el (c-ts-mode-comment-style): New defcustom. (c-ts-mode-font-lock-feature-list): New defcustom. (c-ts-mode--base-mode): Extract comment-* so that we can separate between C and C++. Use the new font-lock-feature-list defcustom. (c-ts-mode, c++-ts-mode): Set comment-* variables. * lisp/progmodes/css-ts-mode.el (css-ts-mode): Add electric-indent. * lisp/progmodes/java-ts-mode.el (java-ts-mode-font-lock-feature-list): New defcustom. (java-ts-mode--imenu): Add categories. Only display categories that exist in the file. (java-ts-mode): Add electric-indent and use the font-lock-feature-list defcustom. * lisp/progmodes/json-ts-mode.el (json-ts-mode-font-lock-feature-list): New defcustom. (json-ts-mode--font-lock-settings): Make much more granular font lock features. (json-ts-mode): Add electric-indent and use the font-lock-feature-list defcustom. * lisp/progmodes/ts-mode.el (ts-mode-font-lock-feature-list): New defcustom. (ts-mode--font-lock-settings): Whitespace cleanup. (ts-mode): Add electric-indent and use the font-lock-feature-list defcustom. --- lisp/progmodes/c-ts-mode.el | 47 +++++++++++++++++++------ lisp/progmodes/css-ts-mode.el | 5 +++ lisp/progmodes/java-ts-mode.el | 63 ++++++++++++++++++++++++++-------- lisp/progmodes/json-ts-mode.el | 51 +++++++++++++++++++-------- lisp/progmodes/ts-mode.el | 32 ++++++++++++++--- 5 files changed, 156 insertions(+), 42 deletions(-) diff --git a/lisp/progmodes/c-ts-mode.el b/lisp/progmodes/c-ts-mode.el index 5617ea7d7c..eacc167909 100644 --- a/lisp/progmodes/c-ts-mode.el +++ b/lisp/progmodes/c-ts-mode.el @@ -31,8 +31,30 @@ (require 'treesit) (require 'rx) +(defcustom c-ts-mode-comment-style 'multi-line + "The comment style as decided by `comment-styles'" + :version "29.1" + :type 'symbol + :safe 'symbolp + :group 'c) + +(defcustom c-ts-mode-font-lock-feature-list + '((comment preprocessor operator constant string literal keyword) + (type definition expression statement) + ()) + "Language constructs to font-lock. + +See `treesit-font-lock-feature-list' for description of how to +use this variable. Supported features are as defined in +`c-ts-mode--font-lock-settings'." + :version "29.1" + :type 'list + :safe 'listp + :group 'c) + (defcustom c-ts-mode-indent-offset 2 "Number of spaces for each indentation step in `c-ts-mode'." + :version "29.1" :type 'integer :safe 'integerp :group 'c) @@ -44,6 +66,7 @@ c-ts-mode-indent-style one of the supplied styles doesn't suffice a function could be set instead. This function is expected return a list that follows the form of `treesit-simple-indent-rules'." + :version "29.1" :type '(choice (symbol :tag "Gnu" 'gnu) (symbol :tag "K&R" 'k&r) (symbol :tag "Linux" 'linux) @@ -396,14 +419,8 @@ c-ts-mode--imenu ;;;###autoload (define-derived-mode c-ts-mode--base-mode prog-mode "C" "Major mode for editing C, powered by tree-sitter." - :group 'c :syntax-table c-ts-mode--syntax-table - ;; Comments. - (setq-local comment-start "// ") - (setq-local comment-start-skip "\\(?://+\\|/\\*+\\)\\s *") - (setq-local comment-end "") - ;; Navigation. (setq-local treesit-defun-type-regexp (rx (or "specifier" @@ -415,16 +432,14 @@ c-ts-mode--base-mode ;; Electric (setq-local electric-indent-chars - (append "{}():;," electric-indent-chars)) + (append "{}():;," electric-indent-chars)) ;; Imenu. (setq-local imenu-create-index-function #'c-ts-mode--imenu) (setq-local which-func-functions nil) (setq-local treesit-font-lock-feature-list - '((comment preprocessor operator constant string literal keyword) - (type definition expression statement) - (error)))) + c-ts-mode-font-lock-feature-list)) ;;;###autoload (define-derived-mode c-ts-mode c-ts-mode--base-mode "C" @@ -436,6 +451,12 @@ c-ts-mode (treesit-parser-create 'c) + ;; Comments. + (setq-local comment-start "/* ") + (setq-local comment-start-skip "\\(?://+\\|/\\*+\\)\\s *") + (setq-local comment-end " */") + (setq-local comment-style c-ts-mode-comment-style) + (setq-local treesit-simple-indent-rules (c-ts-mode--set-indent-style 'c)) @@ -452,6 +473,12 @@ c++-ts-mode (unless (treesit-ready-p nil 'cpp) (error "Tree-sitter for C++ isn't available")) + ;; Comments. + (setq-local comment-start "// ") + (setq-local comment-start-skip "\\(?://+\\|/\\*+\\)\\s *") + (setq-local comment-end "") + (setq-local comment-style c-ts-mode-comment-style) + (treesit-parser-create 'cpp) (setq-local treesit-simple-indent-rules diff --git a/lisp/progmodes/css-ts-mode.el b/lisp/progmodes/css-ts-mode.el index e22bf99c6c..d0f104eac3 100644 --- a/lisp/progmodes/css-ts-mode.el +++ b/lisp/progmodes/css-ts-mode.el @@ -34,6 +34,7 @@ (defcustom css-ts-mode-indent-offset 2 "Number of spaces for each indentation step in `ts-mode'." + :version "29.1" :type 'integer :safe 'integerp :group 'css) @@ -114,6 +115,10 @@ css-ts-mode ;; Indent. (setq-local treesit-simple-indent-rules css-ts-mode--indent-rules) + ;; Electric + (setq-local electric-indent-chars + (append "{}():;," electric-indent-chars)) + ;; Navigation. (setq-local treesit-defun-type-regexp "rule_set") ;; Font-lock. diff --git a/lisp/progmodes/java-ts-mode.el b/lisp/progmodes/java-ts-mode.el index 5ec7da9f5c..9977802f84 100644 --- a/lisp/progmodes/java-ts-mode.el +++ b/lisp/progmodes/java-ts-mode.el @@ -29,10 +29,24 @@ ;;; Code: (require 'treesit) -(require 'rx) + +(defcustom java-ts-mode-font-lock-feature-list + '((basic comment keyword constant string operator) + (type definition expression literal annotation) + ()) + "Language constructs to font-lock. + +See `treesit-font-lock-feature-list' for description of how to +use this variable. Supported features are as defined in +`java-ts-mode--font-lock-settings'." + :version "29.1" + :type 'list + :safe 'listp + :group 'java) (defcustom java-ts-mode-indent-offset 4 "Number of spaces for each indentation step in `java-ts-mode'." + :version "29.1" :type 'integer :safe 'integerp :group 'java) @@ -241,18 +255,38 @@ java-ts-mode--imenu-1 (defun java-ts-mode--imenu () "Return Imenu alist for the current buffer." (let* ((node (treesit-buffer-root-node)) - (tree (treesit-induce-sparse-tree - node (rx (or "class_declaration" - "interface_declaration" - "enum_declaration" - "record_declaration" - "method_declaration"))))) - (java-ts-mode--imenu-1 tree))) + (class-tree + `("Class" . ,(java-ts-mode--imenu-1 + (treesit-induce-sparse-tree + node "^class_declaration$")))) + (interface-tree + `("Interface" . ,(java-ts-mode--imenu-1 + (treesit-induce-sparse-tree + node "^interface_declaration$")))) + (enum-tree + `("Enum" . ,(java-ts-mode--imenu-1 + (treesit-induce-sparse-tree + node "^enum_declaration$")))) + (record-tree + `("Record" . ,(java-ts-mode--imenu-1 + (treesit-induce-sparse-tree + node "^record_declaration$")))) + (method-tree + `("Method" . ,(java-ts-mode--imenu-1 + (treesit-induce-sparse-tree + node "^method_declaration$"))))) + (cl-remove-if + #'null + `(,(when (cdr class-tree) class-tree) + ,(when (cdr interface-tree) interface-tree) + ,(when (cdr enum-tree) enum-tree) + ,(when (cdr record-tree) record-tree) + ,(when (cdr method-tree) method-tree))))) ;;;###autoload (define-derived-mode java-ts-mode prog-mode "Java" "Major mode for editing Java, powered by tree-sitter." - :group 'c + :group 'java :syntax-table java-ts-mode--syntax-table (unless (treesit-ready-p nil 'java) @@ -268,16 +302,17 @@ java-ts-mode ;; Indent. (setq-local treesit-simple-indent-rules java-ts-mode--indent-rules) + ;; Electric + (setq-local electric-indent-chars + (append "{}():;," electric-indent-chars)) + ;; Navigation. - (setq-local treesit-defun-type-regexp - (rx (or "declaration"))) + (setq-local treesit-defun-type-regexp "declaration") ;; Font-lock. (setq-local treesit-font-lock-settings java-ts-mode--font-lock-settings) (setq-local treesit-font-lock-feature-list - '((basic comment keyword constant string operator) - (type definition expression literal annotation) - ())) + java-ts-mode-font-lock-feature-list) ;; Imenu. (setq-local imenu-create-index-function #'java-ts-mode--imenu) diff --git a/lisp/progmodes/json-ts-mode.el b/lisp/progmodes/json-ts-mode.el index 686640f98a..f852cbcf58 100644 --- a/lisp/progmodes/json-ts-mode.el +++ b/lisp/progmodes/json-ts-mode.el @@ -31,8 +31,21 @@ (require 'treesit) (require 'rx) +(defcustom json-ts-mode-font-lock-feature-list + '((comment string number) (constant pair) ()) + "Language constructs to font-lock. + +See `treesit-font-lock-feature-list' for description of how to +use this variable. Supported features are as defined in +`json-ts-mode--font-lock-settings'." + :version "29.1" + :type 'list + :safe 'listp + :group 'json) + (defcustom json-ts-mode-indent-offset 2 "Number of spaces for each indentation step in `json-ts-mode'." + :version "29.1" :type 'integer :safe 'integerp :group 'json) @@ -67,20 +80,26 @@ json-ts--indent-rules (defvar json-ts-mode--font-lock-settings (treesit-font-lock-rules :language 'json - :feature 'minimal + :feature 'comment :override t - `((pair - key: (_) @font-lock-string-face) - - (string) @font-lock-string-face - - (number) @font-lock-constant-face - - [(null) (true) (false)] @font-lock-constant-face - - (escape_sequence) @font-lock-constant-face - - (comment) @font-lock-comment-face)) + '((comment) @font-lock-comment-face) + :language 'json + :feature 'string + :override t + '((escape_sequence) @font-lock-constant-face + (string) @font-lock-string-face) + :language 'json + :feature 'number + :override t + '((number) @font-lock-constant-face) + :language 'json + :feature 'constant + :override t + '([(null) (true) (false)] @font-lock-constant-face) + :language 'json + :feature 'pair + :override t + `((pair key: (_) @font-lock-variable-name-face))) "Font-lock settings for JSON.") (defun json-ts-mode--imenu-1 (node) @@ -127,6 +146,10 @@ json-ts-mode (setq-local comment-start-skip "\\(?://+\\|/\\*+\\)\\s *") (setq-local comment-end "") + ;; Electric + (setq-local electric-indent-chars + (append "{}():;," electric-indent-chars)) + ;; Indent. (setq-local treesit-simple-indent-rules json-ts--indent-rules) @@ -137,7 +160,7 @@ json-ts-mode ;; Font-lock. (setq-local treesit-font-lock-settings json-ts-mode--font-lock-settings) (setq-local treesit-font-lock-feature-list - '((minimal) () ())) + json-ts-mode-font-lock-feature-list) ;; Imenu. (setq-local imenu-create-index-function #'json-ts-mode--imenu) diff --git a/lisp/progmodes/ts-mode.el b/lisp/progmodes/ts-mode.el index f4dfa2ae95..4f6a3f970b 100644 --- a/lisp/progmodes/ts-mode.el +++ b/lisp/progmodes/ts-mode.el @@ -28,8 +28,23 @@ (require 'rx) (require 'js) +(defcustom ts-mode-font-lock-feature-list + '((comment declaration) + (string keyword identifier expression constant) + (property pattern jsx)) + "Language constructs to font-lock. + +See `treesit-font-lock-feature-list' for description of how to +use this variable. Supported features are as defined in +`ts-mode--font-lock-settings'." + :version "29.1" + :type 'list + :safe 'listp + :group 'typescript) + (defcustom ts-mode-indent-offset 2 "Number of spaces for each indentation step in `ts-mode'." + :version "29.1" :type 'integer :safe 'integerp :group 'typescript) @@ -100,7 +115,6 @@ ts-mode--keywords (defvar ts-mode--font-lock-settings (treesit-font-lock-rules - :language 'tsx :override t :feature 'comment @@ -271,29 +285,39 @@ ts-mode ((treesit-ready-p nil 'tsx) ;; Tree-sitter. (treesit-parser-create 'tsx) + ;; Comments. (setq-local comment-start "// ") (setq-local comment-start-skip "\\(?://+\\|/\\*+\\)\\s *") (setq-local comment-end "") + + ;; Electric + (setq-local electric-indent-chars + (append "{}():;," electric-indent-chars)) + ;; Indent. (setq-local treesit-simple-indent-rules ts-mode--indent-rules) + ;; Navigation. (setq-local treesit-defun-type-regexp (rx (or "class_declaration" "method_definition" "function_declaration" "lexical_declaration"))) + ;; Font-lock. (setq-local treesit-font-lock-settings ts-mode--font-lock-settings) (setq-local treesit-font-lock-feature-list - '((comment declaration) - (string keyword identifier expression constant) - (property pattern jsx))) + ts-mode-font-lock-feature-list) + ;; Imenu. (setq-local imenu-create-index-function #'js--treesit-imenu) + ;; Which-func (use imenu). (setq-local which-func-functions nil) + (treesit-major-mode-setup)) + ;; Elisp. (t (js-mode) -- 2.34.1