Eliminate an unuted function argument.
[emacs.git] / lisp / vc / vc-bzr.el
bloba534a1ced3fe75620dd821d7c6a30c6c71c0da1b
1 ;;; vc-bzr.el --- VC backend for the bzr revision control system -*- lexical-binding: t -*-
3 ;; Copyright (C) 2006-2014 Free Software Foundation, Inc.
5 ;; Author: Dave Love <fx@gnu.org>
6 ;; Riccardo Murri <riccardo.murri@gmail.com>
7 ;; Maintainer: emacs-devel@gnu.org
8 ;; Keywords: vc tools
9 ;; Created: Sept 2006
10 ;; Package: vc
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; See <URL:http://bazaar.canonical.com/> concerning bzr.
31 ;; This library provides bzr support in VC.
33 ;; Known bugs
34 ;; ==========
36 ;; When editing a symlink and *both* the symlink and its target
37 ;; are bzr-versioned, `vc-bzr` presently runs `bzr status` on the
38 ;; symlink, thereby not detecting whether the actual contents
39 ;; (that is, the target contents) are changed.
41 ;;; Properties of the backend
43 (defun vc-bzr-revision-granularity () 'repository)
44 (defun vc-bzr-checkout-model (_files) 'implicit)
46 ;;; Code:
48 (eval-when-compile
49 (require 'cl-lib)
50 (require 'vc-dispatcher)
51 (require 'vc-dir)) ; vc-dir-at-event
53 ;; Clear up the cache to force vc-call to check again and discover
54 ;; new functions when we reload this file.
55 (put 'Bzr 'vc-functions nil)
57 (defgroup vc-bzr nil
58 "VC Bazaar (bzr) backend."
59 :version "22.2"
60 :group 'vc)
62 (defcustom vc-bzr-program "bzr"
63 "Name of the bzr command (excluding any arguments)."
64 :group 'vc-bzr
65 :type 'string)
67 (defcustom vc-bzr-diff-switches nil
68 "String or list of strings specifying switches for bzr diff under VC.
69 If nil, use the value of `vc-diff-switches'. If t, use no switches."
70 :type '(choice (const :tag "Unspecified" nil)
71 (const :tag "None" t)
72 (string :tag "Argument String")
73 (repeat :tag "Argument List" :value ("") string))
74 :group 'vc-bzr)
76 (defcustom vc-bzr-log-switches nil
77 "String or list of strings specifying switches for bzr log under VC."
78 :type '(choice (const :tag "None" nil)
79 (string :tag "Argument String")
80 (repeat :tag "Argument List" :value ("") string))
81 :group 'vc-bzr)
83 (defcustom vc-bzr-status-switches
84 (ignore-errors
85 (with-temp-buffer
86 (call-process vc-bzr-program nil t nil "help" "status")
87 (if (search-backward "--no-classify" nil t)
88 "--no-classify")))
89 "String or list of strings specifying switches for bzr status under VC.
90 The option \"--no-classify\" should be present if your bzr supports it."
91 :type '(choice (const :tag "None" nil)
92 (string :tag "Argument String")
93 (repeat :tag "Argument List" :value ("") string))
94 :group 'vc-bzr
95 :version "24.1")
97 ;; since v0.9, bzr supports removing the progress indicators
98 ;; by setting environment variable BZR_PROGRESS_BAR to "none".
99 (defun vc-bzr-command (bzr-command buffer okstatus file-or-list &rest args)
100 "Wrapper round `vc-do-command' using `vc-bzr-program' as COMMAND.
101 Invoke the bzr command adding `BZR_PROGRESS_BAR=none' and
102 `LC_MESSAGES=C' to the environment. If BZR-COMMAND is \"status\",
103 prepends `vc-bzr-status-switches' to ARGS."
104 (let ((process-environment
105 `("BZR_PROGRESS_BAR=none" ; Suppress progress output (bzr >=0.9)
106 "LC_MESSAGES=C" ; Force English output
107 ,@process-environment)))
108 (apply 'vc-do-command (or buffer "*vc*") okstatus vc-bzr-program
109 file-or-list bzr-command
110 (if (and (string-equal "status" bzr-command)
111 vc-bzr-status-switches)
112 (append (if (stringp vc-bzr-status-switches)
113 (list vc-bzr-status-switches)
114 vc-bzr-status-switches)
115 args)
116 args))))
118 (defun vc-bzr-async-command (bzr-command &rest args)
119 "Wrapper round `vc-do-async-command' using `vc-bzr-program' as COMMAND.
120 Invoke the bzr command adding `BZR_PROGRESS_BAR=none' and
121 `LC_MESSAGES=C' to the environment.
122 Use the current Bzr root directory as the ROOT argument to
123 `vc-do-async-command', and specify an output buffer named
124 \"*vc-bzr : ROOT*\". Return this buffer."
125 (let* ((process-environment
126 `("BZR_PROGRESS_BAR=none" "LC_MESSAGES=C"
127 ,@process-environment))
128 (root (vc-bzr-root default-directory))
129 (buffer (format "*vc-bzr : %s*" (expand-file-name root))))
130 (apply 'vc-do-async-command buffer root
131 vc-bzr-program bzr-command args)
132 buffer))
134 ;;;###autoload
135 (defconst vc-bzr-admin-dirname ".bzr"
136 "Name of the directory containing Bzr repository status files.")
137 ;; Used in the autoloaded vc-bzr-registered; see below.
138 ;;;###autoload
139 (defconst vc-bzr-admin-checkout-format-file
140 (concat vc-bzr-admin-dirname "/checkout/format")
141 "Name of the format file in a .bzr directory.")
142 (defconst vc-bzr-admin-dirstate
143 (concat vc-bzr-admin-dirname "/checkout/dirstate"))
144 (defconst vc-bzr-admin-branch-format-file
145 (concat vc-bzr-admin-dirname "/branch/format"))
146 (defconst vc-bzr-admin-revhistory
147 (concat vc-bzr-admin-dirname "/branch/revision-history"))
148 (defconst vc-bzr-admin-lastrev
149 (concat vc-bzr-admin-dirname "/branch/last-revision"))
150 (defconst vc-bzr-admin-branchconf
151 (concat vc-bzr-admin-dirname "/branch/branch.conf"))
153 (defun vc-bzr-root (file)
154 "Return the root directory of the bzr repository containing FILE."
155 ;; Cache technique copied from vc-arch.el.
156 (or (vc-file-getprop file 'bzr-root)
157 (let ((root (vc-find-root file vc-bzr-admin-checkout-format-file)))
158 (when root (vc-file-setprop file 'bzr-root root)))))
160 (defun vc-bzr-branch-conf (file)
161 "Return the Bazaar branch settings for file FILE, as an alist.
162 Each element of the returned alist has the form (NAME . VALUE),
163 which are the name and value of a Bazaar setting, as strings.
165 The settings are read from the file \".bzr/branch/branch.conf\"
166 in the repository root directory of FILE."
167 (let (settings)
168 (with-temp-buffer
169 (insert-file-contents
170 (expand-file-name vc-bzr-admin-branchconf (vc-bzr-root file)))
171 (while (re-search-forward "^\\([^#=][^=]*?\\) *= *\\(.*\\)$" nil t)
172 (push (cons (match-string 1) (match-string 2)) settings)))
173 settings))
175 (defun vc-bzr-sha1 (file)
176 (with-temp-buffer
177 (set-buffer-multibyte nil)
178 (insert-file-contents-literally file)
179 (sha1 (current-buffer))))
181 (defun vc-bzr-state-heuristic (file)
182 "Like `vc-bzr-state' but hopefully without running Bzr."
183 ;; `bzr status' could be slow with large histories and pending merges,
184 ;; so this tries to avoid calling it if possible. bzr status is
185 ;; faster now, so this is not as important as it was.
187 ;; This function tries first to parse Bzr internal file
188 ;; `checkout/dirstate', but it may fail if Bzr internal file format
189 ;; has changed. As a safeguard, the `checkout/dirstate' file is
190 ;; only parsed if it contains the string `#bazaar dirstate flat
191 ;; format 3' in the first line.
192 ;; If the `checkout/dirstate' file cannot be parsed, fall back to
193 ;; running `vc-bzr-state'."
195 ;; The format of the dirstate file is explained in bzrlib/dirstate.py
196 ;; in the bzr distribution. Basically:
197 ;; header-line giving the version of the file format in use.
198 ;; a few lines of stuff
199 ;; entries, one per line, with null-separated fields. Each line:
200 ;; entry_key = dirname (may be empty), basename, file-id
201 ;; current = common ( = kind, fingerprint, size, executable )
202 ;; + working ( = packed_stat )
203 ;; parent = common ( as above ) + history ( = rev_id )
204 ;; kinds = (r)elocated, (a)bsent, (d)irectory, (f)ile, (l)ink
205 (let* ((root (vc-bzr-root file))
206 (dirstate (expand-file-name vc-bzr-admin-dirstate root)))
207 (when root ; Short cut.
208 (condition-case err
209 (with-temp-buffer
210 (insert-file-contents dirstate)
211 (goto-char (point-min))
212 (if (not (looking-at "#bazaar dirstate flat format 3"))
213 (vc-bzr-state file) ; Some other unknown format?
214 (let* ((relfile (file-relative-name file root))
215 (reldir (file-name-directory relfile)))
216 (cond
217 ((not
218 (re-search-forward
219 (concat "^\0"
220 (if reldir (regexp-quote
221 (directory-file-name reldir)))
222 "\0"
223 (regexp-quote (file-name-nondirectory relfile))
224 "\0"
225 "[^\0]*\0" ;id?
226 "\\([^\0]*\\)\0" ;"a/f/d", a=removed?
227 "\\([^\0]*\\)\0" ;sha1 (empty if conflicted)?
228 "\\([^\0]*\\)\0" ;size?p
229 ;; y/n. Whether or not the current copy
230 ;; was executable the last time bzr checked?
231 "[^\0]*\0"
232 "[^\0]*\0" ;?
233 ;; Parent information. Absent in a new repo.
234 "\\(?:\\([^\0]*\\)\0" ;"a/f/d" a=added?
235 "\\([^\0]*\\)\0" ;sha1 again?
236 "\\([^\0]*\\)\0" ;size again?
237 ;; y/n. Whether or not the repo thinks
238 ;; the file should be executable?
239 "\\([^\0]*\\)\0"
240 "[^\0]*\0\\)?" ;last revid?
241 ;; There are more fields when merges are pending.
243 nil t))
244 'unregistered)
245 ;; Apparently the second sha1 is the one we want: when
246 ;; there's a conflict, the first sha1 is absent (and the
247 ;; first size seems to correspond to the file with
248 ;; conflict markers).
249 ((eq (char-after (match-beginning 1)) ?a) 'removed)
250 ;; If there is no parent, this must be a new repo.
251 ;; If file is in dirstate, can only be added (b#8025).
252 ((or (not (match-beginning 4))
253 (eq (char-after (match-beginning 4)) ?a)) 'added)
254 ((or (and (eq (string-to-number (match-string 3))
255 (nth 7 (file-attributes file)))
256 (equal (match-string 5)
257 (save-match-data (vc-bzr-sha1 file)))
258 ;; For a file, does the executable state match?
259 ;; (Bug#7544)
260 (or (not
261 (eq (char-after (match-beginning 1)) ?f))
262 (let ((exe
263 (memq
265 (mapcar
266 'identity
267 (nth 8 (file-attributes file))))))
268 (if (eq (char-after (match-beginning 7))
271 (not exe)))))
272 (and
273 ;; It looks like for lightweight
274 ;; checkouts \2 is empty and we need to
275 ;; look for size in \6.
276 (eq (match-beginning 2) (match-end 2))
277 (eq (string-to-number (match-string 6))
278 (nth 7 (file-attributes file)))
279 (equal (match-string 5)
280 (vc-bzr-sha1 file))))
281 'up-to-date)
282 (t 'edited)))))
283 ;; The dirstate file can't be read, or some other problem.
284 (error
285 (message "Falling back on \"slow\" status detection (%S)" err)
286 (vc-bzr-state file))))))
288 ;; This is a cheap approximation that is autoloaded. If it finds a
289 ;; possible match it loads this file and runs the real function.
290 ;; It requires vc-bzr-admin-checkout-format-file to be autoloaded too.
291 ;;;###autoload (defun vc-bzr-registered (file)
292 ;;;###autoload (if (vc-find-root file vc-bzr-admin-checkout-format-file)
293 ;;;###autoload (progn
294 ;;;###autoload (load "vc-bzr" nil t)
295 ;;;###autoload (vc-bzr-registered file))))
297 (defun vc-bzr-registered (file)
298 "Return non-nil if FILE is registered with bzr."
299 (let ((state (vc-bzr-state-heuristic file)))
300 (not (memq state '(nil unregistered ignored)))))
302 (defconst vc-bzr-state-words
303 "added\\|ignored\\|kind changed\\|modified\\|removed\\|renamed\\|unknown"
304 "Regexp matching file status words as reported in `bzr' output.")
306 ;; History of Bzr commands.
307 (defvar vc-bzr-history nil)
309 (defun vc-bzr-file-name-relative (filename)
310 "Return file name FILENAME stripped of the initial Bzr repository path."
311 (let* ((filename* (expand-file-name filename))
312 (rootdir (vc-bzr-root filename*)))
313 (when rootdir
314 (file-relative-name filename* rootdir))))
316 (defvar vc-bzr-error-regexp-alist
317 '(("^\\( M[* ]\\|+N \\|-D \\|\\| \\*\\|R[M ] \\) \\(.+\\)" 2 nil nil 1)
318 ("^C \\(.+\\)" 2)
319 ("^Text conflict in \\(.+\\)" 1 nil nil 2)
320 ("^Using saved parent location: \\(.+\\)" 1 nil nil 0))
321 "Value of `compilation-error-regexp-alist' in *vc-bzr* buffers.")
323 ;; To be called via vc-pull from vc.el, which requires vc-dispatcher.
324 (declare-function vc-exec-after "vc-dispatcher" (code))
325 (declare-function vc-set-async-update "vc-dispatcher" (process-buffer))
326 (declare-function vc-compilation-mode "vc-dispatcher" (backend))
328 (defun vc-bzr-pull (prompt)
329 "Pull changes into the current Bzr branch.
330 Normally, this runs \"bzr pull\". However, if the branch is a
331 bound branch, run \"bzr update\" instead. If there is no default
332 location from which to pull or update, or if PROMPT is non-nil,
333 prompt for the Bzr command to run."
334 (let* ((vc-bzr-program vc-bzr-program)
335 (branch-conf (vc-bzr-branch-conf default-directory))
336 ;; Check whether the branch is bound.
337 (bound (assoc "bound" branch-conf))
338 (bound (and bound (equal "true" (downcase (cdr bound)))))
339 ;; If we need to do a "bzr pull", check for a parent. If it
340 ;; does not exist, bzr will need a pull location.
341 (has-parent (unless bound
342 (assoc "parent_location" branch-conf)))
343 (command (if bound "update" "pull"))
344 args)
345 ;; If necessary, prompt for the exact command.
346 (when (or prompt (not (or bound has-parent)))
347 (setq args (split-string
348 (read-shell-command
349 "Bzr pull command: "
350 (concat vc-bzr-program " " command)
351 'vc-bzr-history)
352 " " t))
353 (setq vc-bzr-program (car args)
354 command (cadr args)
355 args (cddr args)))
356 (require 'vc-dispatcher)
357 (let ((buf (apply 'vc-bzr-async-command command args)))
358 (with-current-buffer buf (vc-run-delayed (vc-compilation-mode 'bzr)))
359 (vc-set-async-update buf))))
361 (defun vc-bzr-merge-branch ()
362 "Merge another Bzr branch into the current one.
363 Prompt for the Bzr command to run, providing a pre-defined merge
364 source (an upstream branch or a previous merge source) as a
365 default if it is available."
366 (let* ((branch-conf (vc-bzr-branch-conf default-directory))
367 ;; "bzr merge" without an argument defaults to submit_branch,
368 ;; then parent_location. Extract the specific location and
369 ;; add it explicitly to the command line.
370 (setting nil)
371 (location
372 (cond
373 ((setq setting (assoc "submit_branch" branch-conf))
374 (cdr setting))
375 ((setq setting (assoc "parent_location" branch-conf))
376 (cdr setting))))
377 (cmd
378 (split-string
379 (read-shell-command
380 "Bzr merge command: "
381 (concat vc-bzr-program " merge --pull"
382 (if location (concat " " location) ""))
383 'vc-bzr-history)
384 " " t))
385 (vc-bzr-program (car cmd))
386 (command (cadr cmd))
387 (args (cddr cmd)))
388 (let ((buf (apply 'vc-bzr-async-command command args)))
389 (with-current-buffer buf (vc-run-delayed (vc-compilation-mode 'bzr)))
390 (vc-set-async-update buf))))
392 (defun vc-bzr-status (file)
393 "Return FILE status according to Bzr.
394 Return value is a cons (STATUS . WARNING), where WARNING is a
395 string or nil, and STATUS is one of the symbols: `added',
396 `ignored', `kindchanged', `modified', `removed', `renamed', `unknown',
397 which directly correspond to `bzr status' output, or 'unchanged
398 for files whose copy in the working tree is identical to the one
399 in the branch repository (or whose status not be determined)."
400 ;; Doc used to also say the following, but AFAICS, it has never been true.
402 ;; ", or nil for files that are not registered with Bzr.
403 ;; If any error occurred in running `bzr status', then return nil."
405 ;; Rather than returning nil in case of an error, it returns
406 ;; (unchanged . WARNING). FIXME unchanged is not the best status to
407 ;; return in case of error.
408 (with-temp-buffer
409 ;; This is with-demoted-errors without the condition-case-unless-debug
410 ;; annoyance, which makes it fail during ert testing.
411 (condition-case err (vc-bzr-command "status" t 0 file)
412 (error (message "Error: %S" err) nil))
413 (let ((status 'unchanged))
414 ;; the only secure status indication in `bzr status' output
415 ;; is a couple of lines following the pattern::
416 ;; | <status>:
417 ;; | <file name>
418 ;; if the file is up-to-date, we get no status report from `bzr',
419 ;; so if the regexp search for the above pattern fails, we consider
420 ;; the file to be up-to-date.
421 (goto-char (point-min))
422 (when (re-search-forward
423 ;; bzr prints paths relative to the repository root.
424 (concat "^\\(" vc-bzr-state-words "\\):[ \t\n]+"
425 (regexp-quote (vc-bzr-file-name-relative file))
426 ;; Bzr appends a '/' to directory names and
427 ;; '*' to executable files
428 (if (file-directory-p file) "/?" "\\*?")
429 "[ \t\n]*$")
430 nil t)
431 (let ((statusword (match-string 1)))
432 ;; Erase the status text that matched.
433 (delete-region (match-beginning 0) (match-end 0))
434 (setq status
435 (intern (replace-regexp-in-string " " "" statusword)))))
436 (when status
437 (goto-char (point-min))
438 (skip-chars-forward " \n\t") ;Throw away spaces.
439 (cons status
440 ;; "bzr" will output warnings and informational messages to
441 ;; stderr; due to Emacs's `vc-do-command' (and, it seems,
442 ;; `start-process' itself) limitations, we cannot catch stderr
443 ;; and stdout into different buffers. So, if there's anything
444 ;; left in the buffer after removing the above status
445 ;; keywords, let us just presume that any other message from
446 ;; "bzr" is a user warning, and display it.
447 (unless (eobp) (buffer-substring (point) (point-max))))))))
449 (defun vc-bzr-state (file)
450 (let ((result (vc-bzr-status file)))
451 (when (consp result)
452 (let ((warnings (cdr result)))
453 (when warnings
454 ;; bzr 2.3.0 returns info about shelves, which is not really a warning
455 (when (string-match "[0-9]+ shel\\(f\\|ves\\) exists?\\..*?\n" warnings)
456 (setq warnings (replace-match "" nil nil warnings)))
457 (unless (string= warnings "")
458 (message "Warnings in `bzr' output: %s" warnings))))
459 (cdr (assq (car result)
460 '((added . added)
461 (kindchanged . edited)
462 (renamed . edited)
463 (modified . edited)
464 (removed . removed)
465 (ignored . ignored)
466 (unknown . unregistered)
467 (unchanged . up-to-date)))))))
469 (defun vc-bzr-resolve-when-done ()
470 "Call \"bzr resolve\" if the conflict markers have been removed."
471 (save-excursion
472 (goto-char (point-min))
473 (unless (re-search-forward "^<<<<<<< " nil t)
474 (vc-bzr-command "resolve" nil 0 buffer-file-name)
475 ;; Remove the hook so that it is not called multiple times.
476 (remove-hook 'after-save-hook 'vc-bzr-resolve-when-done t))))
478 (defun vc-bzr-find-file-hook ()
479 (when (and buffer-file-name
480 ;; FIXME: We should check that "bzr status" says "conflict".
481 (file-exists-p (concat buffer-file-name ".BASE"))
482 (file-exists-p (concat buffer-file-name ".OTHER"))
483 (file-exists-p (concat buffer-file-name ".THIS"))
484 ;; If "bzr status" says there's a conflict but there are no
485 ;; conflict markers, it's not clear what we should do.
486 (save-excursion
487 (goto-char (point-min))
488 (re-search-forward "^<<<<<<< " nil t)))
489 ;; TODO: the merge algorithm used in `bzr merge' is nicely configurable,
490 ;; but the one in `bzr pull' isn't, so it would be good to provide an
491 ;; elisp function to remerge from the .BASE/OTHER/THIS files.
492 (smerge-start-session)
493 (add-hook 'after-save-hook 'vc-bzr-resolve-when-done nil t)
494 (message "There are unresolved conflicts in this file")))
496 (defun vc-bzr-working-revision (file)
497 (let* ((rootdir (vc-bzr-root file))
498 (branch-format-file (expand-file-name vc-bzr-admin-branch-format-file
499 rootdir))
500 (revhistory-file (expand-file-name vc-bzr-admin-revhistory rootdir))
501 (lastrev-file (expand-file-name vc-bzr-admin-lastrev rootdir)))
502 ;; This looks at internal files to avoid forking a bzr process.
503 ;; May break if they change their format.
504 (if (and (file-exists-p branch-format-file)
505 ;; For lightweight checkouts (obtained with bzr co --lightweight)
506 ;; the branch-format-file does not contain the revision
507 ;; information, we need to look up the branch-format-file
508 ;; in the place where the lightweight checkout comes
509 ;; from. We only do that if it's a local file.
510 (let ((location-fname (expand-file-name
511 (concat vc-bzr-admin-dirname
512 "/branch/location") rootdir)))
513 ;; The existence of this file is how we distinguish
514 ;; lightweight checkouts.
515 (if (file-exists-p location-fname)
516 (with-temp-buffer
517 (insert-file-contents location-fname)
518 ;; If the lightweight checkout points to a
519 ;; location in the local file system, then we can
520 ;; look there for the version information.
521 (when (re-search-forward "file://\\(.+\\)" nil t)
522 (let ((l-c-parent-dir (match-string 1)))
523 (when (and (memq system-type '(ms-dos windows-nt))
524 (string-match-p "^/[[:alpha:]]:"
525 l-c-parent-dir))
526 ;;; The non-Windows code takes a shortcut by using
527 ;;; the host/path separator slash as the start of
528 ;;; the absolute path. That does not work on
529 ;;; Windows, so we must remove it (bug#5345)
530 (setq l-c-parent-dir (substring l-c-parent-dir 1)))
531 (setq branch-format-file
532 (expand-file-name vc-bzr-admin-branch-format-file
533 l-c-parent-dir))
534 (setq lastrev-file
535 (expand-file-name vc-bzr-admin-lastrev
536 l-c-parent-dir))
537 ;; FIXME: maybe it's overkill to check if both these
538 ;; files exist.
539 (and (file-exists-p branch-format-file)
540 (file-exists-p lastrev-file)
541 (equal (emacs-bzr-version-dirstate l-c-parent-dir)
542 (emacs-bzr-version-dirstate rootdir))))))
543 t)))
544 (with-temp-buffer
545 (insert-file-contents branch-format-file)
546 (goto-char (point-min))
547 (cond
548 ((or
549 (looking-at "Bazaar-NG branch, format 0.0.4")
550 (looking-at "Bazaar-NG branch format 5"))
551 ;; count lines in .bzr/branch/revision-history
552 (insert-file-contents revhistory-file)
553 (number-to-string (count-lines (line-end-position) (point-max))))
554 ((or
555 (looking-at "Bazaar Branch Format 6 (bzr 0.15)")
556 (looking-at "Bazaar Branch Format 7 (needs bzr 1.6)"))
557 ;; revno is the first number in .bzr/branch/last-revision
558 (insert-file-contents lastrev-file)
559 (when (re-search-forward "[0-9]+" nil t)
560 (buffer-substring (match-beginning 0) (match-end 0))))))
561 ;; Fallback to calling "bzr revno --tree".
562 ;; The "--tree" matters for lightweight checkouts not on the same
563 ;; revision as the parent.
564 (let* ((result (vc-bzr-command-discarding-stderr
565 vc-bzr-program "revno" "--tree"
566 (file-relative-name file)))
567 (exitcode (car result))
568 (output (cdr result)))
569 (cond
570 ((and (eq exitcode 0) (not (zerop (length output))))
571 (substring output 0 -1))
572 (t nil))))))
574 (defun vc-bzr-create-repo ()
575 "Create a new Bzr repository."
576 (vc-bzr-command "init" nil 0 nil))
578 (defun vc-bzr-previous-revision (_file rev)
579 (if (string-match "\\`[0-9]+\\'" rev)
580 (number-to-string (1- (string-to-number rev)))
581 (concat "before:" rev)))
583 (defun vc-bzr-next-revision (_file rev)
584 (if (string-match "\\`[0-9]+\\'" rev)
585 (number-to-string (1+ (string-to-number rev)))
586 (error "Don't know how to compute the next revision of %s" rev)))
588 (defun vc-bzr-register (files &optional _comment)
589 "Register FILES under bzr. COMMENT is ignored."
590 (vc-bzr-command "add" nil 0 files))
592 ;; Could run `bzr status' in the directory and see if it succeeds, but
593 ;; that's relatively expensive.
594 (defalias 'vc-bzr-responsible-p 'vc-bzr-root
595 "Return non-nil if FILE is (potentially) controlled by bzr.
596 The criterion is that there is a `.bzr' directory in the same
597 or a superior directory.")
599 (defun vc-bzr-unregister (file)
600 "Unregister FILE from bzr."
601 (vc-bzr-command "remove" nil 0 file "--keep"))
603 (declare-function log-edit-extract-headers "log-edit" (headers string))
605 (defun vc-bzr--sanitize-header (arg)
606 ;; Newlines in --fixes (and probably other fields as well) trigger a nasty
607 ;; Bazaar bug; see https://bugs.launchpad.net/bzr/+bug/1094180.
608 (lambda (str) (list arg
609 (replace-regexp-in-string "\\`[ \t]+\\|[ \t]+\\'"
610 "" (replace-regexp-in-string
611 "\n[ \t]?" " " str)))))
613 (defun vc-bzr-checkin (files comment)
614 "Check FILES in to bzr with log message COMMENT."
615 (apply 'vc-bzr-command "commit" nil 0 files
616 (cons "-m" (log-edit-extract-headers
617 `(("Author" . ,(vc-bzr--sanitize-header "--author"))
618 ("Date" . ,(vc-bzr--sanitize-header "--commit-time"))
619 ("Fixes" . ,(vc-bzr--sanitize-header "--fixes")))
620 comment))))
622 (defun vc-bzr-find-revision (file rev buffer)
623 "Fetch revision REV of file FILE and put it into BUFFER."
624 (with-current-buffer buffer
625 (if (and rev (stringp rev) (not (string= rev "")))
626 (vc-bzr-command "cat" t 0 file "-r" rev)
627 (vc-bzr-command "cat" t 0 file))))
629 (defun vc-bzr-find-ignore-file (file)
630 "Return the root directory of the repository of FILE."
631 (expand-file-name ".bzrignore"
632 (vc-bzr-root file)))
634 (defun vc-bzr-checkout (_file &optional rev)
635 (if rev (error "Operation not supported")
636 ;; Else, there's nothing to do.
637 nil))
639 (defun vc-bzr-revert (file &optional contents-done)
640 (unless contents-done
641 (with-temp-buffer (vc-bzr-command "revert" t 0 file "--no-backup"))))
643 (defvar log-view-message-re)
644 (defvar log-view-file-re)
645 (defvar log-view-font-lock-keywords)
646 (defvar log-view-current-tag-function)
647 (defvar log-view-per-file-logs)
648 (defvar log-view-expanded-log-entry-function)
650 (define-derived-mode vc-bzr-log-view-mode log-view-mode "Bzr-Log-View"
651 (remove-hook 'log-view-mode-hook 'vc-bzr-log-view-mode) ;Deactivate the hack.
652 (require 'add-log)
653 (set (make-local-variable 'log-view-per-file-logs) nil)
654 (set (make-local-variable 'log-view-file-re) "\\`a\\`")
655 (set (make-local-variable 'log-view-message-re)
656 (if (eq vc-log-view-type 'short)
657 "^ *\\([0-9.]+\\): \\(.*?\\)[ \t]+\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\)\\( \\[merge\\]\\)?"
658 "^ *\\(?:revno: \\([0-9.]+\\)\\|merged: .+\\)"))
659 ;; Allow expanding short log entries
660 (when (eq vc-log-view-type 'short)
661 (setq truncate-lines t)
662 (set (make-local-variable 'log-view-expanded-log-entry-function)
663 'vc-bzr-expanded-log-entry))
664 (set (make-local-variable 'log-view-font-lock-keywords)
665 ;; log-view-font-lock-keywords is careful to use the buffer-local
666 ;; value of log-view-message-re only since Emacs-23.
667 (if (eq vc-log-view-type 'short)
668 (append `((,log-view-message-re
669 (1 'log-view-message-face)
670 (2 'change-log-name)
671 (3 'change-log-date)
672 (4 'change-log-list nil lax))))
673 (append `((,log-view-message-re . 'log-view-message-face))
674 ;; log-view-font-lock-keywords
675 '(("^ *\\(?:committer\\|author\\): \
676 \\([^<(]+?\\)[ ]*[(<]\\([[:alnum:]_.+-]+@[[:alnum:]_.-]+\\)[>)]"
677 (1 'change-log-name)
678 (2 'change-log-email))
679 ("^ *timestamp: \\(.*\\)" (1 'change-log-date-face)))))))
681 (autoload 'vc-setup-buffer "vc-dispatcher")
683 (defun vc-bzr-print-log (files buffer &optional shortlog start-revision limit)
684 "Print commit log associated with FILES into specified BUFFER.
685 If SHORTLOG is non-nil, use --line format.
686 If START-REVISION is non-nil, it is the newest revision to show.
687 If LIMIT is non-nil, show no more than this many entries."
688 ;; `vc-do-command' creates the buffer, but we need it before running
689 ;; the command.
690 (vc-setup-buffer buffer)
691 ;; If the buffer exists from a previous invocation it might be
692 ;; read-only.
693 ;; FIXME: `vc-bzr-command' runs `bzr log' with `LC_MESSAGES=C', so
694 ;; the log display may not what the user wants - but I see no other
695 ;; way of getting the above regexps working.
696 (with-current-buffer buffer
697 (apply 'vc-bzr-command "log" buffer 'async files
698 (append
699 (if shortlog '("--line") '("--long"))
700 ;; The extra complications here when start-revision and limit
701 ;; are set are due to bzr log's --forward argument, which
702 ;; could be enabled via an alias in bazaar.conf.
703 ;; Svn, for example, does not have this problem, because
704 ;; it doesn't have --forward. Instead, you can use
705 ;; svn --log -r HEAD:0 or -r 0:HEAD as you prefer.
706 ;; Bzr, however, insists in -r X..Y that X come before Y.
707 (if start-revision
708 (list (format
709 (if (and limit (= limit 1))
710 ;; This means we don't have to use --no-aliases.
711 ;; Is -c any different to -r in this case?
712 "-r%s"
713 "-r..%s") start-revision)))
714 (when limit (list "-l" (format "%s" limit)))
715 ;; There is no sensible way to combine --limit and --forward,
716 ;; and it breaks the meaning of START-REVISION as the
717 ;; _newest_ revision. See bug#14168.
718 ;; Eg bzr log --forward -r ..100 --limit 50 prints
719 ;; revisions 1-50 rather than 50-100. There
720 ;; seems no way in general to get bzr to print revisions
721 ;; 50-100 in --forward order in that case.
722 ;; FIXME There may be other alias stuff we want to keep.
723 ;; Is there a way to just suppress --forward?
724 ;; As of 2013/4 the only caller uses limit = 1, so it does
725 ;; not matter much.
726 (and start-revision limit (> limit 1) '("--no-aliases"))
727 (if (stringp vc-bzr-log-switches)
728 (list vc-bzr-log-switches)
729 vc-bzr-log-switches)))))
731 (defun vc-bzr-expanded-log-entry (revision)
732 (with-temp-buffer
733 (apply 'vc-bzr-command "log" t nil nil
734 (list "--long" (format "-r%s" revision)))
735 (goto-char (point-min))
736 (when (looking-at "^-+\n")
737 ;; Indent the expanded log entry.
738 (indent-region (match-end 0) (point-max) 2)
739 (buffer-substring (match-end 0) (point-max)))))
741 (defun vc-bzr-log-incoming (buffer remote-location)
742 (apply 'vc-bzr-command "missing" buffer 'async nil
743 (list "--theirs-only" (unless (string= remote-location "") remote-location))))
745 (defun vc-bzr-log-outgoing (buffer remote-location)
746 (apply 'vc-bzr-command "missing" buffer 'async nil
747 (list "--mine-only" (unless (string= remote-location "") remote-location))))
749 (defun vc-bzr-show-log-entry (revision)
750 "Find entry for patch name REVISION in bzr change log buffer."
751 (goto-char (point-min))
752 (when revision
753 (let (case-fold-search
754 found)
755 (if (re-search-forward
756 ;; "revno:" can appear either at the beginning of a line,
757 ;; or indented.
758 (concat "^[ ]*-+\n[ ]*revno: "
759 ;; The revision can contain ".", quote it so that it
760 ;; does not interfere with regexp matching.
761 (regexp-quote revision) "$") nil t)
762 (progn
763 (beginning-of-line 0)
764 (setq found t))
765 (goto-char (point-min)))
766 found)))
768 (autoload 'vc-switches "vc")
770 (defun vc-bzr-diff (files &optional async rev1 rev2 buffer)
771 "VC bzr backend for diff."
772 (let* ((switches (vc-switches 'bzr 'diff))
773 (args
774 (append
775 ;; Only add --diff-options if there are any diff switches.
776 (unless (zerop (length switches))
777 (list "--diff-options" (mapconcat 'identity switches " ")))
778 ;; This `when' is just an optimization because bzr-1.2 is *much*
779 ;; faster when the revision argument is not given.
780 (when (or rev1 rev2)
781 (list "-r" (format "%s..%s"
782 (or rev1 "revno:-1")
783 (or rev2 "")))))))
784 ;; `bzr diff' exits with code 1 if diff is non-empty.
785 (apply #'vc-bzr-command "diff" (or buffer "*vc-diff*")
786 (if async 1 'async) files
787 args)))
790 ;; FIXME: vc-{next,previous}-revision need fixing in vc.el to deal with
791 ;; straight integer revisions.
793 (defun vc-bzr-delete-file (file)
794 "Delete FILE and delete it in the bzr repository."
795 (condition-case ()
796 (delete-file file)
797 (file-error nil))
798 (vc-bzr-command "remove" nil 0 file))
800 (defun vc-bzr-rename-file (old new)
801 "Rename file from OLD to NEW using `bzr mv'."
802 (setq old (expand-file-name old))
803 (setq new (expand-file-name new))
804 (vc-bzr-command "mv" nil 0 new old)
805 (message "Renamed %s => %s" old new))
807 (defvar vc-bzr-annotation-table nil
808 "Internal use.")
809 (make-variable-buffer-local 'vc-bzr-annotation-table)
811 (defun vc-bzr-annotate-command (file buffer &optional revision)
812 "Prepare BUFFER for `vc-annotate' on FILE.
813 Each line is tagged with the revision number, which has a `help-echo'
814 property containing author and date information."
815 (apply #'vc-bzr-command "annotate" buffer 'async file "--long" "--all"
816 (if revision (list "-r" revision)))
817 (let ((table (make-hash-table :test 'equal)))
818 (set-process-filter
819 (get-buffer-process buffer)
820 (lambda (proc string)
821 (when (process-buffer proc)
822 (with-current-buffer (process-buffer proc)
823 (setq string (concat (process-get proc :vc-left-over) string))
824 ;; Eg: 102020 Gnus developers 20101020 | regexp."
825 ;; As of bzr 2.2.2, no email address in whoami (which can
826 ;; lead to spaces in the author field) is allowed but discouraged.
827 ;; See bug#7792.
828 (while (string-match "^\\( *[0-9.]+ *\\) \\(.+?\\) +\\([0-9]\\{8\\}\\)\\( |.*\n\\)" string)
829 (let* ((rev (match-string 1 string))
830 (author (match-string 2 string))
831 (date (match-string 3 string))
832 (key (substring string (match-beginning 0)
833 (match-beginning 4)))
834 (line (match-string 4 string))
835 (tag (gethash key table))
836 (inhibit-read-only t))
837 (setq string (substring string (match-end 0)))
838 (unless tag
839 (setq tag
840 (propertize
841 (format "%s %-7.7s" rev author)
842 'help-echo (format "Revision: %d, author: %s, date: %s"
843 (string-to-number rev)
844 author date)
845 'mouse-face 'highlight))
846 (puthash key tag table))
847 (goto-char (process-mark proc))
848 (insert tag line)
849 (move-marker (process-mark proc) (point))))
850 (process-put proc :vc-left-over string)))))))
852 (declare-function vc-annotate-convert-time "vc-annotate" (time))
854 (defun vc-bzr-annotate-time ()
855 (when (re-search-forward "^ *[0-9.]+ +.+? +|" nil t)
856 (let ((prop (get-text-property (line-beginning-position) 'help-echo)))
857 (string-match "[0-9]+\\'" prop)
858 (let ((str (match-string-no-properties 0 prop)))
859 (vc-annotate-convert-time
860 (encode-time 0 0 0
861 (string-to-number (substring str 6 8))
862 (string-to-number (substring str 4 6))
863 (string-to-number (substring str 0 4))))))))
865 (defun vc-bzr-annotate-extract-revision-at-line ()
866 "Return revision for current line of annotation buffer, or nil.
867 Return nil if current line isn't annotated."
868 (save-excursion
869 (beginning-of-line)
870 (if (looking-at "^ *\\([0-9.]+\\) +.* +|")
871 (match-string-no-properties 1))))
873 (defun vc-bzr-command-discarding-stderr (command &rest args)
874 "Execute shell command COMMAND (with ARGS); return its output and exitcode.
875 Return value is a cons (EXITCODE . OUTPUT), where EXITCODE is
876 the (numerical) exit code of the process, and OUTPUT is a string
877 containing whatever the process sent to its standard output
878 stream. Standard error output is discarded."
879 (with-temp-buffer
880 (cons
881 (apply #'process-file command nil (list (current-buffer) nil) nil args)
882 (buffer-substring (point-min) (point-max)))))
884 (cl-defstruct (vc-bzr-extra-fileinfo
885 (:copier nil)
886 (:constructor vc-bzr-create-extra-fileinfo (extra-name))
887 (:conc-name vc-bzr-extra-fileinfo->))
888 extra-name) ;; original name for rename targets, new name for
890 (declare-function vc-default-dir-printer "vc-dir" (backend fileentry))
892 (defun vc-bzr-dir-printer (info)
893 "Pretty-printer for the vc-dir-fileinfo structure."
894 (let ((extra (vc-dir-fileinfo->extra info)))
895 (vc-default-dir-printer 'Bzr info)
896 (when extra
897 (insert (propertize
898 (format " (renamed from %s)"
899 (vc-bzr-extra-fileinfo->extra-name extra))
900 'face 'font-lock-comment-face)))))
902 ;; FIXME: this needs testing, it's probably incomplete.
903 (defun vc-bzr-after-dir-status (update-function relative-dir)
904 (let ((status-str nil)
905 (translation '(("+N " . added)
906 ("-D " . removed)
907 (" M " . edited) ;; file text modified
908 (" *" . edited) ;; execute bit changed
909 (" M*" . edited) ;; text modified + execute bit changed
910 ("I " . ignored)
911 (" D " . missing)
912 ;; For conflicts, should we list the .THIS/.BASE/.OTHER?
913 ("C " . conflict)
914 ("? " . unregistered)
915 ;; No such state, but we need to distinguish this case.
916 ("R " . renamed)
917 ("RM " . renamed)
918 ;; For a non existent file FOO, the output is:
919 ;; bzr: ERROR: Path(s) do not exist: FOO
920 ("bzr" . not-found)
921 ;; If the tree is not up to date, bzr will print this warning:
922 ;; working tree is out of date, run 'bzr update'
923 ;; ignore it.
924 ;; FIXME: maybe this warning can be put in the vc-dir header...
925 ("wor" . not-found)
926 ;; Ignore "P " and "P." for pending patches.
927 ("P " . not-found)
928 ("P. " . not-found)
930 (translated nil)
931 (result nil))
932 (goto-char (point-min))
933 (while (not (eobp))
934 ;; Bzr 2.3.0 added this if there are shelves. (Bug#8170)
935 (unless (looking-at "[0-9]+ shel\\(f\\|ves\\) exists?\\.")
936 (setq status-str
937 (buffer-substring-no-properties (point) (+ (point) 3)))
938 (setq translated (cdr (assoc status-str translation)))
939 (cond
940 ((eq translated 'conflict)
941 ;; For conflicts the file appears twice in the listing: once
942 ;; with the M flag and once with the C flag, so take care
943 ;; not to add it twice to `result'. Ugly.
944 (let* ((file
945 (buffer-substring-no-properties
946 ;;For files with conflicts the format is:
947 ;;C Text conflict in FILENAME
948 ;; Bah.
949 (+ (point) 21) (line-end-position)))
950 (entry (assoc file result)))
951 (when entry
952 (setf (nth 1 entry) 'conflict))))
953 ((eq translated 'renamed)
954 (re-search-forward "R[ M] \\(.*\\) => \\(.*\\)$" (line-end-position) t)
955 (let ((new-name (file-relative-name (match-string 2) relative-dir))
956 (old-name (file-relative-name (match-string 1) relative-dir)))
957 (push (list new-name 'edited
958 (vc-bzr-create-extra-fileinfo old-name)) result)))
959 ;; do nothing for non existent files
960 ((eq translated 'not-found))
962 (push (list (file-relative-name
963 (buffer-substring-no-properties
964 (+ (point) 4)
965 (line-end-position)) relative-dir)
966 translated) result))))
967 (forward-line))
968 (funcall update-function result)))
970 (defun vc-bzr-dir-status (dir update-function)
971 "Return a list of conses (file . state) for DIR."
972 (vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S")
973 (vc-run-delayed
974 (vc-bzr-after-dir-status update-function
975 ;; "bzr status" results are relative to
976 ;; the bzr root directory, NOT to the
977 ;; directory "bzr status" was invoked in.
978 ;; Ugh.
979 ;; We pass the relative directory here so
980 ;; that `vc-bzr-after-dir-status' can
981 ;; frob the results accordingly.
982 (file-relative-name dir (vc-bzr-root dir)))))
984 (defun vc-bzr-dir-status-files (dir files update-function)
985 "Return a list of conses (file . state) for DIR."
986 (apply 'vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S" files)
987 (vc-run-delayed
988 (vc-bzr-after-dir-status update-function
989 (file-relative-name dir (vc-bzr-root dir)))))
991 (defvar vc-bzr-shelve-map
992 (let ((map (make-sparse-keymap)))
993 ;; Turn off vc-dir marking
994 (define-key map [mouse-2] 'ignore)
996 (define-key map [down-mouse-3] 'vc-bzr-shelve-menu)
997 (define-key map "\C-k" 'vc-bzr-shelve-delete-at-point)
998 (define-key map "=" 'vc-bzr-shelve-show-at-point)
999 (define-key map "\C-m" 'vc-bzr-shelve-show-at-point)
1000 (define-key map "A" 'vc-bzr-shelve-apply-and-keep-at-point)
1001 (define-key map "P" 'vc-bzr-shelve-apply-at-point)
1002 (define-key map "S" 'vc-bzr-shelve-snapshot)
1003 map))
1005 (defvar vc-bzr-shelve-menu-map
1006 (let ((map (make-sparse-keymap "Bzr Shelve")))
1007 (define-key map [de]
1008 '(menu-item "Delete Shelf" vc-bzr-shelve-delete-at-point
1009 :help "Delete the current shelf"))
1010 (define-key map [ap]
1011 '(menu-item "Apply and Keep Shelf" vc-bzr-shelve-apply-and-keep-at-point
1012 :help "Apply the current shelf and keep it"))
1013 (define-key map [po]
1014 '(menu-item "Apply and Remove Shelf (Pop)" vc-bzr-shelve-apply-at-point
1015 :help "Apply the current shelf and remove it"))
1016 (define-key map [sh]
1017 '(menu-item "Show Shelve" vc-bzr-shelve-show-at-point
1018 :help "Show the contents of the current shelve"))
1019 map))
1021 (defvar vc-bzr-extra-menu-map
1022 (let ((map (make-sparse-keymap)))
1023 (define-key map [bzr-sn]
1024 '(menu-item "Shelve a Snapshot" vc-bzr-shelve-snapshot
1025 :help "Shelve the current state of the tree and keep the current state"))
1026 (define-key map [bzr-sh]
1027 '(menu-item "Shelve..." vc-bzr-shelve
1028 :help "Shelve changes"))
1029 map))
1031 (defun vc-bzr-extra-menu () vc-bzr-extra-menu-map)
1033 (defun vc-bzr-extra-status-menu () vc-bzr-extra-menu-map)
1035 (defun vc-bzr-dir-extra-headers (dir)
1036 (let*
1037 ((str (with-temp-buffer
1038 (vc-bzr-command "info" t 0 dir)
1039 (buffer-string)))
1040 (shelve (vc-bzr-shelve-list))
1041 (shelve-help-echo "Use M-x vc-bzr-shelve to create shelves")
1042 (root-dir (vc-bzr-root dir))
1043 (pending-merge
1044 ;; FIXME: looking for .bzr/checkout/merge-hashes is not a
1045 ;; reliable method to detect pending merges, disable this
1046 ;; until a proper solution is implemented.
1047 (and nil
1048 (file-exists-p
1049 (expand-file-name ".bzr/checkout/merge-hashes" root-dir))))
1050 (pending-merge-help-echo
1051 (format "A merge has been performed.\nA commit from the top-level directory (%s)\nis required before being able to check in anything else" root-dir))
1052 (light-checkout
1053 (when (string-match ".+light checkout root: \\(.+\\)$" str)
1054 (match-string 1 str)))
1055 (light-checkout-branch
1056 (when light-checkout
1057 (when (string-match ".+checkout of branch: \\(.+\\)$" str)
1058 (match-string 1 str)))))
1059 (concat
1060 (propertize "Parent branch : " 'face 'font-lock-type-face)
1061 (propertize
1062 (if (string-match "parent branch: \\(.+\\)$" str)
1063 (match-string 1 str)
1064 "None")
1065 'face 'font-lock-variable-name-face)
1066 "\n"
1067 (when light-checkout
1068 (concat
1069 (propertize "Light checkout root: " 'face 'font-lock-type-face)
1070 (propertize light-checkout 'face 'font-lock-variable-name-face)
1071 "\n"))
1072 (when light-checkout-branch
1073 (concat
1074 (propertize "Checkout of branch : " 'face 'font-lock-type-face)
1075 (propertize light-checkout-branch 'face 'font-lock-variable-name-face)
1076 "\n"))
1077 (when pending-merge
1078 (concat
1079 (propertize "Warning : " 'face 'font-lock-warning-face
1080 'help-echo pending-merge-help-echo)
1081 (propertize "Pending merges, commit recommended before any other action"
1082 'help-echo pending-merge-help-echo
1083 'face 'font-lock-warning-face)
1084 "\n"))
1085 (if shelve
1086 (concat
1087 (propertize "Shelves :\n" 'face 'font-lock-type-face
1088 'help-echo shelve-help-echo)
1089 (mapconcat
1090 (lambda (x)
1091 (propertize x
1092 'face 'font-lock-variable-name-face
1093 'mouse-face 'highlight
1094 'help-echo "mouse-3: Show shelve menu\nA: Apply and keep shelf\nP: Apply and remove shelf (pop)\nS: Snapshot to a shelf\nC-k: Delete shelf"
1095 'keymap vc-bzr-shelve-map))
1096 shelve "\n"))
1097 (concat
1098 (propertize "Shelves : " 'face 'font-lock-type-face
1099 'help-echo shelve-help-echo)
1100 (propertize "No shelved changes"
1101 'help-echo shelve-help-echo
1102 'face 'font-lock-variable-name-face))))))
1104 ;; Follows vc-bzr-command, which uses vc-do-command from vc-dispatcher.
1105 (declare-function vc-resynch-buffer "vc-dispatcher"
1106 (file &optional keep noquery reset-vc-info))
1108 (defun vc-bzr-shelve (name)
1109 "Shelve the changes of the selected files."
1110 (interactive "sShelf name: ")
1111 (let ((root (vc-bzr-root default-directory))
1112 (fileset (vc-deduce-fileset)))
1113 (when root
1114 (vc-bzr-command "shelve" nil 0 (nth 1 fileset) "--all" "-m" name)
1115 (vc-resynch-buffer root t t))))
1117 (defun vc-bzr-shelve-show (name)
1118 "Show the contents of shelve NAME."
1119 (interactive "sShelve name: ")
1120 (vc-setup-buffer "*vc-diff*")
1121 ;; FIXME: how can you show the contents of a shelf?
1122 (vc-bzr-command "unshelve" "*vc-diff*" 'async nil "--preview" name)
1123 (set-buffer "*vc-diff*")
1124 (diff-mode)
1125 (setq buffer-read-only t)
1126 (pop-to-buffer (current-buffer)))
1128 (defun vc-bzr-shelve-apply (name)
1129 "Apply shelve NAME and remove it afterwards."
1130 (interactive "sApply (and remove) shelf: ")
1131 (vc-bzr-command "unshelve" nil 0 nil "--apply" name)
1132 (vc-resynch-buffer (vc-bzr-root default-directory) t t))
1134 (defun vc-bzr-shelve-apply-and-keep (name)
1135 "Apply shelve NAME and keep it afterwards."
1136 (interactive "sApply (and keep) shelf: ")
1137 (vc-bzr-command "unshelve" nil 0 nil "--apply" "--keep" name)
1138 (vc-resynch-buffer (vc-bzr-root default-directory) t t))
1140 (defun vc-bzr-shelve-snapshot ()
1141 "Create a stash with the current tree state."
1142 (interactive)
1143 (vc-bzr-command "shelve" nil 0 nil "--all" "-m"
1144 (format-time-string "Snapshot on %Y-%m-%d at %H:%M"))
1145 (vc-bzr-command "unshelve" nil 0 nil "--apply" "--keep")
1146 (vc-resynch-buffer (vc-bzr-root default-directory) t t))
1148 (defun vc-bzr-shelve-list ()
1149 (with-temp-buffer
1150 (vc-bzr-command "shelve" (current-buffer) 1 nil "--list" "-q")
1151 (delete
1153 (split-string
1154 (buffer-substring (point-min) (point-max))
1155 "\n"))))
1157 (defun vc-bzr-shelve-get-at-point (point)
1158 (save-excursion
1159 (goto-char point)
1160 (beginning-of-line)
1161 (if (looking-at "^ +\\([0-9]+\\):")
1162 (match-string 1)
1163 (error "Cannot find shelf at point"))))
1165 ;; vc-bzr-shelve-delete-at-point must be called from a vc-dir buffer.
1166 (declare-function vc-dir-refresh "vc-dir" ())
1168 (defun vc-bzr-shelve-delete-at-point ()
1169 (interactive)
1170 (let ((shelve (vc-bzr-shelve-get-at-point (point))))
1171 (when (y-or-n-p (format "Remove shelf %s ? " shelve))
1172 (vc-bzr-command "unshelve" nil 0 nil "--delete-only" shelve)
1173 (vc-dir-refresh))))
1175 (defun vc-bzr-shelve-show-at-point ()
1176 (interactive)
1177 (vc-bzr-shelve-show (vc-bzr-shelve-get-at-point (point))))
1179 (defun vc-bzr-shelve-apply-at-point ()
1180 (interactive)
1181 (vc-bzr-shelve-apply (vc-bzr-shelve-get-at-point (point))))
1183 (defun vc-bzr-shelve-apply-and-keep-at-point ()
1184 (interactive)
1185 (vc-bzr-shelve-apply-and-keep (vc-bzr-shelve-get-at-point (point))))
1187 (defun vc-bzr-shelve-menu (e)
1188 (interactive "e")
1189 (vc-dir-at-event e (popup-menu vc-bzr-shelve-menu-map e)))
1191 (defun vc-bzr-revision-table (files)
1192 (let ((vc-bzr-revisions '())
1193 (default-directory (file-name-directory (car files))))
1194 (with-temp-buffer
1195 (vc-bzr-command "log" t 0 files "--line")
1196 (let ((start (point-min))
1197 (loglines (buffer-substring-no-properties (point-min) (point-max))))
1198 (while (string-match "^\\([0-9]+\\):" loglines)
1199 (push (match-string 1 loglines) vc-bzr-revisions)
1200 (setq start (+ start (match-end 0)))
1201 (setq loglines (buffer-substring-no-properties start (point-max))))))
1202 vc-bzr-revisions))
1204 (defun vc-bzr-conflicted-files (dir)
1205 (let ((default-directory (vc-bzr-root dir))
1206 (files ()))
1207 (with-temp-buffer
1208 (vc-bzr-command "status" t 0 default-directory)
1209 (goto-char (point-min))
1210 (when (re-search-forward "^conflicts:\n" nil t)
1211 (while (looking-at " \\(?:Text conflict in \\(.*\\)\\|.*\\)\n")
1212 (if (match-end 1)
1213 (push (expand-file-name (match-string 1)) files))
1214 (goto-char (match-end 0)))))
1215 files))
1217 ;;; Revision completion
1219 (eval-and-compile
1220 (defconst vc-bzr-revision-keywords
1221 ;; bzr help revisionspec | sed -ne 's/^\([a-z]*\):$/"\1"/p' | sort -u
1222 '("ancestor" "annotate" "before" "branch" "date" "last" "mainline" "revid"
1223 "revno" "submit" "tag")))
1225 (defun vc-bzr-revision-completion-table (files)
1226 ;; What about using `files'?!? --Stef
1227 (lambda (string pred action)
1228 (cond
1229 ((string-match "\\`\\(ancestor\\|branch\\|\\(revno:\\)?[-0-9]+:\\):"
1230 string)
1231 (completion-table-with-context (substring string 0 (match-end 0))
1232 (apply-partially
1233 'completion-table-with-predicate
1234 'completion-file-name-table
1235 'file-directory-p t)
1236 (substring string (match-end 0))
1237 pred
1238 action))
1239 ((string-match "\\`\\(before\\):" string)
1240 (completion-table-with-context (substring string 0 (match-end 0))
1241 (vc-bzr-revision-completion-table files)
1242 (substring string (match-end 0))
1243 pred
1244 action))
1245 ((string-match "\\`\\(tag\\):" string)
1246 (let ((prefix (substring string 0 (match-end 0)))
1247 (tag (substring string (match-end 0)))
1248 (table nil)
1249 process-file-side-effects)
1250 (with-temp-buffer
1251 ;; "bzr-1.2 tags" is much faster with --show-ids.
1252 (process-file vc-bzr-program nil '(t) nil "tags" "--show-ids")
1253 ;; The output is ambiguous, unless we assume that revids do not
1254 ;; contain spaces.
1255 (goto-char (point-min))
1256 (while (re-search-forward "^\\(.*[^ \n]\\) +[^ \n]*$" nil t)
1257 (push (match-string-no-properties 1) table)))
1258 (completion-table-with-context prefix table tag pred action)))
1260 ((string-match "\\`annotate:" string)
1261 (completion-table-with-context
1262 (substring string 0 (match-end 0))
1263 (apply-partially #'completion-table-with-terminator '(":" . "\\`a\\`")
1264 #'completion-file-name-table)
1265 (substring string (match-end 0)) pred action))
1267 ((string-match "\\`date:" string)
1268 (completion-table-with-context
1269 (substring string 0 (match-end 0))
1270 '("yesterday" "today" "tomorrow")
1271 (substring string (match-end 0)) pred action))
1273 ((string-match "\\`\\([a-z]+\\):" string)
1274 ;; no actual completion for the remaining keywords.
1275 (completion-table-with-context (substring string 0 (match-end 0))
1276 (if (member (match-string 1 string)
1277 vc-bzr-revision-keywords)
1278 ;; If it's a valid keyword,
1279 ;; use a non-empty table to
1280 ;; indicate it.
1281 '("") nil)
1282 (substring string (match-end 0))
1283 pred
1284 action))
1286 ;; Could use completion-table-with-terminator, except that it
1287 ;; currently doesn't work right w.r.t pcm and doesn't give
1288 ;; the *Completions* output we want.
1289 (complete-with-action action (eval-when-compile
1290 (mapcar (lambda (s) (concat s ":"))
1291 vc-bzr-revision-keywords))
1292 string pred)))))
1294 (provide 'vc-bzr)
1296 ;;; vc-bzr.el ends here