-
Notifications
You must be signed in to change notification settings - Fork 1
/
gpr-ts-mode.el
1398 lines (1253 loc) · 56.3 KB
/
gpr-ts-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
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
;;; gpr-ts-mode.el --- Major mode for GNAT project files using Tree-Sitter -*- lexical-binding: t; -*-
;; Copyright (C) 2023-2024 Troy Brown
;; Author: Troy Brown <[email protected]>
;; Created: February 2023
;; Version: 0.6.7
;; Keywords: gpr gnat ada languages tree-sitter
;; URL: https://github.com/brownts/gpr-ts-mode
;; Package-Requires: ((emacs "29.1"))
;; This file is not part of GNU Emacs.
;; 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 <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This package provides GNAT Project syntax highlighting, indentation
;; and navigation using Tree-Sitter. To use the `gpr-ts-mode' major
;; mode you will need the appropriate grammar installed. By default,
;; on mode startup if the grammar is not detected, you will be
;; prompted to automatically install it.
;;; Code:
(require 'cl-generic)
(require 'lisp-mnt)
(require 'treesit)
(eval-when-compile (require 'rx))
(declare-function treesit-available-p "treesit.c")
(declare-function treesit-induce-sparse-tree "treesit.c")
(declare-function treesit-language-available-p "treesit.c")
(declare-function treesit-parser-create "treesit.c")
(declare-function treesit-node-check "treesit.c")
(declare-function treesit-node-child-by-field-name "treesit.c")
(declare-function treesit-node-child-count "treesit.c")
(declare-function treesit-node-end "treesit.c")
(declare-function treesit-node-eq "treesit.c")
(declare-function treesit-node-next-sibling "treesit.c")
(declare-function treesit-node-parent "treesit.c")
(declare-function treesit-node-prev-sibling "treesit.c")
(declare-function treesit-node-start "treesit.c")
(declare-function treesit-node-type "treesit.c")
(defgroup gpr-ts nil
"Major mode for GNAT Project files, using Tree-Sitter."
:group 'languages
:link '(emacs-library-link :tag "Source" "gpr-ts-mode.el")
:link `(url-link :tag "Website"
,(lm-website (locate-library "gpr-ts-mode.el")))
:link '(custom-manual "(gpr-ts-mode)Top")
:prefix "gpr-ts-mode-")
(defcustom gpr-ts-mode-imenu-categories
'(attribute package type variable with-clause)
"Configuration of Imenu categories."
:type '(repeat :tag "Categories"
(choice :tag "Category"
(const :tag "Attribute Declaration" attribute)
(const :tag "Package Declaration" package)
(const :tag "Project Declaration" project)
(const :tag "Type Declaration" type)
(const :tag "Typed Variable Declaration" typed-variable)
(const :tag "Untyped Variable Declaration" untyped-variable)
(const :tag "Typed and Untyped Variable Declaration" variable)
(const :tag "With Clause" with-clause)))
:group 'gpr-ts
:link '(custom-manual :tag "Imenu" "(gpr-ts-mode)Imenu")
:package-version "0.6.0")
(defcustom gpr-ts-mode-imenu-category-name-alist
'((attribute . "Attribute")
(package . "Package")
(project . "Project")
(type . "Type")
(typed-variable . "Typed Variable")
(untyped-variable . "Untyped Variable")
(variable . "Variable")
(with-clause . "With Clause"))
"Configuration of Imenu category names."
:type '(alist :key-type (symbol :tag "Category")
:value-type (string :tag "Category Name"))
:group 'gpr-ts
:link '(custom-manual :tag "Imenu" "(gpr-ts-mode)Imenu")
:package-version "0.6.0")
(defcustom gpr-ts-mode-indent-offset 3
"Indentation of statements."
:type 'integer
:group 'gpr-ts
:link '(custom-manual :tag "Indentation" "(gpr-ts-mode)Indentation")
:package-version "0.5.0")
;;;###autoload(put 'gpr-ts-mode-indent-offset 'safe-local-variable #'integerp)
(defcustom gpr-ts-mode-indent-when-offset gpr-ts-mode-indent-offset
"Indentation of `when' relative to `case'."
:type 'integer
:group 'gpr-ts
:link '(custom-manual :tag "Indentation" "(gpr-ts-mode)Indentation")
:package-version "0.5.0")
;;;###autoload(put 'gpr-ts-mode-indent-when-offset 'safe-local-variable #'integerp)
(defcustom gpr-ts-mode-indent-broken-offset (- gpr-ts-mode-indent-offset 1)
"Indentation for the continuation of a broken line."
:type 'integer
:group 'gpr-ts
:link '(custom-manual :tag "Indentation" "(gpr-ts-mode)Indentation")
:package-version "0.5.0")
;;;###autoload(put 'gpr-ts-mode-indent-broken-offset 'safe-local-variable #'integerp)
(defcustom gpr-ts-mode-indent-exp-item-offset (- gpr-ts-mode-indent-offset 1)
"Indentation for the continuation of an expression."
:type 'integer
:group 'gpr-ts
:link '(custom-manual :tag "Indentation" "(gpr-ts-mode)Indentation")
:package-version "0.5.0")
;;;###autoload(put 'gpr-ts-mode-indent-exp-item-offset 'safe-local-variable #'integerp)
(defcustom gpr-ts-mode-indent-strategy 'declaration
"Indentation strategy to utilize."
:type '(choice :tag "Indentation Strategy"
(const :tag "Declaration" declaration)
(const :tag "Line" line))
:group 'gpr-ts
:link '(custom-manual :tag "Indentation" "(gpr-ts-mode)Indentation")
:package-version "0.6.0")
(defcustom gpr-ts-mode-grammar "https://github.com/brownts/tree-sitter-gpr"
"Configuration for downloading and installing the tree-sitter language grammar.
Additional settings beyond the git repository can also be
specified. See `treesit-language-source-alist' for full details."
:type '(choice (string :tag "Git Repository")
(list :tag "All Options"
(string :tag "Git Repository")
(choice :tag "Revision" (const :tag "Default" nil) string)
(choice :tag "Source Directory" (const :tag "Default" nil) string)
(choice :tag "C Compiler" (const :tag "Default" nil) string)
(choice :tag "C++ Compiler" (const :tag "Default" nil) string)))
:group 'gpr-ts
:link '(custom-manual :tag "Grammar Installation" "(gpr-ts-mode)Grammar Installation")
:package-version "0.5.0")
(defcustom gpr-ts-mode-grammar-install 'prompt
"Configuration for installation of tree-sitter language grammar library."
:type '(choice (const :tag "Automatically Install" auto)
(const :tag "Prompt to Install" prompt)
(const :tag "Do not install" nil))
:group 'gpr-ts
:link '(custom-manual :tag "Grammar Installation" "(gpr-ts-mode)Grammar Installation")
:package-version "0.5.0")
(defcustom gpr-ts-mode-package-names
'("binder" "builder" "check" "clean" "compiler" "cross_reference"
"documentation" "eliminate" "finder" "format" "gnatls" "gnatstub"
"ide" "install" "linker" "metrics" "naming" "pretty_printer"
"remote" "stack" "synchronize")
"List of known package names."
:type '(repeat string)
:group 'gpr-ts
:link '(custom-manual :tag "Syntax Highlighting" "(gpr-ts-mode)Syntax Highlighting")
:package-version "0.6.0")
;;;###autoload(put 'gpr-ts-mode-package-names 'safe-local-variable #'list-of-strings-p)
(defvar gpr-ts-mode-syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?- ". 12" table)
(modify-syntax-entry ?= "." table)
(modify-syntax-entry ?& "." table)
(modify-syntax-entry ?\| "." table)
(modify-syntax-entry ?> "." table)
(modify-syntax-entry ?\' "." table)
(modify-syntax-entry ?\\ "." table)
(modify-syntax-entry ?\n ">" table)
table)
"Syntax table for `gpr-ts-mode'.")
(defun gpr-ts-mode--indent-recompute (symbol newval operation where)
"Recompute indentation variables when SYMBOL is changed.
SYMBOL is expected to be `gpr-ts-mode-indent-offset', and
OPERATION is queried to check that it is a `set' operation (as
defined by `add-variable-watcher'), otherwise nothing is updated.
Assuming the global value has not been updated by the user, the
indentation variables are updated using the NEWVAL of SYMBOL and
made buffer-local WHERE indicates a buffer-local modification of
SYMBOL, else the default value is updated instead."
(when (and (eq symbol 'gpr-ts-mode-indent-offset)
(eq operation 'set))
(dolist (indent-symbol '(gpr-ts-mode-indent-when-offset
gpr-ts-mode-indent-broken-offset
gpr-ts-mode-indent-exp-item-offset))
(let* ((valspec (or (custom-variable-theme-value indent-symbol)
(get indent-symbol 'standard-value)))
(cur-custom-value (eval (car valspec)))
;; This routine is invoked before SYMBOL is updated to
;; NEWVAL so we need to bind it to the new value so the
;; other indentation variables are evaluated using the
;; updated value.
(gpr-ts-mode-indent-offset newval)
(new-custom-value (eval (car valspec))))
;; Only update if not globally modified by the user outside of
;; the customization system (e.g., via `set-default'), or the
;; symbol is already buffer local.
(when (or (eql cur-custom-value (default-value indent-symbol))
(and where (buffer-local-boundp indent-symbol where)))
(if where
(with-current-buffer where
(set (make-local-variable indent-symbol) new-custom-value))
(set-default indent-symbol new-custom-value)))))))
(add-variable-watcher 'gpr-ts-mode-indent-offset #'gpr-ts-mode--indent-recompute)
(defvar gpr-ts-mode--keywords
'("abstract" "all" "at"
"case"
"end" "extends" "external" "external_as_list"
"for"
"is"
"limited"
"null"
"others"
"package" ;"project"
"renames"
"type"
"use"
"when" "with")
"GPR keywords for tree-sitter font-locking.")
(defun gpr-ts-mode--anchor-first-sibling-matching (type)
"Position of first sibling of node whose type matches TYPE."
(lambda (_n parent &rest _)
(treesit-node-start
(car
(treesit-filter-child
parent
(lambda (n)
(equal (treesit-node-type n) type)))))))
(defun gpr-ts-mode--after-first-sibling-p (sibling)
"Determine if the location of node comes after SIBLING."
(lambda (_node parent bol &rest _)
(if-let* ((sibling-node
(gpr-ts-mode--first-child-matching parent sibling)))
(< (treesit-node-start sibling-node) bol))))
(defun gpr-ts-mode--before-first-sibling-p (sibling)
"Determine if the location of node comes before SIBLING."
(lambda (_node parent bol &rest _)
(if-let* ((sibling-node
(gpr-ts-mode--first-child-matching parent sibling)))
(> (treesit-node-start sibling-node) bol)
;; if it doesn't exist, node is before it
t)))
(defun gpr-ts-mode--between-siblings-p (first-sibling last-sibling)
"Determine if node is between FIRST-SIBLING and LAST-SIBLING."
(lambda (node parent bol &rest _)
(let ((after (gpr-ts-mode--after-first-sibling-p first-sibling))
(before (gpr-ts-mode--before-first-sibling-p last-sibling)))
(and (funcall after node parent bol)
(funcall before node parent bol)))))
(defun gpr-ts-mode--sibling-exists-p (sibling)
"Determine if SIBLING exists."
(lambda (_node parent _bol &rest _)
(gpr-ts-mode--first-child-matching parent sibling)))
(defun gpr-ts-mode--next-sibling (node parent bol &rest _)
"Determine next sibling in PARENT after this NODE or BOL."
(if node
(treesit-node-next-sibling node)
(car
(treesit-filter-child
parent
(lambda (n)
(> (treesit-node-start n) bol))))))
(defalias 'gpr-ts-mode--next-sibling-exists-p
'gpr-ts-mode--next-sibling)
(defun gpr-ts-mode--next-sibling-not-matching (type)
"Locate next sibling not matching TYPE."
(lambda (node parent bol &rest _)
(let ((sibling-node (gpr-ts-mode--next-sibling node parent bol)))
(while (and sibling-node
(equal (treesit-node-type sibling-node) type))
(setq sibling-node (treesit-node-next-sibling sibling-node)))
sibling-node)))
(defalias 'gpr-ts-mode--next-sibling-not-matching-exists-p
'gpr-ts-mode--next-sibling-not-matching)
(defun gpr-ts-mode--anchor-of-next-sibling-not-matching (type)
"Determine indentation anchor of next sibling not matching TYPE."
(lambda (node parent bol &rest _)
(let ((sibling-node
(funcall (gpr-ts-mode--next-sibling-not-matching type) node parent bol)))
(car (treesit-simple-indent sibling-node parent (treesit-node-start sibling-node))))))
(defun gpr-ts-mode--prev-sibling (node parent bol &rest _)
"Determine previous sibling in PARENT before this NODE or BOL."
(if node
(treesit-node-prev-sibling node)
(car
(reverse
(treesit-filter-child
parent
(lambda (n)
(< (treesit-node-start n) bol)))))))
(defun gpr-ts-mode--prev-sibling-matches-p (type)
"Check if previous sibling matches TYPE."
(lambda (node parent bol &rest _)
(if-let* ((prev (gpr-ts-mode--prev-sibling node parent bol)))
(string-equal (treesit-node-type prev) type))))
(defun gpr-ts-mode--prev-nonextra-sibling-matches-p (type)
"Check if previous non-extra sibling matches TYPE."
(lambda (node parent bol &rest _)
(let ((prev (gpr-ts-mode--prev-sibling node parent bol)))
(while (and prev (treesit-node-check prev 'extra))
(setq prev (treesit-node-prev-sibling prev)))
(when prev
(string-equal (treesit-node-type prev) type)))))
(defun gpr-ts-mode--enclosing-compound (compound-info pos)
"Find enclosing compound, specified in COMPOUND-INFO, at POS.
COMPOUND-INFO is a list of compound node information. Each entry should
be of the form (FIRST-CHILD-NODE-TYPE . PROPS), where
FIRST-CHILD-NODE-TYPE is the type of the first child node of the
compound node. PROPS should have the form:
[KEYWORD VALUE]...
The following keywords are meaningful:
:compound-type
VALUE must be the type of the compound node. This is a required
property.
:predicate
VALUE must be a function which takes a candidate node (matching
FIRST-CHILD-NODE-TYPE) as well as the node at POS, if one exists, and
returns non-nil if the candidate is appropriate. This is an optional
property.
The returned node is the closest previous node matching
FIRST-CHILD-NODE-TYPE which is a child of the specified compound node
type and the compound node must enclose POS.
The returned node may also be the closest previous node matching
FIRST-CHILD-NODE-TYPE which is not a child of the specified compound
node. This is a suspected incomplete compound. When a predicate is
provided, it is used to disambiguate any usage of FIRST-CHILD-NODE-TYPE
elsewhere in the grammar and must return non-nil for the node to be
chosen."
(let* ((matches nil)
(node
(save-excursion
(goto-char pos)
(if-let* ((node (treesit-node-at pos)))
(and (<= (treesit-node-start node) pos)
(> (treesit-node-end node) pos)
node))))
(parent
(if node
(treesit-node-parent node)
(treesit-node-on pos pos))))
(while (and parent (not matches))
(setq matches
(treesit-induce-sparse-tree
parent
(lambda (candidate)
(when-let* (((< (treesit-node-start candidate) pos))
(type (treesit-node-type candidate))
(parent (treesit-node-parent candidate))
(parent-type (treesit-node-type parent))
(compound (cdr (assoc-string type compound-info)))
(compound-type (plist-get compound :compound-type)))
(if (string-equal parent-type compound-type)
(and (<= (treesit-node-start parent) pos)
(< pos (treesit-node-end parent)))
(let ((predicate (plist-get compound :predicate)))
(or (null predicate)
(funcall predicate candidate node))))))))
(setq parent (treesit-node-parent parent)))
(when matches
(caar (reverse matches)))))
(defun gpr-ts-mode--indent-error-recovery (op)
"Find indentation in the presence of syntax errors.
If OP is \\='anchor\\=', determine anchor. If OP is \\='offset\\=',
determine offset."
(lambda (node _parent bol &rest _)
(let ((node-type
(let ((type (treesit-node-type node)))
(when (and type (string-equal type "ERROR"))
;; Replace ERROR node with leaf node.
(setq node (treesit-node-at (treesit-node-start node)))
(setq type (treesit-node-type node)))
type))
anchor-node anchor-type)
;; look for enclosing parenthesis or declaration.
(let (force-compound prev-node prev-type)
(save-excursion
(goto-char bol)
(while (and (not anchor-node)
(not force-compound)
(not (bobp)))
(when prev-node
(goto-char (treesit-node-start prev-node)))
(skip-chars-backward " \t\n" (point-min))
(setq prev-node (if (bobp) nil (treesit-node-at (1- (point))))
prev-type (treesit-node-type prev-node))
(cond
;; parenthesis
((and prev-type (string-equal prev-type "("))
(let ((end
(ignore-error scan-error
(scan-lists (treesit-node-start prev-node) 1 0))))
(when (or (null end)
(> end bol))
;; End parenthesis either not found (i.e.,
;; unbalanced) or it was after bol, so it encloses
;; bol.
(if (and node (member node-type '("project" "package" "case")))
(setq force-compound t) ; Recovery point
(setq anchor-node prev-node
anchor-type prev-type)))))
;; declaration
((and (or (null prev-type)
(member prev-type '(";" "=>"))
(and (string-equal prev-type "is")
;; Only consider the "is" keyword as a
;; declaration separator when it's part of a
;; compound (e.g., project_declaration),
;; otherwise ignore it when it isn't (e.g.,
;; typed_string_declaration).
(let ((keywords (cons "project" gpr-ts-mode--keywords))
(compound-keywords '("project" "package" "case"))
(keyword-node prev-node)
(keyword-type prev-type))
(save-excursion
(while (and keyword-node
(or (treesit-node-eq keyword-node prev-node)
(not (member keyword-type keywords))))
(goto-char (treesit-node-start keyword-node))
(skip-chars-backward " \t\n")
(if (bobp)
(setq keyword-node nil)
(setq keyword-node (treesit-node-at (1- (point)))
keyword-type (treesit-node-type keyword-node)))))
(and keyword-node
(member keyword-type compound-keywords))))))
(let (next-node next-type)
(save-excursion
(skip-chars-forward " \t\n")
(setq next-node (if (eobp) nil (treesit-node-at (point)))
next-type (treesit-node-type next-node))
(while (and next-type
(string-equal next-type "comment"))
(goto-char (treesit-node-end next-node))
(skip-chars-forward " \t\n")
(setq next-node (if (eobp) nil (treesit-node-at (point)))
next-type (treesit-node-type next-node)))
(if next-node
(if (>= (treesit-node-start next-node) bol)
;; bol is either a newline or a comment,
;; so anchor to the compound.
(setq force-compound t)
(setq anchor-node next-node
anchor-type next-type))
(setq force-compound t)))))))))
;; look for enclosing compound
(unless anchor-node
(setq anchor-node
(gpr-ts-mode--enclosing-compound
'(("project" . ( :compound-type "project_declaration"
:predicate
;; Don't anchor to a "project" keyword
;; used in an attribute reference.
(lambda (anchor &optional _node)
(let* ((next (treesit-node-next-sibling anchor))
(next-type (treesit-node-type next)))
(or (null next-type)
(not (string-equal next-type "'")))))))
("package" . ( :compound-type "package_declaration"
:predicate
;; Don't allow a nested "package".
;; This is an indication of an
;; incomplete package declaration
;; prior to the start of another
;; package declaration.
(lambda (_anchor &optional node)
(or (null node)
(let ((type (treesit-node-type node)))
(not (string-equal type "package")))))))
("case" . ( :compound-type "case_construction"))
("when" . ( :compound-type "case_item")))
bol)
anchor-type (treesit-node-type anchor-node)))
(if (null anchor-node)
(pcase op
((or (pred null) 'anchor)
(when treesit--indent-verbose
(message "Error recovery anchor: %s" anchor-node))
(pos-bol))
('offset 0))
(pcase op
((or (pred null) 'anchor)
(when treesit--indent-verbose
(message "Error recovery anchor: %s" anchor-node))
(if (string-equal anchor-type "project")
;; Anchor at beginning of line to account for possible
;; qualifier prefixes (e.g., "abstract")
(save-excursion
(goto-char (treesit-node-start anchor-node))
(forward-line 0)
(treesit-node-start (treesit-node-at (point))))
(treesit-node-start anchor-node)))
('offset
;; Determine nodes after anchor and before bol
(let ((zero-offset-types
(append '(";" "project")
(seq-difference
gpr-ts-mode--keywords
'("external" "external_as_list"))))
nodes-before)
(save-excursion
(goto-char (treesit-node-end anchor-node))
(while (< (point) bol)
(skip-chars-forward " \t\n" bol)
(when (< (point) bol)
(let ((node (treesit-node-at (point))))
;; Find largest complete node starting at point.
(setq node
(or
(treesit-parent-while
node
(lambda (n)
(and
(not (string-equal (treesit-node-type n) "ERROR"))
(= (treesit-node-start n) (point)))))
node))
(push (treesit-node-type node) nodes-before)
(goto-char (treesit-node-end node))))))
(setq nodes-before (reverse nodes-before))
(pcase anchor-type
("when"
(cond
((member "=>" nodes-before) gpr-ts-mode-indent-offset)
(t gpr-ts-mode-indent-broken-offset)))
("case"
(cond
((and (member "is" nodes-before)
(not (member "end" nodes-before))
(or (null node) (not (string-equal node-type "end"))))
gpr-ts-mode-indent-when-offset)
((and node (member node-type zero-offset-types))
0)
(t gpr-ts-mode-indent-broken-offset)))
((or "package" "project")
(cond
((and (member "is" nodes-before)
(not (member "end" nodes-before))
(or (null node) (not (string-equal node-type "end"))))
gpr-ts-mode-indent-offset)
((and node (member node-type zero-offset-types))
0)
(t gpr-ts-mode-indent-broken-offset)))
("("
(if (and node-type (string-equal node-type ")"))
0
(let ((next-node anchor-node))
(while (and next-node
(or (treesit-node-eq next-node anchor-node)
;; skip comments
(string-equal (treesit-node-type next-node) "comment")))
(save-excursion
(goto-char (treesit-node-end next-node))
(skip-chars-forward " \t\n" bol)
(if (>= (point) bol)
(setq next-node nil)
(setq next-node (treesit-node-at (point))))))
(if next-node
(let ((anchor-column
(save-excursion
(goto-char (treesit-node-start anchor-node))
(current-column))))
(save-excursion
(goto-char (treesit-node-start next-node))
(- (current-column) anchor-column)))
1))))
(_ ; declaration
(if (and node (member node-type zero-offset-types))
0
gpr-ts-mode-indent-broken-offset))))))))))
(defun gpr-ts-mode--anchor-of-indent-error-recovery ()
"Determine indentation anchor of error recovery point."
(gpr-ts-mode--indent-error-recovery 'anchor))
(defun gpr-ts-mode--offset-of-indent-error-recovery ()
"Determine indentation offset of error recovery point."
(gpr-ts-mode--indent-error-recovery 'offset))
(defun gpr-ts-mode--offset-of-next-sibling-not-matching (type)
"Determine indentation offset of next sibling not matching TYPE."
(lambda (node parent bol &rest _)
(let ((sibling-node
(funcall (gpr-ts-mode--next-sibling-not-matching type) node parent bol)))
(cdr (treesit-simple-indent sibling-node parent (treesit-node-start sibling-node))))))
(defun gpr-ts-mode--anchor-next-sibling (node parent bol &rest _)
"Determine location of next sibling after NODE in PARENT or BOL."
(treesit-node-start
(gpr-ts-mode--next-sibling node parent bol)))
(defun gpr-ts-mode--anchor-prev-sibling-matching (sibling-type)
"Locate previous sibling matching SIBLING-TYPE."
(lambda (_node parent bol &rest _)
(treesit-node-start
(car
(last
(treesit-filter-child
parent
(lambda (n)
(and
(equal (treesit-node-type n) sibling-type)
(< (treesit-node-start n) bol)))))))))
(defun gpr-ts-mode--first-child-matching (parent type)
"Find first child of PARENT matching TYPE.
Return nil if no child of that type is found."
;; NOTE: `treesit-filter-child' uses `treesit-node-next-sibling'
;; which doesn't traverse parser-inserted "missing" nodes (seems
;; like a bug), so filter the nodes manually.
(seq-find
(lambda (n)
(string-equal (treesit-node-type n) type))
(treesit-node-children parent)))
(cl-defgeneric gpr-ts-mode-indent (strategy)
"Indent according to STRATEGY."
(error "Unknown indentation strategy: %s" strategy))
(cl-defmethod gpr-ts-mode-indent ((_strategy (eql line)))
"Indent according to line STRATEGY."
(treesit-indent))
(cl-defmethod gpr-ts-mode-indent ((_strategy (eql declaration)))
"Indent according to declaration STRATEGY."
(let ((initial-point-column (current-column))
(initial-indentation-column (current-indentation))
(region
(save-excursion
(forward-line 0)
(skip-chars-forward " \t")
(unless (looking-at (rx (* whitespace) eol) t)
(let* ((node (treesit-node-at (point)))
(root (treesit-buffer-root-node))
(candidate
(treesit-parent-until
node
(lambda (node)
(or (treesit-node-eq node root)
(string-equal (treesit-node-type node) "ERROR")
(gpr-ts-mode--declaration-p node)))
'include-node)))
(when (and (gpr-ts-mode--declaration-p candidate)
(not (treesit-search-subtree candidate "ERROR")))
;; Prevent interpreting a project declaration "end"
;; next to an incomplete package declaration as a
;; valid package declaration by checking if the names
;; match.
(unless
(and (gpr-ts-mode--package-declaration-p candidate)
(not (gpr-ts-mode--package-declaration-names-match-p candidate)))
(cons (treesit-node-start candidate)
(treesit-node-end candidate)))))))))
(if region
(progn
(treesit-indent-region (car region) (cdr region))
;; Move point if it was in the indentation.
(when (<= initial-point-column
initial-indentation-column)
(back-to-indentation)))
(treesit-indent))))
(defun gpr-ts-mode--indent-line ()
"Indent according to `gpr-ts-mode-indent-strategy'."
(gpr-ts-mode-indent gpr-ts-mode-indent-strategy))
(defvar gpr-ts-mode--indent-rules
`((gpr
;; Non-Parent-driven indentation
;; Indent empty lines immediately following a case_item as part
;; of the case_item. This allows additional lines to keep being
;; added to the case_item without causing indentation to jump
;; after each newline.
((and no-node
(gpr-ts-mode--prev-nonextra-sibling-matches-p "case_item"))
(gpr-ts-mode--anchor-first-sibling-matching "case_item")
gpr-ts-mode-indent-offset)
;; Error recovery rules.
((or (parent-is "ERROR")
(node-is "ERROR")
(gpr-ts-mode--prev-sibling-matches-p "ERROR"))
(gpr-ts-mode--anchor-of-indent-error-recovery)
(gpr-ts-mode--offset-of-indent-error-recovery))
;; Normal indentation rules.
((and (parent-is "case_construction")
(gpr-ts-mode--between-siblings-p "is" "end"))
parent
gpr-ts-mode-indent-when-offset)
;; general indentation for package and project declaration bodies.
((and (or (parent-is "project_declaration")
(parent-is "package_declaration"))
(gpr-ts-mode--between-siblings-p "is" "end"))
parent
gpr-ts-mode-indent-offset)
;; general indentation for comment.
;;
;; NOTE: Indent to where next non-comment sibling would be
;; indented. This may not be aligned to sibling if sibling isn't
;; properly indented, however it prevents a two-pass indentation
;; when region is indented, since comments won't have to be
;; reindented once sibling becomes properly aligned.
((and (node-is "comment")
(gpr-ts-mode--next-sibling-not-matching-exists-p "comment"))
(gpr-ts-mode--anchor-of-next-sibling-not-matching "comment")
(gpr-ts-mode--offset-of-next-sibling-not-matching "comment"))
((and (node-is ")")
(gpr-ts-mode--sibling-exists-p "("))
(gpr-ts-mode--anchor-first-sibling-matching "(")
0)
;; top-level
((parent-is ,(rx bos "project" eos)) column-0 0)
;; with_declaration
((and (parent-is "with_declaration")
(gpr-ts-mode--between-siblings-p "with" ";")
(gpr-ts-mode--after-first-sibling-p "string_literal"))
(gpr-ts-mode--anchor-first-sibling-matching "string_literal")
0)
;; expression / expression_list
((and (parent-is "expression_list")
(gpr-ts-mode--after-first-sibling-p "expression"))
(gpr-ts-mode--anchor-first-sibling-matching "expression")
0)
((parent-is "expression_list")
(gpr-ts-mode--anchor-first-sibling-matching "(")
1)
((parent-is ,(rx bos "expression" eos))
parent
gpr-ts-mode-indent-exp-item-offset)
((or (parent-is ,(rx bos "project_reference" eos))
(parent-is ,(rx bos "variable_reference" eos)))
parent
0)
((node-is "expression_list")
parent
gpr-ts-mode-indent-broken-offset)
((node-is ,(rx bos "expression" eos))
parent
gpr-ts-mode-indent-broken-offset)
;; typed_string_declaration
((and (parent-is "typed_string_declaration")
(gpr-ts-mode--between-siblings-p "(" ")")
(gpr-ts-mode--after-first-sibling-p "string_literal"))
(gpr-ts-mode--anchor-first-sibling-matching "string_literal")
0)
((and (parent-is "typed_string_declaration")
(gpr-ts-mode--between-siblings-p "(" ")"))
(gpr-ts-mode--anchor-first-sibling-matching "(")
1)
;; attribute_reference / attribute_declaration
((and (or (parent-is "attribute_reference")
(parent-is "attribute_declaration"))
(gpr-ts-mode--between-siblings-p "(" ")"))
(gpr-ts-mode--anchor-first-sibling-matching "(")
1)
;; attribute_declaration
((and (parent-is "attribute_declaration")
(node-is "("))
(gpr-ts-mode--anchor-first-sibling-matching "identifier")
gpr-ts-mode-indent-broken-offset)
;; case_construction / case_item / discrete_choice_list
((parent-is "discrete_choice_list")
parent
0)
((node-is "discrete_choice_list")
parent
gpr-ts-mode-indent-broken-offset)
((parent-is "case_item")
parent-bol
gpr-ts-mode-indent-offset)
((match "variable_reference" "case_construction")
parent-bol
gpr-ts-mode-indent-broken-offset)
;; general indentation for newline.
;;
;; NOTE: Indent to where next non-comment sibling would be
;; indented. This may not be aligned to sibling if sibling isn't
;; properly indented, however it prevents a two-pass indentation
;; when region is indented, since comments won't have to be
;; reindented once sibling becomes properly aligned.
((and no-node
(gpr-ts-mode--next-sibling-not-matching-exists-p "comment"))
(gpr-ts-mode--anchor-of-next-sibling-not-matching "comment")
(gpr-ts-mode--offset-of-next-sibling-not-matching "comment"))
;; variable_declaration
((node-is ,(rx bos (or ":" ":=") eos))
parent
gpr-ts-mode-indent-broken-offset)
;; name (e.g., identifier . identifier)
((parent-is ,(rx bos "name" eos))
parent
0)
;; name, identifier, string_literal and string_literal_at.
((or (node-is ,(rx bos "name" eos))
(node-is "identifier")
(node-is "string_literal")
(parent-is "string_literal_at"))
parent
gpr-ts-mode-indent-broken-offset)
;; keywords / semicolon / project / project qualifier
((or (node-is ,(eval `(rx bos (or ,@gpr-ts-mode--keywords ";") eos)))
(match ,(rx bos "project" eos) "project_declaration")
(parent-is "project_qualifier"))
parent
0)
;; non-expression opening parenthesis
((node-is "(") parent gpr-ts-mode-indent-broken-offset)
;; trivial recovery for unexpected broken line
(catch-all prev-line 0)))
"Tree-sitter indent rules for `gpr-ts-mode'.")
(defvar gpr-ts-mode--font-lock-settings
(treesit-font-lock-rules
;; Attributes
:language 'gpr
:feature 'attribute
'((attribute_reference (identifier) @font-lock-property-use-face))
;; Brackets
:language 'gpr
:feature 'bracket
'((["(" ")"]) @font-lock-bracket-face)
;; Comments
:language 'gpr
:feature 'comment
'((comment) @font-lock-comment-face)
;; Definition
:language 'gpr
:feature 'definition
'((package_declaration name: (identifier) @font-lock-function-name-face)
((package_declaration endname: (identifier) @font-lock-function-name-face)
@package-declaration
(:pred gpr-ts-mode--package-declaration-names-match-p @package-declaration))
(typed_string_declaration name: (identifier) @font-lock-type-face)
(variable_declaration name: (identifier) @font-lock-variable-name-face)
(attribute_declaration name: (identifier) @font-lock-property-name-face))
;; Delimiters
:language 'gpr
:feature 'delimiter
'(["," "." ":" ";"] @font-lock-delimiter-face)
;; Functions
:language 'gpr
:feature 'function
:override 'prepend
'((builtin_function_call name: _ @font-lock-function-call-face))
;; Keywords
:language 'gpr
:feature 'keyword
`(([,@gpr-ts-mode--keywords] @font-lock-keyword-face)
(project_declaration "project" @font-lock-keyword-face)
((project_qualifier) @font-lock-keyword-face))
;; Numeric literals
:language 'gpr
:feature 'number
'((numeric_literal) @font-lock-number-face)
;; Package
:language 'gpr
:feature 'package
'((package_declaration
[ origname: (name (identifier) @font-lock-function-call-face :anchor)
basename: (name (identifier) @font-lock-function-call-face :anchor)])
((variable_reference (name (identifier) @font-lock-function-call-face))
(:pred gpr-ts-mode--package-name-p @font-lock-function-call-face)))
;; String literals
:language 'gpr
:feature 'string
'((string_literal) @font-lock-string-face)
;; Types
:language 'gpr
:feature 'type
'((variable_declaration type: (name (identifier) @font-lock-type-face :anchor)))
;; Variables
:language 'gpr
:feature 'variable
:override t
'((variable_reference (name (identifier) @font-lock-variable-use-face :anchor) :anchor))
;; Operators
:language 'gpr
:feature 'operator
'([":=" "&" "|" "=>"] @font-lock-operator-face)
;; Syntax errors
:language 'gpr
:feature 'error
:override t
'((ERROR) @font-lock-warning-face))
"Font-lock settings for `gpr-ts-mode'.")
(defun gpr-ts-mode--package-name-p (node)
"Check if NODE identifier matches a known package name."
(let ((identifier (downcase (treesit-node-text node t)))
(packages (mapcar #'downcase gpr-ts-mode-package-names)))
(seq-find (apply-partially #'string-equal identifier) packages)))
(defun gpr-ts-mode--package-declaration-names-match-p (node)
"Check if names match in package declaration NODE."
(when (gpr-ts-mode--package-declaration-p node)
(let ((name (treesit-node-child-by-field-name node "name"))
(endname (treesit-node-child-by-field-name node "endname")))
(string-equal-ignore-case (treesit-node-text name t)
(treesit-node-text endname t)))))
;;; Imenu
(defun gpr-ts-mode--tree-text
(node &optional ignored-types region-beg-type region-end-type)
"Extract text found within the tree of NODE.
IGNORED-TYPES specifies a list of node types within the tree to ignore.
REGION-BEG-TYPE specifies the type of the first child node of NODE to
begin text extraction (exclusive). REGION-END-TYPE specifies the first
child node of NODE to end text extraction (exclusive). When
REGION-BEG-TYPE or REGION-END-TYPE are nil, the region is expanded to
the beginning or end of NODE respectively.
The extracted text will retain its text properties and the text of the
nodes will be uniformly spaced with the exception of parenthesis and
periods."
(let* ((beg (when region-beg-type
(treesit-node-end
(gpr-ts-mode--first-child-matching node region-beg-type))))
(end (when region-end-type
(treesit-node-start
(gpr-ts-mode--first-child-matching node region-end-type))))
(tree (treesit-induce-sparse-tree
node
(lambda (node)
(let ((start (treesit-node-start node)))
(and (or (null beg) (> start beg))
(or (null end) (< start end))
(not (member (treesit-node-type node) ignored-types))
(= (treesit-node-child-count node) 0))))))
(terminals (flatten-list (cdr tree))))
;; Add spacing between terminals
(let ((name nil)
(prev-node-type nil)