1 00713762 2021-08-17 op ;;; vc-got.el --- VC backend for Game of Trees VCS -*- lexical-binding: t; -*-
3 f0d7c7e7 2022-05-28 op ;; Copyright (C) 2021-2022 Free Software Foundation, Inc.
5 76d978fa 2021-01-05 op ;; Author: Omar Polo <op@omarpolo.com>
6 4b3c0c67 2021-08-17 op ;; Timo Myyrä <timo.myyra@bittivirhe.fi>
7 78607b0c 2022-05-28 op ;; URL: https://projects.omarpolo.com/vc-got.html
8 61b9a83b 2021-08-17 op ;; Keywords: vc tools
9 20cee209 2022-06-08 op ;; Version: 1.1.2
10 3efc7598 2021-09-09 op ;; Package-Requires: ((emacs "25.1"))
12 406d7b4d 2020-12-26 op ;; This program is free software; you can redistribute it and/or modify
13 406d7b4d 2020-12-26 op ;; it under the terms of the GNU General Public License as published by
14 406d7b4d 2020-12-26 op ;; the Free Software Foundation, either version 3 of the License, or
15 406d7b4d 2020-12-26 op ;; (at your option) any later version.
17 406d7b4d 2020-12-26 op ;; This program is distributed in the hope that it will be useful,
18 406d7b4d 2020-12-26 op ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
19 406d7b4d 2020-12-26 op ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 406d7b4d 2020-12-26 op ;; GNU General Public License for more details.
22 406d7b4d 2020-12-26 op ;; You should have received a copy of the GNU General Public License
23 406d7b4d 2020-12-26 op ;; along with this program. If not, see <https://www.gnu.org/licenses/>.
25 7726b6c9 2021-08-10 op ;;; Commentary:
27 b3b5f78a 2022-05-28 op ;; vc-got is a VC backend for the Game of Trees (got) version control
30 af5ef7cd 2020-11-29 op ;; Backend implementation status
32 af5ef7cd 2020-11-29 op ;; Function marked with `*' are required, those with `-' are optional.
34 af5ef7cd 2020-11-29 op ;; FUNCTION NAME STATUS
36 af5ef7cd 2020-11-29 op ;; BACKEND PROPERTIES:
37 af5ef7cd 2020-11-29 op ;; * revision-granularity DONE
38 af5ef7cd 2020-11-29 op ;; - update-on-retrieve-tag XXX: what should this do?
40 af5ef7cd 2020-11-29 op ;; STATE-QUERYING FUNCTIONS:
41 af5ef7cd 2020-11-29 op ;; * registered DONE
42 af5ef7cd 2020-11-29 op ;; * state DONE
43 af5ef7cd 2020-11-29 op ;; - dir-status-files DONE
44 a8466f02 2020-12-07 op ;; - dir-extra-headers DONE
45 2d83de2e 2021-01-05 op ;; - dir-printer DONE
46 af5ef7cd 2020-11-29 op ;; - status-fileinfo-extra NOT IMPLEMENTED
47 af5ef7cd 2020-11-29 op ;; * working-revision DONE
48 af5ef7cd 2020-11-29 op ;; * checkout-model DONE
49 694534b4 2020-12-05 op ;; - mode-line-string DONE
51 23a0b465 2020-11-30 op ;; STATE-CHANGING FUNCTIONS:
52 23a0b465 2020-11-30 op ;; * create-repo NOT IMPLEMENTED
53 eb85ad27 2020-12-05 op ;; I don't think got init does what this function is supposed to
55 23a0b465 2020-11-30 op ;; * register DONE
56 23a0b465 2020-11-30 op ;; - responsible-p DONE
57 3ec8a8b4 2021-08-17 op ;; - receive-file NOT NEEDED, default `register' is fine
58 241a3b12 2021-08-11 op ;; - unregister DONE
59 23a0b465 2020-11-30 op ;; * checkin DONE
60 23a0b465 2020-11-30 op ;; * find-revision DONE
61 eb85ad27 2020-12-05 op ;; * checkout NOT IMPLEMENTED
62 eb85ad27 2020-12-05 op ;; I'm not sure how to properly implement this. Does filling
63 eb85ad27 2020-12-05 op ;; FILE with the find-revision do the trick? Or use got update?
64 eb85ad27 2020-12-05 op ;; * revert DONE
65 eb85ad27 2020-12-05 op ;; - merge-file NOT IMPLEMENTED
66 eb85ad27 2020-12-05 op ;; - merge-branch DONE
67 eb85ad27 2020-12-05 op ;; - merge-news NOT IMPLEMENTED
68 eb85ad27 2020-12-05 op ;; - pull DONE
69 686eac9a 2020-12-07 op ;; - push DONE
70 3cdb0759 2020-01-03 47739920+ ;; - steal-lock NOT NEEDED, `got' is not using locks
71 eb85ad27 2020-12-05 op ;; - modify-change-comment NOT IMPLEMENTED
72 eb85ad27 2020-12-05 op ;; can be implemented via histedit, if I understood correctly
73 eb85ad27 2020-12-05 op ;; what it is supposed to do.
74 ae2ad572 2021-08-17 op ;; - mark-resolved NOT NEEDED
75 ae2ad572 2021-08-17 op ;; got notice by itself when a file doesn't have any pending
76 ae2ad572 2021-08-17 op ;; conflicts to be resolved.
77 ae2ad572 2021-08-17 op ;; - find-admin-dir NOT NEEDED
79 eb85ad27 2020-12-05 op ;; HISTORY FUNCTIONS
80 eb85ad27 2020-12-05 op ;; * print-log DONE
81 9ad1eb5d 2020-12-07 op ;; * log-outgoing DONE
82 6eda2f1f 2020-12-26 op ;; * log-incoming DONE
83 eb85ad27 2020-12-05 op ;; - log-search DONE
84 0a3316a6 2021-02-22 op ;; - log-view-mode DONE
85 6eda2f1f 2020-12-26 op ;; - show-log-entry NOT IMPLEMENTED
86 6eda2f1f 2020-12-26 op ;; - comment-history NOT IMPLEMENTED
87 6eda2f1f 2020-12-26 op ;; - update-changelog NOT IMPLEMENTED
88 7c257a7b 2020-12-31 noreply ;; * diff DONE
89 5fb2f474 2021-08-10 op ;; - revision-completion-table DONE
90 3f25d9ff 2020-01-02 noreply ;; - annotate-command DONE
91 3f25d9ff 2020-01-02 noreply ;; - annotate-time DONE
92 424f5152 2021-08-10 op ;; - annotate-current-time NOT NEEDED
93 424f5152 2021-08-10 op ;; the default time handling is enough.
94 3f25d9ff 2020-01-02 noreply ;; - annotate-extract-revision-at-line DONE
95 7c257a7b 2020-12-31 noreply ;; - region-history NOT IMPLEMENTED
96 7c257a7b 2020-12-31 noreply ;; - region-history-mode NOT IMPLEMENTED
97 7c257a7b 2020-12-31 noreply ;; - mergebase NOT IMPLEMENTED
99 7c257a7b 2020-12-31 noreply ;; TAG SYSTEM
100 6ab1c7b4 2021-08-11 op ;; - create-tag DONE
101 09d59379 2021-08-11 op ;; - retrieve-tag DONE
103 7c257a7b 2020-12-31 noreply ;; MISCELLANEOUS NOT IMPLEMENTED
104 3cdb0759 2020-01-03 47739920+ ;; - make-version-backups-p NOT NEEDED, `got' works fine locally
105 7c257a7b 2020-12-31 noreply ;; - root DONE
106 49945a03 2021-08-11 op ;; - ignore NOT NEEDED, the default action is good
107 49945a03 2021-08-11 op ;; - ignore-completion-table NOT NEEDED, the default action is good
108 2552a6c7 2021-08-11 op ;; - find-ignore-file DONE
109 3f25d9ff 2020-01-02 noreply ;; - previous-revision DONE
110 3f25d9ff 2020-01-02 noreply ;; - next-revision DONE
111 7c257a7b 2020-12-31 noreply ;; - log-edit-mode NOT IMPLEMENTED
112 3cdb0759 2020-01-03 47739920+ ;; - check-headers NOT NEEDED, `got' does not use headers
113 a96df0e8 2020-01-03 noreply ;; - delete-file DONE
114 3ec8a8b4 2021-08-17 op ;; - rename-file NOT IMPLEMENTED
115 c151c257 2021-08-03 op ;; - find-file-hook DONE
116 3ec8a8b4 2021-08-17 op ;; - extra-menu NOT IMPLEMENTED
117 3cdb0759 2020-01-03 47739920+ ;; - extra-dir-menu NOT IMPLEMENTED, same as above
118 7bb16f79 2020-01-03 op ;; - conflicted-files DONE
119 8b635a9f 2020-01-03 op ;; - repository-url DONE
123 eb85ad27 2020-12-05 op ;; TODO: vc-git has most function that starts with:
125 eb85ad27 2020-12-05 op ;; (let* ((root (vc-git-root default-directory))
126 eb85ad27 2020-12-05 op ;; (buffer (format "*vc-git : %s*" (expand-file-name root)))
130 eb85ad27 2020-12-05 op ;; we should 1) investigate if also other backends do something like
131 eb85ad27 2020-12-05 op ;; this (or if there is a better way) and 2) try to do the same.
133 af5ef7cd 2020-11-29 op (eval-when-compile
134 af5ef7cd 2020-11-29 op (require 'subr-x))
136 af5ef7cd 2020-11-29 op (require 'cl-lib)
137 af5ef7cd 2020-11-29 op (require 'seq)
138 23a0b465 2020-11-30 op (require 'vc)
139 3f25d9ff 2020-01-02 noreply (require 'vc-annotate)
141 f7012697 2021-08-17 op ;; FIXME: avoid loading this? We only need it for
142 f7012697 2021-08-17 op ;; log-edit-extract-headers in vc-got-checkin.
143 f7012697 2021-08-17 op (require 'log-edit)
145 2d83de2e 2021-01-05 op ;; FIXME: avoid loading this? We only need it for
146 2d83de2e 2021-01-05 op ;; vc-dir-filename-mouse-map in our custom printer.
147 2d83de2e 2021-01-05 op (require 'vc-dir)
149 95a78ecb 2021-08-31 op ;; FIXME: avoid loading this? We only need it for
150 95a78ecb 2021-08-31 op ;; compilation-{directory,arguments}.
151 95a78ecb 2021-08-31 op (require 'compile)
153 95a78ecb 2021-08-31 op ;; FIXME: avoid loading this? We only need it for
154 95a78ecb 2021-08-31 op ;; log-view-{file-re,per-file-logs,message-re}.
155 95a78ecb 2021-08-31 op (require 'log-view)
157 e79563bd 2020-12-31 noreply (defgroup vc-got nil
158 e79563bd 2020-12-31 noreply "VC GoT backend."
159 e79563bd 2020-12-31 noreply :group 'vc)
161 e79563bd 2020-12-31 noreply (defcustom vc-got-program "got"
162 e79563bd 2020-12-31 noreply "Name of the Got executable (excluding any arguments)."
163 6eea6cfb 2021-01-05 op :type 'string)
165 12ca62f2 2020-12-26 op (defcustom vc-got-diff-switches t
166 12ca62f2 2020-12-26 op "String or list of strings specifying switches for Got diff under VC.
167 12ca62f2 2020-12-26 op If nil, use the value of `vc-diff-switches'. If t, use no switches."
168 12ca62f2 2020-12-26 op :type '(choice (const :tag "Unspecified" nil)
169 12ca62f2 2020-12-26 op (const :tag "None" t)
170 12ca62f2 2020-12-26 op (string :tag "Argument String")
171 6eea6cfb 2021-01-05 op (repeat :tag "Argument List" :value ("") string)))
174 95a78ecb 2021-08-31 op (defmacro vc-got--with-emacs-version<= (version &rest body)
175 95a78ecb 2021-08-31 op "Eval BODY only when the Emacs version in greater or equal VERSION."
176 95a78ecb 2021-08-31 op (declare (debug body)
177 95a78ecb 2021-08-31 op (indent defun))
178 95a78ecb 2021-08-31 op (when (version<= version emacs-version)
179 95a78ecb 2021-08-31 op `(progn ,@body)))
181 6fd5fa32 2022-06-08 op (defun vc-got--version ()
182 76d978fa 2021-01-05 op "Return string representing the got version."
183 f09d6359 2020-12-31 noreply (let (process-file-side-effects)
184 f09d6359 2020-12-31 noreply (with-temp-buffer
185 f09d6359 2020-12-31 noreply (vc-got--call "-V")
186 f09d6359 2020-12-31 noreply (substring (buffer-string) 4 -1))))
188 6fd5fa32 2022-06-08 op (defun vc-got--version<= (target)
189 6fd5fa32 2022-06-08 op "Compare the current version against TARGET.
190 6fd5fa32 2022-06-08 op Takes care of handling the -current suffix."
191 6fd5fa32 2022-06-08 op (let* ((version-string (vc-got--version))
192 6fd5fa32 2022-06-08 op (current-version (string-replace "-current" "" version-string)))
193 6fd5fa32 2022-06-08 op (when (version<= current-version target)
194 6fd5fa32 2022-06-08 op ;; let X.Y-current sort *after* X.Y
195 6fd5fa32 2022-06-08 op (string= version-string current-version))))
197 af5ef7cd 2020-11-29 op (defun vc-got-root (file)
198 af5ef7cd 2020-11-29 op "Return the work tree root for FILE, or nil."
199 6a973a79 2021-08-11 op (vc-find-root file ".got"))
201 af5ef7cd 2020-11-29 op (defmacro vc-got-with-worktree (file &rest body)
202 af5ef7cd 2020-11-29 op "Evaluate BODY in the work tree directory of FILE."
203 3efc7598 2021-09-09 op (declare (debug t) (indent defun))
204 af5ef7cd 2020-11-29 op `(when-let (default-directory (vc-got-root ,file))
207 686eac9a 2020-12-07 op (defun vc-got--repo-root ()
208 686eac9a 2020-12-07 op "Return the path to the repository root.
209 686eac9a 2020-12-07 op Assume `default-directory' is inside a got worktree."
210 686eac9a 2020-12-07 op (vc-got-with-worktree default-directory
211 686eac9a 2020-12-07 op (with-temp-buffer
212 686eac9a 2020-12-07 op (insert-file-contents ".got/repository")
213 76d978fa 2021-01-05 op (string-trim (buffer-string) "" "\n"))))
215 af5ef7cd 2020-11-29 op (defun vc-got--call (&rest args)
216 76d978fa 2021-01-05 op "Call `vc-got-program' with ARGS.
217 76d978fa 2021-01-05 op The output will be placed in the current buffer."
218 fab791a2 2020-01-03 op (apply #'process-file vc-got-program nil (current-buffer) nil
219 3efc7598 2021-09-09 op (apply #'nconc (mapcar (lambda (s) (if (listp s) s (list s))) args))))
221 23a0b465 2020-11-30 op (defun vc-got--add (files)
222 23a0b465 2020-11-30 op "Add FILES to got, passing `vc-register-switches' to the command invocation."
223 23a0b465 2020-11-30 op (with-temp-buffer
224 c3185bf7 2021-08-11 op (vc-got--call "add" vc-register-switches "--" files)))
226 0a66694e 2020-01-02 op (defun vc-got--log (&optional path limit start-commit stop-commit
227 32819756 2021-09-14 op search-pattern reverse include-diff)
228 76d978fa 2021-01-05 op "Execute the log command in the worktree of PATH in the current buffer.
229 23a0b465 2020-11-30 op LIMIT limits the maximum number of commit returned.
231 518ede14 2020-12-05 op START-COMMIT: start traversing history at the specified commit.
232 9ad1eb5d 2020-12-07 op STOP-COMMIT: stop traversing history at the specified commit.
233 518ede14 2020-12-05 op SEARCH-PATTERN: limit to log messages matched by the regexp given.
234 0a66694e 2020-01-02 op REVERSE: display the log messages in reverse order.
235 32819756 2021-09-14 op INCLUDE-DIFF: display the patch of modifications made in each commit.
237 23a0b465 2020-11-30 op Return nil if the command failed or if PATH isn't included in any
239 6fd5fa32 2022-06-08 op (let* ((process-file-side-effects nil)
240 6fd5fa32 2022-06-08 op ;; got 0.71-current at some point switched to -S for search
241 6fd5fa32 2022-06-08 op ;; pattern and -s for the one-line format.
242 6fd5fa32 2022-06-08 op ;; XXX: remove in a few releases.
243 6fd5fa32 2022-06-08 op (search-flag (if (vc-got--version<= "0.71")
246 0a66694e 2020-01-02 op (vc-got-with-worktree (or path default-directory)
248 0a3316a6 2021-02-22 op (save-excursion
249 0a3316a6 2021-02-22 op (vc-got--call "log"
250 3efc7598 2021-09-09 op (and limit (list "-l" (format "%s" limit)))
251 3efc7598 2021-09-09 op (and start-commit (list "-c" start-commit))
252 3efc7598 2021-09-09 op (and stop-commit (list "-x" stop-commit))
253 6fd5fa32 2022-06-08 op (and search-pattern (list search-flag
254 6fd5fa32 2022-06-08 op search-pattern))
255 3efc7598 2021-09-09 op (and reverse '("-R"))
256 32819756 2021-09-14 op (and include-diff '("-p"))
259 0a3316a6 2021-02-22 op (save-excursion
260 3ec8a8b4 2021-08-17 op (delete-matching-lines
261 3ec8a8b4 2021-08-17 op "^-----------------------------------------------$")
264 887e0699 2021-02-22 op (defun vc-got--status (status-codes dir-or-file &optional files)
265 dd4e6a2c 2022-05-28 op "Return a list of lists (FILE STATUS STAGE-STATUS).
266 af5ef7cd 2020-11-29 op DIR-OR-FILE can be either a directory or a file. If FILES is
267 af5ef7cd 2020-11-29 op given, return the status of those files, otherwise the status of
268 668dc8eb 2021-01-04 op DIR-OR-FILE. STATUS-CODES is either nil, or a string that's
269 668dc8eb 2021-01-04 op passed as the -s flag to got status to limit the types of status
270 668dc8eb 2021-01-04 op to report (e.g. \"CD\" to report only conflicts and deleted
272 2d039a22 2021-02-21 op (with-temp-buffer
273 2d039a22 2021-02-21 op (let* ((default-directory (expand-file-name
274 2d039a22 2021-02-21 op (if (file-directory-p dir-or-file)
276 2d039a22 2021-02-21 op (file-name-directory dir-or-file))))
277 2d039a22 2021-02-21 op (root (vc-got-root default-directory))
278 2d039a22 2021-02-21 op (process-file-side-effects))
279 2d039a22 2021-02-21 op (when (zerop (vc-got--call "status"
280 3efc7598 2021-09-09 op (and status-codes (list "-s" status-codes))
282 2d039a22 2021-02-21 op (or files dir-or-file)))
283 2d039a22 2021-02-21 op (goto-char (point-min))
284 2d039a22 2021-02-21 op (cl-loop until (eobp)
285 3ec8a8b4 2021-08-17 op collect (vc-got--parse-status-line root)
286 2d039a22 2021-02-21 op do (forward-line))))))
288 3ec8a8b4 2021-08-17 op (defun vc-got--parse-status-line (root)
289 3ec8a8b4 2021-08-17 op "Parse a line of the the output of status.
290 3ec8a8b4 2021-08-17 op ROOT is the root of the repo."
291 3ec8a8b4 2021-08-17 op ;; the format of each line is
292 3ec8a8b4 2021-08-17 op ;; <status-char> <stage-char> <spc> <filename> \n
293 3ec8a8b4 2021-08-17 op (let* ((file-status (prog1 (vc-got--parse-status-char
294 3ec8a8b4 2021-08-17 op (char-after))
295 3ec8a8b4 2021-08-17 op (forward-char)))
296 3ec8a8b4 2021-08-17 op (stage-status (let* ((c (char-after)))
298 3ec8a8b4 2021-08-17 op (when (member c '(?M ?A ?D))
300 3ec8a8b4 2021-08-17 op (forward-char))))
301 3ec8a8b4 2021-08-17 op (filename (progn
302 3ec8a8b4 2021-08-17 op (forward-char)
303 3ec8a8b4 2021-08-17 op (buffer-substring (point)
304 3ec8a8b4 2021-08-17 op (line-end-position)))))
305 3ec8a8b4 2021-08-17 op (list (file-relative-name (expand-file-name filename root)
306 3ec8a8b4 2021-08-17 op default-directory)
307 3ec8a8b4 2021-08-17 op (or file-status (and stage-status 'up-to-date))
308 3ec8a8b4 2021-08-17 op stage-status)))
310 668dc8eb 2021-01-04 op (defun vc-got--parse-status-char (c)
311 668dc8eb 2021-01-04 op "Parse status char C into a symbol accepted by `vc-state'."
315 668dc8eb 2021-01-04 op (?D 'removed)
316 668dc8eb 2021-01-04 op (?C 'conflict)
317 668dc8eb 2021-01-04 op (?! 'missing)
318 76d978fa 2021-01-05 op (?~ 'edited) ; XXX: what does it means for a file to be ``obstructed''?
319 668dc8eb 2021-01-04 op (?? 'unregistered)
320 76d978fa 2021-01-05 op (?m 'edited) ; modified file modes
323 23a0b465 2020-11-30 op (defun vc-got--cat (commit obj-id)
324 23a0b465 2020-11-30 op "Execute got cat -c COMMIT OBJ-ID in the current buffer."
325 76d978fa 2021-01-05 op (let (process-file-side-effects)
326 76d978fa 2021-01-05 op (zerop (vc-got--call "cat" "-c" commit obj-id))))
328 eb85ad27 2020-12-05 op (defun vc-got--revert (&rest files)
329 76d978fa 2021-01-05 op "Execute got revert FILES."
330 eb85ad27 2020-12-05 op (vc-got-with-worktree (car files)
331 eb85ad27 2020-12-05 op (with-temp-buffer
332 c3185bf7 2021-08-11 op (zerop (vc-got--call "revert" "--" files)))))
334 eb85ad27 2020-12-05 op (defun vc-got--list-branches ()
335 eb85ad27 2020-12-05 op "Return an alist of (branch . commit)."
336 76d978fa 2021-01-05 op (let (process-file-side-effects)
337 76d978fa 2021-01-05 op (with-temp-buffer
338 76d978fa 2021-01-05 op (when (zerop (vc-got--call "branch" "-l"))
340 3efc7598 2021-09-09 op (goto-char (point-min))
341 660cf35d 2021-09-25 op (while (re-search-forward "^\\*?[[:space:]]+\\(.+\\): \\([[:word:]]+\\)$"
343 3efc7598 2021-09-09 op (push (cons (match-string 1) (match-string 2)) alist))
346 694534b4 2020-12-05 op (defun vc-got--current-branch ()
347 694534b4 2020-12-05 op "Return the current branch."
348 76d978fa 2021-01-05 op (let (process-file-side-effects)
349 76d978fa 2021-01-05 op (with-temp-buffer
350 76d978fa 2021-01-05 op (when (zerop (vc-got--call "branch"))
351 76d978fa 2021-01-05 op (string-trim (buffer-string) "" "\n")))))
353 eb85ad27 2020-12-05 op (defun vc-got--integrate (branch)
354 eb85ad27 2020-12-05 op "Integrate BRANCH into the current one."
355 eb85ad27 2020-12-05 op (with-temp-buffer
356 76d978fa 2021-01-05 op (zerop (vc-got--call "integrate" branch))))
358 db89d6fd 2021-08-16 op (defun vc-got--update (branch &optional paths)
359 db89d6fd 2021-08-16 op "Update to a different commit or BRANCH.
360 db89d6fd 2021-08-16 op Optionally restrict the update operation to files at or within
361 db89d6fd 2021-08-16 op the specified PATHS."
362 db89d6fd 2021-08-16 op (with-temp-buffer
363 db89d6fd 2021-08-16 op (unless (zerop (vc-got--call "update" "-b" branch "--" paths))
364 db89d6fd 2021-08-16 op (error "[vc-got] can't update to branch %s: %s"
366 db89d6fd 2021-08-16 op (buffer-string)))))
368 45f7f941 2021-11-09 op (defun vc-got--diff-files (files)
369 36e5655f 2021-11-09 op "Compute the local modifications to FILES."
370 76d978fa 2021-01-05 op (let (process-file-side-effects)
371 36e5655f 2021-11-09 op (zerop (vc-got--call "diff" (vc-switches 'got 'diff) "-P" "--"
374 36e5655f 2021-11-09 op (defun vc-got--diff-objects (obj1 obj2)
375 36e5655f 2021-11-09 op "Diff the two objects OBJ1 and OBJ2.
376 36e5655f 2021-11-09 op OBJ1 and OBJ2 are interpreted as a reference, tag name, or an
377 36e5655f 2021-11-09 op object ID SHA1 hash."
378 36e5655f 2021-11-09 op (let (process-file-side-effects)
379 36e5655f 2021-11-09 op (zerop (vc-got--call "diff" (vc-switches 'got 'diff) "--" obj1 obj2))))
381 6b6c8a78 2021-01-04 op (defun vc-got--unstage (file-or-directory)
382 6b6c8a78 2021-01-04 op "Unstage all the staged hunks at or within FILE-OR-DIRECTORY.
383 6b6c8a78 2021-01-04 op If it's nil, unstage every staged changes across the entire work
385 c3185bf7 2021-08-11 op (zerop (vc-got--call "unstage" "--" file-or-directory)))
387 a96df0e8 2020-01-03 noreply (defun vc-got--remove (file &optional force keep-local)
388 76d978fa 2021-01-05 op "Use got to remove FILE.
389 76d978fa 2021-01-05 op If FORCE is non-nil perform the operation even if a file contains
390 76d978fa 2021-01-05 op local modification. If KEEP-LOCAL is non-nil keep the affected
391 76d978fa 2021-01-05 op files on disk."
392 a96df0e8 2020-01-03 noreply (vc-got-with-worktree (or file default-directory)
393 a96df0e8 2020-01-03 noreply (with-temp-buffer
394 76d978fa 2021-01-05 op (zerop (vc-got--call "remove"
395 3efc7598 2021-09-09 op (and force "-f")
396 3efc7598 2021-09-09 op (and keep-local "-k")
400 5fb2f474 2021-08-10 op (defun vc-got--ref ()
401 5fb2f474 2021-08-10 op "Return a list of all references."
402 3efc7598 2021-09-09 op (let ((process-file-side-effects nil)
403 5fb2f474 2021-08-10 op (re "^refs/\\(heads\\|remotes\\|tags\\)/\\(.*\\):")
404 5fb2f474 2021-08-10 op ;; hardcoding HEAD because it's always present and the regexp
405 5fb2f474 2021-08-10 op ;; won't match it.
406 5fb2f474 2021-08-10 op (table (list "HEAD")))
407 5fb2f474 2021-08-10 op (vc-got-with-worktree default-directory
408 5fb2f474 2021-08-10 op (with-temp-buffer
409 5fb2f474 2021-08-10 op (when (zerop (vc-got--call "ref" "-l"))
410 5fb2f474 2021-08-10 op (goto-char (point-min))
411 5fb2f474 2021-08-10 op (while (re-search-forward re nil t)
412 5fb2f474 2021-08-10 op (push (match-string 2) table))
415 8014bde1 2021-08-10 op (defun vc-got--branch (name)
416 8014bde1 2021-08-10 op "Try to create and switch to the branch called NAME."
417 8014bde1 2021-08-10 op (let (process-file-side-effects)
418 8014bde1 2021-08-10 op (vc-got-with-worktree default-directory
419 8014bde1 2021-08-10 op (with-temp-buffer
420 f0d7c7e7 2022-05-28 op (or (zerop (vc-got--call "branch" "--" name))
421 f0d7c7e7 2022-05-28 op (error "[vc-got] can't create branch %s: %s" name
422 f0d7c7e7 2022-05-28 op (buffer-string)))))))
425 af5ef7cd 2020-11-29 op ;; Backend properties
427 af5ef7cd 2020-11-29 op (defun vc-got-revision-granularity ()
428 af5ef7cd 2020-11-29 op "Got has REPOSITORY granularity."
431 af5ef7cd 2020-11-29 op (defun vc-got-update-on-retrieve-tag ()
432 84beb0d4 2021-08-17 op "Like vc-git, vc-got don't need to buffers on `retrieve-tag'."
436 af5ef7cd 2020-11-29 op ;; State-querying functions
438 af5ef7cd 2020-11-29 op ;;;###autoload (defun vc-got-registered (file)
439 af5ef7cd 2020-11-29 op ;;;###autoload "Return non-nil if FILE is registered with got."
440 af5ef7cd 2020-11-29 op ;;;###autoload (when (vc-find-root file ".got")
441 af5ef7cd 2020-11-29 op ;;;###autoload (load "vc-got" nil t)
442 af5ef7cd 2020-11-29 op ;;;###autoload (vc-got-registered file)))
444 af5ef7cd 2020-11-29 op (defun vc-got-registered (file)
445 af5ef7cd 2020-11-29 op "Return non-nil if FILE is registered with got."
446 af5ef7cd 2020-11-29 op (if (file-directory-p file)
447 76d978fa 2021-01-05 op nil ; got doesn't track directories
448 4093d2f9 2020-12-04 op (when (vc-find-root file ".got")
449 668dc8eb 2021-01-04 op (let ((s (vc-got-state file)))
450 f0d7c7e7 2022-05-28 op (not (memq s '(nil unregistered)))))))
452 af5ef7cd 2020-11-29 op (defun vc-got-state (file)
453 af5ef7cd 2020-11-29 op "Return the current version control state of FILE. See `vc-state'."
454 af5ef7cd 2020-11-29 op (unless (file-directory-p file)
455 76d978fa 2021-01-05 op (let (process-file-side-effects)
456 76d978fa 2021-01-05 op ;; Manually calling got status and checking the result inline to
457 76d978fa 2021-01-05 op ;; avoid building the data structure in vc-got--status.
458 76d978fa 2021-01-05 op (with-temp-buffer
459 c3185bf7 2021-08-11 op (when (zerop (vc-got--call "status" "--" file))
460 76d978fa 2021-01-05 op (goto-char (point-min))
463 76d978fa 2021-01-05 op (vc-got--parse-status-char (char-after))))))))
465 dcb5b83a 2021-01-08 op (defun vc-got--dir-filter-files (files)
466 dcb5b83a 2021-01-08 op "Remove ., .. and .got from FILES."
467 dcb5b83a 2021-01-08 op (cl-loop for file in files
468 dcb5b83a 2021-01-08 op unless (or (string= file "..")
469 dcb5b83a 2021-01-08 op (string= file ".")
470 dcb5b83a 2021-01-08 op (string= file ".got"))
471 dcb5b83a 2021-01-08 op collect file))
473 af5ef7cd 2020-11-29 op (defun vc-got-dir-status-files (dir files update-function)
474 5b4a6b90 2021-01-04 op "Build the status for FILES in DIR.
475 76d978fa 2021-01-05 op The builded result is given to the callback UPDATE-FUNCTION. If
476 5b4a6b90 2021-01-04 op FILES is nil, consider all the files in DIR."
477 dcb5b83a 2021-01-08 op (let* ((fs (vc-got--dir-filter-files (or files (directory-files dir))))
478 d346ca63 2021-01-08 op ;; XXX: we call with files, wich will probably be nil on the
479 d346ca63 2021-01-08 op ;; first run, so we catch deleted, missing and edited files
480 d346ca63 2021-01-08 op ;; in subdirectories.
481 d346ca63 2021-01-08 op (res (vc-got--status nil dir files))
482 d346ca63 2021-01-08 op double-check)
483 82289421 2020-01-02 op (cl-loop for file in fs
484 76d978fa 2021-01-05 op do (when (and (not (cdr (assoc file res #'string=)))
485 76d978fa 2021-01-05 op (not (file-directory-p file))
486 76d978fa 2021-01-05 op ;; if file doesn't exists, it's a
487 76d978fa 2021-01-05 op ;; untracked file that was removed.
488 76d978fa 2021-01-05 op (file-exists-p file))
489 d346ca63 2021-01-08 op ;; if we don't know the status of a file here, it's
490 d346ca63 2021-01-08 op ;; either up-to-date or ignored. Save it for a
491 d346ca63 2021-01-08 op ;; double check
492 d346ca63 2021-01-08 op (push file double-check)))
493 cb973832 2021-01-08 op (cl-loop with statuses = (vc-got--status nil dir double-check)
494 cb973832 2021-01-08 op for file in double-check
495 cb973832 2021-01-08 op unless (eq 'unregistered (cadr (assoc file statuses #'string=)))
496 d346ca63 2021-01-08 op do (push (list file 'up-to-date nil) res))
497 d346ca63 2021-01-08 op (funcall update-function res nil)))
499 c27df03e 2020-01-03 op (defun vc-got-dir-extra-headers (dir)
500 c27df03e 2020-01-03 op "Return a string for the `vc-dir' buffer heading for directory DIR."
501 76d978fa 2021-01-05 op (let ((remote (vc-got-repository-url dir)))
502 76d978fa 2021-01-05 op (concat (propertize "Repository : " 'face 'font-lock-type-face)
503 76d978fa 2021-01-05 op (vc-got--repo-root) "\n"
506 76d978fa 2021-01-05 op (propertize "Remote URL : " 'face 'font-lock-type-face)
507 76d978fa 2021-01-05 op (vc-got-repository-url dir) "\n"))
508 76d978fa 2021-01-05 op (propertize "Branch : " 'face 'font-lock-type-face)
509 76d978fa 2021-01-05 op (vc-got--current-branch))))
511 2d83de2e 2021-01-05 op (defun vc-got-dir-printer (info)
512 2d83de2e 2021-01-05 op "Pretty-printer for the vc-dir-fileinfo structure INFO."
513 2d83de2e 2021-01-05 op (let* ((isdir (vc-dir-fileinfo->directory info))
514 76d978fa 2021-01-05 op (state (if isdir "" (vc-dir-fileinfo->state info)))
515 76d978fa 2021-01-05 op (stage-state (vc-dir-fileinfo->extra info))
516 76d978fa 2021-01-05 op (filename (vc-dir-fileinfo->name info)))
520 2d83de2e 2021-01-05 op (format "%c" (if (vc-dir-fileinfo->marked info) ?* ? ))
521 2d83de2e 2021-01-05 op 'face 'font-lock-type-face)
524 1b2afa91 2021-08-17 op (format "%-12s" state)
525 2d83de2e 2021-01-05 op 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face)
526 76d978fa 2021-01-05 op ((memq state '(missing conflict)) 'font-lock-warning-face)
527 76d978fa 2021-01-05 op ((eq state 'edited) 'font-lock-constant-face)
528 76d978fa 2021-01-05 op (t 'font-lock-variable-name-face))
529 1b2afa91 2021-08-17 op 'mouse-face 'highlight
530 95a78ecb 2021-08-31 op 'keymap (vc-got--with-emacs-version<= "28.0.50"
531 95a78ecb 2021-08-31 op vc-dir-status-mouse-map))
532 1b2afa91 2021-08-17 op " " (propertize
533 1b2afa91 2021-08-17 op (if stage-state
534 1b2afa91 2021-08-17 op (format "%c" stage-state)
536 1b2afa91 2021-08-17 op 'face (cond ((memq stage-state '(?A ?E)) 'font-lock-constant-face)
537 1b2afa91 2021-08-17 op ((eq stage-state ?R) 'font-lock-warning-face)
538 1b2afa91 2021-08-17 op (t 'font-lock-variable-name-face)))
540 1b2afa91 2021-08-17 op (propertize filename
541 1b2afa91 2021-08-17 op 'face (if isdir 'font-lock-comment-delimiter-face
542 1b2afa91 2021-08-17 op 'font-lock-function-name-face)
546 3ec8a8b4 2021-08-17 op "Directory\n"
547 3ec8a8b4 2021-08-17 op "VC operations can be applied to it\n"
548 3ec8a8b4 2021-08-17 op "mouse-3: Pop-up menu")
549 1b2afa91 2021-08-17 op "File\nmouse-3: Pop-up menu")
550 1b2afa91 2021-08-17 op 'mouse-face 'highlight
551 1b2afa91 2021-08-17 op 'keymap vc-dir-filename-mouse-map))))
553 af5ef7cd 2020-11-29 op (defun vc-got-working-revision (file)
554 3ec8a8b4 2021-08-17 op "Return the last commit that touched FILE or \"0\" if it's newly added."
556 af5ef7cd 2020-11-29 op (with-temp-buffer
557 518ede14 2020-12-05 op (when (vc-got--log file 1)
559 af5ef7cd 2020-11-29 op (goto-char (point-min))
560 76d978fa 2021-01-05 op (forward-word) ; skip "commit"
561 76d978fa 2021-01-05 op (forward-char) ; skip the space
562 76d978fa 2021-01-05 op (setq start (point)) ; store start of the SHA
563 76d978fa 2021-01-05 op (forward-word) ; goto SHA end
564 af5ef7cd 2020-11-29 op (buffer-substring start (point)))))
565 af5ef7cd 2020-11-29 op ;; special case: if this file is added but has no previous commits
566 af5ef7cd 2020-11-29 op ;; touching it, got log will fail (as expected), but we have to
567 af5ef7cd 2020-11-29 op ;; return "0".
568 af5ef7cd 2020-11-29 op (when (eq (vc-got-state file) 'added)
571 af5ef7cd 2020-11-29 op (defun vc-got-checkout-model (_files)
572 01bf4e07 2021-08-17 op "Return the checkout model.
573 01bf4e07 2021-08-17 op Got uses an implicit checkout model for every file."
576 694534b4 2020-12-05 op (defun vc-got-mode-line-string (file)
577 694534b4 2020-12-05 op "Return the VC mode line string for FILE."
578 694534b4 2020-12-05 op (vc-got-with-worktree file
579 694534b4 2020-12-05 op (let ((def (vc-default-mode-line-string 'Got file)))
580 694534b4 2020-12-05 op (concat (substring def 0 4) (vc-got--current-branch)))))
583 23a0b465 2020-11-30 op ;; state-changing functions
585 23a0b465 2020-11-30 op (defun vc-got-create-repo (_backend)
586 7726b6c9 2021-08-10 op "Create an empty repository in the current directory."
587 7726b6c9 2021-08-10 op (error "[vc-got] create-repo not implemented"))
589 23a0b465 2020-11-30 op (defun vc-got-register (files &optional _comment)
590 23a0b465 2020-11-30 op "Register FILES, passing `vc-register-switches' to the backend command."
591 23a0b465 2020-11-30 op (vc-got--add files))
593 9e805da8 2020-11-30 op (defalias 'vc-got-responsible-p #'vc-got-root)
595 241a3b12 2021-08-11 op (defun vc-got-unregister (file)
596 241a3b12 2021-08-11 op "Unregister FILE."
597 9114bbc3 2021-08-11 op (vc-got--remove file t t))
599 23a0b465 2020-11-30 op (defun vc-got-checkin (files comment &optional _rev)
600 23a0b465 2020-11-30 op "Commit FILES with COMMENT as commit message."
601 23a0b465 2020-11-30 op (with-temp-buffer
602 ad36649b 2021-02-25 op (unless (zerop (vc-got--call "commit" "-m"
603 e7747ce0 2021-08-11 op (log-edit-extract-headers nil comment)
606 26362bf0 2021-08-11 op (error "[vc-got] can't commit: %s" (buffer-string)))))
608 23a0b465 2020-11-30 op (defun vc-got-find-revision (file rev buffer)
609 c0c9a339 2020-12-04 op "Fill BUFFER with the content of FILE in the given revision REV."
610 961d35b5 2021-09-09 op (with-current-buffer buffer
611 961d35b5 2021-09-09 op (vc-got-with-worktree file
612 961d35b5 2021-09-09 op (vc-got--cat rev (file-relative-name file)))))
614 eb85ad27 2020-12-05 op (defun vc-got-checkout (_file &optional _rev)
615 76d978fa 2021-01-05 op "Checkout revision REV of FILE.
616 76d978fa 2021-01-05 op If REV is t, checkout from the head."
617 7726b6c9 2021-08-10 op (error "[vc-got] checkout not implemented"))
619 eb85ad27 2020-12-05 op (defun vc-got-revert (file &optional _content-done)
620 eb85ad27 2020-12-05 op "Revert FILE back to working revision."
621 eb85ad27 2020-12-05 op (vc-got--revert file))
623 eb85ad27 2020-12-05 op (defun vc-got-merge-branch ()
624 eb85ad27 2020-12-05 op "Prompt for a branch and integrate it into the current one."
625 eb85ad27 2020-12-05 op ;; XXX: be smart and try to "got rebase" if "got integrate" fails?
626 eb85ad27 2020-12-05 op (let* ((branches (cl-loop for (branch . commit) in (vc-got--list-branches)
627 eb85ad27 2020-12-05 op collect branch))
628 eb85ad27 2020-12-05 op (branch (completing-read "Merge from branch: " branches)))
630 eb85ad27 2020-12-05 op (vc-got--integrate branch))))
632 74b00009 2021-08-31 op (defun vc-got--proc-filter (proc s)
633 74b00009 2021-08-31 op "Custom output filter for async process PROC.
634 74b00009 2021-08-31 op It's like `vc-process-filter' but supports \r inside S."
635 74b00009 2021-08-31 op (let ((buffer (process-buffer proc)))
636 74b00009 2021-08-31 op (when (buffer-live-p buffer)
637 74b00009 2021-08-31 op (with-current-buffer buffer
638 74b00009 2021-08-31 op (save-excursion
639 74b00009 2021-08-31 op (let ((buffer-undo-list t)
640 74b00009 2021-08-31 op (inhibit-read-only t))
641 74b00009 2021-08-31 op (goto-char (process-mark proc))
642 74b00009 2021-08-31 op (if (not (string-match ".*\r\\(.*\\)" s))
645 74b00009 2021-08-31 op (end-of-line)
646 74b00009 2021-08-31 op (let ((end (point)))
647 74b00009 2021-08-31 op (beginning-of-line)
648 74b00009 2021-08-31 op (delete-region (point) end))
649 74b00009 2021-08-31 op (insert (match-string 1 s)))
650 74b00009 2021-08-31 op (set-marker (process-mark proc) (point))))))))
652 dec54a74 2021-02-21 op (defun vc-got--push-pull (cmd op prompt)
653 dec54a74 2021-02-21 op "Execute CMD OP, or prompt the user if PROMPT is non-nil."
654 dec54a74 2021-02-21 op (let ((buffer (format "*vc-got : %s*" (expand-file-name default-directory))))
655 686eac9a 2020-12-07 op (when-let (cmd (if prompt
656 686eac9a 2020-12-07 op (split-string
657 686eac9a 2020-12-07 op (read-shell-command (format "%s %s command: " cmd op)
658 1870c8bd 2021-03-27 op (format "%s %s " cmd op))
660 686eac9a 2020-12-07 op (list cmd op)))
661 dec54a74 2021-02-21 op (apply #'vc-do-async-command buffer default-directory cmd)
662 dec54a74 2021-02-21 op (with-current-buffer buffer
663 74b00009 2021-08-31 op (vc-compilation-mode 'got)
664 74b00009 2021-08-31 op (let ((comp-cmd (mapconcat #'identity cmd " "))
665 74b00009 2021-08-31 op (proc (get-buffer-process buffer)))
666 95a78ecb 2021-08-31 op (setq-local compile-command comp-cmd)
667 95a78ecb 2021-08-31 op (setq-local compilation-directory default-directory)
668 95a78ecb 2021-08-31 op (setq-local compilation-arguments (list comp-cmd
670 dec54a74 2021-02-21 op (lambda (_ign) buffer)
672 74b00009 2021-08-31 op ;; Setup a custom process filter that handles \r.
673 74b00009 2021-08-31 op (set-process-filter proc #'vc-got--proc-filter)))
674 dec54a74 2021-02-21 op (vc-set-async-update buffer))))
676 3ec8a8b4 2021-08-17 op ;; TODO: this could be expanded. After a pull the worktree needs to
677 95782f5b 2022-02-01 op ;; be updated, either with a ``got update -b branch-name'' or ``got
678 95782f5b 2022-02-01 op ;; update -b remote/branchname'' plus a rebase.
679 eb85ad27 2020-12-05 op (defun vc-got-pull (prompt)
680 16a2f37b 2022-05-28 op "Execute a fetch prompting for the full command if PROMPT is not nil."
681 e4ac2ae5 2021-10-04 op (vc-got--push-pull vc-got-program "fetch" prompt))
683 686eac9a 2020-12-07 op (defun vc-got-push (prompt)
684 16a2f37b 2022-05-28 op "Execute a send prompting for the full command if PROMPT is not nil."
685 e4ac2ae5 2021-10-04 op (vc-got--push-pull vc-got-program "send" prompt))
688 424f5152 2021-08-10 op ;; History functions
690 eb85ad27 2020-12-05 op (defun vc-got-print-log (files buffer &optional _shortlog start-revision limit)
691 eb85ad27 2020-12-05 op "Insert the revision log for FILES into BUFFER.
692 76d978fa 2021-01-05 op LIMIT limits the number of commits, optionally starting at
693 76d978fa 2021-01-05 op START-REVISION."
694 2217122f 2022-07-19 op (vc-setup-buffer buffer)
695 eb85ad27 2020-12-05 op (with-current-buffer buffer
696 4571b1fd 2020-12-05 op (let ((inhibit-read-only t))
697 eb85ad27 2020-12-05 op (cl-loop for file in files
698 3ec8a8b4 2021-08-17 op do (vc-got--log (file-relative-name file)
700 3ec8a8b4 2021-08-17 op start-revision)))))
702 9ad1eb5d 2020-12-07 op (defun vc-got-log-outgoing (buffer remote-location)
703 9ad1eb5d 2020-12-07 op "Fill BUFFER with the diff between the local worktree branch and REMOTE-LOCATION."
704 9ad1eb5d 2020-12-07 op (vc-setup-buffer buffer)
705 a1839dca 2021-08-17 op (let ((rl (vc-got-next-revision
707 a1839dca 2021-08-17 op (if (or (not remote-location) (string-empty-p remote-location))
708 a1839dca 2021-08-17 op (concat "origin/" (vc-got--current-branch))
709 a1839dca 2021-08-17 op remote-location)))
710 9ad1eb5d 2020-12-07 op (inhibit-read-only t))
711 9ad1eb5d 2020-12-07 op (with-current-buffer buffer
712 9ad1eb5d 2020-12-07 op (vc-got--log nil nil nil rl))))
714 3ec0e0ca 2022-07-19 op (defun vc-got-log-incoming (buffer remote-location)
715 3391eaf8 2022-02-01 op "Fill BUFFER with the incoming diff from REMOTE-LOCATION.
716 3391eaf8 2022-02-01 op That is, the diff between REMOTE-LOCATION and the local repository."
717 3ec0e0ca 2022-07-19 op (vc-setup-buffer buffer)
718 6eda2f1f 2020-12-26 op (let ((rl (if (or (not remote-location) (string-empty-p remote-location))
719 6eda2f1f 2020-12-26 op (concat "origin/" (vc-got--current-branch))
720 6eda2f1f 2020-12-26 op remote-location))
721 6eda2f1f 2020-12-26 op (inhibit-read-only t))
722 6eda2f1f 2020-12-26 op (with-current-buffer buffer
723 6eda2f1f 2020-12-26 op (vc-got--log nil nil (vc-got--current-branch) rl))))
725 eb85ad27 2020-12-05 op (defun vc-got-log-search (buffer pattern)
726 eb85ad27 2020-12-05 op "Search commits for PATTERN and write the results found in BUFFER."
727 eb85ad27 2020-12-05 op (with-current-buffer buffer
728 eb85ad27 2020-12-05 op (let ((inhibit-read-only t))
729 9ad1eb5d 2020-12-07 op (vc-got--log nil nil nil nil pattern))))
731 0a3316a6 2021-02-22 op (define-derived-mode vc-got-log-view-mode log-view-mode "Got-Log-View"
732 0a3316a6 2021-02-22 op "Got-specific log-view mode.
733 0a3316a6 2021-02-22 op Heavily inspired by `vc-git-log-view-mode'."
734 0a3316a6 2021-02-22 op (require 'add-log)
735 95a78ecb 2021-08-31 op (setq-local log-view-file-re regexp-unmatchable)
736 95a78ecb 2021-08-31 op (setq-local log-view-per-file-logs nil)
737 95a78ecb 2021-08-31 op (setq-local log-view-message-re "^commit +\\([0-9a-z]+\\)")
738 95a78ecb 2021-08-31 op (setq-local log-view-font-lock-keywords
740 95a78ecb 2021-08-31 op `((,log-view-message-re (1 'change-log-acknowledgment)))
741 95a78ecb 2021-08-31 op ;; Handle the case:
742 95a78ecb 2021-08-31 op ;; user: foo@bar
743 95a78ecb 2021-08-31 op '(("^from: \\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
744 95a78ecb 2021-08-31 op (1 'change-log-email))
745 95a78ecb 2021-08-31 op ;; Handle the case:
746 95a78ecb 2021-08-31 op ;; user: FirstName LastName <foo@bar>
747 95a78ecb 2021-08-31 op ("^from: \\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
748 95a78ecb 2021-08-31 op (1 'change-log-name)
749 95a78ecb 2021-08-31 op (2 'change-log-email))
750 95a78ecb 2021-08-31 op ("^date: \\(.+\\)" (1 'change-log-date))))))
752 eb85ad27 2020-12-05 op ;; TODO: async
753 f18d3e11 2020-12-05 op ;; TODO: return 0 or 1
754 eb85ad27 2020-12-05 op (defun vc-got-diff (files &optional rev1 rev2 buffer _async)
755 eb85ad27 2020-12-05 op "Insert into BUFFER (or *vc-diff*) the diff for FILES from REV1 to REV2."
756 f457868b 2020-12-07 op (let* ((buffer (get-buffer-create (or buffer "*vc-diff*")))
757 eb85ad27 2020-12-05 op (inhibit-read-only t))
758 eb85ad27 2020-12-05 op (with-current-buffer buffer
759 8ec0bb76 2021-08-11 op (vc-got-with-worktree (or (car files)
760 8ec0bb76 2021-08-11 op default-directory)
761 32819756 2021-09-14 op (cond ((and (null rev1)
763 45f7f941 2021-11-09 op (vc-got--diff-files files))
764 32819756 2021-09-14 op ((and (null rev1)
766 32819756 2021-09-14 op ;; TODO: this includes the whole diff while to respect
767 32819756 2021-09-14 op ;; the vc semantics we should filter only the diff for
768 32819756 2021-09-14 op ;; files in FILES.
770 32819756 2021-09-14 op ;; XXX: this includes also the commit message, I
771 32819756 2021-09-14 op ;; consider it a feature over the usual vc behaviour of
772 32819756 2021-09-14 op ;; showing only the diff.
773 32819756 2021-09-14 op (vc-got--log nil 1 rev2 nil nil nil t))
775 32819756 2021-09-14 op ;; TODO: if rev1 is nil, diff from the current version until
778 32819756 2021-09-14 op ;; TODO 2: if rev2 is nil as well, diff against an empty
779 32819756 2021-09-14 op ;; tree (i.e. get the patch from `got log -p rev1')
780 36e5655f 2021-11-09 op (t (vc-got--diff-objects rev1 rev2)))))))
782 5fb2f474 2021-08-10 op (defun vc-got-revision-completion-table (_files)
783 5fb2f474 2021-08-10 op "Return a completion table for existing revisions.
784 5fb2f474 2021-08-10 op Ignores FILES because GoT doesn't have the concept of ``file
785 5fb2f474 2021-08-10 op revisions''; instead, like with git, you have tags and branches."
786 5fb2f474 2021-08-10 op (letrec ((table (lazy-completion-table
787 5fb2f474 2021-08-10 op table (lambda () (vc-got--ref)))))
790 3f25d9ff 2020-01-02 noreply (defun vc-got-annotate-command (file buf &optional rev)
791 67332bad 2021-01-05 op "Show annotated contents of FILE in buffer BUF. If given, use revision REV."
792 3f25d9ff 2020-01-02 noreply (let (process-file-side-effects)
793 3f25d9ff 2020-01-02 noreply (with-current-buffer buf
794 3f25d9ff 2020-01-02 noreply ;; FIXME: vc-ensure-vc-buffer won't recognise this buffer as managed
795 3f25d9ff 2020-01-02 noreply ;; by got unless vc-parent-buffer points to a buffer managed by got.
796 3f25d9ff 2020-01-02 noreply ;; investigate why this is needed.
797 3efc7598 2021-09-09 op (setq-local vc-parent-buffer (find-file-noselect file))
798 76d978fa 2021-01-05 op (vc-got--call "blame"
799 76d978fa 2021-01-05 op (when rev (list "-c" rev))
803 3f25d9ff 2020-01-02 noreply (defconst vc-got--annotate-re
804 3f25d9ff 2020-01-02 noreply (concat "^[0-9]\\{1,\\}) " ; line number followed by )
805 3f25d9ff 2020-01-02 noreply "\\([a-z0-9]+\\) " ; SHA-1 of commit
806 3f25d9ff 2020-01-02 noreply "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\) " ; year-mm-dd
807 3f25d9ff 2020-01-02 noreply "\\([^ ]\\)+ ") ; author
808 3f25d9ff 2020-01-02 noreply "Regexp to match annotation output lines.
809 3f25d9ff 2020-01-02 noreply Provides capture groups for:
810 3f25d9ff 2020-01-02 noreply 1. revision id
811 3f25d9ff 2020-01-02 noreply 2. date of commit
812 3f25d9ff 2020-01-02 noreply 3. author of commit")
814 3f25d9ff 2020-01-02 noreply (defconst vc-got--commit-re "^commit \\([a-z0-9]+\\)"
815 3f25d9ff 2020-01-02 noreply "Regexp to match commit lines.
816 3f25d9ff 2020-01-02 noreply Provides capture group for the commit revision id.")
818 3f25d9ff 2020-01-02 noreply (defun vc-got-annotate-time ()
819 3f25d9ff 2020-01-02 noreply "Return the time of the next line of annotation at or after point.
820 3f25d9ff 2020-01-02 noreply Value is returned as floating point fractional number of days."
821 01c0cd8c 2021-09-14 op ;; XXX: to behave like vc-git here we should call re-search-forward
822 01c0cd8c 2021-09-14 op ;; instead of looking-at, as it makes the fontification of the line
823 01c0cd8c 2021-09-14 op ;; start AFTER the info. The problem is, due to the format of the
824 01c0cd8c 2021-09-14 op ;; blame, it produces an ugly result, with colors starting at
825 0a5a024b 2022-02-01 op ;; different offsets depending on how long the committer name is.
826 01c0cd8c 2021-09-14 op (when (looking-at vc-got--annotate-re)
827 01c0cd8c 2021-09-14 op (let ((str (match-string-no-properties 2)))
828 01c0cd8c 2021-09-14 op (vc-annotate-convert-time
829 01c0cd8c 2021-09-14 op (encode-time 0 0 0
830 01c0cd8c 2021-09-14 op (string-to-number (substring str 8 10))
831 01c0cd8c 2021-09-14 op (string-to-number (substring str 5 7))
832 01c0cd8c 2021-09-14 op (string-to-number (substring str 0 4)))))))
834 3f25d9ff 2020-01-02 noreply (defun vc-got-annotate-extract-revision-at-line ()
835 67332bad 2021-01-05 op "Return revision corresponding to the current line or nil."
836 3f25d9ff 2020-01-02 noreply (save-excursion
837 3f25d9ff 2020-01-02 noreply (beginning-of-line)
838 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--annotate-re)
839 3f25d9ff 2020-01-02 noreply (match-string-no-properties 1))))
842 8014bde1 2021-08-10 op ;; Tag system
844 6ab1c7b4 2021-08-11 op (defun vc-got--tag-callback (tag)
845 6ab1c7b4 2021-08-11 op "`log-edit' callback for `vc-got-create-tag'.
846 6ab1c7b4 2021-08-11 op Creates the TAG using the content of the current buffer."
847 6ab1c7b4 2021-08-11 op (interactive)
848 6ab1c7b4 2021-08-11 op (let ((msg (buffer-substring-no-properties (point-min)
849 6ab1c7b4 2021-08-11 op (point-max))))
850 6ab1c7b4 2021-08-11 op (with-temp-buffer
851 3dcaa71b 2021-08-31 op (unless (zerop (vc-got--call "tag"
853 3dcaa71b 2021-08-31 op (log-edit-extract-headers nil msg)
856 6ab1c7b4 2021-08-11 op (error "[vc-got] can't create tag %s: %s" tag (buffer-string))))))
858 8014bde1 2021-08-10 op (defun vc-got-create-tag (_dir name branchp)
859 8014bde1 2021-08-10 op "Attach the tag NAME to the state of the worktree.
860 6ab1c7b4 2021-08-11 op DIR is ignored (tags are global, not per-file). If BRANCHP is
861 6ab1c7b4 2021-08-11 op true, NAME should create a new branch otherwise it will pop-up a
862 6ab1c7b4 2021-08-11 op `log-edit' buffer to provide the tag message."
863 8014bde1 2021-08-10 op ;; TODO: vc reccomends to ensure that all the file are in a clean
864 8014bde1 2021-08-10 op ;; state, but is it useful?
866 8014bde1 2021-08-10 op (vc-got--branch name)
867 6ab1c7b4 2021-08-11 op (let ((buf (get-buffer-create "*vc-got tag*")))
868 6ab1c7b4 2021-08-11 op (with-current-buffer buf
869 6ab1c7b4 2021-08-11 op (erase-buffer)
870 3dcaa71b 2021-08-31 op (save-excursion
871 3dcaa71b 2021-08-31 op (insert "Summary: tag " name "\n\n"))
872 3dcaa71b 2021-08-31 op (move-end-of-line 1)
873 6ab1c7b4 2021-08-11 op (switch-to-buffer buf)
874 6ab1c7b4 2021-08-11 op (log-edit (lambda ()
875 6ab1c7b4 2021-08-11 op (interactive)
876 6ab1c7b4 2021-08-11 op (unwind-protect
877 6ab1c7b4 2021-08-11 op (vc-got--tag-callback name)
878 6ab1c7b4 2021-08-11 op (kill-buffer buf))))))))
880 09d59379 2021-08-11 op (defun vc-got-retrieve-tag (dir name _update)
881 09d59379 2021-08-11 op "Switch to the tag NAME for files at or below DIR."
882 09d59379 2021-08-11 op (let ((default-directory dir))
883 db89d6fd 2021-08-16 op (vc-got--update name dir)))
886 424f5152 2021-08-10 op ;; Miscellaneous
888 2552a6c7 2021-08-11 op (defun vc-got-find-ignore-file (file)
889 2552a6c7 2021-08-11 op "Return the gitignore file that controls FILE."
890 2552a6c7 2021-08-11 op (expand-file-name ".gitignore"
891 2552a6c7 2021-08-11 op (vc-got-root file)))
893 3f25d9ff 2020-01-02 noreply (defun vc-got-previous-revision (file rev)
894 3ec8a8b4 2021-08-17 op "Return the revision number that precedes REV for FILE or nil."
895 3f25d9ff 2020-01-02 noreply (with-temp-buffer
896 3f25d9ff 2020-01-02 noreply (vc-got--log file 2 rev nil nil t)
897 3f25d9ff 2020-01-02 noreply (goto-char (point-min))
898 3f25d9ff 2020-01-02 noreply (keep-lines "^commit")
899 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--commit-re)
900 3f25d9ff 2020-01-02 noreply (match-string-no-properties 1))))
902 3f25d9ff 2020-01-02 noreply (defun vc-got-next-revision (file rev)
903 3ec8a8b4 2021-08-17 op "Return the revision number that follows REV for FILE or nil."
904 3f25d9ff 2020-01-02 noreply (with-temp-buffer
905 3f25d9ff 2020-01-02 noreply (vc-got--log file nil nil rev)
906 3f25d9ff 2020-01-02 noreply (keep-lines "^commit" (point-min) (point-max))
907 3f25d9ff 2020-01-02 noreply (goto-char (point-max))
908 76d978fa 2021-01-05 op (forward-line -1) ; return from empty line to last actual commit
909 3f25d9ff 2020-01-02 noreply (unless (= (point) (point-min))
910 3f25d9ff 2020-01-02 noreply (forward-line -1)
911 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--commit-re)
912 3f25d9ff 2020-01-02 noreply (match-string-no-properties 1)))))
914 a96df0e8 2020-01-03 noreply (defun vc-got-delete-file (file)
915 a96df0e8 2020-01-03 noreply "Delete FILE locally and mark it deleted in work tree."
916 a96df0e8 2020-01-03 noreply (vc-got--remove file t))
918 c151c257 2021-08-03 op (defun vc-got-find-file-hook ()
919 c151c257 2021-08-03 op "Activate `smerge-mode' if there is a conflict."
920 c151c257 2021-08-03 op ;; just like vc-git-find-file-hook
921 c151c257 2021-08-03 op (when (and buffer-file-name
922 c151c257 2021-08-03 op (eq (vc-state buffer-file-name 'Got) 'conflict)
923 c151c257 2021-08-03 op (save-excursion
924 c151c257 2021-08-03 op (goto-char (point-min))
925 c151c257 2021-08-03 op (re-search-forward "^<<<<<<< " nil 'noerror)))
926 c151c257 2021-08-03 op (smerge-start-session)
927 c151c257 2021-08-03 op (vc-message-unresolved-conflicts buffer-file-name)))
929 7bb16f79 2020-01-03 op (defun vc-got-conflicted-files (dir)
930 7bb16f79 2020-01-03 op "Return the list of files with conflicts in directory DIR."
931 7bb16f79 2020-01-03 op (let* ((root (vc-got-root dir))
932 7bb16f79 2020-01-03 op (default-directory root)
933 3efc7598 2021-09-09 op (process-file-side-effects nil))
934 3efc7598 2021-09-09 op (cl-loop for (file status _) in (vc-got--status "C" ".")
935 3efc7598 2021-09-09 op when (and (eq status 'conflict)
936 3efc7598 2021-09-09 op (file-in-directory-p file dir))
937 3efc7598 2021-09-09 op collect file)))
939 8b635a9f 2020-01-03 op (defun vc-got-repository-url (_file &optional remote-name)
940 8b635a9f 2020-01-03 op "Return URL for REMOTE-NAME, or for \"origin\" if nil."
941 8b635a9f 2020-01-03 op (let* ((default-directory (vc-got--repo-root))
942 8b635a9f 2020-01-03 op (remote-name (or remote-name "origin"))
943 8b635a9f 2020-01-03 op (heading (concat "[remote \"" remote-name "\"]"))
944 76d978fa 2021-01-05 op (conf (cond ((file-exists-p ".git/config") ".git/config")
945 76d978fa 2021-01-05 op ((file-exists-p ".git") nil)
946 76d978fa 2021-01-05 op ((file-exists-p "config") "config")))
949 6f42ede4 2021-01-05 op (with-temp-buffer
950 f8a9db56 2020-01-03 op (insert-file-contents conf)
951 f8a9db56 2020-01-03 op (goto-char (point-min))
952 f8a9db56 2020-01-03 op (when (search-forward heading nil t)
953 f8a9db56 2020-01-03 op (forward-line)
954 f8a9db56 2020-01-03 op (while (and (not found)
955 76d978fa 2021-01-05 op (looking-at ".*=") ; too broad?
956 7a5ead65 2020-01-03 op (not (= (point) (point-max))))
957 f8a9db56 2020-01-03 op (when (looking-at ".*url = \\(.*\\)")
958 7a5ead65 2020-01-03 op (setq found (match-string-no-properties 1)))
959 7a5ead65 2020-01-03 op (forward-line))
964 a1679b13 2021-09-09 op ;; Automatically register the backend and add ".got" to the exclusion
967 a1679b13 2021-09-09 op ;;;###autoload
968 a1679b13 2021-09-09 op (add-to-list 'vc-handled-backends 'Got)
970 a1679b13 2021-09-09 op ;;;###autoload
971 a1679b13 2021-09-09 op (add-to-list 'vc-directory-exclusion-list ".got")
973 af5ef7cd 2020-11-29 op (provide 'vc-got)
974 af5ef7cd 2020-11-29 op ;;; vc-got.el ends here
