vc-bzr.el 31.6 KB
Newer Older
Stefan Monnier's avatar
Stefan Monnier committed
1 2
;;; vc-bzr.el --- VC backend for the bzr revision control system

3
;; Copyright (C) 2006, 2007, 2008  Free Software Foundation, Inc.
Stefan Monnier's avatar
Stefan Monnier committed
4 5 6 7

;; Author: Dave Love <fx@gnu.org>, Riccardo Murri <riccardo.murri@gmail.com>
;; Keywords: tools
;; Created: Sept 2006
8
;; Version: 2008-01-04 (Bzr revno 25)
Stefan Monnier's avatar
Stefan Monnier committed
9 10 11 12
;; URL: http://launchpad.net/vc-bzr

;; This file is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
13
;; the Free Software Foundation; either version 3, or (at your option)
Stefan Monnier's avatar
Stefan Monnier committed
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
;; any later version.

;; This file is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING.  If not, write to the
;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
;; Boston, MA 02110-1301, USA.


;;; Commentary:

29 30 31
;; See <URL:http://bazaar-vcs.org/> concerning bzr.  See
;; <URL:http://launchpad.net/vc-bzr> for alternate development
;; branches of `vc-bzr'.
Stefan Monnier's avatar
Stefan Monnier committed
32

33
;; Load this library to register bzr support in VC.  
34 35 36 37 38 39 40 41 42 43 44 45

;; Known bugs
;; ==========

;; When edititing a symlink and *both* the symlink and its target
;; are bzr-versioned, `vc-bzr` presently runs `bzr status` on the
;; symlink, thereby not detecting whether the actual contents
;; (that is, the target contents) are changed.  
;; See https://bugs.launchpad.net/vc-bzr/+bug/116607

;; For an up-to-date list of bugs, please see:
;;   https://bugs.launchpad.net/vc-bzr/+bugs
Stefan Monnier's avatar
Stefan Monnier committed
46 47 48 49 50


;;; Code:

(eval-when-compile
51
  (require 'cl)
Stefan Monnier's avatar
Stefan Monnier committed
52 53
  (require 'vc))                        ; for vc-exec-after

54 55
;; Clear up the cache to force vc-call to check again and discover
;; new functions when we reload this file.
56
(put 'Bzr 'vc-functions nil)
57

Stefan Monnier's avatar
Stefan Monnier committed
58 59
(defgroup vc-bzr nil
  "VC bzr backend."
60
  :version "22.2"
Stefan Monnier's avatar
Stefan Monnier committed
61 62 63
  :group 'vc)

(defcustom vc-bzr-program "bzr"
64
  "Name of the bzr command (excluding any arguments)."
Stefan Monnier's avatar
Stefan Monnier committed
65 66 67 68
  :group 'vc-bzr
  :type 'string)

(defcustom vc-bzr-diff-switches nil
69
  "String/list of strings specifying extra switches for bzr diff under VC."
Stefan Monnier's avatar
Stefan Monnier committed
70 71 72 73 74
  :type '(choice (const :tag "None" nil)
                 (string :tag "Argument String")
                 (repeat :tag "Argument List" :value ("") string))
  :group 'vc-bzr)

75 76 77 78 79 80 81
(defcustom vc-bzr-log-switches nil
  "String/list of strings specifying extra switches for `bzr log' under VC."
  :type '(choice (const :tag "None" nil)
                 (string :tag "Argument String")
                 (repeat :tag "Argument List" :value ("") string))
  :group 'vc-bzr)

82 83
;; since v0.9, bzr supports removing the progress indicators
;; by setting environment variable BZR_PROGRESS_BAR to "none".
84
(defun vc-bzr-command (bzr-command buffer okstatus file-or-list &rest args)
85
  "Wrapper round `vc-do-command' using `vc-bzr-program' as COMMAND.
86 87
Invoke the bzr command adding `BZR_PROGRESS_BAR=none' and
`LC_MESSAGES=C' to the environment."
88 89
  (let ((process-environment
         (list* "BZR_PROGRESS_BAR=none" ; Suppress progress output (bzr >=0.9)
90
                "LC_MESSAGES=C"         ; Force English output
91
                process-environment)))
92
    (apply 'vc-do-command buffer okstatus vc-bzr-program
93
           file-or-list bzr-command args)))
Stefan Monnier's avatar
Stefan Monnier committed
94

95 96

;;;###autoload
97
(defconst vc-bzr-admin-dirname ".bzr"
98
  "Name of the directory containing Bzr repository status files.")
99
;;;###autoload
100 101
(defconst vc-bzr-admin-checkout-format-file
  (concat vc-bzr-admin-dirname "/checkout/format"))
102
(defconst vc-bzr-admin-dirstate
103 104 105
  (concat vc-bzr-admin-dirname "/checkout/dirstate"))
(defconst vc-bzr-admin-branch-format-file
  (concat vc-bzr-admin-dirname "/branch/format"))
106
(defconst vc-bzr-admin-revhistory
107
  (concat vc-bzr-admin-dirname "/branch/revision-history"))
