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

Glenn Morris's avatar
Glenn Morris committed
3
;; Copyright (C) 2006, 2007, 2008, 2009  Free Software Foundation, Inc.
Stefan Monnier's avatar
Stefan Monnier committed
4

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

12 13 14
;; This file is part of GNU Emacs.

;; GNU Emacs is free software: you can redistribute it and/or modify
Stefan Monnier's avatar
Stefan Monnier committed
15
;; it under the terms of the GNU General Public License as published by
16 17
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Stefan Monnier's avatar
Stefan Monnier committed
18

19
;; GNU Emacs is distributed in the hope that it will be useful,
Stefan Monnier's avatar
Stefan Monnier committed
20 21 22 23 24
;; 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
25
;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
Stefan Monnier's avatar
Stefan Monnier committed
26 27 28

;;; 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

;; 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
41
;; (that is, the target contents) are changed.
42 43 44 45
;; 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
;;; Properties of the backend

(defun vc-bzr-revision-granularity () 'repository)
(defun vc-bzr-checkout-model (files) 'implicit)
Stefan Monnier's avatar
Stefan Monnier committed
51 52 53 54

;;; Code:

(eval-when-compile
55
  (require 'cl)
56 57
  (require 'vc)  ;; for vc-exec-after
  (require 'vc-dir))
Stefan Monnier's avatar
Stefan Monnier committed
58

59 60
;; Clear up the cache to force vc-call to check again and discover
;; new functions when we reload this file.
61
(put 'Bzr 'vc-functions nil)
62

Stefan Monnier's avatar
Stefan Monnier committed
63 64
(defgroup vc-bzr nil
  "VC bzr backend."
65
  :version "22.2"
Stefan Monnier's avatar
Stefan Monnier committed
66 67 68
  :group 'vc)

(defcustom vc-bzr-program "bzr"
69
  "Name of the bzr command (excluding any arguments)."
Stefan Monnier's avatar
Stefan Monnier committed
70 71 72 73
  :group 'vc-bzr
  :type 'string)

(defcustom vc-bzr-diff-switches nil
74 75 76 77
  "String or list of strings specifying switches for bzr diff under VC.
If nil, use the value of `vc-diff-switches'.  If t, use no switches."
  :type '(choice (const :tag "Unspecified" nil)
                 (const :tag "None" t)
Stefan Monnier's avatar
Stefan Monnier committed
78 79 80 81
                 (string :tag "Argument String")
                 (repeat :tag "Argument List" :value ("") string))
  :group 'vc-bzr)

82
(defcustom vc-bzr-log-switches nil
83
  "String or list of strings specifying switches for bzr log under VC."
84 85 86 87 88
  :type '(choice (const :tag "None" nil)
                 (string :tag "Argument String")
                 (repeat :tag "Argument List" :value ("") string))
  :group 'vc-bzr)

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

102 103

;;;###autoload
104
(defconst vc-bzr-admin-dirname ".bzr"
105
  "Name of the directory containing Bzr repository status files.")
106
;;;###autoload
107 108
(defconst vc-bzr-admin-checkout-format-file
  (concat vc-bzr-admin-dirname "/checkout/format"))
109
(defconst vc-bzr-admin-dirstate
110 111 112
  (concat vc-bzr-admin-dirname "/checkout/dirstate"))
(defconst vc-bzr-admin-branch-format-file
  (concat vc-bzr-admin-dirname "/branch/format"))
113
(defconst vc-bzr-admin-revhistory
114
  (concat vc-bzr-admin-dirname "/branch/revision-history"))
115 116
(defconst vc-bzr-admin-lastrev
  (concat vc-bzr-admin-dirname "/branch/last-revision"))
117 118

;;;###autoload (defun vc-bzr-registered (file)
119
;;;###autoload   (if (vc-find-root file vc-bzr-admin-checkout-format-file)
120 121 122
;;;###autoload       (progn
;;;###autoload         (load "vc-bzr")
;;;###autoload         (vc-bzr-registered file))))
Stefan Monnier's avatar
Stefan Monnier committed
123

124 125 126 127
(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)
128 129
      (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
130

Stefan Monnier's avatar
Stefan Monnier committed
131
(require 'sha1)                         ;For sha1-program
132

Stefan Monnier's avatar
Stefan Monnier committed
133 134 135 136 137 138 139 140
(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)))
141
      (apply 'process-file prog (file-relative-name file) t nil args)
Stefan Monnier's avatar
Stefan Monnier committed
142 143 144 145
      (buffer-substring (point-min) (+ (point-min) 40)))))

(defun vc-bzr-state-heuristic (file)
  "Like `vc-bzr-state' but hopefully without running Bzr."
146
  ;; `bzr status' was excrutiatingly slow with large histories and
Stefan Monnier's avatar
Stefan Monnier committed
147 148 149 150 151 152 153 154 155
  ;; 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'."
156 157 158 159 160
  (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)))
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
        (condition-case nil
            (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)))
                  (if (re-search-forward
                       (concat "^\0"
                               (if reldir (regexp-quote
                                           (directory-file-name reldir)))
                               "\0"
                               (regexp-quote (file-name-nondirectory relfile))
                               "\0"
                               "[^\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.
                               )
                       nil t)
                      ;; 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).
                      (cond
                       ((eq (char-after (match-beginning 1)) ?a) 'removed)
                       ((eq (char-after (match-beginning 3)) ?a) 'added)
                       ((and (eq (string-to-number (match-string 2))
                                 (nth 7 (file-attributes file)))
                             (equal (match-string 4)
                                    (vc-bzr-sha1 file)))
                        'up-to-date)
                       (t 'edited))
                    'unregistered))))
          ;; Either the dirstate file can't be read, or the sha1
          ;; executable is missing, or ...
          ;; In either case, recent versions of Bzr aren't that slow
          ;; any more.
          (error (vc-bzr-state file)))))))

Stefan Monnier's avatar
Stefan Monnier committed
210 211 212 213 214

(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)))))
215 216

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

220 221 222 223
(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))
224
       (rootdir (vc-bzr-root filename*)))
225
    (when rootdir
226 227
         (file-relative-name filename* rootdir))))

228 229 230
(defun vc-bzr-status (file)
  "Return FILE status according to Bzr.
Return value is a cons (STATUS . WARNING), where WARNING is a
231 232
string or nil, and STATUS is one of the symbols: `added',
`ignored', `kindchanged', `modified', `removed', `renamed', `unknown',
233 234 235 236 237 238
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."
239
  (with-temp-buffer
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
    (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))
256 257 258
                         ;; Bzr appends a '/' to directory names and
                         ;; '*' to executable files
                         (if (file-directory-p file) "/?" "\\*?")
259 260
                         "[ \t\n]*$")
                 nil t)
261
            (lexical-let ((statusword (match-string 1)))
262 263
              ;; Erase the status text that matched.
              (delete-region (match-beginning 0) (match-end 0))
264
              (setq status
265
                    (intern (replace-regexp-in-string " " "" statusword)))))
266 267 268 269 270 271 272 273 274 275 276 277
          (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))))))))
