-
Notifications
You must be signed in to change notification settings - Fork 58
/
Copy pathfind-file-in-project.el
1551 lines (1387 loc) · 56.6 KB
/
find-file-in-project.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
;;; find-file-in-project.el --- Find file/directory and review Diff/Patch/Commit efficiently -*- lexical-binding: t -*-
;; Copyright (C) 2006-2009, 2011-2012, 2015-2018
;; Phil Hagelberg, Doug Alcorn, Will Farrington, Chen Bin
;;
;; Version: 6.2.2
;; Author: Phil Hagelberg, Doug Alcorn, and Will Farrington
;; Maintainer: Chen Bin <chenbin.sh@gmail.com>
;; URL: https://github.com/redguardtoo/find-file-in-project
;; Package-Requires: ((emacs "25.1"))
;; Created: 2008-03-18
;; Keywords: project, convenience
;; EmacsWiki: FindFileInProject
;; This file is NOT part of GNU Emacs.
;;; License:
;; 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, 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 GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;; This program provides methods to find file in project.
;;
;; Features,
;; - Only dependency is BSD/GNU find
;; - Works on Windows with minimum setup
;; - Works on Tramp Mode (https://www.emacswiki.org/emacs/TrampMode)
;; - fd (faster alternative of find, see https://github.com/sharkdp/fd) is supported
;; - Uses native API `completing-read' and supports helm/ivy/consult/selectrum out of box.
;;
;; Helm setup,
;; (helm-mode 1)
;;
;; Ivy setup,
;; (ivy-mode 1)
;;
;; Ido setup,
;; (setq ffip-prefer-ido-mode t)
;;
;; Usage,
;; - You can insert "(setq ffip-use-rust-fd t)" into ".emacs" to use fd (alternative of find)
;; - `find-file-in-project-at-point' guess the file path at point and
;; find file
;; - `find-file-in-project-by-selected' uses the selected region
;; as the keyword to search file. You can provide the keyword
;; if no region is selected.
;; - `find-directory-in-project-by-selected' uses the select region
;; to find directory. You can provide the keyword if no region
;; is selected.
;; - `find-file-in-project' starts search file immediately
;; - `ffip-create-project-file' creates ".dir-locals.el"
;; - `ffip-lisp-find-file-in-project' finds file in project.
;; If its parameter is not nil, it find directory.
;; This command is written in pure Lisp and does not use any third party
;; command line program. So it works in all environments.
;;
;; A project is found by searching up the directory tree until a file
;; is found that matches `ffip-project-file'.
;; You can set `ffip-project-root-function' to provide an alternate
;; function to search for the project root. By default, it looks only
;; for files whose names match `ffip-patterns',
;; If you have so many files that it becomes unwieldy, you can set
;; `ffip-find-options' to a string which will be passed to the `find'
;; invocation in order to exclude irrelevant subdirectories/files.
;; For instance, in a Ruby on Rails project, you are interested in all
;; .rb files that don't exist in the "vendor" directory. In that case
;; you could set `ffip-find-options' to "-not -regex \".*vendor.*\"".
;; `ffip-insert-file' insert file content into current buffer.
;; `find-file-with-similar-name' find file with similar name to current
;; opened file. The regular expression `ffip-strip-file-name-regex' is
;; also used by `find-file-with-similar-name'.
;;
;; all these variables may be overridden on a per-directory basis in
;; your ".dir-locals.el". See (info "(Emacs) Directory Variables") for
;; details.
;;
;; Sample ".dir-locals.el",
;;
;; ((nil . ((ffip-project-root . "~/projs/PROJECT_DIR")
;; ;; ignore files bigger than 64k and directory "dist/" when searching
;; (ffip-find-options . "-not -size +64k -not -iwholename '*/dist/*'")
;; ;; only search files with following extensions
;; (ffip-patterns . ("*.html" "*.js" "*.css" "*.java" "*.xml" "*.js"))
;; (eval . (progn
;; (require 'find-file-in-project)
;; ;; ignore directory ".tox/" when searching
;; (setq ffip-prune-patterns `("*/.tox" ,@ffip-prune-patterns))
;; ignore BMP image file
;; (setq ffip-ignore-filenames `("*.bmp" ,@ffip-ignore-filenames))
;; ;; Do NOT ignore directory "bin/" when searching
;; (setq ffip-prune-patterns `(delete "*/bin" ,@ffip-prune-patterns))))
;; )))
;;
;; To find in current directory, use `find-file-in-current-directory'
;; and `find-file-in-current-directory-by-selected'.
;;
;; `ffip-fix-file-path-at-point' replaces path at point with correct relative/absolute path.
;;
;; File/directory searching actions are automatically stored into `ffip-find-files-history'.
;; Use `ffip-find-files-resume' to replay any previous action.
;; The maximum number of items of the history is set in `ffip-find-files-history-max-items'.
;;
;; `ffip-show-diff' execute the backend from `ffip-diff-backends'.
;; The output is in Unified Diff Format and inserted into *ffip-diff* buffer.
;; Press "o" or "C-c C-c" or "ENTER" or `M-x ffip-diff-find-file' in the
;; buffer to open corresponding file. Please note some backends assume that the git cli program
;; is added into environment variable PATH.
;;
;; `ffip-diff-find-file-before-hook' is called in `ffip-diff-find-file'.
;; Two file names are passed to it as parameters. One name is returned by the hook
;; as the file searching keyword.
;;
;; `ffip-diff-apply-hunk' applies current hunk in `diff-mode' (please note
;; `ffip-diff-mode' inherits from `diff-mode') to the target.
;; file. The target file could be located by searching `recentf-list'.
;; Except this extra feature, `ffip-diff-apply-hunk' is same as `diff-apply-hunk'.
;; So `diff-apply-hunk' can be replaced by `ffip-diff-apply-hunk'.
;;
;; `ffip-diff-filter-hunks-by-file-name' can filter hunks by their file names.
;; User input pattern "regex !exclude1 exclude1" means the hunk's file name does match "regex".
;; But does not match "exclude1" or "exclude2".;
;; Please note in "regex", space represents any string.
;;
;; If you use `evil-mode', insert below code into ~/.emacs,
;; (defun ffip-diff-mode-hook-setup ()
;; (evil-local-set-key 'normal "K" 'diff-hunk-prev)
;; (evil-local-set-key 'normal "J" 'diff-hunk-next)
;; (evil-local-set-key 'normal "P" 'diff-file-prev)
;; (evil-local-set-key 'normal "N" 'diff-file-next)
;; (evil-local-set-key 'normal (kbd "RET") 'ffip-diff-find-file)
;; (evil-local-set-key 'normal "o" 'ffip-diff-find-file))
;; (add-hook 'ffip-diff-mode-hook 'ffip-diff-mode-hook-setup)
;; `find-relative-path' find file/directory and copy its relative path
;; into `kill-ring'. You can customize `ffip-find-relative-path-callback'
;; to format the relative path,
;; (setq ffip-find-relative-path-callback 'ffip-copy-reactjs-import)
;; (setq ffip-find-relative-path-callback 'ffip-copy-org-file-link)
;;
;; BSD/GNU Find can be installed through Cygwin or MYSYS2 on Windows.
;; Executable is automatically detected. But you can manually specify
;; the executable location by insert below code into ".emacs",
;;
;; (if (eq system-type 'windows-nt)
;; (setq ffip-find-executable "c:\\\\cygwin64\\\\bin\\\\find"))
;;
;; This program works on Windows/Cygwin/Linux/macOS
;;
;; See https://github.com/redguardtoo/find-file-in-project for advanced tips.
;;; Code:
(require 'find-file)
(require 'find-lisp)
(require 'diff-mode)
(require 'windmove)
(require 'subr-x)
(require 'ido)
(defgroup ffip nil
"Find File in Project."
:group 'convenience)
(defcustom ffip-use-rust-fd nil
"Use rust fd instead of find."
:link '(url-link :tag "fd @ GitHub"
"https://github.com/sharkdp/fd")
:group 'ffip
:type 'boolean
:safe #'booleanp)
(defcustom ffip-rust-fd-respect-ignore-files t
"Don't show search results from '.*ignore' files."
:group 'ffip
:type 'boolean
:safe #'booleanp)
(defcustom ffip-project-search-function 'ffip-project-search-default-function
"Function to execute find program in shell."
:group 'ffip
:type 'function
:safe #'functionp)
(defcustom ffip-prefer-ido-mode nil
"Prefer `ido-completing-read' to filter file candidates."
:group 'ffip
:type 'boolean
:safe #'booleanp)
(defcustom ffip-rust-fd-extra-opts ""
"Rust fd extra options passed to cli."
:group 'ffip
:type 'string)
(defcustom ffip-diff-find-file-by-file-name-p nil
"When find file in diff hunk, only search by file name."
:group 'ffip
:type 'boolean
:safe #'booleanp)
(defcustom ffip-strip-file-name-regex
"\\(\\.mock\\|\\.test\\|\\.mockup\\)"
"Strip file name to get minimum keyword with this regex.
It's used by `find-file-with-similar-name'."
:group 'ffip
:type 'regexp)
(defcustom ffip-find-files-history-max-items 4
"Maximum number of items stored in `ffip-find-files-history'.
If this number is zero, no item is saved into `ffip-find-files-history'."
:group 'ffip
:type 'integer)
(defvar ffip-filename-history nil
"History of file names provided by users.")
(defvar ffip-find-files-history nil
"History generated by `ffip-find-files'.")
(defvar ffip-diff-find-file-before-hook nil
"Hook before `ffip-diff-find-file' move focus out of *ffip-diff* buffer.")
(defvar ffip-read-file-name-hijacked-p nil
"Internal flag used by `ffip-diff-apply-hunk'.")
(defvar ffip-diff-apply-hunk-hook nil
"Hook when `ffip-diff-apply-hunk' find the file to apply hunk.
The file path is passed to the hook as the first argument.")
(defvar ffip-relative-path-pattern "^\\(\\.\\.*/\\)+"
"Pattern of relative path.")
(defun ffip-nonempty-lines (str)
"Return non empty lines from STR."
(split-string str "[\r\n]+" t))
(defun ffip-diff-git-versions ()
"List all versions of code under Git."
(let* ((cmd1 "git branch --no-color --all")
(cmd2 (concat "git --no-pager log --date=short --pretty=format:'%h|%ad|%s|%an'" buffer-file-name)))
(nconc (ffip-nonempty-lines (shell-command-to-string cmd1))
(ffip-nonempty-lines (shell-command-to-string cmd2)))))
(defun ffip-diff-select-version ()
"Select a version from git history."
(let* ((line (completing-read "Select from git history: " (ffip-diff-git-versions)))
(version (replace-regexp-in-string "^ *\\*? *"
""
(car (split-string line "|" t)))))
version))
;;;###autoload
(defun ffip-git-diff-current-file ()
"Compare another version of current file."
(let* ((default-directory (locate-dominating-file default-directory ".git")))
(shell-command-to-string (format "git --no-pager diff %s:%s %s"
(ffip-diff-select-version)
(file-relative-name buffer-file-name default-directory)
buffer-file-name))))
(defun ffip-git-diff-project()
"Compare another version of project."
(let* ((default-directory (locate-dominating-file default-directory ".git")))
(shell-command-to-string (format "git --no-pager diff %s"
(ffip-diff-select-version)))))
(defun ffip-git-diff-directory()
"Compare another version of current directory."
(when buffer-file-name
(let* ((dir (read-directory-name "Directory: " (file-name-directory buffer-file-name)))
(default-directory (locate-dominating-file default-directory ".git")))
(shell-command-to-string (format "git --no-pager diff %s -- \"%s\""
(ffip-diff-select-version)
dir)))))
(defun ffip-git-diff-file-extension()
"Compare another version of files matching file extensions from user input.
File extensions are separated by space character."
(let* ((patterns (read-string "File extensions (e.g., \"cpp py\" matches C++ and Python code files): "
(and buffer-file-name (file-name-extension buffer-file-name)))))
(when patterns
(let* ((default-directory (locate-dominating-file default-directory ".git")))
(setq patterns
(mapconcat (lambda (s) (format "\"*.%s\"" s)) (split-string patterns " +") " "))
(shell-command-to-string (format "git --no-pager diff %s -- %s"
(ffip-diff-select-version)
patterns))))))
(defvar ffip-diff-backends
'(ffip-git-diff-current-file
ffip-git-diff-project
ffip-git-diff-directory
ffip-git-diff-file-extension
("`git diff HEAD^` in project" . "cd $(git rev-parse --show-toplevel) && git diff HEAD^")
("`git diff --cached` in project" . "cd $(git rev-parse --show-toplevel) && git diff --cached")
("`git diff` in project" . "cd $(git rev-parse --show-toplevel) && git diff")
("`git diff` current file" . (shell-command-to-string (format "cd $(git rev-parse --show-toplevel) && git diff \"%s\""
(buffer-file-name))))
;; git option "--cc" shows changes in merge commits
("`git log -p` current file" . (shell-command-to-string (format "cd $(git rev-parse --show-toplevel) && git --no-pager log --date=short -p --cc \"%s\""
(buffer-file-name))))
("`git log -S keyword -p` in project" . (shell-command-to-string (format "cd $(git rev-parse --show-toplevel) && git --no-pager log --date=short -S\"%s\" -p --cc"
(read-string "Git search string: "))))
("Diff from `kill-ring'" . (car kill-ring)))
"The list of back-ends.
If back-end is string, it's run in `shell-command-to-string'.
If it's a function or expression, it'll be executed and return a string.
The output is inserted into *ffip-diff* buffer.")
(defcustom ffip-find-executable nil
"Path of GNU find. If nil we will guess."
:group 'ffip
:type 'string)
(defcustom ffip-project-file '(".svn" ".hg" ".git")
"The file/directory used to locate project root.
May be set using .dir-locals.el. Checks each entry if set to a list."
:group 'ffip
:type '(repeat string))
(defcustom ffip-patterns nil
"List of glob patterns to look for with `find-file-in-project'."
:group 'ffip
:type '(repeat string))
(defvar ffip-match-path-instead-of-filename nil
"Match full path instead of file name.")
;; For "GNU/BSD Find", "*/test/*" matches "./test/" and "./dir/test/"
;;
;; But for "rust fd", only "test/*" matches "./test/" and "./dir/test/";
;; "*/test/*" won't match "./test/" but matches "./dir/test/"
;; Maybe it's a fd bug.
(defcustom ffip-prune-patterns
'(;; VCS
"*/.git"
"*/.svn"
"*/.cvs"
"*/.tox"
"*/.bzr"
"*/.hg"
"*/.DS_Store"
"*/.sass-cache"
"*/elpy"
"*/dcache"
"*/.npm"
"*/.tmp"
"*/.idea"
"*/node_modules"
"*/bower_components"
"*/.gradle"
"*/.cask")
"Ignored directories(prune patterns)."
:group 'ffip
:type '(repeat string))
(defcustom ffip-ignore-filenames
'(;; VCS
;; project misc
"*.log"
;; Ctags
"tags"
"TAGS"
;; compressed
"*.tgz"
"*.gz"
"*.xz"
"*.zip"
"*.tar"
"*.rar"
;; Global/Cscope
"GTAGS"
"GPATH"
"GRTAGS"
"cscope.files"
;; html/javascript/css
"*bundle.js"
"*min.js"
"*min.css"
;; Images
"*.png"
"*.jpg"
"*.jpeg"
"*.gif"
"*.bmp"
"*.tiff"
"*.ico"
;; documents
"*.doc"
"*.docx"
"*.xls"
"*.ppt"
"*.odt"
;; C/C++
"*.obj"
"*.so"
"*.o"
"*.a"
"*.ifso"
"*.tbd"
"*.dylib"
"*.lib"
"*.d"
"*.dll"
"*.exe"
;; Java
".metadata*"
"*.class"
"*.war"
"*.jar"
;; Emacs/Vim
"*flymake"
"#*#"
".#*"
"*.swp"
"*~"
"*.elc"
;; Python
"*.pyc")
"Ignored file names. Wildcast is supported."
:group 'ffip
:type '(repeat string))
(defcustom ffip-find-options ""
"Extra options to pass to `find' when using `find-file-in-project'.
Use this to exclude portions of your project: \"-not -regex \\\".*svn.*\\\"\"."
:group 'ffip
:type 'string)
(defcustom ffip-find-pre-path-options ""
"Options for find program.
GNU Find requires '-H', '-L', '-P', '-D' and `-O' appear before first path '.'.
For example, use '-L' to follow symbolic links."
:group 'ffip
:type 'string)
(defcustom ffip-project-root nil
"If non-nil, overrides the project root directory location."
:group 'ffip
:type 'string)
(defcustom ffip-project-root-function nil
"If non-nil, this function is called to determine the project root.
This overrides variable `ffip-project-root' when set."
:group 'ffip
:type 'function)
(defvar ffip-debug nil "Print debug information.")
;;;###autoload
(defun ffip-copy-without-change (p)
"Copy P without change."
(kill-new p)
(message "%s => kill-ring" p))
;;;###autoload
(defun ffip-copy-reactjs-import(p)
"Create ReactJS link from P and copy the result."
(setq p (format "import str from '%s';" p))
(kill-new p)
(message "%s => kill-ring" p))
;;;###autoload
(defun ffip-copy-org-file-link(p)
"Create org link from P and copy the result."
(setq p (format "[[file:%s]]" p))
(kill-new p)
(message "%s => kill-ring" p))
;;;###autoload
(defcustom ffip-find-relative-path-callback 'ffip-copy-without-change
"The callback after calling `find-relative-path'."
:group 'ffip
:type 'function)
(defun ffip--some (predicate seq)
"Return if PREDICATE is t for any element of SEQ."
(let* (elem rlt)
(while (and (setq elem (car seq))
(not rlt))
(setq seq (cdr seq))
(setq rlt (funcall predicate elem)))
rlt))
;;;###autoload
(defun ffip-project-root ()
"Return project root or `default-directory'."
(let* ((project-root (or ffip-project-root
(cond
((functionp ffip-project-root-function)
(funcall ffip-project-root-function))
((listp ffip-project-file)
(ffip--some (apply-partially 'locate-dominating-file
default-directory)
ffip-project-file))
(t
(locate-dominating-file default-directory
ffip-project-file))))))
(or (and project-root (file-name-as-directory project-root))
default-directory)))
(defun ffip--read-file-text (file)
"Read text from FILE."
(read (decode-coding-string
(with-temp-buffer
(set-buffer-multibyte nil)
(setq buffer-file-coding-system 'binary)
(insert-file-contents-literally file)
(buffer-substring-no-properties (point-min) (point-max))) 'utf-8)))
;;;###autoload
(defun ffip-get-project-root-directory ()
"Get the full path of project root directory."
(if ffip-project-root (file-name-as-directory ffip-project-root)
(ffip-project-root)))
;;;###autoload
(defun ffip-filename-identity (keyword)
"Return identical KEYWORD."
keyword)
;;;###autoload
(defun ffip-filename-camelcase-to-dashes (keyword &optional check-only)
"Convert KEYWORD from camel cased to dash separated.
If CHECK-ONLY is true, only do the check."
(let* (rlt)
(cond
(check-only
(setq rlt (string-match "^[a-z0-9]+[A-Z][A-Za-z0-9]+$" keyword))
(if ffip-debug (message "ffip-filename-camelcase-to-dashes called. check-only keyword=%s rlt=%s" keyword rlt)))
(t
(let* ((case-fold-search nil))
;; case sensitive replace
(setq rlt (downcase (replace-regexp-in-string "\\([a-z]\\)\\([A-Z]\\)" "\\1-\\2" keyword))))
(if (string= rlt (downcase keyword)) (setq rlt nil))
(if (and rlt ffip-debug) (message "ffip-filename-camelcase-to-dashes called. rlt=%s" rlt))))
rlt))
;;;###autoload
(defun ffip-filename-dashes-to-camelcase (keyword &optional check-only)
"Convert KEYWORD from dash separated to camel cased.
If CHECK-ONLY is true, only do the check."
(let* (rlt)
(cond
(check-only
(setq rlt (string-match "^[A-Za-z0-9]+\\(-[A-Za-z0-9]+\\)+$" keyword))
(if ffip-debug (message "ffip-filename-dashes-to-camelcase called. check-only keyword=%s rlt=%s" keyword rlt)))
(t
(setq rlt (mapconcat (lambda (s) (capitalize s)) (split-string keyword "-") ""))
(let ((first-char (substring rlt 0 1)))
(setq rlt (concat "[" first-char (downcase first-char) "]" (substring rlt 1))))
(if (and rlt ffip-debug) (message "ffip-filename-dashes-to-camelcase called. rlt=%s" rlt))))
rlt))
(defun ffip--create-filename-pattern-for-gnufind (keyword)
"Create search pattern from KEYWORD."
(let* ((rlt ""))
(cond
((not keyword)
(setq rlt ""))
(t
(setq rlt (concat (if ffip-match-path-instead-of-filename "-iwholename" "-iname")
" \"*"
keyword
"*\"" ))))
(if ffip-debug (message "ffip--create-filename-pattern-for-gnufind called. rlt=%s" rlt))
rlt))
(defun ffip--win-executable-find (exe)
"Find EXE on windows."
(let* ((drivers '("c" "d" "e" "g" "h" "i" "j" "k"))
(i 0)
j
(dirs '(":\\\\cygwin64\\\\bin\\\\"
":\\\\cygwin-portable\\\\cygwin\\\\bin\\\\"
":\\\\msys64\\\\usr\\\\bin\\\\"))
rlt)
(while (and (not rlt)
(< i (length dirs)))
(setq j 0)
(while (and (not rlt)
(< j (length drivers)))
(setq rlt (executable-find (concat (nth j drivers) (nth i dirs) exe)))
(setq j (1+ j)))
(setq i (1+ i)))
(unless rlt
;; nothing found, fall back to exe
(setq rlt exe))
rlt))
(defun ffip--executable-find ()
"Find EXE on all environments."
(let* ((exe (if ffip-use-rust-fd "fd" "find"))
rlt)
(cond
((file-remote-p default-directory)
;; In tramp mode and local windows, remote nix-like,
;; the `ffip-find-executable' with windows path can't be applied.
;; Assume remote server has already added EXE into $PATH!
;; Thanks for ShuguangSun for the fix
(setq rlt exe))
((setq rlt ffip-find-executable))
((eq system-type 'windows-nt)
;; in case PATH is not setup properly
(cond
(ffip-use-rust-fd
(setq rlt (concat (getenv "USERPROFILE")
"\\\\.cargo\\\\bin\\\\"
exe
".exe"))
(unless (file-exists-p rlt)
(setq rlt exe)))
(t
(setq rlt (ffip--win-executable-find exe)))))
((setq rlt (executable-find exe)))
(t
;; well, `executable-find' failed
(setq rlt exe)))
rlt))
(defun ffip--join-patterns (patterns)
"Convert PATTERNS into cli arguments."
(cond
((and ffip-patterns (not ffip-use-rust-fd))
(format "\\( %s \\)" (mapconcat (lambda (pat) (format "-iwholename \"%s\"" pat))
patterns " -or ")))
(t
;; rust fd only supports ONE pattern (and it's regular expression)
;; which is precious resource to waste here
"")))
(defun ffip--prune-patterns ()
"Turn `ffip-prune-patterns' into a string that `find' can use."
;; Both fd and find use "glob pattern"
;; @see https://en.wikipedia.org/wiki/Glob_%28programming%29
(cond
(ffip-use-rust-fd
;; fd match relative path
(mapconcat (lambda (p)
(format "-E \"%s\"" (replace-regexp-in-string "^\*/" "" p)))
ffip-prune-patterns " "))
(t
;; find match whole path
(mapconcat (lambda (p)
(format "-iwholename \"%s\"" p))
ffip-prune-patterns " -or "))))
(defun ffip--ignore-file-names ()
"Turn `ffip-ignore-filenames' into a string that `find' can use."
;; @see `ffip-prune-patterns' for fd vs find.
(cond
(ffip-use-rust-fd
(mapconcat (lambda (p)
(format "-E \"%s\"" p))
ffip-ignore-filenames " "))
(t
(mapconcat (lambda (n) (format "-not -name \"%s\"" n))
ffip-ignore-filenames " "))))
(defun ffip--file-completion-table (all-files)
;; direct copy of project--file-completion-table
(lambda (string pred action)
(cond
((eq action 'metadata)
'(metadata . ((category . project-file))))
(t
(complete-with-action action all-files string pred)))))
;;;###autoload
(defun ffip-completing-read (prompt collection &optional action)
"Read a string in minibuffer, with completion.
PROMPT is a string with same format parameters in `completing-read'.
COLLECTION is a list of strings.
ACTION is a lambda function to call after selecting a result.
This function returns the selected candidate or nil."
(let* (selected)
(cond
((= 1 (length collection))
;; select the only candidate immediately
(setq selected (car collection)))
(ffip-prefer-ido-mode
;; ido can only handle list of strings
(setq selected (ido-completing-read prompt (mapcar 'car collection))))
(t
(setq selected
(completing-read prompt (ffip--file-completion-table collection)))
(setq selected (or (assoc selected collection) selected))))
(when selected
;; make sure only the string/file is passed to action
(let* ((default-directory (ffip-get-project-root-directory))
(result (if (consp selected) (cdr selected) selected)))
(if action (funcall action result) result)))))
(defun ffip-create-shell-command (keyword find-directory-p)
"Produce command to search KEYWORD.
If FIND-DIRECTORY-P is t, we look up directory instead of file.
Rust fd use regular expression.
BSD/GNU Find use glob pattern."
(let* (cmd fmt tgt)
(cond
(ffip-use-rust-fd
;; `-H` => search hidden files
;; `-E` => exclude pattern
;; `-c` => color
;; `-i` => case insensitive
;; `-t` => directory (d) or file (f)
;; `-p` => match full path
(setq fmt (concat "%s %s -c never -H -i -t %s %s %s %s"
(if ffip-rust-fd-respect-ignore-files "" " -I")
(if ffip-match-path-instead-of-filename " -p" "")
" "
ffip-rust-fd-extra-opts
" %s"))
;; fd use regular expression for target pattern (but glob pattern when excluding, sigh)
(setq tgt (if keyword (format "\".*%s\"" keyword) "")))
(t
(setq tgt
(if find-directory-p (format "-iwholename \"*%s\"" keyword)
(ffip--create-filename-pattern-for-gnufind keyword)))
(setq fmt (concat "%s "
ffip-find-pre-path-options
" . \\( %s \\) -prune -o -type %s %s %s %s %s -print"))))
(setq cmd (format fmt
(ffip--executable-find)
(ffip--prune-patterns)
(if find-directory-p "d" "f")
(ffip--ignore-file-names)
ffip-find-options
(ffip--join-patterns ffip-patterns)
tgt))
cmd))
(defun ffip-glob-to-regex (s)
"Convert glob pattern S into regular expression."
(setq s (replace-regexp-in-string "\\." "\\\\." s))
(setq s (replace-regexp-in-string "\*" ".*" s))
s)
(defmacro ffip-push-one-candidate (file result)
"Push FILE into RESULT."
;; @see https://www.murilopereira.com/how-to-open-a-file-in-emacs/
;; also @see #15 improving handling of directories containing space
`(push (cons (replace-regexp-in-string "^\./" "" ,file) ,file) ,result))
(defun ffip-project-search-default-function (find-command)
"Execute FIND-COMMAND in shell and split its output into lines."
(if ffip-debug "ffip-project-search-default-function => find-command=%s" find-command)
(split-string (shell-command-to-string find-command) "[\r\n]+" t))
;;;###autoload
(defun ffip-project-search (keyword &optional find-directory-p)
"Return an alist of all filenames in the project and their path.
Files with duplicate filenames are suffixed with the name of the
directory they are found in so that they are unique.
If KEYWORD is string, it's the file name or file path to find file.
If KEYWORD is list, it's the list of file names.
IF FIND-DIRECTORY-P is t, we are searching directories, else files."
(let* ((default-directory (ffip-get-project-root-directory))
(cmd (ffip-create-shell-command keyword find-directory-p))
(collection (funcall ffip-project-search-function cmd))
rlt)
(if ffip-debug (message "run command at %s: %s" default-directory cmd))
;; use simple loop statement for clean code
(cond
((and ffip-use-rust-fd ffip-patterns)
(let* ((fd-file-pattern (concat "^"
(mapconcat 'ffip-glob-to-regex ffip-patterns "\\|")
"$")))
(dolist (file collection)
;; filter result with Lisp because fd does NOT support multiple patterns
(if (string-match fd-file-pattern file) (ffip-push-one-candidate file rlt)))))
(t
(dolist (file collection)
(ffip-push-one-candidate file rlt))))
(nreverse rlt)))
(defun ffip--forward-line (lnum)
"Forward LNUM lines."
(if ffip-debug (message "ffip--forward-line called => %s" lnum))
(when (and lnum (> lnum 0))
(goto-char (point-min))
(forward-line (1- lnum))))
(defun ffip-hint ()
"Hint."
(let ((root (ffip-get-project-root-directory)))
(format "Find in %s/: "
(file-name-nondirectory (directory-file-name root)))))
(defun ffip-select-and-open-file (files new-window-p directory-p fn lnum)
"Select and open file from FILES.
If NEW-WINDOW-P is t, create a new window for opened file.
If DIRECTORY-P is t, open directory instead of file.
IF the function FN is not nil, call it after opening the selected file.
After opening the file, forward LNUM lines."
(ffip-completing-read
(ffip-hint)
files
`(lambda (file)
;; only one item in project files
(if ,directory-p
(if (quote ,new-window-p)
(dired-other-window file)
(switch-to-buffer (dired file)))
;; open file
(if (quote ,new-window-p)
(find-file-other-window file)
(find-file file))
;; goto line if needed
(ffip--forward-line ,lnum)
(if ,fn (funcall ,fn file))))))
;;;###autoload
(defun ffip-find-files (keyword open-another-window &optional find-directory-p fn)
"Use KEYWORD to find files.
If OPEN-ANOTHER-WINDOW is t, the results are displayed in a new window.
If FIND-DIRECTORY-P is t, only search directories. FN is callback.
This function is the API to find files."
(let (cands lnum)
;; extract line num if exists
(when (and keyword (stringp keyword)
(string-match "^\\(.*\\):\\([0-9]+\\):?$" keyword))
(setq lnum (string-to-number (match-string 2 keyword)))
(setq keyword (match-string 1 keyword)))
(setq cands (ffip-project-search keyword find-directory-p))
(cond
((> (length cands) 0)
(unless (eq ffip-find-files-history-max-items 0)
;; save the history
(when (>= (length ffip-find-files-history)
ffip-find-files-history-max-items)
;; kick out the oldest item
(setq ffip-find-files-history (butlast ffip-find-files-history)))
;; add the latest item
(push (list :files cands
:keyword keyword
:directory-p find-directory-p
:function fn
:forward-lines lnum
:default-directory (ffip-get-project-root-directory))
ffip-find-files-history))
(ffip-select-and-open-file cands
open-another-window
find-directory-p
fn
lnum))
(t
(message "Nothing found!")))))
;;;###autoload
(defun ffip-find-files-resume (&optional n)
"Resume the last Nth `ffip-find-file' operation.
Please note N is zero originated."
(interactive "P")
(unless n (setq n 0))
(cond
((>= n ffip-find-files-history-max-items)
(message "There are only %d items in `ffip-find-files-history'."
ffip-find-files-history-max-items))
(t
(let* ((item (nth n ffip-find-files-history))
(default-directory (plist-get item :default-directory)))
(ffip-select-and-open-file (plist-get item :files)
nil
(plist-get item :directory-p)
(plist-get item :function)
(plist-get item :forward-lines))))))
(defun ffip--prepare-root-data-for-project-file (root)
"Prepare data for ROOT."
(cons 'ffip-project-root root))
(defun ffip--read-selected ()
"Read select string."
(buffer-substring-no-properties (region-beginning) (region-end)))
(defun ffip-read-keyword ()
"Read keyword from selected text or user input."
(let* ((hint (if ffip-use-rust-fd "Enter regex (or press ENTER): "
"Enter keyword (or press ENTER): "))
rlt)
(cond
((region-active-p)
(push (ffip--read-selected) ffip-filename-history)
(setq rlt (ffip--read-selected)))
(t
(setq rlt (read-from-minibuffer hint nil nil nil 'ffip-filename-history))))
(if rlt (string-trim rlt) rlt)))
;;;###autoload
(defun ffip-create-project-file ()
"Create or Append .dir-locals.el to set up per directory.
You can move .dir-locals.el to root directory.
See (info \"(Emacs) Directory Variables\") for details."
(interactive)
(let* ((root (read-directory-name "Project root directory: " default-directory))
(file (if (and root (file-exists-p root))
(concat (file-name-as-directory root) ".dir-locals.el"))))
(when file
(with-temp-buffer
(let ((print-level nil) (print-length nil) sexp)
(cond
;; modify existing .dir-locals.el
((file-exists-p file)
(let (sub-sexp new-sub-sexp)
(setq sexp (ffip--read-file-text file))
;; valid .dir-locals.el
(when sexp
;; the list for nil
(setq sub-sexp (assoc nil sexp))
(cond
;; `(nil (prop1 . val1) (prop2 . val2))' exists
(sub-sexp
;; remove (ffip-project-root . "/path/file")
(if (assoc 'ffip-project-root sub-sexp)
(setq new-sub-sexp (delete (assoc 'ffip-project-root sub-sexp) sub-sexp))
(setq new-sub-sexp sub-sexp))
(push (ffip--prepare-root-data-for-project-file root) new-sub-sexp)
;; update sexp
(setq sexp (delete sub-sexp sexp))
(push new-sub-sexp sexp))
(t
;; add `(nil (ffip-project-root . "path/file"))'
(push (list nil (ffip--prepare-root-data-for-project-file root)) sexp))))
))
(t
;; a new .dir-locals.el
(setq sexp (list (list nil (ffip--prepare-root-data-for-project-file root))))))
(when sexp
(insert (format "%S" sexp))
(write-file file)
(message "%s created." file)))))))
;;;###autoload
(defun ffip-current-full-filename-match-pattern-p (regex)
"Is current full file name (including directory) match the REGEX?"
(let* ((dir (if (buffer-file-name) (buffer-file-name) "")))
(string-match-p regex dir)))
;;;###autoload
(defun find-file-in-project (&optional open-another-window)
"More powerful and efficient `find-file-in-project-by-selected' is recommended.
Prompt with a completing list of all files in the project to find one.
If OPEN-ANOTHER-WINDOW is not nil, the file will be opened in new window.
The project's scope is defined as the first directory containing
a `ffip-project-file' whose value is \".git\" by default.
You can override this by setting the variable `ffip-project-root'."
(interactive "P")
(ffip-find-files nil open-another-window))
(defun ffip-file-name-relative-p (filename)
"Is FILENAME relative?"
(if (string-match-p ffip-relative-path-pattern filename) t))
(defun ffip-guess-file-name-at-point ()
"Guess file name at point. File name could contain environment variables."
(let* ((file (or (and (region-active-p) (ffip--read-selected))
(thing-at-point 'filename)
(thing-at-point 'symbol)
(read-string "No file name at point. Please provide one: "))))