forked from clojure-emacs/cider
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cider-interaction.el
1567 lines (1381 loc) · 63 KB
/
cider-interaction.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-interaction.el --- IDE for Clojure -*- lexical-binding: t -*-
;; Copyright © 2012-2014 Tim King, Phil Hagelberg
;; Copyright © 2013-2014 Bozhidar Batsov, Hugo Duncan, Steve Purcell
;;
;; Author: Tim King <kingtim@gmail.com>
;; Phil Hagelberg <technomancy@gmail.com>
;; Bozhidar Batsov <bozhidar@batsov.com>
;; Hugo Duncan <hugo@hugoduncan.org>
;; Steve Purcell <steve@sanityinc.com>
;; 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:
;; Provides an Emacs Lisp client to connect to Clojure nREPL servers.
;;; Code:
(require 'cider-client)
(require 'cider-util)
(require 'cider-stacktrace)
(require 'cider-test)
(require 'cider-doc)
(require 'clojure-mode)
(require 'dash)
(require 'thingatpt)
(require 'etags)
(require 'arc-mode)
(require 'ansi-color)
(require 'cl-lib)
(require 'compile)
(require 'tramp)
(require 'button)
(require 'apropos)
(defconst cider-error-buffer "*cider-error*")
(defconst cider-doc-buffer "*cider-doc*")
(defconst cider-result-buffer "*cider-result*")
(defconst cider-apropos-buffer "*cider-apropos*")
(define-obsolete-variable-alias 'cider-use-local-resources
'cider-prefer-local-resources "0.7.0")
(defcustom cider-prefer-local-resources nil
"Prefer local resources to remote (tramp) ones when both are available."
:type 'boolean
:group 'cider)
(defcustom cider-show-error-buffer t
"Control the popup behavior of cider stacktraces.
The following values are possible t or 'always, 'except-in-repl,
'only-in-repl. Any other value, including nil, will cause the stacktrace
not to be automatically shown.
Irespective of the value of this variable, the `cider-error-buffer' is
always generated in the background. Use `cider-visit-error-buffer' to
navigate to this buffer."
:type '(choice (const :tag "always" t)
(const except-in-repl)
(const only-in-repl)
(const :tag "never" nil))
:group 'cider)
(define-obsolete-variable-alias 'cider-popup-stacktraces
'cider-show-error-buffer "0.7.0")
(defcustom cider-auto-select-error-buffer t
"Controls whether to auto-select the error popup buffer."
:type 'boolean
:group 'cider)
(defcustom cider-interactive-eval-result-prefix "=> "
"The prefix displayed in the minibuffer before a result value."
:type 'string
:group 'cider
:package-version '(cider . "0.5.0"))
(defcustom cider-switch-to-repl-command 'cider-switch-to-relevant-repl-buffer
"Select the command to be invoked when switching-to-repl.
The default option is `cider-switch-to-relevant-repl-buffer'. If
you'd like to not use smart matching of repl buffer based on
project directory, you can assign it to `cider-switch-to-current-repl-buffer'
which will use the default REPL connection."
:type 'symbol
:group 'cider)
(defcustom cider-prompt-save-file-on-load t
"Controls whether to prompt to save the file when loading a buffer."
:type 'boolean
:group 'cider
:package-version '(cider . "0.6.0"))
(defcustom cider-completion-use-context t
"When true, uses context at point to improve completion suggestions."
:type 'boolean
:group 'cider
:package-version '(cider . "0.7.0"))
(defconst cider-output-buffer "*cider-out*")
(defcustom cider-interactive-eval-output-destination 'repl-buffer
"The destination for stdout and stderr produced from interactive evaluation."
:type '(choice (const output-buffer)
(const repl-buffer))
:group 'cider
:package-version '(cider . "0.7.0"))
(defface cider-error-highlight-face
'((((supports :underline (:style wave)))
(:underline (:style wave :color "red") :inherit unspecified))
(t (:inherit font-lock-warning-face :underline t)))
"Face used to highlight compilation errors in Clojure buffers."
:group 'cider)
(defface cider-warning-highlight-face
'((((supports :underline (:style wave)))
(:underline (:style wave :color "yellow") :inherit unspecified))
(t (:inherit font-lock-warning-face :underline (:color "yellow"))))
"Face used to highlight compilation warnings in Clojure buffers."
:group 'cider)
(defvar cider-required-nrepl-ops
'("classpath" "complete" "info"
"inspect-start" "inspect-refresh"
"inspect-pop" "inspect-push" "inspect-reset"
"macroexpand" "macroexpand-1" "macroexpand-all"
"resource" "stacktrace" "toggle-trace")
"A list of nREPL ops required by CIDER to function properly.
All of them are provided by CIDER's nREPL middleware(cider-nrepl).")
(defun cider-ensure-op-supported (op)
"Check for support of middleware op OP.
Signal an error if it is not supported."
(unless (nrepl-op-supported-p op)
(error "Can't find nREPL middleware providing op \"%s\". Please, install (or update) cider-nrepl %s and restart CIDER" op cider-version)))
(defun cider-verify-required-nrepl-ops ()
"Check whether all required nREPL ops are present."
(let ((missing-ops (-remove 'nrepl-op-supported-p cider-required-nrepl-ops)))
(when missing-ops
(cider-repl-emit-interactive-output
(format "WARNING: The following required nREPL ops are not supported: \n%s\nPlease, install (or update) cider-nrepl %s and restart CIDER"
(cider-string-join missing-ops " ")
cider-version)))))
;;; Connection info
(defun cider--java-version ()
"Retrieve the underlying connection's Java version."
(cider-eval-and-get-value "(System/getProperty \"java.version\")"))
(defun cider--clojure-version ()
"Retrieve the underlying connection's Clojure version."
(cider-eval-and-get-value "(clojure-version)"))
(defun cider--nrepl-version ()
"Retrieve the underlying connection's nREPL version."
(cider-eval-and-get-value "(:version-string clojure.tools.nrepl/version)"))
(defun cider--nrepl-middleware-version ()
"Retrieve the underlying connection's CIDER nREPL version."
(cider-eval-and-get-value "(try (require 'cider.nrepl)
(:version-string @(resolve 'cider.nrepl/version))
(catch Throwable _ \"not installed\"))"))
(defun cider--connection-info (connection-buffer)
"Return info about CONNECTION-BUFFER.
Info contains project name, current REPL namespace, host:port
endpoint and Clojure version."
(with-current-buffer (get-buffer connection-buffer)
(format "Active nREPL connection: %s:%s, %s:%s (Java %s, Clojure %s, nREPL %s, cider-nrepl %s)"
(or (nrepl--project-name nrepl-project-dir) "<no project>")
nrepl-buffer-ns
(car nrepl-endpoint)
(cadr nrepl-endpoint)
(cider--java-version)
(cider--clojure-version)
(cider--nrepl-version)
(cider--nrepl-middleware-version))))
(defun cider-display-current-connection-info ()
"Display information about the current connection."
(interactive)
(message (cider--connection-info (nrepl-current-connection-buffer))))
(defun cider-rotate-connection ()
"Rotate and display the current nREPL connection."
(interactive)
(cider-ensure-connected)
(setq nrepl-connection-list
(append (cdr nrepl-connection-list)
(list (car nrepl-connection-list))))
(message (cider--connection-info (car nrepl-connection-list))))
(defun cider-extract-designation-from-current-repl-buffer ()
"Extract the designation from the cider repl buffer name."
(let ((repl-buffer-name (cider-current-repl-buffer))
(template (split-string nrepl-repl-buffer-name-template "%s")))
(string-match (format "^%s\\(.*\\)%s"
(regexp-quote (concat (car template) nrepl-buffer-name-separator))
(regexp-quote (cadr template)))
repl-buffer-name)
(or (match-string 1 repl-buffer-name) "<no designation>")))
(defun cider-change-buffers-designation ()
"Changes the designation in cider buffer names.
Buffer names changed are cider-repl, nrepl-connection and nrepl-server."
(interactive)
(cider-ensure-connected)
(let* ((designation (read-string (format "Change CIDER buffer designation from '%s': "
(cider-extract-designation-from-current-repl-buffer))))
(new-repl-buffer-name (nrepl-format-buffer-name-template
nrepl-repl-buffer-name-template designation)))
(with-current-buffer (cider-current-repl-buffer)
(rename-buffer new-repl-buffer-name))
(with-current-buffer (nrepl-current-connection-buffer)
(setq-local nrepl-repl-buffer new-repl-buffer-name)
(let ((new-connection-buffer-name (nrepl-format-buffer-name-template
nrepl-connection-buffer-name-template designation)))
(rename-buffer new-connection-buffer-name)
(setq nrepl-connection-list
(cons new-connection-buffer-name (cdr nrepl-connection-list)))
(with-current-buffer (cider-current-repl-buffer)
(setq-local nrepl-connection-buffer new-connection-buffer-name))
(when nrepl-server-buffer
(let ((new-server-buffer-name (nrepl-format-buffer-name-template
nrepl-server-buffer-name-template designation)))
(with-current-buffer nrepl-server-buffer
(rename-buffer new-server-buffer-name))
(setq-local nrepl-server-buffer new-server-buffer-name)))))
(message "CIDER buffer designation changed to: %s" designation)))
;;; Switching between REPL & source buffers
(defvar-local cider-last-clojure-buffer nil
"A buffer-local variable holding the last Clojure source buffer.
`cider-switch-to-last-clojure-buffer' uses this variable to jump
back to last Clojure source buffer.")
(defvar cider-current-clojure-buffer nil
"This variable holds current buffer temporarily when connecting to a REPL.
It is set to current buffer when `cider' or `cider-jack-in' is called.
After the REPL buffer is created, the value of this variable is used
to call `cider-remember-clojure-buffer'.")
(defun cider-remember-clojure-buffer (buffer)
"Try to remember the BUFFER from which the user jumps.
The BUFFER needs to be a Clojure buffer and current major mode needs
to be `cider-repl-mode'. The user can use `cider-switch-to-last-clojure-buffer'
to jump back to the last Clojure source buffer."
(when (and buffer
(with-current-buffer buffer
(derived-mode-p 'clojure-mode))
(derived-mode-p 'cider-repl-mode))
(setq cider-last-clojure-buffer buffer)))
(defun cider-switch-to-repl-buffer (&optional arg)
"Invoke `cider-switch-to-repl-command'."
(interactive "p")
(funcall cider-switch-to-repl-command arg))
(defun cider-switch-to-current-repl-buffer (&optional arg)
"Select the REPL buffer, when possible in an existing window.
Hint: You can use `display-buffer-reuse-frames' and
`special-display-buffer-names' to customize the frame in which
the buffer should appear.
With a prefix ARG sets the namespace in the REPL buffer to that
of the namespace in the Clojure source buffer."
(interactive "p")
(cider-ensure-connected)
(let ((buffer (current-buffer)))
(when (eq 4 arg)
(cider-repl-set-ns (cider-current-ns)))
(pop-to-buffer (cider-find-or-create-repl-buffer))
(cider-remember-clojure-buffer buffer)
(goto-char (point-max))))
(defun cider-find-connection-buffer-for-project-directory (project-directory)
"Find the relevant connection-buffer for the given PROJECT-DIRECTORY.
A check is made to ensure that all connection buffers have a project-directory
otherwise there is ambiguity as to which connection buffer should be selected.
If there are multiple connection buffers matching PROJECT-DIRECTORY there
is ambiguity, therefore nil is returned."
(unless (-filter
(lambda (conn)
(not
(with-current-buffer (get-buffer conn)
nrepl-project-dir)))
nrepl-connection-list)
(let ((matching-connections
(-filter
(lambda (conn)
(let ((conn-proj-dir (with-current-buffer (get-buffer conn)
nrepl-project-dir)))
(when conn-proj-dir
(equal (file-truename project-directory)
(file-truename conn-proj-dir)))))
nrepl-connection-list)))
(when (= 1 (length matching-connections))
(car matching-connections)))))
(defun cider-switch-to-relevant-repl-buffer (&optional arg)
"Select the REPL buffer, when possible in an existing window.
The buffer chosen is based on the file open in the current buffer.
If the REPL buffer cannot be unambiguously determined, the REPL
buffer is chosen based on the current connection buffer and a
message raised informing the user.
Hint: You can use `display-buffer-reuse-frames' and
`special-display-buffer-names' to customize the frame in which
the buffer should appear.
With a prefix ARG sets the namespace in the REPL buffer to that
of the namespace in the Clojure source buffer.
With a second prefix ARG the chosen REPL buffer is based on a
supplied project directory."
(interactive "p")
(cider-ensure-connected)
(let* ((project-directory
(or (when (eq 16 arg) (read-directory-name "Project: "))
(nrepl-project-directory-for (nrepl-current-dir))))
(connection-buffer
(or
(and (= 1 (length nrepl-connection-list)) (car nrepl-connection-list))
(and project-directory
(cider-find-connection-buffer-for-project-directory project-directory)))))
(when connection-buffer
(setq nrepl-connection-list
(cons connection-buffer (delq connection-buffer nrepl-connection-list))))
(cider-switch-to-current-repl-buffer arg)
(message
(format (if connection-buffer
"Switched to REPL: %s"
"Could not determine relevant nREPL connection, using: %s")
(with-current-buffer (nrepl-current-connection-buffer)
(format "%s:%s, %s:%s"
(or (nrepl--project-name nrepl-project-dir) "<no project>")
nrepl-buffer-ns
(car nrepl-endpoint)
(cadr nrepl-endpoint)))))))
(defun cider-switch-to-last-clojure-buffer ()
"Switch to the last Clojure buffer.
The default keybinding for this command is
the same as `cider-switch-to-repl-buffer',
so that it is very convenient to jump between a
Clojure buffer and the REPL buffer."
(interactive)
(if (and (derived-mode-p 'cider-repl-mode)
(buffer-live-p cider-last-clojure-buffer))
(pop-to-buffer cider-last-clojure-buffer)
(message "Don't know the original Clojure buffer")))
(defun cider-find-and-clear-repl-buffer ()
"Find the current REPL buffer and clear it.
Returns to the buffer in which the command was invoked."
(interactive)
(let ((origin-buffer (current-buffer)))
(switch-to-buffer (cider-current-repl-buffer))
(cider-repl-clear-buffer)
(switch-to-buffer origin-buffer)))
;;; Minibuffer eval
(defvar cider-minibuffer-history '()
"History list of expressions read from the minibuffer.")
(defvar cider-minibuffer-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map minibuffer-local-map)
(define-key map "TAB" 'complete-symbol)
(define-key map "M-TAB" 'complete-symbol)
map)
"Minibuffer keymap used for reading Clojure expressions.")
(defun cider-read-from-minibuffer (prompt &optional initial-value)
"Read a string from the minibuffer, prompting with PROMPT.
If INITIAL-VALUE is non-nil, it is inserted into the minibuffer before
reading input."
(minibuffer-with-setup-hook
(lambda ()
(add-hook 'completion-at-point-functions
#'cider-complete-at-point nil t)
(run-hooks 'eval-expression-minibuffer-setup-hook))
(read-from-minibuffer prompt initial-value
cider-minibuffer-map nil
cider-minibuffer-history)))
(defun cider-read-and-eval ()
"Read a sexp from the minibuffer and output its result to the echo area."
(interactive)
(cider-interactive-eval (cider-read-from-minibuffer "CIDER Eval: ")))
;;; Eval
(defun cider-eval-region (start end)
"Evaluate the region.
The two arguments START and END are character positions;
they can be in either order."
(interactive "r")
(cider-interactive-eval (buffer-substring-no-properties start end)))
(defun cider-eval-buffer ()
"Evaluate the current buffer."
(interactive)
(cider-eval-region (point-min) (point-max)))
(defun cider-defun-at-point ()
"Return the text of the top-level sexp at point."
(apply #'buffer-substring-no-properties
(cider--region-for-defun-at-point)))
(defun cider--region-for-defun-at-point ()
"Return the start and end position of defun at point."
(save-excursion
(save-match-data
(end-of-defun)
(let ((end (point)))
(beginning-of-defun)
(list (point) end)))))
(defun cider-eval-defun-at-point (&optional prefix)
"Evaluate the current toplevel form, and print result in the minibuffer.
With a PREFIX argument, print the result in the current buffer."
(interactive "P")
(let ((form (cider-defun-at-point)))
(if prefix
(cider-interactive-eval-print form)
(cider-interactive-eval form))))
(defun cider-ns-form ()
"Retrieve the ns form."
(when (clojure-find-ns)
(save-excursion
(goto-char (match-beginning 0))
(cider-defun-at-point))))
(defun cider-eval-ns-form ()
"Evaluate the current buffer's namespace form."
(interactive)
(when (clojure-find-ns)
(save-excursion
(goto-char (match-beginning 0))
(cider-eval-defun-at-point))))
(defun cider-bounds-of-sexp-at-point ()
"Return the bounds sexp at point as a pair (or nil)."
(or (and (equal (char-after) ?\()
(member (char-before) '(?\' ?\, ?\@))
;; hide stuff before ( to avoid quirks with '( etc.
(save-restriction
(narrow-to-region (point) (point-max))
(bounds-of-thing-at-point 'sexp)))
(bounds-of-thing-at-point 'sexp)))
;; FIXME: This doesn't have properly at the beginning of the REPL prompt
(defun cider-symbol-at-point ()
"Return the name of the symbol at point, otherwise nil."
(let ((str (substring-no-properties (or (thing-at-point 'symbol) ""))))
(if (equal str (concat (cider-find-ns) "> "))
""
str)))
(defun cider-sexp-at-point ()
"Return the sexp at point as a string, otherwise nil."
(let ((bounds (cider-bounds-of-sexp-at-point)))
(if bounds
(buffer-substring-no-properties (car bounds)
(cdr bounds)))))
(defun cider-sexp-at-point-with-bounds ()
"Return a list containing the sexp at point and its bounds."
(let ((bounds (cider-bounds-of-sexp-at-point)))
(if bounds
(let ((start (car bounds))
(end (cdr bounds)))
(list (buffer-substring-no-properties start end)
(cons (set-marker (make-marker) start)
(set-marker (make-marker) end)))))))
(defun cider-last-sexp ()
"Return the sexp preceding the point."
(buffer-substring-no-properties
(save-excursion
(backward-sexp)
(point))
(point)))
;;;
(defun cider-tramp-prefix (&optional buffer)
"Use the filename for BUFFER to determine a tramp prefix.
Defaults to the current buffer.
Return the tramp prefix, or nil if BUFFER is local."
(let* ((buffer (or buffer (current-buffer)))
(name (buffer-file-name buffer)))
(when (tramp-tramp-file-p name)
(let ((vec (tramp-dissect-file-name name)))
(tramp-make-tramp-file-name (tramp-file-name-method vec)
(tramp-file-name-user vec)
(tramp-file-name-host vec)
nil)))))
(defun cider--client-tramp-filename (name &optional buffer)
"Return the tramp filename for path NAME relative to BUFFER.
If BUFFER has a tramp prefix, it will be added as a prefix to NAME.
If the resulting path is an existing tramp file, it returns the path,
otherwise, nil."
(let* ((buffer (or buffer (current-buffer)))
(name (concat (cider-tramp-prefix buffer) name)))
(if (tramp-handle-file-exists-p name)
name)))
(defun cider--server-filename (name)
"Return the nREPL server-relative filename for NAME."
(if (tramp-tramp-file-p name)
(with-parsed-tramp-file-name name nil
localname)
name))
(defun cider--file-path (path)
"Return PATH's local or tramp path using `cider-prefer-local-resources'.
If no local or remote file exists, return nil."
(let ((local-path path)
(tramp-path (and path (cider--client-tramp-filename path))))
(cond ((equal path "") "")
((and cider-prefer-local-resources (file-exists-p local-path))
local-path)
((file-exists-p tramp-path)
tramp-path)
((file-exists-p local-path)
local-path))))
(defun cider--url-to-file (url)
"Return the filename from the resource URL.
Uses `url-generic-parse-url' to parse the url. The filename is extracted and
then url decoded. If the decoded filename has a Windows device letter followed
by a colon immediately after the leading '/' then the leading '/' is dropped to
create a valid path."
(let ((filename (url-unhex-string (url-filename (url-generic-parse-url url)))))
(if (string-match "^/\\([a-zA-Z]:/.*\\)" filename)
(match-string 1 filename)
filename)))
(defun cider-find-file (url)
"Return a buffer visiting the file URL if it exists, or nil otherwise.
The argument should have a scheme prefix, and represent a fully-qualified file
path or an entry within a zip/jar archive."
(cond ((string-match "^file:\\(.+\\)" url)
(-when-let* ((file (cider--url-to-file (match-string 1 url)))
(path (cider--file-path file)))
(find-file-noselect path)))
((string-match "^\\(jar\\|zip\\):\\(file:.+\\)!/\\(.+\\)" url)
(-when-let* ((entry (match-string 3 url))
(file (cider--url-to-file (match-string 2 url)))
(path (cider--file-path file))
(name (format "%s:%s" path entry)))
(or (get-file-buffer name)
(with-current-buffer (generate-new-buffer
(file-name-nondirectory entry))
(archive-zip-extract path entry)
(set-visited-file-name name)
(setq-local default-directory (file-name-directory path))
(setq-local buffer-read-only t)
(set-buffer-modified-p nil)
(set-auto-mode)
(current-buffer)))))))
(defun cider-find-var (var)
"Return a buffer visiting the definition for VAR, or nil if not found."
(cider-ensure-op-supported "info")
(-when-let* ((info (cider-var-info var))
(file (cadr (assoc "file" info)))
(line (cadr (assoc "line" info)))
(buffer (cider-find-file file)))
(with-current-buffer buffer
(goto-line line)
buffer)))
(defun cider-jump-to (buffer &optional line)
"Push current point onto marker ring, and jump to BUFFER, optionally at LINE.
`cider-mode' is enabled on BUFFER to ensure `cider-jump' and `cider-jump-back'
are available."
(ring-insert find-tag-marker-ring (point-marker))
(with-current-buffer buffer
(goto-line (or line 1))
(cider-mode +1))
(switch-to-buffer buffer))
(defun cider-jump-to-resource (path &optional line)
"Jump to the resource at the relative PATH, optionally at a specific LINE.
When called interactively, this operates on point."
(interactive (list (thing-at-point 'filename)))
(cider-ensure-op-supported "resource")
(-if-let* ((resource (-> (list "op" "resource" "name" path)
(nrepl-send-request-sync)
(plist-get :value)))
(buffer (cider-find-file resource)))
(cider-jump-to buffer line)
(message "Cannot find resource %s" path)))
(defun cider-jump-to-var (var &optional line)
"Jump to the definition of VAR, optionally at a specific LINE.
When called interactively, this operates on point, or falls back to a prompt."
(interactive (list (cider-read-symbol-name "Symbol: " 'identity)))
(cider-ensure-op-supported "info")
(-if-let (info (cider-var-info var))
(-if-let* ((file (cadr (assoc "file" info)))
(line (or line (cadr (assoc "line" info))))
(buffer (cider-find-file file)))
(cider-jump-to buffer line)
(message "No source available for %s" var))
(message "Symbol %s not resolved" var)))
(defalias 'cider-jump 'cider-jump-to-var)
(defalias 'cider-jump-back 'pop-tag-mark)
(defvar cider-completion-last-context nil)
(defun cider-completion-symbol-start-pos ()
"Find the starting position of the symbol at point, unless inside a string."
(let ((sap (symbol-at-point)))
(when (and sap (not (in-string-p)))
(car (bounds-of-thing-at-point 'symbol)))))
(defun cider-completion-get-context-at-point ()
"Extract the context at point.
If point is not inside the list, returns nil; otherwise return top-level
form, with symbol at point replaced by __prefix__."
(when (save-excursion
(condition-case foo
(progn
(up-list)
(check-parens)
t)
(scan-error nil)
(user-error nil)))
(save-excursion
(let* ((pref-end (point))
(pref-start (cider-completion-symbol-start-pos))
(context (cider-defun-at-point))
(_ (beginning-of-defun))
(expr-start (point)))
(concat (substring context 0 (- pref-start expr-start))
"__prefix__"
(substring context (- pref-end expr-start)))))))
(defun cider-completion-get-context ()
"Extract context depending on `cider-completion-use-context' and major mode."
(let ((context (if (and cider-completion-use-context
;; Important because `beginning-of-defun' and
;; `ending-of-defun' work incorrectly in the REPL
;; buffer, so context extraction fails there.
(not (eq major-mode 'cider-repl-buffer)))
(or (cider-completion-get-context-at-point)
"nil")
"nil")))
(if (string= cider-completion-last-context context)
":same"
(setq cider-completion-last-context context)
context)))
(defun cider-complete (str)
"Return a list of completions for STR using nREPL's \"complete\" op."
(cider-ensure-op-supported "complete")
(let ((strlst (plist-get
(nrepl-send-request-sync
(list "op" "complete"
"session" (nrepl-current-session)
"ns" nrepl-buffer-ns
"symbol" str
"context" (cider-completion-get-context)))
:value)))
(when strlst
strlst)))
(defun cider-complete-at-point ()
"Complete the symbol at point."
(let ((sap (symbol-at-point)))
(when (and sap (not (in-string-p)))
(let ((bounds (bounds-of-thing-at-point 'symbol)))
(list (car bounds) (cdr bounds)
(completion-table-dynamic #'cider-complete)
:company-doc-buffer #'cider-create-doc-buffer
:company-location #'cider-company-location
:company-docsig #'cider-company-docsig)))))
(defun cider-company-location (var)
"Open VAR's definition in a buffer.
Returns the cons of the buffer itself and the location of VAR's definition
in the buffer."
(-when-let (buffer (cider-find-var var))
(with-current-buffer buffer
(cons buffer (point)))))
(defun cider-company-docsig (thing)
"Return signature for THING."
(let ((arglist (cider-eldoc-arglist thing)))
(when arglist
(format "%s: %s"
(cider-eldoc-format-thing thing)
arglist))))
(defun cider-javadoc-handler (symbol-name)
"Invoke the nREPL \"info\" op on SYMBOL-NAME if available."
(when symbol-name
(cider-ensure-op-supported "info")
(let* ((info (cider-var-info symbol-name))
(url (cadr (assoc "javadoc" info))))
(if url
(browse-url url)
(error "No Javadoc available for %s" symbol-name)))))
(defun cider-javadoc (query)
"Browse Javadoc on the Java symbol QUERY at point."
(interactive "P")
(cider-read-symbol-name "Javadoc for: " 'cider-javadoc-handler query))
(defun cider-stdin-handler (buffer)
"Make a stdin response handler for BUFFER."
(nrepl-make-response-handler buffer
(lambda (buffer value)
(cider-repl-emit-result buffer value t))
(lambda (buffer out)
(cider-repl-emit-output buffer out t))
(lambda (buffer err)
(cider-repl-emit-output buffer err t))
nil))
(defun cider-insert-eval-handler (buffer)
"Make a nREPL evaluation handler for the BUFFER.
The handler simply inserts the result value in BUFFER."
(nrepl-make-response-handler buffer
(lambda (_buffer value)
(with-current-buffer buffer
(insert value)))
(lambda (_buffer out)
(cider-repl-emit-interactive-output out))
(lambda (buffer err)
(message "%s" err)
(cider-highlight-compilation-errors
buffer err))
'()))
(defun cider-emit-interactive-eval-output (output)
"Emit standard or error output resulting from interactive code evaluation.
The output can be send to either a dedicated output buffer or the current REPL buffer.
This is controlled via `cider-interactive-eval-output-destination'."
(pcase cider-interactive-eval-output-destination
(`output-buffer (let ((output-buffer (or (get-buffer cider-output-buffer)
(cider-popup-buffer cider-output-buffer t))))
(cider-emit-into-popup-buffer output-buffer output)
(pop-to-buffer output-buffer)))
(`repl-buffer (cider-repl-emit-interactive-output output))
(t (error "Unsupported value %s for `cider-interactive-eval-output'"))))
(defun cider-interactive-eval-handler (buffer)
"Make an interactive eval handler for BUFFER."
(nrepl-make-response-handler buffer
(lambda (_buffer value)
(message "%s%s"
cider-interactive-eval-result-prefix
(cider-font-lock-as-clojure value)))
(lambda (_buffer out)
(cider-emit-interactive-eval-output out))
(lambda (buffer err)
(cider-emit-interactive-eval-output err)
(cider-highlight-compilation-errors
buffer err))
'()))
(defun cider-load-file-handler (buffer)
"Make a load file handler for BUFFER."
(nrepl-make-response-handler buffer
(lambda (buffer value)
(message "%s" value)
(with-current-buffer buffer
(setq nrepl-buffer-ns (clojure-find-ns))
(run-hooks 'cider-file-loaded-hook)))
(lambda (_buffer value)
(cider-emit-interactive-eval-output value))
(lambda (buffer err)
(cider-emit-interactive-eval-output err)
(cider-highlight-compilation-errors
buffer err))
'()
(lambda (buffer ex root-ex session)
(funcall nrepl-err-handler
buffer ex root-ex session))))
(defun cider-interactive-eval-print-handler (buffer)
"Make a handler for evaluating and printing result in BUFFER."
(nrepl-make-response-handler buffer
(lambda (buffer value)
(with-current-buffer buffer
(insert (format "\n%s" value))))
(lambda (_buffer out)
(cider-emit-interactive-eval-output out))
(lambda (_buffer err)
(cider-emit-interactive-eval-output err))
'()))
(defun cider-popup-eval-print-handler (buffer)
"Make a handler for evaluating and printing result in popup BUFFER."
(nrepl-make-response-handler buffer
(lambda (buffer str)
(cider-emit-into-popup-buffer buffer str))
'()
(lambda (buffer str)
(cider-emit-into-popup-buffer buffer str))
'()))
(defun cider-popup-eval-out-handler (buffer)
"Make a handler for evaluating and printing stdout/stderr in popup BUFFER."
(nrepl-make-response-handler buffer
'()
(lambda (buffer str)
(cider-emit-into-popup-buffer buffer str))
(lambda (buffer str)
(cider-emit-into-popup-buffer buffer str))
'()))
(defun cider-visit-error-buffer ()
"Visit the `cider-error-buffer' (usually *cider-error*) if it exists."
(interactive)
(let ((buffer (get-buffer cider-error-buffer)))
(if buffer
(cider-popup-buffer-display buffer cider-auto-select-error-buffer)
(error "No %s buffer" cider-error-buffer))))
(defun cider-find-property (property &optional backward)
"Find the next text region which has the specified PROPERTY.
If BACKWARD is t, then search backward.
Returns the position at which PROPERTY was found, or nil if not found."
(let ((p (if backward
(previous-single-char-property-change (point) property)
(next-single-char-property-change (point) property))))
(when (and (not (= p (point-min))) (not (= p (point-max))))
p)))
(defun cider-jump-to-compilation-error (&optional _arg _reset)
"Jump to the line causing the current compilation error.
_ARG and _RESET are ignored, as there is only ever one compilation error.
They exist for compatibility with `next-error'."
(interactive)
(cl-labels ((goto-next-note-boundary
()
(let ((p (or (cider-find-property 'cider-note-p)
(cider-find-property 'cider-note-p t))))
(when p
(goto-char p)
(message (get-char-property p 'cider-note))))))
;; if we're already on a compilation error, first jump to the end of
;; it, so that we find the next error.
(when (get-char-property (point) 'cider-note-p)
(goto-next-note-boundary))
(goto-next-note-boundary)))
(defun cider-default-err-eval-handler (buffer session)
"Display in BUFFER the last SESSION exception, without middleware support."
(cider-eval "(clojure.stacktrace/print-cause-trace *e)"
(lambda (response)
(nrepl-dbind-response response (out)
(when out
(with-current-buffer buffer
(cider-emit-into-color-buffer buffer out)
(compilation-minor-mode +1)))))
nil
session))
(defun cider-default-err-op-handler (buffer session)
"Display in BUFFER the last SESSION exception, with middleware support."
(let (causes)
(nrepl-send-request
(list "op" "stacktrace" "session" session)
(lambda (response)
(nrepl-dbind-response response (class status)
(cond (class (setq causes (cons response causes)))
(status (when causes
(cider-stacktrace-render buffer (reverse causes))))))))))
(defun cider-default-err-handler (buffer ex root-ex session)
"Make an error handler for BUFFER, EX, ROOT-EX and SESSION.
This function determines how the error buffer is shown, and then delegates
the actual error content to the eval or op handler."
(let* ((replp (with-current-buffer buffer (derived-mode-p 'cider-repl-mode)))
(showp (memq cider-show-error-buffer
(if replp
'(t always only-in-repl)
'(t always except-in-repl))))
(error-buffer (if (not showp)
(cider-make-popup-buffer cider-error-buffer)
(cider-popup-buffer cider-error-buffer
cider-auto-select-error-buffer))))
(if (nrepl-op-supported-p "stacktrace")
(cider-default-err-op-handler error-buffer session)
(cider-default-err-eval-handler error-buffer session))))
(defvar cider-compilation-regexp
'("\\(?:.*\\(warning, \\)\\|.*?\\(, compiling\\):(\\)\\([^:]*\\):\\([[:digit:]]+\\)\\(?::\\([[:digit:]]+\\)\\)?\\(\\(?: - \\(.*\\)\\)\\|)\\)" 3 4 5 (1))
"Specifications for matching errors and warnings in Clojure stacktraces.
See `compilation-error-regexp-alist' for help on their format.")
(add-to-list 'compilation-error-regexp-alist-alist
(cons 'cider cider-compilation-regexp))
(add-to-list 'compilation-error-regexp-alist 'cider)
(defun cider-extract-error-info (regexp message)
"Extract error information with REGEXP against MESSAGE."
(let ((file (nth 1 regexp))
(line (nth 2 regexp))
(col (nth 3 regexp))
(type (nth 4 regexp))
(pat (car regexp)))
(when (string-match pat message)
;; special processing for type (1.2) style
(setq type (if (consp type)
(or (and (car type) (match-end (car type)) 1)
(and (cdr type) (match-end (cdr type)) 0)
2)))
(list
(when file
(let ((val (match-string-no-properties file message)))
(unless (string= val "NO_SOURCE_PATH") val)))
(when line (string-to-number (match-string-no-properties line message)))
(when col
(let ((val (match-string-no-properties col message)))
(when val (string-to-number val))))
(aref [cider-warning-highlight-face
cider-warning-highlight-face
cider-error-highlight-face]
(or type 2))
message))))
(defun cider-highlight-compilation-errors (buffer message)
"Highlight compilation error line in BUFFER, using MESSAGE."
(with-current-buffer buffer
(let ((info (cider-extract-error-info cider-compilation-regexp message)))
(when info
(let ((file (nth 0 info))
(line (nth 1 info))
(col (nth 2 info))
(face (nth 3 info))
(note (nth 4 info)))
(save-excursion
;; when we don't have a filename or it's different from the one of
;; the current buffer, the line number is relative to form start
(if (and file (equal file (file-truename (buffer-file-name))))
(goto-char (point-min)) ; start of file
(beginning-of-defun))
(forward-line (1- line))
;; if have column, highlight sexp at that point otherwise whole line.
(move-to-column (or col 0))
(let ((begin (progn (if col (backward-up-list) (back-to-indentation)) (point)))
(end (progn (if col (forward-sexp) (move-end-of-line nil)) (point))))
(let ((overlay (make-overlay begin end)))
(overlay-put overlay 'cider-note-p t)
(overlay-put overlay 'face face)
(overlay-put overlay 'cider-note note)
(overlay-put overlay 'help-echo note)))))))))
(defun cider-need-input (buffer)
"Handle an need-input request from BUFFER."
(with-current-buffer buffer
(nrepl-send-stdin (concat (read-from-minibuffer "Stdin: ") "\n")
(cider-stdin-handler buffer))))
;;;; Popup buffers
(define-minor-mode cider-popup-buffer-mode
"Mode for CIDER popup buffers"
nil
(" cider-tmp")
'(("q" . cider-popup-buffer-quit-function)))
(defvar-local cider-popup-buffer-quit-function 'cider-popup-buffer-quit
"The function that is used to quit a temporary popup buffer.")
(defun cider-popup-buffer-quit-function (&optional kill-buffer-p)