278

279 280 281
(defun vc-bzr-state (file)
  (lexical-let ((result (vc-bzr-status file)))
    (when (consp result)
282 283
      (when (cdr result)
	(message "Warnings in `bzr' output: %s" (cdr result)))
284
      (cdr (assq (car result)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
285
                 '((added . added)
286
                   (kindchanged . edited)
287 288
                   (renamed . edited)
                   (modified . edited)
289
                   (removed . removed)
290
                   (ignored . ignored)
291
                   (unknown . unregistered)
292
                   (unchanged . up-to-date)))))))
Stefan Monnier's avatar
Stefan Monnier committed
293

294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320
(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
321
(defun vc-bzr-workfile-unchanged-p (file)
322
  (eq 'unchanged (car (vc-bzr-status file))))
Stefan Monnier's avatar
Stefan Monnier committed
323

Eric S. Raymond's avatar
Eric S. Raymond committed
324
(defun vc-bzr-working-revision (file)
Stefan Monnier's avatar
Stefan Monnier committed
325 326
  ;; 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.
327 328
  (lexical-let*
      ((rootdir (vc-bzr-root file))
329 330 331 332 333 334
       (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.
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
    (if (and (file-exists-p branch-format-file)
	     ;; For lightweight checkouts (obtained with bzr checkout --lightweight)
	     ;; the branch-format-file does not contain the revision
	     ;; information, we need to look up the branch-format-file
	     ;; in the place where the lightweight checkout comes
	     ;; from.  We only do that if it's a local file.
	     (let ((location-fname (expand-file-name
				    (concat vc-bzr-admin-dirname
					    "/branch/location") rootdir)))
	       ;; The existence of this file is how we distinguish
	       ;; lightweight checkouts.
	       (if (file-exists-p location-fname)
		   (with-temp-buffer
		     (insert-file-contents location-fname)
		     (when (re-search-forward "file://\(.+\)" nil t)
		       (setq branch-format-file (match-string 1))
		       (file-exists-p branch-format-file)))
		 t)))
353
        (with-temp-buffer
354
          (insert-file-contents branch-format-file)
355 356 357 358 359 360
          (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
361
            (insert-file-contents revhistory-file)
362
            (number-to-string (count-lines (line-end-position) (point-max))))
363 364 365
           ((or
	     (looking-at "Bazaar Branch Format 6 (bzr 0.15)")
	     (looking-at "Bazaar Branch Format 7 (needs bzr 1.6)"))
366
            ;; revno is the first number in .bzr/branch/last-revision
367
            (insert-file-contents lastrev-file)
368 369
            (when (re-search-forward "[0-9]+" nil t)
	      (buffer-substring (match-beginning 0) (match-end 0))))))
370
      ;; fallback to calling "bzr revno"
371
      (lexical-let*
372
          ((result (vc-bzr-command-discarding-stderr
373
                    vc-bzr-program "revno" (file-relative-name file)))
374 375 376 377 378
           (exitcode (car result))
           (output (cdr result)))
        (cond
         ((eq exitcode 0) (substring output 0 -1))
         (t nil))))))
Stefan Monnier's avatar
Stefan Monnier committed
379

380
(defun vc-bzr-create-repo ()
381
  "Create a new Bzr repository."
382 383
  (vc-bzr-command "init" nil 0 nil))

384
(defun vc-bzr-init-revision (&optional file)
385 386 387
  "Always return nil, as Bzr cannot register explicit versions."
  nil)

388 389 390 391 392 393 394 395 396 397
(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)))

398
(defun vc-bzr-register (files &optional rev comment)
Stefan Monnier's avatar
Stefan Monnier committed
399 400 401
  "Register FILE under bzr.
Signal an error unless REV is nil.
COMMENT is ignored."
402
  (if rev (error "Can't register explicit revision with bzr"))
403
  (vc-bzr-command "add" nil 0 files))
Stefan Monnier's avatar
Stefan Monnier committed
404 405 406

;; Could run `bzr status' in the directory and see if it succeeds, but
;; that's relatively expensive.
407
(defalias 'vc-bzr-responsible-p 'vc-bzr-root
Stefan Monnier's avatar
Stefan Monnier committed
408 409
  "Return non-nil if FILE is (potentially) controlled by bzr.
The criterion is that there is a `.bzr' directory in the same
410
or a superior directory.")
Stefan Monnier's avatar
Stefan Monnier committed
411 412 413 414 415 416 417 418 419

(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).
420
             (goto-char (point-min))
Stefan Monnier's avatar
Stefan Monnier committed
421 422 423 424 425
             (looking-at "added "))
         (error))))

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

