lisp/vc-bzr.el

   1 ;;; vc-bzr.el --- VC backend for the bzr revision control system
   2
   3 ;; Copyright (C) 2006, 2007, 2008  Free Software Foundation, Inc.
   4
   5 ;; Author: Dave Love <fx@gnu.org>, Riccardo Murri <riccardo.murri@gmail.com>
   6 ;; Keywords: tools
   7 ;; Created: Sept 2006
   8 ;; Version: 2008-01-04 (Bzr revno 25)
   9 ;; URL: http://launchpad.net/vc-bzr
  10
  11 ;; This file is free software; you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation; either version 3, or (at your option)
  14 ;; any later version.
  15
  16 ;; This file is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
  23 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
  24 ;; Boston, MA 02110-1301, USA.
  25
  26
  27 ;;; Commentary:
  28
  29 ;; See <URL:http://bazaar-vcs.org/> concerning bzr.  See
  30 ;; <URL:http://launchpad.net/vc-bzr> for alternate development
  31 ;; branches of `vc-bzr'.
  32
  33 ;; Load this library to register bzr support in VC.
  34
  35 ;; Known bugs
  36 ;; ==========
  37
  38 ;; When edititing a symlink and *both* the symlink and its target
  39 ;; are bzr-versioned, `vc-bzr` presently runs `bzr status` on the
  40 ;; symlink, thereby not detecting whether the actual contents
  41 ;; (that is, the target contents) are changed.
  42 ;; See https://bugs.launchpad.net/vc-bzr/+bug/116607
  43
  44 ;; For an up-to-date list of bugs, please see:
  45 ;;   https://bugs.launchpad.net/vc-bzr/+bugs
  46
  47
  48 ;;; Code:
  49
  50 (eval-when-compile
  51   (require 'cl)
  52   (require 'vc))                        ; for vc-exec-after
  53
  54 ;; Clear up the cache to force vc-call to check again and discover
  55 ;; new functions when we reload this file.
  56 (put 'Bzr 'vc-functions nil)
  57
  58 (defgroup vc-bzr nil
  59   "VC bzr backend."
  60   :version "22.2"
  61   :group 'vc)
  62
  63 (defcustom vc-bzr-program "bzr"
  64   "Name of the bzr command (excluding any arguments)."
  65   :group 'vc-bzr
  66   :type 'string)
  67
  68 (defcustom vc-bzr-diff-switches nil
  69   "String/list of strings specifying extra switches for bzr diff under VC."
  70   :type '(choice (const :tag "None" nil)
  71                  (string :tag "Argument String")
  72                  (repeat :tag "Argument List" :value ("") string))
  73   :group 'vc-bzr)
  74
  75 (defcustom vc-bzr-log-switches nil
  76   "String/list of strings specifying extra switches for `bzr log' under VC."
  77   :type '(choice (const :tag "None" nil)
  78                  (string :tag "Argument String")
  79                  (repeat :tag "Argument List" :value ("") string))
  80   :group 'vc-bzr)
  81
  82 ;; since v0.9, bzr supports removing the progress indicators
  83 ;; by setting environment variable BZR_PROGRESS_BAR to "none".
  84 (defun vc-bzr-command (bzr-command buffer okstatus file-or-list &rest args)
  85   "Wrapper round `vc-do-command' using `vc-bzr-program' as COMMAND.
  86 Invoke the bzr command adding `BZR_PROGRESS_BAR=none' and
  87 `LC_MESSAGES=C' to the environment."
  88   (let ((process-environment
  89          (list* "BZR_PROGRESS_BAR=none" ; Suppress progress output (bzr >=0.9)
  90                 "LC_MESSAGES=C"         ; Force English output
  91                 process-environment)))
  92     (apply 'vc-do-command buffer okstatus vc-bzr-program
  93            file-or-list bzr-command args)))
  94
  95
  96 ;;;###autoload
  97 (defconst vc-bzr-admin-dirname ".bzr"
  98   "Name of the directory containing Bzr repository status files.")
  99 ;;;###autoload
 100 (defconst vc-bzr-admin-checkout-format-file
 101   (concat vc-bzr-admin-dirname "/checkout/format"))
 102 (defconst vc-bzr-admin-dirstate
 103   (concat vc-bzr-admin-dirname "/checkout/dirstate"))
 104 (defconst vc-bzr-admin-branch-format-file
 105   (concat vc-bzr-admin-dirname "/branch/format"))
 106 (defconst vc-bzr-admin-revhistory
 107   (concat vc-bzr-admin-dirname "/branch/revision-history"))
 108 (defconst vc-bzr-admin-lastrev
 109   (concat vc-bzr-admin-dirname "/branch/last-revision"))
 110
 111 ;;;###autoload (defun vc-bzr-registered (file)
 112 ;;;###autoload   (if (vc-find-root file vc-bzr-admin-checkout-format-file)
 113 ;;;###autoload       (progn
 114 ;;;###autoload         (load "vc-bzr")
 115 ;;;###autoload         (vc-bzr-registered file))))
 116
 117 (defun vc-bzr-root (file)
 118   "Return the root directory of the bzr repository containing FILE."
 119   ;; Cache technique copied from vc-arch.el.
 120   (or (vc-file-getprop file 'bzr-root)
 121       (let ((root (vc-find-root file vc-bzr-admin-checkout-format-file)))
 122         (when root (vc-file-setprop file 'bzr-root root)))))
 123
 124 (require 'sha1)                         ;For sha1-program
 125
 126 (defun vc-bzr-sha1 (file)
 127   (with-temp-buffer
 128     (set-buffer-multibyte nil)
 129     (let ((prog sha1-program)
 130           (args nil))
 131       (when (consp prog)
 132         (setq args (cdr prog))
 133         (setq prog (car prog)))
 134       (apply 'call-process prog file t nil args)
 135       (buffer-substring (point-min) (+ (point-min) 40)))))
 136
 137 (defun vc-bzr-state-heuristic (file)
 138   "Like `vc-bzr-state' but hopefully without running Bzr."
 139   ;; `bzr status' is excrutiatingly slow with large histories and
 140   ;; pending merges, so try to avoid using it until they fix their
 141   ;; performance problems.
 142   ;; This function tries first to parse Bzr internal file
 143   ;; `checkout/dirstate', but it may fail if Bzr internal file format
 144   ;; has changed.  As a safeguard, the `checkout/dirstate' file is
 145   ;; only parsed if it contains the string `#bazaar dirstate flat
 146   ;; format 3' in the first line.
 147   ;; If the `checkout/dirstate' file cannot be parsed, fall back to
 148   ;; running `vc-bzr-state'."
 149   (lexical-let ((root (vc-bzr-root file)))
 150     (when root    ; Short cut.
 151       ;; This looks at internal files.  May break if they change
 152       ;; their format.
 153       (lexical-let ((dirstate (expand-file-name vc-bzr-admin-dirstate root)))
 154         (if (not (file-readable-p dirstate))
 155             (vc-bzr-state file)         ; Expensive.
 156           (with-temp-buffer
 157             (insert-file-contents dirstate)
 158             (goto-char (point-min))
 159             (if (not (looking-at "#bazaar dirstate flat format 3"))
 160                 (vc-bzr-state file)     ; Some other unknown format?
 161               (let* ((relfile (file-relative-name file root))
 162                      (reldir (file-name-directory relfile)))
 163                 (if (re-search-forward
 164                      (concat "^\0"
 165                              (if reldir (regexp-quote
 166                                          (directory-file-name reldir)))
 167                              "\0"
 168                              (regexp-quote (file-name-nondirectory relfile))
 169                              "\0"
 170                              "[^\0]*\0"       ;id?
 171                              "\\([^\0]*\\)\0" ;"a/f/d", a=removed?
 172                              "[^\0]*\0"       ;sha1 (empty if conflicted)?
 173                              "\\([^\0]*\\)\0" ;size?
 174                              "[^\0]*\0"       ;"y/n", executable?
 175                              "[^\0]*\0"       ;?
 176                              "\\([^\0]*\\)\0" ;"a/f/d" a=added?
 177                              "\\([^\0]*\\)\0" ;sha1 again?
 178                              "[^\0]*\0"       ;size again?
 179                              "[^\0]*\0"       ;"y/n", executable again?
 180                              "[^\0]*\0"       ;last revid?
 181                              ;; There are more fields when merges are pending.
 182                              )
 183                      nil t)
 184                     ;; Apparently the second sha1 is the one we want: when
 185                     ;; there's a conflict, the first sha1 is absent (and the
 186                     ;; first size seems to correspond to the file with
 187                     ;; conflict markers).
 188                     (cond
 189                      ((eq (char-after (match-beginning 1)) ?a) 'removed)
 190                      ((eq (char-after (match-beginning 3)) ?a) 'added)
 191                      ((and (eq (string-to-number (match-string 2))
 192                                (nth 7 (file-attributes file)))
 193                            (equal (match-string 4)
 194                                   (vc-bzr-sha1 file)))
 195                       'up-to-date)
 196                      (t 'edited))
 197                   'unregistered)))))))))
 198
 199 (defun vc-bzr-registered (file)
 200   "Return non-nil if FILE is registered with bzr."
 201   (let ((state (vc-bzr-state-heuristic file)))
 202     (not (memq state '(nil unregistered ignored)))))
 203
 204 (defconst vc-bzr-state-words
 205   "added\\|ignored\\|kind changed\\|modified\\|removed\\|renamed\\|unknown"
 206   "Regexp matching file status words as reported in `bzr' output.")
 207
 208 (defun vc-bzr-file-name-relative (filename)
 209   "Return file name FILENAME stripped of the initial Bzr repository path."
 210   (lexical-let*
 211       ((filename* (expand-file-name filename))
 212        (rootdir (vc-bzr-root filename*)))
 213     (when rootdir
 214          (file-relative-name filename* rootdir))))
 215
 216 (defun vc-bzr-status (file)
 217   "Return FILE status according to Bzr.
 218 Return value is a cons (STATUS . WARNING), where WARNING is a
 219 string or nil, and STATUS is one of the symbols: `added',
 220 `ignored', `kindchanged', `modified', `removed', `renamed', `unknown',
 221 which directly correspond to `bzr status' output, or 'unchanged
 222 for files whose copy in the working tree is identical to the one
 223 in the branch repository, or nil for files that are not
 224 registered with Bzr.
 225
 226 If any error occurred in running `bzr status', then return nil."
 227   (with-temp-buffer
 228     (let ((ret (condition-case nil
 229                    (vc-bzr-command "status" t 0 file)
 230                  (file-error nil)))     ; vc-bzr-program not found.
 231           (status 'unchanged))
 232           ;; the only secure status indication in `bzr status' output
 233           ;; is a couple of lines following the pattern::
 234           ;;   | <status>:
 235           ;;   |   <file name>
 236           ;; if the file is up-to-date, we get no status report from `bzr',
 237           ;; so if the regexp search for the above pattern fails, we consider
 238           ;; the file to be up-to-date.
 239           (goto-char (point-min))
 240           (when (re-search-forward
 241                  ;; bzr prints paths relative to the repository root.
 242                  (concat "^\\(" vc-bzr-state-words "\\):[ \t\n]+"
 243                          (regexp-quote (vc-bzr-file-name-relative file))
 244                          ;; Bzr appends a '/' to directory names and
 245                          ;; '*' to executable files
 246                          (if (file-directory-p file) "/?" "\\*?")
 247                          "[ \t\n]*$")
 248                  nil t)
 249             (lexical-let ((statusword (match-string 1)))
 250               ;; Erase the status text that matched.
 251               (delete-region (match-beginning 0) (match-end 0))
 252               (setq status
 253                     (intern (replace-regexp-in-string " " "" statusword)))))
 254           (when status
 255             (goto-char (point-min))
 256             (skip-chars-forward " \n\t") ;Throw away spaces.
 257             (cons status
 258                   ;; "bzr" will output warnings and informational messages to
 259                   ;; stderr; due to Emacs' `vc-do-command' (and, it seems,
 260                   ;; `start-process' itself) limitations, we cannot catch stderr
 261                   ;; and stdout into different buffers.  So, if there's anything
 262                   ;; left in the buffer after removing the above status
 263                   ;; keywords, let us just presume that any other message from
 264                   ;; "bzr" is a user warning, and display it.
 265                   (unless (eobp) (buffer-substring (point) (point-max))))))))
 266
 267 (defun vc-bzr-state (file)
 268   (lexical-let ((result (vc-bzr-status file)))
 269     (when (consp result)
 270       (when (cdr result)
 271         (message "Warnings in `bzr' output: %s" (cdr result)))
 272       (cdr (assq (car result)
 273                  '((added . added)
 274                    (kindchanged . edited)
 275                    (renamed . edited)
 276                    (modified . edited)
 277                    (removed . removed)
 278                    (ignored . unregistered)
 279                    (unknown . unregistered)
 280                    (unchanged . up-to-date)))))))
 281
 282 (defun vc-bzr-resolve-when-done ()
 283   "Call \"bzr resolve\" if the conflict markers have been removed."
 284   (save-excursion
 285     (goto-char (point-min))
 286     (unless (re-search-forward "^<<<<<<< " nil t)
 287       (vc-bzr-command "resolve" nil 0 buffer-file-name)
 288       ;; Remove the hook so that it is not called multiple times.
 289       (remove-hook 'after-save-hook 'vc-bzr-resolve-when-done t))))
 290
 291 (defun vc-bzr-find-file-hook ()
 292   (when (and buffer-file-name
 293              ;; FIXME: We should check that "bzr status" says "conflict".
 294              (file-exists-p (concat buffer-file-name ".BASE"))
 295              (file-exists-p (concat buffer-file-name ".OTHER"))
 296              (file-exists-p (concat buffer-file-name ".THIS"))
 297              ;; If "bzr status" says there's a conflict but there are no
 298              ;; conflict markers, it's not clear what we should do.
 299              (save-excursion
 300                (goto-char (point-min))
 301                (re-search-forward "^<<<<<<< " nil t)))
 302     ;; TODO: the merge algorithm used in `bzr merge' is nicely configurable,
 303     ;; but the one in `bzr pull' isn't, so it would be good to provide an
 304     ;; elisp function to remerge from the .BASE/OTHER/THIS files.
 305     (smerge-start-session)
 306     (add-hook 'after-save-hook 'vc-bzr-resolve-when-done nil t)
 307     (message "There are unresolved conflicts in this file")))
 308
 309 (defun vc-bzr-workfile-unchanged-p (file)
 310   (eq 'unchanged (car (vc-bzr-status file))))
 311
 312 (defun vc-bzr-working-revision (file)
 313   ;; Together with the code in vc-state-heuristic, this makes it possible
 314   ;; to get the initial VC state of a Bzr file even if Bzr is not installed.
 315   (lexical-let*
 316       ((rootdir (vc-bzr-root file))
 317        (branch-format-file (expand-file-name vc-bzr-admin-branch-format-file
 318                                              rootdir))
 319        (revhistory-file (expand-file-name vc-bzr-admin-revhistory rootdir))
 320        (lastrev-file (expand-file-name vc-bzr-admin-lastrev rootdir)))
 321     ;; This looks at internal files to avoid forking a bzr process.
 322     ;; May break if they change their format.
 323     (if (file-exists-p branch-format-file)
 324         (with-temp-buffer
 325           (insert-file-contents branch-format-file)
 326           (goto-char (point-min))
 327           (cond
 328            ((or
 329              (looking-at "Bazaar-NG branch, format 0.0.4")
 330              (looking-at "Bazaar-NG branch format 5"))
 331             ;; count lines in .bzr/branch/revision-history
 332             (insert-file-contents revhistory-file)
 333             (number-to-string (count-lines (line-end-position) (point-max))))
 334            ((looking-at "Bazaar Branch Format 6 (bzr 0.15)")
 335             ;; revno is the first number in .bzr/branch/last-revision
 336             (insert-file-contents lastrev-file)
 337             (if (re-search-forward "[0-9]+" nil t)
 338                 (buffer-substring (match-beginning 0) (match-end 0))))))
 339       ;; fallback to calling "bzr revno"
 340       (lexical-let*
 341           ((result (vc-bzr-command-discarding-stderr
 342                     vc-bzr-program "revno" file))
 343            (exitcode (car result))
 344            (output (cdr result)))
 345         (cond
 346          ((eq exitcode 0) (substring output 0 -1))
 347          (t nil))))))
 348
 349 (defun vc-bzr-checkout-model (file)
 350   'implicit)
 351
 352 (defun vc-bzr-create-repo ()
 353   "Create a new Bzr repository."
 354   (vc-bzr-command "init" nil 0 nil))
 355
 356 (defun vc-bzr-init-revision (&optional file)
 357   "Always return nil, as Bzr cannot register explicit versions."
 358   nil)
 359
 360 (defun vc-bzr-previous-revision (file rev)
 361   (if (string-match "\\`[0-9]+\\'" rev)
 362       (number-to-string (1- (string-to-number rev)))
 363     (concat "before:" rev)))
 364
 365 (defun vc-bzr-next-revision (file rev)
 366   (if (string-match "\\`[0-9]+\\'" rev)
 367       (number-to-string (1+ (string-to-number rev)))
 368     (error "Don't know how to compute the next revision of %s" rev)))
 369
 370 (defun vc-bzr-register (files &optional rev comment)
 371   "Register FILE under bzr.
 372 Signal an error unless REV is nil.
 373 COMMENT is ignored."
 374   (if rev (error "Can't register explicit revision with bzr"))
 375   (vc-bzr-command "add" nil 0 files))
 376
 377 ;; Could run `bzr status' in the directory and see if it succeeds, but
 378 ;; that's relatively expensive.
 379 (defalias 'vc-bzr-responsible-p 'vc-bzr-root
 380   "Return non-nil if FILE is (potentially) controlled by bzr.
 381 The criterion is that there is a `.bzr' directory in the same
 382 or a superior directory.")
 383
 384 (defun vc-bzr-could-register (file)
 385   "Return non-nil if FILE could be registered under bzr."
 386   (and (vc-bzr-responsible-p file)      ; shortcut
 387        (condition-case ()
 388            (with-temp-buffer
 389              (vc-bzr-command "add" t 0 file "--dry-run")
 390              ;; The command succeeds with no output if file is
 391              ;; registered (in bzr 0.8).
 392              (goto-char (point-min))
 393              (looking-at "added "))
 394          (error))))
 395
 396 (defun vc-bzr-unregister (file)
 397   "Unregister FILE from bzr."
 398   (vc-bzr-command "remove" nil 0 file "--keep"))
 399
 400 (defun vc-bzr-checkin (files rev comment)
 401   "Check FILE in to bzr with log message COMMENT.
 402 REV non-nil gets an error."
 403   (if rev (error "Can't check in a specific revision with bzr"))
 404   (vc-bzr-command "commit" nil 0 files "-m" comment))
 405
 406 (defun vc-bzr-find-version (file rev buffer)
 407   "Fetch version REV of file FILE and put it into BUFFER."
 408     (with-current-buffer buffer
 409       (if (and rev (stringp rev) (not (string= rev "")))
 410           (vc-bzr-command "cat" t 0 file "-r" rev)
 411         (vc-bzr-command "cat" t 0 file))))
 412
 413 (defun vc-bzr-checkout (file &optional editable rev)
 414   (if rev (error "Operation not supported")
 415     ;; Else, there's nothing to do.
 416     nil))
 417
 418 (defun vc-bzr-revert (file &optional contents-done)
 419   (unless contents-done
 420     (with-temp-buffer (vc-bzr-command "revert" t 0 file))))
 421
 422 (defvar log-view-message-re)
 423 (defvar log-view-file-re)
 424 (defvar log-view-font-lock-keywords)
 425 (defvar log-view-current-tag-function)
 426
 427 (define-derived-mode vc-bzr-log-view-mode log-view-mode "Bzr-Log-View"
 428   (remove-hook 'log-view-mode-hook 'vc-bzr-log-view-mode) ;Deactivate the hack.
 429   (require 'add-log)
 430   (set (make-local-variable 'log-view-file-re) "^Working file:[ \t]+\\(.+\\)")
 431   (set (make-local-variable 'log-view-message-re)
 432        "^ *-+\n *\\(?:revno: \\([0-9.]+\\)\\|merged: .+\\)")
 433   (set (make-local-variable 'log-view-font-lock-keywords)
 434        ;; log-view-font-lock-keywords is careful to use the buffer-local
 435        ;; value of log-view-message-re only since Emacs-23.
 436        (append `((,log-view-message-re . 'log-view-message-face))
 437                ;; log-view-font-lock-keywords
 438                '(("^ *committer: \
 439 \\([^<(]+?\\)[  ]*[(<]\\([[:alnum:]_.+-]+@[[:alnum:]_.-]+\\)[>)]"
 440                   (1 'change-log-name)
 441                   (2 'change-log-email))
 442                  ("^ *timestamp: \\(.*\\)" (1 'change-log-date-face))))))
 443
 444 (defun vc-bzr-print-log (files &optional buffer) ; get buffer arg in Emacs 22
 445   "Get bzr change log for FILES into specified BUFFER."
 446   ;; `vc-do-command' creates the buffer, but we need it before running
 447   ;; the command.
 448   (vc-setup-buffer buffer)
 449   ;; If the buffer exists from a previous invocation it might be
 450   ;; read-only.
 451   ;; FIXME: `vc-bzr-command' runs `bzr log' with `LC_MESSAGES=C', so
 452   ;; the log display may not what the user wants - but I see no other
 453   ;; way of getting the above regexps working.
 454   (dolist (file files)
 455     (vc-exec-after
 456      `(let ((inhibit-read-only t))
 457         (with-current-buffer buffer
 458           ;; Insert the file name so that log-view.el can find it.
 459           (insert "Working file: " ',file "\n")) ;; Like RCS/CVS.
 460         (apply 'vc-bzr-command "log" ',buffer 'async ',file
 461                ',(if (stringp vc-bzr-log-switches)
 462                      (list vc-bzr-log-switches)
 463                    vc-bzr-log-switches))))))
 464
 465 (defun vc-bzr-show-log-entry (revision)
 466   "Find entry for patch name REVISION in bzr change log buffer."
 467   (goto-char (point-min))
 468   (let (case-fold-search)
 469     (if (re-search-forward
 470          ;; "revno:" can appear either at the beginning of a line, or indented.
 471          (concat "^[ ]*-+\n[ ]*revno: "
 472                  ;; The revision can contain ".", quote it so that it
 473                  ;; does not interfere with regexp matching.
 474                  (regexp-quote revision) "$") nil t)
 475         (beginning-of-line 0)
 476       (goto-char (point-min)))))
 477
 478 (defun vc-bzr-diff (files &optional rev1 rev2 buffer)
 479   "VC bzr backend for diff."
 480   ;; `bzr diff' exits with code 1 if diff is non-empty.
 481   (apply #'vc-bzr-command "diff" (or buffer "*vc-diff*") 'async files
 482          "--diff-options" (mapconcat 'identity
 483                                      (vc-diff-switches-list bzr)
 484                                      " ")
 485          ;; This `when' is just an optimization because bzr-1.2 is *much*
 486          ;; faster when the revision argument is not given.
 487          (when (or rev1 rev2)
 488            (list "-r" (format "%s..%s"
 489                               (or rev1 "revno:-1")
 490                               (or rev2 ""))))))
 491
 492
 493 ;; FIXME: vc-{next,previous}-revision need fixing in vc.el to deal with
 494 ;; straight integer revisions.
 495
 496 (defun vc-bzr-delete-file (file)
 497   "Delete FILE and delete it in the bzr repository."
 498   (condition-case ()
 499       (delete-file file)
 500     (file-error nil))
 501   (vc-bzr-command "remove" nil 0 file))
 502
 503 (defun vc-bzr-rename-file (old new)
 504   "Rename file from OLD to NEW using `bzr mv'."
 505   (vc-bzr-command "mv" nil 0 new old))
 506
 507 (defvar vc-bzr-annotation-table nil
 508   "Internal use.")
 509 (make-variable-buffer-local 'vc-bzr-annotation-table)
 510
 511 (defun vc-bzr-annotate-command (file buffer &optional revision)
 512   "Prepare BUFFER for `vc-annotate' on FILE.
 513 Each line is tagged with the revision number, which has a `help-echo'
 514 property containing author and date information."
 515   (apply #'vc-bzr-command "annotate" buffer 0 file "--long" "--all"
 516          (if revision (list "-r" revision)))
 517   (with-current-buffer buffer
 518     ;; Store the tags for the annotated source lines in a hash table
 519     ;; to allow saving space by sharing the text properties.
 520     (setq vc-bzr-annotation-table (make-hash-table :test 'equal))
 521     (goto-char (point-min))
 522     (while (re-search-forward "^\\( *[0-9.]+ *\\) \\([^\n ]+\\) +\\([0-9]\\{8\\}\\) |"
 523                               nil t)
 524       (let* ((rev (match-string 1))
 525              (author (match-string 2))
 526              (date (match-string 3))
 527              (key (match-string 0))
 528              (tag (gethash key vc-bzr-annotation-table)))
 529         (unless tag
 530           (setq tag (propertize rev 'help-echo (concat "Author: " author
 531                                                        ", date: " date)
 532                                 'mouse-face 'highlight))
 533           (puthash key tag vc-bzr-annotation-table))
 534         (replace-match "")
 535         (insert tag " |")))))
 536
 537 (defun vc-bzr-annotate-time ()
 538   (when (re-search-forward "^ *[0-9.]+ +|" nil t)
 539     (let ((prop (get-text-property (line-beginning-position) 'help-echo)))
 540       (string-match "[0-9]+\\'" prop)
 541       (vc-annotate-convert-time
 542        (encode-time 0 0 0
 543                     (string-to-number (substring (match-string 0 prop) 6 8))
 544                     (string-to-number (substring (match-string 0 prop) 4 6))
 545                     (string-to-number (substring (match-string 0 prop) 0 4))
 546                     )))))
 547
 548 (defun vc-bzr-annotate-extract-revision-at-line ()
 549   "Return revision for current line of annoation buffer, or nil.
 550 Return nil if current line isn't annotated."
 551   (save-excursion
 552     (beginning-of-line)
 553     (if (looking-at " *\\([0-9.]+\\) | ")
 554         (match-string-no-properties 1))))
 555
 556 (defun vc-bzr-command-discarding-stderr (command &rest args)
 557   "Execute shell command COMMAND (with ARGS); return its output and exitcode.
 558 Return value is a cons (EXITCODE . OUTPUT), where EXITCODE is
 559 the (numerical) exit code of the process, and OUTPUT is a string
 560 containing whatever the process sent to its standard output
 561 stream.  Standard error output is discarded."
 562   (with-temp-buffer
 563     (cons
 564      (apply #'call-process command nil (list (current-buffer) nil) nil args)
 565      (buffer-substring (point-min) (point-max)))))
 566
 567 ;; TODO: it would be nice to mark the conflicted files in  VC Dired,
 568 ;; and implement a command to run ediff and `bzr resolve' once the
 569 ;; changes have been merged.
 570 (defun vc-bzr-dir-state (dir &optional localp)
 571   "Find the VC state of all files in DIR and its subdirectories.
 572 Optional argument LOCALP is always ignored."
 573   (let ((bzr-root-directory (vc-bzr-root dir))
 574         (at-start t)
 575         current-bzr-state current-vc-state)
 576     ;; Check that DIR is a bzr repository.
 577     (unless (file-name-absolute-p bzr-root-directory)
 578       (error "Cannot find bzr repository for directory `%s'" dir))
 579     ;; `bzr ls --versioned' lists all versioned files;
 580     ;; assume they are up-to-date, unless we are given
 581     ;; evidence of the contrary.
 582     (setq at-start t)
 583     (with-temp-buffer
 584       (buffer-disable-undo)             ;; Because these buffers can get huge
 585       (vc-bzr-command "ls" t 0 nil "--versioned")
 586       (goto-char (point-min))
 587       (while (or at-start
 588                  (eq 0 (forward-line)))
 589         (setq at-start nil)
 590         (let ((file (expand-file-name
 591                      (buffer-substring-no-properties
 592                       (line-beginning-position) (line-end-position))
 593                      bzr-root-directory)))
 594           ;; files are up-to-date unless they appear in the `bzr
 595           ;; status' output below
 596           (vc-file-setprop file 'vc-state 'up-to-date)
 597           ;; XXX: is this correct? what happens if one
 598           ;; mixes different SCMs in the same dir?
 599           ;; Anyway, we're looking at the output of `bzr ls --versioned',
 600           ;; so we know these files are registered with Bzr.
 601           (vc-file-setprop file 'vc-backend 'Bzr))))
 602     ;; `bzr status' reports on added/modified/renamed and unknown/ignored files
 603     (setq at-start t)
 604     (with-temp-buffer
 605       (vc-bzr-command "status" t 0 nil)
 606       (goto-char (point-min))
 607       (while (or at-start
 608                  (eq 0 (forward-line)))
 609         (setq at-start nil)
 610         (cond
 611          ((looking-at "^added")
 612           (setq current-vc-state 'added)
 613           (setq current-bzr-state 'added))
 614          ((looking-at "^kind changed")
 615           (setq current-vc-state 'edited)
 616           (setq current-bzr-state 'kindchanged))
 617          ((looking-at "^modified")
 618           (setq current-vc-state 'edited)
 619           (setq current-bzr-state 'modified))
 620          ((looking-at "^renamed")
 621           (setq current-vc-state 'edited)
 622           (setq current-bzr-state 'renamed))
 623          ((looking-at "^ignored")
 624           (setq current-vc-state 'ignored)
 625           (setq current-bzr-state 'not-versioned))
 626          ((looking-at "^unknown")
 627           (setq current-vc-state 'unregistered)
 628           (setq current-bzr-state 'not-versioned))
 629          ((looking-at "  ")
 630           ;; file names are indented by two spaces
 631           (when current-vc-state
 632             (let ((file (expand-file-name
 633                          (buffer-substring-no-properties
 634                           (match-end 0) (line-end-position))
 635                          bzr-root-directory)))
 636               (vc-file-setprop file 'vc-state current-vc-state)
 637               (vc-file-setprop file 'vc-bzr-state current-bzr-state)
 638               (when (eq 'added current-bzr-state)
 639                 (vc-file-setprop file 'vc-working-revision "0"))))
 640           (when (eq 'not-versioned current-bzr-state)
 641             (let ((file (expand-file-name
 642                          (buffer-substring-no-properties
 643                           (match-end 0) (line-end-position))
 644                          bzr-root-directory)))
 645               (vc-file-setprop file 'vc-backend 'none)
 646               (vc-file-setprop file 'vc-state nil))))
 647          (t
 648           ;; skip this part of `bzr status' output
 649           (setq current-vc-state nil)
 650           (setq current-bzr-state nil)))))))
 651
 652 (defun vc-bzr-dired-state-info (file)
 653   "Bzr-specific version of `vc-dired-state-info'."
 654   (if (eq 'edited (vc-state file))
 655         (concat "(" (symbol-name (or (vc-file-getprop file 'vc-bzr-state)
 656                                      'edited)) ")")
 657     ;; else fall back to default vc.el representation
 658     (vc-default-dired-state-info 'Bzr file)))
 659
 660 ;; XXX Experimental function for the vc-dired replacement.
 661 ;; XXX: this needs testing, it's probably incomplete.
 662 (defun vc-bzr-after-dir-status (update-function status-buffer)
 663   (let ((status-str nil)
 664         (file nil)
 665         (translation '(("+N" . added)
 666                        ("-D" . removed)
 667                        (" M" . edited)
 668                        ;; XXX: what about ignored files?
 669                        (" D" . missing)
 670                        ("? " . unregistered)))
 671         (translated nil)
 672         (result nil))
 673       (goto-char (point-min))
 674       (while (not (eobp))
 675         (setq status-str
 676               (buffer-substring-no-properties (point) (+ (point) 2)))
 677         (setq file
 678               (buffer-substring-no-properties (+ (point) 4)
 679                                               (line-end-position)))
 680         (setq translated (assoc status-str translation))
 681         (push (list file (cdr translated)) result)
 682         (forward-line))
 683       (funcall update-function result status-buffer)))
 684
 685 ;; XXX Experimental function for the vc-dired replacement.
 686 ;; XXX This probably needs some further refinement and testing.
 687 (defun vc-bzr-dir-status (dir update-function status-buffer)
 688   "Return a list of conses (file . state) for DIR."
 689   ;; XXX: Is this the right command to use?
 690   (vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S")
 691   (vc-exec-after
 692    `(vc-bzr-after-dir-status (quote ,update-function) ,status-buffer)))
 693
 694 ;;; Revision completion
 695
 696 (defun vc-bzr-complete-with-prefix (prefix action table string pred)
 697   (let ((comp (complete-with-action action table string pred)))
 698     (if (stringp comp)
 699         (concat prefix comp)
 700       comp)))
 701
 702 (defun vc-bzr-revision-completion-table (files)
 703   (lexical-let ((files files))
 704     ;; What about using `files'?!?  --Stef
 705     (lambda (string pred action)
 706       (cond
 707        ((string-match "\\`\\(ancestor\\|branch\\|\\(revno:\\)?[-0-9]+:\\):"
 708                       string)
 709         (vc-bzr-complete-with-prefix (substring string 0 (match-end 0))
 710                                      action
 711                                      'read-file-name-internal
 712                                      (substring string (match-end 0))
 713                                      ;; Dropping `pred'.   Maybe we should just
 714                                      ;; stash it in `read-file-name-predicate'?
 715                                      nil))
 716        ((string-match "\\`\\(before\\):" string)
 717         (vc-bzr-complete-with-prefix (substring string 0 (match-end 0))
 718                                      action
 719                                      (vc-bzr-revision-completion-table files)
 720                                      (substring string (match-end 0))
 721                                      pred))
 722        ((string-match "\\`\\(tag\\):" string)
 723         (let ((prefix (substring string 0 (match-end 0)))
 724               (tag (substring string (match-end 0)))
 725               (table nil))
 726           (with-temp-buffer
 727             ;; "bzr-1.2 tags" is much faster with --show-ids.
 728             (call-process vc-bzr-program nil '(t) nil "tags" "--show-ids")
 729             ;; The output is ambiguous, unless we assume that revids do not
 730             ;; contain spaces.
 731             (goto-char (point-min))
 732             (while (re-search-forward "^\\(.*[^ \n]\\) +[^ \n]*$" nil t)
 733               (push (match-string-no-properties 1) table)))
 734           (vc-bzr-complete-with-prefix prefix action table tag pred)))
 735
 736        ((string-match "\\`\\(revid\\):" string)
 737         ;; FIXME: How can I get a list of revision ids?
 738         )
 739        (t
 740         (complete-with-action action '("revno:" "revid:" "last:" "before:"
 741                                        "tag:" "date:" "ancestor:" "branch:"
 742                                        "submit:")
 743                               string pred))))))
 744
 745 (eval-after-load "vc"
 746   '(add-to-list 'vc-directory-exclusion-list vc-bzr-admin-dirname t))
 747
 748 (provide 'vc-bzr)
 749 ;; arch-tag: 8101bad8-4e92-4e7d-85ae-d8e08b4e7c06
 750 ;;; vc-bzr.el ends here