-
-
Notifications
You must be signed in to change notification settings - Fork 36
/
gdscript-mode.el
232 lines (194 loc) · 10.4 KB
/
gdscript-mode.el
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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
;;; gdscript-mode.el --- Major mode for Godot's GDScript language -*- lexical-binding: t; -*-
;; Copyright (C) 2020 GDQuest
;; Author: Nathan Lovato <[email protected]>, Fabián E. Gallina <[email protected]>
;; URL: https://github.com/godotengine/emacs-gdscript-mode/
;; Version: 0.1.0
;; Package-Requires: ((emacs "26.3"))
;; Maintainer: [email protected]
;; Created: Jan 2020
;; Keywords: languages
;; This program 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.
;; This program 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 this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Adds support for the GDScript programming language from the Godot game
;; engine. This is a domain-specific language dedicated to game programming.
;;; Code:
(require 'gdscript-customization)
(require 'gdscript-docs)
(require 'gdscript-syntax)
(require 'gdscript-indent-and-nav)
(require 'gdscript-imenu)
(require 'gdscript-fill-paragraph)
(require 'gdscript-completion)
(require 'gdscript-format)
(require 'gdscript-rx)
(require 'gdscript-godot)
(require 'gdscript-hydra)
(require 'gdscript-debug)
(require 'gdscript-eglot)
(when (version< "29" emacs-version)
(require 'gdscript-ts-mode))
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.gd\\'" . gdscript-mode))
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.tscn\\'" . conf-toml-mode))
;;;###autoload
(add-to-list 'auto-mode-alist '("\\.tres\\'" . conf-toml-mode))
;;;###autoload
(with-eval-after-load 'eglot
(defvar eglot-server-programs)
(unless (equal (alist-get 'gdscript-mode eglot-server-programs)
#'gdscript-eglot-contact)
(push (cons 'gdscript-mode #'gdscript-eglot-contact)
eglot-server-programs)))
(defvar gdscript-mode-map (let ((map (make-sparse-keymap)))
;; Movement
(define-key map [remap backward-sentence] 'gdscript-nav-backward-block)
(define-key map [remap forward-sentence] 'gdscript-nav-forward-block)
(define-key map [remap backward-up-list] 'gdscript-nav-backward-up-list)
(define-key map [remap mark-defun] 'gdscript-mark-defun)
(define-key map (kbd "C-c C-j") 'imenu)
;; Indent specific
(define-key map "\177" 'gdscript-indent-dedent-line-backspace)
(define-key map (kbd "<backtab>") 'gdscript-indent-dedent-line)
(define-key map (kbd "\t") 'company-complete)
;; Insertion.
(define-key map (kbd "C-c i") 'gdscript-completion-insert-file-path-at-point)
;; Formatting.
(define-key map (kbd "C-c C-f r") 'gdscript-format-region)
(define-key map (kbd "C-c C-f b") 'gdscript-format-buffer)
;; Run in Godot.
(define-key map (kbd "C-c C-r p") 'gdscript-godot-open-project-in-editor)
(define-key map (kbd "C-c C-r r") 'gdscript-godot-run-project)
(define-key map (kbd "<f5>") 'gdscript-godot-run-project)
(define-key map (kbd "C-c C-r d") 'gdscript-godot-run-project-debug)
(define-key map (kbd "C-c C-r s") 'gdscript-godot-run-current-scene)
(define-key map (kbd "<f6>") 'gdscript-godot-run-current-scene)
(define-key map (kbd "C-c C-r q") 'gdscript-godot-run-current-scene-debug)
(define-key map (kbd "C-c C-r e") 'gdscript-godot-edit-current-scene)
(define-key map (kbd "C-c C-r x") 'gdscript-godot-run-current-script)
;; Docs.
(define-key map (kbd "C-c C-b a") 'gdscript-docs-browse-api)
(define-key map (kbd "C-c C-b o") 'gdscript-docs-browse-symbol-at-point)
(define-key map (kbd "C-c C-b s") 'gdscript-docs-online-search-api)
;; Hydra
(define-key map (kbd "C-c r") 'gdscript-hydra-show)
;; Debugger
(define-key map (kbd "C-c C-d C-d s") 'gdscript-debug-display-stack-frame-vars-buffer)
(define-key map (kbd "C-c C-d C-d d") 'gdscript-debug-display-stack-dump-buffer)
(define-key map (kbd "C-c C-d C-d b") 'gdscript-debug-display-breakpoint-buffer)
(define-key map (kbd "C-c C-d C-d i") 'gdscript-debug-display-inspector-buffer)
(define-key map (kbd "<f9>") 'gdscript-debug-toggle-breakpoint)
(define-key map (kbd "C-c C-d q") 'gdscript-debug-make-server)
(define-key map (kbd "C-c C-d n") 'gdscript-debug-next)
(define-key map (kbd "C-c C-d c") 'gdscript-debug-continue)
(define-key map (kbd "<f7>") 'gdscript-debug-continue)
(define-key map (kbd "C-c C-d s") 'gdscript-debug-step)
;; Debugger Hydra
(define-key map (kbd "C-c n") 'gdscript-debug-hydra)
map)
"Keymap for `gdscript-mode'.")
(defun gdscript-hideshow-forward-sexp-function (_arg)
"Gdscript specific `forward-sexp' function for function `hs-minor-mode'.
Argument ARG is ignored."
(gdscript-nav-end-of-defun)
(unless (gdscript-info-current-line-empty-p)
(backward-char)))
(defun gdscript-electric-pair-string-delimiter ()
"GDScript-specific string delimiter detection for 'electric-pair-mode'.
Return a doubled string character for 'electric-pair-mode', if
the last command event was a string delimiter."
(when (and electric-pair-mode
(memq last-command-event
'(?\" ?\') )
(let ((count 0))
(while (eq (char-before (- (point)
count)) last-command-event)
(cl-incf count))
(= count 3))
(eq (char-after) last-command-event))
(save-excursion
(insert (make-string 2 last-command-event)))))
(defun gdscript-mark-defun ()
"GDScript-specific version of `mark-defun'.
Put mark at end of this defun, point at beginning.
The defun marked is the one that contains point or follows point.
If the mark is active, it marks the next defun after the one
already marked."
(interactive)
(if (use-region-p)
(gdscript-nav-forward-defun)
(save-excursion
(gdscript-nav-backward-defun)
(set-mark (point))))
(gdscript-nav-end-of-defun))
;;;###autoload
(define-derived-mode gdscript-mode prog-mode "gdscript"
"Major mode for editing Godot GDScript files."
(setq-local tab-width gdscript-tab-width)
(setq-local indent-tabs-mode gdscript-use-tab-indents)
(set-syntax-table gdscript-mode-syntax-table)
(modify-syntax-entry ?\# "\<" gdscript-mode-syntax-table)
(modify-syntax-entry ?\n ">" gdscript-mode-syntax-table)
(setq-local comment-start "# ")
(setq-local comment-start-skip "#+\\s-*")
(setq-local comment-end "")
(setq-local parse-sexp-lookup-properties t)
(setq-local parse-sexp-ignore-comments t)
(setq-local forward-sexp-function
'gdscript-nav-forward-sexp)
(setq-local font-lock-defaults
'(gdscript-font-lock))
(setq-local syntax-propertize-function
gdscript-syntax-propertize-function)
(setq-local indent-line-function
#'gdscript-indent-line-function)
(setq-local indent-region-function #'gdscript-indent-region)
;; because indentation is not redundant, we cannot safely reindent code.
(setq-local electric-indent-inhibit t)
(setq-local electric-indent-chars
(cons ?: electric-indent-chars))
;; add """ ... """ pairing to electric-pair-mode.
(add-hook 'post-self-insert-hook
#'gdscript-electric-pair-string-delimiter 'append t)
(setq-local paragraph-start "\\s-*$")
(setq-local fill-paragraph-function
#'gdscript-fill-paragraph)
(setq-local normal-auto-fill-function #'gdscript-fill-paragraph-do-auto-fill)
(setq-local beginning-of-defun-function
#'gdscript-nav-beginning-of-defun)
(setq-local end-of-defun-function
#'gdscript-nav-end-of-defun)
(add-hook 'completion-at-point-functions
#'gdscript-completion-at-point nil 'local)
(add-hook 'post-self-insert-hook
#'gdscript-indent-post-self-insert-function 'append 'local)
(setq-local imenu-create-index-function
#'gdscript-imenu-create-index)
(setq-local add-log-current-defun-function
#'gdscript-info-current-defun)
(add-hook 'which-func-functions #'gdscript-info-current-defun nil t)
(setq-local hs-special-modes-alist ''(gdscript-mode
"\\s-*\\_<\\(?:func\\|class\\)\\_>"
;; use the empty string as end regexp so it doesn't default to
;; "\\s)". this way parens at end of defun are properly hidden.
""
"#"
gdscript-hideshow-forward-sexp-function
nil))
(setq-local outline-regexp
(gdscript-rx (* space) block-start))
(setq-local outline-level
#'(lambda ()
"`outline-level' function for gdscript mode."
(1+ (/ (current-indentation) gdscript-indent-offset)))))
(provide 'gdscript-mode)
;;; gdscript-mode.el ends here