1 00713762 2021-08-17 op ;;; vc-got.el --- VC backend for Game of Trees VCS -*- lexical-binding: t; -*-
3 adbe5db0 2021-09-09 op ;; Copyright (C) 2021 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 d3ca33b4 2021-08-16 op ;; URL: https://git.omarpolo.com/vc-got/
8 61b9a83b 2021-08-17 op ;; Keywords: vc tools
9 8fc127f8 2021-09-09 op ;; Version: 1.0
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 186da174 2021-08-17 op ;; This file contains a VC backend for the Game of Trees (got) version
28 186da174 2021-08-17 op ;; control system.
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
121 eb85ad27 2020-12-05 op ;; TODO: vc-git has most function that starts with:
123 eb85ad27 2020-12-05 op ;; (let* ((root (vc-git-root default-directory))
124 eb85ad27 2020-12-05 op ;; (buffer (format "*vc-git : %s*" (expand-file-name root)))
128 eb85ad27 2020-12-05 op ;; we should 1) investigate if also other backends do something like
129 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 f09d6359 2020-12-31 noreply (defun vc-got--program-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 af5ef7cd 2020-11-29 op (defun vc-got-root (file)
189 af5ef7cd 2020-11-29 op "Return the work tree root for FILE, or nil."
190 6a973a79 2021-08-11 op (vc-find-root file ".got"))
192 af5ef7cd 2020-11-29 op (defmacro vc-got-with-worktree (file &rest body)
193 af5ef7cd 2020-11-29 op "Evaluate BODY in the work tree directory of FILE."
194 3efc7598 2021-09-09 op (declare (debug t) (indent defun))
195 af5ef7cd 2020-11-29 op `(when-let (default-directory (vc-got-root ,file))
198 686eac9a 2020-12-07 op (defun vc-got--repo-root ()
199 686eac9a 2020-12-07 op "Return the path to the repository root.
200 686eac9a 2020-12-07 op Assume `default-directory' is inside a got worktree."
201 686eac9a 2020-12-07 op (vc-got-with-worktree default-directory
202 686eac9a 2020-12-07 op (with-temp-buffer
203 686eac9a 2020-12-07 op (insert-file-contents ".got/repository")
204 76d978fa 2021-01-05 op (string-trim (buffer-string) "" "\n"))))
206 af5ef7cd 2020-11-29 op (defun vc-got--call (&rest args)
207 76d978fa 2021-01-05 op "Call `vc-got-program' with ARGS.
208 76d978fa 2021-01-05 op The output will be placed in the current buffer."
209 fab791a2 2020-01-03 op (apply #'process-file vc-got-program nil (current-buffer) nil
210 3efc7598 2021-09-09 op (apply #'nconc (mapcar (lambda (s) (if (listp s) s (list s))) args))))
212 23a0b465 2020-11-30 op (defun vc-got--add (files)
213 23a0b465 2020-11-30 op "Add FILES to got, passing `vc-register-switches' to the command invocation."
214 23a0b465 2020-11-30 op (with-temp-buffer
215 c3185bf7 2021-08-11 op (vc-got--call "add" vc-register-switches "--" files)))
217 0a66694e 2020-01-02 op (defun vc-got--log (&optional path limit start-commit stop-commit
218 0a66694e 2020-01-02 op search-pattern reverse)
219 76d978fa 2021-01-05 op "Execute the log command in the worktree of PATH in the current buffer.
220 23a0b465 2020-11-30 op LIMIT limits the maximum number of commit returned.
222 518ede14 2020-12-05 op START-COMMIT: start traversing history at the specified commit.
223 9ad1eb5d 2020-12-07 op STOP-COMMIT: stop traversing history at the specified commit.
224 518ede14 2020-12-05 op SEARCH-PATTERN: limit to log messages matched by the regexp given.
225 0a66694e 2020-01-02 op REVERSE: display the log messages in reverse order.
227 23a0b465 2020-11-30 op Return nil if the command failed or if PATH isn't included in any
229 3efc7598 2021-09-09 op (let ((process-file-side-effects nil))
230 0a66694e 2020-01-02 op (vc-got-with-worktree (or path default-directory)
232 0a3316a6 2021-02-22 op (save-excursion
233 0a3316a6 2021-02-22 op (vc-got--call "log"
234 3efc7598 2021-09-09 op (and limit (list "-l" (format "%s" limit)))
235 3efc7598 2021-09-09 op (and start-commit (list "-c" start-commit))
236 3efc7598 2021-09-09 op (and stop-commit (list "-x" stop-commit))
237 3efc7598 2021-09-09 op (and search-pattern (list "-s" search-pattern))
238 3efc7598 2021-09-09 op (and reverse '("-R"))
241 0a3316a6 2021-02-22 op (save-excursion
242 3ec8a8b4 2021-08-17 op (delete-matching-lines
243 3ec8a8b4 2021-08-17 op "^-----------------------------------------------$")
246 887e0699 2021-02-22 op (defun vc-got--status (status-codes dir-or-file &optional files)
247 668dc8eb 2021-01-04 op "Return a list of lists '(FILE STATUS STAGE-STATUS).
248 af5ef7cd 2020-11-29 op DIR-OR-FILE can be either a directory or a file. If FILES is
249 af5ef7cd 2020-11-29 op given, return the status of those files, otherwise the status of
250 668dc8eb 2021-01-04 op DIR-OR-FILE. STATUS-CODES is either nil, or a string that's
251 668dc8eb 2021-01-04 op passed as the -s flag to got status to limit the types of status
252 668dc8eb 2021-01-04 op to report (e.g. \"CD\" to report only conflicts and deleted
254 2d039a22 2021-02-21 op (with-temp-buffer
255 2d039a22 2021-02-21 op (let* ((default-directory (expand-file-name
256 2d039a22 2021-02-21 op (if (file-directory-p dir-or-file)
258 2d039a22 2021-02-21 op (file-name-directory dir-or-file))))
259 2d039a22 2021-02-21 op (root (vc-got-root default-directory))
260 2d039a22 2021-02-21 op (process-file-side-effects))
261 2d039a22 2021-02-21 op (when (zerop (vc-got--call "status"
262 3efc7598 2021-09-09 op (and status-codes (list "-s" status-codes))
264 2d039a22 2021-02-21 op (or files dir-or-file)))
265 2d039a22 2021-02-21 op (goto-char (point-min))
266 2d039a22 2021-02-21 op (cl-loop until (eobp)
267 3ec8a8b4 2021-08-17 op collect (vc-got--parse-status-line root)
268 2d039a22 2021-02-21 op do (forward-line))))))
270 3ec8a8b4 2021-08-17 op (defun vc-got--parse-status-line (root)
271 3ec8a8b4 2021-08-17 op "Parse a line of the the output of status.
272 3ec8a8b4 2021-08-17 op ROOT is the root of the repo."
273 3ec8a8b4 2021-08-17 op ;; the format of each line is
274 3ec8a8b4 2021-08-17 op ;; <status-char> <stage-char> <spc> <filename> \n
275 3ec8a8b4 2021-08-17 op (let* ((file-status (prog1 (vc-got--parse-status-char
276 3ec8a8b4 2021-08-17 op (char-after))
277 3ec8a8b4 2021-08-17 op (forward-char)))
278 3ec8a8b4 2021-08-17 op (stage-status (let* ((c (char-after)))
280 3ec8a8b4 2021-08-17 op (when (member c '(?M ?A ?D))
282 3ec8a8b4 2021-08-17 op (forward-char))))
283 3ec8a8b4 2021-08-17 op (filename (progn
284 3ec8a8b4 2021-08-17 op (forward-char)
285 3ec8a8b4 2021-08-17 op (buffer-substring (point)
286 3ec8a8b4 2021-08-17 op (line-end-position)))))
287 3ec8a8b4 2021-08-17 op (list (file-relative-name (expand-file-name filename root)
288 3ec8a8b4 2021-08-17 op default-directory)
289 3ec8a8b4 2021-08-17 op (or file-status (and stage-status 'up-to-date))
290 3ec8a8b4 2021-08-17 op stage-status)))
292 668dc8eb 2021-01-04 op (defun vc-got--parse-status-char (c)
293 668dc8eb 2021-01-04 op "Parse status char C into a symbol accepted by `vc-state'."
297 668dc8eb 2021-01-04 op (?D 'removed)
298 668dc8eb 2021-01-04 op (?C 'conflict)
299 668dc8eb 2021-01-04 op (?! 'missing)
300 76d978fa 2021-01-05 op (?~ 'edited) ; XXX: what does it means for a file to be ``obstructed''?
301 668dc8eb 2021-01-04 op (?? 'unregistered)
302 76d978fa 2021-01-05 op (?m 'edited) ; modified file modes
305 23a0b465 2020-11-30 op (defun vc-got--cat (commit obj-id)
306 23a0b465 2020-11-30 op "Execute got cat -c COMMIT OBJ-ID in the current buffer."
307 76d978fa 2021-01-05 op (let (process-file-side-effects)
308 76d978fa 2021-01-05 op (zerop (vc-got--call "cat" "-c" commit obj-id))))
310 eb85ad27 2020-12-05 op (defun vc-got--revert (&rest files)
311 76d978fa 2021-01-05 op "Execute got revert FILES."
312 eb85ad27 2020-12-05 op (vc-got-with-worktree (car files)
313 eb85ad27 2020-12-05 op (with-temp-buffer
314 c3185bf7 2021-08-11 op (zerop (vc-got--call "revert" "--" files)))))
316 eb85ad27 2020-12-05 op (defun vc-got--list-branches ()
317 eb85ad27 2020-12-05 op "Return an alist of (branch . commit)."
318 76d978fa 2021-01-05 op (let (process-file-side-effects)
319 76d978fa 2021-01-05 op (with-temp-buffer
320 76d978fa 2021-01-05 op (when (zerop (vc-got--call "branch" "-l"))
322 3efc7598 2021-09-09 op (goto-char (point-min))
323 3efc7598 2021-09-09 op (while (re-search-forward "^\\* \\(.+\\): \\([[:word:]]+\\)$" nil t)
324 3efc7598 2021-09-09 op (push (cons (match-string 1) (match-string 2)) alist))
327 694534b4 2020-12-05 op (defun vc-got--current-branch ()
328 694534b4 2020-12-05 op "Return the current branch."
329 76d978fa 2021-01-05 op (let (process-file-side-effects)
330 76d978fa 2021-01-05 op (with-temp-buffer
331 76d978fa 2021-01-05 op (when (zerop (vc-got--call "branch"))
332 76d978fa 2021-01-05 op (string-trim (buffer-string) "" "\n")))))
334 eb85ad27 2020-12-05 op (defun vc-got--integrate (branch)
335 eb85ad27 2020-12-05 op "Integrate BRANCH into the current one."
336 eb85ad27 2020-12-05 op (with-temp-buffer
337 76d978fa 2021-01-05 op (zerop (vc-got--call "integrate" branch))))
339 db89d6fd 2021-08-16 op (defun vc-got--update (branch &optional paths)
340 db89d6fd 2021-08-16 op "Update to a different commit or BRANCH.
341 db89d6fd 2021-08-16 op Optionally restrict the update operation to files at or within
342 db89d6fd 2021-08-16 op the specified PATHS."
343 db89d6fd 2021-08-16 op (with-temp-buffer
344 db89d6fd 2021-08-16 op (unless (zerop (vc-got--call "update" "-b" branch "--" paths))
345 db89d6fd 2021-08-16 op (error "[vc-got] can't update to branch %s: %s"
347 db89d6fd 2021-08-16 op (buffer-string)))))
349 1d573c91 2021-08-17 op (defun vc-got--diff (&rest files)
350 1d573c91 2021-08-17 op "Call got diff against FILES.
351 1d573c91 2021-08-17 op The result will be stored in the current buffer."
352 76d978fa 2021-01-05 op (let (process-file-side-effects)
353 76d978fa 2021-01-05 op (zerop (vc-got--call "diff"
354 76d978fa 2021-01-05 op (vc-switches 'got 'diff)
356 1d573c91 2021-08-17 op (mapcar #'file-relative-name files)))))
358 6b6c8a78 2021-01-04 op (defun vc-got--unstage (file-or-directory)
359 6b6c8a78 2021-01-04 op "Unstage all the staged hunks at or within FILE-OR-DIRECTORY.
360 6b6c8a78 2021-01-04 op If it's nil, unstage every staged changes across the entire work
362 c3185bf7 2021-08-11 op (zerop (vc-got--call "unstage" "--" file-or-directory)))
364 a96df0e8 2020-01-03 noreply (defun vc-got--remove (file &optional force keep-local)
365 76d978fa 2021-01-05 op "Use got to remove FILE.
366 76d978fa 2021-01-05 op If FORCE is non-nil perform the operation even if a file contains
367 76d978fa 2021-01-05 op local modification. If KEEP-LOCAL is non-nil keep the affected
368 76d978fa 2021-01-05 op files on disk."
369 a96df0e8 2020-01-03 noreply (vc-got-with-worktree (or file default-directory)
370 a96df0e8 2020-01-03 noreply (with-temp-buffer
371 76d978fa 2021-01-05 op (zerop (vc-got--call "remove"
372 3efc7598 2021-09-09 op (and force "-f")
373 3efc7598 2021-09-09 op (and keep-local "-k")
377 5fb2f474 2021-08-10 op (defun vc-got--ref ()
378 5fb2f474 2021-08-10 op "Return a list of all references."
379 3efc7598 2021-09-09 op (let ((process-file-side-effects nil)
380 5fb2f474 2021-08-10 op (re "^refs/\\(heads\\|remotes\\|tags\\)/\\(.*\\):")
381 5fb2f474 2021-08-10 op ;; hardcoding HEAD because it's always present and the regexp
382 5fb2f474 2021-08-10 op ;; won't match it.
383 5fb2f474 2021-08-10 op (table (list "HEAD")))
384 5fb2f474 2021-08-10 op (vc-got-with-worktree default-directory
385 5fb2f474 2021-08-10 op (with-temp-buffer
386 5fb2f474 2021-08-10 op (when (zerop (vc-got--call "ref" "-l"))
387 5fb2f474 2021-08-10 op (goto-char (point-min))
388 5fb2f474 2021-08-10 op (while (re-search-forward re nil t)
389 5fb2f474 2021-08-10 op (push (match-string 2) table))
392 8014bde1 2021-08-10 op (defun vc-got--branch (name)
393 8014bde1 2021-08-10 op "Try to create and switch to the branch called NAME."
394 8014bde1 2021-08-10 op (let (process-file-side-effects)
395 8014bde1 2021-08-10 op (vc-got-with-worktree default-directory
396 8014bde1 2021-08-10 op (with-temp-buffer
397 c3185bf7 2021-08-11 op (if (zerop (vc-got--call "branch" "--" name))
399 8014bde1 2021-08-10 op (error "[vc-got] can't create branch %s: %s" name
400 8014bde1 2021-08-10 op (buffer-string)))))))
403 af5ef7cd 2020-11-29 op ;; Backend properties
405 af5ef7cd 2020-11-29 op (defun vc-got-revision-granularity ()
406 af5ef7cd 2020-11-29 op "Got has REPOSITORY granularity."
409 af5ef7cd 2020-11-29 op (defun vc-got-update-on-retrieve-tag ()
410 84beb0d4 2021-08-17 op "Like vc-git, vc-got don't need to buffers on `retrieve-tag'."
414 af5ef7cd 2020-11-29 op ;; State-querying functions
416 af5ef7cd 2020-11-29 op ;;;###autoload (defun vc-got-registered (file)
417 af5ef7cd 2020-11-29 op ;;;###autoload "Return non-nil if FILE is registered with got."
418 af5ef7cd 2020-11-29 op ;;;###autoload (when (vc-find-root file ".got")
419 af5ef7cd 2020-11-29 op ;;;###autoload (load "vc-got" nil t)
420 af5ef7cd 2020-11-29 op ;;;###autoload (vc-got-registered file)))
422 af5ef7cd 2020-11-29 op (defun vc-got-registered (file)
423 af5ef7cd 2020-11-29 op "Return non-nil if FILE is registered with got."
424 af5ef7cd 2020-11-29 op (if (file-directory-p file)
425 76d978fa 2021-01-05 op nil ; got doesn't track directories
426 4093d2f9 2020-12-04 op (when (vc-find-root file ".got")
427 668dc8eb 2021-01-04 op (let ((s (vc-got-state file)))
428 668dc8eb 2021-01-04 op (not (or (eq s 'unregistered)
429 668dc8eb 2021-01-04 op (null s)))))))
431 af5ef7cd 2020-11-29 op (defun vc-got-state (file)
432 af5ef7cd 2020-11-29 op "Return the current version control state of FILE. See `vc-state'."
433 af5ef7cd 2020-11-29 op (unless (file-directory-p file)
434 76d978fa 2021-01-05 op (let (process-file-side-effects)
435 76d978fa 2021-01-05 op ;; Manually calling got status and checking the result inline to
436 76d978fa 2021-01-05 op ;; avoid building the data structure in vc-got--status.
437 76d978fa 2021-01-05 op (with-temp-buffer
438 c3185bf7 2021-08-11 op (when (zerop (vc-got--call "status" "--" file))
439 76d978fa 2021-01-05 op (goto-char (point-min))
442 76d978fa 2021-01-05 op (vc-got--parse-status-char (char-after))))))))
444 dcb5b83a 2021-01-08 op (defun vc-got--dir-filter-files (files)
445 dcb5b83a 2021-01-08 op "Remove ., .. and .got from FILES."
446 dcb5b83a 2021-01-08 op (cl-loop for file in files
447 dcb5b83a 2021-01-08 op unless (or (string= file "..")
448 dcb5b83a 2021-01-08 op (string= file ".")
449 dcb5b83a 2021-01-08 op (string= file ".got"))
450 dcb5b83a 2021-01-08 op collect file))
452 af5ef7cd 2020-11-29 op (defun vc-got-dir-status-files (dir files update-function)
453 5b4a6b90 2021-01-04 op "Build the status for FILES in DIR.
454 76d978fa 2021-01-05 op The builded result is given to the callback UPDATE-FUNCTION. If
455 5b4a6b90 2021-01-04 op FILES is nil, consider all the files in DIR."
456 dcb5b83a 2021-01-08 op (let* ((fs (vc-got--dir-filter-files (or files (directory-files dir))))
457 d346ca63 2021-01-08 op ;; XXX: we call with files, wich will probably be nil on the
458 d346ca63 2021-01-08 op ;; first run, so we catch deleted, missing and edited files
459 d346ca63 2021-01-08 op ;; in subdirectories.
460 d346ca63 2021-01-08 op (res (vc-got--status nil dir files))
461 d346ca63 2021-01-08 op double-check)
462 82289421 2020-01-02 op (cl-loop for file in fs
463 76d978fa 2021-01-05 op do (when (and (not (cdr (assoc file res #'string=)))
464 76d978fa 2021-01-05 op (not (file-directory-p file))
465 76d978fa 2021-01-05 op ;; if file doesn't exists, it's a
466 76d978fa 2021-01-05 op ;; untracked file that was removed.
467 76d978fa 2021-01-05 op (file-exists-p file))
468 d346ca63 2021-01-08 op ;; if we don't know the status of a file here, it's
469 d346ca63 2021-01-08 op ;; either up-to-date or ignored. Save it for a
470 d346ca63 2021-01-08 op ;; double check
471 d346ca63 2021-01-08 op (push file double-check)))
472 cb973832 2021-01-08 op (cl-loop with statuses = (vc-got--status nil dir double-check)
473 cb973832 2021-01-08 op for file in double-check
474 cb973832 2021-01-08 op unless (eq 'unregistered (cadr (assoc file statuses #'string=)))
475 d346ca63 2021-01-08 op do (push (list file 'up-to-date nil) res))
476 d346ca63 2021-01-08 op (funcall update-function res nil)))
478 c27df03e 2020-01-03 op (defun vc-got-dir-extra-headers (dir)
479 c27df03e 2020-01-03 op "Return a string for the `vc-dir' buffer heading for directory DIR."
480 76d978fa 2021-01-05 op (let ((remote (vc-got-repository-url dir)))
481 76d978fa 2021-01-05 op (concat (propertize "Repository : " 'face 'font-lock-type-face)
482 76d978fa 2021-01-05 op (vc-got--repo-root) "\n"
485 76d978fa 2021-01-05 op (propertize "Remote URL : " 'face 'font-lock-type-face)
486 76d978fa 2021-01-05 op (vc-got-repository-url dir) "\n"))
487 76d978fa 2021-01-05 op (propertize "Branch : " 'face 'font-lock-type-face)
488 76d978fa 2021-01-05 op (vc-got--current-branch))))
490 2d83de2e 2021-01-05 op (defun vc-got-dir-printer (info)
491 2d83de2e 2021-01-05 op "Pretty-printer for the vc-dir-fileinfo structure INFO."
492 2d83de2e 2021-01-05 op (let* ((isdir (vc-dir-fileinfo->directory info))
493 76d978fa 2021-01-05 op (state (if isdir "" (vc-dir-fileinfo->state info)))
494 76d978fa 2021-01-05 op (stage-state (vc-dir-fileinfo->extra info))
495 76d978fa 2021-01-05 op (filename (vc-dir-fileinfo->name info)))
499 2d83de2e 2021-01-05 op (format "%c" (if (vc-dir-fileinfo->marked info) ?* ? ))
500 2d83de2e 2021-01-05 op 'face 'font-lock-type-face)
503 1b2afa91 2021-08-17 op (format "%-12s" state)
504 2d83de2e 2021-01-05 op 'face (cond ((eq state 'up-to-date) 'font-lock-builtin-face)
505 76d978fa 2021-01-05 op ((memq state '(missing conflict)) 'font-lock-warning-face)
506 76d978fa 2021-01-05 op ((eq state 'edited) 'font-lock-constant-face)
507 76d978fa 2021-01-05 op (t 'font-lock-variable-name-face))
508 1b2afa91 2021-08-17 op 'mouse-face 'highlight
509 95a78ecb 2021-08-31 op 'keymap (vc-got--with-emacs-version<= "28.0.50"
510 95a78ecb 2021-08-31 op vc-dir-status-mouse-map))
512 1b2afa91 2021-08-17 op " " (propertize
513 1b2afa91 2021-08-17 op (if stage-state
514 1b2afa91 2021-08-17 op (format "%c" stage-state)
516 1b2afa91 2021-08-17 op 'face (cond ((memq stage-state '(?A ?E)) 'font-lock-constant-face)
517 1b2afa91 2021-08-17 op ((eq stage-state ?R) 'font-lock-warning-face)
518 1b2afa91 2021-08-17 op (t 'font-lock-variable-name-face)))
520 1b2afa91 2021-08-17 op (propertize filename
521 1b2afa91 2021-08-17 op 'face (if isdir 'font-lock-comment-delimiter-face
522 1b2afa91 2021-08-17 op 'font-lock-function-name-face)
526 3ec8a8b4 2021-08-17 op "Directory\n"
527 3ec8a8b4 2021-08-17 op "VC operations can be applied to it\n"
528 3ec8a8b4 2021-08-17 op "mouse-3: Pop-up menu")
529 1b2afa91 2021-08-17 op "File\nmouse-3: Pop-up menu")
530 1b2afa91 2021-08-17 op 'mouse-face 'highlight
531 1b2afa91 2021-08-17 op 'keymap vc-dir-filename-mouse-map))))
533 af5ef7cd 2020-11-29 op (defun vc-got-working-revision (file)
534 3ec8a8b4 2021-08-17 op "Return the last commit that touched FILE or \"0\" if it's newly added."
536 af5ef7cd 2020-11-29 op (with-temp-buffer
537 518ede14 2020-12-05 op (when (vc-got--log file 1)
539 af5ef7cd 2020-11-29 op (goto-char (point-min))
540 76d978fa 2021-01-05 op (forward-word) ; skip "commit"
541 76d978fa 2021-01-05 op (forward-char) ; skip the space
542 76d978fa 2021-01-05 op (setq start (point)) ; store start of the SHA
543 76d978fa 2021-01-05 op (forward-word) ; goto SHA end
544 af5ef7cd 2020-11-29 op (buffer-substring start (point)))))
545 af5ef7cd 2020-11-29 op ;; special case: if this file is added but has no previous commits
546 af5ef7cd 2020-11-29 op ;; touching it, got log will fail (as expected), but we have to
547 af5ef7cd 2020-11-29 op ;; return "0".
548 af5ef7cd 2020-11-29 op (when (eq (vc-got-state file) 'added)
551 af5ef7cd 2020-11-29 op (defun vc-got-checkout-model (_files)
552 01bf4e07 2021-08-17 op "Return the checkout model.
553 01bf4e07 2021-08-17 op Got uses an implicit checkout model for every file."
556 694534b4 2020-12-05 op (defun vc-got-mode-line-string (file)
557 694534b4 2020-12-05 op "Return the VC mode line string for FILE."
558 694534b4 2020-12-05 op (vc-got-with-worktree file
559 694534b4 2020-12-05 op (let ((def (vc-default-mode-line-string 'Got file)))
560 694534b4 2020-12-05 op (concat (substring def 0 4) (vc-got--current-branch)))))
563 23a0b465 2020-11-30 op ;; state-changing functions
565 23a0b465 2020-11-30 op (defun vc-got-create-repo (_backend)
566 7726b6c9 2021-08-10 op "Create an empty repository in the current directory."
567 7726b6c9 2021-08-10 op (error "[vc-got] create-repo not implemented"))
569 23a0b465 2020-11-30 op (defun vc-got-register (files &optional _comment)
570 23a0b465 2020-11-30 op "Register FILES, passing `vc-register-switches' to the backend command."
571 23a0b465 2020-11-30 op (vc-got--add files))
573 9e805da8 2020-11-30 op (defalias 'vc-got-responsible-p #'vc-got-root)
575 241a3b12 2021-08-11 op (defun vc-got-unregister (file)
576 241a3b12 2021-08-11 op "Unregister FILE."
577 9114bbc3 2021-08-11 op (vc-got--remove file t t))
579 23a0b465 2020-11-30 op (defun vc-got-checkin (files comment &optional _rev)
580 23a0b465 2020-11-30 op "Commit FILES with COMMENT as commit message."
581 23a0b465 2020-11-30 op (with-temp-buffer
582 ad36649b 2021-02-25 op (unless (zerop (vc-got--call "commit" "-m"
583 e7747ce0 2021-08-11 op (log-edit-extract-headers nil comment)
586 26362bf0 2021-08-11 op (error "[vc-got] can't commit: %s" (buffer-string)))))
588 23a0b465 2020-11-30 op (defun vc-got-find-revision (file rev buffer)
589 c0c9a339 2020-12-04 op "Fill BUFFER with the content of FILE in the given revision REV."
590 961d35b5 2021-09-09 op (with-current-buffer buffer
591 961d35b5 2021-09-09 op (vc-got-with-worktree file
592 961d35b5 2021-09-09 op (vc-got--cat rev (file-relative-name file)))))
594 eb85ad27 2020-12-05 op (defun vc-got-checkout (_file &optional _rev)
595 76d978fa 2021-01-05 op "Checkout revision REV of FILE.
596 76d978fa 2021-01-05 op If REV is t, checkout from the head."
597 7726b6c9 2021-08-10 op (error "[vc-got] checkout not implemented"))
599 eb85ad27 2020-12-05 op (defun vc-got-revert (file &optional _content-done)
600 eb85ad27 2020-12-05 op "Revert FILE back to working revision."
601 eb85ad27 2020-12-05 op (vc-got--revert file))
603 eb85ad27 2020-12-05 op (defun vc-got-merge-branch ()
604 eb85ad27 2020-12-05 op "Prompt for a branch and integrate it into the current one."
605 eb85ad27 2020-12-05 op ;; XXX: be smart and try to "got rebase" if "got integrate" fails?
606 eb85ad27 2020-12-05 op (let* ((branches (cl-loop for (branch . commit) in (vc-got--list-branches)
607 eb85ad27 2020-12-05 op collect branch))
608 eb85ad27 2020-12-05 op (branch (completing-read "Merge from branch: " branches)))
610 eb85ad27 2020-12-05 op (vc-got--integrate branch))))
612 74b00009 2021-08-31 op (defun vc-got--proc-filter (proc s)
613 74b00009 2021-08-31 op "Custom output filter for async process PROC.
614 74b00009 2021-08-31 op It's like `vc-process-filter' but supports \r inside S."
615 74b00009 2021-08-31 op (let ((buffer (process-buffer proc)))
616 74b00009 2021-08-31 op (when (buffer-live-p buffer)
617 74b00009 2021-08-31 op (with-current-buffer buffer
618 74b00009 2021-08-31 op (save-excursion
619 74b00009 2021-08-31 op (let ((buffer-undo-list t)
620 74b00009 2021-08-31 op (inhibit-read-only t))
621 74b00009 2021-08-31 op (goto-char (process-mark proc))
622 74b00009 2021-08-31 op (if (not (string-match ".*\r\\(.*\\)" s))
625 74b00009 2021-08-31 op (end-of-line)
626 74b00009 2021-08-31 op (let ((end (point)))
627 74b00009 2021-08-31 op (beginning-of-line)
628 74b00009 2021-08-31 op (delete-region (point) end))
629 74b00009 2021-08-31 op (insert (match-string 1 s)))
630 74b00009 2021-08-31 op (set-marker (process-mark proc) (point))))))))
632 dec54a74 2021-02-21 op (defun vc-got--push-pull (cmd op prompt)
633 dec54a74 2021-02-21 op "Execute CMD OP, or prompt the user if PROMPT is non-nil."
634 dec54a74 2021-02-21 op (let ((buffer (format "*vc-got : %s*" (expand-file-name default-directory))))
635 686eac9a 2020-12-07 op (when-let (cmd (if prompt
636 686eac9a 2020-12-07 op (split-string
637 686eac9a 2020-12-07 op (read-shell-command (format "%s %s command: " cmd op)
638 1870c8bd 2021-03-27 op (format "%s %s " cmd op))
640 686eac9a 2020-12-07 op (list cmd op)))
641 dec54a74 2021-02-21 op (apply #'vc-do-async-command buffer default-directory cmd)
642 dec54a74 2021-02-21 op ;; this comes from vc-git.el. We're using git to push, so in
643 dec54a74 2021-02-21 op ;; part it makes sense, but we should revisit for full Got
645 dec54a74 2021-02-21 op (with-current-buffer buffer
646 74b00009 2021-08-31 op (vc-compilation-mode 'got)
647 74b00009 2021-08-31 op (let ((comp-cmd (mapconcat #'identity cmd " "))
648 74b00009 2021-08-31 op (proc (get-buffer-process buffer)))
649 95a78ecb 2021-08-31 op (setq-local compile-command comp-cmd)
650 95a78ecb 2021-08-31 op (setq-local compilation-directory default-directory)
651 95a78ecb 2021-08-31 op (setq-local compilation-arguments (list comp-cmd
653 dec54a74 2021-02-21 op (lambda (_ign) buffer)
655 74b00009 2021-08-31 op ;; Setup a custom process filter that handles \r.
656 74b00009 2021-08-31 op (set-process-filter proc #'vc-got--proc-filter)))
657 dec54a74 2021-02-21 op (vc-set-async-update buffer))))
659 3ec8a8b4 2021-08-17 op ;; TODO: this could be expanded. After a pull the worktree needs to
660 3ec8a8b4 2021-08-17 op ;; be updated, either with a ``got update -b branch-name'' and
661 3ec8a8b4 2021-08-17 op ;; eventually a rebase.
662 eb85ad27 2020-12-05 op (defun vc-got-pull (prompt)
663 3ec8a8b4 2021-08-17 op "Execute a pull prompting for the full command if PROMPT is not nil."
664 dec54a74 2021-02-21 op (let ((default-directory (vc-got-root default-directory)))
665 dec54a74 2021-02-21 op (vc-got--push-pull vc-got-program "fetch" prompt)))
667 686eac9a 2020-12-07 op (defun vc-got-push (prompt)
668 686eac9a 2020-12-07 op "Run git push (not got!) in the repository dir.
669 686eac9a 2020-12-07 op If PROMPT is non-nil, prompt for the git command to run."
670 dec54a74 2021-02-21 op (let ((default-directory (vc-got--repo-root)))
671 5154c5c2 2021-08-31 op (vc-got--push-pull vc-got-program "send" prompt)))
674 424f5152 2021-08-10 op ;; History functions
676 eb85ad27 2020-12-05 op (defun vc-got-print-log (files buffer &optional _shortlog start-revision limit)
677 eb85ad27 2020-12-05 op "Insert the revision log for FILES into BUFFER.
678 76d978fa 2021-01-05 op LIMIT limits the number of commits, optionally starting at
679 76d978fa 2021-01-05 op START-REVISION."
680 eb85ad27 2020-12-05 op (with-current-buffer buffer
681 eb85ad27 2020-12-05 op ;; the *vc-diff* may be read only
682 4571b1fd 2020-12-05 op (let ((inhibit-read-only t))
683 eb85ad27 2020-12-05 op (cl-loop for file in files
684 3ec8a8b4 2021-08-17 op do (vc-got--log (file-relative-name file)
686 3ec8a8b4 2021-08-17 op start-revision)))))
688 9ad1eb5d 2020-12-07 op (defun vc-got-log-outgoing (buffer remote-location)
689 9ad1eb5d 2020-12-07 op "Fill BUFFER with the diff between the local worktree branch and REMOTE-LOCATION."
690 9ad1eb5d 2020-12-07 op (vc-setup-buffer buffer)
691 a1839dca 2021-08-17 op (let ((rl (vc-got-next-revision
693 a1839dca 2021-08-17 op (if (or (not remote-location) (string-empty-p remote-location))
694 a1839dca 2021-08-17 op (concat "origin/" (vc-got--current-branch))
695 a1839dca 2021-08-17 op remote-location)))
696 9ad1eb5d 2020-12-07 op (inhibit-read-only t))
697 9ad1eb5d 2020-12-07 op (with-current-buffer buffer
698 9ad1eb5d 2020-12-07 op (vc-got--log nil nil nil rl))))
700 6eda2f1f 2020-12-26 op (defun vc-got-incoming (buffer remote-location)
701 6eda2f1f 2020-12-26 op "Fill BUFFER with the diff between the REMOTE-LOCATION and the local worktree branch."
702 6eda2f1f 2020-12-26 op (let ((rl (if (or (not remote-location) (string-empty-p remote-location))
703 6eda2f1f 2020-12-26 op (concat "origin/" (vc-got--current-branch))
704 6eda2f1f 2020-12-26 op remote-location))
705 6eda2f1f 2020-12-26 op (inhibit-read-only t))
706 6eda2f1f 2020-12-26 op (with-current-buffer buffer
707 6eda2f1f 2020-12-26 op (vc-got--log nil nil (vc-got--current-branch) rl))))
709 eb85ad27 2020-12-05 op (defun vc-got-log-search (buffer pattern)
710 eb85ad27 2020-12-05 op "Search commits for PATTERN and write the results found in BUFFER."
711 eb85ad27 2020-12-05 op (with-current-buffer buffer
712 eb85ad27 2020-12-05 op (let ((inhibit-read-only t))
713 9ad1eb5d 2020-12-07 op (vc-got--log nil nil nil nil pattern))))
715 0a3316a6 2021-02-22 op (define-derived-mode vc-got-log-view-mode log-view-mode "Got-Log-View"
716 0a3316a6 2021-02-22 op "Got-specific log-view mode.
717 0a3316a6 2021-02-22 op Heavily inspired by `vc-git-log-view-mode'."
718 0a3316a6 2021-02-22 op (require 'add-log)
719 95a78ecb 2021-08-31 op (setq-local log-view-file-re regexp-unmatchable)
720 95a78ecb 2021-08-31 op (setq-local log-view-per-file-logs nil)
721 95a78ecb 2021-08-31 op (setq-local log-view-message-re "^commit +\\([0-9a-z]+\\)")
722 95a78ecb 2021-08-31 op (setq-local log-view-font-lock-keywords
724 95a78ecb 2021-08-31 op `((,log-view-message-re (1 'change-log-acknowledgment)))
725 95a78ecb 2021-08-31 op ;; Handle the case:
726 95a78ecb 2021-08-31 op ;; user: foo@bar
727 95a78ecb 2021-08-31 op '(("^from: \\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)"
728 95a78ecb 2021-08-31 op (1 'change-log-email))
729 95a78ecb 2021-08-31 op ;; Handle the case:
730 95a78ecb 2021-08-31 op ;; user: FirstName LastName <foo@bar>
731 95a78ecb 2021-08-31 op ("^from: \\([^<(]+?\\)[ \t]*[(<]\\([A-Za-z0-9_.+-]+@[A-Za-z0-9_.-]+\\)[>)]"
732 95a78ecb 2021-08-31 op (1 'change-log-name)
733 95a78ecb 2021-08-31 op (2 'change-log-email))
734 95a78ecb 2021-08-31 op ("^date: \\(.+\\)" (1 'change-log-date))))))
736 eb85ad27 2020-12-05 op ;; TODO: async
737 f18d3e11 2020-12-05 op ;; TODO: return 0 or 1
738 eb85ad27 2020-12-05 op (defun vc-got-diff (files &optional rev1 rev2 buffer _async)
739 eb85ad27 2020-12-05 op "Insert into BUFFER (or *vc-diff*) the diff for FILES from REV1 to REV2."
740 f457868b 2020-12-07 op (let* ((buffer (get-buffer-create (or buffer "*vc-diff*")))
741 eb85ad27 2020-12-05 op (inhibit-read-only t))
742 eb85ad27 2020-12-05 op (with-current-buffer buffer
743 8ec0bb76 2021-08-11 op (vc-got-with-worktree (or (car files)
744 8ec0bb76 2021-08-11 op default-directory)
745 e9a5df05 2021-08-10 op (if (and (null rev1)
747 e9a5df05 2021-08-10 op (dolist (file files)
748 e9a5df05 2021-08-10 op (vc-got--diff file))
749 e9a5df05 2021-08-10 op ;; TODO: if rev1 is nil, diff from the current version until
752 e9a5df05 2021-08-10 op ;; TODO: if rev2 is nil as well, diff against an empty tree
753 e9a5df05 2021-08-10 op ;; (i.e. get the patch from `got log -p rev1')
755 83559c7c 2021-08-11 op ;; TODO: it would be nice to optionally include FILES here,
756 83559c7c 2021-08-11 op ;; it would make the `=' key on the *Annotate* buffer do the
757 83559c7c 2021-08-11 op ;; right thing, but AFAICS got doesn't provide something
758 83559c7c 2021-08-11 op ;; like this. Probably only hacking something with ``log
759 83559c7c 2021-08-11 op ;; -p'' and filtering?
760 e9a5df05 2021-08-10 op (vc-got--diff rev1 rev2))))))
762 5fb2f474 2021-08-10 op (defun vc-got-revision-completion-table (_files)
763 5fb2f474 2021-08-10 op "Return a completion table for existing revisions.
764 5fb2f474 2021-08-10 op Ignores FILES because GoT doesn't have the concept of ``file
765 5fb2f474 2021-08-10 op revisions''; instead, like with git, you have tags and branches."
766 5fb2f474 2021-08-10 op (letrec ((table (lazy-completion-table
767 5fb2f474 2021-08-10 op table (lambda () (vc-got--ref)))))
770 3f25d9ff 2020-01-02 noreply (defun vc-got-annotate-command (file buf &optional rev)
771 67332bad 2021-01-05 op "Show annotated contents of FILE in buffer BUF. If given, use revision REV."
772 3f25d9ff 2020-01-02 noreply (let (process-file-side-effects)
773 3f25d9ff 2020-01-02 noreply (with-current-buffer buf
774 3f25d9ff 2020-01-02 noreply ;; FIXME: vc-ensure-vc-buffer won't recognise this buffer as managed
775 3f25d9ff 2020-01-02 noreply ;; by got unless vc-parent-buffer points to a buffer managed by got.
776 3f25d9ff 2020-01-02 noreply ;; investigate why this is needed.
777 3efc7598 2021-09-09 op (setq-local vc-parent-buffer (find-file-noselect file))
778 76d978fa 2021-01-05 op (vc-got--call "blame"
779 76d978fa 2021-01-05 op (when rev (list "-c" rev))
783 3f25d9ff 2020-01-02 noreply (defconst vc-got--annotate-re
784 3f25d9ff 2020-01-02 noreply (concat "^[0-9]\\{1,\\}) " ; line number followed by )
785 3f25d9ff 2020-01-02 noreply "\\([a-z0-9]+\\) " ; SHA-1 of commit
786 3f25d9ff 2020-01-02 noreply "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\) " ; year-mm-dd
787 3f25d9ff 2020-01-02 noreply "\\([^ ]\\)+ ") ; author
788 3f25d9ff 2020-01-02 noreply "Regexp to match annotation output lines.
790 3f25d9ff 2020-01-02 noreply Provides capture groups for:
791 3f25d9ff 2020-01-02 noreply 1. revision id
792 3f25d9ff 2020-01-02 noreply 2. date of commit
793 3f25d9ff 2020-01-02 noreply 3. author of commit")
795 3f25d9ff 2020-01-02 noreply (defconst vc-got--commit-re "^commit \\([a-z0-9]+\\)"
796 3f25d9ff 2020-01-02 noreply "Regexp to match commit lines.
798 3f25d9ff 2020-01-02 noreply Provides capture group for the commit revision id.")
800 3f25d9ff 2020-01-02 noreply (defun vc-got-annotate-time ()
801 3f25d9ff 2020-01-02 noreply "Return the time of the next line of annotation at or after point.
802 3f25d9ff 2020-01-02 noreply Value is returned as floating point fractional number of days."
803 3f25d9ff 2020-01-02 noreply (save-excursion
804 3f25d9ff 2020-01-02 noreply (beginning-of-line)
805 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--annotate-re)
806 3f25d9ff 2020-01-02 noreply (let ((str (match-string-no-properties 2)))
807 3f25d9ff 2020-01-02 noreply (vc-annotate-convert-time
808 3f25d9ff 2020-01-02 noreply (encode-time 0 0 0
809 3f25d9ff 2020-01-02 noreply (string-to-number (substring str 8 10))
810 3f25d9ff 2020-01-02 noreply (string-to-number (substring str 5 7))
811 3f25d9ff 2020-01-02 noreply (string-to-number (substring str 0 4))))))))
813 3f25d9ff 2020-01-02 noreply (defun vc-got-annotate-extract-revision-at-line ()
814 67332bad 2021-01-05 op "Return revision corresponding to the current line or nil."
815 3f25d9ff 2020-01-02 noreply (save-excursion
816 3f25d9ff 2020-01-02 noreply (beginning-of-line)
817 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--annotate-re)
818 3f25d9ff 2020-01-02 noreply (match-string-no-properties 1))))
821 8014bde1 2021-08-10 op ;; Tag system
823 6ab1c7b4 2021-08-11 op (defun vc-got--tag-callback (tag)
824 6ab1c7b4 2021-08-11 op "`log-edit' callback for `vc-got-create-tag'.
825 6ab1c7b4 2021-08-11 op Creates the TAG using the content of the current buffer."
826 6ab1c7b4 2021-08-11 op (interactive)
827 6ab1c7b4 2021-08-11 op (let ((msg (buffer-substring-no-properties (point-min)
828 6ab1c7b4 2021-08-11 op (point-max))))
829 6ab1c7b4 2021-08-11 op (with-temp-buffer
830 3dcaa71b 2021-08-31 op (unless (zerop (vc-got--call "tag"
832 3dcaa71b 2021-08-31 op (log-edit-extract-headers nil msg)
835 6ab1c7b4 2021-08-11 op (error "[vc-got] can't create tag %s: %s" tag (buffer-string))))))
837 8014bde1 2021-08-10 op (defun vc-got-create-tag (_dir name branchp)
838 8014bde1 2021-08-10 op "Attach the tag NAME to the state of the worktree.
839 6ab1c7b4 2021-08-11 op DIR is ignored (tags are global, not per-file). If BRANCHP is
840 6ab1c7b4 2021-08-11 op true, NAME should create a new branch otherwise it will pop-up a
841 6ab1c7b4 2021-08-11 op `log-edit' buffer to provide the tag message."
842 8014bde1 2021-08-10 op ;; TODO: vc reccomends to ensure that all the file are in a clean
843 8014bde1 2021-08-10 op ;; state, but is it useful?
845 8014bde1 2021-08-10 op (vc-got--branch name)
846 6ab1c7b4 2021-08-11 op (let ((buf (get-buffer-create "*vc-got tag*")))
847 6ab1c7b4 2021-08-11 op (with-current-buffer buf
848 6ab1c7b4 2021-08-11 op (erase-buffer)
849 3dcaa71b 2021-08-31 op (save-excursion
850 3dcaa71b 2021-08-31 op (insert "Summary: tag " name "\n\n"))
851 3dcaa71b 2021-08-31 op (move-end-of-line 1)
852 6ab1c7b4 2021-08-11 op (switch-to-buffer buf)
853 6ab1c7b4 2021-08-11 op (log-edit (lambda ()
854 6ab1c7b4 2021-08-11 op (interactive)
855 6ab1c7b4 2021-08-11 op (unwind-protect
856 6ab1c7b4 2021-08-11 op (vc-got--tag-callback name)
857 6ab1c7b4 2021-08-11 op (kill-buffer buf))))))))
859 09d59379 2021-08-11 op (defun vc-got-retrieve-tag (dir name _update)
860 09d59379 2021-08-11 op "Switch to the tag NAME for files at or below DIR."
861 09d59379 2021-08-11 op (let ((default-directory dir))
862 db89d6fd 2021-08-16 op (vc-got--update name dir)))
865 424f5152 2021-08-10 op ;; Miscellaneous
867 2552a6c7 2021-08-11 op (defun vc-got-find-ignore-file (file)
868 2552a6c7 2021-08-11 op "Return the gitignore file that controls FILE."
869 2552a6c7 2021-08-11 op (expand-file-name ".gitignore"
870 2552a6c7 2021-08-11 op (vc-got-root file)))
872 3f25d9ff 2020-01-02 noreply (defun vc-got-previous-revision (file rev)
873 3ec8a8b4 2021-08-17 op "Return the revision number that precedes REV for FILE or nil."
874 3f25d9ff 2020-01-02 noreply (with-temp-buffer
875 3f25d9ff 2020-01-02 noreply (vc-got--log file 2 rev nil nil t)
876 3f25d9ff 2020-01-02 noreply (goto-char (point-min))
877 3f25d9ff 2020-01-02 noreply (keep-lines "^commit")
878 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--commit-re)
879 3f25d9ff 2020-01-02 noreply (match-string-no-properties 1))))
881 3f25d9ff 2020-01-02 noreply (defun vc-got-next-revision (file rev)
882 3ec8a8b4 2021-08-17 op "Return the revision number that follows REV for FILE or nil."
883 3f25d9ff 2020-01-02 noreply (with-temp-buffer
884 3f25d9ff 2020-01-02 noreply (vc-got--log file nil nil rev)
885 3f25d9ff 2020-01-02 noreply (keep-lines "^commit" (point-min) (point-max))
886 3f25d9ff 2020-01-02 noreply (goto-char (point-max))
887 76d978fa 2021-01-05 op (forward-line -1) ; return from empty line to last actual commit
888 3f25d9ff 2020-01-02 noreply (unless (= (point) (point-min))
889 3f25d9ff 2020-01-02 noreply (forward-line -1)
890 3f25d9ff 2020-01-02 noreply (when (looking-at vc-got--commit-re)
891 3f25d9ff 2020-01-02 noreply (match-string-no-properties 1)))))
893 a96df0e8 2020-01-03 noreply (defun vc-got-delete-file (file)
894 a96df0e8 2020-01-03 noreply "Delete FILE locally and mark it deleted in work tree."
895 a96df0e8 2020-01-03 noreply (vc-got--remove file t))
897 c151c257 2021-08-03 op (defun vc-got-find-file-hook ()
898 c151c257 2021-08-03 op "Activate `smerge-mode' if there is a conflict."
899 c151c257 2021-08-03 op ;; just like vc-git-find-file-hook
900 c151c257 2021-08-03 op (when (and buffer-file-name
901 c151c257 2021-08-03 op (eq (vc-state buffer-file-name 'Got) 'conflict)
902 c151c257 2021-08-03 op (save-excursion
903 c151c257 2021-08-03 op (goto-char (point-min))
904 c151c257 2021-08-03 op (re-search-forward "^<<<<<<< " nil 'noerror)))
905 c151c257 2021-08-03 op (smerge-start-session)
906 c151c257 2021-08-03 op (vc-message-unresolved-conflicts buffer-file-name)))
908 7bb16f79 2020-01-03 op (defun vc-got-conflicted-files (dir)
909 7bb16f79 2020-01-03 op "Return the list of files with conflicts in directory DIR."
910 7bb16f79 2020-01-03 op (let* ((root (vc-got-root dir))
911 7bb16f79 2020-01-03 op (default-directory root)
912 3efc7598 2021-09-09 op (process-file-side-effects nil))
913 3efc7598 2021-09-09 op (cl-loop for (file status _) in (vc-got--status "C" ".")
914 3efc7598 2021-09-09 op when (and (eq status 'conflict)
915 3efc7598 2021-09-09 op (file-in-directory-p file dir))
916 3efc7598 2021-09-09 op collect file)))
918 8b635a9f 2020-01-03 op (defun vc-got-repository-url (_file &optional remote-name)
919 8b635a9f 2020-01-03 op "Return URL for REMOTE-NAME, or for \"origin\" if nil."
920 8b635a9f 2020-01-03 op (let* ((default-directory (vc-got--repo-root))
921 8b635a9f 2020-01-03 op (remote-name (or remote-name "origin"))
922 8b635a9f 2020-01-03 op (heading (concat "[remote \"" remote-name "\"]"))
923 76d978fa 2021-01-05 op (conf (cond ((file-exists-p ".git/config") ".git/config")
924 76d978fa 2021-01-05 op ((file-exists-p ".git") nil)
925 76d978fa 2021-01-05 op ((file-exists-p "config") "config")))
928 6f42ede4 2021-01-05 op (with-temp-buffer
929 f8a9db56 2020-01-03 op (insert-file-contents conf)
930 f8a9db56 2020-01-03 op (goto-char (point-min))
931 f8a9db56 2020-01-03 op (when (search-forward heading nil t)
932 f8a9db56 2020-01-03 op (forward-line)
933 f8a9db56 2020-01-03 op (while (and (not found)
934 76d978fa 2021-01-05 op (looking-at ".*=") ; too broad?
935 7a5ead65 2020-01-03 op (not (= (point) (point-max))))
936 f8a9db56 2020-01-03 op (when (looking-at ".*url = \\(.*\\)")
937 7a5ead65 2020-01-03 op (setq found (match-string-no-properties 1)))
938 7a5ead65 2020-01-03 op (forward-line))
943 a1679b13 2021-09-09 op ;; Automatically register the backend and add ".got" to the exclusion
946 a1679b13 2021-09-09 op ;;;###autoload
947 a1679b13 2021-09-09 op (add-to-list 'vc-handled-backends 'Got)
949 a1679b13 2021-09-09 op ;;;###autoload
950 a1679b13 2021-09-09 op (add-to-list 'vc-directory-exclusion-list ".got")
952 af5ef7cd 2020-11-29 op (provide 'vc-got)
953 af5ef7cd 2020-11-29 op ;;; vc-got.el ends here
