lisp/vc/vc-bzr.el

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