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