Function: c-ts-mode

c-ts-mode is an autoloaded, interactive and byte-compiled function defined in c-ts-mode.el.gz.

Signature

(c-ts-mode)

Documentation

Major mode for editing C, powered by tree-sitter.

This mode is independent from the classic cc-mode.el based c-mode, so configuration variables of that mode, like c-basic-offset, don't affect this mode.

To use tree-sitter C/C++ modes by default, evaluate

    (add-to-list 'major-mode-remap-alist '(c-mode . c-ts-mode))
    (add-to-list 'major-mode-remap-alist '(c++-mode . c++-ts-mode))
    (add-to-list 'major-mode-remap-alist
                 '(c-or-c++-mode . c-or-c++-ts-mode))

in your init files.

In addition to any hooks its parent mode c-ts-base-mode might have run, this mode runs the hook c-ts-mode-hook, as the final or penultimate step during initialization.

Probably introduced at or before Emacs version 29.1.

Key Bindings

Source Code

;; Defined in /usr/src/emacs/lisp/progmodes/c-ts-mode.el.gz
;;;###autoload
(define-derived-mode c-ts-mode c-ts-base-mode "C"
  "Major mode for editing C, powered by tree-sitter.

This mode is independent from the classic cc-mode.el based
`c-mode', so configuration variables of that mode, like
`c-basic-offset', don't affect this mode.

To use tree-sitter C/C++ modes by default, evaluate

    (add-to-list \\='major-mode-remap-alist \\='(c-mode . c-ts-mode))
    (add-to-list \\='major-mode-remap-alist \\='(c++-mode . c++-ts-mode))
    (add-to-list \\='major-mode-remap-alist
                 \\='(c-or-c++-mode . c-or-c++-ts-mode))

in your init files."
  :group 'c
  :after-hook (c-ts-mode-set-modeline)

  (when (treesit-ready-p 'c)
    ;; Create an "for-each" parser, see `c-ts-mode--emacs-set-ranges'
    ;; for more.
    (when c-ts-mode-emacs-sources-support
      (setq-local treesit-primary-parser
                  (treesit-parser-create 'c nil nil 'for-each)))

    (treesit-parser-create 'c)
    ;; Comments.
    (setq-local comment-start "/* ")
    (setq-local comment-end " */")
    ;; Indent.
    (setq-local treesit-simple-indent-rules
                (c-ts-mode--get-indent-style 'c))
    ;; Font-lock.
    (setq-local treesit-font-lock-settings (c-ts-mode--font-lock-settings 'c))
    ;; Navigation.
    ;;
    ;; Nodes like struct/enum/union_specifier can appear in
    ;; function_definitions, so we need to find the top-level node.
    (setq-local treesit-defun-tactic 'top-level)
    (treesit-major-mode-setup)

    ;; Emacs source support: handle DEFUN and FOR_EACH_* gracefully.
    (when c-ts-mode-emacs-sources-support
      (setq-local add-log-current-defun-function
                  #'c-ts-mode--emacs-current-defun-name)

      (setq-local treesit-range-settings
                  (treesit-range-rules 'c-ts-mode--emacs-set-ranges))

      (setq-local treesit-language-at-point-function
                  (lambda (_pos) 'c))
      (treesit-font-lock-recompute-features '(emacs-devel)))))