428
(defun vc-bzr-checkin (files rev comment)
Stefan Monnier's avatar
Stefan Monnier committed
429 430
  "Check FILE in to bzr with log message COMMENT.
REV non-nil gets an error."
431
  (if rev (error "Can't check in a specific revision with bzr"))
432
  (vc-bzr-command "commit" nil 0 files "-m" comment))
Stefan Monnier's avatar
Stefan Monnier committed
433

434 435
(defun vc-bzr-find-revision (file rev buffer)
  "Fetch revision REV of file FILE and put it into BUFFER."
436 437 438 439 440
    (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
441 442 443 444
(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
445 446 447

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

450 451 452 453
(defvar log-view-message-re)
(defvar log-view-file-re)
(defvar log-view-font-lock-keywords)
(defvar log-view-current-tag-function)
454
(defvar log-view-per-file-logs)
455 456 457

(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
458
  (require 'add-log)
459
  (set (make-local-variable 'log-view-per-file-logs) nil)
460
  (set (make-local-variable 'log-view-file-re) "\\`a\\`")
461
  (set (make-local-variable 'log-view-message-re)
462
       "^ *\\(?:revno: \\([0-9.]+\\)\\|merged: .+\\)")
Stefan Monnier's avatar
Stefan Monnier committed
463
  (set (make-local-variable 'log-view-font-lock-keywords)
464 465 466 467 468
       ;; 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: \
469
\\([^<(]+?\\)[  ]*[(<]\\([[:alnum:]_.+-]+@[[:alnum:]_.-]+\\)[>)]"
470 471 472
                  (1 'change-log-name)
                  (2 'change-log-email))
                 ("^ *timestamp: \\(.*\\)" (1 'change-log-date-face))))))
Stefan Monnier's avatar
Stefan Monnier committed
473

474 475
(defun vc-bzr-print-log (files &optional buffer) ; get buffer arg in Emacs 22
  "Get bzr change log for FILES into specified BUFFER."
476 477 478 479 480
  ;; `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
481 482 483
  ;; 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.
484 485 486 487 488
  (with-current-buffer buffer
    (apply 'vc-bzr-command "log" buffer 'async files
	   (if (stringp vc-bzr-log-switches)
	       (list vc-bzr-log-switches)
	     vc-bzr-log-switches))))
Stefan Monnier's avatar
Stefan Monnier committed
489

490 491
(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
492
  (goto-char (point-min))
493 494 495 496 497 498 499 500 501 502 503
  (when revision
    (let (case-fold-search)
      (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)
	  (beginning-of-line 0)
	(goto-char (point-min))))))
Stefan Monnier's avatar
Stefan Monnier committed
504

505
(defun vc-bzr-diff (files &optional rev1 rev2 buffer)
Stefan Monnier's avatar
Stefan Monnier committed
506
  "VC bzr backend for diff."
507
  ;; `bzr diff' exits with code 1 if diff is non-empty.
508
  (apply #'vc-bzr-command "diff" (or buffer "*vc-diff*") 'async files
509
         "--diff-options" (mapconcat 'identity
510
                                     (vc-switches 'bzr 'diff)
Miles Bader's avatar
Miles Bader committed
511
				     " ")
512 513 514 515
         ;; 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"
516
                              (or rev1 "revno:-1")
517
                              (or rev2 ""))))))
Stefan Monnier's avatar
Stefan Monnier committed
518 519


520 521
;; FIXME: vc-{next,previous}-revision need fixing in vc.el to deal with
;; straight integer revisions.
Stefan Monnier's avatar
Stefan Monnier committed
522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537

(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)

538
(defun vc-bzr-annotate-command (file buffer &optional revision)
Stefan Monnier's avatar
Stefan Monnier committed
539 540 541
  "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."
542
  (apply #'vc-bzr-command "annotate" buffer 0 file "--long" "--all"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
543 544 545 546 547 548
         (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))
549
    (while (re-search-forward "^\\( *[0-9.]+ *\\) \\([^\n ]+\\) +\\([0-9]\\{8\\}\\) |"
Dan Nicolaescu's avatar
Dan Nicolaescu committed
550 551 552 553 554 555 556 557 558 559 560 561 562
                              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
563

564 565
(declare-function vc-annotate-convert-time "vc-annotate" (time))

Stefan Monnier's avatar
Stefan Monnier committed
566
(defun vc-bzr-annotate-time ()
567
  (when (re-search-forward "^ *[0-9.]+ +|" nil t)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
568 569
    (let ((prop (get-text-property (line-beginning-position) 'help-echo)))
      (string-match "[0-9]+\\'" prop)
570
      (let ((str (match-string-no-properties 0 prop)))
Stefan Monnier's avatar
Stefan Monnier committed
571 572
      (vc-annotate-convert-time
       (encode-time 0 0 0
573 574 575
                      (string-to-number (substring str 6 8))
                      (string-to-number (substring str 4 6))
                      (string-to-number (substring str 0 4))))))))
Stefan Monnier's avatar
Stefan Monnier committed
576 577 578 579 580 581

(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)
582
    (if (looking-at " *\\([0-9.]+\\) *| ")
Dan Nicolaescu's avatar
Dan Nicolaescu committed
583
        (match-string-no-properties 1))))
Stefan Monnier's avatar
Stefan Monnier committed
584

585 586
(defun vc-bzr-command-discarding-stderr (command &rest args)
  "Execute shell command COMMAND (with ARGS); return its output and exitcode.
587 588 589 590 591
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
592
    (cons
593
     (apply #'process-file command nil (list (current-buffer) nil) nil args)
594
     (buffer-substring (point-min) (point-max)))))
Stefan Monnier's avatar
Stefan Monnier committed
595

596 597
(defun vc-bzr-prettify-state-info (file)
  "Bzr-specific version of `vc-prettify-state-info'."
Stefan Monnier's avatar
Stefan Monnier committed
598
  (if (eq 'edited (vc-state file))
599
        (concat "(" (symbol-name (or (vc-file-getprop file 'vc-bzr-state)
600 601
                                     'edited)) ")")
    ;; else fall back to default vc.el representation
602
    (vc-default-prettify-state-info 'Bzr file)))
Stefan Monnier's avatar
Stefan Monnier committed
603

604 605 606 607 608 609
(defstruct (vc-bzr-extra-fileinfo
            (:copier nil)
            (:constructor vc-bzr-create-extra-fileinfo (extra-name))
            (:conc-name vc-bzr-extra-fileinfo->))
  extra-name)         ;; original name for rename targets, new name for

610
(defun vc-bzr-dir-printer (info)
611 612
  "Pretty-printer for the vc-dir-fileinfo structure."
  (let ((extra (vc-dir-fileinfo->extra info)))
613
    (vc-default-dir-printer 'Bzr info)
614 615 616 617 618 619
    (when extra
      (insert (propertize
	       (format "   (renamed from %s)"
		       (vc-bzr-extra-fileinfo->extra-name extra))
	       'face 'font-lock-comment-face)))))

620
;; FIXME: this needs testing, it's probably incomplete.
621
(defun vc-bzr-after-dir-status (update-function)
622
  (let ((status-str nil)
623 624 625 626 627 628 629
	(translation '(("+N " . added)
		       ("-D " . removed)
		       (" M " . edited) ;; file text modified
		       ("  *" . edited) ;; execute bit changed
		       (" M*" . edited) ;; text modified + execute bit changed
		       ;; FIXME: what about ignored files?
		       (" D " . missing)
630
                       ;; For conflicts, should we list the .THIS/.BASE/.OTHER?
631 632
		       ("C  " . conflict)
		       ("?  " . unregistered)
633 634 635
		       ("?  " . unregistered)
		       ;; No such state, but we need to distinguish this case.
		       ("R  " . renamed)
636 637 638
		       ;; For a non existent file FOO, the output is:
		       ;; bzr: ERROR: Path(s) do not exist: FOO
		       ("bzr" . not-found)
639 640 641 642 643
		       ;; If the tree is not up to date, bzr will print this warning:
		       ;; working tree is out of date, run 'bzr update'
		       ;; ignore it.
		       ;; FIXME: maybe this warning can be put in the vc-dir header...
		       ("wor" . not-found)
644 645
                       ;; Ignore "P " and "P." for pending patches.
                       ))
646 647 648 649 650
	(translated nil)
	(result nil))
      (goto-char (point-min))
      (while (not (eobp))
	(setq status-str
651
	      (buffer-substring-no-properties (point) (+ (point) 3)))
652
	(setq translated (cdr (assoc status-str translation)))
653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672
	(cond
	 ((eq translated 'conflict)
	  ;; 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.
	  (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))))
	 ((eq translated 'renamed)
	  (re-search-forward "R   \\(.*\\) => \\(.*\\)$" (line-end-position) t)
	  (let ((new-name (match-string 2))
		(old-name (match-string 1)))
	    (push (list new-name 'edited
		      (vc-bzr-create-extra-fileinfo old-name)) result)))
673 674
	 ;; do nothing for non existent files
	 ((eq translated 'not-found))
675
	 (t
676 677
	  (push (list (buffer-substring-no-properties
		       (+ (point) 4)
678
		       (line-end-position))
679
		      translated) result)))
680
	(forward-line))
681
      (funcall update-function result)))
682

683
(defun vc-bzr-dir-status (dir update-function)
684
  "Return a list of conses (file . state) for DIR."
685 686
  (vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S")
  (vc-exec-after
687
   `(vc-bzr-after-dir-status (quote ,update-function))))
688

689 690 691 692 693
(defun vc-bzr-dir-status-files (dir files default-state update-function)
  "Return a list of conses (file . state) for DIR."
  (apply 'vc-bzr-command "status" (current-buffer) 'async dir "-v" "-S" files)
  (vc-exec-after
   `(vc-bzr-after-dir-status (quote ,update-function))))
694 695

(defun vc-bzr-dir-extra-headers (dir)
696 697 698 699 700 701 702 703 704 705 706
  (let*
      ((str (with-temp-buffer
	      (vc-bzr-command "info" t 0 dir)
	      (buffer-string)))
       (light-checkout
	(when (string-match ".+light checkout root: \\(.+\\)$" str)
	  (match-string 1 str)))
       (light-checkout-branch
	(when light-checkout
	  (when (string-match ".+checkout of branch: \\(.+\\)$" str)
	    (match-string 1 str)))))
707
    (concat
708 709
     (propertize "Parent branch      : " 'face 'font-lock-type-face)
     (propertize
710
      (if (string-match "parent branch: \\(.+\\)$" str)
711 712 713 714 715 716 717 718 719 720 721 722 723 724
 	  (match-string 1 str)
 	"None")
       'face 'font-lock-variable-name-face)
     "\n"
      (when light-checkout
	(concat
	 (propertize "Light checkout root: " 'face 'font-lock-type-face)
	 (propertize light-checkout 'face 'font-lock-variable-name-face)
	 "\n"))
      (when light-checkout-branch
	(concat
	 (propertize "Checkout of branch : " 'face 'font-lock-type-face)
	 (propertize light-checkout-branch 'face 'font-lock-variable-name-face)
	 "\n")))))
725

726 727 728 729 730 731 732 733 734
;;; 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)
735
        (completion-table-with-context (substring string 0 (match-end 0))
736 737
                                       ;; FIXME: only allow directories.
                                       ;; FIXME: don't allow envvars.
738 739 740 741 742 743 744
                                       'read-file-name-internal
                                       (substring string (match-end 0))
                                       ;; Dropping `pred'.   Maybe we should
                                       ;; just stash it in
                                       ;; `read-file-name-predicate'?
                                       nil
                                       action))
745
       ((string-match "\\`\\(before\\):" string)
746 747 748 749 750
        (completion-table-with-context (substring string 0 (match-end 0))
                                       (vc-bzr-revision-completion-table files)
                                       (substring string (match-end 0))
                                       pred
                                       action))
751 752 753 754 755 756
       ((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.
757
            (process-file vc-bzr-program nil '(t) nil "tags" "--show-ids")
758 759 760 761 762
            ;; 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)))
763
          (completion-table-with-context prefix table tag pred action)))
764 765 766 767

       ((string-match "\\`\\(revid\\):" string)
        ;; FIXME: How can I get a list of revision ids?
        )
768 769
       ((eq (car-safe action) 'boundaries)
        (list* 'boundaries
770
               (string-match "[^:]*\\'" string)
771
               (string-match ":" (cdr action))))
772
       (t
773 774 775
        ;; Could use completion-table-with-terminator, except that it
        ;; currently doesn't work right w.r.t pcm and doesn't give
        ;; the *Completions* output we want.
776 777 778 779 780
        (complete-with-action action '("revno:" "revid:" "last:" "before:"
                                       "tag:" "date:" "ancestor:" "branch:"
                                       "submit:")
                              string pred))))))

Stefan Monnier's avatar
Stefan Monnier committed
781
(eval-after-load "vc"
782
  '(add-to-list 'vc-directory-exclusion-list vc-bzr-admin-dirname t))
Stefan Monnier's avatar
Stefan Monnier committed
783 784 785 786

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