summaryrefslogtreecommitdiff
path: root/rust-mode.el
blob: ec1ecba4d4d2e37f556bf22902d8c6e3767ce611 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
;;; rust-mode.el --- A major-mode for editing Rust source code -*-lexical-binding: t-*-

;; Version: 1.0.5
;; Author: Mozilla
;; Url: https://github.com/rust-lang/rust-mode
;; Keywords: languages
;; Package-Requires: ((emacs "25.1"))

;; This file is distributed under the terms of both the MIT license and the
;; Apache License (version 2.0).

;;; Commentary:

;; This package implements a major-mode for editing Rust source code.

;;; Code:
(require 'rust-common)

(eval-when-compile
  (require 'rx)
  (require 'subr-x))

(defvar rust-load-optional-libraries t
  "Whether loading `rust-mode' also loads optional libraries.
This variable might soon be remove again.")

(when rust-load-optional-libraries
  (require 'rust-cargo)
  (require 'rust-compile)
  (require 'rust-playpen)
  (require 'rust-rustfmt))

;;; Customization

(defgroup rust-mode nil
  "Support for Rust code."
  :link '(url-link "https://www.rust-lang.org/")
  :group 'languages)

(defcustom rust-mode-treesitter-derive nil
  "Whether rust-mode should derive from the new treesitter mode `rust-ts-mode'
instead of `prog-mode'. This option requires emacs29+."
  :version "29.1"
  :type 'boolean
  :group 'rustic)

;;; Faces

(define-obsolete-face-alias 'rust-unsafe-face
  'rust-unsafe "0.6.0")
(define-obsolete-face-alias 'rust-question-mark-face
  'rust-question-mark "0.6.0")
(define-obsolete-face-alias 'rust-builtin-formatting-macro-face
  'rust-builtin-formatting-macro "0.6.0")
(define-obsolete-face-alias 'rust-string-interpolation-face
  'rust-string-interpolation "0.6.0")

;;; Mode

(defvar rust-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map (kbd "C-c C-d") #'rust-dbg-wrap-or-unwrap)
    (when rust-load-optional-libraries
      (define-key map (kbd "C-c C-c C-u") 'rust-compile)
      (define-key map (kbd "C-c C-c C-k") 'rust-check)
      (define-key map (kbd "C-c C-c C-t") 'rust-test)
      (define-key map (kbd "C-c C-c C-r") 'rust-run)
      (define-key map (kbd "C-c C-c C-l") 'rust-run-clippy)
      (define-key map (kbd "C-c C-f") 'rust-format-buffer)
      (define-key map (kbd "C-c C-n") 'rust-goto-format-problem))
    map)
  "Keymap for Rust major mode.")

(if (and (version<= "29.1" emacs-version) rust-mode-treesitter-derive)
    (require 'rust-mode-treesitter)
  (require 'rust-prog-mode))

;;;###autoload
(autoload 'rust-mode "rust-mode" "Major mode for Rust code.")

;;;###autoload
(add-to-list 'auto-mode-alist '("\\.rs\\'" . rust-mode))

(provide 'rust-mode)
(require 'rust-utils)

;;; rust-mode.el ends here