-
-
Notifications
You must be signed in to change notification settings - Fork 76
/
helm-ag.el
1452 lines (1300 loc) · 59.3 KB
/
helm-ag.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
;;; helm-ag.el --- The silver searcher with helm interface -*- lexical-binding: t; -*-
;; Copyright (C) 2017 Syohei YOSHIDA
;; Copyright (C) 2020-2024 Shen, Jen-Chieh
;; Author: Syohei YOSHIDA <syohex@gmail.com>
;; Maintainer: Jen-Chieh Shen <jcs090218@gmail.com>
;; URL: https://github.com/syohex/emacs-helm-ag
;; Version: 0.64
;; Package-Requires: ((emacs "27.1") (helm "2.0"))
;; This program is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; helm-ag provides interfaces of the silver searcher(Other search programs can be used
;; such as the platinum searcher, ack). And helm-ag provides wgrep like features which
;; users can edit from searched result.
;;; Code:
(eval-when-compile
(require 'grep)
(defvar helm-help-message))
(require 'cl-lib)
(require 'helm)
(require 'helm-grep)
(require 'helm-occur)
(require 'helm-utils)
(require 'compile)
(require 'subr-x)
(declare-function helm-read-file-name "helm-mode")
(declare-function helm-grep-get-file-extensions "helm-grep")
(declare-function helm-help "helm-help")
(defgroup helm-ag nil
"The silver searcher with helm interface."
:group 'helm)
(defsubst helm-ag--windows-p ()
"Check `ag' available window."
(memq system-type '(ms-dos windows-nt)))
(defcustom helm-ag-base-command
(if (helm-ag--windows-p)
"ag --vimgrep"
"ag --nocolor --nogroup")
"Base command of `ag'."
:type 'string
:group 'helm-ag)
(defcustom helm-ag-command-option nil
"Command line option of `ag'. This is appended after `helm-ag-base-command'."
:type 'string
:group 'helm-ag)
(defcustom helm-ag-success-exit-status nil
"Allows specifying the return code or codes of `helm-ag-base-command' that \
will be treated as successful."
:type '(choice integer
(list integer)))
(defcustom helm-ag-insert-at-point nil
"Insert thing at point as search pattern.
You can set value same as `thing-at-point'"
:type 'symbol
:group 'helm-ag)
(defcustom helm-ag-ignore-patterns nil
"Ignore patterns for `ag'. This parameters are specified as --ignore."
:type '(repeat string))
(defcustom helm-ag-use-grep-ignore-list nil
"Use `grep-find-ignored-files' and `grep-find-ignored-directories' as \
ignore pattern.
They are specified to `--ignore' options."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-always-set-extra-option nil
"Always set `ag' options of `helm-do-ag'."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-fuzzy-match nil
"Enable fuzzy match."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-edit-save t
"Save buffers you edit at completed."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-use-emacs-lisp-regexp nil
"[Experimental] Use Emacs Lisp regexp instead of PCRE."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-use-agignore nil
"Use .agignore where is at project root if it exists."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-use-temp-buffer nil
"Use temporary buffer for persistent action."
:type 'boolean
:group 'helm-ag)
(defcustom helm-ag-ignore-buffer-patterns nil
"Use temporary buffer for persistent action."
:type '(repeat regexp)
:group 'helm-ag)
(defcustom helm-ag-show-status-function 'helm-ag-show-status-default-mode-line
"Function called after that `ag' process is finished after `helm-do-ag'.
Default behaviour shows finish and result in mode-line."
:type 'function
:group 'helm-ag)
(defface helm-ag-edit-deleted-line
'((t (:inherit font-lock-comment-face :strike-through t)))
"Face of deleted line in edit mode.")
(defvar helm-ag--command-history '())
(defvar helm-ag--helm-history '())
(defvar helm-ag--context-stack nil)
(defvar helm-ag--default-directory nil)
(defvar helm-ag--last-default-directory nil)
(defvar helm-ag--last-query nil)
(defvar helm-ag--last-command nil)
(defvar helm-ag--elisp-regexp-query nil)
(defvar helm-ag--valid-regexp-for-emacs nil)
(defvar helm-ag--extra-options nil)
(defvar helm-ag--extra-options-history nil)
(defvar helm-ag--original-window nil)
(defvar helm-ag--search-this-file-p nil)
(defvar helm-ag--default-target nil)
(defvar helm-ag--buffer-search nil)
(defvar helm-ag--command-features '())
(defvar helm-ag--ignore-case nil)
(defvar helm-do-ag--extensions nil)
(defvar helm-do-ag--commands nil)
(defun helm-ag--ignore-case-p (cmds input)
"Determine if search should be case-insensitive based on CMDS and INPUT."
(cl-loop for cmd in cmds
when (member cmd '("-i" "--ignore-case"))
return t
when (member cmd '("-s" "--case-sensitive"))
return nil
finally
return (let ((case-fold-search nil))
(not (string-match-p "[A-Z]" input)))))
(defun helm-ag--save-current-context ()
"Save the current buffer context (file and position) to `helm-ag--context-stack'."
(let ((curpoint (with-helm-current-buffer
(point))))
(helm-aif (buffer-file-name helm-current-buffer)
(push (list :file it :point curpoint) helm-ag--context-stack)
(push (list :buffer helm-current-buffer :point curpoint) helm-ag--context-stack))))
(defun helm-ag--insert-thing-at-point (thing)
"Retrieve the text at the point for a specified THING and insert it."
(helm-aif (thing-at-point thing)
(substring-no-properties it)
""))
(defun helm-ag--searched-word ()
"Return the word to be searched based on `helm-ag-insert-at-point'."
(if helm-ag-insert-at-point
(helm-ag--insert-thing-at-point helm-ag-insert-at-point)
""))
(defun helm-ag--construct-ignore-option (pattern)
"Construct an `ag' ignore option string using PATTERN."
(concat "--ignore=" pattern))
(defun helm-ag--grep-ignore-list-to-options ()
"Generate a list of `ag' ignore options from `grep' ignored files and directories."
(require 'grep)
(cl-loop for ignore in (append grep-find-ignored-files
grep-find-ignored-directories)
collect (helm-ag--construct-ignore-option ignore)))
(defun helm-ag--parse-options-and-query (input)
"Parse command-line options and search query from INPUT.
E.g. Given INPUT = \"--ignore-case --context 5 error\",
returns '((\"--ignore-case\" \"--context\") . \"5 error\")."
(with-temp-buffer
(insert input)
(let (end options)
(goto-char (point-min))
(when (re-search-forward "\\s-*--\\s-+" nil t)
(setq end (match-end 0)))
(goto-char (point-min))
(while (re-search-forward "\\(?:\\=\\|\\s-+\\)\\(-\\S-+\\)\\(?:\\s-+\\|$\\)" end t)
(push (match-string-no-properties 1) options)
(when end
(cl-decf end (- (match-end 0) (match-beginning 0))))
(replace-match ""))
(cons options (buffer-string)))))
(defun helm-ag--parse-query (input)
"Parse command-line search query and options, applying regexp conversions.
E.g. Given INPUT = \"--ignore-case error\",
returns '(\"--ignore-case\" \"error\")."
(let* ((parsed (helm-ag--parse-options-and-query input))
(options (car parsed))
(query (cdr parsed)))
(when helm-ag-use-emacs-lisp-regexp
(setq query (helm-ag--elisp-regexp-to-pcre query)))
(setq helm-ag--last-query query
helm-ag--elisp-regexp-query (helm-ag--convert-to-elisp-regexp query))
(setq helm-ag--valid-regexp-for-emacs
(helm-ag--validate-regexp helm-ag--elisp-regexp-query))
(if (not options)
(list query)
(nconc (nreverse options) (list query)))))
(defsubst helm-ag--search-buffer-p (bufname)
"Determine if BUFNAME should be searched by checking against ignore patterns."
(cl-loop for regexp in helm-ag-ignore-buffer-patterns
never (string-match-p regexp bufname)))
(defun helm-ag--file-visited-buffers ()
"Retrieve a list of file-visiting buffers, filtered by ignore patterns."
(let ((bufs (cl-loop for buf in (buffer-list)
when (buffer-file-name buf)
collect it)))
(if (not helm-ag-ignore-buffer-patterns)
bufs
(cl-loop for buf in bufs
when (helm-ag--search-buffer-p buf)
collect buf))))
(defun helm-ag--construct-targets (targets)
"Convert TARGETS to relative paths based on the default directory."
(let ((default-directory helm-ag--default-directory))
(cl-loop for target in targets
collect (file-relative-name target))))
(defun helm-ag--root-agignore ()
"Return the path to the \".agignore\" file at the project root, if it exists."
(let ((root (helm-ag--project-root)))
(when root
(let ((default-directory root))
(when (file-exists-p ".agignore")
(expand-file-name (concat default-directory ".agignore")))))))
(defun helm-ag--construct-command (this-file)
"Construct the `ag' command for search, incorporating options and targets.
THIS-FILE is an optional file path to add as a specific target in the search
command. The function builds the command by combining `helm-ag-base-command',
user options, and file patterns to ignore.
This function returns a cons cell where the car is the `ag' command and the
cdr is a list of all arguments."
(let* ((commands (split-string helm-ag-base-command nil t))
(command (car commands))
(args (cdr commands)))
(when helm-ag-command-option
(let ((ag-options (split-string helm-ag-command-option nil t)))
(setq args (append args ag-options))))
(when helm-ag-use-agignore
(helm-aif (helm-ag--root-agignore)
(setq args (append args (list "-p" it)))))
(when helm-ag-ignore-patterns
(setq args (append args (mapcar 'helm-ag--construct-ignore-option
helm-ag-ignore-patterns))))
(when helm-ag-use-grep-ignore-list
(setq args (append args (helm-ag--grep-ignore-list-to-options))))
(setq args (append args (helm-ag--parse-query helm-ag--last-query)))
(when this-file
(setq args (append args (list this-file))))
(when helm-ag--buffer-search
(setq args (append args (helm-ag--file-visited-buffers))))
(when helm-ag--default-target
(setq args (append args (helm-ag--construct-targets helm-ag--default-target))))
(cons command args)))
(defun helm-ag--remove-carrige-returns ()
"Remove carriage return characters from the current buffer."
(when (helm-ag--windows-p)
(save-excursion
(goto-char (point-min))
(while (re-search-forward "\xd" nil t)
(replace-match "")))))
(defun helm-ag--abbreviate-file-name ()
"Abbreviate file paths in the current buffer."
(unless (helm-ag--windows-p)
(save-excursion
(goto-char (point-min))
(forward-line 1)
(while (re-search-forward "^\\([^:]+\\)" nil t)
(replace-match (abbreviate-file-name (match-string-no-properties 1)))))))
(defun helm-ag--command-succeeded-p (exit-status)
"Determine if a command succeeded based on EXIT-STATUS"
(cond ((integerp helm-ag-success-exit-status) (= exit-status helm-ag-success-exit-status))
((consp helm-ag-success-exit-status) (member exit-status helm-ag-success-exit-status))
(t (zerop exit-status))))
(defun helm-ag--init ()
"Initialize helm-ag search buffer, execute searching, and handle results."
(let ((buf-coding buffer-file-coding-system))
(helm-attrset 'recenter t)
(with-current-buffer (helm-candidate-buffer 'global)
(let* ((default-directory (or helm-ag--default-directory
default-directory))
(cmds (helm-ag--construct-command (helm-attr 'search-this-file)))
(coding-system-for-read buf-coding)
(coding-system-for-write buf-coding))
(setq helm-ag--ignore-case (helm-ag--ignore-case-p cmds helm-ag--last-query)
helm-ag--last-command cmds)
(let ((ret (apply #'process-file (car cmds) nil t nil (cdr cmds))))
(if (zerop (length (buffer-string)))
(error "No ag output: '%s'" helm-ag--last-query)
(unless (helm-ag--command-succeeded-p ret)
(unless (executable-find (car cmds))
(error "'%s' is not installed" (car cmds)))
(error "Failed: '%s'" helm-ag--last-query))))
(when helm-ag--buffer-search
(helm-ag--abbreviate-file-name))
(helm-ag--remove-carrige-returns)
(helm-ag--save-current-context)))))
(add-to-list 'debug-ignored-errors "^No ag output: ")
(defun helm-ag--search-only-one-file-p ()
"Check if helm-ag is set to search only a single file."
(when (and helm-ag--default-target (= (length helm-ag--default-target) 1))
(let ((target (car helm-ag--default-target)))
(unless (file-directory-p target)
target))))
(defun helm-ag--find-file-action (candidate find-func this-file &optional persistent)
"Open a file and navigate to a specific line based on search results.
CANDIDATE is a string representing the search result line, which includes
the file path and line number to open. FIND-FUNC is a function used to
open the file. THIS-FILE, if provided, specifies the file to open directly,
bypassing the path in CANDIDATE. PERSISTENT, if non-nil, indicates that
this is a temporary preview action."
(when (memq 'pt helm-ag--command-features)
;; 'pt' always show filename if matched file is only one.
(setq this-file nil))
(let* ((file-line (helm-grep-split-line candidate))
(filename (or this-file (cl-first file-line) candidate))
(line (if this-file
(cl-first (split-string candidate ":"))
(cl-second file-line)))
(default-directory (or helm-ag--default-directory
helm-ag--last-default-directory
default-directory)))
(unless persistent
(setq helm-ag--last-default-directory default-directory))
(funcall find-func filename)
(goto-char (point-min))
(when line
(forward-line (1- (string-to-number line))))
(ignore-errors
(and (re-search-forward helm-ag--last-query (line-end-position) t)
;; `helm-goto-char' expands folded headings/outlines if needed
(helm-goto-char (match-beginning 0))))))
(defun helm-ag--open-file-with-temp-buffer (filename)
"Open FILENAME in a temporary buffer."
(let ((search-directory default-directory))
(switch-to-buffer (get-buffer-create " *helm-ag persistent*"))
(setq default-directory search-directory
buffer-read-only nil)
(fundamental-mode)
(erase-buffer)
(insert-file-contents filename)
(let ((buffer-file-name filename))
(set-auto-mode)
(font-lock-fontify-region (point-min) (point-max)))))
(defsubst helm-ag--vimgrep-option ()
"Check if helm-ag use Vim-style grep options."
(member "--vimgrep" helm-ag--last-command))
(defun helm-ag--search-this-file-p ()
"Check if the current search is restricted to a single file"
(unless (helm-ag--vimgrep-option)
(if (eq (helm-get-current-source) 'helm-source-do-ag)
(helm-ag--search-only-one-file-p)
(helm-attr 'search-this-file))))
(defun helm-ag--persistent-action (candidate)
"Display CANDIDATE in a buffer temporarily for preview."
(let ((find-func (if helm-ag-use-temp-buffer
#'helm-ag--open-file-with-temp-buffer
#'find-file))
(helm-ag-p (assoc-default 'real-to-display (helm-get-current-source))))
(helm-ag--find-file-action candidate find-func (helm-ag--search-this-file-p) t)
(let ((helm-input (if helm-ag-p
(concat helm-ag--last-query " " helm-input)
helm-input)))
(helm-highlight-current-line))))
(defun helm-ag--validate-regexp (regexp)
"Check if REGEXP is a valid regular expression."
(condition-case nil
(progn
(string-match-p regexp "")
t)
(invalid-regexp nil)))
(defun helm-ag--convert-to-elisp-regexp (regexp)
"Convert REGEXP to Elisp-compatible regular expression."
;; This is very simple conversion
(with-temp-buffer
(insert regexp)
(goto-char (point-min))
;; convert (, ), {, }, |
(while (re-search-forward "[(){}|]" nil t)
(backward-char 1)
(cond ((looking-back "\\\\\\\\" nil))
((looking-back "\\\\" nil)
(delete-char -1))
(t
(insert "\\")))
(forward-char 1))
;; convert \s and \S -> \s- \S-
(goto-char (point-min))
(while (re-search-forward "\\(\\\\s\\)" nil t)
(unless (looking-back "\\\\\\\\s" nil)
(insert "-")))
(buffer-string)))
(defun helm-ag--elisp-regexp-to-pcre (regexp)
"Convert an Elisp-compatible REGEXP to PCRE format."
(with-temp-buffer
(insert regexp)
(goto-char (point-min))
(while (re-search-forward "[(){}|]" nil t)
(backward-char 1)
(cond ((looking-back "\\\\\\\\" nil))
((looking-back "\\\\" nil)
(delete-char -1))
(t
(insert "\\")))
(forward-char 1))
(buffer-string)))
(defun helm-ag--highlight-candidate (candidate)
"Highlight matching parts in CANDIDATE based on the current query."
(let ((limit (1- (length candidate)))
(last-pos 0)
(case-fold-search helm-ag--ignore-case))
(when helm-ag--valid-regexp-for-emacs
(while (and (< last-pos limit)
(string-match helm-ag--elisp-regexp-query candidate last-pos))
(let ((start (match-beginning 0))
(end (match-end 0)))
(if (= start end)
(cl-incf last-pos)
(put-text-property start end 'face 'helm-match candidate)
(setq last-pos (1+ (match-end 0)))))))
candidate))
(defun helm-ag--candidate-transform-for-this-file (candidate)
"Format CANDIDATE to display line number and highlighted content for a single file."
(when (string-match "\\`\\([^:]+\\):\\(.*\\)" candidate)
(format "%s:%s"
(propertize (match-string 1 candidate) 'face 'helm-grep-lineno)
(helm-ag--highlight-candidate (match-string 2 candidate)))))
(defun helm-ag--candidate-transform-for-files (candidate)
"Format CANDIDATE to display line number and highlighted content for files."
(helm-aif (helm-grep-split-line candidate)
(format "%s:%s:%s"
(propertize (cl-first it) 'face 'helm-moccur-buffer)
(propertize (cl-second it) 'face 'helm-grep-lineno)
(helm-ag--highlight-candidate (cl-third it)))))
(defun helm-ag--candidate-transformer (candidate)
"Transform CANDIDATE for display based on search context."
(or (if (helm-attr 'search-this-file)
(helm-ag--candidate-transform-for-this-file candidate)
(helm-ag--candidate-transform-for-files candidate))
candidate))
(defun helm-ag--action-find-file (candidate)
"Open CANDIDATE in the current window."
(helm-ag--find-file-action candidate 'find-file (helm-ag--search-this-file-p)))
(defun helm-ag--action-find-file-other-window (candidate)
"Open CANDIDATE in another window."
(helm-ag--find-file-action candidate 'find-file-other-window (helm-ag--search-this-file-p)))
(defvar helm-ag--actions
(helm-make-actions
"Open file" #'helm-ag--action-find-file
"Open file other window" #'helm-ag--action-find-file-other-window
"Save results in buffer" #'helm-ag--action-save-buffer
"Edit search results" #'helm-ag--edit)
"Actions for `helm-ag'.")
(defvar helm-ag-map
(let ((map (make-sparse-keymap)))
(set-keymap-parent map helm-map)
(define-key map (kbd "C-c o") 'helm-ag--run-other-window-action)
(define-key map (kbd "C-l") 'helm-ag--up-one-level)
(define-key map (kbd "C-c C-e") 'helm-ag-edit)
(define-key map (kbd "C-x C-s") 'helm-ag--run-save-buffer)
(define-key map (kbd "C-c ?") 'helm-ag-help)
(define-key map (kbd "C-c >") 'helm-ag--next-file)
(define-key map (kbd "<right>") 'helm-ag--next-file)
(define-key map (kbd "C-c <") 'helm-ag--previous-file)
(define-key map (kbd "<left>") 'helm-ag--previous-file)
map)
"Keymap for `helm-ag'.")
(defvar helm-ag-source
(helm-build-in-buffer-source "The Silver Searcher"
:init 'helm-ag--init
:real-to-display 'helm-ag--candidate-transformer
:persistent-action 'helm-ag--persistent-action
:fuzzy-match helm-ag-fuzzy-match
:action helm-ag--actions
:candidate-number-limit 9999
:keymap helm-ag-map
:follow (and helm-follow-mode-persistent 1))
"Helm source definition for integrating with The Silver Searcher.")
;;;###autoload
(defun helm-ag-pop-stack ()
"Restore the previous search context from the `helm-ag--context-stack'."
(interactive)
(let ((context (pop helm-ag--context-stack)))
(unless context
(error "Context stack is empty !"))
(helm-aif (plist-get context :file)
(find-file it)
(let ((buf (plist-get context :buffer)))
(if (buffer-live-p buf)
(switch-to-buffer buf)
(error "The buffer is already killed"))))
(goto-char (plist-get context :point))))
;;;###autoload
(defun helm-ag-clear-stack ()
"Clear all entries in the `helm-ag--context-stack'."
(interactive)
(setq helm-ag--context-stack nil))
(defun helm-ag--marked-input (escape)
"Return the selected region as search input, optionally escaping spaces."
(when (use-region-p)
(let ((input (buffer-substring-no-properties (region-beginning) (region-end))))
(deactivate-mark)
(if (not escape)
input
(replace-regexp-in-string " " "\\\\ " input)))))
(defun helm-ag--query (&optional query)
"Display prompt for a search QUERY, using the marked region or the word at point."
(let* ((searched-word (helm-ag--searched-word))
(marked-word (helm-ag--marked-input nil))
(query (or query
(read-from-minibuffer "Pattern: "
(or marked-word searched-word)
nil
nil
'helm-ag--command-history
(helm-aif (symbol-at-point)
(symbol-name it))))))
(when (string-empty-p query)
(error "Input is empty!!"))
(setq helm-ag--last-query query)))
(defsubst helm-ag--init-state ()
"Initialize helm-ag search state variables."
(setq helm-ag--original-window (selected-window)
helm-ag--last-default-directory nil))
(defun helm-ag--get-default-directory ()
"Determine the default search directory for `helm-ag'"
(let ((prefix-val (and current-prefix-arg (abs (prefix-numeric-value current-prefix-arg)))))
(cond ((not prefix-val) default-directory)
((= prefix-val 4)
(file-name-as-directory
(read-directory-name "Search directory: " nil nil t)))
((= prefix-val 16)
(let ((dirs (list (read-directory-name "Search directory: " nil nil t))))
(while (y-or-n-p "More directories ? ")
(push (read-directory-name "Search directory: " nil nil t) dirs))
(reverse dirs))))))
(defsubst helm-ag--helm-header (dir)
"Generate a header string for helm-ag search"
(if helm-ag--buffer-search
"Search Buffers"
(concat "Search at " (abbreviate-file-name dir))))
(defun helm-ag--run-other-window-action ()
"Execute helm-ag action to open a search result in another window."
(interactive)
(with-helm-alive-p
(helm-exit-and-execute-action #'helm-ag--action-find-file-other-window)))
(defun helm-ag--exit-from-edit-mode ()
"Exit helm-ag's edit mode, restoring the original window."
(when (window-live-p helm-ag--original-window)
(select-window helm-ag--original-window))
(kill-buffer (get-buffer "*helm-ag-edit*")))
(defun helm-ag--match-line-regexp ()
"Generate a regular expression to match lines in search results."
;; $1: file name
;; $2: line
;; $3: match body
;; $4: file attributes part(filename, line, column)
(cond ((helm-ag--vimgrep-option)
"^\\(?4:\\(?1:[^:]+\\):\\(?2:[1-9][0-9]*\\):[^:]+:\\)\\(?3:.*\\)$")
(helm-ag--search-this-file-p
"^\\(?4:\\(?2:[1-9][0-9]*\\)[:-]\\)\\(?3:.*\\)$")
(t
"^\\(?4:\\(?1:[^:]+\\):\\(?2:[1-9][0-9]*\\)[:-]\\)\\(?3:.*\\)$")))
(defun helm-ag--edit-commit ()
"Apply edited changes from `*helm-ag-edit*' buffer to files."
(interactive)
(goto-char (point-min))
(let ((read-only-files 0)
(files-to-lines (make-hash-table :test #'equal))
(regexp (helm-ag--match-line-regexp))
(line-deletes (make-hash-table :test #'equal)))
;; Group changes by file
(while (re-search-forward regexp nil t)
(let* ((file (or (match-string-no-properties 1) helm-ag--search-this-file-p))
(line (string-to-number (match-string-no-properties 2)))
(body (match-string-no-properties 3))
(ovs (overlays-at (line-beginning-position)))
(lines-list (gethash file files-to-lines)))
(if (not (file-writable-p file))
(cl-incf read-only-files)
(if lines-list
(progn
(push (list line body ovs) lines-list)
(puthash file lines-list files-to-lines))
(puthash file (list (list line body ovs)) files-to-lines)))))
;; Batch edits by file
(maphash
(lambda (curr-file lines-data)
(with-temp-buffer
(insert-file-contents curr-file)
(dolist (curr-line-data (reverse lines-data))
(cl-destructuring-bind
(line body ovs) curr-line-data
(goto-char (point-min))
(let ((deleted-lines (gethash curr-file line-deletes 0))
(deleted (and ovs (overlay-get (car ovs) 'helm-ag-deleted))))
(forward-line (- line 1 deleted-lines))
(delete-region (line-beginning-position) (line-end-position))
(if (not deleted)
(insert body)
(let ((beg (point)))
(forward-line 1)
(delete-region beg (point))
(puthash curr-file (1+ deleted-lines) line-deletes))))))
(when helm-ag-edit-save
(write-region (point-min) (point-max) curr-file))))
files-to-lines)
;; Finish
(helm-ag--exit-from-edit-mode)
(if (not (zerop read-only-files))
(message "%d files are read-only and not editable." read-only-files)
(message "Success update"))))
(defun helm-ag--edit-abort ()
"Abort the current helm-ag edit session and discard unsaved changes."
(interactive)
(when (y-or-n-p "Discard changes ? ")
(helm-ag--exit-from-edit-mode)
(message "Abort edit")))
(defun helm-ag--mark-line-deleted ()
"Mark the current line as deleted in helm-ag's edit mode."
(interactive)
(let* ((beg (line-beginning-position))
(end (line-end-position))
(ov (make-overlay beg end)))
(overlay-put ov 'face 'helm-ag-edit-deleted-line)
(overlay-put ov 'helm-ag-deleted t)))
(defun helm-ag--unmark ()
"Remove the deletion mark from the current line in helm-ag's edit mode."
(interactive)
(dolist (ov (overlays-in (line-beginning-position) (line-end-position)))
(when (overlay-get ov 'helm-ag-deleted)
(delete-overlay ov))))
(defvar helm-ag-edit-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-c") 'helm-ag--edit-commit)
(define-key map (kbd "C-c C-k") 'helm-ag--edit-abort)
(define-key map (kbd "C-c C-d") 'helm-ag--mark-line-deleted)
(define-key map (kbd "C-c C-u") 'helm-ag--unmark)
map)
"Editing keymap for `helm-ag'")
(defsubst helm-ag--edit-func-to-keys (func)
"Return the key binding for FUNC in helm-ag's edit mode."
(key-description (car-safe (where-is-internal func helm-ag-edit-map))))
(defun helm-ag--edit (_candidate)
"Initialize helm-ag's edit buffer for interactive editing of search results.
This function sets up an editable buffer `*helm-ag-edit*' populated with
search results from the `*helm-ag*' buffer, allowing users to make batch
edits directly to lines matched by the search:
- Sets the working directory to match the Helm-Ag buffer's default directory.
- Populates `*helm-ag-edit*' with marked lines if any are marked; otherwise,
it includes all search results.
- Adds text properties to the buffer to prevent accidental modifications
to file line numbers.
- Displays a header line indicating keybindings for committing and aborting edits."
(let* ((helm-buf-dir (or helm-ag--default-directory
helm-ag--last-default-directory
default-directory))
(default-directory helm-buf-dir))
(with-current-buffer (get-buffer-create "*helm-ag-edit*")
(let ((inhibit-read-only t))
(erase-buffer))
(setq-local helm-ag--default-directory helm-buf-dir)
(unless (helm-ag--vimgrep-option)
(setq-local helm-ag--search-this-file-p
(assoc-default 'search-this-file (helm-get-current-source))))
(let (buf-content)
(with-current-buffer (get-buffer "*helm-ag*")
(goto-char (point-min))
(forward-line 1)
(let* ((body-start (point))
(marked-lines (cl-loop for ov in (overlays-in body-start (point-max))
when (eq 'helm-visible-mark (overlay-get ov 'face))
return (helm-marked-candidates))))
(if (not marked-lines)
(setq buf-content (buffer-substring-no-properties
body-start (point-max)))
(setq buf-content (concat (string-join marked-lines "\n") "\n")))))
(insert buf-content)
(add-text-properties (point-min) (point-max)
'(read-only t rear-nonsticky t front-sticky t))
(let ((inhibit-read-only t)
(regexp (helm-ag--match-line-regexp)))
(setq header-line-format
(format "[%s] %s: Commit, %s: Abort"
(abbreviate-file-name helm-ag--default-directory)
(helm-ag--edit-func-to-keys #'helm-ag--edit-commit)
(helm-ag--edit-func-to-keys #'helm-ag--edit-abort)))
(goto-char (point-min))
(while (re-search-forward regexp nil t)
(let ((file-line-begin (match-beginning 4))
(file-line-end (match-end 4))
(body-begin (match-beginning 3))
(body-end (match-end 3)))
(add-text-properties file-line-begin file-line-end
'(face font-lock-function-name-face
intangible t))
(remove-text-properties body-begin body-end '(read-only t))
(set-text-properties body-end (1+ body-end)
'(read-only t rear-nonsticky t))))))))
(other-window 1)
(switch-to-buffer (get-buffer "*helm-ag-edit*"))
(goto-char (point-min))
(setq next-error-function 'compilation-next-error-function)
(setq-local compilation-locs (make-hash-table :test 'equal :weakness 'value))
(use-local-map helm-ag-edit-map))
(defun helm-ag-edit ()
"Trigger helm-ag's interactive edit mode for modifying search results."
(interactive)
(helm-exit-and-execute-action 'helm-ag--edit))
(defconst helm-ag--help-message
"\n* Helm Ag\n
\n** Specific commands for Helm Ag:\n
\\<helm-ag-map>
\\[helm-ag--run-other-window-action]\t\t-> Open result in other buffer
\\[helm-ag--up-one-level]\t\t-> Search in parent directory.
\\[helm-ag-edit]\t\t-> Edit search results.
\\[helm-ag-help]\t\t-> Show this help.
\n** Helm Ag Map\n
\\{helm-map}"
"Help message for `helm-ag'.")
(defun helm-ag-help ()
"Display help message for `helm-ag'."
(interactive)
(let ((helm-help-message helm-ag--help-message))
(helm-help)))
(defun helm-ag-mode-jump ()
"Jump to the file and line of the search result under the cursor."
(interactive)
(let ((line (helm-current-line-contents)))
(helm-ag--find-file-action line 'find-file helm-ag--search-this-file-p)))
(defun helm-ag-mode-jump-other-window ()
"Jump to the file and line of the search result under the cursor in another window."
(interactive)
(let ((line (helm-current-line-contents)))
(helm-ag--find-file-action line 'find-file-other-window helm-ag--search-this-file-p)))
(defvar helm-ag-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "RET") 'helm-ag-mode-jump)
(define-key map (kbd "C-o") 'helm-ag-mode-jump-other-window)
(define-key map (kbd "g") 'helm-ag--update-save-results)
map)
"Mode keymap for `helm-ag'")
(define-derived-mode helm-ag-mode special-mode "helm-ag"
"Major mode to provide actions in helm grep saved buffer.
Special commands:
\\{helm-ag-mode-map}")
(defun helm-ag--put-result-in-save-buffer (result search-this-file-p)
"Insert search RESULT into a buffer and set up `helm-ag-mode'"
(setq buffer-read-only t)
(let ((inhibit-read-only t))
(erase-buffer)
(insert "-*- mode: helm-ag -*-\n\n"
(format "Ag Results for `%s':\n\n" helm-ag--last-query))
(save-excursion
(insert result)))
(helm-ag-mode)
(unless (helm-ag--vimgrep-option)
(setq-local helm-ag--search-this-file-p search-this-file-p))
(setq-local helm-ag--default-directory default-directory))
(defun helm-ag--save-results (use-other-buf)
"Save the results of the last helm-ag search into a buffer."
(let* ((search-this-file-p nil)
(result (with-current-buffer helm-buffer
(goto-char (point-min))
(forward-line 1)
(buffer-substring (point) (point-max))))
(default-directory helm-ag--default-directory)
(buf (if use-other-buf
(read-string "Results buffer name: "
(format "*helm ag results for '%s'*" helm-ag--last-query))
"*helm ag results*")))
(when (buffer-live-p (get-buffer buf))
(kill-buffer buf))
(with-current-buffer (get-buffer-create buf)
(helm-ag--put-result-in-save-buffer result search-this-file-p)
(pop-to-buffer buf)
(message "Helm Ag Results saved in `%s' buffer" buf))))
(defun helm-ag--update-save-results ()
"Update the saved search results using the last helm-ag command."
(interactive)
(let* ((default-directory helm-ag--default-directory)
(result (with-temp-buffer
(apply #'process-file (car helm-ag--last-command) nil t nil
(cdr helm-ag--last-command))
(helm-ag--remove-carrige-returns)
(when helm-ag--buffer-search
(helm-ag--abbreviate-file-name))
(helm-ag--propertize-candidates helm-ag--last-query)
(buffer-string))))
(helm-ag--put-result-in-save-buffer result helm-ag--search-this-file-p)
(message "Update Results")))
(defun helm-ag--action-save-buffer (_arg)
"Save the results of the last helm-ag search into the default results buffer."
(helm-ag--save-results nil))
(defun helm-ag--run-save-buffer ()
"Run the action to save helm-ag search results, respecting current prefix argument."
(interactive)
(let ((use-other-buf-p current-prefix-arg))
(with-helm-alive-p
(helm-exit-and-execute-action
(lambda (_arg)
(helm-ag--save-results use-other-buf-p))))))
(defun helm-ag--file-of-current-file ()
"Extract the file name from the current line in the helm buffer."
(let ((line (helm-current-line-contents)))
(when (string-match helm-grep-split-line-regexp line)
(match-string-no-properties 1 line))))
(defun helm-ag--move-file-common (pred move-fn wrap-fn)
"Navigate between files in Helm Ag results using a common pattern.
PRED is a predicate function to determine stopping conditions.
MOVE-FN is a function to move the cursor to the next or previous line.
WRAP-FN is a function to wrap around the buffer when the end or beginning is reached."
(with-helm-window
(let ((file (helm-ag--file-of-current-file)))
(funcall move-fn)
(while (and (not (funcall pred)) (string= file (helm-ag--file-of-current-file)))
(funcall move-fn))
(when (funcall pred)
(funcall wrap-fn)))))
(defun helm-ag--previous-file ()
"Move the selection to the previous file in the helm-ag results."
(interactive)
(helm-ag--move-file-common
#'helm-beginning-of-source-p #'helm-previous-line #'helm-end-of-buffer))
(defun helm-ag--next-file ()
"Move the selection to the next file in the helm-ag results."
(interactive)
(helm-ag--move-file-common
#'helm-end-of-source-p #'helm-next-line #'helm-beginning-of-buffer))
(defsubst helm-ag--root-directory-p ()
"Check if the current directory contains a vcs root."
(cl-loop for dir in '(".git/" ".hg/")
thereis (file-directory-p dir)))
(defun helm-ag--up-one-level ()
"Move up one directory level for Helm Ag search, unless at the project root."
(interactive)
(if (or (not (helm-ag--root-directory-p))
(y-or-n-p "Current directory might be the project root. \
Continue searching the parent directory? "))
(let ((parent (file-name-directory (directory-file-name default-directory))))
(helm-run-after-exit
(lambda ()
(let* ((default-directory parent)
(helm-ag--default-directory parent))
(setq helm-ag--last-default-directory default-directory)
(helm-attrset 'name (helm-ag--helm-header default-directory) helm-ag-source)
(helm :sources '(helm-ag-source) :buffer "*helm-ag*" :keymap helm-ag-map
:history 'helm-ag--helm-history)))))
(message nil)))
;;;###autoload
(defun helm-ag-this-file (&optional query)
"Do ag with in this file with QUERY."
(interactive)
(helm-ag--init-state)
(let ((filename (file-name-nondirectory (buffer-file-name)))
(helm-ag--default-directory default-directory))
(helm-ag--query query)
(helm-ag--set-command-features)
(helm-attrset 'search-this-file (file-relative-name (buffer-file-name))
helm-ag-source)
(helm-attrset 'name (format "Search at %s" filename) helm-ag-source)
(helm :sources '(helm-ag-source) :buffer "*helm-ag*" :keymap helm-ag-map
:history 'helm-ag--helm-history)))
;;;###autoload
(defun helm-ag (&optional basedir query)
"Do ag with in BASEDIR and with QUERY."
(interactive)
(helm-ag--init-state)
(let ((dir (helm-ag--get-default-directory))
targets)
(when (listp dir)
(setq basedir default-directory
targets dir))
(let ((helm-ag--default-directory (or basedir dir))
(helm-ag--default-target targets))
(helm-ag--query query)
(helm-attrset 'search-this-file nil helm-ag-source)
(helm-attrset 'name (helm-ag--helm-header helm-ag--default-directory) helm-ag-source)
(helm :sources '(helm-ag-source) :buffer "*helm-ag*" :keymap helm-ag-map
:history 'helm-ag--helm-history))))
(defun helm-ag--split-string (str)
"Split STR into a list of substrings separated by spaces, handling escaped spaces."
(with-temp-buffer
(insert str)
(goto-char (point-min))
(let ((prev (point))
patterns)
(while (search-forward " " nil 'move)
(cond ((looking-back "\\\\\\\\ " nil)