108 109
(defconst vc-bzr-admin-lastrev
  (concat vc-bzr-admin-dirname "/branch/last-revision"))
110 111

;;;###autoload (defun vc-bzr-registered (file)
112
;;;###autoload   (if (vc-find-root file vc-bzr-admin-checkout-format-file)
113 114 115
;;;###autoload       (progn
;;;###autoload         (load "vc-bzr")
;;;###autoload         (vc-bzr-registered file))))
Stefan Monnier's avatar
Stefan Monnier committed
116

117 118 119 120
(defun vc-bzr-root (file)
  "Return the root directory of the bzr repository containing FILE."
  ;; Cache technique copied from vc-arch.el.
  (or (vc-file-getprop file 'bzr-root)
121 122
      (let ((root (vc-find-root file vc-bzr-admin-checkout-format-file)))
	(when root (vc-file-setprop file 'bzr-root root)))))
Stefan Monnier's avatar
Stefan Monnier committed
123

Stefan Monnier's avatar
Stefan Monnier committed
124
(require 'sha1)                         ;For sha1-program
125

Stefan Monnier's avatar
Stefan Monnier committed
126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
(defun vc-bzr-sha1 (file)
  (with-temp-buffer
    (set-buffer-multibyte nil)
    (let ((prog sha1-program)
          (args nil))
      (when (consp prog)
	(setq args (cdr prog))
        (setq prog (car prog)))
      (apply 'call-process prog file t nil args)
      (buffer-substring (point-min) (+ (point-min) 40)))))

(defun vc-bzr-state-heuristic (file)
  "Like `vc-bzr-state' but hopefully without running Bzr."
  ;; `bzr status' is excrutiatingly slow with large histories and
  ;; pending merges, so try to avoid using it until they fix their
  ;; performance problems.
  ;; This function tries first to parse Bzr internal file
  ;; `checkout/dirstate', but it may fail if Bzr internal file format
  ;; has changed.  As a safeguard, the `checkout/dirstate' file is
  ;; only parsed if it contains the string `#bazaar dirstate flat
  ;; format 3' in the first line.
  ;; If the `checkout/dirstate' file cannot be parsed, fall back to
  ;; running `vc-bzr-state'."
149 150 151 152 153 154 155 156 157 158 159 160 161 162
  (lexical-let ((root (vc-bzr-root file)))
    (when root    ; Short cut.
      ;; This looks at internal files.  May break if they change
      ;; their format.
      (lexical-let ((dirstate (expand-file-name vc-bzr-admin-dirstate root)))
        (if (not (file-readable-p dirstate))
            (vc-bzr-state file)         ; Expensive.
          (with-temp-buffer
            (insert-file-contents dirstate)
            (goto-char (point-min))
            (if (not (looking-at "#bazaar dirstate flat format 3"))
                (vc-bzr-state file)     ; Some other unknown format?
              (let* ((relfile (file-relative-name file root))
                     (reldir (file-name-directory relfile)))
Stefan Monnier's avatar
Stefan Monnier committed
163 164 165 166 167 168 169
                (if (re-search-forward
                     (concat "^\0"
                             (if reldir (regexp-quote
                                         (directory-file-name reldir)))
                             "\0"
                             (regexp-quote (file-name-nondirectory relfile))
                             "\0"
170 171 172 173 174 175 176 177 178 179 180 181 182
                             "[^\0]*\0"       ;id?
                             "\\([^\0]*\\)\0" ;"a/f/d", a=removed?
                             "[^\0]*\0"       ;sha1 (empty if conflicted)?
                             "\\([^\0]*\\)\0" ;size?
                             "[^\0]*\0"       ;"y/n", executable?
                             "[^\0]*\0"       ;?
                             "\\([^\0]*\\)\0" ;"a/f/d" a=added?
                             "\\([^\0]*\\)\0" ;sha1 again?
                             "[^\0]*\0"       ;size again?
                             "[^\0]*\0"       ;"y/n", executable again?
                             "[^\0]*\0"       ;last revid?
                             ;; There are more fields when merges are pending.
                             )
Stefan Monnier's avatar
Stefan Monnier committed
183
                     nil t)
184 185 186 187
                    ;; Apparently the second sha1 is the one we want: when
                    ;; there's a conflict, the first sha1 is absent (and the
                    ;; first size seems to correspond to the file with
                    ;; conflict markers).
Stefan Monnier's avatar
Stefan Monnier committed
188
                    (cond
189
                     ((eq (char-after (match-beginning 1)) ?a) 'removed)
Stefan Monnier's avatar
Stefan Monnier committed
190
                     ((eq (char-after (match-beginning 3)) ?a) 'added)
191
                     ((and (eq (string-to-number (match-string 2))
Stefan Monnier's avatar
Stefan Monnier committed
192
                               (nth 7 (file-attributes file)))
193
                           (equal (match-string 4)
Stefan Monnier's avatar
Stefan Monnier committed
194 195 196 197 198 199 200 201 202
                                  (vc-bzr-sha1 file)))
                      'up-to-date)
                     (t 'edited))
                  'unregistered)))))))))

(defun vc-bzr-registered (file)
  "Return non-nil if FILE is registered with bzr."
  (let ((state (vc-bzr-state-heuristic file)))
    (not (memq state '(nil unregistered ignored)))))
203 204

(defconst vc-bzr-state-words
205
  "added\\|ignored\\|kind changed\\|modified\\|removed\\|renamed\\|unknown"
206 207
  "Regexp matching file status words as reported in `bzr' output.")

208 209 210 211
(defun vc-bzr-file-name-relative (filename)
  "Return file name FILENAME stripped of the initial Bzr repository path."
  (lexical-let*
      ((filename* (expand-file-name filename))
212
       (rootdir (vc-bzr-root filename*)))
213
    (when rootdir 
214 215
         (file-relative-name filename* rootdir))))

216 217 218
(defun vc-bzr-status (file)
  "Return FILE status according to Bzr.
Return value is a cons (STATUS . WARNING), where WARNING is a
219 220
string or nil, and STATUS is one of the symbols: `added',
`ignored', `kindchanged', `modified', `removed', `renamed', `unknown',
221 222 223 224 225 226
which directly correspond to `bzr status' output, or 'unchanged
for files whose copy in the working tree is identical to the one
in the branch repository, or nil for files that are not
registered with Bzr.

If any error occurred in running `bzr status', then return nil."
227
  (with-temp-buffer
228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243
    (let ((ret (condition-case nil
                   (vc-bzr-command "status" t 0 file)
                 (file-error nil)))     ; vc-bzr-program not found.
          (status 'unchanged))
          ;; the only secure status indication in `bzr status' output
          ;; is a couple of lines following the pattern::
          ;;   | <status>:
          ;;   |   <file name>
          ;; if the file is up-to-date, we get no status report from `bzr',
          ;; so if the regexp search for the above pattern fails, we consider
          ;; the file to be up-to-date.
          (goto-char (point-min))
          (when (re-search-forward
                 ;; bzr prints paths relative to the repository root.
                 (concat "^\\(" vc-bzr-state-words "\\):[ \t\n]+"
                         (regexp-quote (vc-bzr-file-name-relative file))
244 245 246
                         ;; Bzr appends a '/' to directory names and
                         ;; '*' to executable files
                         (if (file-directory-p file) "/?" "\\*?")
247 248
                         "[ \t\n]*$")
                 nil t)
249
            (lexical-let ((statusword (match-string 1)))
250 251
              ;; Erase the status text that matched.
              (delete-region (match-beginning 0) (match-end 0))
252
              (setq status
253
                    (intern (replace-regexp-in-string " " "" statusword)))))
254 255 256 257 258 259 260 261 262 263 264 265
          (when status
            (goto-char (point-min))
            (skip-chars-forward " \n\t") ;Throw away spaces.
            (cons status
                  ;; "bzr" will output warnings and informational messages to
                  ;; stderr; due to Emacs' `vc-do-command' (and, it seems,
                  ;; `start-process' itself) limitations, we cannot catch stderr
                  ;; and stdout into different buffers.  So, if there's anything
                  ;; left in the buffer after removing the above status
                  ;; keywords, let us just presume that any other message from
                  ;; "bzr" is a user warning, and display it.
                  (unless (eobp) (buffer-substring (point) (point-max))))))))
266

267 268 269
(defun vc-bzr-state (file)
  (lexical-let ((result (vc-bzr-status file)))
    (when (consp result)
270 271
      (when (cdr result)
	(message "Warnings in `bzr' output: %s" (cdr result)))
272
      (cdr (assq (car result)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
273
                 '((added . added)
274
                   (kindchanged . edited)
275 276
                   (renamed . edited)
                   (modified . edited)
277 278 279
                   (removed . removed)
                   (ignored . unregistered)
                   (unknown . unregistered)
280
                   (unchanged . up-to-date)))))))
Stefan Monnier's avatar
Stefan Monnier committed
281

282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
(defun vc-bzr-resolve-when-done ()
  "Call \"bzr resolve\" if the conflict markers have been removed."
  (save-excursion
    (goto-char (point-min))
    (unless (re-search-forward "^<<<<<<< " nil t)
      (vc-bzr-command "resolve" nil 0 buffer-file-name)
      ;; Remove the hook so that it is not called multiple times.
      (remove-hook 'after-save-hook 'vc-bzr-resolve-when-done t))))

(defun vc-bzr-find-file-hook ()
  (when (and buffer-file-name
             ;; FIXME: We should check that "bzr status" says "conflict".
             (file-exists-p (concat buffer-file-name ".BASE"))
             (file-exists-p (concat buffer-file-name ".OTHER"))
             (file-exists-p (concat buffer-file-name ".THIS"))
             ;; If "bzr status" says there's a conflict but there are no
             ;; conflict markers, it's not clear what we should do.
             (save-excursion
               (goto-char (point-min))
               (re-search-forward "^<<<<<<< " nil t)))
    ;; TODO: the merge algorithm used in `bzr merge' is nicely configurable,
    ;; but the one in `bzr pull' isn't, so it would be good to provide an
    ;; elisp function to remerge from the .BASE/OTHER/THIS files.
    (smerge-start-session)
    (add-hook 'after-save-hook 'vc-bzr-resolve-when-done nil t)
    (message "There are unresolved conflicts in this file")))

Stefan Monnier's avatar
Stefan Monnier committed
309
(defun vc-bzr-workfile-unchanged-p (file)
310
  (eq 'unchanged (car (vc-bzr-status file))))
Stefan Monnier's avatar
Stefan Monnier committed
311

Eric S. Raymond's avatar
Eric S. Raymond committed
312
(defun vc-bzr-working-revision (file)
Stefan Monnier's avatar
Stefan Monnier committed
313 314
  ;; Together with the code in vc-state-heuristic, this makes it possible
  ;; to get the initial VC state of a Bzr file even if Bzr is not installed.
315 316
  (lexical-let*
      ((rootdir (vc-bzr-root file))
317 318 319 320 321 322
       (branch-format-file (expand-file-name vc-bzr-admin-branch-format-file
                                             rootdir))
       (revhistory-file (expand-file-name vc-bzr-admin-revhistory rootdir))
       (lastrev-file (expand-file-name vc-bzr-admin-lastrev rootdir)))
    ;; This looks at internal files to avoid forking a bzr process.
    ;; May break if they change their format.
323
    (if (file-exists-p branch-format-file)
324
        (with-temp-buffer
325 326 327 328 329 330 331
          (insert-file-contents branch-format-file) 
          (goto-char (point-min))
          (cond
           ((or
             (looking-at "Bazaar-NG branch, format 0.0.4")
             (looking-at "Bazaar-NG branch format 5"))
            ;; count lines in .bzr/branch/revision-history
332
            (insert-file-contents revhistory-file) 
333 334 335 336 337 338 339
            (number-to-string (count-lines (line-end-position) (point-max))))
           ((looking-at "Bazaar Branch Format 6 (bzr 0.15)")
            ;; revno is the first number in .bzr/branch/last-revision
            (insert-file-contents lastrev-file) 
            (if (re-search-forward "[0-9]+" nil t)
                (buffer-substring (match-beginning 0) (match-end 0))))))
      ;; fallback to calling "bzr revno"
340
      (lexical-let*
341 342
          ((result (vc-bzr-command-discarding-stderr
                    vc-bzr-program "revno" file))
343 344 345 346 347
           (exitcode (car result))
           (output (cdr result)))
        (cond
         ((eq exitcode 0) (substring output 0 -1))
         (t nil))))))
Stefan Monnier's avatar
Stefan Monnier committed
348 349 350 351

(defun vc-bzr-checkout-model (file)
  'implicit)

352
(defun vc-bzr-create-repo ()
353
  "Create a new Bzr repository."
354 355
  (vc-bzr-command "init" nil 0 nil))

356
(defun vc-bzr-init-revision (&optional file)
357 358 359
  "Always return nil, as Bzr cannot register explicit versions."
  nil)

360 361 362 363 364 365 366 367 368 369
(defun vc-bzr-previous-revision (file rev)
  (if (string-match "\\`[0-9]+\\'" rev)
      (number-to-string (1- (string-to-number rev)))
    (concat "before:" rev)))

(defun vc-bzr-next-revision (file rev)
  (if (string-match "\\`[0-9]+\\'" rev)
      (number-to-string (1+ (string-to-number rev)))
    (error "Don't know how to compute the next revision of %s" rev)))

370
(defun vc-bzr-register (files &optional rev comment)
Stefan Monnier's avatar
Stefan Monnier committed
371 372 373
  "Register FILE under bzr.
Signal an error unless REV is nil.
COMMENT is ignored."
374
  (if rev (error "Can't register explicit revision with bzr"))
375
  (vc-bzr-command "add" nil 0 files))
Stefan Monnier's avatar
Stefan Monnier committed
376 377 378

;; Could run `bzr status' in the directory and see if it succeeds, but
;; that's relatively expensive.
379
(defalias 'vc-bzr-responsible-p 'vc-bzr-root
Stefan Monnier's avatar
Stefan Monnier committed
380 381
  "Return non-nil if FILE is (potentially) controlled by bzr.
The criterion is that there is a `.bzr' directory in the same
382
or a superior directory.")
Stefan Monnier's avatar
Stefan Monnier committed
383 384 385 386 387 388 389 390 391

(defun vc-bzr-could-register (file)
  "Return non-nil if FILE could be registered under bzr."
  (and (vc-bzr-responsible-p file)      ; shortcut
       (condition-case ()
           (with-temp-buffer
             (vc-bzr-command "add" t 0 file "--dry-run")
             ;; The command succeeds with no output if file is
             ;; registered (in bzr 0.8).
392
             (goto-char (point-min))
Stefan Monnier's avatar
Stefan Monnier committed
393 394 395 396 397
             (looking-at "added "))
         (error))))

(defun vc-bzr-unregister (file)
  "Unregister FILE from bzr."
398
  (vc-bzr-command "remove" nil 0 file "--keep"))
Stefan Monnier's avatar
Stefan Monnier committed
399

400
(defun vc-bzr-checkin (files rev comment)
Stefan Monnier's avatar
Stefan Monnier committed
401 402
  "Check FILE in to bzr with log message COMMENT.
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))
Stefan Monnier's avatar
Stefan Monnier committed
405

406 407 408 409 410 411 412
(defun vc-bzr-find-version (file rev buffer)
  "Fetch version REV of file FILE and put it into BUFFER."
    (with-current-buffer buffer
      (if (and rev (stringp rev) (not (string= rev "")))
          (vc-bzr-command "cat" t 0 file "-r" rev)
        (vc-bzr-command "cat" t 0 file))))

Stefan Monnier's avatar
Stefan Monnier committed
413 414 415 416
(defun vc-bzr-checkout (file &optional editable rev)
  (if rev (error "Operation not supported")
    ;; Else, there's nothing to do.
    nil))
Stefan Monnier's avatar
Stefan Monnier committed
417 418 419

(defun vc-bzr-revert (file &optional contents-done)
  (unless contents-done
420
    (with-temp-buffer (vc-bzr-command "revert" t 0 file))))
Stefan Monnier's avatar
Stefan Monnier committed
421

422 423 424 425 426 427 428
(defvar log-view-message-re)
(defvar log-view-file-re)
(defvar log-view-font-lock-keywords)
(defvar log-view-current-tag-function)

(define-derived-mode vc-bzr-log-view-mode log-view-mode "Bzr-Log-View"
  (remove-hook 'log-view-mode-hook 'vc-bzr-log-view-mode) ;Deactivate the hack.
Stefan Monnier's avatar
Stefan Monnier committed
429
  (require 'add-log)
430
  (set (make-local-variable 'log-view-file-re) "^Working file:[ \t]+\\(.+\\)")
431
  (set (make-local-variable 'log-view-message-re)
432
       "^ *-+\n *\\(?:revno: \\([0-9.]+\\)\\|merged: .+\\)")
Stefan Monnier's avatar
Stefan Monnier committed
433
  (set (make-local-variable 'log-view-font-lock-keywords)
434 435 436 437 438
       ;; log-view-font-lock-keywords is careful to use the buffer-local
       ;; value of log-view-message-re only since Emacs-23.
       (append `((,log-view-message-re . 'log-view-message-face))
               ;; log-view-font-lock-keywords
               '(("^ *committer: \
439
\\([^<(]+?\\)[  ]*[(<]\\([[:alnum:]_.+-]+@[[:alnum:]_.-]+\\)[>)]"
440 441 442
                  (1 'change-log-name)
                  (2 'change-log-email))
                 ("^ *timestamp: \\(.*\\)" (1 'change-log-date-face))))))
Stefan Monnier's avatar
Stefan Monnier committed
443

444 445
(defun vc-bzr-print-log (files &optional buffer) ; get buffer arg in Emacs 22
  "Get bzr change log for FILES into specified BUFFER."
446 447 448 449 450
  ;; `vc-do-command' creates the buffer, but we need it before running
  ;; the command.
  (vc-setup-buffer buffer)
  ;; If the buffer exists from a previous invocation it might be
  ;; read-only.
Stefan Monnier's avatar
Stefan Monnier committed
451 452 453 454
  ;; FIXME: `vc-bzr-command' runs `bzr log' with `LC_MESSAGES=C', so
  ;; the log display may not what the user wants - but I see no other
  ;; way of getting the above regexps working.
  (dolist (file files)
455 456
    (vc-exec-after
     `(let ((inhibit-read-only t))
Stefan Monnier's avatar
Stefan Monnier committed
457 458
        (with-current-buffer buffer
          ;; Insert the file name so that log-view.el can find it.
459 460 461
          (insert "Working file: " ',file "\n")) ;; Like RCS/CVS.
        (apply 'vc-bzr-command "log" ',buffer 'async ',file
               ',(if (stringp vc-bzr-log-switches)
Stefan Monnier's avatar
Stefan Monnier committed
462
                     (list vc-bzr-log-switches)
463
                   vc-bzr-log-switches))))))
Stefan Monnier's avatar
Stefan Monnier committed
464

465 466
(defun vc-bzr-show-log-entry (revision)
  "Find entry for patch name REVISION in bzr change log buffer."
Stefan Monnier's avatar
Stefan Monnier committed
467 468
  (goto-char (point-min))
  (let (case-fold-search)
469 470 471 472 473 474
    (if (re-search-forward
	 ;; "revno:" can appear either at the beginning of a line, or indented.
	 (concat "^[ ]*-+\n[ ]*revno: " 
		 ;; The revision can contain ".", quote it so that it
		 ;; does not interfere with regexp matching.
		 (regexp-quote revision) "$") nil t)
Stefan Monnier's avatar
Stefan Monnier committed
475 476 477
        (beginning-of-line 0)
      (goto-char (point-min)))))

478
(defun vc-bzr-diff (files &optional rev1 rev2 buffer)
Stefan Monnier's avatar
Stefan Monnier committed
479
  "VC bzr backend for diff."
480
  ;; `bzr diff' exits with code 1 if diff is non-empty.
481
  (apply #'vc-bzr-command "diff" (or buffer "*vc-diff*") 'async files
482 483
         "--diff-options" (mapconcat 'identity 
                                     (vc-diff-switches-list bzr)
Miles Bader's avatar
Miles Bader committed
484
				     " ")
485 486 487 488 489 490
         ;; This `when' is just an optimization because bzr-1.2 is *much*
         ;; faster when the revision argument is not given.
         (when (or rev1 rev2)
           (list "-r" (format "%s..%s"
                              (or rev1 "revno:-1") 
                              (or rev2 ""))))))
Stefan Monnier's avatar
Stefan Monnier committed
491 492


493 494
;; FIXME: vc-{next,previous}-revision need fixing in vc.el to deal with
;; straight integer revisions.
Stefan Monnier's avatar
Stefan Monnier committed
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510

(defun vc-bzr-delete-file (file)
  "Delete FILE and delete it in the bzr repository."
  (condition-case ()
      (delete-file file)
    (file-error nil))
  (vc-bzr-command "remove" nil 0 file))

(defun vc-bzr-rename-file (old new)
  "Rename file from OLD to NEW using `bzr mv'."
  (vc-bzr-command "mv" nil 0 new old))

(defvar vc-bzr-annotation-table nil
  "Internal use.")
(make-variable-buffer-local 'vc-bzr-annotation-table)

511
(defun vc-bzr-annotate-command (file buffer &optional revision)
Stefan Monnier's avatar
Stefan Monnier committed
512 513 514
  "Prepare BUFFER for `vc-annotate' on FILE.
Each line is tagged with the revision number, which has a `help-echo'
property containing author and date information."
515
  (apply #'vc-bzr-command "annotate" buffer 0 file "--long" "--all"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
516 517 518 519 520 521
         (if revision (list "-r" revision)))
  (with-current-buffer buffer
    ;; Store the tags for the annotated source lines in a hash table
    ;; to allow saving space by sharing the text properties.
    (setq vc-bzr-annotation-table (make-hash-table :test 'equal))
    (goto-char (point-min))
522
    (while (re-search-forward "^\\( *[0-9.]+ *\\) \\([^\n ]+\\) +\\([0-9]\\{8\\}\\) |"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
523 524 525 526 527 528 529 530 531 532 533 534 535
                              nil t)
      (let* ((rev (match-string 1))
             (author (match-string 2))
             (date (match-string 3))
             (key (match-string 0))
             (tag (gethash key vc-bzr-annotation-table)))
        (unless tag
          (setq tag (propertize rev 'help-echo (concat "Author: " author
                                                       ", date: " date)
                                'mouse-face 'highlight))
          (puthash key tag vc-bzr-annotation-table))
        (replace-match "")
        (insert tag " |")))))
Stefan Monnier's avatar
Stefan Monnier committed
536 537

(defun vc-bzr-annotate-time ()
538
  (when (re-search-forward "^ *[0-9.]+ +|" nil t)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
539 540
    (let ((prop (get-text-property (line-beginning-position) 'help-echo)))
      (string-match "[0-9]+\\'" prop)
Stefan Monnier's avatar
Stefan Monnier committed
541 542
      (vc-annotate-convert-time
       (encode-time 0 0 0
Dan Nicolaescu's avatar
Dan Nicolaescu committed
543 544 545 546
                    (string-to-number (substring (match-string 0 prop) 6 8))
                    (string-to-number (substring (match-string 0 prop) 4 6))
                    (string-to-number (substring (match-string 0 prop) 0 4))
                    )))))
Stefan Monnier's avatar
Stefan Monnier committed
547 548 549 550 551 552

(defun vc-bzr-annotate-extract-revision-at-line ()
  "Return revision for current line of annoation buffer, or nil.
Return nil if current line isn't annotated."
  (save-excursion
    (beginning-of-line)
553
    (if (looking-at " *\\([0-9.]+\\) | ")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
554
        (match-string-no-properties 1))))
Stefan Monnier's avatar
Stefan Monnier committed
555

556 557
(defun vc-bzr-command-discarding-stderr (command &rest args)
  "Execute shell command COMMAND (with ARGS); return its output and exitcode.
558 559 560 561 562
Return value is a cons (EXITCODE . OUTPUT), where EXITCODE is
the (numerical) exit code of the process, and OUTPUT is a string
containing whatever the process sent to its standard output
stream.  Standard error output is discarded."
  (with-temp-buffer
563
    (cons
564
     (apply #'call-process command nil (list (current-buffer) nil) nil args)
565
     (buffer-substring (point-min) (point-max)))))
Stefan Monnier's avatar
Stefan Monnier committed
566 567 568 569 570

;; TODO: it would be nice to mark the conflicted files in  VC Dired,
;; and implement a command to run ediff and `bzr resolve' once the 
;; changes have been merged.
(defun vc-bzr-dir-state (dir &optional localp)
Eric S. Raymond's avatar
Eric S. Raymond committed
571
  "Find the VC state of all files in DIR and its subdirectories.
Stefan Monnier's avatar
Stefan Monnier committed
572
Optional argument LOCALP is always ignored."
573 574 575 576 577
  (let ((bzr-root-directory (vc-bzr-root dir))
        (at-start t)
        current-bzr-state current-vc-state)
    ;; Check that DIR is a bzr repository.
    (unless (file-name-absolute-p bzr-root-directory)
Stefan Monnier's avatar
Stefan Monnier committed
578 579 580 581
      (error "Cannot find bzr repository for directory `%s'" dir))
    ;; `bzr ls --versioned' lists all versioned files;
    ;; assume they are up-to-date, unless we are given
    ;; evidence of the contrary.
582
    (setq at-start t)
Stefan Monnier's avatar
Stefan Monnier committed
583
    (with-temp-buffer
584
      (buffer-disable-undo)		;; Because these buffers can get huge
Eric S. Raymond's avatar
Eric S. Raymond committed
585
      (vc-bzr-command "ls" t 0 nil "--versioned")
Stefan Monnier's avatar
Stefan Monnier committed
586
      (goto-char (point-min))
587
      (while (or at-start
Stefan Monnier's avatar
Stefan Monnier committed
588
                 (eq 0 (forward-line)))
589
        (setq at-start nil)
Stefan Monnier's avatar
Stefan Monnier committed
590 591 592 593
        (let ((file (expand-file-name
                     (buffer-substring-no-properties 
                      (line-beginning-position) (line-end-position))
                     bzr-root-directory)))
594 595
          ;; files are up-to-date unless they appear in the `bzr
          ;; status' output below
Stefan Monnier's avatar
Stefan Monnier committed
596 597 598
          (vc-file-setprop file 'vc-state 'up-to-date)
          ;; XXX: is this correct? what happens if one 
          ;; mixes different SCMs in the same dir?
599 600
          ;; Anyway, we're looking at the output of `bzr ls --versioned',
          ;; so we know these files are registered with Bzr.
601
          (vc-file-setprop file 'vc-backend 'Bzr))))
Stefan Monnier's avatar
Stefan Monnier committed
602
    ;; `bzr status' reports on added/modified/renamed and unknown/ignored files
603
    (setq at-start t)
Stefan Monnier's avatar
Stefan Monnier committed
604
    (with-temp-buffer 
605
      (vc-bzr-command "status" t 0 nil)
Stefan Monnier's avatar
Stefan Monnier committed
606
      (goto-char (point-min))
607
      (while (or at-start
Stefan Monnier's avatar
Stefan Monnier committed
608
                 (eq 0 (forward-line)))
609
        (setq at-start nil)
Stefan Monnier's avatar
Stefan Monnier committed
610 611
        (cond 
         ((looking-at "^added") 
612
          (setq current-vc-state 'added)
613
          (setq current-bzr-state 'added))
614 615
         ((looking-at "^kind changed") 
          (setq current-vc-state 'edited)
616
          (setq current-bzr-state 'kindchanged))
Stefan Monnier's avatar
Stefan Monnier committed
617
         ((looking-at "^modified") 
618 619
          (setq current-vc-state 'edited)
          (setq current-bzr-state 'modified))
Stefan Monnier's avatar
Stefan Monnier committed
620
         ((looking-at "^renamed") 
621 622
          (setq current-vc-state 'edited)
          (setq current-bzr-state 'renamed))
623 624 625 626 627
         ((looking-at "^ignored")
          (setq current-vc-state 'ignored)
          (setq current-bzr-state 'not-versioned))
         ((looking-at "^unknown")
          (setq current-vc-state 'unregistered)
628
          (setq current-bzr-state 'not-versioned))
Stefan Monnier's avatar
Stefan Monnier committed
629 630 631 632 633 634 635 636 637 638
         ((looking-at "  ")
          ;; file names are indented by two spaces
          (when current-vc-state
            (let ((file (expand-file-name
                         (buffer-substring-no-properties
                          (match-end 0) (line-end-position))
                         bzr-root-directory)))
              (vc-file-setprop file 'vc-state current-vc-state)
              (vc-file-setprop file 'vc-bzr-state current-bzr-state)
              (when (eq 'added current-bzr-state)
Eric S. Raymond's avatar
Eric S. Raymond committed
639
                (vc-file-setprop file 'vc-working-revision "0"))))
Stefan Monnier's avatar
Stefan Monnier committed
640 641 642 643 644 645 646 647 648
          (when (eq 'not-versioned current-bzr-state)
            (let ((file (expand-file-name
                         (buffer-substring-no-properties
                          (match-end 0) (line-end-position))
                         bzr-root-directory)))
              (vc-file-setprop file 'vc-backend 'none)
              (vc-file-setprop file 'vc-state nil))))
         (t
          ;; skip this part of `bzr status' output
649 650
          (setq current-vc-state nil)
          (setq current-bzr-state nil)))))))
Stefan Monnier's avatar
Stefan Monnier committed
651 652 653 654

(defun vc-bzr-dired-state-info (file)
  "Bzr-specific version of `vc-dired-state-info'."
  (if (eq 'edited (vc-state file))
655 656 657 658
        (concat "(" (symbol-name (or (vc-file-getprop file 'vc-bzr-state) 
                                     'edited)) ")")
    ;; else fall back to default vc.el representation
    (vc-default-dired-state-info 'Bzr file)))
Stefan Monnier's avatar
Stefan Monnier committed
659

660
;; XXX: this needs testing, it's probably incomplete. 
661
(defun vc-bzr-after-dir-status (update-function)
662 663 664 665 666 667
  (let ((status-str nil)
	(file nil)
	(translation '(("+N" . added)
		       ("-D" . removed)
		       (" M" . edited)
		       ;; XXX: what about ignored files?
668
		       (" D" . missing)
669
		       ("C " . conflict)
670 671 672 673 674 675 676
		       ("? " . unregistered)))
	(translated nil)
	(result nil))
      (goto-char (point-min))
      (while (not (eobp))
	(setq status-str
	      (buffer-substring-no-properties (point) (+ (point) 2)))
677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694
	(setq translated (cdr (assoc status-str translation)))
	;; For conflicts the file appears twice in the listing: once
	;; with the M flag and once with the C flag, so take care not
	;; to add it twice to `result'.  Ugly.
	(if (eq translated 'conflict)
	    (let* ((file
		    (buffer-substring-no-properties
		     ;;For files with conflicts the format is:
		     ;;C   Text conflict in FILENAME
		     ;; Bah.
		     (+ (point) 21) (line-end-position)))
		   (entry (assoc file result)))
	      (when entry
		(setf (nth 1 entry) 'conflict)))
	  (push (list (buffer-substring-no-properties
		       (+ (point) 4)
		       (line-end-position)) 
		      translated) result))
695
	(forward-line))
696
      (funcall update-function result)))
697 698 699

;; XXX Experimental function for the vc-dired replacement.
;; XXX This probably needs some further refinement and testing.
700
(defun vc-bzr-dir-status (dir update-function)
701
  "Return a list of conses (file . state) for DIR."
702 703 704
  ;; XXX: Is this the right command to use?
  (vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S")
  (vc-exec-after
705
   `(vc-bzr-after-dir-status (quote ,update-function))))
706

707 708 709 710 711 712 713 714 715
;;; Revision completion

(defun vc-bzr-revision-completion-table (files)
  (lexical-let ((files files))
    ;; What about using `files'?!?  --Stef
    (lambda (string pred action)
      (cond
       ((string-match "\\`\\(ancestor\\|branch\\|\\(revno:\\)?[-0-9]+:\\):"
                      string)
716 717 718 719 720 721 722 723
        (completion-table-with-context (substring string 0 (match-end 0))
                                       'read-file-name-internal
                                       (substring string (match-end 0))
                                       ;; Dropping `pred'.   Maybe we should
                                       ;; just stash it in
                                       ;; `read-file-name-predicate'?
                                       nil
                                       action))
724
       ((string-match "\\`\\(before\\):" string)
725 726 727 728 729
        (completion-table-with-context (substring string 0 (match-end 0))
                                       (vc-bzr-revision-completion-table files)
                                       (substring string (match-end 0))
                                       pred
                                       action))
730 731 732 733 734 735 736 737 738 739 740 741
       ((string-match "\\`\\(tag\\):" string)
        (let ((prefix (substring string 0 (match-end 0)))
              (tag (substring string (match-end 0)))
              (table nil))
          (with-temp-buffer
            ;; "bzr-1.2 tags" is much faster with --show-ids.
            (call-process vc-bzr-program nil '(t) nil "tags" "--show-ids")
            ;; The output is ambiguous, unless we assume that revids do not
            ;; contain spaces.
            (goto-char (point-min))
            (while (re-search-forward "^\\(.*[^ \n]\\) +[^ \n]*$" nil t)
              (push (match-string-no-properties 1) table)))
742
          (completion-table-with-context prefix table tag pred action)))
743 744 745 746 747 748 749 750 751 752

       ((string-match "\\`\\(revid\\):" string)
        ;; FIXME: How can I get a list of revision ids?
        )
       (t
        (complete-with-action action '("revno:" "revid:" "last:" "before:"
                                       "tag:" "date:" "ancestor:" "branch:"
                                       "submit:")
                              string pred))))))

Stefan Monnier's avatar
Stefan Monnier committed
753
(eval-after-load "vc"
754
  '(add-to-list 'vc-directory-exclusion-list vc-bzr-admin-dirname t))
Stefan Monnier's avatar
Stefan Monnier committed
755 756 757 758

(provide 'vc-bzr)
;; arch-tag: 8101bad8-4e92-4e7d-85ae-d8e08b4e7c06
;;; vc-bzr.el ends here