-
-
Notifications
You must be signed in to change notification settings - Fork 28
/
borg.el
1308 lines (1176 loc) · 53.7 KB
/
borg.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
;;; borg.el --- Assimilate Emacs packages as Git submodules -*- lexical-binding:t -*-
;; Copyright (C) 2016-2024 Jonas Bernoulli
;; Author: Jonas Bernoulli <emacs.borg@jonas.bernoulli.dev>
;; Homepage: https://github.com/emacscollective/borg
;; Keywords: tools
;; Package-Version: 3.3.1.50-git
;; Package-Requires: (
;; (emacs "27.1")
;; (epkg "3.3.3")
;; (magit "3.3.0"))
;; SPDX-License-Identifier: GPL-3.0-or-later
;; This file 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 file 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 file. If not, see <https://www.gnu.org/licenses/>.
;; This file contains code taken from GNU Emacs, which is
;; Copyright (C) 1976-2023 Free Software Foundation, Inc.
;;; Commentary:
;; The Borg assimilate Emacs packages as Git submodules. Borg is
;; an alternative, bare-bones package manager for Emacs packages.
;; Please consult the manual for more information:
;; https://www.emacsmirror.net/manual/borg.
;; Borg can be used by itself or alongside `package.el'. In the
;; latter case Borg itself should be installed from Melpa, which
;; is still experimental and not yet covered in the manual. See
;; https://github.com/emacscollective/borg/issues/46 for now.
;;; Code:
(require 'bytecomp)
(require 'cl-lib)
(require 'info)
(require 'pcase)
(require 'subr-x)
(unless (require 'loaddefs-gen nil t)
(with-suppressed-warnings ((obsolete autoload))
(require 'autoload)))
(defvar generated-autoload-file)
(defvar autoload-excludes)
(declare-function eieio-oref "eieio-core" (obj slot))
(declare-function epkg "epkg" (name))
(declare-function epkgs "epkg" (&optional select predicates))
;; check-declare doesn't know about defclass.
;; (declare-function epkg-git-package-p "epkg" (obj))
;; (declare-function epkg-github-package-p "epkg" (obj))
;; (declare-function epkg-gitlab-package-p "epkg" (obj))
;; (declare-function epkg-orphaned-package-p "epkg" (obj))
(declare-function epkg-read-package "epkg" (prompt &optional default predicate))
(declare-function format-spec "format-spec"
(format specification &optional ignore-missing split))
(declare-function magit-get "magit-git" (&rest keys))
(declare-function magit-get-some-remote "magit-git" (&optional branch))
(declare-function org-texinfo-export-to-texinfo "ox-texinfo"
(&optional async subtreep visible-only body-only ext-plist))
(when (< emacs-major-version 26)
(defun register-definition-prefixes (_file _prefixes)))
(when (< emacs-major-version 28)
(defvar byte+native-compile)
(defvar comp-files-queue))
(defvar native-comp-eln-load-path)
(defvar native-compile-target-directory)
(defvar git-commit-mode-map)
(defvar compilation-mode-font-lock-keywords)
(eval-when-compile
(require (quote eieio))
(cl-pushnew 'url eieio--known-slot-names)
(cl-pushnew 'mirror-url eieio--known-slot-names))
(define-obsolete-variable-alias 'borg-drone-directory
'borg-drones-directory "Borg 3.2.0")
(define-obsolete-variable-alias 'borg-byte-compile-recursively
'borg-compile-recursively "Borg 3.3.0")
(define-obsolete-function-alias 'borg-byte-compile
#'borg-compile "Borg 3.3.0")
;;; Variables
(defvar borg-drones-directory
(let* ((libdir (file-name-directory (directory-file-name
(file-name-directory
(file-truename
(or load-file-name
buffer-file-name))))))
(topdir (file-name-directory (directory-file-name libdir))))
(or (ignore-errors
(let ((default-directory topdir))
(file-name-as-directory
(expand-file-name
(car (process-lines "git" "config" "borg.drones-directory"))))))
(if (ignore-errors
(file-equal-p libdir (bound-and-true-p package-user-dir)))
(expand-file-name (file-name-as-directory "borg") topdir)
libdir)))
"Directory beneath which drone submodules are placed.
If you need to change this, then do so before loading `borg'.")
(defconst borg-user-emacs-directory
(file-name-directory (directory-file-name borg-drones-directory))
"Directory beneath which additional per-user Emacs-specific files are placed.
The value of this variable is usually the same as that of
`user-emacs-directory', except when Emacs is started with
`emacs -q -l /path/to/init.el'.")
(defconst borg-top-level-directory
(or (ignore-errors
(let ((default-directory borg-user-emacs-directory))
(file-name-as-directory
(car (process-lines "git" "rev-parse" "--show-toplevel")))))
borg-user-emacs-directory)
"The top-level of repository containing `borg-user-emacs-directory'.")
(defconst borg-gitmodules-file
(expand-file-name ".gitmodules" borg-top-level-directory)
"The \".gitmodules\" file of the drone repository.")
(defvar borg-emacs-arguments '("-Q")
"Arguments used when calling an inferior Emacs instance.
Set this in \"~/.config/emacs/etc/borg/config.el\" and also set
`EMACS_ARGUMENTS' in either \"~/.config/emacs/Makefile\" or
\"~/.config/emacs/etc/borg/config.mk\" to the same value")
(defvar borg-compile-function #'byte-compile-file
"The function used to compile a library.
One of `byte-compile-file', `borg-byte+native-compile'
or `borg-byte+native-compile-async'.")
(defvar borg-compile-recursively nil
"Whether to compile recursively.
Unfortunately there are many packages that put random crap
into subdirectories. Instead of this variable you should set
`submodule.<drone>.recursive-byte-compile' for each DRONE that
needs it.")
(defvar borg-native-compile-deny-list '("yaml.el")
"List of file names to exclude files from native compilation.")
(defvar borg-build-shell-command nil
"Optional command used to run shell command build steps.
This variable is documented in the manual (which see).")
(defvar borg-rewrite-urls-alist nil
"An alist used to optionally rewrite certain URLs.
Each element has the form (ORIG . BASE). Each URL that starts
with ORIG is rewritten to start with BASE instead. See info
node `(borg)Using https URLs'.")
(defvar borg-maketexi-filename-regexp "\\`\\(%s\\|README\\).org\\'"
"Regexp matching Org files that may be exported to Texinfo.
The name of the clone is substituted for %s. Setting this to
nil disables the export of any Org files.")
(defvar borg-minimal-emacs-alist nil
"Alist mapping drones to the Emacs release they depend on.
Drones that depend on an Emacs release higher than the currently
used release are automatically disabled.")
(defvar borg-clone nil
"While running a build step, the package currently being build.")
;;; Utilities
(defun borg-worktree (clone)
"Return the top-level of the working tree of the package named CLONE."
(expand-file-name (file-name-as-directory clone) borg-drones-directory))
(defun borg-gitdir (clone)
"Return the Git directory of the package named CLONE.
Always return `<borg-user-emacs-directory>/.git/modules/<CLONE>',
even when this repository's Git directory is actually located
inside the working tree."
(let* ((default-directory borg-top-level-directory)
(super (ignore-errors
(car (process-lines "git" "rev-parse" "--git-dir")))))
(if super
(expand-file-name (concat super "/modules/" clone "/"))
(error "Cannot locate super-repository"))))
(defvar borg--gitmodule-cache nil)
(defmacro borg-do-drones (spec &rest body)
"Loop over drones.
Evaluate BODY with VAR bound to each drone, in turn.
Inside BODY variables set in \".gitmodules\" are cached.
Then evaluate RESULT to get return value, default nil.
\n(fn (VAR [RESULT]) BODY...)"
(declare (indent 1) (debug (sexp body)))
(let ((var (car spec))
(result (cadr spec)))
`(let ((borg--gitmodule-cache (borg-drones 'raw)))
(dolist (,var borg--gitmodule-cache ,result)
(setq ,var (car ,var))
,@body))))
(defun borg-get (clone variable &optional all)
"Return value of `submodule.CLONE.VARIABLE' in `~/.config/emacs/.gitmodules'.
If optional ALL is non-nil, then return all values as a list.
VARIABLE can be a symbol or a string."
(let ((values
(if borg--gitmodule-cache
(alist-get (if (symbolp variable) variable (intern variable))
(cdr (assoc clone borg--gitmodule-cache)))
(ignore-errors
;; If the variable has no value then the exit code is
;; non-zero, but that isn't an error as far as we are
;; concerned.
(apply #'borg--module-config
`(,@(and all (list "--get-all"))
,(format "submodule.%s.%s" clone variable)))))))
(if all values (car (last values)))))
(defun borg-get-all (clone variable)
"Return values of `submodule.CLONE.VARIABLE' in `~/.config/emacs/.gitmodules'.
Return all values as a list. VARIABLE can be a symbol or
a string."
(borg-get clone variable t))
(defun borg-load-path (clone)
"Return the `load-path' for the clone named CLONE."
(let ((repo (borg-worktree clone))
(path (borg-get-all clone "load-path")))
(if path
(mapcar (lambda (d) (expand-file-name d repo)) path)
(let ((elisp (expand-file-name "elisp" repo))
(lisp (expand-file-name "lisp" repo)))
(list (cond ((file-exists-p elisp) elisp)
((file-exists-p lisp) lisp)
(t (directory-file-name repo))))))))
(defun borg-info-path (clone &optional setup)
"Return the `Info-directory-list' for the clone named CLONE.
If optional SETUP is non-nil, then return a list of directories
containing org, texinfo and/or info files. Otherwise return a
list of directories containing a file named \"dir\"."
(let ((repo (borg-worktree clone))
(path (borg-get-all clone "info-path")))
(cl-mapcan
(if setup
(lambda (d)
(setq d (file-name-as-directory d))
(and (file-directory-p d)
(directory-files
d t "\\.\\(org\\|texi\\(nfo\\)?\\|info\\)\\'" t)
(list d)))
(lambda (d)
(setq d (file-name-as-directory d))
(and (file-exists-p (expand-file-name "dir" d))
(list d))))
(if path
(mapcar (lambda (d) (expand-file-name d repo)) path)
(list repo
(expand-file-name "doc" repo)
(expand-file-name "docs" repo))))))
(defvar borg--multi-value-variables
'(build-step load-path no-byte-compile info-path)
"List of submodule variables which can have multiple values.")
(defun borg-dronep (name)
"Return non-nil if a drone named NAME exists.
If set in \".gitmodules\", then return the value
of `submodule.NAME.path', nil otherwise."
(let ((default-directory borg-top-level-directory))
(ignore-errors
(car (process-lines "git" "config" "--file" ".gitmodules"
(format "submodule.%s.path" name))))))
(defun borg-drones (&optional include-variables)
"Return a list of all assimilated drones.
The returned value is a list of the names of the assimilated
drones, unless optional INCLUDE-VARIABLES is non-nil, in which
case elements of the returned list have the form (NAME . ALIST).
ALIST is an association list. Property names are symbols
and correspond to a VARIABLE defined in the Borg repository's
\".gitmodules\" file as \"submodule.NAME.VARIABLE\".
Each property value is either a string or a list of strings. If
INCLUDE-VARIABLES is `raw' then all values are lists. Otherwise
a property value is only a list if the corresponding property
name is a member of `borg--multi-value-variables'. If a property
name isn't a member of `borg--multi-value-variables' but it does
have multiple values anyway, then the last value is included in
the overall return value."
(let* ((default-directory borg-top-level-directory)
(prefix (file-relative-name
(file-name-as-directory borg-drones-directory))))
(if include-variables
(let (drones)
(dolist (line (borg--module-config "--list"))
(when (string-match
"\\`submodule\\.\\([^.]+\\)\\.\\([^=]+\\)=\\(.+\\)\\'"
line)
(let* ((drone (match-string 1 line))
(var (intern (match-string 2 line)))
(value (match-string 3 line))
(elt (assoc drone drones))
(vars (cdr elt)))
(unless elt
(push (setq elt (list drone)) drones))
(setf (alist-get var vars)
(if (or (eq include-variables 'raw)
(memq var borg--multi-value-variables))
(nconc (alist-get var vars)
(list value))
value))
(setcdr elt vars))))
(cl-sort (cl-delete-if-not
(lambda (drone)
(let ((path (alist-get 'path (cdr drone))))
(string-prefix-p prefix
(if (listp path)
(car (last path))
path))))
drones)
#'string< :key #'car))
;; If "git submodule" gets a list command, we
;; might want to start using that. See #131.
(let ((offset (length prefix)))
(cl-mapcan (lambda (line)
(pcase-let ((`(,mode ,_ ,_ ,file) (split-string line)))
(and (equal mode "160000")
(list (substring file offset)))))
(process-lines "git" "ls-files" "-s"))))))
(defun borg-clones ()
"Return a list of cloned packages.
The returned value includes the names of all packages that were
cloned into `borg-drones-directory', including clones that have
not been assimilated yet."
(cl-mapcan (lambda (file)
(and (file-directory-p file)
(list (file-name-nondirectory file))))
(directory-files borg-drones-directory t "\\`[^.]")))
(defun borg-read-package (prompt &optional edit-url)
"Read a package name and URL, and return them as a list.
If the `epkg' package is available, then read a package name
in the minibuffer and use the URL stored in the Epkg database.
Otherwise if `epkg' is unavailable, the package is unknown,
or when EDIT-URL is non-nil, then also read the URL in the
minibuffer.
PROMPT is used when reading the package name.
Return a list of the form (NAME URL). Unless the URL was
explicitly provided by the user, it may be modified according
to variable `borg-rewrite-urls-alist' (which see)."
(if (require 'epkg nil t)
(let* ((name (completing-read prompt (epkgs 'name)
nil nil nil 'epkg-package-history))
(pkg (epkg name))
(url (and pkg
(with-no-warnings
(if (and (epkg-git-package--eieio-childp pkg)
(not (or (epkg-subtree-package-p pkg)
(epkg-nongnu-elpa-package-p pkg)
(epkg-gnu-elpa-package-p pkg)
(epkg-wiki-package-p pkg))))
(eieio-oref pkg 'url)
(eieio-oref pkg 'mirror-url))))))
(when url
(pcase-dolist (`(,orig . ,base) borg-rewrite-urls-alist)
(when (string-prefix-p orig url)
(setq url (concat base (substring url (length orig)))))))
(list name
(if (or (not url) edit-url)
(read-string
"Url: "
(or url
(and (require 'magit nil t)
(magit-get "remote"
(magit-get-some-remote) "url"))))
url)))
(list (read-string prompt)
(read-string "Url: "))))
(defun borg-read-clone (prompt)
"Read the name of a cloned package, prompting with PROMPT."
(require 'epkg nil t)
(completing-read prompt (borg-clones) nil t nil 'epkg-package-history))
(defmacro borg-silencio (regexp &rest body)
"Execute the forms in BODY while silencing messages that don't match REGEXP."
(declare (indent 1))
(let ((msg (make-symbol "msg")))
`(let ((,msg (symbol-function 'message)))
(cl-letf (((symbol-function 'message)
(lambda (format-string &rest args)
(unless (string-match-p ,regexp format-string)
(apply ,msg format-string args)))))
,@body))))
;;; Activation
(defun borg-initialize ()
"Initialize assimilated drones.
For each drone use `borg-activate' to add the appropriate
directories to the `load-path' and `Info-directory-alist', and
load the autoloads file, if it exists.
If the value of a Git variable named `submodule.DRONE.disabled'
is true in \"~/.config/emacs/.gitmodules\", then the drone named
DRONE is skipped.
If Emacs is running without an interactive terminal, then first
load \"`borg-user-emacs-directory'/etc/borg/init.el\", if that
exists."
(when noninteractive
(let ((init (convert-standard-filename
(expand-file-name "etc/borg/init.el"
borg-user-emacs-directory))))
(when (file-exists-p init)
(load-file init))))
(info-initialize)
(let ((start (current-time))
(skipped 0)
(initialized 0))
(borg-do-drones (drone)
(cond
((borg--drone-disabled-p drone)
(cl-incf skipped))
((not (file-exists-p (borg-worktree drone)))
(cl-incf skipped))
(t
(cl-incf initialized)
(borg-activate drone))))
(let* ((message (current-message))
(inhibit (and message
(string-match-p
"\\`Recompiling .+init\\.el\\.\\.\\.\\'" message))))
(let ((inhibit-message inhibit))
(message "Initializing drones...done (%s drones in %.3fs%s)"
initialized
(float-time (time-subtract (current-time) start))
(if (> skipped 0)
(format ", %d skipped" skipped)
"")))
(when inhibit
(let ((message-log-max nil))
(message "%s" message))))))
(defun borg-activate (clone)
"Activate the clone named CLONE.
Add the appropriate directories to `load-path' and
`Info-directory-list', and load the autoloads file,
if it exists."
(interactive (list (borg-read-clone "Activate clone: ")))
(cl-flet
((activate (dir part)
(let ((file (expand-file-name (format "%s-%s.el" clone part) dir)))
(and (file-exists-p file)
(with-demoted-errors "Error loading autoloads: %s"
(load file nil t))
;; We cannot rely on the autoloads file doing that.
(add-to-list 'load-path dir)))))
(dolist (dir (borg-load-path clone))
(or (activate dir "autoloads")
(activate dir "loaddefs") ; `org' uses a different name.
(add-to-list 'load-path dir)))) ; There might be no autoloads file.
(dolist (dir (borg-info-path clone))
(push dir Info-directory-list)))
;;; Construction
(defun borg-batch-rebuild (&optional quick native)
"Rebuild all assimilated drones.
This function is to be used only with `--batch'.
Build Borg and Compat first, followed by all other drones in
alphabetic order. Finally build `init.el' and, if it exists,
`USER-REAL-LOGIN-NAME.el'.
When optional QUICK is non-nil, then do not build drones for
which `submodule.DRONE.build-step' is set, assuming those are
the drones that take longer to be built.
When optional NATIVE is non-nil, then compile natively. If
NATIVE is a function, then use that, `borg-byte+native-compile'
otherwise."
(unless noninteractive
(error "borg-batch-rebuild is to be used only with --batch"))
(borg-do-drones (drone)
(unless (and quick (borg-get-all drone "build-step"))
(borg--remove-autoloads drone quick)))
(when (borg-dronep "org")
;; `org-loaddefs.el' has to exist when compiling a library
;; which depends on `org', else we get warnings about that
;; not being so.
(let ((default-directory (borg-worktree "org")))
(shell-command "make autoloads")))
(borg-do-drones (drone)
(message "\n--- [%s] ---\n" drone)
(cond
((borg--drone-disabled-p drone)
(message "Skipped (Disabled)"))
((let ((min (cdr (assoc drone borg-minimal-emacs-alist))))
(and min (version< emacs-version min)
(message "Skipped (Requires Emacs >= %s)" min))))
((not (file-exists-p (borg-worktree drone)))
(message "Skipped (Missing)"))
((and quick (borg-get-all drone "build-step"))
(message "Skipped (Expensive to build)"))
((borg-build drone nil native))))
(borg-batch-rebuild-init))
(defun borg-batch-rebuild-init ()
"Rebuild `init.el' and `USER-REAL-LOGIN-NAME.el'.
This function is to be used only with `--batch'."
(unless noninteractive
(error "borg-batch-recompile-init is to be used only with --batch"))
(borg-silencio "\\`%s\\.\\.\\.\\(done\\)?" ; silence use-package
(let ((default-directory borg-user-emacs-directory))
(dolist (file (or command-line-args-left
(list "init.el"
(concat (user-real-login-name) ".el"))))
(when (file-exists-p file)
(message "\n--- [%s] ---\n" file)
(load-file file)
(byte-recompile-file (expand-file-name file) t 0))))))
(defun borg-build (clone &optional activate native)
"Build the clone named CLONE.
Interactively, or when optional ACTIVATE is non-nil, then also
activate the clone using `borg-activate'. When `noninteractive'
and optional NATIVE are both non-nil, then also compile natively."
(interactive (list (borg-read-clone "Build drone: ") t))
(when (string-suffix-p "/" clone)
(setq clone (substring clone 0 -1)))
(borg-clean clone)
(cond
(noninteractive
(let ((borg-compile-function borg-compile-function))
(when (fboundp 'comp-ensure-native-compiler)
(when native
(setq borg-compile-function
(if (functionp native) native #'borg-byte+native-compile)))
(when (memq borg-compile-function '( borg--native-compile
native-compile
native-compile-async))
(message "WARNING: Using `%s' instead of unsuitable `%s'"
'borg-byte+native-compile borg-compile-function)
(setq borg-compile-function #'borg-byte+native-compile)))
(borg--build-noninteractive clone)
(when activate
(borg-activate clone))))
((let ((process (borg--build-interactive clone)))
(when activate
(add-function :after (process-sentinel process)
(lambda (_process event)
(when (string-equal event "finished\n")
(borg-activate clone)))))))))
(defun borg--build-noninteractive (clone)
(let ((default-directory (borg-worktree clone))
(build-cmd (if (functionp borg-build-shell-command)
(funcall borg-build-shell-command clone)
borg-build-shell-command))
(config (borg--config-file)))
(when (file-exists-p config)
(load config nil t t))
(if-let ((commands (borg-get-all clone "build-step")))
(borg--run-build-commands clone commands build-cmd)
(let ((path (mapcar #'file-name-as-directory (borg-load-path clone))))
(borg-update-autoloads clone path)
(borg-compile clone path)
(borg-maketexi clone)
(borg-makeinfo clone)))
(when-let ((commands
(borg--module-config "--get-all" "borg.extra-build-step")))
(borg--run-build-commands clone commands build-cmd))))
(defun borg--run-build-commands (clone commands build-command)
(dolist (cmd commands)
(message " Running `%s'..." cmd)
(cond ((member cmd '("borg-update-autoloads"
"borg-compile"
"borg-maketexi"
"borg-makeinfo"
;; For backward compatibility.
"borg-byte-compile"))
(funcall (intern cmd) clone))
((string-prefix-p "(" cmd)
(let ((borg-clone clone))
(eval (read cmd))))
(build-command
(when (or (stringp build-command)
(setq build-command (funcall build-command clone cmd)))
(require 'format-spec)
(shell-command
(format-spec build-command
`((?s . ,cmd)
(?S . ,(shell-quote-argument cmd)))))))
(t
(shell-command cmd)))
(message " Running `%s'...done" cmd)))
(defun borg--build-interactive (clone)
(save-some-buffers
nil (let ((top default-directory))
(lambda ()
(let ((file (buffer-file-name)))
(and file
(string-match-p emacs-lisp-file-regexp file)
(file-in-directory-p file top))))))
(let ((buffer (get-buffer-create "*Borg Build*"))
(config (borg--config-file))
(process-connection-type nil))
(with-current-buffer buffer
(setq default-directory borg-user-emacs-directory)
(borg-build-mode)
(goto-char (point-max))
(let ((inhibit-read-only t))
(when (file-exists-p config)
(insert (format "\n(%s) Loading %s\n\n"
(format-time-string "%H:%M:%S")
config))
(load-file config))
(unless (looking-back "\n\n" (- (point) 2))
(insert ?\n))
(insert (format "(%s) Building %s\n\n"
(format-time-string "%H:%M:%S")
clone))))
(pop-to-buffer-same-window buffer)
(make-process
:name (format "emacs ... --eval (borg-build %S)" clone)
:buffer buffer
:command `(,(expand-file-name invocation-name invocation-directory)
"--batch" ,@borg-emacs-arguments
"-L" ,(file-name-directory (locate-library "borg"))
"--eval" ,(if (featurep 'borg-elpa)
(borg--build-expression-elpa clone)
(borg--build-expression clone)))
:filter #'borg--build-process-filter)))
(defun borg--build-expression (clone)
(format "(progn
(require 'borg)
(borg-initialize)
(setq borg-build-shell-command (quote %S))
(borg-build %S))"
borg-build-shell-command
clone))
(defun borg--build-expression-elpa (clone)
(format "(progn
(setq user-emacs-directory %S)
(require 'package)
(package-initialize 'no-activate)
(package-activate 'borg)
(require 'borg-elpa)
(borg-elpa-initialize)
(setq borg-build-shell-command (quote %S))
(borg-build %S))"
borg-user-emacs-directory
borg-build-shell-command
clone))
(defun borg--build-process-filter (process string)
(when (buffer-live-p (process-buffer process))
(with-current-buffer (process-buffer process)
(let ((moving (= (point) (process-mark process))))
(save-excursion
(goto-char (process-mark process))
(let ((inhibit-read-only t))
(insert string))
(set-marker (process-mark process) (point)))
(if moving (goto-char (process-mark process)))))))
(defvar borg-build-mode-map
(let ((map (make-sparse-keymap)))
(define-key map "\C-q" #'bury-buffer)
map)
"Keymap for `borg-build-mode'.")
(defvar borg-build-mode-lighter "Borg-Build")
(define-derived-mode borg-build-mode compilation-mode
'borg-build-mode-lighter
"Mode for the \"*Borg Build*\" buffer."
(setq mode-line-process
'((:propertize ":%s" face compilation-mode-line-run)
compilation-mode-line-errors))
(setq font-lock-defaults '(borg-build-mode-font-lock-keywords t)))
(defun borg-build-mode-font-lock-keywords ()
(append '((compilation--ensure-parse))
(remove '(" --?o\\(?:utfile\\|utput\\)?[= ]\\(\\S +\\)" . 1)
compilation-mode-font-lock-keywords)))
(defun borg-update-autoloads (clone &optional path)
"Update autoload files for the clone named CLONE in the directories in PATH."
(let* ((path (borg--expand-load-path clone path))
(file (expand-file-name (format "%s-autoloads.el" clone) (car path)))
(excludes (nconc
(mapcar #'expand-file-name
(borg-get-all clone "no-byte-compile"))
(cl-mapcan
(lambda (dir)
(list (expand-file-name (concat clone "-pkg.el") dir)
(expand-file-name (concat clone "-test.el") dir)
(expand-file-name (concat clone "-tests.el") dir)))
path))))
(message " Creating %s..." file)
;; Stay close to what `package-generate-autoloads' does.
(cond
((functionp 'loaddefs-generate)
;; Suppress "Scraping files for loaddefs" and
;; " GEN NAME-autoloads.el" messages.
(cl-letf* (((symbol-function 'progress-reporter-do-update) (lambda (&rest _)))
((symbol-function 'progress-reporter-done) (lambda (_)))
((symbol-function 'borg--byte-compile-info)
(symbol-function 'byte-compile-info))
((symbol-function 'byte-compile-info)
(lambda (string &optional _message type)
(with-no-warnings
(borg--byte-compile-info string nil type)))))
(loaddefs-generate
path file excludes
;; Same kludge as used in `package-generate-autoloads'.
(prin1-to-string
'(add-to-list 'load-path
(or (and load-file-name
(directory-file-name
(file-name-directory load-file-name)))
(car load-path)))))))
((let (;; This defaults to `nil' on Emacs 26 through 28, there
;; is no need to double down on the default, and by not
;; doing that, we avoid a warning on Emacs 25.
;; (autoload-timestamps nil)
(backup-inhibited t)
;; On Emacs 25 this causes "Making version-control local
;; to NAME-autoloads.el while let-bound!" warnings, but
;; I believe those are harmless.
(version-control 'never)
(noninteractive t)
(autoload-excludes
(nconc excludes (bound-and-true-p autoload-excludes))))
;; Since 35cd9197fc `package-autoload-ensure-default-file' sets
;; the coding-system to fix bug#53529. Doing that here as well
;; caused #128 and to prevent that we use `with-temp-buffer'.
(with-temp-buffer
(let ((coding-system-for-write 'utf-8-emacs-unix))
(write-region (and (functionp 'autoload-rubric)
(autoload-rubric file "package" nil))
nil file nil 'silent)))
(cl-letf (((symbol-function 'progress-reporter-do-update) (lambda (&rest _)))
((symbol-function 'progress-reporter-done) (lambda (_))))
(let ((generated-autoload-file file))
(apply 'update-directory-autoloads path))))))
(when-let ((buf (find-buffer-visiting file)))
(kill-buffer buf))))
(defun borg-compile (clone &optional path)
"Compile libraries for the clone named CLONE in the directories in PATH."
(let ((dirs (borg--expand-load-path clone path))
(exclude (borg-get-all clone "no-byte-compile"))
(topdir (borg-worktree clone))
(default-directory borg-user-emacs-directory)
(byte-compile-root-dir borg-user-emacs-directory)
(skip-count 0)
(fail-count 0)
(file-count 0)
(dir-count 0)
dir last-dir)
(displaying-byte-compile-warnings
(while (setq dir (pop dirs))
(dolist (file (directory-files dir t))
(let ((file-relative (file-relative-name file topdir))
(name (file-name-nondirectory file)))
(if (file-directory-p file)
(when (and (if-let ((v (borg-get
clone "recursive-byte-compile")))
(member v '("yes" "on" "true" "1"))
borg-compile-recursively)
(not (file-symlink-p file))
(not (string-prefix-p "." name))
(not (member name '("RCS" "CVS"))))
(if (or (file-exists-p (expand-file-name ".nosearch" file))
(member file-relative exclude))
(message " Skipping %s...skipped" file)
(setq dirs (nconc dirs (list file)))))
(when (and (file-regular-p file)
(file-readable-p file)
(string-match-p emacs-lisp-file-regexp name)
(not (auto-save-file-name-p file))
(not (string-prefix-p "." name))
(not (string-suffix-p "-autoloads.el" name))
(not (string-equal dir-locals-file name)))
(cl-incf
(if (or (string-suffix-p "-pkg.el" name)
(string-suffix-p "-test.el" name)
(string-suffix-p "-tests.el" name)
(member file-relative exclude))
(progn (message " Skipping %s...skipped" file)
skip-count)
(unless byte-compile-verbose
(message "Compiling %s..." file))
(pcase (funcall borg-compile-function file)
('no-byte-compile
(message "Compiling %s...skipped" file)
skip-count)
((or 't (pred stringp))
file-count)
(_ fail-count))))
(unless (equal dir last-dir)
(setq last-dir dir)
(cl-incf dir-count))))))))
(message "Done (Total of %d file%s compiled%s%s%s)"
file-count (if (= file-count 1) "" "s")
(if (> fail-count 0) (format ", %d failed" fail-count) "")
(if (> skip-count 0) (format ", %d skipped" skip-count) "")
(if (> dir-count 1) (format " in %d directories" dir-count) ""))))
(declare-function borg--byte-write-target-file "borg")
(defun borg-byte+native-compile (file)
(cond
((or (equal (getenv "NATIVE_DISABLED") "1")
(member (file-name-nondirectory file)
borg-native-compile-deny-list))
(byte-compile-file file))
((and (fboundp 'comp--native-compile)
(fboundp 'comp-ensure-native-compiler))
(comp-ensure-native-compiler)
(let* ((byte+native-compile t)
(byte-to-native-output-buffer-file nil)
(native-compile-target-directory (car native-comp-eln-load-path))
(eln-file (comp--native-compile file)))
(pcase byte-to-native-output-buffer-file
(`(,temp-buffer . ,target-file)
(unwind-protect
(progn
(borg--byte-write-target-file temp-buffer target-file)
(when (stringp eln-file)
(set-file-times eln-file)))
(kill-buffer temp-buffer)
(file-exists-p target-file))))))
((error "Emacs %s does not support native compilation" emacs-version))))
(defun borg-byte+native-compile-async (file)
(byte-compile-file file)
(cond
((fboundp 'native-compile-async)
(native-compile-async file))
((error "Emacs %s does not support native compilation" emacs-version))))
(if (fboundp 'byte-write-target-file)
(defalias 'borg--byte-write-target-file 'byte-write-target-file)
(defvar byte-native-compiling)
(defvar byte-to-native-output-buffer-file)
(defun borg--byte-write-target-file (buffer target-file)
(with-current-buffer buffer
(let* ((coding-system-for-write 'no-conversion)
(tempfile
(make-temp-file (when (file-writable-p target-file)
(expand-file-name target-file))))
(default-modes (default-file-modes))
(temp-modes (logand default-modes #o600))
(desired-modes (logand default-modes #o666))
(kill-emacs-hook
(cons (lambda () (ignore-errors (delete-file tempfile)))
kill-emacs-hook)))
(unless (= temp-modes desired-modes)
(with-no-warnings
;; Native compilation, and thus this function, may only
;; be used for Emacs > 28.1. So don't warn about third
;; argument that does exist in older releases.
(set-file-modes tempfile desired-modes 'nofollow)))
(write-region (point-min) (point-max) tempfile nil 1)
(if byte-native-compiling
(setf byte-to-native-output-buffer-file
(cons tempfile target-file))
(rename-file tempfile target-file t))))))
(defun borg-maketexi (clone &optional files)
"Generate Texinfo manuals from Org files for the clone named CLONE.
Export each file located on `borg-info-path' if its name matches
`borg-maketexi-filename-regexp' and the `TEXINFO_DIR_HEADER'
export keyword is set in its content. If optional FILES is
non-nil, then try those files instead. On Emacs 25 this function
doesn't do anything."
;; ... because turning on `org-mode' (via `find-file-noselect')
;; results in an error that I do not wish to investigate.
(when (and (> emacs-major-version 25)
(or files borg-maketexi-filename-regexp))
(let ((repo (borg-worktree clone))
(exclude (borg-get-all clone "no-maketexi")))
(dolist (file (or files
(cl-mapcan
(lambda (dir)
(directory-files
dir t (format borg-maketexi-filename-regexp clone)))
(borg-info-path clone t))))
(unless (or (member (file-relative-name file repo) exclude)
(borg--file-tracked-p
(concat (file-name-sans-extension file) ".texi")))
(let ((buffer (get-file-buffer file)))
(with-current-buffer (or buffer (find-file-noselect file))
(save-excursion
(save-restriction
(widen)
(goto-char (point-min))
(when (save-excursion
(let ((case-fold-search t))
(re-search-forward
"^#\\+texinfo_dir_title:" nil t)))
(let ((export
(save-excursion
(let ((case-fold-search t))
(and (re-search-forward
"^#\\+export_file_name:\\(.+\\)" nil t)
(string-trim (match-string 1)))))))
(unless (and export
(member (file-name-extension export)
'("texi" "texinfo"))
(borg--file-tracked-p export))
(message "Exporting %s..." file)
(require (quote ox))
(ignore-errors (org-texinfo-export-to-texinfo))
(message "Exporting %s...done" file))))))
(unless buffer
(kill-buffer (current-buffer))))))))))
(defun borg-makeinfo (clone)
"Generate Info manuals and the Info index for the clone named CLONE."
(dolist (default-directory (borg-info-path clone t))
(let ((exclude (nconc (list "fdl.texi" "gpl.texi")
(borg-get-all clone "no-makeinfo"))))
(dolist (texi (directory-files default-directory nil
"\\.texi\\(nfo\\)?\\'"))
(let ((info (concat (file-name-sans-extension texi) ".info")))
(unless (or (member texi exclude)
(borg--file-tracked-p info))
(let ((cmd (format "makeinfo --no-split %s -o %s" texi info)))
(message " Running `%s'..." cmd)
(borg-silencio "\\`(Shell command succeeded with %s)\\'"
(shell-command cmd))
(message " Running `%s'...done" cmd))))))
(dolist (info (directory-files default-directory nil "\\.info\\'"))
(let ((cmd (format "install-info %s --dir=dir" info)))
(message " Running `%s'..." cmd)
(borg-silencio "\\`(Shell command succeeded with %s)\\'"
(shell-command cmd))
(message " Running `%s'...done" cmd)))))
(defun borg--remove-autoloads (drone &optional quick)
(unless (or (borg--drone-disabled-p drone)
(not (file-exists-p (borg-worktree drone)))
(and quick (borg-get-all drone "build-step")))
(dolist (dir (borg-load-path drone))
(dolist (file (directory-files
dir t "\\(\\.elc\\|-autoloads\\.el\\|-loaddefs\\.el\\)\\'"
t))
(ignore-errors (delete-file file))))))
(defun borg--batch-clean (&optional quick)
(borg-do-drones (drone)
(unless (or (not (file-exists-p (borg-worktree drone)))
(and quick (borg-get-all drone "build-step")))
(borg-clean drone))))
(defun borg-clean (drone)