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
| | ;;; ruby-ts-mode.el --- Major mode for editing Ruby files using tree-sitter -*- lexical-binding: t; -*-
;; Copyright (C) 2022-2023 Free Software Foundation, Inc.
;; Author: Perry Smith <pedz@easesoftware.com>
;; Created: December 2022
;; Keywords: ruby languages tree-sitter
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This file defines ruby-ts-mode which is a major mode for editing
;; Ruby files that uses Tree Sitter to parse the language. More
;; information about Tree Sitter can be found in the ELisp Info pages
;; as well as this website: https://tree-sitter.github.io/tree-sitter/
;; For this major mode to work, Emacs has to be compiled with
;; tree-sitter support, and the Ruby grammar has to be compiled and
;; put somewhere Emacs can find it. See the docstring of
;; `treesit-extra-load-path'.
;; This mode doesn't associate itself with .rb files automatically.
;; You can do that either by prepending to the value of
;; `auto-mode-alist', or using `major-mode-remap-alist'.
;; Tree Sitter brings a lot of power and versitility which can be
;; broken into these features.
;; * Font Lock
;; The ability to color the source code is not new but what is new is
;; the versatility to enable and disable particular font lock rules.
;; I suggest reviewing variable treesit-font-lock-level and function
;; treesit-font-lock-recompute-features to get a better understanding
;; of the following.
;; Currently tree treesit-font-lock-feature-list is set with the
;; following levels:
;; 1: comment method-definition
;; 2: keyword regexp string type
;; 3: builtin-variable builtin-constant constant
;; delimiter escape-sequence
;; global instance
;; interpolation literal symbol assignment
;; 4: bracket error function operator punctuation
;; Thus if treesit-font-lock-level is set to level 3 which is its
;; default, all the features listed in levels 1 through 3 above will
;; be enabled. i.e. those features will font lock or colorize the
;; code accordingly. Individual features can be added and removed via
;; treesit-font-lock-recompute-features.
;; describe-face can be used to view how a face looks.
;; * Indent
;; ruby-ts-mode tries to adhere to the indentation related user
;; options from ruby-mode, such as ruby-indent-level,
;; ruby-indent-tabs-mode, and so on.
;; * IMenu
;; * Navigation
;; * Which-func
;;; Code:
(require 'treesit)
(require 'ruby-mode)
(declare-function treesit-parser-create "treesit.c")
(declare-function treesit-induce-sparse-tree "treesit.c")
(declare-function treesit-node-child-by-field-name "treesit.c")
(declare-function treesit-search-subtree "treesit.c")
(declare-function treesit-node-parent "treesit.c")
(declare-function treesit-node-next-sibling "treesit.c")
(declare-function treesit-node-type "treesit.c")
(declare-function treesit-node-child "treesit.c")
(declare-function treesit-node-end "treesit.c")
(declare-function treesit-node-start "treesit.c")
(declare-function treesit-node-string "treesit.c")
(defgroup ruby-ts nil
"Major mode for editing Ruby code."
:prefix "ruby-ts-"
:group 'languages)
(defvar ruby-ts--operators
'("+" "-" "*" "/" "%" "**"
"==" "!=" ">" "<" ">=" "<=" "<=>" "==="
"=" "+=" "-=" "*=" "/=" "%=" "**="
"&" "|" "^" "~" "<<" ">>"
"!" "&&" "and" "not" "or" "||"
"?" ":"
".." "..."
"defined?"
"." "::")
"Ruby operators for tree-sitter font-locking.")
(defvar ruby-ts--delimiters '("," ";")
"Ruby's punctuation characters.")
(defvar ruby-ts--predefined-constants
(rx (or "ARGF" "ARGV" "DATA" "ENV" "RUBY_COPYRIGHT"
"RUBY_DESCRIPTION" "RUBY_ENGINE" "RUBY_ENGINE_VERSION"
"RUBY_PATCHLEVEL" "RUBY_PLATFORM" "RUBY_RELEASE_DATE"
"RUBY_REVISION" "RUBY_VERSION" "STDERR" "STDIN" "STDOUT"
"TOPLEVEL_BINDING"))
"Ruby predefined global constants.")
(defvar ruby-ts--predefined-variables
(rx (or "$!" "$@" "$~" "$&" "$‘" "$‘" "$+" "$=" "$/" "$\\" "$," "$;"
"$." "$<" "$>" "$_" "$*" "$$" "$?" "$:" "$LOAD_PATH"
"$LOADED_FEATURES" "$DEBUG" "$FILENAME" "$stderr" "$stdin"
"$stdout" "$VERBOSE" "$-a" "$-i" "$-l" "$-p"
(seq "$" (+ digit))))
"Ruby predefined global variables.")
(defconst ruby-ts--class-or-module-regex
(rx string-start
(or "class" "module" "singleton_class")
string-end)
"Regular expression that matches a class or module's node type.")
(defconst ruby-ts--method-regex
(rx string-start
(or "method" "singleton_method")
string-end)
"Regular expression matching methods and singleton methods.")
(defconst ruby-ts--statement-container-regexp
(rx string-start
(or "program"
"block_body"
"begin_block"
"end_block"
"do"
"else"
"then"
"ensure"
"body_statement"
"parenthesized_statements"
"interpolation")
string-end)
"Regular expression of the nodes that can contain statements.")
(defun ruby-ts--lineno (node)
"Return line number of NODE's start."
(line-number-at-pos (treesit-node-start node)))
;; doc/keywords.rdoc in the Ruby git repository considers these to be
;; reserved keywords. If these keywords are added to the list, it
;; causes the font-lock to stop working.
;;
;; "__ENCODING__" "__FILE__" "__LINE__" "false" "self" "super" "true"
;;
;; "nil" (which does not exhibit this issue) is also considered a
;; keyword but I removed it and added it as a constant.
;;
(defvar ruby-ts--keywords
'("BEGIN" "END" "alias" "and" "begin" "break" "case" "class"
"def" "defined?" "do" "else" "elsif" "end" "ensure" "for"
"if" "in" "module" "next" "not" "or" "redo" "rescue"
"retry" "return" "then" "undef" "unless" "until" "when"
"while" "yield")
"Ruby keywords for tree-sitter font-locking.")
(defun ruby-ts--comment-font-lock (node override start end &rest _)
"Apply font lock to comment NODE within START and END.
Applies `font-lock-comment-delimiter-face' and
`font-lock-comment-face' See `treesit-fontify-with-override' for
values of OVERRIDE"
;; Empirically it appears as if (treesit-node-start node) will be
;; where the # character is at and (treesit-node-end node) will be
;; the end of the line
(let* ((node-start (treesit-node-start node))
(plus-1 (1+ node-start))
(node-end (treesit-node-end node))
(text (treesit-node-text node t)))
(if (and (>= node-start start)
(<= plus-1 end)
(string-match-p "\\`#" text))
(treesit-fontify-with-override node-start plus-1
font-lock-comment-delimiter-face override))
(treesit-fontify-with-override (max plus-1 start) (min node-end end)
font-lock-comment-face override)))
(defun ruby-ts--font-lock-settings (language)
"Tree-sitter font-lock settings for Ruby."
(treesit-font-lock-rules
:language language
:feature 'comment
'((comment) @ruby-ts--comment-font-lock)
:language language
:feature 'builtin-variable
`(((global_variable) @var (:match ,ruby-ts--predefined-variables @var)) @font-lock-builtin-face)
:language language
:feature 'builtin-constant
`(((constant) @var (:match ,ruby-ts--predefined-constants @var)) @font-lock-builtin-face)
:language language
:feature 'keyword
`([,@ruby-ts--keywords] @font-lock-keyword-face
(self) @font-lock-keyword-face
(super) @font-lock-keyword-face)
:language language
:feature 'constant
'((true) @font-lock-doc-markup-face
(false) @font-lock-doc-markup-face
(nil) @font-lock-doc-markup-face)
;; Before 'operator so (unary) works.
:language language
:feature 'literal
'((unary ["+" "-"] [(integer) (rational) (float) (complex)]) @font-lock-number-face
(integer) @font-lock-number-face
(float) @font-lock-number-face
(complex) @font-lock-number-face
(rational) @font-lock-number-face)
;; Also before 'operator because % and / are operators
:language language
:feature 'regexp
'((regex "/" @font-lock-regexp-face)
(regex _ (string_content) @font-lock-regexp-face))
:language language
:feature 'operator
`("!" @font-lock-negation-char-face
[,@ruby-ts--operators] @font-lock-operator-face)
;; TODO: Consider using a different face for string delimiters.
;; font-lock-delimiter-face is not a good choice, though, because it
;; looks like 'default' in the default theme, and its documented purpose
;; is characters like commas, semicolons, etc.
:language language
:feature 'string
'((delimited_symbol [ ":\"" "\"" ] @font-lock-string-face)
(string "\"" @font-lock-string-face)
(string_array ["%w(" ")"] @font-lock-string-face)
(subshell "`" @font-lock-string-face)
(symbol_array ["%i(" ")"] @font-lock-constant-face))
:language language
:feature 'string
'([(string_content)
(heredoc_beginning)
(heredoc_content)
(heredoc_end)]
@font-lock-string-face)
:language language
:feature 'interpolation
'((interpolation "#{" @font-lock-misc-punctuation-face)
(interpolation "}" @font-lock-misc-punctuation-face))
:language language
:feature 'type
'((constant) @font-lock-type-face)
:language language
:feature 'global
'((global_variable) @font-lock-variable-name-face)
:language language
:feature 'instance
'((instance_variable) @font-lock-variable-name-face)
:language language
:feature 'method-definition
'((method
name: (identifier) @font-lock-function-name-face)
(singleton_method
name: (identifier) @font-lock-function-name-face)
(method
name: (setter) @font-lock-function-name-face))
:language language
:feature 'parameter-definition
'((method_parameters
(identifier) @font-lock-variable-name-face)
(block_parameters
(identifier) @font-lock-variable-name-face)
(optional_parameter
name: (identifier) @font-lock-variable-name-face)
(splat_parameter
name: (identifier) @font-lock-variable-name-face)
(hash_splat_parameter
name: (identifier) @font-lock-variable-name-face)
(block_parameter
name: (identifier) @font-lock-variable-name-face)
(destructured_parameter
(identifier) @font-lock-variable-name-face)
(lambda_parameters
(identifier) @font-lock-variable-name-face)
(exception_variable
(identifier) @font-lock-variable-name-face)
(array_pattern
(identifier) @font-lock-variable-name-face)
(keyword_pattern
value: (identifier) @font-lock-variable-name-face)
(keyword_pattern
key: (hash_key_symbol) @font-lock-variable-name-face
!value)
(as_pattern
name: (identifier) @font-lock-variable-name-face)
(in_clause
pattern: (identifier) @font-lock-variable-name-face))
;; Yuan recommends also putting method definitions into the
;; 'function' category (thus keeping it in both). I've opted to
;; just use separate categories for them -- dgutov.
:language language
:feature 'function
'((call
method: (identifier) @font-lock-function-name-face))
:language language
:feature 'assignment
'((assignment
left: (identifier) @font-lock-variable-name-face)
(assignment
left: (left_assignment_list (identifier) @font-lock-variable-name-face))
(operator_assignment
left: (identifier) @font-lock-variable-name-face))
:language language
:feature 'symbol
'((bare_symbol) @font-lock-constant-face
(delimited_symbol (string_content) @font-lock-constant-face)
(hash_key_symbol) @font-lock-constant-face
(simple_symbol) @font-lock-constant-face)
:language language
:feature 'error
'((ERROR) @font-lock-warning-face)
:feature 'escape-sequence
:language language
:override t
'((escape_sequence) @font-lock-escape-face)
:language language
:feature 'bracket
'((["(" ")" "[" "]" "{" "}"]) @font-lock-bracket-face)
:language language
:feature 'punctuation
`(([,@ruby-ts--delimiters] @font-lock-delimiter-face))))
(defun ruby-ts--first-non-comment-child (node)
"Return the first named child of NODE that is not a comment."
(let ((child (treesit-node-child node 0 t)))
(while (and child
(equal "comment" (treesit-node-type child)))
(setq child (treesit-node-next-sibling child t)))
child))
;;
;; These routines would be better added to treesit.el They are
;; intended to be used with indent rules
;;
;; I think this is over simplified but basically
;; treesit--simple-indent-eval calls the result with node, parent, and
;; bol. Thus all of these functions return a lambda that accepts three
;; arguments. Somewhere something explains that &rest should always
;; be used in case extra arguments are added in the future.
;;
(defun ruby-ts--type-pred (regexp)
"Return predicate taking a node returning non-nil if REGEXP matches type of node."
(lambda (node)
(string-match-p regexp (treesit-node-type node))))
(defun ruby-ts--parent-node (_n parent &rest _)
"Return the PARENT node matching ident rule."
parent)
(defun ruby-ts--align-keywords (pred)
"Return either start or bol of PRED.
PRED should specify a node that is listed in
`ruby-alignable-keywords'. If PRED is listed in user option
`ruby-align-to-stmt-keywords', then return the BOL of PRED.
Otherwise return start of PRED."
(lambda (node parent bol &rest rest)
(let* ((pred-node (funcall pred node parent bol rest))
(temp (treesit-node-start pred-node))
(type (treesit-node-type pred-node))
(bol (ruby-smie--indent-to-stmt-p
(if (equal type "method")
"def"
type))))
(when temp
(if bol
(save-excursion
(goto-char temp)
(back-to-indentation)
(point))
temp)))))
(defun ruby-ts--bol (pred)
"Return bol of PRED.
PRED should take (node parent bol &rest rest) and return a node.
Returns bol of the current line if PRED returns nil."
(lambda (node parent bol &rest rest)
(save-excursion
(let ((temp (treesit-node-start (funcall pred node parent bol rest))))
(if temp
(goto-char temp))
(back-to-indentation)
(point)))))
(defun ruby-ts--grand-parent-node (_n parent &rest _)
"Return parent of PARENT node."
(treesit-node-parent parent))
(defun ruby-ts--align-chain-p (&rest _)
"Return value of `ruby-align-chained-calls'."
ruby-align-chained-calls)
(defun ruby-ts--parenless-call-arguments-indent-p (&rest _)
"Return value of `ruby-parenless-call-arguments-indent'."
ruby-parenless-call-arguments-indent)
(defun ruby-ts--align-chain (_n parent &rest _)
"Align chained method call.
Align NODE which will be the dot (.) to the dot of the
first (outermost) call in the chain. See
`ruby-align-chained-calls' for details. PARENT will be the
\"call\" node. Called only when `ruby-align-chained-calls' is
non-nil."
(let* (first-call )
(while (and parent
(setq first-call (treesit-node-parent parent))
(string-match-p "call" (treesit-node-type first-call)))
(setq parent first-call))
(treesit-node-start (treesit-search-subtree parent "\\." nil t))))
(defun ruby-ts--same-line-args-p (_n parent &rest _)
"Return non-nil when first argument is on the same line as the method.
PARENT will be argument_list. NODE can be the close paren."
(let* ((method (treesit-node-parent parent))
(first-param (ruby-ts--first-non-comment-child parent)))
(= (ruby-ts--lineno method) (ruby-ts--lineno first-param))))
(defun ruby-ts--same-line-params-p (_n parent &rest _)
"Return non-nil when first parameter is on the same line as the method.
PARENT will be method_parameters. NODE can be the close paren."
(let* ((method (treesit-node-parent parent))
(first-param (ruby-ts--first-non-comment-child parent)))
(= (ruby-ts--lineno method) (ruby-ts--lineno first-param))))
(defun ruby-ts--param-indent (_n parent &rest _)
"Indent parameters that start on next line.
Given: NODE is the parameter. PARENT is
method_parameters. `ruby-ts--same-line-params-p' is nil.
Indent according to `ruby-method-params-indent'.
If `ruby-method-params-indent' is 0
def foo(
param1,
param2
)
Params start on next line, `ruby-method-params-indent' is t
def foo(
param1,
param2
)"
(let ((method (treesit-node-parent parent)))
(if (eq t ruby-method-params-indent)
;; For methods, the "name" is the name of the method but for
;; singleton methods, we need to find "object"
(let* ((singleton (equal "singleton_method" (treesit-node-type method)))
(name-node (treesit-node-child-by-field-name
method
(if singleton "object" "name"))))
;; (message "name-node: %S" name-node)
(treesit-node-start name-node))
;; Small Danger: if the method name plus the parent is less than
;; `ruby-method-params-indent', then the addition will put the
;; result on the next line and indented incorrectly. There are
;; plausible ways to fix this but the probability seems rather
;; remote.
(+ (treesit-node-start method) (or ruby-method-params-indent 0)))))
(defun ruby-ts--true (&rest _)
"I have no idea why I can't just put t but I can put 0."
t)
(defun ruby-ts--same-line-hash-array-p (_n parent &rest _)
"Return non-nil if first element and open brace are on the same line.
NODE is the element or closing brace or bracket. PARENT is the
array or hash."
(let* ((open-brace (treesit-node-child parent 0 nil))
(first-child (ruby-ts--first-non-comment-child parent)))
(= (ruby-ts--lineno open-brace) (ruby-ts--lineno first-child))))
(defun ruby-ts--assignment-ancestor (node &rest _)
"Return the assignment ancestor of NODE if any."
(treesit-parent-until node (ruby-ts--type-pred "\\`assignment\\'")))
(defun ruby-ts--statement-ancestor (node &rest _)
"Return the statement ancestor of NODE if any.
A statement is defined as a child of a statement container where
a statement container is a node that matches
`ruby-ts--statement-container-regexp'."
(let* ((statement node)
(parent (treesit-node-parent statement)))
(while (and parent
statement
(not (string-match-p ruby-ts--statement-container-regexp
(treesit-node-type parent))))
(setq statement parent
parent (treesit-node-parent parent)))
statement))
(defun ruby-ts--is-in-condition (node &rest _)
"Return the condition node if NODE is within a condition."
(while (and node
(not (equal "condition" (treesit-node-field-name node)))
(not (string-match-p ruby-ts--statement-container-regexp
(treesit-node-type node))))
(setq node (treesit-node-parent node)))
(and (equal "condition" (treesit-node-field-name node)) node))
(defun ruby-ts--endless-method (node &rest _)
"Return the expression node if NODE is in an endless method.
i.e. expr of def foo(args) = expr is returned."
(let* ((method node))
(while (and method
(not (string-match-p ruby-ts--method-regex (treesit-node-type method))))
(setq method (treesit-node-parent method)))
(when method
(if (equal "=" (treesit-node-type (treesit-node-child method 3 nil)))
(treesit-node-child method 4 nil)))))
;;
;; end of functions that can be used for queries
;;
(defun ruby-ts--indent-rules ()
"Indent rules supported by `ruby-ts-mode'."
(let ((common
`(
;; Slam all top level nodes to the left margin
((parent-is "program") parent 0)
;; Do not indent here docs or the end. Not sure why it
;; takes the grand-parent but ok fine.
((n-p-gp nil nil "heredoc_body") no-indent 0)
((parent-is "heredoc_body") no-indent 0)
((node-is "heredoc_body") no-indent 0)
;; Do not indent multiline regexp
((n-p-gp nil nil "regex") no-indent 0)
((parent-is "regex") no-indent 0)
;; if then else elseif notes:
;;
;; 1. The "then" starts at the end of the line that ends
;; the if condition which can be on a different line
;; from the "if".
;;
;; 2. If there is an "elsif", it is a sibling to the then
;; BUT the "else" that follows is now a child of the
;; "elsif".
;;
;; 3. The statements within each of these are direct
;; children. There is no intermediate construct such
;; as a block_statement.
;;
;; I'm using very restrictive patterns hoping to reduce rules
;; triggering unintentionally.
((match "else" "if")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((match "elsif" "if")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((match "end" "if")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((n-p-gp nil "then\\|else\\|elsif" "if\\|unless")
(ruby-ts--align-keywords ruby-ts--grand-parent-node) ruby-indent-level)
;; case expression: when, in_clause, and else are all
;; children of case. when and in_clause have pattern and
;; body as fields. body has "then" and then the statemets.
;; i.e. the statements are not children of when but then.
;; But for the statements are children of else.
((match "when" "case")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((match "in_clause" "case")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((match "else" "case")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((match "end" "case")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((n-p-gp nil "then" "when") grand-parent ruby-indent-level)
((n-p-gp nil "then" "in_clause") grand-parent ruby-indent-level)
((n-p-gp nil "else" "case") parent ruby-indent-level)
;; The beauty of inconsistency :-)
;; while / until have only "do" as a child. The "end" is a
;; child of "do".
((n-p-gp "end" "do" "while\\|until")
(ruby-ts--align-keywords ruby-ts--grand-parent-node) 0)
((n-p-gp nil "do" "while\\|until")
(ruby-ts--align-keywords ruby-ts--grand-parent-node) ruby-indent-level)
;; begin can have rescue, ensure, else, and end.
;; statements are a child of begin. rescue, ensure, else,
;; and end are also children of begin. rescue has a then
;; as a child thus statements will be grand children of
;; rescue.
((n-p-gp nil "then" "rescue")
(ruby-ts--align-keywords ruby-ts--grand-parent-node) ruby-indent-level)
((n-p-gp nil "ensure\\|else" "begin")
(ruby-ts--align-keywords ruby-ts--parent-node) ruby-indent-level)
((match "rescue\\|ensure\\|else\\|end" "begin")
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((parent-is "begin") ;last
(ruby-ts--align-keywords ruby-ts--parent-node) ruby-indent-level)
;; for ... I don't think I have ever used a for loop in
;; Ruby. The "in" (not an in_clause) and "do" are
;; children. The statements are children of the "do".
;; And, of course, the "end" is a child of the "do".
((n-p-gp "end" "do" "for")
(ruby-ts--align-keywords ruby-ts--grand-parent-node) 0)
((n-p-gp nil "do" "for")
(ruby-ts--align-keywords ruby-ts--grand-parent-node) ruby-indent-level)
;; method has a "body_statement" and the "end" as children.
;; The body_statement can have rescue, ensure, and else as
;; well as statements. Note that the first statement of a
;; body_statement hits the node as "body_statement" and not
;; as the assignment, etc.
((match "end" ,ruby-ts--method-regex)
(ruby-ts--align-keywords ruby-ts--parent-node) 0)
((n-p-gp "\\`\\(rescue\\|ensure\\|else\\)\\'" "body_statement" ,ruby-ts--method-regex)
(ruby-ts--align-keywords ruby-ts--grand-parent-node) 0)
((n-p-gp nil "rescue\\|ensure\\|else" "body_statement") parent ruby-indent-level)
((match "body_statement" ,ruby-ts--method-regex) ;first statement
(ruby-ts--align-keywords ruby-ts--parent-node) ruby-indent-level)
((n-p-gp nil "body_statement" ,ruby-ts--method-regex) ;other statements
(ruby-ts--align-keywords ruby-ts--grand-parent-node) ruby-indent-level)
;; Chained calls:
;; if `ruby-align-chained-calls' is true, the first query
;; matches and the node is aligned under the first dot (.);
;; else the second query aligns
;; `ruby-indent-level' spaces in from the parent.
((and ruby-ts--align-chain-p (match "\\." "call")) ruby-ts--align-chain 0)
((match "\\." "call") parent ruby-indent-level)
;; ruby-indent-after-block-in-continued-expression
((match "begin" "assignment") parent ruby-indent-level)
;; method parameters -- four styles:
;; 1) With paren, first arg on same line:
((and (query "(method_parameters \"(\" _ @indent)")
ruby-ts--same-line-params-p
(node-is ")"))
first-sibling 0)
((and (query "(method_parameters \"(\" _ @indent)")
ruby-ts--same-line-params-p)
first-sibling 1)
;; ;; 2) With paren, first arg on next line, ruby-method-params-indent eq t
;; ;; 3) With paren, first arg on next line, ruby-method-params-indent neq t
((and (query "(method_parameters \"(\" _ @indent)") (node-is ")")) ruby-ts--param-indent 0)
((query "(method_parameters \"(\" _ @indent)") ruby-ts--param-indent ruby-indent-level)
;; 4) No paren:
((parent-is "method_parameters") first-sibling 0)
;; Argument lists:
;; 1) With paren, 1st arg on same line
((and (query "(argument_list \"(\" _ @indent)")
ruby-ts--same-line-args-p
(node-is ")"))
first-sibling 0)
((and (query "(argument_list \"(\" _ @indent)")
ruby-ts--same-line-args-p)
first-sibling 1)
;; 2) With paren, 1st arg on next line
((and (query "(argument_list \"(\" _ @indent)")
(node-is ")"))
(ruby-ts--bol ruby-ts--grand-parent-node) 0)
((query "(argument_list \"(\" _ @indent)")
(ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
;; 3) No paren, ruby-parenless-call-arguments-indent is t
((and ruby-ts--parenless-call-arguments-indent-p (parent-is "argument_list"))
first-sibling 0)
;; 4) No paren, ruby-parenless-call-arguments-indent is nil
((parent-is "argument_list") (ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
;; Old... probably too simple
((parent-is "block_parameters") first-sibling 1)
((and (parent-is "binary")
(or ruby-ts--assignment-ancestor
ruby-ts--is-in-condition
ruby-ts--endless-method))
first-sibling 0)
;; ruby-mode does not touch these...
((match "bare_string" "string_array") no-indent 0)
;; hash and array other than assignments. Note that the
;; first sibling is the "{" or "[". There is a special
;; case where the hash is an argument to a method. These
;; need to be processed first.
((and ruby-ts--same-line-hash-array-p (match "}" "hash"))
first-sibling 0)
((and ruby-ts--same-line-hash-array-p (parent-is "hash"))
(nth-sibling 0 ruby-ts--true) 0)
((and ruby-ts--same-line-hash-array-p (match "]" "array"))
first-sibling 0)
((and ruby-ts--same-line-hash-array-p (parent-is "array"))
(nth-sibling 0 ruby-ts--true) 0)
;; NOTE to folks trying to understand my insanity...
;; I having trouble understanding the "logic" of why things
;; are indented like they are so I am adding special cases
;; hoping at some point I will be struck by lightning.
((and (n-p-gp "}" "hash" "pair")
(not ruby-ts--same-line-hash-array-p))
grand-parent 0)
((and (n-p-gp "pair" "hash" "pair")
(not ruby-ts--same-line-hash-array-p))
grand-parent ruby-indent-level)
((and (n-p-gp "}" "hash" "method")
(not ruby-ts--same-line-hash-array-p))
grand-parent 0)
((and (n-p-gp "pair" "hash" "method")
(not ruby-ts--same-line-hash-array-p))
grand-parent ruby-indent-level)
((n-p-gp "}" "hash" "assignment") (ruby-ts--bol ruby-ts--grand-parent-node) 0)
((n-p-gp nil "hash" "assignment") (ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
((n-p-gp "]" "array" "assignment") (ruby-ts--bol ruby-ts--grand-parent-node) 0)
((n-p-gp nil "array" "assignment") (ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
((n-p-gp "}" "hash" "argument_list") first-sibling 0)
((n-p-gp nil "hash" "argument_list") first-sibling ruby-indent-level)
((n-p-gp "]" "array" "argument_list") first-sibling 0)
((n-p-gp nil "array" "argument_list") first-sibling ruby-indent-level)
((match "}" "hash") first-sibling 0)
((parent-is "hash") first-sibling ruby-indent-level)
((match "]" "array") first-sibling 0)
((parent-is "array") first-sibling ruby-indent-level)
;; If the previous method isn't finished yet, this will get
;; the next method indented properly.
((n-p-gp ,ruby-ts--method-regex "body_statement" ,ruby-ts--class-or-module-regex)
(ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
;; Match the end of a class / module
((match "end" ,ruby-ts--class-or-module-regex) parent 0)
;; A "do_block" has a "body_statement" child which has the
;; statements as children within it. The problem is that
;; the first statement starts at the same point as the
;; body_statement and so treesit-simple-indent is called
;; with node set to body_statement on the first statement
;; but with node set to the statement and parent set to
;; body_statement for all others. ... Fine. Be that way.
;; Ditto for "block" and "block_body"
((node-is "body_statement") parent-bol ruby-indent-level)
((parent-is "body_statement") (ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
((match "end" "do_block") parent-bol 0)
((n-p-gp "block_body" "block" nil) parent-bol ruby-indent-level)
((n-p-gp nil "block_body" "block") (ruby-ts--bol ruby-ts--grand-parent-node) ruby-indent-level)
((match "}" "block") parent-bol 0)
;; Chained strings
((match "string" "chained_string") first-sibling 0)
;; Try and indent two spaces when all else fails.
(catch-all parent-bol ruby-indent-level))))
`((ruby . ,common))))
(defun ruby-ts--class-or-module-p (node)
"Predicate if NODE is a class or module."
(string-match-p ruby-ts--class-or-module-regex (treesit-node-type node)))
(defun ruby-ts--get-name (node)
"Return the text of the `name' field of NODE."
(treesit-node-text (treesit-node-child-by-field-name node "name")))
(defun ruby-ts--full-name (node)
"Return the fully qualified name of NODE."
(let* ((name (ruby-ts--get-name node))
(delimiter "#"))
(while (setq node (treesit-parent-until node #'ruby-ts--class-or-module-p))
(setq name (concat (ruby-ts--get-name node) delimiter name))
(setq delimiter "::"))
name))
(defun ruby-ts--imenu-helper (node)
"Convert a treesit sparse tree NODE in an imenu list.
Helper for `ruby-ts--imenu' which converts a treesit sparse
NODE into a list of imenu ( name . pos ) nodes"
(let* ((ts-node (car node))
(subtrees (mapcan #'ruby-ts--imenu-helper (cdr node)))
(name (when ts-node
(ruby-ts--full-name ts-node)))
(marker (when ts-node
(set-marker (make-marker)
(treesit-node-start ts-node)))))
(cond
((or (null ts-node) (null name)) subtrees)
;; Don't include the anonymous "class" and "module" nodes
((string-match-p "(\"\\(class\\|module\\)\")"
(treesit-node-string ts-node))
nil)
(subtrees
`((,name ,(cons name marker) ,@subtrees)))
(t
`((,name . ,marker))))))
;; For now, this is going to work like ruby-mode and return a list of
;; class, modules, def (methods), and alias. It is likely that this
;; can be rigged to be easily extended.
(defun ruby-ts--imenu ()
"Return Imenu alist for the current buffer."
(let* ((root (treesit-buffer-root-node))
(nodes (treesit-induce-sparse-tree root "^\\(method\\|alias\\|class\\|module\\)$")))
(ruby-ts--imenu-helper nodes)))
(defun ruby-ts--arrow-up-start (arg)
"Move to the start ARG levels up or out."
(interactive "p")
(setq arg (or arg 1))
(let* ((pnt (point))
(found (treesit-node-at pnt))
(pos (treesit-node-start found))
new-pos)
(while (and found pos (> arg 0))
(setq found (treesit-node-parent found)
new-pos (treesit-node-start found))
(when (and new-pos (not (= new-pos pos)))
(setq arg (1- arg)
pos new-pos)))
(if pos
(goto-char pos)
(error "Something didn't work"))))
(defun ruby-ts--class-name (node)
"Return NODE's name.
Assumes NODE's type is \"class\" or \"method\""
(list
(treesit-node-text
(treesit-node-child-by-field-name
node
(if (equal "singleton_class" (treesit-node-type node)) "value" "name"))
t)))
(defun ruby-ts--method-name (node)
"Return the method name of NODE.
Assumes NODE's type is method or singleton_method."
(if (equal "method" (treesit-node-type node))
(list (treesit-node-text (treesit-node-child-by-field-name node "name") t))
(let* ((children (treesit-node-children node))
;; 0th is "def"
(first (nth 1 children))
(third (nth 3 children)))
(cond
((equal "(" (treesit-node-type first))
(list (treesit-node-text (nth 2 children) t)
(treesit-node-text (nth 5 children) t)))
;; ((equal "self" (treesit-node-type first))
;; (list (treesit-node-text third t)))
(t (mapcar (lambda (n)
(treesit-node-text n t))
(list first third)))))))
(defun ruby-ts-add-log-current-function ()
"Return the current method name as a string.
The hash (#) is for instance methods only which are methods
\"defined on a class\" -- which is 99% of methods. Otherwise, a
dot (.) is used. Double colon (::) is used between classes. The
leading double colon is not added."
(let* ((node (treesit-node-at (point)))
(method-pred
(lambda (node)
(and (<= (treesit-node-start node) (point))
(>= (treesit-node-end node) (point))
(string-match-p ruby-ts--method-regex (treesit-node-type node)))))
(method (treesit-parent-until node method-pred t))
(class (or method node))
(result nil)
(sep "#")
(method-list nil)
(class-list nil)
(method-name nil))
(when method
(setq method-list (ruby-ts--method-name method))
(unless (= 1 (length method-list))
(setq sep ".")))
(while (setq class (treesit-parent-until class
(ruby-ts--type-pred
ruby-ts--class-or-module-regex)))
(setq class-list (append (ruby-ts--class-name class) class-list)))
(setq method-name (car (last method-list))
method-list (butlast method-list))
(when (equal (car method-list) (car (last class-list)))
(setq method-list (cdr method-list)))
(dolist (ele (append class-list method-list))
(cond
((equal "self" ele)
(setq sep "."))
((string-match-p "\\`[^A-Z]" ele) ;not a class
(setq sep "."
result (if result
(concat result "::" ele)
ele)))
(t (setq result (if result
(concat result "::" ele)
ele)))))
(if method-name
(concat result sep method-name)
result)))
(defvar-keymap ruby-ts-mode-map
:doc "Keymap used in Ruby mode"
:parent prog-mode-map
;; (when ruby-use-smie
;; (define-key map (kbd "M-C-d") 'smie-down-list))
;; (define-key map (kbd "M-C-p") 'ruby-beginning-of-block)
;; (define-key map (kbd "M-C-n") 'ruby-end-of-block)
"C-c {" #'ruby-toggle-block
"C-c '" #'ruby-toggle-string-quotes
"C-c C-f" #'ruby-find-library-file)
;;;###autoload
(define-derived-mode ruby-ts-mode ruby-base-mode "Ruby"
"Major mode for editing Ruby, powered by tree-sitter."
:group 'ruby
:syntax-table ruby-mode-syntax-table
(unless (treesit-ready-p 'ruby)
(error "Tree-sitter for Ruby isn't available"))
(treesit-parser-create 'ruby)
(setq-local add-log-current-defun-function #'ruby-ts-add-log-current-function)
;; Navigation.
(setq-local treesit-defun-type-regexp ruby-ts--method-regex)
;; AFAIK, Ruby can not nest methods
(setq-local treesit-defun-prefer-top-level nil)
;; Imenu.
(setq-local imenu-create-index-function #'ruby-ts--imenu)
(setq-local treesit-simple-indent-rules (ruby-ts--indent-rules))
;; Font-lock.
(setq-local treesit-font-lock-settings (ruby-ts--font-lock-settings 'ruby))
;; Level 3 is the default.
(setq-local treesit-font-lock-feature-list
'(( comment method-definition parameter-definition)
( keyword regexp string type)
( builtin-variable builtin-constant constant
delimiter escape-sequence
global instance
interpolation literal symbol assignment)
( bracket error function operator punctuation)))
(treesit-major-mode-setup))
(if (treesit-ready-p 'ruby)
(add-to-list 'auto-mode-alist
'("\\(?:\\.\\(?:rbw?\\|ru\\|rake\\|thor\\|jbuilder\\|rabl\\|gemspec\\|podspec\\)\\|/\\(?:Gem\\|Rake\\|Cap\\|Thor\\|Puppet\\|Berks\\|Brew\\|Vagrant\\|Guard\\|Pod\\)file\\)\\'" . ruby-ts-mode)))
(provide 'ruby-ts-mode)
;;; ruby-ts-mode.el ends here
|