-
-
Notifications
You must be signed in to change notification settings - Fork 646
/
Copy pathcider-mode.el
1193 lines (1091 loc) · 52.2 KB
/
cider-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
;;; cider-mode.el --- Minor mode for REPL interactions -*- lexical-binding: t -*-
;; Copyright © 2012-2024 Tim King, Phil Hagelberg, Bozhidar Batsov
;; Copyright © 2013-2024 Bozhidar Batsov, Artur Malabarba and CIDER contributors
;;
;; Author: Tim King <[email protected]>
;; Phil Hagelberg <[email protected]>
;; Bozhidar Batsov <[email protected]>
;; Artur Malabarba <[email protected]>
;; Hugo Duncan <[email protected]>
;; Steve Purcell <[email protected]>
;; 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/>.
;; This file is not part of GNU Emacs.
;;; Commentary:
;; Minor mode for REPL interactions.
;;; Code:
(require 'clojure-mode)
(require 'cider-eval)
(require 'cider-test) ; required only for the menu
(require 'cider-eldoc)
(require 'cider-resolve)
(require 'cider-doc) ; required only for the menu
(require 'cider-profile) ; required only for the menu
(require 'cider-completion)
(require 'cider-completion-context)
(require 'cider-inspector)
(require 'cider-find)
(require 'cider-xref-backend)
(require 'subr-x)
(defcustom cider-mode-line-show-connection t
"If the mode-line lighter should detail the connection."
:group 'cider
:type 'boolean
:package-version '(cider "0.10.0"))
(defun cider--modeline-info ()
"Return info for the cider mode modeline.
Info contains the connection type, project name and host:port endpoint."
(if-let* ((current-connection (ignore-errors (cider-current-repl))))
(with-current-buffer current-connection
(concat
(symbol-name cider-repl-type)
(when cider-mode-line-show-connection
(format ":%s@%s:%s"
(or (cider--project-name nrepl-project-dir) "<no project>")
(pcase (plist-get nrepl-endpoint :host)
("localhost" "")
(x x))
(plist-get nrepl-endpoint :port)))))
"not connected"))
;;;###autoload
(defcustom cider-mode-line
'(:eval (format " cider[%s]" (cider--modeline-info)))
"Mode line lighter for cider mode.
The value of this variable is a mode line template as in
`mode-line-format'. See Info Node `(elisp)Mode Line Format' for details
about mode line templates.
Customize this variable to change how cider mode displays its status in the
mode line. The default value displays the current connection. Set this
variable to nil to disable the mode line entirely."
:group 'cider
:type 'sexp
:risky t
:package-version '(cider "0.7.0"))
;;; Switching between REPL & source buffers
(defun cider--switch-to-repl-buffer (repl-buffer &optional set-namespace)
"Select the REPL-BUFFER, when possible in an existing window.
When SET-NAMESPACE is t, sets the namespace in the REPL buffer to
that of the namespace in the Clojure source buffer."
(let ((buffer (current-buffer)))
;; first we switch to the REPL buffer
(if cider-repl-display-in-current-window
(pop-to-buffer-same-window repl-buffer)
(pop-to-buffer repl-buffer))
;; then if necessary we update its namespace
(when set-namespace
(cider-repl-set-ns (with-current-buffer buffer (cider-current-ns))))
(goto-char (point-max))))
(defun cider-switch-to-repl-buffer (&optional set-namespace)
"Switch to current REPL buffer, when possible in an existing window.
The type of the REPL is inferred from the mode of current buffer. With a
prefix arg SET-NAMESPACE sets the namespace in the REPL buffer to that of
the namespace in the Clojure source buffer"
(interactive "P")
(cider--switch-to-repl-buffer
(cider-current-repl nil 'ensure)
set-namespace))
(declare-function cider-load-buffer "cider-eval")
(defun cider-load-buffer-and-switch-to-repl-buffer (&optional set-namespace)
"Load the current buffer into the matching REPL buffer and switch to it.
When SET-NAMESPACE is true, we'll also set the REPL's ns to match that of the
Clojure buffer."
(interactive "P")
(cider-load-buffer)
(cider-switch-to-repl-buffer set-namespace))
(defun cider-switch-to-last-clojure-buffer ()
"Switch to the last Clojure buffer.
The default keybinding for this command is
the same as variable `cider-switch-to-repl-buffer',
so that it is very convenient to jump between a
Clojure buffer and the REPL buffer."
(interactive)
(if (derived-mode-p 'cider-repl-mode)
(let* ((a-buf)
(the-buf (let ((repl-type (cider-repl-type-for-buffer)))
(seq-find (lambda (b)
(unless (with-current-buffer b (derived-mode-p 'cider-repl-mode))
(when-let* ((type (cider-repl-type-for-buffer b)))
(unless a-buf
(setq a-buf b))
(or (eq type 'multi)
(eq type repl-type)))))
(buffer-list)))))
(if-let* ((buf (or the-buf a-buf)))
(if cider-repl-display-in-current-window
(pop-to-buffer-same-window buf)
(pop-to-buffer buf))
(user-error "No Clojure buffer found")))
(user-error "Not in a CIDER REPL buffer")))
(defun cider-find-and-clear-repl-output (&optional clear-repl)
"Find the current REPL buffer and clear it.
With a prefix argument CLEAR-REPL the command clears the entire REPL
buffer. Returns to the buffer in which the command was invoked. See also
the related commands `cider-repl-clear-buffer' and
`cider-repl-clear-output'."
(interactive "P")
(let ((origin-buffer (current-buffer)))
(switch-to-buffer (cider-current-repl nil 'ensure))
(if clear-repl
(cider-repl-clear-buffer)
(cider-repl-clear-output))
(switch-to-buffer origin-buffer)))
;;; cider-run
(defvar cider--namespace-history nil
"History of user input for namespace prompts.")
(defun cider--var-namespace (var)
"Return the namespace of VAR.
VAR is a fully qualified Clojure variable name as a string."
(replace-regexp-in-string "\\(?:#'\\)?\\(.*\\)/.*" "\\1" var))
(defun cider-run (&optional function)
"Run -main or FUNCTION, prompting for its namespace if necessary.
With a prefix argument, prompt for function to run instead of -main."
(interactive (list (when current-prefix-arg (read-string "Function name: "))))
(cider-ensure-connected)
(let ((name (or function "-main")))
(when-let* ((response (cider-nrepl-send-sync-request
`("op" "ns-list-vars-by-name"
"name" ,name))))
(if-let* ((vars (split-string (substring (nrepl-dict-get response "var-list") 1 -1))))
(cider-interactive-eval
(if (= (length vars) 1)
(concat "(" (car vars) ")")
(let* ((completions (mapcar #'cider--var-namespace vars))
(def (or (car cider--namespace-history)
(car completions))))
(format "(#'%s/%s)"
(completing-read (format "Namespace (%s): " def)
completions nil t nil
'cider--namespace-history def)
name))))
(user-error "No %s var defined in any namespace" (cider-propertize name 'fn))))))
;;; Insert (and eval) in REPL functionality
(defvar cider-insert-commands-map
(let ((map (define-prefix-command 'cider-insert-commands-map)))
;; single key bindings defined last for display in menu
(define-key map (kbd "e") #'cider-insert-last-sexp-in-repl)
(define-key map (kbd "d") #'cider-insert-defun-in-repl)
(define-key map (kbd "r") #'cider-insert-region-in-repl)
(define-key map (kbd "n") #'cider-insert-ns-form-in-repl)
;; duplicates with C- for convenience
(define-key map (kbd "C-e") #'cider-insert-last-sexp-in-repl)
(define-key map (kbd "C-d") #'cider-insert-defun-in-repl)
(define-key map (kbd "C-r") #'cider-insert-region-in-repl)
(define-key map (kbd "C-n") #'cider-insert-ns-form-in-repl)
map))
(defcustom cider-switch-to-repl-on-insert t
"Whether to switch to the REPL when inserting a form into the REPL."
:type 'boolean
:group 'cider
:package-version '(cider . "0.21.0"))
(defcustom cider-invert-insert-eval-p nil
"Whether to invert the behavior of evaling.
Default behavior when inserting is to NOT eval the form and only eval with
a prefix. This allows to invert this so that default behavior is to insert
and eval and the prefix is required to prevent evaluation."
:type 'boolean
:group 'cider
:package-version '(cider . "0.18.0"))
(defun cider-insert-in-repl (form eval)
"Insert FORM in the REPL buffer and switch to it.
If EVAL is non-nil the form will also be evaluated. Use
`cider-invert-insert-eval-p' to invert this behavior."
(while (string-match "\\`[ \t\n\r]+\\|[ \t\n\r]+\\'" form)
(setq form (replace-match "" t t form)))
(when cider-switch-to-repl-on-insert
(cider-switch-to-repl-buffer))
(let ((repl (cider-current-repl)))
(with-selected-window (or (get-buffer-window repl t)
(selected-window))
(with-current-buffer repl
(goto-char (point-max))
(let ((beg (point)))
(insert form)
(indent-region beg (point))
(font-lock-ensure beg (point)))
(when (if cider-invert-insert-eval-p
(not eval)
eval)
(cider-repl-return))
(goto-char (point-max))))))
(defun cider-insert-last-sexp-in-repl (&optional arg)
"Insert the expression preceding point in the REPL buffer.
If invoked with a prefix ARG eval the expression after inserting it."
(interactive "P")
(cider-insert-in-repl (cider-last-sexp) arg))
(defun cider-insert-defun-in-repl (&optional arg)
"Insert the top level form at point in the REPL buffer.
If invoked with a prefix ARG eval the expression after inserting it."
(interactive "P")
(cider-insert-in-repl (cider-defun-at-point) arg))
(defun cider-insert-region-in-repl (start end &optional arg)
"Insert the current region in the REPL buffer.
START and END represent the region's boundaries.
If invoked with a prefix ARG eval the expression after inserting it."
(interactive "rP")
(cider-insert-in-repl
(buffer-substring-no-properties start end) arg))
(defun cider-insert-ns-form-in-repl (&optional arg)
"Insert the current buffer's ns form in the REPL buffer.
If invoked with a prefix ARG eval the expression after inserting it."
(interactive "P")
(cider-insert-in-repl (cider-ns-form) arg))
;;; The menu-bar
(defconst cider-mode-menu
`("CIDER"
["Start or connect to any REPL" cider
:help "A simple wrapper around all commands for starting/connecting to a REPL."]
("Clojure"
["Start a Clojure REPL" cider-jack-in
:help "Starts an nREPL server and connects a Clojure REPL to it."]
["Connect to a Clojure REPL" cider-connect
:help "Connects to a REPL that's already running."])
("ClojureScript"
["Start a ClojureScript REPL" cider-jack-in-cljs
:help "Starts an nREPL server and connects a ClojureScript REPL to it."]
["Connect to a ClojureScript REPL" cider-connect-clojurescript
:help "Connects to a ClojureScript REPL that's already running."]
["Create a ClojureScript REPL from a Clojure REPL" cider-jack-in-sibling-clojurescript])
"--"
["Quit" cider-quit :active (cider-connected-p)]
["Restart" cider-restart :active (cider-connected-p)]
"--"
["Connection info" cider-describe-connection
:active (cider-connected-p)]
["Select any CIDER buffer" cider-selector]
"--"
["Configure CIDER" (customize-group 'cider)]
"--"
["A sip of CIDER" cider-drink-a-sip]
["View user manual" cider-view-manual]
["View quick reference card" cider-view-refcard]
["Report a bug" cider-report-bug]
["Version info" cider-version]
"--"
["Close ancillary buffers" cider-close-ancillary-buffers
:active (seq-remove #'null cider-ancillary-buffers)]
("nREPL" :active (cider-connected-p)
["List nREPL middleware" cider-list-nrepl-middleware]
["Describe nREPL session" cider-describe-nrepl-session]
["Toggle message logging" nrepl-toggle-message-logging]))
"Menu for CIDER mode.")
(defconst cider-mode-eval-menu
'("CIDER Eval" :visible (cider-connected-p)
["Eval top-level sexp" cider-eval-defun-at-point]
["Eval top-level sexp to point" cider-eval-defun-up-to-point]
["Eval top-level sexp to comment" cider-eval-defun-to-comment]
["Eval top-level sexp and pretty-print to comment" cider-pprint-eval-defun-to-comment]
"--"
["Eval current list" cider-eval-list-at-point]
["Eval current sexp" cider-eval-sexp-at-point]
["Eval and tap current sexp" cider-tap-sexp-at-point]
["Eval current sexp to point" cider-eval-sexp-up-to-point]
["Eval current sexp in context" cider-eval-sexp-at-point-in-context]
"--"
["Eval last sexp" cider-eval-last-sexp]
["Eval and tap last sexp" cider-tap-last-sexp]
["Eval last sexp in context" cider-eval-last-sexp-in-context]
["Eval last sexp and insert" cider-eval-print-last-sexp
:keys "\\[universal-argument] \\[cider-eval-last-sexp]"]
["Eval last sexp in popup buffer" cider-pprint-eval-last-sexp]
["Eval last sexp and replace" cider-eval-last-sexp-and-replace]
["Eval last sexp to REPL" cider-eval-last-sexp-to-repl]
["Eval last sexp and pretty-print to REPL" cider-pprint-eval-last-sexp-to-repl]
["Eval last sexp and pretty-print to comment" cider-pprint-eval-last-sexp-to-comment]
"--"
["Eval selected region if active, otherwise top-level sexp" cider-eval-dwim]
["Eval selected region" cider-eval-region]
["Eval ns form" cider-eval-ns-form]
"--"
["Interrupt evaluation" cider-interrupt]
"--"
["Insert last sexp in REPL" cider-insert-last-sexp-in-repl]
["Insert last sexp in REPL and eval" (cider-insert-last-sexp-in-repl t)
:keys "\\[universal-argument] \\[cider-insert-last-sexp-in-repl]"]
["Insert top-level sexp in REPL" cider-insert-defun-in-repl]
["Insert region in REPL" cider-insert-region-in-repl]
["Insert ns form in REPL" cider-insert-ns-form-in-repl]
"--"
["Load this buffer" cider-load-buffer]
["Load this buffer and switch to REPL" cider-load-buffer-and-switch-to-repl-buffer]
["Load another file" cider-load-file]
["Recursively load all files in directory" cider-load-all-files]
["Load all project files" cider-load-all-project-ns]
["Refresh loaded code" cider-ns-refresh]
["Require and reload" cider-ns-reload]
["Require and reload all" cider-ns-reload-all]
["Run project (-main function)" cider-run])
"Menu for CIDER mode eval commands.")
(defconst cider-mode-interactions-menu
`("CIDER Interactions" :visible (cider-connected-p)
["Complete symbol" complete-symbol]
"--"
("REPL"
["Set REPL to this ns" cider-repl-set-ns]
["Switch to REPL" cider-switch-to-repl-buffer]
["REPL Pretty Print" cider-repl-toggle-pretty-printing
:style toggle :selected cider-repl-use-pretty-printing]
["Clear latest output" cider-find-and-clear-repl-output]
["Clear all output" (cider-find-and-clear-repl-output t)
:keys "\\[universal-argument] \\[cider-find-and-clear-repl-output]"]
"--"
["Configure the REPL" (customize-group 'cider-repl)])
,cider-doc-menu
("Find (jump to)"
["Find definition" cider-find-var]
["Find namespace" cider-find-ns]
["Find resource" cider-find-resource]
["Find keyword" cider-find-keyword]
["Go back" cider-pop-back])
("Xref"
["Find fn references" cider-xref-fn-refs]
["Find fn references and select" cider-xref-fn-refs-select]
["Find fn dependencies" cider-xref-fn-defs]
["Find fn dependencies and select" cider-xref-fn-defs-select])
("Browse"
["Browse namespace" cider-browse-ns]
["Browse all namespaces" cider-browse-ns-all]
["Browse spec" cider-browse-spec]
["Browse all specs" cider-browse-spec-all]
["Browse REPL input history" cider-repl-history]
["Browse classpath" cider-classpath]
["Browse classpath entry" cider-open-classpath-entry])
("Format"
["Format EDN last sexp" cider-format-edn-last-sexp]
["Format EDN region" cider-format-edn-region]
["Format EDN buffer" cider-format-edn-buffer])
("Macroexpand"
["Macroexpand-1" cider-macroexpand-1]
["Macroexpand-all" cider-macroexpand-all])
,cider-test-menu
("Debug"
["Inspect" cider-inspect]
["Toggle var tracing" cider-toggle-trace-var]
["Toggle ns tracing" cider-toggle-trace-ns]
"--"
["Debug top-level form" cider-debug-defun-at-point
:keys "\\[universal-argument] \\[cider-eval-defun-at-point]"]
["List instrumented defs" cider-browse-instrumented-defs]
"--"
["Configure the Debugger" (customize-group 'cider-debug)])
,cider-profile-menu
("Misc"
["Clojure Cheatsheet" cider-cheatsheet]
["Flush completion cache" cider-completion-flush-caches]))
"Menu for CIDER interactions.")
(declare-function cider-ns-refresh "cider-ns")
(declare-function cider-ns-reload "cider-ns")
(declare-function cider-ns-reload-all "cider-ns")
(declare-function cider-browse-ns "cider-browse-ns")
(declare-function cider-eval-ns-form "cider-eval")
(declare-function cider-repl-set-ns "cider-repl")
(declare-function cider-find-ns "cider-find")
(defvar cider-ns-map
(let ((map (define-prefix-command 'cider-ns-map)))
(define-key map (kbd "b") #'cider-browse-ns)
(define-key map (kbd "M-b") #'cider-browse-ns)
(define-key map (kbd "e") #'cider-eval-ns-form)
(define-key map (kbd "M-e") #'cider-eval-ns-form)
(define-key map (kbd "f") #'cider-find-ns)
(define-key map (kbd "M-f") #'cider-find-ns)
(define-key map (kbd "n") #'cider-repl-set-ns)
(define-key map (kbd "M-n") #'cider-repl-set-ns)
(define-key map (kbd "r") #'cider-ns-refresh)
(define-key map (kbd "M-r") #'cider-ns-refresh)
(define-key map (kbd "l") #'cider-ns-reload)
(define-key map (kbd "M-l") #'cider-ns-reload-all)
map)
"CIDER NS keymap.")
;; Those declares are needed, because we autoload all those commands when first
;; used. That optimizes CIDER's initial load time.
(declare-function cider-macroexpand-1 "cider-macroexpansion")
(declare-function cider-macroexpand-all "cider-macroexpansion")
(declare-function cider-selector "cider-selector")
(declare-function cider-toggle-trace-ns "cider-tracing")
(declare-function cider-toggle-trace-var "cider-tracing")
(declare-function cider-find-resource "cider-find")
(declare-function cider-find-keyword "cider-find")
(declare-function cider-find-var "cider-find")
(declare-function cider-find-dwim-at-mouse "cider-find")
(declare-function cider-xref-fn-refs "cider-xref")
(declare-function cider-xref-fn-refs-select "cider-xref")
(declare-function cider-xref-fn-deps "cider-xref")
(declare-function cider-xref-fn-deps-select "cider-xref")
(defconst cider--has-many-mouse-buttons (not (memq window-system '(mac ns)))
"Non-nil if system binds forward and back buttons to <mouse-8> and <mouse-9>.
As it stands Emacs fires these events on <mouse-8> and <mouse-9> on 'x' and
'w32'systems while on macOS it presents them on <mouse-4> and <mouse-5>.")
(defcustom cider-use-xref t
"Enable xref integration."
:type 'boolean
:safe #'booleanp
:group 'cider
:version '(cider . "1.2.0"))
(defcustom cider-xref-fn-depth -90
"The depth to use when adding the CIDER xref function to the relevant hook.
By convention this is a number between -100 and 100, lower numbers indicating a
higher precedence."
:type 'integer
:group 'cider
:version '(cider . "1.2.0"))
(defconst cider-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-d") 'cider-doc-map)
(unless cider-use-xref
(define-key map (kbd "M-.") #'cider-find-var)
(define-key map (kbd "M-,") #'cider-pop-back))
(define-key map (kbd (if cider--has-many-mouse-buttons "<mouse-8>" "<mouse-4>")) #'xref-pop-marker-stack)
(define-key map (kbd (if cider--has-many-mouse-buttons "<mouse-9>" "<mouse-5>")) #'cider-find-dwim-at-mouse)
(define-key map (kbd "C-c C-.") #'cider-find-ns)
(define-key map (kbd "C-c C-:") #'cider-find-keyword)
(define-key map (kbd "C-c M-.") #'cider-find-resource)
(define-key map (kbd "M-TAB") #'complete-symbol)
(define-key map (kbd "C-M-x") #'cider-eval-defun-at-point)
(define-key map (kbd "C-c C-c") #'cider-eval-defun-at-point)
(define-key map (kbd "C-x C-e") #'cider-eval-last-sexp)
(define-key map (kbd "C-c C-e") #'cider-eval-last-sexp)
(define-key map (kbd "C-c C-p") #'cider-pprint-eval-last-sexp)
(define-key map (kbd "C-c C-f") #'cider-pprint-eval-defun-at-point)
(define-key map (kbd "C-c C-v") 'cider-eval-commands-map)
(define-key map (kbd "C-c C-j") 'cider-insert-commands-map)
(define-key map (kbd "C-c M-;") #'cider-eval-defun-to-comment)
(define-key map (kbd "C-c M-e") #'cider-eval-last-sexp-to-repl)
(define-key map (kbd "C-c M-p") #'cider-insert-last-sexp-in-repl)
(define-key map (kbd "C-c M-:") #'cider-read-and-eval)
(define-key map (kbd "C-c C-u") #'cider-undef)
(define-key map (kbd "C-c C-M-u") #'cider-undef-all)
(define-key map (kbd "C-c C-m") #'cider-macroexpand-1)
(define-key map (kbd "C-c M-m") #'cider-macroexpand-all)
(define-key map (kbd "C-c M-n") 'cider-ns-map)
(define-key map (kbd "C-c M-i") #'cider-inspect)
(define-key map (kbd "C-c M-t v") #'cider-toggle-trace-var)
(define-key map (kbd "C-c M-t n") #'cider-toggle-trace-ns)
(define-key map (kbd "C-c C-z") #'cider-switch-to-repl-buffer)
(define-key map (kbd "C-c M-z") #'cider-load-buffer-and-switch-to-repl-buffer)
(define-key map (kbd "C-c C-o") #'cider-find-and-clear-repl-output)
(define-key map (kbd "C-c C-k") #'cider-load-buffer)
(define-key map (kbd "C-c C-l") #'cider-load-file)
(define-key map (kbd "C-c C-M-l") #'cider-load-all-files)
(define-key map (kbd "C-c C-b") #'cider-interrupt)
(define-key map (kbd "C-c ,") 'cider-test-commands-map)
(define-key map (kbd "C-c C-t") 'cider-test-commands-map)
(define-key map (kbd "C-c M-s") #'cider-selector)
(define-key map (kbd "C-c M-d") #'cider-describe-connection)
(define-key map (kbd "C-c C-=") 'cider-profile-map)
(define-key map (kbd "C-c C-? r") #'cider-xref-fn-refs)
(define-key map (kbd "C-c C-? C-r") #'cider-xref-fn-refs-select)
(define-key map (kbd "C-c C-? d") #'cider-xref-fn-deps)
(define-key map (kbd "C-c C-? C-d") #'cider-xref-fn-deps-select)
(define-key map (kbd "C-c C-q") #'cider-quit)
(define-key map (kbd "C-c M-r") #'cider-restart)
;; NOTE: all cider-log* vars are autoloaded. Please do not add a require.
(define-key map (kbd "C-c M-l a") #'cider-log-appender)
(define-key map (kbd "C-c M-l c") #'cider-log-consumer)
(define-key map (kbd "C-c M-l e") #'cider-log-event)
(define-key map (kbd "C-c M-l s") #'cider-log-show)
(define-key map (kbd "C-c M-l f") #'cider-log-framework)
(define-key map (kbd "C-c M-l i") #'cider-log-info)
(define-key map (kbd "C-c M-l l") #'cider-log)
(dolist (variable '(cider-mode-interactions-menu
cider-mode-eval-menu
cider-mode-menu))
(easy-menu-do-define (intern (format "%s-open" variable))
map
(get variable 'variable-documentation)
(cider--menu-add-help-strings (symbol-value variable))))
map))
;;;###autoload
(defun cider--setup-menu-for-clojure-major-mode (mode-map)
"Setup a Cider menu for a Clojure major mode's MODE-MAP.
This menu works as an easy entry-point into CIDER. Even if cider.el isn't
loaded yet, this will be shown in Clojure buffers next to the Clojure menu."
(easy-menu-define cider-clojure-mode-menu-open mode-map
"Menu for Clojure mode.
This is displayed in `clojure-mode' and `clojure-ts-mode' buffers,
if `cider-mode' is not active."
`("CIDER" :visible (not cider-mode)
["Start a Clojure REPL" cider-jack-in-clj
:help "Starts an nREPL server and connects a Clojure REPL to it."]
["Connect to a Clojure REPL" cider-connect-clj
:help "Connects to a REPL that's already running."]
["Start a ClojureScript REPL" cider-jack-in-cljs
:help "Starts an nREPL server and connects a ClojureScript REPL to it."]
["Connect to a ClojureScript REPL" cider-connect-cljs
:help "Connects to a ClojureScript REPL that's already running."]
["Start a Clojure REPL, and a ClojureScript REPL" cider-jack-in-clj&cljs
:help "Starts an nREPL server, connects a Clojure REPL to it, and then a ClojureScript REPL."]
"--"
["View user manual" cider-view-manual])))
;;;###autoload
(with-eval-after-load 'clojure-mode
(cider--setup-menu-for-clojure-major-mode clojure-mode-map))
;;;###autoload
(with-eval-after-load 'clojure-ts-mode
(cider--setup-menu-for-clojure-major-mode
(with-suppressed-warnings ((free-vars clojure-ts-mode-map))
clojure-ts-mode-map)))
;;; Dynamic indentation
(defcustom cider-dynamic-indentation t
"Whether CIDER should aid Clojure(Script) indentation.
If non-nil, CIDER uses runtime information (such as the \":style/indent\"
metadata) to improve standard `clojure-mode' indentation.
If nil, CIDER won't interfere with `clojure-mode's indentation.
Toggling this variable only takes effect after a file is closed and
re-visited."
:type 'boolean
:package-version '(cider . "0.11.0")
:group 'cider)
(defun cider--get-symbol-indent (symbol-name)
"Return the indent metadata for SYMBOL-NAME in the current namespace."
(let* ((ns (let ((clojure-cache-ns t)) ; we force ns caching here for performance reasons
;; silence bytecode warning of unused lexical var
(ignore clojure-cache-ns)
(cider-current-ns))))
(if-let* ((meta (cider-resolve-var ns symbol-name))
(indent (or (nrepl-dict-get meta "style/indent")
(nrepl-dict-get meta "indent"))))
(let ((format (format ":indent metadata on ‘%s’ is unreadable! \nERROR: %%s"
symbol-name)))
(with-demoted-errors format
(cider--deep-vector-to-list (read indent))))
;; There's no indent metadata, but there might be a clojure-mode
;; indent-spec with fully-qualified namespace.
(when (string-match cider-resolve--prefix-regexp symbol-name)
(when-let* ((sym (intern-soft (replace-match (save-match-data
(cider-resolve-alias ns (match-string 1 symbol-name)))
t t symbol-name 1))))
(get sym 'clojure-indent-function))))))
(defcustom cider-custom-symbol-categorizer-1
nil
"A function that receives `var' (type: string),
and `metadata-map' (type: nrepl dict).
Determines if a given symbol should be rendered using
`cider-custom-face-1'.
See also: `cider-custom-face-1', `cider-font-lock-dynamically'."
:type 'function
:group 'cider
:package-version '(cider . "1.14.0"))
(defcustom cider-custom-symbol-categorizer-2
nil
"A function that receives `var' (type: string),
and `metadata-map' (type: nrepl dict).
Determines if a given symbol should be rendered using
`cider-custom-face-2'.
See also: `cider-custom-face-2', `cider-font-lock-dynamically'."
:type 'function
:group 'cider
:package-version '(cider . "1.14.0"))
(defface cider-custom-face-1
'()
"The face to be used for symbols for which `cider-custom-symbol-categorizer-1', if set, returns t.
See also: `cider-font-lock-dynamically'."
:group 'cider
:package-version '(cider . "1.14.0"))
(defface cider-custom-face-2
'()
"The face to be used for symbols for which `cider-custom-symbol-categorizer-2', if set, returns t.
See also: `cider-font-lock-dynamically'."
:group 'cider
:package-version '(cider . "1.14.0"))
;;; Dynamic font locking
(defcustom cider-font-lock-dynamically '(macro core deprecated custom-1 custom-2)
"Specifies how much dynamic font-locking CIDER should use.
Dynamic font-locking this refers to applying syntax highlighting to vars
defined in the currently active nREPL connection. This is done in addition
to `clojure-mode's usual (static) font-lock, so even if you set this
variable to nil you'll still see basic syntax highlighting.
The value is a list of symbols, each one indicates a different type of var
that should be font-locked:
`macro' (default): Any defined macro gets the `font-lock-keyword-face'.
`function': Any defined function gets the `font-lock-function-face'.
`var': Any non-local var gets the `font-lock-variable-name-face'.
`deprecated' (default): Any deprecated var gets the `cider-deprecated-face'
face.
`core' (default): Any symbol from clojure.core/cljs.core. The selected face will depend on type.
Note that while rendering `core', all types of vars (`macro', `function', `var', `deprecated')
will be honored, regardless of the user's customization value.
`custom-1': any symbol for which
`(funcall cider-custom-symbol-categorizer-1 sym meta)' returns t.
`cider-custom-face-1' will be applied.
`custom-2': any symbol for which
`(funcall cider-custom-symbol-categorizer-2 sym meta)' returns t.
`cider-custom-face-2' will be applied.
The value can also be t, which means to font-lock as much as possible."
:type '(choice (set :tag "Fine-tune font-locking"
(const :tag "Any defined macro" macro)
(const :tag "Any defined function" function)
(const :tag "Any defined var" var)
(const :tag "Any defined deprecated" deprecated)
(const :tag "Any symbol from clojure.core" core))
(const :tag "Font-lock as much as possible" t))
:group 'cider
:package-version '(cider . "0.10.0"))
(defcustom cider-font-lock-reader-conditionals t
"Apply font-locking to unused reader conditional expressions.
The result depends on the buffer CIDER connection type."
:type 'boolean
:group 'cider
:package-version '(cider . "0.15.0"))
(defface cider-deprecated-face
'((((background light)) :background "light goldenrod")
(((background dark)) :background "#432"))
"Face used on deprecated vars."
:group 'cider)
(defface cider-instrumented-face
'((((type graphic)) :box (:color "#c00" :line-width -1))
(t :underline t :background "#800"))
"Face used to mark code being debugged."
:group 'cider-debug
:group 'cider
:package-version '(cider . "0.10.0"))
(defface cider-traced-face
'((((type graphic)) :box (:color "cyan" :line-width -1))
(t :underline t :background "#066"))
"Face used to mark code being traced."
:group 'cider
:package-version '(cider . "0.11.0"))
(defface cider-reader-conditional-face
'((t (:inherit font-lock-comment-face)))
"Face used to mark unused reader conditional expressions."
:group 'cider
:package-version '(cider . "0.15.0"))
(defconst cider-reader-conditionals-regexp "\\(?:#\\?@?[[:space:]\n]*(\\)"
"Regexp for matching reader conditionals with a non-capturing group.
Starts from the reader macro characters to the opening parentheses.")
(defvar cider--reader-conditionals-match-data (list nil nil)
"Reusable list for `match-data` in reader conditionals font lock matchers.")
(defun cider--search-reader-conditionals (limit)
"Matcher for finding reader conditionals.
Search is done with the given LIMIT."
(when (and cider-font-lock-reader-conditionals
(cider-connected-p))
(when (search-forward-regexp cider-reader-conditionals-regexp limit t)
(let ((start (match-beginning 0))
(state (syntax-ppss)))
(if (or (nth 3 state) (nth 4 state)) ; inside string or comment?
(cider--search-reader-conditionals limit)
(when (<= (point) limit)
(ignore-errors
(let ((md (match-data nil cider--reader-conditionals-match-data)))
(setf (nth 0 md) start)
(setf (nth 1 md) (point))
(set-match-data md)
t))))))))
(defun cider--anchored-search-suppressed-forms-internal (repl-types limit)
"Helper function for `cider--anchored-search-suppressed-forms`.
REPL-TYPES is a list of strings repl-type strings. LIMIT is the same as
the LIMIT in `cider--anchored-search-suppressed-forms`"
(when (= (length repl-types) 1)
(let ((type (car repl-types))
(expr (read (current-buffer)))
(start (save-excursion (backward-sexp) (point))))
(when (<= (point) limit)
(forward-sexp)
(if (not (string-equal (symbol-name expr) (concat ":" type)))
(ignore-errors
(cl-assert (<= (point) limit))
(let ((md (match-data nil cider--reader-conditionals-match-data)))
(setf (nth 0 md) start)
(setf (nth 1 md) (point))
(set-match-data md)
t))
(cider--anchored-search-suppressed-forms-internal repl-types limit))))))
(defun cider--anchored-search-suppressed-forms (limit)
"Matcher for finding unused reader conditional expressions.
An unused reader conditional expression is an expression for a platform
that does not match the CIDER connection for the buffer. Search is done
with the given LIMIT."
(let ((repl-types (seq-uniq (seq-map
(lambda (repl)
(symbol-name (cider-repl-type repl)))
(cider-repls))))
(result 'retry))
(while (and (eq result 'retry) (<= (point) limit))
(condition-case condition
(setq result
(cider--anchored-search-suppressed-forms-internal
repl-types limit))
(invalid-read-syntax
(setq result 'retry))
(wrong-type-argument
(setq result 'retry))
(scan-error
(setq result 'retry))
(end-of-file
(setq result nil))
(error
(setq result nil)
(message
"Error during fontification while searching for forms: %S"
condition))))
(if (eq result 'retry) (setq result nil))
result))
(defconst cider--reader-conditionals-font-lock-keywords
'((cider--search-reader-conditionals
(cider--anchored-search-suppressed-forms
(save-excursion
(let* ((state (syntax-ppss))
(list-pt (nth 1 state)))
(when list-pt
(goto-char list-pt)
(forward-list)
(backward-char)
(point))))
nil
(0 'cider-reader-conditional-face t))))
"Font Lock keywords for unused reader conditionals in CIDER mode.")
(defun cider--unless-local-match (value)
"Return VALUE, unless `match-string' is a local var."
(unless (or (get-text-property (point) 'cider-block-dynamic-font-lock)
(member (match-string 0)
(get-text-property (point) 'cider-locals)))
value))
(defun cider--compile-font-lock-keywords (symbols-plist core-plist)
"Return a list of font-lock rules for symbols in SYMBOLS-PLIST, CORE-PLIST."
(let ((cider-font-lock-dynamically (if (eq cider-font-lock-dynamically t)
'(function var macro core deprecated custom-1 custom-2)
cider-font-lock-dynamically))
deprecated enlightened
macros functions vars instrumented traced
custom-1
custom-2)
(cl-labels ((handle-plist
(plist)
;; Note that (memq 'function cider-font-lock-dynamically) and similar statements are evaluated differently
;; for `core' - they're always truthy for `core' (see related core-handling code some lines below):
(let ((do-function (memq 'function cider-font-lock-dynamically))
(do-var (memq 'var cider-font-lock-dynamically))
(do-custom-1 (and (memq 'custom-1 cider-font-lock-dynamically)
cider-custom-symbol-categorizer-1))
(do-custom-2 (and (memq 'custom-2 cider-font-lock-dynamically)
cider-custom-symbol-categorizer-2))
(do-macro (memq 'macro cider-font-lock-dynamically))
(do-deprecated (memq 'deprecated cider-font-lock-dynamically)))
(while plist
(let ((sym (pop plist))
(meta (pop plist)))
(pcase (nrepl-dict-get meta "cider/instrumented")
(`nil nil)
(`"\"breakpoint-if-interesting\""
(push sym instrumented))
(`"\"light-form\""
(push sym enlightened)))
;; The ::traced keywords can be inlined by MrAnderson, so
;; we catch that case too.
;; FIXME: This matches values too, not just keys.
(when (seq-find (lambda (k) (and (stringp k)
(string-match (rx "clojure.tools.trace/traced" eos) k)))
meta)
(push sym traced))
(when (and do-deprecated (nrepl-dict-get meta "deprecated"))
(push sym deprecated))
(let* ((is-custom-1 (and do-custom-1
(funcall cider-custom-symbol-categorizer-1 sym meta)))
(is-custom-2 (and do-custom-2
(funcall cider-custom-symbol-categorizer-2 sym meta)))
(is-any-custom (or is-custom-1 is-custom-2))
(is-macro (and (not is-any-custom)
(nrepl-dict-get meta "macro")))
(is-function (and (not is-any-custom)
(or (nrepl-dict-get meta "fn")
(nrepl-dict-get meta "arglists")))))
(cond ((and do-macro is-macro)
(push sym macros))
((and do-function is-function)
(push sym functions))
((and do-var
(not is-any-custom)
(not is-function)
(not is-macro))
(push sym vars))
(is-custom-1
(push sym custom-1))
(is-custom-2
(push sym custom-2)))))))))
;; For core members, we override `cider-font-lock-dynamically', since all core members should get the same treatment:
(when (memq 'core cider-font-lock-dynamically)
(let ((cider-font-lock-dynamically '(function var macro core deprecated)))
(handle-plist core-plist)))
(handle-plist symbols-plist))
`(
,@(when macros
`((,(concat (rx (or "(" "#'")) ; Can't take the value of macros.
"\\(" (regexp-opt macros 'symbols) "\\)")
1 (cider--unless-local-match font-lock-keyword-face))))
,@(when functions
`((,(regexp-opt functions 'symbols) 0
(cider--unless-local-match font-lock-function-name-face))))
,@(when vars
`((,(regexp-opt vars 'symbols) 0
(cider--unless-local-match font-lock-variable-name-face))))
,@(when deprecated
`((,(regexp-opt deprecated 'symbols) 0
(cider--unless-local-match 'cider-deprecated-face) append)))
,@(when enlightened
`((,(regexp-opt enlightened 'symbols) 0
(cider--unless-local-match 'cider-enlightened-face) append)))
,@(when instrumented
`((,(regexp-opt instrumented 'symbols) 0
(cider--unless-local-match 'cider-instrumented-face) append)))
,@(when custom-1
`((,(regexp-opt custom-1 'symbols) 0
(cider--unless-local-match 'cider-custom-face-1))))
,@(when custom-2
`((,(regexp-opt custom-2 'symbols) 0
(cider--unless-local-match 'cider-custom-face-2))))
,@(when traced
`((,(regexp-opt traced 'symbols) 0
(cider--unless-local-match 'cider-traced-face) append))))))
(defconst cider--static-font-lock-keywords
(eval-when-compile
`((,(regexp-opt '("#break" "#dbg" "#light") 'symbols) 0 font-lock-warning-face)))
"Default expressions to highlight in CIDER mode.")
(defvar-local cider--dynamic-font-lock-keywords nil)
(defun cider-refresh-dynamic-font-lock (&optional ns)
"Ensure that the current buffer has up-to-date font-lock rules.
NS defaults to `cider-current-ns', and it can also be a dict describing the
namespace itself."
(interactive)
(when (and cider-font-lock-dynamically
font-lock-mode)
(font-lock-remove-keywords nil cider--dynamic-font-lock-keywords)
(when-let* ((ns (or ns (cider-current-ns)))
(symbols (cider-resolve-ns-symbols ns)))
(setq-local cider--dynamic-font-lock-keywords
(cider--compile-font-lock-keywords
symbols (cider-resolve-ns-symbols (cider-resolve-core-ns))))
(font-lock-add-keywords nil cider--dynamic-font-lock-keywords 'end))
(font-lock-flush)))
;;; Detecting local variables
(defun cider--read-locals-from-next-sexp ()
"Return a list of all locals inside the next logical sexp."
(save-excursion
(ignore-errors
(clojure-forward-logical-sexp 1)
(let ((out nil)
(end (point)))
(forward-sexp -1)
;; FIXME: This returns locals found inside the :or clause of a
;; destructuring map.
(while (search-forward-regexp "\\_<[^:&]\\(\\sw\\|\\s_\\)*\\_>" end 'noerror)
(push (match-string-no-properties 0) out))
out))))
(defun cider--read-locals-from-bindings-vector ()
"Return a list of all locals inside the next bindings vector."
(save-excursion
(ignore-errors
(cider-start-of-next-sexp)
(when (eq (char-after) ?\[)
(forward-char 1)
(let ((out nil))
(setq out (append (cider--read-locals-from-next-sexp) out))
(while (ignore-errors (clojure-forward-logical-sexp 3)
(unless (eobp)
(forward-sexp -1)
t))
(setq out (append (cider--read-locals-from-next-sexp) out)))
out)))))
(defun cider--read-locals-from-arglist ()
"Return a list of all locals in current form's arglist(s)."
(let ((out nil))
(save-excursion
(ignore-errors
(cider-start-of-next-sexp)
;; Named fn
(when (looking-at-p "\\s_\\|\\sw")
(cider-start-of-next-sexp 1))
;; Docstring
(when (eq (char-after) ?\")
(cider-start-of-next-sexp 1))
;; Attribute map
(when (eq (char-after) ?{)
(cider-start-of-next-sexp 1))
;; The arglist
(pcase (char-after)
(?\[ (setq out (cider--read-locals-from-next-sexp)))