-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathproject.el
2370 lines (2152 loc) · 96.3 KB
/
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
;;; project.el --- Operations on the current project -*- lexical-binding: t; -*-
;; Copyright (C) 2015-2025 Free Software Foundation, Inc.
;; Version: 0.11.1
;; Package-Requires: ((emacs "26.1") (xref "1.7.0"))
;; This is a GNU ELPA :core package. Avoid functionality that is not
;; compatible with the version of Emacs recorded above.
;; This file is part of GNU Emacs.
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; This file contains generic infrastructure for dealing with
;; projects, some utility functions, and commands using that
;; infrastructure.
;;
;; The goal is to make it easier for Lisp programs to operate on the
;; current project, without having to know which package handles
;; detection of that project type, parsing its config files, etc.
;;
;; This file consists of following parts:
;;
;; Infrastructure (the public API):
;;
;; Function `project-current' that returns the current project
;; instance based on the value of the hook `project-find-functions',
;; and several generic functions that act on it.
;;
;; `project-root' must be defined for every project.
;; `project-files' can be overridden for performance purposes.
;; `project-ignores' and `project-external-roots' describe the project
;; files and its relations to external directories. `project-files'
;; should be consistent with `project-ignores'.
;;
;; `project-buffers' can be overridden if the project has some unusual
;; shape (e.g. it contains files residing outside of its root, or some
;; files inside the root must not be considered a part of it). It
;; should be consistent with `project-files'.
;;
;; This list can change in future versions.
;;
;; Transient project:
;;
;; An instance of this type can be returned by `project-current' if no
;; project was detected automatically, and the user had to pick a
;; directory manually. The fileset it describes is the whole
;; directory, with the exception of some standard ignored files and
;; directories. This type has little purpose otherwise, as the only
;; generic function it provides an override for is `project-root'.
;;
;; VC-aware project:
;;
;; Originally conceived as an example implementation, now it's a
;; relatively fast backend that delegates to 'git ls-files' or 'hg
;; status' to list the project's files. It honors the VC ignore
;; files, but supports additions to the list using the user option
;; `project-vc-ignores' (usually through .dir-locals.el). See the
;; customization group `project-vc' for other options that control its
;; behavior.
;;
;; If the repository is using any other VCS than Git or Hg, the file
;; listing uses the default mechanism based on `find-program'.
;;
;; This project type can also be used for non-VCS controlled
;; directories, see the variable `project-vc-extra-root-markers'.
;;
;; Utils:
;;
;; `project-combine-directories' and `project-subtract-directories',
;; mainly for use in the abovementioned generics' implementations.
;;
;; `project-known-project-roots' and `project-remember-project' to
;; interact with the "known projects" list.
;;
;; Commands:
;;
;; `project-prefix-map' contains the full list of commands defined in
;; this package. This map uses the prefix `C-x p' by default.
;; Type `C-x p f' to find file in the current project.
;; Type `C-x p C-h' to see all available commands and bindings.
;;
;; All commands defined in this package are implemented using the
;; public API only. As a result, they will work with any project
;; backend that follows the protocol.
;;
;; Any third-party code that wants to use this package should likewise
;; target the public API. Use any of the built-in commands as the
;; example.
;;
;; How to create a new backend:
;;
;; - Consider whether you really should, or whether there are other
;; ways to reach your goals. If the backend's performance is
;; significantly lower than that of the built-in one, and it's first
;; in the list, it will affect all commands that use it. Unless you
;; are going to be using it only yourself or in special circumstances,
;; you will probably want it to be fast, and it's unlikely to be a
;; trivial endeavor. `project-files' is the method to optimize (the
;; default implementation gets slower the more files the directory
;; has, and the longer the list of ignores is).
;;
;; - Choose the format of the value that represents a project for your
;; backend (we call it project instance). Don't use any of the
;; formats from other backends. The format can be arbitrary, as long
;; as the datatype is something `cl-defmethod' can dispatch on. The
;; value should be stable (when compared with `equal') across
;; invocations, meaning calls to that function from buffers belonging
;; to the same project should return equal values.
;;
;; - Write a new function that will determine the current project
;; based on the directory and add it to `project-find-functions'
;; (which see) using `add-hook'. It is a good idea to depend on the
;; directory only, and not on the current major mode, for example.
;; Because the usual expectation is that all files in the directory
;; belong to the same project (even if some/most of them are ignored).
;;
;; - Define new methods for some or all generic functions for this
;; backend using `cl-defmethod'. A `project-root' method is
;; mandatory, `project-files' is recommended, the rest are optional.
;;; TODO:
;; * Reliably cache the list of files in the project, probably using
;; filenotify.el (if supported) to invalidate. And avoiding caching
;; if it's not available (manual cache invalidation is not nice).
;;
;; * Build tool related functionality. Start with a `project-build'
;; command, which should provide completions on tasks to run, and
;; maybe allow entering some additional arguments. This might
;; be handled better with a separate API, though. Then we won't
;; force every project backend to be aware of the build tool(s) the
;; project is using.
;;
;; * Command to (re)build the tag files in all project roots. To that
;; end, we might need to add a way to provide file whitelist
;; wildcards for each root to limit etags to certain files (in
;; addition to the blacklist provided by ignores), and/or allow
;; specifying additional tag regexps.
;;
;; * UI for the user to be able to pick the current project for the
;; whole Emacs session, independent of the current directory. Or,
;; in the more advanced case, open a set of projects, and have some
;; project-related commands to use them all. E.g., have a command
;; to search for a regexp across all open projects.
;;
;; * Support for project-local variables: a UI to edit them, and a
;; utility function to retrieve a value. Probably useless without
;; support in various built-in commands. In the API, we might get
;; away with only adding a `project-configuration-directory' method,
;; defaulting to the project root the current file/buffer is in.
;; And prompting otherwise. How to best mix that with backends that
;; want to set/provide certain variables themselves, is up for
;; discussion.
;;; Code:
(require 'cl-generic)
(require 'cl-lib)
(require 'seq)
(eval-when-compile (require 'subr-x))
(defgroup project nil
"Operations on the current project."
:version "28.1"
:group 'tools)
(defvar project-find-functions (list #'project-try-vc)
"Special hook to find the project containing a given directory.
Each functions on this hook is called in turn with one
argument, the directory in which to look, and should return
either nil to mean that it is not applicable, or a project instance.
The exact form of the project instance is up to each respective
function; the only practical limitation is to use values that
`cl-defmethod' can dispatch on, like a cons cell, or a list, or a
CL struct.")
(define-obsolete-variable-alias
'project-current-inhibit-prompt
'project-current-directory-override
"29.1")
(defvar project-current-directory-override nil
"Value to use instead of `default-directory' when detecting the project.
When it is non-nil, `project-current' will always skip prompting too.")
(defcustom project-prompter #'project-prompt-project-dir
"Function to call to prompt for a project.
The function is either called with no arguments or with one argument,
which is the prompt string to use. It should return a project root
directory."
:type '(choice (const :tag "Prompt for a project directory"
project-prompt-project-dir)
(const :tag "Prompt for a project name"
project-prompt-project-name)
(function :tag "Custom function" nil))
:group 'project
:version "30.1")
;;;###autoload
(defun project-current (&optional maybe-prompt directory)
"Return the project instance in DIRECTORY, defaulting to `default-directory'.
When no project is found in that directory, the result depends on
the value of MAYBE-PROMPT: if it is nil or omitted, return nil,
else prompt the user for the project to use. To prompt for a
project, call the function specified by `project-prompter', which
returns the directory in which to look for the project. If no
project is found in that directory, return a \"transient\"
project instance. When MAYBE-PROMPT is a string, it's passed to the
prompter function as an argument.
The \"transient\" project instance is a special kind of value
which denotes a project rooted in that directory and includes all
the files under the directory except for those that match entries
in `vc-directory-exclusion-list' or `grep-find-ignored-files'.
See the doc string of `project-find-functions' for the general form
of the project instance object."
(unless directory (setq directory (or project-current-directory-override
default-directory)))
(let* ((non-essential (not maybe-prompt))
(pr (project--find-in-directory directory)))
(cond
(pr)
((unless project-current-directory-override
maybe-prompt)
(setq directory (if (stringp maybe-prompt)
(funcall project-prompter maybe-prompt)
(funcall project-prompter))
pr (project--find-in-directory directory))))
(when maybe-prompt
(if pr
(project-remember-project pr)
(project--remove-from-project-list
directory "Project `%s' not found; removed from list")
(setq pr (cons 'transient directory))))
pr))
(defun project--find-in-directory (dir)
;; Use 'ignore-error' when 27.1 is the minimum supported.
(condition-case nil
(run-hook-with-args-until-success 'project-find-functions dir)
;; Maybe we'd like to continue to the next backend instead? Let's
;; see if somebody ever ends up in that situation.
(permission-denied nil)))
(defvar project--within-roots-fallback nil)
(cl-defgeneric project-root (project)
"Return root directory of the current project.
It usually contains the main build file, dependencies
configuration file, etc. Though neither is mandatory.
The directory name must be absolute.")
(cl-defmethod project-root (project
&context (project--within-roots-fallback
(eql nil)))
(car (project-roots project)))
(cl-defgeneric project-roots (project)
"Return the list containing the current project root.
The function is obsolete, all projects have one main root anyway,
and the rest should be possible to express through
`project-external-roots'."
;; FIXME: Can we specify project's version here?
;; FIXME: Could we make this affect cl-defmethod calls too?
(declare (obsolete project-root "0.3.0"))
(let ((project--within-roots-fallback t))
(list (project-root project))))
;; FIXME: Add MODE argument, like in `ede-source-paths'?
(cl-defgeneric project-external-roots (_project)
"Return the list of external roots for PROJECT.
It's the list of directories outside of the project that are
still related to it. If the project deals with source code then,
depending on the languages used, this list should include the
headers search path, load path, class path, and so on."
nil)
(cl-defgeneric project-name (project)
"A human-readable name for the PROJECT.
Nominally unique, but not enforced."
(file-name-nondirectory (directory-file-name (project-root project))))
(cl-defgeneric project-ignores (_project dir)
"Return the list of glob patterns to ignore inside DIR.
Patterns can match both regular files and directories.
To root an entry, start it with `./'. To match directories only,
end it with `/'. DIR must be either `project-root' or one of
`project-external-roots'."
;; TODO: Document and support regexp ignores as used by Hg.
;; TODO: Support whitelist entries.
(require 'grep)
(defvar grep-find-ignored-files)
(declare-function grep-find-ignored-files "grep" (dir))
(nconc
(mapcar
(lambda (dir)
(concat dir "/"))
vc-directory-exclusion-list)
(if (fboundp 'grep-find-ignored-files)
(grep-find-ignored-files dir)
grep-find-ignored-files)))
(defun project--file-completion-table (all-files)
(lambda (string pred action)
(cond
((eq action 'metadata)
'(metadata . ((category . project-file))))
(t
(complete-with-action action all-files string pred)))))
(cl-defmethod project-root ((project (head transient)))
(cdr project))
(defvar project-files-relative-names nil
"If non-nil, `project-files' is allowed to return relative file names.
The file names should be relative to the project root. And this can
only happen when all returned files are in the same directory.
In other words, the DIRS argument of `project-files' has to be nil or a
list of only one element.
This variable is only meant to be set by Lisp code, not customized by
the user.")
(cl-defgeneric project-files (project &optional dirs)
"Return a list of files in directories DIRS in PROJECT.
DIRS is a list of absolute directories; it should be some
subset of the project root and external roots.
The default implementation uses `find-program'. PROJECT is used
to find the list of ignores for each directory."
(mapcan
(lambda (dir)
(project--files-in-directory dir
(project--dir-ignores project dir)))
(or dirs
(list (project-root project)))))
(defun project--files-in-directory (dir ignores &optional files)
(require 'find-dired)
(require 'xref)
(let* ((dir (file-name-as-directory dir))
(default-directory dir)
;; Make sure ~/ etc. in local directory name is
;; expanded and not left for the shell command
;; to interpret.
(localdir (file-name-unquote (file-local-name (expand-file-name dir))))
(command (format "%s -H . %s -type f %s -print0"
find-program
(xref--find-ignores-arguments ignores "./")
(if files
(concat (shell-quote-argument "(")
" -name "
(mapconcat
#'shell-quote-argument
(split-string files)
(concat " -o -name "))
" "
(shell-quote-argument ")"))
"")))
res)
(with-temp-buffer
(let ((status
(process-file-shell-command command nil t))
(pt (point-min)))
(unless (zerop status)
(goto-char (point-min))
(if (and
(not (eql status 127))
(search-forward "Permission denied\n" nil t))
(let ((end (1- (point))))
(re-search-backward "\\`\\|\0")
(error "File listing failed: %s"
(buffer-substring (1+ (point)) end)))
(error "File listing failed: %s" (buffer-string))))
(goto-char pt)
(while (search-forward "\0" nil t)
(push (buffer-substring-no-properties (+ pt 2) (1- (point)))
res)
(setq pt (point)))))
(if project-files-relative-names
(sort res #'string<)
(project--remote-file-names
(mapcar (lambda (s) (concat localdir s))
(sort res #'string<))))))
(defun project--remote-file-names (local-files)
"Return LOCAL-FILES as if they were on the system of `default-directory'.
Also quote LOCAL-FILES if `default-directory' is quoted."
(let ((remote-id (file-remote-p default-directory)))
(if (not remote-id)
(if (file-name-quoted-p default-directory)
(mapcar #'file-name-quote local-files)
local-files)
(mapcar (lambda (file)
(concat remote-id file))
local-files))))
(cl-defgeneric project-buffers (project)
"Return the list of all live buffers that belong to PROJECT.
The default implementation matches each buffer to PROJECT root using
the buffer's value of `default-directory'."
(let ((root (expand-file-name (file-name-as-directory (project-root project))))
bufs)
(dolist (buf (buffer-list))
(when (string-prefix-p root (expand-file-name
(buffer-local-value 'default-directory buf)))
(push buf bufs)))
(nreverse bufs)))
(defgroup project-vc nil
"VC-aware project implementation."
:version "25.1"
:group 'project)
(defcustom project-vc-ignores nil
"List of patterns to add to `project-ignores'."
:type '(repeat string))
;; Change to `list-of-strings-p' when support for Emacs 28 is dropped.
;;;###autoload(put 'project-vc-ignores 'safe-local-variable (lambda (val) (and (listp val) (not (memq nil (mapcar #'stringp val))))))
(defcustom project-vc-merge-submodules t
"Non-nil to consider submodules part of the parent project.
After changing this variable (using Customize or .dir-locals.el)
you might have to restart Emacs to see the effect."
:type 'boolean
:version "28.1"
:package-version '(project . "0.2.0"))
;;;###autoload(put 'project-vc-merge-submodules 'safe-local-variable #'booleanp)
(defcustom project-vc-include-untracked t
"When non-nil, the VC-aware project backend includes untracked files."
:type 'boolean
:version "29.1")
;;;###autoload(put 'project-vc-include-untracked 'safe-local-variable #'booleanp)
(defcustom project-vc-name nil
"When non-nil, the name of the current VC-aware project.
The best way to change the value a VC-aware project reports as
its name, is by setting this in .dir-locals.el."
:type '(choice (const :tag "Default to the base name" nil)
(string :tag "Custom name"))
:version "29.1"
:package-version '(project . "0.9.0"))
;;;###autoload(put 'project-vc-name 'safe-local-variable #'stringp)
;; Not using regexps because these wouldn't work in Git pathspecs, in
;; case we decide we need to be able to list nested projects.
(defcustom project-vc-extra-root-markers nil
"List of additional markers to signal project roots.
A marker is either a base file name or a glob pattern for such.
A directory containing such a marker file or a file matching a
marker pattern will be recognized as the root of a VC-aware
project.
Example values: \".dir-locals.el\", \"package.json\", \"pom.xml\",
\"requirements.txt\", \"Gemfile\", \"*.gemspec\", \"autogen.sh\".
These will be used in addition to regular directory markers such
as \".git\", \".hg\", and so on, depending on the value of
`vc-handled-backends'. It is most useful when a project has
subdirectories inside it that need to be considered as separate
projects. It can also be used for projects outside of VC
repositories.
In either case, their behavior will still obey the relevant
variables, such as `project-vc-ignores' or `project-vc-name'."
:type '(repeat string)
:version "29.1"
:package-version '(project . "0.9.0"))
;; Change to `list-of-strings-p' when support for Emacs 28 is dropped.
;;;###autoload(put 'project-vc-extra-root-markers 'safe-local-variable (lambda (val) (and (listp val) (not (memq nil (mapcar #'stringp val))))))
;; FIXME: Using the current approach, major modes are supposed to set
;; this variable to a buffer-local value. So we don't have access to
;; the "external roots" of language A from buffers of language B, which
;; seems desirable in multi-language projects, at least for some
;; potential uses, like "jump to a file in project or external dirs".
;;
;; We could add a second argument to this function: a file extension,
;; or a language name. Some projects will know the set of languages
;; used in them; for others, like the VC-aware type, we'll need
;; auto-detection. I see two options:
;;
;; - That could be implemented as a separate second hook, with a
;; list of functions that return file extensions.
;;
;; - This variable will be turned into a hook with "append" semantics,
;; and each function in it will perform auto-detection when passed
;; nil instead of an actual file extension. Then this hook will, in
;; general, be modified globally, and not from major mode functions.
;;
;; The second option seems simpler, but the first one has the
;; advantage that the user could override the list of languages used
;; in a project via a directory-local variable, thus skipping
;; languages they're not working on personally (in a big project), or
;; working around problems in language detection (the detection logic
;; might be imperfect for the project in question, or it might work
;; too slowly for the user's taste).
(defvar project-vc-external-roots-function (lambda () tags-table-list)
"Function that returns a list of external roots.
It should return a list of directory roots that contain source
files related to the current buffer.
The directory names should be absolute. Used in the VC-aware
project backend implementation of `project-external-roots'.")
(defvar project-vc-backend-markers-alist
`((Git . ".git")
(Hg . ".hg")
(Bzr . ".bzr")
;; See the comment above `vc-svn-admin-directory' for why we're
;; duplicating the definition.
(SVN . ,(if (and (memq system-type '(cygwin windows-nt ms-dos))
(getenv "SVN_ASP_DOT_NET_HACK"))
"_svn"
".svn"))
(DARCS . "_darcs")
(Fossil . ".fslckout")
(Got . ".got"))
"Associative list assigning root markers to VC backend symbols.
See `project-vc-extra-root-markers' for the marker value format.")
(defun project-try-vc (dir)
;; FIXME: Learn to invalidate when the value changes:
;; `project-vc-merge-submodules' or `project-vc-extra-root-markers'.
(or (vc-file-getprop dir 'project-vc)
;; FIXME: Cache for a shorter time.
(let ((res (project-try-vc--search dir)))
(and res (vc-file-setprop dir 'project-vc res))
res)))
(defun project-try-vc--search (dir)
(let* ((backend-markers
(delete
nil
(mapcar
(lambda (b) (assoc-default b project-vc-backend-markers-alist))
vc-handled-backends)))
(marker-re
(concat
"\\`"
(mapconcat
(lambda (m) (format "\\(%s\\)" (wildcard-to-regexp m)))
(append backend-markers
(project--value-in-dir 'project-vc-extra-root-markers dir))
"\\|")
"\\'"))
(locate-dominating-stop-dir-regexp
(or vc-ignore-dir-regexp locate-dominating-stop-dir-regexp))
last-matches
(root
(locate-dominating-file
dir
(lambda (d)
;; Maybe limit count to 100 when we can drop Emacs < 28.
(setq last-matches
(condition-case nil
(directory-files d nil marker-re t)
(file-missing nil))))))
(backend
(cl-find-if
(lambda (b)
(member (assoc-default b project-vc-backend-markers-alist)
last-matches))
vc-handled-backends))
project)
(while (and
(eq backend 'Git)
(project--vc-merge-submodules-p root)
(project--submodule-p root))
(let* ((parent (file-name-directory (directory-file-name root))))
(setq root (vc-call-backend 'Git 'root parent))))
(when root
(when (not backend)
(let* ((project-vc-extra-root-markers nil)
;; Avoid submodules scan.
(enable-dir-local-variables nil)
(parent (project-try-vc--search root)))
(and parent (setq backend (nth 1 parent)))))
(setq project (list 'vc backend root))
project)))
(defun project--submodule-p (root)
;; XXX: We only support Git submodules for now.
;;
;; For submodules, at least, we expect the users to prefer them to
;; be considered part of the parent project. For those who don't,
;; there is the custom var now.
;;
;; Some users may also set up things equivalent to Git submodules
;; using "git worktree" (for example). However, we expect that most
;; of them would prefer to treat those as separate projects anyway.
(let* ((gitfile (expand-file-name ".git" root)))
(cond
((file-directory-p gitfile)
nil)
((with-temp-buffer
(insert-file-contents gitfile)
(goto-char (point-min))
;; Kind of a hack to distinguish a submodule from
;; other cases of .git files pointing elsewhere.
(looking-at "gitdir: .+/\\.git/\\(worktrees/.*\\)?modules/"))
t)
(t nil))))
(cl-defmethod project-root ((project (head vc)))
(nth 2 project))
(cl-defmethod project-external-roots ((project (head vc)))
(project-subtract-directories
(project-combine-directories
(mapcar
#'file-name-as-directory
(funcall project-vc-external-roots-function)))
(list (project-root project))))
(cl-defmethod project-files ((project (head vc)) &optional dirs)
(mapcan
(lambda (dir)
(let ((ignores (project--value-in-dir 'project-vc-ignores (nth 2 project)))
(backend (cadr project)))
(when backend
(require (intern (concat "vc-" (downcase (symbol-name backend))))))
(if (and (file-equal-p dir (nth 2 project))
(cond
((eq backend 'Hg))
((and (eq backend 'Git)
(or
(not ignores)
(version<= "1.9" (vc-git--program-version)))))))
(project--vc-list-files dir backend ignores)
(project--files-in-directory
dir
(project--dir-ignores project dir)))))
(or dirs
(list (project-root project)))))
(declare-function vc-git--program-version "vc-git")
(declare-function vc-git-command "vc-git")
(declare-function vc-hg-command "vc-hg")
(defun project--vc-list-files (dir backend extra-ignores)
(defvar vc-git-use-literal-pathspecs)
(pcase backend
(`Git
(let* ((default-directory (expand-file-name (file-name-as-directory dir)))
(args '("-z" "-c" "--exclude-standard"))
(vc-git-use-literal-pathspecs nil)
(include-untracked (project--value-in-dir
'project-vc-include-untracked
dir))
(submodules (project--git-submodules))
files)
(setq args (append args
(and (<= 31 emacs-major-version)
(version<= "2.35" (vc-git--program-version))
'("--sparse"))
(and include-untracked '("-o"))))
(when extra-ignores
(setq args (append args
(cons "--"
(mapcar
(lambda (i)
(format
":(exclude,glob,top)%s"
(if (string-match "\\*\\*" i)
;; Looks like pathspec glob
;; format already.
i
(if (string-match "\\./" i)
;; ./abc -> abc
(setq i (substring i 2))
;; abc -> **/abc
(setq i (concat "**/" i))
;; FIXME: '**/abc' should also
;; match a directory with that
;; name, but doesn't (git 2.25.1).
;; Maybe we should replace
;; such entries with two.
(if (string-match "/\\'" i)
;; abc/ -> abc/**
(setq i (concat i "**"))))
i)))
extra-ignores)))))
(setq files
(delq nil
(mapcar
(lambda (file)
(unless (or (member file submodules)
;; Should occur for sparse directories
;; only, when sparse index is enabled.
(directory-name-p file))
(if project-files-relative-names
file
(concat default-directory file))))
(split-string
(with-output-to-string
(apply #'vc-git-command standard-output 0 nil "ls-files" args))
"\0" t))))
(when (project--vc-merge-submodules-p default-directory)
;; Unfortunately, 'ls-files --recurse-submodules' conflicts with '-o'.
(let ((sub-files
(mapcar
(lambda (module)
(when (file-directory-p module)
(let ((sub-files
(project--vc-list-files
(concat default-directory module)
backend
extra-ignores)))
(if project-files-relative-names
(mapcar (lambda (file)
(concat (file-name-as-directory module) file))
sub-files)
sub-files))))
submodules)))
(setq files
(apply #'nconc files sub-files))))
;; 'git ls-files' returns duplicate entries for merge conflicts.
;; XXX: Better solutions welcome, but this seems cheap enough.
(delete-consecutive-dups files)))
(`Hg
(let* ((default-directory (expand-file-name (file-name-as-directory dir)))
(include-untracked (project--value-in-dir
'project-vc-include-untracked
dir))
(args (list (concat "-mcard" (and include-untracked "u"))
"--no-status"
"-0"))
files)
(when extra-ignores
(setq args (nconc args
(mapcan
(lambda (i)
(list "--exclude" i))
extra-ignores))))
(with-temp-buffer
(apply #'vc-hg-command t 0 "." "status" args)
(setq files (split-string (buffer-string) "\0" t))
(unless project-files-relative-names
(setq files (mapcar
(lambda (s) (concat default-directory s))
files)))
files)))))
(defun project--vc-merge-submodules-p (dir)
(project--value-in-dir
'project-vc-merge-submodules
dir))
(defun project--git-submodules ()
;; 'git submodule foreach' is much slower.
(condition-case nil
(with-temp-buffer
(insert-file-contents ".gitmodules")
(let (res)
(goto-char (point-min))
(while (re-search-forward "^[ \t]*path *= *\\(.+\\)" nil t)
(push (match-string 1) res))
(nreverse res)))
(file-missing nil)))
(cl-defmethod project-ignores ((project (head vc)) dir)
(let* ((root (nth 2 project))
(backend (cadr project)))
(append
(when (and backend
(file-equal-p dir root))
(delq
nil
(mapcar
(lambda (entry)
(cond
((eq ?! (aref entry 0))
;; No support for whitelisting (yet).
nil)
((string-match "\\(/\\)[^/]" entry)
;; FIXME: This seems to be Git-specific.
;; And / in the entry (start or even the middle) means
;; the pattern is "rooted". Or actually it is then
;; relative to its respective .gitignore (of which there
;; could be several), but we only support .gitignore at
;; the root.
(if (= (match-beginning 0) 0)
(replace-match "./" t t entry 1)
(concat "./" entry)))
(t entry)))
(condition-case nil
(vc-call-backend backend 'ignore-completion-table root)
(vc-not-supported () nil)))))
(project--value-in-dir 'project-vc-ignores root)
(mapcar
(lambda (dir)
(concat dir "/"))
vc-directory-exclusion-list))))
(defun project-combine-directories (&rest lists-of-dirs)
"Return a sorted and culled list of directory names.
Appends the elements of LISTS-OF-DIRS together, removes
non-existing directories, as well as directories a parent of
whose is already in the list."
(let* ((dirs (sort
(mapcar
(lambda (dir)
(file-name-as-directory (expand-file-name dir)))
(apply #'append lists-of-dirs))
#'string<))
(ref dirs))
;; Delete subdirectories from the list.
(while (cdr ref)
(if (string-prefix-p (car ref) (cadr ref))
(setcdr ref (cddr ref))
(setq ref (cdr ref))))
(cl-delete-if-not #'file-exists-p dirs)))
(defun project-subtract-directories (files dirs)
"Return a list of elements from FILES that are outside of DIRS.
DIRS must contain directory names."
;; Sidestep the issue of expanded/abbreviated file names here.
(cl-set-difference files dirs :test #'file-in-directory-p))
(defun project--value-in-dir (var dir)
(with-temp-buffer
(setq default-directory dir)
(let ((enable-local-variables :all))
(hack-dir-local-variables))
;; Don't use `hack-local-variables-apply' to avoid setting modes.
(alist-get var file-local-variables-alist
(symbol-value var))))
(cl-defmethod project-buffers ((project (head vc)))
(let* ((root (expand-file-name (file-name-as-directory (project-root project))))
(modules (unless (or (project--vc-merge-submodules-p root)
(condition-case nil
(project--submodule-p root)
(file-missing nil)))
(mapcar
(lambda (m) (format "%s%s/" root m))
(project--git-submodules))))
dd
bufs)
(dolist (buf (buffer-list))
(setq dd (expand-file-name (buffer-local-value 'default-directory buf)))
(when (and (string-prefix-p root dd)
(not (cl-find-if (lambda (module) (string-prefix-p module dd))
modules)))
(push buf bufs)))
(nreverse bufs)))
(cl-defmethod project-name ((project (head vc)))
(or (project--value-in-dir 'project-vc-name (project-root project))
(cl-call-next-method)))
;;; Project commands
;;;###autoload
(defvar project-prefix-map
(let ((map (make-sparse-keymap)))
(define-key map "!" 'project-shell-command)
(define-key map "&" 'project-async-shell-command)
(define-key map "f" 'project-find-file)
(define-key map "F" 'project-or-external-find-file)
(define-key map "b" 'project-switch-to-buffer)
(define-key map "s" 'project-shell)
(define-key map "d" 'project-find-dir)
(define-key map "D" 'project-dired)
(define-key map "v" 'project-vc-dir)
(define-key map "c" 'project-compile)
(define-key map "e" 'project-eshell)
(define-key map "k" 'project-kill-buffers)
(define-key map "p" 'project-switch-project)
(define-key map "g" 'project-find-regexp)
(define-key map "G" 'project-or-external-find-regexp)
(define-key map "r" 'project-query-replace-regexp)
(define-key map "x" 'project-execute-extended-command)
(define-key map "o" 'project-any-command)
(define-key map "\C-b" 'project-list-buffers)
map)
"Keymap for project commands.")
;;;###autoload (define-key ctl-x-map "p" project-prefix-map)
;; We can't have these place-specific maps inherit from
;; project-prefix-map because project--other-place-command needs to
;; know which map the key binding came from, as if it came from one of
;; these maps, we don't want to set display-buffer-overriding-action
(defvar project-other-window-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-o" #'project-display-buffer)
map)
"Keymap for project commands that display buffers in other windows.")
(defvar project-other-frame-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-o" #'project-display-buffer-other-frame)
map)
"Keymap for project commands that display buffers in other frames.")
(defun project--other-place-command (action &optional map)
(let* ((key (read-key-sequence-vector nil t))
(place-cmd (lookup-key map key))
(generic-cmd (lookup-key project-prefix-map key))
(switch-to-buffer-obey-display-actions t)
(display-buffer-overriding-action (unless place-cmd action)))
(if-let* ((cmd (or place-cmd generic-cmd)))
(call-interactively cmd)
(user-error "%s is undefined" (key-description key)))))
(defun project--other-place-prefix (place &optional extra-keymap)
(cl-assert (member place '(window frame tab)))
(prefix-command-preserve-state)
(let ((inhibit-message t)) (funcall (intern (format "other-%s-prefix" place))))
(message "Display next project command buffer in a new %s..." place)
;; Should return exitfun from set-transient-map
(set-transient-map (if extra-keymap
(make-composed-keymap project-prefix-map
extra-keymap)
project-prefix-map)))
;;;###autoload
(defun project-other-window-command ()
"Run project command, displaying resultant buffer in another window.
The following commands are available:
\\{project-prefix-map}
\\{project-other-window-map}"
(interactive)
(if (< emacs-major-version 30)
(project--other-place-command '((display-buffer-pop-up-window)
(inhibit-same-window . t))
project-other-window-map)
(project--other-place-prefix 'window project-other-window-map)))
;;;###autoload (define-key ctl-x-4-map "p" #'project-other-window-command)
;;;###autoload
(defun project-other-frame-command ()
"Run project command, displaying resultant buffer in another frame.
The following commands are available:
\\{project-prefix-map}
\\{project-other-frame-map}"
(interactive)
(if (< emacs-major-version 30)
(project--other-place-command '((display-buffer-pop-up-frame))
project-other-frame-map)
(project--other-place-prefix 'frame project-other-frame-map)))
;;;###autoload (define-key ctl-x-5-map "p" #'project-other-frame-command)
;;;###autoload
(defun project-other-tab-command ()
"Run project command, displaying resultant buffer in a new tab.
The following commands are available:
\\{project-prefix-map}"
(interactive)
(if (< emacs-major-version 30)
(project--other-place-command '((display-buffer-in-new-tab)))
(project--other-place-prefix 'tab)))
;;;###autoload
(when (bound-and-true-p tab-prefix-map)
(define-key tab-prefix-map "p" #'project-other-tab-command))
(declare-function grep-read-files "grep")
(declare-function xref--find-ignores-arguments "xref")